blob: 92824d76cefd566e0345c58341d9cbd46b9e8488 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanous530520e2019-01-02 13:41:37 -08004<!--# Redfish Schema: VirtualMedia v1.2.1-->
Jason M. Billsea4aa752018-06-05 13:29:11 -07005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Ed Tanous530520e2019-01-02 13:41:37 -08008<!--# Copyright 2014-2018 DMTF. -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07009<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource.v1_0_0"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 </edmx:Reference>
26
27 <edmx:DataServices>
28
29 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia">
30 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
31
32 <EntityType Name="VirtualMedia" BaseType="Resource.v1_0_0.Resource" Abstract="true">
33 <Annotation Term="OData.Description" String="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."/>
34 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a virtual media service for a Redfish implementation."/>
35 <Annotation Term="Capabilities.InsertRestrictions">
36 <Record>
37 <PropertyValue Property="Insertable" Bool="false"/>
38 </Record>
39 </Annotation>
40 <Annotation Term="Capabilities.UpdateRestrictions">
41 <Record>
Ed Tanous530520e2019-01-02 13:41:37 -080042 <PropertyValue Property="Updatable" Bool="true"/>
43 <Annotation Term="OData.Description" String="A VirtualMedia instance can be updated to change properties such as Image, Inserted, and WriteProtected."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070044 </Record>
45 </Annotation>
46 <Annotation Term="Capabilities.DeleteRestrictions">
47 <Record>
48 <PropertyValue Property="Deletable" Bool="false"/>
49 </Record>
50 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -080051 <Annotation Term="Redfish.Uris">
52 <Collection>
53 <String>/redfish/v1/Managers/{ManagerId}/VirtualMedia/{VirtualMediaId}</String>
54 </Collection>
55 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070056 </EntityType>
57
58 <Action Name="InsertMedia" IsBound="true">
59 <Annotation Term="OData.Description" String="This action is used to attach remote media to virtual media."/>
60 <Annotation Term="OData.LongDescription" String="This action shall attach remote media to virtual media."/>
61 <Parameter Name="VirtualMedia" Type="VirtualMedia.v1_1_0.Actions"/>
62 <Parameter Name="Image" Type="Edm.String" Nullable="false">
63 <Annotation Term="OData.Description" String="The URI of the remote media to attach to the virtual media."/>
64 <Annotation Term="OData.LongDescription" String="This value shall specify the URI of the remote media to be attached to the virtual media."/>
65 </Parameter>
66 <Parameter Name="Inserted" Type="Edm.Boolean">
67 <Annotation Term="OData.Description" String="Indicates if the image is to be treated as inserted upon completion of the action."/>
68 <Annotation Term="OData.LongDescription" String="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."/>
69 </Parameter>
70 <Parameter Name="WriteProtected" Type="Edm.Boolean">
71 <Annotation Term="OData.Description" String="Indicates if the remote media is supposed to be treated as write protected."/>
72 <Annotation Term="OData.LongDescription" String="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."/>
73 </Parameter>
74 </Action>
75
76 <Action Name="EjectMedia" IsBound="true">
77 <Annotation Term="OData.Description" String="This action is used to detach remote media from virtual media."/>
78 <Annotation Term="OData.LongDescription" String="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."/>
79 <Parameter Name="VirtualMedia" Type="VirtualMedia.v1_1_0.Actions"/>
80 </Action>
81
82 </Schema>
83
84 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_0_0">
85 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
86
87 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.VirtualMedia">
88 <Property Name="ImageName" Type="Edm.String">
89 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
90 <Annotation Term="OData.Description" String="The current image name."/>
91 <Annotation Term="OData.LongDescription" String="The value of this property shall be the name of the image."/>
92 </Property>
93 <Property Name="Image" Type="Edm.String">
94 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
95 <Annotation Term="OData.Description" String="A URI providing the location of the selected image."/>
96 <Annotation Term="OData.LongDescription" String="The value of this string shall be an URI. A null value indicated no image connection."/>
97 <Annotation Term="OData.IsURL"/>
98 </Property>
99 <Property Name="MediaTypes" Type="Collection(VirtualMedia.v1_0_0.MediaType)" Nullable="false">
100 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
101 <Annotation Term="OData.Description" String="This is the media types supported as virtual media."/>
102 <Annotation Term="OData.LongDescription" String="The values of this array shall be the supported media types for this connection."/>
103 </Property>
104 <Property Name="ConnectedVia" Type="VirtualMedia.v1_0_0.ConnectedVia">
105 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
106 <Annotation Term="OData.Description" String="Current virtual media connection methods."/>
107 <Annotation Term="OData.LongDescription" String="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."/>
108 </Property>
109 <Property Name="Inserted" Type="Edm.Boolean">
110 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
111 <Annotation Term="OData.Description" String="Indicates if virtual media is inserted in the virtual device."/>
112 <Annotation Term="OData.LongDescription" String="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."/>
113 </Property>
114 <Property Name="WriteProtected" Type="Edm.Boolean">
115 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
116 <Annotation Term="OData.Description" String="Indicates the media is write protected."/>
117 <Annotation Term="OData.LongDescription" String="The value of this property shall be used to indicate if the remote device media prevents writing to that media."/>
118 </Property>
119 </EntityType>
120
121 <EnumType Name="MediaType">
122 <Member Name="CD">
123 <Annotation Term="OData.Description" String="A CD-ROM format (ISO) image."/>
124 </Member>
125 <Member Name="Floppy">
126 <Annotation Term="OData.Description" String="A floppy disk image."/>
127 </Member>
128 <Member Name="USBStick">
129 <Annotation Term="OData.Description" String="An emulation of a USB storage device."/>
130 </Member>
131 <Member Name="DVD">
132 <Annotation Term="OData.Description" String="A DVD-ROM format image."/>
133 </Member>
134 </EnumType>
135
136 <EnumType Name="ConnectedVia">
137 <Member Name="NotConnected">
138 <Annotation Term="OData.Description" String="No current connection."/>
139 </Member>
140 <Member Name="URI">
141 <Annotation Term="OData.Description" String="Connected to a URI location."/>
142 </Member>
143 <Member Name="Applet">
144 <Annotation Term="OData.Description" String="Connected to a client application."/>
145 </Member>
146 <Member Name="Oem">
147 <Annotation Term="OData.Description" String="Connected via an OEM-defined method."/>
148 </Member>
149 </EnumType>
150
151 </Schema>
152
153 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_0_2">
154 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
155 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
156 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_0_0.VirtualMedia"/>
157 </Schema>
158
159 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_0_3">
160 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
161 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
162 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_0_2.VirtualMedia"/>
163 </Schema>
164
Ed Tanous530520e2019-01-02 13:41:37 -0800165 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_0_4">
166 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
167 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
168 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_0_3.VirtualMedia"/>
169 </Schema>
170
Jason M. Billsea4aa752018-06-05 13:29:11 -0700171 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_1_0">
172 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
173 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_0_3.VirtualMedia">
174 <Property Name="Actions" Type="VirtualMedia.v1_1_0.Actions" Nullable="false">
175 <Annotation Term="OData.Description" String="The available actions for this resource."/>
176 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
177 </Property>
178 </EntityType>
179
180 <ComplexType Name="Actions">
181 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
182 <Annotation Term="OData.Description" String="The available actions for this resource."/>
183 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800184 <Property Name="Oem" Type="VirtualMedia.v1_1_0.OemActions" Nullable="false">
185 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
186 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
187 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700188 </ComplexType>
189
190 <ComplexType Name="OemActions">
191 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
192 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
193 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
194 </ComplexType>
195 </Schema>
196
197 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_1_1">
198 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
199 <Annotation Term="OData.Description" String="This version was created to perform editoral updates of descriptions defined in this schema."/>
200 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_1_0.VirtualMedia"/>
201 </Schema>
202
Ed Tanous530520e2019-01-02 13:41:37 -0800203 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_1_2">
204 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
205 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
206 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_1_1.VirtualMedia"/>
207 </Schema>
208
Jason M. Billsea4aa752018-06-05 13:29:11 -0700209 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_2_0">
210 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
211 <Annotation Term="OData.Description" String="This version was created to change the permissions of Image, Inserted, and WriteProtected and to add the InsertMedia and InjectMedia actions."/>
212 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_1_1.VirtualMedia"/>
213 </Schema>
214
Ed Tanous530520e2019-01-02 13:41:37 -0800215 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="VirtualMedia.v1_2_1">
216 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
217 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
218 <EntityType Name="VirtualMedia" BaseType="VirtualMedia.v1_2_0.VirtualMedia"/>
219 </Schema>
220
Jason M. Billsea4aa752018-06-05 13:29:11 -0700221 </edmx:DataServices>
222</edmx:Edmx>