[comment]: # aside: 1

[comment]: # ({ee4a2645-28092341})
# Objet macro utilisateur

Les objets suivants sont directement liés à l'API `usermacro`.

[comment]: # ({/ee4a2645-28092341})

[comment]: # ({2f5f2156-e654cd12})
### Macro global

L'objet macro global possède les propriétés suivantes.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|globalmacroid|ID|ID de la macro globale.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *lecture seule*<br>- *obligatoire* pour les opérations de mise à jour|
|macro|string|Chaîne de macro.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *obligatoire* pour les opérations de création|
|value|string|Valeur de la macro.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior):<br>- *écriture seule* si `type` est défini sur "Secret macro"<br>- *obligatoire* pour les opérations de création|
|type|integer|Type de macro.<br><br>Valeurs possibles :<br>0 - *(par défaut)* Macro texte;<br>1 - Secret macro;<br>2 - Secret du coffre-fort.|
|description|string|Description de la macro.|

[comment]: # ({/2f5f2156-e654cd12})

[comment]: # ({c73e8f15-5a3a9f9f})
### Macro d'hôte

L'objet macro d'hôte définit une macro disponible sur un hôte, un prototype d'hôte ou un modèle. Il possède les propriétés suivantes.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|hostmacroid|ID|ID de la macro d'hôte.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *read-only*<br>- *required* for update operations|
|hostid|ID|ID de l'hôte auquel appartient la macro.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *constant*<br>- *required* for create operations|
|macro|string|Chaîne de macro.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *required* for create operations|
|value|string|Valeur de la macro.<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *write-only* if `type` is set to "Secret macro"<br>- *required* for create operations|
|type|integer|Type de macro.<br><br>Possible values:<br>0 - *(default)* Text macro;<br>1 - Secret macro;<br>2 - Vault secret.|
|description|string|Description de la macro.|
|automatic|integer|Définit si la macro est contrôlée par une règle de découverte.<br><br>Possible values:<br>0 - *(default)* Macro is managed by user;<br>1 - Macro is managed by discovery rule.<br><br>User is not allowed to create automatic macro.<br>To update automatic macro, it must be [converted to manual](/manual/api/reference/usermacro/update#change-macro-value-that-was-created-by-discovery-rule).|

[comment]: # ({/c73e8f15-5a3a9f9f})