View upgrade status
View upgrade status for system and devices.
Note: This API method produces JSON-formatted response only.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin (readOnly and read/write) |
HTTP method
GET /manager/api/json/1.0/viewUpgradeStatus.adm HTTP/1.1 Host:{manager.dsnet}
Curl method
curl -u {admin}:{password} -k
“https://{manager.dsnet}/manager/api/json/1.0/viewUpgradeStatus.adm”
Parameters
None
Response
Response to consist of:
- "system" - JSON object containing system upgrade state, installed software upgrade
repository version, upgrade repository signature verification status, and array of management
devices for which upgrade is required or in progress. System upgrade state will be one of the following:
- "idle" - Initial system state when no upgrade zip file has been uploaded.
- "managerUpgradeRequired" - System transitions to this state once an upgrade file of version later than manager has uploaded and successfully unzipped, prior to management device(s) upgrade.
- "deviceUpgradeAvailable" - System transitions to this state once all manager devices are current, or if upgrade file of version earlier than management device’s current version is uploaded.
- "systemCurrent" - System transitions to this state once all devices in system have successfully completed upgrade to the existing upgrade file version.
-
"devices" - JSON object containing devices for which upgrade is required or in progress, represented within the storage/access/file server/smc pool to which the device is assigned (or, if unassigned, within a "devicesNotInPool" array of device objects).
Devices are only returned in the response if upgrade for that device is either required or in progress. If a device requires upgrade, "upgradeStatus" for that device will display as null.
While device upgrade is in progress, "upgradeStatus" for that device will be displayed. Once device is successfully upgraded to the current upgrade repository version, it will no longer be displayed in response.
- "config" - JSON object containing "storageDeviceThrottle" setting for storage pool upgrades.
JSON response example
{
"responseStatus": "ok",
"responseHeader": {
"now": 1517515932919,
"status": "ok",
"requestId": "WnN0nKwTDyEAABys3HsAAACM"
},
"responseData": {
"system": {
"state": "managerUpgradeRequired",
"repoVersion": "3.13.1",
"repoSignatureVerified" : true,
"managementDevices": []
},
"devices": {
"storagePools": [
{
"uuid": "eaf9bdad-2efd-751f-112b-98efe2ef5b43",
"name": "SP1",
"sets": [
{
"uuid": "bd562534-e1a7-771f-10b7-0ef721f89d43",
"name": "SP1 - Set 1",
"devices": [
{
"uuid": "0e46f4e1-86af-7ec8-106d-509aad516a43",
"hostname": "slicestor_01",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "987ba4ab-f64b-7ebb-01ef-2a1afc6aee43",
"hostname": "slicestor_02",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "e63723fe-bf30-11e7-abc4-cec278b6b50a",
"hostname": "slicestor_03",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "e63725f2-bf30-11e7-abc4-cec278b6b50a",
"hostname": "slicestor_04",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
}
]
},
{
"uuid": "bd562534-e1a7-771f-10b7-0ef721f89d43",
"name": "SP1 - Set 2",
"devices": [
{
"uuid": "4ud3f4e1-86af-7ec8-106d-509aad516a43",
"hostname": "slicestor_05",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "7nd6a4ab-f64b-7ebb-01ef-2a1afc6aee43",
"hostname": "slicestor_06",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "e6371a3a-bf30-11e7-abc4-cec278b6b50a",
"hostname": "slicestor_07",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "e6372188-bf30-11e7-abc4-cec278b6b50a",
"hostname": "slicestor_08",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
}
]
}
]
}
],
"accessPools": [
{
"uuid": "bd562534-e1a7-771f-10b7-0ef721f89d43",
"name": "Access Pool 1",
"devices": [
{
"uuid": "0a8bc655-b4c7-7031-10db-1254dabf1d43",
"hostname": "accesser_01",
"deviceType": "accesser",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "789ba4ab-f64b-7ebb-01ef-2a1afc6aee43",
"hostname": "accesser_02",
"deviceType": "accesser",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
}
]
}
],
"fileServerPools": [
{
"uuid": "bd562534-e1a7-771f-10b7-0ef721f89d43",
"name": "File Server Pool 1",
"devices": [
{
"uuid": "6kv4f4e1-86af-7ec8-106d-509aad516a43",
"hostname": "gateway_01",
"deviceType": "gateway",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "98b042a5-7e5e-70b5-11b8-ab7468e89343",
"hostname": "gateway_02",
"deviceType": "gateway",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
}
]
}
],
"smcPools": [
{
"uuid": "bd562534-e1a7-771f-10b7-0ef721f89d43",
"name": "SMC Pool 1",
"devices": [
{
"uuid": "6kv4f4e1-86af-7ec8-106d-509aad516a43",
"hostname": "smc_01",
"deviceType": "smc",
"deviceHealth": "ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "789ba4ab-f64b-7ebb-01ef-2a1afc6aee43",
"hostname": "smc_02",
"deviceType": "smc",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
}
]
}
],
"devicesNotInPool": [
{
"uuid": "6kv4f4e1-86af-7ec8-106d-509aad516a43",
"hostname": "accesser_03",
"deviceType": "accesser",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "789ba4ab-f64b-7ebb-01ef-2a1afc6aee43",
"hostname": "slicestor_09",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
},
{
"uuid": "f64ba4ab-afc6-7ebb-01ef-2a1afc6aee43",
"hostname": "slicestor_10",
"deviceType": "slicestor",
"deviceHealth":"ok",
"version": "3.11.0.31",
"upgradeStatus": null
}
]
},
"config": {
"storageDeviceThrottle": 1
}
}
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| system | object | Object containing system upgrade state, installed repository version, and array of management devices for which upgrade is required or in progress. |
| state | String | System upgrade state (e.g. “idle”, “deviceUpgradeAvailable”). |
| repoVersion | String | Version number of the installed software upgrade repository. |
| repoSignatureVerified | boolean | Indicates if the installed software upgrade repository had its signature verified. |
| managementDevices | array | Management devices requiring upgrade to installed software upgrade repository. Represented as array of objects (see below for description of device object). |
| devices | object | Devices in the system for which upgrade is required or in progress. |
| storagePools | array | Storage pools in the system, represented as array of objects. Each storage pool object includes: |
| uuid | String | Storage pool Universally Unique Identifier. |
| name | String | Storage pool name. |
| Sets | array | Sets in an expanded storage pool, represented as array of objects. Each storage pool set object includes: |
| uuid | String | Storage pool set Universally Unique Identifier. |
| name | String | Storage pool set name. |
| accessPools | array | Access pools in the system, represented as array of objects. Each access pool object includes: |
| uuid | String | Access pool Universally Unique Identifier. |
| name | String | Access pool name. |
| fileServerPools | array | File server pools in the system, represented as array of objects. Each file server pool object includes: |
| uuid | String | File server pool Universally Unique Identifier. |
| name | String | File server pool name. |
| smcPools | array | SMC pools in the system, represented as array of objects. Each SMC pool object includes: |
| uuid | String | SMC pool Universally Unique Identifier. |
| name | String | SMC pool name. |
| devices | array | Devices contained within in each of the above pools, represented as array of objects. Each device object includes: |
| uuid | String | Device Universally Unique Identifier. |
| hostname | String | Device hostname. |
| deviceType | String | Device type. |
| deviceHealth | String | Device health. |
| version | String | Device’s current software version |
| upgradeStatus | object | Device’s upgrade status. Null value indicates device requires upgrade. If present, upgradeStatus is represented as an object consisting of: |
| state | String | Device’s upgrade state (e.g. “pending”, “initiated”). |
| upgradeErrorCode | String | Code indicating reason for upgrade failure. |
| modificationTime | String | UNIX time when device upgrade was initiated. |
| markedForRemoval | boolean | Indicates device’s pending removal from upgrade queue. |
| halted | boolean | Indicates whether device upgrade has been temporarily halted. |
| forceKilled | boolean | Indicates whether device upgrade has been force-killed due to unrecoverable error. |
| timeUntilEligibleForUpgrade | Long | Milliseconds until device can safely be upgraded. |
| config | object | Upgrade configuration settings, represented as an object containing: |
| storageDeviceThrottle | integer | Setting for number of devices within a storage pool to be upgraded simultaneously. |