ResourceDefinition
uris
/redfish/v1/Managers/manager_id/VirtualMedia/iBMAUSBStick
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| @odata.context | string | true | - | 虚拟iBMA U盘资源模型的OData描述信息 |
| @odata.id | string | true | - | 虚拟iBMA U盘资源的访问路径 |
| @odata.type | string | true | - | 虚拟iBMA U盘资源的类型 |
| Name | string | true | - | 虚拟iBMA U盘资源的名称 |
| Id | string | true | - | 虚拟iBMA U盘资源的ID |
| MediaTypes | array | true | ● CD ● Floppy ● USBStick ● DVD | 媒体镜像类型 |
| Image | string | true | - | 镜像URI(本资源不涉及) |
| ImageName | string | true | - | 镜像名称(本资源不涉及) |
| ConnectedVia | string | true | ● NotConnected ● URI ● Applet ● Oem | 连接方式 |
| Inserted | boolean | true | - | 是否插入 |
| Oem.Public | object | true | - | 自定义属性 |
| Oem.Public.iBMAPacketInformation | array | true | - | iBMA U盘里安装包的信息,包括版本号和其所支持的操作系统 |
| Oem.Public.iBMAPacketStatus | string | true | - | iBMA安装包的可使用状态 |
| Oem.Public.Actions.#VirtualMedia.USBStickControl | object | true | - | 虚拟iBMA U盘控制操作 |
| Oem.Public.Actions.#VirtualMedia.USBStickControl.target | string | true | - | 控制虚拟iBMA U盘的操作路径 |
| Oem.Public.Actions.#VirtualMedia.USBStickControl.@Redfish.ActionInfo | string | true | - | 控制虚拟iBMA U盘的操作信息查询路径 |
supported_methods
- GET
- POST
HTTP methods
GET
命令功能
查询虚拟 iBMA U 盘资源
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/iBMAUSBStick
请求头:
X-Auth-Token: auth_value请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| manager_id | 管理资源ID | ● 针对机架服务器,取值为1 ● 针对高密服务器,取值为BladeN(N表示节点槽位号),例如"Blade1" ● 针对刀片服务器,取值可以为BladeN(N表示计算节点槽位号)或SwiN(N表示交换模块槽位号),例如"Swi1" ● 针对设备U位信息,取值可以为UN(N表示设备U位号),例如"U1" ● 针对机柜资源,取值为Rack |
| auth_value | 执行该GET请求时,必须在"Headers"中携带"X-Auth-Token"值用于鉴权 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
使用指南
只在以下服务器列表中支持此功能。 1288H V5,2288 V5,2288H V5,2488 V5,2488H V5,5288 V5,CH121 V5,CH121L V5,CH242 V5,CH225 V5,CH221 V5,XH321 V5,XH321L V5,XH628 V5,8100 V5,5885H V5,G530 V5,G560 V5,9008 V5(BC62HFCA, BC62HFCB),XA320 V2,XA320C V2,2280 V2,5280 V2,A500 Pro-3000,DA122Cv2,PangeaV6_Atlantic,PangeaV6_Pacific,PangeaV6_Arctic,PAC1220V6,A800-9000 A800T A3,A800I A3,A800I 2UP
使用实例
请求样例:
GET https://device_ip/redfish/v1/Managers/1/VirtualMedia/iBMAUSBStick请求头:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1请求消息体:无
响应样例:
{
"@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia",
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/iBMAUSBStick",
"@odata.type": "#VirtualMedia.v1_0_2.VirtualMedia",
"Id": "iBMAUSBStick",
"Name": "Removable Virtual Media for iBMA",
"MediaTypes": [
"USBStick"
],
"Image": null,
"ImageName": null,
"ConnectedVia": "NotConnected",
"Inserted": false,
"Oem": {
"Public": {
"iBMAPacketInformation": [
{
"OSType": "Linux",
"Version": "2.1.2.010"
}
],
"iBMAPacketStatus": "iBMAPacketIsAvailable",
"Actions": {
"#VirtualMedia.USBStickControl": {
"target": "/redfish/v1/Managers/1/VirtualMedia/iBMAUSBStick/Oem/Public/Actions/VirtualMedia.USBStickControl",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/VirtualMedia/iBMAUSBStick/USBStickControlActionInfo"
}
}
}
}
}响应码:200
POST (ACTION)
USBStickControl
命令功能
连接虚拟 iBMA U 盘
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/iBMAUSBStick/Oem/Public/Actions/VirtualMedia.USBStickControl
请求头:
X-Auth-Token: auth_value
Content-Type: header_type请求消息体:
{
"USBStickControlType": value
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| manager_id | 管理资源ID | ● 针对机架服务器,取值为1 ● 针对高密服务器,取值为BladeN(N表示节点槽位号),例如"Blade1" ● 针对刀片服务器,取值可以为BladeN(N表示计算节点槽位号)或SwiN(N表示交换模块槽位号),例如"Swi1" ● 针对设备U位信息,取值可以为UN(N表示设备U位号),例如"U1" ● 针对机柜资源,取值为Rack |
| auth_value | 请求消息的鉴权参数 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
| header_type | 请求消息的格式 | 支持的消息格式包括: ● application/json ● application/json;charset=utf-8 |
| value | 连接虚拟U盘 | ● Connect |
使用指南
以下服务器列表支持此功能。 1288H V5,2288 V5,2288H V5,2488 V5,2488H V5,5288 V5,CH121 V5,CH121L V5,CH242 V5,CH225 V5,CH221 V5,XH321 V5,XH321L V5,XH628 V5,8100 V5,5885H V5,G530 V5,G560 V5,9008 V5(BC62HFCA、BC62HFCB),XA320 V2,XA320C V2,2280 V2,5280 V2,A500 Pro-3000,DA122Cv2,PangeaV6_Atlantic,PangeaV6_Pacific,PangeaV6_Arctic,PAC1220V6,A800-9000 A800T A3,A800I A3,A800I 2UP
使用实例
请求样例:
POST https://device_ip/redfish/v1/Managers/1/VirtualMedia/iBMAUSBStick/Oem/Public/Actions/VirtualMedia.USBStickControl请求头:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Content-Type: application/json请求消息体:
{
"USBStickControlType": "Connect"
}响应样例:
{
"@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/1",
"Id": "1",
"Name": "usbstick connect status check task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2019-08-28T21:12:27+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}响应码:202
POST (ACTION)
USBStickControl
命令功能
断开虚拟 iBMA U 盘
命令格式
URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/iBMAUSBStick/Oem/Public/Actions/VirtualMedia.USBStickControl
请求头:
X-Auth-Token: auth_value
Content-Type: header_type请求消息体:
{
"USBStickControlType": value
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| manager_id | 管理资源ID | ● 针对机架服务器,取值为1 ● 针对高密服务器,取值为BladeN(N表示节点槽位号),例如"Blade1" ● 针对刀片服务器,取值可以为BladeN(N表示计算节点槽位号)或SwiN(N表示交换模块槽位号),例如"Swi1" ● 针对设备U位信息,取值可以为UN(N表示设备U位号),例如"U1" ● 针对机柜资源,取值为Rack |
| auth_value | 请求消息的鉴权参数 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
| header_type | 请求消息的格式 | 支持的消息格式包括: ● application/json ● application/json;charset=utf-8 |
| value | 断开连接 | ● Disconnect |
使用指南
只在以下服务器列表中支持此功能。 1288H V5,2288 V5,2288H V5,2488 V5,2488H V5,5288 V5,CH121 V5,CH121L V5,CH242 V5,CH225 V5,CH221 V5,XH321 V5,XH321L V5,XH628 V5,8100 V5,5885H V5,G530 V5,G560 V5,9008 V5(BC62HFCA、BC62HFCB),XA320 V2,XA320C V2,2280 V2,5280 V2,A500 Pro-3000,DA122Cv2,PangeaV6_Atlantic,PangeaV6_Pacific,PangeaV6_Arctic,PAC1220V6,A800-9000,A800T A3,A800I A3,A800I 2UP
使用实例
请求样例:
POST https://device_ip/redfish/v1/Managers/1/VirtualMedia/iBMAUSBStick/Oem/Public/Actions/VirtualMedia.USBStickControl请求头:
X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Content-Type: application/json请求消息体:
{
"USBStickControlType": "Disconnect"
}响应样例:
{
"@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/2",
"Id": "2",
"Name": "usbstick disconnect status check task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2019-08-28T21:17:18+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}响应码:202