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.
LDIF Export Recurring Tasks can be used to perform regular LDIF exports of a specified backend.
↓Parent Component
↓Properties
↓dsconfig Usage
The LDIF Export 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 | |
| ↓ ldif-directory | |
| ↓ backend-id | |
| ↓ exclude-backend-id | |
| ↓ compress | |
| ↓ encrypt | |
| ↓ encryption-settings-definition-id | |
| ↓ sign | |
| ↓ retain-previous-ldif-export-count | |
| ↓ retain-previous-ldif-export-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 LDIF export files will be placed. The directory must already exist. The exported LDIF files will be named with the pattern {backendID}-{timestamp}.ldif[.gz][.encrypted], where {backendID} is the backend ID for the backend being exported and {timestamp} is a generalized time representation of the time that the LDIF export was started. If the LDIF export is gzip-compressed, then the filename will include a ".gz" extension, and if the file is encrypted, then the filename will include a ".encrypted" extension (and it may have an extension of ".gz.encrypted" if it is both compressed and encrypted). |
| Default Value | ldif |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The backend ID for a backend to be exported. If any backend IDs are specified, then only those backends will be exported. If multiple backend IDs are specified, then all of the LDIF exports will be placed in the same LDIF directory, and the configured retention processing will be applied separately for each backend (for example, if a retain-previous-ldif-export-count value of 5 is specified, then the five most recent previous exports will be retained for each of the backends to be exported). The backend-id and exclude-backend-id properties are mutually exclusive and cannot both be provided. If neither is provided, then all non-private backends that support LDIF export will be selected for export. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The backend ID for a backend to be excluded from the export. If any exclude backend IDs are specified, then all backends that support LDIF export and are not listed in this property will be exported. If there are multiple remaining backends that support LDIF export, then all of the LDIF exports will be placed in the same LDIF directory, and the configured retention processing will be applied separately for each backend (for example, if a retain-previous-ldif-export-count value of 5 is specified, then the five most recent previous exports will be retained for each of the backends to be exported). The backend-id and exclude-backend-id properties are mutually exclusive and cannot both be provided. If neither is provided, then all non-private backends that support LDIF export will be selected for export. |
| 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 LDIF data as it is exported. If this property is left undefined, then the behavior will vary based on whether the LDIF file is to be encrypted. If the LDIF file is to be encrypted, then the automatically-compress-encrypted-ldif-exports property in the global configuration will be used to determine whether to compress the LDIF file. If the LDIF export is not to be encrypted, then it will also not be compressed. |
| Default Value | If the LDIF export is to be encrypted, then the automatically-compress-encrypted-ldif-exports property in the global configuration will be used to determine whether to compress the LDIF file. If the LDIF export is not to be encrypted, then it will also not be compressed. |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether to encrypt the LDIF data as it exported. If this property is left undefined, then the encrypt-ldif-exports-by-default global configuration property will be used to determine whether to encrypt the LDIF data. |
| Default Value | The encrypt-ldif-exports-by-default global configuration property will be used to determine whether to encrypt the LDIF data. |
| 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 LDIF export 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 ldif-export-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 the exported data, which will make it possible to detect whether the LDIF data has been altered since it was exported. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
retain-previous-ldif-export-count
| Description | The minimum number of previous LDIF exports that should be preserved after a new export completes successfully. If both the retain-previous-ldif-export-count and the retain-previous-ldif-export-age properties have a value, then only LDIF exports 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 LDIF exports may be removed. At least one of these properties must have a value. |
| Default Value | If a retain-previous-ldif-export-age value is configured, then only that property will be used to determine which LDIF exports to retain, and any exports 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-ldif-export-age
| Description | The minimum age of previous LDIF exports that should be preserved after a new export 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-ldif-export-count and the retain-previous-ldif-export-age properties have a value, then only LDIF exports 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 exports may be removed. At least one of these properties must have a value. |
| Default Value | If a retain-previous-ldif-export-count value is configured, then only that number of the most recent LDIF exports will be retained, and any additional older exports 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 LDIF exports 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 LDIF exports. |
| 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 LDIF Export Recurring Task:
dsconfig create-recurring-task
--task-name {name}
--type ldif-export
[--set {propertyName}:{propertyValue}] ...
To delete an existing Recurring Task:
dsconfig delete-recurring-task
--task-name {name}