hostprototype.get

Descripció

integer/array hostprototype.get(object parameters)

El mètode permet recuperar prototipus d'equips segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
hostids ID/array Retorna només els prototips d'equips amb els identificadors donats.
discoveryids ID/array Retorna només els prototips d'equips que pertanyen a les regles de descobriment de baix nivell donades.
inherited boolean Si s'estableix a true, només retorna els elements heretats d'un model.
selectDiscoveryRule query Retorna una propietat discoveryRule que conté la regla de descoberta de baix nivell a la qual pertany el prototip d'equips.
selectInterfaces query Retorna una propietat interfaces que conté les interfícies personalitzades del prototip d'equips.
selectGroupLinks query Retorna una propietat grouplinks que conté els enllaços de grup del prototip d'equips.
selectGroupPrototypes query Retorna una propietat groupPrototypes que conté els prototips de grup del prototip d'equips.
selectMacros query Retorna una propietat macros que conté les macros del prototip d'equips.
selectParentHost query Retorna una propietat parentHost que conté l'equip al qual pertany el prototip d'equips.
selectTags query Retorna una propietat tags que conté les etiquetes del prototip d'equips.
selectTemplates query Retorna una propietat templates que conté plantilles relacionades amb el prototip d'equips.

Admet count.
sortfield string/array Ordena el resultat per les propietats donades.

Els valors possibles són: hostid, host, name i status.
countOutput boolean Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

recuperar prototips d'equips a partir d'una regla LLD

Recupera tots els prototips d'equips, els seus enllaços de grups, prototips de grups i etiquetes a partir d'una regla LLD.

Petició:

{
           "jsonrpc": "2.0",
           "method": "hostprototype.get",
           "params": {
               "output": "extend",
               "selectInterfaces": "extend",
               "selectGroupLinks": "extend",
               "selectGroupPrototypes": "extend",
               "selectTags": "extend",
               "discoveryids": "23554"
           },
           "id": 1
       }

Resposta:

{
           "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": iInstance-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
       }

Veieu també

Font

CHostPrototype::get() in ui/include/classes/api/services/CHostPrototype.php.