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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create ssl rsakey intermediate_cert
  delegate_to: localhost
  netscaler.adc.sslrsakey:
    state: created
    keyfile: certname.key
    bits: 2048
    exponent: F4
    keyform: PEM

Inputs

    
des:
    description:
    - Encrypt the generated RSA key by using the DES algorithm. On the command line, you
      are prompted to enter the pass phrase (password) that is used to encrypt the key.
    type: bool

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

des3:
    description:
    - Encrypt the generated RSA key by using the Triple-DES algorithm. On the command
      line, you are prompted to enter the pass phrase (password) that is used to encrypt
      the key.
    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

pkcs8:
    description:
    - Create the private key in PKCS#8 format.
    type: bool

state:
    choices:
    - created
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(created), the `create` operation will be applied on the resource.
    type: str

aes256:
    description:
    - Encrypt the generated RSA key by using the AES algorithm.
    type: bool

keyfile:
    description:
    - Name for and, optionally, path to the RSA key file. /nsconfig/ssl/ is the default
      path.
    type: str

keyform:
    choices:
    - DER
    - PEM
    description:
    - Format in which the RSA key file is stored on the appliance.
    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

exponent:
    choices:
    - '3'
    - F4
    description:
    - Public exponent for the RSA key. The exponent is part of the cipher algorithm and
      is required for creating the RSA key.
    type: str

password:
    description:
    - Pass phrase to use for encryption if DES or DES3 option is selected.
    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