[comment]: # translation:outdated

[comment]: # ({8b1700c1-8b1700c1})
# > Objeto de script  
  
Os objetos a seguir estão diretamente relacionados à API `script`.

[comment]: # ({/8b1700c1-8b1700c1})

[comment]: # ({82a38175-9c6db006})
### Script

The script object has the following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|scriptid|string|*(readonly)* ID of the script.|
|**name**<br>(required)|string|Name of the script.|
|**type**<br>(required)|integer|Script type.<br><br>Possible values:<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;<br>3 - Telnet;<br>5 - *(default)* Webhook.|
|**command**<br>(required)|string|Command to run.|
|scope|integer|Script scope.<br><br>Possible values:<br>1 - *default* action operation;<br>2 - manual host action;<br>4 - manual event action.|
|execute\_on|integer|Where to run the script.<br>Used if `type` is `0` (script).<br><br>Possible values:<br>0 - run on Zabbix agent;<br>1 - run on Zabbix server;<br>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.<br>Used if `scope` is `2` or `4`.|
|authtype|integer|Authentication method used for SSH script type.<br>Used if `type` is `2`.<br><br>Possible values:<br>0 - password;<br>1 - public key.|
|username|string|User name used for authentication.<br>Required if `type` is `2` or `3`.|
|password|string|Password used for SSH scripts with password authentication and Telnet scripts.<br>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.<br>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.<br>Required if type is `2` and `authtype` is `1`.|
|port|string|Port number used for SSH and Telnet scripts.<br>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.<br><br>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.<br>Used if `scope` is `2` or `4`.<br><br>Default: 0.|
|host\_access|integer|Host permissions needed to run the script.<br>Used if `scope` is `2` or `4`.<br><br>Possible values:<br>2 - *(default)* read;<br>3 - write.|### Script

O objeto script tem as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|scriptid|string|*(somente leitura)* ID do script.|
|**name**<br>(requerido)|string|Nome do script.|
|**type**<br>(requerido)|integer|Tipo de script.<br><br>Valores possíveis:<br>0 - Script;<br>1 - IPMI;<br>2 - SSH;<br>3 - Telnet;<br>5 - *(padrão)* Webhook.|
|**command**<br>(requerido)|string|Comando para executar.|
|scope|integer|Escopo do script.<br><br>Valores possíveis:<br>1 - operação de ação *padrão*;<br>2 - ação de host manual;<br>4 - ação de evento manual.|
|execute\_on|integer|Onde executar o script.<br>Usado se `type` for `0` (script).<br><br>Valores possíveis:<br>0 - executar no agente Zabbix;<br>1 - executar no servidor Zabbix ;<br>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.<br>Usado se `scope` for `2` ou `4`.|
|authtype|integer|Método de autenticação usado para o tipo de script SSH.<br>Usado se `type` for `2`.<br><br>Valores possíveis:<br>0 - senha;<br>1 - chave pública.|
|username|string|Nome de usuário usado para autenticação.<br>Obrigatório se `type` for `2` ou `3`.|
|password|string|Senha usada para scripts SSH com autenticação de senha e scripts Telnet.<br>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.<br>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.<br>Obrigatório se type for `2` e `authtype` for `1`.|
|port|string|Número da porta usado para scripts SSH e Telnet.<br>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.<br><br>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.<br>Usado se `scope` for `2` ou `4`.<br><br>Padrão: 0.|
|host\_access|integer|Permissões de host necessárias para executar o script.<br>Usado se `scope` for `2` ou `4`.<br><br>Valores possíveis:<br>2 - *(padrão)* Leitura;<br>3 - Escrita.|
|confirmation|string|Texto pop-up de confirmação. O pop-up aparecerá ao tentar executar o script do frontend do Zabbix.<br>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.<br>Obrigatório se `type` for `5`.<br><br>Valores possíveis:<br>1-60s<br><br>Valor padrão:<br>30s|
|parameters|array|Array de [parâmetros de entrada do webhook](parâmetros/manual/api/reference/script/object#Webhook).<br>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.<br>Used if `scope` is `2` or `4`.|
|timeout|string|Webhook script execution timeout in seconds. Time suffixes are supported, e.g. 30s, 1m.<br>Required if `type` is `5`.<br><br>Possible values:<br>1-60s<br><br>Default value:<br>30s|
|parameters|array|Array of [webhook input parameters](/manual/api/reference/script/object#Webhook parameters).<br>Used if `type` is `5`.|
|description|string|Description of the script.|

[comment]: # ({/82a38175-9c6db006})

[comment]: # ({0be157f6-05b0e37d})
### Parâmetros do webhook  
  
Os parâmetros passados ​​para o script de webhook quando ele é chamado têm as seguintes propriedades.  
  
|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|**name**<br>(requerido)|string|Nome do parâmetro.|
|value|string|Valor do parâmetro. Suporta [macros](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/0be157f6-05b0e37d})

[comment]: # ({83e49c48-587d2fd0})
### Debug

Informações de depuração do script de webhook executado. O objeto de depuração tem as seguintes propriedades.  
  
|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|logs|array|Array de [entradas de log](/manual/api/reference/script/object#Log entry).|
|ms|string|Duração da execução do script em milissegundos.|

[comment]: # ({/83e49c48-587d2fd0})

[comment]: # ({63401e0b-8ea23127})
### Entrada de log
  
O objeto de entrada de log tem as seguintes propriedades.  
  
|Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|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.|

[comment]: # ({/63401e0b-8ea23127})