Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Update documentation to add GMP version 22.5 #1098

Merged
merged 1 commit into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/api/gmpv224.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,54 +11,67 @@ Enums
.. autoclass:: AlertCondition
:members:
:undoc-members:
:noindex:

.. autoclass:: AlertEvent
:members:
:undoc-members:
:noindex:

.. autoclass:: AlertMethod
:members:
:undoc-members:
:noindex:

.. autoclass:: AliveTest
:members:
:undoc-members:
:noindex:

.. autoclass:: CredentialFormat
:members:
:undoc-members:
:noindex:

.. autoclass:: CredentialType
:members:
:undoc-members:
:noindex:

.. autoclass:: EntityType
:members:
:undoc-members:
:noindex:

.. autoclass:: FeedType
:members:
:undoc-members:
:noindex:

.. autoclass:: FilterType
:members:
:undoc-members:
:noindex:

.. autoclass:: HostsOrdering
:members:
:undoc-members:
:noindex:

.. autoclass:: HelpFormat
:members:
:undoc-members:
:noindex:

.. autoclass:: InfoType
:members:
:undoc-members:
:noindex:

.. autoclass:: PermissionSubjectType
:members:
:undoc-members:
:noindex:

.. autoclass:: PortRangeType
:members:
Expand All @@ -78,18 +91,22 @@ Enums
.. autoclass:: SeverityLevel
:members:
:undoc-members:
:noindex:

.. autoclass:: SnmpAuthAlgorithm
:members:
:undoc-members:
:noindex:

.. autoclass:: SnmpPrivacyAlgorithm
:members:
:undoc-members:
:noindex:

.. autoclass:: TicketStatus
:members:
:undoc-members:
:noindex:

Protocol
--------
Expand Down
100 changes: 100 additions & 0 deletions docs/api/gmpv225.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
.. _gmpv225:

GMP v22.5
^^^^^^^^^

.. automodule:: gvm.protocols.gmpv225

Enums
-----

.. autoclass:: AlertCondition
:members:
:undoc-members:

.. autoclass:: AlertEvent
:members:
:undoc-members:

.. autoclass:: AlertMethod
:members:
:undoc-members:

.. autoclass:: AliveTest
:members:
:undoc-members:

.. autoclass:: CredentialFormat
:members:
:undoc-members:

.. autoclass:: CredentialType
:members:
:undoc-members:

.. autoclass:: EntityType
:members:
:undoc-members:

.. autoclass:: FeedType
:members:
:undoc-members:

.. autoclass:: FilterType
:members:
:undoc-members:

.. autoclass:: HostsOrdering
:members:
:undoc-members:

.. autoclass:: HelpFormat
:members:
:undoc-members:

.. autoclass:: InfoType
:members:
:undoc-members:

.. autoclass:: PermissionSubjectType
:members:
:undoc-members:

.. autoclass:: PortRangeType
:members:
:undoc-members:

.. autoclass:: ReportFormatType
:members:
:undoc-members:

.. autoclass:: ResourceType
:members:
:undoc-members:

.. autoclass:: ScannerType
:members:
:undoc-members:

.. autoclass:: SeverityLevel
:members:
:undoc-members:

.. autoclass:: SnmpAuthAlgorithm
:members:
:undoc-members:

.. autoclass:: SnmpPrivacyAlgorithm
:members:
:undoc-members:

.. autoclass:: TicketStatus
:members:
:undoc-members:

Protocol
--------

.. autoclass:: Gmp
:members:
:inherited-members:
1 change: 1 addition & 0 deletions docs/api/protocols.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Protocols
gmpv208
gmpv214
gmpv224
gmpv225
ospv1

Dynamic
Expand Down
2 changes: 1 addition & 1 deletion gvm/protocols/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
Package for supported Greenbone Protocol versions.

Currently `GMP version 20.08`_, `GMP version 21.04`_
`GMP version 22.04`, `GMP version 22.05`
`GMP version 22.04`_, `GMP version 22.05`_
and `OSP version 1`_ are supported.

.. _GMP version 20.08:
Expand Down
20 changes: 10 additions & 10 deletions gvm/protocols/gmpv225/entities/resourcenames.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ def get_resource_names_list(

Arguments:
resource_type: Type must be either ALERT, CERT_BUND_ADV,
CONFIG, CPE, CREDENTIAL, CVE, DFN_CERT_ADV, FILTER,
GROUP, HOST, NOTE, NVT, OS, OVERRIDE, PERMISSION,
PORT_LIST, REPORT_FORMAT, REPORT, RESULT, ROLE,
SCANNER, SCHEDULE, TARGET, TASK, TLS_CERTIFICATE
or USER
CONFIG, CPE, CREDENTIAL, CVE, DFN_CERT_ADV, FILTER,
GROUP, HOST, NOTE, NVT, OS, OVERRIDE, PERMISSION,
PORT_LIST, REPORT_FORMAT, REPORT, RESULT, ROLE,
SCANNER, SCHEDULE, TARGET, TASK, TLS_CERTIFICATE
or USER
filter_string: Filter term to use for the query

Returns:
Expand Down Expand Up @@ -124,11 +124,11 @@ def get_resource_name(
Arguments:
resource_id: ID of an existing resource
resource_type: Type must be either ALERT, CERT_BUND_ADV,
CONFIG, CPE, CREDENTIAL, CVE, DFN_CERT_ADV, FILTER,
GROUP, HOST, NOTE, NVT, OS, OVERRIDE, PERMISSION,
PORT_LIST, REPORT_FORMAT, REPORT, RESULT, ROLE,
SCANNER, SCHEDULE, TARGET, TASK, TLS_CERTIFICATE
or USER
CONFIG, CPE, CREDENTIAL, CVE, DFN_CERT_ADV, FILTER,
GROUP, HOST, NOTE, NVT, OS, OVERRIDE, PERMISSION,
PORT_LIST, REPORT_FORMAT, REPORT, RESULT, ROLE,
SCANNER, SCHEDULE, TARGET, TASK, TLS_CERTIFICATE
or USER

Returns:
The response. See :py:meth:`send_command` for details.
Expand Down
2 changes: 1 addition & 1 deletion gvm/protocols/latest.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
:py:mod:`gvm.protocols`.

Exports:
- :py:class:`gvm.protocols.gmpv224.Gmp`
- :py:class:`gvm.protocols.gmpv225.Gmp`
- :py:class:`gvm.protocols.ospv1.Osp`

.. _Greenbone Management Protocol:
Expand Down