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 | string/array | Devuelve sólo prototipos de equipo con los ID proporcionados. |
| discoveryids | cadena/matriz | Devuelve solo el prototipo de equipo que pertenece a las reglas LLD dadas. |
| inherited | 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 | consulta | Devuelve una propiedad macros con macros de prototipo de host. |
| selectParentHost | consulta | 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 | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| 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
Recuperar prototipos de equipo de una regla LLD
Recuperar todos los prototipos de equipo, 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",
"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}"
}
}
]
}
],
"id": 1
}Ver también
Fuente
CHostPrototype::get() en ui/include/classes/api/services/CHostPrototype.php.