Developer Documentation
NetScaler SDX 14.1 NITRO API Reference

xen_health_hsm

March 20, 2024
Contributed by: 
C

Configuration for HSM Statistics resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
partition_name Read-write FIPS Partition Name.
rsa_operations Read-only Number of RSA operations in flight.
crypto_utilization Read-only Utilization of the crypto resources allocated for each partition as a percentage of total allocated..
rsa_handshakes Read-only Total number of new RSA handshakes processed.
maximum_key_store_size Read-only Maximum no of keys for the partition.
queue_depth Read-only Queue depth of instruction queues allocated to the instance from each partition.
ssl_bulk_requests Read-only Total number of SSL bulk requests in flight.
available_key_store_size Read-only Available no of keys for the partition.
ssl_requests_processed Read-only Total number of SSL bulk record encryption/decryption requests processed.

Operations

(click to see Properties )

  • GET (ALL)
  • GET

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

get (all)

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

filter https://<MGMT-IP>/nitro/v2/config/xen_health_hsm ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of xen_health_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_health_hsm ?pagesize=#no;pageno=#no Use this query-parameter to get the xen_health_hsm resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/xen_health_hsm ?count=yes Use this query-parameter to get the count of xen_health_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_health_hsm":[{
"rsa_operations":<Integer_value>,
"crypto_utilization":<Double_value>,
"rsa_handshakes":<Integer_value>,
"maximum_key_store_size":<Integer_value>,
"queue_depth":<Integer_value>,
"partition_name":<String_value>,
"ssl_bulk_requests":<Integer_value>,
"available_key_store_size":<Integer_value>,
"ssl_requests_processed":<Integer_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/xen_health_hsm/partition_name_value<String> 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_health_hsm":[{
"rsa_operations":<Integer_value>,
"crypto_utilization":<Double_value>,
"rsa_handshakes":<Integer_value>,
"maximum_key_store_size":<Integer_value>,
"queue_depth":<Integer_value>,
"partition_name":<String_value>,
"ssl_bulk_requests":<Integer_value>,
"available_key_store_size":<Integer_value>,
"ssl_requests_processed":<Integer_value>}]}

<!--NeedCopy-->
xen_health_hsm
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.