Command-line administration of Recycle Bin

While the recycle bin features in the UI are sufficient for most tasks, Venafi Platform includes a command line utility to run recycle bin tasks either programmatically or manually.

For example, if you have a recycle bin task that is running, and you want to stop it, you can use the stopdelete command. Or, if you want to do an immediate purge and not wait for the nightly task to run, you can use the startpurge command.

The command line utility is located at:

[InstallDir]\Platform\TppRecycleBin.exe

For help at the command line, type the following after any command:

-h

For example, for information on the purge action, type:

TppRecycleBin purge -h

Available Commands

Use any of these commands after the TppRecycleBin.exe statement.

Command	Description	Required flags	Optional Flags1 In all examples in this table, failure to pass optional arguments in the command will result in being prompted for their values. In contrast, Required Values will throw an error unless they are provided in the command with the correct flag and value.
show	Display the contents of the recycle bin.
empty	Purge all items in the recycle bin immediately.		-user:<name> -pass:<password>
restore	Restore a single deleted item using the item's guid	-guid:<guid>	-user:<name> -pass:<password>
purge	Purge a single deleted item using the items guid	-guid:<guid>	-user:<name> -pass:<password>
startpurge	Immediately start the nightly recycle bin purge task.		-user:<name> -pass:<password>
stoppurge	Immediately stop the recycle bin purge task		-user:<name> -pass:<password>
startdelete	Immediately start the nightly automatic deletion task		-user:<name> -pass:<password>
stopdelete	Immediately stop the deletion task		-user:<name> -pass:<password>
showtasks	Display information on tasks that are running

Available Options

For the specific options available for a given command, execute the command with the -h flag.

Option	Description	Command syntax / example
-user:<name>	The username of a master admin	restore -user:"local:VenAdmin" restore -user:ad\smithj
-pass:<name>	The user's password	stoppurge -pass:PasswordGoesHere purge -pass:"Password Here"
-h	Help for the command you supply	startdelete -h
-guid:<guid>	The GUID of the object to restore	purge -guid:339efc1-7150-4fa8-8cd7-9ad3597fe1d2

If an error occurs when using the command line, you might find the following topic in the API documentation helpful: Recycle Bin result codes.

As an alternative to interacting with the command line, you may be able to use the RecycleBin API. For more information see RecycleBin API.