Zabbix Action

7 min

Resumo

Criar, excluir, atualizar ações do Zabbix.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
name - required	string		Noma da ação
event_source	string	Escolhas: - trigger - discovery - auto_registration - internal	Tipo de eventos que a ação tratará. Obrigatório quando (state = present).
state	string	Escolhas: - present (default) - absent	Estado da ação. Em (present), ele criará uma ação se ela não existir ou atualizar a ação se os dados associados principalmente diferentes. Em (absent), removerá a ação se ela existir.
status	string	Escolhas: - enabled (default) - disabled	Status da ação.
pause_in_maintenance	boolean	Escolhas: - false - true (default	Se deve pausar o escalonamento durante períodos de manutenção ou não. Pode ser usado quando (event_source = trigger).
esc_period	string		Duração padrão da etapa de operação. Deve ser maior que 60 segundos. Obrigatório quando (state = present).
conditions (Possíveis valores)	list / elements = dictionary		Lista de condições a serem usadas para filtrar os resultados. Para obter mais informações sobre subopções desta opção, verifique a documentação do Zabbix API.
eval_type	string	Escolhas: - andor - and - or - custom_expression	Método de avaliação da condição do filtro. O padrão é (andor) se as condições forem menores que 2 ou se (formula) não for especificado. O padrão é (custom_expression) quando a fórmula é especificada.
formula	string		Expressão definida pelo usuário a ser usada para avaliar as condições com uma expressão personalizada. A expressão deve conter IDs que fazem referência a cada condição por seu formulaid. - Os IDs usados na expressão devem corresponder exatamente aos definidos em (conditions). Nenhuma condição pode permanecer sem uso ou omitida. Obrigatório quando (eval_type = custom_expression).
default_message	string		Texto padrão da mensagem de problema.
default_subject	string		Assunto padrão da mensagem de problema.
recovery_default_message	string		Texto da mensagem de recuperação.
recovery_default_subject	string		Assunto da mensagem de recuperação.
acknowledge_default_message	string		Operação de atualização (conhecida como "Acknowledge operation" antes do Zabbix 4.0).
acknowledge_default_subject	string		Assunto da mensagem da operação de atualização (conhecida como "Operação de reconhecimento" antes do Zabbix 4.0).
operations (Possíveis valores)	list		Lista de operações de ação.
recovery_operations	list / elements = string		Lista de operações de recuperação. (Suboptions) são iguais a (operations).
acknowledge_operations aliases: update_operations	list / elements = string		Lista de operações de reconhecimento. As operações de reconhecimento de ação são conhecidas como operações de atualização desde o Zabbix 4.0. (Suboptions) são iguais a (operations).

Subcampos da opção conditions

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
type	string		- Tipo (etiqueta) da condição. - 'Valores possíveis quando (event_source=trigger):' - ' - (host_group)' - ' - (host)' - ' - (trigger)' - ' - (trigger_name)' - ' - (trigger_severity)' - ' - (time_period)' - ' - (host_template)' - ' - (application)' - ' - (maintenance_status) conhecido no Zabbix 4.0 e superior como "Problem is suppressed". - ' - (event_tag)' - ' - (event_tag_value)' - 'Valores possíveis quando (event_source=discovery):' - ' - (host_IP)' - ' - (discovered_service_type)' - ' - (discovered_service_port)' - ' - (discovery_status)' - ' - (uptime_or_downtime_duration)' - ' - (received_value)' - ' - (discovery_rule)' - ' - (discovery_check)' - ' - (proxy)' - ' - (discovery_object)' - 'Valores possíveis quando (event_source=auto_registration):' - ' - (proxy)' - ' - (host_name)' - ' - (host_metadata)' - 'Valores possíveis quando (event_source=internal):' - ' - (host_group)' - ' - (host)' - ' - (host_template)' - ' - (application)' - ' - (event_type)'
value	string		- Valor para comparar. - 'Quando (type=discovery_status), as escolhas são:' - ' - (up)' - ' - (down)' - ' - (discovered)' - ' - (lost)' - 'Quando (type=discovery_object), as escolhas são:' - ' - (host)' - ' - (service)' - 'Quando (type=event_type), as escolhas são:' - ' - (item in not supported state)' - ' - (item in normal state)' - ' - (LLD rule in not supported state)' - ' - (LLD rule in normal state)' - ' - (trigger in unknown state)' - ' - (trigger in normal state)' - 'Quando (type=trigger_severity), as escolhas são (case-insensitive):' - ' - (not classified)' - ' - (information)' - ' - (warning)' - ' - (average)' - ' - (high)' - ' - (disaster)' - Independentemente de nomes visíveis ao usuário sendo alterados no Zabbix. O padrão é (not classified) se omitido. - Além das opções acima, geralmente é o nome do objeto ou uma string para comparação.
value2	string		Valor secundário para comparação. Obrigatório para ações de trigger quando condição (type = event_tag_value).
operator	string	Escolhas: - '=' - '<>' - 'like' - 'not like' - 'in' - '>=' - '<=' - 'not in' - 'matches' - 'does not match' - 'Yes' - 'No'	Operador de condição. Quando (type) é definido como (time_period), as opções são (in), (not in). Os operadores de condição (matches), (does not match), (Yes) e (No) funcionam apenas com Zabbix >= 4.0.
formulaid	string		ID exclusivo arbitrário usado para fazer referência à condição de uma expressão personalizada. Só pode conter letras maiúsculas. Obrigatório para filtros de expressão personalizados e ignorado caso contrário.

Subcampos da opção operations

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
type	string	Escolhas: - send_message - remote_command - 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 - notify_all_involved	Tipo de operação. Escolhas válidas ao definir o tipo para (recovery_operations) e (known_operations): - '- C (send_message)' - '- C (remote_command)' - '- C (notify_all_involved)' - Escolha (notify_all_involved) apenas suportado em (recovery_operations) e (acknowledge_operations).
esc_period	string	- "0s" (default)	Duração de uma etapa de escalonamento em segundos. Deve ser maior que 60 segundos. Aceita apenas segundos em int para Zabbix <= 3.2. Aceita segundos, unidade de tempo com sufixo e macro do usuário desde Zabbix => 3.4. Se definido como 0 ou 0s, o período de escalonamento de ação padrão será usado.
esc_step_from	string	- 1 (default)	Etapa para iniciar o escalonamento.
esc_step_to	string	- 1 (default)	Etapa para encerrar o escalonamento. Especifique 0 para infinitamente.
send_to_groups	list / elements = string		Grupos de usuários para os quais enviar mensagens.
send_to_users	list / elements = string		Usuários (nomes de usuário ou aliases) para os quais enviar mensagens.
message	string		Texto da mensagem de operação. Irá verificar a 'mensagem padrão' e usar o texto de (default_message) se este e (default_subject) não forem especificados.
subject	string		Assunto da mensagem de operação. Irá verificar a 'mensagem padrão' e usar o texto de (default_message) se este e (default_subject) não forem especificados.
media_type	string	- "all" (default)	Tipo de mídia que será usado para enviar a mensagem. Pode ser usado com (type = send_message) ou (type = notify_all_involved) dentro de (acknowledge_operations). Defina como C (all) para todos os tipos de mídia.
operation_condition	string	Escolhas: - acknowledged - not_acknowledged	O objeto de condição de operação de ação define uma condição que deve ser atendida para executar a operação atual.
host_groups	list / elements = string		Lista de grupos de hosts aos quais o host deve ser adicionado. Obrigatório quando (type = add_to_host_group) ou (type = remove_from_host_group).
templates	list / elements = string		Lista de modelos aos quais o host deve estar vinculado. Obrigatório quando (type = link_to_template) ou (type = unlink_from_template).
inventory	string	Escolhas: - manual - automatic	Modo de inventário de host. Obrigatório quando (type = set_host_inventory_mode).
command_type	string	Escolhas: - custom_script - ipmi - ssh - telnet - global_script	Tipo de comando de operação. Obrigatório quando (type = remote_command).
command	string		Comando para executar. Obrigatório quando (type = remote_command) e (command_type! = Global_script).
execute_on	string	Escolhas: - agent - server - proxy	Destino no qual o comando de operação de script personalizado será executado. Obrigatório quando (type = remote_command) e (command_type = custom_script).
run_on_groups	string		Grupos de hosts nos quais executar comandos remotos. Obrigatório quando (type = remote_command) e (run_on_hosts) não está definido.
run_on_hosts	string		Hosts para executar comandos remotos. Obrigatório quando (type = remote_command) e (run_on_groups) não está definido. Se definido como 0, o comando será executado no host atual.
ssh_auth_type	string	Escolhas: - password - public_key	Método de autenticação usado para comandos SSH.Obrigatório quando (type = remote_command) e (command_type = ssh).
ssh_privatekey_file	string		Nome do arquivo de chave privada usado para comandos SSH com autenticação de chave pública. Obrigatório quando (ssh_auth_type = public_key). Pode ser usado quando (type = remote_command).
ssh_publickey_file	string		Nome do arquivo de chave pública usado para comandos SSH com autenticação de chave pública. Obrigatório quando (ssh_auth_type = public_key). Pode ser usado quando (type = remote_command).
username	string		Nome de usuário usado para autenticação. Obrigatório quando (ssh_auth_type em [public_key, password]) ou (command_type = telnet). Pode ser usado quando (type = remote_command).
password	string		Senha usada para autenticação. Obrigatório quando (ssh_auth_type = password) ou (command_type = telnet). Pode ser usado quando (type = remote_command).
port	string		Número da porta usada para autenticação. Pode ser usado quando (command_type em [ssh, telnet]) e (type = remote_command).
script_name	string		O nome do script usado para comandos de script globais. Obrigatório quando (command_type = global_script). - Pode ser usado quando (type = remote_command).

Notas

Suportado somente no Zabbix >= 3.0.

Exemplos

# Exemplo: Acionar ação com apenas uma condição
- 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: 60
    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'

# Exemplo: Acionar ação com várias condições e operações
- 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

# Exemplo: Acionar a ação com operações de recuperação e reconhecimento
- 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 retornados

Chave	Tipo	Retornado quando	Descrição
msg	string	Sucesso	O resultado da operação.