Download OmniAgent

OmniAgent Installation

Overview

In the Auto Discovery Instrumentation (ADI) framework, OmniAgent installation is performed through a guided and platform-driven workflow available in the Host Landscape. Unlike traditional onboarding workflows, the ADI-based approach does not require manual configuration such as editing configuration files, setting API keys, or defining connectivity parameters. Instead, it simplifies onboarding by generating a pre-configured installation command directly from the platform.

This ensures that:

• The host is onboarded with the correct Environment
• The host is mapped to the appropriate Host Group
• Authentication is handled securely using a generated API key
• The installation process is consistent and error-free

This approach significantly reduces manual effort and standardizes the onboarding process across different environments.

note

Host discovery and monitoring after OmniAgent installation depend on the ADI_ENABLED platform configuration. Only when ADI_ENABLED is enabled can ADI discover hosts, identify entities, and automatically apply monitoring.

How OmniAgent Installation Works in ADI

The OmniAgent installation process follows a structured flow controlled by the platform.

End-to-End Flow

Select Platform → Select Environment → Select Host Group → Choose Installation Type → Run Generated Command → Start OmniAgent → Host Registers → Discovery Begins → Monitoring Starts

Once the process is complete:

• The host is visible in Host Landscape
• Entities are automatically discovered
• Monitoring configuration is applied automatically

Accessing Download OmniAgent

The OmniAgent installation workflow is initiated through the Download OmniAgent option available in the Host Landscape.

Navigation

• Go to vuSmartMaps
• Navigate to Data Studio > Host Landscape

• Click Download OmniAgent (top-right corner)

This opens the Download OmniAgent dialog, which provides all controls required for onboarding.

Download OmniAgent Dialog Overview

The Download OmniAgent dialog provides the controls and instructions required to prepare the OmniAgent installation for the selected target platform and onboarding context.

The dialog includes the following sections:

• Platform
• Environment
• Host Group
• Installation Type
• Install OmniAgent (generated installation instructions/command area)
• API key visibility control
• Copy command action
• Close

Depending on the selected installation type, the dialog may also display a Download OmniAgent Package action.

Platform

The Platform field is used to select the operating system and architecture for the target host where OmniAgent will be installed. Available platform options include:

• Linux (x86_64)
• AIX (ppc64)
• Solaris (x86_64)
• Windows (x86_64)

The selected platform determines:

• The package type that is downloaded
• The generated installation command format
• The platform-specific installation and service-management instructions displayed in the Install OmniAgent section

note

The platform options available in this field can vary depending on the release version and deployment configuration.

Environment

• The Environment field is used to select the environment to which the target host should be associated during onboarding.
• The selected environment is included in the generated installation command and helps ensure that the host is onboarded into the correct logical environment.

• This is useful for organizing hosts into operational or deployment-specific environments, such as:
  • Development
  • Test
  • Staging
  • Production
  • Customer-specific environments
• Before proceeding, verify that the correct environment is selected, as this value becomes part of the onboarding context for the host.

Host Group

• The Host Group field is used to assign the target host to a host group during onboarding.
• The selected host group is included in the generated installation workflow and helps organize the host within the Host Landscape.

Using the correct host group helps with:

• Structured grouping of onboarded hosts
• Better inventory organization
• Easier filtering and management
• Cleaner operational categorization

If your onboarding workflow requires host grouping, ensure that the correct host group is selected before downloading the package or running the generated installation command.

Installation Type

The Installation Type section lets you choose how OmniAgent will be installed on the target host. Before selecting an installation type, make sure you have selected the following required values:

• Platform
• Environment
• Host Group

Once these values are selected, choose one of the following installation options:

• One-Click provides a single generated command that combines the package download and installation steps.
• Manual separates the package download from the installation command, allowing the package to be downloaded first and installed later on the target host.

The installation content is generated based on the selected onboarding context. If the required selections are not completed, the installation section is not displayed. This gives you the flexibility to choose between a streamlined command-driven workflow or a staged installation workflow.

note

For Unix-based platforms (Linux, Solaris, and AIX), OmniAgent installation and service-management commands must be executed using sudo/root privileges. OmniAgent must be installed in a dedicated system directory such as /opt/vunet/omniagent. Installing OmniAgent in user home directories (for example, /home/<user>/...) is not supported and will cause the installation to fail.

One-Click Installation

• The One-Click installation type provides a single generated command that combines the required package download and installation steps into one guided workflow.

• After you select the Platform, Environment, and Host Group, the Install OmniAgent section displays a platform-specific command that can be executed directly on the target host.

• This command is generated automatically based on the selected onboarding context and is intended to simplify the installation process by reducing the number of separate actions required. It also ensures that the selected Environment and Host Group are included as part of the installation metadata, which aligns with the ADI host-group mapping flow described in the PRD. When OmniAgent is installed with a host group selection, the host and its discovered entities are automatically associated with that host group.

How One-Click Works

In One-Click mode, the Install OmniAgent section provides a single generated command that performs the end-to-end onboarding preparation in one sequence. Based on the selected platform, the generated command can:

1. Download the OmniAgent package from the configured management endpoint.
2. Download the OmniAgent package and verify the package SHA256 checksum included in the generated installation command to ensure the package was downloaded successfully and has not been modified.

note

To securely download the OmniAgent package, VuNet Systems' CA certificate must be present in the target host’s system trust store. If the certificate is not available in the trust store, additional TLS validation handling may be required during installation.

3. Extract the downloaded package.
4. Run the OmniAgent installation command using the selected onboarding details.
5. Display a follow-up instruction to start OmniAgent after installation.

Because the command is generated by the platform, it reduces manual effort and helps ensure that the installation uses the correct Environment and Host Group values.

Steps to Use One-Click Installation

1. Navigate to vuSmartMaps > Data Studio > Host Landscape.
2. Click Download OmniAgent.
3. In the Download OmniAgent dialog, select the required Platform.
4. Select the required Environment.
5. Select the required Host Group.
6. Under Installation Type, select One-Click.
7. Review the generated command shown in the Install OmniAgent section.
8. Use the API key visibility control only if you need to inspect the embedded key.
9. Click the Copy icon to copy the generated command.
10. Open a terminal or shell session on the target host.
11. Review the generated command. If your deployment requires a custom working directory, update the installation command accordingly. VuNet recommends using a dedicated system directory such as /opt/vunet/omniagent instead of user home directories.
12. Paste and run the command using sudo/root privileges.
13. After the installation completes, run the suggested start command shown in the dialog.

note

For Solaris and AIX, installation command uses the $USER environment variable and the OmniAgent process is owned by the same user. To change the user, replace the $USER with another existing username in the command you copied.

sudo ./omniagent start

Install OmniAgent Section (One-Click)

When One-Click is selected, and all required values are provided, the Install OmniAgent section becomes available. This section displays the generated command that must be run on the target host.

Unlike Manual mode, One-Click does not show a separate package download button. Instead, the package download is already included as part of the generated command.

This section can also include:

• API key visibility control
• Copy command action

note

The command contains sensitive credentials and should be executed using sudo/root privileges.

Generated One-Click Command

The generated One-Click command is a combined command sequence that automates the download and installation workflow. It includes:

• Downloading the OmniAgent package using a platform-specific download URL.
• Saving the package as:
  omniagent__<platform_arch>__<version>.tar.gz
• Verifying the downloaded package using the package SHA256 checksum.
• Extracting the package contents.
• Running the OmniAgent installation command.
• Passing the required installation parameters, such as:
  • -c config.yaml
  • -u <user> (Unix-based platforms)
  • --api-key <value>
  • --environment <environment-name>
  • --hostgroup <host-group-name>

note

The exact command structure varies depending on the selected operating system and platform.

• Displaying a follow-up instruction to start OmniAgent using:

sudo ./omniagent start 

If a working directory is not explicitly specified during installation, OmniAgent uses the default installation location based on the operating system:

• Linux: /opt/vunet/omniagent
• AIX: /opt/vunet/omniagent
• Solaris: /opt/vunet/omniagent
• Windows: C:\vunet\omniagent

note

• To securely download the OmniAgent package, VuNet Systems' CA certificate must be present in the target host’s system trust store. If the certificate is not available in the trust store, the generated download command may include the -k option.

• The generated One-Click command automatically validates the downloaded package using the package SHA256 checksum before extraction and installation. If checksum validation fails, the installation process is aborted automatically to prevent installation of a corrupted or modified package. Manual package checksum verification is therefore not required when using the generated One-Click workflow.

Platform-Specific Command Examples

The generated One-Click command differs based on the selected operating system and architecture. The following examples illustrate the command structure generated for each supported platform:

• Linux (amd64)
• AIX (ppc64)
• Solaris (amd64)
• Windows (amd64)

API Key and Copy Command (One-Click)

• The API key control allows you to show or hide the API key embedded in the generated command. Use it only when you need to verify or troubleshoot the command.

• The Copy icon copies the generated command to the clipboard so that it can be pasted directly into the target host terminal. This is the recommended way to use the command because it helps avoid typing errors.

note

The command must be run as sudo/root.

After Installation (One-Click)

After the One-Click installation command completes successfully:

• The OmniAgent package is downloaded and extracted on the target host.
• OmniAgent is installed using the selected onboarding context.
• The host is associated with the selected Environment and Host Group.

sudo ./omniagent start

• Once OmniAgent is started, the host becomes part of the ADI onboarding flow, after which the platform can continue with discovery, inventory updates, and downstream onboarding behavior.

Manual Installation

The Manual installation type provides a staged installation workflow where the OmniAgent package is downloaded separately before the installation command is executed on the target host. This mode is useful when you want more control over how the package is transferred and installed, or when the download must be performed separately from the target server execution.

After you select the Platform, Environment, and Host Group, and then choose Manual, the dialog displays:

• Download OmniAgent Package
• Download & Install OmniAgent
• A generated installation command
• API key visibility control
• Copy command action

How Manual Works

• In Manual mode, the package download and installation are separated.
• You first download the OmniAgent package using the Download OmniAgent Package button.

• After the package is available on the target host, the generated command in the Download & Install OmniAgent section is used to complete the installation.
• Unlike One-Click, the generated command in Manual mode does not include the package download step. It assumes that the package has already been downloaded and moved to the target host.

Steps to Use Manual Installation

1. Navigate to vuSmartMaps > Data Studio > Host Landscape.
2. Click Download OmniAgent.
3. In the Download OmniAgent dialog, select the required Platform.
4. Select the required Environment.
5. Select the required Host Group.
6. Under Installation Type, select Manual.
7. Click Download OmniAgent Package.
8. Save the downloaded package to your local system.
9. Transfer the package to the target host if the download was performed on a different system.
10. Review the generated command shown in the Download & Install OmniAgent section.
11. Use the API key visibility control only if you need to inspect the embedded key.
12. Click the Copy icon to copy the command.
13. Open a terminal or shell session on the target host.
14. Paste and run the command using sudo/root privileges.
15. After the installation completes, run the suggested start command shown in the dialog

note

For Solaris and AIX, installation command uses the $USER environment variable and the OmniAgent process is owned by the same user. To change the user, replace the $USER with another existing username in the command you copied.

sudo ./omniagent start

Download OmniAgent Package (Manual)

The Download OmniAgent Package button is available only in Manual mode. Use this button to download the OmniAgent package for the selected platform.

After downloading the package:

• Save it locally.
• Verify the package integrity using the package SHA256 checksum provided alongside the downloaded package.
• Ensure that the package is available in the location where you plan to execute the installation command.
• Package checksum validation confirms that the downloaded package is complete and has not been altered during transfer.

This staged approach is useful when the download is performed on an intermediate workstation, and the package must then be transferred securely to the target server.

Verify Package Integrity (SHA256)

Before extracting or installing OmniAgent, verify that the downloaded package matches the published SHA256 checksum. The package SHA256 checksum is used to validate the integrity of the downloaded package and helps ensure that the package has not been corrupted or modified during download or transfer.

Linux

sha256sum <downloaded-package>

Windows (PowerShell)

Get-FileHash .\<downloaded-package> -Algorithm SHA256

Compare the calculated SHA256 value with the published checksum. If the values match, proceed with extraction and installation.

important

Do not install the package if the calculated checksum does not match the published SHA256 value.

Executable Integrity Verification

After extracting the OmniAgent package, additional checksum files are included within the package:

• omniagent.sha256 (Linux, AIX, Solaris)
• omniagent.exe.sha256 (Windows)
• autodiscovery.sha256 (Linux, AIX, Solaris)
• autodiscovery.exe.sha256 (Windows)

These checksum files are provided for environments that require verification of executable integrity as part of internal security, compliance, or software validation processes. The OmniAgent checksum files validate the OmniAgent executable, while the autodiscovery checksum files validate the Discovery Probe executable included with the package. Compare the executable checksum against the corresponding SHA256 file according to your organization's security validation procedures before deployment.

Download & Install OmniAgent Section (Manual)

When Manual is selected, the dialog displays the Download & Install OmniAgent section. This section provides the installation command that must be executed after the OmniAgent package has already been downloaded and transferred to the target host.

Unlike One-Click, the Manual workflow does not include the package download request. The generated command begins from package verification (where applicable), package extraction, and OmniAgent installation.

Generated Manual Command

The generated Manual command is a platform-specific installation command built from the selected onboarding context. Depending on the selected operating system, the generated command can perform the following actions:

• Verify the integrity of the downloaded package using the package SHA256 checksum (where supported).
• Extract the downloaded OmniAgent package.
• Execute the OmniAgent installation command.
• Pass the required onboarding parameters, such as:
  • -c config.yaml
  • -u <user> (Unix-based platforms)
  • --api-key <value>
  • --environment <environment-id>
  • --hostgroup <host-group-id>
• Display a follow-up instruction to start OmniAgent.

The exact command structure varies based on the selected operating system and platform.

note

• Do not manually modify the generated command unless there is a validated deployment-specific requirement.
• Linux-generated commands include package SHA256 verification before extraction and installation. If checksum validation fails, the installation process is aborted automatically.

Platform-Specific Installation Behavior

Platform	Package Extraction Method
Linux	tar -xvzf
AIX	gzip -dc package.tar.gz
Solaris	gzip -dc package.tar.gz
Windows	tar -xzf followed by omniagent.exe install

API Key and Copy Command (Manual)

• The API key control allows you to show or hide the API key included in the generated command.

• The Copy icon copies the command to the clipboard so it can be pasted directly into the target host terminal. This is the recommended way to use the command because it helps avoid typing mistakes and preserves the exact generated parameters.

note

The command must be run as sudo/root.

After Installation (Manual)

After the Manual installation command completes successfully:

• The downloaded package is extracted on the target host.
• OmniAgent is installed using the selected onboarding context.
• The host is associated with the selected Environment and Host Group.
• Next step:

sudo ./omniagent start

• Once OmniAgent is started, the ADI flow continues with agent registration, discovery probe installation, and discovery processing.

What Happens After Starting OmniAgent

Once OmniAgent is started, the ADI workflow continues automatically:

important

The ADI discovery and monitoring workflow described below is applicable only when the ADI_ENABLED configuration is enabled in the platform deployment. If ADI_ENABLED is disabled, hosts and entities will not be discovered, updated, or monitored by the ADI module.

1. Host Registration

• OmniAgent authenticates using API key
• Host is registered in the platform
• Appears in Host Landscape → Hosts

2. Discovery Begins

• Discovery process starts automatically
• Entities running on the host are identified

3. Configuration Application

• By default, all monitoring supported by ADI is enabled.
• The platform sends monitoring configurations based on:
  • Policies associated with the selected Environment
  • Policies associated with the selected Host Group
• ADI monitoring behavior is controlled through the ADI_ENABLED configuration parameter available in the Helm charts.
  • ADI_ENABLED = true
    • Hosts with OmniAgent installed are automatically discovered and monitored by the ADI module.
    • Host and entity discovery begins after registration.
  • ADI_ENABLED = false
    • Hosts and entities are not discovered, updated, or monitored by the ADI module.

note

Changing ADI_ENABLED from true to false does not disable monitoring for hosts that were already onboarded and monitored.

4. Probe Deployment

• Required probes are started automatically
• No manual probe installation required

5. Data Collection Begins

• Telemetry data starts flowing to platform
• Probe health and reporting become visible

How ADI Discovery Works

• Once OmniAgent is started and the host is successfully registered, the Discovery Probe automatically begins scanning the host to identify running services and applications.
• The Discovery Probe identifies processes that are actively listening for network connections, such as web servers, application servers, databases, and middleware components. Information about discovered services is reported to the vuSmartMaps platform and displayed as entities within the Host Landscape.
• Based on the Environment and Host Group associated with the host, ADI automatically evaluates the discovered entities and applies the appropriate monitoring configuration. Required probes are deployed automatically, allowing monitoring to begin without manual onboarding of individual services.
• This discovery process runs continuously, ensuring that newly started services are identified and reflected in the Host Landscape.
• Discovered services are displayed as entities within the Host Landscape, providing a continuously updated inventory of monitored applications and infrastructure components.

Verification

After setup, validate the following:

• Host appears in Host Landscape
• Host status shows as reporting
• Entities are discovered
• Monitoring status is updated
• OmniAgent tab shows probe health

note

If a host is successfully discovered but no entities are identified on the host, the Monitoring Status is displayed as No Entities and the Host Monitoring Status is displayed as Not Monitored.

FAQs

What is the difference between a Host and an Entity?

A Host represents the discovered infrastructure system, while an Entity represents a discovered runtime or application component associated with that host.

What happens after OmniAgent is installed?

The host registers with the platform, supported entities are discovered, monitoring policies are evaluated, and the Host Landscape inventory is updated automatically.

Can I organize discovered hosts?

Yes. Hosts can be organized using Environments and Host Groups to simplify inventory management, filtering, and monitoring.