Skip to content

Add Nessus quick-start documentation #1023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rksharma-owg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Nessus quick-start documentation #1023

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/api/nessus/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,33 @@ Tenable Nessus
The Nessus Package is currently a Technology Preview


Quick start
-----------

The following example connects to a Nessus server, displays its server type,
and lists the available scans:

.. code-block:: python

from tenable.nessus import Nessus

access_key = 'access-key-in-hex-goes-here'
secret_key = 'secret-key-in-hex-goes-here'

client = Nessus(
url='https://nessus.example.com:8834/',
access_key=access_key,
secret_key=secret_key,
)

properties = client.server.properties()
print(properties['nessus_type'])

for scan in client.scans.list()['scans']:
print(
f"{scan['name']} - {scan['status']} - "
f"{scan['scan_type']} - {scan['creation_date']}"
)


.. automodule:: tenable.nessus.api