drule.get

Descripció

integer/array drule.get(object parameters)

El mètode permet recuperar regles de descoberta segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
dhostids	ID/array	Retorna només les regles de descoberta que han creat els equips descoberts donats.
druleids	ID/array	Retorna només les regles de descoberta amb els ID donats.
dserviceids	ID/array	Retorna només les regles de descoberta que han creat els serveis descoberts donats.
selectDChecks	query	Retorna una propietat dchecks que conté les proves de descoberta emprades per la regla de descoberta. Admet `count`.
selectDHosts	query	Retorna una propietat dhosts que conté els equips descoberts creats per la regla de descoberta. Admet `count`.
limitSelects	integer	Limita el nombre de registres retornats per les subconsultes. S'aplica a les subconsultes següents: `selectDChecks`: els resultats s'ordenaran per `dcheckid`;< br>`selectDHosts`: resultats s'ordenarà per `dhostsid`.
sortfield	string/array	Ordena el resultat per les propietats donades. Els valors possibles són: `druleid` i `name`.
countOutput	boolean	Aquests paràmetres es descriuen als comentaris de referència.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar totes les regles de descoberta

Recupera totes les regles de descoberta configurades i els testos de descoberta que empren.

Petició:

{  "jsonrpc": "2.0",  "method": "drule.get",  "params": {  "output": "extend",  "selectDChecks": "extend"  },  "id": 1 }

Resposta:

{  "jsonrpc": "2.0",  "result": [  {  "druleid": "2",  "proxyid": "0",  "name": "Local network",  "iprange": "192.168.3.1-255",  "delay": "5s",  "status": "0",  "concurrency_max": "0",  "error": "",  "dchecks": [  {  "dcheckid": "7",  "druleid": "2",  "type": "3",  "key_": "",  "snmp_community": "",  "ports": "21",  "snmpv3_securityname": "",  "snmpv3_securitylevel": "0",  "snmpv3_authpassphrase": "",  "snmpv3_privpassphrase": "",  "uniq": "0",  "snmpv3_authprotocol": "0",  "snmpv3_privprotocol": "0",  "snmpv3_contextname": "",  "host_source": "1",  "name_source": "0",  "allow_redirect": "0"  },  {  "dcheckid": "8",  "druleid": "2",  "type": "4",  "key_": "",  "snmp_community": "",  "ports": "80",  "snmpv3_securityname": "",  "snmpv3_securitylevel": "0",  "snmpv3_authpassphrase": "",  "snmpv3_privpassphrase": "",  "uniq": "0",  "snmpv3_authprotocol": "0",  "snmpv3_privprotocol": "0",  "snmpv3_contextname": "",  "host_source": "1",  "name_source": "0",  "allow_redirect": "0"  }  ]  },  {  "druleid": "6",  "proxyid": "0",  "name": "Zabbix agent discovery",  "iprange": "192.168.1.1-255",  "delay": "1h",  "status": "0",  "concurrency_max": "10",  "error": "",  "dchecks": [  {  "dcheckid": "10",  "druleid": "6",  "type": "9",  "key_": "system.uname",  "snmp_community": "",  "ports": "10050",  "snmpv3_securityname": "",  "snmpv3_securitylevel": "0",  "snmpv3_authpassphrase": "",  "snmpv3_privpassphrase": "",  "uniq": "0",  "snmpv3_authprotocol": "0",  "snmpv3_privprotocol": "0",  "snmpv3_contextname": "",  "host_source": "2",  "name_source": "3",  "allow_redirect": "0"  }  ]  }  ],  "id": 1 }

Veieu també

Font

CDRule::get() in ui/include/classes/api/services/CDRule.php.

Documentation