Listing Hardware: list_all_hardware
|
Service name: list_all_hardware |
|
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=list_all_hardware &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Lists all hardware for the given asset. |
|
Parameters |
|||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
|
assetid |
The assetid must be a valid asset id. The required assetid is referenced in the list_device_asset_detailscall |
integer |
yes |
0 |
0 |
|
Example Service Call =list_all_hardware |
|
https://SERVER/api/?apikey=yourAPItoken&service=list_all_hardware&assetid=ASSETID |
|
Example Response |
|
<?xml version="1.0" ?> <result created="2009-10-01T12:20:26+01:00" host="SERVER" status="OK"> <items> <hardware> <hardwareid>694760</hardwareid> <manufacturer>Broadcom</manufacturer> <name>Broadcom NetLink (TM) Gigabit Ethernet</name> <details>AdapterType=Ethernet 802.3 MACAddress=00:16:58:CC:DD:FF</details> <hardware_type>1</hardware_type> </hardware> ... more <hardware> nodes ... </items> </result> |
|
Fields Description |
|||||||||||||||||||||||||||||||||||
|
Field |
Type |
Can Be Empty |
Description |
||||||||||||||||||||||||||||||||
|
hardwareid |
integer |
no |
The unique identifier of the hardware on this asset |
||||||||||||||||||||||||||||||||
|
hardware_type |
integer |
yes |
The type of hardware:
|
||||||||||||||||||||||||||||||||
|
manufacturer |
string |
yes |
The manufacturer of the hardware. |
||||||||||||||||||||||||||||||||
|
name |
string |
yes |
The name of the hardware. |
||||||||||||||||||||||||||||||||
|
details |
text |
yes |
Any other details of the hardware. |
||||||||||||||||||||||||||||||||