Documentation
Table of Contents
hostprototype.get
Descripción
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.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| hostids | ID/array | Devolver solo prototipos de equipos con los IDs indicados. |
| discoveryids | ID/array | Devolver solo prototipos de equipos que pertenezcan a las reglas LLD indicadas. |
| inherited | booleano | Si se establece en true, devuelve solo los elementos heredados de una plantilla. |
| selectDiscoveryRule | consulta | Devuelve una propiedad discoveryRule con la regla LLD a la que pertenece el prototipo de equipo. |
| selectDiscoveryRulePrototype | consulta | Devuelve una propiedad discoveryRulePrototype con el prototipo de regla LLD principal al que pertenece el prototipo de equipo. |
| selectInterfaces | consulta | Devuelve una propiedad interfaces con las interfaces personalizadas del prototipo de equipo. |
| selectGroupLinks | consulta | Devuelve una propiedad groupLinks con los enlaces de grupo del prototipo de equipo. |
| selectGroupPrototypes | consulta | Devuelve una propiedad groupPrototypes con los prototipos de grupo del prototipo de equipo. |
| selectMacros | consulta | Devuelve una propiedad macros con las macros del prototipo de equipo. |
| selectParentHost | consulta | Devuelve una propiedad parentHost con el equipo al que pertenece el prototipo de equipo. |
| selectTags | consulta | Devuelve una propiedad tags con las etiquetas del prototipo de equipo. |
| selectTemplates | consulta | Devuelve una propiedad templates con las plantillas vinculadas al prototipo de equipo.Admite count. |
| sortfield | string/array | Ordena el resultado por las propiedades indicadas. Valores posibles: hostid, host, name, status, discovered. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | string/array | |
| startSearch | 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.