Product Documentation

sslhsmkey

Sep 07, 2016

Configuration for HSM key resource.

Properties (click to see Operations)

Name Data Type Permissions Description
hsmkeyname
<String>
Read-write
.
Minimum length = 1
hsmtype
<String>
Read-write
Here 0 means Thales and 1 means safenet.
Default value: THALES
Possible values = THALES, SAFENET
key
<String>
Read-write
Name of and, optionally, path to the HSM key file. /var/opt/nfast/kmdata/local/ is the default path.
Maximum length = 63
serialnum
<String>
Read-write
Slot number of the safenet HSM, you want the key to be assigned too.
Maximum length = 16
password
<String>
Read-write
Password for the partition on HSM you want the key to be assigned.
Minimum length = 1
__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/sslhsmkey

HTTP Method: POST

Request Headers:

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

Request Payload:

{"sslhsmkey":{
      "hsmkeyname":<String_value>,
      "hsmtype":<String_value>,
      "key":<String_value>,
      "serialnum":<String_value>,
      "password":<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/sslhsmkey/hsmkeyname_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

get (all)

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/sslhsmkey?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/sslhsmkey?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

Use this query-parameter to get the sslhsmkey 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:

{ "sslhsmkey": [ {
      "hsmkeyname":<String_value>,
      "hsmtype":<String_value>,
      "serialnum":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/sslhsmkey/hsmkeyname_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/sslhsmkey/hsmkeyname_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/sslhsmkey/hsmkeyname_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:

{ "sslhsmkey": [ {
      "hsmkeyname":<String_value>,
      "hsmtype":<String_value>,
      "serialnum":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/sslhsmkey?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:

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