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

Inputs

    
name:
    description:
    - 'Key name.  This follows the same syntax rules as other expression entity names:'
    - '   It must begin with an alpha character (A-Z or a-z) or an underscore (_).'
    - '   The rest of the characters must be alpha, numeric (0-9) or underscores.'
    - '   It cannot be re or xp (reserved for regular and XPath expressions).'
    - '   It cannot be an expression reserved word (e.g. SYS or HTTP).'
    - '   It cannot be used for an existing expression object (HTTP callout, patset, dataset,
      stringmap, or named expression).'
    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

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

digest:
    choices:
    - MD2
    - MD4
    - MD5
    - SHA1
    - SHA224
    - SHA256
    - SHA384
    - SHA512
    description:
    - Digest (hash) function to be used in the HMAC computation.
    type: str

comment:
    description:
    - Comments associated with this encryption key.
    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

keyvalue:
    description:
    - 'The hex-encoded key to be used in the HMAC computation. The key can be any length
      (up to a Citrix ADC-imposed maximum of 255 bytes). If the length is less than the
      digest block size, it will be zero padded up to the block size. If it is greater
      than the block size, it will be hashed using the digest function to the block size.
      The block size for each digest is:'
    - '   MD2    - 16 bytes'
    - '   MD4    - 16 bytes'
    - '   MD5    - 16 bytes'
    - '   SHA1   - 20 bytes'
    - '   SHA224 - 28 bytes'
    - '   SHA256 - 32 bytes'
    - '   SHA384 - 48 bytes'
    - '   SHA512 - 64 bytes'
    - Note that the key will be encrypted when it it is saved
    - ''
    - There is a special key value AUTO which generates a new random key for the specified
      digest. This kind of key is
    - intended for use cases where the NetScaler both generates and verifies an HMAC on  the
      same data.
    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