blob: 7dfdb1a13bcb63e02d6708d5f305666db72b422a [file] [log] [blame]
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +02001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: UpdateService v1.2.1-->
5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). -->
9<!--# 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"/>
22 <edmx:Include Namespace="Resource.v1_0_0"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/SoftwareInventoryCollection_v1.xml">
28 <edmx:Include Namespace="SoftwareInventoryCollection"/>
29 </edmx:Reference>
30
31 <edmx:DataServices>
32
33 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService">
34 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
35
36 <EntityType Name="UpdateService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
37 <Annotation Term="OData.Description" String="This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory."/>
38 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent an Update Service for a Redfish implementation. It represents the properties that affect the service itself."/>
39 <Annotation Term="Capabilities.InsertRestrictions">
40 <Record>
41 <PropertyValue Property="Insertable" Bool="false"/>
42 </Record>
43 </Annotation>
44 <Annotation Term="Capabilities.UpdateRestrictions">
45 <Record>
46 <PropertyValue Property="Updatable" Bool="true"/>
47 <Annotation Term="OData.Description" String="The Update Service can be updated to change properties such as ServiceEnabled."/>
48 </Record>
49 </Annotation>
50 <Annotation Term="Capabilities.DeleteRestrictions">
51 <Record>
52 <PropertyValue Property="Deletable" Bool="false"/>
53 </Record>
54 </Annotation>
55 </EntityType>
56
57 <Action Name="SimpleUpdate" IsBound="true">
58 <Annotation Term="OData.Description" String="This action is used to update software components."/>
59 <Annotation Term="OData.LongDescription" String="This action shall perform an update of installed software component(s) as contained within a software image file located at a URI referenced by the ImageURI parameter."/>
60 <Parameter Name="UpdateService" Type="UpdateService.v1_0_0.Actions"/>
61 <Parameter Name="ImageURI" Type="Edm.String" Nullable="false">
62 <Annotation Term="OData.Description" String="The URI of the software image to be installed."/>
63 <Annotation Term="OData.LongDescription" String="This parameter shall contain a URI referencing a software image to be retreived by the UpdateService for the purpose of installing software contained within the image."/>
64 </Parameter>
65 <Parameter Name="TransferProtocol" Type="UpdateService.v1_0_0.TransferProtocolType">
66 <Annotation Term="OData.Description" String="The network protocol used by the Update Service to retrieve the software image file located at the URI provided in ImageURI, if the URI does not contain a scheme."/>
67 <Annotation Term="OData.LongDescription" String="This parameter shall contain the network protocol that the Update Service shall use to retreive the software image located at the ImageURI. If this parameter is not provided (or supported), and a transfer protocol is not specified by a scheme contained within ImageURI, the Update Service shall use HTTP to retrieve the image."/>
68 </Parameter>
69 <Parameter Name="Targets" Type="Collection(Edm.String)">
70 <Annotation Term="OData.Description" String="The array of URIs indicating where the update image is to be applied."/>
71 <Annotation Term="OData.LongDescription" String="This array property shall contain zero or more URIs indicating where the update image is to be applied."/>
72 <Annotation Term="OData.IsURL"/>
73 </Parameter>
74 </Action>
75 </Schema>
76
77 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_0_0">
78 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
79
80 <EntityType Name="UpdateService" BaseType="UpdateService.UpdateService">
81 <Annotation Term="OData.Description" String="This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory."/>
82 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent an Update Service for a Redfish implementation. It represents the properties that affect the service itself."/>
83 <Property Name="Status" Type="Resource.Status"/>
84 <Property Name="ServiceEnabled" Type="Edm.Boolean">
85 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
86 <Annotation Term="OData.Description" String="This indicates whether this service is enabled."/>
87 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this service is enabled."/>
88 </Property>
89 <NavigationProperty Name="FirmwareInventory" Type="SoftwareInventoryCollection.SoftwareInventoryCollection" ContainsTarget="true">
90 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
91 <Annotation Term="OData.Description" String="An inventory of firmware."/>
92 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource of type SoftwareInventoryCollection."/>
93 <Annotation Term="OData.AutoExpandReferences"/>
94 </NavigationProperty>
95 <NavigationProperty Name="SoftwareInventory" Type="SoftwareInventoryCollection.SoftwareInventoryCollection" ContainsTarget="true">
96 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
97 <Annotation Term="OData.Description" String="An inventory of software."/>
98 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource of type SoftwareInventoryCollection."/>
99 <Annotation Term="OData.AutoExpandReferences"/>
100 </NavigationProperty>
101 <Property Name="Actions" Type="UpdateService.v1_0_0.Actions" Nullable="false">
102 <Annotation Term="OData.Description" String="The Actions object contains the available custom actions on this resource."/>
103 </Property>
104 </EntityType>
105
106 <ComplexType Name="Actions">
107 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
108 <Annotation Term="OData.Description" String="The available actions for this resource."/>
109 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
110 <Property Name="Oem" Type="UpdateService.v1_0_0.OemActions" Nullable="false"/>
111 </ComplexType>
112
113 <ComplexType Name="OemActions">
114 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
115 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
116 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
117 </ComplexType>
118
119 <EnumType Name="TransferProtocolType">
120 <Member Name="CIFS">
121 <Annotation Term="OData.Description" String="Common Internet File System protocol."/>
122 </Member>
123 <Member Name="FTP">
124 <Annotation Term="OData.Description" String="File Transfer Protocol."/>
125 </Member>
126 <Member Name="SFTP">
127 <Annotation Term="OData.Description" String="Secure File Transfer Protocol."/>
128 </Member>
129 <Member Name="HTTP">
130 <Annotation Term="OData.Description" String="Hypertext Transfer Protocol."/>
131 </Member>
132 <Member Name="HTTPS">
133 <Annotation Term="OData.Description" String="HTTP Secure protocol."/>
134 </Member>
135 <Member Name="NSF">
136 <Annotation Term="OData.Description" String="Network File System protocol."/>
137 </Member>
138 <Member Name="SCP">
139 <Annotation Term="OData.Description" String="Secure File Copy protocol."/>
140 </Member>
141 <Member Name="TFTP">
142 <Annotation Term="OData.Description" String="Trivial File Transfer Protocol."/>
143 </Member>
144 <Member Name="OEM">
145 <Annotation Term="OData.Description" String="A protocol defined by the manufacturer."/>
146 </Member>
147 </EnumType>
148
149 </Schema>
150
151 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_0_1">
152 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
153 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
154 <EntityType Name="UpdateService" BaseType="UpdateService.v1_0_0.UpdateService"/>
155 </Schema>
156
157 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_0_2">
158 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
159 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
160 <EntityType Name="UpdateService" BaseType="UpdateService.v1_0_1.UpdateService"/>
161 </Schema>
162
163 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_0_3">
164 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
165 <Annotation Term="OData.Description" String="This version was created to regenerate the JSON schema so that the action parameters are included."/>
166 <EntityType Name="UpdateService" BaseType="UpdateService.v1_0_2.UpdateService"/>
167 </Schema>
168
169 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_1_0">
170 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
171 <EntityType Name="UpdateService" BaseType="UpdateService.v1_0_1.UpdateService">
172 <Property Name="HttpPushUri" Type="Edm.String" Nullable="false">
173 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
174 <Annotation Term="OData.Description" String="The URI used to perform an HTTP or HTTPS push update to the Update Service."/>
175 <Annotation Term="OData.LongDescription" String="This property shall contain a URI at which the UpdateService supports an HTTP or HTTPS POST of a software image for the purpose of installing software contained within the image."/>
176 <Annotation Term="OData.IsURL"/>
177 </Property>
178 </EntityType>
179 </Schema>
180
181 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_1_1">
182 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
183 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
184 <EntityType Name="UpdateService" BaseType="UpdateService.v1_1_0.UpdateService"/>
185 </Schema>
186
187 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_1_2">
188 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
189 <Annotation Term="OData.Description" String="This version was created to regenerate the JSON schema so that the action parameters are included."/>
190 <EntityType Name="UpdateService" BaseType="UpdateService.v1_1_1.UpdateService"/>
191 </Schema>
192
193 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_2_0">
194 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
195 <EntityType Name="UpdateService" BaseType="UpdateService.v1_1_1.UpdateService">
196 <Property Name="HttpPushUriTargets" Type="Collection(Edm.String)">
197 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
198 <Annotation Term="OData.Description" String="The array of URIs indicating the target for applying the update image."/>
199 <Annotation Term="OData.LongDescription" String="This property shall contain zero or more URIs indicating the targets for applying the update image when using HttpPushUri to push a software image. If this property is not present, the Service shall determine where to apply the software image."/>
200 <Annotation Term="OData.IsURL"/>
201 </Property>
202 <Property Name="HttpPushUriTargetsBusy" Type="Edm.Boolean">
203 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
204 <Annotation Term="OData.Description" String="This represents if the HttpPushUriTargets property is reserved by any client."/>
205 <Annotation Term="OData.LongDescription" String="This property shall be a boolean that is set by client when the HttpPushUriTargets property is being used by a client for firmware updates. It shall provide multiple clients a way to negotiate its ownership. This will help clients to know if a firmware update using HttpPushUriTargets is used by another client."/>
206 </Property>
207 </EntityType>
208 </Schema>
209
210 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="UpdateService.v1_2_1">
211 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
212 <Annotation Term="OData.Description" String="This version was created to regenerate the JSON schema so that the action parameters are included."/>
213 <EntityType Name="UpdateService" BaseType="UpdateService.v1_2_0.UpdateService"/>
214 </Schema>
215
216 </edmx:DataServices>
217</edmx:Edmx>