Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact support for assistance if you believe that you have a need to create or modify this type of object.
Backup Recurring Tasks can be used to perform regular backups of one or more backends.
↓Parent Component
↓Properties
↓dsconfig Usage
The Backup Recurring Task component inherits from the Recurring Task
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ cancel-on-task-dependency-failure | |
| ↓ email-on-start | |
| ↓ email-on-success | |
| ↓ email-on-failure | |
| ↓ alert-on-start | |
| ↓ alert-on-success | |
| ↓ alert-on-failure | |
| ↓ backup-directory | |
| ↓ included-backend-id | |
| ↓ excluded-backend-id | |
| ↓ compress | |
| ↓ encrypt | |
| ↓ encryption-settings-definition-id | |
| ↓ sign | |
| ↓ retain-previous-full-backup-count | |
| ↓ retain-previous-full-backup-age | |
| ↓ max-megabytes-per-second |
| Description | A description for this Recurring Task |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
cancel-on-task-dependency-failure
| Description | Indicates whether an instance of this Recurring Task should be canceled if the task immediately before it in the recurring task chain fails to complete successfully (including if it is canceled by an administrator before it starts or while it is running). If this is true, then the instance of this Recurring Task will also be considered a failure (with a state of "canceled before starting"), and if that instance is itself a dependency for any other Recurring Task instance, then that dependent task's cancel-on-task-dependency-failure property will be used to determine whether it should be canceled or preserved. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The email addresses to which a message should be sent whenever an instance of this Recurring Task starts running. If this option is used, then at least one smtp-server must be configured in the global configuration. |
| Default Value | No email message will be sent when instances of this Recurring Task start running. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The email addresses to which a message should be sent whenever an instance of this Recurring Task completes successfully. If this option is used, then at least one smtp-server must be configured in the global configuration. |
| Default Value | No email message will be sent when instances of this Recurring Task finish running. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The email addresses to which a message should be sent if an instance of this Recurring Task fails to complete successfully. If this option is used, then at least one smtp-server must be configured in the global configuration. |
| Default Value | No email message will be sent when instances of this Recurring Task fail to complete successfully. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the server should generate an administrative alert whenever an instance of this Recurring Task starts running. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the server should generate an administrative alert whenever an instance of this Recurring Task completes successfully. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the server should generate an administrative alert whenever an instance of this Recurring Task fails to complete successfully. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The directory in which backup files will be placed. When backing up a single backend, the backup files will be placed directly in this directory. When backing up multiple backends, the backup files for each backend will be placed in a subdirectory whose name is the corresponding backend ID. |
| Default Value | bak |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The backend IDs of any backends that should be included in the backup. If the included-backend-id property has one or more values, then only those backends will be included in the backup. The excluded-backend-id property must not have any values. If the excluded-backend-id property has one or more values, then all backends that are not listed and that do support backups will be included. The included-backend-id property must not have any values. If neither the included-backend-id property nor the excluded-backend-id property has any values, then all backends that support backups will be included. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The backend IDs of any backends that should be excluded from the backup. All backends that support backups and are not listed will be included. If the excluded-backend-id property has one or more values, then all backends that are not listed and that do support backups will be included. The included-backend-id property must not have any values. If the included-backend-id property has one or more values, then only those backends will be included in the backup. The excluded-backend-id property must not have any values. If neither the included-backend-id property nor the excluded-backend-id property has any values, then all backends that support backups will be included. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether to compress the data as it is written into the backup. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether to encrypt the data as it is written into the backup. If this property is left undefined, then the encrypt-backups-by-default global configuration property will be used to determine whether to encrypt the backup. |
| Default Value | The encrypt-backups-by-default global configuration property will be used to determine whether to encrypt the backup. |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
encryption-settings-definition-id
| Description | The ID of an encryption settings definition to use to obtain the backup encryption key. If an encryption settings definition ID is configured, then it must refer to a definition that exists in the server's encryption settings database. The encryption-passphrase-file property must not be set. If neither the encryption-passphrase-file property nor the encryption-settings-definition-id property has a value, then the server will determine which encryption key to use. If the backup-encryption-settings-definition-id global configuration property is set, then that definition will be used to obtain the encryption key. Otherwise, if there is a preferred encryption settings definition, then that definition will be used to obtain the encryption key. And as a last resort, the server will use an internal key shared by servers within the replication topology. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether to cryptographically sign backups, which will make it possible to detect whether the backup has been altered since it was created. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
retain-previous-full-backup-count
| Description | The minimum number of previous full backups that should be preserved after a new backup completes successfully. If both the retain-previous-full-backup-count and the retain-previous-full-backup-age properties have a value, then only full backups that are outside the criteria for both properties will be candidates for removal. If only one of those properties has a value, then only the criteria associated with that property will be used to determine which previous backups may be removed. At least one of these properties must have a value. Only full backups will be examined when determining which backups may be removed. However, when a full backup is to be removed, all incremental backups that depend on that full backup will also be removed. |
| Default Value | If a retain-previous-full-backup-age value is configured, then only that property will be used to determine which backups to retain, and any backups older than that may be removed. |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
retain-previous-full-backup-age
| Description | The minimum age of previous full backups that should be preserved after a new backup completes successfully. Values for this property should use the duration syntax, which consists of an integer value followed by a time unit (for example, "1w" for one week, "5d" for five days, or "12h" for twelve hours). If both the retain-previous-full-backup-count and the retain-previous-full-backup-age properties have a value, then only full backups that are outside the criteria for both properties will be candidates for removal. If only one of those properties has a value, then only the criteria associated with that property will be used to determine which previous backups may be removed. At least one of these properties must have a value. Only full backups will be examined when determining which backups may be removed. However, when a full backup is to be removed, all incremental backups that depend on that full backup will also be removed. |
| Default Value | If a retain-previous-full-backup-count value is configured, then only that number of the most recent full backups (and their associated incremental backups) will be retained, and any additional older backups will be removed. |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The maximum rate, in megabytes per second, at which backups should be written. This can be useful on systems in which increased disk I/O may have a significant impact on performance. This particularly includes instances in which the database is too large to fully cache in memory and operations regularly incur disk I/O, but it may be useful in other scenarios as well. If rate limiting is to be used, then the value must be between 1 and 2047, inclusive. |
| Default Value | No rate limiting will be imposed for backups. |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 2047 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Recurring Tasks:
dsconfig list-recurring-tasks
[--property {propertyName}] ...
To view the configuration for an existing Recurring Task:
dsconfig get-recurring-task-prop
--task-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Recurring Task:
dsconfig set-recurring-task-prop
--task-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Backup Recurring Task:
dsconfig create-recurring-task
--task-name {name}
--type backup
[--set {propertyName}:{propertyValue}] ...
To delete an existing Recurring Task:
dsconfig delete-recurring-task
--task-name {name}