[comment]: # ({02ea8022-02ea8022})
# usermacro.get

[comment]: # ({/02ea8022-02ea8022})

[comment]: # ({78b5ab06-28befc82})
### 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.

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d'informations.
:::

[comment]: # ({/78b5ab06-28befc82})

[comment]: # ({665d8bba-141835f9})
### Paramètres

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

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|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`](/manual/api/reference/hostgroup/object).<br><br>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`](/manual/api/reference/host/object).<br><br>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`](/manual/api/reference/templategroup/object).<br><br>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`](/manual/api/reference/template/object).<br><br>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.<br><br>Valeurs possibles: `macro`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectGroups<br>(deprecated)|query|Ce paramètre est obsolète, veuillez utiliser `selectHostGroups` ou `selectTemplateGroups` à la place.<br>Retourner les groupes d'hôtes et les groupes de modèles auxquels la macro d'hôte appartient dans la propriété `groups`.<br><br>Utilisé uniquement lors de la récupération des macros d'hôte.|

[comment]: # ({/665d8bba-141835f9})

[comment]: # ({7223bab1-7223bab1})
### 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é.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemples

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({4540e2f0-7089e052})
#### 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](/manual/api#performing-requests) :

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "hostids": "10198"
    },
    "id": 1
}
```

Réponse :

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

[comment]: # ({/4540e2f0-7089e052})

[comment]: # ({93c3e1f5-29b64a7a})
#### Récupération des macros globales

Récupérez toutes les macros globales.

[Requête](/manual/api#performing-requests) :

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.get",
    "params": {
        "output": "extend",
        "globalmacro": true
    },
    "id": 1
}
```

Réponse :

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "globalmacroid": "6",
            "macro": "{$SNMP_COMMUNITY}",
            "value": "public",
            "description": "",
            "type": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/93c3e1f5-29b64a7a})

[comment]: # ({26db0ec2-26db0ec2})
### Source

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

[comment]: # ({/26db0ec2-26db0ec2})