netscaler.adc.dnsproxyrecords (2.5.1) — module

Configuration for proxy record resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1


Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for proxy record resource.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Sample Playbook for netscaler.adc.dnsproxyrecords
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Flush DNS Proxy records
      delegate_to: localhost
      netscaler.adc.dnsproxyrecords:
        state: flushed

Inputs

    
nsip:
    description:
    - The ip address of the NetScaler ADC appliance where the nitro API calls will be
      made.
    - The port can be specified with the colon (:). E.g. 192.168.1.1:555.
    required: true
    type: str

type:
    choices:
    - A
    - NS
    - CNAME
    - SOA
    - MX
    - AAAA
    - SRV
    - RRSIG
    - NSEC
    - DNSKEY
    - PTR
    - TXT
    - NAPTR
    - CAA
    description:
    - Filter the DNS records to be flushed.e.g flush dns proxyRecords -type C(A)   will
      flush only the C(A) records from the cache.
    type: str

state:
    choices:
    - flushed
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(flushed), the resource will be flushed on the NetScaler ADC node.
    type: str

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

negrectype:
    choices:
    - NXDOMAIN
    - NODATA
    description:
    - Filter the Negative DNS records i.e C(NXDOMAIN) and C(NODATA) entries to be flushed.
      e.g flush dns proxyRecords C(NXDOMAIN) will flush only the C(NXDOMAIN) entries from
      the cache
    type: str

nitro_pass:
    description:
    - The password with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

nitro_user:
    description:
    - The username with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

save_config:
    default: false
    description:
    - If C(true) the module will save the configuration on the NetScaler ADC node if it
      makes any changes.
    - The module will not save the configuration on the NetScaler ADC node if it made
      no changes.
    type: bool

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    required: false
    type: bool

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

Outputs

changed:
  description: Indicates if any change is made by the module
  returned: always
  sample: true
  type: bool
diff:
  description: Dictionary of before and after changes
  returned: always
  sample:
    after:
      key2: pqr
    before:
      key1: xyz
    prepared: changes done
  type: dict
diff_list:
  description: List of differences between the actual configured object and the configuration
    specified in the module
  returned: when changed
  sample:
  - 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
    PQR'
  type: list
failed:
  description: Indicates if the module failed or not
  returned: always
  sample: false
  type: bool
loglines:
  description: list of logged messages by the module
  returned: always
  sample:
  - message 1
  - message 2
  type: list