Posted: 4/15/2010,
Updated: 2/8/2011
Enterprise Client Command Line Switches

Overview

Identity Finder for Windows (version 4.0 and later) and Mac (version 3.0 and later) can both be executed via the command line for customized configuration, use in batch jobs, or to perform special actions.

 

Switches

For Windows, use /switchname for Mac, use --switchname.

Switch Platforms  
Description
jobmode All

Places Identity Finder into Job Mode and has no additional parameters.

/jobmode

This setting causes Identity Finder 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 will determine if settings are read from Settings or JobSettings

configurationfile All

Causes Identity Finder 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, Identity Finder 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 configuration file can be created by exporting a policy from the Enterprise Console by clicking on Policies, creating a new policy, click on Settings and modifying the desired settings, and then clicking Export on the toolbar and selecting, "Local File" as the policy type.

A sample configuration file is attached to this article.

profilepassword All

Causes Identity Finder to automatically sign in with the supplied password and load the user profile, including any information stored in the encrypted part of the profile.  The profile password is a required parameter.  For example:

/profilepassword=”mypass”
filelist Win

Causes Identity Finder 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.

searchfile Win

Causes Identity Finder to automatically search a search.  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 Identity Finder) to initiate a search.

addtovault Win

Causes Identity Finder 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 Identity Finder encryption (AES-256 bit).

extractfromvault Win

Causes Identity Finder to extract the original file from inside the specified Identity Finder 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 Identity Finder 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 Identity Finder 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”

 

Attachments:

profile1.xml

searchlist.txt