GET /managementServer/data
Use this method to return information about all Lenovo XClarity Administrator backups.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/managementServer/data
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| backups | Array of objects | Information about each backup | ||
| backupDate | String | Date and time when the backup was created | ||
| backupRequestedBy | String | Name of the user that created the backup | ||
| chassis | String | Number of managed chassis in the backup | ||
| checksum | String | Checksum that is used to verify the backup content | ||
| dhcp | Boolean | Indicates whether DHCP mode is enabled on the XClarity Administrator instance that was backed up. This can be one of the following values.
| ||
| dhcpEth | String | Network interface that uses DHCP (for example, “eth0”) If DHCP mode is disabled on the XClarity Administrator instance that was backed up, this value is empty. | ||
| dhcpMac | String | MAC address of the network interface that uses DHCP If DHCP mode is disabled on the XClarity Administrator instance that was backed up, this value is empty. | ||
| eth0IPv4 | String | IPv4 address of the eth0 interface | ||
| eth0IPv6 | String | IPv6 address of the eth0 interface | ||
| eth1IPv4 | String | IPv4 address of the eth1 interface | ||
| eth1IPv6 | String | IPv6 address of the eth1 interface | ||
| filename | String | Name of the XClarity Administrator backup | ||
| firmware | String | Total size of all firmware-update packages that are included in the backup | ||
| ipRedirect | String | IP address that is used to access the source XClarity Administrator. This IP address is used to redirect the browser after import is completed. | ||
| label | String | User-defined label for the backup | ||
| location | Array of strings | Location of the XClarity Administrator backup. This can be one or more of the following values.
| ||
| managementServerUuid | String | UUID of the target XClarity Administrator instance that was backed up | ||
| managementServerVersion | String | Version of the XClarity Administrator instance that was backed up | ||
| osImages | String | Total size of all operating-system images that are included in the backup | ||
| osImagesQty | String | Number of operating-system images in the backup | ||
| patterns | String | Number of configuration patterns in the backup | ||
| racks | String | Number of managed racks in the backup | ||
| servers | String | Number of managed servers in the backup | ||
| size | Integer | Total size of the backup package | ||
| storages | String | Number of managed storage devices in the backup | ||
| switches | String | Number of managed switches in the backup | ||
| urlRedirect | String | DNS address that is used to access the source XClarity Administrator, if applicable. If the DNS address exists, it is used to redirect the browser after import is completed. | ||
| users | String | Number of XClarity Administrator users in the backup | ||
| uuid | String | UUID of the backup file | ||
| result | String | Result of the request. This can be one of the following values.
| ||
| message | Object | Information about the error message | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | Message identifier of a returned message | ||
| recovery | Array of objects | Recovery information | ||
| text | String | User actions that can be taken to recover from the event | ||
| URL | String | Link to the help system for more information, if available | ||
| text | String | Message text associated with the message identifier | ||
The following example is returned if the request is successful.
{
"backups": [{
"backupDate": "16/10/2017 09:11:26",
"backupRequestedBy": "SUPERVISOR",
"chassis": "1",
"checksum": "36147a5b9aea6e4d66fb6551635ca0f77cf8f622645b6ff949527de48c5dcfd5",
"dhcp": false,
"dhcpEth": "",
"dhcpMac": "",
"eth0IPv4": "192.0.2.0",
"eth0IPv6": "fd55:faaf:e1ab:20fb:5054:ff:feb7:cb7c",
"eth1IPv4": "",
"eth1IPv6": "",
"filename": "56be1884-3187-4a4c-90b5-13f05ee824a2_LXCA_Backup1.tar",
"firmware": "0",
"ipRedirect": "192.0.2.0",
"label": "my_backup",
"location": ["internal", "/mnt/mount1"],
"managementServerUuid": "B6E7C884D5FE4F41AB0896FC1E74A3DB",
"managementServerVersion": "2.1.0-154",
"osImages": "0",
"osImagesQty": "0",
"patters": "0",
"racks": "0",
"servers": "15",
"size": 17776640,
"storages": "0",
"switches": "4",
"urlRedirect": "192.0.2.0",
"users": "4",
"uuid": "56be1884-3187-4a4c-90b5-13f05ee824a2"
},
{
"backupDate": "23/05/2018 13:30:45",
"backupRequestedBy": "SUPERVISOR",
"chassis": "1",
"checksum": "bb91001e1fe776ea3306c2f733232cb4ff5d09d996dff9b16983300d0a8f591",
"dhcp": true,
"dhcpEth": "eth0",
"dhcpMac": "10:89:22:ab:4f:1d",
"eth0IPv4": "10.243.16.45",
"eth0IPv6": "",
"eth1IPv4": "",
"eth1IPv6": "",
"filename": "4edf27ff-08d1-49b5-b7f3-7e8edc4fd278_testbkp.tar",
"firmware": "0",
"ipRedirect ": "10.243.16.45",
"label": "testbkp",
"location": ["internal"],
"managementServerUuid": "B6E7C884D5FE4F41AB0896FC1E74A3DB",
"managementServerVersion": "2.1.0-154",
"osImages": "0",
"osImagesQty": "0",
"patterns": "0",
"racks": "0",
"servers": "15",
"size": 237775640,
"storages": "0",
"switches": "4",
"urlRedirect": "mymgntsrv.labs.lenovo.com",
"users": "4",
"uuid": "4edf27ff-08d1-49b5-b7f3-7e8edc4fd278"
}],
"result": "success",
"message": []
}
Give documentation feedback