netscaler.adc.dnszone (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 zone resource.

Inputs

    
nsec:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable nsec generation for dnssec offload.
    type: str

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:
    - ALL
    - ADNS
    - PROXY
    description:
    - 'Type of zone to display. Mutually exclusive with the DNS Zone (zoneName) parameter.
      Available settings function as follows:'
    - '* C(ADNS) - Display all the zones for which the Citrix ADC is authoritative.'
    - '* C(PROXY) - Display all the zones for which the Citrix ADC is functioning as a
      proxy server.'
    - '* C(ALL) - Display all the zones configured on the appliance.'
    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

keyname:
    description:
    - Name of the public/private DNS key pair with which to sign the zone. You can sign
      a zone with up to four keys.
    elements: str
    type: list

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

zonename:
    description:
    - Name of the zone to create.
    type: str

proxymode:
    choices:
    - 'YES'
    - 'NO'
    description:
    - 'Deploy the zone in proxy mode. Enable in the following scenarios:'
    - '* The load balanced DNS servers are authoritative for the zone and all resource
      records that are part of the zone.'
    - '* The load balanced DNS servers are authoritative for the zone, but the Citrix
      ADC owns a subset of the resource records that belong to the zone (partial zone
      ownership configuration). Typically seen in global server load balancing (GSLB)
      configurations, in which the appliance responds authoritatively to queries for GSLB
      domain names but forwards queries for other domain names in the zone to the load
      balanced servers.'
    - In either scenario, do not create the zone's Start of Authority (SOA) and name server
      (NS) resource records on the appliance.
    - Disable if the appliance is authoritative for the zone, but make sure that you have
      created the SOA and NS records on the appliance before you create the zone.
    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

dnssecoffload:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable dnssec offload for this zone.
    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

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