GET /osdeployment/osInfo

Use this method to return information about the operating system that was deployed successfully by this Lenovo XClarity Administrator instance for each managed server.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/osdeployment/osInfo

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.
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. OS Installation Completed 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 static in the Global OS deployment settings.
		ipAddress	String	IP address of the host server. This is used when the network setting is set to static in the Global OS deployment settings.
		ipMode	String	Method for assigning IP addresses for operating-system deployment. This can be one of the following values. dhcpv4 staticv4 staticv6
		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 IPv6 in 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. Local disk Embedded USB Hypervisor M.2drive SAN storage
		value	String	Storage location on which operating system image is deployed. This can be one of the following values. localdisk. Local disk drive. The first enumerated local disk drive in the managed server is used. M.2drive. M.2 drive. The first enumerated M.2 drive in the managed server is used. usbdisk. Embedded USB Hypervisor. This location is applicable only when a VMware ESXi image is being deployed to managed servers. If two hypervisor keys are installed on the managed server, the VMware installer selects the first enumerated key for deployment. lunpluswwn=`LUN`@`WWN`. FC SAN storage (for example, lunpluswwn=2@50:05:07:68:05:0c:09:bb). lunplusiqn=`LUN`@`IQN`. iSCSI SAN Storage (for example, lunplusiqn=0@iqn.1990-01.com.lenovo:tgt1). Specifying the `IQN` is optional if only one iSCSI target is configured If the `IQN` is not specified, the first detected iSCSI target is selected for OSDN. If specified, and exact match is made. 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. Success. The request was successful. Failed. The request failed.
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"
   },
   {
      "deployStatus": "OS Installation Completed",
      "hostname": "node750CE30C694",
      "installedOS": "win2019-x86_64-install-Standard_core",
      "name": "Mehlow-SR150-2",
      "networkSettings": [{
         "dns1": "",
         "dns2": "",
         "ipMode": "dhcpv4",
         "macAddress": "AUTO",
         "mtu": 1500
      }],
      "storageSettings": {
         "label": "Local Disk Drive",
         "value": "localdisk"
      },
      "uuid": "750CE30C694745BCB4631ADBEA3C66C9"
   }],
   "result": "success",
   "messages": []
}

Give documentation feedback

GET /osdeployment/osInfo

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​