hostinterface.get

Descrição

integer/array hostinterface.get(object parameters)

O método permite recuperar interfaces de host 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
hostids	ID/array	Retorna apenas as interfaces de host usadas pelos hosts fornecidos.
interfaceids	ID/array	Retorna apenas as interfaces de host com os IDs fornecidos.
itemids	ID/array	Retorna apenas as interfaces de host usadas pelos itens fornecidos.
triggerids	ID/array	Retorna apenas as interfaces de host usadas por itens nos triggers fornecidos.
selectItems	query	Retorna uma propriedade `items` com os itens que usam a interface. Suporta `count`.
selectHosts	query	Retorna uma propriedade `hosts` com um array de hosts que usam a interface.
limitSelects	integer	Limita o número de registros retornados por subseleções. Aplica-se às seguintes subseleções: `selectItems`.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `interfaceid`, `dns`, `ip`.
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 countOutput foi utilizado.

Exemplos

Recuperar interfaces de host

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

Requisição:

{
           "jsonrpc": "2.0",
           "method": "hostinterface.get",
           "params": {
               "output": "extend",
               "hostids": "30057"
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "interfaceid": "50039",
                   "hostid": "30057",
                   "main": "1",
                   "type": "1",
                   "useip": "0",
                   "ip": "",
                   "dns": "localhost",
                   "port": "10050",
                   "available": "0",
                   "error": "",
                   "errors_from": "0",
                   "disable_until": "0",
                   "details": []
               },
               {
                   "interfaceid": "55082",
                   "hostid": "30057",
                   "main": "1",
                   "type": "2",
                   "useip": "1",
                   "ip": "127.0.0.1",
                   "dns": "",
                   "port": "161",
                   "available": "0",
                   "error": "",
                   "errors_from": "0",
                   "disable_until": "0",
                   "details": {
                       "version": "2",
                       "bulk": "0",
                       "community": "{$SNMP_COMMUNITY}",
                       "max_repetitions": "10"
                   }
               }
           ],
           "id": 1
       }

Veja também

Host
Item

Fonte

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

Documentation