Table of Contents
drule.get
Descrição
integer/array drule.get(object parameters)
O método permite recuperar regras de descoberta de acordo com os parâmetros fornecidos.
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| dhostids | ID/array | Retornar apenas regras de descoberta que criaram os hosts descobertos fornecidos. |
| druleids | ID/array | Retornar apenas regras de descoberta com os IDs fornecidos. |
| dserviceids | ID/array | Retornar apenas regras de descoberta que criaram os serviços descobertos fornecidos. |
| selectDChecks | query | Retornar uma propriedade dchecks com as verificações de descoberta usadas pela regra de descoberta.Suporta count. |
| selectDHosts | query | Retornar uma propriedade dhosts com os hosts descobertos criados pela regra de descoberta.Suporta count. |
| limitSelects | integer | Limita o número de registros retornados por subconsultas. Aplica-se às seguintes subconsultas: selectDChecks - os resultados serão ordenados por dcheckid;selectDHosts - os resultados serão ordenados por dhostsid. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: druleid, name. |
| countOutput | boolean | Esses parâmetros são descritos no comentário 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 |
Valores de retorno
(integer/array) Retorna:
- um array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recuperar todas as regras de descoberta
Recupera todas as regras de descoberta configuradas e as verificações de descoberta que elas utilizam.
{
"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
}Veja também
Fonte
CDRule::get() em ui/include/classes/api/services/CDRule.php.