User macroオブジェクト

次のオブジェクトは、usermacroAPIに直接関連しています。

グローバルマクロ

グローバルマクロオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
globalmacroid ID グローバルマクロのID。

Property behavior:
- read-only
- 更新操作では required
description string マクロの説明。
macro string マクロ文字列。

Property behavior:
- 作成操作では required
type integer マクロのタイプ。

使用可能な値:
0 - (デフォルト) テキストマクロ;
1 - シークレットマクロ;
2 - Vaultシークレット。
value string マクロの値。

Property behavior:
- type が "Secret macro" に設定されている場合は write-only
- 作成操作では required

ホストマクロ

ホストマクロオブジェクトは、ホスト、ホスト プロトタイプ、またはテンプレートで利用可能なマクロを定義します。以下のプロパティがあります。

Property Type Description
hostmacroid ID マクロのID。

Property behavior:
- read-only
- 更新操作で required
automatic integer マクロがディスカバリルールによって制御されるかどうかを定義します。

使用可能な値:
0 - (default) マクロはユーザーによって管理されます。
1 - マクロはディスカバリルールによって管理されます。

ユーザーは自動マクロを作成できません。
自動マクロを更新するには、これを手動に変換する必要があります。
config object/array Host Wizard でマクロをどのように表示するかを制御する マクロ設定。
description string マクロの説明。
hostid ID このマクロが属するホスト、ホストプロトタイプ、またはテンプレートのID。

Property behavior:
- constant
- 作成操作で required
macro string マクロ文字列。

Property behavior:
- 作成操作で required
type integer マクロのタイプ。

使用可能な値:
0 - (default) テキストマクロ。
1 - シークレットマクロ。
2 - Vaultシークレット。
value string マクロの値。

Property behavior:
- type が "Secret macro" に設定されている場合は write-only
- 作成操作で required

マクロ設定

マクロ設定オブジェクトは、ホストウィザードでマクロがどのように表示されるかを定義します。

プロパティ 型 説明
type integer マクロ入力フィールドのタイプ。

使用可能な値:
0 - マクロはホストウィザードで使用されない;
1 - テキストボックス;
2 - リスト;
3 - チェックボックス。

プロパティの動作:
- required
label string マクロ入力フィールドのラベル。

プロパティの動作:
- type が "Textbox"、"List"、または "Checkbox" に設定されている場合は required
description text マクロ入力フィールドの横に表示されるヘルプテキスト。Markdown形式をサポートします。
priority integer マクロリスト内でのマクロ入力フィールドの位置。

priority が設定されていない場合、マクロはグループ化されていないマクロリストの末尾に追加されます。
required integer マクロを必須としてマークします。

使用可能な値:
0 - 必須ではない;
1 - 必須。

プロパティの動作:
- type が "Textbox" または "List" に設定されている場合は supported
regex string テキストボックスフィールド内のユーザー入力を検証するための正規表現。

プロパティの動作:
- type が "Textbox" に設定されている場合は supported
section_name string マクロがグループ化される折りたたみ可能なセクションのラベル。

section_name が設定されていない場合、マクロはグループ化されません。グループ化されていないマクロが最初に表示され、グループ化されたマクロはその下に、各折りたたみ可能セクション内で priority の順に表示されます。
options text リスト項目またはチェックボックスの値を定義するJSON文字列。

リストの場合: value および text プロパティを持つオブジェクトの配列。
例: [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]

チェックボックスの場合: checked および unchecked プロパティを持つオブジェクト。
例: {"checked": true, "unchecked": false}

プロパティの動作:
- type が "List" または "Checkbox" に設定されている場合は required