ADC NITRO APIs

sslhsmkey

August 17, 2023

Contributed by:

Configuration for HSM key resource.

Properties

(click to see Operations )

Name	Permissions	Description
hsmkeyname	Read-write	. Minimum length = 1
hsmtype	Read-write	Type of HSM. Default value: THALES Possible values = THALES, SAFENET, KEYVAULT
key	Read-write	Name of the key. optionally, for Thales, path to the HSM key file; /var/opt/nfast/kmdata/local/ is the default path. Applies when HSMTYPE is THALES or KEYVAULT. Maximum length = 63
serialnum	Read-write	Serial number of the partition on which the key is present. Applies only to SafeNet HSM. Maximum length = 16
password	Read-write	Password for a partition. Applies only to SafeNet HSM. Minimum length = 1
keystore	Read-write	Name of keystore object representing HSM where key is stored. For example, name of keyvault object or azurekeyvault authentication object. Applies only to KEYVAULT type HSM. Minimum length = 1
state	Read-only	Current state of key. Possible values = Created, Access Token Unavailable, Unauthorized, Does not exist, Unreachable, Marked down, Key operations successful, Key operations failed, Key operation throttled
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
GET (ALL)
GET
COUNT

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

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":{
<b>      "hsmkeyname":<String_value>,
</b>      "hsmtype":<String_value>,
      "key":<String_value>,
      "serialnum":<String_value>,
      "password":<String_value>,
      "keystore":<String_value>
}}

<!--NeedCopy-->

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>

Query-parameters:

args=hsmtype: <String_value> ,serialnum: <String_value> ,password: <String_value>

</b>

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

Use this query-parameter to get the summary output of sslhsmkey resources configured on NetScaler.

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 Header:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

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

Use this query-parameter to get the summary output of sslhsmkey resources configured on NetScaler.

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 Header:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

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 Header:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

sslhsmkey

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

sslhsmkey

Properties

Operations

add

delete

get (all)

get

count

In this article