Table of Contents
hostprototype.get
Descripción
integer/array hostprototype.get(object parameters)
El método permite recuperar prototipos de equipos según los parámetros proporcionados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para obtener 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 host con los IDs dados. |
| discoveryids | ID/array | Devolver solo prototipos de host que pertenezcan a las reglas LLD dadas. |
| inherited | booleano | Si se establece en true, devolver solo los elementos heredados de una plantilla. |
| selectDiscoveryData | consulta | Devuelve una propiedad discoveryData con los datos del objeto de descubrimiento del prototipo de host. El objeto de descubrimiento del prototipo de host vincula un prototipo de host descubierto con un prototipo de host del que fue descubierto.Tiene las siguientes propiedades: host - (cadena) ID del host;parent_hostid - (cadena) ID del prototipo de host del que se ha creado el prototipo de host;status - (int) estado de descubrimiento del prototipo de host:0 - (por defecto) el prototipo de host está descubierto, 1 - el prototipo de host ya no está descubierto; ts_delete - (timestamp) hora en la que se eliminará un prototipo de host que ya no se descubre;ts_disable - (timestamp) hora en la que se deshabilitará un prototipo de host que ya no se descubre;disable_source - (int) indicador de si el prototipo de host fue deshabilitado por una regla LLD o manualmente:0 - (por defecto) deshabilitado automáticamente, 1 - deshabilitado por una regla LLD. |
| selectDiscoveryRule | consulta | Devuelve una propiedad discoveryRule con la regla LLD a la que pertenece el prototipo de host. |
| selectDiscoveryRulePrototype | consulta | Devuelve una propiedad discoveryRulePrototype con el prototipo de regla LLD principal al que pertenece el prototipo de host. |
| selectInterfaces | consulta | Devuelve una propiedad interfaces con las interfaces personalizadas del prototipo de host. |
| selectGroupLinks | consulta | Devuelve una propiedad groupLinks con los enlaces de grupo del prototipo de host. |
| selectGroupPrototypes | consulta | Devuelve una propiedad groupPrototypes con los prototipos de grupo del prototipo de host. |
| selectMacros | consulta | Devuelve una propiedad macros con las macros del prototipo de host. |
| selectParentHost | consulta | Devuelve una propiedad parentHost con el host al que pertenece el prototipo de host. |
| selectTags | consulta | Devuelve una propiedad tags con las etiquetas del prototipo de host. |
| selectTemplates | consulta | Devuelve una propiedad templates con las plantillas vinculadas al prototipo de host.Admite count. |
| sortfield | cadena/array | Ordena el resultado por las propiedades dadas. 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 | cadena/array | |
| startSearch | booleano |
Valores de retorno
(integer/array) Devuelve:
- un array de objetos;
- el número de objetos recuperados, si se ha utilizado el parámetro
countOutput.
Ejemplos
Recuperar prototipos de equipos de una regla LLD
Recupera todos los prototipos de equipos, sus enlaces 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",
"flags": "2",
"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
}Véase también
Fuente
CHostPrototype::get() en ui/include/classes/api/services/CHostPrototype.php.