VirtualMedia

VirtualMedia 1.6.5⁠

 

Version	v1.6
Release	2022.3

Description⁠

The VirtualMedia schema contains properties related to the monitor and control of an instance of virtual media, such as a remote CD, DVD, or USB device. A manager for a system or device provides virtual media functionality.

URIs⁠

/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​VirtualMedia/​{VirtualMediaId}
/​redfish/​v1/​Managers/​{ManagerId}/​VirtualMedia/​{VirtualMediaId} (deprecated)
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​VirtualMedia/​{VirtualMediaId}
/​redfish/​v1/​Systems/​{ComputerSystemId}/​VirtualMedia/​{VirtualMediaId}

Properties⁠

Property	Type	Attributes	Notes
Actions (v1.1+) {	object		The available actions for this resource.
#VirtualMedia.EjectMedia (v1.2+) {}	object		This action detaches remote media from virtual media. For more information, see the Actions section below.
#VirtualMedia.InsertMedia (v1.2+) {}	object		This action attaches remote media to virtual media. For more information, see the Actions section below.
}
Certificates (v1.4+) {	object		The link to a collection of server certificates for the server referenced by the Image property.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
ClientCertificates (v1.5+) {	object		The link to a collection of client identity certificates provided to the server referenced by the Image property.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
ConnectedVia	string (enum)	read-only (null)	The current virtual media connection method. For the possible property values, see ConnectedVia in Property details.
EjectPolicy (v1.6+)	string (enum)	read-write (null)	The ejection policy for the virtual media. For the possible property values, see EjectPolicy in Property details.
EjectTimeout (v1.6+)	string (duration)	read-write (null)	Timeout value before the virtual media is automatically ejected.
Image	string (URI)	read-write (null)	The URI of the location of the selected image.
ImageName	string	read-only (null)	The current image name.
Inserted	boolean	read-write (null)	An indication of whether the media is mounted and visible to the host system.
MediaTypes [ ]	array (string (enum))	read-only	The media types supported as virtual media. For the possible property values, see MediaTypes in Property details.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
Password (v1.3+)	string	read-write (null)	The password to access the URI specified by the Image property. The value is null in responses.
Status (v1.4+) {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
TransferMethod (v1.3+)	string (enum)	read-write (null)	The transfer method to use with the image. For the possible property values, see TransferMethod in Property details.
TransferProtocolType (v1.3+)	string (enum)	read-write (null)	The network protocol to use with the URI specified by the Image property. For the possible property values, see TransferProtocolType in Property details.
UserName (v1.3+)	string	read-write (null)	The username to access the URI specified by the Image property.
VerifyCertificate (v1.4+)	boolean	read-write (null)	An indication of whether the service will verify the certificate of the server referenced by the Image property prior to completing the remote media connection.
WriteProtected	boolean	read-write (null)	An indication of whether the media is write-protected.

Actions⁠

EjectMedia (v1.2+)⁠

Description

This action detaches remote media from virtual media.

Action URI

{Base URI of target resource}/Actions/VirtualMedia.EjectMedia

Action parameters

This action takes no parameters.

InsertMedia (v1.2+)⁠

Description

This action attaches remote media to virtual media.

Action URI

{Base URI of target resource}/Actions/VirtualMedia.InsertMedia

Action parameters

Parameter Name	Type	Attributes	Notes
Image	string	required	The URI of the media to attach to the virtual media.
Inserted	boolean	optional	An indication of whether the image is treated as mounted and visible to the host system upon completion of the action. The default is true.
Password (v1.3+)	string	optional	The password to access the URI specified by the Image parameter.
TransferMethod (v1.3+)	string (enum)	optional	The transfer method to use with the image. For the possible property values, see TransferMethod in Property details.
TransferProtocolType (v1.3+)	string (enum)	optional	The network protocol to use with the URI specified by the Image parameter. For the possible property values, see TransferProtocolType in Property details.
UserName (v1.3+)	string	optional	The username to access the URI specified by the Image parameter.
WriteProtected	boolean	optional	An indication of whether the remote media is treated as write-protected. The default is true.

Request Example

{
    "Image": "https://192.168.1.225/boot_image.iso",
    "Inserted": true,
    "WriteProtected": true
}

Property details⁠

ConnectedVia⁠

 

The current virtual media connection method.

string	Description
Applet	Connected to a client application.
NotConnected	No current connection.
Oem	Connected through an OEM-defined method.
URI	Connected to a URI location.

EjectPolicy⁠

 

The ejection policy for the virtual media.

string	Description
AfterUse	The virtual media ejection occurs after the media is used.
OnPowerOff	The virtual media ejection occurs during a system power or reset event.
Persistent	The virtual media mount information persists indefinitely.
Session	The virtual media ejection occurs when a session is terminated. The session might be outside the Redfish service.
Timed	The virtual media ejection occurs when a timer configured by the EjectTimeout property expires.

MediaTypes⁠

 

The media types supported as virtual media.

string	Description
CD	A CD-ROM format (ISO) image.
DVD	A DVD-ROM format image.
Floppy	A floppy disk image.
USBStick	An emulation of a USB storage device.

TransferMethod⁠

 

The transfer method to use with the image.

string	Description
Stream	Stream image file data from the source URI.
Upload	Upload the entire image file from the source URI to the service.

TransferProtocolType⁠

 

The network protocol to use with the URI specified by the Image parameter.

string	Description
CIFS	Common Internet File System (CIFS).
FTP	File Transfer Protocol (FTP).
HTTP	Hypertext Transfer Protocol (HTTP).
HTTPS	Hypertext Transfer Protocol Secure (HTTPS).
NFS	Network File System (NFS).
OEM	A manufacturer-defined protocol.
SCP	Secure Copy Protocol (SCP).
SFTP	SSH File Transfer Protocol (SFTP).
TFTP	Trivial File Transfer Protocol (TFTP).

Example response⁠

{
    "@odata.type": "#VirtualMedia.v1_6_5.VirtualMedia",
    "Id": "CD1",
    "Name": "Virtual CD",
    "MediaTypes": [
        "CD",
        "DVD"
    ],
    "Image": "redfish.dmtf.org/freeImages/freeOS.1.1.iso",
    "ImageName": "mymedia-read-only",
    "ConnectedVia": "Applet",
    "Inserted": true,
    "WriteProtected": false,
    "@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia/CD1"
}