Obtaining Device Information

Introduction

Get device information.

Request Examples

This is an example of obtaining the status of a device only.

$ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/storagesystem?fields=status"

Response Examples

{
  "storage_system_name": "E500_003",
  "status": "Normal",
  "detail_status": "Normal",
  "model_name": "ET503SA",
  "serial_number": "000123456789",
  "wwn": "500000e0dc000000",
  "boxid": "00DXL#########ET06F21AUABCPJ000000######",
  "firmware_version": "V11L40-0000",
  "date": "2020-11-07T02:50:59Z",
  "is_write_through_mode": false,
  "is_thin_provisioning_enable": true,
  "maximum_pool_capacity": 512,
  "is_data_reduction_enable": true,
  "is_local_copy_available": true,
  "local_copy_license_type": "Full",
  "is_remote_copy_available": true,
  "remote_copy_license_type": "Full",
  "is_encryption_available": true,
  "is_exc_enable": true,
  "power_1min_avg": 460,
  "power_1hour_avg": 520
}

Parameters

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and retrieved.

For details about the specification methods, see Property Filter.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

storage_system_name

string

The device name.

status

string

Overall status of the device.

Respond if you have the Status_Display privilege.

Items	Description
Normal	Normal state.
Maintenance	Maintenance state.
Warning	Preventive maintenance is required.
Error	An error has occurred and maintenance is required.

detail_status

string

Detailed status of the device.

Respond if you have the Status_Display privilege.

Items	Description
Normal	Normal state.
Maintenance	Some parts are under maintenance. Or rebuild/copyback is in progress.
Change_Controlling_CM	The assigned CM must be changed.
Pinned_Data	PIN data has occurred.
Warning	Some parts need preventive maintenance. Or, a bad sector has occurred.
Error	Some parts have failed.
Not_Ready	The device has detected a failure at startup or power down. I/O from the host is not accepted successfully.
Subsystem_Down	The device is in the failed state. I/O from the host is not accepted successfully.

model_name

string

Model name of the device.

Respond if you have the Status_Display privilege.

serial_number

string

The serial number of the device.

Respond if you have the Status_Display or Maintenance_Operation privilege.

wwn

string

WWN of the device.

Respond if you have the Status_Display or Maintenance_Operation privilege.

boxid

string

The Box ID of the device.

Respond if you have the Status_Display or Maintenance_Operation privilege.

firmware_version

string

General version of the controller firmware in operation.

Respond if you have the Status_Display or Maintenance_Operation privilege.

date

string

The date and time of the device (ISO 8601 extended format).

It always responds regardless of authority.

Format is as follows:

The time zone is UTC.

YYYY-MM-DDThh:mm:ssZ

is_write_through_mode

boolean

The operational state of the Cache.

Respond if you have the Status_Display or Maintenance_Operation privilege.

If true, this is the mode that returns "Write Completed" to the write requests from the host when the writing data is completed not only in the cache area but also in the drive.

is_thin_provisioning_enable

boolean

Thin Provisioning settings for the device.

Respond if you have the Status_Display, RAID_Group_Management, or Storage_Management privilege.

If true, the Thin Provisioning feature is enabled.

maximum_pool_capacity

integer

Maximum pool capacity of the device.

Respond if you have the Status_Display, RAID_Group_Management, or Storage_Management privilege.

The unit is MB.

is_data_reduction_enable

boolean

Data Reduction settings on the device.

Respond if you have the Status_Display, Storage_Management, or Maintenance_Operation privilege.

If true, the Thin Provisioning feature is enabled.

is_local_copy_available

boolean

Whether the device can use Local Advanced Copy.

Respond if you have the Status_Display, Advanced_Copy_Management, Copy_Session_Management, or Storage_Management privilege.

If true, the Local Advanced Copy feature is enabled.

local_copy_license_type

string

The type of Local Advanced Copy license for the device.

Respond if you have the Status_Display, Advanced_Copy_Management, Copy_Session_Management, or Storage_Management privilege.

If is_local_copy_available is false, no response is made.

Items	Description
Trial	A trial license has been registered.
Full	A paid license is registered. All Advanced Copy functionality is available.

is_remote_copy_available

boolean

Whether the device can use Local Advanced Copy.

Respond if you have the Status_Display, Advanced_Copy_Management, Copy_Session_Management, or Storage_Management privilege.

If true, the Remote Advanced Copy feature is enabled.

remote_copy_license_type

string

The type of Remote Advanced Copy license for the device.

Respond if you have the Status_Display, Advanced_Copy_Management, Copy_Session_Management, or Storage_Management privilege.

If is_remote_copy_available is false, no response is made.

Items	Description
Trial	A trial license has been registered.
Full	A paid license is registered. All Advanced Copy functionality is available.

is_encryption_available

boolean

Whether encryption is enabled by the CM.

Respond if you have the Status_Display, Advanced_Copy_Management, Storage_Management, Security_Settings, or Maintenance_Operation privilege.

If true, encryption by CM is enabled.

is_exc_enable

boolean

Extreme Cache Pool configuration for the device.

Respond if you have the Status_Display, Volume_Create_Modify, or Storage_Management privilege.

If true, the Extreme Cache Pool feature is enabled.

power_1min_avg

integer

Average power consumption in the last minute.

Respond if you have the Status_Display privilege.

The unit is W.

power_1hour_avg

integer

Average power consumption in the last hour.

Respond if you have the Status_Display privilege.

The unit is W.