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 v20.8
- Enums
- Protocol
GmpGmp.__init__()Gmp.authenticate()Gmp.clone_alert()Gmp.clone_audit()Gmp.clone_credential()Gmp.clone_filter()Gmp.clone_group()Gmp.clone_note()Gmp.clone_override()Gmp.clone_permission()Gmp.clone_policy()Gmp.clone_port_list()Gmp.clone_report_format()Gmp.clone_role()Gmp.clone_scan_config()Gmp.clone_scanner()Gmp.clone_schedule()Gmp.clone_tag()Gmp.clone_target()Gmp.clone_task()Gmp.clone_ticket()Gmp.clone_tls_certificate()Gmp.clone_user()Gmp.connect()Gmp.create_alert()Gmp.create_audit()Gmp.create_container_task()Gmp.create_credential()Gmp.create_filter()Gmp.create_group()Gmp.create_host()Gmp.create_note()Gmp.create_override()Gmp.create_permission()Gmp.create_policy()Gmp.create_port_list()Gmp.create_port_range()Gmp.create_role()Gmp.create_scan_config()Gmp.create_scan_config_from_osp_scanner()Gmp.create_scanner()Gmp.create_schedule()Gmp.create_tag()Gmp.create_target()Gmp.create_task()Gmp.create_ticket()Gmp.create_tls_certificate()Gmp.create_user()Gmp.delete_alert()Gmp.delete_audit()Gmp.delete_credential()Gmp.delete_filter()Gmp.delete_group()Gmp.delete_host()Gmp.delete_note()Gmp.delete_operating_system()Gmp.delete_override()Gmp.delete_permission()Gmp.delete_policy()Gmp.delete_port_list()Gmp.delete_port_range()Gmp.delete_report()Gmp.delete_report_format()Gmp.delete_role()Gmp.delete_scan_config()Gmp.delete_scanner()Gmp.delete_schedule()Gmp.delete_tag()Gmp.delete_target()Gmp.delete_task()Gmp.delete_ticket()Gmp.delete_tls_certificate()Gmp.delete_user()Gmp.describe_auth()Gmp.disconnect()Gmp.empty_trashcan()Gmp.get_aggregates()Gmp.get_alert()Gmp.get_alerts()Gmp.get_audit()Gmp.get_audits()Gmp.get_cert_bund_advisories()Gmp.get_cert_bund_advisory()Gmp.get_cpe()Gmp.get_cpes()Gmp.get_credential()Gmp.get_credentials()Gmp.get_cve()Gmp.get_cves()Gmp.get_dfn_cert_advisories()Gmp.get_dfn_cert_advisory()Gmp.get_feed()Gmp.get_feeds()Gmp.get_filter()Gmp.get_filters()Gmp.get_group()Gmp.get_groups()Gmp.get_host()Gmp.get_hosts()Gmp.get_info()Gmp.get_info_list()Gmp.get_note()Gmp.get_notes()Gmp.get_nvt()Gmp.get_nvt_families()Gmp.get_nvt_preference()Gmp.get_nvt_preferences()Gmp.get_nvts()Gmp.get_operating_system()Gmp.get_operating_systems()Gmp.get_oval_definition()Gmp.get_oval_definitions()Gmp.get_override()Gmp.get_overrides()Gmp.get_permission()Gmp.get_permissions()Gmp.get_policies()Gmp.get_policy()Gmp.get_port_list()Gmp.get_port_lists()Gmp.get_protocol_version()Gmp.get_report()Gmp.get_report_format()Gmp.get_report_formats()Gmp.get_reports()Gmp.get_result()Gmp.get_results()Gmp.get_role()Gmp.get_roles()Gmp.get_scan_config()Gmp.get_scan_config_nvt()Gmp.get_scan_config_nvts()Gmp.get_scan_config_preference()Gmp.get_scan_config_preferences()Gmp.get_scan_configs()Gmp.get_scanner()Gmp.get_scanners()Gmp.get_schedule()Gmp.get_schedules()Gmp.get_system_reports()Gmp.get_tag()Gmp.get_tags()Gmp.get_target()Gmp.get_targets()Gmp.get_task()Gmp.get_tasks()Gmp.get_ticket()Gmp.get_tickets()Gmp.get_tls_certificate()Gmp.get_tls_certificates()Gmp.get_user()Gmp.get_user_setting()Gmp.get_user_settings()Gmp.get_users()Gmp.get_version()Gmp.get_vulnerabilities()Gmp.get_vulnerability()Gmp.help()Gmp.import_policy()Gmp.import_report()Gmp.import_report_format()Gmp.import_scan_config()Gmp.is_authenticated()Gmp.is_connected()Gmp.modify_alert()Gmp.modify_audit()Gmp.modify_auth()Gmp.modify_credential()Gmp.modify_filter()Gmp.modify_group()Gmp.modify_host()Gmp.modify_note()Gmp.modify_operating_system()Gmp.modify_override()Gmp.modify_permission()Gmp.modify_policy_set_comment()Gmp.modify_policy_set_family_selection()Gmp.modify_policy_set_name()Gmp.modify_policy_set_nvt_preference()Gmp.modify_policy_set_nvt_selection()Gmp.modify_policy_set_scanner_preference()Gmp.modify_port_list()Gmp.modify_report_format()Gmp.modify_role()Gmp.modify_scan_config()Gmp.modify_scan_config_set_comment()Gmp.modify_scan_config_set_family_selection()Gmp.modify_scan_config_set_name()Gmp.modify_scan_config_set_nvt_preference()Gmp.modify_scan_config_set_nvt_selection()Gmp.modify_scan_config_set_scanner_preference()Gmp.modify_scanner()Gmp.modify_schedule()Gmp.modify_tag()Gmp.modify_target()Gmp.modify_task()Gmp.modify_ticket()Gmp.modify_tls_certificate()Gmp.modify_user()Gmp.modify_user_setting()Gmp.move_task()Gmp.restore_from_trashcan()Gmp.resume_audit()Gmp.resume_task()Gmp.send_command()Gmp.start_audit()Gmp.start_task()Gmp.stop_audit()Gmp.stop_task()Gmp.sync_scan_config()Gmp.test_alert()Gmp.trigger_alert()Gmp.verify_report_format()Gmp.verify_scanner()
- GMP v21.4
- Enums
- Protocol
GmpGmp.__init__()Gmp.authenticate()Gmp.clone_alert()Gmp.clone_audit()Gmp.clone_credential()Gmp.clone_filter()Gmp.clone_group()Gmp.clone_note()Gmp.clone_override()Gmp.clone_permission()Gmp.clone_policy()Gmp.clone_port_list()Gmp.clone_report_format()Gmp.clone_role()Gmp.clone_scan_config()Gmp.clone_scanner()Gmp.clone_schedule()Gmp.clone_tag()Gmp.clone_target()Gmp.clone_task()Gmp.clone_ticket()Gmp.clone_tls_certificate()Gmp.clone_user()Gmp.connect()Gmp.create_alert()Gmp.create_audit()Gmp.create_container_task()Gmp.create_credential()Gmp.create_filter()Gmp.create_group()Gmp.create_host()Gmp.create_note()Gmp.create_override()Gmp.create_permission()Gmp.create_policy()Gmp.create_port_list()Gmp.create_port_range()Gmp.create_role()Gmp.create_scan_config()Gmp.create_scan_config_from_osp_scanner()Gmp.create_scanner()Gmp.create_schedule()Gmp.create_tag()Gmp.create_target()Gmp.create_task()Gmp.create_ticket()Gmp.create_tls_certificate()Gmp.create_user()Gmp.delete_alert()Gmp.delete_audit()Gmp.delete_credential()Gmp.delete_filter()Gmp.delete_group()Gmp.delete_host()Gmp.delete_note()Gmp.delete_operating_system()Gmp.delete_override()Gmp.delete_permission()Gmp.delete_policy()Gmp.delete_port_list()Gmp.delete_port_range()Gmp.delete_report()Gmp.delete_report_format()Gmp.delete_role()Gmp.delete_scan_config()Gmp.delete_scanner()Gmp.delete_schedule()Gmp.delete_tag()Gmp.delete_target()Gmp.delete_task()Gmp.delete_ticket()Gmp.delete_tls_certificate()Gmp.delete_user()Gmp.describe_auth()Gmp.disconnect()Gmp.empty_trashcan()Gmp.get_aggregates()Gmp.get_alert()Gmp.get_alerts()Gmp.get_audit()Gmp.get_audits()Gmp.get_cert_bund_advisories()Gmp.get_cert_bund_advisory()Gmp.get_cpe()Gmp.get_cpes()Gmp.get_credential()Gmp.get_credentials()Gmp.get_cve()Gmp.get_cves()Gmp.get_dfn_cert_advisories()Gmp.get_dfn_cert_advisory()Gmp.get_feed()Gmp.get_feeds()Gmp.get_filter()Gmp.get_filters()Gmp.get_group()Gmp.get_groups()Gmp.get_host()Gmp.get_hosts()Gmp.get_info()Gmp.get_info_list()Gmp.get_note()Gmp.get_notes()Gmp.get_nvt()Gmp.get_nvt_families()Gmp.get_nvt_preference()Gmp.get_nvt_preferences()Gmp.get_nvts()Gmp.get_operating_system()Gmp.get_operating_systems()Gmp.get_oval_definition()Gmp.get_oval_definitions()Gmp.get_override()Gmp.get_overrides()Gmp.get_permission()Gmp.get_permissions()Gmp.get_policies()Gmp.get_policy()Gmp.get_port_list()Gmp.get_port_lists()Gmp.get_protocol_version()Gmp.get_report()Gmp.get_report_format()Gmp.get_report_formats()Gmp.get_reports()Gmp.get_result()Gmp.get_results()Gmp.get_role()Gmp.get_roles()Gmp.get_scan_config()Gmp.get_scan_config_nvt()Gmp.get_scan_config_nvts()Gmp.get_scan_config_preference()Gmp.get_scan_config_preferences()Gmp.get_scan_configs()Gmp.get_scanner()Gmp.get_scanners()Gmp.get_schedule()Gmp.get_schedules()Gmp.get_system_reports()Gmp.get_tag()Gmp.get_tags()Gmp.get_target()Gmp.get_targets()Gmp.get_task()Gmp.get_tasks()Gmp.get_ticket()Gmp.get_tickets()Gmp.get_tls_certificate()Gmp.get_tls_certificates()Gmp.get_user()Gmp.get_user_setting()Gmp.get_user_settings()Gmp.get_users()Gmp.get_version()Gmp.get_vulnerabilities()Gmp.get_vulnerability()Gmp.help()Gmp.import_policy()Gmp.import_report()Gmp.import_report_format()Gmp.import_scan_config()Gmp.is_authenticated()Gmp.is_connected()Gmp.modify_alert()Gmp.modify_audit()Gmp.modify_auth()Gmp.modify_credential()Gmp.modify_filter()Gmp.modify_group()Gmp.modify_host()Gmp.modify_note()Gmp.modify_operating_system()Gmp.modify_override()Gmp.modify_permission()Gmp.modify_policy_set_comment()Gmp.modify_policy_set_family_selection()Gmp.modify_policy_set_name()Gmp.modify_policy_set_nvt_preference()Gmp.modify_policy_set_nvt_selection()Gmp.modify_policy_set_scanner_preference()Gmp.modify_port_list()Gmp.modify_report_format()Gmp.modify_role()Gmp.modify_scan_config()Gmp.modify_scan_config_set_comment()Gmp.modify_scan_config_set_family_selection()Gmp.modify_scan_config_set_name()Gmp.modify_scan_config_set_nvt_preference()Gmp.modify_scan_config_set_nvt_selection()Gmp.modify_scan_config_set_scanner_preference()Gmp.modify_scanner()Gmp.modify_schedule()Gmp.modify_tag()Gmp.modify_target()Gmp.modify_task()Gmp.modify_ticket()Gmp.modify_tls_certificate()Gmp.modify_user()Gmp.modify_user_setting()Gmp.move_task()Gmp.restore_from_trashcan()Gmp.resume_audit()Gmp.resume_task()Gmp.send_command()Gmp.start_audit()Gmp.start_task()Gmp.stop_audit()Gmp.stop_task()Gmp.sync_scan_config()Gmp.test_alert()Gmp.trigger_alert()Gmp.verify_report_format()Gmp.verify_scanner()
- GMP v22.4
- 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.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.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.from_string()
HostsOrderingHelpFormatInfoTypePermissionSubjectTypeSeverityLevelSnmpAuthAlgorithmSnmpPrivacyAlgorithmTicketStatus
- Protocol
GmpGmp.__init__()Gmp.authenticate()Gmp.clone_alert()Gmp.clone_audit()Gmp.clone_credential()Gmp.clone_filter()Gmp.clone_group()Gmp.clone_note()Gmp.clone_override()Gmp.clone_permission()Gmp.clone_policy()Gmp.clone_port_list()Gmp.clone_report_format()Gmp.clone_role()Gmp.clone_scan_config()Gmp.clone_scanner()Gmp.clone_schedule()Gmp.clone_tag()Gmp.clone_target()Gmp.clone_task()Gmp.clone_ticket()Gmp.clone_tls_certificate()Gmp.clone_user()Gmp.connect()Gmp.create_alert()Gmp.create_audit()Gmp.create_container_task()Gmp.create_credential()Gmp.create_filter()Gmp.create_group()Gmp.create_host()Gmp.create_note()Gmp.create_override()Gmp.create_permission()Gmp.create_policy()Gmp.create_port_list()Gmp.create_port_range()Gmp.create_role()Gmp.create_scan_config()Gmp.create_scanner()Gmp.create_schedule()Gmp.create_tag()Gmp.create_target()Gmp.create_task()Gmp.create_ticket()Gmp.create_tls_certificate()Gmp.create_user()Gmp.delete_alert()Gmp.delete_audit()Gmp.delete_credential()Gmp.delete_filter()Gmp.delete_group()Gmp.delete_host()Gmp.delete_note()Gmp.delete_operating_system()Gmp.delete_override()Gmp.delete_permission()Gmp.delete_policy()Gmp.delete_port_list()Gmp.delete_port_range()Gmp.delete_report()Gmp.delete_report_format()Gmp.delete_role()Gmp.delete_scan_config()Gmp.delete_scanner()Gmp.delete_schedule()Gmp.delete_tag()Gmp.delete_target()Gmp.delete_task()Gmp.delete_ticket()Gmp.delete_tls_certificate()Gmp.delete_user()Gmp.describe_auth()Gmp.disconnect()Gmp.empty_trashcan()Gmp.get_aggregates()Gmp.get_alert()Gmp.get_alerts()Gmp.get_audit()Gmp.get_audits()Gmp.get_cert_bund_advisories()Gmp.get_cert_bund_advisory()Gmp.get_cpe()Gmp.get_cpes()Gmp.get_credential()Gmp.get_credentials()Gmp.get_cve()Gmp.get_cves()Gmp.get_dfn_cert_advisories()Gmp.get_dfn_cert_advisory()Gmp.get_feed()Gmp.get_feeds()Gmp.get_filter()Gmp.get_filters()Gmp.get_group()Gmp.get_groups()Gmp.get_host()Gmp.get_hosts()Gmp.get_info()Gmp.get_info_list()Gmp.get_note()Gmp.get_notes()Gmp.get_nvt()Gmp.get_nvt_families()Gmp.get_nvt_preference()Gmp.get_nvt_preferences()Gmp.get_nvts()Gmp.get_operating_system()Gmp.get_operating_systems()Gmp.get_oval_definition()Gmp.get_oval_definitions()Gmp.get_override()Gmp.get_overrides()Gmp.get_permission()Gmp.get_permissions()Gmp.get_policies()Gmp.get_policy()Gmp.get_port_list()Gmp.get_port_lists()Gmp.get_protocol_version()Gmp.get_report()Gmp.get_report_format()Gmp.get_report_formats()Gmp.get_reports()Gmp.get_result()Gmp.get_results()Gmp.get_role()Gmp.get_roles()Gmp.get_scan_config()Gmp.get_scan_config_nvt()Gmp.get_scan_config_nvts()Gmp.get_scan_config_preference()Gmp.get_scan_config_preferences()Gmp.get_scan_configs()Gmp.get_scanner()Gmp.get_scanners()Gmp.get_schedule()Gmp.get_schedules()Gmp.get_system_reports()Gmp.get_tag()Gmp.get_tags()Gmp.get_target()Gmp.get_targets()Gmp.get_task()Gmp.get_tasks()Gmp.get_ticket()Gmp.get_tickets()Gmp.get_tls_certificate()Gmp.get_tls_certificates()Gmp.get_user()Gmp.get_user_setting()Gmp.get_user_settings()Gmp.get_users()Gmp.get_version()Gmp.get_vulnerabilities()Gmp.get_vulnerability()Gmp.help()Gmp.import_policy()Gmp.import_report()Gmp.import_report_format()Gmp.import_scan_config()Gmp.is_authenticated()Gmp.is_connected()Gmp.modify_alert()Gmp.modify_audit()Gmp.modify_auth()Gmp.modify_credential()Gmp.modify_filter()Gmp.modify_group()Gmp.modify_host()Gmp.modify_note()Gmp.modify_operating_system()Gmp.modify_override()Gmp.modify_permission()Gmp.modify_policy_set_comment()Gmp.modify_policy_set_family_selection()Gmp.modify_policy_set_name()Gmp.modify_policy_set_nvt_preference()Gmp.modify_policy_set_nvt_selection()Gmp.modify_policy_set_scanner_preference()Gmp.modify_port_list()Gmp.modify_report_format()Gmp.modify_role()Gmp.modify_scan_config()Gmp.modify_scan_config_set_comment()Gmp.modify_scan_config_set_family_selection()Gmp.modify_scan_config_set_name()Gmp.modify_scan_config_set_nvt_preference()Gmp.modify_scan_config_set_nvt_selection()Gmp.modify_scan_config_set_scanner_preference()Gmp.modify_scanner()Gmp.modify_schedule()Gmp.modify_tag()Gmp.modify_target()Gmp.modify_task()Gmp.modify_ticket()Gmp.modify_tls_certificate()Gmp.modify_user()Gmp.modify_user_setting()Gmp.move_task()Gmp.restore_from_trashcan()Gmp.resume_audit()Gmp.resume_task()Gmp.send_command()Gmp.start_audit()Gmp.start_task()Gmp.stop_audit()Gmp.stop_task()Gmp.test_alert()Gmp.trigger_alert()Gmp.verify_report_format()Gmp.verify_scanner()
- Enums
- OSP v1
- Dynamic
- “latest” protocols
- “next” protocols
- GMP v20.8
- Errors
- Utils
- XML