1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/TaskService.v1_3_0.json", 3 "$ref": "#/definitions/TaskService", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 6 "definitions": { 7 "Actions": { 8 "additionalProperties": false, 9 "description": "The available actions for this resource.", 10 "longDescription": "This type shall contain the available actions for this resource.", 11 "patternProperties": { 12 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 13 "description": "This property shall specify a valid odata or Redfish property.", 14 "type": [ 15 "array", 16 "boolean", 17 "integer", 18 "number", 19 "null", 20 "object", 21 "string" 22 ] 23 } 24 }, 25 "properties": { 26 "#TaskService.DeleteAllCompletedTasks": { 27 "$ref": "#/definitions/DeleteAllCompletedTasks" 28 }, 29 "Oem": { 30 "$ref": "#/definitions/OemActions", 31 "description": "The available OEM-specific actions for this resource.", 32 "longDescription": "This property shall contain the available OEM-specific actions for this resource.", 33 "versionAdded": "v1_1_0" 34 } 35 }, 36 "type": "object" 37 }, 38 "DeleteAllCompletedTasks": { 39 "additionalProperties": false, 40 "description": "Deletes all completed tasks.", 41 "longDescription": "This action shall delete all `Task` resources whose `TaskState` property contains `Completed`, `Killed`, `Cancelled`, or `Exception`.", 42 "parameters": {}, 43 "patternProperties": { 44 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 45 "description": "This property shall specify a valid odata or Redfish property.", 46 "type": [ 47 "array", 48 "boolean", 49 "integer", 50 "number", 51 "null", 52 "object", 53 "string" 54 ] 55 } 56 }, 57 "properties": { 58 "target": { 59 "description": "Link to invoke action", 60 "format": "uri-reference", 61 "type": "string" 62 }, 63 "title": { 64 "description": "Friendly action name", 65 "type": "string" 66 } 67 }, 68 "type": "object", 69 "versionAdded": "v1_3_0" 70 }, 71 "OemActions": { 72 "additionalProperties": true, 73 "description": "The available OEM-specific actions for this resource.", 74 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 75 "patternProperties": { 76 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 77 "description": "This property shall specify a valid odata or Redfish property.", 78 "type": [ 79 "array", 80 "boolean", 81 "integer", 82 "number", 83 "null", 84 "object", 85 "string" 86 ] 87 } 88 }, 89 "properties": {}, 90 "type": "object" 91 }, 92 "OverWritePolicy": { 93 "enum": [ 94 "Manual", 95 "Oldest" 96 ], 97 "enumDescriptions": { 98 "Manual": "Completed tasks are not automatically overwritten.", 99 "Oldest": "Oldest completed tasks are overwritten." 100 }, 101 "type": "string" 102 }, 103 "TaskService": { 104 "additionalProperties": false, 105 "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.", 106 "longDescription": "This resource contains a task service for a Redfish implementation.", 107 "patternProperties": { 108 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 109 "description": "This property shall specify a valid odata or Redfish property.", 110 "type": [ 111 "array", 112 "boolean", 113 "integer", 114 "number", 115 "null", 116 "object", 117 "string" 118 ] 119 } 120 }, 121 "properties": { 122 "@odata.context": { 123 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 124 }, 125 "@odata.etag": { 126 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 127 }, 128 "@odata.id": { 129 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 130 }, 131 "@odata.type": { 132 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 133 }, 134 "Actions": { 135 "$ref": "#/definitions/Actions", 136 "description": "The available actions for this resource.", 137 "longDescription": "This property shall contain the available actions for this resource.", 138 "versionAdded": "v1_1_0" 139 }, 140 "CompletedTaskOverWritePolicy": { 141 "$ref": "#/definitions/OverWritePolicy", 142 "description": "The overwrite policy for completed tasks. This property indicates if the task service overwrites completed task information.", 143 "longDescription": "This property shall contain the overwrite policy for completed tasks. This property shall indicate if the task service overwrites completed task information.", 144 "readonly": true 145 }, 146 "DateTime": { 147 "description": "The current date and time, with UTC offset, setting that the task service uses.", 148 "format": "date-time", 149 "longDescription": "This property shall contain the current date and time for the task service, with UTC offset.", 150 "readonly": true, 151 "type": [ 152 "string", 153 "null" 154 ] 155 }, 156 "Description": { 157 "anyOf": [ 158 { 159 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 160 }, 161 { 162 "type": "null" 163 } 164 ], 165 "readonly": true 166 }, 167 "Id": { 168 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 169 "readonly": true 170 }, 171 "LifeCycleEventOnTaskStateChange": { 172 "description": "An indication of whether a task state change sends an event.", 173 "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.", 174 "readonly": true, 175 "type": "boolean" 176 }, 177 "Name": { 178 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 179 "readonly": true 180 }, 181 "Oem": { 182 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 183 "description": "The OEM extension property.", 184 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 185 }, 186 "ServiceEnabled": { 187 "description": "An indication of whether this service is enabled.", 188 "longDescription": "This property shall indicate whether this service is enabled.", 189 "readonly": false, 190 "type": [ 191 "boolean", 192 "null" 193 ] 194 }, 195 "Status": { 196 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 197 "description": "The status and health of the resource and its subordinate or dependent resources.", 198 "longDescription": "This property shall contain any status or health properties of the resource." 199 }, 200 "TaskAutoDeleteTimeoutMinutes": { 201 "description": "The number of minutes after which a completed task is deleted by the service.", 202 "longDescription": "This property shall contain the number of minutes after which a completed task, where `TaskState` contains the value `Completed`, `Killed`, `Cancelled`, or `Exception`, is deleted by the service.", 203 "minimum": 1, 204 "readonly": false, 205 "type": "integer", 206 "versionAdded": "v1_2_0" 207 }, 208 "TaskMonitorAutoExpirySeconds": { 209 "description": "The number of seconds after reading a task monitor for a completed task until the service deletes the task monitor.", 210 "longDescription": "This property shall contain the number of seconds after reading a task monitor for a completed task until the service deletes the task monitor. If the task is cancelled before it completes the task monitor shall be removed at that time.", 211 "minimum": 0, 212 "readonly": false, 213 "type": [ 214 "integer", 215 "null" 216 ], 217 "units": "s", 218 "versionAdded": "v1_3_0" 219 }, 220 "Tasks": { 221 "$ref": "http://redfish.dmtf.org/schemas/v1/TaskCollection.json#/definitions/TaskCollection", 222 "description": "The links to the collection of tasks.", 223 "longDescription": "This property shall contain a link to a resource collection of type `TaskCollection`.", 224 "readonly": true 225 } 226 }, 227 "required": [ 228 "@odata.id", 229 "@odata.type", 230 "Id", 231 "Name" 232 ], 233 "type": "object" 234 } 235 }, 236 "language": "en", 237 "owningEntity": "DMTF", 238 "release": "2025.4", 239 "title": "#TaskService.v1_3_0.TaskService" 240}