--- title: Task Backend description: The Task Backend provides a mechanism for scheduling tasks in the PingDS directory server. Tasks are intended to provide access to certain types of administrative functions in the server that may not be convenient to perform remotely. component: pingds version: 8.1 page_id: pingds:configref:objects-task-backend canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-task-backend.html section_ids: parent: Parent task_backend_properties: Task Backend properties basic_properties: Basic properties backend-id: backend-id enabled: enabled notification-sender-address: notification-sender-address task-backing-file: task-backing-file task-retention-time: task-retention-time writability-mode: writability-mode advanced_properties: Advanced properties java-class: java-class --- # Task Backend The Task Backend provides a mechanism for scheduling tasks in the PingDS directory server. Tasks are intended to provide access to certain types of administrative functions in the server that may not be convenient to perform remotely. PingDS supports tasks to backup and restore backends, to import and export LDIF files, and to stop and restart the server. The details of a task are in an entry that is below the root of the Task Backend. The Task Backend is responsible for decoding that task entry and ensuring that it is processed as requested. Tasks may be invoked immediately, but they may also be scheduled for execution at some future time. The task backend can also process recurring tasks to ensure that maintenance operations (for example, backups) are performed automatically on a regular basis. ## Parent The Task Backend object inherits from [Local Backend](objects-local-backend.html). ## Task Backend properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [backend-id](#backend-id) [enabled](#enabled) [notification-sender-address](#notification-sender-address) [task-backing-file](#task-backing-file) [task-retention-time](#task-retention-time) [writability-mode](#writability-mode) | [java-class](#java-class) | ### Basic properties Use the `--advanced` option to access advanced properties. ### backend-id | | | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies a name to identify the associated backend. | | *Description* | The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server. | | *Default value* | None | | *Allowed values* | A string. | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | NoneNo base entry has been created as part of this process. A base entry needs to be created before adding further entries to the backend. Please refer to the documentation to create a base entry. | | *Advanced* | No | | *Read-only* | Yes | ### enabled | | | | ----------------------- | --------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates whether the backend is enabled in the server. | | *Description* | If a backend is not enabled, then its contents are not accessible when processing operations. | | *Default value* | None | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### notification-sender-address | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the email address to use as the sender (that is, the "From:" address) address for notification mail messages generated when a task completes execution. | | *Default value* | The default sender address used is "opendj-task-notification@" followed by the canonical address of the system on which the server is running. | | *Allowed values* | A string. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### task-backing-file | | | | ----------------------- | --------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the path to the backing file for storing information about the tasks configured in the server. | | *Description* | It may be either an absolute path or a relative path to the base of the PingDS directory server instance. | | *Default value* | None | | *Allowed values* | A path to an existing file that is readable (and/or writeable) by the server. | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### task-retention-time | | | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the length of time that task entries should be retained after processing on the associated task has been completed. | | *Default value* | 24 hours | | *Allowed values* | Uses [duration syntax](duration-syntax.html).Lower limit: 0 seconds. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### writability-mode | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the behavior that the backend should use when processing write operations. | | *Default value* | enabled | | *Allowed values* | * disabled: Causes all write attempts to fail. * enabled: Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled). * internal-only: Causes external write attempts to fail but allows writes by replication and internal operations. | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ## Advanced properties Use the `--advanced` option to access advanced properties. ### java-class | | | | ----------------------- | ---------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the fully-qualified name of the Java class that provides the backend implementation. | | *Default value* | org.opends.server.backends.task.TaskBackend | | *Allowed values* | A Java class that extends or implements:- org.opends.server.api.Backend | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | The object must be disabled and re-enabled for changes to take effect. | | *Advanced* | Yes | | *Read-only* | No |