summaryrefslogtreecommitdiffstats
path: root/static/redfish/v1/schema/Settings_v1.xml
blob: b589f6607f0ef9c540a8c739656ecca6fcfaecb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  Settings v1.2.2                                                     -->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2019 DMTF.                                                            -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################       -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
    <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
    <edmx:Include Namespace="Resource"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Message_v1.xml">
    <edmx:Include Namespace="Message"/>
  </edmx:Reference>

  <edmx:DataServices>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <ComplexType Name="Settings" Abstract="true"/>
      <ComplexType Name="PreferredApplyTime" Abstract="true"/>
      <ComplexType Name="OperationApplyTimeSupport" Abstract="true"/>
      <ComplexType Name="MaintenanceWindow" Abstract="true"/>

      <EnumType Name="OperationApplyTime">
        <Annotation Term="Redfish.Revisions">
          <Collection>
            <Record>
              <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
              <PropertyValue Property="Version" String="v1_2_0"/>
            </Record>
          </Collection>
        </Annotation>
        <Member Name="Immediate">
          <Annotation Term="OData.Description" String="The requested operation is applied immediately."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the requested create, delete, or action operation is applied immediately."/>
        </Member>
        <Member Name="OnReset">
          <Annotation Term="OData.Description" String="The requested operation is applied on a reset."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the requested create, delete, or action operation is applied when the system or service is reset."/>
        </Member>
        <Member Name="AtMaintenanceWindowStart">
          <Annotation Term="OData.Description" String="The requested operation is applied within the administrator-specified maintenance window."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the requested create, delete, or action operation is applied during the maintenance window that the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties specify.  A service may complete resets during this maintenance window."/>
        </Member>
        <Member Name="InMaintenanceWindowOnReset">
          <Annotation Term="OData.Description" String="The requested operation is applied after a reset but within the administrator-specified maintenance window."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the requested create, delete, or action operation is applied during the maintenance window that the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties specify, and if a reset occurs within the maintenance window."/>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="1.0"/>

      <ComplexType Name="Settings" BaseType="Settings.Settings">
        <Annotation Term="OData.Description" String="The Resource settings."/>
        <Annotation Term="OData.LongDescription" String="This type shall describe any settings of a Resource."/>
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Property Name="Time" Type="Edm.DateTimeOffset">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The time when the settings were applied."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the time when the settings were applied to the Resource."/>
        </Property>
        <Property Name="ETag" Type="Edm.String">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The entity tag (ETag) of the Resource to which the settings were applied, after the application."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the entity tag (ETag) of the Resource to which the settings were applied, after the application.  The client can check this value against the ETag of this Resource to determine whether the Resource had other changes."/>
        </Property>
        <NavigationProperty Name="SettingsObject" Type="Resource.Item" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The link to the Resource that the client may PUT or PATCH to modify the Resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain the URI of the Resource that the client may PUT or PATCH to modify the Resource."/>
          <Annotation Term="OData.AutoExpandReferences"/>
        </NavigationProperty>
        <Property Name="Messages" Type="Collection(Message.Message)" Nullable="false">
          <Annotation Term="OData.Description" String="An array of messages associated with the settings."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain an array of messages associated with the settings."/>
        </Property>
      </ComplexType>

    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_0_0.Settings"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_0_2.Settings"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_4">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_0_3.Settings"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_5">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <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."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_0_4.Settings"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_0_6">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_0_5.Settings"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_1_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2017.2"/>
      <ComplexType Name="Settings" BaseType="Settings.v1_0_4.Settings">
        <Property Name="SupportedApplyTimes" Type="Collection(Settings.v1_1_0.ApplyTime)" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The time when the settings can be applied."/>
          <Annotation Term="OData.LongDescription" String="A service shall advertise its applytime capabilities by using this property to set the time when the settings can be applied."/>
        </Property>
      </ComplexType>

      <ComplexType Name="PreferredApplyTime" BaseType="Settings.PreferredApplyTime">
        <Annotation Term="OData.Description" String="The preferred time to apply configuration settings."/>
        <Annotation Term="OData.LongDescription" String="This type shall be specified by client to indicate the preferred time to apply the configuration settings."/>
        <Property Name="ApplyTime" Type="Settings.v1_1_0.ApplyTime" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The time when to apply the settings."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate when to apply the values in this Settings Resource."/>
        </Property>
        <Property Name="MaintenanceWindowStartTime" Type="Edm.DateTimeOffset" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The start time of a maintenance window."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the date and time when the service can start to apply the future configuration as part of a maintenance window.  This property shall be required if the ApplyTime property is `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`."/>
        </Property>
        <Property Name="MaintenanceWindowDurationInSeconds" Type="Edm.Int64" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The expiry time of maintenance window in seconds."/>
          <Annotation Term="OData.LongDescription" String="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 `AtMaintenanceWindowStart` or `InMaintenanceWindowOnReset`."/>
          <Annotation Term="Validation.Minimum" Int="0"/>
          <Annotation Term="Measures.Unit" String="s"/>
        </Property>
      </ComplexType>

      <EnumType Name="ApplyTime">
        <Member Name="Immediate">
          <Annotation Term="OData.Description" String="Apply immediately."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the values within the Settings Resource are applied immediately."/>
        </Member>
        <Member Name="OnReset">
          <Annotation Term="OData.Description" String="Apply on a reset."/>
          <Annotation Term="OData.LongDescription" String="This value shall indicate the values within Settings Resource are applied when the system or service is reset."/>
        </Member>
        <Member Name="AtMaintenanceWindowStart">
          <Annotation Term="OData.Description" String="Apply during a maintenance window as specified by an administrator."/>
          <Annotation Term="OData.LongDescription" String="This value shall 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."/>
        </Member>
        <Member Name="InMaintenanceWindowOnReset">
          <Annotation Term="OData.Description" String="Apply after a reset but within maintenance window as specified by an adminstrator."/>
          <Annotation Term="OData.LongDescription" String="This value shall 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."/>
        </Member>
      </EnumType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_1_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <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."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_1_0.Settings"/>
      <ComplexType Name="PreferredApplyTime" BaseType="Settings.v1_1_0.PreferredApplyTime"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_1_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_1_1.Settings"/>
      <ComplexType Name="PreferredApplyTime" BaseType="Settings.v1_1_1.PreferredApplyTime"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_2_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2018.1"/>
      <ComplexType Name="Settings" BaseType="Settings.v1_1_0.Settings">
        <NavigationProperty Name="MaintenanceWindowResource" Type="Resource.ItemOrCollection" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The location of the maintenance window settings."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a Resource that contains the @Redfish.MaintenanceWindow property that governs this Resource.  This property should be supported if the SupportedApplyTimes property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
        </NavigationProperty>
      </ComplexType>

      <ComplexType Name="PreferredApplyTime" BaseType="Settings.v1_1_0.PreferredApplyTime"/>

      <ComplexType Name="OperationApplyTimeSupport" BaseType="Settings.OperationApplyTimeSupport">
        <Annotation Term="OData.Description" String="The client can request a specific apply time of a create, delete, or action operation of a Resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall indicate that a client can request a specific apply time of a create, delete, or action operation of a Resource."/>
        <Property Name="SupportedValues" Type="Collection(Settings.OperationApplyTime)" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The types of apply times that the client can request when performing a create, delete, or action operation."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the types of apply times the client can request when performing a create, delete, or action operation."/>
          <Annotation Term="Redfish.Required"/>
        </Property>
        <Property Name="MaintenanceWindowStartTime" Type="Edm.DateTimeOffset" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The start time of a maintenance window."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain 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."/>
        </Property>
        <Property Name="MaintenanceWindowDurationInSeconds" Type="Edm.Int64" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The expiry time of maintenance window in seconds."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain 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."/>
          <Annotation Term="Validation.Minimum" Int="0"/>
          <Annotation Term="Measures.Unit" String="s"/>
        </Property>
        <NavigationProperty Name="MaintenanceWindowResource" Type="Resource.ItemOrCollection" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The location of the maintenance window settings."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a Resource that contains the @Redfish.MaintenanceWindow property that governs this Resource.  This property shall be required if the SupportedValues property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset."/>
        </NavigationProperty>
      </ComplexType>

      <ComplexType Name="MaintenanceWindow" BaseType="Settings.MaintenanceWindow">
        <Annotation Term="OData.Description" String="The maintenance window assignment for applying settings or operations to a Resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall indicate that a Resource has a maintenance window assignment for applying settings or operations.  Other Resources may link to this object to convey a common control surface for the configuration of the maintenance window."/>
        <Property Name="MaintenanceWindowStartTime" Type="Edm.DateTimeOffset" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The start time of a maintenance window."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the date and time when the service can start to apply the requested settings or operation as part of a maintenance window."/>
          <Annotation Term="Redfish.Required"/>
        </Property>
        <Property Name="MaintenanceWindowDurationInSeconds" Type="Edm.Int64" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The expiry time of maintenance window in seconds."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property."/>
          <Annotation Term="Validation.Minimum" Int="0"/>
          <Annotation Term="Measures.Unit" String="s"/>
          <Annotation Term="Redfish.Required"/>
        </Property>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_2_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <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."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_2_0.Settings"/>
      <ComplexType Name="PreferredApplyTime" BaseType="Settings.v1_2_0.PreferredApplyTime"/>
      <ComplexType Name="OperationApplyTimeSupport" BaseType="Settings.v1_2_0.OperationApplyTimeSupport"/>
      <ComplexType Name="MaintenanceWindow" BaseType="Settings.v1_2_0.MaintenanceWindow"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Settings.v1_2_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
      <ComplexType Name="Settings" BaseType="Settings.v1_2_1.Settings"/>
      <ComplexType Name="PreferredApplyTime" BaseType="Settings.v1_2_1.PreferredApplyTime"/>
      <ComplexType Name="OperationApplyTimeSupport" BaseType="Settings.v1_2_1.OperationApplyTimeSupport"/>
      <ComplexType Name="MaintenanceWindow" BaseType="Settings.v1_2_1.MaintenanceWindow"/>
    </Schema>

  </edmx:DataServices>
</edmx:Edmx>
OpenPOWER on IntegriCloud