Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

usermacro.get

Description

integer/array usermacro.get(object parameters)

La méthode permet de récupérer des macros d'hôtes et globales en fonction des paramètres donnés.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
globalmacro flag Renvoie les macros globales au lieu des macros d'hôtes.
globalmacroids string/array Renvoie uniquement les macros globales avec les identifiants donnés.
groupids string/array Renvoie uniquement les macros d'hôtes appartenant aux hôtes ou aux modèles des groupes d'hôtes donnés.
hostids string/array Renvoie uniquement les macros appartenant aux hôtes ou aux modèles donnés.
hostmacroids string/array Renvoie uniquement les macros hôtes avec les identifiants donnés.
selectGroups query Renvoie les groupes d'hôtes auxquels la macro d'hôte appartient dans la propriété groups.

Utilisé uniquement lors de la récupération de macros d'hôte.
selectHosts query Renvoie les hôtes auxquels la macro d'hôte appartient dans la propriété hosts.

Utilisé uniquement lors de la récupération de macros d'hôte.
selectTemplates query Renvoie les modèles auxquels la macro d'hôte appartient dans la propriété templates.

Utilisé uniquement lors de la récupération de macros d'hôte.
sortfield string/array Trie le résultat en fonction des propriétés données.

Valeurs possibles : macro.
countOutput boolean Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les commentaires de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des macros d'hôte pour un hôte

Récupérer les macros d'hôte pour l'hôte "10198".

Requête :

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

Réponse :

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

Récupération de macros globales

Récupérer toutes les macros globales.

Requête :

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

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "globalmacroid": "6",
                   "macro": "{$SNMP_COMMUNITY}",
                   "value": "public"
               }
           ],
           "id": 1
       }

Source

CUserMacro::get() dans frontends/php/include/classes/api/services/CUserMacro.php.