Table of Contents
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 suporta os 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 pelos 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. Possible values are: interfaceid, dns, ip. |
| countOutput | boolean | Esses parâmetros, sendo comuns para todos os métodos get são descritos detalhadamente na página de reference commentary page. |
| 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 interfaces do host
Recupere todos os dados sobre as interfaces usadas pelo host "30057."
Requisição:
{
"jsonrpc": "2.0",
"method": "hostinterface.get",
"params": {
"output": "extend",
"hostids": "30057"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"interfaceid": "50039",
"hostid": "30057",
"main": "1",
"type": "1",
"useip": "1",
"ip": "::1",
"dns": "",
"port": "10050",
"available": "0",
"error": "",
"errors_from": "0",
"disable_until": "0",
"details": []
},
{
"interfaceid": "55082",
"hostid": "30057",
"main": "0",
"type": "1",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "10051",
"available": "0",
"error": "",
"errors_from": "0",
"disable_until": "0",
"details": {
"version": "2",
"bulk": "0",
"community": "{$SNMP_COMMUNITY}"
}
}
],
"id": 1
}Veja também
Fonte
CHostInterface::get() em ui/include/classes/api/services/CHostInterface.php.