blob: e7d973cc6281d87a880454f2e83e440055b43ebc [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: Settings v1.2.0-->
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.Measures.V1.xml">
18 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
25 <edmx:Include Namespace="Resource"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Message_v1.xml">
28 <edmx:Include Namespace="Message"/>
29 </edmx:Reference>
30
31 <edmx:DataServices>
32
33 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings">
34 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
35 <ComplexType Name="Settings" Abstract="true"/>
36 <ComplexType Name="PreferredApplyTime" Abstract="true"/>
37 <ComplexType Name="OperationApplyTimeSupport" Abstract="true"/>
38 <ComplexType Name="MaintenanceWindow" Abstract="true"/>
39
40 <EnumType Name="OperationApplyTime">
41 <Member Name="Immediate">
42 <Annotation Term="OData.Description" String="Apply the requested operation immediately."/>
43 <Annotation Term="OData.LongDescription" String="This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied immediately."/>
44 </Member>
45 <Member Name="OnReset">
46 <Annotation Term="OData.Description" String="Apply the requested operation on a reset."/>
47 <Annotation Term="OData.LongDescription" String="This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied when the system or service is reset."/>
48 </Member>
49 <Member Name="AtMaintenanceWindowStart">
50 <Annotation Term="OData.Description" String="Apply the requested operation during a maintenance window as specified by an administrator."/>
51 <Annotation Term="OData.LongDescription" String="This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A service may perform resets during this maintenance window."/>
52 </Member>
53 <Member Name="InMaintenanceWindowOnReset">
54 <Annotation Term="OData.Description" String="Apply the requested operation after a reset but within maintenance window as specified by an adminstrator."/>
55 <Annotation Term="OData.LongDescription" String="This OperationApplyTime value shall be used to indicate the requested Create, Delete, or Action operation is applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window."/>
56 </Member>
57 </EnumType>
58 </Schema>
59
60 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_0">
61 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
62
63 <ComplexType Name="Settings" BaseType="Settings.Settings">
64 <Annotation Term="OData.Description" String="This type describes the settings of a resouce."/>
65 <Annotation Term="OData.LongDescription" String="This type shall describe any attributes of a resouce."/>
66 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
67 <Property Name="Time" Type="Edm.DateTimeOffset">
68 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
69 <Annotation Term="OData.Description" String="Indicates the time the settings were applied."/>
70 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the time that the settings object was applied to the resource."/>
71 </Property>
72 <Property Name="ETag" Type="Edm.String">
73 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
74 <Annotation Term="OData.Description" String="The ETag of the resource to which the settings were applied, after the application."/>
75 <Annotation Term="OData.LongDescription" String="The value of this property shall be the ETag of the resource to which the settings were applied, after the application. This is here so that the client can check it against the ETag of the current resource to see if any other changes have also happened to the resource."/>
76 </Property>
77 <NavigationProperty Name="SettingsObject" Type="Resource.Item" Nullable="false">
78 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
79 <Annotation Term="OData.Description" String="Reference to the resource the client may PUT/PATCH to in order to change this resource."/>
80 <Annotation Term="OData.LongDescription" String="The value of this property shall be the URI of the resource to which a client must do a PUT or PATCH in order to modify this resource."/>
81 <Annotation Term="OData.AutoExpandReferences"/>
82 </NavigationProperty>
83 <Property Name="Messages" Type="Collection(Message.Message)" Nullable="false">
84 <Annotation Term="OData.Description" String="This is an array of messages associated with the task."/>
85 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of messages associated with the task."/>
86 </Property>
87 </ComplexType>
88
89 </Schema>
90
91 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_2">
92 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
93 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
94 <ComplexType Name="Settings" BaseType="Settings.v1_0_0.Settings"/>
95 </Schema>
96
97 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_3">
98 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
99 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
100 <ComplexType Name="Settings" BaseType="Settings.v1_0_2.Settings"/>
101 </Schema>
102
103 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_4">
104 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
105 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
106 <ComplexType Name="Settings" BaseType="Settings.v1_0_3.Settings"/>
107 </Schema>
108
109 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_1_0">
110 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
111 <ComplexType Name="Settings" BaseType="Settings.v1_0_4.Settings">
112 <Property Name="SupportedApplyTimes" Type="Collection(Settings.v1_1_0.ApplyTime)" Nullable="false">
113 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
114 <Annotation Term="OData.Description" String="This property indicates when a Settings resource can be applied."/>
115 <Annotation Term="OData.LongDescription" String="A service shall advertise its applytime capabilities using this property as to when a Setting resource can be applied."/>
116 </Property>
117 </ComplexType>
118
119 <ComplexType Name="PreferredApplyTime" BaseType="Settings.PreferredApplyTime">
120 <Annotation Term="OData.Description" String="This object indicates when the future configuration (i.e. Settings resource) should be applied."/>
121 <Annotation Term="OData.LongDescription" String="This object shall be specified by client in a request to indicate its preference on when to apply the values in this Settings resource."/>
122 <Property Name="ApplyTime" Type="Settings.v1_1_0.ApplyTime" Nullable="false">
123 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
124 <Annotation Term="OData.Description" String="This property indicates when the future configuration (i.e. Settings resource) should be applied."/>
125 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the preference on to when to apply the values in this Settings resource."/>
126 </Property>
127 <Property Name="MaintenanceWindowStartTime" Type="Edm.DateTimeOffset" Nullable="false">
128 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
129 <Annotation Term="OData.Description" String="The value of this property as specified by client to indicate the start time of a maintenance window."/>
130 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the date and time as to when the service is allowed to start applying the future configuration as part of a maintenance window. This property shall be required if the ApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
131 </Property>
132 <Property Name="MaintenanceWindowDurationInSeconds" Type="Edm.Int64" Nullable="false">
133 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
134 <Annotation Term="OData.Description" String="The value of this property as specified by client indicates the expiry time of maintenance window in seconds."/>
135 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property. This property shall be required if the ApplyTime property is specified as AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
136 <Annotation Term="Validation.Minimum" Int="0"/>
137 <Annotation Term="Measures.Unit" String="s"/>
138 </Property>
139 </ComplexType>
140
141 <EnumType Name="ApplyTime">
142 <Member Name="Immediate">
143 <Annotation Term="OData.Description" String="Apply immediately."/>
144 <Annotation Term="OData.LongDescription" String="This ApplyTime value shall be used to indicate the values within the Settings resource are applied immediately."/>
145 </Member>
146 <Member Name="OnReset">
147 <Annotation Term="OData.Description" String="Apply on a reset."/>
148 <Annotation Term="OData.LongDescription" String="This ApplyTime value shall be used to indicate the values within the Settings resource are applied when the system or service is reset."/>
149 </Member>
150 <Member Name="AtMaintenanceWindowStart">
151 <Annotation Term="OData.Description" String="Apply during a maintenance window as specified by an administrator."/>
152 <Annotation Term="OData.LongDescription" String="This ApplyTime value shall be used to indicate the values within the Settings resource are applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties. A service may perform resets during this maintenance window."/>
153 </Member>
154 <Member Name="InMaintenanceWindowOnReset">
155 <Annotation Term="OData.Description" String="Apply after a reset but within maintenance window as specified by an adminstrator."/>
156 <Annotation Term="OData.LongDescription" String="This ApplyTime value shall be used to indicate the values within the Settings resource are applied during the maintenance window specified by the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties, and if a reset occurs within the maintenance window."/>
157 </Member>
158 </EnumType>
159 </Schema>
160
161 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_2_0">
162 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
163 <ComplexType Name="Settings" BaseType="Settings.v1_1_0.Settings">
164 <NavigationProperty Name="MaintenanceWindowResource" Type="Resource.ItemOrCollection" Nullable="false">
165 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
166 <Annotation Term="OData.Description" String="The value of this property is used to indicate the location of the maintenance window settings."/>
167 <Annotation Term="OData.LongDescription" String="The value of this property shall be a reference to a resource that contains the @Redfish.MaintenanceWindow property which governs this resource. This property should be supported if the SupportedApplyTimes property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
168 </NavigationProperty>
169 </ComplexType>
170
171 <ComplexType Name="PreferredApplyTime" BaseType="Settings.v1_1_0.PreferredApplyTime"/>
172
173 <ComplexType Name="OperationApplyTimeSupport" BaseType="Settings.OperationApplyTimeSupport">
174 <Annotation Term="OData.Description" String="This object indicates if a client is allowed to request for a specific apply time of a Create, Delete, or Action operation of a given resource."/>
175 <Annotation Term="OData.LongDescription" String="This object shall specify the support a service has for a client to request a specific apply time of a Create, Delete, or Action operation of a given resource."/>
176 <Property Name="SupportedValues" Type="Collection(Settings.OperationApplyTime)" Nullable="false">
177 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
178 <Annotation Term="OData.Description" String="This property indicates the types of apply times the client is allowed request when performing a Create, Delete, or Action operation."/>
179 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the types of apply times the client is allowed request when performing a Create, Delete, or Action operation."/>
180 <Annotation Term="Redfish.Required"/>
181 </Property>
182 <Property Name="MaintenanceWindowStartTime" Type="Edm.DateTimeOffset" Nullable="false">
183 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
184 <Annotation Term="OData.Description" String="The value of this property as specified by client to indicate the start time of a maintenance window."/>
185 <Annotation Term="OData.LongDescription" String="The value of this property shall be the same as the MaintenanceWindowStartTime property found in the MaintenanceWindow structure on the MaintenanceWindowResource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
186 </Property>
187 <Property Name="MaintenanceWindowDurationInSeconds" Type="Edm.Int64" Nullable="false">
188 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
189 <Annotation Term="OData.Description" String="The value of this property as specified by client indicates the expiry time of maintenance window in seconds."/>
190 <Annotation Term="OData.LongDescription" String="The value of this property shall be the same as the MaintenanceWindowDurationInSeconds property found in the MaintenanceWindow structure on the MaintenanceWindowResource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
191 <Annotation Term="Validation.Minimum" Int="0"/>
192 <Annotation Term="Measures.Unit" String="s"/>
193 </Property>
194 <NavigationProperty Name="MaintenanceWindowResource" Type="Resource.ItemOrCollection" Nullable="false">
195 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
196 <Annotation Term="OData.Description" String="The value of this property is used to indicate the location of the maintenance window settings."/>
197 <Annotation Term="OData.LongDescription" String="The value of this property shall be a reference to a resource that contains the @Redfish.MaintenanceWindow property which governs this resource. This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
198 </NavigationProperty>
199 </ComplexType>
200
201 <ComplexType Name="MaintenanceWindow" BaseType="Settings.MaintenanceWindow">
202 <Annotation Term="OData.Description" String="This object indicates if a given resource has a maintenance window assignment for applying settings or operations."/>
203 <Annotation Term="OData.LongDescription" String="This object shall indicate if a given resource has a maintenance window assignment for applying settings or operations. Other resources may reference this object in order to convey a common control surface for the configuration of the maintenance window."/>
204 <Property Name="MaintenanceWindowStartTime" Type="Edm.DateTimeOffset" Nullable="false">
205 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
206 <Annotation Term="OData.Description" String="The value of this property as specified by client to indicate the start time of a maintenance window."/>
207 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the date and time as to when the service is allowed to start applying the requested settings or operation as part of a maintenance window."/>
208 <Annotation Term="Redfish.Required"/>
209 </Property>
210 <Property Name="MaintenanceWindowDurationInSeconds" Type="Edm.Int64" Nullable="false">
211 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
212 <Annotation Term="OData.Description" String="The value of this property as specified by client indicates the expiry time of maintenance window in seconds."/>
213 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property."/>
214 <Annotation Term="Validation.Minimum" Int="0"/>
215 <Annotation Term="Measures.Unit" String="s"/>
216 <Annotation Term="Redfish.Required"/>
217 </Property>
218 </ComplexType>
219 </Schema>
220
221 </edmx:DataServices>
222</edmx:Edmx>