Awesome Open Source
Awesome Open Source

Greenbone Logo

Greenbone Vulnerability Management Python Library

GitHub releases PyPI release Scrutinizer Code Quality code test coverage Build and test

The Greenbone Vulnerability Management Python API library (python-gvm) is a collection of APIs that help with remote controlling a Greenbone Security Manager (GSM) appliance and its underlying Greenbone Vulnerability Manager (GVM). The library essentially abstracts accessing the communication protocols Greenbone Management Protocol (GMP) and Open Scanner Protocol (OSP).

Table of Contents


The documentation for python-gvm can be found at Please always take a look at the documentation for further details. This README just gives you a short overview.



Please consider to always use the newest version of gvm-tools and python-gvm. We freqently update this projects to add features and keep them free from bugs. This is why installing python-gvm using pip is recommended.

To use python-gvm with an old GMP version (7, 8, 9) you must use a release version that is <21.05. In the 21.05 release the support of these versions have been dropped.


Python 3.7 and later is supported.

Install using pip

pip 19.0 or later is required.

You can install the latest stable release of python-gvm from the Python Package Index using pip:

python3 -m pip install --user python-gvm


from gvm.connections import UnixSocketConnection
from gvm.protocols.gmp import Gmp
from gvm.transforms import EtreeTransform
from gvm.xml import pretty_print

connection = UnixSocketConnection()
transform = EtreeTransform()

with Gmp(connection, transform=transform) as gmp:
    # Retrieve GMP version supported by the remote daemon
    version = gmp.get_version()

    # Prints the XML in beautiful form

    # Login
    gmp.authenticate('foo', 'bar')

    # Retrieve all tasks
    tasks = gmp.get_tasks()

    # Get names of tasks
    task_names = tasks.xpath('task/name/text()')


For any question on the usage of python-gvm please use the Greenbone Community Portal. If you found a problem with the software, please create an issue on GitHub.


This project is maintained by Greenbone Networks GmbH.


Your contributions are highly appreciated. Please create a pull request on GitHub. For bigger changes, please discuss it first in the issues.

For development you should use poetry to keep you python packages separated in different environments. First install poetry via pip

python3 -m pip install --user poetry

Afterwards run

poetry install

in the checkout directory of python-gvm (the directory containing the pyproject.toml file) to install all dependencies including the packages only required for development.

The python-gvm repository uses autohooks to apply linting and auto formatting via git hooks. Please ensure the git hooks are active.

$ poetry install
$ poetry run autohooks activate --force


Copyright (C) 2017-2021 Greenbone Networks GmbH

Licensed under the GNU General Public License v3.0 or later.

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Python (1,141,503
Python Library (1,273
Vulnerability Scanners (338
Vulnerability Detection (176
Related Projects