Product Documentation

sslpkcs12

Sep 07, 2016

Configuration for pkcs12 resource.

Properties (click to see Operations)

Name Data Type Permissions Description
outfile
<String>
Read-write
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.
Maximum length = 63
Import
<Boolean>
Read-write
Convert the certificate and private-key from PKCS#12 format to PEM format.
pkcs12file
<String>
Read-write
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.
Maximum length = 63
des
<Boolean>
Read-write
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.
des3
<Boolean>
Read-write
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.
export
<Boolean>
Read-write
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.
certfile
<String>
Read-write
Certificate file to be converted from PEM to PKCS#12 format.
Maximum length = 63
keyfile
<String>
Read-write
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.
Maximum length = 63
password
<String>
Read-write
.
Minimum length = 1
Maximum length = 31
pempassphrase
<String>
Read-write
.
Minimum length = 1
Maximum length = 31

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

convert

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"sslpkcs12":{
      "outfile":<String_value>,
      "Import":<Boolean_value>,
      "pkcs12file":<String_value>,
      "des":<Boolean_value>,
      "des3":<Boolean_value>,
      "export":<Boolean_value>,
      "certfile":<String_value>,
      "keyfile":<String_value>,
      "password":<String_value>,
      "pempassphrase":<String_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