Read
GET v1/controllers
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsObjectName |
| array_name | NsObjectName |
| array_id | NsObjectID |
| serial | NsControllerSerialNumber |
| model | NsObjectName |
| hostname | NsHostName |
| support_address | NsIPAddress |
| support_netmask | NsIPNetmask |
| support_nic | NsNICName |
| power_status | NsPowerSupplyStatus |
| fan_status | NsFanStatus |
| temperature_status | NsTemperatureStatus |
| ctrlr_side | NsControllerSide |
| state | NsControllerState |
| nvme_cards_enabled | NsUnsignedInt |
| asup_time | NsTime |
GET v1/controllers/id
Query parameters
Description
List of controllers or controller attributes.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier of the controller. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of the controller. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| array_name | NsObjectName | string | Name of the array containing this controller. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| array_id | NsObjectID | string | Rest ID of the array containing this controller. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| serial | NsControllerSerialNumber | string | Serial number for this controller. Example: 'AC-109084-C2'. | |
| model | NsObjectName | string | Model of this controller. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| hostname | NsHostName | string | Host name for the controller. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen. | |
| support_address | NsIPAddress | string | IP address used for support. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| support_netmask | NsIPNetmask | string | IP netmask used for support. A netmask expressed as a 32 bit binary value must have the highest bit set (2^31) and the lowest bit clear (2^0) with the first zero followed by only zeros. Example: '255.255.255.0'. | |
| support_nic | NsNICName | string | Network card used for support. Name for a network card. | |
| power_status | NsPowerSupplyStatus | string enum | Overall power supply status for the controller. Possible values: 'ps_unknown', 'ps_okay', 'ps_alerted', 'ps_failed'. | |
| fan_status | NsFanStatus | string enum | Overall fan status for the controller. Possible values: 'fan_unknown', 'fan_okay', 'fan_alerted', 'fan_failed'. | |
| temperature_status | NsTemperatureStatus | string enum | Overall temperature status for the controller. Possible values: 'temperature_unknown', 'temperature_okay', 'temperature_alerted', 'temperature_failed'. | |
| power_supplies | NsCtrlrHwSensorInfoList | Array of NsCtrlrHwSensorInfo | Status for each power supply in the controller. A list of sensor information. | |
| fans | NsCtrlrHwSensorInfoList | Array of NsCtrlrHwSensorInfo | Status for each fan in the controller. A list of sensor information. | |
| temperature_sensors | NsCtrlrHwSensorInfoList | Array of NsCtrlrHwSensorInfo | Status for temperature sensor in the controller. A list of sensor information. | |
| partition_status | NsCtrlrRaidInfoList | Array of NsCtrlrRaidInfo | Status of the system's raid partitions. A list of raid arrays. | |
| ctrlr_side | NsControllerSide | string enum | Identifies which controller this is on its array. Possible values: 'A', 'B'. | |
| state | NsControllerState | string enum | Indicates whether this controller is active or not. Possible values: 'none', 'start_standby', 'start_active', 'stale', 'standby', 'solo', 'active'. | |
| nvme_cards_enabled | NsUnsignedInt | number | Indicates if the NVMe accelerator card is enabled. Unsigned 32-bit integer. Example: 1234. | |
| nvme_cards | NsCtrlrNvmeCardList | Array of NsCtrlrNvmeCard | List of NVMe accelerator cards. List of NVMe accelerator cards | |
| asup_time | NsTime | number | Time of the last autosupport by the controller. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. |
JSON Response
{
"data" : [
{
"id" : "c37d046b5282cdb0b9000000000000000100000000",
"name" : "A",
"array_name" : "gsl",
"array_id" : "097d046b5282cdb0b9000000000000000000000001",
"serial" : "AA-123456",
"model" : "HF40",
"hostname" : "gsl-A",
"support_address" : "10.18.169.214",
"support_netmask" : "255.255.224.0",
"support_nic" : "eth1",
"power_status" : "ps_okay",
"fan_status" : "fan_okay",
"temperature_status" : "temperature_okay",
"power_supplies" : [
{
"name" : "power-supply1",
"display_name" : "power-supply1",
"location" : "left rear",
"ctrlr_owner" : "independent",
"state" : "sensor_ok",
"current_reading" : 0
},
{
"name" : "power-supply1",
"display_name" : "power-supply1",
"location" : "left rear",
"ctrlr_owner" : "independent",
"state" : "sensor_ok",
"current_reading" : 0
}
],
"fans" : [
{
"name" : "fan1",
"display_name" : "fan1",
"location" : "lower front of controller A",
"ctrlr_owner" : "A",
"state" : "sensor_ok",
"current_reading" : 6291
},
{
"name" : "fan1",
"display_name" : "fan1",
"location" : "lower front of controller A",
"ctrlr_owner" : "A",
"state" : "sensor_ok",
"current_reading" : 6291
}
],
"temperature_sensors" : [
{
"name" : "bp-temp1",
"display_name" : "bp-temp1",
"location" : "left-side backplane",
"ctrlr_owner" : "A",
"state" : "sensor_ok",
"current_reading" : 18
},
{
"name" : "bp-temp1",
"display_name" : "bp-temp1",
"location" : "left-side backplane",
"ctrlr_owner" : "A",
"state" : "sensor_ok",
"current_reading" : 18
}
],
"partition_status" : [
{
"raid_id" : 18,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 16,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 14,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 12,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 10,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 0,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
}
],
"ctrlr_side" : "A",
"state" : "active"
},
{
"id" : "c37d046b5282cdb0b9000000000000000100000001",
"name" : "B",
"array_name" : "gsl-a",
"array_id" : "097d046b5282cdb0b9000000000000000000000001",
"serial" : "AA-234567",
"model" : "HF40",
"hostname" : "gsl-B",
"support_address" : "10.18.169.215",
"support_netmask" : "255.255.224.0",
"support_nic" : "eth1",
"power_status" : "ps_okay",
"fan_status" : "fan_okay",
"temperature_status" : "temperature_okay",
"power_supplies" : [
{
"name" : "power-supply1",
"display_name" : "power-supply1",
"location" : "left rear",
"ctrlr_owner" : "independent",
"state" : "sensor_ok",
"current_reading" : 0
},
{
"name" : "power-supply1",
"display_name" : "power-supply1",
"location" : "left rear",
"ctrlr_owner" : "independent",
"state" : "sensor_ok",
"current_reading" : 0
}
],
"fans" : [],
"temperature_sensors" : [],
"partition_status" : [
{
"raid_id" : 16,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 14,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 12,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},
{
"raid_id" : 10,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
},{
"raid_id" : 0,
"raid_type" : "raid0",
"max_copies" : 1,
"cur_copies" : 1,
"is_resyncing" : false
}
],
"ctrlr_side" : "B",
"state" : "standby"
}
],
"startRow" : 0,
"endRow" : 2,
"totalRows" : 2
}