Command line parameters for GDPRSCAN are non-positional in nature.  Each parameter requires an identifying flag.  If no parameters are provided at run-time, certain basic assumptions are made, and you will be prompted for values for the parameters marked in the following table as “Mandatory”.  A basic sample command line would be something like

.\gdprscan.ps1 -s listserv.example.com -t joe@example.com -p admin@example.com -v f


While the parameters are non-positional, specifying them in the order shown without the parameter flags also works.  However, if the flags are not used, you MUST provide a non-blank, valid value for each parameter.  The only exception is for the -Server parameter; the server name may be specified in the first position without a flag if the rest of the parameters used are specified with flags.  For instance,

.\gdprscan.ps1 listserv.example.com -v f -p admin@example.com -t joe@example.com


works, even though the parameters following the server hostname are specified “out of order.”

Parameter

Alias

Default

Description

Mandatory?

-Server

-s

none

For LCMDX, the fully-qualified domain name (FQDN) registered in DNS for the target LISTSERV server.  For LCMD, the NETBIOS name of the LISTSERV machine.


For LCMDX only:  If the LISTSERV site configuration variable TCPGUI_PORT= has been configured to a value other than the default of 2306, you must also specify the port number here in the usual way, e.g., if you have set TCPGUI_PORT= 42306, then you must specify it thusly:


-s listserv.example.com:42306

YES

-TargetEmail

-t

none

The email address to be searched.

YES

-PostmasterEmail

-p

none

The email address of the person running the report.  Must be either a LISTSERV postmaster or a list owner.  List owners have access only to information pertaining to their own lists.

YES

-VerboseOutput

-v

True

Determines whether to echo the report information back to the console screen.  As the reports can become extremely verbose, it may be preferred to disable verbose output by setting it to “False”.  Setting this parameter to False will result in only very basic console output, sufficient to assure the operator that the report is running.  “T” and “F” are acceptable values and are case-insensitive.

No

-ReportDepth

-d

none (basic changelog report)

One of “ALLlists”, “SYSTEM”, or “FULL”, depending on the depth of the changelog reporting desired.  The default is to not specify a report depth, which results in a changelog report being run only on the list-level changelogs for the lists to which the target email is currently subscribed.

No

-Method

-m

LCMDX

Windows only.

Either “LCMDX” (TCPGUI) or “LCMD” (named pipes).  Windows users should see the section above entitled “Windows:  Named Pipes or TCPGUI?” for more information.

Linux and MacOS users will always use LCMDX and do not need to specify a value for this parameter.

No

-XMLPath

-x

none (Windows Desktop directory or Linux/MacOS current directory)

The path to the location of the resulting XML report.  The default is to not specify a value, which results in the report being written to the Windows desktop directory or to the Linux/MacOS current directory.  If specified, the path should be enclosed in single quotes.

No