GET /osdeployment/osInfo/{uuid_list}
Use this method to return information about the operating system that was deployed successfully by this Lenovo XClarity Administrator instance for a specific managed server
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/osdeployment/osInfo/{uuid_list}
where {uuid_list} is one or more UUIDs of managed servers, separated by a comma. To obtain the UUIDs, use the GET /nodes.
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. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
Attributes | Type | Description | ||||
---|---|---|---|---|---|---|
items | Array of objects | Information about all operating systems that were deployed on managed server using this XClarity Administrator instance | ||||
deployStatus | String | Deployment status. This can be the following value.
Note Results for only successful deployments are currently saved. | ||||
hostname | String | Hostname that is used for the host server | ||||
installedOS | String | OS profile that is deployed on the host server | ||||
name | String | Name of the host server | ||||
networkSettings | Object | Information about network settings | ||||
dns1 | String | Preferred DNS server for the host server | ||||
dns2 | String | Alternative DNS server for the host server | ||||
gateway | String | Gateway of the host server. This is used when the network setting is set to staticin the Global OS deployment settings. | ||||
ipAddress | String | IP address of the host server. This is used when the network setting is set to staticin the Global OS deployment settings. | ||||
ipMode | String | Method for assigning IP addresses for operating-system deployment. This can be one of the following values.
| ||||
macAddress | Long | Information about the MAC address | ||||
mtu | Long | Maximum transmission unit for the host | ||||
prefixLength | String | Prefix length of the host IP address. This is used when the network setting is set to static IPv6in the Global OS deployment settings. | ||||
subnetMask | String | Subnet mask of the host server. This is used when the network setting is set to static in the Global OS deployment settings. | ||||
vlanId | String | VLAN ID for operating-system VLAN tagging This attribute is valid only if in VLAN mode is enabled (see GET /osdeployment/globalSettings). | ||||
storageSettings | Object | Information about the storage location on which the operating-system image is deployed | ||||
label | String | Storage location on which operating system image is deployed. This can be one of the following values.
| ||||
value | String | Storage location on which operating system image is deployed. This can be one of the following values.
Note For ThinkServer servers, this value is always localdisk. | ||||
uuid | String | UUID of the host server | ||||
result | String | Result of the request. This can be one of the following values.
| ||||
messages | Array | Information about the message that is related to the result of the request | ||||
explanation | String | Additional information to clarify the reason for the message | ||||
id | String | Message identifier of a returned message | ||||
message | String | Message text associated with the message identifier | ||||
recovery | Array | 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 |
The following example is returned if the request is successful.
{
"items": [{
"deployStatus": "OS Installation Completed",
"hostname": "nodeC",
"installedOS": "win2019-x86_64-install-Standard",
"name": "Mehlow-SR250-2",
"networkSettings": [{
"dns1": "",
"dns2": "",
"gateway": "10.240.210.1",
"ipAddress": "10.240.210.154",
"ipMode": "staticv4",
"macAddress": "AUTO",
"mtu": 1500,
"subnetMask": "255.255.254.0"
}],
"storageSettings": {
"label": "Local Disk Drive",
"value": "localdisk"
},
"uuid": "C3050752827D4AD8B4D5AE60B332C4BD"
},
"result": "success",
"messages": []
}
Give documentation feedback