Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
Recurring Task Chains are sets of one or more recurring tasks that will automatically be invoked on a regular basis according to a defined schedule.
Only a single instance of this Recurring Task Chain will be scheduled at any given time. All instances of tasks within the chain will be scheduled at the same time, with all instances having the same scheduled start time and each subsequent task instance dependent upon the previous so that it will not be eligible to start running until the previous instance has completed. When scheduling a recurring task chain, it will be scheduled for the first date and time that meets the scheduling criteria and is greater than or equal to the current time, and is also greater than the time that the last instance of the Recurring Task Chain was scheduled to start.
↓Relations from This Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from Recurring Task Chains:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ recurring-task | |
| ↓ scheduled-month | |
| ↓ scheduled-date-selection-type | |
| ↓ scheduled-day-of-the-week | |
| ↓ scheduled-day-of-the-month | |
| ↓ scheduled-time-of-day | |
| ↓ time-zone | |
| ↓ interrupted-by-shutdown-behavior | |
| ↓ server-offline-at-start-time-behavior |
| Description | A description for this Recurring Task Chain |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this Recurring Task Chain is enabled for use. Recurring Task Chains that are disabled will not have any new instances scheduled, but instances that are already scheduled will be preserved. Those instances may be manually canceled if desired. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of recurring tasks that make up this chain. At least one value must be provided. If multiple values are given, then the task instances will be invoked in the order in which they are listed. |
| Default Value | None |
| Allowed Values | The DN of any Recurring Task. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The months of the year in which instances of this Recurring Task Chain may be scheduled to start. |
| Default Value | january february march april may june july august september october november december |
| Allowed Values | january - Instances of the Recurring Task Chain may be scheduled to start on days in January. february - Instances of the Recurring Task Chain may be scheduled to start on days in February. march - Instances of the Recurring Task Chain may be scheduled to start on days in March. april - Instances of the Recurring Task Chain may be scheduled to start on days in April. may - Instances of the Recurring Task Chain may be scheduled to start on days in May. june - Instances of the Recurring Task Chain may be scheduled to start on days in June. july - Instances of the Recurring Task Chain may be scheduled to start on days in July. august - Instances of the Recurring Task Chain may be scheduled to start on days in August. september - Instances of the Recurring Task Chain may be scheduled to start on days in September. october - Instances of the Recurring Task Chain may be scheduled to start on days in October. november - Instances of the Recurring Task Chain may be scheduled to start on days in November. december - Instances of the Recurring Task Chain may be scheduled to start on days in December. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The mechanism used to determine the dates on which instances of this Recurring Task Chain may be scheduled to start. |
| Default Value | None |
| Allowed Values | every-day - Instances of the Recurring Task Chain may be scheduled to start on every day of the selected months. selected-days-of-the-week - Instances of the Recurring Task Chain may be scheduled to start on a specified set of days of the week. If this option is selected, then the scheduled-day-of-the-week property must be given one or more values to specify the desired days of the week. selected-days-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on specific days of the month. If this option is selected, then the scheduled-day-of-the-month property must be given one or more values to specify the desired days of the month. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The specific days of the week on which instances of this Recurring Task Chain may be scheduled to start. If the scheduled-day-selection-type property has a value of selected-days-of-the-week, then this property must have one or more values; otherwise, it must be left undefined. |
| Default Value | None |
| Allowed Values | every-sunday - Instances of the Recurring Task Chain may be scheduled to start on every Sunday of the month. every-monday - Instances of the Recurring Task Chain may be scheduled to start on every Monday of the month. every-tuesday - Instances of the Recurring Task Chain may be scheduled to start on every Tuesday of the month. every-wednesday - Instances of the Recurring Task Chain may be scheduled to start on every Wednesday of the month. every-thursday - Instances of the Recurring Task Chain may be scheduled to start on every Thursday of the month. every-friday - Instances of the Recurring Task Chain may be scheduled to start on every Friday of the month. every-saturday - Instances of the Recurring Task Chain may be scheduled to start on every Saturday of the month. first-sunday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the first Sunday of the month. first-monday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the first Monday of the month. first-tuesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the first Tuesday of the month. first-wednesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the first Wednesday of the month. first-thursday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the first Thursday of the month. first-friday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the first Friday of the month. first-saturday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the first Saturday of the month. second-sunday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the second Sunday of the month. second-monday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the second Monday of the month. second-tuesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the second Tuesday of the month. second-wednesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the second Wednesday of the month. second-thursday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the second Thursday of the month. second-friday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the second Friday of the month. second-saturday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the second Saturday of the month. third-sunday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the third Sunday of the month. third-monday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the third Monday of the month. third-tuesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the third Tuesday of the month. third-wednesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the third Wednesday of the month. third-thursday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the third Thursday of the month. third-friday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the third Friday of the month. third-saturday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the third Saturday of the month. fourth-sunday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fourth Sunday of the month. fourth-monday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fourth Monday of the month. fourth-tuesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fourth Tuesday of the month. fourth-wednesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fourth Wednesday of the month. fourth-thursday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fourth Thursday of the month. fourth-friday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fourth Friday of the month. fourth-saturday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fourth Saturday of the month. fifth-sunday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fifth Sunday of the month. This value will be ignored in months with fewer than five Sundays. fifth-monday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fifth Monday of the month. This value will be ignored in months with fewer than five Mondays. fifth-tuesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fifth Tuesday of the month. This value will be ignored in months with fewer than five Tuesdays. fifth-wednesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fifth Wednesday of the month. This value will be ignored in months with fewer than five Wednesdays. fifth-thursday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fifth Thursday of the month. This value will be ignored in months with fewer than five Thursdays. fifth-friday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fifth Friday of the month. This value will be ignored in months with fewer than five Fridays. fifth-saturday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the fifth Saturday of the month. This value will be ignored in months with fewer than five Saturdays. last-sunday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last Sunday of the month. last-monday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last Monday of the month. last-tuesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last Tuesday of the month. last-wednesday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last Wednesday of the month. last-thursday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last Thursday of the month. last-friday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last Friday of the month. last-saturday-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last Saturday of the month. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The specific days of the month on which instances of this Recurring Task Chain may be scheduled to start. If the scheduled-day-selection-type property has a value of selected-days-of-the-month, then this property must have one or more values; otherwise, it must be left undefined. |
| Default Value | None |
| Allowed Values | day-01 - Instances of the Recurring Task Chain may be scheduled to start on the first day of the month. day-02 - Instances of the Recurring Task Chain may be scheduled to start on the second day of the month. day-03 - Instances of the Recurring Task Chain may be scheduled to start on the third day of the month. day-04 - Instances of the Recurring Task Chain may be scheduled to start on the fourth day of the month. day-05 - Instances of the Recurring Task Chain may be scheduled to start on the fifth day of the month. day-06 - Instances of the Recurring Task Chain may be scheduled to start on the sixth day of the month. day-07 - Instances of the Recurring Task Chain may be scheduled to start on the seventh day of the month. day-08 - Instances of the Recurring Task Chain may be scheduled to start on the eighth day of the month. day-09 - Instances of the Recurring Task Chain may be scheduled to start on the ninth day of the month. day-10 - Instances of the Recurring Task Chain may be scheduled to start on the tenth day of the month. day-11 - Instances of the Recurring Task Chain may be scheduled to start on the eleventh day of the month. day-12 - Instances of the Recurring Task Chain may be scheduled to start on the twelfth day of the month. day-13 - Instances of the Recurring Task Chain may be scheduled to start on the thirteenth day of the month. day-14 - Instances of the Recurring Task Chain may be scheduled to start on the fourteenth day of the month. day-15 - Instances of the Recurring Task Chain may be scheduled to start on the fifteenth day of the month. day-16 - Instances of the Recurring Task Chain may be scheduled to start on the sixteenth day of the month. day-17 - Instances of the Recurring Task Chain may be scheduled to start on the seventeenth day of the month. day-18 - Instances of the Recurring Task Chain may be scheduled to start on the eighteenth day of the month. day-19 - Instances of the Recurring Task Chain may be scheduled to start on the nineteenth day of the month. day-20 - Instances of the Recurring Task Chain may be scheduled to start on the twentieth day of the month. day-21 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-first day of the month. day-22 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-second day of the month. day-23 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-third day of the month. day-24 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-fourth day of the month. day-25 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-fifth day of the month. day-26 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-sixth day of the month. day-27 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-seventh day of the month. day-28 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-eighth day of the month. day-29 - Instances of the Recurring Task Chain may be scheduled to start on the twenty-ninth day of the month. This value will be ignored in months with fewer than twenty-nine days. day-30 - Instances of the Recurring Task Chain may be scheduled to start on the thirtieth day of the month. This value will be ignored in months with fewer than thirty days. day-31 - Instances of the Recurring Task Chain may be scheduled to start on the thirty-first day of the month. This value will be ignored in months with fewer than thirty-one days. next-to-last-day-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the next-to-last day of the month. For example, in a month with thirty days, this will be interpreted as the twenty-ninth day of that month. last-day-of-the-month - Instances of the Recurring Task Chain may be scheduled to start on the last day of the month. For example, in a month with thirty days, this will be interpreted as the thirtieth day of the month. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The time of day at which instances of the Recurring Task Chain should be eligible to start running. Values should be in the format HH:MM (where HH is a two-digit representation of the hour of the day, between 00 and 23, inclusive), and MM is a two-digit representation of the minute of the hour (between 00 and 59, inclusive). Alternately, the value can be in the form *:MM, which indicates that the task should be eligible to start at the specified minute of every hour. At least one value must be provided, but multiple values may be given to indicate multiple start times within the same day. If the configured time zone is one in which daylight saving time is observed, then start time values may be adjusted if they fall within a time span affected by the transition to or from daylight saving time. An adjustment will only be made if a scheduled start time uses the two-digit hour syntax (not if it uses an asterisk to indicate that it should be scheduled for the specified minute of every hour), and only if the time is affected by the daylight saving time transition. For example, if the time "springs forward" so that 01:59 is immediately followed by 03:00, then an adjustment will be needed for any time between 02:00 and 02:59. In that case, the adjustment will be to add one hour to the scheduled start time for that one instance (e.g., a task scheduled for 02:30 will be adjusted to 03:30). Alternately, if the time "falls back" so that 01:59 is immediately followed by 01:00, then an adjustment will be needed to ensure that only one instance is scheduled (e.g., a task scheduled for 01:30 will only be invoked for the first 01:30 and not for the second). Note that daylight saving time adjustments primarily apply to time of day values in which an hour is explicitly specified. Time of day values that use an asterisk as a wildcard in the hour component, indicating that they apply to every hour, will be considered for every hour of the day. For example, in a "spring forward" case in which the time jumps from 01:59 to 03:00, there will not be any attempt to consider values in the "missing" hour between 02:00 and 02:59, and in a "fall back" case in which the time jumps back from 01:59 to 01:00, each minute between 01:00 and 01:59 will occur twice, and both instances of each minute will be considered. |
| Default Value | None |
| Allowed Values | A value that specifies the time(s) of the day at which instances of this Recurring Task Chain may be scheduled. The value may be in either the "HH:MM" format or the "*:MM" format.
In the "HH:MM" format, "HH" represents a two-digit hour whose value may be between 00 and 23, inclusive, and "MM" represents a two-digit minute whose value may be between 00 and 59, inclusive. This format is used to specify a specific hour and minute at which instances of the Recurring Task Chain may be scheduled.
In the "*:MM" format, the "*" represents a wildcard that matches every hour of the day, and "MM" represents a two-digit minute whose values may be between 00 and 59, inclusive. This format can be used to indicate that the task may be scheduled at the specified minute in any hour of the day. Assuming that the task takes less than one hour to complete, it should start every hour at the specified minute. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The time zone that will be used to interpret the scheduled-time-of-day values. If no value is provided, then the JVM's default time zone will be used. The value can be any string that is supported by the java.util.TimeZone.getTimeZone(String) method (for example, "GMT", "America/Chicago", "Europe/London", or "Asia/Tokyo"), or it can be an offset from GMT that consists of a plus or minus sign followed by two digits that specify the number of hours (for example -05), and optionally two more digits that specify the number of minutes (for example, -0500). If specified as an offset, that offset must fall between -17:59 and +17:59. |
| Default Value | The JVM's default time zone will be used. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
interrupted-by-shutdown-behavior
| Description | Specifies the behavior that the server should exhibit if it is shut down or abnormally terminated while an instance of this Recurring Task Chain is running. |
| Default Value | cancel-only-interrupted-task-but-preserve-dependencies |
| Allowed Values | cancel-interrupted-task-and-dependencies - If an instance of this Recurring Task Chain is running when the server begins the shutdown process (or when the server is abnormally terminated), then that task instance should be canceled, along with the instances of any tasks that follow it in the chain. The server will then schedule the next iteration of this Recurring Task Chain for the next appropriate time after the server is restarted. cancel-only-interrupted-task-but-preserve-dependencies - If an instance of this Recurring Task Chain is running when the server begins the shutdown process (or when the server is abnormally terminated), then the instance of the task that was running will be canceled, but any instances of the tasks that follow it in the chain will be preserved so that they are eligible to start as soon as the server is restarted. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
server-offline-at-start-time-behavior
| Description | Specifies the behavior that the server should exhibit if it is offline when the start time arrives for the tasks in this Recurring Task Chain. Note that this only applies if none of the tasks in the chain had already been started before the server was shut down (or was abnormally terminated). If any tasks in the chain had already started, then the behavior will instead be governed by the interrupted-by-shutdown-behavior configuration property. |
| Default Value | cancel-iteration-and-wait-for-next-scheduled-start-time |
| Allowed Values | run-immediately-upon-server-startup - Existing instances of this Recurring Task Chain should be preserved so that they are eligible to start immediately as soon as the server is started. cancel-iteration-and-wait-for-next-scheduled-start-time - Existing instances of this Recurring Task Chain should be canceled, and a new instance of the chain should be scheduled for the earliest time in the future that matches the schedule criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Recurring Task Chains:
dsconfig list-recurring-task-chains
[--property {propertyName}] ...
To view the configuration for an existing Recurring Task Chain:
dsconfig get-recurring-task-chain-prop
--chain-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Recurring Task Chain:
dsconfig set-recurring-task-chain-prop
--chain-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Recurring Task Chain:
dsconfig create-recurring-task-chain
--chain-name {name}
--set recurring-task:{propertyValue}
--set scheduled-date-selection-type:{propertyValue}
--set scheduled-time-of-day:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Recurring Task Chain:
dsconfig delete-recurring-task-chain
--chain-name {name}