Rapid7 Nexpose

Vulnerability management solution to help reduce threat exposure.

Vulnerability Management · Rapid7 InsightVM

Details

IDRapid7 Nexpose
ProviderRapid7
CategoryVulnerability Management
From Version5.0.0
Docker Imagedemisto/auth-utils:1.0.0.10133006
Supported ModulesAgentix XSIAM EDR Cortex Cloud Cloud Runtime Security Exposure Management

README

Vulnerability management solution to help reduce threat exposure.
This integration was integrated and tested with version 6.6.103 of Rapid7 Nexpose.

Configure Rapid7 InsightVM on Cortex XSOAR

  1. Navigate to Settings > Integrations > Servers & Services.
  2. Search for Rapid7 InsightVM.
  3. Click Add instance to create and configure a new integration instance.

    Parameter Required
    Server URL (e.g., https://192.0.2.0:8080) True
    Username True
    Password True
    2FA Token False
    Trust any certificate (not secure) False
    Use system proxy settings False
  4. Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

nexpose-get-asset


Returns the specified asset.

Base Command

nexpose-get-asset

Input

Argument Name Description Required
id Asset ID. Required

Context Output

Path Type Description
Nexpose.Asset.Addresses unknown All addresses discovered on the asset.
Nexpose.Asset.AssetId number Id of the asset.
Nexpose.Asset.Hardware string The primary Media Access Control (MAC) address of the asset. The format is six groups of two hexadecimal digits separated by colons.
Nexpose.Asset.Aliases unknown All host names or aliases discovered on the asset.
Nexpose.Asset.HostType string The type of asset. Valid values are unknown, guest, hypervisor, physical, mobile
Nexpose.Asset.Site string Asset site name.
Nexpose.Asset.OperatingSystem string Operating system of the asset.
Nexpose.Asset.Vulnerabilities number The total number of vulnerabilities on the asset.
Nexpose.Asset.CPE string The Common Platform Enumeration (CPE) of the operating system.
Nexpose.Asset.LastScanDate date Last scan date of the asset.
Nexpose.Asset.LastScanId number ID of the asset’s last scan.
Nexpose.Asset.RiskScore number The risk score (with criticality adjustments) of the asset.
Nexpose.Asset.Software.Software string The description of the software.
Nexpose.Asset.Software.Version string The version of the software.
Nexpose.Asset.Services.Name string The name of the service.
Nexpose.Asset.Services.Port number The port of the service.
Nexpose.Asset.Services.Product string The product running the service.
Nexpose.Asset.Services.protocol string The protocol of the service, valid values are ip, icmp, igmp, ggp, tcp, pup, udp, idp, esp, nd, raw
Nexpose.Asset.Users.FullName string The full name of the user account.
Nexpose.Asset.Users.Name string The name of the user account.
Nexpose.Asset.Users.UserId number The identifier of the user account.
Nexpose.Asset.Vulnerability.Id number The identifier of the vulnerability.
Nexpose.Asset.Vulnerability.Instances number The number of vulnerable occurrences of the vulnerability. This does not include invulnerable instances.
Nexpose.Asset.Vulnerability.Title string The title (summary) of the vulnerability.
Nexpose.Asset.Vulnerability.Malware number The malware kits that are known to be used to exploit the vulnerability.
Nexpose.Asset.Vulnerability.Exploit number The exploits that can be used to exploit a vulnerability.
Nexpose.Asset.Vulnerability.CVSS string The CVSS exploit score.
Nexpose.Asset.Vulnerability.Risk number The risk score of the vulnerability, rounded to a maximum of to digits of precision. If using the default Rapid7 Real Risk™ model, this value ranges from 0-1000.
Nexpose.Asset.Vulnerability.PublishedOn date The date the vulnerability was first published or announced. The format is an ISO 8601 date, YYYY-MM-DD.
Nexpose.Asset.Vulnerability.ModifiedOn date The last date the vulnerability was modified. The format is an ISO 8601 date, YYYY-MM-DD.
Nexpose.Asset.Vulnerability.Severity string The severity of the vulnerability, one of: “Moderate”, “Severe”, “Critical”.
Endpoint.IP string Endpoint IP address.
Endpoint.HostName string Endpoint host name.
Endpoint.OS string Endpoint operating system.
CVE.ID string Common Vulnerabilities and Exposures IDs.

nexpose-get-asset-tags


Returns the specified tags for an asset.

Base Command

nexpose-get-asset-tags

Input

Argument Name Description Required
asset_id Asset ID. Required

Context Output

Path Type Description
Nexpose.AssetTag.Type string Type of asset tag.
Nexpose.AssetTag.Name string The value of the tag.
Nexpose.AssetTag.CreatedTime string Timestamp of when the tag was created.
Nexpose.AssetTag.RiskModifier string The risk modifier value associated with criticality tag type.

Command example

!nexpose-get-asset-tags asset_id=1

Context Example

{
    "Nexpose":{
        "AssetTag":[
                {
                    "CreatedTime": "2023-00-00T00:00:00.000Z",
                    "Name": "Low",
                    "RiskModifier": "0.75",
                    "Type": "criticality"
                },
                {
                    "CreatedTime": "2023-00-00T00:00:00.000Z",
                    "Name": "FAKELOCATION",
                    "RiskModifier": null,
                    "Type": "location"
                },
                {
                    "CreatedTime": "2023-00-00T00:00:00.000Z",
                    "Name": "FAKEOWNER",
                    "RiskModifier": null,
                    "Type": "owner"
                },
                {
                    "CreatedTime": "2023-00-00T00:00:00.000Z",
                    "Name": "AWS",
                    "RiskModifier": null,
                    "Type": "custom"
                }
            ]
    }
}

Human Readable Output

Nexpose Asset Tags for Asset 1

Type Name Risk Modifier Created Time
criticality Low 0.75 2023-00-00T00:00:00.000Z
location FAKELOCATION   2023-00-00T00:00:00.000Z
owner FAKEOWNER   2023-00-00T00:00:00.000Z
custom AWS   2023-00-00T00:00:00.000Z

nexpose-get-assets


Returns all assets for which you have access.

Base Command

nexpose-get-assets

Input

Argument Name Description Required
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
sort Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a “;”. For example: “riskScore,DESC;hostName,ASC”. Optional
limit A number of records to limit the response to. Default is 10. Optional

Context Output

Path Type Description
Nexpose.Asset.AssetId number The identifier of the asset.
Nexpose.Asset.Address string The primary IPv4 or IPv6 address of the asset.
Nexpose.Asset.Name string The primary host name (local or FQDN) of the asset.
Nexpose.Asset.Site string Asset site name.
Nexpose.Asset.Exploits number The number of distinct exploits that can exploit any of the vulnerabilities on the asset.
Nexpose.Asset.Malware number The number of distinct malware kits that vulnerabilities on the asset are susceptible to.
Nexpose.Asset.OperatingSystem string Operating system of the asset.
Nexpose.Asset.Vulnerabilities number The total number of vulnerabilities.
Nexpose.Asset.RiskScore number The risk score (with criticality adjustments) of the asset.
Nexpose.Asset.Assessed boolean Whether the asset has been assessed for vulnerabilities at least once.
Nexpose.Asset.LastScanDate date Last scan date of the asset.
Nexpose.Asset.LastScanId number Id of the asset’s last scan.
Endpoint.IP string Endpoint IP address.
Endpoint.HostName string Endpoint host name.
Endpoint.OS string Endpoint operating system.

Command example

!nexpose-get-assets limit=3

Context Example

{
    "Endpoint": [
        {
            "Hostname": "pool-96-252-18-158.bstnma.fios.verizon.net",
            "ID": 9,
            "IPAddress": "192.0.2.1",
            "Vendor": "Rapid7 Nexpose"
        },
        {
            "Hostname": "angular.testsparker.com",
            "ID": 11,
            "IPAddress": "192.0.2.2",
            "OS": "Ubuntu Linux",
            "Vendor": "Rapid7 Nexpose"
        },
        {
            "ID": 12,
            "IPAddress": "192.0.2.3",
            "OS": "Microsoft Windows",
            "Vendor": "Rapid7 Nexpose"
        }
    ],
    "Nexpose": {
        "Asset": [
            {
                "Address": "192.0.2.1",
                "Assessed": true,
                "AssetId": 9,
                "Exploits": 0,
                "LastScanDate": "2020-10-01T22:37:33.710Z",
                "LastScanId": 650,
                "Malware": 0,
                "Name": "pool-96-252-18-158.bstnma.fios.verizon.net",
                "OperatingSystem": null,
                "RiskScore": 0,
                "Site": "PANW",
                "Vulnerabilities": 0
            },
            {
                "Address": "192.0.2.2",
                "Assessed": true,
                "AssetId": 11,
                "Exploits": 2,
                "LastScanDate": "2022-11-02T14:54:19.055Z",
                "LastScanId": "-",
                "Malware": 0,
                "Name": "angular.testsparker.com",
                "OperatingSystem": "Ubuntu Linux",
                "RiskScore": 7718.4091796875,
                "Site": "PANW",
                "Vulnerabilities": 26
            },
            {
                "Address": "192.0.2.3",
                "Assessed": true,
                "AssetId": 12,
                "Exploits": 4,
                "LastScanDate": "2049-03-01T04:31:56Z",
                "LastScanId": "-",
                "Malware": 0,
                "Name": null,
                "OperatingSystem": "Microsoft Windows",
                "RiskScore": 18819.919921875,
                "Site": "PANW",
                "Vulnerabilities": 45
            }
        ]
    }
}

Human Readable Output

Nexpose Asset 12

AssetId Address Site Exploits Malware OperatingSystem Vulnerabilities RiskScore Assessed LastScanDate LastScanId
12 192.0.2.3 PANW 4 0 Microsoft Windows 45 18819.919921875 true 2049-03-01T04:31:56Z -

nexpose-search-assets


Search and return all assets matching specific filters. Returns only assets the user has access to.

Base Command

nexpose-search-assets

Input

Argument Name Description Required
query Queries to use as a filter, according to the Search Criteria API standard. Multiple queries can be specified, separated by a “;” separator. For example: “ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost”. For more information regarding Search Criteria, refer to https://help.rapid7.com/insightvm/en-us/api/index.html#section/Overview/Responses. Optional
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
limit A number of records to limit the response to. Default is 10. Optional
sort Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a “;” separator. For example: “riskScore,DESC;hostName,ASC”. Optional
ipAddressIs A specific IP address to search. Optional
hostNameIs A specific host name to search. Optional
riskScoreHigherThan A minimum risk score to use as a filter. Optional
vulnerabilityTitleContains A string to search for in vulnerabilities titles. Optional
siteIdIn Site IDs to filter for. Can be a comma-separated list. Optional
siteNameIn Site names to filter for. Can be a comma-separated list. Optional
match Operator to determine how to match filters. “all” requires that all filters match for an asset to be included. “any” requires only one filter to match for an asset to be included. Possible values are: all, any. Default is all. Optional

Context Output

Path Type Description
Nexpose.Asset.AssetId number The identifier of the asset.
Nexpose.Asset.Address string The primary IPv4 or IPv6 address of the asset.
Nexpose.Asset.Name string The primary host name (local or FQDN) of the asset.
Nexpose.Asset.Site string Asset site name.
Nexpose.Asset.Exploits number The number of distinct exploits that can exploit any of the vulnerabilities on the asset.
Nexpose.Asset.Malware number The number of distinct malware kits that vulnerabilities on the asset are susceptible to.
Nexpose.Asset.OperatingSystem string Operating system of the asset.
Nexpose.Asset.Vulnerabilities number The total number of vulnerabilities.
Nexpose.Asset.RiskScore number The risk score (with criticality adjustments) of the asset.
Nexpose.Asset.Assessed boolean Whether the asset has been assessed for vulnerabilities at least once.
Nexpose.Asset.LastScanDate date Last scan date of the asset.
Nexpose.Asset.LastScanId number Id of the asset’s last scan.
Endpoint.IP string Endpoint IP address.
Endpoint.HostName string Endpoint host name.
Endpoint.OS string Endpoint operating system.

Command example

!nexpose-search-assets match=all riskScoreHigherThan=1000 limit=3

Context Example

{
    "Endpoint": [
        {
            "Hostname": "angular.testsparker.com",
            "ID": 11,
            "IPAddress": "192.0.2.2",
            "OS": "Ubuntu Linux",
            "Vendor": "Rapid7 Nexpose"
        },
        {
            "ID": 12,
            "IPAddress": "192.0.2.3",
            "OS": "Microsoft Windows",
            "Vendor": "Rapid7 Nexpose"
        },
        {
            "Hostname": "57.27.185.35.bc.googleusercontent.com",
            "ID": 13,
            "IPAddress": "192.0.2.4",
            "OS": "Linux 2.6.18",
            "Vendor": "Rapid7 Nexpose"
        }
    ],
    "Nexpose": {
        "Asset": [
            {
                "Address": "192.0.2.2",
                "Assessed": true,
                "AssetId": 11,
                "Exploits": 2,
                "LastScanDate": "2022-11-02T14:54:19.055Z",
                "LastScanId": "-",
                "Malware": 0,
                "Name": "angular.testsparker.com",
                "OperatingSystem": "Ubuntu Linux",
                "RiskScore": 7718.4091796875,
                "Site": "PANW",
                "Vulnerabilities": 26
            },
            {
                "Address": "192.0.2.3",
                "Assessed": true,
                "AssetId": 12,
                "Exploits": 4,
                "LastScanDate": "2049-03-01T04:31:56Z",
                "LastScanId": "-",
                "Malware": 0,
                "Name": null,
                "OperatingSystem": "Microsoft Windows",
                "RiskScore": 18819.919921875,
                "Site": "PANW",
                "Vulnerabilities": 45
            },
            {
                "Address": "192.0.2.4",
                "Assessed": true,
                "AssetId": 13,
                "Exploits": 0,
                "LastScanDate": "2022-11-15T11:53:25.281Z",
                "LastScanId": "-",
                "Malware": 0,
                "Name": "57.27.185.35.bc.googleusercontent.com",
                "OperatingSystem": "Linux 2.6.18",
                "RiskScore": 1323.0916748046875,
                "Site": "PANW",
                "Vulnerabilities": 2
            }
        ]
    }
}

Human Readable Output

Nexpose Asset 13

AssetId Address Name Site Exploits Malware OperatingSystem RiskScore Assessed LastScanDate LastScanId
13 192.0.2.4 57.27.185.35.bc.googleusercontent.com PANW 0 0 Linux 2.6.18 1323.0916748046875 true 2022-11-15T11:53:25.281Z -

nexpose-get-scan


Get a specific scan.

Base Command

nexpose-get-scan

Input

Argument Name Description Required
id ID of a specific scan to retrieve. Can be a comma-separated list. Required

Context Output

Path Type Description
Nexpose.Scan.Id number The identifier of the scan.
Nexpose.Scan.ScanType string The scan type (automated, manual, scheduled).
Nexpose.Scan.StartedBy string The name of the user who started the scan.
Nexpose.Scan.Assets number The number of assets found in the scan
Nexpose.Scan.TotalTime string The duration of the scan in minutes.
Nexpose.Scan.Status string The scan status. Valid values are aborted, unknown, running, finished, stopped, error, paused, dispatched, integrating
Nexpose.Scan.Completed date The end time of the scan in ISO8601 format.
Nexpose.Scan.Vulnerabilities.Critical number The number of critical vulnerabilities.
Nexpose.Scan.Vulnerabilities.Moderate number The number of moderate vulnerabilities.
Nexpose.Scan.Vulnerabilities.Severe number The number of severe vulnerabilities.
Nexpose.Scan.Vulnerabilities.Total number The total number of vulnerabilities.

Command example

!nexpose-get-scan id=1

Context Example

{
    "Nexpose": {
        "Scan": {
            "Assets": 0,
            "Completed": "2019-12-03T20:48:01.368Z",
            "Id": 1,
            "Message": null,
            "ScanName": "Tue 03 Dec 2019 10:47 PM",
            "ScanType": "Manual",
            "StartedBy": null,
            "Status": "finished",
            "TotalTime": "51.316 seconds",
            "Vulnerabilities": {
                "Critical": 0,
                "Moderate": 0,
                "Severe": 0,
                "Total": 0
            }
        }
    }
}

Human Readable Output

Nexpose Scan ID 1

Id ScanType ScanName Assets TotalTime Completed Status
1 Manual Tue 03 Dec 2019 10:47 PM 0 51.316 seconds 2019-12-03T20:48:01.368Z finished

Vulnerabilities

Critical Severe Moderate Total
0 0 0 0

nexpose-get-asset-vulnerability


Returns details and possible remediations for an asset’s vulnerability.

Base Command

nexpose-get-asset-vulnerability

Input

Argument Name Description Required
id ID of an asset to search for the vulnerability. Required
vulnerabilityId ID of a vulnerability to search for. Example: 7-zip-cve-2008-6536. Required

Context Output

Path Type Description
Nexpose.Asset.AssetId number Identifier of the asset.
Nexpose.Asset.Vulnerability.Id number The identifier of the vulnerability.
Nexpose.Asset.Vulnerability.Title string The title (summary) of the vulnerability.
Nexpose.Asset.Vulnerability.Severity string The severity of the vulnerability, one of: “Moderate”, “Severe”, “Critical”.
Nexpose.Asset.Vulnerability.RiskScore number The risk score of the vulnerability, rounded to a maximum of to digits of precision. If using the default Rapid7 Real Risk™ model, this value ranges from 0-1000.
Nexpose.Asset.Vulnerability.CVSS string The CVSS vector(s) for the vulnerability.
Nexpose.Asset.Vulnerability.CVSSV3 string The CVSS v3 vector.
Nexpose.Asset.Vulnerability.Published date The date the vulnerability was first published or announced. The format is an ISO 8601 date, YYYY-MM-DD.
Nexpose.Asset.Vulnerability.Added date The date the vulnerability coverage was added. The format is an ISO 8601 date, YYYY-MM-DD.
Nexpose.Asset.Vulnerability.Modified date The last date the vulnerability was modified. The format is an ISO 8601 date, YYYY-MM-DD.
Nexpose.Asset.Vulnerability.CVSSScore number The CVSS score (ranges from 0-10).
Nexpose.Asset.Vulnerability.CVSSV3Score number The CVSS3 score, which ranges from 0-10.
Nexpose.Asset.Vulnerability.Categories unknown All vulnerability categories assigned to this vulnerability.
Nexpose.Asset.Vulnerability.CVES unknown All CVEs assigned to this vulnerability.
Nexpose.Asset.Vulnerability.Check.Port number The port of the service the result was discovered on.
Nexpose.Asset.Vulnerability.Check.Protocol string The protocol of the service the result was discovered on, valid values ip, icmp, igmp, ggp, tcp, pup, udp, idp, esp, nd, raw
Nexpose.Asset.Vulnerability.Check.Since date The date and time the result was first recorded, in the ISO8601 format. If the result changes status this value is the date and time of the status change.
Nexpose.Asset.Vulnerability.Check.Proof string The proof explaining why the result was found vulnerable.
Nexpose.Asset.Vulnerability.Check.Status string The status of the vulnerability check result. Valid values are, unknown, not-vulnerable, vulnerable, vulnerable-version, vulnerable-potential, vulnerable-with-exception-applied, vulnerable-version-with-exception-applied, vulnerable-potential-with-exception-applied
Nexpose.Asset.Vulnerability.Solution.Type string The type of the solution. One of: “Configuration”, “Rollup patch”, “Patch”.
Nexpose.Asset.Vulnerability.Solution.Summary string The summary of the solution.
Nexpose.Asset.Vulnerability.Solution.Steps string The steps required to remediate the vulnerability.
Nexpose.Asset.Vulnerability.Solution.Estimate string The estimated duration to apply the solution, in minutes.
Nexpose.Asset.Vulnerability.Solution.AdditionalInformation string Additional information or resources that can assist in applying the remediation
CVE.ID string Common Vulnerabilities and Exposures IDs.

Command example

!nexpose-get-asset-vulnerability id=1 vulnerabilityId=apache-httpd-cve-2017-15710

Context Example

{
    "CVE": {
        "CVSS": {
            "Score": 7.5,
            "Vector": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
            "Version": "3"
        },
        "Description": "The affected asset is vulnerable to this vulnerability ONLY if it is running one of the following modules: mod_authnz_ldap. Review your web server configuration for validation. mod_authnz_ldap, if configured with AuthLDAPCharsetConfig, uses the Accept-Language header value to lookup the right charset encoding when verifying the user's credentials. If the header value is not present in the charset conversion table, a fallback mechanism is used to truncate it to a two characters value to allow a quick retry (for example, 'en-US' is truncated to 'en'). A header value of less than two characters forces an out of bound write of one NUL byte to a memory location that is not part of the string. In the worst case, quite unlikely, the process would crash which could be used as a Denial of Service attack. In the more likely case, this memory is already reserved for future use and the issue has no effect at all.",
        "ID": "CVE-2017-15710",
        "Modified": "2020-01-30",
        "Published": "2018-03-26"
    },
    "DBotScore": {
        "Indicator": "CVE-2017-15710",
        "Score": 0,
        "Type": "cve",
        "Vendor": "Rapid7 Nexpose"
    },
    "Nexpose": {
        "Asset": {
            "AssetId": "1",
            "Vulnerability": [
                {
                    "Added": "2018-03-26",
                    "CVES": [
                        "CVE-2017-15710"
                    ],
                    "CVSS": "AV:N/AC:L/Au:N/C:N/I:N/A:P",
                    "CVSSScore": 5,
                    "CVSSV3": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
                    "CVSSV3Score": 7.5,
                    "Categories": [
                        "Apache",
                        "Apache HTTP Server",
                        "Denial of Service",
                        "LDAP",
                        "Web"
                    ],
                    "Check": [
                        {
                            "Port": 80,
                            "Proof": "Running HTTP serviceProduct HTTPD exists -- Apache HTTPD 2.4.29Vulnerable version of product HTTPD found -- Apache HTTPD 2.4.29",
                            "Protocol": "tcp",
                            "Since": "2020-10-01T22:40:08.844Z",
                            "Status": "vulnerable-version"
                        },
                        {
                            "Port": 8000,
                            "Proof": "Running HTTP serviceProduct HTTPD exists -- Apache HTTPD 2.4.29Vulnerable version of product HTTPD found -- Apache HTTPD 2.4.29",
                            "Protocol": "tcp",
                            "Since": "2020-10-01T22:40:08.844Z",
                            "Status": "vulnerable-version"
                        }
                    ],
                    "Id": "apache-httpd-cve-2017-15710",
                    "Modified": "2020-01-30",
                    "Published": "2018-03-26",
                    "RiskScore": 175.22,
                    "Severity": "Severe",
                    "Solution": [
                        {
                            "AdditionalInformation": "The latest version of Apache HTTPD is 2.4.48.\n\nMany platforms and distributions provide pre-built binary packages for Apache HTTP server. These pre-built packages are usually customized and optimized for a particular distribution, therefore we recommend that you use the packages if they are available for your operating system.",
                            "Estimate": "2 hours",
                            "Steps": "Download and apply the upgrade from: http://archive.apache.org/dist/httpd/httpd-2.4.48.tar.gz (http://archive.apache.org/dist/httpd/httpd-2.4.48.tar.gz)",
                            "Summary": "Upgrade to the latest version of Apache HTTPD",
                            "Type": "rollup-patch"
                        }
                    ],
                    "Title": "Apache HTTPD: Out of bound write in mod_authnz_ldap when using too small Accept-Language values (CVE-2017-15710)"
                }
            ]
        }
    }
}

Human Readable Output

Vulnerability apache-httpd-cve-2017-15710

Id Title Severity RiskScore CVSS CVSSV3 Published Added Modified CVSSScore CVSSV3Score Categories CVES
apache-httpd-cve-2017-15710 Apache HTTPD: Out of bound write in mod_authnz_ldap when using too small Accept-Language values (CVE-2017-15710) Severe 175.22 AV:N/AC:L/Au:N/C:N/I:N/A:P CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H 2018-03-26 2018-03-26 2020-01-30 5.0 7.5 Apache,
Apache HTTP Server,
Denial of Service,
LDAP,
Web
CVE-2017-15710

Checks

Port Protocol Since Proof Status
80 tcp 2020-10-01T22:40:08.844Z Running HTTP serviceProduct HTTPD exists – Apache HTTPD 2.4.29Vulnerable version of product HTTPD found – Apache HTTPD 2.4.29 vulnerable-version
8000 tcp 2020-10-01T22:40:08.844Z Running HTTP serviceProduct HTTPD exists – Apache HTTPD 2.4.29Vulnerable version of product HTTPD found – Apache HTTPD 2.4.29 vulnerable-version

Solutions

Type Summary Steps Estimate AdditionalInformation
rollup-patch Upgrade to the latest version of Apache HTTPD Download and apply the upgrade from: http://archive.apache.org/dist/httpd/httpd-2.4.48.tar.gz (http://archive.apache.org/dist/httpd/httpd-2.4.48.tar.gz) 2 hours The latest version of Apache HTTPD is 2.4.48.

Many platforms and distributions provide pre-built binary packages for Apache HTTP server. These pre-built packages are usually customized and optimized for a particular distribution, therefore we recommend that you use the packages if they are available for your operating system.

nexpose-create-shared-credential


Create a new shared credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/createSharedCredential

Base Command

nexpose-create-shared-credential

Input

Argument Name Description Required
name Name of the credential. Required
site_assignment Site assignment configuration for the credential. Assign the shared scan credential either to be available to all sites, or a specific list of sites. Possible values are: All-Sites, Specific-Sites. Required
service Credential service type. Possible values are: AS400, CIFS, CIFSHash, CVS, DB2, FTP, HTTP, MS-SQL, MySQL, Notes, Oracle, POP, PostgresSQL, Remote-Exec, SNMP, SNMPv3, SSH, SSH-Key, Sybase, Telnet. Required
database Database name. Optional
description Description for the credential. Optional
domain Domain address. Optional
host_restriction Hostname or IP address to restrict the credentials to. Optional
http_realm HTTP realm. Optional
notes_id_password Password for the notes account that will be used for authenticating. Optional
ntlm_hash NTLM password hash. Optional
oracle_enumerate_sids Whether the scan engine should attempt to enumerate SIDs from the environment. Possible values are: true, false. Optional
oracle_listener_password Oracle Net Listener password. Used to enumerate SIDs from your environment. Optional
oracle_sid Oracle database name. Optional
password Password for the credential. Optional
port_restriction Further restricts the credential to attempt to authenticate on a specific port. Can be used only if host_restriction is used. Optional
sites List of site IDs for the shared credential that are explicitly assigned access to the shared scan credential, allowing it to use the credential during a scan. Optional
community_name SNMP community for authentication. Optional
authentication_type SNMPv3 authentication type for the credential. Possible values are: No-Authentication, MD5, SHA. Optional
privacy_password SNMPv3 privacy password to use. Optional
privacy_type SNMPv3 Privacy protocol to use. Possible values are: No-Privacy, DES, AES-128, AES-192, AES-192-With-3-DES-Key-Extension, AES-256, AES-256-With-3-DES-Key-Extension. Optional
ssh_key_pem PEM formatted private key. Optional
ssh_permission_elevation Elevation type to use for scans. Possible values are: None, sudo, sudosu, su, pbrun, Privileged-Exec. Optional
ssh_permission_elevation_password Password to use for elevation. Optional
ssh_permission_elevation_username Username to use for elevation. Optional
ssh_private_key_password Password for the private key. Optional
use_windows_authentication Whether to use Windows authentication. Possible values are: true, false. Optional
username Username for the credential. Optional

Context Output

Path Type Description
Nexpose.SharedCredential.id number ID of the generated credential.

nexpose-create-site


Creates a new site with the specified configuration.

Base Command

nexpose-create-site

Input

Argument Name Description Required
name Site name. Must be unique. Required
description Site’s description. Optional
assets Addresses of assets to include in site scans. Can be a comma-separated list. Required
scanTemplateId ID of a scan template to use. If not specified, the default scan template will be used. Use nexpose-get-report-templates to get a list of all available templates. Optional
importance Site importance. Defaults to “normal” if not specified. Possible values are: very_low, low, normal, high, very_high. Optional

Context Output

Path Type Description
Nexpose.Site.Id number ID of the created site.

nexpose-create-vulnerability-exception


Create a new vulnerability exception.

Base Command

nexpose-create-vulnerability-exception

Input

Argument Name Description Required
expires The date and time the vulnerability exception is set to expire in ISO 8601 date format. Optional
vulnerability_id ID of the vulnerability to create the exception for. Example: 7-zip-cve-2008-6536. Required
scope_type The type of the exception scope. If set to anything other than Global, scope_id parameter is required. Possible values are: Global, Site, Asset, Asset Group. Required
state State of the vulnerability exception. Possible values are: Expired, Approved, Rejected, Under Review. Required
comment A comment from the submitter as to why the exception was submitted. Optional
reason Reason why the vulnerability exception was submitted. Possible values are: False Positive, Compensating Control, Acceptable Use, Acceptable Risk, Other. Required
scope_id ID of the chosen scope_type (site ID, asset ID, etc.). Required if scope_type is anything other than Global. Optional

Context Output

Path Type Description
Nexpose.VulnerabilityException.id number ID of the generated vulnerability exception.

nexpose-delete-asset


Delete an asset.

Base Command

nexpose-delete-asset

Input

Argument Name Description Required
id ID of the asset to delete. Required

Context Output

There is no context output for this command.

Command example

!nexpose-delete-asset id=1

Human Readable Output

Asset 1 has been deleted.

nexpose-delete-scan-schedule


Delete a scheduled scan.

Base Command

nexpose-delete-scan-schedule

Input

Argument Name Description Required
site_id ID of the site to delete. Optional
site_name Name of the site to delete (can be used instead of site_id). Optional
schedule_id ID of the scheduled scan to delete. Required

Context Output

There is no context output for this command.

nexpose-delete-shared-credential


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Delete a shared credential.

Base Command

nexpose-delete-shared-credential

Input

Argument Name Description Required
id ID of the shared credential to delete. Required

Context Output

There is no context output for this command.

nexpose-delete-site-scan-credential


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Delete a site scan credential.

Base Command

nexpose-delete-site-scan-credential

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
credential_id ID of the site scan credential to delete. Required

Context Output

There is no context output for this command.

nexpose-delete-site


Deletes a site.

Base Command

nexpose-delete-site

Input

Argument Name Description Required
id ID of a site to delete. Optional
site_name Name of the site to delete (can be used instead of site_id). Optional

Context Output

There is no context output for this command.

nexpose-delete-vulnerability-exception


Delete a vulnerability exception.

Base Command

nexpose-delete-vulnerability-exception

Input

Argument Name Description Required
id ID of the vulnerability exception to delete. Required

Command example

!nexpose-delete-vulnerability-exception id=1

Human Readable Output

Vulnerability exception with ID 1 has been deleted.

nexpose-get-sites


Retrieves accessible sites.

Base Command

nexpose-get-sites

Input

Argument Name Description Required
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
limit A number of records to limit the response to. Default is 10. Optional
sort Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a “;”. For example: “riskScore,DESC;hostName,ASC”. Optional

Context Output

Path Type Description
Nexpose.Site.Id number The identifier of the site.
Nexpose.Site.Name string The site name.
Nexpose.Site.Assets number The number of assets that belong to the site.
Nexpose.Site.Type string The type of the site. Valid values are agent, dynamic, static
Nexpose.Site.Vulnerabilities number The total number of vulnerabilities.
Nexpose.Site.Risk number The risk score (with criticality adjustments) of the site.
Nexpose.Site.LastScan date The date and time of the site’s last scan.

Command example

!nexpose-get-sites limit=5

Context Example

{
    "Nexpose": {
        "Site": [
            {
                "Assets": 4,
                "Id": 1,
                "LastScan": "2021-08-03T14:09:15.321Z",
                "Name": "Authenticated-Assets",
                "Risk": 20416,
                "Type": "static",
                "Vulnerabilities": 41
            },
            {
                "Assets": 18,
                "Id": 2,
                "LastScan": "2021-06-29T07:06:54.733Z",
                "Name": "PANW",
                "Risk": 213245,
                "Type": "static",
                "Vulnerabilities": 455
            },
            {
                "Assets": 10,
                "Id": 3,
                "LastScan": "2020-11-26T17:13:54.117Z",
                "Name": "Test",
                "Risk": 18820,
                "Type": "static",
                "Vulnerabilities": 45
            }
        ]
    }
}

Human Readable Output

Nexpose Sites

Id Name Assets Vulnerabilities Risk Type LastScan
1 Authenticated-Assets 4 41 20416.0 static 2021-08-03T14:09:15.321Z
2 PANW 18 455 213245.0 static 2021-06-29T07:06:54.733Z
3 Test 10 45 18820.0 static 2020-11-26T17:13:54.117Z

nexpose-get-report-templates


Returns all available report templates.

Base Command

nexpose-get-report-templates

Input

There are no input arguments for this command.

Context Output

Path Type Description
Nexpose.Template.Id number The identifier of the report template.
Nexpose.Template.Name string The name of the report template.
Nexpose.Template.Description string The description of the report template.
Nexpose.Template.Type string The type of the report template. document is a templatized, typically printable, report that has various sections of content. export is data-oriented output, typically CSV. file is a printable report template using a report template file.

Command example


#### Context Example

```json
{
    "Nexpose": {
        "Template": [
            {
                "Description": "Provides comprehensive details about discovered assets, vulnerabilities, and users.",
                "Id": "audit-report",
                "Name": "Audit Report",
                "Type": "document"
            },
            {
                "Description": "Compares current scan results to those of an earlier baseline scan.",
                "Id": "baseline-comparison",
                "Name": "Baseline Comparison",
                "Type": "document"
            },
            {
                "Description": "Provides a high-level view of security data, including general results information and statistical charts.",
                "Id": "executive-overview",
                "Name": "Executive Overview",
                "Type": "document"
            },
            {
                "Description": "Provides information and metrics about 10 discovered vulnerabilities with the highest risk scores.",
                "Id": "highest-risk-vulns",
                "Name": "Highest Risk Vulnerabilities",
                "Type": "document"
            },
            {
                "Description": "Lists results for standard policy scans (AS/400, Oracle, Domino, Windows Group, CIFS/SMB account). Does not include Policy Manager results.",
                "Id": "policy-eval",
                "Name": "Policy Evaluation",
                "Type": "document"
            },
            {
                "Description": "Provides detailed remediation instructions for each discovered vulnerability.",
                "Id": "remediation-plan",
                "Name": "Remediation Plan",
                "Type": "document"
            },
            {
                "Description": "Lists test results for each discovered vulnerability, including how it was verified.",
                "Id": "report-card",
                "Name": "Report Card",
                "Type": "document"
            }
        ]
    }
}

Human Readable Output

Nexpose Templates

Id Name Description Type
audit-report Audit Report Provides comprehensive details about discovered assets, vulnerabilities, and users. document
baseline-comparison Baseline Comparison Compares current scan results to those of an earlier baseline scan. document
executive-overview Executive Overview Provides a high-level view of security data, including general results information and statistical charts. document
highest-risk-vulns Highest Risk Vulnerabilities Provides information and metrics about 10 discovered vulnerabilities with the highest risk scores. document
policy-eval Policy Evaluation Lists results for standard policy scans (AS/400, Oracle, Domino, Windows Group, CIFS/SMB account). Does not include Policy Manager results. document
remediation-plan Remediation Plan Provides detailed remediation instructions for each discovered vulnerability. document
report-card Report Card Lists test results for each discovered vulnerability, including how it was verified. document

nexpose-create-asset


Create a new asset.

Base Command

nexpose-create-asset

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
date The date the data was collected on the asset in ISO 8601 format. Required
ip Primary IPv4 or IPv6 address of the asset. Required
host_name Hostname of the asset. Optional
host_name_source The source used to detect the host name. “User” indicates the host name source is user-supplied. Possible values are: User, DNS, NetBIOS, DCE, EPSEC, LDAP, Other. Optional

Context Output

Path Type Description
Nexpose.Asset.id string ID of the newly created asset.

Command example

!nexpose-create-asset site_id="1" date="2022-01-01T10:00:00Z" ip="192.0.2.0"

Context Example

{
    "Nexpose": {
        "Asset": {
            "id": 1
        }
    }
}

Human Readable Output

New asset has been created with ID 1.

nexpose-create-assets-report


Generates a new report on given assets according to a template and arguments.

Base Command

nexpose-create-assets-report

Input

Argument Name Description Required
assets Asset IDs to create the report on. Can be a comma-separated list. Required
template Report template ID to create the report with. If not provided, the first available template will be used. Optional
name Report name. Optional
format Report format (uses PDF by default). Possible values are: pdf, rtf, xml, html, text. Optional
download_immediately Whether to download the report immediately after the report is generated. Defaults to “true”. If the report takes longer than 10 seconds to generate, set to “false”. Possible values are: true, false. Default is true. Optional

Context Output

Path Type Description
InfoFile.EntryId string Entry ID of the report file.
InfoFile.Name string Name of the report file.
InfoFile.Extension string File extension of the report file.
InfoFile.Info string Information about the report file.
InfoFile.Size number Size of the report file (in bytes).
InfoFile.Type string Type of the report file.
Nexpose.Report.ID string The identifier of the report.
Nexpose.Report.InstanceID string The identifier of the report instance.
Nexpose.Report.Name string The report name.
Nexpose.Report.Format string The report format.

nexpose-create-sites-report


Generates a new report on given sites according to a template and arguments.

Base Command

nexpose-create-sites-report

Input

Argument Name Description Required
sites Site IDs to create the report on. Can be a comma-separated list. Optional
site_names Names of sites to create the report on. Can be a comma-separated list. Optional
template Report template ID to use for report’s creation. If not provided, the first available template will be used. Optional
name Report name. Optional
format Report format (uses PDF by default). Possible values are: pdf, rtf, xml, html, text. Optional
download_immediately If true, downloads the report immediately after the report is generated. The default is “true”. If the report takes longer than 10 seconds to generate, set to “false”. Possible values are: true, false. Default is true. Optional

Context Output

Path Type Description
InfoFile.EntryId string Entry ID of the report file.
InfoFile.Name string Name of the report file.
InfoFile.Extension string File extension of the report file.
InfoFile.Info string Info about the report file.
InfoFile.Size number Size of the report file.
InfoFile.Type string Type of the report file.
Nexpose.Report.ID string The identifier of the report.
Nexpose.Report.InstanceID string The identifier of the report instance.
Nexpose.Report.Name string The report name.
Nexpose.Report.Format string The report format.

nexpose-create-site-scan-credential


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Create a new site scan credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/createSiteCredential

Base Command

nexpose-create-site-scan-credential

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
name Name of the credential. Required
service Credential service type. Possible values are: AS400, CIFS, CIFSHash, CVS, DB2, FTP, HTTP, MS-SQL, MySQL, Notes, Oracle, POP, PostgresSQL, Remote-Exec, SNMP, SNMPv3, SSH, SSH-Key, Sybase, Telnet. Required
database Database name. Optional
description Description for the credential. Optional
domain Domain address. Optional
host_restriction Hostname or IP address to restrict the credentials to. Optional
http_realm HTTP realm. Optional
notes_id_password Password for the notes account that will be used for authenticating. Optional
ntlm_hash NTLM password hash. Optional
oracle_enumerate_sids Whether the scan engine should attempt to enumerate SIDs from the environment. Possible values are: true, false. Optional
oracle_listener_password Oracle Net Listener password. Used to enumerate SIDs from your environment. Optional
oracle_sid Oracle database name. Optional
password Password for the credential. Optional
port_restriction Further restricts the credential to attempt to authenticate on a specific port. Can be used only if host_restriction is used. Optional
community_name SNMP community for authentication. Optional
authentication_type SNMPv3 authentication type for the credential. Possible values are: No-Authentication, MD5, SHA. Optional
privacy_password SNMPv3 privacy password to use. Optional
privacy_type SNMPv3 privacy protocol to use. Possible values are: No-Privacy, DES, AES-128, AES-192, AES-192-With-3-DES-Key-Extension, AES-256, AES-256-With-3-DES-Key-Extension. Optional
ssh_key_pem PEM formatted private key. Optional
ssh_permission_elevation Elevation type to use for scans. Possible values are: None, sudo, sudosu, su, pbrun, Privileged-Exec. Optional
ssh_permission_elevation_password Password to use for elevation. Optional
ssh_permission_elevation_username Username to use for elevation. Optional
ssh_private_key_password Password for the private key. Optional
use_windows_authentication Whether to use Windows authentication. Possible values are: true, false. Optional
username Username for the credential. Optional

Context Output

Path Type Description
Nexpose.SiteScanCredential.id number ID of the generated credential.

nexpose-create-scan-report


Generates a new report for a specified scan.

Base Command

nexpose-create-scan-report

Input

Argument Name Description Required
scan ID of the scan to create a report about. Required
template Report template ID to use for creation. If not provided, the first available template will be used. Optional
name Report name. Optional
format Report format (uses PDF by default). Possible values are: pdf, rtf, xml, html, text. Optional
download_immediately If true, downloads the report immediately after the report is generated. The default is “true”. If the report takes longer than 10 seconds to generate, set to “false”. Possible values are: true, false. Default is true. Optional

Context Output

Path Type Description
InfoFile.EntryId string Entry ID of the report file.
InfoFile.Name string Name of the report file.
InfoFile.Extension string File extension of the report file.
InfoFile.Info string Info about the report file.
InfoFile.Size number Size of the report file.
InfoFile.Type string Type of the report file.
Nexpose.Report.ID string The identifier of the report.
Nexpose.Report.InstanceID string The identifier of the report instance.
Nexpose.Report.Name string The report name.
Nexpose.Report.Format string The report format.

Command example

!nexpose-create-scan-report scan=1 download_immediately=false

Context Example

{
    "Nexpose": {
        "Report": {
            "Format": "pdf",
            "ID": 3241,
            "InstanceID": 3212,
            "Name": "report 2022-11-30 09:25:36.359529"
        }
    }
}

Human Readable Output

Report Information

Format ID InstanceID Name
pdf 3241 3212 report 2022-11-30 09:25:36.359529

nexpose-create-scan-schedule


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Create a new site scan schedule.

Base Command

nexpose-create-scan-schedule

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
enabled Whether to enable the scheduled scan after creation. Possible values are: True, False. Default is True. Optional
on_scan_repeat The desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching its maximum duration. Possible values are: Restart-Scan, Resume-Scan. Required
start The scheduled start date and time formatted in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time. Required
excluded_asset_group_ids A list of IDs for asset groups to exclude from the scan. Optional
excluded_addresses A list of addresses to exclude from the scan. Optional
included_asset_group_ids A list of IDs for asset groups to include in the scan. Optional
included_addresses A list of addresses to include in the scan. Optional
duration_days Maximum duration of the scan in days. Optional
duration_hours Maximum duration of the scan in hours. Optional
duration_minutes Maximum duration of the scan in minutes. Optional
frequency How frequently the schedule should repeat (Every…). Possible values are: Hour, Day, Week, Date-of-month. Optional
interval_time The interval time the schedule should repeat. This depends on the value set in frequency. For example, if the value of frequency is set to “Day” and interval is set to 2, then the schedule will repeat every 2 days. Required only if frequency is used. Optional
date_of_month Specifies the schedule repeat day of the interval month. For example, if date_of_month is 17 and interval is set to 2, then the schedule will repeat every 2 months on the 17th day of the month. Required and used only if frequency is set to Date of month. Optional
scan_name A unique user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching. Optional
scan_template ID of the scan template to use. Optional

Context Output

Path Type Description
Nexpose.ScanSchedule.id int ID of the newly created scan schedule.

nexpose-list-assigned-shared-credential


Retrieve information about shared credentials for a specific site.

Base Command

nexpose-list-assigned-shared-credential

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
limit The number of records to limit the response to. Default is 10. Optional

Context Output

Path Type Description
Nexpose.AssignedSharedCredential.enabled string Flag indicating whether the shared credential is enabled for the site’s scans.
Nexpose.AssignedSharedCredential.id string ID of the shared credential.
Nexpose.AssignedSharedCredential.name string The name of the shared credential.
Nexpose.AssignedSharedCredential.service string Credential service type.

Command example

!nexpose-list-assigned-shared-credential site_id=1 limit=3

Context Example

{
    "Nexpose": {
        "AssignedSharedCredential": [
            {
                "enabled": true,
                "id": 1,
                "name": "Test 1",
                "service": "ftp"
            },
            {
                "enabled": true,
                "id": 2,
                "name": "Test 2",
                "service": "ftp"
            },
            {
                "enabled": true,
                "id": 3,
                "name": "Test 3",
                "service": "ftp"
            }
        ]
    }
}

Human Readable Output

Nexpose Assigned Shared Credentials

Id Name Service Enabled
1 Test 1 ftp true
2 Test 2 ftp true
3 Test 3 ftp true

nexpose-list-vulnerability


Retrieve information about all or a specific vulnerability.

Base Command

nexpose-list-vulnerability

Input

Argument Name Description Required
id ID of a specific vulnerability to retrieve. Optional
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
limit The number of records to limit the response to. Default is 10. Optional
sort Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a “;”. For example: “riskScore,DESC;hostName,ASC”. Optional

Context Output

Path Type Description
Nexpose.Vulnerability.added string The date the vulnerability coverage was added in ISO 8601 format.
Nexpose.Vulnerability.categories array All vulnerability categories assigned to this vulnerability.
Nexpose.Vulnerability.cves array All CVEs assigned to this vulnerability.
Nexpose.Vulnerability.cvss.v2.accessComplexity string Access Complexity (AC) component that measures the complexity of the attack required to exploit the vulnerability once an attacker has gained access to the target system.
Nexpose.Vulnerability.cvss.v2.accessVector string Access Vector (Av) component that reflects how the vulnerability is exploited.
Nexpose.Vulnerability.cvss.v2.authentication string Authentication (Au) component that measures the number of times an attacker must authenticate to a target in order to exploit a vulnerability.
Nexpose.Vulnerability.cvss.v2.availabilityImpact string Availability Impact (A) component that measures the impact to availability of a successfully exploited vulnerability.
Nexpose.Vulnerability.cvss.v2.confidentialityImpact string Confidentiality Impact (C) component that measures the impact on confidentiality of a successfully exploited vulnerability.
Nexpose.Vulnerability.cvss.v2.exploitScore number The CVSS exploit score.
Nexpose.Vulnerability.cvss.v2.impactScore number The CVSS impact score.
Nexpose.Vulnerability.cvss.v2.integrityImpact string Integrity Impact (I) component that measures the impact to integrity of a successfully exploited vulnerability.
Nexpose.Vulnerability.cvss.v2.score number The CVSS score (ranges from 0-10).
Nexpose.Vulnerability.cvss.v2.vector string The CVSS v2 vector.
Nexpose.Vulnerability.cvss.v3.attackComplexity string Access Complexity (AC) component that measures the conditions beyond the attacker’s control that must exist in order to exploit the vulnerability.
Nexpose.Vulnerability.cvss.v3.attackVector string Attack Vector (AV) component that measures context by which vulnerability exploitation is possible.
Nexpose.Vulnerability.cvss.v3.availabilityImpact string Availability Impact (A) that measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
Nexpose.Vulnerability.cvss.v3.confidentialityImpact string Confidentiality Impact (C) component that measures the impact on confidentiality of a successfully exploited vulnerability.
Nexpose.Vulnerability.cvss.v3.exploitScore number The CVSS impact score.
Nexpose.Vulnerability.cvss.v3.impactScore number The CVSS exploit score.
Nexpose.Vulnerability.cvss.v3.integrityImpact string Integrity Impact (I) that measures the impact to integrity of a successfully exploited vulnerability. Integrity refers to the trustworthiness and veracity of information.
Nexpose.Vulnerability.cvss.v3.privilegeRequired string Privileges Required (PR) that measures the level of privileges an attacker must possess before successfully exploiting the vulnerability.
Nexpose.Vulnerability.cvss.v3.scope string Scope (S) that measures the collection of privileges defined by a computing authority (e.g., an application, an operating system, or a sandbox environment) when granting access to computing resources (e.g., files, CPU, memory, etc.). These privileges are assigned based on some method of identification and authorization.
Nexpose.Vulnerability.cvss.v3.score number The CVSS score (ranges from 0-10).
Nexpose.Vulnerability.cvss.v3.userInteraction string User Interaction (UI) that measures the requirement for a user, other than the attacker, to participate in the successful compromise of the vulnerable component.
Nexpose.Vulnerability.cvss.v3.vector string The CVSS v3 vector.
Nexpose.Vulnerability.denialOfService boolean Whether the vulnerability can lead to Denial of Service (DoS).
Nexpose.Vulnerability.description.html string Hypertext Markup Language (HTML) representation of the content.
Nexpose.Vulnerability.description.text string Textual representation of the content.
Nexpose.Vulnerability.exploits number The exploits that can be used to exploit a vulnerability.
Nexpose.Vulnerability.id string The identifier of the vulnerability.
Nexpose.Vulnerability.malwareKits number The malware kits that are known to be used to exploit the vulnerability.
Nexpose.Vulnerability.modified string The last date the vulnerability was modified in ISO 8601 format.
Nexpose.Vulnerability.pci.adjustedCVSSScore number The CVSS score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10.
Nexpose.Vulnerability.pci.adjustedSeverityScore number The severity score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10.
Nexpose.Vulnerability.pci.fail boolean Whether, if present on a host, this vulnerability would cause a PCI failure. True if “status” is “Fail”, false otherwise.
Nexpose.Vulnerability.pci.specialNotes string Any special notes or remarks about the vulnerability that pertain to PCI compliance.
Nexpose.Vulnerability.pci.status string The PCI compliance status of the vulnerability. Can be either “Pass”, or “Fail”.
Nexpose.Vulnerability.published string The date the vulnerability was first published or announced in ISO 8601 format.
Nexpose.Vulnerability.riskScore number The risk score of the vulnerability, rounded to a maximum of two digits of precision. If using the default Rapid7 Real Risk model, this value ranges from 0-1000.
Nexpose.Vulnerability.severity string The severity of the vulnerability, can be either “Moderate”, “Severe”, or “Critical”.
Nexpose.Vulnerability.severityScore number The severity score of the vulnerability, on a scale of 0-10.
Nexpose.Vulnerability.title string The title (summary) of the vulnerability.

Command example

!nexpose-list-vulnerability limit=3

Context Example

{
    "Nexpose": {
        "Vulnerability": [
            {
                "added": "2018-05-16",
                "categories": [
                    "7-Zip"
                ],
                "cves": [
                    "CVE-2008-6536"
                ],
                "cvss": {
                    "v2": {
                        "accessComplexity": "L",
                        "accessVector": "N",
                        "authentication": "N",
                        "availabilityImpact": "C",
                        "confidentialityImpact": "C",
                        "exploitScore": 9.9968,
                        "impactScore": 10.0008,
                        "integrityImpact": "C",
                        "score": 10,
                        "vector": "AV:N/AC:L/Au:N/C:C/I:C/A:C"
                    }
                },
                "denialOfService": false,
                "description": {
                    "html": "<p>Unspecified vulnerability in 7-zip before 4.5.7 has unknown impact and remote attack vectors, as demonstrated by the PROTOS GENOME test suite for Archive Formats (c10).</p>",
                    "text": "Unspecified vulnerability in 7-zip before 4.5.7 has unknown impact and remote attack vectors, as demonstrated by the PROTOS GENOME test suite for Archive Formats (c10)."
                },
                "exploits": 0,
                "id": "7-zip-cve-2008-6536",
                "malwareKits": 0,
                "modified": "2018-06-08",
                "pci": {
                    "adjustedCVSSScore": 10,
                    "adjustedSeverityScore": 5,
                    "fail": true,
                    "status": "Fail"
                },
                "published": "2009-03-29",
                "riskScore": 898.63,
                "severity": "Critical",
                "severityScore": 10,
                "title": "7-Zip: CVE-2008-6536: Unspecified vulnerability in 7-zip before 4.5.7"
            },
            {
                "added": "2018-05-16",
                "categories": [
                    "7-Zip",
                    "Remote Execution"
                ],
                "cves": [
                    "CVE-2016-2334"
                ],
                "cvss": {
                    "v2": {
                        "accessComplexity": "M",
                        "accessVector": "N",
                        "authentication": "N",
                        "availabilityImpact": "C",
                        "confidentialityImpact": "C",
                        "exploitScore": 8.5888,
                        "impactScore": 10.0008,
                        "integrityImpact": "C",
                        "score": 9.3,
                        "vector": "AV:N/AC:M/Au:N/C:C/I:C/A:C"
                    },
                    "v3": {
                        "attackComplexity": "L",
                        "attackVector": "L",
                        "availabilityImpact": "H",
                        "confidentialityImpact": "H",
                        "exploitScore": 1.8346,
                        "impactScore": 5.8731,
                        "integrityImpact": "H",
                        "privilegeRequired": "N",
                        "scope": "U",
                        "score": 7.8,
                        "userInteraction": "R",
                        "vector": "CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H"
                    }
                },
                "denialOfService": false,
                "description": {
                    "html": "<p>Heap-based buffer overflow in the NArchive::NHfs::CHandler::ExtractZlibFile method in 7zip before 16.00 and p7zip allows remote attackers to execute arbitrary code via a crafted HFS+ image.</p>",
                    "text": "Heap-based buffer overflow in the NArchive::NHfs::CHandler::ExtractZlibFile method in 7zip before 16.00 and p7zip allows remote attackers to execute arbitrary code via a crafted HFS+ image."
                },
                "exploits": 0,
                "id": "7-zip-cve-2016-2334",
                "malwareKits": 0,
                "modified": "2018-06-08",
                "pci": {
                    "adjustedCVSSScore": 9,
                    "adjustedSeverityScore": 5,
                    "fail": true,
                    "status": "Fail"
                },
                "published": "2016-12-13",
                "riskScore": 717.53,
                "severity": "Critical",
                "severityScore": 9,
                "title": "7-Zip: CVE-2016-2334: Heap-based buffer overflow vulnerability"
            },
            {
                "added": "2018-05-16",
                "categories": [
                    "7-Zip",
                    "Trojan"
                ],
                "cves": [
                    "CVE-2016-7804"
                ],
                "cvss": {
                    "v2": {
                        "accessComplexity": "M",
                        "accessVector": "N",
                        "authentication": "N",
                        "availabilityImpact": "P",
                        "confidentialityImpact": "P",
                        "exploitScore": 8.5888,
                        "impactScore": 6.443,
                        "integrityImpact": "P",
                        "score": 6.8,
                        "vector": "AV:N/AC:M/Au:N/C:P/I:P/A:P"
                    },
                    "v3": {
                        "attackComplexity": "L",
                        "attackVector": "L",
                        "availabilityImpact": "H",
                        "confidentialityImpact": "H",
                        "exploitScore": 1.8346,
                        "impactScore": 5.8731,
                        "integrityImpact": "H",
                        "privilegeRequired": "N",
                        "scope": "U",
                        "score": 7.8,
                        "userInteraction": "R",
                        "vector": "CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H"
                    }
                },
                "denialOfService": false,
                "description": {
                    "html": "<p>Untrusted search path vulnerability in 7 Zip for Windows 16.02 and earlier allows remote attackers to gain privileges via a Trojan horse DLL in an unspecified directory.</p>",
                    "text": "Untrusted search path vulnerability in 7 Zip for Windows 16.02 and earlier allows remote attackers to gain privileges via a Trojan horse DLL in an unspecified directory."
                },
                "exploits": 0,
                "id": "7-zip-cve-2016-7804",
                "malwareKits": 0,
                "modified": "2018-06-08",
                "pci": {
                    "adjustedCVSSScore": 6,
                    "adjustedSeverityScore": 4,
                    "fail": true,
                    "specialNotes": "The presence of malware, including rootkits, backdoors, or trojan horse programs are a violation of PCI DSS, and result in an automatic failure. ",
                    "status": "Fail"
                },
                "published": "2017-05-22",
                "riskScore": 578.88,
                "severity": "Severe",
                "severityScore": 7,
                "title": "7-Zip: CVE-2016-7804: Untrusted search path vulnerability"
            }
        ]
    }
}

Human Readable Output

Nexpose Vulnerabilities

Title MalwareKits Exploits CVSS CVSSv3 Risk PublishedOn ModifiedOn Severity
7-Zip: CVE-2008-6536: Unspecified vulnerability in 7-zip before 4.5.7 0 0 10.0   898.63 2009-03-29 2018-06-08 Critical
7-Zip: CVE-2016-2334: Heap-based buffer overflow vulnerability 0 0 9.3 7.8 717.53 2016-12-13 2018-06-08 Critical
7-Zip: CVE-2016-7804: Untrusted search path vulnerability 0 0 6.8 7.8 578.88 2017-05-22 2018-06-08 Severe

nexpose-list-scan-schedule


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Retrieve information about scan schedules for a specific site or a specific scan schedule.

Base Command

nexpose-list-scan-schedule

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
schedule_id ID of the scheduled scan (optional, will return a single specific scan if used). Optional
limit A number of records to limit the response to. Default is 10. Optional

Context Output

Path Type Description
Nexpose.ScanSchedule.assets.excludedAssetGroups.assetGroupIDs array List of asset group identifiers that will be excluded from scans.
Nexpose.ScanSchedule.assets.excludedTargets.addresses array List of addresses that will be excluded from scans.
Nexpose.ScanSchedule.assets.includedAssetGroups.assetGroupIDs array List of asset group identifiers that will be included in scans.
Nexpose.ScanSchedule.assets.includedTargets.addresses array List of addresses that will be included in scans.
Nexpose.ScanSchedule.duration string Specifies in ISO 8601 duration format the maximum duration the scheduled scan is allowed to run.
Nexpose.ScanSchedule.enabled string Flag indicating whether the scan schedule is enabled.
Nexpose.ScanSchedule.id int The identifier of the scan schedule.
Nexpose.ScanSchedule.nextRuntimes array List the next 10 dates when the schedule will launch.
Nexpose.ScanSchedule.onScanRepeat string Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration.
Nexpose.ScanSchedule.repeat.dayOfWeek unknown Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration.
Nexpose.ScanSchedule.repeat.every unknown The frequency in which the schedule repeats. Each value represents a different unit of time and is used in conjunction with the property interval.
Nexpose.ScanSchedule.repeat.interval unknown The interval time the schedule should repeat. This depends on the value set in every.
Nexpose.ScanSchedule.repeat.weekOfMonth unknown This property only applies to schedules with an every value of “day-of-month”. The week of the month the scheduled task should repeat.
Nexpose.ScanSchedule.repeat.scanEngineId unknown The identifier of the scan engine to be used for this scan schedule. If not set, the site’s assigned scan engine will be used.
Nexpose.ScanSchedule.repeat.scanName unknown A user-defined name for the scan launched by the schedule.
Nexpose.ScanSchedule.repeat.scanTemplateId unknown The identifier of the scan template to be used for this scan schedule. If not set, the site’s assigned scan template will be used.
Nexpose.ScanSchedule.repeat.start unknown The scheduled start date and time. Repeating schedules will determine the next schedule to begin based on this date and time.

nexpose-list-shared-credential


Retrieve information about all or a specific shared credential.

Base Command

nexpose-list-shared-credential

Input

Argument Name Description Required
id ID of a specific shared credential to retrieve. Optional
limit A number of records to limit the response to. Default is 10. Optional

Context Output

Path Type Description
Nexpose.SharedCredential.account.authenticationType string SNMPv3 authentication type for the credential.
Nexpose.SharedCredential.account.communityName string SNMP community for authentication.
Nexpose.SharedCredential.account.database string Database name.
Nexpose.SharedCredential.account.domain string Domain address.
Nexpose.SharedCredential.account.enumerateSids boolean Whether the scan engine should attempt to enumerate SIDs from the environment.
Nexpose.SharedCredential.account.notesIDPassword string Password for the notes account that will be used for authenticating.
Nexpose.SharedCredential.account.ntlmHash string NTLM password hash.
Nexpose.SharedCredential.account.oracleListenerPassword string The Oracle Net Listener password. Used to enumerate SIDs from the environment.
Nexpose.SharedCredential.account.password string Password for the credential.
Nexpose.SharedCredential.account.pemKey string PEM formatted private key.
Nexpose.SharedCredential.account.permissionElevation string Elevation type to use for scans.
Nexpose.SharedCredential.account.permissionElevationPassword string Password to use for elevation.
Nexpose.SharedCredential.account.permissionElevationUserName string Username to use for elevation.
Nexpose.SharedCredential.account.privacyPassword string SNMPv3 privacy password to use.
Nexpose.SharedCredential.account.privacyType string SNMPv3 privacy protocol to use.
Nexpose.SharedCredential.account.privateKeyPassword string Password for the private key.
Nexpose.SharedCredential.account.realm string HTTP realm.
Nexpose.SharedCredential.account.service string Credential service type.
Nexpose.SharedCredential.account.sid string Oracle database name.
Nexpose.SharedCredential.account.useWindowsAuthentication boolean Whether to use Windows authentication.
Nexpose.SharedCredential.account.username string Username for the credential.
Nexpose.SharedCredential.description string Description for the credential.
Nexpose.SharedCredential.hostRestriction string Hostname or IP address to restrict the credentials to.
Nexpose.SharedCredential.id number ID of the shared credential.
Nexpose.SharedCredential.name string Name of the credential.
Nexpose.SharedCredential.portRestriction number Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `hostRestriction` is used.
Nexpose.SharedCredential.siteAssignment string Site assignment configuration for the credential.
Nexpose.SharedCredential.sites array List of site IDs for the shared credential that are explicitly assigned access to the shared scan credential, allowing it to use the credential during a scan.

Command example

!nexpose-list-shared-credential limit=3

Context Example

{
    "Nexpose": {
        "SharedCredential": [
            {
                "account": {
                    "authenticationType": "md5",
                    "privacyType": "no-privacy",
                    "service": "snmpv3",
                    "username": "test"
                },
                "id": 1,
                "name": "shared credentials",
                "siteAssignment": "specific-sites",
                "sites": [
                    1
                ]
            },
            {
                "account": {
                    "service": "as400",
                    "username": "test"
                },
                "id": 2,
                "name": "shared credentials",
                "siteAssignment": "specific-sites",
                "sites": [
                    1
                ]
            },
            {
                "account": {
                    "permissionElevation": "sudosu",
                    "permissionElevationUsername": "test",
                    "service": "ssh",
                    "username": "test"
                },
                "id": 3,
                "name": "shared credentials",
                "siteAssignment": "specific-sites",
                "sites": [
                    1
                ]
            }
        ]
    }
}

Human Readable Output

Nexpose Shared Credentials

Id Name Service UserName
1 shared credentials snmpv3 test
2 shared credentials as400 test
3 shared credentials ssh test

nexpose-list-site-scan-credential


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Retrieve information about all or a specific sca credential.

Base Command

nexpose-list-site-scan-credential

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
credential_id ID of a specific scan credential to retrieve. Optional
limit A number of records to limit the response to. Default is 10. Optional

Context Output

Path Type Description
Nexpose.SiteScanCredential.account.authenticationType string SNMPv3 authentication type for the credential.
Nexpose.SiteScanCredential.account.communityName string SNMP community for authentication.
Nexpose.SiteScanCredential.account.database string Database name.
Nexpose.SiteScanCredential.account.domain string Domain address.
Nexpose.SiteScanCredential.account.enumerateSids boolean Whether the scan engine should attempt to enumerate SIDs from the environment.
Nexpose.SiteScanCredential.account.notesIDPassword string Password for the notes account that will be used for authenticating.
Nexpose.SiteScanCredential.account.ntlmHash string NTLM password hash.
Nexpose.SiteScanCredential.account.oracleListenerPassword string The Oracle Net Listener password. Used to enumerate SIDs from the environment.
Nexpose.SiteScanCredential.account.password string Password for the credential.
Nexpose.SiteScanCredential.account.pemKey string PEM formatted private key.
Nexpose.SiteScanCredential.account.permissionElevation string Elevation type to use for scans.
Nexpose.SiteScanCredential.account.permissionElevationPassword string Password to use for elevation.
Nexpose.SiteScanCredential.account.permissionElevationUserName string Username to use for elevation.
Nexpose.SiteScanCredential.account.privacyPassword string SNMPv3 privacy password to use.
Nexpose.SiteScanCredential.account.privacyType string SNMPv3 privacy protocol to use.
Nexpose.SiteScanCredential.account.privateKeyPassword string Password for the private key.
Nexpose.SiteScanCredential.account.realm string HTTP realm.
Nexpose.SiteScanCredential.account.service string Credential service type.
Nexpose.SiteScanCredential.account.sid string Oracle database name.
Nexpose.SiteScanCredential.account.useWindowsAuthentication boolean Whether to use Windows authentication.
Nexpose.SiteScanCredential.account.username string Username for the credential.
Nexpose.SiteScanCredential.description string Description for the credential.
Nexpose.SiteScanCredential.hostRestriction string Hostname or IP address to restrict the credentials to.
Nexpose.SiteScanCredential.id number ID of the credential.
Nexpose.SiteScanCredential.name string Name of the credential.
Nexpose.SiteScanCredential.portRestriction number Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `hostRestriction` is used.

nexpose-list-vulnerability-exceptions


Retrieve information about scan schedules for a specific site or a specific scan schedule.

Base Command

nexpose-list-vulnerability-exceptions

Input

Argument Name Description Required
id ID of the vulnerability exception to retrieve. If not set, retrieve all vulnerability exceptions. Optional
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
sort Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a “;”. For example: “riskScore,DESC;hostName,ASC”. Default is submit.date,ASC. Optional
limit A number of records to limit the response to. Default is 10. Optional

Context Output

Path Type Description
Nexpose.VulnerabilityException.expires string The date and time the vulnerability exception is set to expire.
Nexpose.VulnerabilityException.id int The The identifier of the vulnerability exception.
Nexpose.VulnerabilityException.scope.id int The identifier of the vulnerability to which the exception applies.
Nexpose.VulnerabilityException.scope.key string If the scope type is “Instance”, an optional key to discriminate the instance the exception applies to.
Nexpose.VulnerabilityException.scope.port int If the scope type is “Instance” and the vulnerability is detected on a service, the port on which the exception applies.
Nexpose.VulnerabilityException.scope.type string The type of the exception scope. One of: “Global”, “Site”, “Asset”, “Asset Group”, “Instance”.
Nexpose.VulnerabilityException.scope.vulnerability string The identifier of the vulnerability to which the exception applies.
Nexpose.VulnerabilityException.state string The state of the vulnerability exception. One of: “Deleted”, “Expired”, “Approved”, “Rejected”, `“Under Review”.
Nexpose.VulnerabilityException.submit.comment string A comment from the submitter as to why the exception was submitted.
Nexpose.VulnerabilityException.submit.date string The date and time the vulnerability exception was submitted.
Nexpose.VulnerabilityException.submit.name string The login name of the user who submitted the vulnerability exception.
Nexpose.VulnerabilityException.submit.reason string The reason the vulnerability exception was submitted. One of: “False Positive”, “Compensating Control”, “Acceptable Use”, “Acceptable Risk”, “Other”
Nexpose.VulnerabilityException.submit.user int The identifier of the user who submitted the vulnerability exception.

Command example

!nexpose-list-vulnerability-exceptions sort="submit.date,ASC" limit=3

Context Example

{
    "Nexpose": {
        "VulnerabilityException": [
            {
                "expires": "2028-03-01T04:31:56Z",
                "id": 1,
                "review": {
                    "comment": "Auto approved by submitter.",
                    "date": "2022-10-31T14:39:15.736Z",
                    "name": "admin",
                    "user": 1
                },
                "scope": {
                    "type": "global",
                    "vulnerability": "tlsv1_0-enabled"
                },
                "state": "approved",
                "submit": {
                    "date": "2022-06-29T16:10:06.616880Z",
                    "name": "admin",
                    "reason": "false positive",
                    "user": 1
                }
            },
            {
                "id": 2,
                "review": {
                    "date": "2022-10-30T13:54:31.084Z",
                    "name": "admin",
                    "user": 1
                },
                "scope": {
                    "type": "global",
                    "vulnerability": "php-cve-2018-10545"
                },
                "state": "rejected",
                "submit": {
                    "date": "2022-07-13T13:27:31.647402Z",
                    "name": "admin",
                    "reason": "acceptable use",
                    "user": 1
                }
            },
            {
                "id": 3,
                "scope": {
                    "type": "global",
                    "vulnerability": "cifs-smb-signing-disabled"
                },
                "state": "under review",
                "submit": {
                    "date": "2022-10-27T11:40:34.109268Z",
                    "name": "admin",
                    "reason": "acceptable use",
                    "user": 1
                }
            }
        ]
    }
}

Human Readable Output

Nexpose Vulnerability Exceptions

Id Vulnerability ExceptionScope Reason ReportedBy ReviewStatus ReviewedOn ExpiresOn
1 tlsv1_0-enabled global false positive admin approved 2022-10-31T14:39:15.736Z 2028-03-01T04:31:56Z
2 php-cve-2018-10545 global acceptable use admin rejected 2022-10-30T13:54:31.084Z  
3 cifs-smb-signing-disabled global acceptable use admin under review    

nexpose-start-site-scan


Starts a scan for the specified site.

Base Command

nexpose-start-site-scan

Input

Argument Name Description Required
site ID of the site. Optional
site_name Name of the site (can be used instead of site). Optional
hosts Specific host(s) on the site to run the scan on. Can be an IP address or a hostname. Can be a comma-separated list. Optional
name Scan name. Optional

Context Output

Path Type Description
Nexpose.Scan.Id number The identifier of the scan.
Nexpose.Scan.ScanType string The scan type (automated, manual, scheduled).
Nexpose.Scan.StartedBy date The name of the user who started the scan.
Nexpose.Scan.Assets number The number of assets found in the scan.
Nexpose.Scan.TotalTime string The duration of the scan in minutes.
Nexpose.Scan.Completed date The end time of the scan in ISO8601 format.
Nexpose.Scan.Status string The scan status. Valid values are aborted, unknown, running, finished, stopped, error, paused, dispatched, integrating.
Nexpose.Scan.Vulnerabilities.Critical number The number of critical vulnerabilities.
Nexpose.Scan.Vulnerabilities.Moderate number The number of moderate vulnerabilities.
Nexpose.Scan.Vulnerabilities.Severe number The number of severe vulnerabilities.
Nexpose.Scan.Vulnerabilities.Total number The total number of vulnerabilities.

nexpose-stop-scan


Stop a running scan.

Base Command

nexpose-stop-scan

Input

Argument Name Description Required
id ID of a running scan. Required

nexpose-pause-scan


Pause a running scan.

Base Command

nexpose-pause-scan

Input

Argument Name Description Required
id ID of a running scan. Required

nexpose-resume-scan


Resume a paused scan.

Base Command

nexpose-resume-scan

Input

Argument Name Description Required
id ID of a paused scan. Required

nexpose-get-scans


Return a list of scans. Returns only active scans by default (active=true).

Base Command

nexpose-get-scans

Input

Argument Name Description Required
active Whether to return only active scans. Possible values are: true, false. Default is true. Optional
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
limit A number of records to limit the response to. Default is 10. Optional
sort Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a “;”. For example: “riskScore,DESC;hostName,ASC”. Optional

Context Output

Path Type Description
Nexpose.Scan.Id number The identifier of the scan.
Nexpose.Scan.ScanType string The scan type (automated, manual, scheduled).
Nexpose.Scan.StartedBy date The name of the user who started the scan.
Nexpose.Scan.Assets number The number of assets found in the scan
Nexpose.Scan.TotalTime string The duration of the scan in minutes.
Nexpose.Scan.Completed date The end time of the scan in ISO8601 format.
Nexpose.Scan.Status string The scan status. Valid values are aborted, unknown, running, finished, stopped, error, paused, dispatched, integrating.

Command example

!nexpose-get-scans active=false limit=3

Context Example

{
    "Nexpose": {
        "Scan": [
            {
                "Assets": 0,
                "Completed": "2019-12-03T20:48:01.368Z",
                "Id": 1,
                "Message": null,
                "ScanName": "Tue 03 Dec 2019 10:47 PM",
                "ScanType": "Manual",
                "StartedBy": null,
                "Status": "finished",
                "TotalTime": "51.316 seconds"
            },
            {
                "Assets": 0,
                "Completed": "2019-12-03T20:53:09.453Z",
                "Id": 2,
                "Message": null,
                "ScanName": "Tue 03 Dec 2019 10:52 PM",
                "ScanType": "Manual",
                "StartedBy": null,
                "Status": "finished",
                "TotalTime": "29.91 seconds"
            },
            {
                "Assets": 0,
                "Completed": "2019-12-03T21:01:33.970Z",
                "Id": 3,
                "Message": null,
                "ScanName": "scan 2019-12-03 19:58:25.961787",
                "ScanType": "Manual",
                "StartedBy": null,
                "Status": "finished",
                "TotalTime": "28.904 seconds"
            }
        ]
    }
}

Human Readable Output

Nexpose Scans

Id ScanType ScanName Assets TotalTime Completed Status
1 Manual Tue 03 Dec 2019 10:47 PM 0 51.316 seconds 2019-12-03T20:48:01.368Z finished
2 Manual Tue 03 Dec 2019 10:52 PM 0 29.91 seconds 2019-12-03T20:53:09.453Z finished
3 Manual scan 2019-12-03 19:58:25.961787 0 28.904 seconds 2019-12-03T21:01:33.970Z finished

nexpose-disable-shared-credential


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Disable an assigned shared credential.

Base Command

nexpose-disable-shared-credential

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
credential_id ID of the scan schedule to update. Required

nexpose-download-report


Returns the generated report.

Base Command

nexpose-download-report

Input

Argument Name Description Required
report_id ID of the report. Required
instance_id ID of the report instance. Supports a “latest” value. Required
name Report name. Optional
format Report format (uses PDF by default). Possible values are: pdf, rtf, xml, html, text, nexpose-simple-xml. Default is pdf. Optional

Context Output

Path Type Description
InfoFile.EntryId string Entry ID of the report file.
InfoFile.Name string Name of the report file.
InfoFile.Extension string File extension of the report file.
InfoFile.Info string Information about the report file.
InfoFile.Size number Size of the report file (in bytes).
InfoFile.Type string Type of the report file.

Command example

!nexpose-download-report report_id=1 instance_id=latest

Context Example

{
    "InfoFile": {
        "EntryID": "4127@403762e2-be4e-4f12-8a17-26cdb21b129e",
        "Extension": "pdf",
        "Info": "application/pdf",
        "Name": "report 2022-11-30 09:25:43.835638.pdf",
        "Size": 76699,
        "Type": "PDF document, version 1.4"
    }
}

nexpose-enable-shared-credential


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Enable an assigned shared credential.

Base Command

nexpose-enable-shared-credential

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
credential_id ID of the scan schedule to update. Required

nexpose-get-report-status


Returns the status of a report generation process.

Base Command

nexpose-get-report-status

Input

Argument Name Description Required
report_id ID of the report. Required
instance_id ID of the report instance. Supports a “latest” value. Required

Context Output

Path Type Description
Nexpose.Report.ID string The identifier of the report.
Nexpose.Report.InstanceID string The identifier of the report instance.
Nexpose.Report.Status string The status of the report generation process. Valid values: “aborted”, “failed”, “complete”, “running”, “unknown”.

Command example

!nexpose-get-report-status report_id=1 instance_id=latest

Context Example

{
    "Nexpose": {
        "Report": {
            "ID": "1",
            "InstanceID": "latest",
            "Status": "complete"
        }
    }
}

Human Readable Output

Report Generation Status

ID InstanceID Status
1 latest complete

nexpose-update-scan-schedule


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Update an existing site scan schedule.

Base Command

nexpose-update-scan-schedule

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
schedule_id ID of the scan schedule to update. Optional
enabled A flag indicating whether the scheduled scan is enabled. Possible values are: True, False. Default is True. Optional
on_scan_repeat The desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching its maximum duration. Possible values are: Restart-Scan, Resume-Scan. Required
start The scheduled start date and time formatted in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time. Required
excluded_asset_group_ids A list of IDs for asset groups to exclude from the scan. Optional
excluded_addresses A list of addresses to exclude from the scan. Optional
included_asset_group_ids A list of IDs for asset groups to include in the scan. Optional
included_addresses A list of addresses to include in the scan. Optional
duration_days Maximum duration of the scan in days. Optional
duration_hours Maximum duration of the scan in hours. Optional
duration_minutes Maximum duration of the scan in minutes. Optional
frequency How frequently should the schedule repeat (Every…). Possible values are: Hour, Day, Week, Date-of-month. Optional
interval_time The interval time the schedule should repeat. This depends on the value set in frequency. For example, if the value of frequency is set to “Day” and interval is set to 2, then the schedule will repeat every 2 days. Required only if frequency is used. Optional
date_of_month Specifies the schedule repeat day of the interval month. For example, if date_of_month is 17 and interval is set to 2, then the schedule will repeat every 2 months on the 17th day of the month. Required and used only if frequency is set to Date of month. Optional
scan_name A unique user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching. Optional
scan_template ID of the scan template to use. Optional

Context Output

There is no context output for this command.

nexpose-update-site-scan-credential


Note:
This command couldn’t have been tested on our side, and therefore could have issues. Please let us know if you encounter any bugs or issues.

Update an existing site scan credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/setSiteCredentials.

Base Command

nexpose-update-site-scan-credential

Input

Argument Name Description Required
site_id ID of the site. Optional
site_name Name of the site (can be used instead of site_id). Optional
credential_id ID of the site scan credential to update. Required
name Name of the credential. Required
service Credential service type. Possible values are: AS400, CIFS, CIFSHash, CVS, DB2, FTP, HTTP, MS-SQL, MySQL, Notes, Oracle, POP, PostgresSQL, Remote-Exec, SNMP, SNMPv3, SSH, SSH-Key, Sybase, Telnet. Required
database Database name. Optional
description Description for the credential. Optional
domain Domain address. Optional
host_restriction Hostname or IP address to restrict the credentials to. Optional
http_realm HTTP realm. Optional
notes_id_password Password for the notes account that will be used for authenticating. Optional
ntlm_hash NTLM password hash. Optional
oracle_enumerate_sids Whether the scan engine should attempt to enumerate SIDs from the environment. Possible values are: true, false. Optional
oracle_listener_password Oracle Net Listener password. Used to enumerate SIDs from your environment. Optional
oracle_sid Oracle database name. Optional
password Password for the credential. Optional
port_restriction Further restricts the credential to attempt to authenticate on a specific port. Can be used only if host_restriction is used. Optional
community_name SNMP community for authentication. Optional
authentication_type SNMPv3 authentication type for the credential. Possible values are: No-Authentication, MD5, SHA. Optional
privacy_password SNMPv3 privacy password to use. Optional
privacy_type SNMPv3 Privacy protocol to use. Possible values are: No-Privacy, DES, AES-128, AES-192, AES-192-With-3-DES-Key-Extension, AES-256, AES-256-With-3-DES-Key-Extension. Optional
ssh_key_pem PEM formatted private key. Optional
ssh_permission_elevation Elevation type to use for scans. Possible values are: None, sudo, sudosu, su, pbrun, Privileged Exec. Optional
ssh_permission_elevation_password Password to use for elevation. Optional
ssh_permission_elevation_username Username to use for elevation. Optional
ssh_private_key_password Password for the private key. Optional
use_windows_authentication Whether to use Windows authentication. Possible values are: true, false. Optional
username Username for the credential. Optional

Context Output

There is no context output for this command.

nexpose-update-vulnerability-exception-expiration


Update an existing vulnerability exception.

Base Command

nexpose-update-vulnerability-exception-expiration

Input

Argument Name Description Required
id ID of the vulnerability exception to update. Required
expiration An expiration date for the vulnerability exception formatted in ISO 8601 format. Must be a date in the future. Required

Command example

!nexpose-update-vulnerability-exception-expiration id=1 expiration=2024-10-10T10:00:00Z

Human Readable Output

Successfully updated expiration date of vulnerability exception 1.

nexpose-update-vulnerability-exception-status


Update an existing vulnerability exception.

Base Command

nexpose-update-vulnerability-exception-status

Input

Argument Name Description Required
id ID of the vulnerability exception to update. Required
status A status to update the vulnerability exception to. Possible values are: Recall, Approve, Reject. Required

Command example

!nexpose-update-vulnerability-exception-status id=1 status=Approve

Human Readable Output

Successfully updated status of vulnerability exception 1.

nexpose-update-shared-credential


Update an existing shared credential.

Base Command

nexpose-update-shared-credential

Input

Argument Name Description Required
id ID of the shared credential to update. Required
name Name of the credential. Required
site_assignment Site assignment configuration for the credential. Assign the shared scan credential either to be available to all sites, or a specific list of sites. Possible values are: All-Sites, Specific-Sites. Required
service Credential service type. Possible values are: AS400, CIFS, CIFSHash, CVS, DB2, FTP, HTTP, MS-SQL, MySQL, Notes, Oracle, POP, PostgresSQL, Remote-Exec, SNMP, SNMPv3, SSH, SSH-Key, Sybase, Telnet. Required
database Database name. Optional
description Description for the credential. Optional
domain Domain address. Optional
host_restriction Hostname or IP address to restrict the credentials to. Optional
http_realm HTTP realm. Optional
notes_id_password Password for the notes account that will be used for authenticating. Optional
ntlm_hash NTLM password hash. Optional
oracle_enumerate_sids Whether the scan engine should attempt to enumerate SIDs from the environment. Possible values are: true, false. Optional
oracle_listener_password Oracle Net Listener password. Used to enumerate SIDs from your environment. Optional
oracle_sid Oracle database name. Optional
password Password for the credential. Optional
port_restriction Further restricts the credential to attempt to authenticate on a specific port. Can be used only if host_restriction is used. Optional
sites List of site IDs for the shared credential that are explicitly assigned access to the shared scan credential, allowing it to use the credential during a scan. Optional
community_name SNMP community for authentication. Optional
authentication_type SNMPv3 authentication type for the credential. Possible values are: No-Authentication, MD5, SHA. Optional
privacy_password SNMPv3 privacy password to use. Optional
privacy_type SNMPv3 Privacy protocol to use. Possible values are: No-Privacy, DES, AES-128, AES-192, AES-192-With-3-DES-Key-Extension, AES-256, AES-256-With-3-DES-Key-Extension. Optional
ssh_key_pem PEM formatted private key. Optional
ssh_permission_elevation Elevation type to use for scans. Possible values are: None, sudo, sudosu, su, pbrun, Privileged-Exec. Optional
ssh_permission_elevation_password Password to use for elevation. Optional
ssh_permission_elevation_username Username to use for elevation. Optional
ssh_private_key_password Password for the private key. Optional
use_windows_authentication Whether to use Windows authentication. Possible values are: true, false. Optional
username Username for the credential. Optional

Context Output

There is no context output for this command.

nexpose-add-site-included-asset


Base Command

nexpose-add-site-included-asset

Input

Argument Name Description Required
site_id A URL parameter. Required
assets List of addresses to add to the site’s included scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation. Optional
asset_group_ids List of asset group identifiers. Optional

Context Output

There is no context output for this command.

Command example

!nexpose-add-site-included-asset site_id=848 assets=8.8.8.8

Human Readable Output

Added assets 8.8.8.8 to site with ID 848

nexpose-remove-tag-asset


Remove an asset from a tag. Note that the asset must be added through the asset or tag. If the asset is added using a site, asset group, or search criteria, this action will not remove the asset from the tag.

Base Command

nexpose-remove-tag-asset

Input

Argument Name Description Required
tag_id The tag ID. Required
asset_id The asset ID. Required

Context Output

There is no context output for this command.

Command example

!nexpose-remove-tag-asset asset_id=25 tag_id=61

Human Readable Output

Asset 25 was removed from tag 61 successfully

nexpose-list-tag-asset


Return a list of assets for a tag.

Base Command

nexpose-list-tag-asset

Input

Argument Name Description Required
tag_id The tag ID. Required

Context Output

Path Type Description
Nexpose.TagAsset.id int Asset ID.
Nexpose.TagAsset.sources string The asset sources.

Command example

!nexpose-list-tag-asset tag_id=33

Context Example

{
    "Nexpose": {
        "TagAsset": [
            {
                "id": 18,
                "sources": [
                    "tag"
                ]
            },
            {
                "id": 25,
                "sources": [
                    "tag"
                ]
            },
            {
                "id": 28,
                "sources": [
                    "tag"
                ]
            }
        ]
    }
}

Human Readable Output

Tag 33 assets

Id Sources
18 tag
25 tag
28 tag

nexpose-delete-tag


Delete a tag.

Base Command

nexpose-delete-tag

Input

Argument Name Description Required
id The tag ID. Required

Context Output

There is no context output for this command.

nexpose-list-site-included-asset


Return a list of included assets for a site.

Base Command

nexpose-list-site-included-asset

Input

Argument Name Description Required
site_id A URL parameter. Required

Context Output

Path Type Description
Nexpose.IncludedAsset.site_id int The site ID.
Nexpose.IncludedAsset.addresses string A list of addresses of the included assets for the specified site.

Command example

!nexpose-list-site-included-asset site_id=848

Context Example

{
    "Nexpose": {
        "IncludedAsset": {
            "addresses": [
                "8.8.8.8",
                "1.1.1.1"
            ],
            "site_id": 848
        }
    }
}

Human Readable Output

Asset list for site ID 848

Addresses
8.8.8.8
1.1.1.1

nexpose-list-site-excluded-asset-group


Return a list of excluded asset groups for a site.

Base Command

nexpose-list-site-excluded-asset-group

Input

Argument Name Description Required
site_id A URL parameter. Required

Context Output

Path Type Description
Nexpose.ExcludedAssetGroup.site_id int The site ID.
Nexpose.ExcludedAssetGroup.resources int The asset group ID.

Command example

!nexpose-list-site-excluded-asset-group site_id=848

Context Example

{
    "Nexpose": {
        "ExcludedAssetGroup": {
            "resources": [],
            "site_id": 848
        }
    }
}

nexpose-list-site-included-asset-group


Return a list of included asset groups for a site.

Base Command

nexpose-list-site-included-asset-group

Input

Argument Name Description Required
site_id A URL parameter. Required

Context Output

Path Type Description
Nexpose.IncludedAssetGroup.site_id int The site ID.
Nexpose.IncludedAssetGroup.resources int The asset group ID.

Command example

!nexpose-list-site-included-asset-group site_id=848

Context Example

{
    "Nexpose": {
        "IncludedAssetGroup": {
            "resources": [],
            "site_id": 848
        }
    }
}

Human Readable Output

Asset group list for site ID 848

No entries.

nexpose-remove-tag-asset-group


Remove an asset group from a tag.

Base Command

nexpose-remove-tag-asset-group

Input

Argument Name Description Required
tag_id The tag ID. Required
asset_group_id The asset group ID. Required

Context Output

There is no context output for this command.

Command example

!nexpose-remove-tag-asset-group asset_group_id=1 tag_id=61

Human Readable Output

Asset group 1 was removed from tag 61 successfully

nexpose-create-tag


Create a tag.

Base Command

nexpose-create-tag

Input

Argument Name Description Required
name The tag name. Required
type The tag type. Possible values are: Owner, Location, Custom. Required
color The tag color - relevant only for “Custom” type. Possible values are: Blue, Green, Orange, Red, Purple, Default. Default is Default. Optional
ip_address_is A specific IP address to search for. Optional
host_name_is A specific host name to search for. Optional
risk_score_higher_than A minimum risk score to use as a filter. Optional
vulnerability_title_contains A string to search for in vulnerability titles. Optional
site_id_in Site IDs to filter for. Can be a comma-separated list. Optional
site_name_in Site names to filter for. Can be a comma-separated list. Optional
match Operator to determine how to match filters. “All” requires that all filters match for an asset to be included. “Any” requires only one filter to match for an asset to be included. Possible values are: All, Any. Default is Any. Optional
query Additional queries to use as a filter, following the Search Criteria API standard. The structure is {field} {operator} {value}. Multiple queries can be specified, separated by a “;” separator. For example, ‘ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost’. Optional

Context Output

Path Type Description
Nexpose.Tag.id int The tag ID.

nexpose-add-tag-asset


Add an existing asset to an existing tag.

Base Command

nexpose-add-tag-asset

Input

Argument Name Description Required
tag_id The tag ID. Required
asset_id The asset ID. Required

Context Output

There is no context output for this command.

Command example

!nexpose-add-tag-asset asset_id=25 tag_id=61

Human Readable Output

Asset 25 was added in tag 61 successfully

nexpose-remove-site-excluded-asset


Remove excluded assets from a site.

Base Command

nexpose-remove-site-excluded-asset

Input

Argument Name Description Required
site_id A URL parameter. Required
assets List of addresses to remove from the site’s excluded scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation. Optional
asset_group_ids List of asset group IDs to remove from the site’s exclusion list. Optional

Context Output

There is no context output for this command.

Command example

!nexpose-remove-site-excluded-asset site_id=848 assets=8.8.8.8

Human Readable Output

Removed assets 8.8.8.8 from site with ID 848

nexpose-remove-site-included-asset


Base Command

nexpose-remove-site-included-asset

Input

Argument Name Description Required
site_id A URL parameter. Required
assets List of addresses to remove from the site’s included scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation. Optional
asset_group_ids List of asset group identifiers. Optional

Context Output

There is no context output for this command.

Command example

!nexpose-remove-site-included-asset site_id=848 assets=8.8.8.8

Human Readable Output

Removed assets 8.8.8.8 from site with ID 848

nexpose-update-tag-search-criteria


Update tag search criteria.

Base Command

nexpose-update-tag-search-criteria

Input

Argument Name Description Required
tag_id The tag ID. Required
ip_address_is A specific IP address to search for. Optional
host_name_is A specific host name to search for. Optional
risk_score_higher_than A minimum risk score to use as a filter. Optional
vulnerability_title_contains A string to search for in vulnerability titles. Optional
site_id_in Site IDs to filter for. Can be a comma-separated list. Optional
site_name_in Site names to filter for. Can be a comma-separated list. Optional
match Operator to determine how to match filters. “All” requires that all filters match for an asset to be included. “Any” requires only one filter to match for an asset to be included. Possible values are: All, Any. Default is Any. Optional
query Additional queries to use as a filter, following the Search Criteria API standard. The structure is {field} {operator} {value}. Multiple queries can be specified, separated by a “;” separator. For example, ‘ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost’. Optional
overwrite Whether to overwrite the original search values or append new conditions to the existing search. Possible values are: yes, no. Default is no. Optional

Context Output

There is no context output for this command.

nexpose-add-tag-asset-group


Add existing asset groups to an existing tag.()

Base Command

nexpose-add-tag-asset-group

Input

Argument Name Description Required
tag_id The tag ID. Required
asset_group_ids The asset group IDs to add. Can be a comma-separated list. Required

Context Output

There is no context output for this command.

nexpose-list-site-excluded-asset


Return a list of excluded assets for a site.

Base Command

nexpose-list-site-excluded-asset

Input

Argument Name Description Required
site_id A URL parameter. Required

Context Output

Path Type Description
Nexpose.ExcludedAsset.site_id int The site ID.
Nexpose.ExcludedAsset.addresses string A list of addresses of the excluded assets for the specified site.

Command example

!nexpose-list-site-excluded-asset site_id=848

Context Example

{
    "Nexpose": {
        "ExcludedAsset": {
            "site_id": 848
        }
    }
}

Human Readable Output

Asset list for site ID 848

No entries.

nexpose-list-tag-asset-group


Return a list of asset groups for a tag.

Base Command

nexpose-list-tag-asset-group

Input

Argument Name Description Required
tag_id The tag ID. Required

Context Output

Path Type Description
Nexpose.TagAssetGroup.id int Asset group ID.

Command example

!nexpose-list-tag-asset-group tag_id=2

Context Example

{
    "Nexpose": {
        "TagAssetGroup": [
            3
        ]
    }
}

Human Readable Output

Tag 2 asset groups

Asset groups IDs
3

nexpose-list-tag


Return a list of tags.

Base Command

nexpose-list-tag

Input

Argument Name Description Required
id Get tag by ID. Optional
name Filters the returned tags to only those containing the value within their name. Optional
type Filters the returned tags to only those of this type. Optional
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
limit A number of records to limit the response to. Optional

Context Output

Path Type Description
Nexpose.Tag.color String The color associated with the tag.
Nexpose.Tag.created Date The date when the tag was created.
Nexpose.Tag.id Number The unique identifier of the tag.
Nexpose.Tag.name String The name of the tag.
Nexpose.Tag.searchCriteria.match String The match criteria used for the tag search (e.g., “all” or “any”).
Nexpose.Tag.searchCriteria.filters.field String The field name used in the tag search filter.
Nexpose.Tag.searchCriteria.filters.operator String The operator used in the tag search filter (e.g., “is”, “contains”, “is-greater-than”).
Nexpose.Tag.searchCriteria.filters.lower String The lower bound of the range used in the tag search filter.
Nexpose.Tag.searchCriteria.filters.upper String The upper bound of the range used in the tag search filter.
Nexpose.Tag.source String The source of the tag.
Nexpose.Tag.type String The type of the tag.
Nexpose.Tag.searchCriteria.filters.value String The value used in the tag search filter.
Nexpose.Tag.page.number Number The current page number in the paginated response.
Nexpose.Tag.page.size Number The number of items per page in the paginated response.
Nexpose.Tag.page.totalResources Number The total number of resources available.
Nexpose.Tag.page.totalPages Number The total number of pages available.

Command example

!nexpose-list-tag limit=2 name=test

Context Example

{
    "resources": [
        {
            "color": "default",
            "created": "2024-05-06T13:32:58.454Z",
            "id": 45,
            "name": "test",
            "searchCriteria": {
                "match": "all",
                "filters": [
                    {
                        "field": "risk-score",
                        "operator": "in-range",
                        "lower": "193.841",
                        "upper": "187.841"
                    }
                ]
            },
            "source": "custom",
            "type": "Owner"
        },
        {
            "color": "default",
            "created": "2024-05-06T13:43:52.874Z",
            "id": 46,
            "name": "new_test2",
            "searchCriteria": {
                "match": "any",
                "filters": [
                    {
                        "field": "ip-address",
                        "operator":"is",
                        "value":"3.3.3.3"
                    }
                ]
            },
            "source": "custom",
            "type": "Owner"
        }
    ],
    "page": {
        "number": 0,
        "size": 2,
        "totalResources": 8,
        "totalPages": 4
    }
}

nexpose-add-site-excluded-asset


Add excluded assets to a site.

Base Command

nexpose-add-site-excluded-asset

Input

Argument Name Description Required
site_id A URL parameter. Required
assets List of addresses to add to the site’s excluded scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation. Optional
asset_group_ids List of asset group IDs to exclude. Optional

Context Output

There is no context output for this command.

Command example

!nexpose-add-site-excluded-asset site_id=848 assets=8.8.8.8

Human Readable Output

Added assets 8.8.8.8 to site with ID 848

nexpose-list-asset-group


Return a list of asset groups.

Base Command

nexpose-list-asset-group

Input

Argument Name Description Required
group_id Get asset group by ID. Optional
group_name Filters the returned asset groups to only those containing the value within their name. Optional
type Filters the returned asset groups to only those of this type. Possible values are: static, dynamic. Optional
page_size Number of records to retrieve in each API call when pagination is used. Optional
page A specific page to retrieve when pagination is used. Page indexing starts at 0. Optional
limit A number of records to limit the response to. Optional
sort The criteria to sort the records by, in the format property[,ASC|DESC]. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. Optional

Context Output

Path Type Description
Nexpose.AssetGroup.assets Number The number of assets in the asset group.
Nexpose.AssetGroup.id Number The unique identifier of the asset group.
Nexpose.AssetGroup.name String The name of the asset group.
Nexpose.AssetGroup.riskScore Number The cumulative risk score of the asset group.
Nexpose.AssetGroup.type String The type of the asset group.
Nexpose.AssetGroup.vulnerabilities.critical Number The number of critical vulnerabilities in the asset group.
Nexpose.AssetGroup.vulnerabilities.moderate Number The number of moderate vulnerabilities in the asset group.
Nexpose.AssetGroup.vulnerabilities.severe Number The number of severe vulnerabilities in the asset group.
Nexpose.AssetGroup.vulnerabilities.total Number The total number of vulnerabilities in the asset group.
Nexpose.AssetGroup.description String The description of the asset group.

Command example

!nexpose-list-asset-group limit=2

nexpose-create-asset-group


Create an asset group.

Base Command

nexpose-create-asset-group

Input

Argument Name Description Required
name The asset group name. Required
type The asset group type. Possible values are: static, dynamic. Required
description The description of the asset group. Required
ip_address_is A specific IP address to search for. Optional
host_name_is A specific host name to search for. Optional
risk_score_higher_than A minimum risk score to use as a filter. Optional
vulnerability_title_contains A string to search for in vulnerability titles. Optional
site_id_in Site IDs to filter for. Can be a comma-separated list. Optional
site_name_in Site names to filter for. Can be a comma-separated list. Optional
match Operator to determine how to match filters. “All” requires that all filters match for an asset to be included. “Any” requires only one filter to match for an asset to be included. Possible values are: All, Any. Default is Any. Optional
query Additional queries to use as a filter, following the Search Criteria API standard. The structure is {field} {operator} {value}. Multiple queries can be specified, separated by a “;” separator. For example, ‘ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost’. Optional

Context Output

Path Type Description
Nexpose.AssetGroup.id int The asset group ID.

Command example

!nexpose-create-asset-group name=test3 type=dynamic ip_address_is=1.1.1.1 query=`risk-score is-greater-than 8000` escription=test

<~PLATFORM>

License Requirements

The following configuration parameters require Cortex XSIAM with the Exposure Management add-on:

  • Fetch Assets

</~PLATFORM>

Configuration parameters

  • server — Server URL (e.g., https://192.0.2.0:8080) (required)
  • credentials — Username (required)
  • token — 2FA Token
  • unsecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings
  • connection_error_retries — Number of connection error retries
  • isFetchAssets — Fetch Assets
  • assetsFetchInterval — Assets Fetch Interval

Commands (64)

  • nexpose-add-site-excluded-asset

    Add excluded assets to a site.

  • nexpose-add-site-included-asset

    Add included assets to a site.

  • nexpose-add-tag-asset

    Add an existing asset to an existing tag.

  • nexpose-add-tag-asset-group

    Add existing asset groups to an existing tag.

  • nexpose-create-asset

    Create a new asset.

  • nexpose-create-asset-group

    Create an asset group. Note: All filters are relevant only for Dynamic asset groups.

  • nexpose-create-assets-report

    Generates a new report on given assets according to a template and arguments.

  • nexpose-create-scan-report

    Generates a new report for a specified scan.

  • nexpose-create-scan-schedule

    Beta Command Create a new site scan schedule.

  • nexpose-create-shared-credential

    Create a new shared credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/createSharedCredential

  • nexpose-create-site

    Creates a new site with the specified configuration.

  • nexpose-create-site-scan-credential

    Beta Command Create a new site scan credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/createSiteCredential

  • nexpose-create-sites-report

    Generates a new report on given sites according to a template and arguments.

  • nexpose-create-tag

    Create a tag.

  • nexpose-create-vulnerability-exception

    Create a new vulnerability exception.

  • nexpose-delete-asset

    Delete an asset.

  • nexpose-delete-scan-schedule

    Delete a scheduled scan.

  • nexpose-delete-shared-credential

    Beta Command Delete a shared credential.

  • nexpose-delete-site

    Deletes a site.

  • nexpose-delete-site-scan-credential

    Beta Command Delete a site scan credential.

  • nexpose-delete-tag

    Delete a tag.

  • nexpose-delete-vulnerability-exception

    Delete a vulnerability exception.

  • nexpose-disable-shared-credential

    Beta Command Disable an assigned shared credential.

  • nexpose-download-report

    Returns the generated report.

  • nexpose-enable-shared-credential

    Beta Command Enable an assigned shared credential.

  • nexpose-get-asset

    Returns the specified asset.

  • nexpose-get-asset-tags

    Returns the specified tags for an asset.

  • nexpose-get-asset-vulnerability

    Returns details and possible remediations for an asset's vulnerability.

  • nexpose-get-assets

    Returns all assets for which you have access.

  • nexpose-get-report-status

    Returns the status of a report generation process.

  • nexpose-get-report-templates

    Returns all available report templates.

  • nexpose-get-scan

    Get a specific scan.

  • nexpose-get-scans

    Return a list of scans. Returns only active scans by default (active=true).

  • nexpose-get-sites

    Retrieves accessible sites.

  • nexpose-list-asset-group

    Return a list of asset groups.

  • nexpose-list-assigned-shared-credential

    Retrieve information about shared credentials for a specific site.

  • nexpose-list-scan-schedule

    BetaCommand Retrieve information about scan schedules for a specific site or a specific scan schedule.

  • nexpose-list-shared-credential

    Retrieve information about all or a specific shared credential.

  • nexpose-list-site-excluded-asset

    Return a list of excluded assets for a site.

  • nexpose-list-site-excluded-asset-group

    Return a list of excluded asset groups for a site.

  • nexpose-list-site-included-asset

    Return a list of included assets for a site.

  • nexpose-list-site-included-asset-group

    Return a list of included asset groups for a site.

  • nexpose-list-site-scan-credential

    Beta Command Retrieve information about all or a specific sca credential.

  • nexpose-list-tag

    Return a list of tags.

  • nexpose-list-tag-asset

    Return the tag assets list.

  • nexpose-list-tag-asset-group

    Return a list of asset groups for a tag.

  • nexpose-list-vulnerability

    Retrieve information about all or a specific vulnerability.

  • nexpose-list-vulnerability-exceptions

    Retrieve information about scan schedules for a specific site or a specific scan schedule.

  • nexpose-pause-scan

    Pause a running scan.

  • nexpose-remove-site-excluded-asset

    Remove excluded assets from a site.

  • nexpose-remove-site-included-asset

    Remove included assets from a site.

  • nexpose-remove-tag-asset

    Remove an asset from a tag. Note that the asset must be added through the asset or tag. If the asset is added using a site, asset group, or search criteria, this action will not remove the asset from the tag.

  • nexpose-remove-tag-asset-group

    Remove an asset group from a tag.

  • nexpose-resume-scan

    Resume a paused scan.

  • nexpose-search-assets

    Search and return all assets matching specific filters. Returns only assets the user has access to.

  • nexpose-start-assets-scan Deprecated

    Deprecated. Use `nexpose-start-site-scan` using the `hosts` argument instead.

  • nexpose-start-site-scan

    Starts a scan for the specified site.

  • nexpose-stop-scan

    Stop a running scan.

  • nexpose-update-scan-schedule

    Beta Command Update an existing site scan schedule.

  • nexpose-update-shared-credential

    Update an existing shared credential.

  • nexpose-update-site-scan-credential

    Beta Command Update an existing site scan credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/setSiteCredentials.

  • nexpose-update-tag-search-criteria

    Update tag search criteria.

  • nexpose-update-vulnerability-exception-expiration

    Update an existing vulnerability exception.

  • nexpose-update-vulnerability-exception-status

    Update an existing vulnerability exception.

category: Vulnerability Management
provider: Rapid7
sectionorder:
- Connect
- Collect
commonfields:
  id: Rapid7 Nexpose
  version: -1
configuration:
- display: Server URL (e.g., https://192.0.2.0:8080)
  name: server
  required: true
  type: 0
  section: Connect
- display: Username
  name: credentials
  required: true
  type: 9
  section: Connect
- display: 2FA Token
  name: token
  type: 9
  hiddenusername: true
  displaypassword: 2FA Token
  required: false
  section: Connect
- display: Trust any certificate (not secure)
  name: unsecure
  type: 8
  required: false
  section: Connect
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
  section: Connect
- defaultvalue: '5'
  display: "Number of connection error retries"
  name: connection_error_retries
  additionalinfo: "The number of times to try and re-create connections with rapid7 instance when there are temporary connection errors"
  type: 0
  section: Connect
- display: Fetch Assets
  name: isFetchAssets
  type: 8
  section: Collect
  required: false
  hidden:
  - xsoar
  supportedModules:
  - xsiam
  - exposure_management
- additionalinfo: The interval between asset fetches. Default is 24 hours.
  defaultvalue: 1440
  display: Assets Fetch Interval
  name: assetsFetchInterval
  type: 19
  section: Collect
  advanced: true
  required: false
  hidden:
  - xsoar
  supportedModules:
  - xsiam
  - exposure_management
description: Vulnerability management solution to help reduce threat exposure.
display: Rapid7 InsightVM
name: Rapid7 Nexpose
script:
  commands:
  - arguments:
    - description: Asset ID.
      name: id
      required: true
    description: Returns the specified asset.
    name: nexpose-get-asset
    outputs:
    - contextPath: Nexpose.Asset.Addresses
      description: All addresses discovered on the asset.
      type: unknown
    - contextPath: Nexpose.Asset.AssetId
      description: Id of the asset.
      type: number
    - contextPath: Nexpose.Asset.Hardware
      description: The primary Media Access Control (MAC) address of the asset. The format is six groups of two hexadecimal digits separated by colons.
      type: string
    - contextPath: Nexpose.Asset.Aliases
      description: All host names or aliases discovered on the asset.
      type: unknown
    - contextPath: Nexpose.Asset.HostType
      description: The type of asset. Valid values are unknown, guest, hypervisor, physical, mobile.
      type: string
    - contextPath: Nexpose.Asset.Site
      description: Asset site name.
      type: string
    - contextPath: Nexpose.Asset.OperatingSystem
      description: Operating system of the asset.
      type: string
    - contextPath: Nexpose.Asset.Vulnerabilities
      description: The total number of vulnerabilities on the asset.
      type: number
    - contextPath: Nexpose.Asset.CPE
      description: The Common Platform Enumeration (CPE) of the operating system.
      type: string
    - contextPath: Nexpose.Asset.LastScanDate
      description: Last scan date of the asset.
      type: date
    - contextPath: Nexpose.Asset.LastScanId
      description: ID of the asset's last scan.
      type: number
    - contextPath: Nexpose.Asset.RiskScore
      description: The risk score (with criticality adjustments) of the asset.
      type: number
    - contextPath: Nexpose.Asset.Software.Software
      description: The description of the software.
      type: string
    - contextPath: Nexpose.Asset.Software.Version
      description: The version of the software.
      type: string
    - contextPath: Nexpose.Asset.Services.Name
      description: The name of the service.
      type: string
    - contextPath: Nexpose.Asset.Services.Port
      description: The port of the service.
      type: number
    - contextPath: Nexpose.Asset.Services.Product
      description: The product running the service.
      type: string
    - contextPath: Nexpose.Asset.Services.protocol
      description: The protocol of the service, valid values are ip, icmp, igmp, ggp, tcp, pup, udp, idp, esp, nd, raw.
      type: string
    - contextPath: Nexpose.Asset.Users.FullName
      description: The full name of the user account.
      type: string
    - contextPath: Nexpose.Asset.Users.Name
      description: The name of the user account.
      type: string
    - contextPath: Nexpose.Asset.Users.UserId
      description: The identifier of the user account.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Id
      description: The identifier of the vulnerability.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Instances
      description: The number of vulnerable occurrences of the vulnerability. This does not include invulnerable instances.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Title
      description: The title (summary) of the vulnerability.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Malware
      description: The malware kits that are known to be used to exploit the vulnerability.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Exploit
      description: The exploits that can be used to exploit a vulnerability.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.CVSS
      description: The CVSS exploit score.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Risk
      description: The risk score of the vulnerability, rounded to a maximum of to digits of precision. If using the default Rapid7 Real Risk™ model, this value ranges from 0-1000.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.PublishedOn
      description: The date the vulnerability was first published or announced. The format is an ISO 8601 date, YYYY-MM-DD.
      type: date
    - contextPath: Nexpose.Asset.Vulnerability.ModifiedOn
      description: The last date the vulnerability was modified. The format is an ISO 8601 date, YYYY-MM-DD.
      type: date
    - contextPath: Nexpose.Asset.Vulnerability.Severity
      description: 'The severity of the vulnerability, one of: "Moderate", "Severe", "Critical".'
      type: string
    - contextPath: Endpoint.IP
      description: Endpoint IP address.
      type: string
    - contextPath: Endpoint.HostName
      description: Endpoint host name.
      type: string
    - contextPath: Endpoint.OS
      description: Endpoint operating system.
      type: string
    - contextPath: CVE.ID
      description: Common Vulnerabilities and Exposures IDs.
      type: string
  - arguments:
    - description: Asset ID.
      name: asset_id
      required: true
    description: Returns the specified tags for an asset.
    name: nexpose-get-asset-tags
    outputs:
    - contextPath: Nexpose.AssetTag.Type
      description: Type of asset tag.
      type: string
    - contextPath: Nexpose.AssetTag.Name
      description: The value of the tag.
      type: string
    - contextPath: Nexpose.AssetTag.CreatedTime
      description: Timestamp of when the tag was created.
      type: string
    - contextPath: Nexpose.AssetTag.RiskModifier
      description: The risk modifier value associated with criticality tag type.
      type: string
  - arguments:
    - description: Number of records to retrieve in each API call when pagination is used.
      name: page_size
    - description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
      name: page
    - description: 'Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a ";". For example: "riskScore,DESC;hostName,ASC".'
      name: sort
    - defaultValue: '10'
      description: A number of records to limit the response to.
      name: limit
    description: Returns all assets for which you have access.
    name: nexpose-get-assets
    outputs:
    - contextPath: Nexpose.Asset.AssetId
      description: The identifier of the asset.
      type: number
    - contextPath: Nexpose.Asset.Address
      description: The primary IPv4 or IPv6 address of the asset.
      type: string
    - contextPath: Nexpose.Asset.Name
      description: The primary host name (local or FQDN) of the asset.
      type: string
    - contextPath: Nexpose.Asset.Site
      description: Asset site name.
      type: string
    - contextPath: Nexpose.Asset.Exploits
      description: The number of distinct exploits that can exploit any of the vulnerabilities on the asset.
      type: number
    - contextPath: Nexpose.Asset.Malware
      description: The number of distinct malware kits that vulnerabilities on the asset are susceptible to.
      type: number
    - contextPath: Nexpose.Asset.OperatingSystem
      description: Operating system of the asset.
      type: string
    - contextPath: Nexpose.Asset.Vulnerabilities
      description: The total number of vulnerabilities.
      type: number
    - contextPath: Nexpose.Asset.RiskScore
      description: The risk score (with criticality adjustments) of the asset.
      type: number
    - contextPath: Nexpose.Asset.Assessed
      description: Whether the asset has been assessed for vulnerabilities at least once.
      type: boolean
    - contextPath: Nexpose.Asset.LastScanDate
      description: Last scan date of the asset.
      type: date
    - contextPath: Nexpose.Asset.LastScanId
      description: Id of the asset's last scan.
      type: number
    - contextPath: Endpoint.IP
      description: Endpoint IP address.
      type: string
    - contextPath: Endpoint.HostName
      description: Endpoint host name.
      type: string
    - contextPath: Endpoint.OS
      description: Endpoint operating system.
      type: string
  - arguments:
    - description: 'Queries to use as a filter, according to the Search Criteria API standard. Multiple queries can be specified, separated by a ";" separator. For example: "ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost". For more information regarding Search Criteria, refer to https://help.rapid7.com/insightvm/en-us/api/index.html#section/Overview/Responses'
      name: query
    - description: Number of records to retrieve in each API call when pagination is used.
      name: page_size
      defaultValue: '100'
    - description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
      name: page
    - description: A number of records to limit the response to.
      name: limit
      defaultValue: '10'
    - description: 'Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a ";" separator. For example: "riskScore,DESC;hostName,ASC".'
      name: sort
    - description: A specific IP address to search.
      name: ipAddressIs
    - description: A specific host name to search.
      name: hostNameIs
    - description: A minimum risk score to use as a filter.
      name: riskScoreHigherThan
    - description: A string to search for in vulnerabilities titles.
      name: vulnerabilityTitleContains
    - description: Site IDs to filter for. Can be a comma-separated list.
      isArray: true
      name: siteIdIn
    - description: Site names to filter for. Can be a comma-separated list.
      isArray: true
      name: siteNameIn
    - auto: PREDEFINED
      defaultValue: all
      description: Operator to determine how to match filters. "all" requires that all filters match for an asset to be included. "any" requires only one filter to match for an asset to be included.
      name: match
      predefined:
      - all
      - any
    description: Search and return all assets matching specific filters. Returns only assets the user has access to.
    name: nexpose-search-assets
    outputs:
    - contextPath: Nexpose.Asset.AssetId
      description: The identifier of the asset.
      type: number
    - contextPath: Nexpose.Asset.Address
      description: The primary IPv4 or IPv6 address of the asset.
      type: string
    - contextPath: Nexpose.Asset.Name
      description: The primary host name (local or FQDN) of the asset.
      type: string
    - contextPath: Nexpose.Asset.Site
      description: Asset site name.
      type: string
    - contextPath: Nexpose.Asset.Exploits
      description: The number of distinct exploits that can exploit any of the vulnerabilities on the asset.
      type: number
    - contextPath: Nexpose.Asset.Malware
      description: The number of distinct malware kits that vulnerabilities on the asset are susceptible to.
      type: number
    - contextPath: Nexpose.Asset.OperatingSystem
      description: Operating system of the asset.
      type: string
    - contextPath: Nexpose.Asset.Vulnerabilities
      description: The total number of vulnerabilities.
      type: number
    - contextPath: Nexpose.Asset.RiskScore
      description: The risk score (with criticality adjustments) of the asset.
      type: number
    - contextPath: Nexpose.Asset.Assessed
      description: Whether the asset has been assessed for vulnerabilities at least once.
      type: boolean
    - contextPath: Nexpose.Asset.LastScanDate
      description: Last scan date of the asset.
      type: date
    - contextPath: Nexpose.Asset.LastScanId
      description: Id of the asset's last scan.
      type: number
    - contextPath: Endpoint.IP
      description: Endpoint IP address.
      type: string
    - contextPath: Endpoint.HostName
      description: Endpoint host name.
      type: string
    - contextPath: Endpoint.OS
      description: Endpoint operating system.
      type: string
  - arguments:
    - description: ID of a specific scan to retrieve. Can be a comma-separated list.
      isArray: true
      name: id
      required: true
    description: Get a specific scan.
    name: nexpose-get-scan
    outputs:
    - contextPath: Nexpose.Scan.Id
      description: The identifier of the scan.
      type: number
    - contextPath: Nexpose.Scan.ScanType
      description: The scan type (automated, manual, scheduled).
      type: string
    - contextPath: Nexpose.Scan.StartedBy
      description: The name of the user who started the scan.
      type: string
    - contextPath: Nexpose.Scan.Assets
      description: The number of assets found in the scan.
      type: number
    - contextPath: Nexpose.Scan.TotalTime
      description: The duration of the scan in minutes.
      type: string
    - contextPath: Nexpose.Scan.Status
      description: The scan status. Valid values are aborted, unknown, running, finished, stopped, error, paused, dispatched, integrating.
      type: string
    - contextPath: Nexpose.Scan.Completed
      description: The end time of the scan in ISO8601 format.
      type: date
    - contextPath: Nexpose.Scan.Vulnerabilities.Critical
      description: The number of critical vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Moderate
      description: The number of moderate vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Severe
      description: The number of severe vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Total
      description: The total number of vulnerabilities.
      type: number
  - arguments:
    - description: ID of an asset to search for the vulnerability.
      name: id
      required: true
    - description: "ID of a vulnerability to search for. Example: 7-zip-cve-2008-6536."
      name: vulnerabilityId
      required: true
    description: Returns details and possible remediations for an asset's vulnerability.
    name: nexpose-get-asset-vulnerability
    outputs:
    - contextPath: Nexpose.Asset.AssetId
      description: Identifier of the asset.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Id
      description: The identifier of the vulnerability.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Title
      description: The title (summary) of the vulnerability.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Severity
      description: 'The severity of the vulnerability, one of: "Moderate", "Severe", "Critical".'
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.RiskScore
      description: The risk score of the vulnerability, rounded to a maximum of to digits of precision. If using the default Rapid7 Real Risk™ model, this value ranges from 0-1000.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.CVSS
      description: The CVSS vector(s) for the vulnerability.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.CVSSV3
      description: The CVSS v3 vector.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Published
      description: The date the vulnerability was first published or announced. The format is an ISO 8601 date, YYYY-MM-DD.
      type: date
    - contextPath: Nexpose.Asset.Vulnerability.Added
      description: The date the vulnerability coverage was added. The format is an ISO 8601 date, YYYY-MM-DD.
      type: date
    - contextPath: Nexpose.Asset.Vulnerability.Modified
      description: The last date the vulnerability was modified. The format is an ISO 8601 date, YYYY-MM-DD.
      type: date
    - contextPath: Nexpose.Asset.Vulnerability.CVSSScore
      description: The CVSS score (ranges from 0-10).
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.CVSSV3Score
      description: The CVSS3 score, which ranges from 0-10.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Categories
      description: All vulnerability categories assigned to this vulnerability.
      type: unknown
    - contextPath: Nexpose.Asset.Vulnerability.CVES
      description: All CVEs assigned to this vulnerability.
      type: unknown
    - contextPath: Nexpose.Asset.Vulnerability.Check.Port
      description: The port of the service the result was discovered on.
      type: number
    - contextPath: Nexpose.Asset.Vulnerability.Check.Protocol
      description: The protocol of the service the result was discovered on, valid values ip, icmp, igmp, ggp, tcp, pup, udp, idp, esp, nd, raw.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Check.Since
      description: The date and time the result was first recorded, in the ISO8601 format. If the result changes status this value is the date and time of the status change.
      type: date
    - contextPath: Nexpose.Asset.Vulnerability.Check.Proof
      description: The proof explaining why the result was found vulnerable.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Check.Status
      description: The status of the vulnerability check result. Valid values are, unknown, not-vulnerable, vulnerable, vulnerable-version, vulnerable-potential, vulnerable-with-exception-applied, vulnerable-version-with-exception-applied, vulnerable-potential-with-exception-applied.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Solution.Type
      description: 'The type of the solution. One of: "Configuration", "Rollup patch", "Patch".'
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Solution.Summary
      description: The summary of the solution.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Solution.Steps
      description: The steps required to remediate the vulnerability.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Solution.Estimate
      description: The estimated duration to apply the solution, in minutes.
      type: string
    - contextPath: Nexpose.Asset.Vulnerability.Solution.AdditionalInformation
      description: Additional information or resources that can assist in applying the remediation.
      type: string
    - contextPath: CVE.ID
      description: Common Vulnerabilities and Exposures IDs.
      type: string
  - arguments:
    - description: Name of the credential.
      name: name
      required: true
    - description: Site assignment configuration for the credential. Assign the shared scan credential either to be available to all sites, or a specific list of sites.
      name: site_assignment
      required: true
      auto: PREDEFINED
      predefined:
      - All-Sites
      - Specific-Sites
    - description: Credential service type.
      name: service
      required: true
      auto: PREDEFINED
      predefined:
      - AS400
      - CIFS
      - CIFSHash
      - CVS
      - DB2
      - FTP
      - HTTP
      - MS-SQL
      - MySQL
      - Notes
      - Oracle
      - POP
      - PostgresSQL
      - Remote-Exec
      - SNMP
      - SNMPv3
      - SSH
      - SSH-Key
      - Sybase
      - Telnet
    - description: Database name.
      name: database
    - description: Description for the credential.
      name: description
    - description: Domain address.
      name: domain
    - description: Hostname or IP address to restrict the credentials to.
      name: host_restriction
    - description: HTTP realm.
      name: http_realm
    - description: Password for the notes account that will be used for authenticating.
      name: notes_id_password
    - description: NTLM password hash.
      name: ntlm_hash
    - auto: PREDEFINED
      description: Whether the scan engine should attempt to enumerate SIDs from the environment.
      name: oracle_enumerate_sids
      predefined:
      - 'true'
      - 'false'
    - description: Oracle Net Listener password. Used to enumerate SIDs from your environment.
      name: oracle_listener_password
    - description: Oracle database name.
      name: oracle_sid
    - description: Password for the credential.
      name: password
    - description: Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `host_restriction` is used.
      name: port_restriction
    - description: List of site IDs for the shared credential that are explicitly assigned access to the shared scan credential, allowing it to use the credential during a scan.
      isArray: true
      name: sites
    - description: SNMP community for authentication.
      name: community_name
    - auto: PREDEFINED
      description: SNMPv3 authentication type for the credential.
      name: authentication_type
      predefined:
      - No-Authentication
      - MD5
      - SHA
    - description: SNMPv3 privacy password to use.
      name: privacy_password
    - auto: PREDEFINED
      description: SNMPv3 Privacy protocol to use.
      name: privacy_type
      predefined:
      - No-Privacy
      - DES
      - AES-128
      - AES-192
      - AES-192-With-3-DES-Key-Extension
      - AES-256
      - AES-256-With-3-DES-Key-Extension
    - description: PEM formatted private key.
      name: ssh_key_pem
    - auto: PREDEFINED
      description: Elevation type to use for scans.
      name: ssh_permission_elevation
      predefined:
      - None
      - sudo
      - sudosu
      - su
      - pbrun
      - Privileged-Exec
    - description: Password to use for elevation.
      name: ssh_permission_elevation_password
    - description: Username to use for elevation.
      name: ssh_permission_elevation_username
    - description: Password for the private key.
      name: ssh_private_key_password
    - auto: PREDEFINED
      description: Whether to use Windows authentication.
      name: use_windows_authentication
      predefined:
      - 'true'
      - 'false'
    - description: Username for the credential.
      name: username
    description: "Create a new shared credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/createSharedCredential"
    name: nexpose-create-shared-credential
    outputs:
    - contextPath: Nexpose.SharedCredential.id
      description: ID of the generated credential.
      type: number
  - arguments:
    - description: Site name. Must be unique.
      name: name
      required: true
    - description: Site's description.
      name: description
    - description: Addresses of assets to include in site scans. Can be a comma-separated list.
      isArray: true
      name: assets
      required: true
    - description: ID of a scan template to use. If not specified, the default scan template will be used. Use `nexpose-get-report-templates` to get a list of all available templates.
      name: scanTemplateId
    - auto: PREDEFINED
      description: Site importance. Defaults to "normal" if not specified.
      name: importance
      predefined:
      - very_low
      - low
      - normal
      - high
      - very_high
    description: Creates a new site with the specified configuration.
    name: nexpose-create-site
    outputs:
    - contextPath: Nexpose.Site.Id
      description: ID of the created site.
      type: number
  - arguments:
    - description: The date and time the vulnerability exception is set to expire in ISO 8601 date format.
      name: expires
    - description: "ID of the vulnerability to create the exception for. Example: 7-zip-cve-2008-6536."
      name: vulnerability_id
      required: true
    - auto: PREDEFINED
      description: The type of the exception scope. If set to anything other than `Global`, `scope_id` parameter is required.
      name: scope_type
      predefined:
      - Global
      - Site
      - Asset
      - Asset Group
#          - Instance  # We had issues with this option, so it's not currently supported
      required: true
    - auto: PREDEFINED
      description: State of the vulnerability exception.
      name: state
      predefined:
      - Expired
      - Approved
      - Rejected
      - Under Review
      required: true
    - description: A comment from the submitter as to why the exception was submitted.
      name: comment
    - auto: PREDEFINED
      description: Reason why the vulnerability exception was submitted.
      name: reason
      predefined:
      - False Positive
      - Compensating Control
      - Acceptable Use
      - Acceptable Risk
      - Other
      required: true
    - description: ID of the chosen `scope_type` (site ID, asset ID, etc.). Required if `scope_type` is anything other than `Global`.
      name: scope_id
    description: Create a new vulnerability exception.
    name: nexpose-create-vulnerability-exception
    outputs:
    - contextPath: Nexpose.VulnerabilityException.id
      description: ID of the generated vulnerability exception.
      type: number
  - description: Delete an asset.
    name: nexpose-delete-asset
    arguments:
    - description: ID of the asset to delete.
      name: id
      required: true
  - arguments:
    - description: ID of the site to delete.
      name: site_id
    - description: Name of the site to delete (can be used instead of `site_id`).
      name: site_name
    - description: ID of the scheduled scan to delete.
      name: schedule_id
      required: true
    description: Delete a scheduled scan.
    name: nexpose-delete-scan-schedule
  - arguments:
    - description: ID of the shared credential to delete.
      name: id
      required: true
    description: "Beta Command\n\nDelete a shared credential."
    name: nexpose-delete-shared-credential
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: ID of the site scan credential to delete.
      name: credential_id
      required: true
    description: "Beta Command\n\nDelete a site scan credential."
    name: nexpose-delete-site-scan-credential
  - arguments:
    - description: ID of a site to delete.
      name: id
    - description: Name of the site to delete (can be used instead of `site_id`).
      name: site_name
    description: Deletes a site.
    name: nexpose-delete-site
  - arguments:
    - description: ID of the vulnerability exception to delete.
      name: id
      required: true
    description: Delete a vulnerability exception.
    name: nexpose-delete-vulnerability-exception
  - arguments:
    - description: Number of records to retrieve in each API call when pagination is used.
      name: page_size
    - description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
      name: page
    - defaultValue: '10'
      description: A number of records to limit the response to.
      name: limit
    - description: 'Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a ";". For example: "riskScore,DESC;hostName,ASC".'
      name: sort
    description: Retrieves accessible sites.
    name: nexpose-get-sites
    outputs:
    - contextPath: Nexpose.Site.Id
      description: The identifier of the site.
      type: number
    - contextPath: Nexpose.Site.Name
      description: The site name.
      type: string
    - contextPath: Nexpose.Site.Assets
      description: The number of assets that belong to the site.
      type: number
    - contextPath: Nexpose.Site.Type
      description: The type of the site. Valid values are agent, dynamic, static.
      type: string
    - contextPath: Nexpose.Site.Vulnerabilities
      description: The total number of vulnerabilities.
      type: number
    - contextPath: Nexpose.Site.Risk
      description: The risk score (with criticality adjustments) of the site.
      type: number
    - contextPath: Nexpose.Site.LastScan
      description: The date and time of the site's last scan.
      type: date
  - description: Returns all available report templates.
    name: nexpose-get-report-templates
    outputs:
    - contextPath: Nexpose.Template.Id
      description: The identifier of the report template.
      type: number
    - contextPath: Nexpose.Template.Name
      description: The name of the report template.
      type: string
    - contextPath: Nexpose.Template.Description
      description: The description of the report template.
      type: string
    - contextPath: Nexpose.Template.Type
      description: The type of the report template. document is a templatized, typically printable, report that has various sections of content. export is data-oriented output, typically CSV. file is a printable report template using a report template file.
      type: string
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: The date the data was collected on the asset in ISO 8601 format.
      name: date
      required: true
    - description: Primary IPv4 or IPv6 address of the asset.
      isArray: true
      name: ip
      required: true
    - description: Hostname of the asset.
      name: host_name
    - auto: PREDEFINED
      description: The source used to detect the host name. "User" indicates the host name source is user-supplied.
      name: host_name_source
      predefined:
      - User
      - DNS
      - NetBIOS
      - DCE
      - EPSEC
      - LDAP
      - Other
    description: Create a new asset.
    name: nexpose-create-asset
    outputs:
    - contextPath: Nexpose.Asset.id
      description: ID of the newly created asset.
      type: string
  - arguments:
    - description: Asset IDs to create the report on. Can be a comma-separated list.
      isArray: true
      name: assets
      required: true
    - description: Report template ID to create the report with. If not provided, the first available template will be used.
      name: template
    - description: Report name.
      name: name
    - auto: PREDEFINED
      description: Report format (uses PDF by default).
      name: format
      predefined:
      - pdf
      - rtf
      - xml
      - html
      - text
    - auto: PREDEFINED
      defaultValue: 'true'
      description: Whether to download the report immediately after the report is generated. Defaults to "true". If the report takes longer than 10 seconds to generate, set to "false".
      name: download_immediately
      predefined:
      - 'true'
      - 'false'
    description: Generates a new report on given assets according to a template and arguments.
    name: nexpose-create-assets-report
    outputs:
    - contextPath: InfoFile.EntryId
      description: Entry ID of the report file.
      type: string
    - contextPath: InfoFile.Name
      description: Name of the report file.
      type: string
    - contextPath: InfoFile.Extension
      description: File extension of the report file.
      type: string
    - contextPath: InfoFile.Info
      description: Information about the report file.
      type: string
    - contextPath: InfoFile.Size
      description: Size of the report file (in bytes).
      type: number
    - contextPath: InfoFile.Type
      description: Type of the report file.
      type: string
    - contextPath: Nexpose.Report.ID
      description: The identifier of the report.
      type: string
    - contextPath: Nexpose.Report.InstanceID
      description: The identifier of the report instance.
      type: string
    - contextPath: Nexpose.Report.Name
      description: The report name.
      type: string
    - contextPath: Nexpose.Report.Format
      description: The report format.
      type: string
  - name: nexpose-create-sites-report
    arguments:
    - name: sites
      description: Site IDs to create the report on. Can be a comma-separated list.
      isArray: true
    - name: site_names
      description: Names of sites to create the report on. Can be a comma-separated list.
      isArray: true
    - name: template
      description: Report template ID to use for report's creation. If not provided, the first available template will be used.
    - name: name
      description: Report name.
    - auto: PREDEFINED
      description: Report format (uses PDF by default).
      name: format
      predefined:
      - pdf
      - rtf
      - xml
      - html
      - text
    - auto: PREDEFINED
      defaultValue: 'true'
      description: If true, downloads the report immediately after the report is generated. The default is "true". If the report takes longer than 10 seconds to generate, set to "false".
      name: download_immediately
      predefined:
      - 'true'
      - 'false'
    outputs:
    - contextPath: InfoFile.EntryId
      description: Entry ID of the report file.
      type: string
    - contextPath: InfoFile.Name
      description: Name of the report file.
      type: string
    - contextPath: InfoFile.Extension
      description: File extension of the report file.
      type: string
    - contextPath: InfoFile.Info
      description: Info about the report file.
      type: string
    - contextPath: InfoFile.Size
      description: Size of the report file.
      type: number
    - contextPath: InfoFile.Type
      description: Type of the report file.
      type: string
    - contextPath: Nexpose.Report.ID
      description: The identifier of the report.
      type: string
    - contextPath: Nexpose.Report.InstanceID
      description: The identifier of the report instance.
      type: string
    - contextPath: Nexpose.Report.Name
      description: The report name.
      type: string
    - contextPath: Nexpose.Report.Format
      description: The report format.
      type: string
    description: Generates a new report on given sites according to a template and arguments.
  - name: nexpose-create-site-scan-credential
    arguments:
    - name: site_id
      description: ID of the site.
    - name: site_name
      description: Name of the site (can be used instead of `site_id`).
    - description: Name of the credential.
      name: name
      required: true
    - auto: PREDEFINED
      description: Credential service type.
      name: service
      predefined:
      - AS400
      - CIFS
      - CIFSHash
      - CVS
      - DB2
      - FTP
      - HTTP
      - MS-SQL
      - MySQL
      - Notes
      - Oracle
      - POP
      - PostgresSQL
      - Remote-Exec
      - SNMP
      - SNMPv3
      - SSH
      - SSH-Key
      - Sybase
      - Telnet
      required: true
    - description: Database name.
      name: database
    - description: Description for the credential.
      name: description
    - description: Domain address.
      name: domain
    - description: Hostname or IP address to restrict the credentials to.
      name: host_restriction
    - description: HTTP realm.
      name: http_realm
    - description: Password for the notes account that will be used for authenticating.
      name: notes_id_password
    - description: NTLM password hash.
      name: ntlm_hash
    - auto: PREDEFINED
      description: Whether the scan engine should attempt to enumerate SIDs from the environment.
      name: oracle_enumerate_sids
      predefined:
      - 'true'
      - 'false'
    - description: Oracle Net Listener password. Used to enumerate SIDs from your environment.
      name: oracle_listener_password
    - description: Oracle database name.
      name: oracle_sid
    - description: Password for the credential.
      name: password
    - description: Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `host_restriction` is used.
      name: port_restriction
    - description: SNMP community for authentication.
      name: community_name
    - auto: PREDEFINED
      description: SNMPv3 authentication type for the credential.
      name: authentication_type
      predefined:
      - No-Authentication
      - MD5
      - SHA
    - description: SNMPv3 privacy password to use.
      name: privacy_password
    - auto: PREDEFINED
      description: SNMPv3 privacy protocol to use.
      name: privacy_type
      predefined:
      - No-Privacy
      - DES
      - AES-128
      - AES-192
      - AES-192-With-3-DES-Key-Extension
      - AES-256
      - AES-256-With-3-DES-Key-Extension
    - description: PEM formatted private key.
      name: ssh_key_pem
    - auto: PREDEFINED
      description: Elevation type to use for scans.
      name: ssh_permission_elevation
      predefined:
      - None
      - sudo
      - sudosu
      - su
      - pbrun
      - Privileged-Exec
    - description: Password to use for elevation.
      name: ssh_permission_elevation_password
    - description: Username to use for elevation.
      name: ssh_permission_elevation_username
    - description: Password for the private key.
      name: ssh_private_key_password
    - auto: PREDEFINED
      description: Whether to use Windows authentication.
      name: use_windows_authentication
      predefined:
      - 'true'
      - 'false'
    - description: Username for the credential.
      name: username
    outputs:
    - contextPath: Nexpose.SiteScanCredential.id
      description: ID of the generated credential.
      type: number
    description: "Beta Command\n\nCreate a new site scan credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/createSiteCredential"
  - arguments:
    - description: ID of the scan to create a report about.
      name: scan
      required: true
    - description: Report template ID to use for creation. If not provided, the first available template will be used.
      name: template
    - description: Report name.
      name: name
    - auto: PREDEFINED
      description: Report format (uses PDF by default).
      name: format
      predefined:
      - pdf
      - rtf
      - xml
      - html
      - text
    - auto: PREDEFINED
      defaultValue: 'true'
      description: If true, downloads the report immediately after the report is generated. The default is "true". If the report takes longer than 10 seconds to generate, set to "false".
      name: download_immediately
      predefined:
      - 'true'
      - 'false'
    description: Generates a new report for a specified scan.
    name: nexpose-create-scan-report
    outputs:
    - contextPath: InfoFile.EntryId
      description: Entry ID of the report file.
      type: string
    - contextPath: InfoFile.Name
      description: Name of the report file.
      type: string
    - contextPath: InfoFile.Extension
      description: File extension of the report file.
      type: string
    - contextPath: InfoFile.Info
      description: Info about the report file.
      type: string
    - contextPath: InfoFile.Size
      description: Size of the report file.
      type: number
    - contextPath: InfoFile.Type
      description: Type of the report file.
      type: string
    - contextPath: Nexpose.Report.ID
      description: The identifier of the report.
      type: string
    - contextPath: Nexpose.Report.InstanceID
      description: The identifier of the report instance.
      type: string
    - contextPath: Nexpose.Report.Name
      description: The report name.
      type: string
    - contextPath: Nexpose.Report.Format
      description: The report format.
      type: string
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - auto: PREDEFINED
      defaultValue: 'True'
      description: Whether to enable the scheduled scan after creation.
      name: enabled
      predefined:
      - 'True'
      - 'False'
    - auto: PREDEFINED
      description: The desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching its maximum duration.
      name: on_scan_repeat
      predefined:
      - Restart-Scan
      - Resume-Scan
      required: true
    - description: The scheduled start date and time formatted in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time.
      name: start
      required: true
    - description: A list of IDs for asset groups to exclude from the scan.
      isArray: true
      name: excluded_asset_group_ids
    - description: A list of addresses to exclude from the scan.
      isArray: true
      name: excluded_addresses
    - description: A list of IDs for asset groups to include in the scan.
      isArray: true
      name: included_asset_group_ids
    - description: A list of addresses to include in the scan.
      isArray: true
      name: included_addresses
    - description: Maximum duration of the scan in days.
      name: duration_days
    - description: Maximum duration of the scan in hours.
      name: duration_hours
    - description: Maximum duration of the scan in minutes.
      name: duration_minutes
    - auto: PREDEFINED
      description: How frequently the schedule should repeat (Every...).
      name: frequency
      predefined:
      - Hour
      - Day
      - Week
      - Date-of-month
    - description: The interval time the schedule should repeat. This depends on the value set in `frequency`. For example, if the value of `frequency` is set to "Day" and `interval` is set to 2, then the schedule will repeat every 2 days. Required only if frequency is used.
      name: interval_time
    - description: Specifies the schedule repeat day of the interval month. For example, if `date_of_month` is 17 and `interval` is set to 2, then the schedule will repeat every 2 months on the 17th day of the month. Required and used only if frequency is set to `Date of month`.
      name: date_of_month
    - description: A unique user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching.
      name: scan_name
    - description: ID of the scan template to use.
      name: scan_template
    description: "Beta Command\n\nCreate a new site scan schedule."
    name: nexpose-create-scan-schedule
    outputs:
    - contextPath: Nexpose.ScanSchedule.id
      description: ID of the newly created scan schedule.
      type: int
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - defaultValue: '10'
      description: The number of records to limit the response to.
      name: limit
    description: Retrieve information about shared credentials for a specific site.
    name: nexpose-list-assigned-shared-credential
    outputs:
    - contextPath: Nexpose.AssignedSharedCredential.enabled
      description: Flag indicating whether the shared credential is enabled for the site's scans.
      type: string
    - contextPath: Nexpose.AssignedSharedCredential.id
      description: ID of the shared credential.
      type: string
    - contextPath: Nexpose.AssignedSharedCredential.name
      description: The name of the shared credential.
      type: string
    - contextPath: Nexpose.AssignedSharedCredential.service
      description: Credential service type.
      type: string
  - arguments:
    - description: ID of a specific vulnerability to retrieve.
      name: id
    - description: Number of records to retrieve in each API call when pagination is used.
      name: page_size
    - description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
      name: page
    - defaultValue: '10'
      description: The number of records to limit the response to.
      name: limit
    - description: 'Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a ";". For example: "riskScore,DESC;hostName,ASC".'
      name: sort
    description: Retrieve information about all or a specific vulnerability.
    name: nexpose-list-vulnerability
    outputs:
    - contextPath: Nexpose.Vulnerability.added
      description: The date the vulnerability coverage was added in ISO 8601 format.
      type: string
    - contextPath: Nexpose.Vulnerability.categories
      description: All vulnerability categories assigned to this vulnerability.
      type: array
    - contextPath: Nexpose.Vulnerability.cves
      description: All CVEs assigned to this vulnerability.
      type: array
    - contextPath: Nexpose.Vulnerability.cvss.v2.accessComplexity
      description: Access Complexity (AC) component that measures the complexity of the attack required to exploit the vulnerability once an attacker has gained access to the target system.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v2.accessVector
      description: Access Vector (Av) component that reflects how the vulnerability is exploited.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v2.authentication
      description: Authentication (Au) component that measures the number of times an attacker must authenticate to a target in order to exploit a vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v2.availabilityImpact
      description: Availability Impact (A) component that measures the impact to availability of a successfully exploited vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v2.confidentialityImpact
      description: Confidentiality Impact (C) component that measures the impact on confidentiality of a successfully exploited vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v2.exploitScore
      description: The CVSS exploit score.
      type: number
    - contextPath: Nexpose.Vulnerability.cvss.v2.impactScore
      description: The CVSS impact score.
      type: number
    - contextPath: Nexpose.Vulnerability.cvss.v2.integrityImpact
      description: Integrity Impact (I) component that measures the impact to integrity of a successfully exploited vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v2.score
      description: The CVSS score (ranges from 0-10).
      type: number
    - contextPath: Nexpose.Vulnerability.cvss.v2.vector
      description: The CVSS v2 vector.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.attackComplexity
      description: Access Complexity (AC) component that measures the conditions beyond the attacker's control that must exist in order to exploit the vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.attackVector
      description: Attack Vector (AV) component that measures context by which vulnerability exploitation is possible.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.availabilityImpact
      description: Availability Impact (A) that measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.confidentialityImpact
      description: Confidentiality Impact (C) component that measures the impact on confidentiality of a successfully exploited vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.exploitScore
      description: The CVSS impact score.
      type: number
    - contextPath: Nexpose.Vulnerability.cvss.v3.impactScore
      description: The CVSS exploit score.
      type: number
    - contextPath: Nexpose.Vulnerability.cvss.v3.integrityImpact
      description: Integrity Impact (I) that measures the impact to integrity of a successfully exploited vulnerability. Integrity refers to the trustworthiness and veracity of information.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.privilegeRequired
      description: Privileges Required (PR) that measures the level of privileges an attacker must possess before successfully exploiting the vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.scope
      description: Scope (S) that measures the collection of privileges defined by a computing authority (e.g., an application, an operating system, or a sandbox environment) when granting access to computing resources (e.g., files, CPU, memory, etc.). These privileges are assigned based on some method of identification and authorization.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.score
      description: The CVSS score (ranges from 0-10).
      type: number
    - contextPath: Nexpose.Vulnerability.cvss.v3.userInteraction
      description: User Interaction (UI) that measures the requirement for a user, other than the attacker, to participate in the successful compromise of the vulnerable component.
      type: string
    - contextPath: Nexpose.Vulnerability.cvss.v3.vector
      description: The CVSS v3 vector.
      type: string
    - contextPath: Nexpose.Vulnerability.denialOfService
      description: Whether the vulnerability can lead to Denial of Service (DoS).
      type: boolean
    - contextPath: Nexpose.Vulnerability.description.html
      description: Hypertext Markup Language (HTML) representation of the content.
      type: string
    - contextPath: Nexpose.Vulnerability.description.text
      description: Textual representation of the content.
      type: string
    - contextPath: Nexpose.Vulnerability.exploits
      description: The exploits that can be used to exploit a vulnerability.
      type: number
    - contextPath: Nexpose.Vulnerability.id
      description: The identifier of the vulnerability.
      type: string
    - contextPath: Nexpose.Vulnerability.malwareKits
      description: The malware kits that are known to be used to exploit the vulnerability.
      type: number
    - contextPath: Nexpose.Vulnerability.modified
      description: The last date the vulnerability was modified in ISO 8601 format.
      type: string
    - contextPath: Nexpose.Vulnerability.pci.adjustedCVSSScore
      description: The CVSS score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10.
      type: number
    - contextPath: Nexpose.Vulnerability.pci.adjustedSeverityScore
      description: The severity score of the vulnerability, adjusted for PCI rules and exceptions, on a scale of 0-10.
      type: number
    - contextPath: Nexpose.Vulnerability.pci.fail
      description: Whether, if present on a host, this vulnerability would cause a PCI failure. True if "status" is "Fail", false otherwise.
      type: boolean
    - contextPath: Nexpose.Vulnerability.pci.specialNotes
      description: Any special notes or remarks about the vulnerability that pertain to PCI compliance.
      type: string
    - contextPath: Nexpose.Vulnerability.pci.status
      description: The PCI compliance status of the vulnerability. Can be either "Pass", or "Fail".
      type: string
    - contextPath: Nexpose.Vulnerability.published
      description: The date the vulnerability was first published or announced in ISO 8601 format.
      type: string
    - contextPath: Nexpose.Vulnerability.riskScore
      description: The risk score of the vulnerability, rounded to a maximum of two digits of precision. If using the default Rapid7 Real Risk model, this value ranges from 0-1000.
      type: number
    - contextPath: Nexpose.Vulnerability.severity
      description: The severity of the vulnerability, can be either "Moderate", "Severe", or "Critical".
      type: string
    - contextPath: Nexpose.Vulnerability.severityScore
      description: The severity score of the vulnerability, on a scale of 0-10.
      type: number
    - contextPath: Nexpose.Vulnerability.title
      description: The title (summary) of the vulnerability.
      type: string
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: ID of the scheduled scan (optional, will return a single specific scan if used).
      name: schedule_id
    - defaultValue: '10'
      description: A number of records to limit the response to.
      name: limit
    description: "BetaCommand\n\nRetrieve information about scan schedules for a specific site or a specific scan schedule."
    name: nexpose-list-scan-schedule
    outputs:
    - contextPath: Nexpose.ScanSchedule.assets.excludedAssetGroups.assetGroupIDs
      description: List of asset group identifiers that will be excluded from scans.
      type: array
    - contextPath: Nexpose.ScanSchedule.assets.excludedTargets.addresses
      description: List of addresses that will be excluded from scans.
      type: array
    - contextPath: Nexpose.ScanSchedule.assets.includedAssetGroups.assetGroupIDs
      description: List of asset group identifiers that will be included in scans.
      type: array
    - contextPath: Nexpose.ScanSchedule.assets.includedTargets.addresses
      description: List of addresses that will be included in scans.
      type: array
    - contextPath: Nexpose.ScanSchedule.duration
      description: Specifies in ISO 8601 duration format the maximum duration the scheduled scan is allowed to run.
      type: string
    - contextPath: Nexpose.ScanSchedule.enabled
      description: Flag indicating whether the scan schedule is enabled.
      type: string
    - contextPath: Nexpose.ScanSchedule.id
      description: The identifier of the scan schedule.
      type: int
    - contextPath: Nexpose.ScanSchedule.nextRuntimes
      description: List the next 10 dates when the schedule will launch.
      type: array
    - contextPath: Nexpose.ScanSchedule.onScanRepeat
      description: Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration.
      type: string
    - contextPath: Nexpose.ScanSchedule.repeat.dayOfWeek
      description: Specifies the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration.
    - contextPath: Nexpose.ScanSchedule.repeat.every
      description: The frequency in which the schedule repeats. Each value represents a different unit of time and is used in conjunction with the property interval.
    - contextPath: Nexpose.ScanSchedule.repeat.interval
      description: The interval time the schedule should repeat. This depends on the value set in every.
    - contextPath: Nexpose.ScanSchedule.repeat.weekOfMonth
      description: This property only applies to schedules with an every value of "day-of-month". The week of the month the scheduled task should repeat.
    - contextPath: Nexpose.ScanSchedule.repeat.scanEngineId
      description: The identifier of the scan engine to be used for this scan schedule. If not set, the site's assigned scan engine will be used.
    - contextPath: Nexpose.ScanSchedule.repeat.scanName
      description: A user-defined name for the scan launched by the schedule.
    - contextPath: Nexpose.ScanSchedule.repeat.scanTemplateId
      description: The identifier of the scan template to be used for this scan schedule. If not set, the site's assigned scan template will be used.
    - contextPath: Nexpose.ScanSchedule.repeat.start
      description: The scheduled start date and time. Repeating schedules will determine the next schedule to begin based on this date and time.
  - arguments:
    - description: ID of a specific shared credential to retrieve.
      name: id
    - defaultValue: '10'
      description: A number of records to limit the response to.
      name: limit
    description: Retrieve information about all or a specific shared credential.
    name: nexpose-list-shared-credential
    outputs:
    - contextPath: Nexpose.SharedCredential.account.authenticationType
      description: SNMPv3 authentication type for the credential.
      type: string
    - contextPath: Nexpose.SharedCredential.account.communityName
      description: SNMP community for authentication.
      type: string
    - contextPath: Nexpose.SharedCredential.account.database
      description: Database name.
      type: string
    - contextPath: Nexpose.SharedCredential.account.domain
      description: Domain address.
      type: string
    - contextPath: Nexpose.SharedCredential.account.enumerateSids
      description: Whether the scan engine should attempt to enumerate SIDs from the environment.
      type: boolean
    - contextPath: Nexpose.SharedCredential.account.notesIDPassword
      description: Password for the notes account that will be used for authenticating.
      type: string
    - contextPath: Nexpose.SharedCredential.account.ntlmHash
      description: NTLM password hash.
      type: string
    - contextPath: Nexpose.SharedCredential.account.oracleListenerPassword
      description: The Oracle Net Listener password. Used to enumerate SIDs from the environment.
      type: string
    - contextPath: Nexpose.SharedCredential.account.password
      description: Password for the credential.
      type: string
    - contextPath: Nexpose.SharedCredential.account.pemKey
      description: PEM formatted private key.
      type: string
    - contextPath: Nexpose.SharedCredential.account.permissionElevation
      description: Elevation type to use for scans.
      type: string
    - contextPath: Nexpose.SharedCredential.account.permissionElevationPassword
      description: Password to use for elevation.
      type: string
    - contextPath: Nexpose.SharedCredential.account.permissionElevationUserName
      description: Username to use for elevation.
      type: string
    - contextPath: Nexpose.SharedCredential.account.privacyPassword
      description: SNMPv3 privacy password to use.
      type: string
    - contextPath: Nexpose.SharedCredential.account.privacyType
      description: SNMPv3 privacy protocol to use.
      type: string
    - contextPath: Nexpose.SharedCredential.account.privateKeyPassword
      description: Password for the private key.
      type: string
    - contextPath: Nexpose.SharedCredential.account.realm
      description: HTTP realm.
      type: string
    - contextPath: Nexpose.SharedCredential.account.service
      description: Credential service type.
      type: string
    - contextPath: Nexpose.SharedCredential.account.sid
      description: Oracle database name.
      type: string
    - contextPath: Nexpose.SharedCredential.account.useWindowsAuthentication
      description: Whether to use Windows authentication.
      type: boolean
    - contextPath: Nexpose.SharedCredential.account.username
      description: Username for the credential.
      type: string
    - contextPath: Nexpose.SharedCredential.description
      description: Description for the credential.
      type: string
    - contextPath: Nexpose.SharedCredential.hostRestriction
      description: Hostname or IP address to restrict the credentials to.
      type: string
    - contextPath: Nexpose.SharedCredential.id
      description: ID of the shared credential.
      type: number
    - contextPath: Nexpose.SharedCredential.name
      description: Name of the credential.
      type: string
    - contextPath: Nexpose.SharedCredential.portRestriction
      description: Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `hostRestriction` is used.
      type: number
    - contextPath: Nexpose.SharedCredential.siteAssignment
      description: Site assignment configuration for the credential.
      type: string
    - contextPath: Nexpose.SharedCredential.sites
      description: List of site IDs for the shared credential that are explicitly assigned access to the shared scan credential, allowing it to use the credential during a scan.
      type: array
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: ID of a specific scan credential to retrieve.
      name: credential_id
    - default: true
      defaultValue: '10'
      description: A number of records to limit the response to.
      name: limit
    description: "Beta Command\n\nRetrieve information about all or a specific sca credential."
    name: nexpose-list-site-scan-credential
    outputs:
    - contextPath: Nexpose.SiteScanCredential.account.authenticationType
      description: SNMPv3 authentication type for the credential.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.communityName
      description: SNMP community for authentication.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.database
      description: Database name.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.domain
      description: Domain address.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.enumerateSids
      description: Whether the scan engine should attempt to enumerate SIDs from the environment.
      type: boolean
    - contextPath: Nexpose.SiteScanCredential.account.notesIDPassword
      description: Password for the notes account that will be used for authenticating.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.ntlmHash
      description: NTLM password hash.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.oracleListenerPassword
      description: The Oracle Net Listener password. Used to enumerate SIDs from the environment.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.password
      description: Password for the credential.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.pemKey
      description: PEM formatted private key.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.permissionElevation
      description: Elevation type to use for scans.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.permissionElevationPassword
      description: Password to use for elevation.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.permissionElevationUserName
      description: Username to use for elevation.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.privacyPassword
      description: SNMPv3 privacy password to use.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.privacyType
      description: SNMPv3 privacy protocol to use.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.privateKeyPassword
      description: Password for the private key.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.realm
      description: HTTP realm.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.service
      description: Credential service type.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.sid
      description: Oracle database name.
      type: string
    - contextPath: Nexpose.SiteScanCredential.account.useWindowsAuthentication
      description: Whether to use Windows authentication.
      type: boolean
    - contextPath: Nexpose.SiteScanCredential.account.username
      description: Username for the credential.
      type: string
    - contextPath: Nexpose.SiteScanCredential.description
      description: Description for the credential.
      type: string
    - contextPath: Nexpose.SiteScanCredential.hostRestriction
      description: Hostname or IP address to restrict the credentials to.
      type: string
    - contextPath: Nexpose.SiteScanCredential.id
      description: ID of the credential.
      type: number
    - contextPath: Nexpose.SiteScanCredential.name
      description: Name of the credential.
      type: string
    - contextPath: Nexpose.SiteScanCredential.portRestriction
      description: Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `hostRestriction` is used.
      type: number
  - arguments:
    - description: ID of the vulnerability exception to retrieve. If not set, retrieve all vulnerability exceptions.
      name: id
    - description: Number of records to retrieve in each API call when pagination is used.
      name: page_size
    - description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
      name: page
    - default: true
      defaultValue: submit.date,ASC
      description: 'Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a ";". For example: "riskScore,DESC;hostName,ASC".'
      name: sort
    - defaultValue: '10'
      description: A number of records to limit the response to.
      name: limit
    description: Retrieve information about scan schedules for a specific site or a specific scan schedule.
    name: nexpose-list-vulnerability-exceptions
    outputs:
    - contextPath: Nexpose.VulnerabilityException.expires
      description: The date and time the vulnerability exception is set to expire.
      type: string
    - contextPath: Nexpose.VulnerabilityException.id
      description: The The identifier of the vulnerability exception.
      type: int
    - contextPath: Nexpose.VulnerabilityException.scope.id
      description: The identifier of the vulnerability to which the exception applies.
      type: int
    - contextPath: Nexpose.VulnerabilityException.scope.key
      description: 'If the scope type is "Instance", an optional key to discriminate the instance the exception applies to.'
      type: string
    - contextPath: Nexpose.VulnerabilityException.scope.port
      description: 'If the scope type is "Instance" and the vulnerability is detected on a service, the port on which the exception applies.'
      type: int
    - contextPath: Nexpose.VulnerabilityException.scope.type
      description: 'The type of the exception scope. One of: "Global", "Site", "Asset", "Asset Group", "Instance".'
      type: string
    - contextPath: Nexpose.VulnerabilityException.scope.vulnerability
      description: The identifier of the vulnerability to which the exception applies.
      type: string
    - contextPath: Nexpose.VulnerabilityException.state
      description: 'The state of the vulnerability exception. One of: "Deleted", "Expired", "Approved", "Rejected", `"Under Review".'
      type: string
    - contextPath: Nexpose.VulnerabilityException.submit.comment
      description: A comment from the submitter as to why the exception was submitted.
      type: string
    - contextPath: Nexpose.VulnerabilityException.submit.date
      description: The date and time the vulnerability exception was submitted.
      type: string
    - contextPath: Nexpose.VulnerabilityException.submit.name
      description: The login name of the user who submitted the vulnerability exception.
      type: string
    - contextPath: Nexpose.VulnerabilityException.submit.reason
      description: 'The reason the vulnerability exception was submitted. One of: "False Positive", "Compensating Control", "Acceptable Use", "Acceptable Risk", "Other".'
      type: string
    - contextPath: Nexpose.VulnerabilityException.submit.user
      description: The identifier of the user who submitted the vulnerability exception.
      type: int
  - arguments:
    - description: ID of the site.
      name: site
    - description: Name of the site (can be used instead of `site`).
      name: site_name
    - description: Specific host(s) on the site to run the scan on. Can be an IP address or a hostname. Can be a comma-separated list.
      isArray: true
      name: hosts
    - description: Scan name.
      name: name
    description: Starts a scan for the specified site.
    name: nexpose-start-site-scan
    outputs:
    - contextPath: Nexpose.Scan.Id
      description: The identifier of the scan.
      type: number
    - contextPath: Nexpose.Scan.ScanType
      description: The scan type (automated, manual, scheduled).
      type: string
    - contextPath: Nexpose.Scan.StartedBy
      description: The name of the user who started the scan.
      type: date
    - contextPath: Nexpose.Scan.Assets
      description: The number of assets found in the scan.
      type: number
    - contextPath: Nexpose.Scan.TotalTime
      description: The duration of the scan in minutes.
      type: string
    - contextPath: Nexpose.Scan.Completed
      description: The end time of the scan in ISO8601 format.
      type: date
    - contextPath: Nexpose.Scan.Status
      description: The scan status. Valid values are aborted, unknown, running, finished, stopped, error, paused, dispatched, integrating.
      type: string
    - contextPath: Nexpose.Scan.Vulnerabilities.Critical
      description: The number of critical vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Moderate
      description: The number of moderate vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Severe
      description: The number of severe vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Total
      description: The total number of vulnerabilities.
      type: number
  - arguments:
    - description: IP addresses of assets to scan. Can be a comma-separated list.
      isArray: true
      name: IPs
    - description: Hostnames of assets to scan. Can be a comma-separated list.
      isArray: true
      name: hostNames
    - description: Scan name.
      name: name
    deprecated: true
    description: Deprecated. Use `nexpose-start-site-scan` using the `hosts` argument instead.
    name: nexpose-start-assets-scan
    outputs:
    - contextPath: Nexpose.Scan.Id
      description: The identifier of the scan.
      type: number
    - contextPath: Nexpose.Scan.ScanType
      description: The scan type (automated, manual, scheduled).
      type: string
    - contextPath: Nexpose.Scan.StartedBy
      description: The name of the user who started the scan.
      type: date
    - contextPath: Nexpose.Scan.Assets
      description: The number of assets found in the scan.
      type: number
    - contextPath: Nexpose.Scan.TotalTime
      description: The duration of the scan in minutes.
      type: string
    - contextPath: Nexpose.Scan.Completed
      description: The end time of the scan in ISO8601 format.
      type: date
    - contextPath: Nexpose.Scan.Status
      description: The scan status. Valid values are aborted, unknown, running, finished, stopped, error, paused, dispatched, integrating.
      type: string
    - contextPath: Nexpose.Scan.Vulnerabilities.Critical
      description: The number of critical vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Moderate
      description: The number of moderate vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Severe
      description: The number of severe vulnerabilities.
      type: number
    - contextPath: Nexpose.Scan.Vulnerabilities.Total
      description: The total number of vulnerabilities.
      type: number
  - arguments:
    - description: ID of a running scan.
      name: id
      required: true
    description: Stop a running scan.
    name: nexpose-stop-scan
  - arguments:
    - description: ID of a running scan.
      name: id
      required: true
    description: Pause a running scan.
    name: nexpose-pause-scan
  - arguments:
    - description: ID of a paused scan.
      name: id
      required: true
    description: Resume a paused scan.
    name: nexpose-resume-scan
  - arguments:
    - auto: PREDEFINED
      defaultValue: 'true'
      description: Whether to return only active scans.
      name: active
      predefined:
      - 'true'
      - 'false'
    - description: Number of records to retrieve in each API call when pagination is used.
      name: page_size
    - description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
      name: page
    - defaultValue: '10'
      description: A number of records to limit the response to.
      name: limit
    - description: 'Criteria to sort the records by, in the format: property[,ASC|DESC]. If not specified, default sort order is ascending. Multiple sort criteria can be specified, separated by a ";". For example: "riskScore,DESC;hostName,ASC".'
      name: sort
    description: Return a list of scans. Returns only active scans by default (active=true).
    name: nexpose-get-scans
    outputs:
    - contextPath: Nexpose.Scan.Id
      description: The identifier of the scan.
      type: number
    - contextPath: Nexpose.Scan.ScanType
      description: The scan type (automated, manual, scheduled).
      type: string
    - contextPath: Nexpose.Scan.StartedBy
      description: The name of the user who started the scan.
      type: date
    - contextPath: Nexpose.Scan.Assets
      description: The number of assets found in the scan.
      type: number
    - contextPath: Nexpose.Scan.TotalTime
      description: The duration of the scan in minutes.
      type: string
    - contextPath: Nexpose.Scan.Completed
      description: The end time of the scan in ISO8601 format.
      type: date
    - contextPath: Nexpose.Scan.Status
      description: The scan status. Valid values are aborted, unknown, running, finished, stopped, error, paused, dispatched, integrating.
      type: string
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: ID of the scan schedule to update.
      name: credential_id
      required: true
    name: nexpose-disable-shared-credential
    description: "Beta Command\n\nDisable an assigned shared credential."
  - arguments:
    - name: report_id
      required: true
      description: ID of the report.
    - name: instance_id
      required: true
      description: ID of the report instance. Supports a "latest" value.
    - name: name
      description: Report name.
    - name: format
      auto: PREDEFINED
      predefined:
      - pdf
      - rtf
      - xml
      - html
      - text
      - nexpose-simple-xml
      description: Report format (uses PDF by default).
      defaultValue: pdf
    name: nexpose-download-report
    outputs:
    - contextPath: InfoFile.EntryId
      description: Entry ID of the report file.
      type: string
    - contextPath: InfoFile.Name
      description: Name of the report file.
      type: string
    - contextPath: InfoFile.Extension
      description: File extension of the report file.
      type: string
    - contextPath: InfoFile.Info
      description: Information about the report file.
      type: string
    - contextPath: InfoFile.Size
      description: Size of the report file (in bytes).
      type: number
    - contextPath: InfoFile.Type
      description: Type of the report file.
      type: string
    description: Returns the generated report.
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: ID of the scan schedule to update.
      name: credential_id
      required: true
    name: nexpose-enable-shared-credential
    description: "Beta Command\n\nEnable an assigned shared credential."
  - arguments:
    - name: report_id
      required: true
      description: ID of the report.
    - name: instance_id
      required: true
      description: ID of the report instance. Supports a "latest" value.
    name: nexpose-get-report-status
    outputs:
    - contextPath: Nexpose.Report.ID
      description: The identifier of the report.
      type: string
    - contextPath: Nexpose.Report.InstanceID
      description: The identifier of the report instance.
      type: string
    - contextPath: Nexpose.Report.Status
      description: 'The status of the report generation process. Valid values: "aborted", "failed", "complete", "running", "unknown".'
      type: string
    description: Returns the status of a report generation process.
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: ID of the scan schedule to update.
      name: schedule_id
    - auto: PREDEFINED
      defaultValue: 'True'
      description: A flag indicating whether the scheduled scan is enabled.
      name: enabled
      predefined:
      - 'True'
      - 'False'
    - auto: PREDEFINED
      description: The desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching its maximum duration.
      name: on_scan_repeat
      predefined:
      - Restart-Scan
      - Resume-Scan
      required: true
    - description: The scheduled start date and time formatted in ISO 8601 format. Repeating schedules will determine the next schedule to begin based on this date and time.
      name: start
      required: true
    - description: A list of IDs for asset groups to exclude from the scan.
      isArray: true
      name: excluded_asset_group_ids
    - description: A list of addresses to exclude from the scan.
      isArray: true
      name: excluded_addresses
    - description: A list of IDs for asset groups to include in the scan.
      isArray: true
      name: included_asset_group_ids
    - description: A list of addresses to include in the scan.
      isArray: true
      name: included_addresses
    - description: Maximum duration of the scan in days.
      name: duration_days
    - description: Maximum duration of the scan in hours.
      name: duration_hours
    - description: Maximum duration of the scan in minutes.
      name: duration_minutes
    - auto: PREDEFINED
      description: How frequently should the schedule repeat (Every...).
      name: frequency
      predefined:
      - Hour
      - Day
      - Week
      - Date-of-month
    - description: The interval time the schedule should repeat. This depends on the value set in `frequency`. For example, if the value of `frequency` is set to "Day" and `interval` is set to 2, then the schedule will repeat every 2 days. Required only if frequency is used.
      name: interval_time
    - description: Specifies the schedule repeat day of the interval month. For example, if `date_of_month` is 17 and `interval` is set to 2, then the schedule will repeat every 2 months on the 17th day of the month. Required and used only if frequency is set to `Date of month`.
      name: date_of_month
    - description: A unique user-defined name for the scan launched by the schedule. If not explicitly set in the schedule, the scan name will be generated prior to the scan launching.
      name: scan_name
    - description: ID of the scan template to use.
      name: scan_template
    description: "Beta Command\n\nUpdate an existing site scan schedule."
    name: nexpose-update-scan-schedule
  - arguments:
    - description: ID of the site.
      name: site_id
    - description: Name of the site (can be used instead of `site_id`).
      name: site_name
    - description: ID of the site scan credential to update.
      name: credential_id
      required: true
    - description: Name of the credential.
      name: name
      required: true
    - auto: PREDEFINED
      description: Credential service type.
      name: service
      predefined:
      - AS400
      - CIFS
      - CIFSHash
      - CVS
      - DB2
      - FTP
      - HTTP
      - MS-SQL
      - MySQL
      - Notes
      - Oracle
      - POP
      - PostgresSQL
      - Remote-Exec
      - SNMP
      - SNMPv3
      - SSH
      - SSH-Key
      - Sybase
      - Telnet
      required: true
    - description: Database name.
      name: database
    - description: Description for the credential.
      name: description
    - description: Domain address.
      name: domain
    - description: Hostname or IP address to restrict the credentials to.
      name: host_restriction
    - description: HTTP realm.
      name: http_realm
    - description: Password for the notes account that will be used for authenticating.
      name: notes_id_password
    - description: NTLM password hash.
      name: ntlm_hash
    - auto: PREDEFINED
      description: Whether the scan engine should attempt to enumerate SIDs from the environment.
      name: oracle_enumerate_sids
      predefined:
      - 'true'
      - 'false'
    - description: Oracle Net Listener password. Used to enumerate SIDs from your environment.
      name: oracle_listener_password
    - description: Oracle database name.
      name: oracle_sid
    - description: Password for the credential.
      name: password
    - description: Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `host_restriction` is used.
      name: port_restriction
    - description: SNMP community for authentication.
      name: community_name
    - auto: PREDEFINED
      description: SNMPv3 authentication type for the credential.
      name: authentication_type
      predefined:
      - No-Authentication
      - MD5
      - SHA
    - description: SNMPv3 privacy password to use.
      name: privacy_password
    - auto: PREDEFINED
      description: SNMPv3 Privacy protocol to use.
      name: privacy_type
      predefined:
      - No-Privacy
      - DES
      - AES-128
      - AES-192
      - AES-192-With-3-DES-Key-Extension
      - AES-256
      - AES-256-With-3-DES-Key-Extension
    - description: PEM formatted private key.
      name: ssh_key_pem
    - auto: PREDEFINED
      description: Elevation type to use for scans.
      name: ssh_permission_elevation
      predefined:
      - None
      - sudo
      - sudosu
      - su
      - pbrun
      - Privileged Exec
    - description: Password to use for elevation.
      name: ssh_permission_elevation_password
    - description: Username to use for elevation.
      name: ssh_permission_elevation_username
    - description: Password for the private key.
      name: ssh_private_key_password
    - auto: PREDEFINED
      description: Whether to use Windows authentication.
      name: use_windows_authentication
      predefined:
      - 'true'
      - 'false'
    - description: Username for the credential.
      name: username
    description: "Beta Command\n\nUpdate an existing site scan credential. For detailed explanation of all parameters of this command, see: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/setSiteCredentials."
    name: nexpose-update-site-scan-credential
  - arguments:
    - description: ID of the vulnerability exception to update.
      name: id
      required: true
    - description: An expiration date for the vulnerability exception formatted in ISO 8601 format. Must be a date in the future.
      name: expiration
      required: true
    description: Update an existing vulnerability exception.
    name: nexpose-update-vulnerability-exception-expiration
  - arguments:
    - description: ID of the vulnerability exception to update.
      name: id
      required: true
    - auto: PREDEFINED
      description: A status to update the vulnerability exception to.
      name: status
      required: true
      predefined:
      - Recall
      - Approve
      - Reject
    description: Update an existing vulnerability exception.
    name: nexpose-update-vulnerability-exception-status
  - arguments:
    - description: ID of the shared credential to update.
      name: id
      required: true
    - description: Name of the credential.
      name: name
      required: true
    - auto: PREDEFINED
      description: Site assignment configuration for the credential. Assign the shared scan credential either to be available to all sites, or a specific list of sites.
      name: site_assignment
      predefined:
      - All-Sites
      - Specific-Sites
      required: true
    - auto: PREDEFINED
      description: Credential service type.
      name: service
      predefined:
      - AS400
      - CIFS
      - CIFSHash
      - CVS
      - DB2
      - FTP
      - HTTP
      - MS-SQL
      - MySQL
      - Notes
      - Oracle
      - POP
      - PostgresSQL
      - Remote-Exec
      - SNMP
      - SNMPv3
      - SSH
      - SSH-Key
      - Sybase
      - Telnet
      required: true
    - description: Database name.
      name: database
    - description: Description for the credential.
      name: description
    - description: Domain address.
      name: domain
    - description: Hostname or IP address to restrict the credentials to.
      name: host_restriction
    - description: HTTP realm.
      name: http_realm
    - description: Password for the notes account that will be used for authenticating.
      name: notes_id_password
    - description: NTLM password hash.
      name: ntlm_hash
    - auto: PREDEFINED
      description: Whether the scan engine should attempt to enumerate SIDs from the environment.
      name: oracle_enumerate_sids
      predefined:
      - 'true'
      - 'false'
    - description: Oracle Net Listener password. Used to enumerate SIDs from your environment.
      name: oracle_listener_password
    - description: Oracle database name.
      name: oracle_sid
    - description: Password for the credential.
      name: password
    - description: Further restricts the credential to attempt to authenticate on a specific port. Can be used only if `host_restriction` is used.
      name: port_restriction
    - description: List of site IDs for the shared credential that are explicitly assigned access to the shared scan credential, allowing it to use the credential during a scan.
      isArray: true
      name: sites
    - description: SNMP community for authentication.
      name: community_name
    - auto: PREDEFINED
      description: SNMPv3 authentication type for the credential.
      name: authentication_type
      predefined:
      - No-Authentication
      - MD5
      - SHA
    - description: SNMPv3 privacy password to use.
      name: privacy_password
    - auto: PREDEFINED
      description: SNMPv3 Privacy protocol to use.
      name: privacy_type
      predefined:
      - No-Privacy
      - DES
      - AES-128
      - AES-192
      - AES-192-With-3-DES-Key-Extension
      - AES-256
      - AES-256-With-3-DES-Key-Extension
    - description: PEM formatted private key.
      name: ssh_key_pem
    - auto: PREDEFINED
      description: Elevation type to use for scans.
      name: ssh_permission_elevation
      predefined:
      - None
      - sudo
      - sudosu
      - su
      - pbrun
      - Privileged-Exec
    - description: Password to use for elevation.
      name: ssh_permission_elevation_password
    - description: Username to use for elevation.
      name: ssh_permission_elevation_username
    - description: Password for the private key.
      name: ssh_private_key_password
    - auto: PREDEFINED
      description: Whether to use Windows authentication.
      name: use_windows_authentication
      predefined:
      - 'true'
      - 'false'
    - description: Username for the credential.
      name: username
    description: Update an existing shared credential.
    name: nexpose-update-shared-credential
  - name: nexpose-create-tag
    arguments:
    - name: name
      required: true
      description: The tag name.
    - name: type
      required: true
      auto: PREDEFINED
      predefined:
      - owner
      - location
      - custom
      description: The tag type.
    - name: color
      auto: PREDEFINED
      predefined:
      - blue
      - green
      - orange
      - red
      - purple
      - default
      description: The tag color - relevant only for "custom" type.
      defaultValue: Default
    - name: ip_address_is
      description: A specific IP address to search for.
    - name: host_name_is
      description: A specific host name to search for.
    - name: risk_score_higher_than
      description: A minimum risk score to use as a filter.
    - name: vulnerability_title_contains
      description: A string to search for in vulnerability titles.
    - name: site_id_in
      description: Site IDs to filter for. Can be a comma-separated list.
      isArray: true
    - name: site_name_in
      description: Site names to filter for. Can be a comma-separated list.
      isArray: true
    - name: match
      auto: PREDEFINED
      predefined:
      - All
      - Any
      description: Operator to determine how to match filters. "All" requires that all filters match for an asset to be included. "Any" requires only one filter to match for an asset to be included.
      defaultValue: Any
    - name: query
      description: Additional queries to use as a filter, following the Search Criteria API standard. The structure is {field} {operator} {value}. Multiple queries can be specified, separated by a ";" separator. For example, 'ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost'.
    description: Create a tag.
    outputs:
    - contextPath: Nexpose.Tag.id
      description: The tag ID.
      type: int
  - name: nexpose-delete-tag
    arguments:
    - name: id
      required: true
      description: The tag ID.
    description: Delete a tag.
  - name: nexpose-list-tag
    arguments:
    - name: id
      description: Get tag by ID.
    - name: name
      description: Filters the returned tags to only those containing the value within their name.
    - name: type
      auto: PREDEFINED
      predefined:
      - owner
      - location
      - custom
      description: Filters the returned tags to only those of this type.
    - name: page_size
      description: Number of records to retrieve in each API call when pagination is used.
    - name: page
      description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
    - name: limit
      description: A number of records to limit the response to.
    description: Return a list of tags.
    outputs:
    - contextPath: Nexpose.Tag.color
      description: The color associated with the tag.
      type: String
    - contextPath: Nexpose.Tag.created
      description: The date when the tag was created.
      type: Date
    - contextPath: Nexpose.Tag.id
      description: The unique identifier of the tag.
      type: Number
    - contextPath: Nexpose.Tag.name
      description: The name of the tag.
      type: String
    - contextPath: Nexpose.Tag.searchCriteria.match
      description: The match criteria used for the tag search (e.g., "all" or "any").
      type: String
    - contextPath: Nexpose.Tag.searchCriteria.filters.field
      description: The field name used in the tag search filter.
      type: String
    - contextPath: Nexpose.Tag.searchCriteria.filters.operator
      description: The operator used in the tag search filter (e.g., "is", "contains", "is-greater-than").
      type: String
    - contextPath: Nexpose.Tag.searchCriteria.filters.lower
      description: The lower bound of the range used in the tag search filter.
      type: String
    - contextPath: Nexpose.Tag.searchCriteria.filters.upper
      description: The upper bound of the range used in the tag search filter.
      type: String
    - contextPath: Nexpose.Tag.source
      description: The source of the tag.
      type: String
    - contextPath: Nexpose.Tag.type
      description: The type of the tag.
      type: String
    - contextPath: Nexpose.Tag.searchCriteria.filters.value
      description: The value used in the tag search filter.
      type: String
    - contextPath: Nexpose.Tag.page.number
      description: The current page number in the paginated response.
      type: Number
    - contextPath: Nexpose.Tag.page.size
      description: The number of items per page in the paginated response.
      type: Number
    - contextPath: Nexpose.Tag.page.totalResources
      description: The total number of resources available.
      type: Number
    - contextPath: Nexpose.Tag.page.totalPages
      description: The total number of pages available.
      type: Number
  - name: nexpose-update-tag-search-criteria
    arguments:
    - name: tag_id
      required: true
      description: The tag ID.
    - name: ip_address_is
      description: A specific IP address to search for.
    - name: host_name_is
      description: A specific host name to search for.
    - name: risk_score_higher_than
      description: A minimum risk score to use as a filter.
    - name: vulnerability_title_contains
      description: A string to search for in vulnerability titles.
    - name: site_id_in
      description: Site IDs to filter for. Can be a comma-separated list.
      isArray: true
    - name: site_name_in
      description: Site names to filter for. Can be a comma-separated list.
    - name: match
      auto: PREDEFINED
      predefined:
      - All
      - Any
      description: Operator to determine how to match filters. "All" requires that all filters match for an asset to be included. "Any" requires only one filter to match for an asset to be included.
      defaultValue: Any
    - name: query
      description: Additional queries to use as a filter, following the Search Criteria API standard. The structure is {field} {operator} {value}. Multiple queries can be specified, separated by a ";" separator. For example, 'ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost'.
    - name: overwrite
      auto: PREDEFINED
      predefined:
      - "yes"
      - "no"
      description: Whether to overwrite the original search values or append new conditions to the existing search.
      defaultValue: "no"
    description: Update tag search criteria.
  - name: nexpose-list-tag-asset-group
    arguments:
    - name: tag_id
      required: true
      description: The tag ID.
    description: Return a list of asset groups for a tag.
    outputs:
    - contextPath: Nexpose.TagAssetGroup.id
      description: Asset group ID.
      type: int
  - name: nexpose-add-tag-asset-group
    arguments:
    - name: tag_id
      required: true
      description: The tag ID.
    - name: asset_group_ids
      required: true
      description: The asset group IDs to add. Can be a comma-separated list.
    description: Add existing asset groups to an existing tag.
  - name: nexpose-remove-tag-asset-group
    arguments:
    - name: tag_id
      required: true
      description: The tag ID.
    - name: asset_group_id
      required: true
      description: The asset group ID.
    description: Remove an asset group from a tag.
  - name: nexpose-list-tag-asset
    arguments:
    - name: tag_id
      required: true
      description: The tag ID.
    description: Return the tag assets list.
    outputs:
    - contextPath: Nexpose.TagAsset.id
      description: Asset ID.
      type: int
    - contextPath: Nexpose.TagAsset.sources
      description: The asset sources.
      type: string
  - name: nexpose-add-tag-asset
    arguments:
    - name: tag_id
      required: true
      description: The tag ID.
    - name: asset_id
      required: true
      description: The asset ID.
    description: Add an existing asset to an existing tag.
  - name: nexpose-remove-tag-asset
    arguments:
    - name: tag_id
      required: true
      description: The tag ID.
    - name: asset_id
      required: true
      description: The asset ID.
    description: Remove an asset from a tag. Note that the asset must be added through the asset or tag. If the asset is added using a site, asset group, or search criteria, this action will not remove the asset from the tag.
  - name: nexpose-add-site-included-asset
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    - name: assets
      description: List of addresses to add to the site's included scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation.
      isArray: true
    - name: asset_group_ids
      isArray: true
      description: List of asset group identifiers.
    description: Add included assets to a site.
  - name: nexpose-remove-site-included-asset
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    - name: assets
      isArray: true
      description: List of addresses to remove from the site's included scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation.
    - name: asset_group_ids
      isArray: true
      description: List of asset group identifiers.
    description: Remove included assets from a site.
    compliantpolicies:
    - EndPoint Isolation
  - name: nexpose-list-site-included-asset
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    description: Return a list of included assets for a site.
    outputs:
    - contextPath: Nexpose.IncludedAsset.site_id
      description: The site ID.
      type: int
    - contextPath: Nexpose.IncludedAsset.addresses
      description: A list of addresses of the included assets for the specified site.
      type: string
  - name: nexpose-list-site-included-asset-group
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    description: Return a list of included asset groups for a site.
    outputs:
    - contextPath: Nexpose.IncludedAssetGroup.site_id
      description: The site ID.
      type: int
    - contextPath: Nexpose.IncludedAssetGroup.resources
      description: The asset group ID.
      type: int
  - name: nexpose-add-site-excluded-asset
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    - name: assets
      description: List of addresses to add to the site's excluded scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation.
    - name: asset_group_ids
      description: List of asset group IDs to exclude.
    description: Add excluded assets to a site.
  - name: nexpose-remove-site-excluded-asset
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    - name: assets
      description: List of addresses to remove from the site's excluded scan assets. Each address is a string that can represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation.
    - name: asset_group_ids
      description: List of asset group IDs to remove from the site's exclusion list.
    description: Remove excluded assets from a site.
  - name: nexpose-list-site-excluded-asset
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    description: Return a list of excluded assets for a site.
    outputs:
    - contextPath: Nexpose.ExcludedAsset.site_id
      description: The site ID.
      type: int
    - contextPath: Nexpose.ExcludedAsset.addresses
      description: A list of addresses of the excluded assets for the specified site.
      type: string
  - name: nexpose-list-site-excluded-asset-group
    arguments:
    - name: site_id
      required: true
      description: A URL parameter.
    description: Return a list of excluded asset groups for a site.
    outputs:
    - contextPath: Nexpose.ExcludedAssetGroup.site_id
      description: The site ID.
      type: int
    - contextPath: Nexpose.ExcludedAssetGroup.resources
      description: The asset group ID.
      type: int
  - name: nexpose-create-asset-group
    arguments:
    - name: name
      required: true
      description: The asset group name.
    - name: type
      required: true
      auto: PREDEFINED
      predefined:
      - static
      - dynamic
      description: The asset group type.
    - name: description
      required: true
      description: The description of the asset group.
    - name: ip_address_is
      description: A specific IP address to search for.
    - name: host_name_is
      description: A specific host name to search for.
    - name: risk_score_higher_than
      description: A minimum risk score to use as a filter.
    - name: vulnerability_title_contains
      description: A string to search for in vulnerability titles.
    - name: site_id_in
      description: Site IDs to filter for. Can be a comma-separated list.
      isArray: true
    - name: site_name_in
      description: Site names to filter for. Can be a comma-separated list.
      isArray: true
    - name: match
      auto: PREDEFINED
      predefined:
      - All
      - Any
      description: Operator to determine how to match filters. "All" requires that all filters match for an asset to be included. "Any" requires only one filter to match for an asset to be included.
      defaultValue: Any
    - name: query
      description: Additional queries to use as a filter, following the Search Criteria API standard. The structure is {field} {operator} {value}. Multiple queries can be specified, separated by a ";" separator. For example, 'ip-address in-range 192.0.2.0,192.0.2.1;host-name is myhost'.
    description: 'Create an asset group. Note: All filters are relevant only for Dynamic asset groups.'
    outputs:
    - contextPath: Nexpose.AssetGroup.id
      description: The asset group ID.
      type: int
  - name: nexpose-list-asset-group
    arguments:
    - name: group_id
      description: Get asset group by ID.
    - name: group_name
      description: Filters the returned asset groups to only those containing the value within their name.
    - name: type
      auto: PREDEFINED
      predefined:
      - static
      - dynamic
      description: Filters the returned asset groups to only those of this type.
    - name: page_size
      description: Number of records to retrieve in each API call when pagination is used.
    - name: page
      description: A specific page to retrieve when pagination is used. Page indexing starts at 0.
    - name: limit
      description: A number of records to limit the response to.
    - name: sort
      description: The criteria to sort the records by, in the format property[,ASC|DESC]. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
    description: Return a list of asset groups.
    outputs:
    - contextPath: Nexpose.AssetGroup.assets
      description: 'The number of assets in the asset group.'
      type: Number
    - contextPath: Nexpose.AssetGroup.id
      description: 'The unique identifier of the asset group.'
      type: Number
    - contextPath: Nexpose.AssetGroup.name
      description: 'The name of the asset group.'
      type: String
    - contextPath: Nexpose.AssetGroup.riskScore
      description: 'The cumulative risk score of the asset group.'
      type: Number
    - contextPath: Nexpose.AssetGroup.type
      description: 'The type of the asset group.'
      type: String
    - contextPath: Nexpose.AssetGroup.vulnerabilities.critical
      description: 'The number of critical vulnerabilities in the asset group.'
      type: Number
    - contextPath: Nexpose.AssetGroup.vulnerabilities.moderate
      description: 'The number of moderate vulnerabilities in the asset group.'
      type: Number
    - contextPath: Nexpose.AssetGroup.vulnerabilities.severe
      description: 'The number of severe vulnerabilities in the asset group.'
      type: Number
    - contextPath: Nexpose.AssetGroup.vulnerabilities.total
      description: 'The total number of vulnerabilities in the asset group.'
      type: Number
    - contextPath: Nexpose.AssetGroup.description
      description: 'The description of the asset group.'
      type: String

  runonce: false
  script: '-'
  type: python
  subtype: python3
  isfetchassets: true
  dockerimage: demisto/auth-utils:1.0.0.10133006
fromversion: 5.0.0
tests:
- nexpose_test
supportedModules:
- agentix
- xsiam
- edr
- cloud
- cloud_runtime_security
- exposure_management