用户宏对象
以下对象均与 usermacro 接口相关 。
全局宏
全局宏对象具有以下属性。
| 属性 | 类型 | 描述 |
|---|---|---|
| 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 设置为“密文宏”时为 只写- 创建操作时必填 |
宏配置
宏配置对象定义了宏在 主机向导 中的显示方式。
| Property | Type | Description |
|---|---|---|
| type | integer | 宏输入字段的类型。 可能的值： 0 - 宏不在主机向导中使用； 1 - 文本框； 2 - 列表； 3 - 复选框。 Property behavior： - required |
| label | string | 宏输入字段的标签。 Property behavior： - 如果 type 设置为“Textbox”、“List”或“Checkbox”，则为 required |
| description | text | 显示在宏输入字段旁边的帮助文本。支持 Markdown 格式。 |
| priority | integer | 宏输入字段在宏列表中的位置。 如果未设置 priority，则该宏会被添加到未分组宏列表的末尾。 |
| required | integer | 将宏标记为必填。 可能的值： 0 - 非必填； 1 - 必填。 Property behavior： - 如果 type 设置为“Textbox”或“List”，则 supported |
| regex | string | 用于验证文本框字段中用户输入内容的正则表达式。 Property behavior： - 如果 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}Property behavior： - 如果 type 设置为“List”或“Checkbox”，则为 required |