Product Documentation

sslcertkey

Sep 07, 2016

Configuration for certificate key resource.

Properties (click to see Operations)

Name Data Type Permissions Description
certkey
<String>
Read-write
Name for the certificate and private-key pair. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the certificate-key pair is created.

The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my cert" or 'my cert').
Minimum length = 1
cert
<String>
Read-write
Name of and, optionally, path to the X509 certificate file that is used to form the certificate-key pair. The certificate file should be present on the appliance's hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.
Minimum length = 1
key
<String>
Read-write
Name of and, optionally, path to the private-key file that is used to form the certificate-key pair. The certificate file should be present on the appliance's hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.
Minimum length = 1
password
<Boolean>
Read-write
Passphrase that was used to encrypt the private-key. Use this option to load encrypted private-keys in PEM format.
fipskey
<String>
Read-write
Name of the FIPS key that was created inside the Hardware Security Module (HSM) of a FIPS appliance, or a key that was imported into the HSM.
Minimum length = 1
hsmkey
<String>
Read-write
Name of the HSM key that was created in the External Hardware Security Module (HSM) of a FIPS appliance.
Minimum length = 1
inform
<String>
Read-write
Input format of the certificate and the private-key files. The three formats supported by the appliance are:
PEM - Privacy Enhanced Mail
DER - Distinguished Encoding Rule
PFX - Personal Information Exchange.
Default value: PEM
Possible values = DER, PEM, PFX
passplain
<String>
Read-write
Pass phrase used to encrypt the private-key. Required when adding an encrypted private-key in PEM format.
Minimum length = 1
expirymonitor
<String>
Read-write
Issue an alert when the certificate is about to expire.
Possible values = ENABLED, DISABLED
notificationperiod
<Double>
Read-write
Time, in number of days, before certificate expiration, at which to generate an alert that the certificate is about to expire.
Minimum value = 10
Maximum value = 100
bundle
<String>
Read-write
Parse the certificate chain as a single file after linking the server certificate to its issuer's certificate within the file.
Default value: NO
Possible values = YES, NO
linkcertkeyname
<String>
Read-write
Name of the Certificate Authority certificate-key pair to which to link a certificate-key pair.
Minimum length = 1
nodomaincheck
<Boolean>
Read-write
Override the check for matching domain names during a certificate update operation.
signaturealg
<String>
Read-only
Signature algorithm.
certificatetype
<String>
Read-only
Specifies whether the certificate is of type root-CA, intermediate-CA, server, client, or client and server.
Possible values = ROOT_CERT, INTM_CERT, CLNT_CERT, SRVR_CERT, UNKNOWN, CLIENTANDSERVER_CERT
serial
<String>
Read-only
Serial number.
issuer
<String>
Read-only
Issuer name.
clientcertnotbefore
<String>
Read-only
Not-Before date.
clientcertnotafter
<String>
Read-only
Not-After date.
daystoexpiration
<Integer>
Read-only
Days remaining for the certificate to expire.
subject
<String>
Read-only
Subject name.
publickey
<String>
Read-only
Public key algorithm.
publickeysize
<Integer>
Read-only
Size of the public key.
version
<Integer>
Read-only
Version.
priority
<Double>
Read-only
ocsp priority.
status
<String>
Read-only
Status of the certificate.
Possible values = Valid, Not yet valid, Expired
passcrypt
<String>
Read-only
Passcrypt.
Minimum length = 1
data
<Double>
Read-only
Vserver Id.
servicename
<String>
Read-only
Service name to which the certificate key pair is bound.
__count
<Double>
Read-only
count parameter

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>.

add

URL: http://<netscaler-ip-address>/nitro/v1/config/sslcertkey

HTTP Method: POST

Request Headers:

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

Request Payload:

{"sslcertkey":{
      "certkey":<String_value>,
      "cert":<String_value>,
      "key":<String_value>,
      "password":<Boolean_value>,
      "fipskey":<String_value>,
      "hsmkey":<String_value>,
      "inform":<String_value>,
      "passplain":<String_value>,
      "expirymonitor":<String_value>,
      "notificationperiod":<Double_value>,
      "bundle":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created
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

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/sslcertkey/certkey_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

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

update

URL: http://<netscaler-ip-address>/nitro/v1/config/sslcertkey

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"sslcertkey":{
      "certkey":<String_value>,
      "expirymonitor":<String_value>,
      "notificationperiod":<Double_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

unset

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"sslcertkey":{
      "certkey":<String_value>,
      "expirymonitor":true,
      "notificationperiod":true
}}

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

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"sslcertkey":{
      "certkey":<String_value>,
      "linkcertkeyname":<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

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"sslcertkey":{
      "certkey":<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

change

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"sslcertkey":{
      "certkey":<String_value>,
      "cert":<String_value>,
      "key":<String_value>,
      "password":<Boolean_value>,
      "fipskey":<String_value>,
      "inform":<String_value>,
      "passplain":<String_value>,
      "nodomaincheck":<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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/sslcertkey

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of sslcertkey resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?pagesize=#no&pageno=#no

Use this query-parameter to get the sslcertkey resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "sslcertkey": [ {
      "certkey":<String_value>,
      "cert":<String_value>,
      "key":<String_value>,
      "inform":<String_value>,
      "signaturealg":<String_value>,
      "certificatetype":<String_value>,
      "serial":<String_value>,
      "issuer":<String_value>,
      "clientcertnotbefore":<String_value>,
      "clientcertnotafter":<String_value>,
      "daystoexpiration":<Integer_value>,
      "subject":<String_value>,
      "publickey":<String_value>,
      "publickeysize":<Integer_value>,
      "version":<Integer_value>,
      "priority":<Double_value>,
      "status":<String_value>,
      "fipskey":<String_value>,
      "hsmkey":<String_value>,
      "passcrypt":<String_value>,
      "data":<Double_value>,
      "servicename":<String_value>,
      "expirymonitor":<String_value>,
      "notificationperiod":<Double_value>,
      "linkcertkeyname":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/sslcertkey/certkey_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey/certkey_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey/certkey_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "sslcertkey": [ {
      "certkey":<String_value>,
      "cert":<String_value>,
      "key":<String_value>,
      "inform":<String_value>,
      "signaturealg":<String_value>,
      "certificatetype":<String_value>,
      "serial":<String_value>,
      "issuer":<String_value>,
      "clientcertnotbefore":<String_value>,
      "clientcertnotafter":<String_value>,
      "daystoexpiration":<Integer_value>,
      "subject":<String_value>,
      "publickey":<String_value>,
      "publickeysize":<Integer_value>,
      "version":<Integer_value>,
      "priority":<Double_value>,
      "status":<String_value>,
      "fipskey":<String_value>,
      "hsmkey":<String_value>,
      "passcrypt":<String_value>,
      "data":<Double_value>,
      "servicename":<String_value>,
      "expirymonitor":<String_value>,
      "notificationperiod":<Double_value>,
      "linkcertkeyname":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

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

Response Headers:

Content-Type:application/json

Response Payload:

{ "sslcertkey": [ { "__count": "#no"} ] }