文档中心
VirtualMediaCD
更新时间： 2026/07/01
在Gitcode上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/VirtualMedia/CD

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-虚拟媒体资源模型的OData描述信息
@odata.idstringtrue-虚拟媒体资源的访问路径
@odata.typestringtrue-虚拟媒体资源的类型
Namestringtrue-虚拟媒体资源的名称
Idstringtrue-虚拟媒体资源的ID
MediaTypesarraytrue● CD
● Floppy
● USBStick
● DVD		媒体镜像类型
Imagestringfalse-镜像URI
ImageNamestringtrue-镜像名称
ConnectedViastringtrue● NotConnected
● URI
● Applet
● Oem		连接方式
Insertedstringtrue-是否插入
TransferMethodstringtrue-虚拟媒体资源传输方法，当前只支持"Stream"
TransferProtocolTypestringfalse● NFS
● CIFS
● HTTPS		虚拟媒体资源传输协议类型
UserNamestringfalse-远程镜像访问的用户名
WriteProtectedbooleantrue-挂载虚拟媒体资源是否开启写保护
Oem.Publicobjecttrue-自定义属性
Oem.Public.EncryptionEnabledbooleantrue-VMM加密使能
Oem.Public.EncryptionConfigurablebooleantrue-VMM加密是否支持配置
Oem.Public.FloppyDriveEnabledbooleantrue-VMM软驱使能
Oem.Public.Actions.#VirtualMedia.VmmControlobjecttrue-虚拟媒体控制操作
Oem.Public.Actions.#VirtualMedia.VmmControl.targetstringtrue-控制虚拟媒体的操作路径
Oem.Public.Actions.#VirtualMedia.VmmControl.@Redfish.ActionInfostringtrue-控制虚拟媒体的操作信息查询路径
Actions.#VirtualMedia.EjectMediaobjecttrue-弹出Virtual Media媒体设备
Actions.#VirtualMedia.EjectMedia.targetstringtrue-弹出Virtual Media媒体设备的操作路径
Actions.#VirtualMedia.EjectMedia.@Redfish.ActionInfostringtrue-弹出Virtual Media媒体设备的操作信息查询路径
Actions.#VirtualMedia.InsertMediaobjecttrue-挂载Virtual Media媒体设备
Actions.#VirtualMedia.InsertMedia.targetstringtrue-挂载Virtual Media媒体设备的操作路径
Actions.#VirtualMedia.InsertMedia.@Redfish.ActionInfostringtrue-挂载Virtual Media媒体设备的操作信息查询路径

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询虚拟媒体资源

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD

请求头:

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创建会话时获得

使用指南

GA140C机型不支持

使用实例

请求样例：

http
GET https://device_ip/redfish/v1/Managers/1/VirtualMedia/CD

请求头：

X-Auth-Token: 6599174c38c36838737d9749179e1ee1

请求消息体：无

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#Managers/Members/1/VirtualMedia/Members/$entity",
  "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD",
  "@odata.type": "#VirtualMedia.v1_0_2.VirtualMedia",
  "Id": "CD",
  "Name": "VirtualMedia",
  "MediaTypes": [],
  "Image": null,
  "ImageName": null,
  "ConnectedVia": "NotConnected",
  "Inserted": false,
  "TransferMethod": "Stream",
  "TransferProtocolType": null,
  "UserName": "",
  "WriteProtected": true,
  "Oem": {
    "Public": {
      "EncryptionEnabled": false,
      "EncryptionConfigurable": true,
      "FloppyDriveEnabled": true,
      "Actions": {
        "#VirtualMedia.VmmControl": {
          "target": "/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl",
          "@Redfish.ActionInfo": "/redfish/v1/Managers/1/VirtualMedia/CD/VmmControlActionInfo"
        }
      }
    }
  },
  "Actions": {
    "#VirtualMedia.EjectMedia": {
      "target": "/redfish/v1/Managers/1/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/VirtualMedia/CD/EjectMediaActionInfo"
    },
    "#VirtualMedia.InsertMedia": {
      "target": "/redfish/v1/Managers/1/VirtualMedia/CD/Actions/VirtualMedia.InsertMedia",
      "@Redfish.ActionInfo": "/redfish/v1/Managers/1/VirtualMedia/CD/InsertMediaActionInfo"
    }
  }
}

响应码：200

POST (ACTION) ​

VmmControl (InsertMedia) ​

命令功能

连接虚拟媒体

说明

以下2个操作均可进行连接虚拟媒体操作。

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

或

URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Actions/VirtualMedia.InsertMedia

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
  "VmmControlType": VmmControlType_value,
  "Image": Image_value
}

或

json
{
  "Image": Image_value,
  "TransferProtocolType": TransferProtocolType_value,
  "UserName": UserName_value,
  "Password": Password_value
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

下表适用于接口https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

参数参数说明取值
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
VmmControlType_value虚拟媒体操作类型Connect：连接虚拟媒体
Image_value虚拟媒体镜像uri当前仅支持带有nfs、cifs、https协议的uri连接

下表适用于接口https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Actions/VirtualMedia.InsertMedia

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
manager_id管理资源ID● 针对机架服务器，取值为1
● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如"Blade1"
● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或SwiN（N表示交换模块槽位号），例如"Swi1"
● 针对X6800 V5，X6000 V5，G5500，XA320 V2服务器，取值还可以为Enc，表示计算节点所在的机框资源
● 针对设备U位信息，取值可以为UN(N表示设备U位号)，例如"U1"
● 针对机柜资源，取值为Rack
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得
header_type请求消息的格式支持的消息格式包括：
● application/json
● application/json;charset=utf-8
Image_value虚拟媒体镜像uri必选字段，当前仅支持带有nfs、cifs、https协议的uri连接
TransferProtocolType_value挂载镜像使用的传输协议类型可选字段，当前传输协议类型仅支持NFS、CIFS、HTTPS，且需要与镜像使用的协议类型相同
UserName访问由Image参数指定的Uri时使用的用户名可选字段，字符串
Password访问由Image参数指定的Uri时使用的密码可选字段，字符串

使用指南

GA140C机型不支持

使用实例

请求样例1：

http
POST https://device_ip/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

请求头：

X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Content-Type: application/json

请求消息体：

json
{
  "VmmControlType": "Connect",
  "Image": "nfs://device_ip/usr/SLE-12-Server-DVD-x86_64-GM-DVD1.ISO"
}

响应样例1：

json
{
  "@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": "vmm connect task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-04-26T00:40:18+08:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

请求样例2：

http
POST https://device_ip/redfish/v1/Managers/1/VirtualMedia/CD/Actions/VirtualMedia.InsertMedia

请求头：

X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Content-Type: application/json

请求消息体：

json
{
  "Image": "https://71.44.33.11:443/https/vmm_dvd.iso",
  "TransferProtocolType": "HTTPS",
  "UserName": "user",
  "Password": "123123"
}

响应样例2：

json
{
  "@odata.context": "/redfish/v1/$metadata#Task.Task",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "vmm connect task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-04-26T00:40:18+08:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

POST (ACTION) ​

VmmControl (EjectMedia) ​

命令功能

断开虚拟媒体

说明

以下2个操作均可进行断开虚拟媒体操作。

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

或

URL: https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia

请求头:

X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
  "VmmControlType": value
}

或

json
{}

请求头参数说明

参见 请求头参数说明

请求体参数说明

下表适用于接口https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

参数参数说明取值
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：断开虚拟媒体

下表适用于接口https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia

参数参数说明取值
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

使用指南

GA140C机型不支持

使用实例

请求样例1：

http
POST https://device_ip/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

请求头：

X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Content-Type: application/json

请求消息体：

json
{
  "VmmControlType": "Disconnect"
}

响应样例1：

json
{
  "@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": "vmm disconnect status task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-04-26T00:58:56+08:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202

请求样例2：

http
POST https://device_ip/redfish/v1/Managers/1/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia

请求头：

X-Auth-Token: 6599174c38c36838737d9749179e1ee1
Content-Type: application/json

请求消息体：

json
{}

响应样例2：

json
{
  "@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": "vmm disconnect status task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-04-26T00:58:56+08:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码：202