Querying Peripheral Resource Information

Function

This interface is used to query peripheral resource information.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/ExtendedDevices/<extend_id>

Request header:

X-Auth-Token: auth_value

Request message body: None

URL Parameters

**Table 1** URL parameters
Parameter	Mandatory/Optional	Parameter Description	Value
extend_id	Mandatory	ID of a peripheral.	Name of the external device. The value is a string of 2 to 64 characters, including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and spaces. You can run the redfish/v1/EdgeSystem/ExtendedDevices command to obtain the value.

Usage Guidelines

None

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/ExtendedDevices/disk0

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/ExtendedDevices/Members/$entity",
    "@odata.id": "/redfish/v1/Systems/ExtendedDevices/disk0",
    "@odata.type": "#MindXEdgeExtendedDevice.v1_0_0.MindXEdgeExtendedDevice",
    "Id": "disk0",
    "Name": "disk0",
    "DeviceClass": "DISK",
    "DeviceName": "/dev/sda",
    "Manufacturer": "HGST",
    "Model": "XXXX",
    "SerialNumber": "XXXX",
    "Location": "PCIE3-0",
    "FirmwareVersion": "XXXX",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    }
}

Response code: 200

Output Description

**Table 2** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of a specified peripheral resource model.
@odata.id	Character string	Path to access 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: HDD USB
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. Health: indicates the health status of a system resource. State: indicates whether a system resource is enabled.

Parent topic: Hardware Management