1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/TaskService.v1_2_1.json", 3 "$ref": "#/definitions/TaskService", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2024 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 "Oem": { 27 "$ref": "#/definitions/OemActions", 28 "description": "The available OEM-specific actions for this resource.", 29 "longDescription": "This property shall contain the available OEM-specific actions for this resource.", 30 "versionAdded": "v1_1_0" 31 } 32 }, 33 "type": "object" 34 }, 35 "OemActions": { 36 "additionalProperties": true, 37 "description": "The available OEM-specific actions for this resource.", 38 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 39 "patternProperties": { 40 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 41 "description": "This property shall specify a valid odata or Redfish property.", 42 "type": [ 43 "array", 44 "boolean", 45 "integer", 46 "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, 69 "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.", 71 "patternProperties": { 72 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 73 "description": "This property shall specify a valid odata or Redfish property.", 74 "type": [ 75 "array", 76 "boolean", 77 "integer", 78 "number", 79 "null", 80 "object", 81 "string" 82 ] 83 } 84 }, 85 "properties": { 86 "@odata.context": { 87 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 88 }, 89 "@odata.etag": { 90 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 91 }, 92 "@odata.id": { 93 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 94 }, 95 "@odata.type": { 96 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 97 }, 98 "Actions": { 99 "$ref": "#/definitions/Actions", 100 "description": "The available actions for this resource.", 101 "longDescription": "This property shall contain the available actions for this resource.", 102 "versionAdded": "v1_1_0" 103 }, 104 "CompletedTaskOverWritePolicy": { 105 "$ref": "#/definitions/OverWritePolicy", 106 "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.", 108 "readonly": true 109 }, 110 "DateTime": { 111 "description": "The current date and time, with UTC offset, setting that the task service uses.", 112 "format": "date-time", 113 "longDescription": "This property shall contain the current date and time for the task service, with UTC offset.", 114 "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": { 136 "description": "An indication of whether a task state change sends an event.", 137 "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.", 138 "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", 147 "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." 149 }, 150 "ServiceEnabled": { 151 "description": "An indication of whether this service is enabled.", 152 "longDescription": "This property shall indicate whether this service is enabled.", 153 "readonly": false, 154 "type": [ 155 "boolean", 156 "null" 157 ] 158 }, 159 "Status": { 160 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 161 "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." 163 }, 164 "TaskAutoDeleteTimeoutMinutes": { 165 "description": "The number of minutes after which a completed task is deleted by the service.", 166 "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.", 167 "minimum": 1, 168 "readonly": false, 169 "type": "integer", 170 "versionAdded": "v1_2_0" 171 }, 172 "Tasks": { 173 "$ref": "http://redfish.dmtf.org/schemas/v1/TaskCollection.json#/definitions/TaskCollection", 174 "description": "The links to the collection of tasks.", 175 "longDescription": "This property shall contain a link to a resource collection of type `TaskCollection`.", 176 "readonly": true 177 } 178 }, 179 "required": [ 180 "@odata.id", 181 "@odata.type", 182 "Id", 183 "Name" 184 ], 185 "type": "object" 186 } 187 }, 188 "language": "en", 189 "owningEntity": "DMTF", 190 "release": "2021.1", 191 "title": "#TaskService.v1_2_1.TaskService" 192}