Exchange Data Collector Command Line options

The following information is to be used with eddc.exe

######################
# COMMAND LINE BASICS
######################
Please note that when passing a command line option that conatins special 
characters or SPACES, the option MUST BE DOUBLE QUOTED. 
Example: 
eddc -outdir "c:\exchange detective"


######################
# RECOMMENDED
######################
It is recommended that you use the RunExchangeDataCollector.exe to produce the command
line switches. On the Verify and Run screen, click the "Save Settings to File"
link. Then from the command line you can run:
eddc -file <your saved file>


######################
# SWITCH DETAILS
######################
Switch:   -v
Details:  Get the version of the program.

Switch:   -encrypt <password> 
Details:  Encrypt a password. Used to produce the string to be used by options 
          that accept encrypted password.

Switch:   -file <filename>          
Details:  Gets other command line parameters from the specified file. 
Note 1:   Each paramter must be on a single line. Please note that a switch that
          takes a value counts as two parameters. Using -outbase for example,
          -outbase will be on a single line, then <basename> will on on its own line.
Note 2:   Any other switches used with -file WILL TAKE PRECEDENCE over the switches
          contained in filename.

Switch:   -comment <comment text>
Details:  Set the working directory for the output. This directory will be used 
          for tmp storage and file generation.
Example:  -comment "This is for MY COMPANY"

Switch:   -outbase <basename>
Details:  The basename of the outfile. Defaults to ExchangeDetective-<timestamp>.ndf.          
Default:  The folder containing the Network Data Collector files.
Note:     Can use the following variables: %COMPUTERNAME%, %DATE%, and %MAC%.

Switch:   -outdir <directory>
Details:  The directory to produce the final EDF. Defaults to the current 
          directory.

Switch:   -exchange <2003|2007|2010|2013|365>
Details:  The version of Exchange to collect data from.
Note 1:   This is a REQUIRED switch.
Note 3:   Version 2003 requires WMI access to the server running Exchange.
Note 2:   Versions 2007, 2010, and 2013 must be run on the Exchange box itself.
Note 3:   Version 365 requires the Microsoft Online Services Module installed on 
          the machine launching the collection.

Switch:   -user
Details:  The username of an account with Admin privileges to Microsoft Office 365 or
          the username to connect to a Exchange 2003 machine via WMI.
Requires: -exchange <2003|365>

Switch:   -epwd
Details:  The ENCRYPED password for the specified user.
Requires: -user
Note:     If both -pwd and -epwd are specified, only the encrypted one will be used.

Switch:   -pwd
Details:  The NON-ENCRYPTED password for the specified user.
Requires: -user
Note:     If both -pwd and -epwd are specified, only the encrypted one will be used.

Switch:   -server
Details:  The hostname or IP Address of the Exchange 2003 server.
Requires: -exchange 2003

Switch:   -domain
Details:  The domain hosting the Exchange 2003 server.
Requires: -exchange 2003

Switch:   -psa <path to psa>
Details:  -exchange <2007|2010|2013>
Note 1:   This is not required if Exchange was installed in the default location.
Note 2:   Default path to PSA per version:
            2007: C:\Program Files\Microsoft\Exchange Server\bin\Exchange.ps1
            2010: C:\Program Files\Microsoft\Exchange Server\V14\bin\RemoteExchange.ps1
            2013: C:\Program Files\Microsoft\Exchange Server\V15\bin\RemoteExchange.ps1                


##########################
# RESUME SWITCH DETAILS
##########################
Switch:   -resume
Details:  Resumes a previous collection.
Note 1:   This will look in the current edf folder for progress.dat and resume based on
          the values it finds. The rest of the switches below are overrides to progress.dat.

Switch:   -nousers
Details:  Skips recollection of the Users.
Requires: -resume

Switch:   -nogroups
Details:  Skips recollection of the Groups.
Requires: -resume

Switch:   -noretention
Details:  Skips recollection of the Retention Groups.
Requires: -resume

Switch:   -noserver
Details:  Skips recollection of the Exchange Server data.
Requires: -resume

Switch:   -nopublic
Details:  Skips recollection of the Public Folders.
Requires: -resume

Switch:   -startuser
Details:  The user number to start from when collecting user data. All previous will be skipped.
Requires: -resume

Switch:   -startgroup
Details:  The group number to start from when collecting user data. All previous will be skipped.
Requires: -resume


############################
# BASIC EXAMPLE PER VERSION
############################
NOTE: All these will produce an EDF with the default basename in the current folder.             
eddc -exchange 2003 -user <username> -epwd <encrypted password> -server <hostname> -domain <my domain>
eddc -exchange 365 -user <username> -epwd <encrypted password>
eddc -exchange 2007 
eddc -exchange 2010 
eddc -exchange 2013