f5networks.f5_modules.bigip_device_dns (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

Manage the DNS settings on a BIG-IP device.

Usage examples

Scanned by Steampunk Spotter

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

- name: Set the DNS settings on the BIG-IP
  bigip_device_dns:
    name_servers:
      - 208.67.222.222
      - 208.67.220.220
    search:
      - localdomain
      - lab.local
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
cache:
    choices:
    - enabled
    - disabled
    - enable
    - disable
    description:
    - Specifies whether the system caches DNS lookups or performs the operation each time
      a lookup is needed. Note this applies only to Access Policy Manager (APM) features,
      such as ACLs, web application rewrites, and authentication.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state of the variable on the system. When C(present), guarantees an existing
      variable is set to C(value).
    type: str

search:
    description:
    - A list of domains the system searches for local domain lookups, to resolve local
      host names.
    elements: str
    type: list

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

ip_version:
    choices:
    - 4
    - 6
    description:
    - Specifies whether the DNS specifies IP addresses using IPv4 or IPv6.
    type: int

name_servers:
    description:
    - A list of name servers the system uses to validate DNS lookups
    elements: str
    type: list

Outputs

cache:
  description: The new value of the DNS caching.
  returned: changed
  sample: enabled
  type: str
ip_version:
  description: IP version that was set, DNS will specify IP addresses in this version.
  returned: changed
  sample: 4
  type: int
name_servers:
  description: List of name servers that were set.
  returned: changed
  sample:
  - 192.0.2.10
  - 172.17.12.10
  type: list
search:
  description: List of search domains that were set.
  returned: changed
  sample:
  - 192.0.2.10
  - 172.17.12.10
  type: list
warnings:
  description: The list of warnings (if any) generated by module based on arguments
  returned: always
  sample:
  - '...'
  - '...'
  type: list