netscaler.adc.dnstxtrec (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 TXT record resource.

Inputs

    
ttl:
    description:
    - Time to Live (TTL), in seconds, for the record. TTL is the time for which the record
      must be cached by DNS proxies. The specified TTL is applied to all the resource
      records that are of the same record type and belong to the specified domain name.
      For example, if you add an address record, with a TTL of 36000, to the domain name
      example.com, the TTLs of all the address records of example.com are changed to 36000.
      If the TTL is not specified, the Citrix ADC uses either the DNS zone's minimum TTL
      or, if the SOA record is not available on the appliance, the default value of 3600.
    type: float

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 records to display. Available settings function as follows:'
    - '* C(ADNS) - Display all authoritative address records.'
    - '* C(PROXY) - Display all proxy address records.'
    - '* C(ALL) - Display all address records.'
    type: str

state:
    choices:
    - present
    - absent
    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.
    type: str

domain:
    description:
    - Name of the domain for the TXT record.
    type: str

nodeid:
    description:
    - Unique number that identifies the cluster node.
    type: float

string:
    description:
    - Information to store in the TXT resource record. Enclose the string in single or
      double quotation marks. A TXT resource record can contain up to six strings, each
      of which can contain up to 255 characters. If you want to add a string of more than
      255 characters, evaluate whether splitting it into two or more smaller strings,
      subject to the six-string limit, works for you.
    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

recordid:
    description:
    - Unique, internally generated record ID. View the details of the TXT record to obtain
      its record ID. Mutually exclusive with the string parameter.
    type: float

ecssubnet:
    description:
    - Subnet for which the cached TXT record need to be removed.
    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