The CLI purge cancel command

Abstract

Reference of the xConnect DevEx CLI cancel command that stops purge tasks.

The xConnect DevEx CLI plugin includes a cancel subcommand. This command cancels the progress of a registered purge task.

You can use the command as follows:

sitecore xconnect purge cancel [options]

You can use the following options with the command:

Option

Required?

Description

-c, --config

Yes

The path to the sitecore.json configuration file (default: cwd). A DevEx CLI standard option.

-n, --environment-name

Yes

The Sitecore environment to use. Default: default. A DevEx CLI standard option.

--pti, --processing-task-id

Yes

The unique identifier of the ongoing purge task.

-v, --verbose

No

Report additional diagnostic and performance data.

-t, --trace

No

Report additional diagnostic and performance data.

-?, -h, --help

No

Help for the command.

Note

You can only cancel the task if it is in the Pending or In Progress state. Otherwise, the command returns an error. Use the status command to retrieve the current state of the task.