Table of Contents
Objeto de cenário web
Os seguintes objetos estão diretamente relacionados à API webcheck.
Cenário web
O objeto de cenário web possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| httptestid | ID | ID do cenário web. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| hostid | ID | ID do host ao qual o cenário web pertence. Comportamento da propriedade: - constante - obrigatório para operações de criação |
| name | string | Nome do cenário web. Comportamento da propriedade: - obrigatório para operações de criação |
| agent | string | String do user agent 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) nenhum; 1 - autenticação HTTP básica; 2 - autenticação NTLM. |
| delay | string | Intervalo de execução do cenário web. Aceita segundos ou unidade de tempo com sufixo (ex.: 30s, 1m, 2h, 1d), ou uma macro de usuário. Padrão: 1m. |
| headers | array | Cabeçalhos HTTP que serão enviados ao realizar uma requisição. |
| http_password | string | Senha usada para autenticação HTTP básica ou NTLM. |
| http_proxy | string | Proxy que será usado pelo cenário web, fornecido como http://[usuário[:senha]@]proxy.exemplo.com[:porta]. |
| http_user | string | Nome de usuário usado para autenticação HTTP básica ou NTLM. |
| retries | integer | Número de vezes que um cenário 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 web está habilitado. Valores possíveis: 0 - (padrão) habilitado; 1 - desabilitado. |
| templateid | ID | ID do cenário web do template pai. Comportamento da propriedade: - somente leitura |
| variables | array | Variáveis do cenário web. |
| verify_host | integer | Se deve validar que o nome do host para a conexão corresponde ao do certificado do host. Valores possíveis: 0 - (padrão) ignorar verificação do host; 1 - verificar host. |
| verify_peer | integer | Se deve validar que o certificado do host é autêntico. Valores possíveis: 0 - (padrão) ignorar verificação do par; 1 - verificar par. |
| uuid | string | Identificador global único, usado para vincular cenários web importados a já existentes. Gerado automaticamente, se não fornecido. Comportamento da propriedade: - suportado se o cenário web pertencer a um template |
Etapa do cenário
O objeto de etapa do cenário define uma verificação específica de cenário web. Ele possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome da etapa do cenário. Comportamento da propriedade: - obrigatório |
| no | integer | Número de sequência da etapa em um cenário web. Comportamento da propriedade: - obrigatório |
| url | string | URL a ser verificada. Comportamento da propriedade: - obrigatório |
| follow_redirects | integer | Se deve seguir redirecionamentos HTTP. Valores possíveis: 0 - não seguir redirecionamentos; 1 - (padrão) seguir redirecionamentos. |
| headers | array | Cabeçalhos HTTP que serão enviados ao realizar uma requisição. Os cabeçalhos da etapa do cenário sobrescreverão os cabeçalhos especificados para o cenário web. |
| posts | string/array | Variáveis HTTP POST como uma string (dados brutos do post) ou como um array de campos HTTP (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. Valores possíveis: 0 - (padrão) apenas o corpo; 1 - apenas cabeçalhos; 2 - cabeçalhos e corpo. |
| status_codes | string | Intervalos de códigos de status HTTP necessários, separados por vírgulas. |
| timeout | string | Tempo limite da requisição em segundos. Aceita segundos, unidade de tempo com sufixo ou uma macro de usuário. Padrão: 15s. Máximo: 1h. Mínimo: 1s. |
| variables | array | Variáveis da etapa do cenário. |
| query_fields | array | Campos de consulta - array de campos HTTP que serão adicionados à URL ao realizar uma requisição. |
Campo HTTP
O objeto de campo HTTP define o nome e o valor que são usados para especificar as variáveis do cenário web, cabeçalhos HTTP e campos POST ou campos de consulta. Possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome do cabeçalho/variável/campo POST ou GET. Comportamento da propriedade: - obrigatório |
| value | string | Valor do cabeçalho/variável/campo POST ou GET. Comportamento da propriedade: - obrigatório |
Tag de cenário web
O objeto de tag de cenário web possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| tag | string | Nome da tag do cenário web. Comportamento da propriedade: - obrigatório |
| value | string | Valor da tag do cenário web. |