The CLI purge status command

Abstract

Reference of the xConnect DevEx CLI status command that checks the progress of data purge tasks.

The xConnect DevEx CLI plugin includes a status command. This command checks the progress of a registered data purge task.

You can use the command as follows:

sitecore purge contacts status [options]

You can use the following options with the command:

Option

Required?

Default

Description

-c, --config

Yes

cwd

The path to the sitecore.json configuration file. A DevEx CLI standard option.

-n, --environment-name

Yes

'default'

The Sitecore environment to use. A DevEx CLI standard option.

--pti, --processing-task-id

Yes

The unique identifier of the ongoing data 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 xconnect purge cancel command.