Nessus

Details

ID	`Nessus`
Provider	Tenable
Category	Vulnerability Management
From Version	5.0.0
Supported Modules	Agentix XSIAM

README

nessus-list-scans

Returns the scan list

Base Command

nessus-list-scans

Input

Argument Name	Description	Required
foldersHeaders	The table’s headers to be shown by order.	Optional
scansHeaders	The table’s headers to be shown by order.	Optional

Context Output

Path	Type	Description
NessusScan.UUID	unknown	The uuid for the scan.
NessusScan.Name	unknown	The name of the scan.
NessusScan.Status	unknown	The status of the scan.
NessusScan.FolderID	unknown	The unique id of the folder housing the scan.
NessusScan.ID	unknown	The unique id of the scan.
NessusScan.UserPermissions	unknown	The sharing permissions for the scan.
NessusScan.CreationDate	unknown	The creation date for the scan in unixtime.
NessusScan.LastModificationDate	unknown	The last modification date for the scan in unixtime.
NessusScan.Type	unknown	The type of scan (local, remote, or agent).
NessusScan.Policy	unknown	The policy if the scan.
NessusFolder.UnreadCount	unknown	The number of unread scans in the folder.
NessusFolder.Custom	unknown	The custom status of the folder (1 or 0).
NessusFolder.DefaultTag	unknown	Whether or not the folder is the default (1 or 0).
NessusFolder.Type	unknown	The type of the folder (main, trash, custom).
NessusFolder.Name	unknown	The name of the folder.
NessusFolder.ID	unknown	The unique id of the folder.

nessus-launch-scan

Launches a new vulnerability scan

Base Command

nessus-launch-scan

Input

Argument Name	Description	Required
scanId	The Scan ID (use command list-scans to get possible scan ID’s).	Required
targets	If specified, these targets will be scanned instead of the default. Value can be single host or of comma separated targets.	Optional

Context Output

Path	Type	Description
ScanUUID	unknown	The uuid of the launched scan.

nessus-scan-details

Returns details for the given scan

Base Command

nessus-scan-details

Input

Argument Name	Description	Required
scanId	The Scan ID (use command list-scans to get possible scan ID’s).	Required
historyId	The history_id of the historical data that should be returned.	Optional
tables	The tables to be shown by order.	Optional

Context Output

Path	Type	Description
NessusScan.UUID	unknown	The uuid for the scan.
NessusScan.Name	unknown	The name of the scan.
NessusScan.Status	unknown	The status of the scan.
NessusScan.FolderID	unknown	The unique id of the folder housing the scan.
NessusScan.ID	unknown	The unique id of the scan.
NessusScan.UserPermissions	unknown	The sharing permissions for the scan.
NessusScan.CreationDate	unknown	The creation date for the scan in unixtime.
NessusScan.LastModificationDate	unknown	The last modification date for the scan in unixtime.
NessusScan.Type	unknown	The type of scan (local, remote, or agent).
NessusScan.Policy	unknown	The policy if the scan.
NessusScan.Endpoint.ID	unknown	The unique id of the host.
NessusScan.Endpoint.Index	unknown	The index for the host.
NessusScan.Endpoint.Hostname	unknown	The overall severity rating of the host.
NessusScan.Endpoint.Progress	unknown	The scan progress of the host.
NessusScan.Endpoint.Critical	unknown	The percentage of critical findings on the host.
NessusScan.Endpoint.High	unknown	The percentage of high findings on the host.
NessusScan.Endpoint.Medium	unknown	The percentage of medium findings on the host.
NessusScan.Endpoint.Low	unknown	The percentage of low findings on the host.
NessusScan.Endpoint.Info	unknown	The percentage of info findings on the host.
NessusScan.Endpoint.TotalChecksConsidered	unknown	The total number of checks considered on the host.
NessusScan.Endpoint.NumChecksConsidered	unknown	The number of checks considered on the host.
NessusScan.Endpoint.ScanProgressTotal	unknown	The total scan progress for the host.
NessusScan.Endpoint.ScanProgressCurrent	unknown	The current scan progress for the host.
NessusScan.Endpoint.Score	unknown	The overall score for the host.
NessusScan.Vulnerability.PluginID	unknown	The unique id of the vulnerability plugin.
NessusScan.Vulnerability.PluginName	unknown	The name of the vulnerability plugin.
NessusScan.Vulnerability.PluginFamily	unknown	The parent family of the vulnerability plugin.
NessusScan.Vulnerability.Count	unknown	The number of vulnerabilities found.
NessusScan.Vulnerability.VulnerabilityIndex	unknown	The index of the vulnerability plugin.
NessusScan.Vulnerability.SeverityIndex	unknown	The severity index order of the plugin.
NessusScan.Note.Title	unknown	The title of the note.
NessusScan.Note.Message	unknown	The specific message of the note.
NessusScan.Note.Sevirity	unknown	The severity of the note.
NessusScan.Filter.Name	unknown	The short name of the filter.
NessusScan.Filter.ReadableName	unknown	The long name of the filter.
NessusScan.Filter.Operators	unknown	The comparison options for the filter.
NessusScan.Filter.Type	unknown	The input type for the filter.
NessusScan.Filter.ReadableRegest	unknown	The input placeholder for the filter.
NessusScan.Filter.Regex	unknown	The input regex values for the filter.
NessusScan.Filter.Options	unknown	Other input options for the filter.
NessusScan.History.ID	unknown	The unique id of the historical data.
NessusScan.History.UUID	unknown	The uuid of the historical data.
NessusScan.History.OwnerID	unknown	The unique id of the owner of the scan.
NessusScan.History.Status	unknown	The status of the historical data.
NessusScan.History.CreationDate	unknown	The creation date for the historical data in unixtime.
NessusScan.History.LastModification_date	unknown	The last modification date for the historical data in unixtime.
NessusScan.Remediations.Remediations	unknown	Remedy to vulnerabilites found during the scan.
NessusScan.Remediations.NumHosts	unknown	Number of hosts of Remediations
NessusScan.Remediations.NumCVEs	unknown	Number of CVE’s
NessusScan.Remediations.NumImpactedHosts	unknown	Number of impacted hosts
NessusScan.Remediations.NumRemediatedCVEs	unknown	Number of Remediated CVE’s

nessus-scan-host-details

Returns details for the given host.

Base Command

nessus-scan-host-details

Input

Argument Name	Description	Required
scanId	The Scan ID (use command list-scans to get possible scan ID’s).	Required
historyId	The history_id of the historical data that should be returned.	Optional
hostId	The id of the host to retrieve.	Required

Context Output

Path	Type	Description
Endpoint.ID	unknown	The unique id of the host.
Endpoint.Index	unknown	The index for the host.
Endpoint.Hostname	unknown	The overall severity rating of the host.
Endpoint.Progress	unknown	The scan progress of the host.
Endpoint.Critical	unknown	The percentage of critical findings on the host.
Endpoint.High	unknown	The percentage of high findings on the host.
Endpoint.Medium	unknown	The percentage of medium findings on the host.
Endpoint.Low	unknown	The percentage of low findings on the host.
Endpoint.Info	unknown	The percentage of info findings on the host.
Endpoint.TotalChecksConsidered	unknown	The total number of checks considered on the host.
Endpoint.NumChecksConsidered	unknown	The number of checks considered on the host.
Endpoint.ScanProgressTotal	unknown	The total scan progress for the host.
Endpoint.ScanProgressCurrent	unknown	The current scan progress for the host.
Endpoint.Score	unknown	The overall score for the host.

nessus-scan-export

Export the given scan (Nessus, HTML, PDF, CSV, or DB format)

Base Command

nessus-scan-export

Input

Argument Name	Description	Required
scanId	The Scan ID (use command list-scans to get possible scan ID’s).	Required
historyId	The history_id of the historical data that should be returned.	Optional
format	scan report file format (nessus, csv, html, db, pdf).	Required
password	The password used to encrypt database exports (*Required when exporting as DB).	Optional
chapters	The chapters to include in the export (expecting a semi-colon delimited string comprised of some combination of the following options: vuln_hosts_summary, vuln_by_host, compliance_exec, remediations, vuln_by_plugin, compliance).	Optional

Context Output

Path	Type	Description
ScanReportID	unknown	ID of the scan report.

nessus-scan-report-download

Download an exported scan

Base Command

nessus-scan-report-download

Input

Argument Name	Description	Required
scanId	The Scan ID (use command list-scans to get possible scan ID’s).	Required
fileId	The id of the file to download (result from command export-scan).	Required

Context Output

There is no context output for this command.

nessus-scan-create

Creates a new scan

Base Command

nessus-scan-create

Input

Argument Name	Description	Required
editor	The uuid for the editor template to use.	Required
name	The name of the scan.	Required
description	The description of the scan.	Optional
policyId	The unique id of the policy to use(number).	Optional
folderId	The unique id of the destination folder for the scan(number).	Optional
scannerId	The unique id of the scanner to use(number).	Optional
schedule	If true, the schedule for the scan is enabled(true/false).	Required
launch	When to launch the scan. (i.e. ON_DEMAND, DAILY, WEEKLY, MONTHLY, YEARLY).	Optional
startTime	The starting time and date for the scan (i.e. YYYYMMDDTHHMMSS).	Optional
rules	Expects a semi-colon delimited string comprised of three values. The frequency (FREQ=ONCE or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 … x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). To create a scan that runs every three weeks on Monday Wednesday and Friday the string would be ‘FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR’.	Optional
timeZone	The timezone for the scan schedule.	Optional
targets	The list of targets to scan, Value can be single host or of comma separated targets.	Required
emails	A comma separated list of accounts who will recieve the email summary report.	Optional
acls	An array containing permissions to apply to the scan.	Optional
fileTargets	The name of a file containing the list of targets to scan.	Optional

Context Output

Path	Type	Description
NessusScan.UUID	unknown	The uuid for the scan.
NessusScan.Name	unknown	The name of the scan.
NessusScan.Status	unknown	The status of the scan.
NessusScan.FolderID	unknown	The unique id of the folder housing the scan.
NessusScan.ID	unknown	The unique id of the scan.
NessusScan.UserPermissions	unknown	The sharing permissions for the scan.
NessusScan.CreationDate	unknown	The creation date for the scan in unixtime.
NessusScan.LastModificationDate	unknown	The last modification date for the scan in unixtime.
NessusScan.Type	unknown	The type of scan (local, remote, or agent).
NessusScan.Policy	unknown	The policy if the scan.

nessus-get-scans-editors

Returns all scan editors template list

Base Command

nessus-get-scans-editors

Input

| Argument Name | Description | Required |
| — | — | — |

Context Output

There is no context output for this command.

nessus-scan-export-status

Check the file status of an exported scan

Base Command

nessus-scan-export-status

Input

Argument Name	Description	Required
scanId	The Scan ID (use command list-scans to get possible scan ID’s).	Required
fileId	The id of the file to download (result from command export-scan).	Required

Context Output

Path	Type	Description
NessusScan.ScanReportStatus	unknown	The status of the scan report.

nessus-scan-status

Get scan status by scan id

Base Command

nessus-scan-status

Input

Argument Name	Description	Required
scanId	The Scan ID (use command list-scans to get possible scan ID’s).	Required

Context Output

Path	Type	Description
NessusScan.Status	unknown	The status of the scan report.

Configuration parameters

url — Server Url (format : https://127.0.0.1:8834) (required)
username — Username
password — Password
credentials — Username
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings

Commands (18)

nessus-get-scans-editors
Returns all scan editors template list.
nessus-launch-scan
Launches a new vulnerability scan
nessus-list-scans
Returns the scan list
nessus-scan-create
Creates a new scan.
nessus-scan-details
Returns details for the given scan.
nessus-scan-export
Export the given scan (Nessus, HTML, PDF, CSV, or DB format).
nessus-scan-export-status
Check the file status of an exported scan.
nessus-scan-host-details
Returns details for the given host.
nessus-scan-report-download
Download an exported scan.
nessus-scan-status
Get scan status by scan id.
scan-create Deprecated
Creates a new scan.
scan-details Deprecated
Returns details for the given scan.
scan-export Deprecated
Export the given scan (Nessus, HTML, PDF, CSV, or DB format).
scan-export-status Deprecated
Check the file status of an exported scan.
scan-host-details Deprecated
Returns details for the given host.
scan-launch Deprecated
Launches a new vulnerability scan
scan-report-download Deprecated
Download an exported scan.
scans-list Deprecated
Returns the scan list

Source

Nessus.js Nessus.yml Nessus_description.md

Download History Raw

commonfields:
  id: Nessus
  version: -1
sectionorder:
- Connect
name: Nessus
display: Nessus
category: Vulnerability Management
provider: Tenable
description: Vulnerability scanner for auditors and security analysts by Tenable Network Security.
configuration:
- display: 'Server Url (format : https://127.0.0.1:8834)'
  name: url
  defaultvalue: ""
  type: 0
  required: true
  section: Connect
- display: Username
  name: username
  defaultvalue: ""
  type: 0
  hidden: true
  required: false
  section: Connect
- display: Password
  name: password
  defaultvalue: ""
  type: 4
  hidden: true
  required: false
  section: Connect
- display: Username
  name: credentials
  type: 9
  displaypassword: Password
  section: Connect
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
  section: Connect
- display: Use system proxy settings
  name: proxy
  defaultvalue: "false"
  type: 8
  required: false
  section: Connect
script:
  script: ''
  type: javascript
  commands:
  - name: nessus-list-scans
    arguments:
    - name: foldersHeaders
      description: The table's headers to be shown by order.
    - name: scansHeaders
      description: The table's headers to be shown by order.
    outputs:
    - contextPath: NessusScan.UUID
      description: The uuid for the scan.
    - contextPath: NessusScan.Name
      description: The name of the scan.
    - contextPath: NessusScan.Status
      description: The status of the scan.
    - contextPath: NessusScan.FolderID
      description: The unique id of the folder housing the scan.
    - contextPath: NessusScan.ID
      description: The unique id of the scan.
    - contextPath: NessusScan.UserPermissions
      description: The sharing permissions for the scan.
    - contextPath: NessusScan.CreationDate
      description: The creation date for the scan in unixtime.
    - contextPath: NessusScan.LastModificationDate
      description: The last modification date for the scan in unixtime.
    - contextPath: NessusScan.Type
      description: The type of scan (local, remote, or agent).
    - contextPath: NessusScan.Policy
      description: The policy if the scan.
    - contextPath: NessusFolder.UnreadCount
      description: The number of unread scans in the folder.
    - contextPath: NessusFolder.Custom
      description: The custom status of the folder (1 or 0).
    - contextPath: NessusFolder.DefaultTag
      description: Whether or not the folder is the default (1 or 0).
    - contextPath: NessusFolder.Type
      description: The type of the folder (main, trash, custom).
    - contextPath: NessusFolder.Name
      description: The name of the folder.
    - contextPath: NessusFolder.ID
      description: The unique id of the folder.
    description: Returns the scan list
  - name: scans-list
    deprecated: true
    arguments:
    - name: foldersHeaders
      description: The table's headers to be shown by order.
    - name: scansHeaders
      description: The table's headers to be shown by order.
    outputs:
    - contextPath: NessusScan.UUID
      description: The uuid for the scan.
    - contextPath: NessusScan.Name
      description: The name of the scan.
    - contextPath: NessusScan.Status
      description: The status of the scan.
    - contextPath: NessusScan.FolderID
      description: The unique id of the folder housing the scan.
    - contextPath: NessusScan.ID
      description: The unique id of the scan.
    - contextPath: NessusScan.UserPermissions
      description: The sharing permissions for the scan.
    - contextPath: NessusScan.CreationDate
      description: The creation date for the scan in unixtime.
    - contextPath: NessusScan.LastModificationDate
      description: The last modification date for the scan in unixtime.
    - contextPath: NessusScan.Type
      description: The type of scan (local, remote, or agent).
    - contextPath: NessusScan.Policy
      description: The policy if the scan.
    - contextPath: NessusFolder.UnreadCount
      description: The number of unread scans in the folder.
    - contextPath: NessusFolder.Custom
      description: The custom status of the folder (1 or 0).
    - contextPath: NessusFolder.DefaultTag
      description: Whether or not the folder is the default (1 or 0).
    - contextPath: NessusFolder.Type
      description: The type of the folder (main, trash, custom).
    - contextPath: NessusFolder.Name
      description: The name of the folder.
    - contextPath: NessusFolder.ID
      description: The unique id of the folder.
    description: Returns the scan list
  - name: nessus-launch-scan
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: targets
      description: If specified, these targets will be scanned instead of the default. Value can be single host or of comma separated targets.
    outputs:
    - contextPath: ScanUUID
      description: The uuid of the launched scan.
    description: Launches a new vulnerability scan
  - name: scan-launch
    deprecated: true
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: targets
      description: If specified, these targets will be scanned instead of the default. Value can be single host or of comma separated targets.
    outputs:
    - contextPath: ScanUUID
      description: The uuid of the launched scan.
    description: Launches a new vulnerability scan
  - name: nessus-scan-details
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: historyId
      description: The history_id of the historical data that should be returned.
    - name: tables
      description: The tables to be shown by order.
    outputs:
    - contextPath: NessusScan.UUID
      description: The uuid for the scan.
    - contextPath: NessusScan.Name
      description: The name of the scan.
    - contextPath: NessusScan.Status
      description: The status of the scan.
    - contextPath: NessusScan.FolderID
      description: The unique id of the folder housing the scan.
    - contextPath: NessusScan.ID
      description: The unique id of the scan.
    - contextPath: NessusScan.UserPermissions
      description: The sharing permissions for the scan.
    - contextPath: NessusScan.CreationDate
      description: The creation date for the scan in unixtime.
    - contextPath: NessusScan.LastModificationDate
      description: The last modification date for the scan in unixtime.
    - contextPath: NessusScan.Type
      description: The type of scan (local, remote, or agent).
    - contextPath: NessusScan.Policy
      description: The policy if the scan.
    - contextPath: NessusScan.Endpoint.ID
      description: The unique id of the host.
    - contextPath: NessusScan.Endpoint.Index
      description: The index for the host.
    - contextPath: NessusScan.Endpoint.Hostname
      description: The overall severity rating of the host.
    - contextPath: NessusScan.Endpoint.Progress
      description: The scan progress of the host.
    - contextPath: NessusScan.Endpoint.Critical
      description: The percentage of critical findings on the host.
    - contextPath: NessusScan.Endpoint.High
      description: The percentage of high findings on the host.
    - contextPath: NessusScan.Endpoint.Medium
      description: The percentage of medium findings on the host.
    - contextPath: NessusScan.Endpoint.Low
      description: The percentage of low findings on the host.
    - contextPath: NessusScan.Endpoint.Info
      description: The percentage of info findings on the host.
    - contextPath: NessusScan.Endpoint.TotalChecksConsidered
      description: The total number of checks considered on the host.
    - contextPath: NessusScan.Endpoint.NumChecksConsidered
      description: The number of checks considered on the host.
    - contextPath: NessusScan.Endpoint.ScanProgressTotal
      description: The total scan progress for the host.
    - contextPath: NessusScan.Endpoint.ScanProgressCurrent
      description: The current scan progress for the host.
    - contextPath: NessusScan.Endpoint.Score
      description: The overall score for the host.
    - contextPath: NessusScan.Vulnerability.PluginID
      description: The unique id of the vulnerability plugin.
    - contextPath: NessusScan.Vulnerability.PluginName
      description: The name of the vulnerability plugin.
    - contextPath: NessusScan.Vulnerability.PluginFamily
      description: The parent family of the vulnerability plugin.
    - contextPath: NessusScan.Vulnerability.Count
      description: The number of vulnerabilities found.
    - contextPath: NessusScan.Vulnerability.VulnerabilityIndex
      description: The index of the vulnerability plugin.
    - contextPath: NessusScan.Vulnerability.SeverityIndex
      description: The severity index order of the plugin.
    - contextPath: NessusScan.Note.Title
      description: The title of the note.
    - contextPath: NessusScan.Note.Message
      description: The specific message of the note.
    - contextPath: NessusScan.Note.Sevirity
      description: The severity of the note.
    - contextPath: NessusScan.Filter.Name
      description: The short name of the filter.
    - contextPath: NessusScan.Filter.ReadableName
      description: The long name of the filter.
    - contextPath: NessusScan.Filter.Operators
      description: The comparison options for the filter.
    - contextPath: NessusScan.Filter.Type
      description: The input type for the filter.
    - contextPath: NessusScan.Filter.ReadableRegest
      description: The input placeholder for the filter.
    - contextPath: NessusScan.Filter.Regex
      description: The input regex values for the filter.
    - contextPath: NessusScan.Filter.Options
      description: Other input options for the filter.
    - contextPath: NessusScan.History.ID
      description: The unique id of the historical data.
    - contextPath: NessusScan.History.UUID
      description: The uuid of the historical data.
    - contextPath: NessusScan.History.OwnerID
      description: The unique id of the owner of the scan.
    - contextPath: NessusScan.History.Status
      description: The status of the historical data.
    - contextPath: NessusScan.History.CreationDate
      description: The creation date for the historical data in unixtime.
    - contextPath: NessusScan.History.LastModification_date
      description: The last modification date for the historical data in unixtime.
    - contextPath: NessusScan.Remediations.Remediations
      description: Remedy to vulnerabilites found during the scan.
    - contextPath: NessusScan.Remediations.NumHosts
      description: Number of hosts of Remediations.
    - contextPath: NessusScan.Remediations.NumCVEs
      description: Number of CVE's.
    - contextPath: NessusScan.Remediations.NumImpactedHosts
      description: Number of impacted hosts.
    - contextPath: NessusScan.Remediations.NumRemediatedCVEs
      description: Number of Remediated CVE's.
    description: Returns details for the given scan.
  - name: scan-details
    deprecated: true
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: historyId
      description: The history_id of the historical data that should be returned.
    - name: tables
      description: The tables to be shown by order.
    outputs:
    - contextPath: NessusScan.UUID
      description: The uuid for the scan.
    - contextPath: NessusScan.Name
      description: The name of the scan.
    - contextPath: NessusScan.Status
      description: The status of the scan.
    - contextPath: NessusScan.FolderID
      description: The unique id of the folder housing the scan.
    - contextPath: NessusScan.ID
      description: The unique id of the scan.
    - contextPath: NessusScan.UserPermissions
      description: The sharing permissions for the scan.
    - contextPath: NessusScan.CreationDate
      description: The creation date for the scan in unixtime.
    - contextPath: NessusScan.LastModificationDate
      description: The last modification date for the scan in unixtime.
    - contextPath: NessusScan.Type
      description: The type of scan (local, remote, or agent).
    - contextPath: NessusScan.Policy
      description: The policy if the scan.
    - contextPath: Endpoint.ID
      description: The unique id of the host.
    - contextPath: Endpoint.Index
      description: The index for the host.
    - contextPath: Endpoint.Hostname
      description: The overall severity rating of the host.
    - contextPath: Endpoint.Progress
      description: The scan progress of the host.
    - contextPath: Endpoint.Critical
      description: The percentage of critical findings on the host.
    - contextPath: Endpoint.High
      description: The percentage of high findings on the host.
    - contextPath: Endpoint.Medium
      description: The percentage of medium findings on the host.
    - contextPath: Endpoint.Low
      description: The percentage of low findings on the host.
    - contextPath: Endpoint.Info
      description: The percentage of info findings on the host.
    - contextPath: Endpoint.TotalChecksConsidered
      description: The total number of checks considered on the host.
    - contextPath: Endpoint.NumChecksConsidered
      description: The number of checks considered on the host.
    - contextPath: Endpoint.ScanProgressTotal
      description: The total scan progress for the host.
    - contextPath: Endpoint.ScanProgressCurrent
      description: The current scan progress for the host.
    - contextPath: Endpoint.Score
      description: The overall score for the host.
    - contextPath: Vulnerability.PluginID
      description: The unique id of the vulnerability plugin.
    - contextPath: Vulnerability.PluginName
      description: The name of the vulnerability plugin.
    - contextPath: Vulnerability.PluginFamily
      description: The parent family of the vulnerability plugin.
    - contextPath: Vulnerability.Count
      description: The number of vulnerabilities found.
    - contextPath: Vulnerability.VulnerabilityIndex
      description: The index of the vulnerability plugin.
    - contextPath: Vulnerability.SeverityIndex
      description: The severity index order of the plugin.
    - contextPath: Note.Title
      description: The title of the note.
    - contextPath: Note.Message
      description: The specific message of the note.
    - contextPath: Note.Sevirity
      description: The severity of the note.
    - contextPath: Filter.Name
      description: The short name of the filter.
    - contextPath: Filter.ReadableName
      description: The long name of the filter.
    - contextPath: Filter.Operators
      description: The comparison options for the filter.
    - contextPath: Filter.Type
      description: The input type for the filter.
    - contextPath: Filter.ReadableRegest
      description: The input placeholder for the filter.
    - contextPath: Filter.Regex
      description: The input regex values for the filter.
    - contextPath: Filter.Options
      description: Other input options for the filter.
    - contextPath: History.ID
      description: The unique id of the historical data.
    - contextPath: History.UUID
      description: The uuid of the historical data.
    - contextPath: History.OwnerID
      description: The unique id of the owner of the scan.
    - contextPath: History.Status
      description: The status of the historical data.
    - contextPath: History.CreationDate
      description: The creation date for the historical data in unixtime.
    - contextPath: History.LastModification_date
      description: The last modification date for the historical data in unixtime.
    - contextPath: Remediations.Remediations
      description: Remedy to vulnerabilites found during the scan.
    - contextPath: Remediations.NumHosts
      description: Number of hosts of Remediations.
    - contextPath: Remediations.NumCVEs
      description: Number of CVE's.
    - contextPath: Remediations.NumImpactedHosts
      description: Number of impacted hosts.
    - contextPath: Remediations.NumRemediatedCVEs
      description: Number of Remediated CVE's.
    description: Returns details for the given scan.
  - name: scan-host-details
    deprecated: true
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: historyId
      description: The history_id of the historical data that should be returned.
    - name: hostId
      required: true
      description: The id of the host to retrieve.
    outputs:
    - contextPath: Endpoint.ID
      description: The unique id of the host.
    - contextPath: Endpoint.Index
      description: The index for the host.
    - contextPath: Endpoint.Hostname
      description: The overall severity rating of the host.
    - contextPath: Endpoint.Progress
      description: The scan progress of the host.
    - contextPath: Endpoint.Critical
      description: The percentage of critical findings on the host.
    - contextPath: Endpoint.High
      description: The percentage of high findings on the host.
    - contextPath: Endpoint.Medium
      description: The percentage of medium findings on the host.
    - contextPath: Endpoint.Low
      description: The percentage of low findings on the host.
    - contextPath: Endpoint.Info
      description: The percentage of info findings on the host.
    - contextPath: Endpoint.TotalChecksConsidered
      description: The total number of checks considered on the host.
    - contextPath: Endpoint.NumChecksConsidered
      description: The number of checks considered on the host.
    - contextPath: Endpoint.ScanProgressTotal
      description: The total scan progress for the host.
    - contextPath: Endpoint.ScanProgressCurrent
      description: The current scan progress for the host.
    - contextPath: Endpoint.Score
      description: The overall score for the host.
    description: Returns details for the given host.
  - name: nessus-scan-host-details
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: historyId
      description: The history_id of the historical data that should be returned.
    - name: hostId
      required: true
      description: The id of the host to retrieve.
    outputs:
    - contextPath: Endpoint.ID
      description: The unique id of the host.
    - contextPath: Endpoint.Index
      description: The index for the host.
    - contextPath: Endpoint.Hostname
      description: The overall severity rating of the host.
    - contextPath: Endpoint.Progress
      description: The scan progress of the host.
    - contextPath: Endpoint.Critical
      description: The percentage of critical findings on the host.
    - contextPath: Endpoint.High
      description: The percentage of high findings on the host.
    - contextPath: Endpoint.Medium
      description: The percentage of medium findings on the host.
    - contextPath: Endpoint.Low
      description: The percentage of low findings on the host.
    - contextPath: Endpoint.Info
      description: The percentage of info findings on the host.
    - contextPath: Endpoint.TotalChecksConsidered
      description: The total number of checks considered on the host.
    - contextPath: Endpoint.NumChecksConsidered
      description: The number of checks considered on the host.
    - contextPath: Endpoint.ScanProgressTotal
      description: The total scan progress for the host.
    - contextPath: Endpoint.ScanProgressCurrent
      description: The current scan progress for the host.
    - contextPath: Endpoint.Score
      description: The overall score for the host.
    description: Returns details for the given host.
  - name: nessus-scan-export
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: historyId
      description: The history_id of the historical data that should be returned.
    - name: format
      required: true
      description: scan report file format (nessus, csv, html, db, pdf).
    - name: password
      description: The password used to encrypt database exports (*Required when exporting as DB).
    - name: chapters
      description: 'The chapters to include in the export (expecting a semi-colon delimited string comprised of some combination of the following options: vuln_hosts_summary, vuln_by_host, compliance_exec, remediations, vuln_by_plugin, compliance).'
    outputs:
    - contextPath: ScanReportID
      description: ID of the scan report.
    description: Export the given scan (Nessus, HTML, PDF, CSV, or DB format).
  - name: scan-export
    deprecated: true
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: historyId
      description: The history_id of the historical data that should be returned.
    - name: format
      required: true
      description: scan report file format (nessus, csv, html, db, pdf).
    - name: password
      description: The password used to encrypt database exports (*Required when exporting as DB).
    - name: chapters
      description: 'The chapters to include in the export (expecting a semi-colon delimited string comprised of some combination of the following options: vuln_hosts_summary, vuln_by_host, compliance_exec, remediations, vuln_by_plugin, compliance).'
    outputs:
    - contextPath: ScanReportID
      description: ID of the scan report.
    description: Export the given scan (Nessus, HTML, PDF, CSV, or DB format).
  - name: scan-report-download
    deprecated: true
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: fileId
      required: true
      description: The id of the file to download (result from command export-scan).
    description: Download an exported scan.
  - name: nessus-scan-report-download
    arguments:
    - name: scanId
      required: true
      default: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: fileId
      required: true
      description: The id of the file to download (result from command export-scan).
    description: Download an exported scan.
  - name: scan-create
    deprecated: true
    arguments:
    - name: editor
      required: true
      default: true
      description: The uuid for the editor template to use.
    - name: name
      required: true
      description: The name of the scan.
    - name: description
      description: The description of the scan.
    - name: policyId
      description: The unique id of the policy to use(number).
    - name: folderId
      description: The unique id of the destination folder for the scan(number).
    - name: scannerId
      description: The unique id of the scanner to use(number).
    - name: schedule
      required: true
      description: If true, the schedule for the scan is enabled(true/false).
    - name: launch
      description: When to launch the scan. (i.e. ON_DEMAND, DAILY, WEEKLY, MONTHLY, YEARLY).
    - name: startTime
      description: The starting time and date for the scan (i.e. YYYYMMDDTHHMMSS).
    - name: rules
      description: Expects a semi-colon delimited string comprised of three values. The frequency (FREQ=ONCE or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). To create a scan that runs every three weeks on Monday Wednesday and Friday the string would be 'FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR'.
    - name: timeZone
      description: The timezone for the scan schedule.
    - name: targets
      required: true
      description: The list of targets to scan, Value can be single host or of comma separated targets.
    - name: emails
      description: A comma separated list of accounts who will receive the email summary report.
    - name: acls
      description: An array containing permissions to apply to the scan.
    - name: fileTargets
      description: The name of a file containing the list of targets to scan.
    outputs:
    - contextPath: NessusScan.UUID
      description: The uuid for the scan.
    - contextPath: NessusScan.Name
      description: The name of the scan.
    - contextPath: NessusScan.Status
      description: The status of the scan.
    - contextPath: NessusScan.FolderID
      description: The unique id of the folder housing the scan.
    - contextPath: NessusScan.ID
      description: The unique id of the scan.
    - contextPath: NessusScan.UserPermissions
      description: The sharing permissions for the scan.
    - contextPath: NessusScan.CreationDate
      description: The creation date for the scan in unixtime.
    - contextPath: NessusScan.LastModificationDate
      description: The last modification date for the scan in unixtime.
    - contextPath: NessusScan.Type
      description: The type of scan (local, remote, or agent).
    - contextPath: NessusScan.Policy
      description: The policy if the scan.
    description: Creates a new scan.
  - name: nessus-scan-create
    arguments:
    - name: editor
      required: true
      default: true
      description: The uuid for the editor template to use.
    - name: name
      required: true
      description: The name of the scan.
    - name: description
      description: The description of the scan.
    - name: policyId
      description: The unique id of the policy to use(number).
    - name: folderId
      description: The unique id of the destination folder for the scan(number).
    - name: scannerId
      description: The unique id of the scanner to use(number).
    - name: schedule
      required: true
      description: If true, the schedule for the scan is enabled(true/false).
    - name: launch
      description: When to launch the scan. (i.e. ON_DEMAND, DAILY, WEEKLY, MONTHLY, YEARLY).
    - name: startTime
      description: The starting time and date for the scan (i.e. YYYYMMDDTHHMMSS).
    - name: rules
      description: Expects a semi-colon delimited string comprised of three values. The frequency (FREQ=ONCE or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). To create a scan that runs every three weeks on Monday Wednesday and Friday the string would be 'FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR'.
    - name: timeZone
      description: The timezone for the scan schedule.
    - name: targets
      required: true
      description: The list of targets to scan, Value can be single host or of comma separated targets.
    - name: emails
      description: A comma separated list of accounts who will receive the email summary report.
    - name: acls
      description: An array containing permissions to apply to the scan.
    - name: fileTargets
      description: The name of a file containing the list of targets to scan.
    outputs:
    - contextPath: NessusScan.UUID
      description: The uuid for the scan.
    - contextPath: NessusScan.Name
      description: The name of the scan.
    - contextPath: NessusScan.Status
      description: The status of the scan.
    - contextPath: NessusScan.FolderID
      description: The unique id of the folder housing the scan.
    - contextPath: NessusScan.ID
      description: The unique id of the scan.
    - contextPath: NessusScan.UserPermissions
      description: The sharing permissions for the scan.
    - contextPath: NessusScan.CreationDate
      description: The creation date for the scan in unixtime.
    - contextPath: NessusScan.LastModificationDate
      description: The last modification date for the scan in unixtime.
    - contextPath: NessusScan.Type
      description: The type of scan (local, remote, or agent).
    - contextPath: NessusScan.Policy
      description: The policy if the scan.
    description: Creates a new scan.
  - name: nessus-get-scans-editors
    arguments: []
    description: Returns all scan editors template list.
  - name: scan-export-status
    deprecated: true
    arguments:
    - name: scanId
      required: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: fileId
      required: true
      description: The id of the file to download (result from command export-scan).
    outputs:
    - contextPath: NessusScan.ScanReportStatus
      description: The status of the scan report.
    description: Check the file status of an exported scan.
  - name: nessus-scan-export-status
    arguments:
    - name: scanId
      required: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    - name: fileId
      required: true
      description: The id of the file to download (result from command export-scan).
    outputs:
    - contextPath: NessusScan.ScanReportStatus
      description: The status of the scan report.
    description: Check the file status of an exported scan.
  - name: nessus-scan-status
    description: Get scan status by scan id.
    arguments:
    - name: scanId
      required: true
      description: The Scan ID (use command list-scans to get possible scan ID's).
    outputs:
    - contextPath: NessusScan.Status
      description: The status of the scan report.
tests:
- Nessus - Test
fromversion: 5.0.0