infoblox.nios_modules.nios_dtc_lbdn (1.6.1) — module

Configure Infoblox NIOS DTC LBDN

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

Authors: Mauricio Teixeira (@badnetmask)

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 Load Balanced Domain Name (LBDN) objects from Infoblox NIOS servers. This module manages NIOS C(dtc:lbdn) 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 LBDN
  infoblox.nios_modules.nios_dtc_lbdn:
    name: web.ansible.com
    lb_method: ROUND_ROBIN
    pools:
      - pool: web_pool
    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 a DTC LBDN
  infoblox.nios_modules.nios_dtc_lbdn:
    name: web.ansible.com
    lb_method: ROUND_ROBIN
    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 LBDN from the system
  infoblox.nios_modules.nios_dtc_lbdn:
    name: web.ansible.com
    lb_method: ROUND_ROBIN
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Inputs

    
ttl:
    description:
    - The Time To Live (TTL) value for the DTC LBDN. A 32-bit unsigned integer that represents
      the duration, in seconds, for which the record is valid (cached). Zero indicates
      that the record should not be cached.
    type: int

name:
    description:
    - Specifies the display name of the DTC LBDN, not DNS related.
    required: true
    type: str

pools:
    description:
    - The pools used for load balancing.
    elements: dict
    required: false
    suboptions:
      pool:
        description:
        - Provide the name of the pool to link with
        required: true
        type: str
      ratio:
        default: 1
        description:
        - Provide the weight of the pool
        required: false
        type: int
    type: list

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

types:
    choices:
    - A
    - AAAA
    - CNAME
    - NAPTR
    - SRV
    description:
    - Specifies the list of resource record types supported by LBDN.
    - This option will work properly only if you set the C(wapi_version) variable on your
      C(provider) variable to a number higher than "2.6".
    elements: str
    required: false
    type: list

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

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

patterns:
    description:
    - Specify LBDN wildcards for pattern match.
    elements: str
    required: false
    type: list

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

topology:
    description:
    - Configures the topology rules for the C(TOPOLOGY) load balancing method.
    - Required only when I(lb_method) is set to C(TOPOLOGY).
    required: false
    type: str

lb_method:
    choices:
    - GLOBAL_AVAILABILITY
    - RATIO
    - ROUND_ROBIN
    - TOPOLOGY
    description:
    - Configures the load balancing method. Used to select pool.
    required: true
    type: str

auth_zones:
    description:
    - List of linked authoritative zones.
    - When using I(auth_zones), you must specify at least one I(patterns)
    elements: str
    required: false
    type: list