Get hardware entity information
get
/rest/{version}/system/hardware
Retrieves various hardware entity information such as chassis, CPU model, main board, network ports, power supplies, fan units, and other hardware-related information. Only supported on hardware SBCs, not virtual SBCs.
Request
Path Parameters
-
version(required):
REST API version string.
Available values: v1.2
Header Parameters
-
Authorization(required):
The value in the Authorization header must be the string "
Bearer {access token}
", where{access token}
is a valid, unexpired token received in response to a prior/rest/{version}/auth/token
request.
Response
200 Response
OK - Requested data is returned in response body
400 Response
The request is malformed in some way or is missing required information and therefore cannot be processed.
401 Response
Unauthorized - Request lacks valid authentication credentials.
404 Response
Resource not found
Examples
Examples of Accessing the API
See Authenticate for how to acquire a token.
The following example shows how to get hardware entity information using curl.
curl -X GET \
--header "Accept: application/xml" \
--header "Authorization: Bearer $TOKEN" \
"https://${SBCIP}/rest/v1.1/system/hardware"
The following example shows how to get hardware entity information using Python.
import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url = "https://" + sbcip + "/rest/v1.1/system/hardware"
resp = requests.get(url, headers=headers)
Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<data>
<hardwareInformation>
<entity>
<index>1</index>
<description>Acme Packet 4600 Chassis</description>
<containedIn>0</containedIn>
<classDescr>chassis</classDescr>
<parentRelPos>0</parentRelPos>
<name>Acme Packet 4600 Chassis</name>
<serialNum>1111111111</serialNum>
<mfgName>Acme Packet</mfgName>
<isFRU>false</isFRU>
</entity>
<entity>
<index>2</index>
<description>Intel(R) Core(TM) i3-3120ME CPU @ 2.40GHz</description>
<containedIn>1</containedIn>
<classDescr>module</classDescr>
<parentRelPos>5</parentRelPos>
<name>Host CPU Processor</name>
<mfgName>RadiSys</mfgName>
<modeName>MOD-0114-61-01</modeName>
<isFRU>false</isFRU>
</entity>
<entity>
<index>3</index>
<description>Assy, 1100 Watt Power 110V Supply</description>
<containedIn>1</containedIn>
<classDescr>powerSupply</classDescr>
<parentRelPos>1</parentRelPos>
<name>Power Supply A</name>
<isFRU>true</isFRU>
</entity>
<entity>
<index>4</index>
<description>Assy, 1100 Watt Power 110V Supply</description>
<containedIn>1</containedIn>
<classDescr>powerSupply</classDescr>
<parentRelPos>2</parentRelPos>
<name>Power Supply B</name>
<isFRU>true</isFRU>
</entity>
<entity>
<index>5</index>
<description>Chassis Slot 0</description>
<containedIn>1</containedIn>
<classDescr>container</classDescr>
<parentRelPos>3</parentRelPos>
<name>Chassis Slot 0</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>6</index>
<description>Assy, Acme Packet 4600 Main Board</description>
<containedIn>5</containedIn>
<classDescr>module</classDescr>
<parentRelPos>1</parentRelPos>
<name>Main Board</name>
<hardwareRev>5.00</hardwareRev>
<firmwareRev>01.03</firmwareRev>
<serialNum>181550000576</serialNum>
<mfgName>MiTAC China - MSL</mfgName>
<modeName>Main Board I</modeName>
<isFRU>false</isFRU>
</entity>
<entity>
<index>7</index>
<description>Assy, 5-fan unit of 40x28 </description>
<containedIn>6</containedIn>
<classDescr>fan</classDescr>
<parentRelPos>1</parentRelPos>
<name>5-Fan 40x28</name>
<isFRU>true</isFRU>
</entity>
<entity>
<index>8</index>
<description>Sensor of fan speed</description>
<containedIn>5</containedIn>
<classDescr>sensor</classDescr>
<parentRelPos>2</parentRelPos>
<name>Fan Sensor</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>9</index>
<description>Sensor of temperature</description>
<containedIn>5</containedIn>
<classDescr>sensor</classDescr>
<parentRelPos>3</parentRelPos>
<name>Temperature Sensor</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>10</index>
<description>voltage sensor</description>
<containedIn>5</containedIn>
<classDescr>sensor</classDescr>
<parentRelPos>4</parentRelPos>
<name>Voltage Sensor</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>12</index>
<description>Management Port 0 10/100 Ethernet Copper</description>
<containedIn>11</containedIn>
<classDescr>port</classDescr>
<parentRelPos>1</parentRelPos>
<name>Wancom0</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>13</index>
<description>Management Port 1 10/100 Ethernet Copper</description>
<containedIn>11</containedIn>
<classDescr>port</classDescr>
<parentRelPos>2</parentRelPos>
<name>Wancom1</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>14</index>
<description>Management Port 2 10/100 Ethernet Copper</description>
<containedIn>11</containedIn>
<classDescr>port</classDescr>
<parentRelPos>3</parentRelPos>
<name>Wancom2</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>15</index>
<description>Assy, 2 Port 10GigE SFP and 4 Port GigE SFP</description>
<containedIn>5</containedIn>
<classDescr>module</classDescr>
<parentRelPos>6</parentRelPos>
<name>Dual Port 10GigE and 4 Port 1GigE PHY</name>
<hardwareRev>2.00</hardwareRev>
<firmwareRev>01.02</firmwareRev>
<serialNum>181551000395</serialNum>
<mfgName>MiTAC China - MSL</mfgName>
<modeName>PHY0 IDPROM</modeName>
<isFRU>true</isFRU>
</entity>
<entity>
<index>36</index>
<description>Media port 0 1Gig Ethernet - Logical Slot 0 Port 0</description>
<containedIn>15</containedIn>
<classDescr>port</classDescr>
<parentRelPos>1</parentRelPos>
<name>Media port 0 1Gig Ethernet - Logical Slot 0 Port 0</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>37</index>
<description>Media port 1 1Gig Ethernet - Logical Slot 0 Port 1</description>
<containedIn>15</containedIn>
<classDescr>port</classDescr>
<parentRelPos>2</parentRelPos>
<name>Media port 1 1Gig Ethernet - Logical Slot 0 Port 1</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>38</index>
<description>Media port 2 1Gig Ethernet - Logical Slot 0 Port 2</description>
<containedIn>15</containedIn>
<classDescr>port</classDescr>
<parentRelPos>3</parentRelPos>
<name>Media port 2 1Gig Ethernet - Logical Slot 0 Port 2</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>39</index>
<description>Media port 3 1Gig Ethernet - Logical Slot 0 Port 3</description>
<containedIn>15</containedIn>
<classDescr>port</classDescr>
<parentRelPos>4</parentRelPos>
<name>Media port 3 1Gig Ethernet - Logical Slot 0 Port 3</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>40</index>
<description>Media port 4 10Gig Ethernet Fiber - Logical Slot 0 Port 4</description>
<containedIn>15</containedIn>
<classDescr>port</classDescr>
<parentRelPos>5</parentRelPos>
<name>Media port 4 10Gig Ethernet Fiber - Logical Slot 0 Port 4</name>
<isFRU>false</isFRU>
</entity>
<entity>
<index>41</index>
<description>Media port 5 10Gig Ethernet Fiber - Logical Slot 0 Port 5</description>
<containedIn>15</containedIn>
<classDescr>port</classDescr>
<parentRelPos>6</parentRelPos>
<name>Media port 5 10Gig Ethernet Fiber - Logical Slot 0 Port 5</name>
<isFRU>false</isFRU>
</entity>
</hardwareInformation>
</data>
<messages/>
<links/>
</response>