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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/Task.v1_4_0.json",
"$ref": "#/definitions/Task",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this resource.",
"longDescription": "This type shall contain the available actions for this 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": {
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "This property contains the available OEM specific actions for this resource.",
"longDescription": "This property shall contain any additional OEM actions for this resource.",
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM specific actions for this resource.",
"longDescription": "This type shall contain any additional OEM actions for this 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": {},
"type": "object"
},
"Payload": {
"additionalProperties": false,
"description": "The HTTP and JSON payload details for this Task.",
"longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this Task.",
"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": {
"HttpHeaders": {
"description": "This represents the HTTP headers used in the operation of this Task.",
"items": {
"type": "string"
},
"longDescription": "The value of this property shall be an array of HTTP headers used in the execution of this Task.",
"readonly": true,
"type": "array",
"versionAdded": "v1_3_0"
},
"HttpOperation": {
"description": "The HTTP operation to perform to execute this Task.",
"longDescription": "This property shall contain the HTTP operation to execute for this Task.",
"readonly": true,
"type": "string",
"versionAdded": "v1_3_0"
},
"JsonBody": {
"description": "This property contains the JSON payload to use in the execution of this Task.",
"longDescription": "The value of this property shall be JSON formatted payload used for this Task.",
"readonly": true,
"type": "string",
"versionAdded": "v1_3_0"
},
"TargetUri": {
"description": "The URI of the target for this task.",
"format": "uri",
"longDescription": "This property shall contain a URI referencing a location to be used as the target for an HTTP operation.",
"readonly": true,
"type": "string",
"versionAdded": "v1_3_0"
}
},
"type": "object"
},
"Task": {
"additionalProperties": false,
"description": "This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task Service.",
"longDescription": "This resource shall be used to represent a task for a Redfish implementation.",
"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": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "The Actions property shall contain the available actions for this resource.",
"versionAdded": "v1_1_0"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"EndTime": {
"description": "The date-time stamp that the task was last completed.",
"format": "date-time",
"longDescription": "The value of this property shall indicate the time the task was completed.",
"readonly": true,
"type": "string"
},
"HidePayload": {
"description": "Indicates that the contents of the Payload should be hidden from view after the Task has been created. When set to True, the Payload object will not be returned on GET.",
"longDescription": "This property shall be set to True if the Payload object shall not be returned on GET operations, and set to False if the contents can be returned normally. If this property is not specified when the Task is created, the default value shall be False.",
"readonly": true,
"type": "boolean",
"versionAdded": "v1_3_0"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Messages": {
"description": "This is an array of messages associated with the task.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Message.json#/definitions/Message"
},
"longDescription": "The value of this property shall be an array of messages associated with the task.",
"type": "array"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
},
"Payload": {
"$ref": "#/definitions/Payload",
"description": "The HTTP and JSON payload details for this task.",
"longDescription": "This object shall contain information detailing the HTTP and JSON payload information for executing this task. This object shall not be included in the response if the HidePayload property is set to True.",
"versionAdded": "v1_3_0"
},
"PercentComplete": {
"description": "The completion percentage of this Task.",
"longDescription": "The value of this property shall indicate the completion progress of the task, reported in percent of completion. If the task has not been started, the value shall be zero.",
"readonly": true,
"type": [
"integer",
"null"
],
"units": "%",
"versionAdded": "v1_4_0"
},
"StartTime": {
"description": "The date-time stamp that the task was last started.",
"format": "date-time",
"longDescription": "The value of this property shall indicate the time the task was started.",
"readonly": true,
"type": "string"
},
"TaskMonitor": {
"description": "The URI of the Task Monitor for this task.",
"format": "uri",
"longDescription": "This property shall contain a URI to Task Monitor as defined in the Redfish Specification.",
"readonly": true,
"type": "string",
"versionAdded": "v1_2_0"
},
"TaskState": {
"$ref": "#/definitions/TaskState",
"description": "The state of the task.",
"longDescription": "The value of this property shall indicate the state of the task. New shall be used to indicate that the task is a new task which has just been instantiated and is in the initial state and indicates it has never been started. Starting shall be used to indicate that the task is moving from the New, Suspended, or Service states into the Running state. Running shall be used to indicate that the Task is running. Suspended shall be used to indicate that the Task is stopped (e.g., by a user), but can be restarted in a seamless manner. Interrupted shall be used to indicate that the Task was interrupted (e.g., by a server crash) in the middle of processing, and the user should either re-run/restart the Task. Pending shall be used to indicate that the Task has been queued and will be scheduled for processing as soon as resources are available to handle the request. Stopping shall be used to indicate that the Task is in the process of moving to a Completed, Killed, or Exception state. Completed shall be used to indicate that the task has completed normally. Killed shall be used to indicate that the task has been stopped by a Kill state change request (non-graceful shutdown). Exception shall be used to indicate that the Task is in an abnormal state that might be indicative of an error condition. Service shall be used to indicate that the Task is in a state that supports problem discovery, or resolution, or both. This state is used when a corrective action is possible.",
"readonly": true
},
"TaskStatus": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health",
"description": "This is the completion status of the task.",
"longDescription": "The value of this property shall be the completion status of the task, as defined in the Status section of the Redfish specification and shall not be set until the task has completed.",
"readonly": true
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"TaskState": {
"enum": [
"New",
"Starting",
"Running",
"Suspended",
"Interrupted",
"Pending",
"Stopping",
"Completed",
"Killed",
"Exception",
"Service",
"Cancelling",
"Cancelled"
],
"enumDeprecated": {
"Killed": "This value has been deprecated and is being replaced by the value Cancelled which has more determinate semantics."
},
"enumDescriptions": {
"Cancelled": "Task has been cancelled by an operator or internal process.",
"Cancelling": "Task is in the process of being cancelled.",
"Completed": "Task has completed.",
"Exception": "Task has stopped due to an exception condition.",
"Interrupted": "Task has been interrupted.",
"Killed": "Task was terminated.",
"New": "A new task.",
"Pending": "Task is pending and has not started.",
"Running": "Task is running normally.",
"Service": "Task is running as a service.",
"Starting": "Task is starting.",
"Stopping": "Task is in the process of stopping.",
"Suspended": "Task has been suspended."
},
"enumLongDescriptions": {
"Cancelled": "This value shall represent that the operation was cancelled either through a Delete on a Task Monitor or Task Resource or by an internal process.",
"Cancelling": "This value shall represent that the operation is in the process of being cancelled.",
"Completed": "This value shall represent that the operation is complete and completed sucessfully or with warnings.",
"Exception": "This value shall represent that the operation is complete and completed with errors.",
"Interrupted": "This value shall represent that the operation has been interrupted but is expected to restart and is therefore not complete.",
"Killed": "This value shall represent that the operation is complete because the task was killed by an operator.",
"New": "This value shall represent that this task is newly created but the operation has not yet started.",
"Pending": "This value shall represent that the operation is pending some condition and has not yet begun to execute.",
"Running": "This value shall represent that the operation is executing.",
"Service": "This value shall represent that the operation is now running as a service and expected to continue operation until stopped or killed.",
"Starting": "This value shall represent that the operation is starting.",
"Stopping": "This value shall represent that the operation is stopping but is not yet complete.",
"Suspended": "This value shall represent that the operation has been suspended but is expected to restart and is therefore not complete."
},
"enumVersionAdded": {
"Cancelled": "v1_2_0",
"Cancelling": "v1_2_0"
},
"enumVersionDeprecated": {
"Killed": "v1_2_0"
},
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2018.3",
"title": "#Task.v1_4_0.Task"
}
|
