netscaler.adc.dnsprofile (2.5.1) — module

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 DNS profile resource.

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

state:
    choices:
    - present
    - absent
    - unset
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(present), the resource will be added/updated configured according to the
      module's parameters.
    - When C(absent), the resource will be deleted from the NetScaler ADC node.
    - When C(unset), the resource will be unset 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

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

cacherecords:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Cache resource records in the DNS cache. Applies to resource records obtained through
      proxy configurations only. End resolver and forwarder configurations always cache
      records in the DNS cache, and you cannot disable this behavior. When you disable
      record caching, the appliance stops caching server responses. However, cached records
      are not flushed. The appliance does not serve requests from the cache until record
      caching is enabled again.
    type: str

dnsprofilename:
    description:
    - Name of the DNS profile
    type: str

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

dnserrorlogging:
    choices:
    - ENABLED
    - DISABLED
    description:
    - DNS error logging; if enabled, whenever error is encountered in DNS module reason
      for the error will be logged.
    type: str

dnsquerylogging:
    choices:
    - ENABLED
    - DISABLED
    description:
    - DNS query logging; if enabled, DNS query information such as DNS query id, DNS query
      flags , DNS domain name and DNS query type will be logged
    type: str

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

cacheecsresponses:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Cache DNS responses with EDNS Client Subnet(ECS) option in the DNS cache. When disabled,
      the appliance stops caching responses with ECS option. This is relevant to proxy
      configuration. Enabling/disabling support of ECS option when Citrix ADC is authoritative
      for a GSLB domain is supported using a knob in GSLB vserver. In all other modes,
      ECS option is ignored.
    type: str

dnsextendedlogging:
    choices:
    - ENABLED
    - DISABLED
    description:
    - DNS extended logging; if enabled, authority and additional section in the response
      will be logged.
    type: str

dnsanswerseclogging:
    choices:
    - ENABLED
    - DISABLED
    description:
    - DNS answer section; if enabled, answer section in the response will be logged.
    type: str

dropmultiqueryrequest:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Drop the DNS requests containing multiple queries. When enabled, DNS requests containing
      multiple queries will be dropped. In case of proxy configuration by default the
      DNS request containing multiple queries is forwarded to the backend and in case
      of ADNS and Resolver configuration NOCODE error response will be sent to the client.
    type: str

cachenegativeresponses:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Cache negative responses in the DNS cache. When disabled, the appliance stops caching
      negative responses except referral records. This applies to all configurations -
      proxy, end resolver, and forwarder. However, cached responses are not flushed. The
      appliance does not serve negative responses from the cache until this parameter
      is enabled again.
    type: str

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