xen_hsm
Configuration for HSM Admin Configuration resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| hsm_fw_sign_file | <String> | Read-write | HSM Signature file.
Minimum length = 1
Maximum length = 256
|
| mco_password | <String> | Read-write | Master crypto officer password.
Minimum length = 7
Maximum length = 14
|
| hsm_fw_image | <String> | Read-write | HSM Firmware Image file.
Minimum length = 1
Maximum length = 256
|
| mco_username | <String> | Read-write | Master crypto officer user name.
Minimum length = 1
Maximum length = 32
|
| occupied_contexts | <Double> | Read-only | Occupied no of contexts. |
| model | <String> | Read-only | Model of adapater. |
| serial_no | <String> | Read-only | Serial no of adapater. |
| occupied_keys | <Double> | Read-only | Occupied no of keys. |
| total_partitions | <Integer> | Read-only | Total no of partitions. |
| act_id | <String> | Read-only | Activity Id. |
| host_ip_address | <String> | Read-only | host_ip_address. |
| occupied_partitions | <Integer> | Read-only | Occupied no of partitions. |
| total_contexts | <Double> | Read-only | Total no of contexts. |
| label_name | <String> | Read-only | Label of adapater. |
| total_cores | <Double> | Read-only | Total no of cores. |
| firmware_version | <String> | Read-only | Firmware version of hardware. |
| hsm_state | <String> | Read-only | HSM state. |
| total_keys | <Double> | Read-only | Total no of keys. |
| occupied_cores | <Double> | Read-only | Occupied no of cores. |
| build_no | <String> | Read-only | Build no of adapater. |
| part_no | <String> | 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=yesIf 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>
or
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>}}
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>}]}
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>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
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 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>}]}