Migrate OpenVAS Manager database from SQLite3 to Postgres.
The canonical places where you will find more information
about the OpenVAS project are:
The OpenVAS Manager is released under the GNU GPL, version 2, or, at your option, any later version.
OMP: OpenVAS Management ProtocolVersion: 7.0 The "management" protocol of the Open Vulnerability Assessment System. Contents
1 Summary of Data Types
2 Summary of Elements
3 Summary of Commands
4 RNC Preamble### Preamble
start = command | response
command
= authenticate
| commands
| create_agent
| create_alert
| create_asset
| create_config
| create_credential
| create_filter
| create_group
| create_note
| create_override
| create_permission
| create_port_list
| create_port_range
| create_report
| create_report_format
| create_role
| create_scanner
| create_schedule
| create_tag
| create_target
| create_task
| create_user
| delete_agent
| delete_asset
| delete_config
| delete_alert
| delete_credential
| delete_filter
| delete_group
| delete_note
| delete_override
| delete_report
| delete_permission
| delete_port_list
| delete_port_range
| delete_report_format
| delete_role
| delete_scanner
| delete_schedule
| delete_tag
| delete_target
| delete_task
| delete_user
| describe_auth
| empty_trashcan
| get_agents
| get_configs
| get_aggregates
| get_alerts
| get_assets
| get_credentials
| get_feeds
| get_filters
| get_groups
| get_info
| get_notes
| get_nvts
| get_nvt_families
| get_overrides
| get_permissions
| get_port_lists
| get_preferences
| get_reports
| get_report_formats
| get_results
| get_roles
| get_scanners
| get_schedules
| get_settings
| get_system_reports
| get_tags
| get_targets
| get_tasks
| get_users
| get_version
| help
| modify_agent
| modify_alert
| modify_asset
| modify_auth
| modify_config
| modify_credential
| modify_filter
| modify_group
| modify_note
| modify_override
| modify_permission
| modify_port_list
| modify_report
| modify_report_format
| modify_role
| modify_scanner
| modify_schedule
| modify_setting
| modify_target
| modify_tag
| modify_task
| modify_user
| move_task
| restore
| resume_task
| run_wizard
| start_task
| stop_task
| sync_cert
| sync_feed
| sync_config
| sync_scap
| test_alert
| verify_agent
| verify_report_format
| verify_scanner
response
= authenticate_response
| commands_response
| create_agent_response
| create_alert_response
| create_asset_response
| create_config_response
| create_credential_response
| create_filter_response
| create_group_response
| create_note_response
| create_override_response
| create_permission_response
| create_port_list_response
| create_port_range_response
| create_report_response
| create_report_format_response
| create_role_response
| create_scanner_response
| create_schedule_response
| create_tag_response
| create_target_response
| create_task_response
| create_user_response
| delete_agent_response
| delete_asset_response
| delete_config_response
| delete_alert_response
| delete_credential_response
| delete_filter_response
| delete_group_response
| delete_note_response
| delete_override_response
| delete_report_response
| delete_permission_response
| delete_port_list_response
| delete_port_range_response
| delete_report_format_response
| delete_role_response
| delete_scanner_response
| delete_schedule_response
| delete_tag_response
| delete_target_response
| delete_task_response
| delete_user_response
| describe_auth_response
| empty_trashcan_response
| get_agents_response
| get_configs_response
| get_aggregates_response
| get_alerts_response
| get_assets_response
| get_credentials_response
| get_feeds_response
| get_filters_response
| get_groups_response
| get_info_response
| get_notes_response
| get_nvts_response
| get_nvt_families_response
| get_overrides_response
| get_permissions_response
| get_port_lists_response
| get_preferences_response
| get_reports_response
| get_report_formats_response
| get_results_response
| get_roles_response
| get_scanners_response
| get_schedules_response
| get_settings_response
| get_system_reports_response
| get_tags_response
| get_targets_response
| get_tasks_response
| get_users_response
| get_version_response
| help_response
| modify_agent_response
| modify_alert_response
| modify_asset_response
| modify_auth_response
| modify_config_response
| modify_credential_response
| modify_filter_response
| modify_group_response
| modify_note_response
| modify_override_response
| modify_permission_response
| modify_port_list_response
| modify_report_response
| modify_report_format_response
| modify_role_response
| modify_scanner_response
| modify_schedule_response
| modify_setting_response
| modify_target_response
| modify_tag_response
| modify_task_response
| modify_user_response
| move_task_response
| restore_response
| resume_task_response
| run_wizard_response
| start_task_response
| stop_task_response
| sync_cert_response
| sync_feed_response
| sync_config_response
| sync_scap_response
| test_alert_response
| verify_agent_response
| verify_report_format_response
| verify_scanner_response
5 Data Type Details5.1 Data Type alive_testIn short: An alive test. 5.1.1 RNCalive_test = xsd:token { pattern = "ICMP, TCP Service & ARP Ping|TCP Service & ARP Ping|I↵
CMP & ARP Ping|ICMP & TCP Service Ping|ARP Ping|TCP Service Ping|ICMP Ping|S↵
can Config Default" }
5.2 Data Type base64In short: Base64 encoded data. 5.2.1 RNCbase64 = xsd:base64Binary 5.3 Data Type booleanIn short: A true or false value. Zero is false, anything else is true. As a result, the empty string is considered true. 5.3.1 RNCboolean = text 5.4 Data Type boolean_atoiIn short: A true or false value, after conversion to an integer. Zero is false, anything else is true. The value is first converted to an integer, as by the C `atoi' routine. This means that an empty string is considered false. 5.4.1 RNCboolean_atoi = text 5.5 Data Type ctimeIn short: A date and time, in the C `ctime' format. An example string in this format is "Wed Jun 30 21:49:08 1993\n". 5.5.1 RNCctime = text 5.6 Data Type type_nameIn short: A name of a data type. 5.6.1 RNCtype_name = xsd:Name 5.7 Data Type integerIn short: An integer. 5.7.1 RNCinteger = xsd:integer 5.8 Data Type iso_timeIn short: A date and time, in ISO 8601 format. An example string in this format is "2011-11-08T19:57:06+02:00". 5.8.1 RNCiso_time = text 5.9 Data Type levelsIn short: A string that may include the characters h, m, l, g and d. 5.9.1 RNClevels = xsd:token { pattern = "h?m?l?g?d?" }
5.10 Data Type nameIn short: A name. Typically this is the name of one of the manager resources, like a task or target. 5.10.1 RNCname = xsd:string 5.11 Data Type portIn short: A port. 5.11.1 RNCport = xsd:token { pattern = "[0-9]{1,5}" }
5.12 Data Type user_listIn short: A space separated list of users. 5.12.1 RNCuser_list = text 5.13 Data Type oidIn short: An Object Identifier (OID). 5.13.1 RNCoid = xsd:token { pattern = "[0-9\.]{1,80}" }
5.14 Data Type severityIn short: A severity score. A severity score is a decimal number between 0.0 and 10.0 (inclusive) with one digit after the decimal point or a special negative value (-1.0, -2.0 or -3.0). If a single severity score defines a constraint, e.g. on whether an override applies, for values 0.0 and lower the severity must be equal to match while for > 0.0 the compared value must be greater or equal. 5.14.1 RNCseverity = xsd:token { pattern = "-[1-3](\.0)?|[0-9](\.[0-9])?|10(\.0)?" }
5.15 Data Type sort_orderIn short: A string describing an order for sorting. The string "descending" denotes descending order, anything else means ascending. 5.15.1 RNCsort_order = text 5.16 Data Type statusIn short: The success or failure status of a command. 5.16.1 RNCstatus = xsd:token { pattern = "200|201|202|400|401|403|404|409|500|503" }
5.17 Data Type task_statusIn short: A task run status. 5.17.1 RNCtask_status = xsd:token { pattern = "Delete Requested|Done|New|Requested|Running|Stop Requ↵
ested|Stopped|Internal Error" }
5.18 Data Type task_trendIn short: The trend of results for a task. 5.18.1 RNCtask_trend = xsd:token { pattern = "up|down|more|less|same" }
5.19 Data Type threatIn short: A threat level. Threat levels are a textual classification of severity scores only supported for importing reports from OpenVAS-6 and older. The use of these elements is deprecated as they are otherwise replaced by severity elements, which should be used instead. 5.19.1 RNCthreat = xsd:token { pattern = "High|Medium|Low|Alarm|Log|Debug" }
5.20 Data Type time_unitIn short: A unit of time. 5.20.1 RNCtime_unit = xsd:token { pattern = "second|minute|hour|day|week|month|year|decade" }
5.21 Data Type timezoneIn short: A timezone. The format of a timezone is the same as that of the TZ environment variable on GNU/Linux systems. That is, the same value accepted by the tzset C function. There are three versions of the format. Note the lack of spaces in the examples. "std offset" defines a simple timezone. For example, "FOO+2" defines a timezone FOO which is 2 hours behind UTC. "std offset dst [offset],start[/time],end[/time]" defines a timezone, including daylight savings time. For example, "NZST-12.00:00NZDT-13:00:00,M10.1.0,M3.3.0". ":[filespec]" refers to a predefined timezone. For example, ":Africa/Johannesburg". Note that the colon is optional. Certain acronyms are predefined, such as GB, NZ and CET. 5.21.1 RNCtimezone = text 5.22 Data Type uuidIn short: A Universally Unique Identifier (UUID). 5.22.1 RNCuuid = xsd:token { pattern = "[0-9abcdefABCDEF\-]{1,40}" }
5.23 Data Type uuid_or_emptyIn short: A Universally Unique Identifier (UUID), or the empty string. 5.23.1 RNCuuid_or_empty = xsd:token { pattern = "[0-9abcdefABCDEF\-]{0,40}" }
6 Element Details6.1 Element cIn short: A reference to a command. 6.1.1 Structure6.1.2 RNCc
= element c
{
text
}
6.2 Element eIn short: A reference to an element. 6.2.1 Structure6.2.2 RNCe
= element e
{
text
}
6.3 Element rIn short: A reference to a response. 6.3.1 Structure6.3.2 RNCr
= element r
{
text
}
6.4 Element oIn short: An optional pattern item. 6.4.1 Structure6.4.2 RNCo
= element o
{
( c
| e
| r
| g )
}
6.5 Element gIn short: A group of pattern items. 6.5.1 Structure6.5.2 RNCg
= element g
{
c*
& e*
& r*
& o*
& any*
}
6.6 Element anyIn short: Pattern item indicating "any number of". 6.6.1 Structure6.6.2 RNCany
= element any
{
( c
| e
| r
| g )
}
6.7 Element patternIn short: The pattern element of a command or command descendant. It's actually either a 't' element, or the word "text", or "". 6.7.1 Structure
6.7.2 RNCpattern
= element pattern
{
text
& pattern_attrib*
& c*
& e*
& r*
& o*
& g*
& any*
& pattern_t?
}
pattern_attrib
= element attrib
{
pattern_attrib_name
& pattern_attrib_type
& pattern_attrib_required
& pattern_attrib_filter_keywords*
}
pattern_attrib_name
= element name
{
type_name
}
pattern_attrib_type
= element type
{
type_name
}
pattern_attrib_required
= element required
{
boolean
}
pattern_attrib_filter_keywords
= element filter_keywords
{
filter_keywords
}
pattern_t
= element t
{
type_name
}
6.8 Element command_definitionIn short: Definition of a command in OMP describing HELP command. 6.8.1 Structure
6.8.2 RNCcommand_definition
= element command_definition
{
command_definition_name
& command_definition_summary?
& command_definition_description?
& ( ( command_definition_pattern
& command_definition_response )
| ( command_definition_type
& command_definition_ele* ) )
& command_definition_example*
}
command_definition_name
= element name
{
type_name
}
command_definition_summary
= element summary
{
text
}
command_definition_description
= element description
{
text
& command_definition_description_p*
}
command_definition_description_p
= element p
{
text
}
command_definition_pattern
= element pattern # type pattern
{
text
& pattern_attrib*
& c*
& e*
& r*
& o*
& g*
& any*
& pattern_t?
}
command_definition_response
= element response # type pattern
{
text
& pattern_attrib*
& c*
& e*
& r*
& o*
& g*
& any*
& pattern_t?
}
command_definition_example
= element example
{
command_definition_example_summary?
& command_definition_example_description?
& command_definition_example_request
& command_definition_example_response
}
command_definition_example_summary
= element summary
{
text
}
command_definition_example_description
= element description
{
text
}
command_definition_example_request
= element request
{
text
}
command_definition_example_response
= element response
{
text
}
command_definition_type
= element type
{
text
}
command_definition_ele
= element ele # type command_definition
{
command_definition_name
& command_definition_summary?
& command_definition_description?
& ( ( command_definition_pattern
& command_definition_response )
| ( command_definition_type
& command_definition_ele* ) )
& command_definition_example*
}
6.9 Element filter_keywordsIn short: A group of filter keywords usable in an attribute or element text. 6.9.1 Structure
6.9.2 RNCfilter_keywords
= element filter_keywords
{
filter_keywords_condition?
& filter_keywords_column*
& filter_keywords_option*
}
filter_keywords_condition
= element condition
{
text
}
filter_keywords_column
= element column
{
filter_keywords_column_name
& filter_keywords_column_type
& filter_keywords_column_summary
}
filter_keywords_column_name
= element name
{
name
}
filter_keywords_column_type
= element type
{
type_name
}
filter_keywords_column_summary
= element summary
{
text
}
filter_keywords_option
= element option
{
filter_keywords_option_name
& filter_keywords_option_type
& filter_keywords_option_summary
}
filter_keywords_option_name
= element name
{
name
}
filter_keywords_option_type
= element type
{
type_name
}
filter_keywords_option_summary
= element summary
{
text
}
6.10 Element certificate_infoIn short: Info about a certificate. 6.10.1 Structure
6.10.2 RNCcertificate_info
= element certificate_info
{
certificate_info_time_status
& certificate_info_activation_time
& certificate_info_expiration_time
& certificate_info_issuer
& certificate_info_md5_fingerprint
}
certificate_info_time_status
= element time_status
{
xsd:token { pattern = "expired|inactive|unknown|valid" }
}
certificate_info_activation_time
= element activation_time
{
text
}
certificate_info_expiration_time
= element expiration_time
{
text
}
certificate_info_issuer
= element issuer
{
text
}
certificate_info_md5_fingerprint
= element md5_fingerprint
{
text
}
6.11 Element noteIn short: A note. 6.11.1 Structure
6.11.2 RNCnote
= element note
{
attribute id { uuid }
& note_permissions
& note_owner
& note_nvt
& note_text
& note_creation_time
& note_modification_time
& note_writable
& note_in_use
& note_active
& note_orphan
& note_user_tags
& ( note_hosts
& note_port
& note_severity
& note_threat
& note_task
& note_end_time?
& note_result? )?
}
note_permissions
= element permissions
{
note_permissions_permission*
}
note_permissions_permission
= element permission
{
note_permissions_permission_name
}
note_permissions_permission_name
= element name
{
name
}
note_owner
= element owner
{
note_owner_name
}
note_owner_name
= element name
{
name
}
note_nvt
= element nvt
{
attribute oid { oid }
& note_nvt_name
& note_nvt_type
}
note_nvt_name
= element name
{
name
}
note_nvt_type
= element type
{
text
}
note_creation_time
= element creation_time
{
iso_time
}
note_modification_time
= element modification_time
{
iso_time
}
note_writable
= element writable
{
boolean
}
note_in_use
= element in_use
{
boolean
}
note_active
= element active
{
boolean
}
note_text
= element text
{
text
& attribute excerpt { boolean }
}
note_orphan
= element orphan
{
boolean
}
note_user_tags
= element user_tags
{
note_user_tags_count
& note_user_tags_tag*
}
note_user_tags_count
= element count
{
integer
}
note_user_tags_tag
= element tag
{
attribute id { uuid }
& note_user_tags_tag_name
& note_user_tags_tag_value
& note_user_tags_tag_comment
}
note_user_tags_tag_name
= element name
{
text
}
note_user_tags_tag_value
= element value
{
text
}
note_user_tags_tag_comment
= element comment
{
text
}
note_hosts
= element hosts
{
text
}
note_port
= element port
{
text
}
note_severity
= element severity
{
severity
}
note_threat
= element threat
{
threat
}
note_task
= element task
{
attribute id { uuid }
}
note_active
= element active
{
integer
}
note_end_time
= element end_time
{
text
}
note_result
= element result
{
attribute id { uuid }
& note_result_host
& note_result_port
& note_result_nvt
& note_result_severity
& note_result_threat
& note_result_qod
& note_result_description
}
note_result_host
= element host
{
text
& note_result_host_asset
}
note_result_host_asset
= element asset
{
attribute asset_id { uuid }
}
note_result_port
= element port
{
text
}
note_result_nvt
= element nvt
{
attribute oid { oid }
& note_result_nvt_name
& note_result_nvt_type
& note_result_nvt_cvss_base
& note_result_nvt_cve?
& note_result_nvt_bid?
}
note_result_nvt_name
= element name
{
name
}
note_result_nvt_type
= element type
{
text
}
note_result_nvt_cvss_base
= element cvss_base
{
text
}
note_result_nvt_cve
= element cve
{
text
}
note_result_nvt_bid
= element bid
{
integer
}
note_result_severity
= element severity
{
severity
}
note_result_threat
= element threat
{
threat
}
note_result_qod
= element qod
{
note_result_qod_value
& note_result_qod_type
}
note_result_qod_value
= element value
{
integer
}
note_result_qod_type
= element type
{
text
}
note_result_description
= element description
{
text
}
6.12 Element overrideIn short: An override. 6.12.1 Structure
6.12.2 RNCoverride
= element override
{
attribute id { uuid }
& override_permissions
& override_owner
& override_nvt
& override_creation_time
& override_modification_time
& override_writable
& override_in_use
& override_active
& override_text
& override_threat
& override_severity
& override_new_threat
& override_new_severity
& override_orphan
& override_permissions
& override_user_tags
& ( override_hosts
& override_port
& override_task
& override_end_time?
& override_result? )?
}
override_permissions
= element permissions
{
override_permissions_permission*
}
override_permissions_permission
= element permission
{
override_permissions_permission_name
}
override_permissions_permission_name
= element name
{
name
}
override_owner
= element owner
{
override_owner_name
}
override_owner_name
= element name
{
name
}
override_nvt
= element nvt
{
attribute oid { oid }
& override_nvt_name
& override_nvt_type
}
override_nvt_name
= element name
{
name
}
override_nvt_type
= element type
{
text
}
override_creation_time
= element creation_time
{
iso_time
}
override_modification_time
= element modification_time
{
iso_time
}
override_writable
= element writable
{
boolean
}
override_in_use
= element in_use
{
boolean
}
override_active
= element active
{
boolean
}
override_text
= element text
{
text
& attribute excerpt { boolean }
}
override_threat
= element threat
{
threat
}
override_severity
= element severity
{
severity
}
override_new_threat
= element new_threat
{
threat
}
override_new_severity
= element new_severity
{
severity
}
override_orphan
= element orphan
{
boolean
}
override_user_tags
= element user_tags
{
override_user_tags_count
& override_user_tags_tag*
}
override_user_tags_count
= element count
{
integer
}
override_user_tags_tag
= element tag
{
attribute id { uuid }
& override_user_tags_tag_name
& override_user_tags_tag_value
& override_user_tags_tag_comment
}
override_user_tags_tag_name
= element name
{
text
}
override_user_tags_tag_value
= element value
{
text
}
override_user_tags_tag_comment
= element comment
{
text
}
override_hosts
= element hosts
{
text
}
override_port
= element port
{
text
}
override_task
= element task
{
attribute id { uuid }
}
override_active
= element active
{
integer
}
override_end_time
= element end_time
{
text
}
override_result
= element result
{
attribute id { uuid }
& override_result_host
& override_result_port
& override_result_nvt
& override_result_threat
& override_result_severity
& override_result_qod
& override_result_description
}
override_result_host
= element host
{
text
& override_result_host_asset
}
override_result_host_asset
= element asset
{
attribute asset_id { uuid }
}
override_result_port
= element port
{
text
}
override_result_nvt
= element nvt
{
attribute oid { oid }
& override_result_nvt_name
& override_result_nvt_type
& override_result_nvt_cvss_base
& override_result_nvt_cve?
& override_result_nvt_bid?
}
override_result_nvt_name
= element name
{
name
}
override_result_nvt_type
= element type
{
text
}
override_result_nvt_cvss_base
= element cvss_base
{
text
}
override_result_nvt_cve
= element cve
{
text
}
override_result_nvt_bid
= element bid
{
integer
}
override_result_threat
= element threat
{
threat
}
override_result_severity
= element severity
{
severity
}
override_result_qod
= element qod
{
override_result_qod_value
& override_result_qod_type
}
override_result_qod_value
= element value
{
integer
}
override_result_qod_type
= element type
{
text
}
override_result_description
= element description
{
text
}
6.13 Element resultIn short: A result. 6.13.1 Structure
6.13.2 RNCresult
= element result
{
attribute id { uuid }
& result_name
& result_owner
& result_comment
& result_creation_time
& result_modification_time
& result_user_tags?
& result_report?
& result_task?
& result_host
& result_port
& result_nvt
& result_scan_nvt_version
& result_threat
& result_severity
& result_qod
& result_original_threat?
& result_original_severity?
& result_description
& result_delta?
& result_details
& result_detection
& result_notes?
& result_overrides?
}
result_name
= element name
{
text
}
result_owner
= element owner
{
result_owner_name
}
result_owner_name
= element name
{
name
}
result_comment
= element comment
{
text
}
result_creation_time
= element creation_time
{
iso_time
}
result_modification_time
= element modification_time
{
iso_time
}
result_user_tags
= element user_tags
{
result_user_tags_count
& result_user_tags_tag*
}
result_user_tags_count
= element count
{
integer
}
result_user_tags_tag
= element tag
{
attribute id { uuid }
& result_user_tags_tag_name
& result_user_tags_tag_value
& result_user_tags_tag_comment
}
result_user_tags_tag_name
= element name
{
text
}
result_user_tags_tag_value
= element value
{
text
}
result_user_tags_tag_comment
= element comment
{
text
}
result_report
= element report
{
attribute id { uuid }
}
result_task
= element task
{
attribute id { uuid }
& result_task_name
}
result_task_name
= element name
{
text
}
result_host
= element host
{
text
& result_host_asset
}
result_host_asset
= element asset
{
attribute asset_id { uuid }
}
result_port
= element port
{
text
}
result_nvt
= element nvt
{
attribute oid { oid }
& result_nvt_name
& result_nvt_type
& result_nvt_family
& result_nvt_cvss_base
& result_nvt_cve
& result_nvt_cpe
& result_nvt_bid
& result_nvt_tags
& result_nvt_cert
& result_nvt_xref
}
result_nvt_name
= element name
{
name
}
result_nvt_type
= element type
{
text
}
result_nvt_family
= element family
{
name
}
result_nvt_cvss_base
= element cvss_base
{
integer
}
result_nvt_cve
= element cve
{
text
}
result_nvt_cpe
= element cpe
{
text
}
result_nvt_bid
= element bid
{
text
}
result_nvt_tags
= element tags
{
text
}
result_nvt_cert
= element cert
{
result_nvt_cert_cert_ref*
}
result_nvt_cert_cert_ref
= element cert_ref
{
attribute id { text }?
& attribute type { text }?
}
result_nvt_xref
= element xref
{
text
}
result_scan_nvt_version
= element scan_nvt_version
{
text
}
result_threat
= element threat
{
threat
}
result_severity
= element severity
{
severity
}
result_qod
= element qod
{
result_qod_value
& result_qod_type
}
result_qod_value
= element value
{
integer
}
result_qod_type
= element type
{
text
}
result_original_threat
= element original_threat
{
threat
}
result_original_severity
= element original_severity
{
severity
}
result_description
= element description
{
text
}
result_delta
= element delta
{
text
& result_delta_result?
& result_delta_diff?
& result_delta_notes?
& result_delta_overrides?
}
result_delta_result
= element result # type result
{
attribute id { uuid }
& result_name
& result_owner
& result_comment
& result_creation_time
& result_modification_time
& result_user_tags?
& result_report?
& result_task?
& result_host
& result_port
& result_nvt
& result_scan_nvt_version
& result_threat
& result_severity
& result_qod
& result_original_threat?
& result_original_severity?
& result_description
& result_delta?
& result_details
& result_detection
& result_notes?
& result_overrides?
}
result_delta_diff
= element diff # type text
{
}
result_delta_notes
= element notes
{
result_delta_notes_note*
}
result_delta_notes_note
= element note # type note
{
attribute id { uuid }
& note_permissions
& note_owner
& note_nvt
& note_text
& note_creation_time
& note_modification_time
& note_writable
& note_in_use
& note_active
& note_orphan
& note_user_tags
& ( note_hosts
& note_port
& note_severity
& note_threat
& note_task
& note_end_time?
& note_result? )?
}
result_delta_overrides
= element overrides
{
result_delta_overrides_override*
}
result_delta_overrides_override
= element override # type override
{
attribute id { uuid }
& override_permissions
& override_owner
& override_nvt
& override_creation_time
& override_modification_time
& override_writable
& override_in_use
& override_active
& override_text
& override_threat
& override_severity
& override_new_threat
& override_new_severity
& override_orphan
& override_permissions
& override_user_tags
& ( override_hosts
& override_port
& override_task
& override_end_time?
& override_result? )?
}
result_details
= element details
{
result_details_detail*
}
result_details_detail
= element detail
{
result_details_detail_name
& result_details_detail_value
}
result_details_detail_name
= element name
{
text
}
result_details_detail_value
= element value
{
text
}
result_detection
= element detection
{
result_detection_result
}
result_detection_result
= element result
{
attribute id { uuid }
& result_detection_result_details
}
result_detection_result_details
= element details
{
result_detection_result_details_detail*
}
result_detection_result_details_detail
= element detail
{
result_detection_result_details_detail_name
& result_detection_result_details_detail_value
}
result_detection_result_details_detail_name
= element name
{
text
}
result_detection_result_details_detail_value
= element value
{
text
}
result_notes
= element notes
{
result_notes_note*
}
result_notes_note
= element note # type note
{
attribute id { uuid }
& note_permissions
& note_owner
& note_nvt
& note_text
& note_creation_time
& note_modification_time
& note_writable
& note_in_use
& note_active
& note_orphan
& note_user_tags
& ( note_hosts
& note_port
& note_severity
& note_threat
& note_task
& note_end_time?
& note_result? )?
}
result_overrides
= element overrides
{
result_overrides_override*
}
result_overrides_override
= element override # type override
{
attribute id { uuid }
& override_permissions
& override_owner
& override_nvt
& override_creation_time
& override_modification_time
& override_writable
& override_in_use
& override_active
& override_text
& override_threat
& override_severity
& override_new_threat
& override_new_severity
& override_orphan
& override_permissions
& override_user_tags
& ( override_hosts
& override_port
& override_task
& override_end_time?
& override_result? )?
}
6.14 Element reportIn short: Actually attributes and either base64 or a report. 6.14.1 Structure
6.14.2 RNCreport
= element report
{
text # RNC limitation: base64
& attribute id { uuid }
& attribute format_id { uuid }
& attribute extension { text }
& attribute content_type { text }
& attribute type { xsd:token { pattern = "scan|assets|prognostic" } }?
& report_owner
& report_name
& report_comment
& report_creation_time
& report_modification_time
& report_writable
& report_in_use
& report_task
& report_report_format
& report_report
}
report_owner
= element owner
{
report_owner_name
}
report_owner_name
= element name
{
name
}
report_name
= element name
{
""
}
report_comment
= element comment
{
text
}
report_creation_time
= element creation_time
{
iso_time
}
report_modification_time
= element modification_time
{
iso_time
}
report_in_use
= element in_use
{
boolean
}
report_writable
= element writable
{
boolean
}
report_task
= element task
{
attribute id { uuid }
& report_task_name
}
report_task_name
= element name
{
name
}
report_report_format
= element report_format
{
attribute id { uuid }
& report_report_format_name
}
report_report_format_name
= element name
{
name
}
report_report
= element report
{
attribute id { uuid }
& attribute type { xsd:token { pattern = "scan|assets|prognostic" } }?
& report_report_omp
& report_report_report_format
& report_report_sort
& report_report_filters
& report_report_severity_class
& report_report_delta?
& ( report_report_timezone
& report_report_timezone_abbrev
& report_report_permissions
& report_report_user_tags
& report_report_scan_run_status
& report_report_result_count
& report_report_severity
& report_report_host_count?
& report_report_task
& report_report_scan
& report_report_ports
& report_report_results
& report_report_hosts
& report_report_closed_cves
& report_report_vulns
& report_report_os
& report_report_apps
& report_report_ssl_certs
& report_report_host*
& report_report_timestamp
& report_report_scan_start
& report_report_host_start*
& report_report_host_end*
& report_report_scan_end
& report_report_errors )?
}
report_report_omp
= element omp
{
report_report_omp_version
}
report_report_omp_version
= element version
{
text
}
report_report_report_format
= element report_format
{
report_report_report_format_param
}
report_report_report_format_param
= element param
{
report_report_report_format_param_name
& report_report_report_format_param_value
}
report_report_report_format_param_name
= element name
{
text
}
report_report_report_format_param_value
= element value
{
text
}
report_report_delta
= element delta
{
report_report_delta_report
}
report_report_delta_report
= element report
{
attribute id { uuid }
& report_report_delta_report_scan_run_status
& report_report_delta_report_timestamp
& report_report_delta_report_scan_start
& report_report_delta_report_scan_end
}
report_report_delta_report_scan_run_status
= element scan_run_status
{
task_status
}
report_report_delta_report_timestamp
= element timestamp
{
iso_time
}
report_report_delta_report_scan_start
= element scan_start
{
iso_time
}
report_report_delta_report_scan_end
= element scan_end
{
iso_time
}
report_report_sort
= element sort
{
report_report_sort_field
}
report_report_sort_field
= element field
{
text
& report_report_sort_field_order
}
report_report_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
report_report_filters
= element filters
{
text # RNC limitation: levels
& attribute id { uuid }?
& report_report_filters_term
& report_report_filters_phrase
& report_report_filters_notes
& report_report_filters_overrides
& report_report_filters_apply_overrides
& report_report_filters_result_hosts_only
& report_report_filters_min_qod
& report_report_filters_autofp
& report_report_filters_filter*
& report_report_filters_host?
& report_report_filters_delta?
}
report_report_filters_term
= element term
{
text
}
report_report_filters_phrase
= element phrase
{
text
}
report_report_filters_notes
= element notes
{
xsd:token { pattern = "0|1" }
}
report_report_filters_overrides
= element overrides
{
xsd:token { pattern = "0|1" }
}
report_report_filters_apply_overrides
= element apply_overrides
{
xsd:token { pattern = "0|1" }
}
report_report_filters_result_hosts_only
= element result_hosts_only
{
xsd:token { pattern = "0|1" }
}
report_report_filters_min_qod
= element min_qod
{
text
}
report_report_filters_autofp
= element autofp
{
xsd:token { pattern = "0|1|2" }
}
report_report_filters_filter
= element filter
{
xsd:token { pattern = "High|Medium|Low|Log|Debug" }
}
report_report_filters_host
= element host
{
report_report_filters_host_ip
}
report_report_filters_host_ip
= element ip
{
text
}
report_report_filters_delta
= element delta
{
text
& report_report_filters_delta_changed
& report_report_filters_delta_gone
& report_report_filters_delta_new
& report_report_filters_delta_same
}
report_report_filters_delta_changed
= element changed
{
boolean
}
report_report_filters_delta_gone
= element gone
{
boolean
}
report_report_filters_delta_new
= element new
{
boolean
}
report_report_filters_delta_same
= element same
{
boolean
}
report_report_timezone
= element timezone
{
timezone
}
report_report_timezone_abbrev
= element timezone_abbrev
{
text
}
report_report_permissions
= element permissions
{
report_report_permissions_permission*
}
report_report_permissions_permission
= element permission
{
report_report_permissions_permission_name
}
report_report_permissions_permission_name
= element name
{
name
}
report_report_user_tags
= element user_tags
{
report_report_user_tags_count
& report_report_user_tags_tag*
}
report_report_user_tags_count
= element count
{
integer
}
report_report_user_tags_tag
= element tag
{
attribute id { uuid }
& report_report_user_tags_tag_name
& report_report_user_tags_tag_value
& report_report_user_tags_tag_comment
}
report_report_user_tags_tag_name
= element name
{
text
}
report_report_user_tags_tag_value
= element value
{
text
}
report_report_user_tags_tag_comment
= element comment
{
text
}
report_report_scan_run_status
= element scan_run_status
{
task_status
}
report_report_result_count
= element result_count
{
text
& report_report_result_count_full
& report_report_result_count_filtered
& report_report_result_count_debug
& report_report_result_count_hole
& report_report_result_count_info
& report_report_result_count_log
& report_report_result_count_warning
}
report_report_result_count_full
= element full
{
integer
}
report_report_result_count_filtered
= element filtered
{
integer
}
report_report_result_count_debug
= element debug
{
report_report_result_count_debug_full
& report_report_result_count_debug_filtered
}
report_report_result_count_debug_full
= element full
{
integer
}
report_report_result_count_debug_filtered
= element filtered
{
integer
}
report_report_result_count_hole
= element hole
{
report_report_result_count_hole_full
& report_report_result_count_hole_filtered
}
report_report_result_count_hole_full
= element full
{
integer
}
report_report_result_count_hole_filtered
= element filtered
{
integer
}
report_report_result_count_info
= element info
{
report_report_result_count_info_full
& report_report_result_count_info_filtered
}
report_report_result_count_info_full
= element full
{
integer
}
report_report_result_count_info_filtered
= element filtered
{
integer
}
report_report_result_count_log
= element log
{
report_report_result_count_log_full
& report_report_result_count_log_filtered
}
report_report_result_count_log_full
= element full
{
integer
}
report_report_result_count_log_filtered
= element filtered
{
integer
}
report_report_result_count_warning
= element warning
{
report_report_result_count_warning_full
& report_report_result_count_warning_filtered
}
report_report_result_count_warning_full
= element full
{
integer
}
report_report_result_count_warning_filtered
= element filtered
{
integer
}
report_report_severity
= element severity
{
report_report_severity_full
& report_report_severity_filtered
}
report_report_severity_full
= element full
{
severity
}
report_report_severity_filtered
= element filtered
{
severity
}
report_report_severity_class
= element severity_class
{
report_report_severity_class_name
& report_report_severity_class_full_name
& report_report_severity_class_severity_range*
}
report_report_severity_class_name
= element name
{
ERROR
}
report_report_severity_class_full_name
= element full_name
{
text
}
report_report_severity_class_severity_range
= element severity_range
{
report_report_severity_class_severity_range_name
& report_report_severity_class_severity_range_min
& report_report_severity_class_severity_range_max
}
report_report_severity_class_severity_range_name
= element name
{
name
}
report_report_severity_class_severity_range_min
= element min
{
integer
}
report_report_severity_class_severity_range_max
= element max
{
integer
}
report_report_host_count
= element host_count
{
report_report_host_count_full
& report_report_host_count_filtered
}
report_report_host_count_full
= element full
{
integer
}
report_report_host_count_filtered
= element filtered
{
integer
}
report_report_task
= element task
{
attribute id { uuid }
& report_report_task_name
& report_report_task_comment
& report_report_task_target
& report_report_task_progress
& report_report_task_user_tags
}
report_report_task_name
= element name
{
name
}
report_report_task_comment
= element comment
{
text
}
report_report_task_target
= element target
{
attribute id { uuid }?
& report_report_task_target_trash
}
report_report_task_target_trash
= element trash # type boolean
{
}
report_report_task_progress
= element progress
{
integer
}
report_report_task_user_tags
= element user_tags
{
report_report_task_user_tags_count
& report_report_task_user_tags_tag*
}
report_report_task_user_tags_count
= element count
{
integer
}
report_report_task_user_tags_tag
= element tag
{
attribute id { uuid }
& report_report_task_user_tags_tag_name
& report_report_task_user_tags_tag_value
& report_report_task_user_tags_tag_comment
}
report_report_task_user_tags_tag_name
= element name
{
text
}
report_report_task_user_tags_tag_value
= element value
{
text
}
report_report_task_user_tags_tag_comment
= element comment
{
text
}
report_report_scan
= element scan
{
report_report_scan_task
}
report_report_scan_task
= element task
{
report_report_scan_task_slave
& report_report_scan_task_preferences
}
report_report_scan_task_slave
= element slave
{
attribute id { uuid }
& report_report_scan_task_slave_name
& report_report_scan_task_slave_host
& report_report_scan_task_slave_port
}
report_report_scan_task_slave_name
= element name
{
name
}
report_report_scan_task_slave_host
= element host
{
text
}
report_report_scan_task_slave_port
= element port
{
text
}
report_report_scan_task_preferences
= element preferences
{
report_report_scan_task_preferences_preference*
}
report_report_scan_task_preferences_preference
= element preference
{
report_report_scan_task_preferences_preference_name
& report_report_scan_task_preferences_preference_scanner_name
& report_report_scan_task_preferences_preference_value
}
report_report_scan_task_preferences_preference_name
= element name
{
text
}
report_report_scan_task_preferences_preference_scanner_name
= element scanner_name
{
text
}
report_report_scan_task_preferences_preference_value
= element value
{
text
}
report_report_ports
= element ports
{
attribute start { integer }
& attribute max { integer }
& report_report_ports_port*
}
report_report_ports_port
= element port
{
text
& report_report_ports_port_host
& report_report_ports_port_severity
& report_report_ports_port_threat
}
report_report_ports_port_host
= element host
{
text
}
report_report_ports_port_severity
= element severity
{
severity
}
report_report_ports_port_threat
= element threat
{
threat
}
report_report_results
= element results
{
attribute start { integer }
& attribute max { integer }
& report_report_results_result*
}
report_report_results_result
= element result # type result
{
attribute id { uuid }
& result_name
& result_owner
& result_comment
& result_creation_time
& result_modification_time
& result_user_tags?
& result_report?
& result_task?
& result_host
& result_port
& result_nvt
& result_scan_nvt_version
& result_threat
& result_severity
& result_qod
& result_original_threat?
& result_original_severity?
& result_description
& result_delta?
& result_details
& result_detection
& result_notes?
& result_overrides?
}
report_report_hosts
= element hosts
{
( ( attribute start { integer }
& attribute max { integer } )
| report_report_hosts_count )
}
report_report_hosts_count
= element count
{
}
report_report_closed_cves
= element closed_cves
{
report_report_closed_cves_count
}
report_report_closed_cves_count
= element count
{
}
report_report_vulns
= element vulns
{
report_report_vulns_count
}
report_report_vulns_count
= element count
{
}
report_report_os
= element os
{
report_report_os_count
}
report_report_os_count
= element count
{
}
report_report_apps
= element apps
{
report_report_apps_count
}
report_report_apps_count
= element count
{
}
report_report_ssl_certs
= element ssl_certs
{
report_report_ssl_certs_count
}
report_report_ssl_certs_count
= element count
{
}
report_report_host
= element host
{
report_report_host_ip
& report_report_host_asset
& report_report_host_start
& report_report_host_end
& report_report_host_port_count
& report_report_host_result_count
& report_report_host_detail*
}
report_report_host_ip
= element ip
{
text
}
report_report_host_asset
= element asset
{
attribute asset_id { uuid }
}
report_report_host_start
= element start
{
text
}
report_report_host_end
= element end
{
text
}
report_report_host_port_count
= element port_count
{
report_report_host_port_count_page
}
report_report_host_port_count_page
= element page
{
integer
}
report_report_host_result_count
= element result_count
{
report_report_host_result_count_page
& report_report_host_result_count_hole
& report_report_host_result_count_warning
& report_report_host_result_count_info
& report_report_host_result_count_log
& report_report_host_result_count_false_positive
}
report_report_host_result_count_page
= element page
{
integer
}
report_report_host_result_count_hole
= element hole
{
report_report_host_result_count_hole_page
}
report_report_host_result_count_hole_page
= element page
{
integer
}
report_report_host_result_count_warning
= element warning
{
report_report_host_result_count_warning_page
}
report_report_host_result_count_warning_page
= element page
{
integer
}
report_report_host_result_count_info
= element info
{
report_report_host_result_count_info_page
}
report_report_host_result_count_info_page
= element page
{
integer
}
report_report_host_result_count_log
= element log
{
report_report_host_result_count_log_page
}
report_report_host_result_count_log_page
= element page
{
integer
}
report_report_host_result_count_false_positive
= element false_positive
{
report_report_host_result_count_false_positive_page
}
report_report_host_result_count_false_positive_page
= element page
{
integer
}
report_report_host_detail
= element detail
{
report_report_host_detail_name
& report_report_host_detail_value
& report_report_host_detail_source
& report_report_host_detail_extra
}
report_report_host_detail_name
= element name
{
text
}
report_report_host_detail_value
= element value
{
text
}
report_report_host_detail_source
= element source
{
report_report_host_detail_source_type
& report_report_host_detail_source_name
& report_report_host_detail_source_description
}
report_report_host_detail_source_type
= element type
{
text
}
report_report_host_detail_source_name
= element name
{
text
}
report_report_host_detail_source_description
= element description
{
text
}
report_report_host_detail_extra
= element extra
{
text
}
report_report_timestamp
= element timestamp
{
iso_time
}
report_report_scan_start
= element scan_start
{
iso_time
}
report_report_host_start
= element host_start
{
text # RNC limitation: iso_time
& report_report_host_start_host
}
report_report_host_start_host
= element host
{
text
}
report_report_host_end
= element host_end
{
text # RNC limitation: iso_time
& report_report_host_end_host
}
report_report_host_end_host
= element host
{
text
}
report_report_scan_end
= element scan_end
{
iso_time
}
report_report_errors
= element errors
{
report_report_errors_count
& report_report_errors_error*
}
report_report_errors_count
= element count
{
}
report_report_errors_error
= element error
{
report_report_errors_error_host
& report_report_errors_error_port
& report_report_errors_error_description
& report_report_errors_error_nvt
& report_report_errors_error_scan_nvt_version
& report_report_errors_error_severity
}
report_report_errors_error_host
= element host
{
text
& report_report_errors_error_host_asset
}
report_report_errors_error_host_asset
= element asset
{
attribute asset_id { uuid }
}
report_report_errors_error_port
= element port
{
port
}
report_report_errors_error_description
= element description
{
text
}
report_report_errors_error_nvt
= element nvt
{
attribute oid { }
& report_report_errors_error_nvt_name
& report_report_errors_error_nvt_type
& report_report_errors_error_nvt_cvss_base
}
report_report_errors_error_nvt_name
= element name
{
text
}
report_report_errors_error_nvt_type
= element type
{
text
}
report_report_errors_error_nvt_cvss_base
= element cvss_base
{
severity
}
report_report_errors_error_scan_nvt_version
= element scan_nvt_version
{
text
}
report_report_errors_error_severity
= element severity
{
severity
}
7 Command Details7.1 Command authenticateIn short: Authenticate with the manager. The client uses the authenticate command to authenticate with the Manager. The client normally executes this command at the beginning of each connection. The only commands permitted before authentication are get_version and commands. 7.1.1 Structure
7.1.2 RNC
Command
authenticate
= element authenticate
{
authenticate_credentials
}
authenticate_credentials
= element credentials
{
authenticate_credentials_username
& authenticate_credentials_password
}
authenticate_credentials_username
= element username
{
text
}
authenticate_credentials_password
= element password
{
text
}
authenticate_response
= element authenticate_response
{
attribute status { status }
& attribute status_text { text }
& authenticate_response_role
& authenticate_response_timezone
}
authenticate_response_role
= element role # type UserAdminSuper AdminObserver
{
}
authenticate_response_timezone
= element timezone
{
timezone
}
7.1.3 Example: Authenticate with a good password
Client
<authenticate>
<credentials>
<username>sally</username>
<password>secret</password>
</credentials>
</authenticate>
<authenticate_response status="200"
status_text="OK">
<role>User</role>
<timezone>UTC</timezone>
</authenticate_response>
7.1.3 Example: Authenticate with a bad password
Client
<authenticate>
<credentials>
<username>sally</username>
<password>secrte</password>
</credentials>
</authenticate>
<authenticate_response status="400"
status_text="Authentication failed"/>
7.2 Command commandsIn short: Run a list of commands. The client uses the commands command to run a list of commands. The elements are executed as OMP commands in the given sequence. The reply contains the result of each command, in the same order as the given commands. 7.2.1 Structure
7.2.2 RNC
Command
commands
= element commands
{
( authenticate
| commands
| create_agent
| create_alert
| create_asset
| create_config
| create_credential
| create_filter
| create_group
| create_note
| create_override
| create_permission
| create_port_list
| create_port_range
| create_report_format
| create_role
| create_scanner
| create_schedule
| create_tag
| create_target
| create_task
| create_user
| delete_agent
| delete_alert
| delete_asset
| delete_config
| delete_credential
| delete_filter
| delete_group
| delete_note
| delete_override
| delete_permission
| delete_report
| delete_report_format
| delete_role
| delete_port_list
| delete_port_range
| delete_scanner
| delete_schedule
| delete_tag
| delete_target
| delete_task
| delete_user
| describe_auth
| empty_trashcan
| get_agents
| get_alerts
| get_assets
| get_configs
| get_credentials
| get_feeds
| get_filters
| get_groups
| get_info
| get_notes
| get_nvts
| get_nvt_families
| get_overrides
| get_permissions
| get_port_lists
| get_preferences
| get_reports
| get_report_formats
| get_results
| get_roles
| get_scanners
| get_schedules
| get_settings
| get_system_reports
| get_tags
| get_targets
| get_tasks
| get_users
| get_version
| help
| modify_agent
| modify_alert
| modify_asset
| modify_auth
| modify_config
| modify_credential
| modify_filter
| modify_group
| modify_note
| modify_override
| modify_permission
| modify_port_list
| modify_report
| modify_report_format
| modify_role
| modify_scanner
| modify_schedule
| modify_setting
| modify_tag
| modify_target
| modify_task
| modify_user
| restore
| resume_task
| run_wizard
| start_task
| stop_task
| sync_feed
| sync_config
| sync_scap
| sync_cert
| test_alert
| verify_agent
| verify_report_format
| verify_scanner )*
}
commands_response
= element commands_response
{
attribute status { status }
& attribute status_text { text }
& ( authenticate_response
| commands_response
| create_agent_response
| create_alert_response
| create_asset_response
| create_config_response
| create_credential_response
| create_filter_response
| create_group_response
| create_note_response
| create_override_response
| create_permission_response
| create_port_list_response
| create_port_range_response
| create_role_response
| create_scanner_response
| create_schedule_response
| create_tag_response
| create_target_response
| create_task_response
| create_user_response
| delete_agent_response
| delete_alert_response
| delete_asset_response
| delete_config_response
| delete_credential_response
| delete_filter_response
| delete_group_response
| delete_note_response
| delete_override_response
| delete_permission_response
| delete_port_list_response
| delete_port_range_response
| delete_report_response
| delete_report_format_response
| delete_role_response
| delete_scanner_response
| delete_schedule_response
| delete_tag_response
| delete_target_response
| delete_task_response
| delete_user_response
| describe_auth_response
| empty_trashcan_response
| get_agents_response
| get_alerts_response
| get_assets_response
| get_configs_response
| get_credentials_response
| get_groups_response
| get_info_response
| get_feeds_response
| get_filters_response
| get_notes_response
| get_nvts_response
| get_nvt_families_response
| get_overrides_response
| get_permissions_response
| get_port_lists_response
| get_preferences_response
| get_reports_response
| get_report_formats_response
| get_results_response
| get_roles_response
| get_scanners_response
| get_schedules_response
| get_settings_response
| get_system_reports_response
| get_tags_response
| get_targets_response
| get_tasks_response
| get_users_response
| get_version_response
| help_response
| modify_agent_response
| modify_alert_response
| modify_asset_response
| modify_auth_response
| modify_config_response
| modify_credential_response
| modify_filter_response
| modify_group_response
| modify_note_response
| modify_override_response
| modify_permission_response
| modify_port_list_response
| modify_report_response
| modify_report_format_response
| modify_role_response
| modify_scanner_response
| modify_schedule_response
| modify_setting_response
| modify_tag_response
| modify_target_response
| modify_task_response
| modify_user_response
| restore_response
| resume_task_response
| run_wizard_response
| start_task_response
| stop_task_response
| sync_feed_response
| sync_config_response
| sync_scap_response
| sync_cert_response
| test_alert_response
| verify_agent_response
| verify_report_format_response
| verify_scanner_response )*
}
7.3 Command create_agentIn short: Create an agent. The client uses the create_agent command to create a new agent. 7.3.1 Structure
7.3.2 RNC
Command
create_agent
= element create_agent
{
create_agent_installer
& create_agent_name
& create_agent_comment?
& create_agent_copy?
& create_agent_howto_install?
& create_agent_howto_use?
}
create_agent_installer
= element installer
{
text # RNC limitation: base64
& create_agent_installer_signature
}
create_agent_installer_signature
= element signature
{
base64
}
create_agent_name
= element name
{
name
}
create_agent_comment
= element comment
{
text
}
create_agent_copy
= element copy
{
uuid
}
create_agent_howto_install
= element howto_install
{
base64
}
create_agent_howto_use
= element howto_use
{
base64
}
create_agent_response
= element create_agent_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.3.3 Example: Create an agent
Client
<create_agent>
<installer>
asdf3235saf3kjBVF...
<signature>iEYEABECAAYFA...</signature>
</installer>
<name>SLAD</name>
</create_agent>
<create_agent_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.4 Command create_alertIn short: Create an alert. The client uses the create_alert command to create a new alert. 7.4.1 Structure
7.4.2 RNC
Command
create_alert
= element create_alert
{
create_alert_name
& create_alert_comment?
& create_alert_copy?
& create_alert_condition
& create_alert_event
& create_alert_method
& create_alert_filter
}
create_alert_name
= element name
{
name
}
create_alert_comment
= element comment
{
text
}
create_alert_copy
= element copy
{
uuid
}
create_alert_condition
= element condition
{
text
& create_alert_condition_data*
}
create_alert_condition_data
= element data
{
text
& create_alert_condition_data_name
}
create_alert_condition_data_name
= element name
{
text
}
create_alert_event
= element event
{
text
& create_alert_event_data*
}
create_alert_event_data
= element data
{
text
& create_alert_event_data_name
}
create_alert_event_data_name
= element name
{
text
}
create_alert_method
= element method
{
text
& create_alert_method_data*
}
create_alert_method_data
= element data
{
text
& create_alert_method_data_name
}
create_alert_method_data_name
= element name
{
text
}
create_alert_filter
= element filter
{
attribute id { uuid }
}
create_alert_response
= element create_alert_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.4.3 Example: Create an alert
Client
<create_alert>
<name>emergency</name>
<condition>
Severity at least
<data>
5.5
<name>severity</name>
</data>
</condition>
<event>
Task run status changed
<data>
Done
<name>status</name>
</data>
</event>
<method>
Email
<data>
sally@example.org
<name>to_address</name>
</data>
<data>
bob@example.org
<name>from_address</name>
</data>
</method>
</create_alert>
<create_alert_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.5 Command create_assetIn short: Create an asset. The client uses the create_asset command to create a new asset. 7.5.1 Structure
7.5.2 RNC
Command
create_asset
= element create_asset
{
( create_asset_asset
| create_asset_report )
}
create_asset_asset
= element asset
{
create_asset_asset_name
& create_asset_asset_comment
}
create_asset_asset_name
= element name
{
name
}
create_asset_asset_comment
= element comment
{
text
}
create_asset_report
= element report
{
attribute id { uuid }
& create_asset_report_filter
}
create_asset_report_filter
= element filter
{
create_asset_report_filter_term
}
create_asset_report_filter_term
= element term
{
text
}
create_asset_response
= element create_asset_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.5.3 Example: Create an asset
Client
<create_asset>
<asset>
<type>host</type>
<name>Localhost</name>
</asset>
</create_asset>
<create_asset_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.6 Command create_configIn short: Create a config. The client uses the create_config command to create a new config. This command can be called in three ways:
7.6.1 Structure
7.6.2 RNC
Command
create_config
= element create_config
{
create_config_comment?
& ( create_config_copy
| get_configs_response )
& create_config_name
}
create_config_comment
= element comment
{
text
}
create_config_copy
= element copy
{
uuid
}
create_config_name
= element name
{
name
}
create_config_response
= element create_config_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.6.3 Example: Copy a config
Client
<create_config> <copy>daba56c8-73ec-11df-a475-002264764cea</copy> <name>Full</name> </create_config> <create_config_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.6.3 Example: Create a config from a GET_CONFIGS response
Client
<create_config>
<get_configs_response>
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
...
</config>
</get_configs_response>
</create_config>
<create_config_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.7 Command create_credentialIn short: Create a credential. The client uses the create_credential command to create a new credential for local security checks and other functions requiring authentication. If the command includes a key, then the manager creates a key-based credential from the key. If the command includes a password, then the manager creates a password only credential. Otherwise the manager autogenerates a key-based credential. 7.7.1 Structure
7.7.2 RNC
Command
create_credential
= element create_credential
{
create_credential_name
& create_credential_comment?
& create_credential_copy?
& create_credential_allow_insecure?
& create_credential_certificate?
& create_credential_key?
& create_credential_login?
& create_credential_password?
& create_credential_auth_algorithm?
& create_credential_community?
& create_credential_privacy?
& create_credential_type?
}
create_credential_name
= element name
{
name
}
create_credential_comment
= element comment
{
text
}
create_credential_copy
= element copy
{
uuid
}
create_credential_allow_insecure
= element allow_insecure
{
boolean
}
create_credential_certificate
= element certificate
{
text
}
create_credential_key
= element key
{
create_credential_key_phrase
& create_credential_key_private
}
create_credential_key_phrase
= element phrase
{
text
}
create_credential_key_private
= element private
{
text
}
create_credential_login
= element login
{
text
}
create_credential_password
= element password
{
text
}
create_credential_community
= element community
{
text
}
create_credential_auth_algorithm
= element auth_algorithm
{
xsd:token { pattern = "md5|sha1" }
}
create_credential_privacy
= element privacy
{
create_credential_privacy_algorithm
& create_credential_privacy_password
}
create_credential_privacy_algorithm
= element algorithm
{
xsd:token { pattern = "aes|des" }
}
create_credential_privacy_password
= element password
{
text
}
create_credential_type
= element type
{
xsd:token { pattern = "cc|snmp|up|usk" }
}
create_credential_response
= element create_credential_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.7.3 Example: Create an LSC credential
Client
<create_credential> <name>cluster sally</name> <login>sally</login> <password>secret</password> <comment>Sally's login to the cluster.</comment> </create_credential> <create_credential_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.8 Command create_filterIn short: Create a filter. The client uses the create_filter command to create a new filter. 7.8.1 Structure
7.8.2 RNC
Command
create_filter
= element create_filter
{
create_filter_name
& create_filter_comment?
& create_filter_copy?
& create_filter_term?
& create_filter_type?
}
create_filter_name
= element name
{
text # RNC limitation: name
& create_filter_name_make_unique
}
create_filter_name_make_unique
= element make_unique
{
boolean
}
create_filter_comment
= element comment
{
text
}
create_filter_copy
= element copy
{
uuid
}
create_filter_term
= element term
{
text
}
create_filter_type
= element type
{
text
}
create_filter_response
= element create_filter_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.8.3 Example: Create a filter
Client
<create_filter> <name>Single Targets</name> <comment>Targets with only one host</comment> <term>ips=1 first=1 rows=-2</term> <type>target</type> </create_filter> <create_filter_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c7"/>
7.9 Command create_groupIn short: Create a group. The client uses the create_group command to create a new group. 7.9.1 Structure
7.9.2 RNC
Command
create_group
= element create_group
{
create_group_name
& create_group_comment?
& create_group_copy?
& create_group_specials?
& create_group_users?
}
create_group_name
= element name
{
name
}
create_group_comment
= element comment
{
text
}
create_group_copy
= element copy
{
uuid
}
create_group_specials
= element specials
{
create_group_specials_full
}
create_group_specials_full
= element full
{
""
}
create_group_users
= element users
{
text
}
create_group_response
= element create_group_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.9.3 Example: Create a group
Client
<create_group> <name>Managers</name> <users>sarah, bob</users> </create_group> <create_group_response status="201"
status_text="OK, resource created"
id="d94211b6-ba40-11e3-bcb1-406186ea4fc5"/>
7.10 Command create_noteIn short: Create a note. The client uses the create_note command to create a new note. 7.10.1 Structure
7.10.2 RNC
Command
create_note
= element create_note
{
create_note_text
& create_note_nvt
& create_note_active?
& create_note_comment?
& create_note_copy?
& create_note_hosts?
& create_note_port?
& create_note_result?
& create_note_severity?
& create_note_task?
& create_note_threat?
}
create_note_text
= element text
{
text
}
create_note_nvt
= element nvt
{
attribute oid { oid }
}
create_note_active
= element active
{
integer
}
create_note_comment
= element comment
{
text
}
create_note_copy
= element copy
{
uuid
}
create_note_hosts
= element hosts
{
text
}
create_note_port
= element port
{
text
}
create_note_result
= element result
{
attribute id { uuid }
}
create_note_severity
= element severity
{
severity
}
create_note_task
= element task
{
attribute id { uuid }
}
create_note_threat
= element threat
{
threat
}
create_note_response
= element create_note_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.10.3 Example: Create a note
Client
<create_note> <text>This issue should be resolved after the upgrade.</text> <nvt oid="1.3.6.1.4.1.25623.1.0.10330"/> <result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result> </create_note> <create_note_response status="202"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.11 Command create_overrideIn short: Create an override. The client uses the create_override command to create a new override. 7.11.1 Structure
7.11.2 RNC
Command
create_override
= element create_override
{
create_override_text
& create_override_nvt
& create_override_active?
& create_override_comment?
& create_override_copy?
& create_override_hosts?
& create_override_new_severity?
& create_override_new_threat?
& create_override_port?
& create_override_result?
& create_override_severity?
& create_override_task?
& create_override_threat?
}
create_override_text
= element text
{
text
}
create_override_active
= element active
{
integer
}
create_override_nvt
= element nvt
{
attribute oid { oid }
}
create_override_comment
= element comment
{
text
}
create_override_copy
= element copy
{
uuid
}
create_override_hosts
= element hosts
{
text
}
create_override_new_severity
= element new_severity
{
severity
}
create_override_new_threat
= element new_threat
{
threat
}
create_override_port
= element port
{
text
}
create_override_result
= element result
{
attribute id { uuid }
}
create_override_severity
= element severity
{
severity
}
create_override_task
= element task
{
attribute id { uuid }
}
create_override_threat
= element threat
{
threat
}
create_override_response
= element create_override_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.11.3 Example: Create an override
Client
<create_override> <text>This is actually of little concern.</text> <nvt oid="1.3.6.1.4.1.25623.1.0.10330"/> <new_threat>Low</new_threat> <result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result> </create_override> <create_override_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.12 Command create_permissionIn short: Create a permission. The client uses the create_permission command to create a new permission. 7.12.1 Structure
7.12.2 RNC
Command
create_permission
= element create_permission
{
create_permission_name
& create_permission_subject
& create_permission_resource?
& create_permission_copy?
& create_permission_comment?
}
create_permission_name
= element name
{
text
}
create_permission_subject
= element subject
{
attribute id { uuid }?
& create_permission_subject_type
}
create_permission_subject_type
= element type
{
text
}
create_permission_resource
= element resource
{
attribute id { uuid }?
& create_permission_resource_type
}
create_permission_resource_type
= element type
{
text
}
create_permission_copy
= element copy
{
uuid
}
create_permission_comment
= element comment
{
text
}
create_permission_response
= element create_permission_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.12.3 Example: Grant a user permission to view a target
Client
<create_permission>
<name>get_target</name>
<resource id="b493b7a8-7489-11df-a3ec-002264764cea"/>
<subject id="66abe5ce-c011-11e3-b96e-406186ea4fc5">
<type>user</type>
</subject>
</create_permission>
<create_permission_response status="201"
status_text="OK, resource created"
id="7ee79232-c011-11e3-b560-406186ea4fc5"/>
7.12.3 Example: Grant a role permission to create users
Client
<create_permission>
<name>create_user</name>
<subject id="9b0cbd98-c011-11e3-a26e-406186ea4fc5">
<type>role</type>
</subject>
</create_permission>
<create_permission_response status="201"
status_text="OK, resource created"
id="b98ad69c-c011-11e3-b001-406186ea4fc5"/>
7.13 Command create_port_listIn short: Create a port list. The client uses the create_port_list command to create a new port list. The get_port_lists_response element overrides the port_range element. 7.13.1 Structure
7.13.2 RNC
Command
create_port_list
= element create_port_list
{
create_port_list_name
& create_port_list_comment?
& create_port_list_copy?
& create_port_list_port_range
& get_port_lists_response
}
create_port_list_name
= element name
{
name
}
create_port_list_comment
= element comment
{
text
}
create_port_list_copy
= element copy
{
uuid
}
create_port_list_port_range
= element port_range
{
text
}
create_port_list_response
= element create_port_list_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.13.3 Example: Create a port list
Client
<create_port_list> <name>All TCP</name> <comment>All possible TCP ports</comment> <port_range>T:1-65535</port_range> </create_port_list> <create_port_list_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.14 Command create_port_rangeIn short: Create a port range. The client uses the create_port_range command to create a new port range. 7.14.1 Structure
7.14.2 RNC
Command
create_port_range
= element create_port_range
{
create_port_range_comment?
& create_port_range_port_list
& create_port_range_start
& create_port_range_end
& create_port_range_type
}
create_port_range_comment
= element comment
{
text
}
create_port_range_port_list
= element port_list
{
attribute id { uuid }
}
create_port_range_start
= element start
{
port
}
create_port_range_end
= element end
{
port
}
create_port_range_type
= element type
{
text
}
create_port_range_response
= element create_port_range_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.14.3 Example: Add a port range to a port list
Client
<create_port_range> <port_list id="354cd3ef-bbe1-4d58-859d-21b8d0c046c4"/> <start>777</start> <end>779</end> <type>TCP</type> </create_port_range> <create_port_range_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.15 Command create_reportIn short: Create a report. The client uses the create_report command to import a report. 7.15.1 Structure
7.15.2 RNC
Command
create_report
= element create_report
{
create_report_report
& create_report_task
& create_report_in_assets?
}
create_report_report
= element report # type report
{
text # RNC limitation: base64
& attribute id { uuid }
& attribute format_id { uuid }
& attribute extension { text }
& attribute content_type { text }
& attribute type { xsd:token { pattern = "scan|assets|prognostic" } }?
& report_owner
& report_name
& report_comment
& report_creation_time
& report_modification_time
& report_writable
& report_in_use
& report_task
& report_report_format
& report_report
}
create_report_task
= element task
{
attribute id { uuid }?
& create_report_task_name?
& create_report_task_comment?
}
create_report_task_name
= element name
{
name
}
create_report_task_comment
= element comment
{
text
}
create_report_in_assets
= element in_assets # type boolean
{
}
create_report_response
= element create_report_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.15.3 Example: Create a report in an existing task
Client
<create_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270"
format_id="d5da9f67-8551-4e51-807b-b6a873d70e34"
extension="xml"
content_type="text/xml">
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<omp>
<version>7.0</version>
</omp>
...
<results start="1"
max="-1">
<result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
...
</result>
...
</results>
<host_start>
2010-02-02T19:11:21+00:00
<host>127.0.1.1</host>
</host_start>
<host_end>
2010-02-02T19:11:52+00:00
<host>127.0.1.1</host>
</host_end>
<scan_end>2010-02-02T19:11:52+00:00</scan_end>
<errors>
<count>0</count>
</errors>
</report>
</report>
<task id="76a4f237-9984-4345-a1f4-71fbcbf0611c"/>
</create_report>
<create_report_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.16 Command create_report_formatIn short: Create a report format. The client uses the create_report_format command to create a new report format. 7.16.1 Structure
7.16.2 RNC
Command
create_report_format
= element create_report_format
{
( create_report_format_copy
| get_report_formats_response )
}
create_report_format_copy
= element copy
{
uuid
}
create_report_format_response
= element create_report_format_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.16.3 Example: Create a report format
Client
<create_report_format>
<get_report_formats_response>
<report_format id="a0704abb-2120-489f-959f-251c9f4ffebd">
<name>CPE</name>
<extension>csv</extension>
<content_type>text/csv</content_type>
<summary>Common Product Enumeration CSV table.</summary>
<description>
CPE stands for Common Product Enumeration. It is a
...
</description>
<predefined>1</predefined>
<trust>
yes
<time>Thu Dec 2 13:22:26 2010</time>
</trust>
<active>1</active>
</report_format>
</get_report_formats_response>
</create_report_format>
<create_report_format_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.17 Command create_roleIn short: Create a role. The client uses the create_role command to create a new role. 7.17.1 Structure
7.17.2 RNC
Command
create_role
= element create_role
{
create_role_name
& create_role_comment?
& create_role_copy?
& create_role_users?
}
create_role_name
= element name
{
name
}
create_role_comment
= element comment
{
text
}
create_role_copy
= element copy
{
uuid
}
create_role_users
= element users
{
text
}
create_role_response
= element create_role_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.17.3 Example: Create a role
Client
<create_role> <name>SCAP Observer</name> <users>sarah, bob</users> </create_role> <create_role_response status="201"
status_text="OK, resource created"
id="b64c81b2-b9de-11e3-a2e9-406186ea4fc5"/>
7.18 Command create_scannerIn short: Create a scanner. The client uses the create_scanner command to create a new scanner. 7.18.1 Structure
7.18.2 RNC
Command
create_scanner
= element create_scanner
{
create_scanner_name
& create_scanner_comment?
& create_scanner_copy?
& create_scanner_host
& create_scanner_port
& create_scanner_type
& create_scanner_ca_pub
& create_scanner_credential
}
create_scanner_name
= element name
{
name
}
create_scanner_comment
= element comment
{
text
}
create_scanner_copy
= element copy
{
uuid
}
create_scanner_host
= element host
{
text
}
create_scanner_port
= element port
{
text
}
create_scanner_type
= element type
{
text
}
create_scanner_ca_pub
= element ca_pub
{
text
}
create_scanner_credential
= element credential
{
attribute id { uuid }
}
create_scanner_response
= element create_scanner_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.18.3 Example: Create a scanner
Client
<create_scanner> <name>Default Scanner</name> <host>localhost</host> <port>9391</port> <type>2</type> <ca_pub>...</ca_pub> <credential id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/> </create_scanner> <create_scanner_response status="201"
status_text="OK, resource created"
id="814cd30f-dee1-4d58-851d-21b8d0c048e3"/>
7.19 Command create_scheduleIn short: Create a schedule. The client uses the create_schedule command to create a new schedule. 7.19.1 Structure
7.19.2 RNC
Command
create_schedule
= element create_schedule
{
create_schedule_name
& create_schedule_comment?
& create_schedule_copy?
& create_schedule_first_time?
& create_schedule_duration?
& create_schedule_period?
& create_schedule_timezone?
}
create_schedule_name
= element name
{
name
}
create_schedule_comment
= element comment
{
text
}
create_schedule_copy
= element copy
{
uuid
}
create_schedule_first_time
= element first_time
{
create_schedule_first_time_minute
& create_schedule_first_time_hour
& create_schedule_first_time_day_of_month
& create_schedule_first_time_month
& create_schedule_first_time_year
}
create_schedule_first_time_minute
= element minute
{
integer
}
create_schedule_first_time_hour
= element hour
{
integer
}
create_schedule_first_time_day_of_month
= element day_of_month
{
integer
}
create_schedule_first_time_month
= element month
{
integer
}
create_schedule_first_time_year
= element year
{
integer
}
create_schedule_duration
= element duration
{
create_schedule_duration_unit
}
create_schedule_duration_unit
= element unit
{
time_unit
}
create_schedule_period
= element period
{
create_schedule_period_unit
}
create_schedule_period_unit
= element unit
{
time_unit
}
create_schedule_timezone
= element timezone
{
timezone
}
create_schedule_response
= element create_schedule_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.19.3 Example: Create a schedule
Client
<create_schedule>
<name>Every night</name>
<first_time>
<day_of_month>1</day_of_month>
<hour>0</hour>
<minute>0</minute>
<month>1</month>
<year>2011</year>
</first_time>
<duration>
3
<unit>hour</unit>
</duration>
<period>
1
<unit>day</unit>
</period>
</create_schedule>
<create_schedule_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.20 Command create_tagIn short: Create a tag. The client uses the create_tag command to create a new tag. A name and the resource type must be provided. If a resource ID is also given, it must refer to an existing resource. 7.20.1 Structure
7.20.2 RNC
Command
create_tag
= element create_tag
{
create_tag_name
& create_tag_resource
& create_tag_copy?
& create_tag_value?
& create_tag_comment?
& create_tag_active?
}
create_tag_name
= element name
{
text
}
create_tag_resource
= element resource
{
attribute id { uuid }?
& create_tag_resource_type
}
create_tag_resource_type
= element type
{
text
}
create_tag_copy
= element copy
{
uuid
}
create_tag_value
= element value
{
text
}
create_tag_comment
= element comment
{
text
}
create_tag_active
= element active
{
boolean
}
create_tag_response
= element create_tag_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.20.3 Example: Create a tag attached to a target
Client
<create_tag>
<name>geo:long</name>
<resource id="b493b7a8-7489-11df-a3ec-002264764cea">
<type>target</type>
</resource>
<value>52.2788</value>
</create_tag>
<create_tag_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.21 Command create_targetIn short: Create a target. The client uses the create_target command to create a new target. If the list of hosts is empty, the command must also include a target locator. 7.21.1 Structure
7.21.2 RNC
Command
create_target
= element create_target
{
create_target_name
& create_target_comment?
& create_target_copy?
& ( create_target_asset_hosts
| create_target_hosts )
& create_target_exclude_hosts?
& create_target_ssh_credential?
& create_target_smb_credential?
& create_target_esxi_credential?
& create_target_snmp_credential?
& create_target_ssh_lsc_credential?
& create_target_smb_lsc_credential?
& create_target_esxi_lsc_credential?
& create_target_alive_tests?
& create_target_reverse_lookup_only?
& create_target_reverse_lookup_unify?
& create_target_port_range?
& create_target_port_list?
}
create_target_name
= element name
{
text # RNC limitation: name
& create_target_name_make_unique
}
create_target_name_make_unique
= element make_unique
{
boolean
}
create_target_comment
= element comment
{
text
}
create_target_copy
= element copy
{
uuid
}
create_target_asset_hosts
= element asset_hosts
{
attribute filter { text }
}
create_target_hosts
= element hosts
{
text
}
create_target_exclude_hosts
= element exclude_hosts
{
text
}
create_target_ssh_credential
= element ssh_credential
{
attribute id { uuid }
& create_target_ssh_credential_port?
}
create_target_ssh_credential_port
= element port
{
text
}
create_target_smb_credential
= element smb_credential
{
attribute id { uuid }
}
create_target_esxi_credential
= element esxi_credential
{
attribute id { uuid }
}
create_target_snmp_credential
= element snmp_credential
{
attribute id { uuid }
}
create_target_ssh_lsc_credential
= element ssh_lsc_credential
{
attribute id { uuid }
& create_target_ssh_lsc_credential_port?
}
create_target_ssh_lsc_credential_port
= element port
{
text
}
create_target_smb_lsc_credential
= element smb_lsc_credential
{
attribute id { uuid }
}
create_target_esxi_lsc_credential
= element esxi_lsc_credential
{
attribute id { uuid }
}
create_target_alive_tests
= element alive_tests
{
alive_test
}
create_target_reverse_lookup_only
= element reverse_lookup_only
{
boolean
}
create_target_reverse_lookup_unify
= element reverse_lookup_unify
{
boolean
}
create_target_port_range
= element port_range
{
text
}
create_target_port_list
= element port_list
{
attribute id { uuid }
}
create_target_response
= element create_target_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.21.3 Example: Create a target, giving a host list
Client
<create_target> <name>All GNU/Linux machines</name> <hosts>192.168.1.0/24</hosts> </create_target> <create_target_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.22 Command create_taskIn short: Create a task. The client uses the create_task command to create a new task. 7.22.1 Structure
7.22.2 RNC
Command
create_task
= element create_task
{
create_task_name
& create_task_comment?
& create_task_copy?
& create_task_alterable?
& create_task_config
& create_task_target
& create_task_hosts_ordering?
& create_task_scanner
& create_task_alert*
& create_task_schedule?
& create_task_schedule_periods?
& create_task_observers?
& create_task_preferences?
}
create_task_name
= element name
{
name
}
create_task_comment
= element comment
{
text
}
create_task_copy
= element copy
{
uuid
}
create_task_alterable
= element alterable
{
boolean
}
create_task_config
= element config
{
attribute id { uuid }
}
create_task_target
= element target
{
attribute id { uuid }
}
create_task_hosts_ordering
= element hosts_ordering
{
text
}
create_task_scanner
= element scanner
{
attribute id { uuid }
}
create_task_alert
= element alert
{
attribute id { uuid }
}
create_task_schedule
= element schedule
{
attribute id { uuid }
}
create_task_schedule_periods
= element schedule_periods
{
integer
}
create_task_observers
= element observers
{
user_list
}
create_task_preferences
= element preferences
{
create_task_preferences_preference*
}
create_task_preferences_preference
= element preference
{
create_task_preferences_preference_scanner_name
& create_task_preferences_preference_value
}
create_task_preferences_preference_scanner_name
= element scanner_name
{
text
}
create_task_preferences_preference_value
= element value
{
text
}
create_task_response
= element create_task_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.22.3 Example: Create a task, giving a host list
Client
<create_task> <name>Scan Webserver</name> <comment>Hourly scan of the webserver</comment> <config id="daba56c8-73ec-11df-a475-002264764cea"/> <target id="b493b7a8-7489-11df-a3ec-002264764cea"/> <scanner id="15348381-3180-213f-4eec-123591912388"/> </create_task> <create_task_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
7.23 Command create_userIn short: Create a user. The client uses the create_user command to create a new user. 7.23.1 Structure
7.23.2 RNC
Command
create_user
= element create_user
{
create_user_name
& create_user_copy?
& create_user_hosts?
& create_user_ifaces?
& create_user_password?
& create_user_role*
}
create_user_name
= element name
{
text
}
create_user_copy
= element copy
{
uuid
}
create_user_hosts
= element hosts
{
text
& attribute allow { boolean }?
}
create_user_ifaces
= element ifaces
{
text
& attribute allow { boolean }?
}
create_user_password
= element password
{
text
}
create_user_role
= element role
{
attribute id { uuid }
}
create_user_response
= element create_user_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
7.23.3 Example: Create a user
Client
<create_user> <name>foobar</name> <password>f00bar</password> <role id="8d453140-b74d-11e2-b0be-406186ea4fc5"/> </create_user> <create_user_response status="201"
status_text="OK, resource created"/>
7.24 Command delete_agentIn short: Delete an agent. The client uses the delete_agent command to delete an existing agent. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.24.1 Structure
7.24.2 RNC
Command
delete_agent
= element delete_agent
{
attribute agent_id { uuid }
& attribute ultimate { boolean }
}
delete_agent_response
= element delete_agent_response
{
attribute status { status }
& attribute status_text { text }
}
7.24.3 Example: Delete an agent
Client
<delete_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_agent_response status="200"
status_text="OK"/>
7.25 Command delete_assetIn short: Delete an asset. The client uses the delete_asset command to delete an existing asset. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.25.1 Structure
7.25.2 RNC
Command
delete_asset
= element delete_asset
{
( attribute asset_id { uuid }
| attribute report_id { uuid } )
}
delete_asset_response
= element delete_asset_response
{
attribute status { status }
& attribute status_text { text }
}
7.25.3 Example: Delete a asset
Client
<delete_asset asset_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_asset_response status="200"
status_text="OK"/>
7.26 Command delete_configIn short: Delete a config. The client uses the delete_config command to delete an existing config. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.26.1 Structure
7.26.2 RNC
Command
delete_config
= element delete_config
{
attribute config_id { uuid }
& attribute ultimate { boolean }
}
delete_config_response
= element delete_config_response
{
attribute status { status }
& attribute status_text { text }
}
7.26.3 Example: Delete a config
Client
<delete_config config_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_config_response status="200"
status_text="OK"/>
7.27 Command delete_alertIn short: Delete an alert. The client uses the delete_alert command to delete an existing alert. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.27.1 Structure
7.27.2 RNC
Command
delete_alert
= element delete_alert
{
attribute alert_id { uuid }
& attribute ultimate { boolean }
}
delete_alert_response
= element delete_alert_response
{
attribute status { status }
& attribute status_text { text }
}
7.27.3 Example: Delete an alert
Client
<delete_alert alert_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_alert_response status="200"
status_text="OK"/>
7.28 Command delete_credentialIn short: Delete a credential. The client uses the delete_credential command to delete an existing credential. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.28.1 Structure
7.28.2 RNC
Command
delete_credential
= element delete_credential
{
attribute credential_id { uuid }
& attribute ultimate { boolean }
}
delete_credential_response
= element delete_credential_response
{
attribute status { status }
& attribute status_text { text }
}
7.28.3 Example: Delete a credential
Client
<delete_credential credential_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_credential_response status="200"
status_text="OK"/>
7.29 Command delete_filterIn short: Delete a filter. The client uses the delete_filter command to delete an existing filter. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.29.1 Structure
7.29.2 RNC
Command
delete_filter
= element delete_filter
{
attribute filter_id { uuid }
& attribute ultimate { boolean }
}
delete_filter_response
= element delete_filter_response
{
attribute status { status }
& attribute status_text { text }
}
7.29.3 Example: Delete a filter
Client
<delete_filter filter_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_filter_response status="200"
status_text="OK"/>
7.30 Command delete_groupIn short: Delete a group. The client uses the delete_group command to delete an existing group. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.30.1 Structure
7.30.2 RNC
Command
delete_group
= element delete_group
{
attribute group_id { uuid }
& attribute ultimate { boolean }
}
delete_group_response
= element delete_group_response
{
attribute status { status }
& attribute status_text { text }
}
7.30.3 Example: Delete a group
Client
<delete_group group_id="d94211b6-ba40-11e3-bcb1-406186ea4fc5"/> <delete_group_response status="200"
status_text="OK"/>
7.31 Command delete_noteIn short: Delete a note. The client uses the delete_note command to delete an existing note. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.31.1 Structure
7.31.2 RNC
Command
delete_note
= element delete_note
{
attribute note_id { uuid }
& attribute ultimate { boolean }
}
delete_note_response
= element delete_note_response
{
attribute status { status }
& attribute status_text { text }
}
7.31.3 Example: Delete a note
Client
<delete_note note_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_note_response status="200"
status_text="OK"/>
7.32 Command delete_overrideIn short: Delete an override. The client uses the delete_override command to delete an existing override. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.32.1 Structure
7.32.2 RNC
Command
delete_override
= element delete_override
{
attribute override_id { uuid }
& attribute ultimate { boolean }
}
delete_override_response
= element delete_override_response
{
attribute status { status }
& attribute status_text { text }
}
7.32.3 Example: Delete an override
Client
<delete_override override_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_override_response status="200"
status_text="OK"/>
7.33 Command delete_reportIn short: Delete a report. The client uses the delete_report command to delete an existing report. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.33.1 Structure7.33.2 RNC
Command
delete_report
= element delete_report
{
attribute report_id { uuid }
}
delete_report_response
= element delete_report_response
{
attribute status { status }
& attribute status_text { text }
}
7.33.3 Example: Delete a report
Client
<delete_report report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_report_response status="200"
status_text="OK"/>
7.34 Command delete_permissionIn short: Delete a permission. The client uses the delete_permission command to delete an existing permission. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.34.1 Structure
7.34.2 RNC
Command
delete_permission
= element delete_permission
{
attribute permission_id { uuid }
& attribute ultimate { boolean }
}
delete_permission_response
= element delete_permission_response
{
attribute status { status }
& attribute status_text { text }
}
7.34.3 Example: Delete a permission
Client
<delete_permission permission_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_permission_response status="200"
status_text="OK"/>
7.35 Command delete_port_listIn short: Delete a port list. The client uses the delete_port_list command to delete an existing port list. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.35.1 Structure
7.35.2 RNC
Command
delete_port_list
= element delete_port_list
{
attribute port_list_id { uuid }
& attribute ultimate { boolean }
}
delete_port_list_response
= element delete_port_list_response
{
attribute status { status }
& attribute status_text { text }
}
7.35.3 Example: Delete a port list
Client
<delete_port_list port_list_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_port_list_response status="200"
status_text="OK"/>
7.36 Command delete_port_rangeIn short: Delete a port range. The client uses the delete_port_range command to delete an existing port range. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.36.1 Structure7.36.2 RNC
Command
delete_port_range
= element delete_port_range
{
attribute port_range_id { uuid }
}
delete_port_range_response
= element delete_port_range_response
{
attribute status { status }
& attribute status_text { text }
}
7.36.3 Example: Delete a port range
Client
<delete_port_range port_range_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_port_range_response status="200"
status_text="OK"/>
7.37 Command delete_report_formatIn short: Delete a report format. The client uses the delete_report_format command to delete an existing report format. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.37.1 Structure
7.37.2 RNC
Command
delete_report_format
= element delete_report_format
{
attribute report_format_id { uuid }
& attribute ultimate { boolean }
}
delete_report_format_response
= element delete_report_format_response
{
attribute status { status }
& attribute status_text { text }
}
7.37.3 Example: Delete a report format
Client
<delete_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_report_format_response status="200"
status_text="OK"/>
7.38 Command delete_roleIn short: Delete a role. The client uses the delete_role command to delete an existing role. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.38.1 Structure
7.38.2 RNC
Command
delete_role
= element delete_role
{
attribute role_id { uuid }
& attribute ultimate { boolean }
}
delete_role_response
= element delete_role_response
{
attribute status { status }
& attribute status_text { text }
}
7.38.3 Example: Delete a role
Client
<delete_role role_id="b64c81b2-b9de-11e3-a2e9-406186ea4fc5"/> <delete_role_response status="200"
status_text="OK"/>
7.39 Command delete_scannerIn short: Delete a scanner. The client uses the delete_scanner command to delete an existing scanner. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.39.1 Structure
7.39.2 RNC
Command
delete_scanner
= element delete_scanner
{
attribute scanner_id { uuid }
& attribute ultimate { boolean }
}
delete_scanner_response
= element delete_scanner_response
{
attribute status { status }
& attribute status_text { text }
}
7.39.3 Example: Delete a scanner
Client
<delete_scanner scanner_id="817a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_scanner_response status="200"
status_text="OK"/>
7.40 Command delete_scheduleIn short: Delete a schedule. The client uses the delete_schedule command to delete an existing schedule. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.40.1 Structure
7.40.2 RNC
Command
delete_schedule
= element delete_schedule
{
attribute schedule_id { uuid }
& attribute ultimate { boolean }
}
delete_schedule_response
= element delete_schedule_response
{
attribute status { status }
& attribute status_text { text }
}
7.40.3 Example: Delete a schedule
Client
<delete_schedule schedule_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_schedule_response status="200"
status_text="OK"/>
7.41 Command delete_tagIn short: Delete a tag. The client uses the delete_tag command to delete an existing tag. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.41.1 Structure
7.41.2 RNC
Command
delete_tag
= element delete_tag
{
attribute tag_id { uuid }
& attribute ultimate { boolean }
}
delete_tag_response
= element delete_tag_response
{
attribute status { status }
& attribute status_text { text }
}
7.41.3 Example: Delete a tag
Client
<delete_tag target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_tag_response status="200"
status_text="OK"/>
7.42 Command delete_targetIn short: Delete a target. The client uses the delete_target command to delete an existing target. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.42.1 Structure
7.42.2 RNC
Command
delete_target
= element delete_target
{
attribute target_id { uuid }
& attribute ultimate { boolean }
}
delete_target_response
= element delete_target_response
{
attribute status { status }
& attribute status_text { text }
}
7.42.3 Example: Delete a target
Client
<delete_target target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_target_response status="200"
status_text="OK"/>
7.43 Command delete_taskIn short: Delete a task. The client uses the delete_task command to delete an existing task, including all reports associated with the task. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Manager. 7.43.1 Structure
7.43.2 RNC
Command
delete_task
= element delete_task
{
attribute task_id { uuid }
& attribute ultimate { boolean }
}
delete_task_response
= element delete_task_response
{
attribute status { status }
& attribute status_text { text }
}
7.43.3 Example: Delete a task
Client
<delete_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <delete_task_response status="200"
status_text="OK"/>
7.44 Command delete_userIn short: Delete a user. The client uses the delete_user command to delete an existing user. Since this is a destructive command, the client is advised to ask for confirmation from the user before sending this command to the Administrator. 7.44.1 Structure
7.44.2 RNC
Command
delete_user
= element delete_user
{
( attribute user_id { uuid }
| attribute name { text } )
& ( attribute inheritor_id { text }
| attribute inheritor_name { text } )
}
delete_user_response
= element delete_user_response
{
attribute status { status }
& attribute status_text { text }
}
7.44.3 Example: Delete a user
Client
<delete_user name="foobar"/> <delete_user_response status="200"
status_text="OK"/>
7.45 Command describe_authIn short: Describe authentication methods. The client uses the "describe_auth" command to get details about the used authentication methods. The Manager will reply with a list of all used authentication methods if such a list is available. 7.45.1 Structure
7.45.2 RNC
Command
describe_auth
= element describe_auth
{
""
}
describe_auth_response
= element describe_auth_response
{
attribute status { status }
& attribute status_text { text }
& describe_auth_response_group
}
describe_auth_response_group
= element group
{
attribute name { text }
& describe_auth_response_group_auth_conf_setting
}
describe_auth_response_group_auth_conf_setting
= element auth_conf_setting
{
describe_auth_response_group_auth_conf_setting_key
& describe_auth_response_group_auth_conf_setting_value
& describe_auth_response_group_auth_conf_setting_certificate_info?
}
describe_auth_response_group_auth_conf_setting_key
= element key
{
text
}
describe_auth_response_group_auth_conf_setting_value
= element value
{
text
}
describe_auth_response_group_auth_conf_setting_certificate_info
= element certificate_info # type certificate_info
{
certificate_info_time_status
& certificate_info_activation_time
& certificate_info_expiration_time
& certificate_info_issuer
& certificate_info_md5_fingerprint
}
7.45.3 Example: Describe the authentication methods
Client
<describe_auth/> <describe_auth_response status="200"
status_text="OK">
<group name="Foo">
<auth_conf_setting>
<key>Bar</key>
<value>Baz</value>
</auth_conf_setting>
</group>
</describe_auth_response>
7.46 Command empty_trashcanIn short: Empty the trashcan. The client uses the empty_trashcan command to empty the trashcan. 7.46.1 Structure
7.46.2 RNC
Command
empty_trashcan
= element empty_trashcan
{
""
}
empty_trashcan_response
= element empty_trashcan_response
{
attribute status { status }
& attribute status_text { text }
}
7.46.3 Example: Empty the trashcan
Client
<empty_trashcan/> <empty_trashcan_response status="200"
status_text="OK"/>
7.47 Command get_agentsIn short: Get one or many agents. The client uses the get_agents command to get agent information. If the command sent by the client was valid, the manager will reply with a list of agents to the client. If the request includes a format then the agents in the response include installer elements, otherwise they include trust state and time. If the details attribute is set, the response will include the installer. 7.47.1 Structure
7.47.2 RNC
Command
get_agents
= element get_agents
{
attribute agent_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute details { boolean }?
& attribute format { xsd:token { pattern = "installer|howto_install|howto_use" } }?
}
get_agents_response
= element get_agents_response
{
attribute status { status }
& attribute status_text { text }
& get_agents_response_agent*
& get_agents_response_filters
& get_agents_response_sort
& get_agents_response_agents
& get_agents_response_agent_count
}
get_agents_response_agent
= element agent
{
attribute id { uuid }
& get_agents_response_agent_owner
& get_agents_response_agent_name
& get_agents_response_agent_comment
& get_agents_response_agent_creation_time
& get_agents_response_agent_modification_time
& get_agents_response_agent_in_use
& get_agents_response_agent_writable
& get_agents_response_agent_permissions
& get_agents_response_agent_user_tags
& ( get_agents_response_agent_installer
| get_agents_response_agent_package )
}
get_agents_response_agent_owner
= element owner
{
get_agents_response_agent_owner_name
}
get_agents_response_agent_owner_name
= element name
{
name
}
get_agents_response_agent_name
= element name
{
name
}
get_agents_response_agent_comment
= element comment
{
text
}
get_agents_response_agent_creation_time
= element creation_time
{
iso_time
}
get_agents_response_agent_modification_time
= element modification_time
{
iso_time
}
get_agents_response_agent_in_use
= element in_use
{
boolean
}
get_agents_response_agent_writable
= element writable
{
boolean
}
get_agents_response_agent_permissions
= element permissions
{
get_agents_response_agent_permissions_permission*
}
get_agents_response_agent_permissions_permission
= element permission
{
get_agents_response_agent_permissions_permission_name
}
get_agents_response_agent_permissions_permission_name
= element name
{
name
}
get_agents_response_agent_user_tags
= element user_tags
{
get_agents_response_agent_user_tags_count
& get_agents_response_agent_user_tags_tag*
}
get_agents_response_agent_user_tags_count
= element count
{
integer
}
get_agents_response_agent_user_tags_tag
= element tag
{
attribute id { uuid }
& get_agents_response_agent_user_tags_tag_name
& get_agents_response_agent_user_tags_tag_value
& get_agents_response_agent_user_tags_tag_comment
}
get_agents_response_agent_user_tags_tag_name
= element name
{
text
}
get_agents_response_agent_user_tags_tag_value
= element value
{
text
}
get_agents_response_agent_user_tags_tag_comment
= element comment
{
text
}
get_agents_response_agent_installer
= element installer
{
get_agents_response_agent_installer_trust
}
get_agents_response_agent_installer_trust
= element trust
{
text # RNC limitation: xsd:token { pattern = "yes|no|unknown" }
& get_agents_response_agent_installer_trust_time
}
get_agents_response_agent_installer_trust_time
= element time
{
iso_time
}
get_agents_response_agent_package
= element package
{
text # RNC limitation: base64
& get_agents_response_agent_package_filename
}
get_agents_response_agent_package_filename
= element filename
{
text
}
get_agents_response_filters
= element filters
{
attribute id { uuid }
& get_agents_response_filters_term
& get_agents_response_filters_name?
& get_agents_response_filters_keywords
}
get_agents_response_filters_term
= element term
{
text
}
get_agents_response_filters_name
= element name
{
text
}
get_agents_response_filters_keywords
= element keywords
{
get_agents_response_filters_keywords_keyword*
}
get_agents_response_filters_keywords_keyword
= element keyword
{
get_agents_response_filters_keywords_keyword_column
& get_agents_response_filters_keywords_keyword_relation
& get_agents_response_filters_keywords_keyword_value
}
get_agents_response_filters_keywords_keyword_column
= element column
{
text
}
get_agents_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_agents_response_filters_keywords_keyword_value
= element value
{
text
}
get_agents_response_sort
= element sort
{
text
& get_agents_response_sort_field
}
get_agents_response_sort_field
= element field
{
get_agents_response_sort_field_order
}
get_agents_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_agents_response_agents
= element agents
{
attribute start { integer }
& attribute max { integer }
}
get_agents_response_agent_count
= element agent_count
{
get_agents_response_agent_count_filtered
& get_agents_response_agent_count_page
}
get_agents_response_agent_count_filtered
= element filtered
{
integer
}
get_agents_response_agent_count_page
= element page
{
integer
}
7.47.3 Example: Get one or many agents
Client
<get_agents/> <get_agents_response status="200"
status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
<creation_time>2012-01-23T10:44:00+01:00</creation_time>
<modification_time>2013-01-23T10:44:00+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<installer>
<trust>
yes
<time>Wed Jun 30 21:49:08 2012</time>
</trust>
</installer>
</agent>
...
</get_agents_response>
7.47.3 Example: Get one agent
Client
<get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/> <get_agents_response status="200"
status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
<creation_time>2012-01-23T10:44:00+01:00</creation_time>
<modification_time>2013-01-23T10:44:00+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<installer>
<trust>
yes
<time>Wed Jun 30 21:49:08 2012</time>
</trust>
</installer>
</agent>
</get_agents_response>
7.47.3 Example: Get one agent, including the installer package
Client
<get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
format="installer"/>
<get_agents_response status="200"
status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
<creation_time>2012-01-23T10:44:00+01:00</creation_time>
<modification_time>2013-01-23T10:44:00+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<package format="installer">
CgoKCgoKCgoKCgoKCSAgI...
<filename>agent.deb</filename>
</package>
</agent>
</get_agents_response>
7.48 Command get_configsIn short: Get one or many configs. The client uses the get_configs command to get config information. If the command sent by the client was valid, the manager will reply with a list of configs to the client. 7.48.1 Structure
7.48.2 RNC
Command
get_configs
= element get_configs
{
attribute config_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute details { boolean }?
& attribute families { boolean }?
& attribute preferences { boolean }?
& attribute tasks { boolean }?
}
get_configs_response
= element get_configs_response
{
attribute status { status }
& attribute status_text { text }
& get_configs_response_config*
& get_configs_response_filters
& get_configs_response_sort
& get_configs_response_configs
& get_configs_response_config_count
}
get_configs_response_config
= element config
{
attribute id { uuid }
& get_configs_response_config_owner
& get_configs_response_config_name
& get_configs_response_config_comment
& get_configs_response_config_creation_time
& get_configs_response_config_modification_time
& get_configs_response_config_family_count
& get_configs_response_config_nvt_count
& get_configs_response_config_type
& get_configs_response_config_max_nvt_count
& get_configs_response_config_known_nvt_count
& get_configs_response_config_in_use
& get_configs_response_config_writable
& get_configs_response_config_permissions
& get_configs_response_config_user_tags
& get_configs_response_config_tasks
& get_configs_response_config_families?
& get_configs_response_config_preferences?
& get_configs_response_config_nvt_selectors?
}
get_configs_response_config_owner
= element owner
{
get_configs_response_config_owner_name
}
get_configs_response_config_owner_name
= element name
{
name
}
get_configs_response_config_name
= element name
{
name
}
get_configs_response_config_comment
= element comment
{
text
}
get_configs_response_config_creation_time
= element creation_time
{
iso_time
}
get_configs_response_config_modification_time
= element modification_time
{
iso_time
}
get_configs_response_config_family_count
= element family_count
{
text # RNC limitation: integer
& get_configs_response_config_family_count_growing
}
get_configs_response_config_family_count_growing
= element growing
{
boolean
}
get_configs_response_config_nvt_count
= element nvt_count
{
text # RNC limitation: integer
& get_configs_response_config_nvt_count_growing
}
get_configs_response_config_nvt_count_growing
= element growing
{
boolean
}
get_configs_response_config_type
= element type
{
text
}
get_configs_response_config_max_nvt_count
= element max_nvt_count
{
integer
}
get_configs_response_config_known_nvt_count
= element known_nvt_count
{
integer
}
get_configs_response_config_in_use
= element in_use
{
boolean
}
get_configs_response_config_writable
= element writable
{
boolean
}
get_configs_response_config_permissions
= element permissions
{
get_configs_response_config_permissions_permission*
}
get_configs_response_config_permissions_permission
= element permission
{
get_configs_response_config_permissions_permission_name
}
get_configs_response_config_permissions_permission_name
= element name
{
name
}
get_configs_response_config_user_tags
= element user_tags
{
get_configs_response_config_user_tags_count
& get_configs_response_config_user_tags_tag*
}
get_configs_response_config_user_tags_count
= element count
{
integer
}
get_configs_response_config_user_tags_tag
= element tag
{
attribute id { uuid }
& get_configs_response_config_user_tags_tag_name
& get_configs_response_config_user_tags_tag_value
& get_configs_response_config_user_tags_tag_comment
}
get_configs_response_config_user_tags_tag_name
= element name
{
text
}
get_configs_response_config_user_tags_tag_value
= element value
{
text
}
get_configs_response_config_user_tags_tag_comment
= element comment
{
text
}
get_configs_response_config_tasks
= element tasks
{
get_configs_response_config_tasks_task*
}
get_configs_response_config_tasks_task
= element task
{
attribute id { uuid }
& get_configs_response_config_tasks_task_name
& get_configs_response_config_tasks_task_permissions?
}
get_configs_response_config_tasks_task_name
= element name
{
name
}
get_configs_response_config_tasks_task_permissions
= element permissions
{
""
}
get_configs_response_config_families
= element families
{
get_configs_response_config_families_family*
}
get_configs_response_config_families_family
= element family
{
get_configs_response_config_families_family_name
& get_configs_response_config_families_family_nvt_count
& get_configs_response_config_families_family_max_nvt_count
& get_configs_response_config_families_family_growing
}
get_configs_response_config_families_family_name
= element name
{
name
}
get_configs_response_config_families_family_type
= element type
{
integer
}
get_configs_response_config_families_family_nvt_count
= element nvt_count
{
integer
}
get_configs_response_config_families_family_max_nvt_count
= element max_nvt_count
{
integer
}
get_configs_response_config_families_family_growing
= element growing
{
boolean
}
get_configs_response_config_preferences
= element preferences
{
get_configs_response_config_preferences_preference*
}
get_configs_response_config_preferences_preference
= element preference
{
get_configs_response_config_preferences_preference_nvt
& get_configs_response_config_preferences_preference_hr_name
& get_configs_response_config_preferences_preference_name
& get_configs_response_config_preferences_preference_type
& get_configs_response_config_preferences_preference_value
& get_configs_response_config_preferences_preference_default
& get_configs_response_config_preferences_preference_alt*
}
get_configs_response_config_preferences_preference_nvt
= element nvt
{
attribute oid { oid }
& get_configs_response_config_preferences_preference_nvt_name
}
get_configs_response_config_preferences_preference_nvt_name
= element name
{
name
}
get_configs_response_config_preferences_preference_hr_name
= element hr_name
{
name
}
get_configs_response_config_preferences_preference_name
= element name
{
name
}
get_configs_response_config_preferences_preference_type
= element type
{
text
}
get_configs_response_config_preferences_preference_value
= element value
{
text
}
get_configs_response_config_preferences_preference_default
= element default
{
text
}
get_configs_response_config_preferences_preference_alt
= element alt
{
text
}
get_configs_response_config_nvt_selectors
= element nvt_selectors
{
get_configs_response_config_nvt_selectors_nvt_selector*
}
get_configs_response_config_nvt_selectors_nvt_selector
= element nvt_selector
{
get_configs_response_config_nvt_selectors_nvt_selector_name
& get_configs_response_config_nvt_selectors_nvt_selector_include
& get_configs_response_config_nvt_selectors_nvt_selector_type
& get_configs_response_config_nvt_selectors_nvt_selector_family_or_nvt
}
get_configs_response_config_nvt_selectors_nvt_selector_name
= element name
{
text
}
get_configs_response_config_nvt_selectors_nvt_selector_include
= element include
{
boolean
}
get_configs_response_config_nvt_selectors_nvt_selector_type
= element type
{
integer
}
get_configs_response_config_nvt_selectors_nvt_selector_family_or_nvt
= element family_or_nvt
{
text
}
get_configs_response_filters
= element filters
{
attribute id { uuid }
& get_configs_response_filters_term
& get_configs_response_filters_name?
& get_configs_response_filters_keywords
}
get_configs_response_filters_term
= element term
{
text
}
get_configs_response_filters_name
= element name
{
text
}
get_configs_response_filters_keywords
= element keywords
{
get_configs_response_filters_keywords_keyword*
}
get_configs_response_filters_keywords_keyword
= element keyword
{
get_configs_response_filters_keywords_keyword_column
& get_configs_response_filters_keywords_keyword_relation
& get_configs_response_filters_keywords_keyword_value
}
get_configs_response_filters_keywords_keyword_column
= element column
{
text
}
get_configs_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_configs_response_filters_keywords_keyword_value
= element value
{
text
}
get_configs_response_sort
= element sort
{
text
& get_configs_response_sort_field
}
get_configs_response_sort_field
= element field
{
get_configs_response_sort_field_order
}
get_configs_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_configs_response_configs
= element configs
{
attribute start { integer }
& attribute max { integer }
}
get_configs_response_config_count
= element config_count
{
get_configs_response_config_count_filtered
& get_configs_response_config_count_page
}
get_configs_response_config_count_filtered
= element filtered
{
integer
}
get_configs_response_config_count_page
= element page
{
integer
}
7.48.3 Example: Get one or many configs
Client
<get_configs/> <get_configs_response status="200"
status_text="OK">
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
<comment>
All NVT's; optimized by using previously collected information.
</comment>
<creation_time>2012-11-23T10:44:00+01:00</creation_time>
<modification_time>2013-01-23T10:44:00+01:00</modification_time>
<family_count>
4
<growing>1</growing>
</family_count>
<nvt_count>
12
<growing>1</growing>
</nvt_count>
<in_use>1</in_use>
<writable>0</writable>
<user_tags>
<count>0</count>
</user_tags>
</config>
...
</get_configs_response>
7.48.3 Example: Get a single config, including preference, family lists and tasks using this config
Client
<get_configs config_id="daba56c8-73ec-11df-a475-002264764cea"
preferences="1"
families="1"
tasks="1"/>
<get_configs_response status="200"
status_text="OK">
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
<comment>
All NVT's; optimized by using previously collected information.
</comment>
<family_count>
4
<growing>1</growing>
</family_count>
<nvt_count>
12
<growing>1</growing>
</nvt_count>
<in_use>1</in_use>
<user_tags>
<count>0</count>
</user_tags>
<tasks>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>Web Servers</name>
</task>
...
</tasks>
<families>
<family>
<name>Credentials</name>
<nvt_count>8</nvt_count>
<max_nvt_count>8</max_nvt_count>
<growing>1</growing>
</family>
...
</families>
<preferences>
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
</preference>
...
</preferences>
</config>
...
</get_configs_response>
7.49 Command get_aggregatesIn short: Get aggregates of various resources. The client uses the get_aggregate command to get aggregated data like counts or averages of various resources. Unlike other get_... commands, get_aggregates ignores the filter keywords "first" and "rows". It also does not support selecting single items by id or getting items from the trashcan. 7.49.1 Structure
7.49.2 RNC
Command
get_aggregates
= element get_aggregates
{
attribute filter { text }?
& attribute filt_id { uuid }?
& attribute type { text }
& attribute data_column { text }?
& attribute group_column { text }?
& attribute subgroup_column { text }?
& attribute sort_field { text }?
& attribute sort_order { xsd:token { pattern = "ascending|descending" } }?
& attribute sort_stat { xsd:token { pattern = "min|max|mean|sum|count|value" } }?
& attribute first_group { integer }?
& attribute max_groups { integer }?
& attribute mode { xsd:token { pattern = "|word_counts" } }?
& get_aggregates_sort*
& get_aggregates_data_column*
& get_aggregates_text_column*
}
get_aggregates_sort
= element sort
{
attribute sort_field { text }?
& attribute sort_order { xsd:token { pattern = "ascending|descending" } }?
& attribute sort_stat { xsd:token { pattern = "min|max|mean|sum|count|value" } }?
}
get_aggregates_data_column
= element data_column # type text
{
}
get_aggregates_text_column
= element text_column # type text
{
}
get_aggregates_response
= element get_aggregates_response
{
attribute status { status }
& attribute status_text { text }
& get_aggregates_response_aggregate*
& get_aggregates_response_filters
}
get_aggregates_response_aggregate
= element aggregate
{
get_aggregates_response_aggregate_data_type
& get_aggregates_response_aggregate_data_column*
& get_aggregates_response_aggregate_group_column?
& get_aggregates_response_aggregate_text_column*
& ( get_aggregates_response_aggregate_group*
| get_aggregates_response_aggregate_overall )
& get_aggregates_response_aggregate_subgroups?
& get_aggregates_response_aggregate_column_info
}
get_aggregates_response_aggregate_data_type
= element data_type
{
text
}
get_aggregates_response_aggregate_data_column
= element data_column
{
text
}
get_aggregates_response_aggregate_group_column
= element group_column
{
text
}
get_aggregates_response_aggregate_text_column
= element text_column
{
text
}
get_aggregates_response_aggregate_group
= element group
{
get_aggregates_response_aggregate_group_value
& get_aggregates_response_aggregate_group_subgroup*
& get_aggregates_response_aggregate_group_count
& get_aggregates_response_aggregate_group_c_count
& get_aggregates_response_aggregate_group_stats*
& get_aggregates_response_aggregate_group_text*
}
get_aggregates_response_aggregate_group_value
= element value
{
text
}
get_aggregates_response_aggregate_group_subgroup
= element subgroup
{
get_aggregates_response_aggregate_group_subgroup_value
& get_aggregates_response_aggregate_group_subgroup_count
& get_aggregates_response_aggregate_group_subgroup_c_count
& get_aggregates_response_aggregate_group_subgroup_stats*
}
get_aggregates_response_aggregate_group_subgroup_value
= element value
{
text
}
get_aggregates_response_aggregate_group_subgroup_count
= element count
{
integer
}
get_aggregates_response_aggregate_group_subgroup_c_count
= element c_count
{
integer
}
get_aggregates_response_aggregate_group_subgroup_stats
= element stats
{
attribute column { text }?
& get_aggregates_response_aggregate_group_subgroup_stats_min
& get_aggregates_response_aggregate_group_subgroup_stats_max
& get_aggregates_response_aggregate_group_subgroup_stats_mean
& get_aggregates_response_aggregate_group_subgroup_stats_sum
& get_aggregates_response_aggregate_group_subgroup_stats_c_sum
}
get_aggregates_response_aggregate_group_subgroup_stats_min
= element min
{
text
}
get_aggregates_response_aggregate_group_subgroup_stats_max
= element max
{
text
}
get_aggregates_response_aggregate_group_subgroup_stats_mean
= element mean
{
text
}
get_aggregates_response_aggregate_group_subgroup_stats_sum
= element sum
{
text
}
get_aggregates_response_aggregate_group_subgroup_stats_c_sum
= element c_sum
{
text
}
get_aggregates_response_aggregate_group_count
= element count
{
integer
}
get_aggregates_response_aggregate_group_c_count
= element c_count
{
integer
}
get_aggregates_response_aggregate_group_text
= element text
{
text
& attribute name { text }?
}
get_aggregates_response_aggregate_group_stats
= element stats
{
attribute column { text }?
& get_aggregates_response_aggregate_group_stats_min
& get_aggregates_response_aggregate_group_stats_max
& get_aggregates_response_aggregate_group_stats_mean
& get_aggregates_response_aggregate_group_stats_sum
& get_aggregates_response_aggregate_group_stats_c_sum
}
get_aggregates_response_aggregate_group_stats_min
= element min
{
text
}
get_aggregates_response_aggregate_group_stats_max
= element max
{
text
}
get_aggregates_response_aggregate_group_stats_mean
= element mean
{
text
}
get_aggregates_response_aggregate_group_stats_sum
= element sum
{
text
}
get_aggregates_response_aggregate_group_stats_c_sum
= element c_sum
{
text
}
get_aggregates_response_aggregate_overall
= element overall
{
get_aggregates_response_aggregate_overall_count
& get_aggregates_response_aggregate_overall_min
& get_aggregates_response_aggregate_overall_max
& get_aggregates_response_aggregate_overall_mean
& get_aggregates_response_aggregate_overall_sum
}
get_aggregates_response_aggregate_overall_count
= element count
{
integer
}
get_aggregates_response_aggregate_overall_min
= element min
{
text
}
get_aggregates_response_aggregate_overall_max
= element max
{
text
}
get_aggregates_response_aggregate_overall_mean
= element mean
{
text
}
get_aggregates_response_aggregate_overall_sum
= element sum
{
text
}
get_aggregates_response_aggregate_subgroups
= element subgroups
{
get_aggregates_response_aggregate_subgroups_value*
}
get_aggregates_response_aggregate_subgroups_value
= element value
{
text
}
get_aggregates_response_aggregate_column_info
= element column_info
{
get_aggregates_response_aggregate_column_info_aggregate_column*
}
get_aggregates_response_aggregate_column_info_aggregate_column
= element aggregate_column
{
get_aggregates_response_aggregate_column_info_aggregate_column_name
& get_aggregates_response_aggregate_column_info_aggregate_column_stat
& get_aggregates_response_aggregate_column_info_aggregate_column_type
& get_aggregates_response_aggregate_column_info_aggregate_column_column
& get_aggregates_response_aggregate_column_info_aggregate_column_data_type
}
get_aggregates_response_aggregate_column_info_aggregate_column_name
= element name
{
text
}
get_aggregates_response_aggregate_column_info_aggregate_column_stat
= element stat
{
text
}
get_aggregates_response_aggregate_column_info_aggregate_column_type
= element type
{
text
}
get_aggregates_response_aggregate_column_info_aggregate_column_column
= element column
{
text
}
get_aggregates_response_aggregate_column_info_aggregate_column_data_type
= element data_type
{
text
}
get_aggregates_response_filters
= element filters
{
attribute id { uuid }
& get_aggregates_response_filters_term
& get_aggregates_response_filters_name?
& get_aggregates_response_filters_keywords
}
get_aggregates_response_filters_term
= element term
{
text
}
get_aggregates_response_filters_name
= element name
{
text
}
get_aggregates_response_filters_keywords
= element keywords
{
get_aggregates_response_filters_keywords_keyword*
}
get_aggregates_response_filters_keywords_keyword
= element keyword
{
get_aggregates_response_filters_keywords_keyword_column
& get_aggregates_response_filters_keywords_keyword_relation
& get_aggregates_response_filters_keywords_keyword_value
}
get_aggregates_response_filters_keywords_keyword_column
= element column
{
text
}
get_aggregates_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_aggregates_response_filters_keywords_keyword_value
= element value
{
text
}
7.49.3 Example: Get severity statistics of NVTs by family
Client
<get_aggregates type="nvt"
group_column="family"
data_column="severity"/>
<get_aggregates_response status_text="OK"
status="200">
<aggregate>
<data_type>nvt</data_type>
<data_column>severity</data_column>
<group_column>family</group_column>
<group>
<value>AIX Local Security Checks</value>
<count>1</count>
<c_count>1</c_count>
<min>3.3</min>
<max>3.3</max>
<mean>3.3</mean>
<sum>3.3</sum>
<c_sum>3.3</c_sum>
</group>
<group>
<value>Brute force attacks</value>
<count>8</count>
<c_count>9</c_count>
<min>0</min>
<max>7.8</max>
<mean>6.275</mean>
<sum>50.2</sum>
<c_sum>53.5</c_sum>
</group>
<group>
<value>Buffer overflow</value>
<count>519</count>
<c_count>528</c_count>
<min>10</min>
<max>9.7</max>
<mean>8.63083</mean>
<sum>4479.4</sum>
<c_sum>4532.9</c_sum>
</group>
...
<column_info>
<aggregate_column>
<name>value</name>
<stat>value</stat>
<type>nvt</type>
<column>family</column>
<data_type>text</data_type>
</aggregate_column>
<aggregate_column>
<name>count</name>
<stat>count</stat>
<type>nvt</type>
<column/>
<data_type>integer</data_type>
</aggregate_column>
<aggregate_column>
<name>c_count</name>
<stat>c_count</stat>
<type>nvt</type>
<column/>
<data_type>integer</data_type>
</aggregate_column>
<aggregate_column>
<name>min</name>
<stat>min</stat>
<type>nvt</type>
<column>severity</column>
<data_type>cvss</data_type>
</aggregate_column>
...
</column_info>
</aggregate>
<filters id="">
<term>first=1 rows=-1 sort=name</term>
<keywords>
<keyword>
<column>first</column>
<relation>=</relation>
<value>1</value>
</keyword>
<keyword>
<column>rows</column>
<relation>=</relation>
<value>-1</value>
</keyword>
<keyword>
<column>sort</column>
<relation>=</relation>
<value>name</value>
</keyword>
</keywords>
</filters>
</get_aggregates_response>
7.50 Command get_alertsIn short: Get one or many alerts. The client uses the get_alerts command to get alert information. If the command sent by the client was valid, the manager will reply with a list of alerts to the client. 7.50.1 Structure
7.50.2 RNC
Command
get_alerts
= element get_alerts
{
attribute alert_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute tasks { boolean }?
}
get_alerts_response
= element get_alerts_response
{
attribute status { status }
& attribute status_text { text }
& get_alerts_response_alert*
& get_alerts_response_filters
& get_alerts_response_sort
& get_alerts_response_alerts
& get_alerts_response_alert_count
}
get_alerts_response_alert
= element alert
{
attribute id { uuid }
& get_alerts_response_alert_owner
& get_alerts_response_alert_name
& get_alerts_response_alert_comment
& get_alerts_response_alert_creation_time
& get_alerts_response_alert_modification_time
& get_alerts_response_alert_in_use
& get_alerts_response_alert_writable
& get_alerts_response_alert_permissions
& get_alerts_response_alert_user_tags
& get_alerts_response_alert_condition
& get_alerts_response_alert_event
& get_alerts_response_alert_method
& get_alerts_response_alert_filter
& get_alerts_response_alert_tasks?
}
get_alerts_response_alert_owner
= element owner
{
get_alerts_response_alert_owner_name
}
get_alerts_response_alert_owner_name
= element name
{
name
}
get_alerts_response_alert_name
= element name
{
name
}
get_alerts_response_alert_comment
= element comment
{
text
}
get_alerts_response_alert_in_use
= element in_use
{
boolean
}
get_alerts_response_alert_writable
= element writable
{
boolean
}
get_alerts_response_alert_creation_time
= element creation_time
{
iso_time
}
get_alerts_response_alert_modification_time
= element modification_time
{
iso_time
}
get_alerts_response_alert_permissions
= element permissions
{
get_alerts_response_alert_permissions_permission*
}
get_alerts_response_alert_permissions_permission
= element permission
{
get_alerts_response_alert_permissions_permission_name
}
get_alerts_response_alert_permissions_permission_name
= element name
{
name
}
get_alerts_response_alert_user_tags
= element user_tags
{
get_alerts_response_alert_user_tags_count
& get_alerts_response_alert_user_tags_tag*
}
get_alerts_response_alert_user_tags_count
= element count
{
integer
}
get_alerts_response_alert_user_tags_tag
= element tag
{
attribute id { uuid }
& get_alerts_response_alert_user_tags_tag_name
& get_alerts_response_alert_user_tags_tag_value
& get_alerts_response_alert_user_tags_tag_comment
}
get_alerts_response_alert_user_tags_tag_name
= element name
{
text
}
get_alerts_response_alert_user_tags_tag_value
= element value
{
text
}
get_alerts_response_alert_user_tags_tag_comment
= element comment
{
text
}
get_alerts_response_alert_condition
= element condition
{
text
& get_alerts_response_alert_condition_data*
}
get_alerts_response_alert_condition_data
= element data
{
text
& get_alerts_response_alert_condition_data_name
}
get_alerts_response_alert_condition_data_name
= element name
{
text
}
get_alerts_response_alert_event
= element event
{
text
& get_alerts_response_alert_event_data*
}
get_alerts_response_alert_event_data
= element data
{
text
& get_alerts_response_alert_event_data_name
}
get_alerts_response_alert_event_data_name
= element name
{
text
}
get_alerts_response_alert_method
= element method
{
text
& get_alerts_response_alert_method_data*
}
get_alerts_response_alert_method_data
= element data
{
text
& get_alerts_response_alert_method_data_name
& get_alerts_response_alert_method_data_credential?
}
get_alerts_response_alert_method_data_name
= element name
{
text
}
get_alerts_response_alert_method_data_credential
= element credential
{
attribute id { uuid }?
& get_alerts_response_alert_method_data_credential_name
& get_alerts_response_alert_method_data_credential_login
}
get_alerts_response_alert_method_data_credential_name
= element name
{
name
}
get_alerts_response_alert_method_data_credential_login
= element login
{
name
}
get_alerts_response_alert_filter
= element filter
{
attribute id { uuid }?
& get_alerts_response_alert_filter_name
& get_alerts_response_alert_filter_permissions?
& get_alerts_response_alert_filter_trash
}
get_alerts_response_alert_filter_name
= element name
{
name
}
get_alerts_response_alert_filter_permissions
= element permissions
{
""
}
get_alerts_response_alert_filter_trash
= element trash
{
boolean
}
get_alerts_response_alert_tasks
= element tasks
{
get_alerts_response_alert_tasks_task*
}
get_alerts_response_alert_tasks_task
= element task
{
attribute id { uuid }
& get_alerts_response_alert_tasks_task_name
& get_alerts_response_alert_tasks_task_permissions?
}
get_alerts_response_alert_tasks_task_name
= element name
{
name
}
get_alerts_response_alert_tasks_task_permissions
= element permissions
{
""
}
get_alerts_response_filters
= element filters
{
attribute id { uuid }
& get_alerts_response_filters_term
& get_alerts_response_filters_name?
& get_alerts_response_filters_keywords
}
get_alerts_response_filters_term
= element term
{
text
}
get_alerts_response_filters_name
= element name
{
text
}
get_alerts_response_filters_keywords
= element keywords
{
get_alerts_response_filters_keywords_keyword*
}
get_alerts_response_filters_keywords_keyword
= element keyword
{
get_alerts_response_filters_keywords_keyword_column
& get_alerts_response_filters_keywords_keyword_relation
& get_alerts_response_filters_keywords_keyword_value
}
get_alerts_response_filters_keywords_keyword_column
= element column
{
text
}
get_alerts_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_alerts_response_filters_keywords_keyword_value
= element value
{
text
}
get_alerts_response_sort
= element sort
{
text
& get_alerts_response_sort_field
}
get_alerts_response_sort_field
= element field
{
get_alerts_response_sort_field_order
}
get_alerts_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_alerts_response_alerts
= element alerts
{
attribute start { integer }
& attribute max { integer }
}
get_alerts_response_alert_count
= element alert_count
{
get_alerts_response_alert_count_filtered
& get_alerts_response_alert_count_page
}
get_alerts_response_alert_count_filtered
= element filtered
{
integer
}
get_alerts_response_alert_count_page
= element page
{
integer
}
7.50.3 Example: Get the alerts
Client
<get_alerts/> <get_alerts_response status="200"
status_text="OK">
<alert id="6181e65d-8ba0-4937-9c44-8f2b10b0def7">
<name>Team alert</name>
<comment/>
<creation_time>2012-04-27T12:44:00+01:00</creation_time>
<modification_time>2012-08-28T12:14:00+01:00</modification_time>
<writable>1</writable>
<in_use>1</in_use>
<user_tags>
<count>0</count>
</user_tags>
<condition>
Threat level at least
<data>
High
<name>level</name>
</data>
</condition>
<event>
Task run status changed
<data>
Done
<name>status</name>
</data>
</event>
<method>
Email
<data>
team@example.org
<name>to_address</name>
</data>
<data>
admin@example.org
<name>from_address</name>
</data>
<data>
0
<name>notice</name>
</data>
</method>
</alert>
...
</get_alerts_response>
7.51 Command get_assetsIn short: Get one or many assets. The client uses the get_assets command to get asset information. 7.51.1 Structure
7.51.2 RNC
Command
get_assets
= element get_assets
{
attribute asset_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute ignore_pagination { boolean }?
}
get_assets_response
= element get_assets_response
{
attribute status { status }
& attribute status_text { text }
& get_assets_response_asset*
& get_assets_response_filters
& get_assets_response_sort
& get_assets_response_assets
& get_assets_response_asset_count
}
get_assets_response_asset
= element asset
{
attribute id { uuid }
& get_assets_response_asset_owner
& get_assets_response_asset_name
& get_assets_response_asset_comment
& get_assets_response_asset_creation_time
& get_assets_response_asset_modification_time
& get_assets_response_asset_writable
& get_assets_response_asset_in_use
& get_assets_response_asset_permissions
& get_assets_response_asset_user_tags
& get_assets_response_asset_identifiers?
& ( get_assets_response_asset_host
| get_assets_response_asset_os )
}
get_assets_response_asset_owner
= element owner
{
get_assets_response_asset_owner_name
}
get_assets_response_asset_owner_name
= element name
{
name
}
get_assets_response_asset_name
= element name
{
name
}
get_assets_response_asset_comment
= element comment
{
text
}
get_assets_response_asset_creation_time
= element creation_time
{
iso_time
}
get_assets_response_asset_modification_time
= element modification_time
{
iso_time
}
get_assets_response_asset_identifiers
= element identifiers
{
get_assets_response_asset_identifiers_identifier
}
get_assets_response_asset_identifiers_identifier
= element identifier
{
get_assets_response_asset_identifiers_identifier_name
& get_assets_response_asset_identifiers_identifier_value
& get_assets_response_asset_identifiers_identifier_creation_time
& get_assets_response_asset_identifiers_identifier_modification_time
& get_assets_response_asset_identifiers_identifier_source
& get_assets_response_asset_identifiers_identifier_os?
}
get_assets_response_asset_identifiers_identifier_name
= element name
{
name
}
get_assets_response_asset_identifiers_identifier_value
= element value
{
text
}
get_assets_response_asset_identifiers_identifier_creation_time
= element creation_time
{
iso_time
}
get_assets_response_asset_identifiers_identifier_modification_time
= element modification_time
{
iso_time
}
get_assets_response_asset_identifiers_identifier_source
= element source
{
attribute id { uuid }
& get_assets_response_asset_identifiers_identifier_source_type
& get_assets_response_asset_identifiers_identifier_source_data
& get_assets_response_asset_identifiers_identifier_source_deleted
}
get_assets_response_asset_identifiers_identifier_source_type
= element type
{
text
}
get_assets_response_asset_identifiers_identifier_source_data
= element data
{
text
}
get_assets_response_asset_identifiers_identifier_source_deleted
= element deleted
{
boolean
}
get_assets_response_asset_identifiers_identifier_os
= element os
{
attribute id { uuid }
& get_assets_response_asset_identifiers_identifier_os_title
}
get_assets_response_asset_identifiers_identifier_os_title
= element title
{
text
}
get_assets_response_asset_host
= element host
{
get_assets_response_asset_host_severity
& get_assets_response_asset_host_detail*
& get_assets_response_asset_host_routes
}
get_assets_response_asset_host_severity
= element severity
{
get_assets_response_asset_host_severity_value
}
get_assets_response_asset_host_severity_value
= element value
{
severity
}
get_assets_response_asset_host_detail
= element detail
{
get_assets_response_asset_host_detail_name
& get_assets_response_asset_host_detail_value
& get_assets_response_asset_host_detail_source
}
get_assets_response_asset_host_detail_name
= element name
{
name
}
get_assets_response_asset_host_detail_value
= element value
{
text
}
get_assets_response_asset_host_detail_source
= element source
{
attribute id { uuid }
& get_assets_response_asset_host_detail_source_type
}
get_assets_response_asset_host_detail_source_type
= element type
{
text
}
get_assets_response_asset_host_routes
= element routes
{
get_assets_response_asset_host_routes_route*
}
get_assets_response_asset_host_routes_route
= element route
{
get_assets_response_asset_host_routes_route_host*
}
get_assets_response_asset_host_routes_route_host
= element host
{
attribute id { uuid }?
& attribute distance { number }?
& attribute same_source { boolean }?
& get_assets_response_asset_host_routes_route_host_ip
}
get_assets_response_asset_host_routes_route_host_ip
= element ip
{
text
}
get_assets_response_asset_os
= element os
{
get_assets_response_asset_os_title
& get_assets_response_asset_os_installs
& get_assets_response_asset_os_latest_severity
& get_assets_response_asset_os_highest_severity
& get_assets_response_asset_os_average_severity
& get_assets_response_asset_os_hosts
}
get_assets_response_asset_os_title
= element title
{
text
}
get_assets_response_asset_os_installs
= element installs
{
integer
}
get_assets_response_asset_os_latest_severity
= element latest_severity
{
get_assets_response_asset_os_latest_severity_value
}
get_assets_response_asset_os_latest_severity_value
= element value
{
text
}
get_assets_response_asset_os_highest_severity
= element highest_severity
{
get_assets_response_asset_os_highest_severity_value
}
get_assets_response_asset_os_highest_severity_value
= element value
{
text
}
get_assets_response_asset_os_average_severity
= element average_severity
{
get_assets_response_asset_os_average_severity_value
}
get_assets_response_asset_os_average_severity_value
= element value
{
text
}
get_assets_response_asset_os_hosts
= element hosts
{
get_assets_response_asset_os_hosts_asset
}
get_assets_response_asset_os_hosts_asset
= element asset
{
attribute id { uuid }
& get_assets_response_asset_os_hosts_asset_name
& get_assets_response_asset_os_hosts_asset_severity
}
get_assets_response_asset_os_hosts_asset_name
= element name
{
name
}
get_assets_response_asset_os_hosts_asset_severity
= element severity
{
get_assets_response_asset_os_hosts_asset_severity_value
}
get_assets_response_asset_os_hosts_asset_severity_value
= element value
{
text
}
get_assets_response_asset_in_use
= element in_use
{
boolean
}
get_assets_response_asset_writable
= element writable
{
boolean
}
get_assets_response_asset_permissions
= element permissions
{
get_assets_response_asset_permissions_permission*
}
get_assets_response_asset_permissions_permission
= element permission
{
get_assets_response_asset_permissions_permission_name
}
get_assets_response_asset_permissions_permission_name
= element name
{
name
}
get_assets_response_asset_user_tags
= element user_tags
{
get_assets_response_asset_user_tags_count
& get_assets_response_asset_user_tags_tag*
}
get_assets_response_asset_user_tags_count
= element count
{
integer
}
get_assets_response_asset_user_tags_tag
= element tag
{
attribute id { uuid }
& get_assets_response_asset_user_tags_tag_name
& get_assets_response_asset_user_tags_tag_value
& get_assets_response_asset_user_tags_tag_comment
}
get_assets_response_asset_user_tags_tag_name
= element name
{
text
}
get_assets_response_asset_user_tags_tag_value
= element value
{
text
}
get_assets_response_asset_user_tags_tag_comment
= element comment
{
text
}
get_assets_response_filters
= element filters
{
attribute id { uuid }
& get_assets_response_filters_term
& get_assets_response_filters_name?
& get_assets_response_filters_keywords
}
get_assets_response_filters_term
= element term
{
text
}
get_assets_response_filters_name
= element name
{
text
}
get_assets_response_filters_keywords
= element keywords
{
get_assets_response_filters_keywords_keyword*
}
get_assets_response_filters_keywords_keyword
= element keyword
{
get_assets_response_filters_keywords_keyword_column
& get_assets_response_filters_keywords_keyword_relation
& get_assets_response_filters_keywords_keyword_value
}
get_assets_response_filters_keywords_keyword_column
= element column
{
text
}
get_assets_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_assets_response_filters_keywords_keyword_value
= element value
{
text
}
get_assets_response_sort
= element sort
{
text
& get_assets_response_sort_field
}
get_assets_response_sort_field
= element field
{
get_assets_response_sort_field_order
}
get_assets_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_assets_response_assets
= element assets
{
attribute start { integer }
& attribute max { integer }
}
get_assets_response_asset_count
= element asset_count
{
get_assets_response_asset_count_filtered
& get_assets_response_asset_count_page
}
get_assets_response_asset_count_filtered
= element filtered
{
integer
}
get_assets_response_asset_count_page
= element page
{
integer
}
7.51.3 Example: Get one or many assets
Client
<get_assets/> <get_assets_response status="200"
status_text="OK">
<asset id="b493b7a8-7489-11df-a3ec-002264764cea">
<name>Localhost</name>
<comment/>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<writable>0</writable>
<in_use>7</in_use>
<user_tags>
<count>0</count>
</user_tags>
<hosts>localhost</hosts>
<max_hosts>1</max_hosts>
<ssh_credential id="">
<name/>
</ssh_credential>
<smb_credential id="">
<name/>
</smb_credential>
<esxi_credential id="">
<name/>
</esxi_credential>
</asset>
...
</get_assets_response>
7.51.3 Example: Get a single asset, including tasks using the asset
Client
<get_assets asset_id="1f28d970-17ef-4c69-ba8a-13827059f2b9"
tasks="1"/>
<get_assets_response status="200"
status_text="OK">
<asset id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>dik</name>
<comment>dik mm</comment>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<writable>0</writable>
<in_use>4</in_use>
<user_tags>
<count>0</count>
</user_tags>
<hosts>dik.example.org</hosts>
<max_hosts>1</max_hosts>
<ssh_credential id="58ff2793-2dc7-43fe-85f9-20bfac5a87e4">
<name>mm</name>
</ssh_credential>
<smb_credential id="">
<name/>
</smb_credential>
<esxi_credential id="">
<name/>
</esxi_credential>
<tasks>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>dik mm</name>
</task>
...
</tasks>
</asset>
</get_assets_response>
7.52 Command get_credentialsIn short: Get one or many credentials. The client uses the get_credentials command to get credentials information. If the command sent by the client was valid, the manager will reply with a list of credentials to the client. 7.52.1 Structure
7.52.2 RNC
Command
get_credentials
= element get_credentials
{
attribute credential_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute scanners { boolean }?
& attribute trash { boolean }?
& attribute targets { boolean }?
& attribute format { xsd:token { pattern = "key|rpm|deb|exe" } }?
}
get_credentials_response
= element get_credentials_response
{
attribute status { status }
& attribute status_text { text }
& get_credentials_response_credential*
& get_credentials_response_filters
& get_credentials_response_sort
& get_credentials_response_credentials
& get_credentials_response_credential_count
}
get_credentials_response_credential
= element credential
{
attribute id { uuid }
& get_credentials_response_credential_owner
& get_credentials_response_credential_name
& get_credentials_response_credential_allow_insecure
& get_credentials_response_credential_login
& get_credentials_response_credential_comment
& get_credentials_response_credential_creation_time
& get_credentials_response_credential_modification_time
& get_credentials_response_credential_writable
& get_credentials_response_credential_in_use
& get_credentials_response_credential_permissions
& get_credentials_response_credential_user_tags
& get_credentials_response_credential_type
& get_credentials_response_credential_full_type
& get_credentials_response_credential_auth_algorithm?
& get_credentials_response_credential_privacy?
& get_credentials_response_credential_certificate_info?
& get_credentials_response_credential_scanners?
& get_credentials_response_credential_targets?
& ( get_credentials_response_credential_public_key
| get_credentials_response_credential_package )
}
get_credentials_response_credential_owner
= element owner
{
get_credentials_response_credential_owner_name
}
get_credentials_response_credential_owner_name
= element name
{
name
}
get_credentials_response_credential_name
= element name
{
name
}
get_credentials_response_credential_allow_insecure
= element allow_insecure
{
boolean
}
get_credentials_response_credential_login
= element login
{
name
}
get_credentials_response_credential_comment
= element comment
{
text
}
get_credentials_response_credential_creation_time
= element creation_time
{
iso_time
}
get_credentials_response_credential_modification_time
= element modification_time
{
iso_time
}
get_credentials_response_credential_writable
= element writable
{
boolean
}
get_credentials_response_credential_in_use
= element in_use
{
boolean
}
get_credentials_response_credential_permissions
= element permissions
{
get_credentials_response_credential_permissions_permission*
}
get_credentials_response_credential_permissions_permission
= element permission
{
get_credentials_response_credential_permissions_permission_name
}
get_credentials_response_credential_permissions_permission_name
= element name
{
name
}
get_credentials_response_credential_user_tags
= element user_tags
{
get_credentials_response_credential_user_tags_count
& get_credentials_response_credential_user_tags_tag*
}
get_credentials_response_credential_user_tags_count
= element count
{
integer
}
get_credentials_response_credential_user_tags_tag
= element tag
{
attribute id { uuid }
& get_credentials_response_credential_user_tags_tag_name
& get_credentials_response_credential_user_tags_tag_value
& get_credentials_response_credential_user_tags_tag_comment
}
get_credentials_response_credential_user_tags_tag_name
= element name
{
text
}
get_credentials_response_credential_user_tags_tag_value
= element value
{
text
}
get_credentials_response_credential_user_tags_tag_comment
= element comment
{
text
}
get_credentials_response_credential_type
= element type
{
xsd:token { pattern = "up|usk" }
}
get_credentials_response_credential_full_type
= element full_type
{
text
}
get_credentials_response_credential_auth_algorithm
= element auth_algorithm
{
xsd:token { pattern = "md5|sha1" }
}
get_credentials_response_credential_privacy
= element privacy
{
get_credentials_response_credential_privacy_algorithm
}
get_credentials_response_credential_privacy_algorithm
= element algorithm
{
xsd:token { pattern = "aes|des" }
}
get_credentials_response_credential_certificate_info
= element certificate_info # type certificate_info
{
certificate_info_time_status
& certificate_info_activation_time
& certificate_info_expiration_time
& certificate_info_issuer
& certificate_info_md5_fingerprint
}
get_credentials_response_credential_scanners
= element scanners
{
get_credentials_response_credential_scanners_scanner*
}
get_credentials_response_credential_scanners_scanner
= element scanner
{
attribute id { uuid }
& get_credentials_response_credential_scanners_scanner_name
& get_credentials_response_credential_scanners_scanner_permissions?
}
get_credentials_response_credential_scanners_scanner_name
= element name
{
name
}
get_credentials_response_credential_scanners_scanner_permissions
= element permissions
{
""
}
get_credentials_response_credential_targets
= element targets
{
get_credentials_response_credential_targets_target*
}
get_credentials_response_credential_targets_target
= element target
{
attribute id { uuid }
& get_credentials_response_credential_targets_target_name
& get_credentials_response_credential_targets_target_permissions?
}
get_credentials_response_credential_targets_target_name
= element name
{
name
}
get_credentials_response_credential_targets_target_permissions
= element permissions
{
""
}
get_credentials_response_credential_public_key
= element public_key
{
text
}
get_credentials_response_credential_package
= element package
{
base64
& attribute format { xsd:token { pattern = "rpm|deb|exe" } }
}
get_credentials_response_filters
= element filters
{
attribute id { uuid }
& get_credentials_response_filters_term
& get_credentials_response_filters_name?
& get_credentials_response_filters_keywords
}
get_credentials_response_filters_term
= element term
{
text
}
get_credentials_response_filters_name
= element name
{
text
}
get_credentials_response_filters_keywords
= element keywords
{
get_credentials_response_filters_keywords_keyword*
}
get_credentials_response_filters_keywords_keyword
= element keyword
{
get_credentials_response_filters_keywords_keyword_column
& get_credentials_response_filters_keywords_keyword_relation
& get_credentials_response_filters_keywords_keyword_value
}
get_credentials_response_filters_keywords_keyword_column
= element column
{
text
}
get_credentials_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_credentials_response_filters_keywords_keyword_value
= element value
{
text
}
get_credentials_response_sort
= element sort
{
text
& get_credentials_response_sort_field
}
get_credentials_response_sort_field
= element field
{
get_credentials_response_sort_field_order
}
get_credentials_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_credentials_response_credentials
= element credentials
{
attribute start { integer }
& attribute max { integer }
}
get_credentials_response_credential_count
= element credential_count
{
get_credentials_response_credential_count_filtered
& get_credentials_response_credential_count_page
}
get_credentials_response_credential_count_filtered
= element filtered
{
integer
}
get_credentials_response_credential_count_page
= element page
{
integer
}
7.52.3 Example: Get one or many the credentials
Client
<get_credentials/> <get_credentials_response status="200"
status_text="OK">
<credential id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>sally</name>
<login>sally</login>
<comment/>
<creation_time>2012-12-14T17:11:25+01:00</creation_time>
<modification_time>2012-05-28T11:19:20+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<type>usk</type>
<full_type>username + SSH key</full_type>
</credential>
<credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<comment>Bob on the web server.</comment>
<creation_time>2013-01-03T15:49:35+01:00</creation_time>
<modification_time>2013-01-18T12:07:00+01:00</modification_time>
<writable>1</writable>
<in_use>1</in_use>
<login>bob</login>
<type>up</type>
<full_type>username + password</full_type>
</credential>
...
</get_credentials_response>
7.52.3 Example: Get a single credential, its public key and targets using it
Client
<get_credentials credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
format="key"
targets="1"/>
<get_credentials_response status="200"
status_text="OK">
<credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<comment>Bob on the web server.</comment>
<creation_time>2012-11-03T15:41:35+01:00</creation_time>
<modification_time>2012-11-18T13:17:00+01:00</modification_time>
<writable>1</writable>
<in_use>1</in_use>
<user_tags>
<count>0</count>
</user_tags>
<login>bob</login>
<type>up</type>
<full_type>username + password</full_type>
<targets>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>Web server</name>
</target>
</targets>
<public_key>
ssh-rsa AAAAB3...Z64IcQ== Key generated by OpenVAS Manager
</public_key>
</credential>
</get_credentials_response>
7.52.3 Example: Get the Debian package of a single credential
Client
<get_credentials credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
format="deb"/>
<get_credentials_response status="200"
status_text="OK">
<credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<login>bob</login>
<comment>Bob on the web server.</comment>
<creation_time>2012-11-03T15:41:35+01:00</creation_time>
<modification_time>2012-11-18T13:17:00+01:00</modification_time>
<writable>1</writable>
<in_use>1</in_use>
<user_tags>
<count>0</count>
</user_tags>
<type>up</type>
<full_type>username + password</full_type>
<targets>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>Web server</name>
</target>
</targets>
<package format="deb">ITxhcmNoPgpk...DmvF0AKAAACg==</package>
</credential>
</get_credentials_response>
7.53 Command get_feedsIn short: Get one or many feeds. The client uses the get_feeds command to get feed information. If the command sent by the client was valid, the manager will reply with a list of feeds to the client. 7.53.1 Structure
7.53.2 RNC
Command
get_feeds
= element get_feeds
{
attribute type { text }?
}
get_feeds_response
= element get_feeds_response
{
attribute status { status }
& attribute status_text { text }
& get_feeds_response_feed*
}
get_feeds_response_feed
= element feed
{
get_feeds_response_feed_type
& get_feeds_response_feed_name
& get_feeds_response_feed_version
& get_feeds_response_feed_description
& get_feeds_response_feed_sync_not_available?
& get_feeds_response_feed_currently_syncing?
}
get_feeds_response_feed_type
= element type
{
text
}
get_feeds_response_feed_name
= element name
{
text
}
get_feeds_response_feed_version
= element version
{
text
}
get_feeds_response_feed_description
= element description
{
text
}
get_feeds_response_feed_sync_not_available
= element sync_not_available
{
get_feeds_response_feed_sync_not_available_error
}
get_feeds_response_feed_sync_not_available_error
= element error
{
}
get_feeds_response_feed_currently_syncing
= element currently_syncing
{
get_feeds_response_feed_currently_syncing_timestamp
& get_feeds_response_feed_currently_syncing_user
}
get_feeds_response_feed_currently_syncing_timestamp
= element timestamp
{
text
}
get_feeds_response_feed_currently_syncing_user
= element user
{
text
}
7.53.3 Example: Get the feeds
Client
<get_feeds/> <get_feeds_response status_text="OK"
status="200">
<feed>
<type>NVT</type>
<name>Greenbone Security Feed</name>
<version>201608180124</version>
<description>This script synchronizes an NVT collection with...</description>
</feed>
<feed>
<type>CERT</type>
<name>Greenbone CERT Feed</name>
<version>201609130000</version>
<description>This script synchronizes a CERT collection with...</description>
</feed>
<feed>
<type>SCAP</type>
<name>Greenbone SCAP Feed</name>
<version>201608172300</version>
<description>This script synchronizes a SCAP collection with...</description>
</feed>
</get_feeds_response>
7.54 Command get_filtersIn short: Get one or many filters. The client uses the get_filters command to get filter information. 7.54.1 Structure
7.54.2 RNC
Command
get_filters
= element get_filters
{
attribute filter_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute alerts { boolean }?
}
get_filters_response
= element get_filters_response
{
attribute status { status }
& attribute status_text { text }
& get_filters_response_filter*
& get_filters_response_filters
& get_filters_response_sort
& get_filters_response_filters
& get_filters_response_filter_count
}
get_filters_response_filter
= element filter
{
attribute id { uuid }
& get_filters_response_filter_owner
& get_filters_response_filter_name
& get_filters_response_filter_comment
& get_filters_response_filter_term
& get_filters_response_filter_type
& get_filters_response_filter_creation_time
& get_filters_response_filter_modification_time
& get_filters_response_filter_in_use
& get_filters_response_filter_writable
& get_filters_response_filter_permissions
& get_filters_response_filter_user_tags
& get_filters_response_filter_alerts?
}
get_filters_response_filter_owner
= element owner
{
get_filters_response_filter_owner_name
}
get_filters_response_filter_owner_name
= element name
{
name
}
get_filters_response_filter_name
= element name
{
name
}
get_filters_response_filter_comment
= element comment
{
text
}
get_filters_response_filter_term
= element term
{
text
}
get_filters_response_filter_type
= element type
{
text
}
get_filters_response_filter_creation_time
= element creation_time
{
iso_time
}
get_filters_response_filter_modification_time
= element modification_time
{
iso_time
}
get_filters_response_filter_in_use
= element in_use
{
boolean
}
get_filters_response_filter_writable
= element writable
{
boolean
}
get_filters_response_filter_permissions
= element permissions
{
get_filters_response_filter_permissions_permission*
}
get_filters_response_filter_permissions_permission
= element permission
{
get_filters_response_filter_permissions_permission_name
}
get_filters_response_filter_permissions_permission_name
= element name
{
name
}
get_filters_response_filter_user_tags
= element user_tags
{
get_filters_response_filter_user_tags_count
& get_filters_response_filter_user_tags_tag*
}
get_filters_response_filter_user_tags_count
= element count
{
integer
}
get_filters_response_filter_user_tags_tag
= element tag
{
attribute id { uuid }
& get_filters_response_filter_user_tags_tag_name
& get_filters_response_filter_user_tags_tag_value
& get_filters_response_filter_user_tags_tag_comment
}
get_filters_response_filter_user_tags_tag_name
= element name
{
text
}
get_filters_response_filter_user_tags_tag_value
= element value
{
text
}
get_filters_response_filter_user_tags_tag_comment
= element comment
{
text
}
get_filters_response_filter_alerts
= element alerts
{
get_filters_response_filter_alerts_alert*
}
get_filters_response_filter_alerts_alert
= element alert
{
attribute id { uuid }
& get_filters_response_filter_alerts_alert_name
& get_filters_response_filter_alerts_alert_permissions?
}
get_filters_response_filter_alerts_alert_name
= element name
{
name
}
get_filters_response_filter_alerts_alert_permissions
= element permissions
{
""
}
get_filters_response_filters
= element filters
{
attribute id { uuid }
& get_filters_response_filters_term
& get_filters_response_filters_name?
& get_filters_response_filters_keywords
}
get_filters_response_filters_term
= element term
{
text
}
get_filters_response_filters_name
= element name
{
text
}
get_filters_response_filters_keywords
= element keywords
{
get_filters_response_filters_keywords_keyword*
}
get_filters_response_filters_keywords_keyword
= element keyword
{
get_filters_response_filters_keywords_keyword_column
& get_filters_response_filters_keywords_keyword_relation
& get_filters_response_filters_keywords_keyword_value
}
get_filters_response_filters_keywords_keyword_column
= element column
{
text
}
get_filters_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_filters_response_filters_keywords_keyword_value
= element value
{
text
}
get_filters_response_sort
= element sort
{
text
& get_filters_response_sort_field
}
get_filters_response_sort_field
= element field
{
get_filters_response_sort_field_order
}
get_filters_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_filters_response_filters
= element filters
{
attribute start { integer }
& attribute max { integer }
}
get_filters_response_filter_count
= element filter_count
{
get_filters_response_filter_count_filtered
& get_filters_response_filter_count_page
}
get_filters_response_filter_count_filtered
= element filtered
{
integer
}
get_filters_response_filter_count_page
= element page
{
integer
}
7.54.3 Example: Get one or many filters
Client
<get_filters/> <get_filters_response status="200"
status_text="OK">
<filter id="b493b7a8-7489-11df-a3ec-001164764cea">
<name>Single Targets</name>
<comment>Targets with only one host</comment>
<term>ips=1 first=1 rows=-2</term>
<type>target</type>
<in_use>1</in_use>
<writable>1</writable>
<user_tags>
<count>0</count>
</user_tags>
<creation_time>Sun Jun 27 08:49:46 2010</creation_time>
<modification_time>Sun Jun 27 08:49:46 2010</modification_time>
</filter>
...
</get_filters_response>
7.54.3 Example: Get single filter, including alerts that use the filter
Client
<get_filters filter_id="c33864a9-d3fd-44b3-8717-972bfb01dfc0"
tasks="1"/>
<get_filters_response status="200"
status_text="OK">
<filter id="c33864a9-d3fd-44b3-8717-972bfb01dfc0">
<name>Local</name>
<comment>Any item with name containing 'local'.</comment>
<term>name~local first=1 rows=-2</term>
<type/>
<in_use>1</in_use>
<writable>1</writable>
<user_tags>
<count>0</count>
</user_tags>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<alerts>
<alert id="13bb418a-4220-4575-b35b-ec398bff7418">
<name>Local Mailer</name>
</alert>
...
</alerts>
</filter>
</get_filters_response>
7.55 Command get_groupsIn short: Get one or many groups. The client uses the get_groups command to get group information. 7.55.1 Structure
7.55.2 RNC
Command
get_groups
= element get_groups
{
attribute group_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
}
get_groups_response
= element get_groups_response
{
attribute status { status }
& attribute status_text { text }
& get_groups_response_group*
& get_groups_response_filters
& get_groups_response_sort
& get_groups_response_groups
& get_groups_response_group_count
}
get_groups_response_group
= element group
{
attribute id { uuid }
& get_groups_response_group_owner
& get_groups_response_group_name
& get_groups_response_group_comment
& get_groups_response_group_creation_time
& get_groups_response_group_modification_time
& get_groups_response_group_writable
& get_groups_response_group_in_use
& get_groups_response_group_permissions
& get_groups_response_group_user_tags
& get_groups_response_group_users
}
get_groups_response_group_owner
= element owner
{
get_groups_response_group_owner_name
}
get_groups_response_group_owner_name
= element name
{
name
}
get_groups_response_group_name
= element name
{
name
}
get_groups_response_group_comment
= element comment
{
text
}
get_groups_response_group_creation_time
= element creation_time
{
iso_time
}
get_groups_response_group_modification_time
= element modification_time
{
iso_time
}
get_groups_response_group_users
= element users
{
text
}
get_groups_response_group_writable
= element writable
{
boolean
}
get_groups_response_group_in_use
= element in_use
{
boolean
}
get_groups_response_group_permissions
= element permissions
{
get_groups_response_group_permissions_permission*
}
get_groups_response_group_permissions_permission
= element permission
{
get_groups_response_group_permissions_permission_name
}
get_groups_response_group_permissions_permission_name
= element name
{
name
}
get_groups_response_group_user_tags
= element user_tags
{
get_groups_response_group_user_tags_count
& get_groups_response_group_user_tags_tag*
}
get_groups_response_group_user_tags_count
= element count
{
integer
}
get_groups_response_group_user_tags_tag
= element tag
{
attribute id { uuid }
& get_groups_response_group_user_tags_tag_name
& get_groups_response_group_user_tags_tag_value
& get_groups_response_group_user_tags_tag_comment
}
get_groups_response_group_user_tags_tag_name
= element name
{
text
}
get_groups_response_group_user_tags_tag_value
= element value
{
text
}
get_groups_response_group_user_tags_tag_comment
= element comment
{
text
}
get_groups_response_filters
= element filters
{
attribute id { uuid }
& get_groups_response_filters_term
& get_groups_response_filters_name?
& get_groups_response_filters_keywords
}
get_groups_response_filters_term
= element term
{
text
}
get_groups_response_filters_name
= element name
{
text
}
get_groups_response_filters_keywords
= element keywords
{
get_groups_response_filters_keywords_keyword*
}
get_groups_response_filters_keywords_keyword
= element keyword
{
get_groups_response_filters_keywords_keyword_column
& get_groups_response_filters_keywords_keyword_relation
& get_groups_response_filters_keywords_keyword_value
}
get_groups_response_filters_keywords_keyword_column
= element column
{
text
}
get_groups_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_groups_response_filters_keywords_keyword_value
= element value
{
text
}
get_groups_response_sort
= element sort
{
text
& get_groups_response_sort_field
}
get_groups_response_sort_field
= element field
{
get_groups_response_sort_field_order
}
get_groups_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_groups_response_groups
= element groups
{
attribute start { integer }
& attribute max { integer }
}
get_groups_response_group_count
= element group_count
{
get_groups_response_group_count_filtered
& get_groups_response_group_count_page
}
get_groups_response_group_count_filtered
= element filtered
{
integer
}
get_groups_response_group_count_page
= element page
{
integer
}
7.55.3 Example: Get one or many groups
Client
<get_groups/> <get_groups_response status="200"
status_text="OK">
<group id="b493b7a8-7489-11df-a3ec-002264764cea">
<name>Management</name>
<comment>Managers</comment>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<users>sarah, frank</users>
</group>
...
<filters id="">
<term>first=1 rows=-1 sort=name</term>
<keywords>
<keyword>
<column>first</column>
<relation>=</relation>
<value>1</value>
</keyword>
...
</keywords>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<groups max="-1"
start="1"/>
<group_count>
1
<filtered>1</filtered>
<page>1</page>
</group_count>
</get_groups_response>
7.56 Command get_infoIn short: Get information for items of given type. The client uses the get_info command to get information about static data from an external source, like CVE or CPE. If the command sent by the client was valid, the manager will reply with a list of info elements of a given type to the client. 7.56.1 Structure
7.56.2 RNC
Command
get_info
= element get_info
{
attribute type { text }
& attribute name { text }?
& attribute info_id { text }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute details { boolean }?
}
get_info_response
= element get_info_response
{
attribute status { status }
& attribute status_text { text }
& get_info_response_info*
& get_info_response_filters
& get_info_response_sort
& get_info_response_details
& get_info_response_info_count
}
get_info_response_info
= element info
{
attribute id { integer }?
& get_info_response_info_owner
& get_info_response_info_name
& get_info_response_info_comment
& get_info_response_info_creation_time
& get_info_response_info_modification_time
& get_info_response_info_permissions
& get_info_response_info_user_tags
& get_info_response_info_update_time
& ( get_info_response_info_cert_bund_adv
| get_info_response_info_cpe
| get_info_response_info_cve
| get_info_response_info_dfn_cert_adv
| get_info_response_info_ovaldef
| get_info_response_info_nvt
| get_info_response_info_allinfo )
}
get_info_response_info_owner
= element owner
{
get_info_response_info_owner_name
}
get_info_response_info_owner_name
= element name
{
name
}
get_info_response_info_name
= element name
{
name
}
get_info_response_info_comment
= element comment
{
text
}
get_info_response_info_creation_time
= element creation_time
{
iso_time
}
get_info_response_info_modification_time
= element modification_time
{
iso_time
}
get_info_response_info_update_time
= element update_time
{
iso_time
}
get_info_response_info_permissions
= element permissions
{
get_info_response_info_permissions_permission*
}
get_info_response_info_permissions_permission
= element permission
{
get_info_response_info_permissions_permission_name
}
get_info_response_info_permissions_permission_name
= element name
{
name
}
get_info_response_info_user_tags
= element user_tags
{
get_info_response_info_user_tags_count
& get_info_response_info_user_tags_tag*
}
get_info_response_info_user_tags_count
= element count
{
integer
}
get_info_response_info_user_tags_tag
= element tag
{
attribute id { uuid }
& get_info_response_info_user_tags_tag_name
& get_info_response_info_user_tags_tag_value
& get_info_response_info_user_tags_tag_comment
}
get_info_response_info_user_tags_tag_name
= element name
{
text
}
get_info_response_info_user_tags_tag_value
= element value
{
text
}
get_info_response_info_user_tags_tag_comment
= element comment
{
text
}
get_info_response_info_cert_bund_adv
= element cert_bund_adv
{
get_info_response_info_cert_bund_adv_title
& get_info_response_info_cert_bund_adv_summary
& get_info_response_info_cert_bund_adv_max_cvss
& get_info_response_info_cert_bund_adv_cve_refs
& get_info_response_info_cert_bund_adv_raw_data?
}
get_info_response_info_cert_bund_adv_title
= element title
{
text
}
get_info_response_info_cert_bund_adv_summary
= element summary
{
text
}
get_info_response_info_cert_bund_adv_max_cvss
= element max_cvss
{
text
}
get_info_response_info_cert_bund_adv_cve_refs
= element cve_refs
{
integer
}
get_info_response_info_cert_bund_adv_raw_data
= element raw_data
{
text
}
get_info_response_info_cpe
= element cpe
{
get_info_response_info_cpe_nvd_id
& get_info_response_info_cpe_title?
& get_info_response_info_cpe_max_cvss
& get_info_response_info_cpe_cve_refs
& get_info_response_info_cpe_status
& get_info_response_info_cpe_cves?
& get_info_response_info_cpe_raw_data?
}
get_info_response_info_cpe_nvd_id
= element nvd_id
{
text
}
get_info_response_info_cpe_title
= element title
{
text
}
get_info_response_info_cpe_max_cvss
= element max_cvss
{
integer
}
get_info_response_info_cpe_cve_refs
= element cve_refs
{
integer
}
get_info_response_info_cpe_status
= element status
{
text
}
get_info_response_info_cpe_cves
= element cves
{
get_info_response_info_cpe_cves_cve*
}
get_info_response_info_cpe_cves_cve
= element cve
{
text
}
get_info_response_info_cpe_raw_data
= element raw_data
{
text
}
get_info_response_info_nvt
= element nvt
{
text
}
get_info_response_info_cve
= element cve
{
get_info_response_info_cve_cvss
& get_info_response_info_cve_vector
& get_info_response_info_cve_complexity
& get_info_response_info_cve_authentication
& get_info_response_info_cve_confidentiality_impact
& get_info_response_info_cve_integrity_impact
& get_info_response_info_cve_availability_impact
& get_info_response_info_cve_description
& get_info_response_info_cve_products
& get_info_response_info_cve_nvts?
& get_info_response_info_cve_cert?
& get_info_response_info_cve_raw_data?
}
get_info_response_info_cve_cvss
= element cvss
{
text
}
get_info_response_info_cve_vector
= element vector
{
text
}
get_info_response_info_cve_complexity
= element complexity
{
text
}
get_info_response_info_cve_authentication
= element authentication
{
text
}
get_info_response_info_cve_confidentiality_impact
= element confidentiality_impact
{
text
}
get_info_response_info_cve_integrity_impact
= element integrity_impact
{
text
}
get_info_response_info_cve_availability_impact
= element availability_impact
{
text
}
get_info_response_info_cve_description
= element description
{
text
}
get_info_response_info_cve_products
= element products
{
text
}
get_info_response_info_cve_nvts
= element nvts
{
get_info_response_info_cve_nvts_nvt*
}
get_info_response_info_cve_nvts_nvt
= element nvt
{
attribute oid { oid }?
& get_info_response_info_cve_nvts_nvt_name
}
get_info_response_info_cve_nvts_nvt_name
= element name
{
text
}
get_info_response_info_cve_cert
= element cert
{
get_info_response_info_cve_cert_cert_ref*
& get_info_response_info_cve_cert_warning?
}
get_info_response_info_cve_cert_cert_ref
= element cert_ref
{
attribute type { text }?
& get_info_response_info_cve_cert_cert_ref_name
& get_info_response_info_cve_cert_cert_ref_title
}
get_info_response_info_cve_cert_cert_ref_name
= element name
{
text
}
get_info_response_info_cve_cert_cert_ref_title
= element title
{
text
}
get_info_response_info_cve_cert_warning
= element warning
{
text
}
get_info_response_info_cve_raw_data
= element raw_data
{
text
}
get_info_response_info_dfn_cert_adv
= element dfn_cert_adv
{
get_info_response_info_dfn_cert_adv_title
& get_info_response_info_dfn_cert_adv_summary
& get_info_response_info_dfn_cert_adv_max_cvss
& get_info_response_info_dfn_cert_adv_cve_refs
& get_info_response_info_dfn_cert_adv_raw_data?
}
get_info_response_info_dfn_cert_adv_title
= element title
{
text
}
get_info_response_info_dfn_cert_adv_summary
= element summary
{
text
}
get_info_response_info_dfn_cert_adv_max_cvss
= element max_cvss
{
text
}
get_info_response_info_dfn_cert_adv_cve_refs
= element cve_refs
{
integer
}
get_info_response_info_dfn_cert_adv_raw_data
= element raw_data
{
text
}
get_info_response_info_ovaldef
= element ovaldef
{
get_info_response_info_ovaldef_version
& get_info_response_info_ovaldef_deprecated
& get_info_response_info_ovaldef_status
& get_info_response_info_ovaldef_class
& get_info_response_info_ovaldef_title
& get_info_response_info_ovaldef_max_cvss
& get_info_response_info_ovaldef_cve_refs
& get_info_response_info_ovaldef_file
& get_info_response_info_ovaldef_description?
& get_info_response_info_ovaldef_raw_data?
}
get_info_response_info_ovaldef_version
= element version
{
integer
}
get_info_response_info_ovaldef_deprecated
= element deprecated
{
boolean
}
get_info_response_info_ovaldef_status
= element status
{
text
}
get_info_response_info_ovaldef_class
= element class
{
text
}
get_info_response_info_ovaldef_title
= element title
{
text
}
get_info_response_info_ovaldef_max_cvss
= element max_cvss
{
text
}
get_info_response_info_ovaldef_cve_refs
= element cve_refs
{
integer
}
get_info_response_info_ovaldef_file
= element file
{
text
}
get_info_response_info_ovaldef_description
= element description
{
text
}
get_info_response_info_ovaldef_raw_data
= element raw_data
{
text
}
get_info_response_info_allinfo
= element allinfo
{
get_info_response_info_allinfo_type
& get_info_response_info_allinfo_extra
& get_info_response_info_allinfo_severity
}
get_info_response_info_allinfo_type
= element type
{
text
}
get_info_response_info_allinfo_extra
= element extra
{
text
}
get_info_response_info_allinfo_severity
= element severity
{
severity
}
get_info_response_filters
= element filters
{
attribute id { uuid }
& get_info_response_filters_term
& get_info_response_filters_name?
& get_info_response_filters_keywords
}
get_info_response_filters_term
= element term # type text
{
}
get_info_response_filters_name
= element name
{
text
}
get_info_response_filters_keywords
= element keywords
{
get_info_response_filters_keywords_keyword*
}
get_info_response_filters_keywords_keyword
= element keyword
{
get_info_response_filters_keywords_keyword_column
& get_info_response_filters_keywords_keyword_relation
& get_info_response_filters_keywords_keyword_value
}
get_info_response_filters_keywords_keyword_column
= element column
{
text
}
get_info_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_info_response_filters_keywords_keyword_value
= element value
{
text
}
get_info_response_sort
= element sort
{
text
& get_info_response_sort_field
}
get_info_response_sort_field
= element field
{
get_info_response_sort_field_order
}
get_info_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_info_response_info_count
= element info_count
{
get_info_response_info_count_filtered
& get_info_response_info_count_page
}
get_info_response_info_count_filtered
= element filtered
{
integer
}
get_info_response_info_count_page
= element page
{
integer
}
get_info_response_details
= element details # type boolean
{
}
7.56.3 Example: Get a info about cpe:/a:gnu:gzip:1.3.3 with all details
Client
<get_info type="CPE"
name="cpe:/a:gnu:gzip:1.3.3"
details="1"/>
<get_info_response status_text="OK"
status="200">
<info id="28139">
<name>cpe:/a:gnu:gzip:1.3.3</name>
<comment/>
<creation_time>2007-09-14T17:36:49Z</creation_time>
<modification_time>2007-09-14T17:36:49Z</modification_time>
<writable>0</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<update_time>2012-10-26T13:18:00.000+0000</update_time>
<cpe>
<title>GNU Gzip 1.3.3</title>
<max_cvss>10.0</max_cvss>
<cve_refs>5</cve_refs>
<status>DRAFT</status>
<cves>
<cve>
<entry id="CVE-2004-0603">
<vuln:cvss>
<cvss:base_metrics>
<cvss:score>10.0</cvss:score>
</cvss:base_metrics>
</vuln:cvss>
</entry>
</cve>
<cve>
<entry id="CVE-2010-0001">
<vuln:cvss>
<cvss:base_metrics>
<cvss:score>6.8</cvss:score>
</cvss:base_metrics>
</vuln:cvss>
</entry>
</cve>
<cve>
<entry id="CVE-2009-2624">
<vuln:cvss>
<cvss:base_metrics>
<cvss:score>6.8</cvss:score>
</cvss:base_metrics>
</vuln:cvss>
</entry>
</cve>
<cve>
<entry id="CVE-2005-1228">
<vuln:cvss>
<cvss:base_metrics>
<cvss:score>5.0</cvss:score>
</cvss:base_metrics>
</vuln:cvss>
</entry>
</cve>
<cve>
<entry id="CVE-2005-0988">
<vuln:cvss>
<cvss:base_metrics>
<cvss:score>3.7</cvss:score>
</cvss:base_metrics>
</vuln:cvss>
</entry>
</cve>
</cves>
<raw_data>
<cpe-item name="cpe:/a:gnu:gzip:1.3.3">
<title xml:lang="en-US">GNU Gzip 1.3.3</title>
<meta:item-metadata nvd-id="28139"
status="DRAFT"
modification-date="2007-09-14T17:36:49.090Z"/>
</cpe-item>
</raw_data>
</cpe>
</info>
<details>1</details>
<filters id="(null)">
<term/>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<info max="-1"
start="1"/>
<info_count>
<filtered>1</filtered>
<page>1</page>
</info_count>
</get_info_response>
7.56.3 Example: Get a info CVE-1999-0010 without details
Client
<get_info name="CVE-2011-0018"
type="cve"/>
<get_info_response status_text="OK"
status="200">
<info id="CVE-2011-0018">
<name>CVE-2011-0018</name>
<comment/>
<creation_time>2011-01-28T16:00:02Z</creation_time>
<modification_time>2011-02-05T07:01:22Z</modification_time>
<writable>0</writable>
<in_use>0</in_use>
<update_time>2012-10-26T13:18:00.000+0000</update_time>
<user_tags>
<count>0</count>
</user_tags>
<cve>
<cvss>9.0</cvss>
<vector>NETWORK</vector>
<complexity>LOW</complexity>
<authentication>SINGLE_INSTANCE</authentication>
<confidentiality_impact>COMPLETE</confidentiality_impact>
<integrity_impact>COMPLETE</integrity_impact>
<availability_impact>COMPLETE</availability_impact>
<description>
The email function in manage_sql.c in ...(truncated for example)
</description>
<products>
cpe:/a:openvas:openvas_manager:1.0.1 ...(truncated for example)
</products>
</cve>
</info>
<filters id="(null)">
<term/>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<info max="-1"
start="1"/>
<info_count>
<filtered>1</filtered>
<page>1</page>
</info_count>
</get_info_response>
7.57 Command get_notesIn short: Get one or many notes. The client uses the get_notes command to get note information. If the command sent by the client was valid, the manager will reply with a list of notes to the client. 7.57.1 Structure
7.57.2 RNC
Command
get_notes
= element get_notes
{
attribute note_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute nvt_oid { oid }?
& attribute task_id { uuid }?
& attribute details { boolean }?
& attribute result { boolean }?
}
get_notes_response
= element get_notes_response
{
attribute status { status }
& attribute status_text { text }
& get_notes_response_note*
& get_notes_response_filters
& get_notes_response_sort
& get_notes_response_notes
& get_notes_response_note_count
}
get_notes_response_filters
= element filters
{
attribute id { uuid }
& get_notes_response_filters_term
& get_notes_response_filters_name?
& get_notes_response_filters_keywords
}
get_notes_response_filters_term
= element term
{
text
}
get_notes_response_filters_name
= element name
{
text
}
get_notes_response_filters_keywords
= element keywords
{
get_notes_response_filters_keywords_keyword*
}
get_notes_response_filters_keywords_keyword
= element keyword
{
get_notes_response_filters_keywords_keyword_column
& get_notes_response_filters_keywords_keyword_relation
& get_notes_response_filters_keywords_keyword_value
}
get_notes_response_filters_keywords_keyword_column
= element column
{
text
}
get_notes_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_notes_response_filters_keywords_keyword_value
= element value
{
text
}
get_notes_response_sort
= element sort
{
text
& get_notes_response_sort_field
}
get_notes_response_sort_field
= element field
{
get_notes_response_sort_field_order
}
get_notes_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_notes_response_notes
= element notes
{
attribute start { integer }
& attribute max { integer }
}
get_notes_response_note_count
= element note_count
{
get_notes_response_note_count_filtered
& get_notes_response_note_count_page
}
get_notes_response_note_count_filtered
= element filtered
{
integer
}
get_notes_response_note_count_page
= element page
{
integer
}
get_notes_response_note
= element note # type note
{
attribute id { uuid }
& note_permissions
& note_owner
& note_nvt
& note_text
& note_creation_time
& note_modification_time
& note_writable
& note_in_use
& note_active
& note_orphan
& note_user_tags
& ( note_hosts
& note_port
& note_severity
& note_threat
& note_task
& note_end_time?
& note_result? )?
}
7.57.3 Example: Get one or many notes
Client
<get_notes/> <get_notes_response status="200"
status_text="OK">
<note id="b76b81a7-9df8-42df-afff-baa9d4620128">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
</nvt>
<creation_time>2013-01-09T09:47:41+01:00</creation_time>
<modification_time>2013-01-09T09:47:41+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<active>1</active>
<orphan>1</orphan>
<user_tags>
<count>0</count>
</user_tags>
<text excerpt="0">This is the full text of the note.</text>
</note>
...
</get_notes_response>
7.57.3 Example: Get details of a single note and result to which it applies
Client
<get_notes note_id="7f618bbb-4664-419e-9bbf-367d93954cb0"
details="1"
result="1"/>
<get_notes_response status="200"
status_text="OK">
<note id="7f618bbb-4664-419e-9bbf-367d93954cb0">
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
</nvt>
<creation_time>Sun Jun 27 08:49:46 2010</creation_time>
<modification_time>Sun Jun 27 08:49:46 2010</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<active>1</active>
<end_time/>
<text>note fixed to result</text>
<hosts>127.0.0.1</hosts>
<port>general/tcp</port>
<threat>Medium</threat>
<task id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4">
<name>test</name>
</task>
<orphan>0</orphan>
<user_tags>
<count>0</count>
</user_tags>
<result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de">
<host>127.0.0.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
<cvss_base/>
<cve/>
<bid/>
</nvt>
<threat>Medium</threat>
<description>Warning with control char between fullstops: . .</description>
</result>
</note>
...
</get_notes_response>
7.58 Command get_nvtsIn short: Get one or many NVTs. The client uses the get_nvts command to get NVT information. This command may always include a details flag, a config, a sort order and a sort field. If the command includes a details flag, the manager also consults the timeout, preference_count and preferences flags. The NVT OID, family name and config attributes limit the listing to a single NVT or all NVTs in a particular family and/or config. If the details flag is present the manager will send full details of the NVT, otherwise it will send just the NVT name. With the preferences flag the manager includes in the listing, the values of each listed NVT's preferences for the given config. The timeout flag does the same for the special timeout preference. If the config contains no values for a preference, the default value of the preference is returned. The same applies if no config is given. If the manager possesses an NVT collection, it will reply with the NVT information. If the manager cannot access a list of available NVTs at that time, it will reply with the 503 response. 7.58.1 Structure
7.58.2 RNC
Command
get_nvts
= element get_nvts
{
attribute nvt_oid { oid }
& attribute details { boolean }?
& attribute preferences { boolean }?
& attribute preference_count { boolean }?
& attribute timeout { boolean }?
& attribute config_id { uuid }?
& attribute preferences_config_id { uuid }?
& attribute family { text }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
get_nvts_response
= element get_nvts_response
{
attribute status { status }
& attribute status_text { text }
& get_nvts_response_nvt
}
get_nvts_response_nvt
= element nvt
{
attribute oid { oid }
& get_nvts_response_nvt_name
& get_nvts_response_nvt_user_tags
& ( get_nvts_response_nvt_creation_time
& get_nvts_response_nvt_modification_time
& get_nvts_response_nvt_category
& get_nvts_response_nvt_copyright
& get_nvts_response_nvt_summary
& get_nvts_response_nvt_family
& get_nvts_response_nvt_version
& get_nvts_response_nvt_cvss_base
& get_nvts_response_nvt_qod
& get_nvts_response_nvt_cve_id
& get_nvts_response_nvt_cert_refs
& get_nvts_response_nvt_bugtraq_id
& get_nvts_response_nvt_xrefs
& get_nvts_response_nvt_tags
& get_nvts_response_nvt_preference_count?
& get_nvts_response_nvt_timeout?
& get_nvts_response_nvt_preferences? )?
}
get_nvts_response_nvt_name
= element name
{
name
}
get_nvts_response_nvt_category
= element category
{
text
}
get_nvts_response_nvt_creation_time
= element creation_time
{
iso_time
}
get_nvts_response_nvt_modification_time
= element modification_time
{
iso_time
}
get_nvts_response_nvt_user_tags
= element user_tags
{
get_nvts_response_nvt_user_tags_count
& get_nvts_response_nvt_user_tags_tag*
}
get_nvts_response_nvt_user_tags_count
= element count
{
integer
}
get_nvts_response_nvt_user_tags_tag
= element tag
{
attribute id { uuid }
& get_nvts_response_nvt_user_tags_tag_name
& get_nvts_response_nvt_user_tags_tag_value
& get_nvts_response_nvt_user_tags_tag_comment
}
get_nvts_response_nvt_user_tags_tag_name
= element name
{
text
}
get_nvts_response_nvt_user_tags_tag_value
= element value
{
text
}
get_nvts_response_nvt_user_tags_tag_comment
= element comment
{
text
}
get_nvts_response_nvt_copyright
= element copyright
{
text
}
get_nvts_response_nvt_summary
= element summary
{
text
}
get_nvts_response_nvt_family
= element family
{
text
}
get_nvts_response_nvt_version
= element version
{
text
}
get_nvts_response_nvt_cvss_base
= element cvss_base
{
text
}
get_nvts_response_nvt_qod
= element qod
{
get_nvts_response_nvt_qod_value
& get_nvts_response_nvt_qod_type
}
get_nvts_response_nvt_qod_value
= element value
{
integer
}
get_nvts_response_nvt_qod_type
= element type
{
text
}
get_nvts_response_nvt_cve_id
= element cve_id
{
text
}
get_nvts_response_nvt_bugtraq_id
= element bugtraq_id
{
text
}
get_nvts_response_nvt_cert_refs
= element cert_refs
{
get_nvts_response_nvt_cert_refs_cert_ref*
& get_nvts_response_nvt_cert_refs_warning?
}
get_nvts_response_nvt_cert_refs_cert_ref
= element cert_ref
{
attribute id { text }?
& attribute type { text }?
}
get_nvts_response_nvt_cert_refs_warning
= element warning
{
text
}
get_nvts_response_nvt_xrefs
= element xrefs
{
text
}
get_nvts_response_nvt_tags
= element tags
{
text
}
get_nvts_response_nvt_preference_count
= element preference_count
{
text
}
get_nvts_response_nvt_timeout
= element timeout
{
text
}
get_nvts_response_nvt_preferences
= element preferences
{
text
& get_nvts_response_nvt_preferences_timeout
& get_nvts_response_nvt_preferences_preference*
}
get_nvts_response_nvt_preferences_timeout
= element timeout
{
text
}
get_nvts_response_nvt_preferences_preference
= element preference
{
get_nvts_response_nvt_preferences_preference_nvt
& get_nvts_response_nvt_preferences_preference_name
& get_nvts_response_nvt_preferences_preference_type
& get_nvts_response_nvt_preferences_preference_value
& get_nvts_response_nvt_preferences_preference_alt*
& get_nvts_response_nvt_preferences_preference_default
}
get_nvts_response_nvt_preferences_preference_nvt
= element nvt
{
attribute oid { oid }
& get_nvts_response_nvt_preferences_preference_nvt_name
}
get_nvts_response_nvt_preferences_preference_nvt_name
= element name
{
name
}
get_nvts_response_nvt_preferences_preference_name
= element name
{
text
}
get_nvts_response_nvt_preferences_preference_type
= element type
{
text
}
get_nvts_response_nvt_preferences_preference_value
= element value
{
text
}
get_nvts_response_nvt_preferences_preference_alt
= element alt
{
text
}
get_nvts_response_nvt_preferences_preference_default
= element default
{
text
}
7.58.3 Example: Get full NVT listing with details
Client
<get_nvts details="1"/> <get_nvts_response status="200"
status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.7.13005">
<name>Services</name>
<creation_time>2011-01-14T10:12:23+01:00</creation_time>
<modification_time>2012-09-19T20:56:15+02:00</modification_time>
<user_tags>
<count>0</count>
</user_tags>
<category>Services</category>
<copyright>GNU GPL v2</copyright>
<summary>Find what is listening on which port</summary>
<family>Service detection</family>
<version>$Revision: 1852 $</version>
<cvss_base/>
<cve_id>NOCVE</cve_id>
<bugtraq_id>NOBID</bugtraq_id>
<cert_refs/>
<xrefs>NOXREF</xrefs>
<tags>NOTAG</tags>
<preference_count>-1</preference_count>
<timeout/>
<preferences>
<timeout/>
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
<default>5</default>
</preference>
...
</preferences>
</nvt>
<nvt oid="1.3.6.1.4.1.25623.1.7.13006">
<name>FooBar 21</name>
<creation_time>2011-01-14T10:12:23+01:00</creation_time>
<modification_time>2012-09-19T20:56:15+02:00</modification_time>
<category>Services</category>
<copyright>GNU GPL v2</copyright>
<description>
This script detects whether the FooBar 2.1 XSS vulnerability is present.
</description>
...
</nvt>
...
</get_nvts_response>
7.58.3 Example: Get minimal information about one NVT
Client
<get_nvts nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/> <get_nvts_response status="200"
status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
<user_tags>
<count>0</count>
</user_tags>
</nvt>
</get_nvts_response>
7.59 Command get_nvt_familiesIn short: Get a list of all NVT families. The client uses the get_nvt_families command to get NVT family information. If the command sent by the client was valid, the manager will reply with a list of NVT families to the client. 7.59.1 Structure
7.59.2 RNC
Command
get_nvt_families
= element get_nvt_families
{
attribute sort_order { sort_order }?
}
get_nvt_families_response
= element get_nvt_families_response
{
attribute status { status }
& attribute status_text { text }
& get_nvt_families_response_families
}
get_nvt_families_response_families
= element families
{
get_nvt_families_response_families_family*
}
get_nvt_families_response_families_family
= element family
{
get_nvt_families_response_families_family_name
& get_nvt_families_response_families_family_max_nvt_count
}
get_nvt_families_response_families_family_name
= element name
{
name
}
get_nvt_families_response_families_family_max_nvt_count
= element max_nvt_count
{
integer
}
7.59.3 Example: Get the NVT families
Client
<get_nvt_families/> <get_nvt_families_response status="200"
status_text="OK">
<families>
<family>
<name>Credentials</name>
<max_nvt_count>8</max_nvt_count>
</family>
<family>
<name>Port scanners</name>
<max_nvt_count>12</max_nvt_count>
</family>
...
</families>
</get_nvt_families_response>
7.60 Command get_overridesIn short: Get one or many overrides. The client uses the get_overrides command to get override information. If the command sent by the client was valid, the manager will reply with a list of overrides to the client. 7.60.1 Structure
7.60.2 RNC
Command
get_overrides
= element get_overrides
{
attribute override_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute nvt_oid { oid }?
& attribute task_id { uuid }?
& attribute details { boolean }?
& attribute result { boolean }?
}
get_overrides_response
= element get_overrides_response
{
attribute status { status }
& attribute status_text { text }
& get_overrides_response_override*
& get_overrides_response_filters
& get_overrides_response_sort
& get_overrides_response_overrides
& get_overrides_response_override_count
}
get_overrides_response_filters
= element filters
{
attribute id { uuid }
& get_overrides_response_filters_term
& get_overrides_response_filters_name?
& get_overrides_response_filters_keywords
}
get_overrides_response_filters_term
= element term
{
text
}
get_overrides_response_filters_name
= element name
{
text
}
get_overrides_response_filters_keywords
= element keywords
{
get_overrides_response_filters_keywords_keyword*
}
get_overrides_response_filters_keywords_keyword
= element keyword
{
get_overrides_response_filters_keywords_keyword_column
& get_overrides_response_filters_keywords_keyword_relation
& get_overrides_response_filters_keywords_keyword_value
}
get_overrides_response_filters_keywords_keyword_column
= element column
{
text
}
get_overrides_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_overrides_response_filters_keywords_keyword_value
= element value
{
text
}
get_overrides_response_sort
= element sort
{
text
& get_overrides_response_sort_field
}
get_overrides_response_sort_field
= element field
{
get_overrides_response_sort_field_order
}
get_overrides_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_overrides_response_overrides
= element overrides
{
attribute start { integer }
& attribute max { integer }
}
get_overrides_response_override_count
= element override_count
{
get_overrides_response_override_count_filtered
& get_overrides_response_override_count_page
}
get_overrides_response_override_count_filtered
= element filtered
{
integer
}
get_overrides_response_override_count_page
= element page
{
integer
}
get_overrides_response_override
= element override # type override
{
attribute id { uuid }
& override_permissions
& override_owner
& override_nvt
& override_creation_time
& override_modification_time
& override_writable
& override_in_use
& override_active
& override_text
& override_threat
& override_severity
& override_new_threat
& override_new_severity
& override_orphan
& override_permissions
& override_user_tags
& ( override_hosts
& override_port
& override_task
& override_end_time?
& override_result? )?
}
7.60.3 Example: Get one or many overrides
Client
<get_overrides/> <get_overrides_response status="200"
status_text="OK">
<override id="b76b81a7-9df8-42df-afff-baa9d4620128">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
</nvt>
<creation_time>2013-01-09T09:50:10+01:00</creation_time>
<modification_time>2013-01-09T09:50:10+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<active>1</active>
<text excerpt="0">This is the full text of the override.</text>
<new_threat>Log</new_threat>
<new_severity>0.0</new_severity>
<orphan>1</orphan>
<user_tags>
<count>0</count>
</user_tags>
</override>
...
</get_overrides_response>
7.60.3 Example: Get details of a single override
Client
<get_overrides override_id="7f618bbb-4664-419e-9bbf-367d93954cb0"
details="1"/>
<get_overrides_response status="200"
status_text="OK">
<override id="7f618bbb-4664-419e-9bbf-367d93954cb0">
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
</nvt>
<creation_time>Sun Jun 27 08:49:46 2010</creation_time>
<modification_time>Sun Jun 27 08:49:46 2010</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<active>1</active>
<end_time/>
<text>override fixed to result</text>
<hosts>127.0.0.1</hosts>
<port>general/tcp</port>
<threat>Medium</threat>
<new_threat>Low</new_threat>
<new_severity>2.0</new_severity>
<task id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4">
<name>test</name>
</task>
<orphan>0</orphan>
<user_tags>
<count>0</count>
</user_tags>
<result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de"/>
</override>
...
</get_overrides_response>
7.61 Command get_permissionsIn short: Get one or many permissions. The client uses the get_permissions command to get permission information. 7.61.1 Structure
7.61.2 RNC
Command
get_permissions
= element get_permissions
{
attribute permission_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
}
get_permissions_response
= element get_permissions_response
{
attribute status { status }
& attribute status_text { text }
& get_permissions_response_permission*
& get_permissions_response_filters
& get_permissions_response_sort
& get_permissions_response_permissions
& get_permissions_response_permission_count
}
get_permissions_response_permission
= element permission
{
attribute id { uuid }
& get_permissions_response_permission_owner
& get_permissions_response_permission_name
& get_permissions_response_permission_comment
& get_permissions_response_permission_creation_time
& get_permissions_response_permission_modification_time
& get_permissions_response_permission_writable
& get_permissions_response_permission_in_use
& get_permissions_response_permission_permissions
& get_permissions_response_permission_user_tags
& get_permissions_response_permission_resource
& get_permissions_response_permission_subject
}
get_permissions_response_permission_owner
= element owner
{
get_permissions_response_permission_owner_name
}
get_permissions_response_permission_owner_name
= element name
{
name
}
get_permissions_response_permission_name
= element name
{
name
}
get_permissions_response_permission_comment
= element comment
{
text
}
get_permissions_response_permission_creation_time
= element creation_time
{
iso_time
}
get_permissions_response_permission_modification_time
= element modification_time
{
iso_time
}
get_permissions_response_permission_resource
= element resource
{
attribute id { uuid }?
& get_permissions_response_permission_resource_name
& get_permissions_response_permission_resource_permissions?
& get_permissions_response_permission_resource_type
& get_permissions_response_permission_resource_trash
& get_permissions_response_permission_resource_deleted
}
get_permissions_response_permission_resource_name
= element name
{
text
}
get_permissions_response_permission_resource_permissions
= element permissions
{
""
}
get_permissions_response_permission_resource_type
= element type
{
text
}
get_permissions_response_permission_resource_trash
= element trash
{
boolean
}
get_permissions_response_permission_resource_deleted
= element deleted
{
boolean
}
get_permissions_response_permission_subject
= element subject
{
attribute id { uuid }?
& get_permissions_response_permission_subject_name
& get_permissions_response_permission_subject_permissions?
& get_permissions_response_permission_subject_type
& get_permissions_response_permission_subject_trash
}
get_permissions_response_permission_subject_name
= element name
{
text
}
get_permissions_response_permission_subject_permissions
= element permissions
{
""
}
get_permissions_response_permission_subject_type
= element type
{
text
}
get_permissions_response_permission_subject_trash
= element trash
{
boolean
}
get_permissions_response_permission_subject_deleted
= element deleted
{
boolean
}
get_permissions_response_permission_writable
= element writable
{
boolean
}
get_permissions_response_permission_in_use
= element in_use
{
boolean
}
get_permissions_response_permission_permissions
= element permissions
{
get_permissions_response_permission_permissions_permission*
}
get_permissions_response_permission_permissions_permission
= element permission
{
get_permissions_response_permission_permissions_permission_name
}
get_permissions_response_permission_permissions_permission_name
= element name
{
name
}
get_permissions_response_permission_user_tags
= element user_tags
{
get_permissions_response_permission_user_tags_count
& get_permissions_response_permission_user_tags_tag*
}
get_permissions_response_permission_user_tags_count
= element count
{
integer
}
get_permissions_response_permission_user_tags_tag
= element tag
{
attribute id { uuid }
& get_permissions_response_permission_user_tags_tag_name
& get_permissions_response_permission_user_tags_tag_value
& get_permissions_response_permission_user_tags_tag_comment
}
get_permissions_response_permission_user_tags_tag_name
= element name
{
text
}
get_permissions_response_permission_user_tags_tag_value
= element value
{
text
}
get_permissions_response_permission_user_tags_tag_comment
= element comment
{
text
}
get_permissions_response_filters
= element filters
{
attribute id { uuid }
& get_permissions_response_filters_term
& get_permissions_response_filters_name?
& get_permissions_response_filters_keywords
}
get_permissions_response_filters_term
= element term
{
text
}
get_permissions_response_filters_name
= element name
{
text
}
get_permissions_response_filters_keywords
= element keywords
{
get_permissions_response_filters_keywords_keyword*
}
get_permissions_response_filters_keywords_keyword
= element keyword
{
get_permissions_response_filters_keywords_keyword_column
& get_permissions_response_filters_keywords_keyword_relation
& get_permissions_response_filters_keywords_keyword_value
}
get_permissions_response_filters_keywords_keyword_column
= element column
{
text
}
get_permissions_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_permissions_response_filters_keywords_keyword_value
= element value
{
text
}
get_permissions_response_sort
= element sort
{
text
& get_permissions_response_sort_field
}
get_permissions_response_sort_field
= element field
{
get_permissions_response_sort_field_order
}
get_permissions_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_permissions_response_permissions
= element permissions
{
attribute start { integer }
& attribute max { integer }
}
get_permissions_response_permission_count
= element permission_count
{
get_permissions_response_permission_count_filtered
& get_permissions_response_permission_count_page
}
get_permissions_response_permission_count_filtered
= element filtered
{
integer
}
get_permissions_response_permission_count_page
= element page
{
integer
}
7.61.3 Example: Get one or many permissions
Client
<get_permissions/> <get_permissions_response status="200"
status_text="OK">
<permission id="b493b7a8-7489-11df-a3ec-002264764cea">
<name>Management</name>
<comment>Managers</comment>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<users>sarah, frank</users>
</permission>
...
<filters id="">
<term>first=1 rows=-1 sort=name</term>
<keywords>
<keyword>
<column>first</column>
<relation>=</relation>
<value>1</value>
</keyword>
...
</keywords>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<permissions max="-1"
start="1"/>
<permission_count>
1
<filtered>1</filtered>
<page>1</page>
</permission_count>
</get_permissions_response>
7.62 Command get_port_listsIn short: Get one or many port lists. The client uses the get_port_lists command to get port list information. 7.62.1 Structure
7.62.2 RNC
Command
get_port_lists
= element get_port_lists
{
attribute port_list_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute details { boolean }?
& attribute targets { boolean }?
& attribute trash { boolean }?
}
get_port_lists_response
= element get_port_lists_response
{
attribute status { status }
& attribute status_text { text }
& get_port_lists_response_port_list*
& get_port_lists_response_filters
& get_port_lists_response_sort
& get_port_lists_response_port_lists
& get_port_lists_response_port_list_count
}
get_port_lists_response_port_list
= element port_list
{
attribute id { uuid }
& get_port_lists_response_port_list_owner
& get_port_lists_response_port_list_name
& get_port_lists_response_port_list_comment
& get_port_lists_response_port_list_creation_time
& get_port_lists_response_port_list_modification_time
& get_port_lists_response_port_list_writable
& get_port_lists_response_port_list_in_use
& get_port_lists_response_port_list_permissions
& get_port_lists_response_port_list_user_tags
& get_port_lists_response_port_list_port_count
& get_port_lists_response_port_list_port_ranges?
& get_port_lists_response_port_list_targets?
}
get_port_lists_response_port_list_owner
= element owner
{
get_port_lists_response_port_list_owner_name
}
get_port_lists_response_port_list_owner_name
= element name
{
name
}
get_port_lists_response_port_list_name
= element name
{
name
}
get_port_lists_response_port_list_comment
= element comment
{
text
}
get_port_lists_response_port_list_creation_time
= element creation_time
{
iso_time
}
get_port_lists_response_port_list_modification_time
= element modification_time
{
iso_time
}
get_port_lists_response_port_list_writable
= element writable
{
boolean
}
get_port_lists_response_port_list_in_use
= element in_use
{
boolean
}
get_port_lists_response_port_list_permissions
= element permissions
{
get_port_lists_response_port_list_permissions_permission*
}
get_port_lists_response_port_list_permissions_permission
= element permission
{
get_port_lists_response_port_list_permissions_permission_name
}
get_port_lists_response_port_list_permissions_permission_name
= element name
{
name
}
get_port_lists_response_port_list_user_tags
= element user_tags
{
get_port_lists_response_port_list_user_tags_count
& get_port_lists_response_port_list_user_tags_tag*
}
get_port_lists_response_port_list_user_tags_count
= element count
{
integer
}
get_port_lists_response_port_list_user_tags_tag
= element tag
{
attribute id { uuid }
& get_port_lists_response_port_list_user_tags_tag_name
& get_port_lists_response_port_list_user_tags_tag_value
& get_port_lists_response_port_list_user_tags_tag_comment
}
get_port_lists_response_port_list_user_tags_tag_name
= element name
{
text
}
get_port_lists_response_port_list_user_tags_tag_value
= element value
{
text
}
get_port_lists_response_port_list_user_tags_tag_comment
= element comment
{
text
}
get_port_lists_response_port_list_port_count
= element port_count
{
get_port_lists_response_port_list_port_count_all
& get_port_lists_response_port_list_port_count_tcp
& get_port_lists_response_port_list_port_count_udp
}
get_port_lists_response_port_list_port_count_all
= element all
{
integer
}
get_port_lists_response_port_list_port_count_tcp
= element tcp
{
integer
}
get_port_lists_response_port_list_port_count_udp
= element udp
{
integer
}
get_port_lists_response_port_list_port_ranges
= element port_ranges
{
get_port_lists_response_port_list_port_ranges_port_range*
}
get_port_lists_response_port_list_port_ranges_port_range
= element port_range
{
attribute id { uuid }
& get_port_lists_response_port_list_port_ranges_port_range_start
& get_port_lists_response_port_list_port_ranges_port_range_end
& get_port_lists_response_port_list_port_ranges_port_range_type
& get_port_lists_response_port_list_port_ranges_port_range_comment
}
get_port_lists_response_port_list_port_ranges_port_range_start
= element start
{
integer
}
get_port_lists_response_port_list_port_ranges_port_range_end
= element end
{
integer
}
get_port_lists_response_port_list_port_ranges_port_range_type
= element type
{
text
}
get_port_lists_response_port_list_port_ranges_port_range_comment
= element comment
{
text
}
get_port_lists_response_port_list_targets
= element targets
{
get_port_lists_response_port_list_targets_target*
}
get_port_lists_response_port_list_targets_target
= element target
{
attribute id { uuid }
& get_port_lists_response_port_list_targets_target_name
& get_port_lists_response_port_list_targets_target_permissions?
}
get_port_lists_response_port_list_targets_target_name
= element name
{
name
}
get_port_lists_response_port_list_targets_target_permissions
= element permissions
{
""
}
get_port_lists_response_filters
= element filters
{
attribute id { uuid }
& get_port_lists_response_filters_term
& get_port_lists_response_filters_name?
& get_port_lists_response_filters_keywords
}
get_port_lists_response_filters_term
= element term
{
text
}
get_port_lists_response_filters_name
= element name
{
text
}
get_port_lists_response_filters_keywords
= element keywords
{
get_port_lists_response_filters_keywords_keyword*
}
get_port_lists_response_filters_keywords_keyword
= element keyword
{
get_port_lists_response_filters_keywords_keyword_column
& get_port_lists_response_filters_keywords_keyword_relation
& get_port_lists_response_filters_keywords_keyword_value
}
get_port_lists_response_filters_keywords_keyword_column
= element column
{
text
}
get_port_lists_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_port_lists_response_filters_keywords_keyword_value
= element value
{
text
}
get_port_lists_response_sort
= element sort
{
text
& get_port_lists_response_sort_field
}
get_port_lists_response_sort_field
= element field
{
get_port_lists_response_sort_field_order
}
get_port_lists_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_port_lists_response_port_lists
= element port_lists
{
attribute start { integer }
& attribute max { integer }
}
get_port_lists_response_port_list_count
= element port_list_count
{
get_port_lists_response_port_list_count_filtered
& get_port_lists_response_port_list_count_page
}
get_port_lists_response_port_list_count_filtered
= element filtered
{
integer
}
get_port_lists_response_port_list_count_page
= element page
{
integer
}
7.62.3 Example: Export a port list
Client
<get_port_lists port_list_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"
details="1"
targets="1"/>
<get_port_lists_response status="200"
status_text="OK">
<port_list id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
<name>All TCP</name>
<comment>Every single TCP port.</comment>
<creation_time>2012-12-31T16:38:45+01:00</creation_time>
<modification_time>2012-12-31T16:38:45+01:00</modification_time>
<writable>0</writable>
<in_use>1</in_use>
<user_tags>
<count>0</count>
</user_tags>
<port_count>
<all>65535</all>
<tcp>65535</tcp>
<udp>0</udp>
</port_count>
<port_ranges>
<port_range>
<type>TCP</type>
<start>1</start>
<end>65535</end>
</port_range>
</port_ranges>
<targets>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>Web server</name>
</target>
</targets>
</port_list>
</get_port_lists_response>
7.63 Command get_preferencesIn short: Get one or many preferences. The client uses the get_preferences command to get preference information. If the command sent by the client was valid, the manager will reply with a list of preferences to the client. If the manager cannot access a list of available NVTs at present, it will reply with the 503 response. When the command includes a config_id attribute, the preference element includes the preference name, type and value, and the NVT to which the preference applies. Otherwise, the preference element includes just the name and value, with the NVT and type built into the name. 7.63.1 Structure
7.63.2 RNC
Command
get_preferences
= element get_preferences
{
attribute nvt_oid { oid }?
& attribute config_id { uuid }?
& attribute preference { text }?
}
get_preferences_response
= element get_preferences_response
{
attribute status { status }
& attribute status_text { text }
& get_preferences_response_preference*
}
get_preferences_response_preference
= element preference
{
get_preferences_response_preference_nvt
& get_preferences_response_preference_name
& get_preferences_response_preference_type
& get_preferences_response_preference_value
& get_preferences_response_preference_alt*
& get_preferences_response_preference_default
}
get_preferences_response_preference_nvt
= element nvt
{
attribute oid { oid }
& get_preferences_response_preference_nvt_name
}
get_preferences_response_preference_nvt_name
= element name
{
name
}
get_preferences_response_preference_name
= element name
{
name
}
get_preferences_response_preference_type
= element type
{
text
}
get_preferences_response_preference_value
= element value
{
text
}
get_preferences_response_preference_alt
= element alt
{
text
}
get_preferences_response_preference_default
= element default
{
text
}
7.63.3 Example: Get default preferences for all NVTs
Client
<get_preferences/> <get_preferences_response status="200"
status_text="OK">
<preference>
<name>Services[entry]:Network connection timeout :</name>
<value>5</value>
</preference>
...
</get_preferences_response>
7.63.3 Example: Get default preferences for a single NVT
Client
<get_preferences nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/> <get_preferences_response status="200"
status_text="OK">
<preference>
<name>Services[entry]:Network connection timeout :</name>
<value>5</value>
<default>5</default>
</preference>
...
</get_preferences_response>
7.63.3 Example: Get preferences from a config for all NVTs
Client
<get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea"/> <get_preferences_response status="200"
status_text="OK">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
</preference>
...
</get_preferences_response>
7.63.3 Example: Get preferences from a config for a single NVT
Client
<get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea"
nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
<get_preferences nvt_oid="1.3.6.1.4.1.25623.1.0.10330">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
<default>5</default>
</preference>
</get_preferences>
7.64 Command get_reportsIn short: Get one or many reports. The client uses the get_reports command to get report information. The XML report format is sent as XML. All other formats are sent in Base64 encoding. 7.64.1 Structure
7.64.2 RNC
Command
get_reports
= element get_reports
{
attribute report_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute report_filter { text }?
& attribute report_filt_id { uuid }?
& attribute type { xsd:token { pattern = "scan|assets|prognostic" } }?
& attribute format_id { uuid }?
& attribute alert_id { uuid }?
& attribute note_details { boolean }?
& attribute override_details { boolean }?
& attribute host { text }?
& attribute host_first_result { integer }?
& attribute host_max_results { integer }?
& attribute host_levels { levels }?
& attribute host_search_phrase { text }?
& attribute pos { integer }?
& attribute delta_report_id { uuid }?
& attribute ignore_pagination { boolean }?
}
get_reports_response
= element get_reports_response
{
attribute status { status }
& attribute status_text { text }
& get_reports_response_report*
& ( get_reports_response_filters
& get_reports_response_sort
& get_reports_response_reports
& get_reports_response_report_count )?
}
get_reports_response_report
= element report # type report
{
text # RNC limitation: base64
& attribute id { uuid }
& attribute format_id { uuid }
& attribute extension { text }
& attribute content_type { text }
& attribute type { xsd:token { pattern = "scan|assets|prognostic" } }?
& report_owner
& report_name
& report_comment
& report_creation_time
& report_modification_time
& report_writable
& report_in_use
& report_task
& report_report_format
& report_report
}
get_reports_response_filters
= element filters
{
attribute id { uuid }
& get_reports_response_filters_term
& get_reports_response_filters_name?
& get_reports_response_filters_filter*
& get_reports_response_filters_host?
& get_reports_response_filters_delta?
& get_reports_response_filters_keywords
}
get_reports_response_filters_term
= element term
{
text
}
get_reports_response_filters_name
= element name
{
text
}
get_reports_response_filters_filter
= element filter
{
xsd:token { pattern = "High|Medium|Low|Log|Debug" }
}
get_reports_response_filters_host
= element host
{
get_reports_response_filters_host_ip
}
get_reports_response_filters_host_ip
= element ip
{
text
}
get_reports_response_filters_delta
= element delta
{
text
& get_reports_response_filters_delta_changed
& get_reports_response_filters_delta_gone
& get_reports_response_filters_delta_new
& get_reports_response_filters_delta_same
}
get_reports_response_filters_delta_changed
= element changed
{
boolean
}
get_reports_response_filters_delta_gone
= element gone
{
boolean
}
get_reports_response_filters_delta_new
= element new
{
boolean
}
get_reports_response_filters_delta_same
= element same
{
boolean
}
get_reports_response_filters_keywords
= element keywords
{
get_reports_response_filters_keywords_keyword*
}
get_reports_response_filters_keywords_keyword
= element keyword
{
get_reports_response_filters_keywords_keyword_column
& get_reports_response_filters_keywords_keyword_relation
& get_reports_response_filters_keywords_keyword_value
}
get_reports_response_filters_keywords_keyword_column
= element column
{
text
}
get_reports_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_reports_response_filters_keywords_keyword_value
= element value
{
text
}
get_reports_response_sort
= element sort
{
text
& get_reports_response_sort_field
}
get_reports_response_sort_field
= element field
{
get_reports_response_sort_field_order
}
get_reports_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_reports_response_reports
= element reports
{
attribute start { integer }
& attribute max { integer }
}
get_reports_response_report_count
= element report_count
{
get_reports_response_report_count_filtered
& get_reports_response_report_count_page
}
get_reports_response_report_count_filtered
= element filtered
{
integer
}
get_reports_response_report_count_page
= element page
{
integer
}
7.64.3 Example: Get a report in PDF
Client
<get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
format_id="1a60a67e-97d0-4cbf-bc77-f71b08e7043d"/>
<get_reports_response status="200"
status_text="OK">
<report id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
format_id="1a60a67e-97d0-4cbf-bc77-f71b08e7043d"
extension="pdf"
content_type="application/pdf">hsisn3qaVFhkjFRG4...</report>
</get_reports_response>
7.64.3 Example: Get a report in XML
Client
<get_reports report_id="f0fdf522-276d-4893-9274-fb8699dc2270"/> <get_reports_response status="200"
status_text="OK">
<report id="f0fdf522-276d-4893-9274-fb8699dc2270"
format_id="d5da9f67-8551-4e51-807b-b6a873d70e34"
extension="xml"
content_type="text/xml">
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<omp>
<version>7.0</version>
</omp>
<sort>
<field>
type
<order>descending</order>
</field>
</sort>
<filters id="0">
<term>first=1 rows=-1 sort=name</term>
<filter>High</filter>
<filter>Medium</filter>
<filter>Low</filter>
<filter>Log</filter>
<filter>Debug</filter>
<keywords>
<keyword>
<column>first</column>
<relation>=</relation>
<value>1</value>
</keyword>
<keyword>
<column>rows</column>
<relation>=</relation>
<value>-1</value>
</keyword>
<keyword>
<column>sort</column>
<relation>=</relation>
<value>name</value>
</keyword>
</keywords>
</filters>
<user_tags>
<count>0</count>
</user_tags>
<scan_run_status>Done</scan_run_status>
<hosts>
<count>1</count>
</hosts>
<closed_cves>
<count>0</count>
</closed_cves>
<vulns>
<count>3</count>
</vulns>
<os>
<count>1</count>
</os>
<apps>
<count>2</count>
</apps>
<ssl_certs>
<count>0</count>
</ssl_certs>
<result_count>
<full>10</full>
<filtered>10</filtered>
<debug>
<full>0</full>
<filtered>0</filtered>
</debug>
<hole>
<full>0</full>
<filtered>0</filtered>
</hole>
<info>
<full>7</full>
<filtered>7</filtered>
</info>
<log>
<full>0</full>
<filtered>0</filtered>
</log>
<warning>
<full>3</full>
<filtered>3</filtered>
</warning>
</result_count>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>dik mm</name>
</task>
<scan>
<task/>
</scan>
<timestamp>2010-02-02T19:11:21+00:00</timestamp>
<scan_start>2010-02-02T19:11:21+00:00</scan_start>
<timezone>UTC</timezone>
<timezone_abbrev>UTC</timezone_abbrev>
<ports start="1"
max="-1">
<port>
general/tcp
<host>127.0.1.1</host>
<severity>5.0</severity>
<threat>Medium</threat>
</port>
...
</ports>
<results start="1"
max="-1">
<result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
<host>127.0.1.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.74">
<name>Test NVT: fields with ISO-8859-1 chars ()</name>
<cvss_base>5.0</cvss_base>
<cve>CVE-2013-1406</cve>
<bid>51702</bid>
<tags>NOTAGS</tags>
<cert>
<cert_ref id="DFN-CERT-2013-0246"
type="DFN-CERT"/>
</cert>
<xref>NOXREF</xref>
</nvt>
<threat>Medium</threat>
<description>Test with umlaut Warning Port 0.</description>
</result>
...
</results>
<host_start>
2010-02-02T19:11:21+00:00
<host>127.0.1.1</host>
</host_start>
<host_end>
2010-02-02T19:11:52+00:00
<host>127.0.1.1</host>
</host_end>
<scan_end>2010-02-02T19:11:52+00:00</scan_end>
<errors>
<count>0</count>
</errors>
</report>
</report>
</get_reports_response>
7.65 Command get_report_formatsIn short: Get one or many report formats. The client uses the get_report_formats command to get report format information. 7.65.1 Structure
7.65.2 RNC
Command
get_report_formats
= element get_report_formats
{
attribute report_format_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute alerts { boolean }?
& attribute params { boolean }?
& attribute details { boolean }?
}
get_report_formats_response
= element get_report_formats_response
{
attribute status { status }
& attribute status_text { text }
& get_report_formats_response_report_format*
& get_report_formats_response_filters
& get_report_formats_response_sort
& get_report_formats_response_report_formats
& get_report_formats_response_report_format_count
}
get_report_formats_response_report_format
= element report_format
{
attribute id { uuid }
& get_report_formats_response_report_format_owner
& get_report_formats_response_report_format_name
& get_report_formats_response_report_format_creation_time
& get_report_formats_response_report_format_modification_time
& get_report_formats_response_report_format_writable
& get_report_formats_response_report_format_in_use
& get_report_formats_response_report_format_permissions
& get_report_formats_response_report_format_user_tags
& get_report_formats_response_report_format_extension
& get_report_formats_response_report_format_content_type
& get_report_formats_response_report_format_summary
& get_report_formats_response_report_format_description
& get_report_formats_response_report_format_predefined
& get_report_formats_response_report_format_alerts?
& ( get_report_formats_response_report_format_file*
& get_report_formats_response_report_format_signature )?
& get_report_formats_response_report_format_trust
& get_report_formats_response_report_format_active
& get_report_formats_response_report_format_param*
}
get_report_formats_response_report_format_owner
= element owner
{
get_report_formats_response_report_format_owner_name
}
get_report_formats_response_report_format_owner_name
= element name
{
name
}
get_report_formats_response_report_format_name
= element name
{
name
}
get_report_formats_response_report_format_creation_time
= element creation_time
{
iso_time
}
get_report_formats_response_report_format_modification_time
= element modification_time
{
iso_time
}
get_report_formats_response_report_format_writable
= element writable
{
boolean
}
get_report_formats_response_report_format_in_use
= element in_use
{
boolean
}
get_report_formats_response_report_format_permissions
= element permissions
{
get_report_formats_response_report_format_permissions_permission*
}
get_report_formats_response_report_format_permissions_permission
= element permission
{
get_report_formats_response_report_format_permissions_permission_name
}
get_report_formats_response_report_format_permissions_permission_name
= element name
{
name
}
get_report_formats_response_report_format_user_tags
= element user_tags
{
get_report_formats_response_report_format_user_tags_count
& get_report_formats_response_report_format_user_tags_tag*
}
get_report_formats_response_report_format_user_tags_count
= element count
{
integer
}
get_report_formats_response_report_format_user_tags_tag
= element tag
{
attribute id { uuid }
& get_report_formats_response_report_format_user_tags_tag_name
& get_report_formats_response_report_format_user_tags_tag_value
& get_report_formats_response_report_format_user_tags_tag_comment
}
get_report_formats_response_report_format_user_tags_tag_name
= element name
{
text
}
get_report_formats_response_report_format_user_tags_tag_value
= element value
{
text
}
get_report_formats_response_report_format_user_tags_tag_comment
= element comment
{
text
}
get_report_formats_response_report_format_summary
= element summary
{
text
}
get_report_formats_response_report_format_description
= element description
{
text
}
get_report_formats_response_report_format_extension
= element extension
{
text
}
get_report_formats_response_report_format_content_type
= element content_type
{
text
}
get_report_formats_response_report_format_predefined
= element predefined
{
boolean
}
get_report_formats_response_report_format_alerts
= element alerts
{
get_report_formats_response_report_format_alerts_alert*
}
get_report_formats_response_report_format_alerts_alert
= element alert
{
attribute id { uuid }
& get_report_formats_response_report_format_alerts_alert_name
& get_report_formats_response_report_format_alerts_alert_permissions?
}
get_report_formats_response_report_format_alerts_alert_name
= element name
{
name
}
get_report_formats_response_report_format_alerts_alert_permissions
= element permissions
{
""
}
get_report_formats_response_report_format_param
= element param
{
get_report_formats_response_report_format_param_name
& get_report_formats_response_report_format_param_type
& get_report_formats_response_report_format_param_value
& get_report_formats_response_report_format_param_default
}
get_report_formats_response_report_format_param_name
= element name
{
name
}
get_report_formats_response_report_format_param_type
= element type
{
text # RNC limitation: xsd:token { pattern = "boolean|integer|selection|string|text|report_format_list" }
& get_report_formats_response_report_format_param_type_min?
& get_report_formats_response_report_format_param_type_max?
& get_report_formats_response_report_format_param_type_options?
}
get_report_formats_response_report_format_param_type_min
= element min
{
text
}
get_report_formats_response_report_format_param_type_max
= element max
{
text
}
get_report_formats_response_report_format_param_type_options
= element options
{
get_report_formats_response_report_format_param_type_options_option*
}
get_report_formats_response_report_format_param_type_options_option
= element option
{
text
}
get_report_formats_response_report_format_param_value
= element value
{
get_report_formats_response_report_format_param_value_report_format*
}
get_report_formats_response_report_format_param_value_report_format
= element report_format
{
attribute id { uuid }
& get_report_formats_response_report_format_param_value_report_format_name
}
get_report_formats_response_report_format_param_value_report_format_name
= element name
{
text
}
get_report_formats_response_report_format_param_default
= element default
{
text
}
get_report_formats_response_report_format_file
= element file
{
text # RNC limitation: base64
& attribute name { text }
}
get_report_formats_response_report_format_signature
= element signature
{
text
}
get_report_formats_response_report_format_trust
= element trust
{
text # RNC limitation: xsd:token { pattern = "yes|no|unknown" }
& attribute name { text }
& get_report_formats_response_report_format_trust_time
}
get_report_formats_response_report_format_trust_time
= element time
{
iso_time
}
get_report_formats_response_report_format_active
= element active
{
boolean
}
get_report_formats_response_filters
= element filters
{
attribute id { uuid }
& get_report_formats_response_filters_term
& get_report_formats_response_filters_name?
& get_report_formats_response_filters_keywords
}
get_report_formats_response_filters_term
= element term
{
text
}
get_report_formats_response_filters_name
= element name
{
text
}
get_report_formats_response_filters_keywords
= element keywords
{
get_report_formats_response_filters_keywords_keyword*
}
get_report_formats_response_filters_keywords_keyword
= element keyword
{
get_report_formats_response_filters_keywords_keyword_column
& get_report_formats_response_filters_keywords_keyword_relation
& get_report_formats_response_filters_keywords_keyword_value
}
get_report_formats_response_filters_keywords_keyword_column
= element column
{
text
}
get_report_formats_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_report_formats_response_filters_keywords_keyword_value
= element value
{
text
}
get_report_formats_response_sort
= element sort
{
text
& get_report_formats_response_sort_field
}
get_report_formats_response_sort_field
= element field
{
get_report_formats_response_sort_field_order
}
get_report_formats_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_report_formats_response_report_formats
= element report_formats
{
attribute start { integer }
& attribute max { integer }
}
get_report_formats_response_report_format_count
= element report_format_count
{
get_report_formats_response_report_format_count_filtered
& get_report_formats_response_report_format_count_page
}
get_report_formats_response_report_format_count_filtered
= element filtered
{
integer
}
get_report_formats_response_report_format_count_page
= element page
{
integer
}
7.65.3 Example: Get information about a report format
Client
<get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"/> <get_report_formats_response status="200"
status_text="OK">
<report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
<name>HTML</name>
<creation_time>2013-01-31T16:46:32+01:00</creation_time>
<modification_time>2013-01-31T16:46:32+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<extension>html</extension>
<content_type>text/html</content_type>
<summary>Single page HTML report.</summary>
<description>
A single HTML page listing results of a scan. Style information
...
</description>
<predefined>1</predefined>
<trust>
no
<time>Thu Dec 2 13:22:26 2010</time>
</trust>
<active>1</active>
</report_format>
...
</get_report_formats_response>
7.65.3 Example: Export a report format
Client
<get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"
details="1"/>
<get_report_formats_response status="200"
status_text="OK">
<report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
<name>HTML</name>
<comment/>
<creation_time>2013-01-18T18:23:53+01:00</creation_time>
<modification_time>2013-01-18T18:24:10+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<extension>html</extension>
<content_type>text/html</content_type>
<summary>Single page HTML report.</summary>
<description>
A single HTML page listing results of a scan. Style information
...
</description>
<predefined>1</predefined>
<file name="HTML.xsl">
PD9ldD4K
...
</file>
<file name="generate">
IyEvAk
...
</file>
<signature/>
</report_format>
...
</get_report_formats_response>
7.66 Command get_resultsIn short: Get results. The client uses the get_results command to get result information. If the request includes a notes flag, an overrides flag or an apply_overrides flag and any of these is true, then the request must also include a task ID. 7.66.1 Structure
7.66.2 RNC
Command
get_results
= element get_results
{
attribute result_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute task_id { uuid }?
& attribute note_details { boolean }?
& attribute override_details { boolean }?
& attribute details { boolean }?
}
get_results_response
= element get_results_response
{
attribute status { status }
& attribute status_text { text }
& get_results_response_result*
& get_results_response_filters
& get_results_response_sort
& get_results_response_results
& get_results_response_result_count
}
get_results_response_result
= element result # type result
{
attribute id { uuid }
& result_name
& result_owner
& result_comment
& result_creation_time
& result_modification_time
& result_user_tags?
& result_report?
& result_task?
& result_host
& result_port
& result_nvt
& result_scan_nvt_version
& result_threat
& result_severity
& result_qod
& result_original_threat?
& result_original_severity?
& result_description
& result_delta?
& result_details
& result_detection
& result_notes?
& result_overrides?
}
get_results_response_filters
= element filters
{
attribute id { uuid }
& get_results_response_filters_term
& get_results_response_filters_name?
& get_results_response_filters_keywords
}
get_results_response_filters_term
= element term
{
text
}
get_results_response_filters_name
= element name
{
text
}
get_results_response_filters_keywords
= element keywords
{
get_results_response_filters_keywords_keyword*
}
get_results_response_filters_keywords_keyword
= element keyword
{
get_results_response_filters_keywords_keyword_column
& get_results_response_filters_keywords_keyword_relation
& get_results_response_filters_keywords_keyword_value
}
get_results_response_filters_keywords_keyword_column
= element column
{
text
}
get_results_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_results_response_filters_keywords_keyword_value
= element value
{
text
}
get_results_response_sort
= element sort
{
text
& get_results_response_sort_field
}
get_results_response_sort_field
= element field
{
get_results_response_sort_field_order
}
get_results_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_results_response_results
= element results
{
attribute start { integer }
& attribute max { integer }
}
get_results_response_result_count
= element result_count
{
get_results_response_result_count_filtered
& get_results_response_result_count_page
}
get_results_response_result_count_filtered
= element filtered
{
integer
}
get_results_response_result_count_page
= element page
{
integer
}
7.66.3 Example: Get one or many results
Client
<get_results/> <get_results_response status="200"
status_text="OK">
<result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
<owner>
<name>admin</name>
</owner>
<comment/>
<creation_time>2014-05-23T09:22:12Z</creation_time>
<modification_time>2014-05-23T09:22:12Z</modification_time>
<user_tags>
<count>0</count>
</user_tags>
<host>127.0.1.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.74">
<name>Test NVT: fields with ISO-8859-1 chars</name>
<cvss_base>5.0</cvss_base>
<cve>CVE-2009-3095</cve>
<bid>36254</bid>
<tags>NOTAGS</tags>
<cert/>
<xref>NOXREF</xref>
</nvt>
<threat>Medium</threat>
<description>Test with umlaut.</description>
</result>
...
<filters id="">
<term>first=1 rows=-1 sort=name</term>
<keywords>
<keyword>
<column>first</column>
<relation>=</relation>
<value>1</value>
</keyword>
...
</keywords>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<results max="-1"
start="1"/>
<result_count>
124
<filtered>124</filtered>
<page>124</page>
</result_count>
</get_results_response>
7.66.3 Example: Get a result, including notes and overrides
Client
<get_results result_id="cac9e7c8-c726-49fd-a710-5f99079ab93e"
task_id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4"
filter="notes=1 overrides=1"/>
<get_results_response status="200"
status_text="OK">
<result id="cac9e7c8-c726-49fd-a710-5f99079ab93e">
<owner>
<name>admin</name>
</owner>
<comment/>
<creation_time>2014-05-23T09:22:12Z</creation_time>
<modification_time>2014-05-23T09:22:12Z</modification_time>
<user_tags>
<count>0</count>
</user_tags>
<host>127.0.0.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
<cvss_base>9</cvss_base>
<cve>CVE-2009-3095</cve>
<bid>36254</bid>
<tags>NOTAGS</tags>
<cert/>
<xref>NOXREF</xref>
</nvt>
<threat>High</threat>
<description>Test with very long warning.</description>
<original_threat>Medium</original_threat>
<notes/>
<overrides>
<override id="b0832812-75f1-45eb-b676-99c6e6bf2b24">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
</nvt>
<text excerpt="0">Test override</text>
<new_threat>High</new_threat>
<orphan>0</orphan>
</override>
</overrides>
</result>
<filters id="">
<term>first=1 rows=-1 sort=name</term>
<keywords>
<keyword>
<column>first</column>
<relation>=</relation>
<value>1</value>
</keyword>
...
</keywords>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<results max="-1"
start="1"/>
<result_count>
1
<filtered>1</filtered>
<page>1</page>
</result_count>
</get_results_response>
7.67 Command get_rolesIn short: Get one or many roles. The client uses the get_roles command to get role information. 7.67.1 Structure
7.67.2 RNC
Command
get_roles
= element get_roles
{
attribute role_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
}
get_roles_response
= element get_roles_response
{
attribute status { status }
& attribute status_text { text }
& get_roles_response_role*
& get_roles_response_filters
& get_roles_response_sort
& get_roles_response_roles
& get_roles_response_role_count
}
get_roles_response_role
= element role
{
attribute id { uuid }
& get_roles_response_role_owner
& get_roles_response_role_name
& get_roles_response_role_comment
& get_roles_response_role_creation_time
& get_roles_response_role_modification_time
& get_roles_response_role_writable
& get_roles_response_role_in_use
& get_roles_response_role_permissions
& get_roles_response_role_user_tags
& get_roles_response_role_users
}
get_roles_response_role_owner
= element owner
{
get_roles_response_role_owner_name
}
get_roles_response_role_owner_name
= element name
{
name
}
get_roles_response_role_name
= element name
{
name
}
get_roles_response_role_comment
= element comment
{
text
}
get_roles_response_role_creation_time
= element creation_time
{
iso_time
}
get_roles_response_role_modification_time
= element modification_time
{
iso_time
}
get_roles_response_role_users
= element users
{
text
}
get_roles_response_role_writable
= element writable
{
boolean
}
get_roles_response_role_in_use
= element in_use
{
boolean
}
get_roles_response_role_permissions
= element permissions
{
get_roles_response_role_permissions_permission*
}
get_roles_response_role_permissions_permission
= element permission
{
get_roles_response_role_permissions_permission_name
}
get_roles_response_role_permissions_permission_name
= element name
{
name
}
get_roles_response_role_user_tags
= element user_tags
{
get_roles_response_role_user_tags_count
& get_roles_response_role_user_tags_tag*
}
get_roles_response_role_user_tags_count
= element count
{
integer
}
get_roles_response_role_user_tags_tag
= element tag
{
attribute id { uuid }
& get_roles_response_role_user_tags_tag_name
& get_roles_response_role_user_tags_tag_value
& get_roles_response_role_user_tags_tag_comment
}
get_roles_response_role_user_tags_tag_name
= element name
{
text
}
get_roles_response_role_user_tags_tag_value
= element value
{
text
}
get_roles_response_role_user_tags_tag_comment
= element comment
{
text
}
get_roles_response_filters
= element filters
{
attribute id { uuid }
& get_roles_response_filters_term
& get_roles_response_filters_name?
& get_roles_response_filters_keywords
}
get_roles_response_filters_term
= element term
{
text
}
get_roles_response_filters_name
= element name
{
text
}
get_roles_response_filters_keywords
= element keywords
{
get_roles_response_filters_keywords_keyword*
}
get_roles_response_filters_keywords_keyword
= element keyword
{
get_roles_response_filters_keywords_keyword_column
& get_roles_response_filters_keywords_keyword_relation
& get_roles_response_filters_keywords_keyword_value
}
get_roles_response_filters_keywords_keyword_column
= element column
{
text
}
get_roles_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_roles_response_filters_keywords_keyword_value
= element value
{
text
}
get_roles_response_sort
= element sort
{
text
& get_roles_response_sort_field
}
get_roles_response_sort_field
= element field
{
get_roles_response_sort_field_order
}
get_roles_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_roles_response_roles
= element roles
{
attribute start { integer }
& attribute max { integer }
}
get_roles_response_role_count
= element role_count
{
get_roles_response_role_count_filtered
& get_roles_response_role_count_page
}
get_roles_response_role_count_filtered
= element filtered
{
integer
}
get_roles_response_role_count_page
= element page
{
integer
}
7.67.3 Example: Get one or many roles
Client
<get_roles/> <get_roles_response status="200"
status_text="OK">
<role id="b493b7a8-7489-11df-a3ec-002264764cea">
<name>Management</name>
<comment>Managers</comment>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<users>sarah, frank</users>
</role>
...
<filters id="">
<term>first=1 rows=-1 sort=name</term>
<keywords>
<keyword>
<column>first</column>
<relation>=</relation>
<value>1</value>
</keyword>
...
</keywords>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<roles max="-1"
start="1"/>
<role_count>
1
<filtered>1</filtered>
<page>1</page>
</role_count>
</get_roles_response>
7.68 Command get_scannersIn short: Get one or many scanners. The client uses the get_scanners command to get scanner information. 7.68.1 Structure
7.68.2 RNC
Command
get_scanners
= element get_scanners
{
attribute scanner_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute details { boolean }?
}
get_scanners_response
= element get_scanners_response
{
attribute status { status }
& attribute status_text { text }
& get_scanners_response_scanner*
& get_scanners_response_filters
& get_scanners_response_sort
& get_scanners_response_scanners
& get_scanners_response_scanner_count
}
get_scanners_response_scanner
= element scanner
{
attribute id { uuid }
& get_scanners_response_scanner_owner
& get_scanners_response_scanner_name
& get_scanners_response_scanner_comment
& get_scanners_response_scanner_creation_time
& get_scanners_response_scanner_modification_time
& get_scanners_response_scanner_writable
& get_scanners_response_scanner_in_use
& get_scanners_response_scanner_permissions
& get_scanners_response_scanner_user_tags
& get_scanners_response_scanner_ca_pub_info
& get_scanners_response_scanner_certificate_info
& get_scanners_response_scanner_host
& get_scanners_response_scanner_port
& get_scanners_response_scanner_type
& get_scanners_response_scanner_ca_pub
& get_scanners_response_scanner_credential
& get_scanners_response_scanner_tasks?
}
get_scanners_response_scanner_owner
= element owner
{
get_scanners_response_scanner_owner_name
}
get_scanners_response_scanner_owner_name
= element name
{
name
}
get_scanners_response_scanner_name
= element name
{
name
}
get_scanners_response_scanner_comment
= element comment
{
text
}
get_scanners_response_scanner_creation_time
= element creation_time
{
iso_time
}
get_scanners_response_scanner_modification_time
= element modification_time
{
iso_time
}
get_scanners_response_scanner_writable
= element writable
{
boolean
}
get_scanners_response_scanner_in_use
= element in_use
{
boolean
}
get_scanners_response_scanner_permissions
= element permissions
{
get_scanners_response_scanner_permissions_permission*
}
get_scanners_response_scanner_permissions_permission
= element permission
{
get_scanners_response_scanner_permissions_permission_name
}
get_scanners_response_scanner_permissions_permission_name
= element name
{
name
}
get_scanners_response_scanner_user_tags
= element user_tags
{
get_scanners_response_scanner_user_tags_count
& get_scanners_response_scanner_user_tags_tag*
}
get_scanners_response_scanner_user_tags_count
= element count
{
integer
}
get_scanners_response_scanner_user_tags_tag
= element tag
{
attribute id { uuid }
& get_scanners_response_scanner_user_tags_tag_name
& get_scanners_response_scanner_user_tags_tag_value
& get_scanners_response_scanner_user_tags_tag_comment
}
get_scanners_response_scanner_user_tags_tag_name
= element name
{
text
}
get_scanners_response_scanner_user_tags_tag_value
= element value
{
text
}
get_scanners_response_scanner_user_tags_tag_comment
= element comment
{
text
}
get_scanners_response_scanner_ca_pub_info
= element ca_pub_info # type certificate_info
{
certificate_info_time_status
& certificate_info_activation_time
& certificate_info_expiration_time
& certificate_info_issuer
& certificate_info_md5_fingerprint
}
get_scanners_response_scanner_certificate_info
= element certificate_info # type certificate_info
{
certificate_info_time_status
& certificate_info_activation_time
& certificate_info_expiration_time
& certificate_info_issuer
& certificate_info_md5_fingerprint
}
get_scanners_response_scanner_host
= element host
{
text
}
get_scanners_response_scanner_port
= element port
{
text
}
get_scanners_response_scanner_type
= element type
{
text
}
get_scanners_response_scanner_ca_pub
= element ca_pub
{
text
}
get_scanners_response_scanner_credential
= element credential
{
attribute id { uuid }
& get_scanners_response_scanner_credential_name
& get_scanners_response_scanner_credential_trash
}
get_scanners_response_scanner_credential_name
= element name
{
text
}
get_scanners_response_scanner_credential_login
= element login
{
text
}
get_scanners_response_scanner_credential_trash
= element trash
{
boolean
}
get_scanners_response_scanner_tasks
= element tasks
{
get_scanners_response_scanner_tasks_task*
}
get_scanners_response_scanner_tasks_task
= element task
{
attribute id { uuid }
& get_scanners_response_scanner_tasks_task_name
& get_scanners_response_scanner_tasks_task_permissions?
}
get_scanners_response_scanner_tasks_task_name
= element name
{
name
}
get_scanners_response_scanner_tasks_task_permissions
= element permissions
{
""
}
get_scanners_response_filters
= element filters
{
attribute id { uuid }
& get_scanners_response_filters_term
& get_scanners_response_filters_name?
& get_scanners_response_filters_keywords
}
get_scanners_response_filters_term
= element term
{
text
}
get_scanners_response_filters_name
= element name
{
text
}
get_scanners_response_filters_keywords
= element keywords
{
get_scanners_response_filters_keywords_keyword*
}
get_scanners_response_filters_keywords_keyword
= element keyword
{
get_scanners_response_filters_keywords_keyword_column
& get_scanners_response_filters_keywords_keyword_relation
& get_scanners_response_filters_keywords_keyword_value
}
get_scanners_response_filters_keywords_keyword_column
= element column
{
text
}
get_scanners_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_scanners_response_filters_keywords_keyword_value
= element value
{
text
}
get_scanners_response_sort
= element sort
{
text
& get_scanners_response_sort_field
}
get_scanners_response_sort_field
= element field
{
get_scanners_response_sort_field_order
}
get_scanners_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_scanners_response_scanners
= element scanners
{
attribute start { integer }
& attribute max { integer }
}
get_scanners_response_scanner_count
= element scanner_count
{
get_scanners_response_scanner_count_filtered
& get_scanners_response_scanner_count_page
}
get_scanners_response_scanner_count_filtered
= element filtered
{
integer
}
get_scanners_response_scanner_count_page
= element page
{
integer
}
7.68.3 Example: Get full details of a single scanner
Client
<get_scanners details="1"
scanner_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/>
<get_scanners_response status="200"
status_text="OK">
<scanner id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Default Scanner</name>
<comment/>
<creation_time>2014-01-01T13:57:25+01:00</creation_time>
<modification_time>2014-01-18T12:07:36+01:00</modification_time>
<writable>0</writable>
<in_use>1</in_use>
<user_tags>
<count>0</count>
</user_tags>
<host>localhost</host>
<port>9391</port>
<type>2</type>
<ca_pub>...</ca_pub>
<key_pub>...</key_pub>
<tasks>
<task id="813864a9-d3fd-44b3-8717-972bfb01dfc0">
<name>Debian desktops</name>
</task>
...
</tasks>
</scanner>
<truncate>...</truncate>
</get_scanners_response>
7.69 Command get_schedulesIn short: Get one or many schedules. The client uses the get_schedules command to get schedule information. 7.69.1 Structure
7.69.2 RNC
Command
get_schedules
= element get_schedules
{
attribute schedule_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute tasks { boolean }?
}
get_schedules_response
= element get_schedules_response
{
attribute status { status }
& attribute status_text { text }
& get_schedules_response_schedule*
& get_schedules_response_filters
& get_schedules_response_sort
& get_schedules_response_schedules
& get_schedules_response_schedule_count
}
get_schedules_response_schedule
= element schedule
{
attribute id { uuid }
& get_schedules_response_schedule_owner
& get_schedules_response_schedule_name
& get_schedules_response_schedule_comment
& get_schedules_response_schedule_creation_time
& get_schedules_response_schedule_modification_time
& get_schedules_response_schedule_writable
& get_schedules_response_schedule_in_use
& get_schedules_response_schedule_permissions
& get_schedules_response_schedule_user_tags
& get_schedules_response_schedule_first_time
& get_schedules_response_schedule_next_time
& get_schedules_response_schedule_timezone
& get_schedules_response_schedule_timezone_abbrev
& get_schedules_response_schedule_period
& get_schedules_response_schedule_period_months
& get_schedules_response_schedule_simple_period
& get_schedules_response_schedule_duration
& get_schedules_response_schedule_simple_duration
& get_schedules_response_schedule_tasks?
}
get_schedules_response_schedule_owner
= element owner
{
get_schedules_response_schedule_owner_name
}
get_schedules_response_schedule_owner_name
= element name
{
name
}
get_schedules_response_schedule_name
= element name
{
name
}
get_schedules_response_schedule_comment
= element comment
{
text
}
get_schedules_response_schedule_creation_time
= element creation_time
{
iso_time
}
get_schedules_response_schedule_modification_time
= element modification_time
{
iso_time
}
get_schedules_response_schedule_writable
= element writable
{
boolean
}
get_schedules_response_schedule_in_use
= element in_use
{
boolean
}
get_schedules_response_schedule_permissions
= element permissions
{
get_schedules_response_schedule_permissions_permission*
}
get_schedules_response_schedule_permissions_permission
= element permission
{
get_schedules_response_schedule_permissions_permission_name
}
get_schedules_response_schedule_permissions_permission_name
= element name
{
name
}
get_schedules_response_schedule_user_tags
= element user_tags
{
get_schedules_response_schedule_user_tags_count
& get_schedules_response_schedule_user_tags_tag*
}
get_schedules_response_schedule_user_tags_count
= element count
{
integer
}
get_schedules_response_schedule_user_tags_tag
= element tag
{
attribute id { uuid }
& get_schedules_response_schedule_user_tags_tag_name
& get_schedules_response_schedule_user_tags_tag_value
& get_schedules_response_schedule_user_tags_tag_comment
}
get_schedules_response_schedule_user_tags_tag_name
= element name
{
text
}
get_schedules_response_schedule_user_tags_tag_value
= element value
{
text
}
get_schedules_response_schedule_user_tags_tag_comment
= element comment
{
text
}
get_schedules_response_schedule_first_time
= element first_time
{
iso_time
}
get_schedules_response_schedule_next_time
= element next_time
{
iso_time
}
get_schedules_response_schedule_timezone
= element timezone
{
timezone
}
get_schedules_response_schedule_timezone_abbrev
= element timezone_abbrev
{
text
}
get_schedules_response_schedule_period
= element period
{
integer
}
get_schedules_response_schedule_period_months
= element period_months
{
integer
}
get_schedules_response_schedule_simple_period
= element simple_period
{
text
& get_schedules_response_schedule_simple_period_unit?
}
get_schedules_response_schedule_simple_period_unit
= element unit
{
time_unit
}
get_schedules_response_schedule_duration
= element duration
{
integer
}
get_schedules_response_schedule_simple_duration
= element simple_duration
{
text
& get_schedules_response_schedule_simple_duration_unit?
}
get_schedules_response_schedule_simple_duration_unit
= element unit
{
time_unit
}
get_schedules_response_schedule_tasks
= element tasks
{
get_schedules_response_schedule_tasks_task*
}
get_schedules_response_schedule_tasks_task
= element task
{
attribute id { uuid }
& get_schedules_response_schedule_tasks_task_name
& get_schedules_response_schedule_tasks_task_permissions?
}
get_schedules_response_schedule_tasks_task_name
= element name
{
name
}
get_schedules_response_schedule_tasks_task_permissions
= element permissions
{
""
}
get_schedules_response_filters
= element filters
{
attribute id { uuid }
& get_schedules_response_filters_term
& get_schedules_response_filters_name?
& get_schedules_response_filters_keywords
}
get_schedules_response_filters_term
= element term
{
text
}
get_schedules_response_filters_name
= element name
{
text
}
get_schedules_response_filters_keywords
= element keywords
{
get_schedules_response_filters_keywords_keyword*
}
get_schedules_response_filters_keywords_keyword
= element keyword
{
get_schedules_response_filters_keywords_keyword_column
& get_schedules_response_filters_keywords_keyword_relation
& get_schedules_response_filters_keywords_keyword_value
}
get_schedules_response_filters_keywords_keyword_column
= element column
{
text
}
get_schedules_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_schedules_response_filters_keywords_keyword_value
= element value
{
text
}
get_schedules_response_sort
= element sort
{
text
& get_schedules_response_sort_field
}
get_schedules_response_sort_field
= element field
{
get_schedules_response_sort_field_order
}
get_schedules_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_schedules_response_schedules
= element schedules
{
attribute start { integer }
& attribute max { integer }
}
get_schedules_response_schedule_count
= element schedule_count
{
get_schedules_response_schedule_count_filtered
& get_schedules_response_schedule_count_page
}
get_schedules_response_schedule_count_filtered
= element filtered
{
integer
}
get_schedules_response_schedule_count_page
= element page
{
integer
}
7.69.3 Example: Get full details of a single schedule
Client
<get_schedules schedule_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/> <get_schedules_response status="200"
status_text="OK">
<schedule id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Overnight</name>
<comment>3 hours, starting at 12h00.</comment>
<creation_time>2013-01-01T13:57:25+01:00</creation_time>
<modification_time>2013-01-18T12:07:36+01:00</modification_time>
<writable>0</writable>
<in_use>1</in_use>
<user_tags>
<count>0</count>
</user_tags>
<first_time>Tue Jun 29 00:00:00 2010</first_time>
<next_time>Tue Jun 29 00:00:00 2010</next_time>
<period>86400</period>
<period_months>0</period_months>
<simple_period>
1
<unit>day</unit>
</simple_period>
<duration>10800</duration>
<simple_duration>
3
<unit>hour</unit>
</simple_duration>
<timezone>Europe/Berlin</timezone>
<timezone_abbrev>CEST</timezone_abbrev>
<tasks>
<task id="d4daf4c4-25c7-40ac-87d3-38e489f34330">
<name>Task 1</name>
</task>
</tasks>
</schedule>
<truncate>...</truncate>
</get_schedules_response>
7.70 Command get_settingsIn short: Get one or many settings. The client uses the get_settings command to get the settings. 7.70.1 Structure
7.70.2 RNC
Command
get_settings
= element get_settings
{
attribute setting_id { uuid }?
& attribute filter { text }?
& attribute first { integer }?
& attribute max { integer }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
get_settings_response
= element get_settings_response
{
attribute status { status }
& attribute status_text { text }
& get_settings_response_filters
& get_settings_response_settings
& get_settings_response_setting*
& get_settings_response_setting_count
}
get_settings_response_filters
= element filters
{
get_settings_response_filters_term
}
get_settings_response_filters_term
= element term
{
text
}
get_settings_response_settings
= element settings
{
attribute start { integer }
& attribute max { integer }
}
get_settings_response_setting
= element setting
{
get_settings_response_setting_name
& get_settings_response_setting_comment
& get_settings_response_setting_value
}
get_settings_response_setting_name
= element name
{
text
}
get_settings_response_setting_comment
= element comment
{
text
}
get_settings_response_setting_value
= element value
{
text
}
get_settings_response_setting_count
= element setting_count
{
get_settings_response_setting_count_filtered
& get_settings_response_setting_count_page
}
get_settings_response_setting_count_filtered
= element filtered
{
integer
}
get_settings_response_setting_count_page
= element page
{
integer
}
7.70.3 Example: Get one or many settings
Client
<get_settings/> <get_settings_response status="200"
status_text="OK">
<settings>
<setting id="5f5a8712-8017-11e1-8556-406186ea4fc5">
<name>Rows Per Page</name>
<value>15</value>
</setting>
</settings>
</get_settings_response>
7.71 Command get_system_reportsIn short: Get one or many system reports. The client uses the get_system_reports command to get system reports. 7.71.1 Structure
7.71.2 RNC
Command
get_system_reports
= element get_system_reports
{
attribute name { text }?
& attribute duration { integer }?
& attribute start_time { iso_time }?
& attribute end_time { iso_time }?
& attribute brief { boolean }?
& attribute slave_id { uuid }?
}
get_system_reports_response
= element get_system_reports_response
{
attribute status { status }
& attribute status_text { text }
& get_system_reports_response_system_report*
}
get_system_reports_response_system_report
= element system_report
{
get_system_reports_response_system_report_name
& get_system_reports_response_system_report_title
& get_system_reports_response_system_report_report?
}
get_system_reports_response_system_report_name
= element name
{
name
}
get_system_reports_response_system_report_title
= element title
{
text
}
get_system_reports_response_system_report_report
= element report
{
text # RNC limitation: base64
& attribute format { xsd:token { pattern = "png|txt" } }
& attribute duration { integer }
}
7.71.3 Example: Get listing of available system reports
Client
<get_system_reports brief="1"/> <get_system_reports_response status="200"
status_text="OK">
<system_report>
<name>proc</name>
<title>Processes</title>
</system_report>
<system_report>
<name>load</name>
<title>System Load</title>
</system_report>
<system_report>
<name>cpu_0</name>
<title>CPU Usage: CPU 0</title>
</system_report>
...
</get_system_reports_response>
7.71.3 Example: Get a system report
Client
<get_system_reports name="proc"/> <get_system_reports_response status="200"
status_text="OK">
<system_report>
<name>proc</name>
<title>Processes</title>
<report format="png"
duration="86400">
iVBORw0KGgoAAAANSUhEUgAAArkAAAE...2bEdAAAAAElFTkSuQmCC
</report>
</system_report>
</get_system_reports_response>
7.72 Command get_tagsIn short: Get one or many tags. The client uses the get_tags command to get tag information. 7.72.1 Structure
7.72.2 RNC
Command
get_tags
= element get_tags
{
attribute tag_id { uuid }?
& attribute filter { text }?
& attribute filt_id { text }?
& attribute trash { boolean }?
& attribute names_only { boolean }?
}
get_tags_response
= element get_tags_response
{
attribute status { status }
& attribute status_text { text }
& get_tags_response_tag*
& get_tags_response_filters
& get_tags_response_sort
& get_tags_response_tags
& get_tags_response_tag_count
}
get_tags_response_tag
= element tag
{
attribute id { uuid }?
& get_tags_response_tag_name
& ( get_tags_response_tag_permissions
& get_tags_response_tag_owner
& get_tags_response_tag_comment
& get_tags_response_tag_creation_time
& get_tags_response_tag_modification_time
& get_tags_response_tag_writable
& get_tags_response_tag_in_use
& get_tags_response_tag_resource
& get_tags_response_tag_value
& get_tags_response_tag_active
& get_tags_response_tag_orphan )?
}
get_tags_response_tag_permissions
= element permissions
{
get_tags_response_tag_permissions_permission*
}
get_tags_response_tag_permissions_permission
= element permission
{
get_tags_response_tag_permissions_permission_name
}
get_tags_response_tag_permissions_permission_name
= element name
{
name
}
get_tags_response_tag_owner
= element owner
{
get_tags_response_tag_owner_name
}
get_tags_response_tag_owner_name
= element name
{
name
}
get_tags_response_tag_name
= element name
{
text
}
get_tags_response_tag_comment
= element comment
{
text
}
get_tags_response_tag_creation_time
= element creation_time
{
iso_time
}
get_tags_response_tag_modification_time
= element modification_time
{
iso_time
}
get_tags_response_tag_writable
= element writable
{
boolean
}
get_tags_response_tag_in_use
= element in_use
{
boolean
}
get_tags_response_tag_resource
= element resource
{
attribute id { uuid }
& get_tags_response_tag_resource_type
& get_tags_response_tag_resource_name
& get_tags_response_tag_resource_trash
& get_tags_response_tag_resource_permissions?
}
get_tags_response_tag_resource_type
= element type
{
text
}
get_tags_response_tag_resource_name
= element name
{
text
}
get_tags_response_tag_resource_trash
= element trash
{
boolean
}
get_tags_response_tag_resource_permissions
= element permissions
{
""
}
get_tags_response_tag_value
= element value
{
text
}
get_tags_response_tag_active
= element active
{
boolean
}
get_tags_response_tag_orphan
= element orphan
{
boolean
}
get_tags_response_filters
= element filters
{
attribute id { uuid }
& get_tags_response_filters_term
& get_tags_response_filters_name?
& get_tags_response_filters_keywords
}
get_tags_response_filters_term
= element term
{
text
}
get_tags_response_filters_name
= element name
{
text
}
get_tags_response_filters_keywords
= element keywords
{
get_tags_response_filters_keywords_keyword*
}
get_tags_response_filters_keywords_keyword
= element keyword
{
get_tags_response_filters_keywords_keyword_column
& get_tags_response_filters_keywords_keyword_relation
& get_tags_response_filters_keywords_keyword_value
}
get_tags_response_filters_keywords_keyword_column
= element column
{
text
}
get_tags_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_tags_response_filters_keywords_keyword_value
= element value
{
text
}
get_tags_response_sort
= element sort
{
text
& get_tags_response_sort_field
}
get_tags_response_sort_field
= element field
{
get_tags_response_sort_field_order
}
get_tags_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_tags_response_tags
= element tags
{
attribute start { integer }
& attribute max { integer }
}
get_tags_response_tag_count
= element tag_count
{
get_tags_response_tag_count_filtered
& get_tags_response_tag_count_page
}
get_tags_response_tag_count_filtered
= element filtered
{
integer
}
get_tags_response_tag_count_page
= element page
{
integer
}
7.72.3 Example: Get one or many tags
Client
<get_tags/> <get_tags_response status="200"
status_text="OK">
<tag id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<name>geo:long</name>
<comment/>
<creation_time>Fri Apr 12 08:49:43 2013</creation_time>
<modification_time>Fri Apr 12 08:49:43 2013</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<resource id="b493b7a8-7489-11df-a3ec-002264764cea">
<type>target</type>
<name>Server 1</name>
<trash>0</trash>
</resource>
<value>52.2788</value>
<active>1</active>
<orphaned>0</orphaned>
</tag>
...
</get_tags_response>
7.73 Command get_targetsIn short: Get one or many targets. The client uses the get_targets command to get target information. 7.73.1 Structure
7.73.2 RNC
Command
get_targets
= element get_targets
{
attribute target_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute tasks { boolean }?
}
get_targets_response
= element get_targets_response
{
attribute status { status }
& attribute status_text { text }
& get_targets_response_target*
& get_targets_response_filters
& get_targets_response_sort
& get_targets_response_targets
& get_targets_response_target_count
}
get_targets_response_target
= element target
{
attribute id { uuid }
& get_targets_response_target_owner
& get_targets_response_target_name
& get_targets_response_target_comment
& get_targets_response_target_creation_time
& get_targets_response_target_modification_time
& get_targets_response_target_writable
& get_targets_response_target_in_use
& get_targets_response_target_permissions
& get_targets_response_target_user_tags
& get_targets_response_target_hosts
& get_targets_response_target_exclude_hosts
& get_targets_response_target_max_hosts
& get_targets_response_target_ssh_credential
& get_targets_response_target_smb_credential
& get_targets_response_target_esxi_credential
& get_targets_response_target_snmp_credential
& get_targets_response_target_permissions
& get_targets_response_target_port_range
& get_targets_response_target_port_list
& get_targets_response_target_alive_tests
& get_targets_response_target_reverse_lookup_only
& get_targets_response_target_reverse_lookup_unify
& get_targets_response_target_tasks?
}
get_targets_response_target_owner
= element owner
{
get_targets_response_target_owner_name
}
get_targets_response_target_owner_name
= element name
{
name
}
get_targets_response_target_name
= element name
{
name
}
get_targets_response_target_comment
= element comment
{
text
}
get_targets_response_target_creation_time
= element creation_time
{
iso_time
}
get_targets_response_target_modification_time
= element modification_time
{
iso_time
}
get_targets_response_target_hosts
= element hosts
{
text
}
get_targets_response_target_exclude_hosts
= element exclude_hosts
{
text
}
get_targets_response_target_max_hosts
= element max_hosts
{
integer
}
get_targets_response_target_writable
= element writable
{
boolean
}
get_targets_response_target_in_use
= element in_use
{
boolean
}
get_targets_response_target_permissions
= element permissions
{
get_targets_response_target_permissions_permission*
}
get_targets_response_target_permissions_permission
= element permission
{
get_targets_response_target_permissions_permission_name
}
get_targets_response_target_permissions_permission_name
= element name
{
name
}
get_targets_response_target_user_tags
= element user_tags
{
get_targets_response_target_user_tags_count
& get_targets_response_target_user_tags_tag*
}
get_targets_response_target_user_tags_count
= element count
{
integer
}
get_targets_response_target_user_tags_tag
= element tag
{
attribute id { uuid }
& get_targets_response_target_user_tags_tag_name
& get_targets_response_target_user_tags_tag_value
& get_targets_response_target_user_tags_tag_comment
}
get_targets_response_target_user_tags_tag_name
= element name
{
text
}
get_targets_response_target_user_tags_tag_value
= element value
{
text
}
get_targets_response_target_user_tags_tag_comment
= element comment
{
text
}
get_targets_response_target_ssh_credential
= element ssh_credential
{
attribute id { uuid_or_empty }
& get_targets_response_target_ssh_credential_name
& get_targets_response_target_ssh_credential_permissions?
& get_targets_response_target_ssh_credential_port
& get_targets_response_target_ssh_credential_trash
}
get_targets_response_target_ssh_credential_name
= element name
{
name
}
get_targets_response_target_ssh_credential_permissions
= element permissions
{
""
}
get_targets_response_target_ssh_credential_port
= element port
{
text
}
get_targets_response_target_ssh_credential_trash
= element trash
{
boolean
}
get_targets_response_target_smb_credential
= element smb_credential
{
attribute id { uuid_or_empty }
& get_targets_response_target_smb_credential_name
& get_targets_response_target_smb_credential_permissions?
& get_targets_response_target_smb_credential_trash
}
get_targets_response_target_smb_credential_name
= element name
{
name
}
get_targets_response_target_smb_credential_permissions
= element permissions
{
""
}
get_targets_response_target_smb_credential_trash
= element trash
{
boolean
}
get_targets_response_target_esxi_credential
= element esxi_credential
{
attribute id { uuid_or_empty }
& get_targets_response_target_esxi_credential_name
& get_targets_response_target_esxi_credential_permissions?
& get_targets_response_target_esxi_credential_trash
}
get_targets_response_target_esxi_credential_name
= element name
{
name
}
get_targets_response_target_esxi_credential_permissions
= element permissions
{
""
}
get_targets_response_target_esxi_credential_trash
= element trash
{
boolean
}
get_targets_response_target_snmp_credential
= element snmp_credential
{
attribute id { uuid_or_empty }
& get_targets_response_target_snmp_credential_name
& get_targets_response_target_snmp_credential_permissions?
& get_targets_response_target_snmp_credential_trash
}
get_targets_response_target_snmp_credential_name
= element name
{
name
}
get_targets_response_target_snmp_credential_permissions
= element permissions
{
""
}
get_targets_response_target_snmp_credential_trash
= element trash
{
boolean
}
get_targets_response_target_port_range
= element port_range
{
name
}
get_targets_response_target_port_list
= element port_list
{
attribute id { uuid }
& get_targets_response_target_port_list_name
& get_targets_response_target_port_list_permissions?
& get_targets_response_target_port_list_trash
}
get_targets_response_target_port_list_name
= element name
{
name
}
get_targets_response_target_port_list_permissions
= element permissions
{
""
}
get_targets_response_target_port_list_trash
= element trash
{
boolean
}
get_targets_response_target_alive_tests
= element alive_tests
{
alive_test
}
get_targets_response_target_reverse_lookup_only
= element reverse_lookup_only
{
boolean
}
get_targets_response_target_reverse_lookup_unify
= element reverse_lookup_unify
{
boolean
}
get_targets_response_target_tasks
= element tasks
{
get_targets_response_target_tasks_task*
}
get_targets_response_target_tasks_task
= element task
{
attribute id { uuid }
& get_targets_response_target_tasks_task_name
& get_targets_response_target_tasks_task_permissions?
}
get_targets_response_target_tasks_task_name
= element name
{
name
}
get_targets_response_target_tasks_task_permissions
= element permissions
{
""
}
get_targets_response_filters
= element filters
{
attribute id { uuid }
& get_targets_response_filters_term
& get_targets_response_filters_name?
& get_targets_response_filters_keywords
}
get_targets_response_filters_term
= element term
{
text
}
get_targets_response_filters_name
= element name
{
text
}
get_targets_response_filters_keywords
= element keywords
{
get_targets_response_filters_keywords_keyword*
}
get_targets_response_filters_keywords_keyword
= element keyword
{
get_targets_response_filters_keywords_keyword_column
& get_targets_response_filters_keywords_keyword_relation
& get_targets_response_filters_keywords_keyword_value
}
get_targets_response_filters_keywords_keyword_column
= element column
{
text
}
get_targets_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_targets_response_filters_keywords_keyword_value
= element value
{
text
}
get_targets_response_sort
= element sort
{
text
& get_targets_response_sort_field
}
get_targets_response_sort_field
= element field
{
get_targets_response_sort_field_order
}
get_targets_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_targets_response_targets
= element targets
{
attribute start { integer }
& attribute max { integer }
}
get_targets_response_target_count
= element target_count
{
get_targets_response_target_count_filtered
& get_targets_response_target_count_page
}
get_targets_response_target_count_filtered
= element filtered
{
integer
}
get_targets_response_target_count_page
= element page
{
integer
}
7.73.3 Example: Get one or many targets
Client
<get_targets/> <get_targets_response status="200"
status_text="OK">
<target id="b493b7a8-7489-11df-a3ec-002264764cea">
<name>Localhost</name>
<comment/>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<writable>0</writable>
<in_use>7</in_use>
<user_tags>
<count>0</count>
</user_tags>
<hosts>localhost</hosts>
<max_hosts>1</max_hosts>
<ssh_credential id="">
<name/>
</ssh_credential>
<smb_credential id="">
<name/>
</smb_credential>
<esxi_credential id="">
<name/>
</esxi_credential>
</target>
...
</get_targets_response>
7.73.3 Example: Get a single target, including tasks using the target
Client
<get_targets target_id="1f28d970-17ef-4c69-ba8a-13827059f2b9"
tasks="1"/>
<get_targets_response status="200"
status_text="OK">
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>dik</name>
<comment>dik mm</comment>
<creation_time>Sun Jun 27 08:49:43 2010</creation_time>
<modification_time>Sun Jun 27 08:49:43 2010</modification_time>
<writable>0</writable>
<in_use>4</in_use>
<user_tags>
<count>0</count>
</user_tags>
<hosts>dik.example.org</hosts>
<max_hosts>1</max_hosts>
<ssh_credential id="58ff2793-2dc7-43fe-85f9-20bfac5a87e4">
<name>mm</name>
</ssh_credential>
<smb_credential id="">
<name/>
</smb_credential>
<esxi_credential id="">
<name/>
</esxi_credential>
<tasks>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>dik mm</name>
</task>
...
</tasks>
</target>
</get_targets_response>
7.74 Command get_tasksIn short: Get one or many tasks. The client uses the get_tasks command to get task information. As a convenience for clients the response includes a task count and the values of the sort order, sort field and apply overrides flag that the manager applied when selecting the tasks. 7.74.1 Structure
7.74.2 RNC
Command
get_tasks
= element get_tasks
{
attribute task_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
& attribute trash { boolean }?
& attribute details { boolean }?
& attribute ignore_pagination { boolean }?
& attribute schedules_only { boolean }?
}
get_tasks_response
= element get_tasks_response
{
attribute status { status }
& attribute status_text { text }
& get_tasks_response_apply_overrides
& get_tasks_response_task*
& get_tasks_response_filters
& get_tasks_response_sort
& get_tasks_response_tasks
& get_tasks_response_task_count
}
get_tasks_response_apply_overrides
= element apply_overrides
{
xsd:token { pattern = "0|1" }
}
get_tasks_response_task
= element task
{
attribute id { uuid }
& ( ( get_tasks_response_task_owner
& get_tasks_response_task_name
& get_tasks_response_task_comment
& get_tasks_response_task_creation_time
& get_tasks_response_task_modification_time
& get_tasks_response_task_writable
& get_tasks_response_task_in_use
& get_tasks_response_task_permissions
& get_tasks_response_task_user_tags
& get_tasks_response_task_status
& get_tasks_response_task_progress
& get_tasks_response_task_alterable
& get_tasks_response_task_config
& get_tasks_response_task_target
& get_tasks_response_task_hosts_ordering
& get_tasks_response_task_scanner
& get_tasks_response_task_alert
& get_tasks_response_task_observers
& get_tasks_response_task_schedule
& get_tasks_response_task_schedule_periods
& get_tasks_response_task_report_count
& get_tasks_response_task_trend
& get_tasks_response_task_current_report?
& get_tasks_response_task_first_report?
& get_tasks_response_task_last_report?
& get_tasks_response_task_second_last_report?
& get_tasks_response_task_reports*
& get_tasks_response_task_average_duration?
& get_tasks_response_task_result_count
& get_tasks_response_task_preferences )
| ( get_tasks_response_task_name
& get_tasks_response_task_schedule
& get_tasks_response_task_schedule_periods ) )
}
get_tasks_response_task_owner
= element owner
{
get_tasks_response_task_owner_name
}
get_tasks_response_task_owner_name
= element name
{
name
}
get_tasks_response_task_name
= element name
{
name
}
get_tasks_response_task_comment
= element comment
{
text
}
get_tasks_response_task_creation_time
= element creation_time
{
iso_time
}
get_tasks_response_task_modification_time
= element modification_time
{
iso_time
}
get_tasks_response_task_writable
= element writable
{
boolean
}
get_tasks_response_task_in_use
= element in_use
{
boolean
}
get_tasks_response_task_permissions
= element permissions
{
get_tasks_response_task_permissions_permission*
}
get_tasks_response_task_permissions_permission
= element permission
{
get_tasks_response_task_permissions_permission_name
}
get_tasks_response_task_permissions_permission_name
= element name
{
name
}
get_tasks_response_task_user_tags
= element user_tags
{
get_tasks_response_task_user_tags_count
& get_tasks_response_task_user_tags_tag*
}
get_tasks_response_task_user_tags_count
= element count
{
integer
}
get_tasks_response_task_user_tags_tag
= element tag
{
attribute id { uuid }
& get_tasks_response_task_user_tags_tag_name
& get_tasks_response_task_user_tags_tag_value
& get_tasks_response_task_user_tags_tag_comment
}
get_tasks_response_task_user_tags_tag_name
= element name
{
text
}
get_tasks_response_task_user_tags_tag_value
= element value
{
text
}
get_tasks_response_task_user_tags_tag_comment
= element comment
{
text
}
get_tasks_response_task_status
= element status
{
task_status
}
get_tasks_response_task_progress
= element progress
{
text # RNC limitation: integer
& get_tasks_response_task_progress_host_progress*
}
get_tasks_response_task_progress_host_progress
= element host_progress
{
text # RNC limitation: integer
& get_tasks_response_task_progress_host_progress_host
}
get_tasks_response_task_progress_host_progress_host
= element host
{
text
}
get_tasks_response_task_alterable
= element alterable
{
boolean
}
get_tasks_response_task_config
= element config
{
attribute id { uuid }
& get_tasks_response_task_config_name
& get_tasks_response_task_config_permissions?
& get_tasks_response_task_config_trash
}
get_tasks_response_task_config_name
= element name
{
name
}
get_tasks_response_task_config_permissions
= element permissions
{
""
}
get_tasks_response_task_config_trash
= element trash
{
boolean
}
get_tasks_response_task_target
= element target
{
attribute id { uuid }
& get_tasks_response_task_target_name
& get_tasks_response_task_target_permissions?
& get_tasks_response_task_target_trash
}
get_tasks_response_task_target_name
= element name
{
name
}
get_tasks_response_task_target_permissions
= element permissions
{
""
}
get_tasks_response_task_target_trash
= element trash
{
boolean
}
get_tasks_response_task_hosts_ordering
= element hosts_ordering
{
text
}
get_tasks_response_task_scanner
= element scanner
{
attribute id { uuid }
& get_tasks_response_task_scanner_name
& get_tasks_response_task_scanner_permissions?
& get_tasks_response_task_scanner_type
}
get_tasks_response_task_scanner_name
= element name
{
name
}
get_tasks_response_task_scanner_type
= element type
{
integer
}
get_tasks_response_task_scanner_permissions
= element permissions
{
""
}
get_tasks_response_task_alert
= element alert
{
attribute id { uuid_or_empty }
& get_tasks_response_task_alert_name
& get_tasks_response_task_alert_permissions?
& get_tasks_response_task_alert_trash
}
get_tasks_response_task_alert_name
= element name
{
name
}
get_tasks_response_task_alert_permissions
= element permissions
{
""
}
get_tasks_response_task_alert_trash
= element trash
{
boolean
}
get_tasks_response_task_observers
= element observers
{
text # RNC limitation: user_list
& get_tasks_response_task_observers_group*
& get_tasks_response_task_observers_role*
}
get_tasks_response_task_observers_group
= element group
{
attribute id { uuid }
& get_tasks_response_task_observers_group_name
}
get_tasks_response_task_observers_group_name
= element name
{
name
}
get_tasks_response_task_observers_role
= element role
{
attribute id { uuid }
& get_tasks_response_task_observers_role_name
}
get_tasks_response_task_observers_role_name
= element name
{
name
}
get_tasks_response_task_schedule
= element schedule
{
attribute id { uuid_or_empty }
& get_tasks_response_task_schedule_name
& get_tasks_response_task_schedule_next_time?
& get_tasks_response_task_schedule_permissions?
& get_tasks_response_task_schedule_trash
& get_tasks_response_task_schedule_first_time?
& get_tasks_response_task_schedule_period?
& get_tasks_response_task_schedule_period_months?
& get_tasks_response_task_schedule_duration?
}
get_tasks_response_task_schedule_name
= element name
{
name
}
get_tasks_response_task_schedule_next_time
= element next_time
{
iso_time
}
get_tasks_response_task_schedule_permissions
= element permissions
{
""
}
get_tasks_response_task_schedule_trash
= element trash
{
boolean
}
get_tasks_response_task_schedule_first_time
= element first_time
{
iso_time
}
get_tasks_response_task_schedule_period
= element period
{
integer
}
get_tasks_response_task_schedule_period_months
= element period_months
{
integer
}
get_tasks_response_task_schedule_duration
= element duration
{
integer
}
get_tasks_response_task_schedule_periods
= element schedule_periods
{
integer
}
get_tasks_response_task_report_count
= element report_count
{
text # RNC limitation: integer
& get_tasks_response_task_report_count_finished
}
get_tasks_response_task_report_count_finished
= element finished
{
integer
}
get_tasks_response_task_trend
= element trend
{
task_trend
}
get_tasks_response_task_current_report
= element current_report
{
get_tasks_response_task_current_report_report
}
get_tasks_response_task_current_report_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_current_report_report_timestamp
}
get_tasks_response_task_current_report_report_timestamp
= element timestamp
{
iso_time
}
get_tasks_response_task_first_report
= element first_report
{
get_tasks_response_task_first_report_report
}
get_tasks_response_task_first_report_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_first_report_report_timestamp
& get_tasks_response_task_first_report_report_scan_end
& get_tasks_response_task_first_report_report_result_count
& get_tasks_response_task_first_report_report_severity
}
get_tasks_response_task_first_report_report_timestamp
= element timestamp
{
iso_time
}
get_tasks_response_task_first_report_report_scan_end
= element scan_end
{
iso_time
}
get_tasks_response_task_first_report_report_result_count
= element result_count
{
get_tasks_response_task_first_report_report_result_count_debug
& get_tasks_response_task_first_report_report_result_count_false_positive
& get_tasks_response_task_first_report_report_result_count_log
& get_tasks_response_task_first_report_report_result_count_info
& get_tasks_response_task_first_report_report_result_count_warning
& get_tasks_response_task_first_report_report_result_count_hole
}
get_tasks_response_task_first_report_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_first_report_report_result_count_false_positive
= element false_positive
{
integer
}
get_tasks_response_task_first_report_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_first_report_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_first_report_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_first_report_report_result_count_hole
= element hole
{
integer
}
get_tasks_response_task_first_report_report_severity
= element severity
{
severity
}
get_tasks_response_task_last_report
= element last_report
{
get_tasks_response_task_last_report_report
}
get_tasks_response_task_last_report_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_last_report_report_timestamp
& get_tasks_response_task_last_report_report_scan_end
& get_tasks_response_task_last_report_report_result_count
& get_tasks_response_task_last_report_report_severity
}
get_tasks_response_task_last_report_report_timestamp
= element timestamp
{
iso_time
}
get_tasks_response_task_last_report_report_scan_end
= element scan_end
{
iso_time
}
get_tasks_response_task_last_report_report_result_count
= element result_count
{
get_tasks_response_task_last_report_report_result_count_debug
& get_tasks_response_task_last_report_report_result_count_false_positive
& get_tasks_response_task_last_report_report_result_count_log
& get_tasks_response_task_last_report_report_result_count_info
& get_tasks_response_task_last_report_report_result_count_warning
& get_tasks_response_task_last_report_report_result_count_hole
}
get_tasks_response_task_last_report_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_last_report_report_result_count_false_positive
= element false_positive
{
integer
}
get_tasks_response_task_last_report_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_last_report_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_last_report_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_last_report_report_result_count_hole
= element hole
{
integer
}
get_tasks_response_task_last_report_report_severity
= element severity
{
severity
}
get_tasks_response_task_second_last_report
= element second_last_report
{
get_tasks_response_task_second_last_report_report
}
get_tasks_response_task_second_last_report_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_second_last_report_report_timestamp
& get_tasks_response_task_second_last_report_report_scan_end
& get_tasks_response_task_second_last_report_report_result_count
& get_tasks_response_task_second_last_report_report_severity
}
get_tasks_response_task_second_last_report_report_timestamp
= element timestamp
{
iso_time
}
get_tasks_response_task_second_last_report_report_scan_end
= element scan_end
{
iso_time
}
get_tasks_response_task_second_last_report_report_result_count
= element result_count
{
get_tasks_response_task_second_last_report_report_result_count_debug
& get_tasks_response_task_second_last_report_report_result_count_false_positive
& get_tasks_response_task_second_last_report_report_result_count_log
& get_tasks_response_task_second_last_report_report_result_count_info
& get_tasks_response_task_second_last_report_report_result_count_warning
& get_tasks_response_task_second_last_report_report_result_count_hole
}
get_tasks_response_task_second_last_report_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_false_positive
= element false_positive
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_hole
= element hole
{
integer
}
get_tasks_response_task_second_last_report_report_severity
= element severity
{
severity
}
get_tasks_response_task_reports
= element reports
{
get_tasks_response_task_reports_report*
}
get_tasks_response_task_reports_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_reports_report_timestamp
& get_tasks_response_task_reports_report_scan_end
& get_tasks_response_task_reports_report_scan_run_status
& get_tasks_response_task_reports_report_result_count
& get_tasks_response_task_reports_report_severity
}
get_tasks_response_task_reports_report_timestamp
= element timestamp
{
iso_time
}
get_tasks_response_task_reports_report_scan_end
= element scan_end
{
iso_time
}
get_tasks_response_task_reports_report_scan_run_status
= element scan_run_status
{
task_status
}
get_tasks_response_task_reports_report_result_count
= element result_count
{
get_tasks_response_task_reports_report_result_count_debug
& get_tasks_response_task_reports_report_result_count_false_positive
& get_tasks_response_task_reports_report_result_count_log
& get_tasks_response_task_reports_report_result_count_info
& get_tasks_response_task_reports_report_result_count_warning
& get_tasks_response_task_reports_report_result_count_hole
}
get_tasks_response_task_reports_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_reports_report_result_count_false_positive
= element false_positive
{
integer
}
get_tasks_response_task_reports_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_reports_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_reports_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_reports_report_result_count_hole
= element hole
{
integer
}
get_tasks_response_task_reports_report_severity
= element severity
{
severity
}
get_tasks_response_task_average_duration
= element average_duration
{
text
}
get_tasks_response_task_result_count
= element result_count
{
text
}
get_tasks_response_task_preferences
= element preferences
{
get_tasks_response_task_preferences_preference*
}
get_tasks_response_task_preferences_preference
= element preference
{
get_tasks_response_task_preferences_preference_name
& get_tasks_response_task_preferences_preference_scanner_name
& get_tasks_response_task_preferences_preference_value
}
get_tasks_response_task_preferences_preference_name
= element name
{
text
}
get_tasks_response_task_preferences_preference_scanner_name
= element scanner_name
{
text
}
get_tasks_response_task_preferences_preference_value
= element value
{
text
}
get_tasks_response_filters
= element filters
{
attribute id { uuid }
& get_tasks_response_filters_term
& get_tasks_response_filters_name?
& get_tasks_response_filters_keywords
}
get_tasks_response_filters_term
= element term
{
text
}
get_tasks_response_filters_name
= element name
{
text
}
get_tasks_response_filters_keywords
= element keywords
{
get_tasks_response_filters_keywords_keyword*
}
get_tasks_response_filters_keywords_keyword
= element keyword
{
get_tasks_response_filters_keywords_keyword_column
& get_tasks_response_filters_keywords_keyword_relation
& get_tasks_response_filters_keywords_keyword_value
}
get_tasks_response_filters_keywords_keyword_column
= element column
{
text
}
get_tasks_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_tasks_response_filters_keywords_keyword_value
= element value
{
text
}
get_tasks_response_sort
= element sort
{
text
& get_tasks_response_sort_field
}
get_tasks_response_sort_field
= element field
{
get_tasks_response_sort_field_order
}
get_tasks_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_tasks_response_tasks
= element tasks
{
attribute start { integer }
& attribute max { integer }
}
get_tasks_response_task_count
= element task_count
{
get_tasks_response_task_count_filtered
& get_tasks_response_task_count_page
}
get_tasks_response_task_count_filtered
= element filtered
{
integer
}
get_tasks_response_task_count_page
= element page
{
integer
}
7.74.3 Example: Get one or many tasks
Client
<get_tasks/> <get_tasks_response status="200"
status_text="OK">
<apply_overrides>0</apply_overrides>
<task id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<name>Scan Webserver</name>
<comment>Scan of the web server.</comment>
<creation_time>2013-01-03T13:50:03+01:00</creation_time>
<modification_time>2013-01-11T16:03:24+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<owner>
<name>admin</name>
</owner>
<observers/>
<alterable>0</alterable>
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
</config>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>dik</name>
</target>
<scanner id="34891919-37ff-5c69-1a2a-089e9018308a">
<name>foo scanner</name>
<type>2</type>
</scanner>
<status>Done</status>
<progress>-1</progress>
<report_count>
2
<finished>2</finished>
</report_count>
<trend/>
<schedule id="">
<name/>
<next_time>over</next_time>
</schedule>
<first_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
<severity>5.0</severity>
</report>
</first_report>
<last_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
<severity>5.0</severity>
</report>
</last_report>
<second_last_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
<severity>5.0</severity>
</report>
</second_last_report>
<alert id="">
<name/>
</alert>
<preferences>
<preference>
<name>Maximum concurrently executed NVTs per host</name>
<scanner_name>max_checks</scanner_name>
<value>4</value>
</preference>
<preference>
<name>Maximum concurrently scanned hosts</name>
<scanner_name>max_hosts</scanner_name>
<value>20</value>
</preference>
<preference>
<name>Add results to Asset Management</name>
<scanner_name>in_assets</scanner_name>
<value>yes</value>
</preference>
</preferences>
</task>
<task id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c">
<name>Scan Mailserver</name>
...
</task>
</get_tasks_response>
7.74.3 Example: Get a single task, including all reports
Client
<get_tasks task_id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c"
details="1"/>
<get_tasks_response status="200"
status_text="OK">
<apply_overrides>0</apply_overrides>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>Scan Mailserver</name>
<comment>Scan of the web server.</comment>
<creation_time>2013-01-03T13:50:03+01:00</creation_time>
<modification_time>2013-01-11T16:03:24+01:00</modification_time>
<writable>1</writable>
<in_use>0</in_use>
<user_tags>
<count>0</count>
</user_tags>
<owner>
<name>admin</name>
</owner>
<observers/>
<alterable>1</alterable>
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
</config>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>dik</name>
</target>
<status>Done</status>
<progress>-1</progress>
<report_count>
2
<finished>2</finished>
</report_count>
<trend/>
<schedule id="">
<name/>
<next_time>over</next_time>
</schedule>
<first_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
<severity>5.0</severity>
</report>
</first_report>
<last_report>
<report id="2688e6c7-db29-4505-80f1-0fd4a09e1011">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
<severity>5.0</severity>
</report>
</last_report>
<second_last_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
<severity>5.0</severity>
</report>
</second_last_report>
<alert id="">
<name/>
</alert>
<reports>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 18:51:38 2010</timestamp>
<scan_run_status>Done</scan_run_status>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
<report id="2688e6c7-db29-4505-80f1-0fd4a09e1011">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<scan_run_status>Done</scan_run_status>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
<severity>5.0</severity>
</report>
<preferences>
<preference>
<name>Maximum concurrently executed NVTs per host</name>
<scanner_name>max_checks</scanner_name>
<value>4</value>
</preference>
<preference>
<name>Maximum concurrently scanned hosts</name>
<scanner_name>max_hosts</scanner_name>
<value>20</value>
</preference>
<preference>
<name>Add results to Asset Management</name>
<scanner_name>in_assets</scanner_name>
<value>yes</value>
</preference>
</preferences>
</reports>
</task>
<filters id="0">
<term/>
</filters>
<sort>
<field>
name
<order>ascending</order>
</field>
</sort>
<tasks max="-1"
start="1"/>
<task_count>
3
<filtered>1</filtered>
<page>1</page>
</task_count>
</get_tasks_response>
7.75 Command get_usersIn short: Get one or many users. The client uses the "get_users" command to retrieve the list of user accounts on the Scanner. 7.75.1 Structure
7.75.2 RNC
Command
get_users
= element get_users
{
attribute user_id { uuid }?
& attribute filter { text }?
& attribute filt_id { uuid }?
}
get_users_response
= element get_users_response
{
attribute status { status }
& attribute status_text { text }
& get_users_response_user*
& get_users_response_filters
& get_users_response_sort
& get_users_response_users
& get_users_response_user_count
}
get_users_response_user
= element user
{
attribute id { uuid }
& get_users_response_user_owner
& get_users_response_user_name
& get_users_response_user_comment
& get_users_response_user_creation_time
& get_users_response_user_modification_time
& get_users_response_user_writable
& get_users_response_user_in_use
& get_users_response_user_role*
& get_users_response_user_groups
& get_users_response_user_hosts
& get_users_response_user_ifaces
& get_users_response_user_permissions
& get_users_response_user_user_tags
& get_users_response_user_sources
}
get_users_response_user_owner
= element owner
{
get_users_response_user_owner_name
}
get_users_response_user_owner_name
= element name
{
name
}
get_users_response_user_name
= element name
{
text
}
get_users_response_user_comment
= element comment
{
text
}
get_users_response_user_creation_time
= element creation_time
{
iso_time
}
get_users_response_user_modification_time
= element modification_time
{
iso_time
}
get_users_response_user_writable
= element writable
{
boolean
}
get_users_response_user_in_use
= element in_use
{
boolean
}
get_users_response_user_role
= element role
{
attribute id { uuid }
& get_users_response_user_role_name
& get_users_response_user_role_permissions?
}
get_users_response_user_role_name
= element name
{
name
}
get_users_response_user_role_permissions
= element permissions
{
""
}
get_users_response_user_groups
= element groups
{
get_users_response_user_groups_group
}
get_users_response_user_groups_group
= element group
{
attribute id { uuid }
& get_users_response_user_groups_group_name
& get_users_response_user_groups_group_permissions?
}
get_users_response_user_groups_group_name
= element name
{
name
}
get_users_response_user_groups_group_permissions
= element permissions
{
""
}
get_users_response_user_hosts
= element hosts
{
text
& attribute allow { xsd:token { pattern = "0|1|2|3" } }
}
get_users_response_user_ifaces
= element ifaces
{
text
& attribute allow { xsd:token { pattern = "0|1|2|3" } }
}
get_users_response_user_permissions
= element permissions
{
get_users_response_user_permissions_permission*
}
get_users_response_user_permissions_permission
= element permission
{
get_users_response_user_permissions_permission_name
}
get_users_response_user_permissions_permission_name
= element name
{
name
}
get_users_response_user_user_tags
= element user_tags
{
get_users_response_user_user_tags_count
& get_users_response_user_user_tags_tag*
}
get_users_response_user_user_tags_count
= element count
{
integer
}
get_users_response_user_user_tags_tag
= element tag
{
attribute id { uuid }
& get_users_response_user_user_tags_tag_name
& get_users_response_user_user_tags_tag_value
& get_users_response_user_user_tags_tag_comment
}
get_users_response_user_user_tags_tag_name
= element name
{
text
}
get_users_response_user_user_tags_tag_value
= element value
{
text
}
get_users_response_user_user_tags_tag_comment
= element comment
{
text
}
get_users_response_user_sources
= element sources # type sources
{
}
get_users_response_filters
= element filters
{
attribute id { uuid }
& get_users_response_filters_term
& get_users_response_filters_name?
& get_users_response_filters_keywords
}
get_users_response_filters_term
= element term
{
text
}
get_users_response_filters_name
= element name
{
text
}
get_users_response_filters_keywords
= element keywords
{
get_users_response_filters_keywords_keyword*
}
get_users_response_filters_keywords_keyword
= element keyword
{
get_users_response_filters_keywords_keyword_column
& get_users_response_filters_keywords_keyword_relation
& get_users_response_filters_keywords_keyword_value
}
get_users_response_filters_keywords_keyword_column
= element column
{
text
}
get_users_response_filters_keywords_keyword_relation
= element relation
{
ERROR
}
get_users_response_filters_keywords_keyword_value
= element value
{
text
}
get_users_response_sort
= element sort
{
text
& get_users_response_sort_field
}
get_users_response_sort_field
= element field
{
get_users_response_sort_field_order
}
get_users_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_users_response_users
= element users
{
attribute start { integer }
& attribute max { integer }
}
get_users_response_user_count
= element user_count
{
get_users_response_user_count_filtered
& get_users_response_user_count_page
}
get_users_response_user_count_filtered
= element filtered
{
integer
}
get_users_response_user_count_page
= element page
{
integer
}
7.75.3 Example: Get the users
Client
<get_users/> <get_users_response status="200"
status_text="OK">
<user>
<name>foobar</name>
<role id="8d453140-b74d-11e2-b0be-406186ea4fc5">
<name>User</name>
</role>
<hosts allow="2"/>
<user_tags>
<count>0</count>
</user_tags>
<sources>
<source>file</source>
</sources>
</user>
</get_users_response>
7.76 Command get_versionIn short: Get the OpenVAS Manager Protocol version. 7.76.1 Structure
7.76.2 RNC
Command
get_version
= element get_version
{
""
}
get_version_response
= element get_version_response
{
attribute status { status }
& attribute status_text { text }
& get_version_response_version
}
get_version_response_version
= element version
{
text
}
7.76.3 Example: Get the version
Client
<get_version/> <get_version_response status="200"
status_text="OK">
<version>1.0</version>
</get_version_response>
7.77 Command helpIn short: Get the help text. 7.77.1 Structure
7.77.2 RNC
Command
help
= element help
{
attribute format { xsd:token { pattern = "html|HTML|rnc|RNC|text|TEXT|xml|XML" } }?
& attribute type { xsd:token { pattern = "brief|" } }?
}
help_response
= element help_response
{
text
& attribute status { status }
& attribute status_text { text }
& help_response_schema?
}
help_response_schema
= element schema
{
help_response_schema_protocol
}
help_response_schema_protocol
= element protocol
{
attribute format { text }?
& attribute extension { text }?
& attribute content_type { text }?
& help_response_schema_protocol_name
& help_response_schema_protocol_abbreviation?
& help_response_schema_protocol_summary?
& help_response_schema_protocol_version?
& help_response_schema_protocol_type*
& help_response_schema_protocol_command*
}
help_response_schema_protocol_name
= element name
{
text
}
help_response_schema_protocol_abbreviation
= element abbreviation
{
text
}
help_response_schema_protocol_summary
= element summary
{
text
}
help_response_schema_protocol_version
= element version
{
text
}
help_response_schema_protocol_type
= element type
{
help_response_schema_protocol_type_name
& help_response_schema_protocol_type_summary?
& help_response_schema_protocol_type_description?
& help_response_schema_protocol_type_pattern
}
help_response_schema_protocol_type_name
= element name
{
type_name
}
help_response_schema_protocol_type_summary
= element summary
{
text
}
help_response_schema_protocol_type_description
= element description
{
text
& help_response_schema_protocol_type_description_p*
}
help_response_schema_protocol_type_description_p
= element p
{
text
}
help_response_schema_protocol_type_pattern
= element pattern
{
text
}
help_response_schema_protocol_command
= element command # type command_definition
{
command_definition_name
& command_definition_summary?
& command_definition_description?
& ( ( command_definition_pattern
& command_definition_response )
| ( command_definition_type
& command_definition_ele* ) )
& command_definition_example*
}
7.77.3 Example: Get the help text
Client
<help/> <help_response status="200"
status_text="OK">
AUTHENTICATE Authenticate with the manager.
COMMANDS Run a list of commands.
CREATE_AGENT Create an agent.
CREATE_ALERT Create an alert.
CREATE_ASSET Create an asset.
CREATE_CONFIG Create a config.
CREATE_CREDENTIAL Create a credential.
CREATE_FILTER Create a filter.
CREATE_GROUP Create a group.
CREATE_NOTE Create a note.
CREATE_OVERRIDE Create an override.
CREATE_PERMISSION Create a permission.
CREATE_PORT_LIST Create a port list.
CREATE_PORT_RANGE Create a port range in a port list.
CREATE_REPORT Create a report.
CREATE_REPORT_FORMAT Create a report format.
CREATE_ROLE Create a role.
CREATE_SCANNER Create a scanner.
CREATE_SCHEDULE Create a schedule.
CREATE_TAG Create a tag.
CREATE_TARGET Create a target.
CREATE_TASK Create a task.
CREATE_USER Create a new user.
DELETE_AGENT Delete an agent.
DELETE_ALERT Delete an alert.
DELETE_ASSET Delete an asset.
DELETE_CONFIG Delete a config.
DELETE_CREDENTIAL Delete a credential.
DELETE_FILTER Delete a filter.
DELETE_GROUP Delete a group.
DELETE_NOTE Delete a note.
DELETE_OVERRIDE Delete an override.
DELETE_PERMISSION Delete a permission.
DELETE_PORT_LIST Delete a port list.
DELETE_PORT_RANGE Delete a port range.
DELETE_REPORT Delete a report.
DELETE_REPORT_FORMAT Delete a report format.
DELETE_ROLE Delete a role.
DELETE_SCANNER Delete a scanner.
DELETE_SCHEDULE Delete a schedule.
DELETE_TAG Delete a tag.
DELETE_TARGET Delete a target.
DELETE_TASK Delete a task.
DELETE_USER Delete an existing user.
DESCRIBE_AUTH Get details about the used authentication methods.
EMPTY_TRASHCAN Empty the trashcan.
GET_AGENTS Get all agents.
GET_AGGREGATES Get aggregates of resources.
GET_ALERTS Get all alerts.
GET_ASSETS Get all assets.
GET_CONFIGS Get all configs.
GET_CREDENTIALS Get all credentials.
GET_FEEDS Get details of one or all feeds this Manager uses.
GET_FILTERS Get all filters.
GET_GROUPS Get all groups.
GET_INFO Get raw information for a given item.
GET_NOTES Get all notes.
GET_NVTS Get one or all available NVTs.
GET_NVT_FAMILIES Get a list of all NVT families.
GET_OVERRIDES Get all overrides.
GET_PERMISSIONS Get all permissions.
GET_PORT_LISTS Get all port lists.
GET_PREFERENCES Get preferences for all available NVTs.
GET_REPORTS Get all reports.
GET_REPORT_FORMATS Get all report formats.
GET_RESULTS Get results.
GET_ROLES Get all roles.
GET_SCANNERS Get all scanners.
GET_SCHEDULES Get all schedules.
GET_SETTINGS Get all settings.
GET_SYSTEM_REPORTS Get all system reports.
GET_TAGS Get all tags.
GET_TARGETS Get all targets.
GET_TASKS Get all tasks.
GET_USERS Get all users.
GET_VERSION Get the OpenVAS Manager Protocol version.
HELP Get this help text.
MODIFY_AGENT Modify an existing agent.
MODIFY_ALERT Modify an existing alert.
MODIFY_ASSET Modify an existing asset.
MODIFY_AUTH Modify the authentication methods.
MODIFY_CONFIG Update an existing config.
MODIFY_CREDENTIAL Modify an existing credential.
MODIFY_FILTER Modify an existing filter.
MODIFY_GROUP Modify an existing group.
MODIFY_NOTE Modify an existing note.
MODIFY_OVERRIDE Modify an existing override.
MODIFY_PERMISSION Modify an existing permission.
MODIFY_PORT_LIST Modify an existing port list.
MODIFY_REPORT Modify an existing report.
MODIFY_REPORT_FORMAT Modify an existing report format.
MODIFY_ROLE Modify an existing role.
MODIFY_SCANNER Modify an existing scanner.
MODIFY_SCHEDULE Modify an existing schedule.
MODIFY_SETTING Modify an existing setting.
MODIFY_TAG Modify an existing tag.
MODIFY_TARGET Modify an existing target.
MODIFY_TASK Update an existing task.
MODIFY_USER Modify a user.
MOVE_TASK Assign task to another slave scanner, even while running.
RESTORE Restore a resource.
RESUME_TASK Resume a stopped task.
RUN_WIZARD Run a wizard.
START_TASK Manually start an existing task.
STOP_TASK Stop a running task.
SYNC_CERT Synchronize with a CERT feed.
SYNC_CONFIG Synchronize a config with a scanner.
SYNC_FEED Synchronize with an NVT feed.
SYNC_SCAP Synchronize with a SCAP feed.
TEST_ALERT Run an alert.
VERIFY_AGENT Verify an agent.
VERIFY_REPORT_FORMAT Verify a report format.
VERIFY_SCANNER Verify a scanner.
</help_response>
7.77.3 Example: Get the OMP schema
Client
<help format="XML"/> <help_response status="200"
status_text="OK">
<schema format="XML"
extension="xml"
content_type="text/xml">
<protocol>
<name>OpenVAS Management Protocol</name>
<abbreviation>OMP</abbreviation>
<summary>
The "management" protocol of the Open Vulnerability Assessment System
</summary>
<version>1.0</version>
<type>
<name>base64</name>
<summary>Base64 encoded data</summary>
<pattern>xsd:base64Binary</pattern>
</type>
...
<command>
<name>authenticate</name>
<summary>Authenticate with the manager</summary>
<description>
<p>
The client uses the authenticate command to authenticate with the
Manager.
</p>
<p>
The client normally executes this command at the beginning of each
connection. The only commands permitted before authentication are
get_version and commands.
</p>
</description>
<pattern>
<e>credentials</e>
</pattern>
<ele>
<name>credentials</name>
<pattern>
<e>username</e>
<e>password</e>
</pattern>
<ele>
<name>username</name>
<summary>The login name of the user</summary>
<pattern>text</pattern>
</ele>
<ele>
<name>password</name>
<summary>The user's password</summary>
<pattern>text</pattern>
</ele>
</ele>
<response>
<pattern>
<attrib>
<name>status</name>
<type>status</type>
<required>1</required>
</attrib>
<attrib>
<name>status_text</name>
<type>text</type>
<required>1</required>
</attrib>
</pattern>
</response>
<example>
<summary>Authenticate with a good password</summary>
<request>
<authenticate>
<credentials>
<username>sally</username>
<password>secret</password>
</credentials>
</authenticate>
</request>
<response>
<authenticate_response status="200"
status_text="OK">
<role>User</role>
<timezone>UTC</timezone>
</authenticate_response>
</response>
</example>
...
</command>
...
</protocol>
</schema>
</help_response>
7.78 Command modify_agentIn short: Modify an existing agent. The client uses the modify_agent command to change an existing agent. 7.78.1 Structure
7.78.2 RNC
Command
modify_agent
= element modify_agent
{
attribute agent_id { uuid }
& modify_agent_name?
& modify_agent_comment?
}
modify_agent_comment
= element comment
{
text
}
modify_agent_name
= element name
{
name
}
modify_agent_response
= element modify_agent_response
{
attribute status { status }
& attribute status_text { text }
}
7.78.3 Example: Modify the comment on an agent
Client
<modify_agent agent_id="c737f787-9473-410d-8956-9d7b57bdd11f"> <comment>Old Agent 1</comment> </modify_agent> <modify_agent_response status="200"
status_text="OK"/>
7.79 Command modify_alertIn short: Modify an existing alert. The client uses the modify_alert command to change an existing alert. 7.79.1 Structure
7.79.2 RNC
Command
modify_alert
= element modify_alert
{
attribute alert_id { uuid }
& modify_alert_name?
& modify_alert_comment?
& modify_alert_filter?
& modify_alert_event?
& modify_alert_condition?
& modify_alert_method?
}
modify_alert_name
= element name
{
name
}
modify_alert_comment
= element comment
{
text
}
modify_alert_condition
= element condition
{
text
& modify_alert_condition_data*
}
modify_alert_condition_data
= element data
{
text
& modify_alert_condition_data_name
}
modify_alert_condition_data_name
= element name
{
text
}
modify_alert_event
= element event
{
text
& modify_alert_event_data*
}
modify_alert_event_data
= element data
{
text
& modify_alert_event_data_name
}
modify_alert_event_data_name
= element name
{
text
}
modify_alert_method
= element method
{
text
& modify_alert_method_data*
}
modify_alert_method_data
= element data
{
text
& modify_alert_method_data_name
}
modify_alert_method_data_name
= element name
{
text
}
modify_alert_filter
= element filter
{
attribute id { uuid }
}
modify_alert_response
= element modify_alert_response
{
attribute status { status }
& attribute status_text { text }
}
7.79.3 Example: Modify the name and report filter of an alert and the condition that triggers it
Client
<modify_alert alert_id="914b59f8-25f5-4c8f-832c-2379cd625236">
<name>Low Level Alert 2</name>
<condition>
Threat level at least
<data>
Low
<name>level</name>
</data>
</condition>
<filter id="7a06bd00-7e4a-4669-b7d7-8fe65ec64a41"/>
</modify_alert>
<modify_alert_response status="200"
status_text="OK"/>
7.80 Command modify_assetIn short: Modify an existing asset. The client uses the modify_asset command to change an existing asset. 7.80.1 Structure
7.80.2 RNC
Command
modify_asset
= element modify_asset
{
attribute asset_id { uuid }
& modify_asset_comment?
}
modify_asset_comment
= element comment
{
text
}
modify_asset_response
= element modify_asset_response
{
attribute status { status }
& attribute status_text { text }
}
7.80.3 Example: Modify the comment of an asset
Client
<modify_asset asset_id="914b59f8-25f5-4c8f-832c-2379cd625236"> <comment>New comment</comment> </modify_asset> <modify_asset_response status="200"
status_text="OK"/>
7.81 Command modify_authIn short: Modify the authentication methods. The client uses the "modify_auth" command to modify the authentication methods. 7.81.1 Structure
7.81.2 RNC
Command
modify_auth
= element modify_auth
{
modify_auth_group
}
modify_auth_group
= element group
{
modify_auth_group_auth_conf_setting*
}
modify_auth_group_auth_conf_setting
= element auth_conf_setting
{
modify_auth_group_auth_conf_setting_key
& modify_auth_group_auth_conf_setting_value
}
modify_auth_group_auth_conf_setting_key
= element key
{
text
}
modify_auth_group_auth_conf_setting_value
= element value
{
text
}
modify_auth_response
= element modify_auth_response
{
attribute status { status }
& attribute status_text { text }
}
7.81.3 Example: Modify a single setting for an authentication method
Client
<modify_auth>
<group name="Foo">
<auth_conf_setting>
<key>Bar</key>
<value>Baz</value>
</auth_conf_setting>
</group>
</modify_auth>
<modify_auth_response status="200"
status_text="OK"/>
7.82 Command modify_configIn short: Modify an existing config. This command can take five forms: with a preference, with a family selection, with an NVT selection, or with a name or comment. The first form modifies a preference on the config. If the preference includes an NVT, then the preference is an NVT preference, otherwise the preference is a scanner preference. If the preference includes a value then the manager updates the value of the preference, otherwise the manager removes the preference. The value must be base64 encoded. The second form, with a family selection, lets the client modify the NVTs selected by the config at a family level. The idea is that the client modifies the entire family selection at once, so a client will often need to include many families in a family selection. The family_selection may include a growing element to indicate whether new families should be added to the selection. It may also include any number of family elements. A family element must always include a name and may include a growing element and an all element. The all element indicates whether all NVTs in the family should be selected. The growing element indicates whether new NVTs in the family should be added to the selection as they arrive. Leaving a family out of the family_selection is equivalent to including the family with all 0 and growing 0. The effect of the all 0 and growing 0 case is subtle: if all NVTs were selected then all are removed (effectively removing the family from the config). However if some NVTs were selected then they remain selected. As a result the client must include in the family_selection all families that must have all NVTs selected. The third option, an NVT selection, must include a family and may include any number of NVTs. The manager updates the given family in the config to include only the given NVTs. If there was no error with the command sent by the client, the manager will apply the changes to the config and will reply with a response code indicating success. 7.82.1 Structure
7.82.2 RNC
Command
modify_config
= element modify_config
{
attribute config_id { uuid }
& ( modify_config_name
| modify_config_comment
| modify_config_scanner
| modify_config_preference
| modify_config_family_selection
| modify_config_nvt_selection )
}
modify_config_name
= element name
{
name
}
modify_config_comment
= element comment
{
text
}
modify_config_scanner
= element scanner
{
text
}
modify_config_preference
= element preference
{
modify_config_preference_name
& modify_config_preference_nvt?
& modify_config_preference_value?
}
modify_config_preference_name
= element name
{
name
}
modify_config_preference_nvt
= element nvt
{
attribute oid { oid }
}
modify_config_preference_value
= element value
{
base64
}
modify_config_family_selection
= element family_selection
{
modify_config_family_selection_growing?
& modify_config_family_selection_family*
}
modify_config_family_selection_growing
= element growing
{
boolean_atoi
}
modify_config_family_selection_family
= element family
{
modify_config_family_selection_family_all?
& modify_config_family_selection_family_growing?
& modify_config_family_selection_family_name
}
modify_config_family_selection_family_all
= element all
{
boolean_atoi
}
modify_config_family_selection_family_growing
= element growing
{
boolean_atoi
}
modify_config_family_selection_family_name
= element name
{
name
}
modify_config_nvt_selection
= element nvt_selection
{
modify_config_nvt_selection_family
& modify_config_nvt_selection_nvt*
}
modify_config_nvt_selection_family
= element family
{
name
}
modify_config_nvt_selection_nvt
= element nvt
{
attribute oid { oid }
}
modify_config_response
= element modify_config_response
{
attribute status { status }
& attribute status_text { text }
}
7.82.3 Example: Modify a config NVT preference
Client
<modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.14259"/>
<name>Nmap (NASL wrapper)[checkbox]:UDP port scan</name>
<value>eWVz</value>
</preference>
</modify_config>
<modify_config_response status="200"
status_text="OK"/>
7.82.3 Example: Modify a config Scanner preference
Client
<modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<preference>
<name>scanner[scanner]:vhosts</name>
<value>ZXhhbXBsZQ==</value>
</preference>
</modify_config>
<modify_config_response status="200"
status_text="OK"/>
7.82.3 Example: Modify the families that a config selectsThe outer "growing" element sets the config to add any new families that arrive. The client requests the Manager to keep a single selected family (Debian Local Security Checks), to select all NVTs in this family, and to automatically add any new NVTs in this family to the config.
Client
<modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<family_selection>
<growing>1</growing>
<family>
<name>Debian Local Security Checks</name>
<all>1</all>
<growing>1</growing>
</family>
</family_selection>
</modify_config>
<modify_config_response status="200"
status_text="OK"/>
7.82.3 Example: Modify the NVTs that a config selects in a particular family
Client
<modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<nvt_selection>
<family>Debian Local Security Checks</family>
<nvt oid="1.3.6.1.4.1.25623.1.0.53797"/>
<nvt oid="1.3.6.1.4.1.25623.1.0.63272"/>
<nvt oid="1.3.6.1.4.1.25623.1.0.55615"/>
<nvt oid="1.3.6.1.4.1.25623.1.0.53546"/>
</nvt_selection>
</modify_config>
<modify_config_response status="200"
status_text="OK"/>
7.83 Command modify_credentialIn short: Modify an existing credential. The client uses the modify_credential command to change an existing credential. The login and password can only be changed for password credentials. Modification of login or password on package credentials is forbidden. 7.83.1 Structure
7.83.2 RNC
Command
modify_credential
= element modify_credential
{
attribute credential_id { uuid }
& modify_credential_comment?
& modify_credential_name?
& modify_credential_allow_insecure?
& modify_credential_certificate?
& modify_credential_key?
& modify_credential_login?
& modify_credential_password?
& modify_credential_community?
& modify_credential_auth_algorithm?
& modify_credential_privacy?
}
modify_credential_name
= element name
{
name
}
modify_credential_comment
= element comment
{
text
}
modify_credential_allow_insecure
= element allow_insecure
{
boolean
}
modify_credential_certificate
= element certificate
{
text
}
modify_credential_key
= element key
{
modify_credential_key_phrase
& modify_credential_key_private
}
modify_credential_key_phrase
= element phrase
{
text
}
modify_credential_key_private
= element private
{
text
}
modify_credential_login
= element login
{
text
}
modify_credential_password
= element password
{
text
}
modify_credential_community
= element community
{
text
}
modify_credential_auth_algorithm
= element auth_algorithm
{
xsd:token { pattern = "md5|sha1" }
}
modify_credential_privacy
= element privacy
{
modify_credential_privacy_algorithm
& modify_credential_privacy_password
}
modify_credential_privacy_algorithm
= element algorithm
{
xsd:token { pattern = "aes|des" }
}
modify_credential_privacy_password
= element password
{
text
}
modify_credential_response
= element modify_credential_response
{
attribute status { status }
& attribute status_text { text }
}
7.83.3 Example: Modify the comment of an credential
Client
<modify_credential credential_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <comment>Credential for all machines in lab 4.</comment> </modify_credential> <modify_credential_response status="200"
status_text="OK"/>
7.84 Command modify_filterIn short: Modify an existing filter. The client uses the modify_filter command to change an existing filter. 7.84.1 Structure
7.84.2 RNC
Command
modify_filter
= element modify_filter
{
attribute filter_id { uuid }
& modify_filter_comment?
& modify_filter_name?
& modify_filter_term?
& modify_filter_type?
}
modify_filter_comment
= element comment
{
text
}
modify_filter_name
= element name
{
name
}
modify_filter_term
= element term
{
text
}
modify_filter_type
= element type
{
text
}
modify_filter_response
= element modify_filter_response
{
attribute status { status }
& attribute status_text { text }
}
7.84.3 Example: Modify the term of a filter
Client
<modify_filter filter_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <term>name=local</term> </modify_filter> <modify_filter_response status="200"
status_text="OK"/>
7.85 Command modify_groupIn short: Modify an existing group. The client uses the modify_group command to change an existing group. 7.85.1 Structure
7.85.2 RNC
Command
modify_group
= element modify_group
{
attribute group_id { uuid }
& modify_group_name?
& modify_group_comment?
& modify_group_users?
}
modify_group_name
= element name
{
name
}
modify_group_comment
= element comment
{
text
}
modify_group_users
= element users
{
text
}
modify_group_response
= element modify_group_response
{
attribute status { status }
& attribute status_text { text }
}
7.85.3 Example: Modify the name of a group
Client
<modify_group group_id="d94211b6-ba40-11e3-bcb1-406186ea4fc5"> <name>Line Managers</name> </modify_group> <modify_group_response status="200"
status_text="OK"/>
7.86 Command modify_noteIn short: Modify an existing note. The client uses the modify_note command to change an existing note. If an optional element is left out, the existing value will be cleared, generalising that constraint. 7.86.1 Structure
7.86.2 RNC
Command
modify_note
= element modify_note
{
attribute note_id { uuid }
& modify_note_active?
& modify_note_hosts?
& modify_note_port?
& modify_note_result?
& modify_note_severity?
& modify_note_task?
& modify_note_text
& modify_note_threat?
}
modify_note_active
= element active
{
integer
}
modify_note_hosts
= element hosts
{
text
}
modify_note_port
= element port
{
text
}
modify_note_severity
= element severity
{
severity
}
modify_note_text
= element text
{
text
}
modify_note_threat
= element threat
{
threat
}
modify_note_task
= element task
{
attribute id { uuid }
}
modify_note_result
= element result
{
attribute id { uuid }
}
modify_note_response
= element modify_note_response
{
attribute status { status }
& attribute status_text { text }
}
7.86.3 Example: Modify the text and result of a note
Client
<modify_note note_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <text>This issue should be resolved after the upgrade.</text> <result result_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c"/> </modify_note> <modify_note_response status="200"
status_text="OK"/>
7.87 Command modify_overrideIn short: Modify an existing override. The client uses the modify_override command to change an existing override. If an optional element is left out, the existing value will be cleared, generalising that constraint. 7.87.1 Structure
7.87.2 RNC
Command
modify_override
= element modify_override
{
attribute override_id { uuid }
& modify_override_active?
& modify_override_hosts?
& modify_override_new_severity?
& modify_override_new_threat?
& modify_override_port?
& modify_override_result?
& modify_override_task?
& modify_override_text
& modify_override_severity?
& modify_override_threat?
}
modify_override_active
= element active
{
integer
}
modify_override_hosts
= element hosts
{
text
}
modify_override_new_severity
= element new_severity
{
severity
}
modify_override_new_threat
= element new_threat
{
threat
}
modify_override_port
= element port
{
text
}
modify_override_text
= element text
{
text
}
modify_override_severity
= element severity
{
severity
}
modify_override_threat
= element threat
{
threat
}
modify_override_task
= element task
{
attribute id { uuid }
}
modify_override_result
= element result
{
attribute id { uuid }
}
modify_override_response
= element modify_override_response
{
attribute status { status }
& attribute status_text { text }
}
7.87.3 Example: Set the override threat to Low
Client
<modify_override override_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <text>This issue is less important in our setup.</text> <new_threat>Low</new_threat> </modify_override> <modify_override_response status="200"
status_text="OK"/>
7.88 Command modify_permissionIn short: Modify a permission. The client uses the modify_permission command to change an existing permission. 7.88.1 Structure
7.88.2 RNC
Command
modify_permission
= element modify_permission
{
attribute permission_id { uuid }
& modify_permission_name?
& modify_permission_comment?
& modify_permission_resource?
& modify_permission_subject?
}
modify_permission_name
= element name
{
text
}
modify_permission_comment
= element comment
{
text
}
modify_permission_resource
= element resource
{
attribute id { uuid }?
& modify_permission_resource_type
}
modify_permission_resource_type
= element type
{
text
}
modify_permission_subject
= element subject
{
attribute id { uuid }?
& modify_permission_subject_type
}
modify_permission_subject_type
= element type
{
text
}
modify_permission_response
= element modify_permission_response
{
attribute status { status }
& attribute status_text { text }
}
7.88.3 Example: Change user of a permission
Client
<modify_permission permission_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<subject id="76e47468-c095-11e3-9285-406186ea4fc5">
<type>user</type>
</subject>
</modify_permission>
<modify_permission_response status="200"
status_text="OK"/>
7.89 Command modify_port_listIn short: Modify an existing port list. The client uses the modify_port_list command to change an existing port list. 7.89.1 Structure
7.89.2 RNC
Command
modify_port_list
= element modify_port_list
{
attribute port_list_id { uuid }
& modify_port_list_name?
& modify_port_list_comment?
}
modify_port_list_name
= element name
{
name
}
modify_port_list_comment
= element comment
{
text
}
modify_port_list_response
= element modify_port_list_response
{
attribute status { status }
& attribute status_text { text }
}
7.89.3 Example: Modify the name of a port list
Client
<modify_port_list port_list_id="27140836-05ae-4e8b-9abf-f725ddc2888f"> <name>PL-WS1</name> <comment>Port List for Web Server 1</comment> </modify_port_list> <modify_port_list_response status="200"
status_text="OK"/>
7.90 Command modify_reportIn short: Modify an existing report. The client uses the modify_report command to change an existing report. 7.90.1 Structure
7.90.2 RNC
Command
modify_report
= element modify_report
{
attribute report_id { uuid }
& modify_report_comment
}
modify_report_comment
= element comment
{
text
}
modify_report_response
= element modify_report_response
{
attribute status { status }
& attribute status_text { text }
}
7.90.3 Example: Modify a report comment
Client
<modify_report report_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <comment>Monthly scan of the webserver.</comment> </modify_report> <modify_report_response status="200"
status_text="OK"/>
7.91 Command modify_report_formatIn short: Update an existing report format. The client uses the modify_report_format command to change an existing report format. 7.91.1 Structure
7.91.2 RNC
Command
modify_report_format
= element modify_report_format
{
attribute report_format_id { uuid }
& ( modify_report_format_active
| modify_report_format_name
| modify_report_format_summary
| modify_report_format_param )
}
modify_report_format_active
= element active
{
boolean
}
modify_report_format_name
= element name
{
name
}
modify_report_format_summary
= element summary
{
text
}
modify_report_format_param
= element param
{
modify_report_format_param_name
& modify_report_format_param_value?
}
modify_report_format_param_name
= element name
{
name
}
modify_report_format_param_value
= element value
{
base64
}
modify_report_format_response
= element modify_report_format_response
{
attribute status { status }
& attribute status_text { text }
}
7.91.3 Example: Modify a report format param
Client
<modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<param>
<name>Background Colour</name>
<value>cmVk</value>
</param>
</modify_report_format>
<modify_report_format_response status="200"
status_text="OK"/>
7.91.3 Example: Modify the name of a report format
Client
<modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <name>New name</name> </modify_report_format> <modify_report_format_response status="200"
status_text="OK"/>
7.92 Command modify_roleIn short: Modify an existing role. The client uses the modify_role command to change an existing role. 7.92.1 Structure
7.92.2 RNC
Command
modify_role
= element modify_role
{
attribute role_id { uuid }
& modify_role_name?
& modify_role_comment?
& modify_role_users?
}
modify_role_name
= element name
{
name
}
modify_role_comment
= element comment
{
text
}
modify_role_users
= element users
{
text
}
modify_role_response
= element modify_role_response
{
attribute status { status }
& attribute status_text { text }
}
7.92.3 Example: Modify the name of a role
Client
<modify_role role_id="914b59f8-25f5-4c8f-832c-2379cd625236"> <name>SCAP User</name> </modify_role> <modify_role_response status="200"
status_text="OK"/>
7.93 Command modify_scannerIn short: Modify an existing scanner. The client uses the modify_scanner command to change an existing scanner. 7.93.1 Structure
7.93.2 RNC
Command
modify_scanner
= element modify_scanner
{
attribute scanner_id { uuid }
& modify_scanner_comment?
& modify_scanner_name?
& modify_scanner_host
& modify_scanner_port
& modify_scanner_type
& modify_scanner_ca_pub?
& modify_scanner_credential?
}
modify_scanner_comment
= element comment
{
text
}
modify_scanner_name
= element name
{
name
}
modify_scanner_host
= element host
{
text
}
modify_scanner_port
= element port
{
text
}
modify_scanner_type
= element type
{
text
}
modify_scanner_ca_pub
= element ca_pub
{
text
}
modify_scanner_credential
= element credential
{
attribute id { uuid }
}
modify_scanner_response
= element modify_scanner_response
{
attribute status { status }
& attribute status_text { text }
}
7.93.3 Example: Modify the name of a scanner
Client
<modify_scanner scanner_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <name>Weekly Scan</name> </modify_scanner> <modify_scanner_response status="200"
status_text="OK"/>
7.94 Command modify_scheduleIn short: Modify an existing schedule. The client uses the modify_schedule command to change an existing schedule. 7.94.1 Structure
7.94.2 RNC
Command
modify_schedule
= element modify_schedule
{
attribute schedule_id { uuid }
& modify_schedule_comment?
& modify_schedule_name?
& modify_schedule_first_time?
& modify_schedule_duration?
& modify_schedule_period?
& modify_schedule_timezone?
}
modify_schedule_comment
= element comment
{
text
}
modify_schedule_name
= element name
{
name
}
modify_schedule_first_time
= element first_time
{
modify_schedule_first_time_day_of_month?
& modify_schedule_first_time_hour?
& modify_schedule_first_time_minute?
& modify_schedule_first_time_month?
& modify_schedule_first_time_year?
}
modify_schedule_first_time_day_of_month
= element day_of_month
{
text
}
modify_schedule_first_time_hour
= element hour
{
text
}
modify_schedule_first_time_minute
= element minute
{
text
}
modify_schedule_first_time_month
= element month
{
text
}
modify_schedule_first_time_year
= element year
{
text
}
modify_schedule_timezone
= element timezone
{
timezone
}
modify_schedule_duration
= element duration
{
text
& modify_schedule_duration_unit?
}
modify_schedule_duration_unit
= element unit
{
time_unit
}
modify_schedule_period
= element period
{
text
& modify_schedule_period_unit?
}
modify_schedule_period_unit
= element unit
{
time_unit
}
modify_schedule_response
= element modify_schedule_response
{
attribute status { status }
& attribute status_text { text }
}
7.94.3 Example: Modify the name of a schedule
Client
<modify_schedule schedule_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <name>Weekly Scan</name> </modify_schedule> <modify_schedule_response status="200"
status_text="OK"/>
7.95 Command modify_settingIn short: Modify an existing setting. The client uses the modify_setting command to change an existing setting. These are user settings that can be controlled via OMP. The settings "Password" and "Timezone" can be modified by name, the rest by UUID. 7.95.1 Structure
7.95.2 RNC
Command
modify_setting
= element modify_setting
{
attribute setting_id { uuid }?
& modify_setting_name
& modify_setting_value
}
modify_setting_name
= element name
{
text
}
modify_setting_value
= element value
{
text
}
modify_setting_response
= element modify_setting_response
{
attribute status { status }
& attribute status_text { text }
}
7.95.3 Example: Modify the timezone
Client
<modify_setting> <name>Timezone</name> <value>Africa/Johannesburg</value> </modify_setting> <modify_setting_response status="200"
status_text="OK"/>
7.96 Command modify_targetIn short: Modify an existing target. The client uses the modify_target command to change an existing target. 7.96.1 Structure
7.96.2 RNC
Command
modify_target
= element modify_target
{
attribute target_id { uuid }
& modify_target_comment?
& modify_target_name?
& modify_target_hosts?
& modify_target_hosts_ordering?
& modify_target_exclude_hosts?
& modify_target_ssh_credential?
& modify_target_smb_credential?
& modify_target_esxi_credential?
& modify_target_snmp_credential?
& modify_target_ssh_lsc_credential?
& modify_target_smb_lsc_credential?
& modify_target_esxi_lsc_credential?
& modify_target_port_list?
& modify_target_alive_tests?
& modify_target_reverse_lookup_only?
& modify_target_reverse_lookup_unify?
}
modify_target_comment
= element comment
{
text
}
modify_target_name
= element name
{
name
}
modify_target_hosts
= element hosts
{
text
}
modify_target_hosts_ordering
= element hosts_ordering
{
text
}
modify_target_exclude_hosts
= element exclude_hosts
{
text
}
modify_target_ssh_credential
= element ssh_credential
{
attribute id { uuid }
}
modify_target_smb_credential
= element smb_credential
{
attribute id { uuid }
}
modify_target_esxi_credential
= element esxi_credential
{
attribute id { uuid }
}
modify_target_snmp_credential
= element snmp_credential
{
attribute id { uuid }
}
modify_target_ssh_lsc_credential
= element ssh_lsc_credential
{
attribute id { uuid }
}
modify_target_smb_lsc_credential
= element smb_lsc_credential
{
attribute id { uuid }
}
modify_target_esxi_lsc_credential
= element esxi_lsc_credential
{
attribute id { uuid }
}
modify_target_port_list
= element port_list
{
attribute id { uuid }
}
modify_target_alive_tests
= element alive_tests
{
alive_test
}
modify_target_reverse_lookup_only
= element reverse_lookup_only
{
boolean
}
modify_target_reverse_lookup_unify
= element reverse_lookup_unify
{
boolean
}
modify_target_response
= element modify_target_response
{
attribute status { status }
& attribute status_text { text }
}
7.96.3 Example: Modify the name of a target
Client
<modify_target target_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <name>Upstairs Lab</name> </modify_target> <modify_target_response status="200"
status_text="OK"/>
7.97 Command modify_tagIn short: Modify a tag. The client uses the modify_tag command to change an existing tag. 7.97.1 Structure
7.97.2 RNC
Command
modify_tag
= element modify_tag
{
attribute tag_id { uuid }
& modify_tag_name?
& modify_tag_resource?
& modify_tag_value?
& modify_tag_comment?
& modify_tag_active?
}
modify_tag_name
= element name
{
text
}
modify_tag_resource
= element resource
{
attribute id { uuid }?
& modify_tag_resource_type
}
modify_tag_resource_type
= element type
{
text
}
modify_tag_value
= element value
{
text
}
modify_tag_comment
= element comment
{
text
}
modify_tag_active
= element active
{
boolean
}
modify_tag_response
= element modify_tag_response
{
attribute status { status }
& attribute status_text { text }
}
7.97.3 Example: Deactivate a tag
Client
<modify_tag tag_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <active>0</active> </modify_tag> <modify_tag_response status="200"
status_text="OK"/>
7.98 Command modify_taskIn short: Modify an existing task. The client uses the modify_task command to change an existing task. 7.98.1 Structure
7.98.2 RNC
Command
modify_task
= element modify_task
{
attribute task_id { uuid }
& ( modify_task_comment
| modify_task_alert*
| modify_task_name
| modify_task_observers
| modify_task_preferences
| modify_task_schedule
| modify_task_schedule_periods
| modify_task_scanner
| modify_task_file )
}
modify_task_comment
= element comment
{
text
}
modify_task_alert
= element alert
{
attribute id { uuid }
}
modify_task_name
= element name
{
name
}
modify_task_observers
= element observers
{
user_list
}
modify_task_preferences
= element preferences
{
modify_task_preferences_preference*
}
modify_task_preferences_preference
= element preference
{
modify_task_preferences_preference_scanner_name
& modify_task_preferences_preference_value
}
modify_task_preferences_preference_scanner_name
= element scanner_name
{
text
}
modify_task_preferences_preference_value
= element value
{
text
}
modify_task_schedule
= element schedule
{
attribute id { uuid }
}
modify_task_schedule_periods
= element schedule_periods
{
integer
}
modify_task_scanner
= element scanner
{
attribute id { uuid }
}
modify_task_file
= element file
{
text # RNC limitation: base64
& attribute name { text }
& attribute action { xsd:token { pattern = "update|remove" } }
}
modify_task_response
= element modify_task_response
{
attribute status { status }
& attribute status_text { text }
}
7.98.3 Example: Modify a task comment
Client
<modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"> <comment>Monthly scan of the webserver.</comment> </modify_task> <modify_task_response status="200"
status_text="OK"/>
7.99 Command modify_userIn short: Modify a user. The client uses the "modify_user" command to modify an user account on the OpenVAS server. 7.99.1 Structure
7.99.2 RNC
Command
modify_user
= element modify_user
{
attribute user_id { uuid }
& modify_user_name
& modify_user_new_name?
& modify_user_password?
& modify_user_role*
& modify_user_hosts?
& modify_user_ifaces?
& modify_user_sources?
}
modify_user_name
= element name
{
text
}
modify_user_new_name
= element new_name
{
text
}
modify_user_hosts
= element hosts
{
text
& attribute allow { boolean }?
}
modify_user_ifaces
= element ifaces
{
text
& attribute allow { boolean }?
}
modify_user_password
= element password
{
text
}
modify_user_role
= element role
{
attribute id { uuid }
}
modify_user_sources
= element sources # type sources
{
}
modify_user_response
= element modify_user_response
{
attribute status { status }
& attribute status_text { text }
}
7.99.3 Example: Modify a user
Client
<modify_user> <name>Foobar</name> <password modify="0"/> <role id="8d453140-b74d-11e2-b0be-406186ea4fc5"/> <hosts allow="0"/> </modify_user> <modify_user_response status="200"
status_text="OK"/>
7.100 Command move_taskIn short: Moves an existing task to another OMP slave scanner or the master. If a scan is running, this command will stop the task and resume it after reassigning to the new OMP scanner or master. Note that in this case, the command will wait until the task has been requested to resume. 7.100.1 Structure
7.100.2 RNC
Command
move_task
= element move_task
{
attribute task_id { uuid }
& attribute slave_id { uuid }
}
move_task_response
= element move_task_response
{
attribute status { status }
& attribute status_text { text }
}
7.100.3 Example: Move a task to a slave
Client
<move_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"
slave_id="97390ade-e075-11df-9973-002264764cea"/>
<move_task_response status="200"
status_text="OK"/>
7.101 Command restoreIn short: Restore a resource. The client uses the restore a resource from the trashcan. 7.101.1 Structure7.101.2 RNC
Command
restore
= element restore
{
attribute id { uuid }
}
restore_response
= element restore_response
{
attribute status { status }
& attribute status_text { text }
}
7.101.3 Example: Restore a target
Client
<restore id="97390ade-e075-11df-9973-002264764cea"/> <restore_response status="200"
status_text="OK"/>
7.102 Command resume_taskIn short: Resume a task. The client uses the resume_task command to manually resume a stopped task. 7.102.1 Structure
7.102.2 RNC
Command
resume_task
= element resume_task
{
attribute task_id { uuid }
}
resume_task_response
= element resume_task_response
{
attribute status { status }
& attribute status_text { text }
& resume_task_response_report_id
}
resume_task_response_report_id
= element report_id
{
uuid
}
7.102.3 Example: Resume a task
Client
<resume_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <resume_task_response status="200"
status_text="OK">
<report_id>330ee785-c2c0-4d4c-ab96-725142c9b789</report_id>
</resume_task_response>
7.103 Command run_wizardIn short: Run a wizard. The client uses the run_wizard command to run a wizard. 7.103.1 Structure
7.103.2 RNC
Command
run_wizard
= element run_wizard
{
run_wizard_mode?
& run_wizard_name
& run_wizard_params
& attribute read_only { boolean }?
}
run_wizard_mode
= element mode
{
text
}
run_wizard_name
= element name
{
name
}
run_wizard_params
= element params
{
run_wizard_params_param*
}
run_wizard_params_param
= element param
{
run_wizard_params_param_name
& run_wizard_params_param_value
}
run_wizard_params_param_name
= element name
{
text
}
run_wizard_params_param_value
= element value
{
text
}
run_wizard_response
= element run_wizard_response
{
attribute status { status }
& attribute status_text { text }
& run_wizard_response_response
}
run_wizard_response_response
= element response
{
""
}
7.103.3 Example: Run the Quick Start wizard to scan localhost
Client
<run_wizard>
<name>quick_first_scan</name>
<params>
<param>
<name>hosts</name>
<value>localhost</value>
</param>
</params>
</run_wizard>
<run_wizard_response status="202"
status_text="OK, request submitted">
<response>
<start_task_response status="202"
status_text="OK, request submitted">
<report_id>a06d21f7-8e2f-4d7f-bceb-1df852d8b37d</report_id>
</start_task_response>
</response>
</run_wizard_response>
7.104 Command start_taskIn short: Manually start an existing task. The client uses the start_task command to manually start an existing task. 7.104.1 Structure
7.104.2 RNC
Command
start_task
= element start_task
{
attribute task_id { uuid }
}
start_task_response
= element start_task_response
{
attribute status { status }
& attribute status_text { text }
& start_task_response_report_id
}
start_task_response_report_id
= element report_id
{
uuid
}
7.104.3 Example: Start a task
Client
<start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <start_task_response status="200"
status_text="OK">
<report_id>330ee785-c2c0-4d4c-ab96-725142c9b789</report_id>
</start_task_response>
7.105 Command stop_taskIn short: Stop a running task. The client uses the stop_task command to manually stop a running task. 7.105.1 Structure7.105.2 RNC
Command
stop_task
= element stop_task
{
attribute task_id { uuid }
}
stop_task_response
= element stop_task_response
{
attribute status { status }
& attribute status_text { text }
}
7.105.3 Example: Stop a running task
Client
<stop_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <stop_task_response status="200"
status_text="OK"/>
7.106 Command sync_certIn short: Synchronize with a CERT feed. The client uses the "sync_cert" command to request a synchronization with the CERT feed service the Manager uses. 7.106.1 Structure
7.106.2 RNC
Command
sync_cert
= element sync_cert
{
""
}
sync_cert_response
= element sync_cert_response
{
attribute status { status }
& attribute status_text { text }
}
7.106.3 Example: Sync the feed
Client
<sync_cert/> <sync_cert_response status="202"
status_text="OK, request submitted"/>
7.107 Command sync_feedIn short: Synchronize with an NVT feed. The client uses the "sync_feed" command to request a synchronization with the NVT feed service the Manager uses. 7.107.1 Structure
7.107.2 RNC
Command
sync_feed
= element sync_feed
{
""
}
sync_feed_response
= element sync_feed_response
{
attribute status { status }
& attribute status_text { text }
}
7.107.3 Example: Sync the feed
Client
<sync_feed/> <sync_feed_response status="202"
status_text="OK, request submitted"/>
7.108 Command sync_configIn short: Synchronize a config with a scanner. The client uses the "sync_config" command to request an OSP config synchronization with a scanner, adding new parameters and removing old ones. 7.108.1 Structure
7.108.2 RNC
Command
sync_config
= element sync_config
{
""
}
sync_config_response
= element sync_config_response
{
attribute status { status }
& attribute status_text { text }
}
7.108.3 Example: Sync the config
Client
<sync_config/> <sync_config_response status="202"
status_text="OK, request submitted"/>
7.109 Command sync_scapIn short: Synchronize with a SCAP feed. The client uses the "sync_scap" command to request a synchronization with the SCAP feed service the Manager uses. 7.109.1 Structure
7.109.2 RNC
Command
sync_scap
= element sync_scap
{
""
}
sync_scap_response
= element sync_scap_response
{
attribute status { status }
& attribute status_text { text }
}
7.109.3 Example: Sync the feed
Client
<sync_scap/> <sync_scap_response status="202"
status_text="OK, request submitted"/>
7.110 Command test_alertIn short: Run an alert. The client uses the test_alert command to invoke a test run of an alert. 7.110.1 Structure7.110.2 RNC
Command
test_alert
= element test_alert
{
attribute alert_id { uuid }
}
test_alert_response
= element test_alert_response
{
attribute status { status }
& attribute status_text { text }
}
7.110.3 Example: Test an alert
Client
<test_alert alert_id="97390ade-e075-11df-9973-002264764cea"/> <test_alert_response status="200"
status_text="OK"/>
7.111 Command verify_agentIn short: Verify an agent. The client uses the verify_agent command to verify the trust level of an existing agent. The Manager checks whether the signature of the agent currently matches the agent. This includes the agent installer file. The Manager searches for the signature first in the feed, then in the agent itself. 7.111.1 Structure7.111.2 RNC
Command
verify_agent
= element verify_agent
{
attribute agent_id { uuid }
}
verify_agent_response
= element verify_agent_response
{
attribute status { status }
& attribute status_text { text }
}
7.111.3 Example: Verify an agent
Client
<verify_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <verify_agent_response status="200"
status_text="OK"/>
7.112 Command verify_report_formatIn short: Verify a report format. The client uses the verify_report_format command to verify the trust level of an existing report format. The Manager checks whether the signature of the report format currently matches the report format. This includes the script and files used to generate reports of this format. The Manager searches for the signature first in the feed, then in the report format itself. 7.112.1 Structure7.112.2 RNC
Command
verify_report_format
= element verify_report_format
{
attribute report_format_id { uuid }
}
verify_report_format_response
= element verify_report_format_response
{
attribute status { status }
& attribute status_text { text }
}
7.112.3 Example: Verify a report format
Client
<verify_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/> <verify_report_format_response status="200"
status_text="OK"/>
7.113 Command verify_scannerIn short: Verify a scanner. The client uses the verify_scanner command to verify whether it is possible to connect to an existing scanner. 7.113.1 Structure7.113.2 RNC
Command
verify_scanner
= element verify_scanner
{
attribute scanner_id { uuid }
}
verify_scanner_response
= element verify_scanner_response
{
attribute status { status }
& attribute status_text { text }
}
7.113.3 Example: Verify a scanner
Client
<verify_scanner scanner_id="6acd0832-df90-11e4-b9d5-28d24461215b"/> <verify_scanner_response status="200"
status_text="OK">
<version>OTP/2.0</version>
</verify_scanner_response>
8 Compatibility Changes in Version 7.08.1 Change in GET_NVT_FEED_VERSIONIn short: Command removed. The GET_NVT_FEED_VERSION command has been removed, as it has been superseded by the GET_FEEDS command. 8.2 Change in GET_TASKS, MODIFY_TASKIn short: Element SLAVE removed. Slaves have been replaced by OMP Scanners, therefore the SLAVE elements of commands GET_TASKS and MODIFY_TASK have been removed. 8.3 Change in GET_CREDENTIALSIn short: Attribute "slaves" and element SLAVES removed. Slaves have been replaced by OMP Scanners, therefore the "slaves" attribute and CREDENTIAL/SLAVES element of GET_CREDENTIALS have been removed. 8.4 Change in CREATE_TASKIn short: Element SLAVE removed. Slaves have been replaced by OMP Scanners, therefore the SLAVE element of CREATE_TASK has been removed. 8.5 Change in CREATE_SLAVE, DELETE_SLAVE, GET_SLAVES, MODIFY_SLAVEIn short: Commands removed. Slaves have been replaced by OMP Scanners, therefore the CREATE_SLAVE, DELETE_SLAVE, GET_SLAVES and MODIFY_SLAVE commands have been removed. 8.6 Change in DESCRIBE_FEED, DESCRIBE_SCAP, DESCRIBE_CERTIn short: Commands replaced with GET_FEEDS. The commands DESCRIBE_FEED, DESCRIBE_SCAP and DESCRIBE_CERT have been replaced with a single command, GET_FEEDS. 8.7 Change in GET_REPORT_FORMATS, CREATE_REPORT_FORMATIn short: Element GLOBAL removed. The GLOBAL element has been removed from REPORT_FORMAT. The element will simply be ignored by CREATE_REPORT_FORMAT. 8.8 Change in DESCRIBE_AUTH, MODIFY_AUTHIn short: Response attributes "key" and "value" moved to elements. The attributes "key" and "value" of AUTH_CONF_SETTING have been moved to new child elements of AUTH_CONF_SETTING, KEY and VALUE. This is in order to preserve whitespace in the settings. 8.9 Change in All GET_... commandsIn short: Limit on number of returned rows introduced. The new setting "Max Rows Per Page" introduces a hard upper limit on the number of rows return by any GET command, regardless of the value of the "rows" term in the filter. The setting defaults to 1000 and can be changed globally via the --max-rows option. A value of 0 indicates no limit, which is the previous behaviour. 8.10 Change in GET_RESULTSIn short: Redundant filtering attributes removed. The command attributes "apply_overrides", "autofp", "notes" and "overrides" were removed. Equivalent functionality is available using filters (with the filter and filt_id attributes). 8.11 Change in GET_REPORTSIn short: Redundant filtering attributes removed. The command attributes "first_result", "max_results", "sort_order", "sort_field", "apply_overrides", "levels", "search_phrase", "min_cvss_base", "min_qod", "notes", "overrides", "delta_states", "autofp", "result_hosts_only" and "timezone" were removed. Equivalent functionality is available using filters (with the filter and filt_id attributes). 8.12 Change in GET_REPORTSIn short: Filter keywords in response changed to common format. The elements "phrase", "autofp", "notes", "overrides", "apply_overrides", "result_hosts_only", "min_cvss_base", "min_qod", "timezone" were removed from the "filters" element in the report and replaced with a "keywords" element using the same syntax as other GET_... commands. 8.13 Change in GET_CREDENTIALSIn short: Credential types renamed. The TYPE element in the response will contain "up" instead of "pass" for username + password credentials and "usk" instead of "gen" for username + SSH key ones. 8.14 Change in CREATE_LSC_CREDENTIAL, DELETE_LSC_CREDENTIAL, GET_LSC_CREDENTIALS, MODIFY_LSC_CREDENTIALIn short: Resource type and commands renamed. The type LSC_CREDENTIAL has been renamed to CREDENTIAL, so the CREATE_LSC_CREDENTIAL command is now named CREATE_CREDENTIAL, GET_LSC_CREDENTIALS is named GET_CREDENTIALS, etc. 8.15 Change in CREATE_SCANNER, GET_SCANNERS, MODIFY_SCANNERIn short: key_priv and key_pub replaced by credential. The key_priv and key_pub elements have been replaced by a credential one referencing a "cc" (client certificate) type credential. 8.16 Change in CREATE_SLAVE, GET_SLAVES, MODIFY_SLAVEIn short: username and password replaced by credential. The username and password elements have been replaced by a credential one referencing a "up" (username + password) type credential. 8.17 Change in GET_TARGETSIn short: "lsc_" removed from credential element names. The elements ssh_lsc_credential, smb_lsc_credential and esxi_lsc_credential have been renamed to ssh_credential, smb_credential and esxi_credential.
This file was automatically generated.
|
xS4tτ
HCA!J * {RM2]&ॸz?)?Z-TH8!tWvw35rK!qqU*0Td&yM% B1T֪flr@3`+)^N H\u|S%C<# ^El2-NE*j9T`GfݳBla$Irр[BBVN#]iM"Ab
uP.k&LΆH$h4\ Zg
.7T@}JHIW}\i N 킄4ރʶgAgZ
L{̙vXA,ox/
͵f \qMbz "'%HOu(i7TH ҘȀVd _cT$0vs7z#03$#]zE(i1Ao ;8hTatF_&:+r+?[\ IѬ&>xf448͂ iHH $ $T꒠H#
Su!8uWzl2az;*`bM >
OpenVAS Scanner, openvassd(8), acts as a service and offers a
communication protocol for its clients called OTP. The core
task of the OpenVAS Scanner is the actual scan process.
The OpenVAS Manager is a OTP client and adds various management
functionalities to handle and organise scan results.
Thus OpenVAS Manager acts as a layer between the
OpenVAS Scanner and its own clients (for example omp(8),
gsad(8) or gsd(8)) which connect via the OMP protocol
to the OpenVAS Manager.
A related service is OpenVAS Administrator, openvasad(8) which
among other tasks also manages user accounts for OpenVAS.
SIGHUP causes openvasmd to rebuild the database with information from
the Scanner (openvassd). openvasmd --port 1241 Serve OMP clients on port 1241 and connect to a OTP server on 7772.
The canonical places where you will find more information
about the OpenVAS project are:
The OpenVAS Manager is released under the GNU GPL, version 2,
or, at your option, any later version.
Update OpenVAS Manager port names data from XML file FILE.
The canonical places where you will find more information
about the OpenVAS project are:
The OpenVAS Manager is released under the GNU GPL, version 2,
or, at your option, any later version.
Update the CERT data from the feed server.
The canonical places where you will find more information
about the OpenVAS project are:
The OpenVAS Manager is released under the GNU GPL, version 2,
or, at your option, any later version.
OpenVAS Scanner, openvassd(8), acts as a service and offers a
communication protocol for its clients called OTP. The core
task of the OpenVAS Scanner is the actual scan process.
The OpenVAS Manager is a OTP client and adds various management
functionalities to handle and organise scan results.
Thus OpenVAS Manager acts as a layer between the
OpenVAS Scanner and its own clients (for example omp(8),
gsad(8) or gsd(8)) which connect via the OMP protocol
to the OpenVAS Manager.
A related service is OpenVAS Administrator, openvasad(8) which
among other tasks also manages user accounts for OpenVAS.
-a, --listen=ADDRESS Listen on ADDRESS. --create-user=USERNAME Create admin user USERNAME and exit. --role=ROLE Role for --create-user option. --delete-user=USERNAME Delete user USERNAME and exit. --get-users List users and exit. --create-scanner=NAME Create scanner NAME and exit. --scanner-host=HOST Scanner host for --create-scanner, --rebuild and --update. Default is 127.0.0.1. --scanner-port=PORT Scanner port for --create-scanner, --rebuild and --update. Default is 9391. --scanner-type=TYPE Type for --create-scanner option.
Could be "OpenVAS Scanner" or "OSP Ovaldi". --scanner-ca-pub=CAPUB Scanner CA public key path for --create-scanner. --scanner-key-pub=KEYPUB Scanner public key path for --create-scanner. --scanner-key-priv=KEYPRIV Scanner private key path for --create-scanner. --delete-scanner=UUID Delete scanner with UUID and exit. --get-scanners List scanners and exit. --gnutls-priorities=PRIORITY Set the GnuTLS priority string to PRIORITY. --dh-params=FILE Path to file containing Diffie-Hellman parameters which
are needed for DHE-RSA. This file could be generated using
openssl or certtool. --max-email-attachment-size=SIZE
Maximum number of bytes permitted in alert email attachments.
0 to use the default, negative to allow any size.
--max-email-include-size=SIZE
Maximum number of bytes permitted in reports inlined in alert email
attachments.
0 to use the default, negative to allow any size.
--max-ips-per-target=SIZE
Maximum number of IPs per target.
-u, --update Updates the database with information from a running
scanner (openvassd) and exits. -p, --port=NUMBER Listen on port number NUMBER. --rebuild Rebuild the database with information from a running
scanner (openvassd) and exits. --version Print version. -v, --verbose Print progress messages. -?, --help Show help. SIGHUP causes openvasmd to rebuild the database with information from
the Scanner (openvassd). openvasmd --port 1241 Serve OMP clients on port 1241 and connect to a OTP server on 7772.
openvassd (8),
openvasad (8),
gsad (8),
omp (8),
gsd (8)
The canonical places where you will find more information
about the OpenVAS project are:
http://www.openvas.org/
(Official site)
http://wald.intevation.org/projects/openvas/
(Development Platform)
The OpenVAS Manager is released under the GNU GPL, version 2,
or, at your option, any later version.
h Prr#$(a*AL+4B筿 *>JW$yЍ(ɯw8{H bp*eO JLR50vwEL+Jι2J ⧲F\d^(;%&*-PC&D%K8"JZv ''z//K,7RMQAI9FZOva&(n*qjj\>
i g,QPܭM]0A9ћEHW]>t(zBQ.}30Pw"Z447iJQ(hrepPR]QZN}%G*v)P@ Wt\?E(
3ዝ~uӬ2gn<($r@f JdB65\ʦK5فH Ėt8|ɧ|^X.%6#z ",JgڢqU%$hR) o!Iݾ yTN%a.qjZ T$z %KW?mҽ4\}}5D$Vu¦:~[`~oU()] 4vo %kAGw')~5]yAJ4 #̎YKOT֒Fб3 w֣nº
openvasmd
Manager daemon of the Open Vulnerability Assessment System (OpenVAS)
Synopsis
openvasmd OPTIONS
Description
Options
SIGNALS
EXAMPLES
SEE ALSO
MORE INFORMATION ABOUT THE OpenVAS PROJECT
COPYRIGHT