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

“VirtualMedia”

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.

Certificates

Link

A reference link to collection of certificates resource.

VerifyCertificate

Boolean

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

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "ConnectedVia": "NotConnected",
    "Id": "RDOC1",
    "@odata.etag": "\"3da38b2209e828a948b\"",
    "MediaTypes": [
        "CD",
        "DVD",
        "Floppy",
        "USBStick"
    ],
    "Image": null,
    "@odata.id": "/redfish/v1/Systems/1/VirtualMedia/RDOC1",
  "Certificates": {
        "@odata.id": "/redfish/v1/Systems/1/VirtualMedia/RDOC1/Certificates"
   },
  "VerifyCertificate": false,
    "Name": "VirtualMedia",
    "Password": null,
    "@odata.type": "#VirtualMedia.v1_5_1.VirtualMedia",
    "WriteProtected": true,
    "Description": "This resource shall be used to represent a virtual media service for a Redfish implementation.",
    "Inserted": false,
    "ImageName": null,
    "UserName": null,
  "TransferMethod": null,
  "TransferProtocolType": null
}