Skip to content

ssldsakey

Configuration for dsa key resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
keyfile <String> Read-write Name for and, optionally, path to the DSA key file. /nsconfig/ssl/ is the default path.

Maximum length = 63
bits <Double> Read-write Size, in bits, of the DSA key.

Minimum value = 512

Maximum value = 2048
keyform <String> Read-write Format in which the DSA key file is stored on the appliance.

Default value: PEM

Possible values = DER, PEM
des <Boolean> Read-write Encrypt the generated DSA key by using the DES algorithm. On the command line, you are prompted to enter the pass phrase (password) that will be used to encrypt the key.
des3 <Boolean> Read-write Encrypt the generated DSA key by using the Triple-DES algorithm. On the command line, you are prompted to enter the pass phrase (password) that will be used to encrypt the key.
aes256 <Boolean> Read-write Encrypt the generated DSA key by using the AES algorithm.
password <String> Read-write Pass phrase to use for encryption if DES or DES3 option is selected.

Minimum length = 1

Maximum length = 31
pkcs8 <Boolean> Read-write Create the private key in PKCS#8 format.

Operations

(click to see Properties )

  • CREATE

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in green

create

URL: http:// <netscaler-ip-address> /nitro/v1/config/ssldsakey? action=create

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"ssldsakey":{
<b>      "keyfile":<String_value>,
</b><b>      "bits":<Double_value>,
</b>      "keyform":<String_value>,
      "des":<Boolean_value>,
      "des3":<Boolean_value>,
      "aes256":<Boolean_value>,
      "password":<String_value>,
      "pkcs8":<Boolean_value>
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error