GET /osdeployment/hostSettings/{uuid}
Use this method to return information about the network and storage settings for a specific server.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/osdeployment/hostSettings/{uuid}
where {uuid} is the UUID of the server. To obtain the UUID, use the GET /nodes method.
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. |
| 409 | Conflict | There is a conflict with the current state of the resource. 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 | ||||
|---|---|---|---|---|---|---|
| host | Object | Information about host settings for the specified server | ||||
| networkSettings | Object | Information about network settings | ||||
| dns1 | String | Preferred DNS server for the host server to be used after the operating system is deployed | ||||
| dns2 | String | Alternative DNS server for the host server to be used after the operating system is deployed | ||||
| gateway | String | Gateway of the host server to be used after the operating system is deployed. This is used when the network setting is set to static in the Global OS deployment settings. Tip To determine the IP mode, use | ||||
| hostname | String | Hostname of the host server If a hostname is not specified, a default hostname is assigned. | ||||
| ipAddress | String | IP address of the host server to be used after the operating system is deployed. This is used when the network setting is set to static in the Global OS deployment settings. | ||||
| mtu | Long | Maximum transmission unit for the host to be used after the operating system is deployed | ||||
| prefixLength | String | Prefix length of the host IP address to be used after the operating system is deployed. This is used when the network setting is set to static IPv6 in the Global OS deployment settings. | ||||
| selectedMAC | String | MAC address of the host server to which the IP address is to be bound The MAC address is set to AUTO by default. This setting automatically detects the Ethernet ports that can be configured and used for deployment. The first MAC address (port) that is detected is used by default. If connectivity is detected on a different MAC address, the XClarity Administrator host is automatically restarted to use the newly detected MAC address for deployment. VLAN mode is supported only for servers that have MAC addresses in their inventory. If AUTO is the only the MAC address that is available for a server, then VLANs cannot be used to deploy operating systems to that server. Tip To obtain the MAC address, use the macaddress | ||||
| subnetMask | String | Subnet mask of the host server to be used after the operating system is deployed. This is used when the network setting is set to static in the Global OS deployment settings. Tip To determine the IP mode, use the | ||||
| vlanId | String | VLAN ID for operating-system VLAN tagging This attribute is valid only if in VLAN mode is enabled (see GET /osdeployment/globalSettings). Important Only specify a VLAN ID when a VLAN tag is required to function on the network. Using VLAN tags can affect the network routability between the host operating system and the | ||||
| selectedImage | String | Name of the selected OS image to be deployed | ||||
| storageSettings | Object | Preferred storage location on which you want to deploy operating-system images | ||||
| targetDevice | String | Target device. This can be one of the following values.
Note For ThinkServer servers, this value is always localdisk. | ||||
| 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.
{
"hosts": {
"networkSettings": {
"dns1": "",
"dns2": "",
"gateway": "",
"hostname": "",
"ipAddress": "",
"mtu": 1500,
"prefixLength": 0,
"selectedMAC": "AUTO",
"subnetMask": "",
"vlanId": "2"
},
"storageSettings": {
"targetDevice": "localdisk"
}
},
"result": "success",
"messages": []
}
Give documentation feedback