Objet macro utilisateur

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

Macro globale

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

Propriété Type Description
globalmacroid ID ID de la macro globale.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
description string Description de la macro.
macro string Chaîne de la macro.

Comportement de la propriété :
- obligatoire pour les opérations de création
type integer Type de macro.

Valeurs possibles :
0 - (par défaut) Macro texte ;
1 - Macro secrète ;
2 - Secret du coffre-fort.
value string Valeur de la macro.

Comportement de la propriété :
- écriture seule si type est défini sur "Secret macro"
- obligatoire pour les opérations de création

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.

Propriété Type Description
hostmacroid ID ID de la macro.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
automatic integer Définit si la macro est contrôlée par une règle de découverte.

Valeurs possibles :
0 - (par défaut) La macro est gérée par l’utilisateur ;
1 - La macro est gérée par une règle de découverte.

L’utilisateur n’est pas autorisé à créer une macro automatique.
Pour mettre à jour une macro automatique, elle doit être convertie en macro manuelle.
config object/array Configuration de la macro responsable de la manière dont la macro est affichée dans l’assistant d’hôte.
description string Description de la macro.
hostid ID ID de l’hôte, du prototype d’hôte ou du modèle auquel appartient la macro.

Comportement de la propriété :
- constant
- obligatoire pour les opérations de création
macro string Chaîne de macro.

Comportement de la propriété :
- obligatoire pour les opérations de création
type integer Type de macro.

Valeurs possibles :
0 - (par défaut) Macro texte ;
1 - Macro secrète ;
2 - Secret du coffre-fort.
value string Valeur de la macro.

Comportement de la propriété :
- écriture seule si type est défini sur "Secret macro"
- obligatoire pour les opérations de création

Configuration des macros

L'objet de configuration des macros définit la manière dont une macro est affichée dans le Host Wizard.

Propriété Type Description
type integer Type du champ de saisie de la macro.

Valeurs possibles :
0 - La macro n'est pas utilisée dans le Host Wizard ;
1 - Zone de texte ;
2 - Liste ;
3 - Case à cocher.

Comportement de la propriété :
- obligatoire
label string Libellé du champ de saisie de la macro.

Comportement de la propriété :
- obligatoire si type est défini sur "Textbox", "List" ou "Checkbox"
description text Texte d'aide affiché à côté du champ de saisie de la macro. Prend en charge le formatage Markdown.
priority integer Position du champ de saisie de la macro dans la liste des macros.

Si priority n'est pas défini, la macro est ajoutée à la fin de la liste des macros non groupées.
required integer Indique que la macro est obligatoire.

Valeurs possibles :
0 - Non obligatoire ;
1 - Obligatoire.

Comportement de la propriété :
- pris en charge si type est défini sur "Textbox" ou "List"
regex string Expression régulière permettant de valider la saisie utilisateur dans un champ de zone de texte.

Comportement de la propriété :
- pris en charge si type est défini sur "Textbox"
section_name string Libellé de la section repliable dans laquelle la macro est groupée.

Si section_name n'est pas défini, la macro n'est pas groupée. Les macros non groupées sont affichées en premier ; les macros groupées sont affichées en dessous, triées selon leur priority dans chaque section repliable.
options text Chaîne JSON définissant les éléments de liste ou les valeurs de case à cocher.

Pour les listes : un tableau d'objets avec les propriétés value et text.
Exemple : [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]

Pour les cases à cocher : un objet avec les propriétés checked et unchecked.
Exemple : {"checked": true, "unchecked": false}

Comportement de la propriété :
- obligatoire si type est défini sur "List" ou "Checkbox"