Objeto tipo de medio

Los siguientes objetos están directamente relacionados con la API mediatype.

Tipo de medio

El objeto tipo de medio tiene las siguientes propiedades.

Property Type Description
mediatypeid ID ID del tipo de medio.

Property behavior:
- solo lectura
- obligatorio para operaciones de actualización
name string Nombre del tipo de medio.

Property behavior:
- obligatorio para operaciones de creación
type integer Transporte utilizado por el tipo de medio.

Valores posibles:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Property behavior:
- obligatorio para operaciones de creación
exec_path string Nombre del archivo de script (por ejemplo, notification.sh) que se encuentra en el directorio especificado en el parámetro de configuración del server AlertScriptsPath.

Property behavior:
- obligatorio si type está establecido en "Script"
gsm_modem string Nombre del dispositivo serie del módem GSM.

Property behavior:
- obligatorio si type está establecido en "SMS"
passwd string Contraseña de autenticación.

Property behavior:
- compatible si smtp_authentication está establecido en "Normal password"
provider integer Proveedor de correo electrónico.

Valores posibles:
0 - (predeterminado) SMTP genérico;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string Dirección de correo electrónico desde la que se enviarán las notificaciones.

Property behavior:
- obligatorio si type está establecido en "Email"
smtp_helo string SMTP HELO.

Property behavior:
- compatible si type está establecido en "Email"
smtp_server string SMTP server.

Property behavior:
- obligatorio si type está establecido en "Email"
smtp_port integer Puerto del SMTP server al que conectarse.

Predeterminado: 25.

Property behavior:
- compatible si type está establecido en "Email"
smtp_security integer Nivel de seguridad de la conexión SMTP que se va a usar.

Valores posibles:
0 - (predeterminado) Ninguno;
1 - STARTTLS;
2 - SSL/TLS.

Property behavior:
- compatible si type está establecido en "Email"
smtp_verify_host integer Verificación SSL del host para SMTP.

Valores posibles:
0 - (predeterminado) No;
1 - Sí.

Property behavior:
- compatible si smtp_security está establecido en "STARTTLS" o "SSL/TLS"
smtp_verify_peer integer Verificación SSL del peer para SMTP.

Valores posibles:
0 - (predeterminado) No;
1 - Sí.

Property behavior:
- compatible si smtp_security está establecido en "STARTTLS" o "SSL/TLS"
smtp_authentication integer Método de autenticación SMTP que se va a usar.

Valores posibles:
0 - (predeterminado) Ninguno;
1 - Contraseña normal;
2 - Token OAuth.
La autenticación OAuth no está permitida para el proveedor de correo electrónico Office365 relay.

Property behavior:
- compatible si type está establecido en "Email"
redirection_url string URL del frontend de Zabbix a la que redirigir la autorización OAuth de vuelta.

Predeterminado:
Valor de la propiedad url de la configuración de la API con la parte zabbix.php?action=oauth.authorize

Property behavior:
- obligatorio si smtp_authentication está establecido en "OAuth token"
client_id string El identificador de cliente registrado en el servidor de autorización OAuth.

Property behavior:
- obligatorio si smtp_authentication está establecido en "OAuth token"
client_secret string El secreto de cliente registrado en el servidor de autorización OAuth. Accesible solo para usuarios de tipo Super Admin.

Property behavior:
- obligatorio si smtp_authentication está establecido en "OAuth token"
authorization_url string URL OAuth, con parámetros, para obtener tokens de acceso y actualización.

Property behavior:
- obligatorio si smtp_authentication está establecido en "OAuth token"
token_url string URL OAuth para intercambiar el token de autorización por tokens de acceso y actualización.
Esta URL también es utilizada por el server para actualizar un token de acceso no válido.

Property behavior:
- obligatorio si smtp_authentication está establecido en "OAuth token"
tokens_status integer Máscara de bits sobre el estado de los tokens.

Valores posibles:
0 - (predeterminado) Ambos tokens contienen un valor no válido
1 - El token de acceso contiene un valor válido
2 - El token de actualización contiene un valor válido
3 - Ambos tokens contienen un valor válido.

Property behavior:
- compatible si smtp_authentication está establecido en "OAuth token"
access_token string Valor del token de acceso OAuth.

Property behavior:
- obligatorio si smtp_authentication está establecido en "OAuth token"
access_token_updated timestamp Marca de tiempo de la última modificación de access_token realizada por el server al actualizar con refresh_token o por la API cuando cambian los tokens.

Property behavior:
- compatible si smtp_authentication está establecido en "OAuth token"
access_expires_in integer Tiempo en segundos hasta que access_token quede obsoleto y sea necesario realizar una solicitud a refresh_url.
Lo establece el Zabbix server al actualizar access_token o la API cuando cambian los tokens.

La marca de tiempo se calcula sumando el valor de access_token_updated.

Property behavior:
- compatible si smtp_authentication está establecido en "OAuth token"
refresh_token string Valor del token de actualización OAuth.

Property behavior:
- obligatorio si smtp_authentication está establecido en "OAuth token"
status integer Indica si el tipo de medio está habilitado.

Valores posibles:
0 - (predeterminado) Habilitado;
1 - Deshabilitado.
username string Nombre de usuario.

Property behavior:
- compatible si smtp_authentication está establecido en "Normal password"
maxsessions integer Número máximo de alertas que se pueden procesar en paralelo.

Valores posibles si type está establecido en "SMS": 1.

Valores posibles si type está establecido en "Email", "Script" o "Webhook": 0-100.

Predeterminado: 1.
maxattempts integer Número máximo de intentos para enviar una alerta.

Valores posibles: 1-100.

Predeterminado: 3.
attempt_interval string Intervalo entre reintentos.
Acepta segundos y unidades de tiempo con sufijo.

Valores posibles: 0-1h.

Predeterminado: 10s.
message_format integer Formato del mensaje.

Valores posibles:
0 - Texto sin formato;
1 - (predeterminado) HTML.

Property behavior:
- compatible si type está establecido en "Email"
script text Cuerpo del script de webhook (JavaScript).

Property behavior:
- obligatorio si type está establecido en "Webhook"
timeout string Tiempo de espera del script de webhook.
Acepta segundos y unidades de tiempo con sufijo.

Valores posibles: 1-60s.

Predeterminado: 30s.

Property behavior:
- compatible si type está establecido en "Webhook"
process_tags integer Procesa los valores de las propiedades JSON en la respuesta del script de webhook como etiquetas. Estas etiquetas se añaden a cualquier etiqueta de problema existente.

Valores posibles:
0 - (predeterminado) Ignorar la respuesta del script de webhook;
1 - Procesar la respuesta del script de webhook como etiquetas.

Property behavior:
- compatible si type está establecido en "Webhook"
show_event_menu integer Incluye una entrada en el event menu que enlaza a una URL personalizada. También añade la propiedad urls a la salida de problem.get y event.get.

Valores posibles:
0 - (predeterminado) No incluir la entrada del event menu ni la propiedad urls;
1 - Incluir la entrada del event menu y la propiedad urls.

Property behavior:
- compatible si type está establecido en "Webhook"
event_menu_url string URL utilizada en la entrada del event menu y en la propiedad urls devuelta por problem.get y event.get.

Property behavior:
- compatible si show_event_menu está establecido en "Include event menu entry and urls property"
event_menu_name string Nombre utilizado para la entrada del event menu y en la propiedad urls devuelta por problem.get y event.get.

Property behavior:
- compatible si show_event_menu está establecido en "Include event menu entry and urls property"
parameters array Parámetros de Webhook o script.

Property behavior:
- compatible si type está establecido en "Webhook" o "Script"
description text Descripción del tipo de medio.

Parámetros de webhook

Los parámetros de webhook tienen las siguientes propiedades.

Propiedad Tipo Descripción
name string Nombre del parámetro.

Comportamiento de la propiedad:
- obligatorio
value string Valor del parámetro, admite macros.
Las macros admitidas se describen en la página Macros admitidas.

Parámetros de script

Los parámetros de script tienen las siguientes propiedades.

Propiedad Tipo Descripción
sortorder integer El orden en el que los valores de los parámetros se pasarán al script como argumentos de línea de comandos, comenzando con 0 como el primero.

Comportamiento de la propiedad:
- requerido
value string Valor del parámetro, admite macros.
Las macros admitidas se describen en la página Macros soportadas.

Plantilla de mensaje

El objeto de plantilla de mensaje define una plantilla que se utilizará como mensaje por defecto para las operaciones de acción para enviar una notificación. Tiene las siguientes propiedades.

Propiedad Tipo Descripción
eventsource integer Fuente del evento.

Valores posibles:
0 - Triggers;
1 - Descubrimiento;
2 - Autoregistro;
3 - Interno;
4 - Servicios.

Comportamiento de la propiedad:
- obligatorio
recovery integer Modo de operación.

Valores posibles:
0 - Operaciones;
1 - Operaciones de recuperación;
2 - Operaciones de actualización.

Comportamiento de la propiedad:
- obligatorio
subject string Asunto del mensaje.
message string Texto del mensaje.