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. 

Parameter Description

-q

Starts the Installer in quiet mode (no UI).

-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.

-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.

-dir [directory]

Sets a different installation directory than the default.

-Vcollector.name=[name]

Sets name of Collector used on Sumo Logic.

-Vcollector.url=[url]

Sets the URL used to register Collector for data collection API.

-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.

-Vproxy.ntlmdomain=[NTLM domain]

Sets proxy NTLM domain when a proxy server is used with NTLM authentication.

 

-Vsources=[filepath]

Sets the JSON file describing sources to configure on registration. On Windows, specify the path with double backslashes ( \\ ).
Example: -Vsources=C:\\sumo\\sources.json

-VsyncSources=[filepath]

Sets the JSON file describing sources to configure on registration, which will be continuously monitored and synchronized with the collector's configuration. On Windows, specify the path with double backslashes ( \\ ).
Example:

-VsyncSources=C:\\sumo\\sources.json

-Vephemeral=[true/false]

When true, the Collector will be deleted after goes offline for a certain period of time.

-Vclobber=[true/false]

When true, if there is any existing Collector with the same name, that collector will be deleted.

-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.

-VskipRegistration=[true/false]

When true, the Collector will install files and create 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.
Note: 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.

-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

-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.

-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.

-Vcategory=[category]

* Available on Collector version 19.182+

Source category to use when a Source does not specify a category.
Example:

 -Vcategory=auth_logs

-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.

-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."

-VdisableScriptSource=[true/false]

If your organization's internal policies restrict the use of scripts, you can disable the running of script-based Sources. When this parameter is passed, Script Source will not execute on this Collector.

-VdisableActionSource=[true/false]

If your organization's internal policies restrict the use of script actions, you can disable the creation of script-based Action Sources. When this parameter is passed, Action Source will not execute on this Collector.

-VdisableUpgrade=[true/false]

If true, the Collector rejects upgrade requests from Sumo Logic.

-varfile [fileName]

Instead of passing arguments via the command line, you can specify a file that contains the arguments (without the "-V" flag). 

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>

and pass this file via the command line:

sudo ./SumoCollector.sh -q -varfile /path/to/sumo_credentials.txt