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 string/array Retorna només macros globals amb els ID donats.
groupids string/array Retorna només macros d'equips que pertanyen als equips o plantilles dels grups d'equips donats.
hostids string/array Retorna només macros que pertanyen als equips o plantilles donades.
hostmacroids string/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.
selectGroups query Retorna els grups d'equips als quals pertany la macro de l'equip a la propietat grups.

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 equips.

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 plantilles.

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 comuns a tots els mètodes get es descriuen amb 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

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

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

Petició:

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

Resposta:

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

Recuperar macros globals

Recuperar totes les macros globals.

Petició:

{
           "jsonrpc": "2.0",
           "method": "usermacro.get",
           "params": {
               "output": "extend",
               "globalmacro": true
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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.