dhost.get

Descrição

integer/array dhost.get(object parameters)

O método permite recuperar hosts descobertos 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 hosts descobertos com os IDs fornecidos.
druleids string/array Retorna apenas hosts descobertos que foram criados pelas regras de descoberta fornecidas.
dserviceids string/array Retorna apenas os hosts descobertos que estão executando os serviços fornecidos.
selectDRules query Retorne uma propriedade drules com uma matriz das regras de descoberta que detectaram o host.
selectDServices query Retorne uma propriedade dservices com os serviços descobertos em execução no host.

Suporta count.
limitSelects integer Limite o número de registros retornados por subseleções.

Aplica-se às seguintes subseleções:
selectDServices - os resultados serão classificados por dserviceid.
sortfield string/array Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: dhostid e druleid.
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 countOutput tiver sido usado.

Exemplos

Recuperar hosts descobertos por regra de descoberta

Recupere todos os hosts e os serviços descobertos que estão executando foram detectados pela regra de descoberta "4".

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "dhost.get",
    "parâmetros": {
        "saída": "estender",
        "selectDServices": "estender",
        "druleidas": "4"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "dserviços": [
                {
                    "dserviceid": "1",
                    "dhostid": "1",
                    "tipo": "4",
                    "chave_": "",
                    "valor": "",
                    "porta": "80",
                    "estado": "0",
                    "lastup": "1337697227",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.1",
                    "dns": "estação.empresa.lan"
                }
            ],
            "dhostid": "1",
            "druleid": "4",
            "estado": "0",
            "lastup": "1337697227",
            "lastdown": "0"
        },
        {
            "dserviços": [
                {
                    "dserviceid": "2",
                    "dhostid": "2",
                    "tipo": "4",
                    "chave_": "",
                    "valor": "",
                    "porta": "80",
                    "estado": "0",
                    "lastup": "1337697234",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.4",
                    "dns": "john.company.lan"
                }
            ],
            "dhostid": "2",
            "druleid": "4",
            "estado": "0",
            "lastup": "1337697234",
            "lastdown": "0"
        },
        {
            "dserviços": [
                {
                    "dserviceid": "3",
                    "dhostid": "3",
                    "tipo": "4",
                    "chave_": "",
                    "valor": "",
                    "porta": "80",
                    "estado": "0",
                    "lastup": "1337697234",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.26",
                    "dns": "impressora.empresa.lan"
                }
            ],
            "dhostid": "3",
            "druleid": "4",
            "estado": "0",
            "lastup": "1337697234",
            "lastdown": "0"
        },
        {
            "dserviços": [
                {
                    "dserviceid": "4",
                    "dhostid": "4",
                    "tipo": "4",
                    "chave_": "",
                    "valor": "",
                    "porta": "80",
                    "estado": "0",
                    "lastup": "1337697234",
                    "lastdown": "0",
                    "dcheckid": "5",
                    "ip": "192.168.1.7",
                    "dns": "mail.company.lan"
                }
            ],
            "dhostid": "4",
            "druleid": "4",
            "estado": "0",
            "lastup": "1337697234",
            "lastdown": "0"
        }
    ],
    "id": 1
}

Veja também

Fonte

CDHost::get() em ui/include/classes/api/services/CDHost.php.