Table of Contents
Objeto de escenario web
Los siguientes objetos están directamente relacionados con la API webcheck.
Escenario web
El objeto escenario web tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| httptestid | ID | ID del escenario web. Comportamiento de la propiedad: - solo lectura - requerido para operaciones de actualización |
| hostid | ID | ID del equipo al que pertenece el escenario web. Comportamiento de la propiedad: - constante - requerido para operaciones de creación |
| name | string | Nombre del escenario web. Comportamiento de la propiedad: - requerido para operaciones de creación |
| agent | string | Cadena de agente de usuario que será utilizada por el escenario web. Por defecto: Zabbix |
| authentication | integer | Método de autenticación que será utilizado por el escenario web. Valores posibles: 0 - (por defecto) ninguno; 1 - autenticación HTTP básica; 2 - autenticación NTLM. |
| delay | string | Intervalo de ejecución del escenario web. Acepta segundos o unidad de tiempo con sufijo (por ejemplo, 30s, 1m, 2h, 1d), o una macro de usuario. Por defecto: 1m. |
| headers | array | Cabeceras HTTP que se enviarán al realizar una solicitud. |
| http_password | string | Contraseña utilizada para la autenticación HTTP básica o NTLM. |
| http_proxy | string | Proxy que será utilizado por el escenario web dado como http://[usuario[:contraseña]@]proxy.ejemplo.com[:puerto]. |
| http_user | string | Nombre de usuario utilizado para la autenticación HTTP básica o NTLM. |
| retries | integer | Número de veces que un escenario web intentará ejecutar cada paso antes de fallar. Por defecto: 1. |
| ssl_cert_file | string | Nombre del archivo de certificado SSL utilizado para la autenticación del cliente (debe estar en formato PEM). |
| ssl_key_file | string | Nombre del archivo de clave privada SSL utilizado para la autenticación del cliente (debe estar en formato PEM). |
| ssl_key_password | string | Contraseña de la clave privada SSL. |
| status | integer | Indica si el escenario web está habilitado. Valores posibles: 0 - (por defecto) habilitado; 1 - deshabilitado. |
| templateid | ID | ID del escenario web de la plantilla padre. Comportamiento de la propiedad: - solo lectura |
| variables | array | Variables del escenario web. |
| verify_host | integer | Indica si se debe validar que el nombre del equipo para la conexión coincida con el del certificado del equipo. Valores posibles: 0 - (por defecto) omitir la verificación del equipo; 1 - verificar equipo. |
| verify_peer | integer | Indica si se debe validar que el certificado del equipo sea auténtico. Valores posibles: 0 - (por defecto) omitir la verificación del par; 1 - verificar par. |
| uuid | string | Identificador global único, utilizado para vincular escenarios web importados con los ya existentes. Se genera automáticamente si no se proporciona. Comportamiento de la propiedad: - soportado si el escenario web pertenece a una plantilla |
Paso de escenario
El objeto paso de escenario define una comprobación específica de escenario web. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del paso de escenario. Comportamiento de la propiedad: - obligatorio |
| no | integer | Número de secuencia del paso en un escenario web. Comportamiento de la propiedad: - obligatorio |
| url | string | URL que se comprobará. Comportamiento de la propiedad: - obligatorio |
| follow_redirects | integer | Indica si se deben seguir las redirecciones HTTP. Valores posibles: 0 - no seguir redirecciones; 1 - (por defecto) seguir redirecciones. |
| headers | array | Cabeceras HTTP que se enviarán al realizar una petición. Las cabeceras del paso de escenario sobrescribirán las cabeceras especificadas para el escenario web. |
| posts | string/array | Variables POST HTTP como una cadena (datos post sin procesar) o como un array de campos HTTP (datos de campos de formulario). |
| required | string | Texto que debe estar presente en la respuesta. |
| retrieve_mode | integer | Parte de la respuesta HTTP que el paso de escenario debe recuperar. Valores posibles: 0 - (por defecto) solo cuerpo; 1 - solo cabeceras; 2 - cabeceras y cuerpo. |
| status_codes | string | Rangos de códigos de estado HTTP requeridos, separados por comas. |
| timeout | string | Tiempo de espera de la petición en segundos. Acepta segundos, unidad de tiempo con sufijo o una macro de usuario. Por defecto: 15s. Máximo: 1h. Mínimo: 1s. |
| variables | array | Variables del paso de escenario. |
| query_fields | array | Campos de consulta: array de campos HTTP que se añadirán a la URL al realizar una petición. |
Campo HTTP
El objeto campo HTTP define el nombre y el valor que se utilizan para especificar las variables del escenario web, las cabeceras HTTP y los campos POST o de consulta. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre de la cabecera/variable/campo POST o GET. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor de la cabecera/variable/campo POST o GET. Comportamiento de la propiedad: - obligatorio |
Etiqueta de escenario web
El objeto de etiqueta de escenario web tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tag | string | Nombre de la etiqueta del escenario web. Comportamiento de la propiedad: - requerido |
| value | string | Valor de la etiqueta del escenario web. |