bigip_dns_nameserver

Manage LTM DNS Express nameservers

Collection: f5networks.f5_modules

Full Name: f5networks.f5_modules.bigip_dns_nameserver

Synopsis

Manage LTM DNS Express nameservers

Parameters

Name	Type	Required	Description
provider	dict		Execution-host connection: server, user, private password/pass/pwd aliases, server_port (443), validate_certs (true), transport (rest), timeout, auth_provider. Host environment fallbacks apply. no_f5_teem defaults false: private fixed-endpoint telemetry is ENABLED unless explicitly opted out.
name	str	yes	LTM DNS Express nameserver name; required by membership, null converts to empty. Original converted name is sent on create. Does not configure GTM or system DNS. Prepared generated arguments require unique object keys at every depth.
address	str		Optional address without IP validation. Create-only default 127.0.0.1. Null is unmanaged; empty is a managed empty string. Containers use Python str/repr.
service_port	str		Create-only default 53. Lazy Unicode base10 integer with optional sign/valid underscores and 4300-digit guard; no port range. Integer 53 converts to string then integer; float 53.0 converts to ‘53.0’ and fails when reached. Null is unmanaged.
route_domain	str		Optional partition-qualified reference. Relative ‘0’ uses requested partition; empty qualifies to /partition/. Create-only default is literal /Common/0 in every partition. Null is unmanaged.
tsig_key	str		Private no_log TSIG reference, qualified by partition unless absolute. Null unmanaged; empty clears. Literal none is a relative name. Original scalar values are gathered for exit privacy before conversion.
state	str		present (default) creates or updates; absent deletes and verifies absence. Check mode reads/evaluates reached properties but skips mutation. Diff adds no output. Failures after mutation may retain appliance effects; no rollback.
partition	str		Omitted uses execution-host F5_PARTITION, including present-empty, otherwise Common. Explicit null/empty stays empty; surrounding slashes stripped. No Common-only restriction.

Example

yaml

- name: Create with DNS Express defaults
  f5networks.f5_modules.bigip_dns_nameserver:
    name: dns-app
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller opt-out; runtime default is enabled.
  delegate_to: localhost

- name: Update address port and route
  f5networks.f5_modules.bigip_dns_nameserver:
    name: dns-app
    address: 10.0.0.1
    service_port: '5353'
    route_domain: '7'
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller opt-out; runtime default is enabled.
  delegate_to: localhost

- name: Clear the TSIG reference
  f5networks.f5_modules.bigip_dns_nameserver:
    name: dns-app
    tsig_key: ''
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller opt-out; runtime default is enabled.
  delegate_to: localhost

- name: Preview a nameserver change
  f5networks.f5_modules.bigip_dns_nameserver:
    name: dns-app
    service_port: '5353'
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller opt-out; runtime default is enabled.
  check_mode: true
  delegate_to: localhost

- name: Delete and verify the nameserver
  f5networks.f5_modules.bigip_dns_nameserver:
    name: dns-app
    state: absent
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller opt-out; runtime default is enabled.
  delegate_to: localhost