From c0cc114b270762edaca623dcdcd264653768f433 Mon Sep 17 00:00:00 2001 From: Ahmed Abdelsalam Date: Wed, 13 Dec 2023 16:54:33 +0100 Subject: [PATCH] Doc: Update documentation to add GMP version 22.5 --- docs/api/gmpv224.rst | 17 +++ docs/api/gmpv225.rst | 100 ++++++++++++++++++ docs/api/protocols.rst | 1 + gvm/protocols/__init__.py | 2 +- .../gmpv225/entities/resourcenames.py | 20 ++-- gvm/protocols/latest.py | 2 +- 6 files changed, 130 insertions(+), 12 deletions(-) create mode 100644 docs/api/gmpv225.rst diff --git a/docs/api/gmpv224.rst b/docs/api/gmpv224.rst index fc543902b..e3f4415f4 100644 --- a/docs/api/gmpv224.rst +++ b/docs/api/gmpv224.rst @@ -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: @@ -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 -------- diff --git a/docs/api/gmpv225.rst b/docs/api/gmpv225.rst new file mode 100644 index 000000000..b1d5c2015 --- /dev/null +++ b/docs/api/gmpv225.rst @@ -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: diff --git a/docs/api/protocols.rst b/docs/api/protocols.rst index 848f3fbac..7b75d235e 100644 --- a/docs/api/protocols.rst +++ b/docs/api/protocols.rst @@ -11,6 +11,7 @@ Protocols gmpv208 gmpv214 gmpv224 + gmpv225 ospv1 Dynamic diff --git a/gvm/protocols/__init__.py b/gvm/protocols/__init__.py index ff87e7872..373a6b9d5 100644 --- a/gvm/protocols/__init__.py +++ b/gvm/protocols/__init__.py @@ -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: diff --git a/gvm/protocols/gmpv225/entities/resourcenames.py b/gvm/protocols/gmpv225/entities/resourcenames.py index f6d6ead4e..35a7acc08 100644 --- a/gvm/protocols/gmpv225/entities/resourcenames.py +++ b/gvm/protocols/gmpv225/entities/resourcenames.py @@ -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: @@ -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. diff --git a/gvm/protocols/latest.py b/gvm/protocols/latest.py index f41a2530b..ec6c438b5 100644 --- a/gvm/protocols/latest.py +++ b/gvm/protocols/latest.py @@ -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: