infoblox.nios_modules.nios_dtc_monitor_http module – Configure Infoblox NIOS DTC HTTP monitors

Note

This module is part of the infoblox.nios_modules collection (version 1.7.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install infoblox.nios_modules. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: infoblox.nios_modules.nios_dtc_monitor_http.

New in infoblox.nios_modules 1.6.0

Synopsis 

Adds and/or removes instances of DTC HTTP monitor objects from Infoblox NIOS servers. This module manages dtc:monitor:http objects using the Infoblox WAPI interface over REST.

Requirements 

The below requirements are needed on the host that executes this module.

infoblox-client

Parameters 

Parameter	Comments
ciphers string	Configures an optional cipher list for the secure HTTP/S connection.
client_cert string	Configures an optional client certificate, supplied in a secure HTTP/S mode if present.
comment string	Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance.
content_check string	Configures the content check type Choices: `"EXTRACT"` `"MATCH"` `"NONE"` ← (default)
content_check_input string	Configures the portion of the response to use as input for content check. Choices: `"ALL"` ← (default) `"BODY"` `"HEADERS"`
content_check_op string	Configures the content check success criteria operator. Choices: `"EQ"` `"GEQ"` `"LEQ"` `"NEQ"`
content_check_regex string	Configures the content check regular expression. Values with leading or trailing white space are not valid for this field.
content_extract_group integer	Configures the content extraction sub-expression to extract. Default: `0`
content_extract_type string	Configures the content extraction expected type for the extracted data. Choices: `"INTEGER"` `"STRING"` ← (default)
content_extract_value string	Configures the content extraction value to compare with the extracted result. Values with leading or trailing white space are not valid for this field.
enable_sni boolean	Configures whether or not Server Name Indication (SNI) for the HTTPS monitor is enabled. Choices: `false` ← (default) `true`
extattrs dictionary	Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration.
interval integer	Configures the interval for HTTP health check. Default: `5`
name string / required	Configures the display name for this DTC monitor. Values with leading or trailing white space are not valid for this field.
port integer	Configures the port value for HTTP requests. Default: `80`
provider dictionary	A dict object containing connection details.
cert string	Specifies the client certificate file with digest of x509 config for extra layer secure connection the remote instance of NIOS. Value can also be specified using `INFOBLOX_CERT` environment variable.
host string	Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST Value can also be specified using `INFOBLOX_HOST` environment variable.
http_pool_connections integer	Insert decription here Default: `10`
http_pool_maxsize integer	Insert description here Default: `10`
http_request_timeout integer	The amount of time before to wait before receiving a response Value can also be specified using `INFOBLOX_HTTP_REQUEST_TIMEOUT` environment variable. Default: `10`
key string	Specifies private key file for encryption with the certificate in order to connect with remote instance of NIOS. Value can also be specified using `INFOBLOX_KEY` environment variable.
max_results integer	Specifies the maximum number of objects to be returned, if set to a negative number the appliance will return an error when the number of returned objects would exceed the setting. Value can also be specified using `INFOBLOX_MAX_RESULTS` environment variable. Default: `1000`
max_retries integer	Configures the number of attempted retries before the connection is declared usable Value can also be specified using `INFOBLOX_MAX_RETRIES` environment variable. Default: `3`
password string	Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_PASSWORD` environment variable.
silent_ssl_warnings boolean	Insert description here Choices: `false` `true` ← (default)
username string	Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_USERNAME` environment variable.
validate_certs aliases: ssl_verify boolean	Boolean value to enable or disable verifying SSL certificates Value can also be specified using `INFOBLOX_SSL_VERIFY` environment variable. Choices: `false` ← (default) `true`
wapi_version string	Specifies the version of WAPI to use Value can also be specified using `INFOBLOX_WAPI_VERSION` environment variable. Until ansible 2.8 the default WAPI was 1.4 Default: `"2.12.3"`
request string	Configures the HTTP request to send Default: `"GET /"`
result string	Configures the type of the expected result Choices: `"ANY"` ← (default) `"CODE_IS"` `"CODE_IS_NOT"`
result_code integer	Configures the expected return code Default: `200`
retry_down integer	Configures the value of how many times the server should appear as down to be treated as dead after it was alive. Default: `1`
retry_up integer	Configures the value of how many times the server should appear as up to be treated as alive after it was dead. Default: `1`
secure boolean	Configures the security status of the connection. Choices: `false` ← (default) `true`
state string	Configures the intended state of the instance of the object on the NIOS server. When this value is set to `present`, the object is configured on the device and when this value is set to `absent` the value is removed (if necessary) from the device. Choices: `"present"` ← (default) `"absent"`
timeout integer	Configures the timeout for HTTP health check in seconds. Default: `15`
validate_cert boolean	Configures whether the validation of the remote server’s certificate is enabled. Choices: `false` `true` ← (default)

Notes 

Note

This module supports check_mode.
This module must be run locally, which can be achieved by specifying connection: local.
Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible.

Examples 

- name: Configure a DTC HTTPS monitor
  infoblox.nios_modules.nios_dtc_monitor_http:
    name: https_monitor
    port: 443
    secure: true
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Add a comment to an existing DTC HTTPS monitor
  infoblox.nios_modules.nios_dtc_monitor_http:
    name: https_monitor
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Remove a DTC HTTPS monitor from the system
  infoblox.nios_modules.nios_dtc_monitor_http:
    name: https_monitor
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Authors

Joachim Buyse (@jbisabel)

infoblox.nios_modules.nios_dtc_monitor_http module – Configure Infoblox NIOS DTC HTTP monitors

Synopsis

Requirements

Parameters

Notes

Examples