Zabbix Documentation 2.2

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


Sidebar

ru:manual:api:reference:discoveryrule:get

discoveryrule.get

Описание

целое число/массив discoveryrule.get(объект параметры)

Этот метод позволяет получать правила LLD в соответствии с заданными параметрами.

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр Тип Описание
itemids строка/массив Возврат правил LLD только с заданными ID.
hostids строка/массив Возврат только тех правил LLD, которые принадлежат заданным узлам сети.
inherited логический Если задано значение true, возвращать только те правила LLD, которые унаследованы из шаблона.
interfaceids строка/массив Возврат только тех правил LLD, которые используют заданные интерфейсы узлов сети.
monitored логический Если задано значение true, возвращать только активированные правила LLD, которые принадлежат узлам сети под наблюдением.
templated логический Если задано значение true, возвращать только те правила LLD, которые принадлежат шаблонам.
templateids строка/массив Возврат только тех правил LLD, которые принадлежат заданным шаблонам.
selectHosts запрос Возврат узла сети, которому принадлежит правило LLD, в виде массива в свойстве hosts.
selectGraphs запрос Возврат прототипов графиков, которые принадлежат правилу LLD, в свойстве graphs.

Поддерживается count.
selectHostPrototypes запрос Возврат прототипов узлов сети, которые принадлежат правилу обнаружения, в свойстве hostPrototypes.

Поддерживается count.
selectItems запрос Возврат прототипов элементов данных, которые принадлежат правилу LLD, в свойстве items.

Поддерживается count.
selectTriggers запрос Возврат прототипов триггеров, которые принадлежат правилу обнаружения, в свойстве triggers.

Поддерживается count.
filter объект Возврат только тех результатов, которые в точности соответствуют заданному фильтру.

Принимает массив, где ключи являются именами свойств и значения, которые являются либо одним значением, либо массивом сопоставляемых значений.

Поддерживает дополнительные фильтры:
host - техническое имя узла сети, которому принадлежит правило LLD.
limitSelects целое число Ограничение количества записей, возвращаемых подзапросами.

Применимо только к следующим подзапросам:
selctItems;
selectGraphs;
selectTriggers.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: itemid, name, key_, delay, type и status.
countOutput флагЭти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch флаг
limit целое число
nodeids строка/массив
output запрос
preservekeys флаг
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch флаг

Возвращаемые значения

(целое число/массив) Возвращает либо:

  • массив объектов;
  • количество найденных объектов, если используется параметр countOutput.

Примеры

Получение правил обнаружения с узла сети

Получение всех правил обнаружения с узла сети “10202”.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "discoveryrule.get",
    "params": {
        "output": "extend",
        "hostids": "10202"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "27425",
            "type": "0",
            "snmp_community": "",
            "snmp_oid": "",
            "hostid": "10202",
            "name": "Network interface discovery",
            "key_": "net.if.discovery",
            "delay": "3600",
            "state": "0",
            "status": "0",
            "trapper_hosts": "",
            "snmpv3_securityname": "",
            "snmpv3_securitylevel": "0",
            "snmpv3_authpassphrase": "",
            "snmpv3_privpassphrase": "",
            "error": "",
            "templateid": "22444",
            "delay_flex": "",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "filter": "{#IFNAME}:@Network interfaces for discovery",
            "interfaceid": "119",
            "port": "",
            "description": "Discovery of network interfaces as defined in global regular expression \"Network interfaces for discovery\".",
            "lifetime": "30",
            "snmpv3_authprotocol": "0",
            "snmpv3_privprotocol": "0"
        },
        {
            "itemid": "27426",
            "type": "0",
            "snmp_community": "",
            "snmp_oid": "",
            "hostid": "10202",
            "name": "Mounted filesystem discovery",
            "key_": "vfs.fs.discovery",
            "delay": "3600",
            "state": "0",
            "status": "0",
            "trapper_hosts": "",
            "snmpv3_securityname": "",
            "snmpv3_securitylevel": "0",
            "snmpv3_authpassphrase": "",
            "snmpv3_privpassphrase": "",
            "error": "",
            "templateid": "22450",
            "delay_flex": "",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "filter": "{#FSTYPE}:@File systems for discovery",
            "interfaceid": "119",
            "port": "",
            "description": "Discovery of file systems of different types as defined in global regular expression \"File systems for discovery\".",
            "lifetime": "30",
            "snmpv3_authprotocol": "0",
            "snmpv3_privprotocol": "0"
        }
    ],
    "id": 2
}

Смотрите также

Исходный код

CDiscoveryRule::get() в frontends/php/api/classes/CDiscoveryRule.php.