blob: 0bfac446f4fd4685c201f7ab1265c053e329cd6d [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Mills262d7d42021-01-20 16:28:41 -06002 "$id": "http://redfish.dmtf.org/schemas/v1/TaskService.v1_1_6.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/TaskService",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Gunnar Millsa778c022020-05-12 12:20:36 -05005 "copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07006 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -05009 "description": "The available actions for this resource.",
10 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070013 "description": "This property shall specify a valid odata or Redfish property.",
14 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080017 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070018 "number",
19 "null",
20 "object",
21 "string"
22 ]
23 }
24 },
25 "properties": {
26 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -080027 "$ref": "#/definitions/OemActions",
Gunnar Millsa778c022020-05-12 12:20:36 -050028 "description": "The available OEM-specific actions for this resource.",
29 "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -070030 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -070031 }
32 },
33 "type": "object"
34 },
35 "OemActions": {
36 "additionalProperties": true,
Gunnar Millsa778c022020-05-12 12:20:36 -050037 "description": "The available OEM-specific actions for this resource.",
38 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070039 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070040 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070041 "description": "This property shall specify a valid odata or Redfish property.",
42 "type": [
43 "array",
44 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080045 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070046 "number",
47 "null",
48 "object",
49 "string"
50 ]
51 }
52 },
53 "properties": {},
54 "type": "object"
55 },
56 "OverWritePolicy": {
57 "enum": [
58 "Manual",
59 "Oldest"
60 ],
61 "enumDescriptions": {
62 "Manual": "Completed tasks are not automatically overwritten.",
63 "Oldest": "Oldest completed tasks are overwritten."
64 },
65 "type": "string"
66 },
67 "TaskService": {
68 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -050069 "description": "The TaskService schema describes a task service that enables management of long-duration operations, includes the properties for the task service itself, and has links to the resource collection of tasks.",
70 "longDescription": "This resource contains a task service for a Redfish implementation.",
Ed Tanous118b1c72018-09-13 13:45:51 -070071 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070072 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070073 "description": "This property shall specify a valid odata or Redfish property.",
74 "type": [
75 "array",
76 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080077 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070078 "number",
79 "null",
80 "object",
81 "string"
82 ]
83 }
84 },
85 "properties": {
86 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -070087 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -080088 },
89 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -070090 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -070091 },
92 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -070093 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -070094 },
95 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -070096 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -070097 },
98 "Actions": {
99 "$ref": "#/definitions/Actions",
Gunnar Millsa778c022020-05-12 12:20:36 -0500100 "description": "The available actions for this resource.",
101 "longDescription": "This property shall contain the available actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -0700102 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700103 },
104 "CompletedTaskOverWritePolicy": {
105 "$ref": "#/definitions/OverWritePolicy",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600106 "description": "The overwrite policy for completed tasks. This property indicates if the task service overwrites completed task information.",
107 "longDescription": "This property shall contain the overwrite policy for completed tasks. This property shall indicate if the task service overwrites completed task information.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700108 "readonly": true
109 },
110 "DateTime": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500111 "description": "The current date and time, with UTC offset, setting that the task service uses.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700112 "format": "date-time",
Gunnar Millsa778c022020-05-12 12:20:36 -0500113 "longDescription": "This property shall contain the current date and time for the task service, with UTC offset.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700114 "readonly": true,
115 "type": [
116 "string",
117 "null"
118 ]
119 },
120 "Description": {
121 "anyOf": [
122 {
123 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
124 },
125 {
126 "type": "null"
127 }
128 ],
129 "readonly": true
130 },
131 "Id": {
132 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
133 "readonly": true
134 },
135 "LifeCycleEventOnTaskStateChange": {
Ed Tanouscb103132019-10-08 11:34:22 -0700136 "description": "An indication of whether a task state change sends an event.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500137 "longDescription": "This property shall indicate whether a task state change sends an event. Services should send an event containing a message defined in the Task Event Message Registry when the state of a task changes.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700138 "readonly": true,
139 "type": "boolean"
140 },
141 "Name": {
142 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
143 "readonly": true
144 },
145 "Oem": {
146 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700147 "description": "The OEM extension property.",
148 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700149 },
150 "ServiceEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -0700151 "description": "An indication of whether this service is enabled.",
152 "longDescription": "This property shall indicate whether this service is enabled.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700153 "readonly": false,
154 "type": [
155 "boolean",
156 "null"
157 ]
158 },
159 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800160 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Gunnar Millsa778c022020-05-12 12:20:36 -0500161 "description": "The status and health of the resource and its subordinate or dependent resources.",
162 "longDescription": "This property shall contain any status or health properties of the resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700163 },
164 "Tasks": {
165 "$ref": "http://redfish.dmtf.org/schemas/v1/TaskCollection.json#/definitions/TaskCollection",
Gunnar Millsa778c022020-05-12 12:20:36 -0500166 "description": "The links to the collection of tasks.",
167 "longDescription": "This property shall contain a link to a resource collection of type TaskCollection.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700168 "readonly": true
169 }
170 },
171 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800172 "@odata.id",
173 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700174 "Id",
175 "Name"
176 ],
177 "type": "object"
178 }
179 },
Ed Tanous530520e2019-01-02 13:41:37 -0800180 "owningEntity": "DMTF",
Ed Tanouscb103132019-10-08 11:34:22 -0700181 "release": "2017.1",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600182 "title": "#TaskService.v1_1_6.TaskService"
Ed Tanous118b1c72018-09-13 13:45:51 -0700183}