f5networks.f5_modules.bigip_dns_nameserver (1.28.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manages LTM DNS nameservers on a BIG-IP. These nameservers form part of what is known as DNS Express on a BIG-IP. This module does not configure GTM (DNS module) related functionality, nor does it configure system-level name servers that affect the ability of the base system to resolve DNS names.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a nameserver
  bigip_dns_nameserver:
    name: foo
    address: 10.10.10.10
    service_port: 53
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
name:
    description:
    - Specifies the name of the nameserver.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(present), ensures the resource exists.
    - When C(absent), ensures the resource is removed.
    type: str

address:
    description:
    - Specifies the IP address on which the DNS nameserver (client) or back-end DNS authoritative
      server (DNS Express server) listens for DNS messages.
    - When creating a new nameserver, if this value is not specified, the default is C(127.0.0.1).
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP or the BIG-IQ.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(no), SSL certificates are not validated. Use this only on personally controlled
          sites using self-signed certificates.
        - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

tsig_key:
    description:
    - Specifies the TSIG key the system uses to communicate with this DNS nameserver (client)
      or back-end DNS authoritative server (DNS Express server) for AXFR zone transfers.
    - If the nameserver is a client, then the system uses this TSIG key to verify the
      request and sign the response.
    - If this nameserver is a DNS Express server, then this TSIG key must match the TSIG
      key for the zone on the back-end DNS authoritative server.
    type: str

partition:
    default: Common
    description:
    - Device partition to manage resources on.
    type: str

route_domain:
    description:
    - Specifies the local route domain the DNS nameserver (client) or back-end DNS authoritative
      server (DNS Express server) uses for outbound traffic.
    - When creating a new nameserver, if this value is not specified, the default is C(0).
    type: str

service_port:
    description:
    - Specifies the service port on which the DNS nameserver (client) or back-end DNS
      authoritative server (DNS Express server) listens for DNS messages.
    - When creating a new nameserver, if this value is not specified, the default is C(53).
    type: str

Outputs

address:
  description: Address which the nameserver listens for DNS messages.
  returned: changed
  sample: 127.0.0.1
  type: str
service_port:
  description: Service port on which the nameserver listens for DNS messages.
  returned: changed
  sample: 53
  type: int