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
  • __version__
  • get_version()
• Connections
  • GvmConnection
    • GvmConnection.__init__()
  • SSHConnection
    • SSHConnection.__init__()
    • SSHConnection.connect()
    • SSHConnection.disconnect()
    • SSHConnection.finish_send()
    • SSHConnection.read()
    • SSHConnection.send()
  • TLSConnection
    • TLSConnection.__init__()
    • TLSConnection.connect()
    • TLSConnection.disconnect()
    • TLSConnection.finish_send()
    • TLSConnection.read()
    • TLSConnection.send()
  • UnixSocketConnection
    • UnixSocketConnection.__init__()
    • UnixSocketConnection.connect()
    • UnixSocketConnection.disconnect()
    • UnixSocketConnection.finish_send()
    • UnixSocketConnection.read()
    • UnixSocketConnection.send()
  • DebugConnection
    • DebugConnection.__init__()
• Transforms
  • CheckCommandTransform
  • EtreeCheckCommandTransform
  • EtreeTransform
    • EtreeTransform.__init__()
• Protocols
  • GMP v20.8
    • Enums
    • Protocol
      • Gmp
        • Gmp.__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
      • Gmp
        • Gmp.__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
    • Protocol
      • Gmp
        • Gmp.__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()
  • GMP v22.5
    • Enums
      • AlertCondition
        • AlertCondition.ALWAYS
        • AlertCondition.ERROR
        • AlertCondition.FILTER_COUNT_AT_LEAST
        • AlertCondition.FILTER_COUNT_CHANGED
        • AlertCondition.SEVERITY_AT_LEAST
        • AlertCondition.SEVERITY_CHANGED
        • AlertCondition.__new__()
      • AlertEvent
        • AlertEvent.ASSIGNED_TICKET_CHANGED
        • AlertEvent.NEW_SECINFO_ARRIVED
        • AlertEvent.OWNED_TICKET_CHANGED
        • AlertEvent.TASK_RUN_STATUS_CHANGED
        • AlertEvent.TICKET_RECEIVED
        • AlertEvent.UPDATED_SECINFO_ARRIVED
        • AlertEvent.__new__()
      • AlertMethod
        • AlertMethod.ALEMBA_VFIRE
        • AlertMethod.EMAIL
        • AlertMethod.HTTP_GET
        • AlertMethod.SCP
        • AlertMethod.SEND
        • AlertMethod.SMB
        • AlertMethod.SNMP
        • AlertMethod.SOURCEFIRE_CONNECTOR
        • AlertMethod.START_TASK
        • AlertMethod.SYSLOG
        • AlertMethod.TIPPINGPOINT_SMS
        • AlertMethod.VERINICE_CONNECTOR
        • AlertMethod.__new__()
      • AliveTest
        • AliveTest.APR_PING
        • AliveTest.ARP_PING
        • AliveTest.CONSIDER_ALIVE
        • AliveTest.ICMP_AND_ARP_PING
        • AliveTest.ICMP_AND_TCP_ACK_SERVICE_PING
        • AliveTest.ICMP_PING
        • AliveTest.ICMP_TCP_ACK_SERVICE_AND_ARP_PING
        • AliveTest.SCAN_CONFIG_DEFAULT
        • AliveTest.TCP_ACK_SERVICE_AND_ARP_PING
        • AliveTest.TCP_ACK_SERVICE_PING
        • AliveTest.TCP_SYN_SERVICE_PING
        • AliveTest.from_string()
      • CredentialFormat
        • CredentialFormat.DEB
        • CredentialFormat.EXE
        • CredentialFormat.KEY
        • CredentialFormat.PEM
        • CredentialFormat.RPM
        • CredentialFormat.__new__()
      • CredentialType
        • CredentialType.CLIENT_CERTIFICATE
        • CredentialType.PASSWORD_ONLY
        • CredentialType.PGP_ENCRYPTION_KEY
        • CredentialType.SMIME_CERTIFICATE
        • CredentialType.SNMP
        • CredentialType.USERNAME_PASSWORD
        • CredentialType.USERNAME_SSH_KEY
        • CredentialType.__new__()
      • EntityType
        • EntityType.ALERT
        • EntityType.ASSET
        • EntityType.AUDIT
        • EntityType.CERT_BUND_ADV
        • EntityType.CPE
        • EntityType.CREDENTIAL
        • EntityType.CVE
        • EntityType.DFN_CERT_ADV
        • EntityType.FILTER
        • EntityType.GROUP
        • EntityType.HOST
        • EntityType.INFO
        • EntityType.NOTE
        • EntityType.NVT
        • EntityType.OPERATING_SYSTEM
        • EntityType.OVALDEF
        • EntityType.OVERRIDE
        • EntityType.PERMISSION
        • EntityType.POLICY
        • EntityType.PORT_LIST
        • EntityType.REPORT
        • EntityType.REPORT_FORMAT
        • EntityType.RESULT
        • EntityType.ROLE
        • EntityType.SCANNER
        • EntityType.SCAN_CONFIG
        • EntityType.SCHEDULE
        • EntityType.TAG
        • EntityType.TARGET
        • EntityType.TASK
        • EntityType.TICKET
        • EntityType.TLS_CERTIFICATE
        • EntityType.USER
        • EntityType.VULNERABILITY
        • EntityType.__new__()
        • EntityType.from_string()
      • FeedType
        • FeedType.CERT
        • FeedType.GVMD_DATA
        • FeedType.NVT
        • FeedType.SCAP
        • FeedType.__new__()
      • FilterType
        • FilterType.ALERT
        • FilterType.ALL_SECINFO
        • FilterType.ASSET
        • FilterType.CREDENTIAL
        • FilterType.FILTER
        • FilterType.GROUP
        • FilterType.HOST
        • FilterType.NOTE
        • FilterType.OPERATING_SYSTEM
        • FilterType.OVERRIDE
        • FilterType.PERMISSION
        • FilterType.PORT_LIST
        • FilterType.REPORT
        • FilterType.REPORT_FORMAT
        • FilterType.RESULT
        • FilterType.ROLE
        • FilterType.SCAN_CONFIG
        • FilterType.SCHEDULE
        • FilterType.TAG
        • FilterType.TARGET
        • FilterType.TASK
        • FilterType.TICKET
        • FilterType.TLS_CERTIFICATE
        • FilterType.USER
        • FilterType.VULNERABILITY
        • FilterType.__new__()
        • FilterType.from_string()
      • HostsOrdering
        • HostsOrdering.RANDOM
        • HostsOrdering.REVERSE
        • HostsOrdering.SEQUENTIAL
        • HostsOrdering.__new__()
      • HelpFormat
        • HelpFormat.HTML
        • HelpFormat.RNC
        • HelpFormat.TEXT
        • HelpFormat.XML
        • HelpFormat.__new__()
      • InfoType
        • InfoType.CERT_BUND_ADV
        • InfoType.CPE
        • InfoType.CVE
        • InfoType.DFN_CERT_ADV
        • InfoType.NVT
        • InfoType.OVALDEF
        • InfoType.__new__()
      • PermissionSubjectType
        • PermissionSubjectType.GROUP
        • PermissionSubjectType.ROLE
        • PermissionSubjectType.USER
        • PermissionSubjectType.__new__()
      • PortRangeType
        • PortRangeType.TCP
        • PortRangeType.UDP
        • PortRangeType.__new__()
      • ReportFormatType
        • ReportFormatType.ANONYMOUS_XML
        • ReportFormatType.ARF
        • ReportFormatType.CPE
        • ReportFormatType.CSV_HOSTS
        • ReportFormatType.CSV_RESULTS
        • ReportFormatType.GCR_PDF
        • ReportFormatType.GSR_HTML
        • ReportFormatType.GSR_PDF
        • ReportFormatType.GXCR_PDF
        • ReportFormatType.GXR_PDF
        • ReportFormatType.ITG
        • ReportFormatType.LATEX
        • ReportFormatType.NBE
        • ReportFormatType.PDF
        • ReportFormatType.SVG
        • ReportFormatType.TXT
        • ReportFormatType.VERINICE_ISM
        • ReportFormatType.VERINICE_ITG
        • ReportFormatType.XML
        • ReportFormatType.__new__()
      • ResourceType
        • ResourceType.ALERT
        • ResourceType.CERT_BUND_ADV
        • ResourceType.CONFIG
        • ResourceType.CPE
        • ResourceType.CREDENTIAL
        • ResourceType.CVE
        • ResourceType.DFN_CERT_ADV
        • ResourceType.FILTER
        • ResourceType.GROUP
        • ResourceType.HOST
        • ResourceType.NOTE
        • ResourceType.NVT
        • ResourceType.OS
        • ResourceType.OVERRIDE
        • ResourceType.PERMISSION
        • ResourceType.PORT_LIST
        • ResourceType.REPORT
        • ResourceType.REPORT_FORMAT
        • ResourceType.RESULT
        • ResourceType.ROLE
        • ResourceType.SCANNER
        • ResourceType.SCHEDULE
        • ResourceType.TARGET
        • ResourceType.TASK
        • ResourceType.TLS_CERTIFICATE
        • ResourceType.USER
        • ResourceType.__new__()
      • ScannerType
        • ScannerType.CVE_SCANNER_TYPE
        • ScannerType.GREENBONE_SENSOR_SCANNER_TYPE
        • ScannerType.OPENVAS_SCANNER_TYPE
        • ScannerType.from_string()
      • SeverityLevel
        • SeverityLevel.ALARM
        • SeverityLevel.DEBUG
        • SeverityLevel.HIGH
        • SeverityLevel.LOG
        • SeverityLevel.LOW
        • SeverityLevel.MEDIUM
        • SeverityLevel.__new__()
      • SnmpAuthAlgorithm
        • SnmpAuthAlgorithm.MD5
        • SnmpAuthAlgorithm.SHA1
        • SnmpAuthAlgorithm.__new__()
      • SnmpPrivacyAlgorithm
        • SnmpPrivacyAlgorithm.AES
        • SnmpPrivacyAlgorithm.DES
        • SnmpPrivacyAlgorithm.__new__()
      • TicketStatus
        • TicketStatus.CLOSED
        • TicketStatus.FIXED
        • TicketStatus.OPEN
        • TicketStatus.__new__()
    • Protocol
      • Gmp
        • Gmp.__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_resource_name()
        • Gmp.get_resource_names_list()
        • 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()
  • OSP v1
    • Osp
      • Osp.__init__()
      • Osp.connect()
      • Osp.delete_scan()
      • Osp.disconnect()
      • Osp.get_protocol_version()
      • Osp.get_scanner_details()
      • Osp.get_scans()
      • Osp.get_version()
      • Osp.get_vts()
      • Osp.help()
      • Osp.is_connected()
      • Osp.send_command()
      • Osp.start_scan()
      • Osp.stop_scan()
  • Dynamic
  • “latest” protocols
  • “next” protocols
• Errors
  • GvmClientError
  • GvmError
    • GvmError.__init__()
  • GvmResponseError
    • GvmResponseError.__init__()
  • GvmServerError
    • GvmServerError.__init__()
  • InvalidArgument
    • InvalidArgument.__init__()
  • InvalidArgumentType
    • InvalidArgumentType.__init__()
  • RequiredArgument
    • RequiredArgument.__init__()
• Utils
  • TypesDict
  • check_command_status()
  • to_dotted_types_dict()
• XML
  • pretty_print()
  • validate_xml_string()