Ask the Community
Groups
Exchange Data Collector Command Line options - Connect IT Community | Kaseya
<main> <article class="userContent"> <p>The following information is to be used with eddc.exe<br><br>######################<br># COMMAND LINE BASICS<br>######################<br>Please note that when passing a command line option that conatins special <br>characters or SPACES, the option MUST BE DOUBLE QUOTED. <br>Example: <br>eddc -outdir "c:\exchange detective"<br><br><br>######################<br># RECOMMENDED<br>######################<br>It is recommended that you use the RunExchangeDataCollector.exe to produce the command<br>line switches. On the Verify and Run screen, click the "Save Settings to File"<br>link. Then from the command line you can run:<br>eddc -file <your saved file><br><br><br>######################<br># SWITCH DETAILS<br>######################<br>Switch: -v<br>Details: Get the version of the program.<br><br>Switch: -encrypt <password> <br>Details: Encrypt a password. Used to produce the string to be used by options <br> that accept encrypted password.<br><br>Switch: -file <filename> <br>Details: Gets other command line parameters from the specified file. <br>Note 1: Each paramter must be on a single line. Please note that a switch that<br> takes a value counts as two parameters. Using -outbase for example,<br> -outbase will be on a single line, then <basename> will on on its own line.<br>Note 2: Any other switches used with -file WILL TAKE PRECEDENCE over the switches<br> contained in filename.<br><br>Switch: -comment <comment text><br>Details: Set the working directory for the output. This directory will be used <br> for tmp storage and file generation.<br>Example: -comment "This is for MY COMPANY"<br><br>Switch: -outbase <basename><br>Details: The basename of the outfile. Defaults to ExchangeDetective-<timestamp>.ndf. <br>Default: The folder containing the Network Data Collector files.<br>Note: Can use the following variables: %COMPUTERNAME%, %DATE%, and %MAC%.<br><br>Switch: -outdir <directory><br>Details: The directory to produce the final EDF. Defaults to the current <br> directory.<br><br>Switch: -exchange <2003|2007|2010|2013|365><br>Details: The version of Exchange to collect data from.<br>Note 1: This is a REQUIRED switch.<br>Note 3: Version 2003 requires WMI access to the server running Exchange.<br>Note 2: Versions 2007, 2010, and 2013 must be run on the Exchange box itself.<br>Note 3: Version 365 requires the Microsoft Online Services Module installed on <br> the machine launching the collection.<br><br>Switch: -user<br>Details: The username of an account with Admin privileges to Microsoft Office 365 or<br> the username to connect to a Exchange 2003 machine via WMI.<br>Requires: -exchange <2003|365><br><br>Switch: -epwd<br>Details: The ENCRYPED password for the specified user.<br>Requires: -user<br>Note: If both -pwd and -epwd are specified, only the encrypted one will be used.<br><br>Switch: -pwd<br>Details: The NON-ENCRYPTED password for the specified user.<br>Requires: -user<br>Note: If both -pwd and -epwd are specified, only the encrypted one will be used.<br><br>Switch: -server<br>Details: The hostname or IP Address of the Exchange 2003 server.<br>Requires: -exchange 2003<br><br>Switch: -domain<br>Details: The domain hosting the Exchange 2003 server.<br>Requires: -exchange 2003<br><br>Switch: -psa <path to psa><br>Details: -exchange <2007|2010|2013><br>Note 1: This is not required if Exchange was installed in the default location.<br>Note 2: Default path to PSA per version:<br> 2007: C:\Program Files\Microsoft\Exchange Server\bin\Exchange.ps1<br> 2010: C:\Program Files\Microsoft\Exchange Server\V14\bin\RemoteExchange.ps1<br> 2013: C:\Program Files\Microsoft\Exchange Server\V15\bin\RemoteExchange.ps1 <br><br><br>##########################<br># RESUME SWITCH DETAILS<br>##########################<br>Switch: -resume<br>Details: Resumes a previous collection.<br>Note 1: This will look in the current edf folder for progress.dat and resume based on<br> the values it finds. The rest of the switches below are overrides to progress.dat.<br><br>Switch: -nousers<br>Details: Skips recollection of the Users.<br>Requires: -resume<br><br>Switch: -nogroups<br>Details: Skips recollection of the Groups.<br>Requires: -resume<br><br>Switch: -noretention<br>Details: Skips recollection of the Retention Groups.<br>Requires: -resume<br><br>Switch: -noserver<br>Details: Skips recollection of the Exchange Server data.<br>Requires: -resume<br><br>Switch: -nopublic<br>Details: Skips recollection of the Public Folders.<br>Requires: -resume<br><br>Switch: -startuser<br>Details: The user number to start from when collecting user data. All previous will be skipped.<br>Requires: -resume<br><br>Switch: -startgroup<br>Details: The group number to start from when collecting user data. All previous will be skipped.<br>Requires: -resume<br><br><br>############################<br># BASIC EXAMPLE PER VERSION<br>############################<br>NOTE: All these will produce an EDF with the default basename in the current folder. <br>eddc -exchange 2003 -user <username> -epwd <encrypted password> -server <hostname> -domain <my domain><br>eddc -exchange 365 -user <username> -epwd <encrypted password><br>eddc -exchange 2007 <br>eddc -exchange 2010 <br>eddc -exchange 2013 <br><br><br></p> </article> </main>