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

Inputs

    
iv:
    description:
    - Initialization Vector (IV) to use for importing the key. Required for importing
      a non-FIPS key.
    type: str

key:
    description:
    - Name of and, optionally, path to the key file to be imported.
    - ' /nsconfig/ssl/ is the default path.'
    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

curve:
    choices:
    - P_256
    - P_384
    description:
    - Only p_256 (prime256v1) and C(P_384) (secp384r1) are supported.
    type: str

state:
    choices:
    - absent
    - created
    - imported
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - 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.
    type: str

inform:
    choices:
    - SIM
    - DER
    - PEM
    description:
    - 'Input format of the key file. Available formats are:'
    - C(SIM) - Secure Information Management; select when importing a FIPS key. If the
      external FIPS key is encrypted, first decrypt it, and then import it.
    - C(PEM) - Privacy Enhanced Mail; select when importing a non-FIPS key.
    type: str

keytype:
    choices:
    - RSA
    - ECDSA
    description:
    - Only C(RSA) key and C(ECDSA) Key are supported.
    type: str

modulus:
    description:
    - Modulus, in multiples of 64, of the FIPS key to be created.
    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

exponent:
    choices:
    - '3'
    - F4
    description:
    - 'Exponent value for the FIPS key to be created. Available values function as follows:'
    - ' 3=3 (hexadecimal)'
    - F4=10001 (hexadecimal)
    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

fipskeyname:
    description:
    - Name for the FIPS key. Must begin with an ASCII alphanumeric or underscore (_) character,
      and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space,
      colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after
      the FIPS key is created.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my fipskey" or 'my fipskey').
    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

wrapkeyname:
    description:
    - Name of the wrap key to use for importing the key. Required for importing a non-FIPS
      key.
    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