Nota

Este complemento es parte del colección community.zabbix (versión 1.2.0).

Para instalarlo use: ansible-galaxy collection install community.zabbix.

Para usarlo en un libro de jugadas, especifique: community.zabbix.zabbix_action.

  • Sinopsis
  • Requisitos
  • Parámetros
  • Notas
  • Ejemplos de
  • Valores devueltos

Sinopsis

  • Este módulo le permite crear, modificar y eliminar acciones de Zabbix.

Requisitos

Los siguientes requisitos son necesarios en el host que ejecuta este módulo.

  • zabbix-api> = 0.5.4

Parámetros

Parámetro Opciones / Valores predeterminados Comentarios
reconocer_mensaje_predeterminadocuerda Actualizar el texto del mensaje de operación (conocida como “Operación de reconocimiento” antes de Zabbix 4.0). Con> = Zabbix 5.0, este campo se elimina de la API y el módulo lo elimina silenciosamente. Funciona solo con> = Zabbix 3.4 y
reconocer_subjeto_predeterminadocuerda Asunto del mensaje de la operación de actualización (conocida como “Operación de reconocimiento” antes de Zabbix 4.0). Con> = Zabbix 5.0, este campo se elimina de la API y el módulo lo elimina silenciosamente. Funciona solo con> = Zabbix 3.4 y
reconocer_operacioneslista / elementos = cadena Lista de operaciones de reconocimiento Las operaciones de reconocimiento de acciones se conocen como operaciones de actualización desde Zabbix 4.0.Suboptions son los mismos que para operaciones.Funciona solo con> = Zabbix 3.4
alias: update_operations
condicioneslista / elementos = diccionario Lista de condiciones para usar para filtrar resultados.Para obtener más información sobre las subopciones de esta opción, consulte la documentación de la API de Zabbix https://www.zabbix.com/documentation/5.0/manual/api/reference/action/object#action_filter_condition
formulaidcuerda ID único arbitrario que se usa para hacer referencia a la condición de una expresión personalizada. Solo puede contener letras mayúsculas. Se requiere para filtros de expresión personalizados y se ignora en caso contrario.
operadorcuerda
    Opciones:

  • =
  • <>
  • igual que
  • diferente a
  • en
  • > =
  • <=
  • no en
  • partidos
  • no coincide
  • No
Operador de condición. escribe se establece en time_period, las opciones son in, not in.matches, does not match, Yes y No Los operadores de condición funcionan solo con> = Zabbix 4.0
escribecuerda Tipo (etiqueta) de la condición Valores posibles cuando event_source = disparador: – host_grouphosttriggertrigger_nametrigger_severitytime_periodhost_templateapplicationmaintenance_status conocido en Zabbix 4.0 y superior como “Problema suprimido” – event_tagevent_tag_valueValores posibles cuando event_source = descubrimiento: – host_IPdiscovered_service_typediscovered_service_portdiscovery_statusuptime_or_downtime_durationreceived_valuediscovery_rulediscovery_checkproxydiscovery_objectValores posibles cuando event_source = auto_registration: – proxyhost_namehost_metadataValores posibles cuando event_source = interno: – host_grouphosthost_templateapplicationevent_type
valorcuerda Valor para comparar. type = discovery_status, las opciones son: – updowndiscoveredlostCuando type = descubrimiento_objeto, las opciones son: – hostserviceCuando type = event_type, las opciones son: – item in not supported stateitem in normal stateLLD rule in not supported stateLLD rule in normal statetrigger in unknown statetrigger in normal stateCuando type = trigger_severity, las opciones son (no distinguen entre mayúsculas y minúsculas): – not classifiedinformationwarningaveragehighdisasterIndependientemente de los nombres visibles para el usuario que se cambien en Zabbix. Predeterminado a not classified si se omite Además de las opciones anteriores, suele ser el nombre del objeto o una cadena con la que comparar.
valor2cuerda Valor secundario para comparar. Requerido para acciones de activación cuando la condición type = event_tag_value.
default_messagecuerda Texto predeterminado del mensaje de problema.Con> = Zabbix 5.0, este campo se elimina de la API y el módulo lo elimina silenciosamente.Funciona solo con
tema_predeterminadocuerda Asunto predeterminado del mensaje de problema.Con> = Zabbix 5.0, este campo se elimina de la API y el módulo lo elimina silenciosamente.Funciona solo con
esc_periodcuerda Duración predeterminada del paso de operación. Debe ser superior a 60 segundos. Acepta solo segundos en int para <= Zabbix 3.2Accepts seconds, time unit with suffix and user macro since => Zabbix 3.4 Requerido cuando state=present.
eval_typecuerda
    Opciones:

  • andor
  • y
  • o
  • expresión_personalizada
Método de evaluación de la condición del filtro. andor si las condiciones son inferiores a 2 o si fórmula no se especifica. custom_expression cuando se especifica la fórmula.
event_sourcecuerda
    Opciones:

  • desencadenar
  • descubrimiento
  • auto_registration
  • interno
Tipo de eventos que manejará la acción. Requerido cuando state=present.
fórmulacuerda Expresión definida por el usuario que se utilizará para evaluar condiciones con una expresión personalizada. La expresión debe contener ID que hagan referencia a cada condición por su fórmula. Los ID utilizados en la expresión deben coincidir exactamente con los definidos en el condiciones. Ninguna condición puede permanecer sin usar u omitida. eval_type = expresión_personalizada.Utilice ID secuenciales que comiencen en “A”. Si se utilizan ID no secuenciales, Zabbix los vuelve a indexar. Esto hace que cada módulo ejecutado note la diferencia en los ID y actualice la acción.
http_login_passwordcuerda Contraseña de autenticación básica
http_login_usercuerda Inicio de sesión de autenticación básica
contraseña de inicio de sesióncuerda / requerido Contraseña de usuario de Zabbix.
login_usercuerda / requerido Nombre de usuario de Zabbix.
nombrecuerda / requerido Nombre de la acción
operacioneslista / elementos = cadena Lista de operaciones de acción
mandocuerda Comando para correr Requerido cuando tipo = comando_remoto y command_type! = global_script.
command_typecuerda
    Opciones:

  • script_personalizado
  • ipmi
  • ssh
  • telnet
  • global_script
Tipo de comando de operación Requerido cuando tipo = comando_remoto.
esc_periodcuerda Defecto:
“0”
Duración de un paso de escalamiento en segundos. Debe ser mayor de 60 segundos. Acepta solo segundos en int para <= Zabbix 3.2Accepts seconds, time unit with suffix and user macro since => Zabbix 3.4 Si se establece en 0 o 0, se utilizará el período de escalamiento de acción predeterminado.
esc_step_fromcuerda Defecto:
1
Paso desde el que comenzar la escalada.
esc_step_tocuerda Defecto:
1
Paso para finalizar la escalada en. Especifique 0 para infinitamente.
ejecutar_encuerda
    Opciones:

  • agente
  • servidor
  • apoderado
Destino en el que se ejecutará el comando de operación del script personalizado. tipo = comando_remoto y command_type = custom_script.
host_groupslista / elementos = cadena Se debe agregar la lista de grupos de hosts a los que se debe agregar el host. type = add_to_host_group o type = remove_from_host_group.
inventariocuerda
    Opciones:

  • manual
  • automático
Modo de inventario de host Requerido cuando type = set_host_inventory_mode.
tipo de mediocuerda Defecto:
“todos”
Tipo de medio que se utilizará para enviar el mensaje. Se puede utilizar con tipo = enviar_mensaje o tipo = notificar_todos_involucrados dentro reconocer_operaciones.Ajustado a all para todo tipo de medios
mensajecuerda Texto del mensaje de operación. Verificará el ‘mensaje predeterminado’ y usará el texto de default_message si esto y tema_predeterminado no están especificados
condición de operacióncuerda
    Opciones:

  • admitido
  • not_acknowledged
El objeto de condición de operación de acción define una condición que debe cumplirse para realizar la operación actual.
contraseñacuerda Contraseña utilizada para la autenticación Se requiere cuando ssh_auth_type = contraseña o command_type = telnet.Puede usarse cuando tipo = comando_remoto.
Puertocuerda Número de puerto utilizado para la autenticación. Se puede utilizar cuando command_type en [ssh, telnet] y tipo = comando_remoto.
run_on_groupscuerda Grupos de hosts para ejecutar comandos remotos. tipo = comando_remoto y run_on_hosts no está configurado.
run_on_hostscuerda Hosts para ejecutar comandos remotos. tipo = comando_remoto y run_on_groups no está establecido Si se establece en 0, el comando se ejecutará en el host actual.
script_namecuerda El nombre de la secuencia de comandos utilizada para los comandos de secuencia de comandos globales. command_type = global_script.Puede usarse cuando tipo = comando_remoto.
send_to_groupslista / elementos = cadena Grupos de usuarios a los que enviar mensajes.
send_to_userslista / elementos = cadena Usuarios (nombres de usuario o alias) a los que enviar mensajes.
ssh_auth_typecuerda
    Opciones:

  • contraseña
  • Llave pública
Método de autenticación utilizado para los comandos SSH. Requerido cuando tipo = comando_remoto y command_type = ssh.
ssh_privatekey_filecuerda Nombre del archivo de clave privada que se utiliza para los comandos SSH con autenticación de clave pública. ssh_auth_type = public_key.Puede usarse cuando tipo = comando_remoto.
ssh_publickey_filecuerda Nombre del archivo de clave pública utilizado para los comandos SSH con autenticación de clave pública. ssh_auth_type = public_key.Puede usarse cuando tipo = comando_remoto.
temacuerda Asunto del mensaje de operación. Verificará el ‘mensaje predeterminado’ y usará el texto de tema_predeterminado si esto y tema_predeterminado no están especificados
plantillaslista / elementos = cadena Lista de plantillas a las que se debe vincular el host. type = link_to_template o type = unlink_from_template.
escribecuerda
    Opciones:

  • enviar mensaje
  • comando_remoto
  • add_host
  • remove_host
  • add_to_host_group
  • remove_from_host_group
  • link_to_template
  • unlink_from_template
  • enable_host
  • disable_host
  • set_host_inventory_mode
  • notificar_todos_involucrados
Tipo de operación Opciones válidas al configurar el tipo para operaciones_de_recuperación y reconocer_operaciones: – send_messageremote_commandnotify_all_involvedElección notify_all_involved solo soportado en operaciones_de_recuperación y reconocer_operaciones.
nombre de usuariocuerda Nombre de usuario utilizado para la autenticación. Requerido cuando ssh_auth_type en [public_key, password] o command_type = telnet.Puede usarse cuando tipo = comando_remoto.
pause_in_maintenancebooleano
    Opciones:

  • no
Ya sea para pausar la escalada durante los períodos de mantenimiento o no. event_source = disparador.
recovery_default_messagecuerda Texto del mensaje de recuperación. Con> = Zabbix 5.0, este campo se elimina de la API y el módulo lo elimina silenciosamente. Funciona solo con> = Zabbix 3.2 y
recovery_default_subjectcuerda Asunto del mensaje de recuperación. Con> = Zabbix 5.0, este campo se elimina de la API y el módulo lo elimina silenciosamente. Funciona solo con> = Zabbix 3.2 y
operaciones_de_recuperaciónlista / elementos = cadena Lista de operaciones de recuperación.Suboptions son los mismos que para operaciones.Funciona solo con> = Zabbix 3.2
server_urlcuerda / requerido URL del servidor Zabbix, con protocolo (http o https). url es un alias para server_url.
alias: url
estadocuerda
    Opciones:

  • regalo
  • ausente
Estado de la acción. present, creará una acción si no existe o actualizará la acción si los datos asociados son diferentes. absent, eliminará la acción si existe.
estadocuerda
    Opciones:

  • activado
  • discapacitado
Estado de la acción.
se acabó el tiempoentero Defecto:
10
El tiempo de espera de la solicitud de API (segundos).
validate_certsbooleano
    Opciones:

  • no
Si se establece en False, los certificados SSL no se validarán. Esto solo debe usarse en sitios controlados personalmente que utilicen certificados autofirmados.

Notas

Nota

  • Solo se admite Zabbix> = 3.0.
  • Si utiliza login_password = zabbix, la palabra “zabbix” se sustituye por “****”En toda la salida del módulo, porque contraseña de inicio de sesión usos no_log. Ver estas preguntas frecuentes para más información.

Ejemplos de

# Trigger action with only one condition-name: Deploy trigger action
  community.zabbix.zabbix_action:server_url:"http://zabbix.example.com/zabbix/"login_user: Admin
    login_password: secret
    name:"Send alerts to Admin"event_source:'trigger'state: present
    status: enabled
    esc_period:60conditions:-type:'trigger_severity'operator:'>='value:'Information'operations:-type: send_message
        subject:"Something bad is happening"message:"Come on, guys do something"media_type:'Email'send_to_users:-'Admin'# Trigger action with multiple conditions and operations-name: Deploy trigger action
  community.zabbix.zabbix_action:server_url:"http://zabbix.example.com/zabbix/"login_user: Admin
    login_password: secret
    name:"Send alerts to Admin"event_source:'trigger'state: present
    status: enabled
    esc_period: 1m
    conditions:-type:'trigger_name'operator:'like'value:'Zabbix agent is unreachable'formulaid: A
      -type:'trigger_severity'operator:'>='value:'disaster'formulaid: B
    formula: A or B
    operations:-type: send_message
        media_type:'Email'send_to_users:-'Admin'-type: remote_command
        command:'systemctl restart zabbix-agent'command_type: custom_script
        execute_on: server
        run_on_hosts:-0# Trigger action with recovery and acknowledge operations-name: Deploy trigger action
  community.zabbix.zabbix_action:server_url:"http://zabbix.example.com/zabbix/"login_user: Admin
    login_password: secret
    name:"Send alerts to Admin"event_source:'trigger'state: present
    status: enabled
    esc_period: 1h
    conditions:-type:'trigger_severity'operator:'>='value:'Information'operations:-type: send_message
        subject:"Something bad is happening"message:"Come on, guys do something"media_type:'Email'send_to_users:-'Admin'recovery_operations:-type: send_message
        subject:"Host is down"message:"Come on, guys do something"media_type:'Email'send_to_users:-'Admin'acknowledge_operations:-type: send_message
        media_type:'Email'send_to_users:-'Admin'

Valores devueltos

Los valores de retorno comunes están documentados aquí, los siguientes son los campos exclusivos de este módulo:

Llave Devuelto Descripción
msgcuerda éxito El resultado de la operación
Muestra:Acción eliminada: registrar servidores web, ID: 0001

Autores

  • Ruben Tsirunyan (@rubentsirunyan)
  • Ruben Harutyunov (@ K-DOT)