infoblox.nios_modules.nios_dtc_topology (1.6.1) — module

Configure Infoblox NIOS DTC Topology

| "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 Topology objects from Infoblox NIOS topologies. This module manages NIOS C(dtc:topology) 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 Topology
  infoblox.nios_modules.nios_dtc_topology:
    name: a_topology
    rules:
      - dest_type: POOL
        destination_link: web_pool1
        return_type: REGULAR
        sources:
          - source_op: IS
            source_type: EA0
            source_value: DC1
      - dest_type: POOL
        destination_link: web_pool2
        return_type: REGULAR
        sources:
          - source_op: IS
            source_type: EA0
            source_value: DC2
    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 topology
  infoblox.nios_modules.nios_dtc_topology:
    name: a_topology
    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 Topology from the system
  infoblox.nios_modules.nios_dtc_topology:
    name: a_topology
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Inputs

    
name:
    description:
    - Specifies the DTC Topology display name.
    required: true
    type: str

rules:
    description:
    - Configures the topology rules
    elements: dict
    suboptions:
      dest_type:
        choices:
        - POOL
        - SERVER
        description:
        - Configures the type of the destination for this DTC Topology Rule.
        required: true
        type: str
      destination_link:
        description:
        - Configures the name of the destination DTC pool or DTC server.
        type: str
      return_type:
        choices:
        - NOERR
        - NXDOMAIN
        - REGULAR
        default: REGULAR
        description:
        - Configures the type of the DNS response for the rule.
        type: str
      sources:
        description:
        - Configures the conditions for matching sources. Should be empty to set the rule
          as default destination.
        elements: dict
        suboptions:
          source_op:
            choices:
            - IS
            - IS_NOT
            description:
            - Configures the operation used to match the value.
            type: str
          source_type:
            choices:
            - CITY
            - CONTINENT
            - COUNTRY
            - EA0
            - EA1
            - EA2
            - EA3
            - SUBDIVISION
            - SUBNET
            description:
            - Configures the source type.
            required: true
            type: str
          source_value:
            description:
            - Configures the source value.
            required: true
            type: str
        type: list
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Configures the intended state of the instance of the object on the NIOS topology.  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

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

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