ControlSphere command-line services

ControlSphere provides an ability to manage encrypted volumes and archives from the system command line, allowing even further automation. You can create, mount and dismount encrypted volumes and archives according to your needs and create the automation rules in your BAT/CMD files.

Command-line access functions are especially useful for automated BAT/CMD-file-based data backup processes which require minimal or none of user intervention.
Automatic file/data archiving is best with the Encrypted Archives.

Command-line support for Encrypted Archives
Command-line support for Encrypted Volumes


Command-line support for Encrypted Archives
You can manage encrypted volumes by calling command-line TCryptoArchive.exe module. The module is located in Windows system directory and thus is included in the system path.

There are three general operations available for the module: create, mount and dismount encrypted archives.

If the command cannot be completed due to syntax or execution error then the module sets errorlevel and displays corresponding error message, making it easier to put workaround logic to your automated BAT file.

TCryptoArchive.exe create  [/key=...]<or>[/password] /path=...  [/drive=...]

This command allows you creating encrypted archives from the command line. It can mount them automatically if required.
Parameter Meaning
/key=... Name of the Encryption key to use for the archive. Enclose the name in quotes if the key name contains spaces. You will need to connect and authorize (enter a User PIN) a token to retrieve the encryption key from unless the key is located on the currently authorized token.
This parameter cannot be combined together with the /password parameter. But either /key or /password parameters are required.
/password

If this parameter present, ControlSphere will ask you to provide a protective password to derive the custom encryption key from. No hardware token presence will be required.
This parameter cannot be combined together with the /key parameter. But either /key or /password parameters must be provided.

/path=... Full path to the EAR file to create. Enclose the path in quotes if it contains spaces. The specified directory path should exist. If the file with the same name exists then it will be overwritten.
/drive=... Optional parameter. Provide this parameter with the drive name to mount the archive under after it is created. The archive is not mounted unless this parameter is provided.
Example: /drive=E

TCryptoArchive.exe mount  /drive=...  /path=...

This command allows you mounting encrypted archives from the command line. If the encryption key is located on a token then you will need to authorize it according to the token PIN security policy. Otherwise, if you use a Token Image file to mount the volume then you will need to enter an encryption password.
Parameter Meaning
/drive=... Drive letter to mount the volume under.
Example: /drive=E
/path=... Full path to the EDR file to mount. Enclose the path in quotes if it contains spaces.

TCryptoArchive.exe dismount  /drive=...

This command allows you dismounting encrypted archives from the command line.
Parameter Meaning
/drive=... Drive letter the encrypted archive is mounted under.
Example: /drive=E



Command-line support for Encrypted Volumes
You can manage encrypted volumes by calling command-line TCryptoDrive.exe module. The module is located in Windows system directory and thus is included in the system path.

There are three general operations available for the module: create, mount and dismount encrypted volumes.

If the command cannot be completed due to syntax or execution error then the module sets errorlevel and displays corresponding error message, making it easier to put workaround logic to your automated BAT file.

TCryptoDrive.exe create  /key=...  /path=...  [/name=...]  [/drive=...]

This command allows you creating encrypted volumes from the command line. It can mount volumes automatically if required.
Parameter Meaning
/key=... Name of the Encryption key to use for the volume. Enclose the name in quotes if the key name contains spaces. You will need to connect and authorize (enter a User PIN) a token to retrieve the encryption key from unless the key is located on the currently authorized token.
/path=... Full path to the EDR file to create. Enclose the path in quotes if it contains spaces. The specified directory path should exist. If the file with the same name exists then it will be overwritten.
/size=... Size of the encrypted volume, either in megabytes or gigabytes. Use the following predefined size specifications: MB to specify size in megabytes or GB to specify size in gigabytes.
Example: /size=200MB, /size=10GB
/name=... Optional parameter. Provide this parameter to set a specific name to the encrypted volume. Enclose the name in quotes if the name contains spaces.
/drive=... Optional parameter. Provide this parameter with the drive letter to mount the volume under after it is created. The volume is not mounted unless this parameter is provided.
Example: /drive=E

TCryptoDrive.exe mount  /drive=...  /path=... [/global]

This command allows you mounting encrypted volumes from the command line. If the encryption key is located on a token then you will need to authorize it according to the token PIN security policy. Otherwise, if you use a Token Image file to mount the volume then you will need to enter an encryption password.
Parameter Meaning
/drive=... Drive name to mount the volume under.
Example: /drive=E
/path=... Full path to the EDR file to mount. Enclose the path in quotes if it contains spaces.

TCryptoDrive.exe dismount  /drive=...

This command allows you dismounting encrypted volumes from the command line.
Parameter Meaning
/drive=... Drive name the encrypted archive is mounted under.
Example: /drive=E