netscaler.adc.dnssoarec (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 SOA 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

retry:
    description:
    - Time, in seconds, between retries if a secondary server's attempt to contact the
      primary server for a zone refresh fails.
    type: float

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

domain:
    description:
    - Domain name for which to add the SOA record.
    type: str

expire:
    description:
    - Time, in seconds, after which the zone data on a secondary name server can no longer
      be considered authoritative because all refresh and retry attempts made during the
      period have failed. After the expiry period, the secondary server stops serving
      the zone. Typically one week. Not used by the primary server.
    type: float

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

serial:
    description:
    - The secondary server uses this parameter to determine whether it requires a zone
      transfer from the primary server.
    type: float

contact:
    description:
    - Email address of the contact to whom domain issues can be addressed. In the email
      address, replace the @ sign with a period (.). For example, enter domainadmin.example.com
      instead of domainadmin@example.com.
    type: str

minimum:
    description:
    - Default time to live (TTL) for all records in the zone. Can be overridden for individual
      records.
    type: float

refresh:
    description:
    - Time, in seconds, for which a secondary server must wait between successive checks
      on the value of the serial number.
    type: float

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

ecssubnet:
    description:
    - Subnet for which the cached SOA 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

originserver:
    description:
    - Domain name of the name server that responds authoritatively for the domain.
    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