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
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/Settings.v1_2_2.json",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"ApplyTime": {
"enum": [
"Immediate",
"OnReset",
"AtMaintenanceWindowStart",
"InMaintenanceWindowOnReset"
],
"enumDescriptions": {
"AtMaintenanceWindowStart": "Apply during a maintenance window as specified by an administrator.",
"Immediate": "Apply immediately.",
"InMaintenanceWindowOnReset": "Apply after a reset but within maintenance window as specified by an adminstrator.",
"OnReset": "Apply on a reset."
},
"enumLongDescriptions": {
"AtMaintenanceWindowStart": "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.",
"Immediate": "This value shall indicate the values within the Settings Resource are applied immediately.",
"InMaintenanceWindowOnReset": "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.",
"OnReset": "This value shall indicate the values within Settings Resource are applied when the system or service is reset."
},
"type": "string"
},
"MaintenanceWindow": {
"additionalProperties": false,
"description": "The maintenance window assignment for applying settings or operations to a Resource.",
"longDescription": "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.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"MaintenanceWindowDurationInSeconds": {
"description": "The expiry time of maintenance window in seconds.",
"longDescription": "This property shall indicate the end of the maintenance window as the number of seconds after the time specified by the MaintenanceWindowStartTime property.",
"minimum": 0,
"readonly": false,
"type": "integer",
"units": "s",
"versionAdded": "v1_2_0"
},
"MaintenanceWindowStartTime": {
"description": "The start time of a maintenance window.",
"format": "date-time",
"longDescription": "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.",
"readonly": false,
"type": "string",
"versionAdded": "v1_2_0"
}
},
"required": [
"MaintenanceWindowStartTime",
"MaintenanceWindowDurationInSeconds"
],
"type": "object"
},
"OperationApplyTimeSupport": {
"additionalProperties": false,
"description": "The client can request a specific apply time of a create, delete, or action operation of a Resource.",
"longDescription": "This type shall indicate that a client can request a specific apply time of a create, delete, or action operation of a Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"MaintenanceWindowDurationInSeconds": {
"description": "The expiry time of maintenance window in seconds.",
"longDescription": "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.",
"minimum": 0,
"readonly": true,
"type": "integer",
"units": "s",
"versionAdded": "v1_2_0"
},
"MaintenanceWindowResource": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef",
"description": "The location of the maintenance window settings.",
"longDescription": "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.",
"readonly": true,
"versionAdded": "v1_2_0"
},
"MaintenanceWindowStartTime": {
"description": "The start time of a maintenance window.",
"format": "date-time",
"longDescription": "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.",
"readonly": true,
"type": "string",
"versionAdded": "v1_2_0"
},
"SupportedValues": {
"description": "The types of apply times that the client can request when performing a create, delete, or action operation.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Settings.json#/definitions/OperationApplyTime"
},
"longDescription": "This property shall indicate the types of apply times the client can request when performing a create, delete, or action operation.",
"readonly": true,
"type": "array",
"versionAdded": "v1_2_0"
}
},
"required": [
"SupportedValues"
],
"type": "object"
},
"PreferredApplyTime": {
"additionalProperties": false,
"description": "The preferred time to apply configuration settings.",
"longDescription": "This type shall be specified by client to indicate the preferred time to apply the configuration settings.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"ApplyTime": {
"$ref": "#/definitions/ApplyTime",
"description": "The time when to apply the settings.",
"longDescription": "This property shall indicate when to apply the values in this Settings Resource.",
"readonly": false,
"versionAdded": "v1_1_0"
},
"MaintenanceWindowDurationInSeconds": {
"description": "The expiry time of maintenance window in seconds.",
"longDescription": "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`.",
"minimum": 0,
"readonly": false,
"type": "integer",
"units": "s",
"versionAdded": "v1_1_0"
},
"MaintenanceWindowStartTime": {
"description": "The start time of a maintenance window.",
"format": "date-time",
"longDescription": "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`.",
"readonly": false,
"type": "string",
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"Settings": {
"additionalProperties": false,
"description": "The Resource settings.",
"longDescription": "This type shall describe any settings of a Resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"ETag": {
"description": "The entity tag (ETag) of the Resource to which the settings were applied, after the application.",
"longDescription": "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.",
"readonly": true,
"type": [
"string",
"null"
]
},
"MaintenanceWindowResource": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef",
"description": "The location of the maintenance window settings.",
"longDescription": "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.",
"readonly": true,
"versionAdded": "v1_2_0"
},
"Messages": {
"description": "An array of messages associated with the settings.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message"
},
"longDescription": "This property shall contain an array of messages associated with the settings.",
"type": "array"
},
"SettingsObject": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef",
"description": "The link to the Resource that the client may PUT or PATCH to modify the Resource.",
"longDescription": "This property shall contain the URI of the Resource that the client may PUT or PATCH to modify the Resource.",
"readonly": true
},
"SupportedApplyTimes": {
"description": "The time when the settings can be applied.",
"items": {
"$ref": "#/definitions/ApplyTime"
},
"longDescription": "A service shall advertise its applytime capabilities by using this property to set the time when the settings can be applied.",
"readonly": true,
"type": "array",
"versionAdded": "v1_1_0"
},
"Time": {
"description": "The time when the settings were applied.",
"format": "date-time",
"longDescription": "This property shall indicate the time when the settings were applied to the Resource.",
"readonly": true,
"type": [
"string",
"null"
]
}
},
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2018.1",
"title": "#Settings.v1_2_2"
}
|
