stop_task
Stops the selected task.
Required User Role: See Required Enterprise Manager permissions.
Syntax
def stop_task(
self,
server,
task,
int timeout = 30
)
Parameters
Parameter | Type | Description |
---|---|---|
server | string | The name of the server. |
task |
string |
|
timeout |
int |
Time, in seconds, to wait until getting a response. |
Return values
AemStopTaskResp
Value | Type | Description |
---|---|---|
state |
AemTaskState { STOPPED = 0, RUNNING = 1, ERROR = 2, RECOVERY = 3 } |
The current state of the task. |
error_message | string | The description of the error. |
Errors
All of the general errors as well as the errors listed in the table below.
Error | Message | Description |
---|---|---|
AEM_TASK_ALREADY_STOPPED |
Replicate task {task} on server {server} is already stopped. |
Cannot stop a task that is in Stopped state. |
AEM_STOP_TASK_INNER_ERR |
Failed to stop Replicate task {0} on server {1}: <{2}> |
An error occurred while trying to stop the task. |
AEM_STOP_TASK_TIMEOUT |
A timeout occurred when trying to stop Replicate task {0} on server {1} |
A timeout occurred while trying to stop the task. |