Documentation
Table of Contents
hostprototype.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array hostprototype.get(object parameters)
El m¨¦todo permite recuperar prototipos de equipo de acuerdo con los par¨¢metros dados.
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. Los permisos para llamar al m¨¦todo se pueden revocar en la configuraci¨®n de roles de usuario. Ver Roles de usuario para m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| hostids | ID/matriz | Devuelve s¨®lo prototipos de host con los ID proporcionados. |
| discoveryids | ID/matriz | Devuelve solo prototipos de host que pertenecen a las reglas LLD dadas. |
| heredado | booleano | Si se establece en "verdadero", devuelve solo los elementos heredados de una plantilla. |
| selectDiscoveryRule | query | Devuelve una propiedad discoveryRule con la regla LLD a la que pertenece el prototipo de host. |
| selectInterfaces | query | Devuelve una propiedad interfaces con interfaces personalizadas de prototipo de host. |
| selectGroupLinks | query | Devuelve una propiedad groupLinks con los enlaces de grupo del prototipo de host. |
| selectGroupPrototypes | query | Devuelve una propiedad groupPrototypes con los prototipos de grupo del prototipo de host. |
| selectMacros | query | Devuelve una propiedad macros con macros de prototipo de host. |
| selectParentHost | query | Devuelve una propiedad parentHost con el host al que pertenece el prototipo de host. |
| selectTags | query | Devuelve una propiedad tags con etiquetas de prototipo de host. |
| selectTemplates | query | Devuelve una propiedad templates con las plantillas vinculadas al prototipo del host.Admite count. |
| sortfield | string/array | Ordena el resultado por las propiedades dadas. Valores posibles: hostid, host, name, status. |
| countOutput | boolean | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| ±ô¨ª³¾¾±³Ù±ð | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| ³¦±ô²¹²õ¾±´Ú¾±³¦²¹³¦¾±¨®²Ô | cadena/matriz | |
| iniciarBuscar | booleano |
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
Recuperaci¨®n de prototipos de equipo de una regla LLD
Recupere todos los prototipos de equipo, sus v¨ªnculos de grupo, prototipos de grupo y etiquetas de una regla LLD.
{
"jsonrpc": "2.0",
"method": "hostprototype.get",
"params": {
"output": "extend",
"selectInterfaces": "extend",
"selectGroupLinks": "extend",
"selectGroupPrototypes": "extend",
"selectTags": "extend",
"discoveryids": "23554"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10092",
"host": "{#HV.UUID}",
"name": "{#HV.UUID}",
"status": "0",
"templateid": "0",
"discover": "0",
"custom_interfaces": "1",
"inventory_mode": "-1",
"groupLinks": [
{
"group_prototypeid": "4",
"hostid": "10092",
"groupid": "7",
"templateid": "0"
}
],
"groupPrototypes": [
{
"group_prototypeid": "7",
"hostid": "10092",
"name": "{#CLUSTER.NAME}",
"templateid": "0"
}
],
"tags": [
{
"tag": "datacenter",
"value": "{#DATACENTER.NAME}"
},
{
"tag": "instance-type",
"value": "{#INSTANCE_TYPE}"
}
],
"interfaces": [
{
"main": "1",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}",
"max_repetitions": "10"
}
}
]
}
],
"id": 1
}Ver tambi¨¦n
Fuente
CHostPrototype::get() en ui/include/classes/api/services/CHostPrototype.php.