Service and CLI Management

Service Management

Managing the OmniAgent Service

After installation, OmniAgent runs as a system-level service on the host. This service can be controlled using command-line operations to start, stop, restart, or check its status.

These commands are useful for:

• Starting the agent after installation
• Troubleshooting connectivity or reporting issues
• Restarting the agent after configuration updates
• Verifying whether the agent is actively running

note

Service operations require appropriate privileges (for example, sudo on Linux or Administrator access on Windows).

Start OmniAgent

sudo ./omniagent start

Starts the OmniAgent service on the host.

Behavior

• Initiates communication with the vuSmartMaps platform
• Begins sending heartbeat signals
• Applies any pending configurations received from the platform
• Starts required probes based on the current monitoring configuration

Impact in ADI

• Host becomes active and reporting
• Host status is updated in Host Landscape
• Discovery and monitoring workflows begin

Stop OmniAgent

sudo ./omniagent stop

Stops the OmniAgent service on the host.

Behavior

• Terminates the OmniAgent process
• Stops probe execution associated with the agent

Impact in ADI

• Host stops reporting data
• Host may appear as Not Reporting / Stale in Host Landscape
• Monitoring and discovery processes are paused

Restart OmniAgent

sudo ./omniagent restart

Restarts the OmniAgent service.

Behavior

• Stops and then starts the OmniAgent service
• Re-establishes connection with the platform
• Re-applies configurations
• Re-initializes probe execution based on configuration

When to Use

• After configuration changes
• When troubleshooting agent or probe issues
• When the agent becomes unresponsive

Check OmniAgent Status

sudo ./omniagent status

Displays the current state of the OmniAgent service.

Possible States

• Running: OmniAgent is active and reporting
• Stopped: OmniAgent is installed but not running

Usage

• Verify installation success
• Confirm whether the agent is actively reporting
• Troubleshoot connectivity or onboarding issues

Additional Validation (Recommended)

Linux

sudo systemctl status omniagent

Windows

sc query omniagent

AIX

sudo lssrc \-s omniagent

Solaris

sudo svcs omniagent

These commands provide additional service-level validation.

CLI Management (OmniAgent CTL)

OmniAgent provides a command-line utility called omniagentctl, which allows users to inspect and manage OmniAgent and its associated probes directly on the host.

In the Auto Discovery Instrumentation (ADI) framework, most probe lifecycle and configuration management is handled automatically by the platform. The CLI is therefore primarily used for:

• Troubleshooting probe-related issues
• Inspecting probe configuration and health
• Verifying local agent behavior
• Performing advanced or controlled operations when required

note

• In ADI, probe deployment and configuration are platform-driven. Direct CLI-based probe management should be used only when necessary.
• OmniAgent CTL is currently supported only on Linux and Windows platforms. OmniAgent CTL commands and functionality are not available on AIX and Solaris.

Starting the OmniAgent CTL Shell

You can start the OmniAgent CTL shell by simply running:

sudo omniagentctl 

• Once inside the shell, you can execute any command interactively.
• Every command available within the shell can also be executed directly from the command line using the omniagentctl executable.

For example, both of the following provide the same output:

omniagentctl help

Running the following command displays a list of all supported commands along with their descriptions:

omniagentctl help

This serves as the entry point for exploring different operations available within OmniAgent CTL.

note

The examples in this guide use the Linux command format (omniagentctl) with sudo/root privileges where applicable. On Windows, add the .exe extension when running commands., add the .exe extension when running commands.

• Example:
  • Linux: sudo omniagentctl stop-probe
  • Windows: omniagentctl.exe stop-probe

Aside from this naming difference, all commands and their options function identically on both operating systems.

Available Commands

Command	Description
help	Displays help information for OmniAgent CTL commands.
about	Shows OmniAgent version and configuration details.
add-probe	Adds a new probe to OmniAgent.
completion	Generates shell autocompletion scripts.
describe-probe	Displays configuration and health details of a probe.
exit	Exits the OmniAgent CTL shell.
list-probes	Lists all probes managed by OmniAgent.
remove-probe	Stops and removes a probe from OmniAgent.
start-probe	Starts a specified probe.
stop-probe	Stops a running probe.
update-probe	Updates a probe’s configuration.

help

• Displays detailed help information about any available command.

• Use this to understand syntax, usage, and command-specific options.

omniagentctl help \<command\>

Example:

omniagentctl help update-probe

about

Displays version and configuration information about the OmniAgent, including its current settings and location. This command helps verify the active OmniAgent version and ensure proper configuration.

omniagentctl about

add-probe

• Creates a new probe in the OmniAgent with a specified name.
• —probe-name, —target-file-path, -–version.

sudo omniagentctl add-probe

note

A probe name must be alphanumeric, may contain hyphens or underscores, and must begin with a letter.

completion

Generates the autocompletion script for supported shells, making it easier to use omniagentctl commands interactively.

omniagentctl completion

• Available Subcommands:
  • bash – Generate autocompletion for Bash shell
  • fish – Generate autocompletion for Fish shell
  • powershell – Generate autocompletion for PowerShell
  • zsh – Generate autocompletion for Zsh shell

Each subcommand provides detailed instructions for enabling autocompletion in the respective shell environment.

describe-probe

• Retrieves and displays details about a specific probe.
• You can view the probe’s configuration, health, state, and package details using subcommands.

omniagentctl describe-probe

• Available Subcommands:
  • get-config: Displays the content of a specific configuration file for a probe. This command helps you verify the configuration currently applied to the selected probe.

omniagentctl describe-probe get-config --probe <probe-name> --config-file <file-name>

• get-config-version: Retrieves a specific version of a probe’s configuration file and writes it to a temporary location. Use the list-config-versions command first to view available configuration versions.

omniagentctl describe-probe get-config-version --probe <probe-name> --config-version-file <versioned-file-name>

• health: Displays the health status and resource utilization of a specific probe.
  Information shown includes:

  • Whether the probe is healthy

  • When the probe started

  • Current uptime and status

  • Last error (if any)

  • Resource usage details

omniagentctl describe-probe health --probe <probe-name>

• list-config-versions: Lists all available versions of a specific configuration file for a probe. Each version entry includes when it was applied and whether it was applied locally or remotely.

omniagentctl describe-probe list-config-versions --probe <probe-name> --config-file <file-name>

• list-configs: Lists all configuration files for a probe, including metadata such as:

  • File path and content type

  • Creation and modification timestamps

  • Source (local or remote)

  • Deletion status, if applicable

omniagentctl describe-probe list-configs --probe <probe-name>

• package: Provides detailed information about the probe’s installed package, including:

  • Package identifier sent by the server

  • The package currently used by the probe

  • Any errors encountered during package download

  • Package creation timestamp

omniagentctl describe-probe package --probe <probe-name>

This command is useful for inspecting probe status, verifying applied configurations, and reviewing package information.

exit

• Exits the interactive OmniAgent CTL shell.

• This command is used when you are working within an interactive session.

exit

list-probes

Lists all probes that the OmniAgent currently manages.
Each listed probe includes:

• Probe name

• Path to the probe’s executable

omniagentctl list-probes

This helps you verify which probes are registered and their corresponding executable paths.

remove-probe

• Only works for probes added by omniagentctl.

• Stops and removes the specified probe from the OmniAgent.

• The probe’s process is stopped, but any files it created while running will be retained.

sudo omniagentctl remove-probe

• This is typically used when decommissioning or replacing a probe.

start-probe

• Starts a specific probe managed by OmniAgent.
• Use this command to start a probe after it has been added or after its configuration or package has been updated.

sudo omniagentctl start-probe --probe <probe-name>

note

If a probe is expected to be stopped based on the OmniAgent Console configuration but is started locally using this command, the probe will appear unhealthy in the OmniAgent Console. This status mismatch indicates a difference between the local probe state and the expected state defined in the console.

stop-probe

• Stops a running probe managed by OmniAgent.
• Use this command to stop a probe before applying updates, performing maintenance, or troubleshooting probe-related issues.

sudo omniagentctl stop-probe --probe <probe-name>

note

If a probe is expected to be running based on the OmniAgent Console configuration but is stopped locally using this command, the probe will appear unhealthy in the OmniAgent Console. This indicates a mismatch between the local probe state and the expected state defined in the console.

update-probe

• Used to update an existing probe’s configuration or package.

• This command supports multiple subcommands for applying, upgrading, or deleting configurations.

sudo omniagentctl update-probe

• Available Subcommands:

  • apply-config: Applies a configuration file to a probe. This command is used to push a specific configuration file so that the probe operates using the updated configuration.

sudo omniagentctl update-probe apply-config --probe <probe-name> --config-file <file-name>

• delete-config: Deletes a specific configuration file from a probe. This command removes the configuration file reference from the probe while retaining other probe-related files and data.

sudo omniagentctl update-probe delete-config --probe <probe-name> --config-file <file-name>

OmniAgent Monitoring and Visibility

In the Auto Discovery Instrumentation (ADI) framework, monitoring and operational visibility of OmniAgent is provided through the Host Landscape interface in vuSmartMaps. Host Landscape provides a unified and discovery-driven view of hosts, entities, OmniAgent status, and probe health. Instead of managing OmniAgent separately, users can now monitor and manage all related components from a centralized interface.

Accessing OmniAgent Information

To view OmniAgent-related details:

• Navigate to vuSmartMaps → Data Studio → Host Landscape

Within Host Landscape, OmniAgent-related information is available across multiple tabs:

• Summary – High-level overview of discovered inventory and monitoring state
• Hosts – Host-level details, onboarding status, and associations
• Entities – Component-level monitoring and discovery details
• OmniAgent – OmniAgent health, reporting status, and probe visibility
• History – Discovery and monitoring activity tracking

OmniAgent Visibility in ADI

In the ADI model, OmniAgent operates as the execution layer on each host, while the platform provides centralized visibility.

Users can:

• Verify whether OmniAgent is installed and reporting
• Check probe health and data collection status
• Identify hosts or entities with monitoring issues
• Track onboarding and monitoring lifecycle
• Analyze discovery and monitoring activity

Additionally, Host Landscape reflects the monitoring state determined by ADI discovery results:

• Hosts with discovered entities are monitored according to the applied ADI configuration.
• Hosts without discovered entities are displayed with:
  • Monitoring Status: No Entities
  • Host Monitoring Status: Not Monitored

Relationship with Host Landscape

• OmniAgent runs on the host and executes monitoring tasks
• The platform processes collected data
• Host Landscape displays:
  • Host inventory
  • Entity discovery
  • Monitoring status
  • OmniAgent and probe health

This creates a unified workflow where execution happens on the host and visibility is provided through the platform.

Reference to Host Landscape Documentation

Detailed information about:

• Host Landscape tabs
• Filters and actions
• Monitoring workflows
• Discovery and onboarding behavior

is available in the Auto Discovery Instrumentation / Host Landscape User Guide. Refer to Auto Discovery Instrumentation / Host Landscape Documentation.