Greenbone
Greenbone provides advanced vulnerability management solutions for identifying and mitigating security risks across IT environments.
Greenbone is a leading open-source platform for vulnerability scanning and management, providing comprehensive security assessments across IT assets. This connector enables Swimlane Turbine users to automate the retrieval and management of vulnerability scan reports, access detailed findings, and customize report formats directly within their security workflows. By integrating Greenbone with Swimlane Turbine, security teams can streamline vulnerability management, accelerate incident response, and ensure up-to-date visibility into security risksβall without manual intervention or coding. The connector supports secure TLS and SSH connections, ensuring safe and flexible integration with Greenbone deployments.
Supported Version
- The Greenbone connector supports the following versions of the Greenbone:
- GMP v22.4
- GMP v22.5
- GMP v22.6
- GMP v22.7
Additional Documents
Prerequisites
To use the Greenbone connector, ensure you have the following prerequisites configured:
- SSH-based authentication using the SSH Class asset:
- Hostname: The IP address or DNS name of your Greenbone server.
- Port: The SSH port number used to connect (typically 22).
- SSH User: The username for SSH access to the Greenbone server.
- User: The Greenbone application user account for GVM operations.
- Password: The password associated with the specified user account.
- TLS-based authentication using the Greenbone TLS asset:
- Hostname: The IP address or DNS name of your Greenbone TLS server.
- Port: The port number for TLS connections (commonly 9390).
- User: The Greenbone application user account for GVM operations.
- Base64 CA File: The base64-encoded Certificate Authority file required for secure TLS communication.
- Password: The password associated with the specified user account.
Authentication Methods
Setup Instructions:
- Obtain TLS Certificates and Keys:
- Contact your Greenbone administrator to obtain the required TLS certificates and keys
- You will need:
- CA (Certificate Authority) file
- Client certificate file
- Private key file
- Convert Files to Base64:
- Convert each certificate/key file to Base64 encoding
- Use the following command for each file:
base64 -i <filename> -o <filename>.b64- Example:
base64 -i ca.pem -o ca.pem.b64
base64 -i client.crt -o client.crt.b64
base64 -i client.key -o client.key.b64- Configure Asset:
- Navigate to the Greenbone connector asset configuration
- Fill in the following required fields:
- Hostname: IP address or FQDN of your Greenbone server
- Port: TLS port (typically 9392)
- User: Username for Greenbone authentication
- CA File: Paste the Base64-encoded CA file content
- Password: Password for the Greenbone user account
Capabilities
This Greenbone Connector provides the following capabilities:
- Get Report Formats
- Get Report
Get Report Formats
- Request a list of report formats Click Here.
Get Report
- Request a single report Click Here.
- Choose Output Format:
- JSON (default): returns structured report data.
- CSV: requests Greenbone's native CSV Results format and returns it as a file attachment.
Additional Documentation
Configurations
Greenbone TLS Connection
This asset is used to connect to a Greenbone TLS server.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
hostname | The hostname of the target host. | string | Required |
port | The port of the target host. | number | Required |
user | The user of the Greenbone server. | string | Required |
base64_certfile | The base64 encoded certfile of the Greenbone server. PEM encoded certificate file. | string | Optional |
base64_cafile | The base64 encoded cafile of the Greenbone server. PEM encoded CA file. | string | Required |
base64_keyfile | The base64 encoded keyfile of the Greenbone server. PEM encoded private key file. | string | Optional |
password | The password of the Greenbone server. | string | Required |
timeout | The timeout of the Greenbone server. | number | Optional |
Greenbone SSH Connection
This asset is used SSH Class to connect, read and write from GVM via SSH.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
hostname | The hostname of the target host. | string | Required |
port | The port of the target host. | number | Required |
ssh_user | The user of the SSH server. | string | Required |
ssh_password | The password of the SSH server. | string | Optional |
gb_user | The user of the Greenbone server. | string | Required |
gb_password | The password of the Greenbone server. | string | Required |
timeout | The timeout of the Greenbone server. | number | Optional |
Actions
Get Report
Retrieve a detailed vulnerability analysis report from Greenbone using the specified report ID.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
report_id | string | Required | UUID of an existing report. |
filter_string | string | Optional | Filter term to use to filter results in the report. |
filter_id | string | Optional | UUID of filter to use to filter results in the report. |
delta_report_id | string | Optional | UUID of an existing report to compare report to. |
report_format_id | string | Optional | UUID of report format to use. |
ignore_pagination | boolean | Optional | Whether to ignore the filter terms βfirstβ and βrowsβ. |
details | boolean | Optional | Request additional report information details defaults to True. |
output_format | string | Optional | Format for the report data. JSON returns structured report data. CSV requests Greenbone's native CSV Results format and returns it as a file attachment. |
Input Example
{"report_id":"1fd969ce-157c-40ed-b6f7-71ee8b053a33","filter_string":"apply_overrides=0 min_qod=70 first=1 rows=10 sort=name","filter_id":"1fd969ce-157c-40ed-b6f7-71ee8b053a33","delta_report_id":"1fd969ce-157c-40ed-b6f7-71ee8b053a33","report_format_id":"c402cc3e-b531-11e1-9163-406186ea4fc5","ignore_pagination":false,"details":true,"output_format":"JSON"}
Output
Parameter | Type | Description |
|---|---|---|
file | object | Greenbone CSV Results file when Output Format is CSV. |
file.filename | string | Name of the resource |
file.file_data | string | Response data |
get_reports_response | object | Output field: get_reports_response |
get_reports_response.@status | string | Status value |
get_reports_response.@status_text | string | Status value |
get_reports_response.report | object | Output field: get_reports_response.report |
get_reports_response.report.@id | string | Unique identifier |
get_reports_response.report.@format_id | string | Unique identifier |
get_reports_response.report.@extension | string | Output field: get_reports_response.report.@extension |
get_reports_response.report.@content_type | string | Type of the resource |
get_reports_response.report.owner | object | Output field: get_reports_response.report.owner |
get_reports_response.report.owner.name | string | Name of the resource |
get_reports_response.report.name | string | Name of the resource |
get_reports_response.report.comment | object | Output field: get_reports_response.report.comment |
get_reports_response.report.creation_time | string | Time value |
get_reports_response.report.modification_time | string | Time value |
get_reports_response.report.writable | string | Output field: get_reports_response.report.writable |
get_reports_response.report.in_use | string | Output field: get_reports_response.report.in_use |
get_reports_response.report.task | object | Output field: get_reports_response.report.task |
get_reports_response.report.task.@id | string | Unique identifier |
get_reports_response.report.task.name | string | Name of the resource |
get_reports_response.report.report_format | object | Output field: get_reports_response.report.report_format |
get_reports_response.report.report_format.@id | string | Unique identifier |
get_reports_response.report.report_format.name | string | Name of the resource |
Output Example
{"get_reports_response":{"@status":"200","@status_text":"OK","report":{"@id":"1fd969ce-157c-40ed-b6f7-71ee8b053a33","@format_id":"c402cc3e-b531-11e1-9163-406186ea4fc5","@extension":"pdf","@content_type":"application/pdf","owner":{},"name":"2025-10-13T05:22:13Z","comment":null,"creation_time":"2025-10-13T05:22:13Z","modification_time":"2025-10-13T05:38:38Z","writable":"0","in_use":"0","task":{},"report_format":{}},"filters":{"@id":"","term":"apply_overrides=0 min_qod=70 first=1 rows=10 sort=name"...
Get Report Formats
Retrieve available report formats from Greenbone to enable selection of preferred data export options.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
filter_string | string | Optional | Filter term to use for the query. |
filter_id | string | Optional | UUID of an existing filter to use for the query. |
trash | boolean | Optional | Whether to get the trashcan report formats instead. |
alerts | boolean | Optional | Whether to include alerts that use the report format. |
params | boolean | Optional | Whether to include report format parameters. |
details | boolean | Optional | Include report format file, signature and parameters. |
Input Example
{"filter_string":"apply_overrides=0 min_qod=70 first=1 rows=10 sort=name","filter_id":"1fd969ce-157c-40ed-b6f7-71ee8b053a33","trash":false,"alerts":false,"params":false,"details":true}
Output
Parameter | Type | Description |
|---|---|---|
get_report_formats_response | object | Output field: get_report_formats_response |
get_report_formats_response.@status | string | Status value |
get_report_formats_response.@status_text | string | Status value |
get_report_formats_response.report_format | array | Output field: get_report_formats_response.report_format |
get_report_formats_response.filters | object | Output field: get_report_formats_response.filters |
get_report_formats_response.filters.@id | string | Unique identifier |
get_report_formats_response.filters.term | string | Output field: get_report_formats_response.filters.term |
get_report_formats_response.filters.keywords | object | Output field: get_report_formats_response.filters.keywords |
get_report_formats_response.filters.keywords.keyword | array | Output field: get_report_formats_response.filters.keywords.keyword |
get_report_formats_response.filters.keywords.keyword.column | string | Output field: get_report_formats_response.filters.keywords.keyword.column |
get_report_formats_response.filters.keywords.keyword.relation | string | Output field: get_report_formats_response.filters.keywords.keyword.relation |
get_report_formats_response.filters.keywords.keyword.value | string | Value for the parameter |
get_report_formats_response.sort | object | Output field: get_report_formats_response.sort |
get_report_formats_response.sort.field | object | Output field: get_report_formats_response.sort.field |
get_report_formats_response.sort.field.order | string | Output field: get_report_formats_response.sort.field.order |
get_report_formats_response.sort.field.#text | string | Output field: get_report_formats_response.sort.field.#text |
get_report_formats_response.report_formats | object | Output field: get_report_formats_response.report_formats |
get_report_formats_response.report_formats.@start | string | Output field: get_report_formats_response.report_formats.@start |
get_report_formats_response.report_formats.@max | string | Output field: get_report_formats_response.report_formats.@max |
get_report_formats_response.report_format_count | object | Count value |
get_report_formats_response.report_format_count.filtered | string | Output field: get_report_formats_response.report_format_count.filtered |
get_report_formats_response.report_format_count.page | string | Output field: get_report_formats_response.report_format_count.page |
get_report_formats_response.report_format_count.#text | string | Output field: get_report_formats_response.report_format_count.#text |
Output Example
{"get_report_formats_response":{"@status":"200","@status_text":"OK","report_format":[{"@id":"5057e5cc-b825-11e4-9d0e-28d24461215b","owner":{"name":"admin"},"name":"Anonymous XML","comment":null,"creation_time":"2025-10-13T02:58:45Z","modification_time":"2025-10-13T02:58:45Z","writable":"1","in_use":"0","permissions":{"permission":{"name":"Everything"}},"extension":"xml","content_type":"text/xml","summary":"Anonymous version of the raw XML report. Version 20200827.","description":"Anonymized scan...
Get Reports
Obtain a detailed list of scan reports from Greenbone, highlighting security scan outcomes and findings.
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
filter_string | string | Optional | Filter term to use for the query. |
filter_id | string | Optional | UUID of an existing filter to use for the query. |
note_details | boolean | Optional | If notes are included, whether to include note details. |
override_details | boolean | Optional | If overrides are included, whether to include override details. |
ignore_pagination | boolean | Optional | Whether to ignore the filter terms "first" and "rows". |
details | boolean | Optional | Request additional report information details defaults to True. |
Input Example
{"filter_string":"apply_overrides=0 min_qod=70 first=1 rows=10 sort=name","filter_id":"1fd969ce-157c-40ed-b6f7-71ee8b053a33","note_details":true,"override_details":true,"ignore_pagination":false,"details":true}
Output
Parameter | Type | Description |
|---|---|---|
get_reports_response | object | Output field: get_reports_response |
get_reports_response.@status | string | Status value |
get_reports_response.@status_text | string | Status value |
get_reports_response.report | object | Output field: get_reports_response.report |
get_reports_response.report.@id | string | Unique identifier |
get_reports_response.report.@format_id | string | Unique identifier |
get_reports_response.report.@extension | string | Output field: get_reports_response.report.@extension |
get_reports_response.report.@content_type | string | Type of the resource |
get_reports_response.report.owner | object | Output field: get_reports_response.report.owner |
get_reports_response.report.owner.name | string | Name of the resource |
get_reports_response.report.name | string | Name of the resource |
get_reports_response.report.comment | object | Output field: get_reports_response.report.comment |
get_reports_response.report.creation_time | string | Time value |
get_reports_response.report.modification_time | string | Time value |
get_reports_response.report.writable | string | Output field: get_reports_response.report.writable |
get_reports_response.report.in_use | string | Output field: get_reports_response.report.in_use |
get_reports_response.report.task | object | Output field: get_reports_response.report.task |
get_reports_response.report.task.@id | string | Unique identifier |
get_reports_response.report.task.name | string | Name of the resource |
get_reports_response.report.report | object | Output field: get_reports_response.report.report |
get_reports_response.report.report.@id | string | Unique identifier |
get_reports_response.report.report.gmp | object | Output field: get_reports_response.report.report.gmp |
get_reports_response.report.report.gmp.version | string | Output field: get_reports_response.report.report.gmp.version |
get_reports_response.report.report.sort | object | Output field: get_reports_response.report.report.sort |
get_reports_response.report.report.sort.field | object | Output field: get_reports_response.report.report.sort.field |
Output Example
{"get_reports_response":{"@status":"200","@status_text":"OK","report":{"@id":"1fd969ce-157c-40ed-b6f7-71ee8b053a33","@format_id":"","@extension":"","@content_type":"application/xml","owner":{},"name":"2025-10-13T05:22:13Z","comment":null,"creation_time":"2025-10-13T05:22:13Z","modification_time":"2025-10-13T05:38:38Z","writable":"0","in_use":"0","task":{},"report":{}},"filters":{"@id":"","term":"apply_overrides=0 min_qod=70 first=1 rows=10 sort=name","keywords":{}},"sort":{"field":{}},"reports":...
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |