bigip_dns_cache_resolver

Manage BIG-IP DNS resolver caches

Collection: f5networks.f5_modules

Full Name: f5networks.f5_modules.bigip_dns_cache_resolver

Synopsis

Manage BIG-IP DNS resolver caches

Parameters

Name	Type	Required	Description
provider	dict		Execution-host JSON provider: server, user, private password/pass/pwd (pwd overwrites pass); server_port443, validate_certs true, transport rest, timeout and auth_provider. F5_SERVER/F5_SERVER_PORT/F5_USER or ANSIBLE_NET_USERNAME/F5_PASSWORD or ANSIBLE_NET_PASSWORD/F5_VALIDATE_CERTS fallbacks apply only on the execution host. no_f5_teem defaults false; F5_TEEM/F5_TELEMETRY_OFF fallbacks and local/private telemetry policy match the held runtime. Original passwords, aliases, tokens and environment values remain private. No ambient proxy/netrc or redirects.
name	str	yes	Required resource name; absent differs from explicit null, which becomes empty string. Other JSON kinds use Python str/repr. Original converted spelling is sent on create. Fixed generated prepared arguments require unique object keys at every depth; direct native raw JSON preserves duplicate last value at first position. This does not manage DNS Express nameservers, GTM or system DNS.
route_domain	str		Optional core Python string conversion then partition qualification. Numeric-looking strings retain original spelling. Desired values use requested partition; API values use their own partition or Common. Null is unmanaged. No typed integer/range restriction applies.
answer_default_zones	bool		Optional core bool then yes/no strings in API and return values. Null is unmanaged; appliance defaultfalse is not synthesized.
forward_zones	raw		Raw input: nested displayed options do not coerce or validate name/address/port or fill defaults. Null is unmanaged; exact empty string or none clears; [] is a distinct managed empty list. Zones retain raw names and insertion order. Nameservers require address; absent port spells53, explicit null spellsNone, raw string0053 stays0053. Source-formatted address:port strings sort with duplicates retained, then API/report forward_zones repacks them as nameservers:[{name:…}]. Comparison uses stable zone-name sorting and sets, retaining source duplicate/index/unhashable errors. No IP/port/zone/member limit is added. Raw nonfinite names may mutate the appliance then fail the fixed SDK result emitter: delimiter/private stderr/exit1, no result envelope and no unchanged-appliance guarantee.
state	str		present (default) creates or updates; absent deletes and verifies absence. Check mode still authenticates, reads and evaluates reached properties, while skipping writes and delete verification. Diff invents no output. Failure may follow a successful appliance mutation; there is no rollback. Local fixtures are not live BIG-IP/device or custody acceptance.
partition	str		Omitted uses execution-host F5_PARTITION including present-empty, otherwise Common. Explicit null/empty remains empty; only surrounding slashes are stripped. No Common-only policy. Runtime retains inherited bounded JSON/owner profile, original80MiB modeled backing/40MiB modeled work and one original context, with no refill.

Example

yaml

- name: Create a resolver cache with forward zones
  f5networks.f5_modules.bigip_dns_cache_resolver:
    name: dns-resolver
    route_domain: "0"
    answer_default_zones: true
    forward_zones:
      - name: example.test
        nameservers:
          - address: 192.0.2.53
          - address: 192.0.2.54
            port: 5353
    provider:
      server: '{{ bigip_server }}'
      user: '{{ bigip_user }}'
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller choice; runtime default is enabled.
  delegate_to: localhost

- name: Update a resolver cache route
  f5networks.f5_modules.bigip_dns_cache_resolver:
    name: dns-resolver
    route_domain: "/Tenant/7"
    provider:
      server: '{{ bigip_server }}'
      user: '{{ bigip_user }}'
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller choice; runtime default is enabled.
  delegate_to: localhost

- name: Clear the forward zones
  f5networks.f5_modules.bigip_dns_cache_resolver:
    name: dns-resolver
    forward_zones: none
    provider:
      server: '{{ bigip_server }}'
      user: '{{ bigip_user }}'
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller choice; runtime default is enabled.
  delegate_to: localhost

- name: Preview a forward zone update
  f5networks.f5_modules.bigip_dns_cache_resolver:
    name: dns-resolver
    forward_zones:
      - name: example.test
        nameservers:
          - address: 192.0.2.53
            port: 5353
    provider:
      server: '{{ bigip_server }}'
      user: '{{ bigip_user }}'
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller choice; runtime default is enabled.
  check_mode: true
  delegate_to: localhost

- name: Remove and verify the resolver cache
  f5networks.f5_modules.bigip_dns_cache_resolver:
    name: dns-resolver
    state: absent
    provider:
      server: '{{ bigip_server }}'
      user: '{{ bigip_user }}'
      password: '{{ bigip_password }}'
      no_f5_teem: true # Explicit caller choice; runtime default is enabled.
  delegate_to: localhost