Documentation
Table of Contents
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.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | 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
countOutputa ¨¦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.