Parameters for the Command Line Installer
This page provides the available parameters for Collector installation using the command line installer.
Collector versions 19.253-26+ support wrapper configuration parameters.
For details and example commands on Collector installation, see Install a Collector on Linux, Install a Collector on macOS, and Install a Collector on Windows.
Unique parameters
Here are the parameters unique to the command line installer:
-console
Only has an effect when used with -q. Causes the installer to send progress messages to the console (whether you are running the installer in UI or command-line mode.)
On Windows, for this option to take effect, you must run the installer with start /wait. For example:
start /wait installer.exe -q -console
-dir [directory]
Sets a different installation directory than the default.
-q
Causes the installer to run silently, which means you won't be prompted to supply installation parameters. For any installation parameter that you do not define at the command line, Sumo Logic will use a default value. No output is sent to the console during installation, unless you also use the -console parameter.
Note that for a new Collector installation, even during a silent installation, you will be prompted to provide an authorization token, or an Access ID and Access Key.
-varfile [fileName]
Instead of passing arguments via the command line, you can specify a file that contains the arguments (without the -V flag). Since many operating systems allow a user to list information about processes that are owned by other users, we recommend using the -varfile option to specify Sumo Logic credentials.
Example: To pass credentials when installing the Collector, you can create a file called sumo_credentials.txt with the following contents:
sumo.accessid=<access id> sumo.accesskey=<access key> proxy.host=<proxy host> proxy.port=<proxy port>
and pass this file via the command line:
sudo ./SumoCollector.sh -q -varfile /path/to/sumo_credentials.txt
Parameters for -q and -dir must be passed in the command line and cannot be used within a varfile.
-Vcollector.secureFiles=[true|false]
By default, new Collector installations will use enhanced file system security. To disable this feature during installation, use the command line argument: -Vcollector.secureFiles=false.
-VrunAs.username=[username]
When set, the Collector will run as the specified user (Windows and Linux). For Windows, the user account needs Log on as a Service permission.
-VwinRunAs.password=[password]
(Windows only) When set in conjunction with -VrunAs.username, the Collector will run as the specified user with the specified password.
Many operating systems allow a user to list information about processes that are owned by other users. This information could include command line arguments. For enhanced security, we recommend using the -varfile option to specify Windows RunAs password.
Authentication parameters
Following are parameters that relate to authenticating the Collector.
-VskipRegistration=[boolean]
When specified as true, the installer will skip registration.
Collectors will normally register with Sumo Logic during the installation process, but you can pass the ‑VskipRegistration=true flag to skip registration. This way, the Collector is installed as a service that will start and register automatically when the instance is launched.
-Vsumo.accessid=[accessId] -Vsumo.accesskey=[accessKey]
An authentication option is required, either this option or the token option (see next entry).
If you have a Sumo Logic access ID and access key, include both. -Vsumo.accessid and -Vsumo.accesskey Admins can generate an access ID/access key pair on the Preferences page. See Access Keys.
Many operating systems allow a user to list information about processes that are owned by other users. This information could include command line arguments. For enhanced security, we recommend using the -varfile option to specify Sumo Logic credentials.
-Vsumo.token_and_url=[token]
An authentication option is required, either this option or the access ID/access key option (see the above entry). Token can be an Installation Token.
user.properties parameters
The command line installer can use all of the parameters available in the user.properties file. To use parameters from user.properties, just add a -V to the beginning of the parameter without a space character. For example, to use the sources parameter you would specify it as -Vsources.
For reference, see the available user.properties parameters.
Parameters with a different format
There are a few parameters from user.properties that require specific formatting when used with the command line installer.
| user.properties parameter format | Command line installer format |
|---|---|
name | -Vcollector.name |
url | -Vcollector.url |
proxyHost | -Vproxy.host |
proxyPort | -Vproxy.port |
proxyUser | -Vproxy.user |
proxyPassword | -Vproxy.password |
proxyNtlmDomain | -Vproxy.ntlmdomain |
collector.properties parameters
The command line installer can use any of the parameters available in the collector.properties file.
To use parameters from collector.properties, just add a -V to the beginning of the parameter without a space character. For example, to use the source.max.threads.num parameter, you would specify it as -Vsource.max.threads.num.
For reference, see the available collector.properties parameters.