API Doc
Search Docs...
⌘ K
OverviewDeploymentManagementOperationReferenceGlossary

Canceling CDP tasks

When you cancel a task, the current synchronization process stops.

Canceling a single CDP task

Procedure

Run the following command on any node in the cluster:

  • Cancel by the task ID:

    zbs-cdp job cancel <id> [options]
  • Cancel by the local volume ID:

    zbs-cdp job cancel_by_volume <volume_id> [options]

Parameter description

ParameterDescription
idThe task ID.
volume_idThe local volume ID.
--sync / --no-syncOptional. Specifies whether to wait synchronously until the task is canceled. Default: True.
-v / --version <VER>Optional. Specifies the CDP protocol version (v1 or v2).

Output example

  • Cancel by the task ID:

    zbs-cdp job cancel 1 -v v2
  • Cancel by the local volume ID:

    zbs-cdp job cancel_by_volume 1 -v v2

Output note

If the command succeeds, no output is displayed. If the execution fails, an error message will be displayed.

Batch canceling CDP tasks

Batch canceling CDP tasks means canceling all CDP tasks in a CDP task group.

Procedure

Run the following command on any node in the cluster:

zbs-cdp job cancel_by_group <group> [options]

Parameter description

ParameterDescription
groupThe CDP task group name.
--sync / --no-syncOptional. Specifies whether to wait synchronously until the task group is canceled. Default: True.
-v / --version <VER>Optional. Specifies the CDP protocol version (v1 or v2).

Output example

zbs-cdp job cancel_by_group group1 -v v2

Output note

If the command succeeds, no output is displayed. If the execution fails, an error message will be displayed.