Querying External Device Module Resource Collection

Function

Queries the resource collection of external device modules. Currently, the OM SDK supports customized module extension. For details about the API extension function, see the section about module extension.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/Modules

Request header:
X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

None

Example

Request:
GET https://10.10.10.10/redfish/v1/Systems/Modules
Request header:
X-Auth-Token: auth_value

Request message body: None

Response:
{
    "@odata.context": "/redfish/v1/$metadata#Systems/Modules/$entity",
    "@odata.id": "/redfish/v1/Systems/Modules",
    "@odata.type": "#MindXEdgeModuleCollection.MindXEdgeModuleCollection",
    "Name": "Device Module Collection",
    "Members@odata.count": 0,
    "Members": []
}

Response code: 200

Output Description

Table 1 Operation output description

Field

Type

Description

@odata.context

String

OData description information of the model on the external device module resource collection

@odata.id

String

Access path of the external device module resource collection

@odata.type

String

Type of the external device module resource collection

Name

String

Name of the external device module resource collection

Members@odata.count

Number

Number of external device modules.