Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

Objeto 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
- requerido para operaciones de actualización
description string Descripción de la macro.
macro string Cadena de la macro.

Comportamiento de la propiedad:
- requerido para operaciones de creación
type integer Tipo de macro.

Valores posibles:
0 - (por defecto) Macro de texto;
1 - Macro secreta;
2 - Secreto de Vault.
value string Valor de la macro.

Comportamiento de la propiedad:
- solo escritura si type está establecido en "Macro secreta"
- requerido para operaciones de creación

Macro de equipo

El objeto macro de equipo define una macro disponible en un equipo, prototipo de equipo o plantilla. Tiene las siguientes propiedades.

Propiedad Tipo Descripción
hostmacroid ID ID de la macro.

Comportamiento de la propiedad:
- solo lectura
- requerido para operaciones de actualización
automatic integer Define si la macro está controlada por una regla de descubrimiento.

Valores posibles:
0 - (por defecto) La macro es gestionada por el usuario;
1 - La macro es gestionada por la regla de descubrimiento.

No se permite al usuario crear una macro automática.
Para actualizar una macro automática, debe ser convertida a manual.
config object/array Configuración de macro responsable de cómo se muestra la macro en el Asistente de equipo.
description string Descripción de la macro.
hostid ID ID del equipo, prototipo de equipo o plantilla al que pertenece la macro.

Comportamiento de la propiedad:
- constante
- requerido para operaciones de creación
macro string Cadena de la macro.

Comportamiento de la propiedad:
- requerido para operaciones de creación
type integer Tipo de macro.

Valores posibles:
0 - (por defecto) Macro de texto;
1 - Macro secreta;
2 - Secreto de Vault.
value string Valor de la macro.

Comportamiento de la propiedad:
- solo escritura si type está establecido en "Macro secreta"
- requerido para operaciones de creación

Configuración de macro

El objeto de configuración de macro define cómo se muestra una macro en el Asistente de equipos.

Propiedad Tipo Descripción
type integer Tipo de campo de entrada de macro.

Valores posibles:
0 - La macro no se utiliza en el Asistente de equipos;
1 - Cuadro de texto;
2 - Lista;
3 - Casilla de verificación.

Comportamiento de la propiedad:
- obligatorio
label string Etiqueta para el campo de entrada de macro.

Comportamiento de la propiedad:
- obligatorio si type está establecido en "Cuadro de texto", "Lista" o "Casilla de verificación"
description text Texto de ayuda que se muestra junto al campo de entrada de macro. Soporta formato Markdown.
priority integer Posición del campo de entrada de macro en la lista de macros.

Si priority no está establecido, la macro se añade al final de la lista de macros no agrupadas.
required integer Marca la macro como obligatoria.

Valores posibles:
0 - No obligatoria;
1 - Obligatoria.

Comportamiento de la propiedad:
- soportado si type está establecido en "Cuadro de texto" o "Lista"
regex string Expresión regular para validar la entrada del usuario en un campo de cuadro de texto.

Comportamiento de la propiedad:
- soportado si type está establecido en "Cuadro de texto"
section_name string Etiqueta de la sección plegable donde se agrupa la macro.

Si section_name no está establecido, la macro no está agrupada. Las macros no agrupadas se muestran primero; las macros agrupadas se muestran debajo, ordenadas por su priority dentro de cada sección plegable.
options text Cadena JSON que define los elementos de la lista o los valores de la casilla de verificación.

Para listas: un array de objetos con las propiedades value y text.
Ejemplo: [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]

Para casillas de verificación: un objeto con las propiedades checked y unchecked.
Ejemplo: {"checked": true, "unchecked": false}

Comportamiento de la propiedad:
- obligatorio si type está establecido en "Lista" o "Casilla de verificación"