Objeto script

Os seguintes objetos estão diretamente relacionados à API script.

Script

O objeto script tem as seguintes propriedades.

Property Type Description
scriptid ID ID do script.

Comportamento da propriedade:
- somente leitura
- obrigatório para operações de atualização
name string Nome do script.

Comportamento da propriedade:
- obrigatório para operações de criação
type integer Tipo de script.

Valores possíveis se scope estiver definido como "action operation":
0 - Script;
1 - IPMI;
2 - SSH;
3 - TELNET;
5 - Webhook.

Valores possíveis se scope estiver definido como "manual host action" ou "manual event action":
6 - URL.

Comportamento da propriedade:
- obrigatório para operações de criação
command string Comando a ser executado.

Comportamento da propriedade:
- obrigatório se type estiver definido como "Script", "IPMI", "SSH", "TELNET" ou "Webhook"
scope integer Escopo do script.

Valores possíveis:
1 - action operation;
2 - manual host action;
4 - manual event action.

Comportamento da propriedade:
- obrigatório para operações de criação
execute_on integer Local onde o script será executado.

Valores possíveis:
0 - executar no Zabbix agent;
1 - executar no Zabbix server. É suportado somente se a execução de scripts globais estiver habilitada no Zabbix server;
2 - (padrão) executar no Zabbix server ou proxy.

Comportamento da propriedade:
- suportado se type estiver definido como "Script"
menu_path string Pastas separadas por barra que formam uma navegação semelhante a um menu no frontend quando clicadas em um host ou evento.

Comportamento da propriedade:
- suportado se scope estiver definido como "manual host action" ou "manual event action"
authtype integer Método de autenticação usado para scripts do tipo SSH.

Valores possíveis:
0 - senha;
1 - chave pública.

Comportamento da propriedade:
- suportado se type estiver definido como "SSH"
username string Nome de usuário usado para autenticação.

Comportamento da propriedade:
- obrigatório se type estiver definido como "SSH" ou "TELNET"
password string Senha usada para scripts SSH com autenticação por senha e scripts TELNET.

Comportamento da propriedade:
- suportado se type estiver definido como "SSH" e authtype estiver definido como "password", ou se type estiver definido como "TELNET"
publickey string Nome do arquivo de chave pública usado para scripts SSH com autenticação por chave pública.

Comportamento da propriedade:
- obrigatório se type estiver definido como "SSH" e authtype estiver definido como "public key"
privatekey string Nome do arquivo de chave privada usado para scripts SSH com autenticação por chave pública.

Comportamento da propriedade:
- obrigatório se type estiver definido como "SSH" e authtype estiver definido como "public key"
port string Número da porta usado para scripts SSH e TELNET.

Comportamento da propriedade:
- suportado se type estiver definido como "SSH" ou "TELNET"
groupid ID ID do grupo de hosts no qual o script pode ser executado.

Se definido como "0", o script estará disponível em todos os grupos de hosts.

Padrão: 0.
usrgrpid ID ID do grupo de usuários autorizado a executar o script.

Se definido como "0", o script estará disponível para todos os grupos de usuários.

Padrão: 0.

Comportamento da propriedade:
- suportado se scope estiver definido como "manual host action" ou "manual event action"
host_access integer Permissões de host necessárias para executar o script.

Valores possíveis:
2 - (padrão) leitura;
3 - gravação.

Comportamento da propriedade:
- suportado se scope estiver definido como "manual host action" ou "manual event action"
confirmation string Texto da janela pop-up de confirmação.
A janela pop-up será exibida ao tentar executar o script pelo frontend do Zabbix.

Comportamento da propriedade:
- suportado se scope estiver definido como "manual host action" ou "manual event action"
timeout string Tempo limite de execução do script webhook em segundos. Sufixos de tempo são suportados (por exemplo, 30s, 1m).

Valores possíveis: 1-60s.

Padrão: 30s.

Comportamento da propriedade:
- obrigatório se type estiver definido como "Webhook"
parameters array Array de parâmetros de entrada do webhook.

Comportamento da propriedade:
- suportado se type estiver definido como "Webhook"
description string Descrição do script.
url string URL definida pelo usuário.

Comportamento da propriedade:
- obrigatório se type estiver definido como "URL"
new_window integer Abrir a URL em uma nova janela.

Valores possíveis:
0 - Não;
1 - (padrão) Sim.

Comportamento da propriedade:
- suportado se type estiver definido como "URL"
manualinput integer Indica se o script aceita entradas fornecidas pelo usuário.

Valores possíveis:
0 - (padrão) Desabilitado;
1 - Habilitado;

Comportamento da propriedade:
- suportado se scope estiver definido como "manual host action" ou "manual event action"
manualinput_prompt string Texto do prompt de entrada manual.

Comportamento da propriedade:
- obrigatório se manualinput estiver definido como "Enabled"
manualinput_validator string Campo de texto usado para validar a entrada fornecida pelo usuário. A string consiste em uma expressão regular ou em um conjunto de valores separados por vírgulas.

Comportamento da propriedade:
- obrigatório se manualinput estiver definido como "Enabled"
manualinput_validator_type integer Determina o tipo de entrada do usuário esperado.

Valores possíveis:
0 - (padrão) String. Indica que manualinput_validator deve ser tratado como uma expressão regular;
1 - Lista. Indica que manualinput_validator deve ser tratado como uma lista separada por vírgulas de possíveis valores de entrada.

Comportamento da propriedade:
- suportado se manualinput estiver definido como "Enabled"
manualinput_default_value string Valor padrão para preencher automaticamente a entrada do usuário.

Comportamento da propriedade:
- suportado se manualinput_validator_type estiver definido como "String"

Parâmetros do webhook

Os parâmetros passados para o script do webhook quando ele é chamado têm as seguintes propriedades.

Propriedade Tipo Descrição
name string Nome do parâmetro.

Comportamento da propriedade:
- obrigatório
value string Valor do parâmetro. Suporta macros.

Depuração

Informações de depuração do script webhook executado. O objeto de depuração possui as seguintes propriedades.

Propriedade Tipo Descrição
logs array Array de entradas de log.
ms string Duração da execução do script em milissegundos.

Entrada de log

O objeto de entrada de log possui as seguintes propriedades.

Propriedade Tipo Descrição
level integer Nível de log.
ms string O tempo decorrido em milissegundos desde que o script foi executado antes da entrada de log ser adicionada.
message string Mensagem de log.