Documentation
Table of Contents
Objeto de macro de usuario
Los siguientes objetos están directamente relacionados con la API usermacro.
Macro global
El objeto macro global tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| globalmacroid | ID | ID de la macro global. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| macro | cadena | Cadena de macro. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| valor | cadena | Valor de la macro. Comportamiento de la propiedad: - solo escritura si tipo está establecido en " Macro secreta"- obligatoria para operaciones de creación |
| tipo | entero | Tipo de macro. Valores posibles: 0 - (predeterminado) Macro de texto; 1 - Macro secreta; 2 - Secreto de Vault. |
| descripción | cadena | Descripción de la macro. |
Macro de host
El objeto macro de host define una macro disponible en un host, host prototipo o plantilla. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| hostmacroid | ID | ID de la macro de host. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| hostid | ID | ID del host al que pertenece la macro. Comportamiento de la propiedad: - constante - * requerido* para crear operaciones |
| macro | cadena | Cadena de macro. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| valor | cadena | Valor de la macro. Comportamiento de la propiedad: - solo escritura si tipo está establecido en " Macro secreta"- obligatoria para operaciones de creación |
| tipo | entero | Tipo de macro. Valores posibles: 0 - (predeterminado) Macro de texto; 1 - Macro secreta; 2 - Secreto de Vault. |
| descripción | cadena | Descripción de la macro. |
| automatic | integer | Define si la macro está controlada por la regla de descubrimiento. Valores posibles: 0 - (predeterminado) La macro es administrada por el usuario; 1 - La macro es administrada por el descubrimiento regla. El usuario no puede crear una macro automática. Para actualizar la macro automática, debe convertirse a manual. |
Macro configuration
The macro configuration object defines how a macro is displayed in the Host Wizard.
| Property | Type | Description |
|---|---|---|
| type | integer | Type of macro input field. Possible values: 0 - Macro is not used in Host Wizard; 1 - Textbox; 2 - List; 3 - Checkbox. Property behavior: - required |
| label | string | Label for macro input field. Property behavior: - required if type is set to "Textbox", "List", or "Checkbox" |
| description | text | Help text displayed alongside macro input field. Supports Markdown formatting. |
| priority | integer | Macro input field position in the macro list. If priority is not set, the macro is added at the end of the ungrouped macro list. |
| required | integer | Marks the macro as mandatory. Possible values: 0 - Not mandatory; 1 - Mandatory. Property behavior: - supported if type is set to "Textbox" or "List" |
| regex | string | Regular expression to validate user input in a textbox field. Property behavior: - supported if type is set to "Textbox" |
| section_name | string | Label of the collapsible section where the macro is grouped. If section_name is not set, the macro is ungrouped. Ungrouped macros are displayed first; grouped macros are displayed below, ordered by their priority within each collapsible section. |
| options | text | JSON string defining list items or checkbox values. For lists: an array of objects with value and text properties.Example: [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]For checkboxes: an object with checked and unchecked properties.Example: {"checked": true, "unchecked": false}Property behavior: - required if type is set to "List" or "Checkbox" |