usermacro.get

Description

integer/array usermacro.get(object parameters)

Cette méthode permet de récupérer les macros d'hôte et globales selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir User roles 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.

Parameter Type Description
globalmacro flag Retourner les macros globales au lieu des macros d'hôte.
globalmacroids ID/array Retourner uniquement les macros globales avec les IDs donnés.
groupids ID/array Retourner uniquement les macros d'hôte qui appartiennent à des hôtes ou des modèles issus des groupes d'hôtes ou groupes de modèles donnés.
hostids ID/array Retourner uniquement les macros qui appartiennent aux hôtes ou modèles donnés.
hostmacroids ID/array Retourner uniquement les macros d'hôte avec les IDs donnés.
inherited boolean Si défini sur true, retourner uniquement les macros utilisateur de prototype d'hôte héritées d'un modèle.
selectHostGroups query Retourner les groupes d'hôtes auxquels la macro d'hôte appartient dans la propriété hostgroups.

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

Utilisé uniquement lors de la récupération des macros d'hôte.
selectTemplateGroups query Retourner les groupes de modèles auxquels la macro de modèle appartient dans la propriété templategroups.

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

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

Valeurs possibles: macro.
countOutput boolean Ces paramètres sont décrits dans le 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
selectGroups
(deprecated)		 query Ce paramètre est obsolète, veuillez utiliser selectHostGroups ou selectTemplateGroups à la place.
Retourner les groupes d'hôtes et les groupes de modèles auxquels la macro d'hôte appartient dans la propriété groups.

Utilisé uniquement lors de la récupération des macros d'hôte.

Valeurs retournées

(integer/array) Renvoie 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é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"
    },
    "id": 1
}

Réponse :

{
    "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
}

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
    },
    "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.