[comment]: # aside: 1
[comment]: # translation:outdated
[comment]: # ({ee4a2645-28092341})
# Oggetto macro utente
I seguenti oggetti sono direttamente correlati all'API `usermacro`.
[comment]: # ({/ee4a2645-28092341})
[comment]: # ({0a76e75e-e654cd12})
### Macro globale
L'oggetto macro globale ha le seguenti proprietà.
|Proprietà|[Tipo](/manual/api/reference_commentary#data-types)|Descrizione|
|--|--|------|
|globalmacroid|ID|ID della macro globale.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *sola lettura*
- *obbligatoria* per le operazioni di aggiornamento|
|description|string|Descrizione della macro.|
|macro|string|Stringa della macro.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* per le operazioni di creazione|
|type|integer|Tipo di macro.
Valori possibili:
0 - *(predefinito)* Macro di testo;
1 - Macro segreta;
2 - Segreto del vault.|
|value|string|Valore della macro.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *sola scrittura* se `type` è impostato su "Macro segreta"
- *obbligatoria* per le operazioni di creazione|
[comment]: # ({/0a76e75e-e654cd12})
[comment]: # ({52a5aa5d-5a3a9f9f})
### Macro host
L'oggetto macro host definisce una macro disponibile su un host, un prototipo di host o un template. Ha le seguenti proprietà.
|Proprietà|[Type](/manual/api/reference_commentary#data-types)|Descrizione|
|--|--|------|
|hostmacroid|ID|ID della macro.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *sola lettura*
- *obbligatoria* per le operazioni di aggiornamento|
|automatic|integer|Definisce se la macro è controllata dalla regola di discovery.
Valori possibili:
0 - *(predefinito)* La macro è gestita dall'utente;
1 - La macro è gestita dalla regola di discovery.
L'utente non può creare una macro automatica.
Per aggiornare una macro automatica, deve essere [convertita in manuale](/manual/api/reference/usermacro/update#change-macro-value-that-was-created-by-discovery-rule).|
|config|object/array|[Configurazione della macro](#macro-configuration) responsabile di come la macro viene visualizzata nel [Host Wizard](/manual/config/hosts/host_wizard#configure-host).|
|description|string|Descrizione della macro.|
|hostid|ID|ID dell'host, del prototipo di host o del template a cui appartiene la macro.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *costante*
- *obbligatoria* per le operazioni di creazione|
|macro|string|Stringa della macro.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* per le operazioni di creazione|
|type|integer|Tipo di macro.
Valori possibili:
0 - *(predefinito)* Macro di testo;
1 - Macro segreta;
2 - Segreto del vault.|
|value|string|Valore della macro.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *sola scrittura* se `type` è impostato su "Macro segreta"
- *obbligatoria* per le operazioni di creazione|
[comment]: # ({/52a5aa5d-5a3a9f9f})
[comment]: # ({17133911-2d3baa1d})
#### Configurazione della macro
L'oggetto di configurazione della macro definisce come una macro viene visualizzata nel [Host Wizard](/manual/config/hosts/host_wizard#configure-host).
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|type|integer|Tipo del campo di input della macro.
Valori possibili:
0 - La macro non viene utilizzata in Host Wizard;
1 - Casella di testo;
2 - Elenco;
3 - Casella di controllo.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required*|
|label|string|Etichetta del campo di input della macro.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* se `type` è impostato su "Textbox", "List" o "Checkbox"|
|description|text|Testo di aiuto visualizzato accanto al campo di input della macro. Supporta la formattazione Markdown.|
|priority|integer|Posizione del campo di input della macro nell'elenco delle macro.
Se `priority` non è impostato, la macro viene aggiunta alla fine dell'elenco delle macro non raggruppate.|
|required|integer|Indica la macro come obbligatoria.
Valori possibili:
0 - Non obbligatoria;
1 - Obbligatoria.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* se `type` è impostato su "Textbox" o "List"|
|regex|string|Espressione regolare per convalidare l'input dell'utente in un campo casella di testo.
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *supported* se `type` è impostato su "Textbox"|
|section\_name|string|Etichetta della sezione comprimibile in cui la macro è raggruppata.
Se `section_name` non è impostato, la macro non viene raggruppata. Le macro non raggruppate vengono visualizzate per prime; le macro raggruppate vengono visualizzate sotto, ordinate in base alla loro `priority` all'interno di ciascuna sezione comprimibile.|
|options|text|Stringa JSON che definisce gli elementi dell'elenco o i valori della casella di controllo.
Per gli elenchi: un array di oggetti con proprietà `value` e `text`.
Esempio: `[{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]`
Per le caselle di controllo: un oggetto con proprietà `checked` e `unchecked`.
Esempio: `{"checked": true, "unchecked": false}`
[Property behavior](/manual/api/reference_commentary#property-behavior):
- *required* se `type` è impostato su "List" o "Checkbox"|
[comment]: # ({/17133911-2d3baa1d})