NetScaler SDX 14.1 NITRO API Reference

xen_hsm

March 20, 2024

Contributed by:

Configuration for HSM Admin Configuration resource.

Properties

(click to see Operations )

Name	Permissions	Description
hsm_fw_sign_file	Read-write	HSM Signature file. Minimum length = 1 Maximum length = 256
mco_password	Read-write	Master crypto officer password. Minimum length = 7 Maximum length = 14
hsm_fw_image	Read-write	HSM Firmware Image file. Minimum length = 1 Maximum length = 256
mco_username	Read-write	Master crypto officer user name. Minimum length = 1 Maximum length = 32
occupied_contexts	Read-only	Occupied no of contexts.
model	Read-only	Model of adapater.
serial_no	Read-only	Serial no of adapater.
occupied_keys	Read-only	Occupied no of keys.
total_partitions	Read-only	Total no of partitions.
act_id	Read-only	Activity Id.
host_ip_address	Read-only	host_ip_address.
occupied_partitions	Read-only	Occupied no of partitions.
total_contexts	Read-only	Total no of contexts.
label_name	Read-only	Label of adapater.
total_cores	Read-only	Total no of cores.
firmware_version	Read-only	Firmware version of hardware.
hsm_state	Read-only	HSM state.
total_keys	Read-only	Total no of keys.
occupied_cores	Read-only	Occupied no of cores.
build_no	Read-only	Build no of adapater.
part_no	Read-only	Part no of adapater.

Operations

(click to see Properties )

ADD
GET (ALL)

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/xen_hsm?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"xen_hsm": {
"hsm_fw_sign_file":<String_value>,
"mco_password":<String_value>,
"mco_username":<String_value>,
"hsm_fw_image":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "xen_hsm":[{
"occupied_contexts":<Double_value>,
"hsm_fw_sign_file":<String_value>,
"model":<String_value>,
"serial_no":<String_value>,
"occupied_keys":<Double_value>,
"total_partitions":<Integer_value>,
"act_id":<String_value>,
"mco_password":<String_value>,
"host_ip_address":<String_value>,
"occupied_partitions":<Integer_value>,
"total_contexts":<Double_value>,
"label_name":<String_value>,
"total_cores":<Double_value>,
"firmware_version":<String_value>,
"hsm_fw_image":<String_value>,
"mco_username":<String_value>,
"sync_operation":<Boolean_value>,
"hsm_state":<String_value>,
"total_keys":<Double_value>,
"occupied_cores":<Double_value>,
"build_no":<String_value>,
"part_no":<String_value>}]}

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/xen_hsm Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/xen_hsm ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of xen_hsm resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/xen_hsm ?pagesize=#no;pageno=#no Use this query-parameter to get the xen_hsm resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/xen_hsm ?count=yes Use this query-parameter to get the count of xen_hsm resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "xen_hsm":[{
"occupied_contexts":<Double_value>,
"hsm_fw_sign_file":<String_value>,
"model":<String_value>,
"serial_no":<String_value>,
"occupied_keys":<Double_value>,
"total_partitions":<Integer_value>,
"act_id":<String_value>,
"mco_password":<String_value>,
"host_ip_address":<String_value>,
"occupied_partitions":<Integer_value>,
"total_contexts":<Double_value>,
"label_name":<String_value>,
"total_cores":<Double_value>,
"firmware_version":<String_value>,
"hsm_fw_image":<String_value>,
"mco_username":<String_value>,
"sync_operation":<Boolean_value>,
"hsm_state":<String_value>,
"total_keys":<Double_value>,
"occupied_cores":<Double_value>,
"build_no":<String_value>,
"part_no":<String_value>}]}

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

xen_hsm

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

xen_hsm

Properties

Operations

add

get (all)

In this article