Documentation
Table of Contents
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".
{
"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
}Recuperació de macros d'equip per a una plantilla
Recupera les macros d'equip definides per a la plantilla "10265" que contenen "STATUS" al nom de la macro.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10265",
"search": {
"macro": "STATUS"
}
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "6709",
"hostid": "10265",
"macro": "{$APACHE.STATUS.HOST}",
"value": "",
"description": "El nom d'amfitrió o l'adreça IP de l'amfitrió de la pàgina d'estat d'Apache.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "1",
"section_name": "",
"label": "Amfitrió d'estat d'Apache",
"description": "Nom d'amfitrió o adreça IP de l'amfitrió de la pàgina d'estat d'Apache.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "814",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PATH}",
"value": "server-status?auto",
"description": "La ruta URL de la pàgina d'estat d'Apache.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "3",
"section_name": "",
"label": "Ruta de la pàgina d'estat d'Apache",
"description": "Ruta URL de la pàgina d'estat d'Apache.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "815",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PORT}",
"value": "80",
"description": "El port de la pàgina d'estat d'Apache.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "2",
"section_name": "",
"label": "Port de la pàgina d'estat d'Apache",
"description": "En el rang d'1 a 65535 ambdós inclosos.",
"required": "1",
"regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",
"options": []
}
},
{
"hostmacroid": "816",
"hostid": "10265",
"macro": "{$APACHE.STATUS.SCHEME}",
"valor": "http",
"descripció": "L'esquema de sol·licitud, que pot ser HTTP o HTTPS.",
"tipus": "0",
"automàtic": "0",
"config": {
"tipus": "2",
"prioritat": "4",
"nom_secció": "",
"etiqueta": "Esquema de sol·licitud",
"descripció": "Esquema de sol·licitud, que pot ser HTTP o HTTPS.",
"requerit": "0",
"expressió_regular": "",
"opcions": [
{
"valor": "http",
"text": "HTTP"
},
{
"valor": "https",
"text": "HTTPS"
}
]
}
}
],
"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.