hostprototype.get

Descripción

integer/array hostprototype.get(object parameters)

El método permite recuperar prototipos de host de acuerdo con los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Permisos para activar el método se puede revocar en los ajustes de roles de usuario. Ver User roles para más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
hostids	cadena/matriz	Devuelve sólo prototipos de host con los ID proporcionados.
discoveryids	cadena/matriz	Devuelve solo el prototipo de host que pertenece a las reglas LLD dadas.
heredado	booleano	Si se establece en "verdadero", devuelve solo los elementos heredados de una template.
selectDiscoveryRule	consulta	Devuelve una propiedad discoveryRule con la regla LLD a la que pertenece el prototipo de host.
selectInterfaces	consulta	Devuelve una propiedad interfaces con interfaces personalizadas de 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 macros de 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 etiquetas de prototipo de host.
selectTemplates	consulta	Devuelve una propiedad templates con las templates vinculadas al prototipo del host. Admite `count`.
sortfield	cadena/matriz	Ordena el resultado por las propiedades dadas. Los valores posibles son: `hostid`, `host`, `name` y `status`.
countOutput	booleano	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en el reference commentary.
editable	booleano
excluirBuscar	booleano
filtro	objeto
límite	entero
salida	consulta
preservekeys	booleano
buscar	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
clasificación	cadena/matriz
iniciarBuscar	booleano

Valores de devueltos

(integer/array) Devuelve:

una matriz de objetos;
la suma de los objetos devueltos, si el parámetros countOutput está siendo usado

Ejemplos

Recuperando prototipos de host de una regla LLD

Retcupere todos los prototipos de host, sus enlaces de grupo, prototipos de grupos y etiquetas de una regla LLD.

Solicitud:

{
       "jsonrpc": "2.0",
       "method": "hostprototype.get",
       "params": {
       "output": "extend",
       "selectInterfaces": "extend",
       "selectGroupLinks": "extend",
       "selectGroupPrototypes": "extend",
       "selectTags": "extend",
       "discoveryids": "23554"
       },
       "auth": "038e1d7b1735c6a5436ee9eae095879e",
       "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.

Documentation