OmniAgent Service and CLI Management

Service Management

Managing the OmniAgent Service

After installation, OmniAgent can be controlled using the following commands:

Start OmniAgent

omniagent start

Starts the OmniAgent service. If any probes were previously added, they are started automatically when OmniAgent starts.

Stop OmniAgent

omniagent stop

Stops the OmniAgent service and terminates all running probe processes managed by the agent.

Restart OmniAgent

omniagent restart

Restarts the OmniAgent service. All managed probes are restarted as part of this process.

Check OmniAgent Status

omniagent status

Displays the current state of the OmniAgent service (running or stopped).

CLI Management

OmniAgent CTL

The omniagentctl provides a comprehensive interface for managing probes through the OmniAgent. It serves as the central control utility to monitor, configure, and manage probes effectively from the command line.

It allows you to:

• Monitor probe health and operational status.
• Create, start, stop, and uninstall probes.
• View, apply, and manage configuration files.
• Apply and manage probe packages.
• Retrieve version and configuration information.

Starting the OmniAgent CTL Shell

You can start the OmniAgent CTL shell by simply running:

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).On Windows, add the .exe extension when running commands.

• Example:
  • Linux: 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 working directory. 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.

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.

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.

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.

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.

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.

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.

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