Running task-based tools
The PingDirectory server has a Tasks subsystem that allows you to schedule basic operations, such as backup
, restore
, rotate-log
, schedule-exec-task
, stop-server
, and others. All task-based tools require the --task
option that explicitly indicates the tool is to run as a task rather than in offline mode.
The following table shows the options that you can use for task-based operations:
Option | Description |
---|---|
|
Indicates that the tool is invoked as a task. The |
|
Indicates the date and time, expressed in the format 'YYYYMMDDhhmmss', when the operation is to start. A value of '0' causes the task to be scheduled for immediate execution. After the scheduled run, the tool exits immediately. |
|
Specifies the ID of a task upon which this task depends. A task does not start execution until all its dependencies have completed execution. You can use this option multiple times in a single command. |
|
Specifies the action this task takes if one of its dependent tasks fail. Valid action values are:
|
|
Generates an administrative alert when the task starts running. |
|
Generates an administrative alert when the task fails to complete successfully. |
|
Generates an administrative alert when the task completes successfully. |
|
Specifies an email address to notify when the task starts running. You can use this option multiple times in a single command. |
|
Specifies an email address to notify when the task completes, regardless of whether it succeeded or failed. You can use this option multiple times in a single command. |
|
Specifies an email address to notify if an error occurs when this task executes. You can use this option multiple times in a single command. |
|
Specifies an email address to notify when this task completes successfully. You can use this option multiple times in a single command. |