Documentation
Table of Contents
usermacro.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
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.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que defineixen la sortida esperada.
El m¨¨tode admet els par¨¤metres seg¨¹ents.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| 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".
{
"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
}Recuperar macros globals
Recupera totes les macros globals.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"globalmacro": true
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"globalmacroid": "6",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0"
}
],
"id": 1
}Font
CUserMacro::get() in ui/include/classes/api/services/CUserMacro.php.