Developer Interface¶
This part of the documentation covers all public interfaces of python-gvm.
The API consists of the main module containing version information, connection classes for establishing a communication to a remote server, protocol modules to talk the communication languages, possible raised errors, additional utilities and xml helpers.
- Main
- Connections
- Transforms
- Protocols
- GMP
GMP- GMP v22.4
- Protocol
GMPv224GMPv224.__init__()GMPv224.authenticate()GMPv224.clone_alert()GMPv224.clone_audit()GMPv224.clone_credential()GMPv224.clone_filter()GMPv224.clone_group()GMPv224.clone_note()GMPv224.clone_override()GMPv224.clone_permission()GMPv224.clone_policy()GMPv224.clone_port_list()GMPv224.clone_report_format()GMPv224.clone_role()GMPv224.clone_scan_config()GMPv224.clone_scanner()GMPv224.clone_schedule()GMPv224.clone_tag()GMPv224.clone_target()GMPv224.clone_task()GMPv224.clone_ticket()GMPv224.clone_tls_certificate()GMPv224.clone_user()GMPv224.connect()GMPv224.create_alert()GMPv224.create_audit()GMPv224.create_container_task()GMPv224.create_credential()GMPv224.create_filter()GMPv224.create_group()GMPv224.create_host()GMPv224.create_note()GMPv224.create_override()GMPv224.create_permission()GMPv224.create_policy()GMPv224.create_port_list()GMPv224.create_port_range()GMPv224.create_role()GMPv224.create_scan_config()GMPv224.create_scanner()GMPv224.create_schedule()GMPv224.create_tag()GMPv224.create_target()GMPv224.create_task()GMPv224.create_ticket()GMPv224.create_tls_certificate()GMPv224.create_user()GMPv224.delete_alert()GMPv224.delete_audit()GMPv224.delete_credential()GMPv224.delete_filter()GMPv224.delete_group()GMPv224.delete_host()GMPv224.delete_note()GMPv224.delete_operating_system()GMPv224.delete_override()GMPv224.delete_permission()GMPv224.delete_policy()GMPv224.delete_port_list()GMPv224.delete_port_range()GMPv224.delete_report()GMPv224.delete_report_format()GMPv224.delete_role()GMPv224.delete_scan_config()GMPv224.delete_scanner()GMPv224.delete_schedule()GMPv224.delete_tag()GMPv224.delete_target()GMPv224.delete_task()GMPv224.delete_ticket()GMPv224.delete_tls_certificate()GMPv224.delete_user()GMPv224.describe_auth()GMPv224.disconnect()GMPv224.empty_trashcan()GMPv224.get_aggregates()GMPv224.get_alert()GMPv224.get_alerts()GMPv224.get_audit()GMPv224.get_audits()GMPv224.get_cert_bund_advisories()GMPv224.get_cert_bund_advisory()GMPv224.get_cpe()GMPv224.get_cpes()GMPv224.get_credential()GMPv224.get_credentials()GMPv224.get_cve()GMPv224.get_cves()GMPv224.get_dfn_cert_advisories()GMPv224.get_dfn_cert_advisory()GMPv224.get_feed()GMPv224.get_feeds()GMPv224.get_filter()GMPv224.get_filters()GMPv224.get_group()GMPv224.get_groups()GMPv224.get_host()GMPv224.get_hosts()GMPv224.get_info()GMPv224.get_info_list()GMPv224.get_note()GMPv224.get_notes()GMPv224.get_nvt()GMPv224.get_nvt_families()GMPv224.get_nvt_preference()GMPv224.get_nvt_preferences()GMPv224.get_nvts()GMPv224.get_operating_system()GMPv224.get_operating_systems()GMPv224.get_override()GMPv224.get_overrides()GMPv224.get_permission()GMPv224.get_permissions()GMPv224.get_policies()GMPv224.get_policy()GMPv224.get_port_list()GMPv224.get_port_lists()GMPv224.get_protocol_version()GMPv224.get_report()GMPv224.get_report_format()GMPv224.get_report_formats()GMPv224.get_reports()GMPv224.get_result()GMPv224.get_results()GMPv224.get_role()GMPv224.get_roles()GMPv224.get_scan_config()GMPv224.get_scan_config_nvt()GMPv224.get_scan_config_nvts()GMPv224.get_scan_config_preference()GMPv224.get_scan_config_preferences()GMPv224.get_scan_configs()GMPv224.get_scanner()GMPv224.get_scanners()GMPv224.get_schedule()GMPv224.get_schedules()GMPv224.get_system_reports()GMPv224.get_tag()GMPv224.get_tags()GMPv224.get_target()GMPv224.get_targets()GMPv224.get_task()GMPv224.get_tasks()GMPv224.get_ticket()GMPv224.get_tickets()GMPv224.get_tls_certificate()GMPv224.get_tls_certificates()GMPv224.get_user()GMPv224.get_user_setting()GMPv224.get_user_settings()GMPv224.get_users()GMPv224.get_version()GMPv224.get_vulnerabilities()GMPv224.get_vulnerability()GMPv224.help()GMPv224.import_policy()GMPv224.import_report()GMPv224.import_report_format()GMPv224.import_scan_config()GMPv224.is_authenticated()GMPv224.is_connected()GMPv224.modify_alert()GMPv224.modify_audit()GMPv224.modify_auth()GMPv224.modify_credential()GMPv224.modify_filter()GMPv224.modify_group()GMPv224.modify_host()GMPv224.modify_note()GMPv224.modify_operating_system()GMPv224.modify_override()GMPv224.modify_permission()GMPv224.modify_policy_set_comment()GMPv224.modify_policy_set_family_selection()GMPv224.modify_policy_set_name()GMPv224.modify_policy_set_nvt_preference()GMPv224.modify_policy_set_nvt_selection()GMPv224.modify_policy_set_scanner_preference()GMPv224.modify_port_list()GMPv224.modify_report_format()GMPv224.modify_role()GMPv224.modify_scan_config_set_comment()GMPv224.modify_scan_config_set_family_selection()GMPv224.modify_scan_config_set_name()GMPv224.modify_scan_config_set_nvt_preference()GMPv224.modify_scan_config_set_nvt_selection()GMPv224.modify_scan_config_set_scanner_preference()GMPv224.modify_scanner()GMPv224.modify_schedule()GMPv224.modify_tag()GMPv224.modify_target()GMPv224.modify_task()GMPv224.modify_ticket()GMPv224.modify_tls_certificate()GMPv224.modify_user()GMPv224.modify_user_setting()GMPv224.move_task()GMPv224.restore_from_trashcan()GMPv224.resume_audit()GMPv224.resume_task()GMPv224.send_command()GMPv224.start_audit()GMPv224.start_task()GMPv224.stop_audit()GMPv224.stop_task()GMPv224.test_alert()GMPv224.trigger_alert()GMPv224.verify_report_format()GMPv224.verify_scanner()
- Enums
AlertConditionAlertEventAlertMethodAliveTestAliveTest.APR_PINGAliveTest.ARP_PINGAliveTest.CONSIDER_ALIVEAliveTest.ICMP_AND_ARP_PINGAliveTest.ICMP_AND_TCP_ACK_SERVICE_PINGAliveTest.ICMP_PINGAliveTest.ICMP_TCP_ACK_SERVICE_AND_ARP_PINGAliveTest.SCAN_CONFIG_DEFAULTAliveTest.TCP_ACK_SERVICE_AND_ARP_PINGAliveTest.TCP_ACK_SERVICE_PINGAliveTest.TCP_SYN_SERVICE_PINGAliveTest.__new__()AliveTest.from_string()
CredentialFormatCredentialTypeEntityTypeEntityType.ALERTEntityType.ASSETEntityType.AUDITEntityType.CERT_BUND_ADVEntityType.CPEEntityType.CREDENTIALEntityType.CVEEntityType.DFN_CERT_ADVEntityType.FILTEREntityType.GROUPEntityType.HOSTEntityType.INFOEntityType.NOTEEntityType.NVTEntityType.OPERATING_SYSTEMEntityType.OVALDEFEntityType.OVERRIDEEntityType.PERMISSIONEntityType.POLICYEntityType.PORT_LISTEntityType.REPORTEntityType.REPORT_FORMATEntityType.RESULTEntityType.ROLEEntityType.SCANNEREntityType.SCAN_CONFIGEntityType.SCHEDULEEntityType.TAGEntityType.TARGETEntityType.TASKEntityType.TICKETEntityType.TLS_CERTIFICATEEntityType.USEREntityType.VULNERABILITYEntityType.__new__()EntityType.from_string()
FeedTypeFilterTypeFilterType.ALERTFilterType.ALL_SECINFOFilterType.ASSETFilterType.CREDENTIALFilterType.FILTERFilterType.GROUPFilterType.HOSTFilterType.NOTEFilterType.OPERATING_SYSTEMFilterType.OVERRIDEFilterType.PERMISSIONFilterType.PORT_LISTFilterType.REPORTFilterType.REPORT_FORMATFilterType.RESULTFilterType.ROLEFilterType.SCAN_CONFIGFilterType.SCHEDULEFilterType.TAGFilterType.TARGETFilterType.TASKFilterType.TICKETFilterType.TLS_CERTIFICATEFilterType.USERFilterType.VULNERABILITYFilterType.__new__()FilterType.from_string()
HostsOrderingHelpFormatInfoTypePermissionSubjectTypePortRangeTypeReportFormatTypeReportFormatType.ANONYMOUS_XMLReportFormatType.ARFReportFormatType.CPEReportFormatType.CSV_HOSTSReportFormatType.CSV_RESULTSReportFormatType.GCR_PDFReportFormatType.GSR_HTMLReportFormatType.GSR_PDFReportFormatType.GXCR_PDFReportFormatType.GXR_PDFReportFormatType.ITGReportFormatType.LATEXReportFormatType.NBEReportFormatType.PDFReportFormatType.SVGReportFormatType.TXTReportFormatType.VERINICE_ISMReportFormatType.VERINICE_ITGReportFormatType.XMLReportFormatType.__new__()
ScannerTypeSnmpAuthAlgorithmSnmpPrivacyAlgorithmTicketStatus
- Protocol
- GMP v22.5
- Protocol
GMPv225GMPv225.__init__()GMPv225.authenticate()GMPv225.clone_alert()GMPv225.clone_audit()GMPv225.clone_credential()GMPv225.clone_filter()GMPv225.clone_group()GMPv225.clone_note()GMPv225.clone_override()GMPv225.clone_permission()GMPv225.clone_policy()GMPv225.clone_port_list()GMPv225.clone_report_format()GMPv225.clone_role()GMPv225.clone_scan_config()GMPv225.clone_scanner()GMPv225.clone_schedule()GMPv225.clone_tag()GMPv225.clone_target()GMPv225.clone_task()GMPv225.clone_ticket()GMPv225.clone_tls_certificate()GMPv225.clone_user()GMPv225.connect()GMPv225.create_alert()GMPv225.create_audit()GMPv225.create_container_task()GMPv225.create_credential()GMPv225.create_filter()GMPv225.create_group()GMPv225.create_host()GMPv225.create_note()GMPv225.create_override()GMPv225.create_permission()GMPv225.create_policy()GMPv225.create_port_list()GMPv225.create_port_range()GMPv225.create_role()GMPv225.create_scan_config()GMPv225.create_scanner()GMPv225.create_schedule()GMPv225.create_tag()GMPv225.create_target()GMPv225.create_task()GMPv225.create_ticket()GMPv225.create_tls_certificate()GMPv225.create_user()GMPv225.delete_alert()GMPv225.delete_audit()GMPv225.delete_credential()GMPv225.delete_filter()GMPv225.delete_group()GMPv225.delete_host()GMPv225.delete_note()GMPv225.delete_operating_system()GMPv225.delete_override()GMPv225.delete_permission()GMPv225.delete_policy()GMPv225.delete_port_list()GMPv225.delete_port_range()GMPv225.delete_report()GMPv225.delete_report_format()GMPv225.delete_role()GMPv225.delete_scan_config()GMPv225.delete_scanner()GMPv225.delete_schedule()GMPv225.delete_tag()GMPv225.delete_target()GMPv225.delete_task()GMPv225.delete_ticket()GMPv225.delete_tls_certificate()GMPv225.delete_user()GMPv225.describe_auth()GMPv225.disconnect()GMPv225.empty_trashcan()GMPv225.get_aggregates()GMPv225.get_alert()GMPv225.get_alerts()GMPv225.get_audit()GMPv225.get_audits()GMPv225.get_cert_bund_advisories()GMPv225.get_cert_bund_advisory()GMPv225.get_cpe()GMPv225.get_cpes()GMPv225.get_credential()GMPv225.get_credentials()GMPv225.get_cve()GMPv225.get_cves()GMPv225.get_dfn_cert_advisories()GMPv225.get_dfn_cert_advisory()GMPv225.get_feed()GMPv225.get_feeds()GMPv225.get_filter()GMPv225.get_filters()GMPv225.get_group()GMPv225.get_groups()GMPv225.get_host()GMPv225.get_hosts()GMPv225.get_info()GMPv225.get_info_list()GMPv225.get_note()GMPv225.get_notes()GMPv225.get_nvt()GMPv225.get_nvt_families()GMPv225.get_nvt_preference()GMPv225.get_nvt_preferences()GMPv225.get_nvts()GMPv225.get_operating_system()GMPv225.get_operating_systems()GMPv225.get_override()GMPv225.get_overrides()GMPv225.get_permission()GMPv225.get_permissions()GMPv225.get_policies()GMPv225.get_policy()GMPv225.get_port_list()GMPv225.get_port_lists()GMPv225.get_protocol_version()GMPv225.get_report()GMPv225.get_report_format()GMPv225.get_report_formats()GMPv225.get_reports()GMPv225.get_resource_name()GMPv225.get_resource_names()GMPv225.get_result()GMPv225.get_results()GMPv225.get_role()GMPv225.get_roles()GMPv225.get_scan_config()GMPv225.get_scan_config_nvt()GMPv225.get_scan_config_nvts()GMPv225.get_scan_config_preference()GMPv225.get_scan_config_preferences()GMPv225.get_scan_configs()GMPv225.get_scanner()GMPv225.get_scanners()GMPv225.get_schedule()GMPv225.get_schedules()GMPv225.get_system_reports()GMPv225.get_tag()GMPv225.get_tags()GMPv225.get_target()GMPv225.get_targets()GMPv225.get_task()GMPv225.get_tasks()GMPv225.get_ticket()GMPv225.get_tickets()GMPv225.get_tls_certificate()GMPv225.get_tls_certificates()GMPv225.get_user()GMPv225.get_user_setting()GMPv225.get_user_settings()GMPv225.get_users()GMPv225.get_version()GMPv225.get_vulnerabilities()GMPv225.get_vulnerability()GMPv225.help()GMPv225.import_policy()GMPv225.import_report()GMPv225.import_report_format()GMPv225.import_scan_config()GMPv225.is_authenticated()GMPv225.is_connected()GMPv225.modify_alert()GMPv225.modify_audit()GMPv225.modify_auth()GMPv225.modify_credential()GMPv225.modify_filter()GMPv225.modify_group()GMPv225.modify_host()GMPv225.modify_note()GMPv225.modify_operating_system()GMPv225.modify_override()GMPv225.modify_permission()GMPv225.modify_policy_set_comment()GMPv225.modify_policy_set_family_selection()GMPv225.modify_policy_set_name()GMPv225.modify_policy_set_nvt_preference()GMPv225.modify_policy_set_nvt_selection()GMPv225.modify_policy_set_scanner_preference()GMPv225.modify_port_list()GMPv225.modify_report_format()GMPv225.modify_role()GMPv225.modify_scan_config_set_comment()GMPv225.modify_scan_config_set_family_selection()GMPv225.modify_scan_config_set_name()GMPv225.modify_scan_config_set_nvt_preference()GMPv225.modify_scan_config_set_nvt_selection()GMPv225.modify_scan_config_set_scanner_preference()GMPv225.modify_scanner()GMPv225.modify_schedule()GMPv225.modify_tag()GMPv225.modify_target()GMPv225.modify_task()GMPv225.modify_ticket()GMPv225.modify_tls_certificate()GMPv225.modify_user()GMPv225.modify_user_setting()GMPv225.move_task()GMPv225.restore_from_trashcan()GMPv225.resume_audit()GMPv225.resume_task()GMPv225.send_command()GMPv225.start_audit()GMPv225.start_task()GMPv225.stop_audit()GMPv225.stop_task()GMPv225.test_alert()GMPv225.trigger_alert()GMPv225.verify_report_format()GMPv225.verify_scanner()
- Enums
ResourceTypeResourceType.ALERTResourceType.CERT_BUND_ADVResourceType.CONFIGResourceType.CPEResourceType.CREDENTIALResourceType.CVEResourceType.DFN_CERT_ADVResourceType.FILTERResourceType.GROUPResourceType.HOSTResourceType.NOTEResourceType.NVTResourceType.OSResourceType.OVERRIDEResourceType.PERMISSIONResourceType.PORT_LISTResourceType.REPORTResourceType.REPORT_FORMATResourceType.RESULTResourceType.ROLEResourceType.SCANNERResourceType.SCHEDULEResourceType.TARGETResourceType.TASKResourceType.TLS_CERTIFICATEResourceType.USERResourceType.__new__()
- Protocol
- OSP v1
- Dynamic
- “latest” protocols
- “next” protocols
- GMP
- Errors
- Utils
- XML
