Queue Task

Command

QUEUETASK

Description

Queues tasks inline with replication data

Syntax

QueueTASK <job_name> TO <target> ONQueue = <task> [args] | ONTRANSmit = <task> [args] | ONRECeive = <task> [args] | ONEXECute = <task> [args] [TIMEOUT = <timeout>] [INTERACT | NOINTERACT]

Options

• job_name—Unique job name assigned to this task. This will be the identifier you see in the log files.
• target—Name of the target or an IP address on the target. The target is required even if you are only queuing a task to be executed on the source.
• ONQueue—Execute the specified task on the source machine as soon as the source receives and queues the task. During heavy replication, there may be a delay while the task is queued inline with the replication operations.
• ONTRANSmit—Execute the specified task on the source machine just before the source transmits the task to the target.
• ONRECeive—Execute the specified task on the target machine as soon as the target receives and queues the task.
• ONEXECute—Execute the specified task on the target when the target processes the task from the queue. Since the task is not executed until it is processed, if the target is paused, the task will be held in queue.
• task—The path and filename of the task to run relative to the machine it will be run on. Tasks include any valid executable or batch file. The executables or files must exist in the specified location on the machine where they will be executed
• args—Arguments or options which need to be supplied with the task. Multiple arguments can be supplied in a space-separated list enclosed in quotation marks.
• TIMEOUT timeout—Valid number followed by an optional time indicator indicating the length of time ot pause while waiting for the task to complete. The valid time indicators include seconds, minutes, hours, and days. If you do not specify a time indicator, it will default to seconds. The number zero (0) indicates there is no timeout delay and the next operation is immediately processed. The keyword FOREVER indicates that the next operation is not processed until the task has completed execution. If you do not specify this option, the timeout will default to forever.
• INTERACT—Tasks interact with the desktop and, therefore, display on screen and run in the foreground
• NOINTERACT—Tasks do not interact with the desktop

Examples

• queuetask backup to beta onreceive=PauseAndBackup.bat onexecute=Resume.bat
• qtask backup to beta onrec=PauseAndBackup.bat onexec=resume.bat

Notes

• The default setting for this command is nointeract.
• Any combination of one or more execution points can be used with the same queuetask command.
• All script processing messages, including errors, can be viewed in the Double-Take Availability log.
• Onqueue will still execute as soon as the task is placed on the queue even if transmission is stopped (manually stopped or paused, unmet scheduled transmission criteria, etc.). Any other option will not execute until transmission is restarted.
• If your source is in a restore required state, any task placed on the queue will be executed immediately. Use caution when submitting tasks while in this state so that the target does not get inadvertently updated.
• A task may be discarded if all connections to a target are manually disconnected, replication is stopped for all connections to a target, or an auto-disconnect occurs.
• If a task is submitted after replication is stopped, the task will be executed immediately.
• If you disable task command processing while tasks are in queue, those tasks will not be executed.
• The user submitting the task command must be a member of the Double-Take Admin security group on both the source and target and the Double-Take service must have proper privileges to access the files or run the commands specified in the task.
• Options, except for IP addresses, that contain non-alphanumeric characters must be enclosed in quotation marks.