Documentation forSolarWinds Observability SaaS

SolarWinds Observability Agent installation parameters

Review available parameters for stand-alone installation.

Installation parameters for Linux

Parameter Optional/
Required		 Description
SWO_URL optional

The correct endpoint for your organization.

The default value is na-01: North American AWS data center
UAMS_ACCESS_TOKEN required An access token used to register the Agent.
UAMS_BIND_IDENTITY optional

Persist the given UUID identity as the Agent ID override.
UAMS_BIND_NEW_IDENTITY optional

Persist a new, randomly generated UUID as the Agent ID override.
UAMS_DISABLE_AGENT_AUTO_UPDATE optional

Supported values: true or false

Set to true to disable the Agent during the installation. Use for example when you want to install an older Agent version and keep the Agent on this version.

By default, the Agent executes auto-update after the installation and then sets this option to false.

UAMS_HTTPS_PROXY optional

The proxy only for the Agent

Use a proxy IP address, hostname, or domain name in one of the following formats:

  • proxyAddress
  • proxyAddress:port,
  • http://user:password@proxyAddress:port
UAMS_IS_EPHEMERAL optional Marks an Agent as ephemeral. Ephemeral Agents are automatically removed from SolarWinds Observability SaaS when they are disconnected for at least 24 hours. Use this parameter for temporary Agents.
UAMS_MANAGED_LOCALLY optional

Supported value: true

Set to true to install the Agent as a locally-managed Agent.

By default, the configuration source for Agents is set to Remote.
UAMS_METADATA optional Custom metadata to be sent to the cluster on the first registration.
UAMS_OVERRIDE_HOSTNAME optional A name that will override the default hostname.

Installation parameters for Windows script-based installation

Parameter Optional/
Required		 Description
-AccessToken required An access token used to register the Agent.
-BindIdentity optional

Persist the given UUID identity as the Agent ID override.
-BindNewIdentity optional

Persist a new, randomly generated UUID as the Agent ID override.
-DisableAgentAutoUpdate optional

Supported values: true or false

Set to true to disable the Agent during the installation. Use for example when you want to install an older Agent version and keep the Agent on this version.

By default, the Agent executes auto-update after the installation and then sets this option to false.

-HTTPSProxy optional

The proxy only for the Agent

Use a proxy IP address, hostname, or domain name in one of the following formats:

  • proxyAddress
  • proxyAddress:port,
  • http://user:password@proxyAddress:port
-IsEphemeral optional Marks an Agent as ephemeral. Ephemeral Agents are automatically removed from SolarWinds Observability SaaS when they are disconnected for at least 24 hours. Use this parameter for temporary Agents.
-ManagedLocally optional

Supported value: true

Set to true to install the Agent as a locally-managed Agent.

By default, the configuration source for Agents is set to Remote.
-Metadata optional Custom metadata to be sent to the cluster on the first registration.
-OverrideHostname optional A name that will override the default hostname.
-SwoUrl optional

The correct endpoint for your organization.

The default value is na-01: North American AWS data center

Installation parameters for Windows Installer

Parameter Optional/
Required		 Description
ACCESSTOKEN required An access token used to register the Agent.
BIND_IDENTITY optional

Persist the given UUID identity as the Agent ID override.
BIND_NEW_IDENTITY optional

Persist a new, randomly generated UUID as the Agent ID override.
DISABLE_AGENT_AUTO_UPDATE optional

Supported values: true or false

Set to true to disable the Agent during the installation. Use for example when you want to install an older Agent version and keep the Agent on this version.

By default, the Agent executes auto-update after the installation and then sets this option to false.

HTTPS_PROXY optional

The proxy only for the Agent

Use a proxy IP address, hostname, or domain name in one of the following formats:

  • proxyAddress
  • proxyAddress:port,
  • http://user:password@proxyAddress:port
IS_EPHEMERAL optional Marks an Agent as ephemeral. Ephemeral Agents are automatically removed from SolarWinds Observability SaaS when they are disconnected for at least 24 hours. Use this parameter for temporary Agents.
MANAGED_LOCALLY optional

Supported value: true

Set to true to install the Agent as a locally-managed Agent.

By default, the configuration source for Agents is set to Remote.
METADATA optional Custom metadata to be sent to the cluster on the first registration.
OVERRIDE_HOSTNAME optional A name that will override the default hostname.
SWO_URL optional

The correct endpoint for your organization.

The default value is na-01: North American AWS data center