diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json | 289 |
1 files changed, 289 insertions, 0 deletions
diff --git a/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json b/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json new file mode 100644 index 0000000000..7bc0416485 --- /dev/null +++ b/static/redfish/v1/JsonSchemas/VirtualMedia/VirtualMedia.json @@ -0,0 +1,289 @@ +{ + "$ref": "#/definitions/VirtualMedia", + "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json", + "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (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|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "#VirtualMedia.EjectMedia": { + "$ref": "#/definitions/EjectMedia" + }, + "#VirtualMedia.InsertMedia": { + "$ref": "#/definitions/InsertMedia" + }, + "Oem": { + "$ref": "#/definitions/OemActions" + } + }, + "type": "object" + }, + "ConnectedVia": { + "enum": [ + "NotConnected", + "URI", + "Applet", + "Oem" + ], + "enumDescriptions": { + "Applet": "Connected to a client application.", + "NotConnected": "No current connection.", + "Oem": "Connected via an OEM-defined method.", + "URI": "Connected to a URI location." + }, + "type": "string" + }, + "EjectMedia": { + "additionalProperties": false, + "description": "This action is used to detach 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|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "target": { + "description": "Link to invoke action", + "format": "uri", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object" + }, + "InsertMedia": { + "additionalProperties": false, + "description": "This action is used to attach remote media to virtual media.", + "longDescription": "This action shall attach remote media to virtual media.", + "parameters": { + "Image": { + "description": "The URI of the remote media to attach to the virtual media.", + "longDescription": "This value shall specify the URI of the remote media to be attached to the virtual media.", + "requiredParameter": true, + "type": "string" + }, + "Inserted": { + "description": "Indicates if the image is to be treated as inserted upon completion of the action.", + "longDescription": "This value shall specify if the image is to be treated as inserted upon completion of the action. If this parameter is not provided by the client, the service shall default this value to be true.", + "type": "boolean" + }, + "WriteProtected": { + "description": "Indicates if the remote media is supposed to be treated as write protected.", + "longDescription": "This value shall specify if the remote media is supposed to be treated as write protected. If this parameter is not provided by the client, the service shall default this value to be true.", + "type": "boolean" + } + }, + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "target": { + "description": "Link to invoke action", + "format": "uri", + "type": "string" + }, + "title": { + "description": "Friendly action name", + "type": "string" + } + }, + "type": "object" + }, + "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 any additional OEM actions for this resource.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": {}, + "type": "object" + }, + "VirtualMedia": { + "additionalProperties": false, + "description": "The VirtualMedia schema contains properties related to monitoring and control of an instance of virtual media such as a remote CD, DVD, or USB device. Virtual media functionality is provided by a Manager for a system or device.", + "longDescription": "This resource shall be used to represent a virtual media service for a Redfish implementation.", + "patternProperties": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "description": "This property shall specify a valid odata or Redfish property.", + "type": [ + "array", + "boolean", + "number", + "null", + "object", + "string" + ] + } + }, + "properties": { + "@odata.context": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context" + }, + "@odata.id": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id" + }, + "@odata.type": { + "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type" + }, + "Actions": { + "$ref": "#/definitions/Actions", + "description": "The available actions for this resource.", + "longDescription": "The Actions property shall contain the available actions for this resource." + }, + "ConnectedVia": { + "anyOf": [ + { + "$ref": "#/definitions/ConnectedVia" + }, + { + "type": "null" + } + ], + "description": "Current virtual media connection methods.", + "longDescription": "The value of this property shall indicate the current connection method from a client to the virtual media represented by this resource. A value of NotConnected shall indicate no connection is present. A value of URI shall indicate that a remote connection via a URI reference type is being used.", + "readonly": true + }, + "Description": { + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" + }, + { + "type": "null" + } + ], + "readonly": true + }, + "Id": { + "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", + "readonly": true + }, + "Image": { + "description": "A URI providing the location of the selected image.", + "format": "uri", + "longDescription": "The value of this string shall be an URI. A null value indicated no image connection.", + "readonly": false, + "type": [ + "string", + "null" + ] + }, + "ImageName": { + "description": "The current image name.", + "longDescription": "The value of this property shall be the name of the image.", + "readonly": true, + "type": [ + "string", + "null" + ] + }, + "Inserted": { + "description": "Indicates if virtual media is inserted in the virtual device.", + "longDescription": "The value of this property shall be used to indicate if media is present in the virtual media device. This is usually only applicable to remoting of devices and not for image virtual media usage.", + "readonly": false, + "type": [ + "boolean", + "null" + ] + }, + "MediaTypes": { + "description": "This is the media types supported as virtual media.", + "items": { + "$ref": "#/definitions/MediaType" + }, + "longDescription": "The values of this array shall be 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": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.", + "longDescription": "The value of this string shall be of the format for the reserved word *Oem*." + }, + "WriteProtected": { + "description": "Indicates the media is write protected.", + "longDescription": "The value of this property shall be used to indicate if the remote device media prevents writing to that media.", + "readonly": false, + "type": [ + "boolean", + "null" + ] + } + }, + "required": [ + "Id", + "Name" + ], + "type": "object" + } + }, + "title": "#VirtualMedia.v1_2_0.VirtualMedia" +}
\ No newline at end of file |