Documentation
Table of Contents
hostinterface.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array hostinterface.get(object parameters)
Este procedimiento nos permite recuperar las interfaces de equipo seg¨²n los par¨¢metros dados.
Este m¨¦todo est¨¢ disponible para todo tipo de usuarios. Los permisos para invocar este procedimiento pueden ser revocados en los roles de usuario. Ver Roles de usuario para m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(object) Los par¨¢metros que definen la salida deseada.
Este procedimiento soporta los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| hostids | ID/matriz | Devuelve s¨®lo las interfaces de equipo de la IDs dadas. |
| interfaceids | ID/matriz | Devuelve s¨®lo interfaces de equipo con los ID proporcionados. |
| itemids | ID/matriz | Devuelve s¨®lo las interfaces del equipo usadas por las m¨¦tricas dadas. |
| triggerids | string/array | Devuelve s¨®lo las interfaces de equipo usadas por las m¨¦tricas en los iniciadores dados. |
| selectItems | consulta | Devuelve una propiedad items con las m¨¦tricas que usa la interfaz. Soporta count |
| selectHosts | consulta | Devuelve una propiedad hosts con una matriz de equipos que usan la interfaz. |
| limitSelects | entero | Limita el numero de registros devueltos por subconsultas. Se aplica en las siguientes subconsultas: selectItems. |
| sortfield | cadena/matriz | Ordena el resultado por las propiedad dadas. Los posibles valores son: interfaceid, dns, ip. |
| countOutput | booleano | Estos par¨¢metros son comunes para todos los procedimientos get est¨¢n descritos en detalle en la p¨¢gina comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | boobleano |
Valores de devueltos
(integer/array) Returns either:
- una matriz de objetos;
- la suma de los objetos devueltos, si el par¨¢metros
countOutputest¨¢ siendo usado
Ejemplos
Recuperar interfaces del equipo
Recuperar todos los datos sobre las interfaces utilizadas por el equipo "30057".
{
"jsonrpc": "2.0",
"method": "hostinterface.get",
"params": {
"output": "extend",
"hostids": "30057"
},
"id": 1
}Respuesta:
{
"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
}Ver tambi¨¦n
Fuente
CHostInterface::get() in ui/include/classes/api/services/CHostInterface.php.