<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OMP</title>
</head>
<body style="background-color: #FFFFFF; margin: 0px; font: small Verdana, sans-serif; font-size: 12px; color: #1A1A1A;"><div style="width: 98%; width:700px; align: center; margin-left: auto; margin-right: auto;"><table style="width: 100%;" cellpadding="3" cellspacing="0"><tr><td valign="top">
<h1>OMP:
OpenVAS Management Protocol</h1>
<p>Version: 2.0</p>
<p>The "management" protocol of the Open Vulnerability Assessment System.</p>
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#type_summary">Summary of Data Types</a></li>
<li><a href="#element_summary">Summary of Elements</a></li>
<li><a href="#command_summary">Summary of Commands</a></li>
<li><a href="#rnc_preamble">RNC Preamble</a></li>
<li><a href="#type_details">Data Type Details</a></li>
<li><a href="#element_details">Element Details</a></li>
<li><a href="#command_details">Command Details</a></li>
</ol>
<h2 id="type_summary">1 Summary of Data Types</h2>
<table id="index">
<tr id="index">
<td id="index"><a href="#type_base64">base64</a></td>
<td id="index"><div style="margin-left: 15px;">Base64 encoded data.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_boolean">boolean</a></td>
<td id="index"><div style="margin-left: 15px;">A true or false value.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_boolean_atoi">boolean_atoi</a></td>
<td id="index"><div style="margin-left: 15px;">A true or false value, after conversion to an integer.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_ctime">ctime</a></td>
<td id="index"><div style="margin-left: 15px;">A date and time, in the C `ctime' format.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_type_name">type_name</a></td>
<td id="index"><div style="margin-left: 15px;">A name of a data type.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_integer">integer</a></td>
<td id="index"><div style="margin-left: 15px;">An integer.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_levels">levels</a></td>
<td id="index"><div style="margin-left: 15px;">A string that may include the characters h, m, l, g and d.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_name">name</a></td>
<td id="index"><div style="margin-left: 15px;">A name.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_oid">oid</a></td>
<td id="index"><div style="margin-left: 15px;">An Object Identifier (OID).</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_sort_order">sort_order</a></td>
<td id="index"><div style="margin-left: 15px;">A string describing an order for sorting.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_status">status</a></td>
<td id="index"><div style="margin-left: 15px;">The success or failure status of a command.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_task_status">task_status</a></td>
<td id="index"><div style="margin-left: 15px;">A task run status.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_task_trend">task_trend</a></td>
<td id="index"><div style="margin-left: 15px;">The trend of results for a task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_threat">threat</a></td>
<td id="index"><div style="margin-left: 15px;">A threat level.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_time_unit">time_unit</a></td>
<td id="index"><div style="margin-left: 15px;">A unit of time.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_uuid">uuid</a></td>
<td id="index"><div style="margin-left: 15px;">A Universally Unique Identifier (UUID).</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#type_uuid_or_empty">uuid_or_empty</a></td>
<td id="index"><div style="margin-left: 15px;">A Universally Unique Identifier (UUID), or the empty string.</div></td>
</tr>
</table>
<h2 id="element_summary">2 Summary of Elements</h2>
<table id="index">
<tr id="index">
<td id="index"><a href="#element_c">c</a></td>
<td id="index"><div style="margin-left: 15px;">A reference to a command.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#element_e">e</a></td>
<td id="index"><div style="margin-left: 15px;">A reference to an element.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#element_r">r</a></td>
<td id="index"><div style="margin-left: 15px;">A reference to a response.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#element_o">o</a></td>
<td id="index"><div style="margin-left: 15px;">An optional pattern item.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#element_g">g</a></td>
<td id="index"><div style="margin-left: 15px;">A group of pattern items.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#element_any">any</a></td>
<td id="index"><div style="margin-left: 15px;">Pattern item indicating "any number of".</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#element_pattern">pattern</a></td>
<td id="index"><div style="margin-left: 15px;">The pattern element of a command or command descendant.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#element_command_definition">command_definition</a></td>
<td id="index"><div style="margin-left: 15px;">Definition of a command in OMP describing HELP command.</div></td>
</tr>
</table>
<h2 id="command_summary">3 Summary of Commands</h2>
<table id="index">
<tr id="index">
<td id="index"><a href="#command_authenticate">authenticate</a></td>
<td id="index"><div style="margin-left: 15px;">Authenticate with the manager.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_commands">commands</a></td>
<td id="index"><div style="margin-left: 15px;">Run a list of commands.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_agent">create_agent</a></td>
<td id="index"><div style="margin-left: 15px;">Create an agent.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_config">create_config</a></td>
<td id="index"><div style="margin-left: 15px;">Create a config.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_escalator">create_escalator</a></td>
<td id="index"><div style="margin-left: 15px;">Create an escalator.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_lsc_credential">create_lsc_credential</a></td>
<td id="index"><div style="margin-left: 15px;">Create an LSC credential.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_note">create_note</a></td>
<td id="index"><div style="margin-left: 15px;">Create a note.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_override">create_override</a></td>
<td id="index"><div style="margin-left: 15px;">Create an override.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_report_format">create_report_format</a></td>
<td id="index"><div style="margin-left: 15px;">Create a report format.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_schedule">create_schedule</a></td>
<td id="index"><div style="margin-left: 15px;">Create a schedule.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_slave">create_slave</a></td>
<td id="index"><div style="margin-left: 15px;">Create a slave.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_target">create_target</a></td>
<td id="index"><div style="margin-left: 15px;">Create a target.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_create_task">create_task</a></td>
<td id="index"><div style="margin-left: 15px;">Create a task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_agent">delete_agent</a></td>
<td id="index"><div style="margin-left: 15px;">Delete an agent.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_config">delete_config</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a config.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_escalator">delete_escalator</a></td>
<td id="index"><div style="margin-left: 15px;">Delete an escalator.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_lsc_credential">delete_lsc_credential</a></td>
<td id="index"><div style="margin-left: 15px;">Delete an LSC credential.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_note">delete_note</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a note.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_override">delete_override</a></td>
<td id="index"><div style="margin-left: 15px;">Delete an override.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_report">delete_report</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a report.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_report_format">delete_report_format</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a report format.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_schedule">delete_schedule</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a schedule.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_slave">delete_slave</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a slave.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_target">delete_target</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a target.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_delete_task">delete_task</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_agents">get_agents</a></td>
<td id="index"><div style="margin-left: 15px;">Get all agents.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_configs">get_configs</a></td>
<td id="index"><div style="margin-left: 15px;">Get all configs.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_dependencies">get_dependencies</a></td>
<td id="index"><div style="margin-left: 15px;">Get dependencies for all available NVTs.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_escalators">get_escalators</a></td>
<td id="index"><div style="margin-left: 15px;">Get all escalators.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_lsc_credentials">get_lsc_credentials</a></td>
<td id="index"><div style="margin-left: 15px;">Get all LSC credentials.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_notes">get_notes</a></td>
<td id="index"><div style="margin-left: 15px;">Get all notes.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_nvts">get_nvts</a></td>
<td id="index"><div style="margin-left: 15px;">Get all NVTs.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_nvt_families">get_nvt_families</a></td>
<td id="index"><div style="margin-left: 15px;">Get a list of all NVT families.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_nvt_feed_checksum">get_nvt_feed_checksum</a></td>
<td id="index"><div style="margin-left: 15px;">Get checksum for entire NVT collection.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_overrides">get_overrides</a></td>
<td id="index"><div style="margin-left: 15px;">Get all overrides.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_preferences">get_preferences</a></td>
<td id="index"><div style="margin-left: 15px;">Get all preferences.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_reports">get_reports</a></td>
<td id="index"><div style="margin-left: 15px;">Get all reports.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_report_formats">get_report_formats</a></td>
<td id="index"><div style="margin-left: 15px;">Get all report formats.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_results">get_results</a></td>
<td id="index"><div style="margin-left: 15px;">Get results.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_schedules">get_schedules</a></td>
<td id="index"><div style="margin-left: 15px;">Get all schedules.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_slaves">get_slaves</a></td>
<td id="index"><div style="margin-left: 15px;">Get all slaves.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_system_reports">get_system_reports</a></td>
<td id="index"><div style="margin-left: 15px;">Get all system reports.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_target_locators">get_target_locators</a></td>
<td id="index"><div style="margin-left: 15px;">Get configured target locators.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_targets">get_targets</a></td>
<td id="index"><div style="margin-left: 15px;">Get all targets.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_tasks">get_tasks</a></td>
<td id="index"><div style="margin-left: 15px;">Get all tasks.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_get_version">get_version</a></td>
<td id="index"><div style="margin-left: 15px;">Get the OpenVAS Manager Protocol version.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_help">help</a></td>
<td id="index"><div style="margin-left: 15px;">Get the help text.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_modify_config">modify_config</a></td>
<td id="index"><div style="margin-left: 15px;">Update an existing config.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_modify_lsc_credential">modify_lsc_credential</a></td>
<td id="index"><div style="margin-left: 15px;">Modify an existing LSC credential.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_modify_note">modify_note</a></td>
<td id="index"><div style="margin-left: 15px;">Modify an existing note.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_modify_override">modify_override</a></td>
<td id="index"><div style="margin-left: 15px;">Modify an existing override.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_modify_report">modify_report</a></td>
<td id="index"><div style="margin-left: 15px;">Modify an existing report.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_modify_report_format">modify_report_format</a></td>
<td id="index"><div style="margin-left: 15px;">Update an existing report format.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_modify_task">modify_task</a></td>
<td id="index"><div style="margin-left: 15px;">Modify an existing task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_pause_task">pause_task</a></td>
<td id="index"><div style="margin-left: 15px;">Pause a running task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_resume_or_start_task">resume_or_start_task</a></td>
<td id="index"><div style="margin-left: 15px;">Resume task if stopped, else start task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_resume_paused_task">resume_paused_task</a></td>
<td id="index"><div style="margin-left: 15px;">Resume a paused task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_resume_stopped_task">resume_stopped_task</a></td>
<td id="index"><div style="margin-left: 15px;">Resume a stopped task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_start_task">start_task</a></td>
<td id="index"><div style="margin-left: 15px;">Manually start an existing task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_stop_task">stop_task</a></td>
<td id="index"><div style="margin-left: 15px;">Stop a running task.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_test_escalator">test_escalator</a></td>
<td id="index"><div style="margin-left: 15px;">Run an escalator.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_verify_agent">verify_agent</a></td>
<td id="index"><div style="margin-left: 15px;">Verify an agent.</div></td>
</tr>
<tr id="index">
<td id="index"><a href="#command_verify_report_format">verify_report_format</a></td>
<td id="index"><div style="margin-left: 15px;">Verify a report format.</div></td>
</tr>
</table>
<h2 id="rnc_preamble">4 RNC Preamble</h2>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>### Preamble
start = command | response
command
= authenticate
| commands
| create_agent
| create_config
| create_escalator
| create_lsc_credential
| create_note
| create_override
| create_report_format
| create_schedule
| create_slave
| create_target
| create_task
| delete_agent
| delete_config
| delete_escalator
| delete_lsc_credential
| delete_note
| delete_override
| delete_report
| delete_report_format
| delete_schedule
| delete_slave
| delete_target
| delete_task
| get_agents
| get_configs
| get_dependencies
| get_escalators
| get_lsc_credentials
| get_notes
| get_nvts
| get_nvt_families
| get_nvt_feed_checksum
| get_overrides
| get_preferences
| get_reports
| get_report_formats
| get_results
| get_schedules
| get_slaves
| get_system_reports
| get_target_locators
| get_targets
| get_tasks
| get_version
| help
| modify_config
| modify_lsc_credential
| modify_note
| modify_override
| modify_report
| modify_report_format
| modify_task
| pause_task
| resume_or_start_task
| resume_paused_task
| resume_stopped_task
| start_task
| stop_task
| test_escalator
| verify_agent
| verify_report_format
response
= authenticate_response
| commands_response
| create_agent_response
| create_config_response
| create_escalator_response
| create_lsc_credential_response
| create_note_response
| create_override_response
| create_report_format_response
| create_schedule_response
| create_slave_response
| create_target_response
| create_task_response
| delete_agent_response
| delete_config_response
| delete_escalator_response
| delete_lsc_credential_response
| delete_note_response
| delete_override_response
| delete_report_response
| delete_report_format_response
| delete_schedule_response
| delete_slave_response
| delete_target_response
| delete_task_response
| get_agents_response
| get_configs_response
| get_dependencies_response
| get_escalators_response
| get_lsc_credentials_response
| get_notes_response
| get_nvts_response
| get_nvt_families_response
| get_nvt_feed_checksum_response
| get_overrides_response
| get_preferences_response
| get_reports_response
| get_report_formats_response
| get_results_response
| get_schedules_response
| get_slaves_response
| get_system_reports_response
| get_target_locators_response
| get_targets_response
| get_tasks_response
| get_version_response
| help_response
| modify_config_response
| modify_lsc_credential_response
| modify_note_response
| modify_override_response
| modify_report_response
| modify_report_format_response
| modify_task_response
| pause_task_response
| resume_or_start_task_response
| resume_paused_task_response
| resume_stopped_task_response
| start_task_response
| stop_task_response
| test_escalator_response
| verify_agent_response
| verify_report_format_response
</pre></div>
<h2 id="type_details">5 Data Type Details</h2>
<div>
<div><h3 id="type_base64">5.1
Data Type <tt>base64</tt>
</h3></div>
<p>In short: Base64 encoded data.</p>
<h4>5.1.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>base64 = xsd:base64Binary
</pre></div>
</div>
<div>
<div><h3 id="type_boolean">5.2
Data Type <tt>boolean</tt>
</h3></div>
<p>In short: A true or false value.</p>
<p>
Zero is false, anything else is true. As a result, the empty string is
considered true.
</p>
<h4>5.2.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>boolean = text
</pre></div>
</div>
<div>
<div><h3 id="type_boolean_atoi">5.3
Data Type <tt>boolean_atoi</tt>
</h3></div>
<p>In short: A true or false value, after conversion to an integer.</p>
<p>
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.
</p>
<h4>5.3.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>boolean_atoi = text
</pre></div>
</div>
<div>
<div><h3 id="type_ctime">5.4
Data Type <tt>ctime</tt>
</h3></div>
<p>In short: A date and time, in the C `ctime' format.</p>
<p>
An example string in this format is "Wed Jun 30 21:49:08 1993\n".
</p>
<h4>5.4.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>ctime = text
</pre></div>
</div>
<div>
<div><h3 id="type_type_name">5.5
Data Type <tt>type_name</tt>
</h3></div>
<p>In short: A name of a data type.</p>
<h4>5.5.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>type_name = xsd:string - xsd:whitespace
</pre></div>
</div>
<div>
<div><h3 id="type_integer">5.6
Data Type <tt>integer</tt>
</h3></div>
<p>In short: An integer.</p>
<h4>5.6.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>integer = xsd:integer
</pre></div>
</div>
<div>
<div><h3 id="type_levels">5.7
Data Type <tt>levels</tt>
</h3></div>
<p>In short: A string that may include the characters h, m, l, g and d.</p>
<h4>5.7.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>levels = xsd:token { pattern = "h?m?l?g?d?" }
</pre></div>
</div>
<div>
<div><h3 id="type_name">5.8
Data Type <tt>name</tt>
</h3></div>
<p>In short: A name.</p>
<p>
Typically this is the name of one of the manager resources, like a
task or target.
</p>
<h4>5.8.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>name = xsd:string
</pre></div>
</div>
<div>
<div><h3 id="type_oid">5.9
Data Type <tt>oid</tt>
</h3></div>
<p>In short: An Object Identifier (OID).</p>
<h4>5.9.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>oid = xsd:token { pattern = "[0-9\.]{1,80}" }
</pre></div>
</div>
<div>
<div><h3 id="type_sort_order">5.10
Data Type <tt>sort_order</tt>
</h3></div>
<p>In short: A string describing an order for sorting.</p>
<p>
The string "descending" denotes descending order, anything else means
ascending.
</p>
<h4>5.10.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>sort_order = text
</pre></div>
</div>
<div>
<div><h3 id="type_status">5.11
Data Type <tt>status</tt>
</h3></div>
<p>In short: The success or failure status of a command.</p>
<h4>5.11.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>status = xsd:token { pattern = "200|201|202|400|401|403|404|409|500|503" }
</pre></div>
</div>
<div>
<div><h3 id="type_task_status">5.12
Data Type <tt>task_status</tt>
</h3></div>
<p>In short: A task run status.</p>
<h4>5.12.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>task_status = xsd:token { pattern = "Delete Requested|Done|New|Pause Requested|Paused|Requ↵
ested|Resume Requested|Running|Stop Requested|Stopped|Internal Error" }
</pre></div>
</div>
<div>
<div><h3 id="type_task_trend">5.13
Data Type <tt>task_trend</tt>
</h3></div>
<p>In short: The trend of results for a task.</p>
<h4>5.13.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>task_trend = xsd:token { pattern = "up|down|more|less|same" }
</pre></div>
</div>
<div>
<div><h3 id="type_threat">5.14
Data Type <tt>threat</tt>
</h3></div>
<p>In short: A threat level.</p>
<h4>5.14.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>threat = xsd:token { pattern = "High|Medium|Low|Log|Debug" }
</pre></div>
</div>
<div>
<div><h3 id="type_time_unit">5.15
Data Type <tt>time_unit</tt>
</h3></div>
<p>In short: A unit of time.</p>
<h4>5.15.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>time_unit = xsd:token { pattern = "second|minute|hour|day|week|month|year|decade" }
</pre></div>
</div>
<div>
<div><h3 id="type_uuid">5.16
Data Type <tt>uuid</tt>
</h3></div>
<p>In short: A Universally Unique Identifier (UUID).</p>
<h4>5.16.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>uuid = xsd:token { pattern = "[0-9abcdefABCDEF\-]{1,40}" }
</pre></div>
</div>
<div>
<div><h3 id="type_uuid_or_empty">5.17
Data Type <tt>uuid_or_empty</tt>
</h3></div>
<p>In short: A Universally Unique Identifier (UUID), or the empty string.</p>
<h4>5.17.1 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>uuid_or_empty = xsd:token { pattern = "[0-9abcdefABCDEF\-]{0,40}" }
</pre></div>
</div>
<h2 id="element_details">6 Element Details</h2>
<div>
<div><h3 id="element_c">6.1
Element <tt>c</tt>
</h3></div>
<p>In short: A reference to a command.</p>
<h4>6.1.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none"></ul></li></ul>
<h4>6.1.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>c
= element c
{
text
}
</pre></div></div>
</div>
<div>
<div><h3 id="element_e">6.2
Element <tt>e</tt>
</h3></div>
<p>In short: A reference to an element.</p>
<h4>6.2.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none"></ul></li></ul>
<h4>6.2.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>e
= element e
{
text
}
</pre></div></div>
</div>
<div>
<div><h3 id="element_r">6.3
Element <tt>r</tt>
</h3></div>
<p>In short: A reference to a response.</p>
<h4>6.3.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none"></ul></li></ul>
<h4>6.3.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>r
= element r
{
text
}
</pre></div></div>
</div>
<div>
<div><h3 id="element_o">6.4
Element <tt>o</tt>
</h3></div>
<p>In short: An optional pattern item.</p>
<h4>6.4.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none"><li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<a href="#element_c"><b>c</b></a>>
<div style="margin-left: 15px; display: inline;">A reference to a command.</div>
</li>
<li>
<<a href="#element_e"><b>e</b></a>>
<div style="margin-left: 15px; display: inline;">A reference to an element.</div>
</li>
<li>
<<a href="#element_r"><b>r</b></a>>
<div style="margin-left: 15px; display: inline;">A reference to a response.</div>
</li>
<li>
<<a href="#element_g"><b>g</b></a>>
<div style="margin-left: 15px; display: inline;">A group of pattern items.</div>
</li>
</ul>
</li></ul></li></ul>
<h4>6.4.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>o
= element o
{
( c
| e
| r
| g )
}
</pre></div></div>
</div>
<div>
<div><h3 id="element_g">6.5
Element <tt>g</tt>
</h3></div>
<p>In short: A group of pattern items.</p>
<h4>6.5.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none">
<li>
<<a href="#element_c"><b>c</b></a>>
*<div style="margin-left: 15px; display: inline;">A reference to a command.</div>
</li>
<li>
<<a href="#element_e"><b>e</b></a>>
*<div style="margin-left: 15px; display: inline;">A reference to an element.</div>
</li>
<li>
<<a href="#element_r"><b>r</b></a>>
*<div style="margin-left: 15px; display: inline;">A reference to a response.</div>
</li>
<li>
<<a href="#element_o"><b>o</b></a>>
*<div style="margin-left: 15px; display: inline;">An optional pattern item.</div>
</li>
<li>
<<a href="#element_any"><b>any</b></a>>
*<div style="margin-left: 15px; display: inline;">Pattern item indicating "any number of".</div>
</li>
</ul></li></ul>
<h4>6.5.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>g
= element g
{
c*
& e*
& r*
& o*
& any*
}
</pre></div></div>
</div>
<div>
<div><h3 id="element_any">6.6
Element <tt>any</tt>
</h3></div>
<p>In short: Pattern item indicating "any number of".</p>
<h4>6.6.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none"><li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<a href="#element_c"><b>c</b></a>>
<div style="margin-left: 15px; display: inline;">A reference to a command.</div>
</li>
<li>
<<a href="#element_e"><b>e</b></a>>
<div style="margin-left: 15px; display: inline;">A reference to an element.</div>
</li>
<li>
<<a href="#element_r"><b>r</b></a>>
<div style="margin-left: 15px; display: inline;">A reference to a response.</div>
</li>
<li>
<<a href="#element_g"><b>g</b></a>>
<div style="margin-left: 15px; display: inline;">A group of pattern items.</div>
</li>
</ul>
</li></ul></li></ul>
<h4>6.6.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>any
= element any
{
( c
| e
| r
| g )
}
</pre></div></div>
</div>
<div>
<div><h3 id="element_pattern">6.7
Element <tt>pattern</tt>
</h3></div>
<p>In short: The pattern element of a command or command descendant.</p>
<p>
It's actually either a 't' element, or the word "text", or "".
</p>
<h4>6.7.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none">
<li>
<<b>attrib</b>>
*<div style="margin-left: 15px; display: inline;">An attribute.</div>
<ul style="list-style: none">
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>type</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>required</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<a href="#element_c"><b>c</b></a>>
*<div style="margin-left: 15px; display: inline;">A reference to a command.</div>
</li>
<li>
<<a href="#element_e"><b>e</b></a>>
*<div style="margin-left: 15px; display: inline;">A reference to an element.</div>
</li>
<li>
<<a href="#element_r"><b>r</b></a>>
*<div style="margin-left: 15px; display: inline;">A reference to a response.</div>
</li>
<li>
<<a href="#element_o"><b>o</b></a>>
*<div style="margin-left: 15px; display: inline;">An optional pattern item.</div>
</li>
<li>
<<a href="#element_g"><b>g</b></a>>
*<div style="margin-left: 15px; display: inline;">A group of pattern items.</div>
</li>
<li>
<<a href="#element_any"><b>any</b></a>>
*<div style="margin-left: 15px; display: inline;">Pattern item indicating "any number of".</div>
</li>
<li>
<<b>t</b>>
?<div style="margin-left: 15px; display: inline;">The type of the text of the element.</div>
<ul style="list-style: none"></ul>
</li>
</ul></li></ul>
<h4>6.7.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>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_name
= element name
{
type_name
}
pattern_attrib_type
= element type
{
type_name
}
pattern_attrib_required
= element required
{
boolean
}
pattern_t
= element t
{
type_name
}
</pre></div></div>
</div>
<div>
<div><h3 id="element_command_definition">6.8
Element <tt>command_definition</tt>
</h3></div>
<p>In short: Definition of a command in OMP describing HELP command.</p>
<h4>6.8.1 Structure</h4>
<ul style="list-style: none"><li><ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the command.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>summary</b>>
?<div style="margin-left: 15px; display: inline;">A summary of the command.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
?<div style="margin-left: 15px; display: inline;">A description of the command.</div>
<ul style="list-style: none"><li>
<<b>p</b>>
*<div style="margin-left: 15px; display: inline;">A paragraph.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<i>The group</i><b></b><ul style="list-style: none">
<li>
<<b>pattern</b>>
<div style="margin-left: 15px; display: inline;">(<a href="#element_pattern">pattern</a>)</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>response</b>>
<div style="margin-left: 15px; display: inline;">(<a href="#element_pattern">pattern</a>)</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<i>The group</i><b></b><ul style="list-style: none">
<li>
<<b>type</b>>
<div style="margin-left: 15px; display: inline;">The type of the element.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>ele</b>>
*<div style="margin-left: 15px; display: inline;">(<a href="#element_command_definition">command_definition</a>)</div>
<div style="margin-left: 15px; display: inline;">An element.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
<<b>example</b>>
*<ul style="list-style: none">
<li>
<<b>summary</b>>
?<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
?<ul style="list-style: none"></ul>
</li>
<li>
<<b>request</b>>
<div style="margin-left: 15px; display: inline;">Example request.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>response</b>>
<div style="margin-left: 15px; display: inline;">Response to example request.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul></li></ul>
<h4>6.8.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><div style="margin-left: 5%"><pre>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*
}
</pre></div></div>
</div>
<h2 id="command_details">7 Command Details</h2>
<div>
<div><h3 id="command_authenticate">7.1
Command <tt>authenticate</tt>
</h3></div>
<p>In short: Authenticate with the manager.</p>
<p>
The client uses the authenticate command to authenticate with the
Manager.
</p>
<p>
The client normally executes this command at the beginning of each
connection. The only commands permitted before authentication are
get_version and commands.
</p>
<h4>7.1.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
<<b>credentials</b>>
<ul style="list-style: none">
<li>
<<b>username</b>>
<div style="margin-left: 15px; display: inline;">The login name of the user.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>password</b>>
<div style="margin-left: 15px; display: inline;">The user's password.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.1.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>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
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>authenticate_response
= element authenticate_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.1.3 Example: Authenticate with a good password</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate>
<credentials>
<username>sally</username>
<password>secret</password>
</credentials>
</authenticate>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate_response status="200"
status_text="OK"/>
</pre></div>
</div>
<h4>7.1.3 Example: Authenticate with a bad password</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate>
<credentials>
<username>sally</username>
<password>secrte</password>
</credentials>
</authenticate>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate_response status="400"
status_text="Authentication failed"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_commands">7.2
Command <tt>commands</tt>
</h3></div>
<p>In short: Run a list of commands.</p>
<p>
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.
</p>
<h4>7.2.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
<i>One of</i><b>*</b><ul style="list-style: none">
<li>
<<b>authenticate></b><div style="margin-left: 15px; display: inline;">
<a href="#command_authenticate">authenticate</a> command.
</div>
</li>
<li>
<<b>commands></b><div style="margin-left: 15px; display: inline;">
<a href="#command_commands">commands</a> command.
</div>
</li>
<li>
<<b>create_agent></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_agent">create_agent</a> command.
</div>
</li>
<li>
<<b>create_config></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_config">create_config</a> command.
</div>
</li>
<li>
<<b>create_escalator></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_escalator">create_escalator</a> command.
</div>
</li>
<li>
<<b>create_lsc_credential></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_lsc_credential">create_lsc_credential</a> command.
</div>
</li>
<li>
<<b>create_note></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_note">create_note</a> command.
</div>
</li>
<li>
<<b>create_override></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_override">create_override</a> command.
</div>
</li>
<li>
<<b>create_schedule></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_schedule">create_schedule</a> command.
</div>
</li>
<li>
<<b>create_slave></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_slave">create_slave</a> command.
</div>
</li>
<li>
<<b>create_target></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_target">create_target</a> command.
</div>
</li>
<li>
<<b>create_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_create_task">create_task</a> command.
</div>
</li>
<li>
<<b>delete_agent></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_agent">delete_agent</a> command.
</div>
</li>
<li>
<<b>delete_config></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_config">delete_config</a> command.
</div>
</li>
<li>
<<b>delete_escalator></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_escalator">delete_escalator</a> command.
</div>
</li>
<li>
<<b>delete_lsc_credential></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_lsc_credential">delete_lsc_credential</a> command.
</div>
</li>
<li>
<<b>delete_note></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_note">delete_note</a> command.
</div>
</li>
<li>
<<b>delete_override></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_override">delete_override</a> command.
</div>
</li>
<li>
<<b>delete_report></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_report">delete_report</a> command.
</div>
</li>
<li>
<<b>delete_schedule></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_schedule">delete_schedule</a> command.
</div>
</li>
<li>
<<b>delete_slave></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_slave">delete_slave</a> command.
</div>
</li>
<li>
<<b>delete_target></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_target">delete_target</a> command.
</div>
</li>
<li>
<<b>delete_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_delete_task">delete_task</a> command.
</div>
</li>
<li>
<<b>get_agents></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_agents">get_agents</a> command.
</div>
</li>
<li>
<<b>get_configs></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_configs">get_configs</a> command.
</div>
</li>
<li>
<<b>get_dependencies></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_dependencies">get_dependencies</a> command.
</div>
</li>
<li>
<<b>get_escalators></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_escalators">get_escalators</a> command.
</div>
</li>
<li>
<<b>get_lsc_credentials></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_lsc_credentials">get_lsc_credentials</a> command.
</div>
</li>
<li>
<<b>get_notes></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_notes">get_notes</a> command.
</div>
</li>
<li>
<<b>get_nvts></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_nvts">get_nvts</a> command.
</div>
</li>
<li>
<<b>get_nvt_families></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_nvt_families">get_nvt_families</a> command.
</div>
</li>
<li>
<<b>get_nvt_feed_checksum></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_nvt_feed_checksum">get_nvt_feed_checksum</a> command.
</div>
</li>
<li>
<<b>get_overrides></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_overrides">get_overrides</a> command.
</div>
</li>
<li>
<<b>get_preferences></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_preferences">get_preferences</a> command.
</div>
</li>
<li>
<<b>get_reports></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_reports">get_reports</a> command.
</div>
</li>
<li>
<<b>get_results></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_results">get_results</a> command.
</div>
</li>
<li>
<<b>get_schedules></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_schedules">get_schedules</a> command.
</div>
</li>
<li>
<<b>get_slaves></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_slaves">get_slaves</a> command.
</div>
</li>
<li>
<<b>get_system_reports></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_system_reports">get_system_reports</a> command.
</div>
</li>
<li>
<<b>get_target_locators></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_target_locators">get_target_locators</a> command.
</div>
</li>
<li>
<<b>get_targets></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_targets">get_targets</a> command.
</div>
</li>
<li>
<<b>get_tasks></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_tasks">get_tasks</a> command.
</div>
</li>
<li>
<<b>get_version></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_version">get_version</a> command.
</div>
</li>
<li>
<<b>help></b><div style="margin-left: 15px; display: inline;">
<a href="#command_help">help</a> command.
</div>
</li>
<li>
<<b>modify_config></b><div style="margin-left: 15px; display: inline;">
<a href="#command_modify_config">modify_config</a> command.
</div>
</li>
<li>
<<b>modify_lsc_credential></b><div style="margin-left: 15px; display: inline;">
<a href="#command_modify_lsc_credential">modify_lsc_credential</a> command.
</div>
</li>
<li>
<<b>modify_note></b><div style="margin-left: 15px; display: inline;">
<a href="#command_modify_note">modify_note</a> command.
</div>
</li>
<li>
<<b>modify_override></b><div style="margin-left: 15px; display: inline;">
<a href="#command_modify_override">modify_override</a> command.
</div>
</li>
<li>
<<b>modify_report></b><div style="margin-left: 15px; display: inline;">
<a href="#command_modify_report">modify_report</a> command.
</div>
</li>
<li>
<<b>modify_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_modify_task">modify_task</a> command.
</div>
</li>
<li>
<<b>pause_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_pause_task">pause_task</a> command.
</div>
</li>
<li>
<<b>resume_or_start_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_resume_or_start_task">resume_or_start_task</a> command.
</div>
</li>
<li>
<<b>resume_paused_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_resume_paused_task">resume_paused_task</a> command.
</div>
</li>
<li>
<<b>resume_stopped_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_resume_stopped_task">resume_stopped_task</a> command.
</div>
</li>
<li>
<<b>start_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_start_task">start_task</a> command.
</div>
</li>
<li>
<<b>stop_task></b><div style="margin-left: 15px; display: inline;">
<a href="#command_stop_task">stop_task</a> command.
</div>
</li>
<li>
<<b>test_escalator></b><div style="margin-left: 15px; display: inline;">
<a href="#command_test_escalator">test_escalator</a> command.
</div>
</li>
</ul>
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<i>One of</i><b>*</b><ul style="list-style: none">
<li>
<<b>authenticate_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_authenticate">authenticate</a> command.
</div>
</li>
<li>
<<b>commands_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_commands">commands</a> command.
</div>
</li>
<li>
<<b>create_agent_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_agent">create_agent</a> command.
</div>
</li>
<li>
<<b>create_config_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_config">create_config</a> command.
</div>
</li>
<li>
<<b>create_escalator_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_escalator">create_escalator</a> command.
</div>
</li>
<li>
<<b>create_lsc_credential_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_lsc_credential">create_lsc_credential</a> command.
</div>
</li>
<li>
<<b>create_note_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_note">create_note</a> command.
</div>
</li>
<li>
<<b>create_override_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_override">create_override</a> command.
</div>
</li>
<li>
<<b>create_schedule_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_schedule">create_schedule</a> command.
</div>
</li>
<li>
<<b>create_slave_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_slave">create_slave</a> command.
</div>
</li>
<li>
<<b>create_target_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_target">create_target</a> command.
</div>
</li>
<li>
<<b>create_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_create_task">create_task</a> command.
</div>
</li>
<li>
<<b>delete_agent_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_agent">delete_agent</a> command.
</div>
</li>
<li>
<<b>delete_config_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_config">delete_config</a> command.
</div>
</li>
<li>
<<b>delete_escalator_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_escalator">delete_escalator</a> command.
</div>
</li>
<li>
<<b>delete_lsc_credential_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_lsc_credential">delete_lsc_credential</a> command.
</div>
</li>
<li>
<<b>delete_note_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_note">delete_note</a> command.
</div>
</li>
<li>
<<b>delete_override_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_override">delete_override</a> command.
</div>
</li>
<li>
<<b>delete_report_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_report">delete_report</a> command.
</div>
</li>
<li>
<<b>delete_schedule_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_schedule">delete_schedule</a> command.
</div>
</li>
<li>
<<b>delete_slave_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_slave">delete_slave</a> command.
</div>
</li>
<li>
<<b>delete_target_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_target">delete_target</a> command.
</div>
</li>
<li>
<<b>delete_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_delete_task">delete_task</a> command.
</div>
</li>
<li>
<<b>get_agents_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_agents">get_agents</a> command.
</div>
</li>
<li>
<<b>get_configs_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_configs">get_configs</a> command.
</div>
</li>
<li>
<<b>get_dependencies_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_dependencies">get_dependencies</a> command.
</div>
</li>
<li>
<<b>get_escalators_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_escalators">get_escalators</a> command.
</div>
</li>
<li>
<<b>get_lsc_credentials_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_lsc_credentials">get_lsc_credentials</a> command.
</div>
</li>
<li>
<<b>get_notes_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_notes">get_notes</a> command.
</div>
</li>
<li>
<<b>get_nvts_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_nvts">get_nvts</a> command.
</div>
</li>
<li>
<<b>get_nvt_families_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_nvt_families">get_nvt_families</a> command.
</div>
</li>
<li>
<<b>get_nvt_feed_checksum_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_nvt_feed_checksum">get_nvt_feed_checksum</a> command.
</div>
</li>
<li>
<<b>get_overrides_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_overrides">get_overrides</a> command.
</div>
</li>
<li>
<<b>get_preferences_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_preferences">get_preferences</a> command.
</div>
</li>
<li>
<<b>get_reports_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_reports">get_reports</a> command.
</div>
</li>
<li>
<<b>get_results_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_results">get_results</a> command.
</div>
</li>
<li>
<<b>get_slaves_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_slaves">get_slaves</a> command.
</div>
</li>
<li>
<<b>get_schedules_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_schedules">get_schedules</a> command.
</div>
</li>
<li>
<<b>get_system_reports_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_system_reports">get_system_reports</a> command.
</div>
</li>
<li>
<<b>get_target_locators_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_target_locators">get_target_locators</a> command.
</div>
</li>
<li>
<<b>get_targets_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_targets">get_targets</a> command.
</div>
</li>
<li>
<<b>get_tasks_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_tasks">get_tasks</a> command.
</div>
</li>
<li>
<<b>get_version_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_version">get_version</a> command.
</div>
</li>
<li>
<<b>help_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_help">help</a> command.
</div>
</li>
<li>
<<b>modify_config_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_modify_config">modify_config</a> command.
</div>
</li>
<li>
<<b>modify_lsc_credential_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_modify_lsc_credential">modify_lsc_credential</a> command.
</div>
</li>
<li>
<<b>modify_note_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_modify_note">modify_note</a> command.
</div>
</li>
<li>
<<b>modify_override_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_modify_override">modify_override</a> command.
</div>
</li>
<li>
<<b>modify_report_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_modify_report">modify_report</a> command.
</div>
</li>
<li>
<<b>modify_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_modify_task">modify_task</a> command.
</div>
</li>
<li>
<<b>pause_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_pause_task">pause_task</a> command.
</div>
</li>
<li>
<<b>resume_or_start_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_resume_or_start_task">resume_or_start_task</a> command.
</div>
</li>
<li>
<<b>resume_paused_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_resume_paused_task">resume_paused_task</a> command.
</div>
</li>
<li>
<<b>resume_stopped_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_resume_stopped_task">resume_stopped_task</a> command.
</div>
</li>
<li>
<<b>start_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_start_task">start_task</a> command.
</div>
</li>
<li>
<<b>stop_task_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_stop_task">stop_task</a> command.
</div>
</li>
<li>
<<b>test_escalator_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_test_escalator">test_escalator</a> command.
</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.2.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>commands
= element commands
{
( authenticate
| commands
| create_agent
| create_config
| create_escalator
| create_lsc_credential
| create_note
| create_override
| create_schedule
| create_slave
| create_target
| create_task
| delete_agent
| delete_config
| delete_escalator
| delete_lsc_credential
| delete_note
| delete_override
| delete_report
| delete_schedule
| delete_slave
| delete_target
| delete_task
| get_agents
| get_configs
| get_dependencies
| get_escalators
| get_lsc_credentials
| get_notes
| get_nvts
| get_nvt_families
| get_nvt_feed_checksum
| get_overrides
| get_preferences
| get_reports
| get_results
| get_schedules
| get_slaves
| get_system_reports
| get_target_locators
| get_targets
| get_tasks
| get_version
| help
| modify_config
| modify_lsc_credential
| modify_note
| modify_override
| modify_report
| modify_task
| pause_task
| resume_or_start_task
| resume_paused_task
| resume_stopped_task
| start_task
| stop_task
| test_escalator )*
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>commands_response
= element commands_response
{
attribute status { status }
& attribute status_text { text }
& ( authenticate_response
| commands_response
| create_agent_response
| create_config_response
| create_escalator_response
| create_lsc_credential_response
| create_note_response
| create_override_response
| create_schedule_response
| create_slave_response
| create_target_response
| create_task_response
| delete_agent_response
| delete_config_response
| delete_escalator_response
| delete_lsc_credential_response
| delete_note_response
| delete_override_response
| delete_report_response
| delete_schedule_response
| delete_slave_response
| delete_target_response
| delete_task_response
| get_agents_response
| get_configs_response
| get_dependencies_response
| get_escalators_response
| get_lsc_credentials_response
| get_notes_response
| get_nvts_response
| get_nvt_families_response
| get_nvt_feed_checksum_response
| get_overrides_response
| get_preferences_response
| get_reports_response
| get_results_response
| get_slaves_response
| get_schedules_response
| get_system_reports_response
| get_target_locators_response
| get_targets_response
| get_tasks_response
| get_version_response
| help_response
| modify_config_response
| modify_lsc_credential_response
| modify_note_response
| modify_override_response
| modify_report_response
| modify_task_response
| pause_task_response
| resume_or_start_task_response
| resume_paused_task_response
| resume_stopped_task_response
| start_task_response
| stop_task_response
| test_escalator_response )*
}
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_agent">7.3
Command <tt>create_agent</tt>
</h3></div>
<p>In short: Create an agent.</p>
<p>
The client uses the create_agent command to create a new agent.
</p>
<h4>7.3.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>installer</b>>
<div style="margin-left: 15px; display: inline;">A file that installs the agent on a target machine.</div>
<ul style="list-style: none"><li>
<<b>signature</b>>
<div style="margin-left: 15px; display: inline;">A detached OpenPGP signature of the installer.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the installer.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the agent.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>howto_install</b>>
?<div style="margin-left: 15px; display: inline;">A file that describes how to install the agent.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>howto_use</b>>
?<div style="margin-left: 15px; display: inline;">A file that describes how to use the agent.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.3.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_agent
= element create_agent
{
create_agent_installer
& create_agent_name
& create_agent_comment?
& 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_howto_install
= element howto_install
{
base64
}
create_agent_howto_use
= element howto_use
{
base64
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_agent_response
= element create_agent_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.3.3 Example: Create an agent</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_agent>
<installer>
asdf3235saf3kjBVF...
<signature>iEYEABECAAYFA...</signature>
</installer>
<name>SLAD</name>
</create_agent>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_agent_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_config">7.4
Command <tt>create_config</tt>
</h3></div>
<p>In short: Create a config.</p>
<p>
The client uses the create_config command to create a new config.
</p>
<p>This command can be called in three ways:<ul>
<li>
With a copy element. The new config is a copy of the existing
config, with the given name.
</li>
<li>
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.
</li>
<li>
With an rcfile element. The config is created as described in
the RC file. In this case a name element is required. The new
config is given this name.
</li>
</ul></p>
<h4>7.4.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<b>copy</b>>
<div style="margin-left: 15px; display: inline;">The UUID of an existing config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>get_configs_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_configs">get_configs</a> command.
</div>
</li>
<li>
<<b>rcfile</b>>
<div style="margin-left: 15px; display: inline;">An openvasrc style file that defines the config.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the config.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.4.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_config
= element create_config
{
create_config_comment?
& ( create_config_copy
| get_configs_response
| create_config_rcfile )
& create_config_name
}
create_config_comment
= element comment
{
text
}
create_config_copy
= element copy
{
uuid
}
create_config_rcfile
= element rcfile
{
base64
}
create_config_name
= element name
{
name
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_config_response
= element create_config_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.4.3 Example: Copy a config</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config>
<copy>daba56c8-73ec-11df-a475-002264764cea</copy>
<name>Full</name>
</create_config>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
<h4>7.4.3 Example: Create a config from an RC file</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config>
<rcfile>asdf3235saf3kjBVF...</rcfile>
<name>Full</name>
</create_config>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
<h4>7.4.3 Example: Create a config from a GET_CONFIGS response</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config>
<get_configs_response>
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
...
</config>
</get_configs_response>
</create_config>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_escalator">7.5
Command <tt>create_escalator</tt>
</h3></div>
<p>In short: Create an escalator.</p>
<p>
The client uses the create_escalator command to create a new
escalator.
</p>
<h4>7.5.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>condition</b>>
<div style="margin-left: 15px; display: inline;">The condition that must be satisfied for escalation.</div>
<ul style="list-style: none"><li>
<<b>data</b>>
*<div style="margin-left: 15px; display: inline;">Some data that defines the condition.</div>
<ul style="list-style: none"><li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the condition data.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>event</b>>
<div style="margin-left: 15px; display: inline;">The event that must happen for escalation.</div>
<ul style="list-style: none"><li>
<<b>data</b>>
*<div style="margin-left: 15px; display: inline;">Some data that defines the event.</div>
<ul style="list-style: none"><li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the event data.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>method</b>>
<div style="margin-left: 15px; display: inline;">The method by which escalation must occur.</div>
<ul style="list-style: none"><li>
<<b>data</b>>
*<div style="margin-left: 15px; display: inline;">Some data that defines the method.</div>
<ul style="list-style: none"><li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the method data.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.5.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_escalator
= element create_escalator
{
create_escalator_name
& create_escalator_comment?
& create_escalator_condition
& create_escalator_event
& create_escalator_method
}
create_escalator_name
= element name
{
name
}
create_escalator_comment
= element comment
{
text
}
create_escalator_condition
= element condition
{
text
& create_escalator_condition_data*
}
create_escalator_condition_data
= element data
{
text
& create_escalator_condition_data_name
}
create_escalator_condition_data_name
= element name
{
text
}
create_escalator_event
= element event
{
text
& create_escalator_event_data*
}
create_escalator_event_data
= element data
{
text
& create_escalator_event_data_name
}
create_escalator_event_data_name
= element name
{
text
}
create_escalator_method
= element method
{
text
& create_escalator_method_data*
}
create_escalator_method_data
= element data
{
text
& create_escalator_method_data_name
}
create_escalator_method_data_name
= element name
{
text
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_escalator_response
= element create_escalator_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.5.3 Example: Create an escalator</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_escalator>
<name>emergency</name>
<condition>
Threat level at least
<data>
High
<name>level</name>
</data>
</condition>
<event>
Task run status changed
<data>
Done
<name>status</name>
</data>
</event>
<method>
Email
<data>
sally@example.org
<name>to_address</name>
</data>
<data>
bob@example.org
<name>from_address</name>
</data>
</method>
</create_escalator>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_escalator_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_lsc_credential">7.6
Command <tt>create_lsc_credential</tt>
</h3></div>
<p>In short: Create an LSC credential.</p>
<p>
The client uses the create_lsc_credential command to create a new
LSC credential.
</p>
<p>
If the command includes a password, then the manager creates a
password only credential, otherwise the manager creates a key-based
credential.
</p>
<h4>7.6.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>login</b>>
<div style="margin-left: 15px; display: inline;">The user name of the credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>password</b>>
?<div style="margin-left: 15px; display: inline;">The password for the credential login.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.6.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_lsc_credential
= element create_lsc_credential
{
create_lsc_credential_name
& create_lsc_credential_comment?
& create_lsc_credential_login
& create_lsc_credential_password?
}
create_lsc_credential_name
= element name
{
name
}
create_lsc_credential_comment
= element comment
{
text
}
create_lsc_credential_login
= element login
{
text
}
create_lsc_credential_password
= element password
{
text
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_lsc_credential_response
= element create_lsc_credential_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.6.3 Example: Create an LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_lsc_credential>
<name>cluster sally</name>
<login>sally</login>
<password>secret</password>
<comment>Sally's login to the cluster.</comment>
</create_lsc_credential>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_lsc_credential_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_note">7.7
Command <tt>create_note</tt>
</h3></div>
<p>In short: Create a note.</p>
<p>
The client uses the create_note command to create a new note.
</p>
<h4>7.7.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">The text of the note.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
<div style="margin-left: 15px; display: inline;">NVT to which note applies.</div>
<ul style="list-style: none"><li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the note.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hosts</b>>
?<div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
?<div style="margin-left: 15px; display: inline;">Port to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result</b>>
?<div style="margin-left: 15px; display: inline;">Result to which note applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>task</b>>
?<div style="margin-left: 15px; display: inline;">Task to which note applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>threat</b>>
?<div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.7.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_note
= element create_note
{
create_note_text
& create_note_nvt
& create_note_comment?
& create_note_hosts?
& create_note_port?
& create_note_result?
& create_note_task?
& create_note_threat?
}
create_note_text
= element text
{
text
}
create_note_nvt
= element nvt
{
attribute oid { oid }
}
create_note_comment
= element comment
{
text
}
create_note_hosts
= element hosts
{
text
}
create_note_port
= element port
{
text
}
create_note_result
= element result
{
attribute id { uuid }
}
create_note_task
= element task
{
attribute id { uuid }
}
create_note_threat
= element threat
{
threat
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_note_response
= element create_note_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.7.3 Example: Create a note</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_note>
<text>This issue should be resolved after the upgrade.</text>
<nvt>1.3.6.1.4.1.25623.1.0.10330</nvt>
<result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
</create_note>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_note_response status="202"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_override">7.8
Command <tt>create_override</tt>
</h3></div>
<p>In short: Create an override.</p>
<p>
The client uses the create_override command to create a new override.
</p>
<h4>7.8.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">The text of the override.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
<div style="margin-left: 15px; display: inline;">NVT to which override applies.</div>
<ul style="list-style: none"><li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the override.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hosts</b>>
?<div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>new_threat</b>>
?<div style="margin-left: 15px; display: inline;">New threat level for result.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
?<div style="margin-left: 15px; display: inline;">Port to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result</b>>
?<div style="margin-left: 15px; display: inline;">Result to which override applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>task</b>>
?<div style="margin-left: 15px; display: inline;">Task to which override applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>threat</b>>
?<div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.8.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_override
= element create_override
{
create_override_text
& create_override_nvt
& create_override_comment?
& create_override_hosts?
& create_override_new_threat?
& create_override_port?
& create_override_result?
& create_override_task?
& create_override_threat?
}
create_override_text
= element text
{
text
}
create_override_nvt
= element nvt
{
attribute oid { oid }
}
create_override_comment
= element comment
{
text
}
create_override_hosts
= element hosts
{
text
}
create_override_new_threat
= element new_threat
{
threat
}
create_override_port
= element port
{
text
}
create_override_result
= element result
{
attribute id { uuid }
}
create_override_task
= element task
{
attribute id { uuid }
}
create_override_threat
= element threat
{
threat
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_override_response
= element create_override_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.8.3 Example: Create an override</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_override>
<text>This is actually of little concern.</text>
<nvt>1.3.6.1.4.1.25623.1.0.10330</nvt>
<new_threat>Low</new_threat>
<result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
</create_override>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_override_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_report_format">7.9
Command <tt>create_report_format</tt>
</h3></div>
<p>In short: Create a report format.</p>
<p>
The client uses the create_report_format command to create a new report
format.
</p>
<h4>7.9.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
<<b>get_report_formats_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_report_formats">get_report_formats</a> command.
</div>
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.9.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_report_format
= element create_report_format
{
get_report_formats_response
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_report_format_response
= element create_report_format_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.9.3 Example: Create a report format</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <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>
<global>1</global>
<trust>
yes
<time>Thu Dec 2 13:22:26 2010</time>
</trust>
<active>1</active>
</report_format>
</get_report_formats_response>
</create_report_format>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_report_format_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_schedule">7.10
Command <tt>create_schedule</tt>
</h3></div>
<p>In short: Create a schedule.</p>
<p>
The client uses the create_schedule command to create a new schedule.
</p>
<h4>7.10.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the schedule.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the schedule.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>first_time</b>>
<div style="margin-left: 15px; display: inline;">The first time the schedule will run.</div>
<ul style="list-style: none">
<li>
<<b>minute</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hour</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>day_of_month</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>month</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>year</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>duration</b>>
<div style="margin-left: 15px; display: inline;">How long the Manager will run the scheduled task for.</div>
<ul style="list-style: none"><li>
<<b>unit</b>>
<div style="margin-left: 15px; display: inline;">Duration time unit.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>period</b>>
<div style="margin-left: 15px; display: inline;">How often the Manager will repeat the scheduled task.</div>
<ul style="list-style: none"><li>
<<b>unit</b>>
<div style="margin-left: 15px; display: inline;">Period time unit.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.10.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_schedule
= element create_schedule
{
create_schedule_name
& create_schedule_comment?
& create_schedule_first_time
& create_schedule_duration
& create_schedule_period
}
create_schedule_name
= element name
{
name
}
create_schedule_comment
= element comment
{
text
}
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
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_schedule_response
= element create_schedule_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.10.3 Example: Create a schedule</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <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>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_schedule_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_slave">7.11
Command <tt>create_slave</tt>
</h3></div>
<p>In short: Create a slave.</p>
<p>
The client uses the create_slave command to create a new slave.
</p>
<h4>7.11.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the slave.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the slave.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>host</b>>
<div style="margin-left: 15px; display: inline;">The host that the slave Manager is running on.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<div style="margin-left: 15px; display: inline;">The port that the slave Manager is serving on the host.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>login</b>>
<div style="margin-left: 15px; display: inline;">Login name on the slave Manager.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>password</b>>
<div style="margin-left: 15px; display: inline;">Password for login on the slave Manager.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.11.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_slave
= element create_slave
{
create_slave_name
& create_slave_comment?
& create_slave_host
& create_slave_port
& create_slave_login
& create_slave_password
}
create_slave_name
= element name
{
name
}
create_slave_comment
= element comment
{
text
}
create_slave_host
= element host
{
text
}
create_slave_port
= element port
{
text
}
create_slave_login
= element login
{
text
}
create_slave_password
= element password
{
text
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_slave_response
= element create_slave_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.11.3 Example: Create a slave</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_slave>
<name>Bangkok</name>
<comment>Manager in Bangkok department.</comment>
<host>192.0.32.10</host>
<login>sally</login>
<password>secret</password>
</create_slave>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_slave_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_target">7.12
Command <tt>create_target</tt>
</h3></div>
<p>In short: Create a target.</p>
<p>
The client uses the create_target command to create a new target.
</p>
<p>
If the list of hosts is empty, the command must also include a
target locator.
</p>
<h4>7.12.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the target.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the target.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hosts</b>>
<div style="margin-left: 15px; display: inline;">A textual list of hosts, which may be empty.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>ssh_lsc_credential</b>>
<div style="margin-left: 15px; display: inline;">SSH login credentials for target.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>smb_lsc_credential</b>>
<div style="margin-left: 15px; display: inline;">SMB login credentials for target.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>target_locator</b>>
<div style="margin-left: 15px; display: inline;">Target locator (for example, for LDAP).</div>
<ul style="list-style: none">
<li>
<<b>username</b>>
?<div style="margin-left: 15px; display: inline;">The login for the target locator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>password</b>>
?<div style="margin-left: 15px; display: inline;">The password for the target locator.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>port_range</b>>
?<div style="margin-left: 15px; display: inline;">Port range for the target.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.12.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_target
= element create_target
{
create_target_name
& create_target_comment?
& create_target_hosts
& create_target_ssh_lsc_credential
& create_target_smb_lsc_credential
& create_target_target_locator
& create_target_port_range?
}
create_target_name
= element name
{
name
}
create_target_comment
= element comment
{
text
}
create_target_hosts
= element hosts
{
text
}
create_target_ssh_lsc_credential
= element ssh_lsc_credential
{
attribute id { uuid }
}
create_target_smb_lsc_credential
= element smb_lsc_credential
{
attribute id { uuid }
}
create_target_target_locator
= element target_locator
{
create_target_target_locator_username?
& create_target_target_locator_password?
}
create_target_target_locator_username
= element username
{
text
}
create_target_target_locator_password
= element password
{
text
}
create_target_port_range
= element port_range
{
text
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_target_response
= element create_target_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.12.3 Example: Create a target, giving a host list</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_target>
<name>All GNU/Linux machines</name>
<hosts>192.168.1.0/24</hosts>
</create_target>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_target_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_task">7.13
Command <tt>create_task</tt>
</h3></div>
<p>In short: Create a task.</p>
<p>
The client uses the create_task command to create a new task.
</p>
<p>
If an rcfile is given, then config and target should actually be
left out. This form of the command is special support for
OpenVAS-Client, and will likely be removed in future versions.
</p>
<h4>7.13.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">A name for the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>config</b>>
<div style="margin-left: 15px; display: inline;">The scan configuration used by the task.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>target</b>>
<div style="margin-left: 15px; display: inline;">The hosts scanned by the task.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>escalator</b>>
?<div style="margin-left: 15px; display: inline;">An escalator that applies to the task.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>schedule</b>>
?<div style="margin-left: 15px; display: inline;">When the task will run.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>slave</b>>
?<div style="margin-left: 15px; display: inline;">Slave that the task will run on.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>rcfile</b>>
?<div style="margin-left: 15px; display: inline;">An openvasrc style file defining the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
</li>
</ul>
<h4>7.13.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_task
= element create_task
{
create_task_name
& create_task_comment?
& create_task_config
& create_task_target
& create_task_escalator?
& create_task_schedule?
& create_task_slave?
& create_task_rcfile?
}
create_task_name
= element name
{
name
}
create_task_comment
= element comment
{
text
}
create_task_config
= element config
{
attribute id { uuid }
}
create_task_target
= element target
{
attribute id { uuid }
}
create_task_escalator
= element escalator
{
attribute id { uuid }
}
create_task_schedule
= element schedule
{
attribute id { uuid }
}
create_task_slave
= element slave
{
attribute id { uuid }
}
create_task_rcfile
= element rcfile
{
base64
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>create_task_response
= element create_task_response
{
attribute status { status }
& attribute status_text { text }
& attribute id { uuid }
}
</pre></div>
</div>
<h4>7.13.3 Example: Create a task, giving a host list</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <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"/>
</create_task>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_task_response status="201"
status_text="OK, resource created"
id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_agent">7.14
Command <tt>delete_agent</tt>
</h3></div>
<p>In short: Delete an agent.</p>
<p>
The client uses the delete_agent command to delete an existing agent.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.14.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>agent_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.14.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_agent
= element delete_agent
{
attribute agent_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_agent_response
= element delete_agent_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.14.3 Example: Delete an agent</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_agent_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_config">7.15
Command <tt>delete_config</tt>
</h3></div>
<p>In short: Delete a config.</p>
<p>
The client uses the delete_config command to delete an existing config.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.15.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.15.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_config
= element delete_config
{
attribute config_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_config_response
= element delete_config_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.15.3 Example: Delete a config</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_config config_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_config_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_escalator">7.16
Command <tt>delete_escalator</tt>
</h3></div>
<p>In short: Delete an escalator.</p>
<p>
The client uses the delete_escalator command to delete an existing
escalator.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.16.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>escalator_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.16.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_escalator
= element delete_escalator
{
attribute escalator_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_escalator_response
= element delete_escalator_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.16.3 Example: Delete an escalator</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_escalator escalator_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_escalator_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_lsc_credential">7.17
Command <tt>delete_lsc_credential</tt>
</h3></div>
<p>In short: Delete an LSC credential.</p>
<p>
The client uses the delete_lsc_credential command to delete an
existing LSC credential.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.17.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>lsc_credential_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.17.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_lsc_credential
= element delete_lsc_credential
{
attribute lsc_credential_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_lsc_credential_response
= element delete_lsc_credential_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.17.3 Example: Delete an LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_lsc_credential lsc_credential_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_lsc_credential_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_note">7.18
Command <tt>delete_note</tt>
</h3></div>
<p>In short: Delete a note.</p>
<p>
The client uses the delete_note command to delete an existing note.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.18.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>note_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.18.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_note
= element delete_note
{
attribute note_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_note_response
= element delete_note_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.18.3 Example: Delete a note</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_note note_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_note_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_override">7.19
Command <tt>delete_override</tt>
</h3></div>
<p>In short: Delete an override.</p>
<p>
The client uses the delete_override command to delete an existing override.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.19.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>override_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.19.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_override
= element delete_override
{
attribute override_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_override_response
= element delete_override_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.19.3 Example: Delete an override</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_override override_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_override_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_report">7.20
Command <tt>delete_report</tt>
</h3></div>
<p>In short: Delete a report.</p>
<p>
The client uses the delete_report command to delete an existing report.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.20.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>report_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.20.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_report
= element delete_report
{
attribute report_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_report_response
= element delete_report_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.20.3 Example: Delete a report</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_report_format">7.21
Command <tt>delete_report_format</tt>
</h3></div>
<p>In short: Delete a report format.</p>
<p>
The client uses the delete_report_format command to delete an existing
report format.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.21.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>report_format_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.21.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_report_format
= element delete_report_format
{
attribute report_format_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_report_format_response
= element delete_report_format_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.21.3 Example: Delete a report format</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report_format_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_schedule">7.22
Command <tt>delete_schedule</tt>
</h3></div>
<p>In short: Delete a schedule.</p>
<p>
The client uses the delete_schedule command to delete an existing schedule.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.22.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>schedule_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.22.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_schedule
= element delete_schedule
{
attribute schedule_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_schedule_response
= element delete_schedule_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.22.3 Example: Delete a schedule</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_schedule schedule_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_schedule_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_slave">7.23
Command <tt>delete_slave</tt>
</h3></div>
<p>In short: Delete a slave.</p>
<p>
The client uses the delete_slave command to delete an existing slave.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.23.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>slave_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.23.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_slave
= element delete_slave
{
attribute slave_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_slave_response
= element delete_slave_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.23.3 Example: Delete a slave</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_slave slave_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_slave_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_target">7.24
Command <tt>delete_target</tt>
</h3></div>
<p>In short: Delete a target.</p>
<p>
The client uses the delete_target command to delete an existing target.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.24.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>target_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.24.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_target
= element delete_target
{
attribute target_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_target_response
= element delete_target_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.24.3 Example: Delete a target</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_target target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_target_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_delete_task">7.25
Command <tt>delete_task</tt>
</h3></div>
<p>In short: Delete a task.</p>
<p>
The client uses the delete_task command to delete an existing task,
including all reports associated with the task.
</p>
<p>
Since this is a destructive command, the client is advised to ask
for confirmation from the user before sending this command to the
Manager.
</p>
<h4>7.25.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.25.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_task
= element delete_task
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>delete_task_response
= element delete_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.25.3 Example: Delete a task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_agents">7.26
Command <tt>get_agents</tt>
</h3></div>
<p>In short: Get all agents.</p>
<p>
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.
</p>
<p>
If the request includes a format then the agents in the response
include installer elements, otherwise they include package
elements.
</p>
<h4>7.26.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>agent_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single agent to get.
</li>
<li>
@<b>format</b>
("installer", "howto_install" or "howto_use")
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>agent</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the agent.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the agent.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>in_use</b>>
<div style="margin-left: 15px; display: inline;">Whether the agent is in use.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<b>installer</b>>
<ul style="list-style: none"><li>
<<b>trust</b>>
<div style="margin-left: 15px; display: inline;">Whether signature verification succeeded.</div>
<ul style="list-style: none"><li>
<<b>time</b>>
<div style="margin-left: 15px; display: inline;">When the signature was verified.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>package</b>>
<div style="margin-left: 15px; display: inline;">Either the installer or one of the HOWTOs.</div>
<ul style="list-style: none"><li>
<<b>filename</b>>
<div style="margin-left: 15px; display: inline;">The filename of the package.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.26.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_agents
= element get_agents
{
attribute agent_id { uuid }?
& attribute format { xsd:token { pattern = "installer|howto_install|howto_use" } }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_agents_response
= element get_agents_response
{
attribute status { status }
& attribute status_text { text }
& get_agents_response_agent*
}
get_agents_response_agent
= element agent
{
attribute id { uuid }
& get_agents_response_agent_name
& get_agents_response_agent_comment
& get_agents_response_agent_in_use
& ( get_agents_response_agent_installer
| get_agents_response_agent_package )
}
get_agents_response_agent_name
= element name
{
name
}
get_agents_response_agent_comment
= element comment
{
text
}
get_agents_response_agent_in_use
= element in_use
{
boolean
}
get_agents_response_agent_installer
= element installer
{
get_agents_response_agent_installer_trust
}
get_agents_response_agent_installer_trust
= element trust
{
text # RNC limitation: xsd:token { pattern = "yes|no|unknown" }
& get_agents_response_agent_installer_trust_time
}
get_agents_response_agent_installer_trust_time
= element time
{
ctime
}
get_agents_response_agent_package
= element package
{
text # RNC limitation: base64
& get_agents_response_agent_package_filename
}
get_agents_response_agent_package_filename
= element filename
{
text
}
</pre></div>
</div>
<h4>7.26.3 Example: Get all agents</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents_response status="200"
status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
<in_use>1</in_use>
<installer>
<trust>
yes
<time>Wed Jun 30 21:49:08 1993</time>
</trust>
</installer>
</agent>
...
</get_agents_response>
</pre></div>
</div>
<h4>7.26.3 Example: Get one agent</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents_response status="200"
status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
<in_use>1</in_use>
<installer>
<trust>
yes
<time>Wed Jun 30 21:49:08 1993</time>
</trust>
</installer>
</agent>
</get_agents_response>
</pre></div>
</div>
<h4>7.26.3 Example: Get one agent, including the installer package</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
format="installer"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents_response status="200"
status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
<in_use>1</in_use>
<package format="installer">
CgoKCgoKCgoKCgoKCSAgI...
<filename>agent.deb</filename>
</package>
</agent>
</get_agents_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_configs">7.27
Command <tt>get_configs</tt>
</h3></div>
<p>In short: Get all configs.</p>
<p>
The client uses the get_configs command to get config information.
If the command sent by the client was valid, the manager will
reply with a list of configs to the client.
</p>
<h4>7.27.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single config to get.
</li>
<li>
@<b>families</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
@<b>preferences</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>config</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>family_count</b>>
<div style="margin-left: 15px; display: inline;">The number of families selected by the config.</div>
<ul style="list-style: none"><li>
<<b>growing</b>>
<div style="margin-left: 15px; display: inline;">Whether new families are automatically added to the config.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>nvt_count</b>>
<div style="margin-left: 15px; display: inline;">The number of NVTs selected by the config.</div>
<ul style="list-style: none"><li>
<<b>growing</b>>
<div style="margin-left: 15px; display: inline;">Whether new NVTs are automatically added to the config.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>max_nvt_count</b>>
<div style="margin-left: 15px; display: inline;">Total number of NVTs in the families selected by the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>known_nvt_count</b>>
<div style="margin-left: 15px; display: inline;">Total number of known NVTs selected by the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>in_use</b>>
<div style="margin-left: 15px; display: inline;">Whether any tasks are using the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>tasks</b>>
<div style="margin-left: 15px; display: inline;">All tasks using the config.</div>
<ul style="list-style: none"><li>
<<b>task</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li>
<<b>families</b>>
?<div style="margin-left: 15px; display: inline;">All families selected by the config.</div>
<ul style="list-style: none"><li>
<<b>family</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt_count</b>>
<div style="margin-left: 15px; display: inline;">The number of NVTs selected in the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>max_nvt_count</b>>
<div style="margin-left: 15px; display: inline;">The total number of NVTs in the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>growing</b>>
<div style="margin-left: 15px; display: inline;">Whether new NVTs in the family are automatically added to the selection.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li>
<<b>preferences</b>>
?<div style="margin-left: 15px; display: inline;">Preferences for all NVTs selected by the config.</div>
<ul style="list-style: none"><li>
<<b>preference</b>>
*<ul style="list-style: none">
<li>
<<b>nvt</b>>
<div style="margin-left: 15px; display: inline;">NVT to which preference applies.</div>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the preference.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>type</b>>
<div style="margin-left: 15px; display: inline;">The type of preference.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>value</b>>
<div style="margin-left: 15px; display: inline;">The value of the preference.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.27.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_configs
= element get_configs
{
attribute config_id { uuid }?
& attribute families { boolean }?
& attribute preferences { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_configs_response
= element get_configs_response
{
attribute status { status }
& attribute status_text { text }
& get_configs_response_config*
}
get_configs_response_config
= element config
{
get_configs_response_config_name
& get_configs_response_config_comment
& get_configs_response_config_family_count
& get_configs_response_config_nvt_count
& get_configs_response_config_max_nvt_count
& get_configs_response_config_known_nvt_count
& get_configs_response_config_in_use
& get_configs_response_config_tasks
& get_configs_response_config_families?
& get_configs_response_config_preferences?
}
get_configs_response_config_name
= element name
{
name
}
get_configs_response_config_comment
= element comment
{
text
}
get_configs_response_config_family_count
= element family_count
{
text # RNC limitation: integer
& get_configs_response_config_family_count_growing
}
get_configs_response_config_family_count_growing
= element growing
{
boolean
}
get_configs_response_config_nvt_count
= element nvt_count
{
text # RNC limitation: integer
& get_configs_response_config_nvt_count_growing
}
get_configs_response_config_nvt_count_growing
= element growing
{
boolean
}
get_configs_response_config_max_nvt_count
= element max_nvt_count
{
integer
}
get_configs_response_config_known_nvt_count
= element known_nvt_count
{
integer
}
get_configs_response_config_in_use
= element in_use
{
boolean
}
get_configs_response_config_tasks
= element tasks
{
get_configs_response_config_tasks_task*
}
get_configs_response_config_tasks_task
= element task
{
attribute id { uuid }
& get_configs_response_config_tasks_task_name
}
get_configs_response_config_tasks_task_name
= element name
{
name
}
get_configs_response_config_families
= element families
{
get_configs_response_config_families_family*
}
get_configs_response_config_families_family
= element family
{
get_configs_response_config_families_family_name
& get_configs_response_config_families_family_nvt_count
& get_configs_response_config_families_family_max_nvt_count
& get_configs_response_config_families_family_growing
}
get_configs_response_config_families_family_name
= element name
{
name
}
get_configs_response_config_families_family_nvt_count
= element nvt_count
{
integer
}
get_configs_response_config_families_family_max_nvt_count
= element max_nvt_count
{
integer
}
get_configs_response_config_families_family_growing
= element growing
{
boolean
}
get_configs_response_config_preferences
= element preferences
{
get_configs_response_config_preferences_preference*
}
get_configs_response_config_preferences_preference
= element preference
{
get_configs_response_config_preferences_preference_nvt
& get_configs_response_config_preferences_preference_name
& get_configs_response_config_preferences_preference_type
& get_configs_response_config_preferences_preference_value
}
get_configs_response_config_preferences_preference_nvt
= element nvt
{
attribute oid { oid }
& get_configs_response_config_preferences_preference_nvt_name
}
get_configs_response_config_preferences_preference_nvt_name
= element name
{
name
}
get_configs_response_config_preferences_preference_name
= element name
{
name
}
get_configs_response_config_preferences_preference_type
= element type
{
text
}
get_configs_response_config_preferences_preference_value
= element value
{
text
}
</pre></div>
</div>
<h4>7.27.3 Example: Get all configs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs_response status="200"
status_text="OK">
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
<comment>
All NVT's; optimized by using previously collected information.
</comment>
<family_count>
4
<growing>1</growing>
</family_count>
<nvt_count>
12
<growing>1</growing>
</nvt_count>
<in_use>1</in_use>
<tasks>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>Web Servers</name>
</task>
...
</tasks>
</config>
...
</get_configs_response>
</pre></div>
</div>
<h4>7.27.3 Example: Get a single config, including preference and family lists</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs config_id="daba56c8-73ec-11df-a475-002264764cea"
preferences="1"
families="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs_response status="200"
status_text="OK">
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
<comment>
All NVT's; optimized by using previously collected information.
</comment>
<family_count>
4
<growing>1</growing>
</family_count>
<nvt_count>
12
<growing>1</growing>
</nvt_count>
<in_use>1</in_use>
<tasks>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>Web Servers</name>
</task>
...
</tasks>
<families>
<family>
<name>Credentials</name>
<nvt_count>8</nvt_count>
<max_nvt_count>8</max_nvt_count>
<growing>1</growing>
</family>
...
</families>
<preferences>
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
</preference>
...
</preferences>
</config>
...
</get_configs_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_dependencies">7.28
Command <tt>get_dependencies</tt>
</h3></div>
<p>In short: Get dependencies for all available NVTs.</p>
<p>
The client uses the get_dependencies command to request the
dependencies for one or all NVTs available through this manager.
</p>
<h4>7.28.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
ID of single NVT for which to get dependencies.
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>nvt</b>>
*<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>requires</b>>
<ul style="list-style: none"><li>
<<b>nvt</b>>
*<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.28.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_dependencies
= element get_dependencies
{
attribute nvt_oid { oid }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_dependencies_response
= element get_dependencies_response
{
attribute status { status }
& attribute status_text { text }
& get_dependencies_response_nvt*
}
get_dependencies_response_nvt
= element nvt
{
attribute oid { oid }
& get_dependencies_response_nvt_name
& get_dependencies_response_nvt_requires
}
get_dependencies_response_nvt_name
= element name
{
name
}
get_dependencies_response_nvt_requires
= element requires
{
get_dependencies_response_nvt_requires_nvt*
}
get_dependencies_response_nvt_requires_nvt
= element nvt
{
attribute oid { oid }
& get_dependencies_response_nvt_requires_nvt_name
}
get_dependencies_response_nvt_requires_nvt_name
= element name
{
name
}
</pre></div>
</div>
<h4>7.28.3 Example: Get dependencies for all NVTs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies_response status="200"
status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.0.114664">
<name>Dependency Test</name>
<requires>
<nvt oid="1.3.6.1.4.1.25623.1.0.114663">
<name>File Upload Test</name>
</nvt>
</requires>
</nvt>
...
</get_dependencies_response>
</pre></div>
</div>
<h4>7.28.3 Example: Get dependencies for a single NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies nvt_oid="1.3.6.1.4.1.25623.1.0.114664"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies_response status="200"
status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.0.114664">
<name>Dependency Test</name>
<requires>
<nvt oid="1.3.6.1.4.1.25623.1.0.114663">
<name>File Upload Test</name>
</nvt>
</requires>
</nvt>
</get_dependencies_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_escalators">7.29
Command <tt>get_escalators</tt>
</h3></div>
<p>In short: Get all escalators.</p>
<p>
The client uses the get_escalators command to get escalator information.
If the command sent by the client was valid, the manager will
reply with a list of escalators to the client.
</p>
<h4>7.29.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>escalator_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single escalator to get.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>escalator</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>in_use</b>>
<div style="margin-left: 15px; display: inline;">Whether any tasks are using the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>condition</b>>
<div style="margin-left: 15px; display: inline;">The condition that must be satisfied for escalation.</div>
<ul style="list-style: none"><li>
<<b>data</b>>
*<div style="margin-left: 15px; display: inline;">Some data that defines the condition.</div>
<ul style="list-style: none"><li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the condition data.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>event</b>>
<div style="margin-left: 15px; display: inline;">The event that must happen for escalation.</div>
<ul style="list-style: none"><li>
<<b>data</b>>
*<div style="margin-left: 15px; display: inline;">Some data that defines the event.</div>
<ul style="list-style: none"><li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the event data.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>method</b>>
<div style="margin-left: 15px; display: inline;">The method by which escalation must occur.</div>
<ul style="list-style: none"><li>
<<b>data</b>>
*<div style="margin-left: 15px; display: inline;">Some data that defines the method.</div>
<ul style="list-style: none"><li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the method data.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.29.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_escalators
= element get_escalators
{
attribute escalator_id { uuid }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_escalators_response
= element get_escalators_response
{
attribute status { status }
& attribute status_text { text }
& get_escalators_response_escalator*
}
get_escalators_response_escalator
= element escalator
{
get_escalators_response_escalator_name
& get_escalators_response_escalator_comment
& get_escalators_response_escalator_in_use
& get_escalators_response_escalator_condition
& get_escalators_response_escalator_event
& get_escalators_response_escalator_method
}
get_escalators_response_escalator_name
= element name
{
name
}
get_escalators_response_escalator_comment
= element comment
{
text
}
get_escalators_response_escalator_in_use
= element in_use
{
boolean
}
get_escalators_response_escalator_condition
= element condition
{
text
& get_escalators_response_escalator_condition_data*
}
get_escalators_response_escalator_condition_data
= element data
{
text
& get_escalators_response_escalator_condition_data_name
}
get_escalators_response_escalator_condition_data_name
= element name
{
text
}
get_escalators_response_escalator_event
= element event
{
text
& get_escalators_response_escalator_event_data*
}
get_escalators_response_escalator_event_data
= element data
{
text
& get_escalators_response_escalator_event_data_name
}
get_escalators_response_escalator_event_data_name
= element name
{
text
}
get_escalators_response_escalator_method
= element method
{
text
& get_escalators_response_escalator_method_data*
}
get_escalators_response_escalator_method_data
= element data
{
text
& get_escalators_response_escalator_method_data_name
}
get_escalators_response_escalator_method_data_name
= element name
{
text
}
</pre></div>
</div>
<h4>7.29.3 Example: Get the escalators</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_escalators/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_escalators_response status="200"
status_text="OK">
<escalator id="6181e65d-8ba0-4937-9c44-8f2b10b0def7">
<name>Team alert</name>
<comment/>
<in_use>1</in_use>
<condition>
Threat level at least
<data>
High
<name>level</name>
</data>
</condition>
<event>
Task run status changed
<data>
Done
<name>status</name>
</data>
</event>
<method>
Email
<data>
team@example.org
<name>to_address</name>
</data>
<data>
admin@example.org
<name>from_address</name>
</data>
<data>
0
<name>notice</name>
</data>
</method>
</escalator>
...
</get_escalators_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_lsc_credentials">7.30
Command <tt>get_lsc_credentials</tt>
</h3></div>
<p>In short: Get all LSC credentials.</p>
<p>
The client uses the get_lsc_credentials command to get LSC credential information.
If the command sent by the client was valid, the manager will
reply with a list of LSC credentials to the client.
</p>
<h4>7.30.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>lsc_credential_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single LSC credential to get.
</li>
<li>
@<b>format</b>
("key", "rpm", "deb" or "exe")
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>lsc_credential</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>login</b>>
<div style="margin-left: 15px; display: inline;">The username of the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>in_use</b>>
<div style="margin-left: 15px; display: inline;">Whether any targets are using the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>type</b>>
<div style="margin-left: 15px; display: inline;">The type of the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>targets</b>>
<div style="margin-left: 15px; display: inline;">All targets using this LSC credential.</div>
<ul style="list-style: none"><li>
<<b>target</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the target.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li>
<<b>public_key</b>>
?<ul style="list-style: none"></ul>
</li>
<li>
<<b>package</b>>
?<ul style="list-style: none"><li>
@<b>format</b>
("rpm", "deb" or "exe")
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.30.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_lsc_credentials
= element get_lsc_credentials
{
attribute lsc_credential_id { uuid }?
& attribute format { xsd:token { pattern = "key|rpm|deb|exe" } }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_lsc_credentials_response
= element get_lsc_credentials_response
{
attribute status { status }
& attribute status_text { text }
& get_lsc_credentials_response_lsc_credential*
}
get_lsc_credentials_response_lsc_credential
= element lsc_credential
{
attribute id { uuid }
& get_lsc_credentials_response_lsc_credential_name
& get_lsc_credentials_response_lsc_credential_login
& get_lsc_credentials_response_lsc_credential_comment
& get_lsc_credentials_response_lsc_credential_in_use
& get_lsc_credentials_response_lsc_credential_type
& get_lsc_credentials_response_lsc_credential_targets
& get_lsc_credentials_response_lsc_credential_public_key?
& get_lsc_credentials_response_lsc_credential_package?
}
get_lsc_credentials_response_lsc_credential_name
= element name
{
name
}
get_lsc_credentials_response_lsc_credential_login
= element login
{
name
}
get_lsc_credentials_response_lsc_credential_comment
= element comment
{
text
}
get_lsc_credentials_response_lsc_credential_in_use
= element in_use
{
boolean
}
get_lsc_credentials_response_lsc_credential_type
= element type
{
xsd:token { pattern = "gen|pass" }
}
get_lsc_credentials_response_lsc_credential_targets
= element targets
{
get_lsc_credentials_response_lsc_credential_targets_target*
}
get_lsc_credentials_response_lsc_credential_targets_target
= element target
{
attribute id { uuid }
& get_lsc_credentials_response_lsc_credential_targets_target_name
}
get_lsc_credentials_response_lsc_credential_targets_target_name
= element name
{
name
}
get_lsc_credentials_response_lsc_credential_public_key
= element public_key
{
text
}
get_lsc_credentials_response_lsc_credential_package
= element package
{
base64
& attribute format { xsd:token { pattern = "rpm|deb|exe" } }
}
</pre></div>
</div>
<h4>7.30.3 Example: Get all the LSC credentials</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials_response status="200"
status_text="OK">
<lsc_credential id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>sally</name>
<login>sally</login>
<comment/>
<in_use>0</in_use>
<type>gen</type>
<targets/>
</lsc_credential>
<lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<login>bob</login>
<comment>Bob on the web server.</comment>
<in_use>1</in_use>
<type>pass</type>
<targets>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>Web server</name>
</target>
</targets>
</lsc_credential>
...
</get_lsc_credentials_response>
</pre></div>
</div>
<h4>7.30.3 Example: Get the public key of a single LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
format="key"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials_response status="200"
status_text="OK">
<lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<login>bob</login>
<comment>Bob on the web server.</comment>
<in_use>1</in_use>
<type>pass</type>
<targets>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>Web server</name>
</target>
</targets>
<public_key>
ssh-rsa AAAAB3...Z64IcQ== Key generated by OpenVAS Manager
</public_key>
</lsc_credential>
</get_lsc_credentials_response>
</pre></div>
</div>
<h4>7.30.3 Example: Get the Debian package of a single LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
format="deb"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials_response status="200"
status_text="OK">
<lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<login>bob</login>
<comment>Bob on the web server.</comment>
<in_use>1</in_use>
<type>pass</type>
<targets>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>Web server</name>
</target>
</targets>
<package format="deb">ITxhcmNoPgpk...DmvF0AKAAACg==</package>
</lsc_credential>
</get_lsc_credentials_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_notes">7.31
Command <tt>get_notes</tt>
</h3></div>
<p>In short: Get all notes.</p>
<p>
The client uses the get_notes command to get note information.
If the command sent by the client was valid, the manager will
reply with a list of notes to the client.
</p>
<h4>7.31.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>note_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single note to get.
</li>
<li>
@<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
@<b>details</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
@<b>result</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>note</b>>
*<ul style="list-style: none">
<li>
<<b>nvt</b>>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">The text of the note.</div>
<ul style="list-style: none"><li>
@<b>excerpt</b>
(<a href="#type_boolean">boolean</a>)
</li></ul>
</li>
<li>
<<b>orphan</b>>
<div style="margin-left: 15px; display: inline;">Whether the note is an orphan.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
<<b>creation_time</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>modification_time</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hosts</b>>
<div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<div style="margin-left: 15px; display: inline;">Port to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>threat</b>>
<div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>task</b>>
<div style="margin-left: 15px; display: inline;">Task to which note applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>result</b>>
?<div style="margin-left: 15px; display: inline;">Result to which note applies.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>subnet</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cvss_base</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>risk_factor</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cve</b>>
?<div style="margin-left: 15px; display: inline;">CVE value associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>bid</b>>
?<div style="margin-left: 15px; display: inline;">BID associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>threat</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.31.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_notes
= element get_notes
{
attribute note_id { uuid }?
& attribute nvt_oid { oid }?
& attribute task_id { uuid }?
& attribute details { boolean }?
& attribute result { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_notes_response
= element get_notes_response
{
attribute status { status }
& attribute status_text { text }
& get_notes_response_note*
}
get_notes_response_note
= element note
{
get_notes_response_note_nvt
& get_notes_response_note_text
& get_notes_response_note_orphan
& ( get_notes_response_note_creation_time
& get_notes_response_note_modification_time
& get_notes_response_note_hosts
& get_notes_response_note_port
& get_notes_response_note_threat
& get_notes_response_note_task
& get_notes_response_note_result? )?
}
get_notes_response_note_nvt
= element nvt
{
attribute oid { oid }
& get_notes_response_note_nvt_name
}
get_notes_response_note_nvt_name
= element name
{
name
}
get_notes_response_note_text
= element text
{
text
& attribute excerpt { boolean }
}
get_notes_response_note_orphan
= element orphan
{
boolean
}
get_notes_response_note_creation_time
= element creation_time
{
ctime
}
get_notes_response_note_modification_time
= element modification_time
{
ctime
}
get_notes_response_note_hosts
= element hosts
{
text
}
get_notes_response_note_port
= element port
{
text
}
get_notes_response_note_threat
= element threat
{
threat
}
get_notes_response_note_task
= element task
{
attribute id { uuid }
}
get_notes_response_note_result
= element result
{
attribute id { uuid }
& get_notes_response_note_result_subnet
& get_notes_response_note_result_host
& get_notes_response_note_result_port
& get_notes_response_note_result_nvt
& get_notes_response_note_result_threat
& get_notes_response_note_result_description
}
get_notes_response_note_result_subnet
= element subnet
{
text
}
get_notes_response_note_result_host
= element host
{
text
}
get_notes_response_note_result_port
= element port
{
text
}
get_notes_response_note_result_nvt
= element nvt
{
attribute oid { oid }
& get_notes_response_note_result_nvt_name
& get_notes_response_note_result_nvt_cvss_base
& get_notes_response_note_result_nvt_risk_factor
& get_notes_response_note_result_nvt_cve?
& get_notes_response_note_result_nvt_bid?
}
get_notes_response_note_result_nvt_name
= element name
{
name
}
get_notes_response_note_result_nvt_cvss_base
= element cvss_base
{
text
}
get_notes_response_note_result_nvt_risk_factor
= element risk_factor
{
text
}
get_notes_response_note_result_nvt_cve
= element cve
{
text
}
get_notes_response_note_result_nvt_bid
= element bid
{
integer
}
get_notes_response_note_result_threat
= element threat
{
threat
}
get_notes_response_note_result_description
= element description
{
text
}
</pre></div>
</div>
<h4>7.31.3 Example: Get all notes</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes_response status="200"
status_text="OK">
<note id="b76b81a7-9df8-42df-afff-baa9d4620128">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
</nvt>
<text excerpt="0">This is the full text of the note.</text>
<orphan>1</orphan>
</note>
...
</get_notes_response>
</pre></div>
</div>
<h4>7.31.3 Example: Get details of a single note</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes note_id="7f618bbb-4664-419e-9bbf-367d93954cb0"
details="1"
result="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes_response status="200"
status_text="OK">
<note id="7f618bbb-4664-419e-9bbf-367d93954cb0">
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
</nvt>
<creation_time>Sun Jun 27 08:49:46 2010</creation_time>
<modification_time>Sun Jun 27 08:49:46 2010</modification_time>
<text>note fixed to result</text>
<hosts>127.0.0.1</hosts>
<port>general/tcp</port>
<threat>Medium</threat>
<task id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4">
<name>test</name>
</task>
<orphan>0</orphan>
<result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de">
<subnet>127.0.0.1</subnet>
<host>127.0.0.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
<cvss_base/>
<risk_factor/>
<cve/>
<bid/>
</nvt>
<threat>Medium</threat>
<description>Warning with control char between fullstops: . .</description>
</result>
</note>
...
</get_notes_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_nvts">7.32
Command <tt>get_nvts</tt>
</h3></div>
<p>In short: Get all NVTs.</p>
<p>
The client uses the get_nvts command to get NVT information.
</p>
<p>
This command may always include a details flag, a config, a sort
order and a sort field. If the command includes a details flag, the
manager also consults the timeout, preference_count and preferences
flags. The timeout and preferences flags require a config.
</p>
<p>
The NVT OID, family name and config attributes limit the listing to
a single NVT or all NVTs in a particular family and/or config.
</p>
<p>
If the details flag is present the manager will send full details
of the NVT, otherwise it will send just the NVT name and checksum.
</p>
<p>
With the preferences flag the manager includes in the listing, the
values of each listed NVT's preferences for the given config. The
timeout flag does the same for the special timeout preference.
</p>
<p>
If the manager possesses an NVT collection, it will reply with the
NVT information. If the manager cannot access a list of available
NVTs at that time, it will reply with the 503 response.
</p>
<h4>7.32.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
Single NVT to get.
</li>
<li>
@<b>details</b>
(<a href="#type_boolean">boolean</a>)
Whether to include full details.
</li>
<li>
@<b>preferences</b>
(<a href="#type_boolean">boolean</a>)
Whether to include preference.
</li>
<li>
@<b>preference_count</b>
(<a href="#type_boolean">boolean</a>)
Whether to include preference count.
</li>
<li>
@<b>timeout</b>
(<a href="#type_boolean">boolean</a>)
Whether to include the special timeout preference.
</li>
<li>
@<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
ID of config to which to limit the NVT listing.
</li>
<li>
@<b>family</b>
(text)
Family to which to limit NVT listing.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>nvt</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>checksum</b>>
<ul style="list-style: none"><li>
<<b>algorithm</b>>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
<<b>category</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>copyright</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>summary</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>family</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>version</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cvss_base</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>risk_factor</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cve_id</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>bugtraq_id</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>xrefs</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>fingerprints</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>tags</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>preference_count</b>>
?<ul style="list-style: none"></ul>
</li>
<li>
<<b>timeout</b>>
?<ul style="list-style: none"></ul>
</li>
<li>
<<b>preferences</b>>
?<ul style="list-style: none">
<li>
<<b>timeout</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>preference</b>>
*<ul style="list-style: none">
<li>
<<b>nvt</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>type</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>value</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.32.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_nvts
= element get_nvts
{
attribute nvt_oid { oid }
& attribute details { boolean }?
& attribute preferences { boolean }?
& attribute preference_count { boolean }?
& attribute timeout { boolean }?
& attribute config_id { uuid }?
& attribute family { text }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_nvts_response
= element get_nvts_response
{
attribute status { status }
& attribute status_text { text }
& get_nvts_response_nvt
}
get_nvts_response_nvt
= element nvt
{
attribute id { uuid }
& get_nvts_response_nvt_name
& get_nvts_response_nvt_checksum
& ( get_nvts_response_nvt_category
& get_nvts_response_nvt_copyright
& get_nvts_response_nvt_description
& get_nvts_response_nvt_summary
& get_nvts_response_nvt_family
& get_nvts_response_nvt_version
& get_nvts_response_nvt_cvss_base
& get_nvts_response_nvt_risk_factor
& get_nvts_response_nvt_cve_id
& get_nvts_response_nvt_bugtraq_id
& get_nvts_response_nvt_xrefs
& get_nvts_response_nvt_fingerprints
& get_nvts_response_nvt_tags
& get_nvts_response_nvt_preference_count?
& get_nvts_response_nvt_timeout?
& get_nvts_response_nvt_preferences? )?
}
get_nvts_response_nvt_name
= element name
{
name
}
get_nvts_response_nvt_category
= element category
{
text
}
get_nvts_response_nvt_copyright
= element copyright
{
text
}
get_nvts_response_nvt_description
= element description
{
text
}
get_nvts_response_nvt_summary
= element summary
{
text
}
get_nvts_response_nvt_family
= element family
{
text
}
get_nvts_response_nvt_version
= element version
{
text
}
get_nvts_response_nvt_cvss_base
= element cvss_base
{
text
}
get_nvts_response_nvt_risk_factor
= element risk_factor
{
text
}
get_nvts_response_nvt_cve_id
= element cve_id
{
text
}
get_nvts_response_nvt_bugtraq_id
= element bugtraq_id
{
text
}
get_nvts_response_nvt_xrefs
= element xrefs
{
text
}
get_nvts_response_nvt_fingerprints
= element fingerprints
{
text
}
get_nvts_response_nvt_tags
= element tags
{
text
}
get_nvts_response_nvt_preference_count
= element preference_count
{
text
}
get_nvts_response_nvt_timeout
= element timeout
{
text
}
get_nvts_response_nvt_checksum
= element checksum
{
text
& get_nvts_response_nvt_checksum_algorithm
}
get_nvts_response_nvt_checksum_algorithm
= element algorithm
{
text
}
get_nvts_response_nvt_preferences
= element preferences
{
text
& get_nvts_response_nvt_preferences_timeout
& get_nvts_response_nvt_preferences_preference*
}
get_nvts_response_nvt_preferences_timeout
= element timeout
{
text
}
get_nvts_response_nvt_preferences_preference
= element preference
{
get_nvts_response_nvt_preferences_preference_nvt
& get_nvts_response_nvt_preferences_preference_name
& get_nvts_response_nvt_preferences_preference_type
& get_nvts_response_nvt_preferences_preference_value
}
get_nvts_response_nvt_preferences_preference_nvt
= element nvt
{
oid
}
get_nvts_response_nvt_preferences_preference_name
= element name
{
text
}
get_nvts_response_nvt_preferences_preference_type
= element type
{
text
}
get_nvts_response_nvt_preferences_preference_value
= element value
{
text
}
</pre></div>
</div>
<h4>7.32.3 Example: Get full NVT listing</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts details="1"
timeout="1"
preference_count="1"
preferences="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts_response status="200"
status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.7.13005">
<name>Services</name>
<category>Services</category>
<copyright>GNU GPL v2</copyright>
<description>
This script attepts to detects with service is running on which port.
</description>
<summary>Find what is listening on which port</summary>
<family>Service detection</family>
<version>$Revision: 1852 $</version>
<cvss_base/>
<risk_factor>None</risk_factor>
<cve_id>NOCVE</cve_id>
<bugtraq_id>NOBID</bugtraq_id>
<xrefs>NOXREF</xrefs>
<fingerprints>NOSIGNKEYS</fingerprints>
<tags>NOTAG</tags>
<preference_count>-1</preference_count>
<timeout/>
<checksum>
2397586ea5cd3a69f953836f7be9ef7b
<algorithm>md5</algorithm>
</checksum>
<preferences>
<timeout/>
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
</preference>
...
</preferences>
</nvt>
<nvt oid="1.3.6.1.4.1.25623.1.7.13006">
<name>FooBar 21</name>
<category>Services</category>
<copyright>GNU GPL v2</copyright>
<description>
This script detects whether the FooBar 2.1 XSS vulnerability is present.
</description>
...
</nvt>
...
</get_nvts_response>
</pre></div>
</div>
<h4>7.32.3 Example: Get minimal information about one NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts_response status="200"
status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
<checksum>
2397586ea5cd3a69f953836f7be9ef7b
<algorithm>md5</algorithm>
</checksum>
</nvt>
</get_nvts_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_nvt_families">7.33
Command <tt>get_nvt_families</tt>
</h3></div>
<p>In short: Get a list of all NVT families.</p>
<p>
The client uses the get_nvt_families command to get NVT family
information. If the command sent by the client was valid, the
manager will reply with a list of NVT families to the client.
</p>
<h4>7.33.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>families</b>>
<ul style="list-style: none"><li>
<<b>family</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>max_nvt_count</b>>
<div style="margin-left: 15px; display: inline;">The number of NVTs in the family.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<h4>7.33.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_nvt_families
= element get_nvt_families
{
attribute sort_order { sort_order }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_nvt_families_response
= element get_nvt_families_response
{
attribute status { status }
& attribute status_text { text }
& get_nvt_families_response_families
}
get_nvt_families_response_families
= element families
{
get_nvt_families_response_families_family*
}
get_nvt_families_response_families_family
= element family
{
get_nvt_families_response_families_family_name
& get_nvt_families_response_families_family_max_nvt_count
}
get_nvt_families_response_families_family_name
= element name
{
name
}
get_nvt_families_response_families_family_max_nvt_count
= element max_nvt_count
{
integer
}
</pre></div>
</div>
<h4>7.33.3 Example: Get the NVT families</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_families/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_families_response status="200"
status_text="OK">
<families>
<family>
<name>Credentials</name>
<max_nvt_count>8</max_nvt_count>
</family>
<family>
<name>Port scanners</name>
<max_nvt_count>12</max_nvt_count>
</family>
...
</families>
</get_nvt_families_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_nvt_feed_checksum">7.34
Command <tt>get_nvt_feed_checksum</tt>
</h3></div>
<p>In short: Get checksum for entire NVT collection.</p>
<p>
The client uses the get_nvt_feed_checksum command to request a
checksum for the complete NVT collection available through this
manager. The client may specify an algorithm to be used for
computing this checksum.
</p>
<p>
If the specified algorithm is not implemented in the manager, then
the manager will reply with a response code in the 4xx range.
</p>
<p>
If the client does not specify a checksum algorithm, the manager is
expected to use the MD5 algorithm for computing the checksum.
</p>
<p>
If the manager possesses such a collection, it will reply with a
response code indicating success, and the checksum over all NVT
files. If the manager cannot access a list of available NVTs at
present, it will reply with the 503 response.
</p>
<h4>7.34.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>algorithm</b>
(text)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>checksum</b>>
<ul style="list-style: none"><li>
@<b>algorithm</b>
(text)
</li></ul>
</li>
</ul>
</li>
</ul>
<h4>7.34.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_nvt_feed_checksum
= element get_nvt_feed_checksum
{
attribute algorithm { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_nvt_feed_checksum_response
= element get_nvt_feed_checksum_response
{
attribute status { status }
& attribute status_text { text }
& get_nvt_feed_checksum_response_checksum
}
get_nvt_feed_checksum_response_checksum
= element checksum
{
text # RNC limitation: base64
& attribute algorithm { text }
}
</pre></div>
</div>
<h4>7.34.3 Example: Get the NVT feed checksum</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_feed_checksum/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_feed_checksum_response status="200"
status_text="OK">
<checksum algorithm="md5">931db829a06b9a440a2ecaeb68c03715</checksum>
</get_nvt_feed_checksum_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_overrides">7.35
Command <tt>get_overrides</tt>
</h3></div>
<p>In short: Get all overrides.</p>
<p>
The client uses the get_overrides command to get override information.
If the command sent by the client was valid, the manager will
reply with a list of overrides to the client.
</p>
<h4>7.35.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>override_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single override to get.
</li>
<li>
@<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
@<b>details</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
@<b>result</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>override</b>>
*<ul style="list-style: none">
<li>
<<b>nvt</b>>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">The text of the override.</div>
<ul style="list-style: none"><li>
@<b>excerpt</b>
(<a href="#type_boolean">boolean</a>)
</li></ul>
</li>
<li>
<<b>threat</b>>
<div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>new_threat</b>>
<div style="margin-left: 15px; display: inline;">New threat for result.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>orphan</b>>
<div style="margin-left: 15px; display: inline;">Whether the override is an orphan.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
<<b>creation_time</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>modification_time</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hosts</b>>
<div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<div style="margin-left: 15px; display: inline;">Port to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>task</b>>
<div style="margin-left: 15px; display: inline;">Task to which override applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>result</b>>
?<div style="margin-left: 15px; display: inline;">Result to which override applies.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>subnet</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cvss_base</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>risk_factor</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cve</b>>
?<div style="margin-left: 15px; display: inline;">CVE value associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>bid</b>>
?<div style="margin-left: 15px; display: inline;">BID associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>threat</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.35.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_overrides
= element get_overrides
{
attribute override_id { uuid }?
& attribute nvt_oid { oid }?
& attribute task_id { uuid }?
& attribute details { boolean }?
& attribute result { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_overrides_response
= element get_overrides_response
{
attribute status { status }
& attribute status_text { text }
& get_overrides_response_override*
}
get_overrides_response_override
= element override
{
get_overrides_response_override_nvt
& get_overrides_response_override_text
& get_overrides_response_override_threat
& get_overrides_response_override_new_threat
& get_overrides_response_override_orphan
& ( get_overrides_response_override_creation_time
& get_overrides_response_override_modification_time
& get_overrides_response_override_hosts
& get_overrides_response_override_port
& get_overrides_response_override_task
& get_overrides_response_override_result? )?
}
get_overrides_response_override_nvt
= element nvt
{
attribute oid { oid }
& get_overrides_response_override_nvt_name
}
get_overrides_response_override_nvt_name
= element name
{
name
}
get_overrides_response_override_text
= element text
{
text
& attribute excerpt { boolean }
}
get_overrides_response_override_threat
= element threat
{
threat
}
get_overrides_response_override_new_threat
= element new_threat
{
threat
}
get_overrides_response_override_orphan
= element orphan
{
boolean
}
get_overrides_response_override_creation_time
= element creation_time
{
ctime
}
get_overrides_response_override_modification_time
= element modification_time
{
ctime
}
get_overrides_response_override_hosts
= element hosts
{
text
}
get_overrides_response_override_port
= element port
{
text
}
get_overrides_response_override_task
= element task
{
attribute id { uuid }
}
get_overrides_response_override_result
= element result
{
attribute id { uuid }
& get_overrides_response_override_result_subnet
& get_overrides_response_override_result_host
& get_overrides_response_override_result_port
& get_overrides_response_override_result_nvt
& get_overrides_response_override_result_threat
& get_overrides_response_override_result_description
}
get_overrides_response_override_result_subnet
= element subnet
{
text
}
get_overrides_response_override_result_host
= element host
{
text
}
get_overrides_response_override_result_port
= element port
{
text
}
get_overrides_response_override_result_nvt
= element nvt
{
attribute oid { oid }
& get_overrides_response_override_result_nvt_name
& get_overrides_response_override_result_nvt_cvss_base
& get_overrides_response_override_result_nvt_risk_factor
& get_overrides_response_override_result_nvt_cve?
& get_overrides_response_override_result_nvt_bid?
}
get_overrides_response_override_result_nvt_name
= element name
{
name
}
get_overrides_response_override_result_nvt_cvss_base
= element cvss_base
{
text
}
get_overrides_response_override_result_nvt_risk_factor
= element risk_factor
{
text
}
get_overrides_response_override_result_nvt_cve
= element cve
{
text
}
get_overrides_response_override_result_nvt_bid
= element bid
{
integer
}
get_overrides_response_override_result_threat
= element threat
{
threat
}
get_overrides_response_override_result_description
= element description
{
text
}
</pre></div>
</div>
<h4>7.35.3 Example: Get all overrides</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides_response status="200"
status_text="OK">
<override id="b76b81a7-9df8-42df-afff-baa9d4620128">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
</nvt>
<text excerpt="0">This is the full text of the override.</text>
<threat>High</threat>
<new_threat>Log</new_threat>
<orphan>1</orphan>
</override>
...
</get_overrides_response>
</pre></div>
</div>
<h4>7.35.3 Example: Get details of a single override</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides override_id="7f618bbb-4664-419e-9bbf-367d93954cb0"
details="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides_response status="200"
status_text="OK">
<override id="7f618bbb-4664-419e-9bbf-367d93954cb0">
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
</nvt>
<creation_time>Sun Jun 27 08:49:46 2010</creation_time>
<modification_time>Sun Jun 27 08:49:46 2010</modification_time>
<text>override fixed to result</text>
<hosts>127.0.0.1</hosts>
<port>general/tcp</port>
<threat>Medium</threat>
<new_threat>Low</new_threat>
<task id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4">
<name>test</name>
</task>
<orphan>0</orphan>
<result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de"/>
</override>
...
</get_overrides_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_preferences">7.36
Command <tt>get_preferences</tt>
</h3></div>
<p>In short: Get all preferences.</p>
<p>
The client uses the get_preferences command to get preference information.
If the command sent by the client was valid, the manager will reply with
a list of preferences to the client. If the manager cannot access a list
of available NVTs at present, it will reply with the 503 response.
</p>
<p>
When the command includes a config_id attribute, the preference element
includes the preference name, type and value, and the NVT to which the
preference applies. Otherwise, the preference element includes just the
name and value, with the NVT and type built into the name.
</p>
<h4>7.36.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
@<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
ID of config of which to show preference values.
</li>
<li>
@<b>preference</b>
(text)
The name of a particular preference to get.
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>preference</b>>
*<ul style="list-style: none">
<li>
<<b>nvt</b>>
?<div style="margin-left: 15px; display: inline;">NVT to which preference applies.</div>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the preference.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>type</b>>
?<div style="margin-left: 15px; display: inline;">The type of preference.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>value</b>>
<div style="margin-left: 15px; display: inline;">The value of the preference.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.36.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_preferences
= element get_preferences
{
attribute nvt_oid { oid }?
& attribute config_id { uuid }?
& attribute preference { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_preferences_response
= element get_preferences_response
{
attribute status { status }
& attribute status_text { text }
& get_preferences_response_preference*
}
get_preferences_response_preference
= element preference
{
get_preferences_response_preference_nvt?
& get_preferences_response_preference_name
& get_preferences_response_preference_type?
& get_preferences_response_preference_value
}
get_preferences_response_preference_nvt
= element nvt
{
attribute oid { oid }
& get_preferences_response_preference_nvt_name
}
get_preferences_response_preference_nvt_name
= element name
{
name
}
get_preferences_response_preference_name
= element name
{
name
}
get_preferences_response_preference_type
= element type
{
text
}
get_preferences_response_preference_value
= element value
{
text
}
</pre></div>
</div>
<h4>7.36.3 Example: Get default preferences for all NVTs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences_response status="200"
status_text="OK">
<preference>
<name>Services[entry]:Network connection timeout :</name>
<value>5</value>
</preference>
...
</get_preferences_response>
</pre></div>
</div>
<h4>7.36.3 Example: Get default preferences for a single NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences_response status="200"
status_text="OK">
<preference>
<name>Services[entry]:Network connection timeout :</name>
<value>5</value>
</preference>
...
</get_preferences_response>
</pre></div>
</div>
<h4>7.36.3 Example: Get preferences from a config for all NVTs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences_response status="200"
status_text="OK">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
</preference>
...
</get_preferences_response>
</pre></div>
</div>
<h4>7.36.3 Example: Get preferences from a config for a single NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea"
nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences nvt_oid="1.3.6.1.4.1.25623.1.0.10330">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
</nvt>
<name>Network connection timeout :</name>
<type>entry</type>
<value>5</value>
</preference>
</get_preferences>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_reports">7.37
Command <tt>get_reports</tt>
</h3></div>
<p>In short: Get all reports.</p>
<p>
The client uses the get_reports command to get report information.
</p>
<p>
The XML report format is sent as XML. All other formats are sent in
Base64 encoding.
</p>
<h4>7.37.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>report_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single report to get.
</li>
<li>
@<b>format_id</b>
(<a href="#type_uuid">uuid</a>)
ID of required report format.
</li>
<li>
@<b>first_result</b>
(<a href="#type_integer">integer</a>)
First result to get.
</li>
<li>
@<b>max_results</b>
(<a href="#type_integer">integer</a>)
Maximum number of results to get.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
<li>
@<b>levels</b>
(<a href="#type_levels">levels</a>)
Which threat levels to include in the report.
</li>
<li>
@<b>search_phrase</b>
(text)
A string that all results in the report must contain.
</li>
<li>
@<b>min_cvss_base</b>
(<a href="#type_integer">integer</a>)
Minimum CVSS base of results in report.
</li>
<li>
@<b>notes</b>
(<a href="#type_boolean">boolean</a>)
Whether to include notes in the report.
</li>
<li>
@<b>note_details</b>
(<a href="#type_boolean">boolean</a>)
If notes are included, whether to include note details.
</li>
<li>
@<b>overrides</b>
(<a href="#type_boolean">boolean</a>)
Whether to include overrides in the report.
</li>
<li>
@<b>override_details</b>
(<a href="#type_boolean">boolean</a>)
If overrides are included, whether to include override details.
</li>
<li>
@<b>result_hosts_only</b>
(<a href="#type_boolean">boolean</a>)
Whether to include only those hosts that have results.
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>report</b>>
*<div style="margin-left: 15px; display: inline;">Actually attributes and either base64 or a report.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
@<b>format_id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
@<b>extension</b>
(text)
</li>
<li>
@<b>content_type</b>
(text)
</li>
<li>
<<b>report</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
<<b>sort</b>>
<div style="margin-left: 15px; display: inline;">Result sorting information.</div>
<ul style="list-style: none"><li>
<<b>field</b>>
<div style="margin-left: 15px; display: inline;">Sort field.</div>
<ul style="list-style: none"><li>
<<b>order</b>>
<div style="margin-left: 15px; display: inline;">Sort order of field.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>filters</b>>
<div style="margin-left: 15px; display: inline;">Result filtering information.</div>
<ul style="list-style: none">
<li>
<<b>phrase</b>>
<div style="margin-left: 15px; display: inline;">Search phrase.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>notes</b>>
<div style="margin-left: 15px; display: inline;">Whether notes are included.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>overrides</b>>
<div style="margin-left: 15px; display: inline;">Whether overrides are included.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>apply_overrides</b>>
<div style="margin-left: 15px; display: inline;">Whether overrides are applied.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result_hosts_only</b>>
<div style="margin-left: 15px; display: inline;">Whether only those hosts that have results are included.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>min_cvss_base</b>>
<div style="margin-left: 15px; display: inline;">Minimum CVSS base if in effect, else empty string.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>filter</b>>
*<div style="margin-left: 15px; display: inline;">Level filter.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>scan_run_status</b>>
<div style="margin-left: 15px; display: inline;">Run status of task scan at time of report.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result_count</b>>
<ul style="list-style: none">
<li>
<<b>full</b>>
<div style="margin-left: 15px; display: inline;">Total number of results produced by scan.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>filtered</b>>
<div style="margin-left: 15px; display: inline;">Number of results after filtering.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>debug</b>>
<div style="margin-left: 15px; display: inline;">Number of "debug" results (threat level Debug).</div>
<ul style="list-style: none">
<li>
<<b>full</b>>
<div style="margin-left: 15px; display: inline;">Total number of results.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>filtered</b>>
<div style="margin-left: 15px; display: inline;">Number of results after filtering.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>hole</b>>
<div style="margin-left: 15px; display: inline;">Number of "hole" results (threat level High).</div>
<ul style="list-style: none">
<li>
<<b>full</b>>
<div style="margin-left: 15px; display: inline;">Total number of results.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>filtered</b>>
<div style="margin-left: 15px; display: inline;">Number of results after filtering.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>info</b>>
<div style="margin-left: 15px; display: inline;">Number of "info" results (threat level Low).</div>
<ul style="list-style: none">
<li>
<<b>full</b>>
<div style="margin-left: 15px; display: inline;">Total number of results.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>filtered</b>>
<div style="margin-left: 15px; display: inline;">Number of results after filtering.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>log</b>>
<div style="margin-left: 15px; display: inline;">Number of "log" results (threat level Log).</div>
<ul style="list-style: none">
<li>
<<b>full</b>>
<div style="margin-left: 15px; display: inline;">Total number of results.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>filtered</b>>
<div style="margin-left: 15px; display: inline;">Number of results after filtering.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>warning</b>>
<div style="margin-left: 15px; display: inline;">Number of "warning" results (threat level Medium).</div>
<ul style="list-style: none">
<li>
<<b>full</b>>
<div style="margin-left: 15px; display: inline;">Total number of results.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>filtered</b>>
<div style="margin-left: 15px; display: inline;">Number of results after filtering.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
<<b>task</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>ports</b>>
<ul style="list-style: none">
<li>
@<b>start</b>
(<a href="#type_integer">integer</a>)
</li>
<li>
@<b>max</b>
(<a href="#type_integer">integer</a>)
</li>
<li>
<<b>port</b>>
*<ul style="list-style: none">
<li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>threat</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
<<b>results</b>>
<ul style="list-style: none">
<li>
@<b>start</b>
(<a href="#type_integer">integer</a>)
</li>
<li>
@<b>max</b>
(<a href="#type_integer">integer</a>)
</li>
<li>
<<b>result</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>subnet</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
<div style="margin-left: 15px; display: inline;">NVT to which result applies.</div>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cvss_base</b>>
<div style="margin-left: 15px; display: inline;">CVSS base value associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>risk_factor</b>>
<div style="margin-left: 15px; display: inline;">Risk factor associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>threat</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
<div style="margin-left: 15px; display: inline;">Description of the result.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
<<b>scan_start</b>>
<div style="margin-left: 15px; display: inline;">Start time of scan.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>host_start</b>>
*<div style="margin-left: 15px; display: inline;">Start time of a particular host.</div>
<ul style="list-style: none"><li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>host_end</b>>
*<div style="margin-left: 15px; display: inline;">End time of a particular host.</div>
<ul style="list-style: none"><li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>scan_end</b>>
<div style="margin-left: 15px; display: inline;">End time of scan.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.37.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_reports
= element get_reports
{
attribute report_id { uuid }?
& attribute format_id { uuid }?
& attribute first_result { integer }?
& attribute max_results { integer }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
& attribute levels { levels }?
& attribute search_phrase { text }?
& attribute min_cvss_base { integer }?
& attribute notes { boolean }?
& attribute note_details { boolean }?
& attribute overrides { boolean }?
& attribute override_details { boolean }?
& attribute result_hosts_only { boolean }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_reports_response
= element get_reports_response
{
attribute status { status }
& attribute status_text { text }
& get_reports_response_report*
}
get_reports_response_report
= element report
{
text # RNC limitation: base64
& attribute id { uuid }
& attribute format_id { uuid }
& attribute extension { text }
& attribute content_type { text }
& get_reports_response_report_report
}
get_reports_response_report_report
= element report
{
attribute id { uuid }
& ( get_reports_response_report_report_sort
& get_reports_response_report_report_filters
& get_reports_response_report_report_scan_run_status
& get_reports_response_report_report_result_count
& get_reports_response_report_report_task
& get_reports_response_report_report_ports
& get_reports_response_report_report_results
& get_reports_response_report_report_scan_start
& get_reports_response_report_report_host_start*
& get_reports_response_report_report_host_end*
& get_reports_response_report_report_scan_end )?
}
get_reports_response_report_report_sort
= element sort
{
get_reports_response_report_report_sort_field
}
get_reports_response_report_report_sort_field
= element field
{
text
& get_reports_response_report_report_sort_field_order
}
get_reports_response_report_report_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_reports_response_report_report_filters
= element filters
{
text # RNC limitation: levels
& get_reports_response_report_report_filters_phrase
& get_reports_response_report_report_filters_notes
& get_reports_response_report_report_filters_overrides
& get_reports_response_report_report_filters_apply_overrides
& get_reports_response_report_report_filters_result_hosts_only
& get_reports_response_report_report_filters_min_cvss_base
& get_reports_response_report_report_filters_filter*
}
get_reports_response_report_report_filters_phrase
= element phrase
{
text
}
get_reports_response_report_report_filters_notes
= element notes
{
xsd:token { pattern = "0|1" }
}
get_reports_response_report_report_filters_overrides
= element overrides
{
xsd:token { pattern = "0|1" }
}
get_reports_response_report_report_filters_apply_overrides
= element apply_overrides
{
xsd:token { pattern = "0|1" }
}
get_reports_response_report_report_filters_result_hosts_only
= element result_hosts_only
{
xsd:token { pattern = "0|1" }
}
get_reports_response_report_report_filters_min_cvss_base
= element min_cvss_base
{
text
}
get_reports_response_report_report_filters_filter
= element filter
{
xsd:token { pattern = "High|Medium|Low|Log|Debug" }
}
get_reports_response_report_report_scan_run_status
= element scan_run_status
{
task_status
}
get_reports_response_report_report_result_count
= element result_count
{
get_reports_response_report_report_result_count_full
& get_reports_response_report_report_result_count_filtered
& get_reports_response_report_report_result_count_debug
& get_reports_response_report_report_result_count_hole
& get_reports_response_report_report_result_count_info
& get_reports_response_report_report_result_count_log
& get_reports_response_report_report_result_count_warning
}
get_reports_response_report_report_result_count_full
= element full
{
integer
}
get_reports_response_report_report_result_count_filtered
= element filtered
{
integer
}
get_reports_response_report_report_result_count_debug
= element debug
{
get_reports_response_report_report_result_count_debug_full
& get_reports_response_report_report_result_count_debug_filtered
}
get_reports_response_report_report_result_count_debug_full
= element full
{
integer
}
get_reports_response_report_report_result_count_debug_filtered
= element filtered
{
integer
}
get_reports_response_report_report_result_count_hole
= element hole
{
get_reports_response_report_report_result_count_hole_full
& get_reports_response_report_report_result_count_hole_filtered
}
get_reports_response_report_report_result_count_hole_full
= element full
{
integer
}
get_reports_response_report_report_result_count_hole_filtered
= element filtered
{
integer
}
get_reports_response_report_report_result_count_info
= element info
{
get_reports_response_report_report_result_count_info_full
& get_reports_response_report_report_result_count_info_filtered
}
get_reports_response_report_report_result_count_info_full
= element full
{
integer
}
get_reports_response_report_report_result_count_info_filtered
= element filtered
{
integer
}
get_reports_response_report_report_result_count_log
= element log
{
get_reports_response_report_report_result_count_log_full
& get_reports_response_report_report_result_count_log_filtered
}
get_reports_response_report_report_result_count_log_full
= element full
{
integer
}
get_reports_response_report_report_result_count_log_filtered
= element filtered
{
integer
}
get_reports_response_report_report_result_count_warning
= element warning
{
get_reports_response_report_report_result_count_warning_full
& get_reports_response_report_report_result_count_warning_filtered
}
get_reports_response_report_report_result_count_warning_full
= element full
{
integer
}
get_reports_response_report_report_result_count_warning_filtered
= element filtered
{
integer
}
get_reports_response_report_report_task
= element task
{
attribute id { uuid }
& get_reports_response_report_report_task_name
}
get_reports_response_report_report_task_name
= element name
{
name
}
get_reports_response_report_report_ports
= element ports
{
attribute start { integer }
& attribute max { integer }
& get_reports_response_report_report_ports_port*
}
get_reports_response_report_report_ports_port
= element port
{
text
& get_reports_response_report_report_ports_port_host
& get_reports_response_report_report_ports_port_threat
}
get_reports_response_report_report_ports_port_host
= element host
{
text
}
get_reports_response_report_report_ports_port_threat
= element threat
{
threat
}
get_reports_response_report_report_results
= element results
{
attribute start { integer }
& attribute max { integer }
& get_reports_response_report_report_results_result*
}
get_reports_response_report_report_results_result
= element result
{
attribute id { uuid }
& get_reports_response_report_report_results_result_subnet
& get_reports_response_report_report_results_result_host
& get_reports_response_report_report_results_result_port
& get_reports_response_report_report_results_result_nvt
& get_reports_response_report_report_results_result_threat
& get_reports_response_report_report_results_result_description
}
get_reports_response_report_report_results_result_subnet
= element subnet
{
text
}
get_reports_response_report_report_results_result_host
= element host
{
text
}
get_reports_response_report_report_results_result_port
= element port
{
text
}
get_reports_response_report_report_results_result_nvt
= element nvt
{
attribute oid { oid }
& get_reports_response_report_report_results_result_nvt_name
& get_reports_response_report_report_results_result_nvt_cvss_base
& get_reports_response_report_report_results_result_nvt_risk_factor
}
get_reports_response_report_report_results_result_nvt_name
= element name
{
name
}
get_reports_response_report_report_results_result_nvt_cvss_base
= element cvss_base
{
integer
}
get_reports_response_report_report_results_result_nvt_risk_factor
= element risk_factor
{
integer
}
get_reports_response_report_report_results_result_threat
= element threat
{
threat
}
get_reports_response_report_report_results_result_description
= element description
{
text
}
get_reports_response_report_report_scan_start
= element scan_start
{
ctime
}
get_reports_response_report_report_host_start
= element host_start
{
text # RNC limitation: ctime
& get_reports_response_report_report_host_start_host
}
get_reports_response_report_report_host_start_host
= element host
{
text
}
get_reports_response_report_report_host_end
= element host_end
{
text # RNC limitation: ctime
& get_reports_response_report_report_host_end_host
}
get_reports_response_report_report_host_end_host
= element host
{
text
}
get_reports_response_report_report_scan_end
= element scan_end
{
ctime
}
</pre></div>
</div>
<h4>7.37.3 Example: Get a report in PDF</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
format_id="1a60a67e-97d0-4cbf-bc77-f71b08e7043d"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_reports_response status="200"
status_text="OK">
<report id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
format_id="1a60a67e-97d0-4cbf-bc77-f71b08e7043d"
extension="pdf"
content_type="application/pdf">hsisn3qaVFhkjFRG4...</report>
</get_reports_response>
</pre></div>
</div>
<h4>7.37.3 Example: Get a report in XML</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_reports report_id="f0fdf522-276d-4893-9274-fb8699dc2270"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_reports_response status="200"
status_text="OK">
<report id="f0fdf522-276d-4893-9274-fb8699dc2270"
format_id="d5da9f67-8551-4e51-807b-b6a873d70e34"
extension="xml"
content_type="text/xml">
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<sort>
<field>
type
<order>descending</order>
</field>
</sort>
<filters>
hmlgd
<phrase/>
<notes>0</notes>
<overrides>0</overrides>
<apply_overrides>0</apply_overrides>
<result_hosts_only>1</result_hosts_only>
<min_cvss_base/>
<filter>High</filter>
<filter>Medium</filter>
<filter>Low</filter>
<filter>Log</filter>
<filter>Debug</filter>
</filters>
<scan_run_status>Done</scan_run_status>
<result_count>
<full>10</full>
<filtered>10</filtered>
<debug>
<full>0</full>
<filtered>0</filtered>
</debug>
<hole>
<full>0</full>
<filtered>0</filtered>
</hole>
<info>
<full>7</full>
<filtered>7</filtered>
</info>
<log>
<full>0</full>
<filtered>0</filtered>
</log>
<warning>
<full>3</full>
<filtered>3</filtered>
</warning>
</result_count>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>dik mm</name>
</task>
<ports start="1"
max="-1">
<port>
general/tcp
<host>127.0.1.1</host>
<threat>Medium</threat>
</port>
...
</ports>
<results start="1"
max="-1">
<result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
<subnet>127.0.1.1</subnet>
<host>127.0.1.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.74">
<name>Test NVT: fields with ISO-8859-1 chars ()</name>
<cvss_base>5.0</cvss_base>
<risk_factor>Medium</risk_factor>
</nvt>
<threat>Medium</threat>
<description>Test with umlaut Warning Port 0.</description>
</result>
...
</results>
<scan_start>Mon Feb 1 19:11:21 2010</scan_start>
<host_start>
Mon Feb 1 19:11:21 2010
<host>127.0.1.1</host>
</host_start>
<host_end>
Mon Feb 1 19:11:52 2010
<host>127.0.1.1</host>
</host_end>
<scan_end>Mon Feb 1 19:11:52 2010</scan_end>
</report>
</report>
</get_reports_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_report_formats">7.38
Command <tt>get_report_formats</tt>
</h3></div>
<p>In short: Get all report formats.</p>
<p>
The client uses the get_report_formats command to get report format
information.
</p>
<h4>7.38.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>report_format_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single report format to get.
</li>
<li>
@<b>export</b>
(<a href="#type_boolean">boolean</a>)
Whether to get report format in importable form.
</li>
<li>
@<b>params</b>
(<a href="#type_boolean">boolean</a>)
Whether to include report format parameters.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>report_format</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the report format.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>summary</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>extension</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>content_type</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>global</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>param</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the param.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>type</b>>
<div style="margin-left: 15px; display: inline;">The type of the param.</div>
<ul style="list-style: none">
<li>
<<b>min</b>>
?<div style="margin-left: 15px; display: inline;">Minimum.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>max</b>>
?<div style="margin-left: 15px; display: inline;">Maximum.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>options</b>>
?<div style="margin-left: 15px; display: inline;">Selection options.</div>
<ul style="list-style: none"><li>
<<b>option</b>>
*<div style="margin-left: 15px; display: inline;">Option value.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
</ul>
</li>
<li>
<<b>value</b>>
<div style="margin-left: 15px; display: inline;">The value of the param.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>default</b>>
<div style="margin-left: 15px; display: inline;">The fallback value of the param.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<b>file</b>>
*<div style="margin-left: 15px; display: inline;">One of the files used to generate the report.</div>
<ul style="list-style: none"><li>
@<b>name</b>
(text)
</li></ul>
</li>
<li>
<i>The group</i><b></b><ul style="list-style: none">
<li>
<<b>trust</b>>
<div style="margin-left: 15px; display: inline;">Whether signature verification succeeded.</div>
<ul style="list-style: none">
<li>
@<b>name</b>
(text)
</li>
<li>
<<b>time</b>>
<div style="margin-left: 15px; display: inline;">The time the trust was checked.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>active</b>>
<div style="margin-left: 15px; display: inline;">Whether the report format is active.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.38.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_report_formats
= element get_report_formats
{
attribute report_format_id { uuid }?
& attribute export { boolean }?
& attribute params { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_report_formats_response
= element get_report_formats_response
{
attribute status { status }
& attribute status_text { text }
& get_report_formats_response_report_format*
}
get_report_formats_response_report_format
= element report_format
{
attribute id { uuid }
& get_report_formats_response_report_format_name
& get_report_formats_response_report_format_summary
& get_report_formats_response_report_format_description
& get_report_formats_response_report_format_extension
& get_report_formats_response_report_format_content_type
& get_report_formats_response_report_format_global
& get_report_formats_response_report_format_param*
& ( get_report_formats_response_report_format_file*
| ( get_report_formats_response_report_format_trust
& get_report_formats_response_report_format_active ) )
}
get_report_formats_response_report_format_name
= element name
{
name
}
get_report_formats_response_report_format_summary
= element summary
{
text
}
get_report_formats_response_report_format_description
= element description
{
text
}
get_report_formats_response_report_format_extension
= element extension
{
text
}
get_report_formats_response_report_format_global
= element global
{
boolean
}
get_report_formats_response_report_format_content_type
= element content_type
{
text
}
get_report_formats_response_report_format_param
= element param
{
get_report_formats_response_report_format_param_name
& get_report_formats_response_report_format_param_type
& get_report_formats_response_report_format_param_value
& get_report_formats_response_report_format_param_default
}
get_report_formats_response_report_format_param_name
= element name
{
name
}
get_report_formats_response_report_format_param_type
= element type
{
text # RNC limitation: xsd:token { pattern = "boolean|integer|selection|string|text" }
& get_report_formats_response_report_format_param_type_min?
& get_report_formats_response_report_format_param_type_max?
& get_report_formats_response_report_format_param_type_options?
}
get_report_formats_response_report_format_param_type_min
= element min
{
text
}
get_report_formats_response_report_format_param_type_max
= element max
{
text
}
get_report_formats_response_report_format_param_type_options
= element options
{
get_report_formats_response_report_format_param_type_options_option*
}
get_report_formats_response_report_format_param_type_options_option
= element option
{
text
}
get_report_formats_response_report_format_param_value
= element value
{
text
}
get_report_formats_response_report_format_param_default
= element default
{
text
}
get_report_formats_response_report_format_file
= element file
{
text # RNC limitation: base64
& attribute name { text }
}
get_report_formats_response_report_format_trust
= element trust
{
text # RNC limitation: xsd:token { pattern = "yes|no|unknown" }
& attribute name { text }
& get_report_formats_response_report_format_trust_time
}
get_report_formats_response_report_format_trust_time
= element time
{
ctime
}
get_report_formats_response_report_format_active
= element active
{
boolean
}
</pre></div>
</div>
<h4>7.38.3 Example: Get information about a report format</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats_response status="200"
status_text="OK">
<report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
<name>HTML</name>
<extension>html</extension>
<content_type>text/html</content_type>
<summary>Single page HTML report.</summary>
<description>
A single HTML page listing results of a scan. Style information
...
</description>
<global>1</global>
<trust>
no
<time>Thu Dec 2 13:22:26 2010</time>
</trust>
<active>1</active>
</report_format>
</get_report_formats_response>
</pre></div>
</div>
<h4>7.38.3 Example: Export a report format</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"
export="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats_response status="200"
status_text="OK">
<report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
<name>HTML</name>
<extension>html</extension>
<content_type>text/html</content_type>
<summary>Single page HTML report.</summary>
<description>
A single HTML page listing results of a scan. Style information
...
</description>
<global>1</global>
<file name="HTML.xsl">
PD9ldD4K
...
</file>
<file name="generate">
IyEvAk
...
</file>
<signature/>
</report_format>
</get_report_formats_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_results">7.39
Command <tt>get_results</tt>
</h3></div>
<p>In short: Get results.</p>
<p>
The client uses the get_results command to get result information.
</p>
<p>
If the request includes a notes flag, an overrides flag or an
apply_overrides flag and any of these is true, then the request
must also include a task ID.
</p>
<h4>7.39.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>result_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single result to get.
</li>
<li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
ID of task for note and override handling.
</li>
<li>
@<b>notes</b>
(<a href="#type_boolean">boolean</a>)
Whether to include notes in the result.
</li>
<li>
@<b>note_details</b>
(<a href="#type_boolean">boolean</a>)
If notes are included, whether to include note details.
</li>
<li>
@<b>overrides</b>
(<a href="#type_boolean">boolean</a>)
Whether to include overrides in the result.
</li>
<li>
@<b>override_details</b>
(<a href="#type_boolean">boolean</a>)
If overrides are included, whether to include override details.
</li>
<li>
@<b>apply_overrides</b>
(<a href="#type_boolean">boolean</a>)
Whether to override result threat levels.
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>results</b>>
<ul style="list-style: none"><li>
<<b>result</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>subnet</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
<div style="margin-left: 15px; display: inline;">NVT to which result applies.</div>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cvss_base</b>>
<div style="margin-left: 15px; display: inline;">CVSS base value associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>risk_factor</b>>
<div style="margin-left: 15px; display: inline;">Risk factor associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>cve</b>>
<div style="margin-left: 15px; display: inline;">CVE value associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>bid</b>>
<div style="margin-left: 15px; display: inline;">BID associated with the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>threat</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
<div style="margin-left: 15px; display: inline;">Description of the result.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>notes</b>>
?<div style="margin-left: 15px; display: inline;">Notes on the result.</div>
<ul style="list-style: none"><li>
<<b>note</b>>
*<ul style="list-style: none">
<li>
<<b>nvt</b>>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">The text of the note.</div>
<ul style="list-style: none"><li>
@<b>excerpt</b>
(<a href="#type_boolean">boolean</a>)
</li></ul>
</li>
<li>
<<b>orphan</b>>
<div style="margin-left: 15px; display: inline;">Whether the note is an orphan.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li>
<<b>overrides</b>>
?<div style="margin-left: 15px; display: inline;">Overrides on the result.</div>
<ul style="list-style: none"><li>
<<b>override</b>>
*<ul style="list-style: none">
<li>
<<b>nvt</b>>
<ul style="list-style: none">
<li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">The text of the override.</div>
<ul style="list-style: none"><li>
@<b>excerpt</b>
(<a href="#type_boolean">boolean</a>)
</li></ul>
</li>
<li>
<<b>threat</b>>
<div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>new_threat</b>>
<div style="margin-left: 15px; display: inline;">New threat for result.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>orphan</b>>
<div style="margin-left: 15px; display: inline;">Whether the override is an orphan.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<h4>7.39.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_results
= element get_results
{
attribute result_id { uuid }?
& attribute task_id { uuid }?
& attribute notes { boolean }?
& attribute note_details { boolean }?
& attribute overrides { boolean }?
& attribute override_details { boolean }?
& attribute apply_overrides { boolean }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_results_response
= element get_results_response
{
attribute status { status }
& attribute status_text { text }
& get_results_response_results
}
get_results_response_results
= element results
{
get_results_response_results_result*
}
get_results_response_results_result
= element result
{
attribute id { uuid }
& get_results_response_results_result_subnet
& get_results_response_results_result_host
& get_results_response_results_result_port
& get_results_response_results_result_nvt
& get_results_response_results_result_threat
& get_results_response_results_result_description
& get_results_response_results_result_notes?
& get_results_response_results_result_overrides?
}
get_results_response_results_result_subnet
= element subnet
{
text
}
get_results_response_results_result_host
= element host
{
text
}
get_results_response_results_result_port
= element port
{
text
}
get_results_response_results_result_nvt
= element nvt
{
attribute oid { oid }
& get_results_response_results_result_nvt_name
& get_results_response_results_result_nvt_cvss_base
& get_results_response_results_result_nvt_risk_factor
& get_results_response_results_result_nvt_cve
& get_results_response_results_result_nvt_bid
}
get_results_response_results_result_nvt_name
= element name
{
name
}
get_results_response_results_result_nvt_cvss_base
= element cvss_base
{
integer
}
get_results_response_results_result_nvt_risk_factor
= element risk_factor
{
integer
}
get_results_response_results_result_nvt_cve
= element cve
{
text
}
get_results_response_results_result_nvt_bid
= element bid
{
integer
}
get_results_response_results_result_threat
= element threat
{
threat
}
get_results_response_results_result_description
= element description
{
text
}
get_results_response_results_result_notes
= element notes
{
get_results_response_results_result_notes_note*
}
get_results_response_results_result_notes_note
= element note
{
get_results_response_results_result_notes_note_nvt
& get_results_response_results_result_notes_note_text
& get_results_response_results_result_notes_note_orphan
}
get_results_response_results_result_notes_note_nvt
= element nvt
{
attribute oid { oid }
& get_results_response_results_result_notes_note_nvt_name
}
get_results_response_results_result_notes_note_nvt_name
= element name
{
name
}
get_results_response_results_result_notes_note_text
= element text
{
text
& attribute excerpt { boolean }
}
get_results_response_results_result_notes_note_orphan
= element orphan
{
boolean
}
get_results_response_results_result_overrides
= element overrides
{
get_results_response_results_result_overrides_override*
}
get_results_response_results_result_overrides_override
= element override
{
get_results_response_results_result_overrides_override_nvt
& get_results_response_results_result_overrides_override_text
& get_results_response_results_result_overrides_override_threat
& get_results_response_results_result_overrides_override_new_threat
& get_results_response_results_result_overrides_override_orphan
}
get_results_response_results_result_overrides_override_nvt
= element nvt
{
attribute oid { oid }
& get_results_response_results_result_overrides_override_nvt_name
}
get_results_response_results_result_overrides_override_nvt_name
= element name
{
name
}
get_results_response_results_result_overrides_override_text
= element text
{
text
& attribute excerpt { boolean }
}
get_results_response_results_result_overrides_override_threat
= element threat
{
threat
}
get_results_response_results_result_overrides_override_new_threat
= element new_threat
{
threat
}
get_results_response_results_result_overrides_override_orphan
= element orphan
{
boolean
}
</pre></div>
</div>
<h4>7.39.3 Example: Get all results</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_results/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_results_response status="200"
status_text="OK">
<results>
<result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
<subnet>127.0.1.1</subnet>
<host>127.0.1.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.74">
<name>Test NVT: fields with ISO-8859-1 chars</name>
<cvss_base>5.0</cvss_base>
<risk_factor>Medium</risk_factor>
<cve>CVE-2009-3095</cve>
<bid>36254</bid>
</nvt>
<threat>Medium</threat>
<description>Test with umlaut.</description>
</result>
...
</results>
</get_results_response>
</pre></div>
</div>
<h4>7.39.3 Example: Get a result, including notes and overrides</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_results result_id="cac9e7c8-c726-49fd-a710-5f99079ab93e"
task_id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4"
notes="1"
overrides="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_results_response status="200"
status_text="OK">
<results>
<result id="cac9e7c8-c726-49fd-a710-5f99079ab93e">
<subnet>127.0.0.1</subnet>
<host>127.0.0.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
<cvss_base>9</cvss_base>
<risk_factor>High</risk_factor>
<cve>CVE-2009-3095</cve>
<bid>36254</bid>
</nvt>
<threat>High</threat>
<description>Test with very long warning.</description>
<original_threat>Medium</original_threat>
<notes/>
<overrides>
<override id="b0832812-75f1-45eb-b676-99c6e6bf2b24">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
</nvt>
<text excerpt="0">Test override</text>
<new_threat>High</new_threat>
<orphan>0</orphan>
</override>
</overrides>
</result>
</results>
</get_results_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_schedules">7.40
Command <tt>get_schedules</tt>
</h3></div>
<p>In short: Get all schedules.</p>
<p>
The client uses the get_schedules command to get schedule information.
</p>
<h4>7.40.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>schedule_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single schedule to get.
</li>
<li>
@<b>details</b>
(<a href="#type_boolean">boolean</a>)
Whether to include full schedule details.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>schedule</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the schedule.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the schedule.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>first_time</b>>
<div style="margin-left: 15px; display: inline;">First time the task ran or will run.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>next_time</b>>
<div style="margin-left: 15px; display: inline;">The next time the task will run.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>period</b>>
<div style="margin-left: 15px; display: inline;">How often the task will run, in seconds.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>period_months</b>>
<div style="margin-left: 15px; display: inline;">How often the task will run, months portion.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>duration</b>>
<div style="margin-left: 15px; display: inline;">How long the task will run for (0 for entire task).</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>in_use</b>>
<div style="margin-left: 15px; display: inline;">Whether any tasks are using the schedule.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>tasks</b>>
<ul style="list-style: none"><li>
<<b>task</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.40.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_schedules
= element get_schedules
{
attribute schedule_id { uuid }?
& attribute details { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_schedules_response
= element get_schedules_response
{
attribute status { status }
& attribute status_text { text }
& get_schedules_response_schedule*
}
get_schedules_response_schedule
= element schedule
{
attribute id { uuid }
& get_schedules_response_schedule_name
& ( get_schedules_response_schedule_comment
& get_schedules_response_schedule_first_time
& get_schedules_response_schedule_next_time
& get_schedules_response_schedule_period
& get_schedules_response_schedule_period_months
& get_schedules_response_schedule_duration
& get_schedules_response_schedule_in_use
& get_schedules_response_schedule_tasks )?
}
get_schedules_response_schedule_name
= element name
{
name
}
get_schedules_response_schedule_comment
= element comment
{
text
}
get_schedules_response_schedule_first_time
= element first_time
{
ctime
}
get_schedules_response_schedule_next_time
= element next_time
{
ctime
}
get_schedules_response_schedule_period
= element period
{
integer
}
get_schedules_response_schedule_period_months
= element period_months
{
integer
}
get_schedules_response_schedule_duration
= element duration
{
integer
}
get_schedules_response_schedule_in_use
= element in_use
{
boolean
}
get_schedules_response_schedule_tasks
= element tasks
{
get_schedules_response_schedule_tasks_task*
}
get_schedules_response_schedule_tasks_task
= element task
{
attribute id { uuid }
& get_schedules_response_schedule_tasks_task_name
}
get_schedules_response_schedule_tasks_task_name
= element name
{
name
}
</pre></div>
</div>
<h4>7.40.3 Example: Get all schedules</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_schedules/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_schedules_response status="200"
status_text="OK">
<schedule id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Overnight</name>
</schedule>
...
</get_schedules_response>
</pre></div>
</div>
<h4>7.40.3 Example: Get full details of a single schedule</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_schedules schedule_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
details="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_schedules_response status="200"
status_text="OK">
<schedule id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Overnight</name>
<comment>3 hours, starting at 12h00.</comment>
<first_time>Tue Jun 29 00:00:00 2010</first_time>
<next_time>Tue Jun 29 00:00:00 2010</next_time>
<period>86400</period>
<period_months>0</period_months>
<duration>10800</duration>
<in_use>1</in_use>
<tasks>
<task id="d4daf4c4-25c7-40ac-87d3-38e489f34330">
<name>kk</name>
</task>
</tasks>
</schedule>
</get_schedules_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_slaves">7.41
Command <tt>get_slaves</tt>
</h3></div>
<p>In short: Get all slaves.</p>
<p>
The client uses the get_slaves command to get slave information.
</p>
<h4>7.41.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>slave_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single slave to get.
</li>
<li>
@<b>tasks</b>
(<a href="#type_boolean">boolean</a>)
Whether to include a list of tasks using the slave.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>slave</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the slave.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the slave.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>host</b>>
<div style="margin-left: 15px; display: inline;">The host that the slave Manager is running on.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
<div style="margin-left: 15px; display: inline;">The port that the slave Manager is serving on the host.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>login</b>>
<div style="margin-left: 15px; display: inline;">Login name on the slave Manager.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>password</b>>
<div style="margin-left: 15px; display: inline;">Password for login on the slave Manager.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>in_use</b>>
<div style="margin-left: 15px; display: inline;">Whether any tasks are using the slave.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>tasks</b>>
?<ul style="list-style: none"><li>
<<b>task</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.41.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_slaves
= element get_slaves
{
attribute slave_id { uuid }?
& attribute tasks { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_slaves_response
= element get_slaves_response
{
attribute status { status }
& attribute status_text { text }
& get_slaves_response_slave*
}
get_slaves_response_slave
= element slave
{
attribute id { uuid }
& get_slaves_response_slave_name
& get_slaves_response_slave_comment
& get_slaves_response_slave_host
& get_slaves_response_slave_port
& get_slaves_response_slave_login
& get_slaves_response_slave_password
& get_slaves_response_slave_in_use
& get_slaves_response_slave_tasks?
}
get_slaves_response_slave_name
= element name
{
name
}
get_slaves_response_slave_comment
= element comment
{
text
}
get_slaves_response_slave_host
= element host
{
text
}
get_slaves_response_slave_port
= element port
{
text
}
get_slaves_response_slave_login
= element login
{
text
}
get_slaves_response_slave_password
= element password
{
text
}
get_slaves_response_slave_in_use
= element in_use
{
boolean
}
get_slaves_response_slave_tasks
= element tasks
{
get_slaves_response_slave_tasks_task*
}
get_slaves_response_slave_tasks_task
= element task
{
attribute id { uuid }
& get_slaves_response_slave_tasks_task_name
}
get_slaves_response_slave_tasks_task_name
= element name
{
name
}
</pre></div>
</div>
<h4>7.41.3 Example: Get all slaves, including task lists</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_slaves tasks="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_slaves_response status="200"
status_text="OK">
<slave id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Bangkok</name>
<comment>Manager in Bangkok department.</comment>
<host>192.0.32.10</host>
<login>sally</login>
<password>secret</password>
<tasks>
<task id="c33864a9-d3fd-44b3-8717-972bfb01dfc0">
<name>Debian desktops</name>
</task>
...
</tasks>
</slave>
...
</get_slaves_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_system_reports">7.42
Command <tt>get_system_reports</tt>
</h3></div>
<p>In short: Get all system reports.</p>
<p>
The client uses the get_system_reports command to get system reports.
</p>
<h4>7.42.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>name</b>
(text)
A string describing the required report.
</li>
<li>
@<b>duration</b>
(<a href="#type_integer">integer</a>)
The number of seconds into the past that the report should include.
</li>
<li>
@<b>brief</b>
(<a href="#type_boolean">boolean</a>)
Whether to include the actual reports.
</li>
<li>
@<b>slave_id</b>
(<a href="#type_uuid">uuid</a>)
Slave from which to get report.
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>system_report</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the system report.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>title</b>>
<div style="margin-left: 15px; display: inline;">The title of the system report.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>report</b>>
?<ul style="list-style: none">
<li>
@<b>format</b>
(<a href="#type_%22png%22">"png"</a>)
</li>
<li>
@<b>duration</b>
(<a href="#type_integer">integer</a>)
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.42.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_system_reports
= element get_system_reports
{
attribute name { text }?
& attribute duration { integer }?
& attribute brief { boolean }?
& attribute slave_id { uuid }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_system_reports_response
= element get_system_reports_response
{
attribute status { status }
& attribute status_text { text }
& get_system_reports_response_system_report*
}
get_system_reports_response_system_report
= element system_report
{
get_system_reports_response_system_report_name
& get_system_reports_response_system_report_title
& get_system_reports_response_system_report_report?
}
get_system_reports_response_system_report_name
= element name
{
name
}
get_system_reports_response_system_report_title
= element title
{
text
}
get_system_reports_response_system_report_report
= element report
{
text # RNC limitation: base64
& attribute format { "png" }
& attribute duration { integer }
}
</pre></div>
</div>
<h4>7.42.3 Example: Get listing of available system reports</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_system_reports brief="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_system_reports_response status="200"
status_text="OK">
<system_report>
<name>proc</name>
<title>Processes</title>
</system_report>
<system_report>
<name>load</name>
<title>System Load</title>
</system_report>
<system_report>
<name>cpu_0</name>
<title>CPU Usage: CPU 0</title>
</system_report>
...
</get_system_reports_response>
</pre></div>
</div>
<h4>7.42.3 Example: Get a system report</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_system_reports name="proc"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_system_reports_response status="200"
status_text="OK">
<system_report>
<name>proc</name>
<title>Processes</title>
<report format="png"
duration="86400">
iVBORw0KGgoAAAANSUhEUgAAArkAAAE...2bEdAAAAAElFTkSuQmCC
</report>
</system_report>
</get_system_reports_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_target_locators">7.43
Command <tt>get_target_locators</tt>
</h3></div>
<p>In short: Get configured target locators.</p>
<p>
The client uses the get_target_locators command to get target locators.
</p>
<h4>7.43.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>target_locator</b>>
*<ul style="list-style: none"><li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the target locator.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<h4>7.43.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_target_locators
= element get_target_locators
{
""
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_target_locators_response
= element get_target_locators_response
{
attribute status { status }
& attribute status_text { text }
& get_target_locators_response_target_locator*
}
get_target_locators_response_target_locator
= element target_locator
{
get_target_locators_response_target_locator_name
}
get_target_locators_response_target_locator_name
= element name
{
name
}
</pre></div>
</div>
<h4>7.43.3 Example: Get target locators</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_target_locators/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_target_locators_response status="200"
status_text="OK">
<target_locator>
<name>ldap</name>
</target_locator>
...
</get_target_locators_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_targets">7.44
Command <tt>get_targets</tt>
</h3></div>
<p>In short: Get all targets.</p>
<p>
The client uses the get_targets command to get target information.
</p>
<h4>7.44.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>target_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single target to get.
</li>
<li>
@<b>tasks</b>
(<a href="#type_boolean">boolean</a>)
Whether to include list of tasks that use the target.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>target</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the target.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the target.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hosts</b>>
<div style="margin-left: 15px; display: inline;">A list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>max_hosts</b>>
<div style="margin-left: 15px; display: inline;">The maximum number of hosts defined by the target.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>in_use</b>>
<div style="margin-left: 15px; display: inline;">Whether any tasks are using the target.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>ssh_lsc_credential</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid_or_empty">uuid_or_empty</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the SSH LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>smb_lsc_credential</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid_or_empty">uuid_or_empty</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the SMB LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>port_range</b>>
<div style="margin-left: 15px; display: inline;">Port range of the target.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>tasks</b>>
?<div style="margin-left: 15px; display: inline;">All tasks using the target.</div>
<ul style="list-style: none"><li>
<<b>task</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.44.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_targets
= element get_targets
{
attribute target_id { uuid }?
& attribute tasks { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_targets_response
= element get_targets_response
{
attribute status { status }
& attribute status_text { text }
& get_targets_response_target*
}
get_targets_response_target
= element target
{
get_targets_response_target_name
& get_targets_response_target_comment
& get_targets_response_target_hosts
& get_targets_response_target_max_hosts
& get_targets_response_target_in_use
& get_targets_response_target_ssh_lsc_credential
& get_targets_response_target_smb_lsc_credential
& get_targets_response_target_port_range
& get_targets_response_target_tasks?
}
get_targets_response_target_name
= element name
{
name
}
get_targets_response_target_comment
= element comment
{
text
}
get_targets_response_target_hosts
= element hosts
{
text
}
get_targets_response_target_max_hosts
= element max_hosts
{
integer
}
get_targets_response_target_in_use
= element in_use
{
boolean
}
get_targets_response_target_ssh_lsc_credential
= element ssh_lsc_credential
{
attribute id { uuid_or_empty }
& get_targets_response_target_ssh_lsc_credential_name
}
get_targets_response_target_ssh_lsc_credential_name
= element name
{
name
}
get_targets_response_target_smb_lsc_credential
= element smb_lsc_credential
{
attribute id { uuid_or_empty }
& get_targets_response_target_smb_lsc_credential_name
}
get_targets_response_target_smb_lsc_credential_name
= element name
{
name
}
get_targets_response_target_port_range
= element port_range
{
name
}
get_targets_response_target_tasks
= element tasks
{
get_targets_response_target_tasks_task*
}
get_targets_response_target_tasks_task
= element task
{
attribute id { uuid }
& get_targets_response_target_tasks_task_name
}
get_targets_response_target_tasks_task_name
= element name
{
name
}
</pre></div>
</div>
<h4>7.44.3 Example: Get all targets</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_targets/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_targets_response status="200"
status_text="OK">
<target id="b493b7a8-7489-11df-a3ec-002264764cea">
<name>Localhost</name>
<hosts>localhost</hosts>
<max_hosts>1</max_hosts>
<comment/>
<in_use>7</in_use>
<ssh_lsc_credential id="">
<name/>
</ssh_lsc_credential>
<smb_lsc_credential id="">
<name/>
</smb_lsc_credential>
</target>
...
</get_targets_response>
</pre></div>
</div>
<h4>7.44.3 Example: Get a single target, including tasks using the target</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_targets target_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
tasks="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_targets_response status="200"
status_text="OK">
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>dik</name>
<hosts>dik.example.org</hosts>
<max_hosts>1</max_hosts>
<comment>dik mm</comment>
<in_use>4</in_use>
<ssh_lsc_credential id="58ff2793-2dc7-43fe-85f9-20bfac5a87e4">
<name>mm</name>
</ssh_lsc_credential>
<smb_lsc_credential id="">
<name/>
</smb_lsc_credential>
<tasks>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>dik mm</name>
</task>
...
</tasks>
</target>
</get_targets_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_tasks">7.45
Command <tt>get_tasks</tt>
</h3></div>
<p>In short: Get all tasks.</p>
<p>
The client uses the get_tasks command to get task information.
</p>
<p>
As a convenience for clients the response includes a task count and
the values of the sort order, sort field and apply overrides flag
that the manager applied when selecting the tasks.
</p>
<h4>7.45.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single task to get.
</li>
<li>
@<b>details</b>
(<a href="#type_boolean">boolean</a>)
Whether to include full task details.
</li>
<li>
@<b>rcfile</b>
(<a href="#type_boolean">boolean</a>)
Whether to include task RC file (for openvas-client).
</li>
<li>
@<b>apply_overrides</b>
(<a href="#type_boolean">boolean</a>)
Whether to override result threat levels.
</li>
<li>
@<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
@<b>sort_field</b>
(text)
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>task_count</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>sort</b>>
<ul style="list-style: none"><li>
<<b>field</b>>
*<ul style="list-style: none"><li>
<<b>order</b>>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>apply_overrides</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>task</b>>
*<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>status</b>>
<div style="margin-left: 15px; display: inline;">The run status of the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>progress</b>>
<div style="margin-left: 15px; display: inline;">The percentage of the task that is complete.</div>
<ul style="list-style: none"><li>
<<b>host_progress</b>>
*<div style="margin-left: 15px; display: inline;">Percentage complete for a particular host.</div>
<ul style="list-style: none"><li>
<<b>host</b>>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
<li>
<<b>config</b>>
<div style="margin-left: 15px; display: inline;">The scan configuration used by the task.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the config.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>target</b>>
<div style="margin-left: 15px; display: inline;">The hosts scanned by the task.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the target.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>escalator</b>>
<div style="margin-left: 15px; display: inline;">An escalator that applies to the task.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid_or_empty">uuid_or_empty</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the escalator.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>schedule</b>>
<div style="margin-left: 15px; display: inline;">When the task will run.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid_or_empty">uuid_or_empty</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the schedule.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>slave</b>>
<div style="margin-left: 15px; display: inline;">The slave that the task will run on.</div>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the slave.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>report_count</b>>
<div style="margin-left: 15px; display: inline;">Number of reports.</div>
<ul style="list-style: none"><li>
<<b>finished</b>>
<div style="margin-left: 15px; display: inline;">Number of reports where the scan completed.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>trend</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>first_report</b>>
?<ul style="list-style: none"><li>
<<b>report</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>timestamp</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result_count</b>>
<div style="margin-left: 15px; display: inline;">Result counts for this report.</div>
<ul style="list-style: none">
<li>
<<b>debug</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>log</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>info</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>warning</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hole</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li></ul>
</li>
<li>
<<b>last_report</b>>
?<ul style="list-style: none"><li>
<<b>report</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>timestamp</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result_count</b>>
<div style="margin-left: 15px; display: inline;">Result counts for this report.</div>
<ul style="list-style: none">
<li>
<<b>debug</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>log</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>info</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>warning</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hole</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li></ul>
</li>
<li>
<<b>second_last_report</b>>
?<ul style="list-style: none"><li>
<<b>report</b>>
<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>timestamp</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result_count</b>>
<div style="margin-left: 15px; display: inline;">Result counts for this report.</div>
<ul style="list-style: none">
<li>
<<b>debug</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>log</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>info</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>warning</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hole</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li></ul>
</li>
<li>
<<b>rcfile</b>>
?<ul style="list-style: none"></ul>
</li>
<li>
<<b>reports</b>>
*<ul style="list-style: none"><li>
<<b>report</b>>
*<ul style="list-style: none">
<li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
<<b>timestamp</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>scan_run_status</b>>
<div style="margin-left: 15px; display: inline;">Run status of task scan.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result_count</b>>
<div style="margin-left: 15px; display: inline;">Result counts for this report.</div>
<ul style="list-style: none">
<li>
<<b>debug</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>log</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>info</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>warning</b>>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>hole</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>7.45.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_tasks
= element get_tasks
{
attribute task_id { uuid }?
& attribute details { boolean }?
& attribute rcfile { boolean }?
& attribute apply_overrides { boolean }?
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_tasks_response
= element get_tasks_response
{
attribute status { status }
& attribute status_text { text }
& get_tasks_response_task_count
& get_tasks_response_sort
& get_tasks_response_apply_overrides
& get_tasks_response_task*
}
get_tasks_response_task_count
= element task_count
{
integer
}
get_tasks_response_sort
= element sort
{
get_tasks_response_sort_field*
}
get_tasks_response_sort_field
= element field
{
text
& get_tasks_response_sort_field_order
}
get_tasks_response_sort_field_order
= element order
{
xsd:token { pattern = "ascending|descending" }
}
get_tasks_response_apply_overrides
= element apply_overrides
{
xsd:token { pattern = "0|1" }
}
get_tasks_response_task
= element task
{
get_tasks_response_task_name
& get_tasks_response_task_comment
& get_tasks_response_task_status
& get_tasks_response_task_progress
& get_tasks_response_task_config
& get_tasks_response_task_target
& get_tasks_response_task_escalator
& get_tasks_response_task_schedule
& get_tasks_response_task_slave
& get_tasks_response_task_report_count
& get_tasks_response_task_trend
& get_tasks_response_task_first_report?
& get_tasks_response_task_last_report?
& get_tasks_response_task_second_last_report?
& get_tasks_response_task_rcfile?
& get_tasks_response_task_reports*
}
get_tasks_response_task_name
= element name
{
name
}
get_tasks_response_task_comment
= element comment
{
text
}
get_tasks_response_task_status
= element status
{
task_status
}
get_tasks_response_task_progress
= element progress
{
text # RNC limitation: integer
& get_tasks_response_task_progress_host_progress*
}
get_tasks_response_task_progress_host_progress
= element host_progress
{
text # RNC limitation: integer
& get_tasks_response_task_progress_host_progress_host
}
get_tasks_response_task_progress_host_progress_host
= element host
{
text
}
get_tasks_response_task_config
= element config
{
attribute id { uuid }
& get_tasks_response_task_config_name
}
get_tasks_response_task_config_name
= element name
{
name
}
get_tasks_response_task_target
= element target
{
attribute id { uuid }
& get_tasks_response_task_target_name
}
get_tasks_response_task_target_name
= element name
{
name
}
get_tasks_response_task_escalator
= element escalator
{
attribute id { uuid_or_empty }
& get_tasks_response_task_escalator_name
}
get_tasks_response_task_escalator_name
= element name
{
name
}
get_tasks_response_task_schedule
= element schedule
{
attribute id { uuid_or_empty }
& get_tasks_response_task_schedule_name
}
get_tasks_response_task_schedule_name
= element name
{
name
}
get_tasks_response_task_slave
= element slave
{
attribute id { uuid }
& get_tasks_response_task_slave_name
}
get_tasks_response_task_slave_name
= element name
{
name
}
get_tasks_response_task_report_count
= element report_count
{
text # RNC limitation: integer
& get_tasks_response_task_report_count_finished
}
get_tasks_response_task_report_count_finished
= element finished
{
integer
}
get_tasks_response_task_trend
= element trend
{
task_trend
}
get_tasks_response_task_first_report
= element first_report
{
get_tasks_response_task_first_report_report
}
get_tasks_response_task_first_report_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_first_report_report_timestamp
& get_tasks_response_task_first_report_report_result_count
}
get_tasks_response_task_first_report_report_timestamp
= element timestamp
{
ctime
}
get_tasks_response_task_first_report_report_result_count
= element result_count
{
get_tasks_response_task_first_report_report_result_count_debug
& get_tasks_response_task_first_report_report_result_count_log
& get_tasks_response_task_first_report_report_result_count_info
& get_tasks_response_task_first_report_report_result_count_warning
& get_tasks_response_task_first_report_report_result_count_hole
}
get_tasks_response_task_first_report_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_first_report_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_first_report_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_first_report_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_first_report_report_result_count_hole
= element hole
{
integer
}
get_tasks_response_task_last_report
= element last_report
{
get_tasks_response_task_last_report_report
}
get_tasks_response_task_last_report_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_last_report_report_timestamp
& get_tasks_response_task_last_report_report_result_count
}
get_tasks_response_task_last_report_report_timestamp
= element timestamp
{
ctime
}
get_tasks_response_task_last_report_report_result_count
= element result_count
{
get_tasks_response_task_last_report_report_result_count_debug
& get_tasks_response_task_last_report_report_result_count_log
& get_tasks_response_task_last_report_report_result_count_info
& get_tasks_response_task_last_report_report_result_count_warning
& get_tasks_response_task_last_report_report_result_count_hole
}
get_tasks_response_task_last_report_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_last_report_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_last_report_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_last_report_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_last_report_report_result_count_hole
= element hole
{
integer
}
get_tasks_response_task_second_last_report
= element second_last_report
{
get_tasks_response_task_second_last_report_report
}
get_tasks_response_task_second_last_report_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_second_last_report_report_timestamp
& get_tasks_response_task_second_last_report_report_result_count
}
get_tasks_response_task_second_last_report_report_timestamp
= element timestamp
{
ctime
}
get_tasks_response_task_second_last_report_report_result_count
= element result_count
{
get_tasks_response_task_second_last_report_report_result_count_debug
& get_tasks_response_task_second_last_report_report_result_count_log
& get_tasks_response_task_second_last_report_report_result_count_info
& get_tasks_response_task_second_last_report_report_result_count_warning
& get_tasks_response_task_second_last_report_report_result_count_hole
}
get_tasks_response_task_second_last_report_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_second_last_report_report_result_count_hole
= element hole
{
integer
}
get_tasks_response_task_rcfile
= element rcfile
{
base64
}
get_tasks_response_task_reports
= element reports
{
get_tasks_response_task_reports_report*
}
get_tasks_response_task_reports_report
= element report
{
attribute id { uuid }
& get_tasks_response_task_reports_report_timestamp
& get_tasks_response_task_reports_report_scan_run_status
& get_tasks_response_task_reports_report_result_count
}
get_tasks_response_task_reports_report_timestamp
= element timestamp
{
ctime
}
get_tasks_response_task_reports_report_scan_run_status
= element scan_run_status
{
task_status
}
get_tasks_response_task_reports_report_result_count
= element result_count
{
get_tasks_response_task_reports_report_result_count_debug
& get_tasks_response_task_reports_report_result_count_log
& get_tasks_response_task_reports_report_result_count_info
& get_tasks_response_task_reports_report_result_count_warning
& get_tasks_response_task_reports_report_result_count_hole
}
get_tasks_response_task_reports_report_result_count_debug
= element debug
{
integer
}
get_tasks_response_task_reports_report_result_count_log
= element log
{
integer
}
get_tasks_response_task_reports_report_result_count_info
= element info
{
integer
}
get_tasks_response_task_reports_report_result_count_warning
= element warning
{
integer
}
get_tasks_response_task_reports_report_result_count_hole
= element hole
{
integer
}
</pre></div>
</div>
<h4>7.45.3 Example: Get all tasks</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_tasks/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_tasks_response status="200"
status_text="OK">
<task_count>2</task_count>
<sort>
<field>
ROWID
<order>ascending</order>
</field>
</sort>
<apply_overrides>0</apply_overrides>
<task id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<name>Scan Webserver</name>
<comment>Scan of the web server.</comment>
<status>Done</status>
<progress>-1</progress>
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
</config>
<escalator id="">
<name/>
</escalator>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>dik</name>
</target>
<schedule id="">
<name/>
<next_time>over</next_time>
</schedule>
<slave id="">
<name/>
</slave>
<report_count>
2
<finished>2</finished>
</report_count>
<trend/>
<first_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
</first_report>
<last_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
</last_report>
<second_last_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
</second_last_report>
</task>
<task id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c">
<name>Scan Mailserver</name>
...
</task>
</get_tasks_response>
</pre></div>
</div>
<h4>7.45.3 Example: Get a single task, including all reports</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_tasks task_id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c"
details="1"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_tasks_response status="200"
status_text="OK">
<task_count>1</task_count>
<sort>
<field>
ROWID
<order>ascending</order>
</field>
</sort>
<apply_overrides>0</apply_overrides>
<task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>Scan Mailserver</name>
<comment>Scan of the web server.</comment>
<status>Done</status>
<progress>-1</progress>
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
</config>
<escalator id="">
<name/>
</escalator>
<target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
<name>dik</name>
</target>
<schedule id="">
<name/>
<next_time>over</next_time>
</schedule>
<slave id="">
<name/>
</slave>
<report_count>
2
<finished>2</finished>
</report_count>
<trend/>
<first_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
</first_report>
<last_report>
<report id="2688e6c7-db29-4505-80f1-0fd4a09e1011">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
</last_report>
<second_last_report>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
</second_last_report>
<reports>
<report id="f0fdf522-276d-4893-9274-fb8699dc2270">
<timestamp>Mon Feb 1 18:51:38 2010</timestamp>
<scan_run_status>Done</scan_run_status>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
<report id="2688e6c7-db29-4505-80f1-0fd4a09e1011">
<timestamp>Mon Feb 1 19:11:20 2010</timestamp>
<scan_run_status>Done</scan_run_status>
<result_count>
<debug>0</debug>
<hole>0</hole>
<info>7</info>
<log>0</log>
<warning>3</warning>
</result_count>
</report>
</reports>
</task>
</get_tasks_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_get_version">7.46
Command <tt>get_version</tt>
</h3></div>
<p>In short: Get the OpenVAS Manager Protocol version.</p>
<h4>7.46.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>version</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
<h4>7.46.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_version
= element get_version
{
""
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>get_version_response
= element get_version_response
{
attribute status { status }
& attribute status_text { text }
& get_version_response_version
}
get_version_response_version
= element version
{
text
}
</pre></div>
</div>
<h4>7.46.3 Example: Get the version</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_version/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_version_response status="200"
status_text="OK">
<version>1.0</version>
</get_version_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_help">7.47
Command <tt>help</tt>
</h3></div>
<p>In short: Get the help text.</p>
<h4>7.47.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>format</b>
("html", "HTML", "rnc", "RNC", "text", "TEXT", "xml" or "XML")
Required help format.
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
<li>
<<b>schema</b>>
?<ul style="list-style: none"><li>
<<b>protocol</b>>
<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The full name of the protocol.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>abbreviation</b>>
?<div style="margin-left: 15px; display: inline;">The abbreviated name of the protocol.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>summary</b>>
?<div style="margin-left: 15px; display: inline;">A summary of the protocol.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>version</b>>
?<div style="margin-left: 15px; display: inline;">The version number of the protocol.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>type</b>>
*<div style="margin-left: 15px; display: inline;">A data type.</div>
<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the data type.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>summary</b>>
?<div style="margin-left: 15px; display: inline;">A summary of the data type.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>description</b>>
?<div style="margin-left: 15px; display: inline;">A description of the data type.</div>
<ul style="list-style: none"><li>
<<b>p</b>>
*<div style="margin-left: 15px; display: inline;">A paragraph.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<<b>pattern</b>>
<div style="margin-left: 15px; display: inline;">The RNC pattern for the data type.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>command</b>>
*<div style="margin-left: 15px; display: inline;">(<a href="#element_command_definition">command_definition</a>)</div>
<div style="margin-left: 15px; display: inline;">A command.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<h4>7.47.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>help
= element help
{
attribute format { xsd:token { pattern = "html|HTML|rnc|RNC|text|TEXT|xml|XML" } }?
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>help_response
= element help_response
{
text
& attribute status { status }
& attribute status_text { text }
& help_response_schema?
}
help_response_schema
= element schema
{
help_response_schema_protocol
}
help_response_schema_protocol
= element protocol
{
help_response_schema_protocol_name
& help_response_schema_protocol_abbreviation?
& help_response_schema_protocol_summary?
& help_response_schema_protocol_version?
& help_response_schema_protocol_type*
& help_response_schema_protocol_command*
}
help_response_schema_protocol_name
= element name
{
text
}
help_response_schema_protocol_abbreviation
= element abbreviation
{
text
}
help_response_schema_protocol_summary
= element summary
{
text
}
help_response_schema_protocol_version
= element version
{
text
}
help_response_schema_protocol_type
= element type
{
help_response_schema_protocol_type_name
& help_response_schema_protocol_type_summary?
& help_response_schema_protocol_type_description?
& help_response_schema_protocol_type_pattern
}
help_response_schema_protocol_type_name
= element name
{
type_name
}
help_response_schema_protocol_type_summary
= element summary
{
text
}
help_response_schema_protocol_type_description
= element description
{
text
& help_response_schema_protocol_type_description_p*
}
help_response_schema_protocol_type_description_p
= element p
{
text
}
help_response_schema_protocol_type_pattern
= element pattern
{
text
}
help_response_schema_protocol_command
= element command # type command_definition
{
command_definition_name
& command_definition_summary?
& command_definition_description?
& ( ( command_definition_pattern
& command_definition_response )
| ( command_definition_type
& command_definition_ele* ) )
& command_definition_example*
}
</pre></div>
</div>
<h4>7.47.3 Example: Get the help text</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <help/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <help_response status="200"
status_text="OK">
AUTHENTICATE Authenticate with the manager.
COMMANDS Run a list of commands.
CREATE_AGENT Create an agent.
CREATE_CONFIG Create a config.
CREATE_ESCALATOR Create an escalator.
CREATE_LSC_CREDENTIAL Create a local security check credential.
CREATE_NOTE Create a note.
CREATE_OVERRIDE Create an override.
CREATE_REPORT_FORMAT Create a report format.
CREATE_SCHEDULE Create a schedule.
CREATE_SLAVE Create a slave.
CREATE_TARGET Create a target.
CREATE_TASK Create a task.
DELETE_AGENT Delete an agent.
DELETE_CONFIG Delete a config.
DELETE_ESCALATOR Delete an escalator.
DELETE_LSC_CREDENTIAL Delete a local security check credential.
DELETE_NOTE Delete a note.
DELETE_OVERRIDE Delete an override.
DELETE_REPORT Delete a report.
DELETE_REPORT_FORMAT Delete a report format.
DELETE_SCHEDULE Delete a schedule.
DELETE_SLAVE Delete a slave.
DELETE_TARGET Delete a target.
DELETE_TASK Delete a task.
GET_AGENTS Get all agents.
GET_CONFIGS Get all configs.
GET_DEPENDENCIES Get dependencies for all available NVTs.
GET_ESCALATORS Get all escalators.
GET_LSC_CREDENTIALS Get all local security check credentials.
GET_NOTES Get all notes.
GET_NVTS Get one or all available NVTs.
GET_NVT_FAMILIES Get a list of all NVT families.
GET_NVT_FEED_CHECKSUM Get checksum for entire NVT collection.
GET_OVERRIDES Get all overrides.
GET_PREFERENCES Get preferences for all available NVTs.
GET_REPORTS Get all reports.
GET_REPORT_FORMATS Get all report formats.
GET_RESULTS Get results.
GET_SCHEDULES Get all schedules.
GET_SLAVES Get all slaves.
GET_SYSTEM_REPORTS Get all system reports.
GET_TARGET_LOCATORS Get configured target locators.
GET_TARGETS Get all targets.
GET_TASKS Get all tasks.
GET_VERSION Get the OpenVAS Manager Protocol version.
HELP Get this help text.
MODIFY_CONFIG Update an existing config.
MODIFY_LSC_CREDENTIAL Modify an existing LSC credential.
MODIFY_NOTE Modify an existing note.
MODIFY_OVERRIDE Modify an existing override.
MODIFY_REPORT Modify an existing report.
MODIFY_REPORT_FORMAT Modify an existing report format.
MODIFY_TASK Update an existing task.
PAUSE_TASK Pause a running task.
RESUME_OR_START_TASK Resume task if stopped, else start task.
RESUME_PAUSED_TASK Resume a paused task.
RESUME_STOPPED_TASK Resume a stopped task.
START_TASK Manually start an existing task.
STOP_TASK Stop a running task.
TEST_ESCALATOR Run an escalator.
VERIFY_AGENT Verify an agent.
VERIFY_REPORT_FORMAT Verify a report format.
</help_response>
</pre></div>
</div>
<h4>7.47.3 Example: Get the OMP schema</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <help format="XML"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <help_response status="200"
status_text="OK">
<schema format="XML"
extension="xml"
content_type="text/xml">
<protocol>
<name>OpenVAS Management Protocol</name>
<abbreviation>OMP</abbreviation>
<summary>
The "management" protocol of the Open Vulnerability Assessment System
</summary>
<version>1.0</version>
<type>
<name>base64</name>
<summary>Base64 encoded data</summary>
<pattern>xsd:base64Binary</pattern>
</type>
...
<command>
<name>authenticate</name>
<summary>Authenticate with the manager</summary>
<description>
<p>
The client uses the authenticate command to authenticate with the
Manager.
</p>
<p>
The client normally executes this command at the beginning of each
connection. The only commands permitted before authentication are
get_version and commands.
</p>
</description>
<pattern>
<e>credentials</e>
</pattern>
<ele>
<name>credentials</name>
<pattern>
<e>username</e>
<e>password</e>
</pattern>
<ele>
<name>username</name>
<summary>The login name of the user</summary>
<pattern>text</pattern>
</ele>
<ele>
<name>password</name>
<summary>The user's password</summary>
<pattern>text</pattern>
</ele>
</ele>
<response>
<pattern>
<attrib>
<name>status</name>
<type>status</type>
<required>1</required>
</attrib>
<attrib>
<name>status_text</name>
<type>text</type>
<required>1</required>
</attrib>
</pattern>
</response>
<example>
<summary>Authenticate with a good password</summary>
<request>
<authenticate>
<credentials>
<username>sally</username>
<password>secret</password>
</credentials>
</authenticate>
</request>
<response>
<authenticate_response status="200"
status_text="OK"/>
</response>
</example>
...
</command>
...
</protocol>
</schema>
</help_response>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_config">7.48
Command <tt>modify_config</tt>
</h3></div>
<p>In short: Update an existing config.</p>
<p>
This command can take three forms: with a preference, with a family selection
or with an NVT selection.
</p>
<p>
The first form modifies a preference on the config.
If the preference includes an NVT, then the preference is an NVT preference,
otherwise the preference is a scanner preference. If the preference includes
a value then the manager updates the value of the preference, otherwise the
manager removes the preference.
</p>
<p>
The second form, with a family selection, lets the client modify the
NVTs selected by the config at a family level. The idea is that the
client modifies the entire family selection at once, so a client will
often need to include many families in a family selection.
</p>
<p>
The family_selection may include a growing element to indicate whether new
families should be added to the selection. It may also include any number
of family elements.
</p>
<p>
A family element must always include a name and may include a growing element
and an all element. The all element indicates whether all NVTs in the family
should be selected. The growing element indicates whether new NVTs in the
family should be added to the selection as they arrive. Leaving a family
out of the family_selection is equivalent to including the family with all
0 and growing 0.
</p>
<p>
The effect of the all 0 and growing 0 case is subtle: if
all NVTs were selected then all are removed (effectively removing the
family from the config). However if some NVTs were selected then they
remain selected. As a result the client must include in the
family_selection all families that must have all NVTs selected.
</p>
<p>
The third option, an NVT selection, must include a family and may include any
number of NVTs. The manager updates the given family in the config to
include only the given NVTs.
</p>
<p>
If there was no error with the command sent by the client, the manager will
apply the changes to the config and will reply with a response code indicating
success.
</p>
<h4>7.48.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
ID of config to modify.
</li>
<li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<b>preference</b>>
<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the preference to modify.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
?<div style="margin-left: 15px; display: inline;">NVT associated with preference to modify.</div>
<ul style="list-style: none"><li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
<li>
<<b>value</b>>
?<div style="margin-left: 15px; display: inline;">New value for preference.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
<<b>family_selection</b>>
<ul style="list-style: none">
<li>
<<b>growing</b>>
?<div style="margin-left: 15px; display: inline;">Whether new families should be added to the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>family</b>>
*<ul style="list-style: none">
<li>
<<b>all</b>>
?<div style="margin-left: 15px; display: inline;">Whether to select all NVTs initially.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>growing</b>>
?<div style="margin-left: 15px; display: inline;">Whether to add newly arrived nvts to the selection.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>name</b>>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
<<b>nvt_selection</b>>
<ul style="list-style: none">
<li>
<<b>family</b>>
<div style="margin-left: 15px; display: inline;">Name of family to modify.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>nvt</b>>
*<ul style="list-style: none"><li>
@<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.48.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_config
= element modify_config
{
attribute config_id { uuid }
& ( modify_config_preference
| modify_config_family_selection
| modify_config_nvt_selection )
}
modify_config_preference
= element preference
{
modify_config_preference_name
& modify_config_preference_nvt?
& modify_config_preference_value?
}
modify_config_preference_name
= element name
{
name
}
modify_config_preference_nvt
= element nvt
{
attribute oid { oid }
}
modify_config_preference_value
= element value
{
base64
}
modify_config_family_selection
= element family_selection
{
modify_config_family_selection_growing?
& modify_config_family_selection_family*
}
modify_config_family_selection_growing
= element growing
{
boolean_atoi
}
modify_config_family_selection_family
= element family
{
modify_config_family_selection_family_all?
& modify_config_family_selection_family_growing?
& modify_config_family_selection_family_name
}
modify_config_family_selection_family_all
= element all
{
boolean_atoi
}
modify_config_family_selection_family_growing
= element growing
{
boolean_atoi
}
modify_config_family_selection_family_name
= element name
{
name
}
modify_config_nvt_selection
= element nvt_selection
{
modify_config_nvt_selection_family
& modify_config_nvt_selection_nvt*
}
modify_config_nvt_selection_family
= element family
{
name
}
modify_config_nvt_selection_nvt
= element nvt
{
attribute oid { oid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>modify_config_response
= element modify_config_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.48.3 Example: Modify a config preference</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.14259"/>
<name>Nmap (NASL wrapper)[checkbox]:UDP port scan</name>
<value>eWVz</value>
</preference>
</modify_config>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config_response status="200"
status_text="OK"/>
</pre></div>
</div>
<h4>7.48.3 Example: Modify the families that a config selects</h4>
<p>
The outer "growing" element sets the config to add any new families
that arrive.
</p>
<p>
The client requests the Manager to keep a single selected
family (Debian Local Security Checks), to select all NVTs in
this family, and to automatically add any new NVTs in this family
to the config.
</p>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<family_selection>
<growing>1</growing>
<family>
<name>Debian Local Security Checks</name>
<all>1</all>
<growing>1</growing>
</family>
</family_selection>
</modify_config>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config_response status="200"
status_text="OK"/>
</pre></div>
</div>
<h4>7.48.3 Example: Modify the NVTs that a config selects in a particular family</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<nvt_selection>
<family>Debian Local Security Checks</family>
<nvt oid="1.3.6.1.4.1.25623.1.0.53797"/>
<nvt oid="1.3.6.1.4.1.25623.1.0.63272"/>
<nvt oid="1.3.6.1.4.1.25623.1.0.55615"/>
<nvt oid="1.3.6.1.4.1.25623.1.0.53546"/>
</nvt_selection>
</modify_config>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_lsc_credential">7.49
Command <tt>modify_lsc_credential</tt>
</h3></div>
<p>In short: Modify an existing LSC credential.</p>
<p>
The client uses the modify_lsc_credential command to change an
existing LSC credential.
</p>
<p>
The login and password can only be changed for password LSC credentials.
Modification of login or password on package credentials is forbidden.
</p>
<h4>7.49.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>lsc_credential_id</b>
(<a href="#type_uuid">uuid</a>)
ID of LSC credential to modify.
</li>
<li>
<<b>comment</b>>
?<div style="margin-left: 15px; display: inline;">A comment on the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>name</b>>
?<div style="margin-left: 15px; display: inline;">A name for the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>password</b>>
?<div style="margin-left: 15px; display: inline;">The password for the credential login.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>login</b>>
?<div style="margin-left: 15px; display: inline;">The user name of the credential.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.49.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_lsc_credential
= element modify_lsc_credential
{
attribute lsc_credential_id { uuid }
& modify_lsc_credential_comment?
& modify_lsc_credential_name?
& modify_lsc_credential_password?
& modify_lsc_credential_login?
}
modify_lsc_credential_name
= element name
{
name
}
modify_lsc_credential_comment
= element comment
{
text
}
modify_lsc_credential_login
= element login
{
text
}
modify_lsc_credential_password
= element password
{
text
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>modify_lsc_credential_response
= element modify_lsc_credential_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.49.3 Example: Modify the comment of an LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_lsc_credential lsc_credential_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Credential for all machines in lab 4.</comment>
</modify_lsc_credential>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_lsc_credential_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_note">7.50
Command <tt>modify_note</tt>
</h3></div>
<p>In short: Modify an existing note.</p>
<p>
The client uses the modify_note command to change an existing note.
</p>
<p>
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
<h4>7.50.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>note_id</b>
(<a href="#type_uuid">uuid</a>)
ID of note to modify.
</li>
<li>
<<b>hosts</b>>
?<div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
?<div style="margin-left: 15px; display: inline;">Port to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result</b>>
?<div style="margin-left: 15px; display: inline;">Result to which note applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>task</b>>
?<div style="margin-left: 15px; display: inline;">Task to which note applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">The text of the note.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>threat</b>>
?<div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.50.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_note
= element modify_note
{
attribute note_id { uuid }
& modify_note_hosts?
& modify_note_port?
& modify_note_result?
& modify_note_task?
& modify_note_text
& modify_note_threat?
}
modify_note_hosts
= element hosts
{
text
}
modify_note_port
= element port
{
text
}
modify_note_text
= element text
{
text
}
modify_note_threat
= element threat
{
threat
}
modify_note_task
= element task
{
attribute id { uuid }
}
modify_note_result
= element result
{
attribute id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>modify_note_response
= element modify_note_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.50.3 Example: Modify the text and result of a note</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_note note_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<text>This issue should be resolved after the upgrade.</text>
<result result_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c"/>
</modify_note>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_note_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_override">7.51
Command <tt>modify_override</tt>
</h3></div>
<p>In short: Modify an existing override.</p>
<p>
The client uses the modify_override command to change an existing
override.
</p>
<p>
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
<h4>7.51.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>override_id</b>
(<a href="#type_uuid">uuid</a>)
ID of override to modify.
</li>
<li>
<<b>hosts</b>>
?<div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>new_threat</b>>
?<div style="margin-left: 15px; display: inline;">New threat level for result.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>port</b>>
?<div style="margin-left: 15px; display: inline;">Port to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>result</b>>
?<div style="margin-left: 15px; display: inline;">Result to which override applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>task</b>>
?<div style="margin-left: 15px; display: inline;">Task to which override applies.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>text</b>>
<div style="margin-left: 15px; display: inline;">Text describing the override.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>threat</b>>
?<div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.51.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_override
= element modify_override
{
attribute override_id { uuid }
& modify_override_hosts?
& modify_override_new_threat?
& modify_override_port?
& modify_override_result?
& modify_override_task?
& modify_override_text
& modify_override_threat?
}
modify_override_hosts
= element hosts
{
text
}
modify_override_new_threat
= element new_threat
{
threat
}
modify_override_port
= element port
{
text
}
modify_override_text
= element text
{
text
}
modify_override_threat
= element threat
{
threat
}
modify_override_task
= element task
{
attribute id { uuid }
}
modify_override_result
= element result
{
attribute id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>modify_override_response
= element modify_override_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.51.3 Example: Set the override threat to Low</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_override override_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<text>This issue is less important in our setup.</text>
<new_threat>Low</new_threat>
</modify_override>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_override_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_report">7.52
Command <tt>modify_report</tt>
</h3></div>
<p>In short: Modify an existing report.</p>
<p>
The client uses the modify_report command to change an existing
report.
</p>
<h4>7.52.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>report_id</b>
(<a href="#type_uuid">uuid</a>)
ID of report to modify.
</li>
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the report.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.52.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_report
= element modify_report
{
attribute report_id { uuid }
& modify_report_comment
}
modify_report_comment
= element comment
{
text
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>modify_report_response
= element modify_report_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.52.3 Example: Modify a report comment</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report report_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
</modify_report>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_report_format">7.53
Command <tt>modify_report_format</tt>
</h3></div>
<p>In short: Update an existing report format.</p>
<p>
The client uses the modify_report_format command to change an existing
report format.
</p>
<h4>7.53.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>report_format_id</b>
(<a href="#type_uuid">uuid</a>)
ID of report format to modify.
</li>
<li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<b>active</b>>
<div style="margin-left: 15px; display: inline;">Whether the report format is active.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the report format.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>summary</b>>
<div style="margin-left: 15px; display: inline;">A summary of the report format.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>param</b>>
<ul style="list-style: none">
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the param.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>value</b>>
?<div style="margin-left: 15px; display: inline;">New value for the param.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.53.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_report_format
= element modify_report_format
{
attribute report_format_id { uuid }
& ( modify_report_format_active
| modify_report_format_name
| modify_report_format_summary
| modify_report_format_param )
}
modify_report_format_active
= element active
{
boolean
}
modify_report_format_name
= element name
{
name
}
modify_report_format_summary
= element summary
{
text
}
modify_report_format_param
= element param
{
modify_report_format_param_name
& modify_report_format_param_value?
}
modify_report_format_param_name
= element name
{
name
}
modify_report_format_param_value
= element value
{
base64
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>modify_report_format_response
= element modify_report_format_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.53.3 Example: Modify a report format param</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<param>
<name>Background Colour</name>
<value>cmVk</value>
</param>
</modify_report_format>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format_response status="200"
status_text="OK"/>
</pre></div>
</div>
<h4>7.53.3 Example: Modify the name of a report format</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<name>New name</name>
</modify_report_format>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_task">7.54
Command <tt>modify_task</tt>
</h3></div>
<p>In short: Modify an existing task.</p>
<p>
The client uses the modify_task command to change an existing
task.
</p>
<h4>7.54.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
<li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
ID of task to modify.
</li>
<li>
<i>One of</i><b></b><ul style="list-style: none">
<li>
<<b>comment</b>>
<div style="margin-left: 15px; display: inline;">The comment on the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>escalator</b>>
<div style="margin-left: 15px; display: inline;">Task escalator.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>name</b>>
<div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>rcfile</b>>
<div style="margin-left: 15px; display: inline;">An openvasrc style file describing the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<<b>schedule</b>>
<div style="margin-left: 15px; display: inline;">Task schedule.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>slave</b>>
<div style="margin-left: 15px; display: inline;">Task slave.</div>
<ul style="list-style: none"><li>
@<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
<<b>file</b>>
<div style="margin-left: 15px; display: inline;">File to attach to task.</div>
<ul style="list-style: none">
<li>
@<b>name</b>
(text)
</li>
<li>
@<b>action</b>
("update" or "remove")
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.54.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_task
= element modify_task
{
attribute task_id { uuid }
& ( modify_task_comment
| modify_task_escalator
| modify_task_name
| modify_task_rcfile
| modify_task_schedule
| modify_task_slave
| modify_task_file )
}
modify_task_comment
= element comment
{
text
}
modify_task_escalator
= element escalator
{
attribute id { uuid }
}
modify_task_name
= element name
{
name
}
modify_task_rcfile
= element rcfile
{
base64
}
modify_task_schedule
= element schedule
{
attribute id { uuid }
}
modify_task_slave
= element slave
{
attribute id { uuid }
}
modify_task_file
= element file
{
text # RNC limitation: base64
& attribute name { text }
& attribute action { xsd:token { pattern = "update|remove" } }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>modify_task_response
= element modify_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.54.3 Example: Modify a task comment</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
</modify_task>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_pause_task">7.55
Command <tt>pause_task</tt>
</h3></div>
<p>In short: Pause a running task.</p>
<p>
The client uses the pause_task command to manually pause a running task.
</p>
<h4>7.55.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.55.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>pause_task
= element pause_task
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>pause_task_response
= element pause_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.55.3 Example: Pause a running task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <pause_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <pause_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_resume_or_start_task">7.56
Command <tt>resume_or_start_task</tt>
</h3></div>
<p>In short: Resume task if stopped, else start task.</p>
<p>
The client uses the resume_or_start_task command to manually start
an existing task, ensuring that the task will resume from its
previous position if the task is in the Stopped state.
</p>
<h4>7.56.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.56.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>resume_or_start_task
= element resume_or_start_task
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>resume_or_start_task_response
= element resume_or_start_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.56.3 Example: Resume a running task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_or_start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_or_start_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_resume_paused_task">7.57
Command <tt>resume_paused_task</tt>
</h3></div>
<p>In short: Resume a paused task.</p>
<p>
The client uses the resume_paused_task command to manually resume a
paused task.
</p>
<h4>7.57.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.57.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>resume_paused_task
= element resume_paused_task
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>resume_paused_task_response
= element resume_paused_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.57.3 Example: Resume a paused task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_paused_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_paused_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_resume_stopped_task">7.58
Command <tt>resume_stopped_task</tt>
</h3></div>
<p>In short: Resume a stopped task.</p>
<p>
The client uses the resume_stopped_task command to manually resume a
stopped task.
</p>
<h4>7.58.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.58.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>resume_stopped_task
= element resume_stopped_task
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>resume_stopped_task_response
= element resume_stopped_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.58.3 Example: Resume a stopped task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_stopped_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_stopped_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_start_task">7.59
Command <tt>start_task</tt>
</h3></div>
<p>In short: Manually start an existing task.</p>
<p>
The client uses the start_task command to manually start an
existing task.
</p>
<h4>7.59.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.59.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>start_task
= element start_task
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>start_task_response
= element start_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.59.3 Example: Start a task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <start_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_stop_task">7.60
Command <tt>stop_task</tt>
</h3></div>
<p>In short: Stop a running task.</p>
<p>
The client uses the stop_task command to manually stop a
running task.
</p>
<h4>7.60.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.60.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>stop_task
= element stop_task
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>stop_task_response
= element stop_task_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.60.3 Example: Stop a running task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <stop_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <stop_task_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_test_escalator">7.61
Command <tt>test_escalator</tt>
</h3></div>
<p>In short: Run an escalator.</p>
<p>
The client uses the test_escalator command to invoke a test run of
an escalator.
</p>
<h4>7.61.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.61.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>test_escalator
= element test_escalator
{
attribute task_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>test_escalator_response
= element test_escalator_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.61.3 Example: Test an escalator</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <test_escalator escalator_id="97390ade-e075-11df-9973-002264764cea"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <test_escalator_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_verify_agent">7.62
Command <tt>verify_agent</tt>
</h3></div>
<p>In short: Verify an agent.</p>
<p>
The client uses the verify_agent command to verify the trust
level of an existing agent.
</p>
<p>
The Manager checks whether the signature of the agent currently
matches the agent. This includes the agent installer file.
The Manager searches for the signature first in the feed, then
in the agent itself.
</p>
<h4>7.62.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>agent_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.62.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>verify_agent
= element verify_agent
{
attribute agent_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>verify_agent_response
= element verify_agent_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.62.3 Example: Verify an agent</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_agent_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div>
<div><h3 id="command_verify_report_format">7.63
Command <tt>verify_report_format</tt>
</h3></div>
<p>In short: Verify a report format.</p>
<p>
The client uses the verify_report_format command to verify the trust
level of an existing report format.
</p>
<p>
The Manager checks whether the signature of the report format currently
matches the report format. This includes the script and files used
to generate reports of this format. The Manager searches for the
signature first in the feed, then in the report format itself.
</p>
<h4>7.63.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@<b>report_format_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li style="margin-top: 15px;">
<i>Response</i><ul style="list-style: none">
<li>
@<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
@<b>status_text</b>
(text)
</li>
</ul>
</li>
</ul>
<h4>7.63.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>verify_report_format
= element verify_report_format
{
attribute report_format_id { uuid }
}
</pre></div>
<i>Response</i><div style="margin-left: 5%"><pre>verify_report_format_response
= element verify_report_format_response
{
attribute status { status }
& attribute status_text { text }
}
</pre></div>
</div>
<h4>7.63.3 Example: Verify a report format</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_report_format_response status="200"
status_text="OK"/>
</pre></div>
</div>
</div>
<div style="text-align: center; padding: 5px;">
This file was automatically generated.
</div>
</td></tr></table></div></body>
</html>
