Skip to main content

GET – Virtual Media Instance

Request​

  1. This is the schema definition for the Virtual Media Service. This resource shall be used to represent a virtual media service for a Redfish implementation.

  2. The user can initiate CD media redirection using InsertMedia action and can stop the redirection using EjectMedia action.

  3. This link will be shown to the user only when VirtualMedia CD instance is redirected from Remote Media from BMC Webpage.

  4. KVM Virtual Media will not be listed in Redfish Virtual Media Instance when redirected through KVM.

GET https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/VirtualMedia/{{virtualmedia_instance}}
Content-Type: application/json

Response​

The response of the request will be in JSON format. The properties are mentioned in the following table.

Table 1. Virtual Media Property

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support.

OemObject 
AMI Virtual Media OEM Properties

Name

Type

Read only

Description

@odata.type

String

True

Refer to OData Support.

RedirectionStatus

String

True

Specifies the redirection status of the image.

BoostMode

Boolean

False

Specifies the BoostMode support status

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

ImageName

String

True

The current image name.

Image

String

True

A URI providing the location of the selected image

ConnectedVia

String

True

  1. The value of this property shall indicate the current connection method from a client to the virtual media represented by this resource.

  2. A value of NotConnected shall indicate no connection is present.

  3. A value of URI shall indicate that a remote connection via a URI reference type is being used.

Enum

Description

NotConnected

No current connection

URI

Connected to a URI location

Applet(Not Supported)

Connected to a client application

Oem(Not Supported)

Connected via an OEM-defined method

Inserted

BooleanTrue

  1. Indicates if virtual media is inserted in the virtual device.

  2. This is usually only applicable to remoting of devices and not for image virtual media usage.

  3. When the redirection is initiated for a CD instance, then the Inserted property value of that instance would be true.

WriteProtectedBooleanTrue

  1. Indicates the media is write-protected.

  2. For CD instance, the WriteProtected value is always true.

ActionsObjectTrue

  1. EjectMedia - This action is used to detach remote media from virtual media.

  2. InsertMedia - This action is used to attach remote media to virtual media.

  3. This action object will also contain the actions for this resource under Oem property if any.

Action Name = InsertMedia

Property

Type

Description

Image

String

The URI of the remote media to attach to the virtual media.

Inserted

Boolean

  1. Indicates if the image is to be treated as inserted upon completion of the action.

  2. Inserted value should be true.

TransferMethod

String

  1. Transfer method to use with the given Image.

  2. The allowed value for this property is "Stream".

TransferProtocolType

String

  1. Network protocol to use with the image.

  2. The allowed value for this property is "NFS" , "CIFS" and "HTTPS".

WriteProtected

String

  1. Indicates if the remote media is supposed to be treated as write protected.

  2. For CD instance, WriteProtected value is always true.

UserName

String

  1. The username to access the Image parameter-specified URI.

  2. This is a required property for "CIFS" and "HTTPS" protocol.

Password

String

  1. The password to access the Image parameter-specified URI.

  2. This is a required property for "CIFS" and "HTTPS" protocol.

Action Name = InsertMedia

Property

Type

Description

NA

NA

Empty parameter should be given as request data.

MediaTypeArrayTrue

  1. The values of this array shall be the supported media types for this connection.

  2. Only CD MediaType is supported in Redfish

Enum

Description

CD

A CD-ROM format (ISO) image.

TransferProtocolTypeStringTrue
Network protocol to use with the image.

Enum

Description

NFS

Network File System protocol.

CIFS

Common Internet File System.

HTTPS

Hyper Text Transfer Protocol over SecureSocket Layer

TransferMethodStringTrue

  1. Transfer method to use with the given Image.

  2. Only Stream TransferMethod is supported in Redfish.

Enum

Description

Stream

Stream image file data from the source URI

UserNameStringTrueThe username to access the Image parameter-specified URI.

Response example​

When the request is successful, a message body similar to the following is returned:

{
    "@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia",
    "@odata.etag": "\"1593620509\"",
    "@odata.id": "/redfish/v1/Managers/Self/VirtualMedia/CD1",
    "@odata.type": "#VirtualMedia.v1_3_2.VirtualMedia",
    "Actions": {
        "#VirtualMedia.EjectMedia": {
             "@Redfish.ActionInfo": "/redfish/v1/Managers/Self/VirtualMedia/CD1/EjectMediaActionInfo",
             "target": "/redfish/v1/Managers/Self/VirtualMedia/CD1/Actions/VirtualMedia.EjectMedia"
        },
        "#VirtualMedia.InsertMedia": {
            "@Redfish.ActionInfo": "/redfish/v1/Managers/Self/VirtualMedia/CD1/InsertMediaActionInfo",
            "target": "/redfish/v1/Managers/Self/VirtualMedia/CD1/Actions/VirtualMedia.InsertMedia"
        }
    },
    "ConnectedVia": "NotConnected",
    "Description": "Virtual Media Instance redirected to host via this Manager",
    "Id": "CD1",
    "Image": "//10.0.121.123/home/tamil/image",
    "ImageName": "",
    "Inserted": false,
    "MediaTypes": [
      "CD"
    ],
    "Name": "CD1",
    "Oem": {
      "Ami":{
        "@odata.type": "#AMIVirtualMedia.v1_0_0.AMIVirtualMedia",
        "BoostMode": false,
        "RedirectionStatus": "None"
      }
    ],
    "TransferMethod": "Stream",
    "TransferProtocolType": "NFS",
    "UserName": "",
    "WriteProtected": true
}