Table of Contents
> Objeto de script
Os objetos a seguir estão diretamente relacionados à API script.
Script
The script object has the following properties.
| Property | Type | Description |
|---|---|---|
| scriptid | string | (readonly) ID of the script. |
| name (required) |
string | Name of the script. |
| type (required) |
integer | Script type. Possible values: 0 - Script; 1 - IPMI; 2 - SSH; 3 - Telnet; 5 - (default) Webhook. |
| command (required) |
string | Command to run. |
| scope | integer | Script scope. Possible values: 1 - default action operation; 2 - manual host action; 4 - manual event action. |
| execute_on | integer | Where to run the script. Used if type is 0 (script).Possible values: 0 - run on Zabbix agent; 1 - run on Zabbix server; 2 - (default) run on Zabbix server (proxy). |
| menu_path | string | Folders separated by slash that form a menu like navigation in frontend when clicked on host or event. Used if scope is 2 or 4. |
| authtype | integer | Authentication method used for SSH script type. Used if type is 2.Possible values: 0 - password; 1 - public key. |
| username | string | User name used for authentication. Required if type is 2 or 3. |
| password | string | Password used for SSH scripts with password authentication and Telnet scripts. Used if type is 2 and authtype is 0 or type is 3. |
| publickey | string | Name of the public key file used for SSH scripts with public key authentication. Required if type is 2 and authtype is 1. |
| privatekey | string | Name of the private key file used for SSH scripts with public key authentication. Required if type is 2 and authtype is 1. |
| port | string | Port number used for SSH and Telnet scripts. Used if type is 2 or 3. |
| groupid | string | ID of the host group that the script can be run on. If set to 0, the script will be available on all host groups. Default: 0. |
| usrgrpid | string | ID of the user group that will be allowed to run the script. If set to 0, the script will be available for all user groups. Used if scope is 2 or 4.Default: 0. |
| host_access | integer | Host permissions needed to run the script. Used if scope is 2 or 4.Possible values: 2 - (default) read; 3 - write. |
O objeto script tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| scriptid | string | (somente leitura) ID do script. |
| name (requerido) |
string | Nome do script. |
| type (requerido) |
integer | Tipo de script. Valores possíveis: 0 - Script; 1 - IPMI; 2 - SSH; 3 - Telnet; 5 - (padrão) Webhook. |
| command (requerido) |
string | Comando para executar. |
| scope | integer | Escopo do script. Valores possíveis: 1 - operação de ação padrão; 2 - ação de host manual; 4 - ação de evento manual. |
| execute_on | integer | Onde executar o script. Usado se type for 0 (script).Valores possíveis: 0 - executar no agente Zabbix; 1 - executar no servidor Zabbix ; 2 - (padrão) roda no servidor Zabbix (proxy). |
| menu_path | string | Pastas separadas por barra que formam um menu como navegação no frontend quando clicado no host ou evento. Usado se scope for 2 ou 4. |
| authtype | integer | Método de autenticação usado para o tipo de script SSH. Usado se type for 2.Valores possíveis: 0 - senha; 1 - chave pública. |
| username | string | Nome de usuário usado para autenticação. Obrigatório se type for 2 ou 3. |
| password | string | Senha usada para scripts SSH com autenticação de senha e scripts Telnet. Usado se type for 2 e authtype for 0 ou type for 3. |
| publickey | string | Nome do arquivo de chave pública usado para scripts SSH com autenticação de chave pública. Obrigatório se type for 2 e authtype for 1. |
| privatekey | string | Nome do arquivo de chave privada usado para scripts SSH com autenticação de chave pública. Obrigatório se type for 2 e authtype for 1. |
| port | string | Número da porta usado para scripts SSH e Telnet. Usado se o tipo for 2 ou 3. |
| groupid | string | 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 | string | ID do grupo de usuários que terá permissão para executar o script. Se definido como 0, o script estará disponível para todos os grupos de usuários. Usado se scope for 2 ou 4.Padrão: 0. |
| host_access | integer | Permissões de host necessárias para executar o script. Usado se scope for 2 ou 4.Valores possíveis: 2 - (padrão) Leitura; 3 - Escrita. |
| confirmation | string | Texto pop-up de confirmação. O pop-up aparecerá ao tentar executar o script do frontend do Zabbix. Usado se scope for 2 ou 4. |
| timeout | string | Tempo limite de execução do script do webhook em segundos. Sufixos de tempo são suportados, por exemplo 30s, 1m. Obrigatório se type for 5.Valores possíveis: 1-60s Valor padrão: 30s |
| parameters | array | Array de parâmetros de entrada do webhook. Usado se type for 5. |
| description | string | Descrição do script. |
| confirmation | string | Confirmation pop up text. The pop up will appear when trying to run the script from the Zabbix frontend. Used if scope is 2 or 4. |
| timeout | string | Webhook script execution timeout in seconds. Time suffixes are supported, e.g. 30s, 1m. Required if type is 5.Possible values: 1-60s Default value: 30s |
| parameters | array | Array of webhook input parameters. Used if type is 5. |
| description | string | Description of the script. |
Parâmetros do webhook
Os parâmetros passados para o script de webhook quando ele é chamado têm as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| name (requerido) |
string | Nome do parâmetro. |
| value | string | Valor do parâmetro. Suporta macros. |
Debug
Informações de depuração do script de webhook executado. O objeto de depuração tem 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 tem 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 que a entrada de log fosse adicionada. |
| message | string | Mensagem de log. |