netscaler.adc.dnskey (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 key resource.

Inputs

    
src:
    description:
    - 'URL (protocol, host, path, and file name) from where the DNS key file will be imported.
      NOTE: The import fails if the object to be imported is on an HTTPS server that requires
      client certificate authentication for access. This is a mandatory argument'
    type: str

ttl:
    description:
    - Time to Live (TTL), in seconds, for the DNSKEY resource record created in the zone.
      TTL is the time for which the record must be cached by the DNS proxies. If the TTL
      is not specified, either the DNS zone's minimum TTL or the default value of 3600
      is used.
    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

state:
    choices:
    - present
    - absent
    - created
    - imported
    - 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(created), the `create` operation will be applied on the resource.
    - When C(imported), the resource will be imported on the NetScaler ADC node.
    - When C(unset), the resource will be unset on the NetScaler ADC node.
    type: str

units1:
    choices:
    - MINUTES
    - HOURS
    - DAYS
    description:
    - Units for the expiry period.
    type: str

units2:
    choices:
    - MINUTES
    - HOURS
    - DAYS
    description:
    - Units for the notification period.
    type: str

expires:
    description:
    - Time period for which to consider the key valid, after the key is used to sign a
      zone.
    type: float

keyname:
    description:
    - Name of the public-private key pair to publish in the zone.
    type: str

keysize:
    description:
    - Size of the key, in bits.
    type: float

keytype:
    choices:
    - KSK
    - KeySigningKey
    - ZSK
    - ZoneSigningKey
    description:
    - Type of key to create.
    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

password:
    description:
    - Passphrase for reading the encrypted public/private DNS keys
    type: str

zonename:
    description:
    - Name of the zone for which to create a key.
    type: str

algorithm:
    choices:
    - RSASHA1
    - RSASHA256
    - RSASHA512
    description:
    - Algorithm to generate for zone signing.
    type: str

publickey:
    description:
    - File name of the public key.
    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

privatekey:
    description:
    - File name of the private key.
    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

filenameprefix:
    description:
    - Common prefix for the names of the generated public and private key files and the
      Delegation Signer (DS) resource record. During key generation, the .key, .private,
      and .ds suffixes are appended automatically to the file name prefix to produce the
      names of the public key, the private key, and the DS record, respectively.
    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

notificationperiod:
    description:
    - Time at which to generate notification of key expiration, specified as number of
      days, hours, or minutes before expiry. Must be less than the expiry period. The
      notification is an SNMP trap sent to an SNMP manager. To enable the appliance to
      send the trap, enable the DNSKEY-EXPIRY SNMP alarm.
    type: float

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