Querying Peripheral Resource Information
Function
This interface is used to query peripheral resource information.
Syntax
Operation type: GET
URL: https://device_ip/redfish/v1/EdgeSystem/ExtendedDevices/extendeddevice_id
Request header:
X-Auth-Token: auth_value
Request message body: None
Parameters
Parameter |
Description |
Value |
|---|---|---|
device_ip |
IP address for logging in to a device. |
An IPv4 or IPv6 address. |
extendeddevice_id |
ID of a peripheral. |
The value is a number. You can obtain the value from redfish/v1/EdgeSystem/ExtendedDevices. |
auth_value |
Authentication parameter contained in the request. |
You can obtain the value from the session created by using /redfish/v1/SessionService/Sessions. |
Usage Guidelines
None
Example
Example request:
GET https://10.10.10.10/redfish/v1/EdgeSystems/NetworkAdapters/1
Request header:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Request message body: None
Response example:
{
"@odata.context": "/redfish/v1/$metadata#EdgeSystem/ExtendedDevices/Members/$entity",
"@odata.id": "/redfish/v1/EdgeSystem/ExtendedDevices/1,
"Id": "1",
"Name": "SATA DISK 1",
"DeviceClass": "HDD",
"DeviceName": "/dev/sda",
"Manufacturer": "Seagate",
"Model": "Hi3559A GMAC",
"SerialNumber": "XXXX",
"FirmwareVersion": "XXXX",
"Location": "SATA Slot 1",
"Status": {
"State": "Enabled",
"Health": null
}
}
Response code: 200
Output Description
Attribute |
Type |
Description |
|---|---|---|
@odata.context |
Character string |
OData description of a specified peripheral resource model. |
@odata.id |
Character string |
Access path of a specified peripheral resource node. |
@odata.type |
Character string |
Resource type of a specified peripheral. |
Id |
Character string |
ID of a specified peripheral resource. |
Name |
Character string |
Name of a specified peripheral resource. |
DeviceClass |
Character string |
Type of a specified peripheral. The options are as follows:
|
DeviceName |
Character string |
Device name of a specified peripheral in the system. |
Manufacturer |
Character string |
Manufacturer of a peripheral. |
Model |
Character string |
Model of a peripheral. |
SerialNumber |
Character string |
Serial number of a peripheral. |
FirmwareVersion |
Character string |
Firmware version of a peripheral. |
Location |
Character string |
Position of a peripheral in the system. |
Status |
Object |
Status of a peripheral.
|
