hostinterface.get

Descrição

integer/array hostinterface.get(object parameters)

O método permite recuperar interfaces de host 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
hostids string/array Retorna apenas interfaces de host usadas pelos hosts fornecidos.
interfaceids string/array Retorna apenas interfaces de host com os IDs fornecidos.
itemids string/array Retorna apenas interfaces de host usadas pelos itens fornecidos.
triggerids string/array Retorna apenas interfaces de host usadas por itens nos gatilhos fornecidos.
selectItems query Retorne uma propriedade items com os itens que usam a interface.

Suporta count.
selectHosts query Retorne uma propriedade hosts com uma matriz de hosts que usam a interface.
limitSelects integer Limite o número de registros retornados por subseleções.

Aplica-se às seguintes subseleções:
selectItems.
sortfield string/array Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: interfaceid, dns, ip.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes na página comentário de referência.
editável booleano
excludePesquisa boolean
filtro objeto
limite inteiro
nodeids string/array
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 interfaces de host

Recupere todos os dados sobre as interfaces usadas pelo host "30057".

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "hostinterface.get",
    "parâmetros": {
        "saída": "estender",
        "hostids": "30057"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "interfaceid": "50039",
            "hostid": "30057",
            "principal": "1",
            "tipo 1",
            "useip": "1",
            "ip": "::1",
            "dns": "",
            "porta": "10050",
            "disponível": "0",
            "erro": "",
            "errors_from": "0",
            "disable_until": "0",
            "detalhes": []
        },
        {
            "interfaceid": "55082",
            "hostid": "30057",
            "principal": "0",
            "tipo 1",
            "useip": "1",
            "ip": "127.0.0.1",
            "dns": "",
            "porta": "10051",
            "disponível": "0",
            "erro": "",
            "errors_from": "0",
            "disable_until": "0",
            "detalhes": {
                "versão 2",
                "em massa": "0",
                "community": "{$SNMP_COMMUNITY}"
            }
        }
    ],
    "id": 1
}

Veja também

Fonte

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