TOC & Recently Viewed

Recently Viewed Topics

Nessuscli Agent

Use the nessuscli agent utility to perform some Nessus Agent functions through a command line interface.

Note: You must run all nessuscli agent commands as a user with administrative privileges.

Nessuscli Agent Syntax

Operating System

Command

Linux

# /opt/nessus_agent/sbin/nessuscli agent <arg1> <arg2>

Mac OS X

# /Library/NessusAgent/run/sbin/nessuscli <arg1> <arg2>

Windows

C:\Program Files\Tenable\Nessus Agent

or

C:\ProgramData\Tenable\Nessus Agent

Run cmd.exe as administrator

Nessuscli Agent Commands

Command Description
Help Commands

# nessuscli agent help

Displays a list of Nessus Agent commands.

Bug Reporting Commands

# nessuscli bug-report-generator

Generates an archive of system diagnostics.

If you run this command without arguments, the utility prompts you for values.

Optional arguments:

--quiet: Run the bug report generator without prompting user for feedback.

--scrub: When in quiet mode, the bug report generator sanitizes the last two octets of the IPv4 address.

--full: When in quiet mode, the bug report generator collects extra data.

Local Agent Commands

Used to link, unlink, and display agent status

# nessuscli agent link --key=<key> --host=<host> --port=<port>

Using the Nessus Agent Linking Key, this command links the agent to the Nessus Manager or Tenable.io.

Required arguments:

--key=<key>

--host=<host>

--port=<port>

Optional arguments:

--name=<name>

--groups=<group1,group2,...>

--ca-path=<ca_file_name>

--offline-install

--proxy-host=<host>

--proxy-port=<port>

--proxy-username=<username>

--proxy-password=<password>

--proxy-agent=<agent>

Tenable.io arguments:

--cloud

# nessuscli agent unlink

Unlinks agent from the Nessus Manager or Tenable.io.

# nessuscli agent update

Used to manually install a plugins set.

Required arguments:

--file=<plugins_set.tgz>

# nessuscli agent status

Displays the status of the agent, jobs pending, and if the agent is linked or not linked to server.

Optional arguments:

--local: Provides the status and current jobs count.

--remote: Fetches the job count from the manager and displays the status.

--offline: Provides the most recently cached agent status when it cannot connect to Nessus Manager or Tenable.io.

Fix Commands
# nessuscli fix --set update_hostname="<value>"

Updates agent hostnames automatically in Tenable.io or Nessus Manager 7.1.1 or later.

The update_hostname parameter can be set to yes or no. By default, this preference is disabled.

Note: Restart the agent service for the change to take affect in Nessus Manager.

# nessuscli fix --set track_unique_agents="<value>"

Tracks unique agent assets by MAC address to prevent duplicates and outdated agents from appearing in Nessus Manager if a system is reinstalled.

The track_unique_agent parameter is available in Nessus 7.1.1 and can be set to yes or no. By default, this preference is enabled.

# nessuscli fix --set max_retries="<value>" Sets the maximum number of times an agent should retry in the event of a failure when executing the agent link, agent status, and agent unlink commands.

Copyright 2017 - 2018 Tenable, Inc. All rights reserved. Tenable Network Security, Nessus, SecurityCenter, SecurityCenter Continuous View and Log Correlation Engine are registered trademarks of Tenable, Inc. Tenable, Tenable.io, Assure, and The Cyber Exposure Company are trademarks of Tenable, Inc. All other products or services are trademarks of their respective owners.