Developer Documentation
NetScaler SDX 13.1 NITRO API Reference

xen_health_disk

March 20, 2024
Contributed by: 
C

Configuration for Disk IO Statistics resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
total_blocks_read Read-write Total blocks read.
status Read-write Status of the storage repository - OK/ERROR/DEGRADED.
name Read-write Name of the Disk.
sr_name Read-write Name of the storage repository.
size Read-write Size of the disk (bytes).
total_blocks_written Read-write Total blocks written.
physical_disks Read-write The physical disks that make up the logical disk.
block_read_rate Read-write Blocks read per second.
block_write_rate Read-write Blocks written per second.
bay_number Read-write Bay number.
host_ip_address Read-write Host IP Address.

Minimum length = 1

Maximum length = 64
utilized Read-write Utilization of the disk (bytes).
transaction_rate Read-write Transactions per second.

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_disk Query-parameters:

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

count https://<MGMT-IP>/nitro/v2/config/xen_health_disk ?count=yes Use this query-parameter to get the count of xen_health_disk 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_disk":[{
"total_blocks_read":<Double_value>,
"status":<String_value>,
"name":<String_value>,
"sr_name":<String_value>,
"size":<Double_value>,
"total_blocks_written":<Double_value>,
"physical_disks":<String_value>,
"block_read_rate":<Double_value>,
"block_write_rate":<Double_value>,
"bay_number":<String_value>,
"host_ip_address":<String_value>,
"utilized":<Double_value>,
"transaction_rate":<Double_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/xen_health_disk/bay_number_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_disk":[{
"total_blocks_read":<Double_value>,
"status":<String_value>,
"name":<String_value>,
"sr_name":<String_value>,
"size":<Double_value>,
"total_blocks_written":<Double_value>,
"physical_disks":<String_value>,
"block_read_rate":<Double_value>,
"block_write_rate":<Double_value>,
"bay_number":<String_value>,
"host_ip_address":<String_value>,
"utilized":<Double_value>,
"transaction_rate":<Double_value>}]}

<!--NeedCopy-->
xen_health_disk
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.