Endpoint Software Command Line Interface

Switch

Platforms

Description

jobmode

All

Places Spirion into Job Mode and has no additional parameters.

/jobmode

This setting causes Spirion to automatically initiate a search after launching. When jobmode is specified, most UI prompts are disabled at the beginning of the search, during the search, and on exit.

For example, check for updates is not executed, prompts for network credentials are suppressed, invalid file system prompts are suppressed, etc.

The value of Settings\ScheduledTask\SettingsSource determines if settings are read from Settings or JobSettings

configurationfile

All

Causes Spirion to read profile settings from an XML configuration file and requires the full path to a configuration (.xml) file.

For example: /configurationfile=”c:\myconfigfiles\profile1.xml”

This switch may be combined with the jobmode switch to use a specific set of options for a scheduled task. When used without the jobmode switch, Spirion will open with the options set in the configuration file. Any items set in the configuration file cannot be changed via the UI as the configuration file is considered an authoritative source for the session.

A configuration file can be created by exporting a Profile from the Windows client by selecting the “Configuration” ribbon tab, clicking the “Settings” button, selecting the “Profile” page, clicking the “Export Profile” button, and specifying a location and filename for the exported file.

A sample configuration file is attached to this article.

To use an exported Profile to run via command line you need to include settings for Scheduled Task when exporting the Profile.

profilepassword

Win,Mac

Causes Spirion to automatically sign in with the supplied password and load the user profile, including any information stored in the encrypted part of the profile.

• profile password is a required parameter.

For example: /profilepassword=”mypass”

filelist

Win

Causes Spirion to automatically start a search of the files or folders listed in the supplied file. The switch requires the full path to a plain text file that contains one filename or folder per line with no additional header or footer information.

For example: /filelist=”c:\myfiles\searchlist.txt”

This setting causes a modified search order for settings. When started with this switch, some settings are automatically set. Notably, only files and compressed file locations are searched, the default AnyFinds are enabled (unless otherwise specified in an authoritative source) and Search History and Search date restrictions are disabled.

A sample file list is attached to this article.

NOTE: You cannot use UNC paths in the file list. The path must be a local or mapped drive letter.

searchfile

Win

Causes Spirion to automatically search a file. The switch requires the full path to an individual file or folder to search. 

For example: /searchfile=”c:\mydocs\taxfile.pdf”

This setting causes a modified search order for settings as described in the detail for the /filelist switch. This switch is used by the Windows Explorer shell extension (Search with Spirion) to initiate a search.

addtovault

Win

Causes Spirion to create a new encrypted file vault file. This switch requires the full path to a file to place in the encrypted file vault.

For example: /addtovault=”c:\full_path_to\filename.ext”

The file vault will be named originalfilename.ext.idfvault and the original file will be shredded. The encryption used for the file vault is High Spirion encryption (AES-256 bit).

extractfromvault

Win

Causes Spirion to extract the original file from inside the specified Spirion file vault and delete the vault file. This switch requires the full path to a file vault file. 

For example: /extractfromvault =”c:\full_path_to\filename.ext.idfvault”

passwordvault

Win

Causes Spirion to open the Password Vault. A prompt for the profile password will be display unless the /profilepassword switch is also used. There are no additional parameters.

/passwordvault

shredlocation

Win

Causes Spirion to shred the specified file or folder (and all of its files and subfolders). This switch requires the full path to a file or folder. For example:

/shredlocation =”c:\foldername\subfoldername”
/shredlocation =”c:\full_path_to\filename.ext”

gatherdata

All

This is used to generate a diagnostic report (Gather Data Report) and write it to the specified folder.

For example: /gatherdata ="c:\foldername\subfoldername"

The path specification is windows only and is optional. If not specified, the GD report is put in a temp dir.

gatherdatapath

All

This switch is used in conjunction with the /gatherdata switch to specify the path for the GD report. This is available to all platforms but only necessary for unix as unix does not support optional value side of switch.

For example: /gatherdatapath ="c:\foldername\subfolder"

deletesearchhistory

Windows

Deletes local search history database, so that next search will not skip previously searched files. There are no additional parameters.

/deletesearchhistory

deleteignorelists

All

Deletes local ignore lists. All previously ignored matches and locations will be searched and reported as normal. There are no additional parameters.

/deleteignorelists