iLO 4 REST API Data Model (VirtualMedia Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki

HP RESTful API Data Model Reference for iLO 4—Redfish 1.0 Conformance (Cont)

"VirtualMedia" Resource Type

Resource Instances

/rest/v1/Managers/{item}/VirtualMedia/{item}

See Resource Map for more details.

This is the schema definition for the Virtual Media service.

"VirtualMedia" defines the following properties:

"ConnectedVia"

This property is a member of VirtualMedia

Specifies how the virtual media is connected to the server.
JSON type:
String containing one of the following supported values: "NotConnected" "URI" "Applet"

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Image"

This property is a member of [VirtualMedia](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(VirtualMedia-Resource-Type)#virtualmedia-resource-type)
The valid URI indicating the image that is mounted on this server. A null value indicates that no image exists.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Image": "<string-value>"}

The property "Image" on resource type VirtualMedia may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"ImageName"

This property is a member of [VirtualMedia](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(VirtualMedia-Resource-Type)#virtualmedia-resource-type)
The name of the image that is mounted on this server. This is usually provided when a URL image is mounted through scripted virtual media.
JSON type:
String

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Inserted"

This property is a member of [VirtualMedia](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(VirtualMedia-Resource-Type)#virtualmedia-resource-type)
Indicates whether the virtual media is mounted on the server.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.

"Oem/Hp/BootOnNextServerReset"

This property is a member of [VirtualMedia](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(VirtualMedia-Resource-Type)#virtualmedia-resource-type)
If set to true, the server will boot to this image on the next server reboot. The image will be ejected automatically on the second server reboot so that the server does not boot to this image twice.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not.
PATCH This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers.

PATCH Example

HTTP PATCH to resource with request JSON:

{"Oem": {"Hp": {"BootOnNextServerReset": true}}}

The property "Oem/Hp/BootOnNextServerReset" on resource type VirtualMedia may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.

"WriteProtected"

This property is a member of [VirtualMedia](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(VirtualMedia-Resource-Type)#virtualmedia-resource-type)
Indicates whether the virtual media is protected against write operations.
JSON type:
Boolean ('true' or 'false')

HTTP Operations

GET Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request.
⚠️ **GitHub.com Fallback** ⚠️