Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Products Best Practices Hardware Guides Products A-Z
Summary
By Solution
By 4D Pillars
By Cloud
All Products
Secure Networking
Unified SASE
Security Operations
Secure SD-WAN
Secure Access Service Edge (SASE)
ZTNA
LAN Edge
Identity and Access Management
Next Generation Firewall
Web Application Firewall
Public Cloud
Private Cloud
FortiCloud
Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
    • More >>
    Unified SASE
  • Single Vendor SASE
  • Cloud Network Security
  • Secure Endpoint Connectivity
  • Web Application / API Protection
    • More >>
    Security Operations
  • Security Operations Automation
  • Identity
  • Early Detection & Prevention
    • More >>
    Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
  • Communication & Surveillance
    • Unified SASE
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Cloud Network Security
  • Cloud-Native Security
  • Web Application / API Protection
    • Security Operations
  • Security Operations Automation
  • Endpoint
  • Data Protection
  • Identity
  • Email
  • Early Detection & Prevention
  • Expert Services
  • Edge Firewall
  • Orchestration & management
  • SD Branch
  • Application Delivery
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Secure Private Access
  • Thin Edge
  • Identity
  • Application Gateway
  • Enterprise Asset Management
  • Endpoint Agent
  • Agentless Security Posture
  • Identity
  • Wireless
  • Switching
  • Identity
  • Privilege Acccess Management
  • Next Generation Firewall
  • Orchestration & management
  • Expert Services
  • Web Application / API Protection
  • All
  • All
  • Account Management
  • SAAS Management
  • SAAS Application Security
  • Managed Services
  • Platform as a service (PAAS)
  • Other SAAS Services
    • 4D Resources
    Solution Hubs
  • 4D Pillars
  • Cloud
  • Popular Solutions
    • All Products

    User Guide

    26.1.0
    26.1.0

    Manage and configure your OnSight vCollector

    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:

    onsight [OPTIONS] COMMAND [ARGS]

    To see the available commands, run:

    onsight --help

    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 FortiMonitor 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 FortiMonitor 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.

    list-proxy

    List proxy server .

    set-proxy

    Set the proxy server.

    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 NTP server configuration .
    ncm-uninstall Uninstalls the NCM. This command is only applicable if you are using NCM.

    agent-install

    Installs an Agent.

    agent-uninstall

    Uninstalls the Agent.
    Previous
    Next

    Manage and configure your OnSight vCollector

    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:

    onsight [OPTIONS] COMMAND [ARGS]

    To see the available commands, run:

    onsight --help

    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 FortiMonitor 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 FortiMonitor 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.

    list-proxy

    List proxy server .

    set-proxy

    Set the proxy server.

    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 NTP server configuration .
    ncm-uninstall Uninstalls the NCM. This command is only applicable if you are using NCM.

    agent-install

    Installs an Agent.

    agent-uninstall

    Uninstalls the Agent.
    Previous
    Next