DTC HTTP Monitor

name

Required

Specifies the display name of the DTC monitor.

port

Optional

Specifies the port number for the HTTP request.
The default value is 80.

ciphers

Optional

Specifies an optional cipher list for the secure HTTP/S connection.

client_cert

Optional

Specifies an optional client certificate, supplied in a secure HTTP or HTTPS mode if present.

content_check

Optional

Specifies the type of content check to use for checking the server response.
The default value is NONE.

content_check_input

Optional

Specifies the portion of the response to use as input for the content check.
The default value is ALL.

content_check_op

Optional

Specifies the operator for the success criteria for the content check.
The default value is ALL.

content_check_regex

Optional

Specifies the content check regular expression.
Values with leading or trailing white space are not valid for this field.

content_extract_group

Optional

Specifies the content extraction sub-expression to extract.
The default value is 0.

content_extract_type

Optional

Specifies the content extraction expected type for the extracted data.
The default value is STRING.

content_extract_value

Optional

Specifies the content extraction value to compare with the extracted result.
Values with leading or trailing white space are not valid for this field.

request

Optional

Specifies the type of the HTTP request to send.
The default type of request is GET.

result

Optional

Specifies the type of the expected result.
The default is ANY.

result_code

Optional

Configures the expected return code.
The default value is 200.

enable_sni

Optional

Specifies whether or not Server Name Indication (SNI) for the HTTPS monitor is enabled.
The default value is false.

secure

Optional

Specifies the security status of the connection.
The default value is false.

validate_cert

Optional

Indicates whether the validation of the remote server's certificate is enabled.
The default value is true.

interval

Optional

Specifies the interval for the HTTP health check.
The interval value is measured from the end of the
previous monitor cycle. The default value is 5.

retry_down

Optional

Specifies the number of times the server should appear as down, for it to be treated as dead after it was alive.
The default value is 1.

retry_up

Optional

Specifies the number of times the server should appear as up, for it to be treated as alive after it was dead.
The default value is 1.

timeout

Optional

Specifies the timeout in seconds for the HTTP health check.
It is the duration that a monitor waits to receive a response after sending a request. If a response is not received, it considers the check as failed.
The default value is 15.

extattrs

Optional

Specifies extensible attributes for the DTC HTTP monitor object.
This field accepts a set of key / value pairs for the configuration.

state

Optional

Specifies the state of the DTC HTTP monitor instance in NIOS. Set one of the following values:

• present (default): Configures the object on the device.

• absent: Removes the object from the device.

comment

Optional

Describes the DTC HTTP monitor object.

provider

Required

A dictionary object that contains the connection details.

• host: DNS host name or IP address to connect to the remote instance of NIOS.

• username: User name to use for authenticating the connection to the remote instance.

• password: Password to use for authenticating the connection to the remote instance.

For information on additional fields you can define, see the list of subparameters in the NIOS Modules for Ansible Collections topic.

connection

Required

The nios_dtc_monitor_http module must be run locally.