netscaler.adc.dnspolicy (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 policy resource.

Inputs

    
drop:
    choices:
    - 'YES'
    - 'NO'
    description:
    - The dns packet must be dropped.
    type: str

name:
    description:
    - Name for the DNS policy.
    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

rule:
    description:
    - Expression against which DNS traffic is evaluated.
    - 'Note:'
    - '* On the command line interface, if the expression includes blank spaces, the entire
      expression must be enclosed in double quotation marks.'
    - '* If the expression itself includes double quotation marks, you must escape the
      quotations by using the  character.'
    - '* Alternatively, you can use single quotation marks to enclose the rule, in which
      case you do not have to escape the double quotation marks.'
    - 'Example: CLIENT.UDP.DNS.DOMAIN.EQ("domainname")'
    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

viewname:
    description:
    - The view name that must be used for the given policy.
    type: str

logaction:
    description:
    - Name of the messagelog action to use for requests that match this policy.
    type: str

actionname:
    description:
    - 'Name of the DNS action to perform when the rule evaluates to TRUE. The built in
      actions function as follows:'
    - '* dns_default_act_Drop. Drop the DNS request.'
    - '* dns_default_act_Cachebypass. Bypass the DNS cache and forward the request to
      the name server.'
    - You can create custom actions by using the add dns action command in the CLI or
      the DNS > Actions > Create DNS Action dialog box in the Citrix ADC configuration
      utility.
    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

cachebypass:
    choices:
    - 'YES'
    - 'NO'
    description:
    - By pass dns cache for this.
    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

preferredloclist:
    description:
    - The location list in priority order used for the given policy.
    elements: str
    type: list

preferredlocation:
    description:
    - The location used for the given policy. This is deprecated attribute. Please use
      -prefLocList
    type: str

dnspolicylabel_dnspolicy_binding:
    description: Bindings for dnspolicylabel_dnspolicy_binding resource
    suboptions:
      binding_members:
        default: []
        description: List of binding members
        elements: dict
        type: list
      mode:
        choices:
        - desired
        - bind
        - unbind
        default: desired
        description:
        - The mode in which to configure the bindings.
        - If mode is set to C(desired), the bindings will be added or removed from the
          target NetScaler ADCs as necessary to match the bindings specified in the state.
        - If mode is set to C(bind), the specified bindings will be added to the resource.
          The existing bindings in the target ADCs will not be modified.
        - If mode is set to C(unbind), the specified bindings will be removed from the
          resource. The existing bindings in the target ADCs will not be modified.
        type: str
    type: dict

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