NetScaler SDX 14.1 NITRO API Reference

physical_disk

Configuration for Raid Physical Drive resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
logical_disk_name Read-write Logical Disk Name.

Minimum length = 1

Maximum length = 128
host_ip_address Read-write host_ip_address.

Minimum length = 1

Maximum length = 128
id Read-write Id is system generated key for all physical drives.
slot Read-write Slot/Bay Number.
force_clean Read-write Force Clean Disk before Rebuilding.
ld_number Read-only Logical Drive number.
deviceid Read-only Device ID.
size Read-only Disk Size.
firmwarestate Read-only Firmware State.
adapter_id Read-only Adapter ID.
mec Read-only mec.
disk_index Read-only Disk Index.
oec Read-only Drives.
is_used Read-only Is Used.
enclosure Read-only Enclosure.
inquiry Read-only Inquiry.
wwn Read-only wwn.
disk_name Read-only Disk Name.
physicalstate Read-only Physical State: Present OR Not Present.
foreignstate Read-only Foreign State.
mediatype Read-only Media Type.
partner_state Read-only Partner Disk firmware state.

Operations

(click to see Properties )

  • MAKE_GOOD_PD
  • REPLACE_MISSING
  • REMOVE_PD
  • LOCATE_PD_START
  • GET (ALL)
  • GET
  • LOCATE_PD_STOP

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

make_good_pd

URL: https://<MGMT-IP>/nitro/v2/config/physical_disk?action=make_good_pd;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:

{"physical_disk": {
"logical_disk_name":<String_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"force_clean":<Boolean_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, "physical_disk":[{
"ld_number":<Integer_value>,
"deviceid":<Integer_value>,
"logical_disk_name":<String_value>,
"size":<String_value>,
"firmwarestate":<String_value>,
"adapter_id":<Integer_value>,
"mec":<String_value>,
"disk_index":<Integer_value>,
"host_ip_address":<String_value>,
"oec":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"is_used":<Boolean_value>,
"enclosure":<Integer_value>,
"inquiry":<String_value>,
"wwn":<String_value>,
"disk_name":<String_value>,
"physicalstate":<String_value>,
"foreignstate":<String_value>,
"mediatype":<String_value>,
"partner_state":<String_value>,
"response":<String_value>,
"force_clean":<Boolean_value>}]}

<!--NeedCopy-->

replace_missing

URL: https://<MGMT-IP>/nitro/v2/config/physical_disk?action=replace_missing;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:

{"physical_disk": {
"logical_disk_name":<String_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"force_clean":<Boolean_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, "physical_disk":[{
"ld_number":<Integer_value>,
"deviceid":<Integer_value>,
"logical_disk_name":<String_value>,
"size":<String_value>,
"firmwarestate":<String_value>,
"adapter_id":<Integer_value>,
"mec":<String_value>,
"disk_index":<Integer_value>,
"host_ip_address":<String_value>,
"oec":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"is_used":<Boolean_value>,
"enclosure":<Integer_value>,
"inquiry":<String_value>,
"wwn":<String_value>,
"disk_name":<String_value>,
"physicalstate":<String_value>,
"foreignstate":<String_value>,
"mediatype":<String_value>,
"partner_state":<String_value>,
"response":<String_value>,
"force_clean":<Boolean_value>}]}

<!--NeedCopy-->

remove_pd

URL: https://<MGMT-IP>/nitro/v2/config/physical_disk?action=remove_pd;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:

{"physical_disk": {
"logical_disk_name":<String_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"force_clean":<Boolean_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, "physical_disk":[{
"ld_number":<Integer_value>,
"deviceid":<Integer_value>,
"logical_disk_name":<String_value>,
"size":<String_value>,
"firmwarestate":<String_value>,
"adapter_id":<Integer_value>,
"mec":<String_value>,
"disk_index":<Integer_value>,
"host_ip_address":<String_value>,
"oec":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"is_used":<Boolean_value>,
"enclosure":<Integer_value>,
"inquiry":<String_value>,
"wwn":<String_value>,
"disk_name":<String_value>,
"physicalstate":<String_value>,
"foreignstate":<String_value>,
"mediatype":<String_value>,
"partner_state":<String_value>,
"response":<String_value>,
"force_clean":<Boolean_value>}]}

<!--NeedCopy-->

locate_pd_start

URL: https://<MGMT-IP>/nitro/v2/config/physical_disk?action=locate_pd_start;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:

{"physical_disk": {
"logical_disk_name":<String_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"force_clean":<Boolean_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, "physical_disk":[{
"ld_number":<Integer_value>,
"deviceid":<Integer_value>,
"logical_disk_name":<String_value>,
"size":<String_value>,
"firmwarestate":<String_value>,
"adapter_id":<Integer_value>,
"mec":<String_value>,
"disk_index":<Integer_value>,
"host_ip_address":<String_value>,
"oec":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"is_used":<Boolean_value>,
"enclosure":<Integer_value>,
"inquiry":<String_value>,
"wwn":<String_value>,
"disk_name":<String_value>,
"physicalstate":<String_value>,
"foreignstate":<String_value>,
"mediatype":<String_value>,
"partner_state":<String_value>,
"response":<String_value>,
"force_clean":<Boolean_value>}]}

<!--NeedCopy-->

get (all)

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

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

count https://<MGMT-IP>/nitro/v2/config/physical_disk ?count=yes Use this query-parameter to get the count of physical_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, "physical_disk":[{
"ld_number":<Integer_value>,
"deviceid":<Integer_value>,
"logical_disk_name":<String_value>,
"size":<String_value>,
"firmwarestate":<String_value>,
"adapter_id":<Integer_value>,
"mec":<String_value>,
"disk_index":<Integer_value>,
"host_ip_address":<String_value>,
"oec":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"is_used":<Boolean_value>,
"enclosure":<Integer_value>,
"inquiry":<String_value>,
"wwn":<String_value>,
"disk_name":<String_value>,
"physicalstate":<String_value>,
"foreignstate":<String_value>,
"mediatype":<String_value>,
"partner_state":<String_value>,
"response":<String_value>,
"force_clean":<Boolean_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/physical_disk/id_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, "physical_disk":[{
"ld_number":<Integer_value>,
"deviceid":<Integer_value>,
"logical_disk_name":<String_value>,
"size":<String_value>,
"firmwarestate":<String_value>,
"adapter_id":<Integer_value>,
"mec":<String_value>,
"disk_index":<Integer_value>,
"host_ip_address":<String_value>,
"oec":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"is_used":<Boolean_value>,
"enclosure":<Integer_value>,
"inquiry":<String_value>,
"wwn":<String_value>,
"disk_name":<String_value>,
"physicalstate":<String_value>,
"foreignstate":<String_value>,
"mediatype":<String_value>,
"partner_state":<String_value>,
"response":<String_value>,
"force_clean":<Boolean_value>}]}

<!--NeedCopy-->

locate_pd_stop

URL: https://<MGMT-IP>/nitro/v2/config/physical_disk?action=locate_pd_stop;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:

{"physical_disk": {
"logical_disk_name":<String_value>,
"host_ip_address":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"force_clean":<Boolean_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, "physical_disk":[{
"ld_number":<Integer_value>,
"deviceid":<Integer_value>,
"logical_disk_name":<String_value>,
"size":<String_value>,
"firmwarestate":<String_value>,
"adapter_id":<Integer_value>,
"mec":<String_value>,
"disk_index":<Integer_value>,
"host_ip_address":<String_value>,
"oec":<String_value>,
"id":<String_value>,
"slot":<Integer_value>,
"is_used":<Boolean_value>,
"enclosure":<Integer_value>,
"inquiry":<String_value>,
"wwn":<String_value>,
"disk_name":<String_value>,
"physicalstate":<String_value>,
"foreignstate":<String_value>,
"mediatype":<String_value>,
"partner_state":<String_value>,
"response":<String_value>,
"force_clean":<Boolean_value>}]}

<!--NeedCopy-->
physical_disk