代码仓
中
文档中心
VirtualMediaCD
更新时间： 2026/09/24
在AtomGit上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Systems/system_id/VirtualMedia/CD

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-虚拟媒体资源模型的OData描述信息
@odata.idstringtrue-虚拟媒体资源的访问路径
@odata.typestringtrue-虚拟媒体资源的类型
Namestringtrue-虚拟媒体资源的名称
Idstringtrue-虚拟媒体资源的ID
EjectPolicystringfalse-镜像弹出策略：
● OnPowerOff：OS下电或重启时弹出
● Persistent：永不弹出
● Timed：在经过指定时间后弹出
EjectTimeoutstringfalse-镜像超时弹出时间，ISO 8601持续时间格式
UserNamestringfalse-远程镜像访问用户名
Passwordstringfalse-远程镜像访问密码
MediaTypesarraytrue-● 媒体镜像类型
● CD
● Floppy
● USBStick
● DVD
Imagestringtrue-镜像URI
ImageNamestringtrue-镜像名称
ConnectedViastringtrue-● 连接方式
● NotConnected
● URI
● Applet
● Oem
Insertedstringtrue-是否插入
Actions {objecttrue--
Actions.可以对虚拟媒体执行的自定义操作-true-可以对虚拟媒体执行的自定义操作
}
#VirtualMedia.EjectMediaobjecttrue-弹出Virtual Media媒体设备
targetstringtrue-弹出Virtual Media媒体设备的操作路径
@Redfish.ActionInfostringtrue-弹出Virtual Media媒体设备的操作信息查询路径
#VirtualMedia.InsertMediaobjecttrue-挂载Virtual Media媒体设备
Actions {objecttrue--
Actions.#VirtualMedia.EjectMedia {objecttrue--
Actions.#VirtualMedia.EjectMedia.targetstringtrue--
Actions.#VirtualMedia.EjectMedia.@Redfish.ActionInfostringtrue--
}
Actions.#VirtualMedia.InsertMedia {objecttrue--
Actions.#VirtualMedia.InsertMedia.targetstringtrue--
Actions.#VirtualMedia.InsertMedia.@Redfish.ActionInfostringtrue--
}
}

supported_methods ​

  • GET
  • PATCH
  • POST

HTTP methods ​

GET ​

命令功能

查询虚拟媒体资源。

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/VirtualMedia/CD

请求头:

X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
system_id系统资源的ID● 针对机架服务器，取值为1
● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1”
● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或SwiN（N表示交换模块槽位号），例如“Swi1”
auth_value执行该GET请求时，必须在“Heaers”中携带“X-Auth-Token”值用于鉴权可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

GA140C机型不支持

使用实例

请求样例：

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

请求头：

X-Auth-Token: 123456789***********************

请求消息体：无

响应样例：

json
{ 
    "@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia", 
    "@odata.id": "/redfish/v1/Systems/1/VirtualMedia/CD", 
    "@odata.type": "#VirtualMedia.v1_6_4.VirtualMedia", 
    "Id": "CD", 
    "Name": "VirtualMedia", 
    "EjectPolicy": "Persistent", 
    "EjectTimeout": "PT2H", 
    "UserName": "", 
    "Password": null, 
    "MediaTypes": [], 
    "Image": null, 
    "ImageName": null, 
    "ConnectedVia": "NotConnected", 
    "Inserted": false, 
    "Actions": { 
        "#VirtualMedia.EjectMedia": { 
            "target": "/redfish/v1/Systems/1/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia", 
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/VirtualMedia/CD/EjectMediaActionInfo" 
        }, 
        "#VirtualMedia.InsertMedia": { 
            "target": "/redfish/v1/Systems/1/VirtualMedia/CD/Actions/VirtualMedia.InsertMedia", 
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/VirtualMedia/CD/InsertMediaActionInfo" 
        } 
    } 
}

响应码：200

PATCH ​

命令功能

设置虚拟媒体资源

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/VirtualMedia/CD

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type 
If-Match: ifmatch_value

请求消息体:

json
{ 
    "EjectPolicy": "Persistent", 
    "EjectTimeout": "PT1H", 
    "UserName": "aaa", 
    "Password": "bbb" 
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
system_id管理资源ID● 针对机架服务器，取值为1
● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1”
● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或SwiN（N表示交换模块槽位号），例如“Swi1”
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得
header_type请求消息的格式支持的消息格式包括：
● application/json
● application/json;charset=utf-8
ifmatch_value请求消息的匹配参数可通过对相应资源发起GET操作，从响应头中获取（对应于“ETag”参数）
EjectPolicy镜像弹出策略● OnPowerOff：OS下电或重启时弹出
● Persistent：永不弹出
● Timed：在经过指定时间后弹出
EjectTimeout镜像超时弹出时间使用ISO 8601持续时间格式，最大为PT8H
UserName远程镜像访问用户名字符串
Password远程镜像访问密码字符串

使用指南

GA140C机型不支持

使用实例

请求样例：

http
PATCH https://device_ip/redfish/v1/Systems/1/VirtualMedia/CD

请求头：

X-Auth-Token: 123456789***********************

请求消息体：

{ 
    "EjectPolicy": "Persistent", 
    "EjectTimeout": "PT1H", 
    "UserName": "aaa", 
    "Password": "bbb" 
}

响应样例：

json
{ 
    "@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia", 
    "@odata.id": "/redfish/v1/Systems/1/VirtualMedia/CD", 
    "@odata.type": "#VirtualMedia.v1_6_4.VirtualMedia", 
    "Id": "CD", 
    "Name": "VirtualMedia", 
    "EjectPolicy": "Persistent", 
    "EjectTimeout": "PT1H", 
    "UserName": "aaa", 
    "Password": null, 
    "MediaTypes": [], 
    "Image": null, 
    "ImageName": null, 
    "ConnectedVia": "NotConnected", 
    "Inserted": false, 
    "Actions": { 
        "#VirtualMedia.EjectMedia": { 
            "target": "/redfish/v1/Systems/1/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia", 
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/VirtualMedia/CD/EjectMediaActionInfo" 
        }, 
        "#VirtualMedia.InsertMedia": { 
            "target": "/redfish/v1/Systems/1/VirtualMedia/CD/Actions/VirtualMedia.InsertMedia", 
            "@Redfish.ActionInfo": "/redfish/v1/Systems/1/VirtualMedia/CD/InsertMediaActionInfo" 
        } 
    } 
}

响应码：200

POST (ACTION) ​

InsertMedia ​

命令功能

连接虚拟媒体

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/VirtualMedia/CD/Actions/VirtualMedia.InsertMedia

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

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

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
system_id系统资源的ID● 针对机架服务器，取值为1
● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1”
● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或SwiN（N表示交换模块槽位号），例如“Swi1”
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机型不支持

使用实例

请求样例：

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

请求头：

X-Auth-Token: 123456789***********************

请求消息体：

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

响应样例：

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": {  
    "openUBMC": {  
      "TaskPercentage": null  
    }  
  }  
}

响应码：202

POST (ACTION) ​

EjectMedia ​

命令功能

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/VirtualMedia/CD/Actions/VirtualMedia.EjectMedia

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json
{}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
system_id系统资源的ID● 针对机架服务器，取值为1
● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1”
● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或SwiN（N表示交换模块槽位号），例如“Swi1”
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得
header_type请求消息的格式支持的消息格式包括：
● application/json
● application/json;charset=utf-8

使用指南

GA140C机型不支持

使用实例

请求样例：

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

请求头：

X-Auth-Token: 123456789***********************

请求消息体：

{}

响应样例：

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": { 
    "openUBMC": { 
      "TaskPercentage": null 
    } 
  } 
}

响应码：202

下一篇探索openUBMC