Table of Contents
User macroオブジェクト
次のオブジェクトは、usermacroAPIに直接関連しています。
グローバルマクロ
グローバルマクロオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| globalmacroid | ID | グローバルマクロのID。 プロパティの動作: - 読み取り専用 - 更新操作では必須 |
| description | string | マクロの説明。 |
| macro | string | マクロ文字列。 プロパティの動作: - 作成操作では必須 |
| type | integer | マクロのタイプ。 可能な値: 0 - (デフォルト) テキストマクロ; 1 - シークレットマクロ; 2 - Vaultシークレット。 |
| value | string | マクロの値。 プロパティの動作: - typeが"シークレットマクロ"の場合は書き込み専用- 作成操作では必須 |
ホストマクロ
ホストマクロオブジェクトは、ホスト、ホストプロトタイプ、またはテンプレートで利用可能なマクロを定義します。以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| hostmacroid | ID | マクロのID。 プロパティの動作: - 読み取り専用 - 更新操作では必須 |
| automatic | integer | マクロがディスカバリールールによって制御されているかどうかを定義します。 可能な値: 0 - (デフォルト) マクロはユーザーによって管理される; 1 - マクロはディスカバリールールによって管理される。 ユーザーは自動マクロを作成できません。 自動マクロを更新するには、手動に変換する必要があります。 |
| config | object/array | ホストウィザードでマクロの表示方法を決定するマクロ設定。 |
| description | string | マクロの説明。 |
| hostid | ID | マクロが属するホスト、ホストプロトタイプ、またはテンプレートのID。 プロパティの動作: - 定数 - 作成操作では必須 |
| macro | string | マクロ文字列。 プロパティの動作: - 作成操作では必須 |
| type | integer | マクロのタイプ。 可能な値: 0 - (デフォルト) テキストマクロ; 1 - シークレットマクロ; 2 - Vaultシークレット。 |
| value | string | マクロの値。 プロパティの動作: - typeが「シークレットマクロ」に設定されている場合は書き込み専用- 作成操作では必須 |
マクロ設定
マクロ設定オブジェクトは、ホストウィザードでマクロがどのように表示されるかを定義します。
| プロパティ | 型 | 説明 |
|---|---|---|
| type | integer | マクロ入力フィールドのタイプ。 設定可能な値: 0 - ホストウィザードでマクロを使用しない; 1 - テキストボックス; 2 - リスト; 3 - チェックボックス。 プロパティの動作: - 必須 |
| label | string | マクロ入力フィールドのラベル。 プロパティの動作: - typeが"Textbox"、"List"、"Checkbox"に設定されている場合は必須 |
| description | text | マクロ入力フィールドの横に表示されるヘルプテキスト。Markdown形式に対応。 |
| priority | integer | マクロリスト内でのマクロ入力フィールドの位置。priorityが設定されていない場合、マクロはグループ化されていないマクロリストの最後に追加されます。 |
| required | integer | マクロを必須としてマークします。 設定可能な値: 0 - 必須ではない; 1 - 必須。 プロパティの動作: - typeが"Textbox"または"List"に設定されている場合にサポート |
| regex | string | テキストボックスフィールドでのユーザー入力を検証するための正規表現。 プロパティの動作: - typeが"Textbox"に設定されている場合にサポート |
| 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"に設定されている場合は必須 |