infoblox.nios_modules.nios_range (1.6.1) — module

Configure Infoblox NIOS network range object

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

Authors: Matthew Dennett (@matthewdennett)

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 range objects from Infoblox NIOS servers. This module manages NIOS DHCP range objects using the Infoblox WAPI interface over REST.

Supports both IPV4 and IPV6 internet protocols.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure a ipv4 reserved range
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    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: Upadtes a ipv4 reserved range
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    new_start: 192.168.10.5
    end: 192.168.10.20
    new_end: 192.168.10.50
    name: Test Range 1
    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: Configure a ipv4 range served by a member
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    member: infoblox1.localdomain
    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: Configure a ipv4 range served by a failover association
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    failover_association: fo_association_01
    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: Configure a ipv4 range with options
  infoblox.nios_modules.nios_range:
    network: 18.10.0.0/24
    network_view: custom
    start_addr: 18.10.0.12
    end_addr: 18.10.0.14
    options:
     - name: domain-name
       value: zone1.com
    comment: Created with Ansible
    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: Configure a ipv4 range served by a MS Server
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    ms_server: dc01.ad.localdomain
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Inputs

    
name:
    description:
    - Congifured the name of the Microsoft scope for the instance of the object on the
      NIOS server.
    type: str

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

member:
    description:
    - The hostname of the Nios member which will be configured to server this object instance.
      Can not be configured when 'ms_server' or 'failover_association' are configured.
    required: false
    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

disable:
    default: false
    description:
    - Determines whether a range is disabled or not. When this is set to False, the range
      is enabled.
    type: bool

network:
    aliases:
    - cidr
    description:
    - Specifies the network to add or remove DHCP range to.  The value should use CIDR
      notation.
    required: true
    type: str

options:
    description:
    - Configures the set of DHCP options to be included as part of the configured network
      instance.  This argument accepts a list of values (see suboptions).  When configuring
      suboptions at least one of C(name) or C(num) must be specified.
    elements: dict
    suboptions:
      name:
        description:
        - The name of the DHCP option to configure. The standard options are C(router),
          C(router-templates), C(domain-name-servers), C(domain-name), C(broadcast-address),
          C(broadcast-address-offset), C(dhcp-lease-time), and C(dhcp6.name-servers).
        type: str
      num:
        description:
        - The number of the DHCP option to configure
        type: int
      use_option:
        default: 'yes'
        description:
        - Only applies to a subset of options (see NIOS API documentation)
        type: bool
      value:
        description:
        - The value of the DHCP option specified by C(name)
        required: true
        type: str
      vendor_class:
        default: DHCP
        description:
        - The name of the space this DHCP option is associated to
        type: str
    type: list

end_addr:
    aliases:
    - end
    - last_addr
    - last
    description:
    - Configures IP address this object instance is to end at. If 'new_end_addr' is defined
      during a create operation this value is overridden with the value of 'new_end_addr'
    required: true
    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

ms_server:
    description:
    - The hostname of the MS member which will be configured to server this object instance.
      Can not be configured when 'member' or 'failover_association' are configured.
    required: false
    type: str

start_addr:
    aliases:
    - start
    - first_addr
    - first
    description:
    - Configures IP address this object instance is to begin from. If 'new_start_addr'
      is defined during a create operation this value is overridden with the value of
      'new_start_addr'
    required: true
    type: str

network_view:
    default: default
    description:
    - Configures the name of the network view to associate with this configured instance.
    type: str

new_end_addr:
    aliases:
    - new_end
    - new_last_addr
    - new_last
    description:
    - Configures IP address to update this object instance to end at.
    required: false
    type: str

new_start_addr:
    aliases:
    - new_start
    - new_first_addr
    - new_first
    description:
    - Configures IP address to update this object instance to begin from.
    required: false
    type: str

failover_association:
    description:
    - The name of the DHCP failover association which will be configured to server this
      object instance. A failover of MS or Nios members can be configured. Can not be
      configured when 'ms_server' or 'member' are configured.
    required: false
    type: str

server_association_type:
    choices:
    - NONE
    - FAILOVER
    - MEMBER
    - FAILOVER_MS
    - MS_SERVER
    description:
    - Configured the type of server association that will be assigned to serve this object
      instance. This value is not required and will be set as needed automatically during
      module execution.
    required: false
    type: str