Table of Contents
drule.get
Descrição
integer/array drule.get(object parameters)
O método permite recuperar as regras de descoberta de acordo com o dado parâmetros.
Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método oferece suporte aos seguintes parâmetros.
|Parâmetro|Tipo|Descrição| |---------|----------------------------------- ------------|-----------| |dhostids|string/array|Retorna apenas as regras de descoberta que criaram os hosts descobertos fornecidos.| |druleids|string/array|Retorna apenas regras de descoberta com os IDs fornecidos.| |dserviceids|string/array|Retorna apenas as regras de descoberta que criaram os serviços descobertos fornecidos.| |selectDChecks|query|Retorne uma propriedade dchecks com as verificações de descoberta usadas pela regra de descoberta.
Suporta count.| |selectDHosts|query|Retorne uma propriedade dhosts com os hosts descobertos criados pela regra de descoberta.
Suporta count.| |limitSelects|integer|Limite o número de registros retornados por subseleções.
Aplica-se às seguintes subseleções:selectDChecks - os resultados serão classificados por dcheckid;selectDHosts - resultados será ordenado por dhostsid.| |sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.
Os valores possíveis são: druleid e name.| |countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes no comentário de referência.| |editável|booleano|^| |excludePesquisa|boolean|^| |filtro|objeto|^| |limite|inteiro|^| |saída|consulta|^| |preservekeys|boolean|^| |pesquisar|objeto|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |ordem de classificação|cadeia/matriz|^| |startSearch|boolean|^|
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recupere todas as regras de descoberta
Recupere todas as regras de descoberta configuradas e a descoberta as verifica usar.
Solicitação:
{
"jsonrpc": "2.0",
"método": "drule.get",
"parâmetros": {
"saída": "estender",
"selectDChecks": "estender"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"druleid": "2",
"proxy_hostid": "0",
"nome": "Rede local",
"iprange": "192.168.3.1-255",
"atraso": "5s",
"nextcheck": "1348754327",
"estado": "0",
"dchecks": [
{
"dcheckid": "7",
"druleid": "2",
"tipo": "3",
"chave_": "",
"snmp_community": "",
"portas": "21",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"único": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
},
{
"dcheckid": "8",
"druleid": "2",
"tipo": "4",
"chave_": "",
"snmp_community": "",
"portas": "80",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"único": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "1",
"name_source": "0"
}
]
},
{
"druleid": "6",
"proxy_hostid": "0",
"name": "Descoberta do agente Zabbix",
"iprange": "192.168.1.1-255",
"atraso": "1h",
"nextcheck": "0",
"estado": "0",
"dchecks": [
{
"dcheckid": "10",
"druleid": "6",
"tipo": "9",
"key_": "system.uname",
"snmp_community": "",
"portas": "10050",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"único": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"host_source": "2",
"name_source": "3"
}
]
}
],
"id": 1
}Veja também
Fonte
CDRule::get() em ui/include/classes/api/services/CDRule.php.