Modifying External Device Information

Description

Modifies external device information. Currently, the OM SDK supports customized module extension. For details about the API extension function, see the section about module extension.

Syntax

Operation type: PATCH

URL: https://device_ip/redfish/v1/Systems/Modules/<module_id>/<device_id>

Request header:

X-Auth-Token: auth_value

Request message body:

{
   "Attributes":{
     "status": "inactive"
   }
}

URL Parameters

**Table 1** URL parameters
Parameter	Mandatory/Optional	Description	Value
<module_id>	Mandatory	Name of an external module	Matches a string of 1 to 127 characters consisting of letters, digits, spaces, hyphens (-), or underscores (_). Note: This parameter is extended by a third party. Currently, the OM SDK does not have a specific module name that can be accessed.
<device_id>	Mandatory	Name of the external device	Matches a string of 1 to 127 characters consisting of letters, digits, spaces, hyphens (-), or underscores (_). This parameter is extended by a third party. Currently, the OM SDK does not have a specific module name that can be accessed.

Request Parameters

**Table 2** Request parameters
Parameter	Mandatory/Optional	Description	Value
Attributes	Mandatory	Modified the device attributes and attribute values	Object. The value is the modified device attribute.

Usage Guidelines

None

Example

Request:

PATCH https://10.10.10.10/redfish/v1/Systems/Modules/XXX/XXX-XXX

Request header:

X-Auth-Token: auth_value

Request message body: None

Response (Currently, the OM SDK does not have accessible peripheral devices. Only the following error code is returned.):

{
    "error": {
        "code": "Base.1.0.GeneralError",
        "message": "A GeneralError has occurred. See ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry",
                "Description": "Indicates that a general error has occurred.",
                "Message": "XXX does not exist",
                "Severity": "Critical",
                "NumberOfArgs": null,
                "ParamTypes": null,
                "Resolution": "None",
                "Oem": {
                    "status": null
                }
            }
        ]
    }
}

Response code: 404

Output Description

**Table 3** Operation output description
Field	Type	Description
code	String	A string indicating the specific message ID in the message registry
message	String	Message details
@Message.ExtendedInfo	Object	Extended message
@odata.type	String	Session resource type
Description	String	Details
Message	String	Response message
Severity	String	Severity supported by Redfish OK Warning Critical
NumberOfArgs	Number	Number of added parameters
ParamTypes	Array	Types of the added parameters
Resolution	String	Solution description
Oem	Object	Extended fields
status	String	Extended field status information

Parent topic: Hardware Management