[comment]: # aside: 1

[comment]: # translation:outdated

[comment]: # ({ee4a2645-28092341})
# Benutzer-Makro-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der `usermacro` API.

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

[comment]: # ({0a76e75e-e654cd12})
### Globales Makro

Das globale Makro-Objekt hat die folgenden Eigenschaften.

|Eigenschaft|[Typ](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|globalmacroid|ID|ID des globalen Makros.<br><br>[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):<br>- *schreibgeschützt*<br>- *erforderlich* für Aktualisierungsvorgänge|
|description|string|Beschreibung des Makros.|
|macro|string|Makro-Zeichenfolge.<br><br>[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):<br>- *erforderlich* für Erstellungsvorgänge|
|type|integer|Typ des Makros.<br><br>Mögliche Werte:<br>0 - *(Standard)* Textmakro;<br>1 - Geheimes Makro;<br>2 - Vault-Geheimnis.|
|value|string|Wert des Makros.<br><br>[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):<br>- *nur schreibbar*, wenn `type` auf "Geheimes Makro" gesetzt ist<br>- *erforderlich* für Erstellungsvorgänge|

[comment]: # ({/0a76e75e-e654cd12})

[comment]: # ({52a5aa5d-5a3a9f9f})
### Host-Makro

Das Host-Makro-Objekt definiert ein Makro, das auf einem Host, Host-Prototyp oder in einer Vorlage verfügbar ist. Es hat die folgenden Eigenschaften.

|Eigenschaft|[Typ](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|hostmacroid|ID|ID des Makros.<br><br>[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):<br>- *schreibgeschützt*<br>- *erforderlich* für Aktualisierungsvorgänge|
|automatic|integer|Definiert, ob das Makro durch eine Discovery-Regel gesteuert wird.<br><br>Mögliche Werte:<br>0 - *(Standard)* Das Makro wird vom Benutzer verwaltet;<br>1 - Das Makro wird von der Discovery-Regel verwaltet.<br><br>Der Benutzer darf kein automatisches Makro erstellen.<br>Um ein automatisches Makro zu aktualisieren, muss es [in ein manuelles Makro umgewandelt werden](/manual/api/reference/usermacro/update#change-macro-value-that-was-created-by-discovery-rule).|
|config|object/array|[Makrokonfiguration](#macro-configuration), die dafür verantwortlich ist, wie das Makro im [Host Wizard](/manual/config/hosts/host_wizard#configure-host) angezeigt wird.|
|description|string|Beschreibung des Makros.|
|hostid|ID|ID des Hosts, Host-Prototyps oder der Vorlage, zu dem bzw. zu der das Makro gehört.<br><br>[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):<br>- *konstant*<br>- *erforderlich* für Erstellungsvorgänge|
|macro|string|Makro-String.<br><br>[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):<br>- *erforderlich* für Erstellungsvorgänge|
|type|integer|Typ des Makros.<br><br>Mögliche Werte:<br>0 - *(Standard)* Textmakro;<br>1 - Geheimes Makro;<br>2 - Vault-Geheimnis.|
|value|string|Wert des Makros.<br><br>[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):<br>- *nur schreibbar*, wenn `type` auf "Secret macro" gesetzt ist<br>- *erforderlich* für Erstellungsvorgänge|

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

[comment]: # ({17133911-2d3baa1d})
#### Makrokonfiguration

Das Makrokonfigurationsobjekt definiert, wie ein Makro im [Host Wizard](/manual/config/hosts/host_wizard#configure-host) angezeigt wird.

|Eigenschaft|[Typ](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|type|integer|Typ des Makro-Eingabefelds.<br><br>Mögliche Werte:<br>0 - Makro wird im Host Wizard nicht verwendet;<br>1 - Textfeld;<br>2 - Liste;<br>3 - Kontrollkästchen.<br><br>[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):<br>- *erforderlich*|
|label|string|Beschriftung für das Makro-Eingabefeld.<br><br>[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):<br>- *erforderlich*, wenn `type` auf "Textbox", "List" oder "Checkbox" gesetzt ist|
|description|text|Hilfetext, der neben dem Makro-Eingabefeld angezeigt wird. Unterstützt Markdown-Formatierung.|
|priority|integer|Position des Makro-Eingabefelds in der Makroliste.<br><br>Wenn `priority` nicht gesetzt ist, wird das Makro am Ende der nicht gruppierten Makroliste hinzugefügt.|
|required|integer|Kennzeichnet das Makro als obligatorisch.<br><br>Mögliche Werte:<br>0 - Nicht obligatorisch;<br>1 - Obligatorisch.<br><br>[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):<br>- *unterstützt*, wenn `type` auf "Textbox" oder "List" gesetzt ist|
|regex|string|Regulärer Ausdruck zur Validierung der Benutzereingabe in einem Textfeld.<br><br>[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):<br>- *unterstützt*, wenn `type` auf "Textbox" gesetzt ist|
|section\_name|string|Beschriftung des einklappbaren Abschnitts, in dem das Makro gruppiert wird.<br><br>Wenn `section_name` nicht gesetzt ist, wird das Makro nicht gruppiert. Nicht gruppierte Makros werden zuerst angezeigt; gruppierte Makros werden darunter angezeigt und innerhalb jedes einklappbaren Abschnitts nach ihrer `priority` sortiert.|
|options|text|JSON-String zur Definition von Listeneinträgen oder Kontrollkästchenwerten.<br><br>Für Listen: ein Array von Objekten mit den Eigenschaften `value` und `text`.<br>Beispiel: `[{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]`<br><br>Für Kontrollkästchen: ein Objekt mit den Eigenschaften `checked` und `unchecked`.<br>Beispiel: `{"checked": true, "unchecked": false}`<br><br>[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):<br>- *erforderlich*, wenn `type` auf "List" oder "Checkbox" gesetzt ist|

[comment]: # ({/17133911-2d3baa1d})