Parameters

Jump to:

• General

• Action

• Threads

• Source

• Destination

• Errors

• Key Export

• Key Import

• CSV

• Configuration

• Max queue

• Level

• Verbose

• Convert

• File Names 

• Example

• Archive

General

The general layout of the Virtru Data Protection Toolkit execution is:

virtru.console.exe [Action] parameters

Action

• Options
  • bulk-decrypt
    • Bulk decrypts mbox/pst/tdf files in the source directory
  • bulk-export
    • Bulk exports all policy keys to PROTOBUF binary.  Used to improve performance by limiting HTTP requests. 
  • bulk-encrypt
    • Bulk encrypts tdf files in the source directory
  • help
    • Display more information on a specific command.
  • version
    • Display version information.

Threads

• -t
  • The number of Threads to allocate
  •  Default: 4
• -r
  • Maximum number of Http Requests per second before throttling
  • Default: 10

Source

• -s
  • (Required) Path to read encrypted mbox/pst/tdf files.

Destination

• -d
  • (Required) Path to write decrypted mbox/pst/tdf files.

Errors

• -e

  • (Default: ./errors) Path to write mbox/pst files with e-mails that had errors decrypting. Default: ./errors

Summary output

• -w
  • Write the console summary to a file upon completion (Example: "./summary.log")

Key Export

• -e

  • Export policies before decrypting to improve performance by reducing http requests. Path to write exported policy keys.

  • Example: ./policies.bin

Key Import

• -i

  Path to PROTOBUF binary of policy keys to import. Used to improve performance by reducing http requests.

CSV

• -x

  • Required. Path to File to the CSV digest file generated by the Google Vault

Configuration

• -c

  • (Required) Path to the configuration file. E.g. './.creds/virtru-cli-creds.json'.

Max queue

• -m

  •  (Default: 200) Maximum queue size for processing. Default is 200, set to 0 for unlimited. Larger queues are more performant at the cost of memory usage.

Level

• -l
  • (Default: WARN) Logging level. Default: 'warning'.

Verbose

• -v, verbose
  • Shortcut to configure logging for debug level output.

Convert

• -n
  • Convert MBOX files to PST after processing
  • Default: False

File Names 

• -a

  • Fixes the name of decrypted vault files by appending the extension found before the random 33 characters

  • Default: False

Example

Bulk Decrypt

virtru.console.exe bulk-decrypt -

Bulk Key Export

 virtru.console.exe bulk-export -

Bulk Encrypt

 virtru.console.exe bulk-encrypt -

Archive