Documentation
Table of Contents
#dhost.get
Descrição
integer/array dhost.get(object parameters)
O método permite recuperar hosts descobertos 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 | Retorna apenas hosts descobertos com os IDs fornecidos. |
| druleids | ID/array | Retorna apenas hosts descobertos que foram criados pelas regras de descoberta fornecidas. |
| dserviceids | ID/array | Retorna apenas hosts descobertos que estão executando os serviços fornecidos. |
| selectDRules | query | Retorna uma propriedade drules com um array das regras de descoberta que detectaram o host. |
| selectDServices | query | Retorna uma propriedade dservices com os serviços descobertos em execução no host.Suporta count. |
| limitSelects | integer | Limita o número de registros retornados por subconsultas. Aplica-se às seguintes subconsultas: selectDServices - os resultados serão ordenados por dserviceid. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: dhostid, druleid. |
| countOutput | boolean | Estes 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:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recuperar hosts descobertos por regra de descoberta
Recupere todos os hosts e os serviços descobertos que estão sendo executados e que foram detectados pela regra de descoberta "4".
{ "jsonrpc": "2.0", "method": "dhost.get", "params": { "output": "extend", "selectDServices": "extend", "druleids": "4" }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "dservices": [ { "dserviceid": "1", "dhostid": "1", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697227", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.1", "dns": "station.company.lan" } ], "dhostid": "1", "druleid": "4", "status": "0", "lastup": "1337697227", "lastdown": "0" }, { "dservices": [ { "dserviceid": "2", "dhostid": "2", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697234", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.4", "dns": "john.company.lan" } ], "dhostid": "2", "druleid": "4", "status": "0", "lastup": "1337697234", "lastdown": "0" }, { "dservices": [ { "dserviceid": "3", "dhostid": "3", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697234", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.26", "dns": "printer.company.lan" } ], "dhostid": "3", "druleid": "4", "status": "0", "lastup": "1337697234", "lastdown": "0" }, { "dservices": [ { "dserviceid": "4", "dhostid": "4", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697234", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.7", "dns": "mail.company.lan" } ], "dhostid": "4", "druleid": "4", "status": "0", "lastup": "1337697234", "lastdown": "0" } ], "id": 1 }Veja também
Fonte
CDHost::get() em ui/include/classes/api/services/CDHost.php.