修改外部设备信息

命令功能

修改外部设备信息。当前OMSDK支持自定义模组扩展，具体接口扩展功能可参照模组扩展章节开发。

命令格式

操作类型：PATCH

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

请求头：

X-Auth-Token: auth_value

请求消息体：

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

URL参数

表1 URL参数
参数名	是否必选	参数说明	取值
<module_id>	必选	外部模组名称。	匹配任何由字母、数字、空格、减号（-）或下划线组成的字符串，长度1~127。注：该参数根据第三方扩展而来，当前OM SDK无具体可访问模组名称。
<device_id>	必选	外部设备名称。	匹配任何由字母、数字、空格、减号（-）或下划线组成的字符串，长度1~127。该参数根据第三方扩展而来，当前OM SDK无具体可访问模组名称。

请求参数

表2 请求参数
参数名	是否必选	参数说明	取值
Attributes	必选	修改的设备属性与属性值。	对象，取值为修改的设备属性。

使用指南

无

使用实例

请求样例：

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

请求头：

X-Auth-Token: auth_value

请求消息体：无

响应样例（当前OM SDK无可访问外设设备，当前只会返回以下错误）：

{
    "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
                }
            }
        ]
    }
}

响应码：404

输出说明

表3 操作输出说明
字段	类型	说明
code	字符串	指示消息注册表中特定消息ID的字符串。
message	字符串	消息详情。
@Message.ExtendedInfo	对象	扩展消息
@odata.type	字符串	会话资源类型。
Description	字符串	详细信息。
Message	字符串	返回消息。
Severity	字符串	严重性，Redfish支持的严重级。 OK Warning Critical
NumberOfArgs	数字	传递的参数数量。
ParamTypes	数组	传递的参数类型。
Resolution	字符串	解决方案描述。
Oem	对象	扩展字段。
status	字符串	扩展字段状态信息。

父主题： 硬件管理