Documentation
Table of Contents
> Objeto de cenário Web
Os objetos a seguir estão diretamente relacionados à API webcheck.
Cenário Web
O objeto de cenário da web tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| httptestid | string | (somente leitura) ID do cenário web. |
| hostid (requirido) |
string | ID do host ao qual o cenário da web pertence. |
| name (requirido) |
string | Nome do cenário web. |
| agent | string | String do agente do usuário que será usada pelo cenário web. Padrão: Zabbix |
| authentication | integer | Método de autenticação que será usado pelo cenário web. Valores possíveis: 0 - (padrão) none; 1 - autenticação HTTP básica; 2 - Autenticação NTLM. |
| delay | string | Intervalo de execução do cenário web. Aceita segundos, unidade de tempo com sufixo e macro do usuário.. Padrão: 1m. |
| headers | array de HTTP fields | cabeçalhos HTTP que serão enviados ao realizar uma solicitação. |
| http_password | string | Senha usada para autenticação básica HTTP ou NTLM. |
| http_proxy | string | Proxy que será usado pelo cenário da web dado como http://[username[:password]@]proxy.example.com[:port]. |
| http_user | string | Nome de usuário usado para autenticação HTTP ou NTLM básica. |
| nextcheck | timestamp | (somente leitura) Hora da próxima execução do cenário web. |
| retries | integer | Número de vezes que um cenário da Web tentará executar cada etapa antes de falhar. Padrão: 1. |
| ssl_cert_file | string | Nome do arquivo de certificado SSL usado para autenticação do cliente (deve estar no formato PEM). |
| ssl_key_file | string | Nome do arquivo de chave privada SSL usado para autenticação do cliente (deve estar no formato PEM). |
| ssl_key_password | string | Senha da chave privada SSL. |
| status | integer | Se o cenário da Web está ativado. Os valores possíveis são: 0 - (padrão) Ativado; 1 - Desativado. |
| templateid | string | (somente leitura) ID do cenário Web do modelo pai. |
| variables | array of HTTP fields | Variáveis de cenário web. |
| verify_host | integer | Se deve verificar se o nome do host especificado no certificado SSL corresponde ao usado no cenário. Os valores possíveis são: 0 - (padrão) pular a verificação do host; 1 - verificar host. |
| verify_peer | integer | Se deve verificar o certificado SSL do servidor web. Os valores possíveis são: 0 - (padrão) pular verificação de pares; 1 - verificar par. |
| uuid | string | (somente leitura em cenários da web já existentes) Identificador exclusivo global, usado para vincular cenários Web importados a cenários já existentes. Usado apenas para cenários Web em modelos. |
Cenário Web
O objeto de cenário da web tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| httptestid | string | (somente leitura) ID do cenário web. |
| hostid (requirido) |
string | ID do host ao qual o cenário da web pertence. |
| name (requirido) |
string | Nome do cenário web. |
| agent | string | String do agente do usuário que será usada pelo cenário web. Padrão: Zabbix |
| authentication | integer | Método de autenticação que será usado pelo cenário web. Valores possíveis: 0 - (padrão) none; 1 - autenticação HTTP básica; 2 - Autenticação NTLM. |
| delay | string | Intervalo de execução do cenário web. Aceita segundos, unidade de tempo com sufixo e macro do usuário.. Padrão: 1m. |
| headers | array de HTTP fields | cabeçalhos HTTP que serão enviados ao realizar uma solicitação. |
| http_password | string | Senha usada para autenticação básica HTTP ou NTLM. |
| http_proxy | string | Proxy que será usado pelo cenário da web dado como http://[username[:password]@]proxy.example.com[:port]. |
| http_user | string | Nome de usuário usado para autenticação HTTP ou NTLM básica. |
| nextcheck | timestamp | (somente leitura) Hora da próxima execução do cenário web. |
| retries | integer | Número de vezes que um cenário da Web tentará executar cada etapa antes de falhar. Padrão: 1. |
| ssl_cert_file | string | Nome do arquivo de certificado SSL usado para autenticação do cliente (deve estar no formato PEM). |
| ssl_key_file | string | Nome do arquivo de chave privada SSL usado para autenticação do cliente (deve estar no formato PEM). |
| ssl_key_password | string | Senha da chave privada SSL. |
| status | integer | Se o cenário da Web está ativado. Os valores possíveis são: 0 - (padrão) Ativado; 1 - Desativado. |
| templateid | string | (somente leitura) ID do cenário Web do modelo pai. |
| variables | array of HTTP fields | Variáveis de cenário web. |
| verify_host | integer | Se deve verificar se o nome do host especificado no certificado SSL corresponde ao usado no cenário. Os valores possíveis são: 0 - (padrão) pular a verificação do host; 1 - verificar host. |
| verify_peer | integer | Se deve verificar o certificado SSL do servidor web. Os valores possíveis são: 0 - (padrão) pular verificação de pares; 1 - verificar par. |
| uuid | string | (somente leitura em cenários da web já existentes) Identificador exclusivo global, usado para vincular cenários Web importados a cenários já existentes. Usado apenas para cenários Web em modelos. |
Etapa do cenário
O objeto de etapa de cenário define uma verificação de cenário da web específica. Tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| httpstepid | string | (somente leitura) ID da etapa do cenário. |
| name (requirido) |
string | Nome da etapa do cenário. |
| no (requirido) |
integer | Número de sequência da etapa em um cenário web. |
| url (requirido) |
string | URL a ser verificado. |
| follow_redirects | integer | Se deve seguir redirecionamentos HTTP. Os valores possíveis são: 0 - não siga redirecionamentos; 1 - (padrão) seguir redirecionamentos. |
| headers | array de HTTP fields | Cabeçalhos HTTP que serão enviados ao realizar uma solicitação. Os cabeçalhos das etapas do cenário substituirão os cabeçalhos especificados para o cenário web. |
| httptestid | string | (somente leitura) ID do cenário da web ao qual a etapa pertence. |
| posts | string array de HTTP fields |
Variáveis HTTP POST como uma string (dados brutos de postagem) ou como uma matriz de HTTP fields (dados de campo de formulário). |
| required | string | Texto que deve estar presente na resposta. |
| retrieve_mode | integer | Parte da resposta HTTP que a etapa do cenário deve recuperar. Os valores possíveis são: 0 - (padrão) somente body; 1 - somente headers; 2 - headers e body. |
| status_codes | string | Intervalos de códigos de status HTTP necessários separados por vírgulas. |
| timeout | string | Solicitar tempo limite em segundos. Aceita segundos, unidade de tempo com sufixo e macro do usuário. Padrão: 15s. Máximo: 1h. Mínimo: 1s. |
| variables | array de HTTP fields | Variáveis da etapa do cenário. |
| query_fields | array de HTTP fields | Campos de consulta - array de HTTP fields que será adicionado ao URL ao realizar uma solicitação |
Campo HTTP
O objeto de campo HTTP define um nome e um valor que é usado para especificar a variável, o cabeçalho HTTP, os dados do campo de formulário POST dos dados do campo de consulta. Tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| name (required) |
string | Nome do cabeçalho / variável / Campo POST ou GET. |
| value (required) |
string | Valor do cabeçalho / variável / Campo POST ou GET. |