Greenbone
24 min
the greenbone connector enables streamlined vulnerability management by facilitating the retrieval and analysis of security scan reports directly within the swimlane turbine platform greenbone is a leading provider of vulnerability management solutions that enable organizations to identify, assess, and mitigate security risks the greenbone connector for swimlane turbine allows users to automate the retrieval of detailed vulnerability reports, format selections, and comprehensive scan results directly within their security workflows by integrating with greenbone, swimlane turbine users can enhance their vulnerability management processes, gain deeper insights into security posture, and streamline remediation efforts with up to date vulnerability data 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 https //greenbone github io/python gvm/index html prerequisites to effectively utilize the greenbone connector with swimlane turbine, ensure you have the following prerequisites a greenbone tls server connection with the following parameters hostname the address of the greenbone server port the port number used to connect to the greenbone server user your greenbone server username base64 ca file the base64 encoded certificate authority file for secure connection password your greenbone server password an ssh connection setup with the following parameters hostname the address of the greenbone server for ssh connections port the port number used for ssh connections to the greenbone server user your username for ssh access to the greenbone server password your password for ssh access to the greenbone server 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 https //greenbone github io/python gvm/api/gmpv225 html?utm source=chatgpt com#gvm protocols gmp gmpv225 get report formats get report request a single report https //greenbone github io/python gvm/api/gmpv225 html?utm source=chatgpt com#gvm protocols gmp gmpv225 get report 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 string 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 string required user the user of the greenbone server string required password the password of the greenbone server string required timeout the timeout of the greenbone server number optional actions get report retrieves a detailed report from greenbone using the specified report id, essential for vulnerability analysis 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 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 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 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 get reports response filters object output field get reports response filters get reports response filters \@id string unique identifier get reports response filters term string output field get reports response filters term 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 select 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 retrieve a comprehensive list of scan reports from greenbone, detailing security scan results 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