infoblox.nios_modules.nios_dtc_monitor_http (1.6.1) — module

Configure Infoblox NIOS DTC HTTP monitors

| "added in version" 1.6.0 of infoblox.nios_modules"

Authors: Joachim Buyse (@jbisabel)

Install collection

Install with ansible-galaxy collection install infoblox.nios_modules:==1.6.1


Add to requirements.yml

  collections:
    - name: infoblox.nios_modules
      version: 1.6.1

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description:
    - Configures the display name for this DTC monitor. Values with leading or trailing
      white space are not valid for this field.
    required: true
    type: str

port:
    default: 80
    description:
    - Configures the port value for HTTP requests.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Configures the intended state of the instance of the object on the NIOS server.  When
      this value is set to C(present), the object is configured on the device and when
      this value is set to C(absent) the value is removed (if necessary) from the device.
    type: str

result:
    choices:
    - ANY
    - CODE_IS
    - CODE_IS_NOT
    default: ANY
    description:
    - Configures the type of the expected result
    type: str

secure:
    default: false
    description:
    - Configures the security status of the connection.
    type: bool

ciphers:
    description:
    - Configures an optional cipher list for the secure HTTP/S connection.
    type: str

comment:
    description:
    - 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.
    type: str

request:
    default: GET /
    description:
    - Configures the HTTP request to send
    type: str

timeout:
    default: 15
    description:
    - Configures the timeout for HTTP health check in seconds.
    type: int

extattrs:
    description:
    - Allows for the configuration of Extensible Attributes on the instance of the object.  This
      argument accepts a set of key / value pairs for configuration.
    type: dict

interval:
    default: 5
    description:
    - Configures the interval for HTTP health check.
    type: int

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      cert:
        description:
        - 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 C(INFOBLOX_CERT) environment variable.
        type: str
      host:
        description:
        - Specifies the DNS host name or address for connecting to the remote instance
          of NIOS WAPI over REST
        - Value can also be specified using C(INFOBLOX_HOST) environment variable.
        type: str
      http_pool_connections:
        default: 10
        description:
        - Insert decription here
        type: int
      http_pool_maxsize:
        default: 10
        description:
        - Insert description here
        type: int
      http_request_timeout:
        default: 10
        description:
        - The amount of time before to wait before receiving a response
        - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
          variable.
        type: int
      key:
        description:
        - Specifies private key file for encryption with the certificate in order to connect
          with remote instance of NIOS.
        - Value can also be specified using C(INFOBLOX_KEY) environment variable.
        type: str
      max_results:
        default: 1000
        description:
        - 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 C(INFOBLOX_MAX_RESULTS) environment variable.
        type: int
      max_retries:
        default: 3
        description:
        - Configures the number of attempted retries before the connection is declared
          usable
        - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable.
        type: int
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote instance
          of NIOS.
        - Value can also be specified using C(INFOBLOX_PASSWORD) environment variable.
        type: str
      silent_ssl_warnings:
        default: true
        description:
        - Insert description here
        type: bool
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          instance of NIOS.
        - Value can also be specified using C(INFOBLOX_USERNAME) environment variable.
        type: str
      validate_certs:
        aliases:
        - ssl_verify
        default: false
        description:
        - Boolean value to enable or disable verifying SSL certificates
        - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable.
        type: bool
      wapi_version:
        default: '2.9'
        description:
        - Specifies the version of WAPI to use
        - Value can also be specified using C(INFOBLOX_WAPI_VERSION) environment variable.
        - Until ansible 2.8 the default WAPI was 1.4
        type: str
    type: dict

retry_up:
    default: 1
    description:
    - Configures the value of how many times the server should appear as up to be treated
      as alive after it was dead.
    type: int

enable_sni:
    default: false
    description:
    - Configures whether or not Server Name Indication (SNI) for the HTTPS monitor is
      enabled.
    type: bool

retry_down:
    default: 1
    description:
    - Configures the value of how many times the server should appear as down to be treated
      as dead after it was alive.
    type: int

client_cert:
    description:
    - Configures an optional client certificate, supplied in a secure HTTP/S mode if present.
    type: str

result_code:
    default: 200
    description:
    - Configures the expected return code
    type: int

content_check:
    choices:
    - EXTRACT
    - MATCH
    - NONE
    default: NONE
    description:
    - Configures the content check type
    type: str

validate_cert:
    default: true
    description:
    - Configures whether the validation of the remote server's certificate is enabled.
    type: bool

content_check_op:
    choices:
    - EQ
    - GEQ
    - LEQ
    - NEQ
    description:
    - Configures the content check success criteria operator.
    type: str

content_check_input:
    choices:
    - ALL
    - BODY
    - HEADERS
    default: ALL
    description:
    - Configures the portion of the response to use as input for content check.
    type: str

content_check_regex:
    description:
    - Configures the content check regular expression. Values with leading or trailing
      white space are not valid for this field.
    type: str

content_extract_type:
    choices:
    - INTEGER
    - STRING
    default: STRING
    description:
    - Configures the content extraction expected type for the extracted data.
    type: str

content_extract_group:
    default: 0
    description:
    - Configures the content extraction sub-expression to extract.
    type: int

content_extract_value:
    description:
    - Configures the content extraction value to compare with the extracted result. Values
      with leading or trailing white space are not valid for this field.
    type: str