GET /hostPlatforms

Use this method to return information about the host platforms.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/hostPlatforms

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
availableImages					Array of strings	Operating-system image profile ID. This ID is made up of the OS-image name and image-profile name separated by a bar (for example, `sles12.2\|sles12.2-x86_64-install-Basic`).
imagesWithoutWinPERemoved					Boolean	Indicates whether Windows images that have no matching WinPE are removed from the availableImages list.
incompatibleImagesRemoved					Boolean	Indicates whether images that not supported in the current security mode are removed from the availableImages list
isAuthorized					Boolean	Indicates whether the user is assigned a role that can manage and deploy an operating system. This can be one of the following values. true. The user is authorized. false. The user is not authorized.
items					Array of objects	Information about all other host platforms
	availableImages
		label			String	Name of the operating system image profile
		selected			Boolean	Internal use only
		value			String	ID of the operating system image profile
	bay				String	Bay number of the host platform in the chassis, if the host platform is a server in a Flex chassis
	bootOrder				Array
		bootOrderList			Array
			currentBootOrderDevices		String	Boot order that is currently configured for a specified boot type
			bootType		String	Boot type of the boot order setting. The boot type must match a supported boot type for the server and varies by operating system.
			possibleBootOrderDevices		String	Boot order devices that are available for the specified boot type
	chassisIpAddress				String	IP address of the chassis that is associated with the host platform. This is applicable only if the host platform is a server in a Flex System chassis.
	chassisName				String	Name of the chassis that is associated with the host platform. This is applicable only if the host platform is a server in a Flex System chassis.
	chassisuuid				String	UUID of the chassis in which the host platform resides, if the host platform is a server in a Flex System chassis
	deployStatus				String	Deployment status. This can be one of the following values. 0. Ready 1. Not Ready 2. Unknown OS Deploy Status 3. No OS being deployed 4. OS Deployment Starting 5. Pre-deployment Validation 6. Node Created 7. Node Updated 8. Bootable ISO Created 9. Bootable ISO Mounted 10. Boot Order Sequence Modified 11. Node Rebooting 12. Node Restarted 13. Preparing Server for OS installation 14. Installing OS 15. Post-Installation Processing 16. Starting newly installed OS 17. OS Installation Completed 18. OS Discovery Started 19. Post-Deployment Cleanup Started 20. OS Deployment Failed 21. OS Deployment Stopped 22. Failed Preparing Server for OS Installation - storage failure 23. Failed Preparing Server for OS Installation - unsupported USB storage failure 24. Failed Preparing Server for OS Installation - unsupported SAN detected failure 25. Failed Preparing Server for OS Installation - Windows partition failure XCAT status 26. Active directory join failed 27. Active directory join succeeded using domain credentials 28. Active directory join succeeded using blob 29. Failed Preparing Server for OS Installation – hypervisor key detected 30. Custom post-install scripts started 31. Custom post-install script started 32. Custom post-install script completed 33. Custom post-install scripts completed 34. Downloading custom software payloads 35. Downloading custom software payload 36. Finished downloading custom software payload 37. Error downloading custom software payload 38. Finished downloading custom software payloads 39. Extracting custom software payloads 40. Extracting custom software payload 41. Finished extracting custom software payload 42. Error extracting custom software payload 43. Finished extracting custom software payloads 44. Workload deployment succeeded 45. Workload deployment is running with warning 46. Workload deployment failed 47. Workload deployment message 48. Custom post-install script error 49. Installing custom drivers 50. Installing custom driver 51. Finished installing custom driver 52. Error installing custom driver 53. Finished installing custom drivers Note If the deployStatus is Not Ready, use the readyCheck attribute to get information to help resolve the problem.
	deployStatusID				Integer	Status ID of the host platform when the operating system is actively being deployed
	id				String	UUID of the host platform
	immIpAddress				String	IP address of the baseboard management controller for the host platform
	isRealNode				Boolean	Indicates whether the server is real or demo. This can be one of the following values. true. The server is a real server. false. The server is a demo server.
	licenseKey				String	License key for Windows or ESXI operating system
	mgmtProcType				String	Type of management controller. This can be one of the following values. FSP IMM2 lenovo-AMI-controller XCC XCC2 UNKNOWN
	name				String	Name of the host platform
	networkSettings				Array	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.
		hostname			String	Hostname that is used for the host server
		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. If using static IP addresses, you must specify either the hostname or IP address. If using DHCP, you must specify the hostname of the server.
		macAddress			Array	Information about the MAC address
			label		String	MAC address of the host platform and the port status, separated by a dash (for example, 08:94:EF:4E:FB:C2 – Up). The port status can be one of the following values. Up Down N/A. Not applicable Note If the device is a ThinkServer server with expansion Ethernet adapter cards, no MAC address is returned. It is recommended that you use the default `AUTO` setting when specifying the MAC address for deployment.
			selected		String	Internal use only
			value		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. Note If the device is a ThinkServer server with expansion Ethernet adapter cards, no MAC address is returned. It is recommended that you use the default `AUTO` setting when specifying the MAC address for deployment.
		mtu			String	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.
		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.
		vlanId			String	VLAN ID for operating-system VLAN tagging This attribute is valid only if in VLAN mode is enabled (see GET /osdeployment/globalSettings).
	nodeType				String	Type of the host platform
	primary				String	Indicates whether the host platform is the primary node within the scalable partition
	rackID				String	Name of the rack in which the host platform resides
	rackUnit				String	Lowest unit number in the rack for the device on which the host platform resides
	readyCheck				Array
		accessState			String	Current state of the host platform. This can be one of the following values. Online Offline Partial Pending Unknown Notes For servers in a Flex chassis, this reflects the current state. For rack servers, this value is set to unSupported. The access state must be online Online or unSupported to deploy an operating system on the host platform.
		isAuthorized			Boolean	Indicates whether the user is assigned a role that can manage and deploy an operating system. This can be one of the following values. true. The user is authorized. false. The user is not authorized.
		remotePresenceMode			String	Indicates whether the virtual media (also known as remote media) is enabled. Virtual media must be enabled to deploy operation systems. This can be one of the following values. Enabled. Virtual media is enabled. Disabled. Virtual media is disabled. You cannot deploy an operating system on the server. Note To use virtual media, XClarity Controller Enterprise or the remote-presence FoD key must be enabled on the server.
		secureBootMode			String	Indicates whether secure boot mode is enabled. This can be one of the following values. Enabled. Secure boot mode is enabled. You cannot deploy an operating system on the server. Disabled. Secure boot mode is disabled.
		uefiMode			String	Indicates whether the UEFI boot mode is enabled. This can be one of the following values. Enabled. The boot mode is UEFI. Disabled. The boot mode is not UEFI. You cannot deploy an operating system on the server. Tip You can modify the UEFI mode using server patterns.
		validMac			String	Indicates whether the MAC address is valid. This can be one of the following values. ok. The MAC address is a valid address. error. The MAC address is empty. You cannot deploy an operating system on the server. not found. A valid MAC address was not found. Consider setting the macAddress to `AUTO` to automatically detect valid Ethernet MAC addresses that can be used.
		vlanAutoMac			String	Indicates whether the MAC addresses are valid under VLAN mode. This can be one of the following values. ok. There are MAC addresses other than AUTO. error. The only MAC address is AUTO, or the selected MAC address is AUTO. You cannot deploy an operating system on the server. Tip If available, select a MAC address other than AUTO. Alternatively, do not use VLANs in global settings.
	remoteControl				String	Indicates the remote-control enablement status. This can be one of the following values. singleUser. Only one user can be logged in at a time. multiUser. Multiple users can be logged at a time. disabled. Remote control is disabled.
	storageSettings				String
		label			String	Name of the preferred 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 Note For ThinkServer servers, this value is always Local disk.
		selected			String	Internal use only
		value			String	Name of the preferred 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 platform
	windowsDomain				Array	Information about Active Directory domains
		domainName			String	Name of Active Directory domain to which the Windows operating system is joined
		OU			String	Organizational unit of Active Directory domain
partitions					Array	Host platforms that support multiple node functionality
	nodes				Array	IP address of the baseboard management controller for the host platform
		availableImages			Array	Operating-system profiles that this server supports
			label		String	Name of the operating system image profile
			selected		Boolean	Internal use only
			value		String	ID of the operating system image profile
		bay			String	Bay number of the host platform in the chassis, if the host platform is a server in a Flex chassis
		bootOrder			Array
			bootOrderList		Array
				bootType	String	Boot type of the boot order setting. This can be one of the following values. BootOrder CDDVDROMBootOrder HardDiskBootOrder NetworkBootOrder Permanent SingleUse USBBootOrder WakeOnLan Unknown
				currentBootOrderDevices	String	Boot order that is currently configured for a specified boot type
				possibleBootOrderDevices	String	Boot order devices that are available for the specified boot type
		chassisName			String	Name of the chassis that is associated with the host platform. This is applicable only if the host platform is a server in a Flex chassis.
		chassisIpAddress			String	IP address of the chassis that is associated with the host platform. This is applicable only if the host platform is a server in a Flex chassis.
		chassisuuid			String	UUID of the chassis in which the host platform resides, if the host platform is a server in a Flex chassis
		deployStatus			String	Deploy status. This can be one of the following values. Ready Not Ready Unknown OS Deploy Status No OS being deployed OS Deployment Starting Pre-deployment Validation Node Created Node Updated Bootable ISO Created Bootable ISO Mounted Boot Order Sequence Modified Node Rebooting Node Restarted Preparing Server for OS installation Installing OS Post-Installation Processing Starting newly installed OS OS Installation Completed OS Discovery Started Post-Deployment Cleanup Started OS Deployment Failed OS Deployment Stopped Failed Preparing Server for OS Installation - storage failure Failed Preparing Server for OS Installation - unsupported USB storage failure Failed Preparing Server for OS Installation - unsupported SAN detected failure Failed Preparing Server for OS Installation - Windows partition failure XCAT status Active directory join failed Active directory join succeeded using domain credentials Active directory join succeeded using blob Failed Preparing Server for OS Installation – hypervisor key detected Custom post-install scripts started Custom post-install script started Custom post-install script completed Custom post-install scripts completed Downloading custom software payloads Downloading custom software payload Finished downloading custom software payload Error downloading custom software payload Finished downloading custom software payloads Extracting custom software payloads Extracting custom software payload Finished extracting custom software payload Error extracting custom software payload Finished extracting custom software payloads Workload deployment succeeded Workload deployment is running with warning Workload deployment failed Workload deployment message Installing custom drivers Installing custom driver Finished installing custom driver Error installing custom driver Finished installing custom drivers Note You cannot deploy an operating-system image to that server if the deployStatus is Not Ready.. Use the readyCheck attribute to get information to help resolve the problem. If all of the validation checks pass, verify that the network settings are configured.
		deployStatusID			Integer	Status ID of the host platform when the operating system is actively being deployed. This can be one of the following values. 0. Ready 1. Not Ready 2. Unknown OS Deploy Status 3. No OS being deployed 4. OS Deployment Starting 5. Pre-deployment Validation 6. Node Created 7. Node Updated 8. Bootable ISO Created 9. Bootable ISO Mounted 10. Boot Order Sequence Modified 11. Node Rebooting 12. Node Restarted 13. Preparing Server for OS installation 14. Installing OS 15. Post-Installation Processing 16. Starting newly installed OS 17. OS Installation Completed 18. OS Discovery Started 19. Post-Deployment Cleanup Started 20. OS Deployment Failed 21. OS Deployment Stopped 22. Failed Preparing Server for OS Installation - storage failure 23. Failed Preparing Server for OS Installation - unsupported USB storage failure 24. Failed Preparing Server for OS Installation - unsupported SAN detected failure 25. Failed Preparing Server for OS Installation - Windows partition failure XCAT status 26. Active directory join failed 27. Active directory join succeeded using domain credentials 28. Active directory join succeeded using blob 29. Failed Preparing Server for OS Installation – hypervisor key detected 30. Custom post-install scripts started 31. Custom post-install script started 32. Custom post-install script completed 33. Custom post-install scripts completed 34. Downloading custom software payloads 35. Downloading custom software payload 36. Finished downloading custom software payload 37. Error downloading custom software payload 38. Finished downloading custom software payloads 39. Extracting custom software payloads 40. Extracting custom software payload 41. Finished extracting custom software payload 42. Error extracting custom software payload 43. Finished extracting custom software payloads 44. Workload deployment succeeded 45. Workload deployment is running with warning 46. Workload deployment failed 47. Workload deployment message 48. Custom post-install script error 49. Installing custom drivers 50. Installing custom driver 51. Finished installing custom driver 52. Error installing custom driver 53. Finished installing custom drivers
		id			String	Internal use only. Use the uuid attribute instead.
		immIpAddress			String	IP address of the baseboard management controller for the host platform
		isRealNode			Boolean	Indicates whether the server is real or demo. This can be one of the following values. true. The server is a real server. false. The server is a demo server.
		licenseKey			String	License key for Windows or ESXI operating system
		mgmtProcType			String	Type of management controller. This can be one of the following values. FSP IMM2 lenovo-AMI-controller XCC XCC2 UNKNOWN
		name			String	Name of the host platform
		networkSettings			Array	Information about network settings
			mtu		String	Internal use only
			dns1		String	Internal use only
			dns2		String	Internal use only
			gateway		String	Internal use only
			hostname		String	Internal use only
			subnetMask		String	Internal use only
			macAddress		Array	Information about the MAC address
				label	String	MAC address of the host platform and the port status, separated by a dash (for example, 08:94:EF:4E:FB:C2 – Up). The port status can be one of the following values. Up Down N/A. Not applicable
				selected	String	Internal use only
				value	String	MAC address of the host platform
			prefixLength		String	Internal use only
			ipAddress		String	Internal use only
		nodeType			String	Type of the host platform
		rackID			String	Name of the rack in which the host platform resides
		rackUnit			String	Lowest unit number in the rack for the device on which the host platform resides
		readyCheck			Array	List of validation checks
			accessState		String	Current state of the host platform. This can be one of the following values. Online Offline Partial Pending Unknown Notes For servers in a Flex chassis, this reflects the current state. For rack servers, this value is set to unSupported. The access state must be online Online or unSupported to deploy an operating system on the host platform.
			isAuthorized		Boolean	Indicates whether the user is assigned a role that can manage and deploy an operating system. This can be one of the following values. true. The user is authorized. false. The user is not authorized.
			remotePresenceMode		String	Indicates whether the virtual media (also known as remote media) is enabled. Virtual media must be enabled to deploy operation systems. This can be one of the following values. Enabled. Virtual media is enabled. Disabled. Virtual media is disabled. You cannot deploy an operating system on the server. Note To use virtual media, XClarity Controller Enterprise or the remote-presence FoD key must be enabled on the server.
			secureBootMode		String	Indicates whether secure boot mode is enabled. This can be one of the following values. Enabled Secure boot mode is enabled. You cannot deploy an operating system on the server. Disabled. Secure boot mode is disabled.
			uefiMode		String	Indicates whether the UEFI boot mode is enabled. This can be one of the following values. Enabled The boot mode is UEFI. Disabled. The boot mode is not UEFI. You cannot deploy an operating system on the server. Tip You can modify the UEFI mode using server patterns.
			validMac		String	Indicates whether the MAC address is valid. This can be one of the following values. ok. The MAC address is a valid address. error. The MAC address is empty. You cannot deploy an operating system on the server. not found. A valid MAC address was not found. Consider setting the macAddress to `AUTO` to automatically detect valid Ethernet MAC addresses that can be used.
		remoteControl			String	Indicates the remote-control enablement status. This can be one of the following values. singleUser. Only one user can be logged in at a time. multiUser. Multiple users can be logged at a time. disabled. Remote control is disabled.
		storageSettings			Array	Preferred storage location on which you want to deploy operating-system images
			label		String	Descriptive name of the preferred storage location. This can be one of the following values. Local disk Embedded USB Hypervisor M.2drive SAN storage
			selected		Boolean
			value		String	Preferred storage location. 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.
		uuid			String	UUID of the host platform
		windowsDomain			Array	Information about Active Directory domains
			domainName		String	Name of Active Directory domain to which the Windows operating system is joined
			OU		String	organizational unit of Active Directory domain
	partitionID				String	Partition ID, if the server is in a scalable complex
	partitionName				String	Partition name, if the server is in a scalable complex
	uuid				String	Partition UUID, if the server is in a scalable complex
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.

{
   "availableImages": ["esxi5.5_2.33|esxi5.5_2.33-x86_64-install-Virtualization"],
   "imagesWithoutWinPERemoved": true,
   "incompatibleImagesRemoved": false,
   "isAuthorized": true,
   "items": [{
      "availableImages": [{
         "label": "esxi5.5_2.33|esxi5.5_2.33-x86_64-install-Virtualization"
         "selected": true,
         "value": "esxi5.5_2.33|esxi5.5_2.33-x86_64-install-Virtualization",
      }],
      "bay": "13",
      "bootOrder": {
         "bootOrderList": [{
            "currentBootOrderDevices": ["None"],
            "bootType": "SingleUse",
            "possibleBootOrderDevices": [
               "None",
               "PXE Network",
               "Disk Drive 0",
               "Diagnostics",
               "CD\/DVD Rom",
               "Boot To F1",
               "Hypervisor",
               "Floppy Disk"
            ]
         },
         ...,
         {
            "bootType": "Permanent",
            "currentBootOrderDevices": [
               "CD\/DVD Rom",
               "Disk Drive 0",
               "PXE Network"
            ],
            "possibleBootOrderDevices": [
               "CD\/DVD Rom",
               "Diagnostics",
               "DSA",
               "Embedded Hypervisor",
               "Floppy Disk",
               "Disk Drive 0",
               "Disk Drive 1",
               "Disk Drive 2",
               "Disk Drive 3",
               "Disk Drive 4",
               "IMM1",
               "IMM2",
               "iSCSI",
               "iSCSI Critical",
               "Legacy Only",
               "NIC1",
               "NIC2",
               "PXE Network",
               "SAS",
               "SdRaid",
               "Slot1Dev1",
               "Slot1Dev2",
               "Slot1Dev3",
               "Slot2Dev1",
               "Slot2Dev2",
               "Slot2Dev3",
               "Slot3Dev1",
               "Slot3Dev2",
               "USB Storage",
               "USB1",
               "USB2",
               "USB3",
               "VNIC1",
               "VNIC2",
               "VNIC3",
               "VNIC4",
               "VNIC5",
               "VNIC6"
            ]
         }]
      },
      "chassisIpAddress": "192.0.2.0",
      "chassisName": "SN#Y034BG16E0AR",
      "chassisuuid": "FBEF740B178F4EFAA846E7225EE256DC"
      "deployStatus": "Not Ready",
      "deployStatusID": 1,
      "id": "69BDF8912E5211E4998B40F2E99033F0",
      "immIpAddress": "192.0.2.10",
      "isRealNode": true,
      "licenseKey": "",
      "mgmtProcType": "IMM2",
      "name": "node12",
      "networkSettings": {
         "dns1": "",
         "dns2": "",
         "gateway": "",
         "hostname": "",
         "ipAddress": "",
         "macAddress": [{
            "label": "AUTO",
            "selected": true,
            "value": "AUTO"
         },
         ...,
         {
            "label": "40:F2:E9:90:33:FC - Down",
            "selected": false,
            "value": "40:F2:E9:90:33:FC"
         }],
         "mtu": 1500,
         "prefixLength": 0,
         "subnetMask": "",
         "vlanId": "2"
      },
      "nodeType": "ite",
      "primary": false,
      "rackID": "",
      "rackUnit": "0",
      "readyCheck": {
         "accessState": "Online",
         "isAuthorized": true,
         "remotePresenceMode": "Enabled",
         "secureBootMode": "Disabled",
         "uefiMode": "Enabled",
         "validMac": "ok"
      },
      "remoteControl": "multiUser",
      "storageSettings": [{
         "label": "Local Disk",
         "selected": true,
         "value": "localdisk"
      },
      {
         "label": "Embedded Hypervisor",
         "selected": false,
         "value": "usbdisk"
      }],
      "uuid": "69BDF8912E5211E4998B40F2E99033F0",
      "windowsDomain": {
         "domainName": "",
         "OU": ""
      },
   },
   ...,
   {
      "availableImages": [{
         "label": "esxi5.5_2.33|esxi5.5_2.33-x86_64-install-Virtualization",
         "selected": true,
         "value": "esxi5.5_2.33|esxi5.5_2.33-x86_64-install-Virtualization"
      }],
      "bay": "3",
      "bootOrder": {
         "bootOrderList": [{
            "currentBootOrderDevices": ["None"],
            "bootType": "SingleUse",
            "possibleBootOrderDevices": [
               "None",
               "PXE Network",
               "Disk Drive 0",
               "Diagnostics",
               "CD\/DVD Rom",
               "Boot To F1",
               "Hypervisor",
               "Floppy Disk"
            ]
         },
         ...,
         {
            "currentBootOrderDevices": [
               "CD\/DVD Rom",
               "Floppy Disk",
               "Disk Drive 0",
               "PXE Network"
            ],
            "bootType": "Permanent",
            "possibleBootOrderDevices": [
               "CD\/DVD Rom",
               "Diagnostics",
               "DSA",
               "Embedded Hypervisor",
               "Floppy Disk",
               "Disk Drive 0",
               "Disk Drive 1",
               "Disk Drive 2",
               "Disk Drive 3",
               "Disk Drive 4",
               "IMM1",
               "IMM2",
               "iSCSI",
               "iSCSI Critical",
               "Legacy Only",
               "NIC1",
               "NIC2",
               "PXE Network",
               "SAS",
               "SdRaid",
               "Slot1Dev1",
               "Slot1Dev2",
               "Slot1Dev3",
               "Slot2Dev1",
               "Slot2Dev2",
               "Slot2Dev3",
               "Slot3Dev1",
               "Slot3Dev2",
               "USB Storage",
               "USB1",
               "USB2",
               "USB3",
               "VNIC1",
               "VNIC2",
               "VNIC3",
               "VNIC4",
               "VNIC5",
               "VNIC6"
            ]
         }]
      },
      "chassisIpAddress": "10.240.73.217",
      "chassisName": "SN#Y034BG16E0BH",
      "chassisuuid": "8C070E3262114E36B7E68699386FBA53"
      "deployStatus": "Not Ready",
      "deployStatusID": 1,
      "id": "0E0BEA009E2411E2BEB93440B5EFB9B8",
      "immIpAddress": "10.240.74.69",
      "isRealNode": true,
      "licenseKey": "",
      "mgmtProcType": "IMM2",
      "name": "node04_2",
      "networkSettings": {
         "dns1": "",
         "dns2": "",
         "gateway": "",
         "hostname": "",
         "ipAddress": "",
         "macAddress": [{
            "label": "34:40:B5:EF:B9:B8 - Up",
            "selected": true,
            "value": "34:40:B5:EF:B9:B8"
         },
         {
            "label": "34:40:B5:EF:B9:BC - Down",
            "selected": false,
            "value": "34:40:B5:EF:B9:BC"
         }],
         "mtu": 1500,
         "prefixLength": 0,
         "subnetMask": ""
         "vlanId": "2"
      },
      "nodeType": "ite",
      "primary": false,
      "rackID": "",
      "rackUnit": "0",
      "readyCheck": {
         "accessState": "Online",
         "remotePresenceMode": "Enabled",
         "secureBootMode": "Disabled",
         "uefiMode": "Enabled",
         "validMac": "ok"
      },
      "remoteControl": "multiUser",
      "storageSettings": [{
         "label": "Local Disk",
         "selected": true,
         "value": "localdisk"
      },
      {
         "label": "Embedded Hypervisor",
         "selected": false,
         "value": "usbdisk"
      }],
      "windowsDomain": {
         "domainName": "",
         "OU": ""
      },

      "uuid": "0E0BEA009E2411E2BEB93440B5EFB9B8",
   }],
   "partitions": [{
      "nodes": [{
         "availableImages": [{
            "label": "rhels6.6|rhels6.6-x86_64-install-Basic",
            "selected": true,
            "value": "rhels6.6|rhels6.6-x86_64-install-Basic"
         },
         {
            "label": "rhels6.6|rhels6.6-x86_64-install-Minimal",
            "selected": false,
            "value": "rhels6.6|rhels6.6-x86_64-install-Minimal"
         },
         ...,
         {
            "label": "esxi6|esxi6-x86_64-install-Virtualization",
            "selected": false,
            "value": "esxi6|esxi6-x86_64-install-Virtualization"
         }],
         "bay": "",
         "bootOrder": {
            "bootOrderList": [{
               "currentBootOrderDevices": ["None"],
               "bootType": "SingleUse",
               "possibleBootOrderDevices": [
                  "None",
                  "PXE Network",
                  "Disk Drive 0",
                  "Diagnostics",
                  "CD\/DVD Rom",
                  "Boot To F1",
                  "Hypervisor",
                  "Floppy Disk"
               ]
            },
            ...,
            {
               "currentBootOrderDevices": [
                  "PXE Network",
                  "CD\/DVD Rom",
                  "Disk Drive 0"
               ],
               "bootType": "WakeOnLAN",
               "possibleBootOrderDevices": [
                  "PXE Network",
                  "CD\/DVD Rom",
                  "Disk Drive 0",
                  "Red Hat Enterprise Linux",
                  "Floppy Disk",
                  "Disk Drive 1",
                  "Disk Drive 2",
                  "Disk Drive 3",
                  "Disk Drive 4",
                  "USB Storage",
                  "Diagnostics",
                  "iSCSI",
                  "iSCSI Critical",
                  "Embedded Hypervisor",
                  "Legacy Only",
                  "USB0",
                  "USB1",
                  "USB2",
                  "USB3",
                  "USB4",
                  "USB5",
                  "USB6",
                  "USB7",
                  "DSA",
                  "Slot16",
                  "Slot17",
                  "Slot18",
                  "Slot19",
                  "Slot12",
                  "Slot11",
                  "Slot10",
                  "Slot1",
                  "Slot2",
                  "Slot3",
                  "Slot4",
                  "Slot5",
                  "Slot6",
                  "Slot7",
                  "Slot8",
                  "Slot9",
                  "IMM1",
                  "IMM2",
                  "Node2-USB0",
                  "Node2-USB1",
                  "Node2-USB2",
                  "Node2-USB3",
                  "Node2-USB4",
                  "Node2-USB5",
                  "Node2-USB6",
                  "Node2-USB7",
                  "Node2-Slot16",
                  "Node2-Slot17",
                  "Node2-Slot18",
                  "Node2-Slot19",
                  "Node2-Slot12",
                  "Node2-Slot11",
                  "Node2-Slot10",
                  "Node2-Slot1",
                  "Node2-Slot2",
                  "Node2-Slot3",
                  "Node2-Slot4",
                  "Node2-Slot5",
                  "Node2-Slot6",
                  "Node2-Slot7",
                  "Node2-Slot8",
                  "Node2-Slot9",
                  "Node2-IMM1",
                  "Node2-IMM2"
               ]
            }]
         },
         "chassisIpAddress": "",
         "chassisName": "",
         "chassisuuid": "",
         "deployStatus": "Ready",
         "deployStatusID": 0,
         "name": "SAMT-D8S-1B",
         "id": "401D78E65B2AB7012FCA98E54FA1FAFE",
         "immIpAddress": "fd55:faaf:e1ab:20fa:42f2:e9ff:fe4d:2a1",
         "isRealNode": true,
         "licenseKey": "",
         "mgmtProcType": "IMM2",
         "name": "SAMT-D8S-1B",
         "networkSettings": {
            "dns1": "",
            "dns2": "",
            "gateway": "",
            "hostname": "",
            "ipAddress": "",
            "macAddress": [{
               "label": "00:0A:F7:25:76:C2",
               "selected": true,
               "value": "00:0A:F7:25:76:C2"
            },
            {
               "label": "00:0A:F7:25:76:C3",
               "selected": false,
               "value": "00:0A:F7:25:76:C3"
            }],
            "mtu": 1500,
            "prefixLength": 0,
            "subnetMask": ""
         "vlanId": "2"
         },
         "nodeType": "rack-tower server",
         "primary": true,
         "rackID": "",
         "rackUnit": "0",
         "readyCheck": {
            "accessState": "Online",
            "isAuthorized": true,
            "remotePresenceMode": "Enabled",
            "secureBootMode": "Disabled",
            "uefiMode": "Enabled",
            "validMac": "ok"
         },
         "remoteControl": "multiUser",
         "storageSettings": [{
            "label": "Local Disk",
            "selected": true,
            "value": "localdisk",,
         },
         {
            "label": "Embedded USB Hypervisor",
            "selected": false,
            "value": "usbdisk"
         }],
         "uuid": "401D78E65B2AB7012FCA98E54FA1FAFE",
         "windowsDomain": {
            "domainName": "",
            "OU": ""
         },
      }],
      "partitionID": "1",
      "partitionName": "SAMT-D8S-1B (Partition 1)"
      "uuid": "401D78E65B2AB7012FCA98E54FA1FAFE",
   }],
   "result": "success",
   "messages": []
}

The following example is returned if the request is not successful.

{
   "result": "failed",
   "messages": [{
      "explanation": "An internal error occurred while obtaining the list of all nodes.",
      "id": "FQXHMFC0080M",
      "message": "Unable to obtain the list of all nodes.",
      "recovery": {
         "URL": "",
         "text": "Attempt the operation again. If the problem persists, contact Support."
      }
   }]
}

Give documentation feedback

GET /hostPlatforms

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​