Skip to main content
Sumo Logic

Parameters for the Command Line Installer

The following table lists all of the available parameters for Collector installation using the command line installer. For details and example commands on Collector installation, see Install a Collector on LinuxInstall a Collector on MacOS, and Install a Collector on Windows

Parameter Description
-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 GUI 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 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 in a silent installation, you will be prompted to 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.
-Vcategory=[category]
* Available on Collector version 19.182+
Source category to use when a Source does not specify a category.

Example:  -Vcategory=auth_logs
-Vclobber=[true/false] When true, if there is any existing Collector with the same name, that Collector will be deleted.
-Vcollector.localfile.inputType=nonblocking Instructs the Collector to use the Windows Rollable code path for UNC file paths and should address any problems with file locking on the remote system.
-Vcollector.name=[name] Sets name of Collector used on Sumo Logic.
-Vcollector.registration.delay.ms=[#] Sets a delay in milliseconds for registration.
-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
-Vcollector.syslog.udp.readBufferSize=[bytes] Sets the maximum UDP message length limit for Syslog Sources. See choosing TCP or UDP for more information.
-Vcollector.url=[url] Sets the collection endpoint URL used to register the Collector. For example, https://collectors.sumologic.com. The endpoint may be adjusted for your deployment pod. For example, the US2 deployment would use, https://collectors.us2.sumologic.com.
-Vcollector.wildcard.fpSize=[bytes] Set the fingerprint size in bytes for all Sources on the Collector.
-Vdescription=[description]
* Available on Collector version 19.182+
Description for the Collector to appear in Sumo Logic.
Example:

-Vdescription="This Collector will send Apache logs from our Production environment."
-VdisableActionSource=[true/false]
* Deprecated on Collector version 19.245-4. Use -VenableActionSource instead.
If your organization's internal policies restrict the use of Script Actions, you can disable them by setting this parameter to true.
-VdisableScriptSource=[true/false]
* Deprecated on Collector version 19.245-4. Use -VenableScriptSource instead.
If your organization's internal policies restrict the use of Script Sources, you can disable them by setting this parameter to true.
-VdisableUpgrade=[true/false] If true, the Collector rejects upgrade requests from Sumo Logic.
-Vdocker.maxPerContainerConnections=[#] Sets the maximum number of Docker containers the Collector can collect from. The default is 40. The maximum supported number is 100.
-VenableActionSource=[true/false]
* Available on Collector version 19.245-4+
Script Action Sources are disabled by default. You can enable them by setting this parameter to true.
-VenableScriptSource=[true/false]
* Available on Collector version 19.245-4+
Script Sources are disabled by default. You can enable them by setting this parameter to true.
-Vephemeral=[true/false] When true, the Collector will be deleted after it goes offline for 12 hours.
-Vfields=[list of fields] Comma-separated list of key=value fields. This is used to assign an ingest budget to the Collector. Use field _budget to assign an ingest budget. Example: 

-Vfields=_budget=test_budget
-VfipsJce=[true/false]
* Available on Collector version 19.253-3+
Enables FIPS 140-2 compliant Java Cryptography Extension (JCE) to encrypt your data. Once enabled, the Collector version cannot be downgraded below version 19.253-3.
-Vforwarding.syslog.maxMessageSize=[bytes] Sets the segment size in bytes of forwarded syslog messages. The default is 1024.
-VfreeSpace.threshold.percent=[percent] Sets the free space percentage threshold for entering flush mode. Example:

-VfreeSpace.threshold.percent=10

To disable flushing mode set to 0.
-VhostName=[hostname]
* Available on Collector version 19.182+
The host name of the machine on which the Collector is running.
Example:

-VhostName="My Host"

The host name can be a maximum of 128 characters.
-VlocalWindowsEventLog.batchSize=[number of events] Sets a hard limit on the number of events a Source may retrieve from an Event Log source every second. The default is 512 events.
-Vproxy.host=[host] Sets proxy host when a proxy server is used.
-Vproxy.port=[port] Sets proxy port when a proxy server is used.
-Vproxy.user=[username] Sets proxy user when a proxy server is used with authentication.
-Vproxy.password=[password] Sets proxy password when a proxy server is used with authentication.

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 below to specify proxy server password.
-Vproxy.ntlmdomain=[NTLM domain] Sets proxy NTLM domain when a proxy server is used with NTLM authentication.  
-Vqueue.max.disk.gb=[# of GB] Sets the limit for disk caching for logs. For example, to set a limit of 2GB use: -Vqueue.max.disk.gb=2
-Vqueue.metrics.max.disk.gb=[# of GB] Sets the limit for disk caching for metrics. For example, to set a limit of 2GB use: -Vqueue.metrics.max.disk.gb=2
-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.
-VskipAccessKeyRemoval=[true/false] If true, it will skip the access key removal from the user.properties file. (The default behavior is to remove accesskey from user.properties after a Collector has successfully registered with the Sumo service.)
-VskipRegistration=[true/false] When true, the Collector will install files and create a user.properties file, but not register or start the Collector. This option is ideal for "baking" the Collector into AMI images so that it will start and register automatically when the image is launched.

This option requires using Access Id / Access Key credentials. For more information, see Add a Collector to a Linux Machine Image or Add a Collector to a Windows Machine Image.
-Vsource.max.threads.num=[#] Sets the max thread count.
-Vsources=[filepath] Sets the location of the UTF-8 encoded JSON file describing Sources to configure on registration. To make changes to Sources after the Collector has been configured, you can use the Collector Management API or the Sumo web application.
-Vssh.host.verify.file=[path] Enables remote host key verification. Provide the actual path to your known_hosts file.
-Vstreaming.metrics.hostname=[host] Sets the network interface for Steaming Metrics Sources to bind to.
-Vsumo.accessid=[accessId] -Vsumo.accesskey=[accessKey] An authentication option is required, either this option or the token option (see previous entry in this table). 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 in the Web application. 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 below 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 following entry in the table).

If Sumo Logic has provided you with a one-time token for installation, include it in this parameter.
-VsyncSources=[filepath] Sets the location of the UTF-8 encoded JSON file describing Sources to configure on registration, which will be continuously monitored and synchronized with the Collector's configuration.

For more information on setting the syncSources parameter, see Local Configuration File Management.
-VtargetCPU=[target]
* Available on Collector version 19.182+
You can choose to set a CPU target to limit the amount of CPU processing a Collector uses.  The value must be expressed as a whole number percentage.
Example:

-VtargetCPU=20

The Collector will adjust resources to attempt to limit the CPU usage to at most 20%.  For more information, see Set the Collector CPU Usage Target.
-VtimeZone=[timezone]
* Available on Collector version 19.182+
The time zone to use when the time zone can't be extracted from the time stamp.
Example:

-VtimeZone=America/Los_Angeles

For a list of possible values, refer to the "TZ" column in this Wikipedia article.
-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 below to specify Windows RunAs password.