OMP: OpenVAS Management Protocol

Version: 7.0

The "management" protocol of the Open Vulnerability Assessment System.

Summary of Data Types
Summary of Elements
Summary of Commands
RNC Preamble
Data Type Details
Element Details
Command Details
Compatibility Changes in Version 7.0

1 Summary of Data Types

alive_test	An alive test.
base64	Base64 encoded data.
boolean	A true or false value.
boolean_atoi	A true or false value, after conversion to an integer.
ctime	A date and time, in the C `ctime' format.
type_name	A name of a data type.
integer	An integer.
iso_time	A date and time, in ISO 8601 format.
levels	A string that may include the characters h, m, l, g and d.
name	A name.
port	A port.
user_list	A space separated list of users.
oid	An Object Identifier (OID).
severity	A severity score.
sort_order	A string describing an order for sorting.
status	The success or failure status of a command.
task_status	A task run status.
task_trend	The trend of results for a task.
threat	A threat level.
time_unit	A unit of time.
timezone	A timezone.
uuid	A Universally Unique Identifier (UUID).
uuid_or_empty	A Universally Unique Identifier (UUID), or the empty string.

2 Summary of Elements

c	A reference to a command.
e	A reference to an element.
r	A reference to a response.
o	An optional pattern item.
g	A group of pattern items.
any	Pattern item indicating "any number of".
pattern	The pattern element of a command or command descendant.
command_definition	Definition of a command in OMP describing HELP command.
filter_keywords	A group of filter keywords usable in an attribute or element text.
certificate_info	Info about a certificate.
note	A note.
override	An override.
result	A result.
report	Actually attributes and either base64 or a report.

3 Summary of Commands

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.
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 user.
delete_agent	Delete an agent.
delete_asset	Delete an asset.
delete_config	Delete a config.
delete_alert	Delete an alert.
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_report	Delete a report.
delete_permission	Delete a permission.
delete_port_list	Delete a port list.
delete_port_range	Delete a port range.
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 a user.
describe_auth	Describe authentication methods.
empty_trashcan	Empty the trashcan.
get_agents	Get one or many agents.
get_configs	Get one or many configs.
get_aggregates	Get aggregates of various resources.
get_alerts	Get one or many alerts.
get_assets	Get one or many assets.
get_credentials	Get one or many credentials.
get_feeds	Get one or many feeds.
get_filters	Get one or many filters.
get_groups	Get one or many groups.
get_info	Get information for items of given type.
get_notes	Get one or many notes.
get_nvts	Get one or many NVTs.
get_nvt_families	Get a list of all NVT families.
get_overrides	Get one or many overrides.
get_permissions	Get one or many permissions.
get_port_lists	Get one or many port lists.
get_preferences	Get one or many preferences.
get_reports	Get one or many reports.
get_report_formats	Get one or many report formats.
get_results	Get results.
get_roles	Get one or many roles.
get_scanners	Get one or many scanners.
get_schedules	Get one or many schedules.
get_settings	Get one or many settings.
get_system_reports	Get one or many system reports.
get_tags	Get one or many tags.
get_targets	Get one or many targets.
get_tasks	Get one or many tasks.
get_users	Get one or many users.
get_version	Get the OpenVAS Manager Protocol version.
help	Get the 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	Modify 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 a permission.
modify_port_list	Modify an existing port list.
modify_report	Modify an existing report.
modify_report_format	Update 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_target	Modify an existing target.
modify_tag	Modify a tag.
modify_task	Modify an existing task.
modify_user	Modify a user.
move_task	Moves an existing task to another OMP slave scanner or the master.
restore	Restore a resource.
resume_task	Resume a 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_feed	Synchronize with an NVT feed.
sync_config	Synchronize a config with a scanner.
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.

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 Details

5.1 Data Type `alive_test`

In short: An alive test.

5.1.1 RNC

alive_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 `base64`

In short: Base64 encoded data.

5.2.1 RNC

base64 = xsd:base64Binary

5.3 Data Type `boolean`

In 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 RNC

boolean = text

5.4 Data Type `boolean_atoi`

In 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 RNC

boolean_atoi = text

5.5 Data Type `ctime`

In 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 RNC

ctime = text

5.6 Data Type `type_name`

In short: A name of a data type.

5.6.1 RNC

type_name = xsd:Name

5.7 Data Type `integer`

In short: An integer.

5.7.1 RNC

integer = xsd:integer

5.8 Data Type `iso_time`

In 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 RNC

iso_time = text

5.9 Data Type `levels`

In short: A string that may include the characters h, m, l, g and d.

5.9.1 RNC

levels = xsd:token { pattern = "h?m?l?g?d?" }

5.10 Data Type `name`

In short: A name.

Typically this is the name of one of the manager resources, like a task or target.

5.10.1 RNC

name = xsd:string

5.11 Data Type `port`

In short: A port.

5.11.1 RNC

port = xsd:token { pattern = "[0-9]{1,5}" }

5.12 Data Type `user_list`

In short: A space separated list of users.

5.12.1 RNC

user_list = text

5.13 Data Type `oid`

In short: An Object Identifier (OID).

5.13.1 RNC

oid = xsd:token { pattern = "[0-9\.]{1,80}" }

5.14 Data Type `severity`

In 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 RNC

severity = xsd:token { pattern = "-[1-3](\.0)?|[0-9](\.[0-9])?|10(\.0)?" }

5.15 Data Type `sort_order`

In short: A string describing an order for sorting.

The string "descending" denotes descending order, anything else means ascending.

5.15.1 RNC

sort_order = text

5.16 Data Type `status`

In short: The success or failure status of a command.

5.16.1 RNC

status = xsd:token { pattern = "200|201|202|400|401|403|404|409|500|503" }

5.17 Data Type `task_status`

In short: A task run status.

5.17.1 RNC

task_status = xsd:token { pattern = "Delete Requested|Done|New|Requested|Running|Stop Requ↵
ested|Stopped|Internal Error" }

5.18 Data Type `task_trend`

In short: The trend of results for a task.

5.18.1 RNC

task_trend = xsd:token { pattern = "up|down|more|less|same" }

5.19 Data Type `threat`

In 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 RNC

threat = xsd:token { pattern = "High|Medium|Low|Alarm|Log|Debug" }

5.20 Data Type `time_unit`

In short: A unit of time.

5.20.1 RNC

time_unit = xsd:token { pattern = "second|minute|hour|day|week|month|year|decade" }

5.21 Data Type `timezone`

In 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 RNC

timezone = text

5.22 Data Type `uuid`

In short: A Universally Unique Identifier (UUID).

5.22.1 RNC

uuid = xsd:token { pattern = "[0-9abcdefABCDEF\-]{1,40}" }

5.23 Data Type `uuid_or_empty`

In short: A Universally Unique Identifier (UUID), or the empty string.

5.23.1 RNC

uuid_or_empty = xsd:token { pattern = "[0-9abcdefABCDEF\-]{0,40}" }

6 Element Details

6.1 Element `c`

In short: A reference to a command.

6.1.1 Structure

6.1.2 RNC

c
 = element c
     {
       text
     }

6.2 Element `e`

In short: A reference to an element.

6.2.1 Structure

6.2.2 RNC

e
 = element e
     {
       text
     }

6.3 Element `r`

In short: A reference to a response.

6.3.1 Structure

6.3.2 RNC

r
 = element r
     {
       text
     }

6.4 Element `o`

In short: An optional pattern item.

6.4.1 Structure

- One of
  - <c>
    A reference to a command.
  - <e>
    A reference to an element.
  - <r>
    A reference to a response.
  - <g>
    A group of pattern items.

6.4.2 RNC

o
 = element o
     {
       ( c
           | e
           | r
           | g )
     }

6.5 Element `g`

In short: A group of pattern items.

6.5.1 Structure

- <c> *
  A reference to a command.
- <e> *
  A reference to an element.
- <r> *
  A reference to a response.
- <o> *
  An optional pattern item.
- <any> *
  Pattern item indicating "any number of".

6.5.2 RNC

g
 = element g
     {
       c*
       & e*
       & r*
       & o*
       & any*
     }

6.6 Element `any`

In short: Pattern item indicating "any number of".

6.6.1 Structure

- One of
  - <c>
    A reference to a command.
  - <e>
    A reference to an element.
  - <r>
    A reference to a response.
  - <g>
    A group of pattern items.

6.6.2 RNC

any
 = element any
     {
       ( c
           | e
           | r
           | g )
     }

6.7 Element `pattern`

In 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

- <attrib> *
  An attribute.
  - <name>
  - <type>
  - <required>
  - <filter_keywords> *
    Optional description of filter keywords usable in the attribute.
- <c> *
  A reference to a command.
- <e> *
  A reference to an element.
- <r> *
  A reference to a response.
- <o> *
  An optional pattern item.
- <g> *
  A group of pattern items.
- <any> *
  Pattern item indicating "any number of".
- <t> ?
  The type of the text of the element.

6.7.2 RNC

pattern
 = 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_definition`

In short: Definition of a command in OMP describing HELP command.

6.8.1 Structure

- <name>
  The name of the command.
- <summary> ?
  A summary of the command.
- <description> ?
  A description of the command.
  - <p> *
    A paragraph.
- One of
  - The group
    - <pattern>
      (pattern)
    - <response>
      (pattern)
  - The group
    - <type>
      The type of the element.
    - <ele> *
      (command_definition)
      
      An element.
- <example> *
  - <summary> ?
  - <description> ?
  - <request>
    Example request.
  - <response>
    Response to example request.

6.8.2 RNC

command_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_keywords`

In short: A group of filter keywords usable in an attribute or element text.

6.9.1 Structure

- <condition> ?
  Description of the condition under which the group of keywords applies.
- <column> *
  A column that can be used multiple times with operators and in sorting.
  - <name>
    Name of the keyword as used in the filter.
  - <type>
    Type of the values the keyword can use.
  - <summary>
    Short description of the keyword.
- <option> *
  An option only applied once which cannot be used with operators or in sorting.
  - <name>
    Name of the keyword as used in the filter.
  - <type>
    Type of the values the keyword can use.
  - <summary>
    Short description of the keyword.

6.9.2 RNC

filter_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_info`

In short: Info about a certificate.

6.10.1 Structure

- <time_status>
  Whether the certificate is valid, expired or not active yet.
- <activation_time>
  Time before which the certificate is not valid.
- <expiration_time>
  Time after which the certificate is no longer valid.
- <issuer>
  DN of the issuer of the certificate.
- <md5_fingerprint>
  MD5 fingerprint of the certificate.

6.10.2 RNC

certificate_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 `note`

In short: A note.

6.11.1 Structure

- @id (uuid)
- <permissions>
  Permissions that the current user has on the note.
  - <permission> *
    - <name>
      The name of the permission.
- <owner>
  Owner of the note.
  - <name>
    The name of the owner.
- <nvt>
  - @oid (oid)
  - <name>
  - <type>
    The type of the NVT: nvt, cve, ovaldef, ....
- <text>
  The text of the note.
  - @excerpt (boolean) Whether the content is an excerpt of the full text.
- <creation_time>
  Date and time the note was created.
- <modification_time>
  Date and time the note was last modified.
- <writable>
- <in_use>
- <active>
  Whether the note is active.
- <orphan>
  Whether the note is an orphan.
- <user_tags>
  Info on tags attached to the note.
  - <count>
    Number of attached tags.
  - <tag> *
    Short info on an individual tag (only if details were requested).
    - @id (uuid) UUID of the tag.
    - <name>
      Name of the tag (usually namespace:predicate).
    - <value>
      Value of the tag.
    - <comment>
      Comment for the tag.
- The group?
  - <hosts>
    A textual list of hosts.
  - <port>
    Port to which note applies.
  - <severity>
    Severity to which note applies.
  - <threat>
    Threat level to which note applies.
  - <task>
    Task to which note applies.
    - @id (uuid)
  - <end_time> ?
    End time of the note in case of limit, else empty.
  - <result> ?
    Result to which note applies.
    - @id (uuid)
    - <host>
      - <asset>
        Asset linked to host.
        
        @asset_id (uuid)
    - <port>
    - <nvt>
      - @oid (oid)
      - <name>
      - <type>
        The type of the NVT: nvt, cve, ovaldef, ....
      - <cvss_base>
      - <cve> ?
        CVE value associated with the NVT.
      - <bid> ?
        BID associated with the NVT.
    - <severity>
    - <threat>
    - <qod>
      The quality of detection (QoD) of the result.
      - <value>
        The numeric QoD value.
      - <type>
        The QoD type.
    - <description>

6.11.2 RNC

note
 = 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 `override`

In short: An override.

6.12.1 Structure

- @id (uuid)
- <permissions>
  Permissions that the current user has on the note.
  - <permission> *
    - <name>
      The name of the permission.
- <owner>
  Owner of the override.
  - <name>
- <nvt>
  - @oid (oid)
  - <name>
  - <type>
    The type of the NVT: nvt, cve, ovaldef, ....
- <creation_time>
  Date and time the override was created.
- <modification_time>
  Date and time the override was last modified.
- <writable>
- <in_use>
- <active>
  Whether the override is currently active.
- <text>
  The text of the override.
  - @excerpt (boolean) Whether the contents is an excerpt of the full text.
- <threat>
  Threat level to which override applies, derived from severity.
- <severity>
  Severity score to which override applies.
- <new_threat>
  New threat for result.
- <new_severity>
  New severity score for result.
- <orphan>
  Whether the override is an orphan.
- <permissions>
  Permissions that the current user has on the note.
  - <permission> *
    - <name>
      The name of the permission.
- <user_tags>
  Info on tags attached to the override.
  - <count>
    Number of attached tags.
  - <tag> *
    Short info on an individual tag (only if details were requested).
    - @id (uuid) UUID of the tag.
    - <name>
      Name of the tag (usually namespace:predicate).
    - <value>
      Value of the tag.
    - <comment>
      Comment for the tag.
- The group?
  - <hosts>
    A textual list of hosts.
  - <port>
    Port to which override applies.
  - <task>
    Task to which override applies.
    - @id (uuid)
  - <end_time> ?
    Override end time in case of limit, else empty.
  - <result> ?
    Result to which override applies.
    - @id (uuid)
    - <host>
      - <asset>
        Asset linked to host.
        
        @asset_id (uuid)
    - <port>
    - <nvt>
      - @oid (oid)
      - <name>
      - <type>
        The type of the NVT: nvt, cve, ovaldef, ....
      - <cvss_base>
      - <cve> ?
        CVE value associated with the NVT.
      - <bid> ?
        BID associated with the NVT.
    - <threat>
    - <severity>
    - <qod>
      The quality of detection (QoD) of the result.
      - <value>
        The numeric QoD value.
      - <type>
        The QoD type.
    - <description>

6.12.2 RNC

override
 = 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 `result`

In short: A result.

6.13.1 Structure

- @id (uuid)
- <name>
  The name of the result.
- <owner>
  Owner of the result.
  - <name>
    The name of the owner.
- <comment>
  The comment on the result.
- <creation_time>
  Date and time the result was created.
- <modification_time>
  Date and time the result was last modified.
- <user_tags> ?
  Info on tags attached to the result (not in delta results).
  - <count>
    Number of attached tags.
  - <tag> *
    Short info on an individual tag (only if details were requested).
    - @id (uuid) UUID of the tag.
    - <name>
      Name of the tag (usually namespace:predicate).
    - <value>
      Value of the tag.
    - <comment>
      Comment for the tag.
- <report> ?
  Report the result belongs to (only when details were requested).
  - @id (uuid) UUID of the report the result belongs to.
- <task> ?
  Task the result applies to (only when details were requested).
  - @id (uuid) UUID of the task the result applies to.
  - <name>
    Name of the task the result applies to.
- <host>
  The host the result applies to.
  - <asset>
    Asset linked to host.
    - @asset_id (uuid)
- <port>
  The port on the host.
- <nvt>
  NVT to which result applies.
  - @oid (oid)
  - <name>
    The name of the NVT.
  - <type>
    The type of the NVT: nvt, cve, ovaldef, ....
  - <family>
    The family the NVT is in.
  - <cvss_base>
    CVSS base value associated with the NVT.
  - <cve>
    CVE associated with the NVT.
  - <cpe>
    The CPE which produced the CVE (for "cve" results).
  - <bid>
    BID associated with the NVT.
  - <tags>
    Tags associated with the NVT.
  - <cert>
    List of CERT advisories referencing this NVT via CVEs.
    - <cert_ref> *
      A CERT advisory reference.
      - @id (text) ID of the advisory.
      - @type (text) Type of the advisory (e.g. "DFN-CERT", "CERT-BUND").
  - <xref>
    XREFs associated with the NVT.
- <scan_nvt_version>
  Version of the NVT used in the scan.
- <threat>
- <severity>
- <qod>
  The quality of detection (QoD) of the result.
  - <value>
    The numeric QoD value.
  - <type>
    The QoD type.
- <original_threat> ?
  Original threat when overridden.
- <original_severity> ?
  Original severity when overridden.
- <description>
  Description of the result.
- <delta> ?
  Delta state.
  - <result> ?
    (result)
    
    Delta result.
  - <diff> ?
    (text)
    
    Comparison between descriptions.
  - <notes> ?
    List of notes on the result.
    - <note> *
      (note)
  - <overrides> ?
    List of overrides on the result.
    - <override> *
      (override)
- <details>
  Any details associated with the result.
  - <detail> *
    A detail associated with the result.
    - <name>
      The name of the detail.
    - <value>
      The value of the detail.
- <detection>
  Detection details.
  - <result>
    Detection result.
    - @id (uuid) UUID of the detection result.
    - <details>
      - <detail> *
        A detail associated with the detection result.
        
        <name>
        The name of the detail.
        
        <value>
        The value of the detail.
- <notes> ?
  List of notes on the result.
  - <note> *
    (note)
- <overrides> ?
  List of overrides on the result.
  - <override> *
    (override)

6.13.2 RNC

result
 = 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 `report`

In short: Actually attributes and either base64 or a report.

6.14.1 Structure

- @id (uuid)
- @format_id (uuid)
- @extension (text)
- @content_type (text)
- @type ("scan", "assets" or "prognostic")
- <owner>
  Owner of the report.
  - <name>
    The name of the owner.
- <name>
  Creation time as compatibility placeholder.
- <comment>
  The comment on the report.
- <creation_time>
  Date and time the report was created.
- <modification_time>
  Date and time the report was last modified.
- <writable>
  Whether the report is writable.
- <in_use>
  Whether the report is in use.
- <task>
  The task the report belongs to.
  - @id (uuid)
  - <name>
    The name of the task.
- <report_format>
  The report format used.
  - @id (uuid)
  - <name>
    The name of the report format.
- <report>
  - @id (uuid)
  - @type ("scan", "assets" or "prognostic")
  - <omp>
    Information of the OMP server.
    - <version>
      The OMP version.
  - <report_format>
    - <param>
      Report format parameter.
      - <name>
        Parameter name.
      - <value>
        Parameter value.
  - <sort>
    Result sorting information.
    - <field>
      Sort field.
      - <order>
        Sort order of field.
  - <filters>
    Result filtering information.
    - @id (uuid) Filter used if any, else 0.
    - <term>
      Filter term.
    - <phrase>
      Search phrase.
    - <notes>
      Whether notes are included.
    - <overrides>
      Whether overrides are included.
    - <apply_overrides>
      Whether overrides are applied.
    - <result_hosts_only>
      Whether only those hosts that have results are included.
    - <min_qod>
      Minimum QoD if in effect, else empty string.
    - <autofp>
      Whether to trust vendor security updates. 1 full match, 2 partial.
    - <filter> *
      Level filter.
    - <host> ?
      - <ip>
        IP of single host in report (for "delta" and "prognostic").
    - <delta> ?
      Delta states.
      - <changed>
        Whether changed results are included.
      - <gone>
        Whether results that have vanished are included.
      - <new>
        Whether new results are included.
      - <same>
        Whether results that are equal are included.
  - <severity_class>
    - <name>
      Short severity class name.
    - <full_name>
      Full severity class name.
    - <severity_range> *
      Severity range.
      - <name>
        Name of severity range.
      - <min>
        Minimum CVSS value.
      - <max>
        Maximum CVSS value.
  - <delta> ?
    - <report>
      Second report, for delta reports.
      - @id (uuid)
      - <scan_run_status>
        Run status of task scan at time of report.
      - <timestamp>
        The time the scan was requested.
      - <scan_start>
        Start time of scan.
      - <scan_end>
        End time of scan.
  - The group?
    - <timezone>
      Name of timezone used for dates.
    - <timezone_abbrev>
      Abbreviation used for timezone.
    - <permissions>
      Permissions that the current user has on the report.
      - <permission> *
        <name>
        The name of the permission.
    - <user_tags>
      Info on tags attached to the report.
      - <count>
        Number of attached tags.
      - <tag> *
        Short info on an individual tag (only if details were requested).
        
        @id (uuid) UUID of the tag.
        
        <name>
        Name of the tag (usually namespace:predicate).
        
        <value>
        Value of the tag.
        
        <comment>
        Comment for the tag.
    - <scan_run_status>
      Run status of task scan at time of report.
    - <result_count>
      Counts of results produced by scan.
      - <full>
        Total number of results produced by scan.
      - <filtered>
        Number of results after filtering.
      - <debug>
        Number of "debug" results (threat level Debug).
        
        <full>
        Total number of results.
        
        <filtered>
        Number of results after filtering.
      - <hole>
        Number of "hole" results (threat level High).
        
        <full>
        Total number of results.
        
        <filtered>
        Number of results after filtering.
      - <info>
        Number of "info" results (threat level Low).
        
        <full>
        Total number of results.
        
        <filtered>
        Number of results after filtering.
      - <log>
        Number of "log" results (threat level Log).
        
        <full>
        Total number of results.
        
        <filtered>
        Number of results after filtering.
      - <warning>
        Number of "warning" results (threat level Medium).
        
        <full>
        Total number of results.
        
        <filtered>
        Number of results after filtering.
    - <severity>
      - <full>
        Maximum severity of the full report.
      - <filtered>
        Maximum severity of the report after filtering.
    - <host_count> ?
      Counts of hosts in the results.
      - <full>
        Total number of hosts.
      - <filtered>
        Number of hosts after filtering.
    - <task>
      - @id (uuid)
      - <name>
        The name of the task.
      - <comment>
        Comment for the task.
      - <target>
        The target of the task.
        
        @id (uuid) The UUID of the target.
        
        <trash>
        (boolean)
        
        Whether the target is in the trashcan.
      - <progress>
        The percentage of the task that is complete.
      - <user_tags>
        Info on tags attached to the task.
        
        <count>
        Number of attached tags.
        
        <tag> *
        Short info on an individual tag.
        
        @id (uuid) UUID of the tag.
        
        <name>
        Name of the tag (usually namespace:predicate).
        
        <value>
        Value of the tag.
        
        <comment>
        Comment for the tag.
    - <scan>
      Info from scan time.
      - <task>
        
        <slave>
        The task slave.
        
        @id (uuid)
        
        <name>
        
        <host>
        
        <port>
        
        <preferences>
        Currently only "source_iface".
        
        <preference> *
        
        <name>
        Full name of preference, suitable for end users.
        
        <scanner_name>
        Compact name of preference, from scanner.
        
        <value>
    - <ports>
      - @start (integer)
      - @max (integer)
      - <port> *
        
        <host>
        
        <severity>
        
        <threat>
    - <results>
      - @start (integer)
      - @max (integer)
      - <result> *
        (result)
        
        A result.
    - <hosts>
      - One of
        
        The group
        
        @start (integer)
        
        @max (integer)
        
        <count>
        Number of hosts.
    - <closed_cves>
      .
      - <count>
        The number of closed CVEs.
    - <vulns>
      .
      - <count>
        The number of Vulnerabilities.
    - <os>
      .
      - <count>
        The number of operating systems.
    - <apps>
      .
      - <count>
        The number of Applications.
    - <ssl_certs>
      .
      - <count>
        The number of SSL certificates.
    - <host> *
      - <ip>
        IP of the host.
      - <asset>
        Asset linked to host.
        
        @asset_id (uuid)
      - <start>
        Scan start time for this host.
      - <end>
        Scan end time for this host.
      - <port_count>
        .
        
        <page>
        Number of ports of current host on current page.
      - <result_count>
        .
        
        <page>
        Total number of results for current host on current page.
        
        <hole>
        Number of "hole" results (level "High").
        
        <page>
        Number of results on current page.
        
        <warning>
        Number of "warning" results (level "Medium").
        
        <page>
        Number of results on current page.
        
        <info>
        Number of "info" results (level "Low").
        
        <page>
        Number of results on current page.
        
        <log>
        Number of "log" results.
        
        <page>
        Number of results on current page.
        
        <false_positive>
        Number of "false positive" results.
        
        <page>
        Number of results on current page.
      - <detail> *
        A detail associated with the host.
        
        <name>
        The name of the detail.
        
        <value>
        The value of the detail.
        
        <source>
        Where the detail comes from.
        
        <type>
        The type of the detail source.
        
        <name>
        The name of the detail source.
        
        <description>
        A description of the detail source.
        
        <extra>
        Extra info (NVT CVSS for closed CVE results).
    - <timestamp>
      The time the scan was requested.
    - <scan_start>
      Start time of scan.
    - <host_start> *
      Start time of a particular host.
      - <host>
    - <host_end> *
      End time of a particular host.
      - <host>
    - <scan_end>
      End time of scan.
    - <errors>
      - <count>
        The number of error messages.
      - <error> *
        An error message.
        
        <host>
        The host of the error message.
        
        <asset>
        Asset linked to host.
        
        @asset_id (uuid)
        
        <port>
        The port of the error message.
        
        <description>
        The description of the error message.
        
        <nvt>
        The NVT that generated the error message.
        
        @oid ()
        
        <name>
        The name of the NVT.
        
        <type>
        The type of the NVT: nvt, cve, ovaldef, ....
        
        <cvss_base>
        The base CVSS score of the NVT.
        
        <scan_nvt_version>
        The NVT version that generated the error.
        
        <severity>
        The severity score of the error message.

6.14.2 RNC

report
 = 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 Details

7.1 Command `authenticate`

In 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

Command
- <credentials>
  - <username>
    The login name of the user.
  - <password>
    The user's password.
Response
- @status (status)
- @status_text (text)
- <role>
  ("User", "Admin", "Super Admin" or "Observer")
  
  The user's role.
- <timezone>
  The user's timezone.

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
     }

Response

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>

Manager

 <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>

Manager

 <authenticate_response status="400"
                        status_text="Authentication failed"/>

7.2 Command `commands`

In 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

Command
- One of*
  - <authenticate>
    authenticate command.
  - <commands>
    commands command.
  - <create_agent>
    create_agent command.
  - <create_alert>
    create_alert command.
  - <create_asset>
    create_asset command.
  - <create_config>
    create_config command.
  - <create_credential>
    create_credential command.
  - <create_filter>
    create_filter command.
  - <create_group>
    create_group command.
  - <create_note>
    create_note command.
  - <create_override>
    create_override command.
  - <create_permission>
    create_permission command.
  - <create_port_list>
    create_port_list command.
  - <create_port_range>
    create_port_range command.
  - <create_report_format>
    create_report_format command.
  - <create_role>
    create_role command.
  - <create_scanner>
    create_scanner command.
  - <create_schedule>
    create_schedule command.
  - <create_tag>
    create_tag command.
  - <create_target>
    create_target command.
  - <create_task>
    create_task command.
  - <create_user>
    create_user command.
  - <delete_agent>
    delete_agent command.
  - <delete_alert>
    delete_alert command.
  - <delete_asset>
    delete_asset command.
  - <delete_config>
    delete_config command.
  - <delete_credential>
    delete_credential command.
  - <delete_filter>
    delete_filter command.
  - <delete_group>
    delete_group command.
  - <delete_note>
    delete_note command.
  - <delete_override>
    delete_override command.
  - <delete_permission>
    delete_permission command.
  - <delete_report>
    delete_report command.
  - <delete_report_format>
    delete_report_format command.
  - <delete_role>
    delete_role command.
  - <delete_port_list>
    delete_port_list command.
  - <delete_port_range>
    delete_port_range command.
  - <delete_scanner>
    delete_scanner command.
  - <delete_schedule>
    delete_schedule command.
  - <delete_tag>
    delete_tag command.
  - <delete_target>
    delete_target command.
  - <delete_task>
    delete_task command.
  - <delete_user>
    delete_user command.
  - <describe_auth>
    describe_auth command.
  - <empty_trashcan>
    empty_trashcan command.
  - <get_agents>
    get_agents command.
  - <get_alerts>
    get_alerts command.
  - <get_assets>
    get_assets command.
  - <get_configs>
    get_configs command.
  - <get_credentials>
    get_credentials command.
  - <get_feeds>
    get_feeds command.
  - <get_filters>
    get_filters command.
  - <get_groups>
    get_groups command.
  - <get_info>
    get_info command.
  - <get_notes>
    get_notes command.
  - <get_nvts>
    get_nvts command.
  - <get_nvt_families>
    get_nvt_families command.
  - <get_overrides>
    get_overrides command.
  - <get_permissions>
    get_permissions command.
  - <get_port_lists>
    get_port_lists command.
  - <get_preferences>
    get_preferences command.
  - <get_reports>
    get_reports command.
  - <get_report_formats>
    get_report_formats command.
  - <get_results>
    get_results command.
  - <get_roles>
    get_roles command.
  - <get_scanners>
    get_scanners command.
  - <get_schedules>
    get_schedules command.
  - <get_settings>
    get_settings command.
  - <get_system_reports>
    get_system_reports command.
  - <get_tags>
    get_tags command.
  - <get_targets>
    get_targets command.
  - <get_tasks>
    get_tasks command.
  - <get_users>
    get_users command.
  - <get_version>
    get_version command.
  - <help>
    help command.
  - <modify_agent>
    modify_agent command.
  - <modify_alert>
    modify_alert command.
  - <modify_asset>
    modify_asset command.
  - <modify_auth>
    modify_auth command.
  - <modify_config>
    modify_config command.
  - <modify_credential>
    modify_credential command.
  - <modify_filter>
    modify_filter command.
  - <modify_group>
    modify_group command.
  - <modify_note>
    modify_note command.
  - <modify_override>
    modify_override command.
  - <modify_permission>
    modify_permission command.
  - <modify_port_list>
    modify_port_list command.
  - <modify_report>
    modify_report command.
  - <modify_report_format>
    modify_report_format command.
  - <modify_role>
    modify_role command.
  - <modify_scanner>
    modify_scanner command.
  - <modify_schedule>
    modify_schedule command.
  - <modify_setting>
    modify_setting command.
  - <modify_tag>
    modify_tag command.
  - <modify_target>
    modify_target command.
  - <modify_task>
    modify_task command.
  - <modify_user>
    modify_user command.
  - <restore>
    restore command.
  - <resume_task>
    resume_task command.
  - <run_wizard>
    run_wizard command.
  - <start_task>
    start_task command.
  - <stop_task>
    stop_task command.
  - <sync_feed>
    sync_feed command.
  - <sync_config>
    sync_config command.
  - <sync_scap>
    sync_scap command.
  - <sync_cert>
    sync_cert command.
  - <test_alert>
    test_alert command.
  - <verify_agent>
    verify_agent command.
  - <verify_report_format>
    verify_report_format command.
  - <verify_scanner>
    verify_scanner command.
Response
- @status (status)
- @status_text (text)
- One of*
  - <authenticate_response>
    Response to authenticate command.
  - <commands_response>
    Response to commands command.
  - <create_agent_response>
    Response to create_agent command.
  - <create_alert_response>
    Response to create_alert command.
  - <create_asset_response>
    Response to create_asset command.
  - <create_config_response>
    Response to create_config command.
  - <create_credential_response>
    Response to create_credential command.
  - <create_filter_response>
    Response to create_filter command.
  - <create_group_response>
    Response to create_group command.
  - <create_note_response>
    Response to create_note command.
  - <create_override_response>
    Response to create_override command.
  - <create_permission_response>
    Response to create_permission command.
  - <create_port_list_response>
    Response to create_port_list command.
  - <create_port_range_response>
    Response to create_port_range command.
  - <create_role_response>
    Response to create_role command.
  - <create_scanner_response>
    Response to create_scanner command.
  - <create_schedule_response>
    Response to create_schedule command.
  - <create_tag_response>
    Response to create_tag command.
  - <create_target_response>
    Response to create_target command.
  - <create_task_response>
    Response to create_task command.
  - <create_user_response>
    Response to create_user command.
  - <delete_agent_response>
    Response to delete_agent command.
  - <delete_alert_response>
    Response to delete_alert command.
  - <delete_asset_response>
    Response to delete_asset command.
  - <delete_config_response>
    Response to delete_config command.
  - <delete_credential_response>
    Response to delete_credential command.
  - <delete_filter_response>
    Response to delete_filter command.
  - <delete_group_response>
    Response to delete_group command.
  - <delete_note_response>
    Response to delete_note command.
  - <delete_override_response>
    Response to delete_override command.
  - <delete_permission_response>
    Response to delete_permission command.
  - <delete_port_list_response>
    Response to delete_port_list command.
  - <delete_port_range_response>
    Response to delete_port_range command.
  - <delete_report_response>
    Response to delete_report command.
  - <delete_report_format_response>
    Response to delete_report_format command.
  - <delete_role_response>
    Response to delete_role command.
  - <delete_scanner_response>
    Response to delete_scanner command.
  - <delete_schedule_response>
    Response to delete_schedule command.
  - <delete_tag_response>
    Response to delete_tag command.
  - <delete_target_response>
    Response to delete_target command.
  - <delete_task_response>
    Response to delete_task command.
  - <delete_user_response>
    Response to delete_user command.
  - <describe_auth_response>
    Response to describe_auth command.
  - <empty_trashcan_response>
    Response to empty_trashcan command.
  - <get_agents_response>
    Response to get_agents command.
  - <get_alerts_response>
    Response to get_alerts command.
  - <get_assets_response>
    Response to get_assets command.
  - <get_configs_response>
    Response to get_configs command.
  - <get_credentials_response>
    Response to get_credentials command.
  - <get_groups_response>
    Response to get_groups command.
  - <get_info_response>
    Response to get_info command.
  - <get_feeds_response>
    Response to get_feeds command.
  - <get_filters_response>
    Response to get_filters command.
  - <get_notes_response>
    Response to get_notes command.
  - <get_nvts_response>
    Response to get_nvts command.
  - <get_nvt_families_response>
    Response to get_nvt_families command.
  - <get_overrides_response>
    Response to get_overrides command.
  - <get_permissions_response>
    Response to get_permissions command.
  - <get_port_lists_response>
    Response to get_port_lists command.
  - <get_preferences_response>
    Response to get_preferences command.
  - <get_reports_response>
    Response to get_reports command.
  - <get_report_formats_response>
    Response to get_report_formats command.
  - <get_results_response>
    Response to get_results command.
  - <get_roles_response>
    Response to get_roles command.
  - <get_scanners_response>
    Response to get_scanners command.
  - <get_schedules_response>
    Response to get_schedules command.
  - <get_settings_response>
    Response to get_settings command.
  - <get_system_reports_response>
    Response to get_system_reports command.
  - <get_tags_response>
    Response to get_tags command.
  - <get_targets_response>
    Response to get_targets command.
  - <get_tasks_response>
    Response to get_tasks command.
  - <get_users_response>
    Response to get_users command.
  - <get_version_response>
    Response to get_version command.
  - <help_response>
    Response to help command.
  - <modify_agent_response>
    Response to modify_agent command.
  - <modify_alert_response>
    Response to modify_alert command.
  - <modify_asset_response>
    Response to modify_asset command.
  - <modify_auth_response>
    Response to modify_auth command.
  - <modify_config_response>
    Response to modify_config command.
  - <modify_credential_response>
    Response to modify_credential command.
  - <modify_filter_response>
    Response to modify_filter command.
  - <modify_group_response>
    Response to modify_group command.
  - <modify_note_response>
    Response to modify_note command.
  - <modify_override_response>
    Response to modify_override command.
  - <modify_permission_response>
    Response to modify_permission command.
  - <modify_port_list_response>
    Response to modify_port_list command.
  - <modify_report_response>
    Response to modify_report command.
  - <modify_report_format_response>
    Response to modify_report_format command.
  - <modify_role_response>
    Response to modify_role command.
  - <modify_scanner_response>
    Response to modify_scanner command.
  - <modify_schedule_response>
    Response to modify_schedule command.
  - <modify_setting_response>
    Response to modify_setting command.
  - <modify_tag_response>
    Response to modify_tag command.
  - <modify_target_response>
    Response to modify_target command.
  - <modify_task_response>
    Response to modify_task command.
  - <modify_user_response>
    Response to modify_user command.
  - <restore_response>
    Response to restore command.
  - <resume_task_response>
    Response to resume_task command.
  - <run_wizard_response>
    Response to run_wizard command.
  - <start_task_response>
    Response to start_task command.
  - <stop_task_response>
    Response to stop_task command.
  - <sync_feed_response>
    Response to sync_feed command.
  - <sync_config_response>
    Response to sync_config command.
  - <sync_scap_response>
    Response to sync_scap command.
  - <sync_cert_response>
    Response to sync_cert command.
  - <test_alert_response>
    Response to test_alert command.
  - <verify_agent_response>
    Response to verify_agent command.
  - <verify_report_format_response>
    Response to verify_report_format command.
  - <verify_scanner_response>
    Response to verify_scanner command.

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 )*
     }

Response

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_agent`

In short: Create an agent.

The client uses the create_agent command to create a new agent.

7.3.1 Structure

Command
- <installer>
  A file that installs the agent on a target machine.
  - <signature>
    A detached OpenPGP signature of the installer.
- <name>
  A name for the installer.
- <comment> ?
  A comment on the agent.
- <copy> ?
  The UUID of an existing agent.
- <howto_install> ?
  A file that describes how to install the agent.
- <howto_use> ?
  A file that describes how to use the agent.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_agent_response status="201"
                        status_text="OK, resource created"
                        id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.4 Command `create_alert`

In short: Create an alert.

The client uses the create_alert command to create a new alert.

7.4.1 Structure

Command
- <name>
  A name for the alert.
- <comment> ?
  A comment on the alert.
- <copy> ?
  The UUID of an existing alert.
- <condition>
  The condition that must be satisfied for the alert to occur.
  - <data> *
    Some data that defines the condition.
    - <name>
      The name of the condition data.
- <event>
  The event that must happen for the alert to occur.
  - <data> *
    Some data that defines the event.
    - <name>
      The name of the event data.
- <method>
  The method by which the user is alerted.
  - <data> *
    Some data that defines the method.
    - <name>
      The name of the method data.
- <filter>
  Filter to apply when executing alert.
  - @id (uuid)
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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 }
     }

Response

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>

Manager

 <create_alert_response status="201"
                        status_text="OK, resource created"
                        id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.5 Command `create_asset`

In short: Create an asset.

The client uses the create_asset command to create a new asset.

7.5.1 Structure

Command
- One of
  - <asset>
    - <name>
      A name for the asset.
    - <comment>
      A comment on the asset.
  - <report>
    Report from which to import assets.
    - @id (uuid)
    - <filter>
      Filter, for min_qod and apply_overrides.
      - <term>
        Filter term.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_asset_response status="201"
                        status_text="OK, resource created"
                        id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.6 Command `create_config`

In short: Create a config.

The client uses the create_config command to create a new config.

This command can be called in three ways:

With a copy element. The new config is a copy of the existing config, with the given name.
With an embedded get_configs response element. The config is created as defined by the get_configs response element. Name is actually optional in this case. The config is given the name of the config in the get_configs response. If there is already a config with this name, then a number is attached to the name to make it unique.

7.6.1 Structure

Command
- <comment> ?
  A comment on the config.
- One of
  - <copy>
    The UUID of an existing config.
  - <get_configs_response>
    Response to get_configs command.
- <name>
  A name for the config.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <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>

Manager

 <create_config_response status="201"
                         status_text="OK, resource created"
                         id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.7 Command `create_credential`

In 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

Command
- <name>
  A name for the credential.
- <comment> ?
  A comment on the credential.
- <copy> ?
  The UUID of an existing credential.
- <allow_insecure> ?
  Whether to allow insecure use of the credential.
- <certificate> ?
  The certificate of the credential.
- <key> ?
  - <phrase>
    Key passphrase.
  - <private>
    Private key.
- <login> ?
  The user name of the credential.
- <password> ?
  The password for the credential login.
- <auth_algorithm> ?
  Authentication algorithm for SNMP, either md5 or sha1.
- <community> ?
  The SNMP community.
- <privacy> ?
  - <algorithm>
    The SNMP privacy algorithm, either aes or des.
  - <password>
    The SNMP privacy password.
- <type> ?
  The type of credential to create.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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" }
     }

Response

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>

Manager

 <create_credential_response status="201"
                             status_text="OK, resource created"
                             id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.8 Command `create_filter`

In short: Create a filter.

The client uses the create_filter command to create a new filter.

7.8.1 Structure

Command
- <name>
  A name for the filter.
  - <make_unique>
    Whether to append a unique suffix if the name already exists.
- <comment> ?
  A comment on the filter.
- <copy> ?
  The UUID of an existing filter.
- <term> ?
  Filter term.
- <type> ?
  Resource type.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_filter_response status="201"
                         status_text="OK, resource created"
                         id="254cd3ef-bbe1-4d58-859d-21b8d0c046c7"/>

7.9 Command `create_group`

In short: Create a group.

The client uses the create_group command to create a new group.

7.9.1 Structure

Command
- <name>
  A name for the group.
- <comment> ?
  A comment on the group.
- <copy> ?
  The UUID of an existing group.
- <specials> ?
  - <full>
    Create permission giving members full access to each other's resources.
- <users> ?
  Comma separated list of user names.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_group_response status="201"
                        status_text="OK, resource created"
                        id="d94211b6-ba40-11e3-bcb1-406186ea4fc5"/>

7.10 Command `create_note`

In short: Create a note.

The client uses the create_note command to create a new note.

7.10.1 Structure

Command
- <text>
  The text of the note.
- <nvt>
  NVT to which note applies.
  - @oid (oid)
- <active> ?
  Seconds note will be active. -1 on always, 0 off.
- <comment> ?
  A comment on the note.
- <copy> ?
  The UUID of an existing note.
- <hosts> ?
  A textual list of hosts.
- <port> ?
  Port to which note applies.
- <result> ?
  Result to which note applies.
  - @id (uuid)
- <severity> ?
  Severity to which note applies.
- <task> ?
  Task to which note applies.
  - @id (uuid)
- <threat> ?
  Threat level to which note applies. Will be converted to severity.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_note_response status="202"
                       status_text="OK, resource created"
                       id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.11 Command `create_override`

In short: Create an override.

The client uses the create_override command to create a new override.

7.11.1 Structure

Command
- <text>
  The text of the override.
- <nvt>
  NVT to which override applies.
  - @oid (oid)
- <active> ?
  Seconds override will be active. -1 on always, 0 off.
- <comment> ?
  A comment on the override.
- <copy> ?
  The UUID of an existing override.
- <hosts> ?
  A textual list of hosts.
- <new_severity> ?
  New severity for result.
- <new_threat> ?
  New threat level for result, will be converted to a new_severity.
- <port> ?
  Port to which override applies.
- <result> ?
  Result to which override applies.
  - @id (uuid)
- <severity> ?
  Severity score to which override applies.
- <task> ?
  Task to which override applies.
  - @id (uuid)
- <threat> ?
  Threat level to which override applies, will be converted to severity.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_override_response status="201"
                           status_text="OK, resource created"
                           id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.12 Command `create_permission`

In short: Create a permission.

The client uses the create_permission command to create a new permission.

7.12.1 Structure

Command
- <name>
  A permission name, currently the name of a command.
- <subject>
  A subject to whom the permission is granted.
  - @id (uuid)
  - <type>
    OMP type of the subject: user, group or role.
- <resource> ?
  A resource to which the permission applies.
  - @id (uuid)
  - <type>
    OMP type, for Super permissions: user, group or role.
- <copy> ?
  UUID of an existing permission to copy.
- <comment> ?
  Comment on the permission.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <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>

Manager

 <create_permission_response status="201"
                             status_text="OK, resource created"
                             id="b98ad69c-c011-11e3-b001-406186ea4fc5"/>

7.13 Command `create_port_list`

In 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

Command
- <name>
  The name of the port list.
- <comment> ?
  A comment on the port list.
- <copy> ?
  The UUID of an existing agent.
- <port_range>
  Comma or newline separated list of ranges.
- <get_port_lists_response>
  Response to get_port_lists command.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_port_list_response status="201"
                            status_text="OK, resource created"
                            id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.14 Command `create_port_range`

In short: Create a port range.

The client uses the create_port_range command to create a new port range.

7.14.1 Structure

Command
- <comment> ?
  A comment on the port range.
- <port_list>
  The port list to which to add the range.
  - @id (uuid)
- <start>
  The first port in the range.
- <end>
  The last port in the range.
- <type>
  The type of the ports: TCP, UDP, ....
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_port_range_response status="201"
                             status_text="OK, resource created"
                             id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.15 Command `create_report`

In short: Create a report.

The client uses the create_report command to import a report.

7.15.1 Structure

Command
- <report>
  (report)
  
  A report wrapper, as in the GET_REPORTS response.
- <task>
  Task for report: id to use existing task, name to create new task.
  - @id (uuid)
  - <name> ?
    The name of the task.
  - <comment> ?
    Comment for the new task.
- <in_assets> ?
  (boolean)
  
  Whether to create or update assets using the report.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     {
     }

Response

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>

Manager

 <create_report_response status="201"
                         status_text="OK, resource created"
                         id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.16 Command `create_report_format`

In short: Create a report format.

The client uses the create_report_format command to create a new report format.

7.16.1 Structure

Command
- One of
  - <copy>
    The UUID of an existing report format.
  - <get_report_formats_response>
    Response to get_report_formats command.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_report_format_response status="201"
                                status_text="OK, resource created"
                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.17 Command `create_role`

In short: Create a role.

The client uses the create_role command to create a new role.

7.17.1 Structure

Command
- <name>
  A name for the role.
- <comment> ?
  A comment on the role.
- <copy> ?
  The UUID of an existing role.
- <users> ?
  Comma separated list of user names.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_role_response status="201"
                       status_text="OK, resource created"
                       id="b64c81b2-b9de-11e3-a2e9-406186ea4fc5"/>

7.18 Command `create_scanner`

In short: Create a scanner.

The client uses the create_scanner command to create a new scanner.

7.18.1 Structure

Command
- <name>
  A name for the scanner.
- <comment> ?
  A comment on the scanner.
- <copy> ?
  The UUID of an existing scanner.
- <host>
  The host of the scanner.
- <port>
  The port of the scanner.
- <type>
  The type of the scanner.
- <ca_pub>
  Certificate of CA to verify scanner certificate..
- <credential>
  Client certificate credential for the Scanner.
  - @id (uuid) UUID of the credential.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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 }
     }

Response

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>

Manager

 <create_scanner_response status="201"
                          status_text="OK, resource created"
                          id="814cd30f-dee1-4d58-851d-21b8d0c048e3"/>

7.19 Command `create_schedule`

In short: Create a schedule.

The client uses the create_schedule command to create a new schedule.

7.19.1 Structure

Command
- <name>
  A name for the schedule.
- <comment> ?
  A comment on the schedule.
- <copy> ?
  The UUID of an existing schedule.
- <first_time> ?
  The first time the schedule will run.
  - <minute>
  - <hour>
  - <day_of_month>
  - <month>
  - <year>
- <duration> ?
  How long the Manager will run the scheduled task for.
  - <unit>
    Duration time unit.
- <period> ?
  How often the Manager will repeat the scheduled task.
  - <unit>
    Period time unit.
- <timezone> ?
  The timezone the schedule will follow.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_schedule_response status="201"
                           status_text="OK, resource created"
                           id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.20 Command `create_tag`

In 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

Command
- <name>
  A full tag name consisting of namespace and predicate.
- <resource>
  Identifies a resource the tag is to be attached to.
  - @id (uuid) ID of the resource the tag is to be attached to.
  - <type>
    OMP type of the resource the tag is to be attached to.
- <copy> ?
  UUID of an existing tag to copy.
- <value> ?
  Value associated with the tag.
- <comment> ?
  Comment to add to the tag.
- <active> ?
  Whether the tag is active.
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_tag_response status="201"
                      status_text="OK, resource created"
                      id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.21 Command `create_target`

In 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

Command
- <name>
  A name for the target.
  - <make_unique>
    Whether to append a unique suffix if the name already exists.
- <comment> ?
  A comment on the target.
- <copy> ?
  The UUID of an existing target.
- One of
  - <asset_hosts>
    Hosts from which to create the target.
    - @filter (text) Filter term that defines the list of hosts.
  - <hosts>
    A textual list of hosts, which may be empty.
- <exclude_hosts> ?
  A list of hosts to exclude.
- <ssh_credential> ?
  SSH login credentials for target.
  - @id (uuid)
  - <port> ?
    The port the LSCs will use.
- <smb_credential> ?
  SMB login credentials for target.
  - @id (uuid)
- <esxi_credential> ?
  ESXi credential to use on target.
  - @id (uuid)
- <snmp_credential> ?
  SNMP credentials to use on target.
  - @id (uuid)
- <ssh_lsc_credential> ?
  Deprecated: use ssh_credential. SSH credential.
  - @id (uuid)
  - <port> ?
    The port the LSCs will use.
- <smb_lsc_credential> ?
  Deprecated: use ssh_credential. SMB credential.
  - @id (uuid)
- <esxi_lsc_credential> ?
  Deprecated: use esxi_credential. ESXi credential.
  - @id (uuid)
- <alive_tests> ?
  Which alive tests to use.
- <reverse_lookup_only> ?
  Whether to scan only hosts that have names.
- <reverse_lookup_unify> ?
  Whether to scan only one IP when multiple IPs have the same name.
- <port_range> ?
  Port range for the target.
- <port_list> ?
  Port list for the target.
  - @id (uuid)
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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 }
     }

Response

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>

Manager

 <create_target_response status="201"
                         status_text="OK, resource created"
                         id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.22 Command `create_task`

In short: Create a task.

The client uses the create_task command to create a new task.

7.22.1 Structure

Command
- <name>
  A name for the task.
- <comment> ?
  A comment on the task.
- <copy> ?
  The UUID of an existing task.
- <alterable> ?
  Whether the task is alterable.
- <config>
  The scan configuration used by the task.
  - @id (uuid)
- <target>
  The hosts scanned by the task.
  - @id (uuid)
- <hosts_ordering> ?
  The order hosts are scanned in.
- <scanner>
  The scanner to use for scanning the target.
  - @id (uuid)
- <alert> *
  An alert that applies to the task.
  - @id (uuid)
- <schedule> ?
  When the task will run.
  - @id (uuid)
- <schedule_periods> ?
  A limit to the number of times the task will be scheduled, or 0 for no limit.
- <observers> ?
  Users allowed to observe this task.
- <preferences> ?
  - <preference> *
    - <scanner_name>
      Compact name of preference, from scanner.
    - <value>
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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
     }

Response

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>

Manager

 <create_task_response status="201"
                       status_text="OK, resource created"
                       id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>

7.23 Command `create_user`

In short: Create a user.

The client uses the create_user command to create a new user.

7.23.1 Structure

Command
- <name>
  The name of the user to be created.
- <copy> ?
  The UUID of an existing user.
- <hosts> ?
  User access rules: a textual list of hosts.
  - @allow (boolean) If 1, allow only listed, otherwise forbid listed.
- <ifaces> ?
  User access rules: a textual list of ifaces.
  - @allow (boolean) If 1, allow only listed, otherwise forbid listed.
- <password> ?
  The password for the user.
- <role> *
  A role of the user.
  - @id (uuid)
Response
- @status (status)
- @status_text (text)
- @id (uuid)

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 }
     }

Response

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>

Manager

 <create_user_response status="201"
                       status_text="OK, resource created"/>

7.24 Command `delete_agent`

In 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

Command
- @agent_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.24.2 RNC

Command

delete_agent
 = element delete_agent
     {
       attribute agent_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_agent_response status="200"
                        status_text="OK"/>

7.25 Command `delete_asset`

In 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

Command
- One of
  - @asset_id (uuid) Single asset to delete.
  - @report_id (uuid) Report from which to get all assets to delete.
Response
- @status (status)
- @status_text (text)

7.25.2 RNC

Command

delete_asset
 = element delete_asset
     {
       ( attribute asset_id { uuid }
           | attribute report_id { uuid } )
     }

Response

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"/>

Manager

 <delete_asset_response status="200"
                        status_text="OK"/>

7.26 Command `delete_config`

In 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

Command
- @config_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.26.2 RNC

Command

delete_config
 = element delete_config
     {
       attribute config_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_config_response status="200"
                         status_text="OK"/>

7.27 Command `delete_alert`

In 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

Command
- @alert_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.27.2 RNC

Command

delete_alert
 = element delete_alert
     {
       attribute alert_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_alert_response status="200"
                        status_text="OK"/>

7.28 Command `delete_credential`

In 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

Command
- @credential_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.28.2 RNC

Command

delete_credential
 = element delete_credential
     {
       attribute credential_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_credential_response status="200"
                             status_text="OK"/>

7.29 Command `delete_filter`

In 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

Command
- @filter_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.29.2 RNC

Command

delete_filter
 = element delete_filter
     {
       attribute filter_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_filter_response status="200"
                         status_text="OK"/>

7.30 Command `delete_group`

In 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

Command
- @group_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.30.2 RNC

Command

delete_group
 = element delete_group
     {
       attribute group_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_group_response status="200"
                        status_text="OK"/>

7.31 Command `delete_note`

In 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

Command
- @note_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.31.2 RNC

Command

delete_note
 = element delete_note
     {
       attribute note_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_note_response status="200"
                       status_text="OK"/>

7.32 Command `delete_override`

In 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

Command
- @override_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.32.2 RNC

Command

delete_override
 = element delete_override
     {
       attribute override_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_override_response status="200"
                           status_text="OK"/>

7.33 Command `delete_report`

In 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 Structure

Command
- @report_id (uuid)
Response
- @status (status)
- @status_text (text)

7.33.2 RNC

Command

delete_report
 = element delete_report
     {
       attribute report_id { uuid }
     }

Response

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"/>

Manager

 <delete_report_response status="200"
                         status_text="OK"/>

7.34 Command `delete_permission`

In 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

Command
- @permission_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.34.2 RNC

Command

delete_permission
 = element delete_permission
     {
       attribute permission_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_permission_response status="200"
                             status_text="OK"/>

7.35 Command `delete_port_list`

In 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

Command
- @port_list_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.35.2 RNC

Command

delete_port_list
 = element delete_port_list
     {
       attribute port_list_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_port_list_response status="200"
                            status_text="OK"/>

7.36 Command `delete_port_range`

In 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 Structure

Command
- @port_range_id (uuid)
Response
- @status (status)
- @status_text (text)

7.36.2 RNC

Command

delete_port_range
 = element delete_port_range
     {
       attribute port_range_id { uuid }
     }

Response

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"/>

Manager

 <delete_port_range_response status="200"
                             status_text="OK"/>

7.37 Command `delete_report_format`

In 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

Command
- @report_format_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.37.2 RNC

Command

delete_report_format
 = element delete_report_format
     {
       attribute report_format_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_report_format_response status="200"
                                status_text="OK"/>

7.38 Command `delete_role`

In 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

Command
- @role_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.38.2 RNC

Command

delete_role
 = element delete_role
     {
       attribute role_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_role_response status="200"
                       status_text="OK"/>

7.39 Command `delete_scanner`

In 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

Command
- @scanner_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.39.2 RNC

Command

delete_scanner
 = element delete_scanner
     {
       attribute scanner_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_scanner_response status="200"
                          status_text="OK"/>

7.40 Command `delete_schedule`

In 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

Command
- @schedule_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.40.2 RNC

Command

delete_schedule
 = element delete_schedule
     {
       attribute schedule_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_schedule_response status="200"
                           status_text="OK"/>

7.41 Command `delete_tag`

In 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

Command
- @tag_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.41.2 RNC

Command

delete_tag
 = element delete_tag
     {
       attribute tag_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_tag_response status="200"
                      status_text="OK"/>

7.42 Command `delete_target`

In 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

Command
- @target_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.42.2 RNC

Command

delete_target
 = element delete_target
     {
       attribute target_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_target_response status="200"
                         status_text="OK"/>

7.43 Command `delete_task`

In 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

Command
- @task_id (uuid)
- @ultimate (boolean) Whether to remove entirely, or to the trashcan.
Response
- @status (status)
- @status_text (text)

7.43.2 RNC

Command

delete_task
 = element delete_task
     {
       attribute task_id { uuid }
       & attribute ultimate { boolean }
     }

Response

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"/>

Manager

 <delete_task_response status="200"
                       status_text="OK"/>

7.44 Command `delete_user`

In 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

Command
- One of
  - @user_id (uuid) The ID of the user to be deleted. Overrides name.
  - @name (text) The name of the user to be deleted.
- One of
  - @inheritor_id (text) The ID of the inheriting user or "self". Overrides inheritor_name.
  - @inheritor_name (text) The name of the inheriting user.
Response
- @status (status)
- @status_text (text)

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 } )
     }

Response

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"/>

Manager

 <delete_user_response status="200"
                       status_text="OK"/>

7.45 Command `describe_auth`

In 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

Command
Response
- @status (status)
- @status_text (text)
- <group>
  Config group.
  - @name (text)
  - <auth_conf_setting>
    - <key>
      Setting name.
    - <value>
      Setting value.
    - <certificate_info> ?
      (certificate_info)
      
      Info about the certificate.

7.45.2 RNC

Command

describe_auth
 = element describe_auth
     {
       ""
     }

Response

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/>

Manager

 <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_trashcan`

In short: Empty the trashcan.

The client uses the empty_trashcan command to empty the trashcan.

7.46.1 Structure

Command
Response
- @status (status)
- @status_text (text)

7.46.2 RNC

Command

empty_trashcan
 = element empty_trashcan
     {
       ""
     }

Response

empty_trashcan_response
 = element empty_trashcan_response
     {
       attribute status { status }
       & attribute status_text { text }
     }

7.46.3 Example: Empty the trashcan

Client

 <empty_trashcan/>

Manager

 <empty_trashcan_response status="200"
                          status_text="OK"/>

7.47 Command `get_agents`

In 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

Command
- @agent_id (uuid) ID of single agent to get.
- @filter (text) Filter term to use to filter query.
  Keywords
  - column uuid (uuid) Unique ID
  - column name (name) Name
  - column comment (text) Comment text
  - column created (iso_time) Creation time
  - column modified (iso_time) Modification time
  - column owner (name) Name of the owner
  - column trust (boolean) Whether the the agent is trusted
- @filt_id (uuid) ID of filter to use to filter query.
- @trash (boolean) Whether to get the trashcan agents instead.
- @details (boolean) Whether to include agents package information when no format was provided.
- @format ("installer", "howto_install" or "howto_use")
Response
- @status (status)
- @status_text (text)
- <agent> *
  - @id (uuid)
  - <owner>
    Owner of the agent.
    - <name>
      The name of the owner.
  - <name>
    The name of the agent.
  - <comment>
    The comment on the agent.
  - <creation_time>
    Date and time the agent was created.
  - <modification_time>
    Date and time the agent was last modified.
  - <in_use>
    Whether the agent is in use.
  - <writable>
    Whether the agent is writable.
  - <permissions>
    Permissions that the current user has on the agent.
    - <permission> *
      - <name>
        The name of the permission.
  - <user_tags>
    Info on tags attached to the agent.
    - <count>
      Number of attached tags.
    - <tag> *
      Short info on an individual tag (only if details were requested).
      - @id (uuid) UUID of the tag.
      - <name>
        Name of the tag (usually namespace:predicate).
      - <value>
        Value of the tag.
      - <comment>
        Comment for the tag.
  - One of
    - <installer>
      - <trust>
        Whether signature verification succeeded.
        
        <time>
        When the signature was verified.
    - <package>
      Either the installer or one of the HOWTOs.
      - <filename>
        The filename of the package.
- <filters>
  - @id (uuid) UUID of filter if any, else 0.
  - <term>

OMP: OpenVAS Management Protocol

Contents

1 Summary of Data Types

2 Summary of Elements

3 Summary of Commands

4 RNC Preamble

5 Data Type Details

5.1 Data Type alive_test

5.1.1 RNC

5.2 Data Type base64

5.2.1 RNC

5.3 Data Type boolean

5.3.1 RNC

5.4 Data Type boolean_atoi

5.4.1 RNC

5.5 Data Type ctime

5.5.1 RNC

5.6 Data Type type_name

5.6.1 RNC

5.7 Data Type integer

5.7.1 RNC

5.8 Data Type iso_time

5.8.1 RNC

5.9 Data Type levels

5.9.1 RNC

5.10 Data Type name

5.10.1 RNC

5.11 Data Type port

5.11.1 RNC

5.12 Data Type user_list

5.12.1 RNC

5.13 Data Type oid

5.13.1 RNC

5.14 Data Type severity

5.14.1 RNC

5.15 Data Type sort_order

5.15.1 RNC

5.16 Data Type status

5.16.1 RNC

5.17 Data Type task_status

5.17.1 RNC

5.18 Data Type task_trend

5.18.1 RNC

5.19 Data Type threat

5.19.1 RNC

5.20 Data Type time_unit

5.20.1 RNC

5.21 Data Type timezone

5.21.1 RNC

5.22 Data Type uuid

5.22.1 RNC

5.23 Data Type uuid_or_empty

5.23.1 RNC

6 Element Details

6.1 Element c

6.1.1 Structure

6.1.2 RNC

6.2 Element e

6.2.1 Structure

6.2.2 RNC

6.3 Element r

6.3.1 Structure

6.3.2 RNC

6.4 Element o

6.4.1 Structure

6.4.2 RNC

6.5 Element g

6.5.1 Structure

6.5.2 RNC

6.6 Element any

6.6.1 Structure

6.6.2 RNC

6.7 Element pattern

6.7.1 Structure

6.7.2 RNC

6.8 Element command_definition

6.8.1 Structure

6.8.2 RNC

6.9 Element filter_keywords

6.9.1 Structure

5.1 Data Type `alive_test`

5.2 Data Type `base64`

5.3 Data Type `boolean`

5.4 Data Type `boolean_atoi`

5.5 Data Type `ctime`

5.6 Data Type `type_name`

5.7 Data Type `integer`

5.8 Data Type `iso_time`

5.9 Data Type `levels`

5.10 Data Type `name`

5.11 Data Type `port`

5.12 Data Type `user_list`

5.13 Data Type `oid`

5.14 Data Type `severity`

5.15 Data Type `sort_order`

5.16 Data Type `status`

5.17 Data Type `task_status`

5.18 Data Type `task_trend`

5.19 Data Type `threat`

5.20 Data Type `time_unit`

5.21 Data Type `timezone`

5.22 Data Type `uuid`

5.23 Data Type `uuid_or_empty`

6.1 Element `c`

6.2 Element `e`

6.3 Element `r`

6.4 Element `o`

6.5 Element `g`

6.6 Element `any`

6.7 Element `pattern`

6.8 Element `command_definition`

6.9 Element `filter_keywords`

6.10 Element `certificate_info`

6.11 Element `note`

6.12 Element `override`

6.13 Element `result`

6.14 Element `report`

7.1 Command `authenticate`

7.2 Command `commands`

7.3 Command `create_agent`

7.4 Command `create_alert`

7.5 Command `create_asset`

7.6 Command `create_config`

7.7 Command `create_credential`

7.8 Command `create_filter`

7.9 Command `create_group`

7.10 Command `create_note`

7.11 Command `create_override`

7.12 Command `create_permission`

7.13 Command `create_port_list`