getHardwareInformation

The getHardwareInformation method returns detailed hardware information, including everything from the HardwareModelService, as well as CPU/Memory information.

Request Parameters
None
Response Parameters (return element children)
result


A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.
hardwareInformation

Some of these parameters are self-explanatory:
    • diskCount - The number of disks.
    • diskInformation
      • number - Number of disks.
      • size - Size in gigabytes.
      • total - Total number of disks.
    • hasMotorizedDriveTray - Does the drive have a motorized drive tray?
    • isServerHeadless - Is the server headless (no monitor).
    • memory - Memory installed.
    • memoryAvailable - How much of that memory is available.
    • memoryUsed - How much of that memory is in use.
    • model - The model of the hardware (or virtual machine).
    • objectId - The object ID.
    • oemModel - The OEM model, if available.
    • opticalDrives
      • driveTray - Is the optical drive tray motorized?
    • partitions - There may be multiple partitions. There are three in this sample case.
      • 0 - First partition.
        • available - Available space.
        • name - The name or mount point of the partition.
        • total - Total space on the partition.
        • unrestricted - Whether or not the partition is unrestricted.
        • used - How much space on the partition is used.
      • 1 - Second partition.
        • available - Available space.
        • name - The name or mount point of the partition.
        • total - Total space on the partition.
        • unrestricted - Whether or not the partition is unrestricted.
        • used - How much space on the partition is used.
      • 2 - Third partition.
        • available - Available space.
        • name - The name or mount point of the partition.
        • total - Total space on the partition.
        • unrestricted - Whether or not the partition is unrestricted.
        • used - How much space on the partition is used.
    • processorCount
    • processorSpeed
    • processorType
    • raidStatus - Information about RAID if available.
    • serialNumber - Serial number of the machine or virtual machine.
    • supportedHardware - True if hardware is supported, false if not.
    • virtualMachine - True if this is a virtual machine, false if not.

Example Request and Response
Request Response 
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: getHardwareInformation</wsa:Action>
		<wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:To></wsa:To>
	</soapenv:Header>
	<soapenv:Body>
		<getHardwareInformation xmlns="http://services.api.platform.vos.cisco.com"/>
	</soapenv:Body>
</soapenv:Envelope>
     
								
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
		<wsa:MessageID>urn:uuid:c0afa34a-410a-4788-852b-d28850abfb2b</wsa:MessageID>
		<wsa:Action>urn:getHardwareInformationResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getHardwareInformationResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax293="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax294="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax293:HardwareInformationResponse">
				<ax293:result>internal.request.complete</ax293:result>
				<ax293:hardwareInformation xsi:type="ax293:HardwareInformation">
					<ax293:diskCount>1</ax293:diskCount>
					<ax293:diskInformation>
						<ax293:number>1</ax293:number>
						<ax293:size>80</ax293:size>
						<ax293:total>1</ax293:total>
					</ax293:diskInformation>
					<ax293:hasMotorizedDriveTray>false</ax293:hasMotorizedDriveTray>
					<ax293:isServerHeadless>false</ax293:isServerHeadless>
					<ax293:memory>4096</ax293:memory>
					<ax293:memoryAvailable>120800</ax293:memoryAvailable>
					<ax293:memoryUsed>3804920</ax293:memoryUsed>
					<ax293:model>VMware</ax293:model>
					<ax293:objectId>1.3.6.1.4.1.9.1.1348</ax293:objectId>
					<ax293:oemModel></ax293:oemModel>
					<ax293:opticalDrives>
						<ax293:driveTray>opticaldrive.drivetray.nonmotorized</ax293:driveTray>
					</ax293:opticalDrives>
					<ax293:partitions>
						<ax293:available>1805760</ax293:available>
						<ax293:name>/</ax293:name>
						<ax293:total>14643056</ax293:total>
						<ax293:unrestricted>partition.unrestricted.false</ax293:unrestricted>
						<ax293:used>12688532</ax293:used>
					</ax293:partitions>
					<ax293:partitions>
						<ax293:available>13731912</ax293:available>
						<ax293:name>/partB</ax293:name>
						<ax293:total>14643120</ax293:total>
						<ax293:unrestricted>partition.unrestricted.false</ax293:unrestricted>
						<ax293:used>167376</ax293:used>
					</ax293:partitions>
					<ax293:partitions>
						<ax293:available>33281580</ax293:available>
						<ax293:name>/common</ax293:name>
						<ax293:total>50989088</ax293:total>
						<ax293:unrestricted>partition.unrestricted.notsupported</ax293:unrestricted>
						<ax293:used>15117332</ax293:used>
					</ax293:partitions>
					<ax293:processorCount>2</ax293:processorCount>
					<ax293:processorSpeed>2400</ax293:processorSpeed>
					<ax293:processorType>Intel(R) Xeon(R) CPU E7- 2870 @ 2.40GHz</ax293:processorType>
					<ax293:raidStatus>No RAID information is available ----------------------------------------------------------------------- Physical device information ----------------------------------------------------------------------- Number of Disks : 1 Hard Disk #1 Size (in GB) : 80</ax293:raidStatus>
					<ax293:serialNumber>VMware-42 09 cb 44 ba 75 bc a1-35 6b 51 bb 9e 9a dd 02</ax293:serialNumber>
					<ax293:supportedHardware>true</ax293:supportedHardware>
					<ax293:virtualMachine>true</ax293:virtualMachine>
				</ax293:hardwareInformation>
			</ns:return>
		</ns:getHardwareInformationResponse>
	</soapenv:Body>
</soapenv:Envelope>