drule.get

Opis

integer/array drule.get(object parameters)

Metoda pozwala na pobranie reguł wykrywania zgodnie z żądanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.

Parametry

(object) Parametry określające pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr	Typ	Opis
dhostids	string/array	Zwraca tylko reguły wykrywania, które utworzyły podane hosty.
druleids	string/array	Zwraca tylko reguły wykrywania z podanymi ID.
dserviceids	string/array	Zwraca tylko reguły wykrywania, które utworzyły podane usługi.
selectDChecks	query	Zwraca właściwość dchecks z testami wykrywania użytymi przez regułę wykrywania. Obsługuje `count`.
selectDHosts	query	Zwraca właściwość dhosts z wykrytymi hostami utworzonymi przez regułę wykrywania. Obsługuje `count`.
limitSelects	integer	Ogranicza liczbę rekordów zwracanych przez podwybory. Dotyczy następujących podwyborów: `selectDChecks` - wyniki zostaną posortowane według `dcheckid`; `selectDHosts` - wyniki zostanie posortowane według `dhostsid`.
sortfield	string/array	Sortuje wynik według podanych właściwości. Możliwe wartości to:`druleid` i `name`.
countOutput	boolean	Parametry te są wspólne dla wszystkich metod `get` i są szczegółowo opisane w komentarzu referencyjnym.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

tablicę obiektów;
liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobierz wszystkie reguły wykrywania

Pobiera wszystkie skonfigurowane reguły wykrywania i używane przez nie testy wykrywania.

Zapytanie:

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

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "druleid": "2",
                   "proxy_hostid": "0",
                   "name": "Local network",
                   "iprange": "192.168.3.1-255",
                   "delay": "5s",
                   "nextcheck": "1348754327",
                   "status": "0",
                   "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",
                           "host_source": "1",
                           "name_source": "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",
                           "host_source": "1",
                           "name_source": "0"                    
                       }
                   ]
               },
               {
                   "druleid": "6",
                   "proxy_hostid": "0",
                   "name": "Zabbix agent discovery",
                   "iprange": "192.168.1.1-255",
                   "delay": "1h",
                   "nextcheck": "0",
                   "status": "0",
                   "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",
                           "host_source": "2",
                           "name_source": "3"                    
                       }
                   ]
               }
           ],
           "id": 1
       }

Zobacz także

Źródło

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

Documentation