usermacro.get

Descripció

integer/array usermacro.get(object parameters)

El mètode permet recuperar equips i macros globals 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ó
globalmacro	flag	Retorna macros globals en lloc de macros d'equips.
globalmacroids	ID/array	Retorna només macros globals amb els ID donats.
groupids	ID/array	Retorna només macros d'equips que pertanyen als equips o plantilles dels grups d'equips donats.
hostids	ID/array	Retorna només macros que pertanyen als equips o plantilles donades.
hostmacroids	ID/array	Retorna només macros de l'equip amb els ID donats.
inherited	boolean	Si s'estableix a `true`, només retorna les macros d'usuari prototip d'equips heretades d'una plantilla.
selectHostGroups	query	Retorna els grups d'equips als quals pertany la macro de l'equip a la propietat `hostgroups`. Només s'empra per recuperar macros d'equips.
selectHosts	query	Retorna els equips als quals pertany la macro de l'equip a la propietat `hosts`. Només s'empra per recuperar macros d'equips.
selectTemplateGroups	query	Retorna els grups d'equips als quals pertany la macro de l'equip a la propietat `templategroups`. Només s'empra per recuperar macros d'equips.
selectTemplates	query	Retorna les plantilles a les quals pertany la macro de l'equip a la propietat `templates`. Només s'empra per recuperar macros de l'equip.
sortfield	string/array	Ordena el resultat segons les propietats donades. Valor possible: `macro`.
countOutput	boolean	Aquests paràmetres es descriuen en detall a la pàgina 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
selectGroups (obsolet)	query	Aquest paràmetre és obsolet; si us plau, emprau `selectHostGroups` o `selectTemplateGroups` en el seu lloc. Retorna els grups d'equips i els grups de plantilles on el trigger pertany a la propietat `groups`. Emprat només quan es recuperen macros d'equip.

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 les macros d'un equip

Recupera totes les macros definides per l'equip "10198".

Petició:

{  "jsonrpc": "2.0",  "method": "usermacro.get",  "params": {  "output": "extend",  "hostids": "10198"  },  "id": 1 }

Resposta:

{  "jsonrpc": "2.0",  "result": [  {  "hostmacroid": "9",  "hostid": "10198",  "macro": "{$INTERFACE}",  "value": "eth0",  "description": "",  "type": "0",  "automatic": "0"  },  {  "hostmacroid": "11",  "hostid": "10198",  "macro": "{$SNMP_COMMUNITY}",  "value": "public",  "description": "",  "type": "0",  "automatic": "0"  }  ],  "id": 1 }

Retrieving host macros for a template

Retrieve host macros defined for template "10265" that contain "STATUS" in the macro name.

Request:

{  "jsonrpc": "2.0",  "method": "usermacro.get",  "params": {  "output": "extend",  "hostids": "10265",  "search": {  "macro": "STATUS"  }  },  "id": 1 }

Response:

{  "jsonrpc": "2.0",  "result": [  {  "hostmacroid": "6709",  "hostid": "10265",  "macro": "{$APACHE.STATUS.HOST}",  "value": "",  "description": "The hostname or IP address of the Apache status page host.",  "type": "0",  "automatic": "0",  "config": {  "type": "1",  "priority": "1",  "section_name": "",  "label": "Apache status host",  "description": "Hostname or IP address of the Apache status page host.",  "required": "1",  "regex": "",  "options": []  }  },  {  "hostmacroid": "814",  "hostid": "10265",  "macro": "{$APACHE.STATUS.PATH}",  "value": "server-status?auto",  "description": "The URL path of the Apache status page.",  "type": "0",  "automatic": "0",  "config": {  "type": "1",  "priority": "3",  "section_name": "",  "label": "Apache status page path",  "description": "URL path of the Apache status page.",  "required": "1",  "regex": "",  "options": []  }  },  {  "hostmacroid": "815",  "hostid": "10265",  "macro": "{$APACHE.STATUS.PORT}",  "value": "80",  "description": "The port of the Apache status page.",  "type": "0",  "automatic": "0",  "config": {  "type": "1",  "priority": "2",  "section_name": "",  "label": "Apache status page port",  "description": "In the range from 1 to 65535 inclusive.",  "required": "1",  "regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",  "options": []  }  },  {  "hostmacroid": "816",  "hostid": "10265",  "macro": "{$APACHE.STATUS.SCHEME}",  "value": "http",  "description": "The request scheme, which may be either HTTP or HTTPS.",  "type": "0",  "automatic": "0",  "config": {  "type": "2",  "priority": "4",  "section_name": "",  "label": "Request scheme",  "description": "Request scheme, which may be either HTTP or HTTPS.",  "required": "0",  "regex": "",  "options": [  {  "value": "http",  "text": "HTTP"  },  {  "value": "https",  "text": "HTTPS"  }  ]  }  }  ],  "id": 1 }

Recuperar macros globals

Recupera totes les macros globals.