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:drule:get

drule.get

Описание

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

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

Параметры

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

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

Параметр Тип Описание
dhostids строка/массив Возврат только тех правил обнаружения, которые создали заданные обнаруженные узлы сети.
druleids строка/массив Возврат правил обнаружения только с заданными ID.
dserviceids строка/массив Возврат только тех правил обнаружения, которые создали заданные обнаруженные сервисы.
selectDChecks запрос Возврат проверок обнаружения, которые используются правилом обнаружения, в свойстве dchecks.

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

Поддерживает count.
limitSelects целое число Ограничение количества записей, возвращаемых подзапросами.

Применимо только к следующим подзапросам:
selectDChecks - результаты отсортируются по dcheckid;
selectDHosts - результаты отсортируются по dhostsid.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

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

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

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

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

Примеры

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

Получение всех настроенных правил обнаружения и проверок обнаружения, которые они используют.

Ответ:

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

Ответ:

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

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

Исходный код

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