netscaler.adc.sslpkcs12 (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 pkcs12 resource.

Inputs

    
des:
    description:
    - Encrypt the private key by using the DES algorithm in CBC mode during the import
      operation. On the command line, you are prompted to enter the pass phrase.
    type: bool

des3:
    description:
    - Encrypt the private key by using the Triple-DES algorithm in EDE CBC mode (168-bit
      key) during the import operation. On the command line, you are prompted to enter
      the pass phrase.
    type: bool

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

aes256:
    description:
    - Encrypt the private key by using the AES algorithm (256-bit key) during the import
      operation. On the command line, you are prompted to enter the pass phrase.
    type: bool

export:
    description:
    - Convert the certificate and private key from PEM format to PKCS#12 format. On the
      command line, you are prompted to enter the pass phrase.
    type: bool

import:
    description:
    - Convert the certificate and private-key from PKCS#12 format to PEM format.
    type: bool

keyfile:
    description:
    - Name of the private key file to be converted from PEM to PKCS#12 format. If the
      key file is encrypted, you are prompted to enter the pass phrase used for encrypting
      the key.
    type: str

outfile:
    description:
    - Name for and, optionally, path to, the output file that contains the certificate
      and the private key after converting from PKCS#12 to PEM format. /nsconfig/ssl/
      is the default path.
    - If importing, the certificate-key pair is stored in PEM format. If exporting, the
      certificate-key pair is stored in PKCS#12 format.
    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

certfile:
    description:
    - Certificate file to be converted from PEM to PKCS#12 format.
    type: str

password:
    description:
    - '0'
    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

pkcs12file:
    description:
    - Name for and, optionally, path to, the PKCS#12 file. If importing, specify the input
      file name that contains the certificate and the private key in PKCS#12 format. If
      exporting, specify the output file name that contains the certificate and the private
      key after converting from PEM to
    - PKCS#12 format. /nsconfig/ssl/ is the default path.
    - During the import operation, if the key is encrypted, you are prompted to enter
      the pass phrase used for encrypting the 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

pempassphrase:
    description:
    - '0'
    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