Product Documentation

sslpkcs8

Sep 07, 2016

Configuration for pkcs8 resource.

Properties (click to see Operations)

Name Data Type Permissions Description
pkcs8file
<String>
Read-write
Name for and, optionally, path to, the output file where the PKCS#8 format key file is stored. /nsconfig/ssl/ is the default path.
Maximum length = 63
keyfile
<String>
Read-write
Name of and, optionally, path to the input key file to be converted from PEM or DER format to PKCS#8 format. /nsconfig/ssl/ is the default path.
Maximum length = 63
keyform
<String>
Read-write
Format in which the key file is stored on the appliance.
Default value: PEM
Possible values = DER, PEM
password
<String>
Read-write
Password to assign to the file if the key is encrypted. Applies only for PEM format files.
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/sslpkcs8?action=convert

HTTP Method: POST

Request Headers:

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

Request Payload:

{"sslpkcs8":{
      "pkcs8file":<String_value>,
      "keyfile":<String_value>,
      "keyform":<String_value>,
      "password":<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