Skip to main content

GET – Virtual media properties

Use the GET method to retrieve properties in virtual media resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Systems/1/VirtualMedia/Id

Request body​

None

Response body​

FieldTypeDescription

Id

String

This field shows the storage type with index value.

The Id value will be any of (Remote1, …, Remote4), (RDOC1, RDOC2) or (EXT1, …, EXT4).

Description

String

This resource is used to represent a virtual media service for a Redfish implementation

Name

String

Expanded.

Action

Object

VirtualMedia

 

#VirtualMedia.EjectMedia

Object

Action for ejecting RDOC media

 

#VirtualMedia.InsertMedia

Object

Action for inserting RDOC media

  

Image

String

Required. This parameter shall contain the URI of the media to be attached to the virtual media. Currently supported protocol: SFTP, CIFS, NFS, HTTP and HTTPS. Currently support at most mounting 2 RDOC images with a total RDOC images size of 100MB.

Note
The value of srouce URL must add protocol prefix. HTTP protocol prefix is “http://” and the complete source URL for HTTP shall be like “http://10.10.10.10/path/to/test.iso”, the SAMBA protocol prefix is “smb://”, the NFS protocol prefix is “nfs://”, the SFTP protocol prefix is “sftp://” and the FTP protocol prefix is “ftp://”.
  

UserName

String

Optional. This parameter shall contain the username to access the URI specified by the Image parameter.

  

Password

String

Optional. This parameter shall contain the password to access the URI specified by the Image parameter.

  

WriteProtected

Boolean

Optional. This parameter shall contain whether the remote media is treated as write-protected.

  

Domain

String

Optional. Domain value for samba protocol.

ImageName

String

Image name.

Image

String

A URI providing the location of the selected image.

MediaTypes

Array

The media types supported as virtual media.

MediaTypes[]

String

The type values for virtual disk devices.

ConnectedVia

String

Current virtual media connection methods.

Inserted

Boolean

Indicates the virtual media is inserted in the virtual device or not.

WriteProtected

Boolean

Indicate the media is write protected

UserName

String

User name

Password

String

null

TransferMethod

String

“Upload” or “Stream”.

TransferProtocolType

String

“HTTPS” or “NFS” or “CIFS”. For RDOC type, this property doesn’t show.

VerifyCertificate

Boolean

Indicated whether to perform certificates verification. By default, this value is false.

Status

Object

Expanded.

 

State

String

  • Enabled: if a VM is installed.

  • Absent: if none is installed.

 

Health

String

OK

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia",
    "@odata.etag": "\"A442E1B6\"",
    "@odata.id": "/redfish/v1/Systems/1/VirtualMedia/EXT1",
    "@odata.type": "#VirtualMedia.v1_4_0.VirtualMedia",
    "ConnectedVia": "NotConnected",
    "Description": "This resource shall be used to represent a virtual media                     service for a Redfish implementation.",
    "Id": "EXT1",
    "Image": null,
    "ImageName": null,
    "Inserted": false,
    "MediaTypes": [
        "CD",
        "DVD",
        "USBStick"
    ],
    "Name": "Virtual Media",
    "Oem": {
        ...
        }
    },
    "Password": null,
    "Status": {
        "Health": "OK",
        "State": "Absent"
    },
    "TransferMethod": "Stream",
    "UserName": null,
    "VerifyCertificate": true,
    "WriteProtected": true
}