xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/VirtualMedia.v1_6_5.json (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/VirtualMedia.v1_6_5.json",
    "$ref": "#/definitions/VirtualMedia",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "#VirtualMedia.EjectMedia": {
                    "$ref": "#/definitions/EjectMedia"
                },
                "#VirtualMedia.InsertMedia": {
                    "$ref": "#/definitions/InsertMedia"
                },
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
                    "versionAdded": "v1_1_0"
                }
            },
            "type": "object"
        },
        "ConnectedVia": {
            "enum": [
                "NotConnected",
                "URI",
                "Applet",
                "Oem"
            ],
            "enumDescriptions": {
                "Applet": "Connected to a client application.",
                "NotConnected": "No current connection.",
                "Oem": "Connected through an OEM-defined method.",
                "URI": "Connected to a URI location."
            },
            "type": "string"
        },
        "EjectMedia": {
            "additionalProperties": false,
            "description": "This action detaches remote media from virtual media.",
            "longDescription": "This action shall detach the remote media from the virtual media.  At the completion of the operation, inserted shall be set to `false` and the image name shall be cleared.",
            "parameters": {},
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object",
            "versionAdded": "v1_2_0"
        },
        "EjectPolicy": {
            "enum": [
                "OnPowerOff",
                "Session",
                "Timed",
                "AfterUse",
                "Persistent"
            ],
            "enumDescriptions": {
                "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."
            },
            "type": "string"
        },
        "InsertMedia": {
            "additionalProperties": false,
            "description": "This action attaches remote media to virtual media.",
            "longDescription": "This action shall attach remote media to virtual media.  Service should reject the request if the `Image` property in the resource does not contain `null`.  Users are expected to eject media prior to inserting new media.",
            "parameters": {
                "Image": {
                    "description": "The URI of the media to attach to the virtual media.",
                    "longDescription": "This parameter shall contain the URI of the media to be attached to the virtual media.  This parameter may specify an absolute URI to remote media or a relative URI to media local to the implementation.  A service may allow a relative URI to reference a `SoftwareInventory` resource.  Services may reject this action if the URI is not accessible.",
                    "requiredParameter": true,
                    "type": "string"
                },
                "Inserted": {
                    "description": "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`.",
                    "longDescription": "This parameter shall contain whether the image is treated as mounted and visible to the host system upon completion of the action.  If the client does not provide this parameter, the service shall default this value to `true`.",
                    "type": "boolean"
                },
                "Password": {
                    "description": "The password to access the URI specified by the `Image` parameter.",
                    "longDescription": "This parameter shall contain the password to access the URI specified by the `Image` parameter.",
                    "type": "string",
                    "versionAdded": "v1_3_0"
                },
                "TransferMethod": {
                    "$ref": "#/definitions/TransferMethod",
                    "description": "The transfer method to use with the image.",
                    "longDescription": "This parameter shall contain the transfer method to use with the specified image URI.",
                    "versionAdded": "v1_3_0"
                },
                "TransferProtocolType": {
                    "$ref": "#/definitions/TransferProtocolType",
                    "description": "The network protocol to use with the URI specified by the `Image` parameter.",
                    "longDescription": "This parameter shall contain the network protocol to use with the URI specified by the `Image` parameter.",
                    "versionAdded": "v1_3_0"
                },
                "UserName": {
                    "description": "The username to access the URI specified by the `Image` parameter.",
                    "longDescription": "This parameter shall contain the username to access the URI specified by the `Image` parameter.",
                    "type": "string",
                    "versionAdded": "v1_3_0"
                },
                "WriteProtected": {
                    "description": "An indication of whether the remote media is treated as write-protected.  The default is `true`.",
                    "longDescription": "This parameter shall contain whether the remote media is treated as write-protected.  If the client does not provide this parameter, the service shall default this value to `true`.",
                    "type": "boolean"
                }
            },
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "target": {
                    "description": "Link to invoke action",
                    "format": "uri-reference",
                    "type": "string"
                },
                "title": {
                    "description": "Friendly action name",
                    "type": "string"
                }
            },
            "type": "object",
            "versionAdded": "v1_2_0"
        },
        "MediaType": {
            "enum": [
                "CD",
                "Floppy",
                "USBStick",
                "DVD"
            ],
            "enumDescriptions": {
                "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."
            },
            "type": "string"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "TransferMethod": {
            "enum": [
                "Stream",
                "Upload"
            ],
            "enumDescriptions": {
                "Stream": "Stream image file data from the source URI.",
                "Upload": "Upload the entire image file from the source URI to the service."
            },
            "type": "string"
        },
        "TransferProtocolType": {
            "enum": [
                "CIFS",
                "FTP",
                "SFTP",
                "HTTP",
                "HTTPS",
                "NFS",
                "SCP",
                "TFTP",
                "OEM"
            ],
            "enumDescriptions": {
                "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)."
            },
            "type": "string"
        },
        "VirtualMedia": {
            "additionalProperties": false,
            "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.",
            "longDescription": "This resource shall represent a virtual media service for a Redfish implementation.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource.",
                    "versionAdded": "v1_1_0"
                },
                "Certificates": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
                    "description": "The link to a collection of server certificates for the server referenced by the `Image` property.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CertificateCollection` that represents the server certificates for the server referenced by the `Image` property.  If `VerifyCertificate` is `true`, services shall compare the certificates in this collection with the certificate obtained during handshaking with the image server in order to verify the identity of the image server prior to completing the remote media connection.  If the server cannot be verified, the service shall not complete the remote media connection.  If `VerifyCertificate` is `false`, the service shall not perform certificate verification with certificates in this collection.  Regardless of the contents of this collection, services may perform additional verification based on other factors, such as the configuration of the `SecurityPolicy` resource.",
                    "readonly": true,
                    "versionAdded": "v1_4_0"
                },
                "ClientCertificates": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
                    "description": "The link to a collection of client identity certificates provided to the server referenced by the `Image` property.",
                    "longDescription": "This property shall contain a link to a resource collection of type `CertificateCollection` that represents the client identity certificates that are provided to the server referenced by the `Image` property as part of TLS handshaking.",
                    "readonly": true,
                    "versionAdded": "v1_5_0"
                },
                "ConnectedVia": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/ConnectedVia"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The current virtual media connection method.",
                    "longDescription": "This property shall contain the current connection method from a client to the virtual media that this resource represents.",
                    "readonly": true
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "EjectPolicy": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/EjectPolicy"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The ejection policy for the virtual media.",
                    "longDescription": "This property shall contain the ejection policy for the virtual media.",
                    "readonly": false,
                    "versionAdded": "v1_6_0"
                },
                "EjectTimeout": {
                    "description": "Timeout value before the virtual media is automatically ejected.",
                    "longDescription": "This property shall indicate the amount of time before virtual media is automatically ejected when `EjectPolicy` contains `Timed`.",
                    "pattern": "^P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?$",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_6_0"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Image": {
                    "description": "The URI of the location of the selected image.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain the URI of the media attached to the virtual media.  This value may specify an absolute URI to remote media or a relative URI to media local to the implementation.  A service may allow a relative URI to reference a SoftwareInventory resource.  The value `null` shall indicate no image connection.  If the URI specified by this property is not accessible, services should populate the `Conditions` property in `Status` with messages that describe the condition.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "ImageName": {
                    "description": "The current image name.",
                    "longDescription": "This property shall contain the name of the image.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Inserted": {
                    "description": "An indication of whether the media is mounted and visible to the host system.",
                    "longDescription": "This property shall indicate whether the media is mounted and visible to the host system.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "MediaTypes": {
                    "description": "The media types supported as virtual media.",
                    "items": {
                        "$ref": "#/definitions/MediaType"
                    },
                    "longDescription": "This property shall contain an array of the supported media types for this connection.",
                    "readonly": true,
                    "type": "array"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "Password": {
                    "description": "The password to access the URI specified by the `Image` property.  The value is `null` in responses.",
                    "longDescription": "This property shall contain the password to access the URI specified by the `Image` property.  The value shall be `null` in responses.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_3_0"
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of the resource and its subordinate or dependent resources.",
                    "longDescription": "This property shall contain any status or health properties of the resource.",
                    "versionAdded": "v1_4_0"
                },
                "TransferMethod": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/TransferMethod"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The transfer method to use with the image.",
                    "longDescription": "This property shall describe how the image transfer occurs.",
                    "readonly": false,
                    "versionAdded": "v1_3_0"
                },
                "TransferProtocolType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/TransferProtocolType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The network protocol to use with the URI specified by the `Image` property.",
                    "longDescription": "This property shall contain network protocol to use with the URI specified by the `Image` property.",
                    "readonly": false,
                    "versionAdded": "v1_3_0"
                },
                "UserName": {
                    "description": "The username to access the URI specified by the `Image` property.",
                    "longDescription": "This property shall contain the username to access the URI specified by the `Image` property.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_3_0"
                },
                "VerifyCertificate": {
                    "description": "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.",
                    "longDescription": "This property shall indicate whether the service will verify the certificate of the server referenced by the `Image` property prior to completing the remote media connection with the certificates found in the collection referenced by the `Certificates` property.  If this property is not supported by the service, it shall be assumed to be `false`.  This property should default to `false` in order to maintain compatibility with older clients.  Regardless of the value of this property, services may perform additional verification based on other factors, such as the configuration of the SecurityPolicy resource.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "WriteProtected": {
                    "description": "An indication of whether the media is write-protected.",
                    "longDescription": "This property shall indicate whether the remote device media prevents writing to that media.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2022.3",
    "title": "#VirtualMedia.v1_6_5.VirtualMedia"
}