Manage and configure your OnSight vCollector

This page is only applicable to OnSight versions 2020.51 and later.

The OnSight comes bundled with a set of CLI commands to manage and configure the OnSight. The commands utilize the following structure:

To see the available commands, run:

Management and configuration commands

The available OnSight management and configuration commands are described in the following table:

Command

Use this to

check-upgrade

Check to see if a newer vCollector is available

configure-vcollector

onsight configure-vcollector [OPTIONS]

where [OPTIONS] are:

  • --enable-agent-proxy – Enable the Agent proxy in the OnSight.

  • --disable-agent-proxy – Disable the Agent proxy in the OnSight

  • --appliance-key [KEY] – Set the Appliance key to use if already registered.

  • --customer-key [KEY]  – Set the Customer key from Panopta account.

  • --aggregator-url [URL] – Set the Aggregator URL to use for syncing.

  • --name [NAME] – Set the name to use when registering the new OnSight.

  • --help – Show this message and exit.

logs

Retrieves the OnSight logs and adds them to a zip file locally. You also have the option to send the logs to our support team. To use this command, run:

onsight logs [OPTIONS]

where [OPTIONS] are:

  • --upload – Sends the logs to Panopta Customer Support team.

  • --filter TEXT – Filters the log files by name. You can use regular expressions as a filter and any log with a name that matches the given regex will be added to the zip file.

  • --age TEXT – Filters how many days of logs to be retrieved and added to the zip file.

Running the onsight logs command without any option will create a zip file of all of the logs in your current directory.

register

Register a new OnSight and generate an appliance key.

shell

Open a shell connection to the collector.

start-vcollector

Start the OnSight vCollector container.

status

Get the current status of the OnSight and its components

uninstall

Uninstall the OnSight.

upgrade

Upgrade to the latest version of the OnSight vCollector.

configure-ntp

Configure the OnSight to use an internal NTP server. This command is only applicable to OnSight virtual image installations. To use this command, see https://confluence-panopta.atlassian.net/wiki/spaces/PD/pages/686194708/OnSight+virtual+image+installation#NTP-server-configuration .