Documentation
Table of Contents
usermacro.get
Description
integer/array usermacro.get(object parameters)
La méthode permet de récupérer les macros hôtes et globales en fonction des paramètres donnés.
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.
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 hôtes. |
| globalmacroids | string/array | Renvoie uniquement les macros globales avec les ID donnés. |
| groupids | string/array | Renvoie uniquement les macros d'hôtes qui appartiennent aux hôtes ou aux modèles des groupes d'hôtes donnés. |
| hostids | string/array | Renvoie uniquement les macros qui appartiennent aux hôtes ou modèles donnés. |
| hostmacroids | string/array | Renvoie uniquement les macros hôtes avec les ID donnés. |
| inherited | boolean | S'il est défini sur "true", ne renvoie que les macros utilisateur du prototype d'hôte héritées d'un modèle. |
| selectGroups | query | Renvoie les groupes d'hôtes auxquels la macro hôte appartient dans la propriété groups. Utilisé uniquement lors de la récupération des macros hôte. |
| selectHosts | query | Renvoie les hôtes auxquels appartient la macro hôte dans la propriété hosts. Utilisé uniquement lors de la récupération des macros hôtes. |
| selectTemplates | query | Renvoie les modèles auxquels la macro hôte appartient dans la propriété templates. Utilisé uniquement lors de la récupération des macros hôte. |
| sortfield | string/array | Trie le résultat en fonction des propriétés données. Valeur possible : macro. |
| countOutput | boolean | Ces paramètres communs à toutes les méthodes get sont décrits en détail dans la page de commentaire 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) Renvoie 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érez toutes les macros d'hôte définies 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",
"description": "",
"type": "0"
},
{
"hostmacroid": "11",
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0"
}
],
"id": 1
}Récupération des macros globales
Récupérez 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",
"description": "",
"type": "0"
}
],
"id": 1
}Source
CUserMacro::get() dans ui/include/classes/api/services/CUserMacro.php.