Benutzer-Makro-Objekt

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

Globales Makro

Das globale Makro-Objekt hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
globalmacroid ID ID des globalen Makros.

Verhalten der Eigenschaft:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
description string Beschreibung des Makros.
macro string Makro-Zeichenfolge.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
type integer Typ des Makros.

Mögliche Werte:
0 - (Standard) Textmakro;
1 - Geheimes Makro;
2 - Vault-Geheimnis.
value string Wert des Makros.

Verhalten der Eigenschaft:
- nur schreibbar, wenn type auf "Geheimes Makro" gesetzt ist
- erforderlich für Erstellungsvorgänge

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 Beschreibung
hostmacroid ID ID des Makros.

Verhalten der Eigenschaft:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
automatic integer Definiert, ob das Makro durch eine Discovery-Regel gesteuert wird.

Mögliche Werte:
0 - (Standard) Das Makro wird vom Benutzer verwaltet;
1 - Das Makro wird von der Discovery-Regel verwaltet.

Der Benutzer darf kein automatisches Makro erstellen.
Um ein automatisches Makro zu aktualisieren, muss es in ein manuelles Makro umgewandelt werden.
config object/array Makrokonfiguration, die dafür verantwortlich ist, wie das Makro im Host Wizard 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.

Verhalten der Eigenschaft:
- konstant
- erforderlich für Erstellungsvorgänge
macro string Makro-String.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
type integer Typ des Makros.

Mögliche Werte:
0 - (Standard) Textmakro;
1 - Geheimes Makro;
2 - Vault-Geheimnis.
value string Wert des Makros.

Verhalten der Eigenschaft:
- nur schreibbar, wenn type auf "Secret macro" gesetzt ist
- erforderlich für Erstellungsvorgänge

Makrokonfiguration

Das Makrokonfigurationsobjekt definiert, wie ein Makro im Host Wizard angezeigt wird.

Eigenschaft Typ Beschreibung
type integer Typ des Makro-Eingabefelds.

Mögliche Werte:
0 - Makro wird im Host Wizard nicht verwendet;
1 - Textfeld;
2 - Liste;
3 - Kontrollkästchen.

Eigenschaftsverhalten:
- erforderlich
label string Beschriftung für das Makro-Eingabefeld.

Eigenschaftsverhalten:
- 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.

Wenn priority nicht gesetzt ist, wird das Makro am Ende der nicht gruppierten Makroliste hinzugefügt.
required integer Kennzeichnet das Makro als obligatorisch.

Mögliche Werte:
0 - Nicht obligatorisch;
1 - Obligatorisch.

Eigenschaftsverhalten:
- unterstützt, wenn type auf "Textbox" oder "List" gesetzt ist
regex string Regulärer Ausdruck zur Validierung der Benutzereingabe in einem Textfeld.

Eigenschaftsverhalten:
- unterstützt, wenn type auf "Textbox" gesetzt ist
section_name string Beschriftung des einklappbaren Abschnitts, in dem das Makro gruppiert wird.

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.

Für Listen: ein Array von Objekten mit den Eigenschaften value und text.
Beispiel: [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]

Für Kontrollkästchen: ein Objekt mit den Eigenschaften checked und unchecked.
Beispiel: {"checked": true, "unchecked": false}

Eigenschaftsverhalten:
- erforderlich, wenn type auf "List" oder "Checkbox" gesetzt ist