{ "$id": "http://redfish.dmtf.org/schemas/v1/TaskService.v1_2_1.json", "$ref": "#/definitions/TaskService", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2024 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": "The available OEM-specific actions for this resource.", "longDescription": "This property shall contain the available OEM-specific 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 the available OEM-specific 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" }, "OverWritePolicy": { "enum": [ "Manual", "Oldest" ], "enumDescriptions": { "Manual": "Completed tasks are not automatically overwritten.", "Oldest": "Oldest completed tasks are overwritten." }, "type": "string" }, "TaskService": { "additionalProperties": false, "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.", "longDescription": "This resource contains a task service 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.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", "description": "The available actions for this resource.", "longDescription": "This property shall contain the available actions for this resource.", "versionAdded": "v1_1_0" }, "CompletedTaskOverWritePolicy": { "$ref": "#/definitions/OverWritePolicy", "description": "The overwrite policy for completed tasks. This property indicates if the task service overwrites completed task information.", "longDescription": "This property shall contain the overwrite policy for completed tasks. This property shall indicate if the task service overwrites completed task information.", "readonly": true }, "DateTime": { "description": "The current date and time, with UTC offset, setting that the task service uses.", "format": "date-time", "longDescription": "This property shall contain the current date and time for the task service, with UTC offset.", "readonly": true, "type": [ "string", "null" ] }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "LifeCycleEventOnTaskStateChange": { "description": "An indication of whether a task state change sends an event.", "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.", "readonly": true, "type": "boolean" }, "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": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "ServiceEnabled": { "description": "An indication of whether this service is enabled.", "longDescription": "This property shall indicate whether this service is enabled.", "readonly": false, "type": [ "boolean", "null" ] }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", "description": "The status and health of the resource and its subordinate or dependent resources.", "longDescription": "This property shall contain any status or health properties of the resource." }, "TaskAutoDeleteTimeoutMinutes": { "description": "The number of minutes after which a completed task is deleted by the service.", "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.", "minimum": 1, "readonly": false, "type": "integer", "versionAdded": "v1_2_0" }, "Tasks": { "$ref": "http://redfish.dmtf.org/schemas/v1/TaskCollection.json#/definitions/TaskCollection", "description": "The links to the collection of tasks.", "longDescription": "This property shall contain a link to a resource collection of type `TaskCollection`.", "readonly": true } }, "required": [ "@odata.id", "@odata.type", "Id", "Name" ], "type": "object" } }, "language": "en", "owningEntity": "DMTF", "release": "2021.1", "title": "#TaskService.v1_2_1.TaskService" }