[Openvas-commits] r9301 - in trunk/openvas-manager: . doc src/schema_formats/HTML src/schema_formats/RNC src/schema_formats/XML
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Wed Oct 27 21:49:28 CEST 2010
Author: mattm
Date: 2010-10-27 21:49:21 +0200 (Wed, 27 Oct 2010)
New Revision: 9301
Modified:
trunk/openvas-manager/ChangeLog
trunk/openvas-manager/doc/omp.html
trunk/openvas-manager/doc/omp.rnc
trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl
trunk/openvas-manager/src/schema_formats/HTML/rnc.xsl
trunk/openvas-manager/src/schema_formats/RNC/rnc.xsl
trunk/openvas-manager/src/schema_formats/XML/OMP.xml
Log:
* src/schema_formats/XML/OMP.xml: Add create commmands.
* src/schema_formats/HTML/HTML.xsl (description): Add lists.
(pretty): Explicitly indent element text.
(breakdown-line): Add r, to refer to command responses.
* src/schema_formats/HTML/rnc.xsl, src/schema_formats/RNC/rnc.xsl: Add r
to pattern, to refer to command responses.
* doc/omp.html, doc/omp.rnc: Update from source.
Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog 2010-10-27 13:46:57 UTC (rev 9300)
+++ trunk/openvas-manager/ChangeLog 2010-10-27 19:49:21 UTC (rev 9301)
@@ -1,5 +1,18 @@
-2010-09-20 Matthew Mundell <matthew.mundell at greenbone.net>
+2010-10-27 Matthew Mundell <matthew.mundell at greenbone.net>
+ * src/schema_formats/XML/OMP.xml: Add create commmands.
+
+ * src/schema_formats/HTML/HTML.xsl (description): Add lists.
+ (pretty): Explicitly indent element text.
+ (breakdown-line): Add r, to refer to command responses.
+
+ * src/schema_formats/HTML/rnc.xsl, src/schema_formats/RNC/rnc.xsl: Add r
+ to pattern, to refer to command responses.
+
+ * doc/omp.html, doc/omp.rnc: Update from source.
+
+2010-10-26 Matthew Mundell <matthew.mundell at greenbone.net>
+
* src/report_formats/LaTeX/latex.xsl (header): Define another character
that seems to be missing from Debian Lenny ucs LaTeX package.
Modified: trunk/openvas-manager/doc/omp.html
===================================================================
--- trunk/openvas-manager/doc/omp.html 2010-10-27 13:46:57 UTC (rev 9300)
+++ trunk/openvas-manager/doc/omp.html 2010-10-27 19:49:21 UTC (rev 9301)
@@ -19,6 +19,42 @@
<td id="index"><div style="margin-left: 15px;">Run a list of commands.</div></td>
</tr>
<tr id="index">
+<td id="index"><a href="#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="#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="#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="#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="#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="#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="#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="#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="#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="#delete_agent">delete_agent</a></td>
<td id="index"><div style="margin-left: 15px;">Delete an agent.</div></td>
</tr>
@@ -283,7 +319,1529 @@
</div>
</div>
<div>
-<div><h3 id="delete_agent">2.3
+<div><h3 id="create_agent">2.3
+ Command <tt>create_agent</tt>
+</h3></div>
+<p><b>In short: </b>Create an agent.</p>
+<p>
+ The client uses the create_agent command to create a new agent.
+ </p>
+<h4>2.3.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.3.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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
+ {
+ 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 style="font-weight:bold;">Response</div>
+<pre>create_agent_response
+ = element create_agent_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.3.1 Example: Create an agent</h4>
+<b>Client:</b><br><pre> <create_agent>
+ <installer>
+ asdf3235saf3kjBVF...
+ <signature>iEYEABECAAYFA...</signature>
+ </installer>
+ <name>SLAD</name>
+ </create_agent>
+</pre>
+<br><b>Manager:</b><br><pre> <create_agent_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_config">2.4
+ Command <tt>create_config</tt>
+</h3></div>
+<p><b>In short: </b>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>2.4.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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><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></b><div style="margin-left: 15px; display: inline;">
+ A response to a <a href="#get_configs">get_configs</a> command.
+ </div>
+</li>
+<li>
+<b>
+ <rcfile></b><div style="margin-left: 15px; display: inline;">A 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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.4.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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 style="font-weight:bold;">Response</div>
+<pre>create_config_response
+ = element create_config_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.4.1 Example: Copy a config</h4>
+<b>Client:</b><br><pre> <create_config>
+ <copy>daba56c8-73ec-11df-a475-002264764cea</copy>
+ <name>Full</name>
+ </create_config>
+</pre>
+<br><b>Manager:</b><br><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+<h4>2.4.1 Example: Create a config from an RC file</h4>
+<b>Client:</b><br><pre> <create_config>
+ <rcfile>asdf3235saf3kjBVF...</rcfile>
+ <name>Full</name>
+ </create_config>
+</pre>
+<br><b>Manager:</b><br><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+<h4>2.4.1 Example: Create a config from a GET_CONFIGS response</h4>
+<b>Client:</b><br><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>
+<br><b>Manager:</b><br><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_escalator">2.5
+ Command <tt>create_escalator</tt>
+</h3></div>
+<p><b>In short: </b>Create an escalator.</p>
+<p>
+ The client uses the create_escalator command to create a new
+ escalator.
+ </p>
+<h4>2.5.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.5.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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 style="font-weight:bold;">Response</div>
+<pre>create_escalator_response
+ = element create_escalator_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.5.1 Example: Create an escalator</h4>
+<b>Client:</b><br><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 at example.org
+ <name>to_address</name>
+ </data>
+ <data>
+ bob at example.org
+ <name>from_address</name>
+ </data>
+ </method>
+ </create_escalator>
+</pre>
+<br><b>Manager:</b><br><pre> <create_escalator_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_lsc_credential">2.6
+ Command <tt>create_lsc_credential</tt>
+</h3></div>
+<p><b>In short: </b>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>2.6.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.6.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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 style="font-weight:bold;">Response</div>
+<pre>create_lsc_credential_response
+ = element create_lsc_credential_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.6.1 Example: Create an LSC credential</h4>
+<b>Client:</b><br><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>
+<br><b>Manager:</b><br><pre> <create_lsc_credential_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_note">2.7
+ Command <tt>create_note</tt>
+</h3></div>
+<p><b>In short: </b>Create a note.</p>
+<p>
+ The client uses the create_note command to create a new note.
+ </p>
+<h4>2.7.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+ (oid)
+ </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>
+ (uuid)
+ </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>
+ (uuid)
+ </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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.7.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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 style="font-weight:bold;">Response</div>
+<pre>create_note_response
+ = element create_note_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.7.1 Example: Create a note</h4>
+<b>Client:</b><br><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>
+<br><b>Manager:</b><br><pre> <create_note_response status="202" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_override">2.8
+ Command <tt>create_override</tt>
+</h3></div>
+<p><b>In short: </b>Create an override.</p>
+<p>
+ The client uses the create_override command to create a new override.
+ </p>
+<h4>2.8.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+ (oid)
+ </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>
+ (uuid)
+ </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>
+ (uuid)
+ </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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.8.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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 style="font-weight:bold;">Response</div>
+<pre>create_override_response
+ = element create_override_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.8.1 Example: Create an override</h4>
+<b>Client:</b><br><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>
+<br><b>Manager:</b><br><pre> <create_override_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_schedule">2.9
+ Command <tt>create_schedule</tt>
+</h3></div>
+<p><b>In short: </b>Create a schedule.</p>
+<p>
+ The client uses the create_schedule command to create a new schedule.
+ </p>
+<h4>2.9.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.9.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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 style="font-weight:bold;">Response</div>
+<pre>create_schedule_response
+ = element create_schedule_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.9.1 Example: Create a schedule</h4>
+<b>Client:</b><br><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>
+<br><b>Manager:</b><br><pre> <create_schedule_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_target">2.10
+ Command <tt>create_target</tt>
+</h3></div>
+<p><b>In short: </b>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>2.10.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+ <lsc_credential></b><div style="margin-left: 15px; display: inline;">Login credentials for target.</div>
+<ul style="list-style: none"><li>
+<b>"id"</b>
+ (uuid)
+ </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>
+</ul>
+</li>
+<li>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.10.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<pre>create_target
+ = element create_target
+ {
+ ""
+ & create_target_name
+ & create_target_comment?
+ & create_target_hosts
+ & create_target_lsc_credential
+ & create_target_target_locator
+ }
+
+create_target_name
+ = element name
+ {
+ name
+ }
+
+create_target_comment
+ = element comment
+ {
+ text
+ }
+
+create_target_hosts
+ = element hosts
+ {
+ text
+ }
+
+create_target_lsc_credential
+ = element 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
+ }
+</pre>
+<div style="font-weight:bold;">Response</div>
+<pre>create_target_response
+ = element create_target_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.10.1 Example: Create a target, giving a host list</h4>
+<b>Client:</b><br><pre> <create_target>
+ <create_target>
+ <name>All GNU/Linux machines</name>
+ <hosts>192.168.1.0/24</hosts>
+ </create_target>
+ </create_target>
+</pre>
+<br><b>Manager:</b><br><pre> <create_target_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="create_task">2.11
+ Command <tt>create_task</tt>
+</h3></div>
+<p><b>In short: </b>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>2.11.1 Breakdown</h4>
+<ul style="list-style: none">
+<li>
+<div style="font-weight:bold;">Command</div>
+<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>
+ (uuid)
+ </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>
+ (uuid)
+ </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>
+ (uuid)
+ </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>
+ (uuid)
+ </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>
+<div style="font-weight:bold;">Response</div>
+<ul style="list-style: none">
+<li>
+<b>"status"</b>
+ (status)
+ </li>
+<li>
+<b>"status_text"</b>
+ (text)
+ </li>
+<li>
+<b>"id"</b>
+ (uuid)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>2.11.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<div style="font-weight:bold;">Command</div>
+<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_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_rcfile
+ = element rcfile
+ {
+ base64
+ }
+</pre>
+<div style="font-weight:bold;">Response</div>
+<pre>create_task_response
+ = element create_task_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre>
+</div>
+<h4>2.11.1 Example: Create a task, giving a host list</h4>
+<b>Client:</b><br><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>
+<br><b>Manager:</b><br><pre> <create_task_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre>
+</div>
+<div>
+<div><h3 id="delete_agent">2.12
Command <tt>delete_agent</tt>
</h3></div>
<p><b>In short: </b>Delete an agent.</p>
@@ -295,7 +1853,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.3.1 Breakdown</h4>
+<h4>2.12.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -318,7 +1876,7 @@
</ul>
</li>
</ul>
-<h4>2.3.2 RNC</h4>
+<h4>2.12.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_agent
@@ -338,14 +1896,14 @@
}
</pre>
</div>
-<h4>2.3.1 Example: Delete an agent</h4>
+<h4>2.12.1 Example: Delete an agent</h4>
<b>Client:</b><br><pre> <delete_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_agent_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_config">2.4
+<div><h3 id="delete_config">2.13
Command <tt>delete_config</tt>
</h3></div>
<p><b>In short: </b>Delete a config.</p>
@@ -357,7 +1915,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.4.1 Breakdown</h4>
+<h4>2.13.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -380,7 +1938,7 @@
</ul>
</li>
</ul>
-<h4>2.4.2 RNC</h4>
+<h4>2.13.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_config
@@ -400,14 +1958,14 @@
}
</pre>
</div>
-<h4>2.4.1 Example: Delete a config</h4>
+<h4>2.13.1 Example: Delete a config</h4>
<b>Client:</b><br><pre> <delete_config config_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_config_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_escalator">2.5
+<div><h3 id="delete_escalator">2.14
Command <tt>delete_escalator</tt>
</h3></div>
<p><b>In short: </b>Delete an escalator.</p>
@@ -420,7 +1978,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.5.1 Breakdown</h4>
+<h4>2.14.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -443,7 +2001,7 @@
</ul>
</li>
</ul>
-<h4>2.5.2 RNC</h4>
+<h4>2.14.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_escalator
@@ -463,14 +2021,14 @@
}
</pre>
</div>
-<h4>2.5.1 Example: Delete an escalator</h4>
+<h4>2.14.1 Example: Delete an escalator</h4>
<b>Client:</b><br><pre> <delete_escalator escalator_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_escalator_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_lsc_credential">2.6
+<div><h3 id="delete_lsc_credential">2.15
Command <tt>delete_lsc_credential</tt>
</h3></div>
<p><b>In short: </b>Delete an LSC credential.</p>
@@ -483,7 +2041,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.6.1 Breakdown</h4>
+<h4>2.15.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -506,7 +2064,7 @@
</ul>
</li>
</ul>
-<h4>2.6.2 RNC</h4>
+<h4>2.15.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_lsc_credential
@@ -526,14 +2084,14 @@
}
</pre>
</div>
-<h4>2.6.1 Example: Delete an LSC credential</h4>
+<h4>2.15.1 Example: Delete an LSC credential</h4>
<b>Client:</b><br><pre> <delete_lsc_credential lsc_credential_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_lsc_credential_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_note">2.7
+<div><h3 id="delete_note">2.16
Command <tt>delete_note</tt>
</h3></div>
<p><b>In short: </b>Delete a note.</p>
@@ -545,7 +2103,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.7.1 Breakdown</h4>
+<h4>2.16.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -568,7 +2126,7 @@
</ul>
</li>
</ul>
-<h4>2.7.2 RNC</h4>
+<h4>2.16.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_note
@@ -588,14 +2146,14 @@
}
</pre>
</div>
-<h4>2.7.1 Example: Delete a note</h4>
+<h4>2.16.1 Example: Delete a note</h4>
<b>Client:</b><br><pre> <delete_note note_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_note_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_override">2.8
+<div><h3 id="delete_override">2.17
Command <tt>delete_override</tt>
</h3></div>
<p><b>In short: </b>Delete a override.</p>
@@ -607,7 +2165,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.8.1 Breakdown</h4>
+<h4>2.17.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -630,7 +2188,7 @@
</ul>
</li>
</ul>
-<h4>2.8.2 RNC</h4>
+<h4>2.17.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_override
@@ -650,14 +2208,14 @@
}
</pre>
</div>
-<h4>2.8.1 Example: Delete a override</h4>
+<h4>2.17.1 Example: Delete a override</h4>
<b>Client:</b><br><pre> <delete_override override_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_override_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_report">2.9
+<div><h3 id="delete_report">2.18
Command <tt>delete_report</tt>
</h3></div>
<p><b>In short: </b>Delete a report.</p>
@@ -669,7 +2227,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.9.1 Breakdown</h4>
+<h4>2.18.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -692,7 +2250,7 @@
</ul>
</li>
</ul>
-<h4>2.9.2 RNC</h4>
+<h4>2.18.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_report
@@ -712,14 +2270,14 @@
}
</pre>
</div>
-<h4>2.9.1 Example: Delete a report</h4>
+<h4>2.18.1 Example: Delete a report</h4>
<b>Client:</b><br><pre> <delete_report report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_report_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_schedule">2.10
+<div><h3 id="delete_schedule">2.19
Command <tt>delete_schedule</tt>
</h3></div>
<p><b>In short: </b>Delete a schedule.</p>
@@ -731,7 +2289,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.10.1 Breakdown</h4>
+<h4>2.19.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -754,7 +2312,7 @@
</ul>
</li>
</ul>
-<h4>2.10.2 RNC</h4>
+<h4>2.19.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_schedule
@@ -774,14 +2332,14 @@
}
</pre>
</div>
-<h4>2.10.1 Example: Delete a schedule</h4>
+<h4>2.19.1 Example: Delete a schedule</h4>
<b>Client:</b><br><pre> <delete_schedule schedule_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_schedule_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_target">2.11
+<div><h3 id="delete_target">2.20
Command <tt>delete_target</tt>
</h3></div>
<p><b>In short: </b>Delete a target.</p>
@@ -793,7 +2351,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.11.1 Breakdown</h4>
+<h4>2.20.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -816,7 +2374,7 @@
</ul>
</li>
</ul>
-<h4>2.11.2 RNC</h4>
+<h4>2.20.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_target
@@ -836,14 +2394,14 @@
}
</pre>
</div>
-<h4>2.11.1 Example: Delete a target</h4>
+<h4>2.20.1 Example: Delete a target</h4>
<b>Client:</b><br><pre> <delete_target target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_target_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="delete_task">2.12
+<div><h3 id="delete_task">2.21
Command <tt>delete_task</tt>
</h3></div>
<p><b>In short: </b>Delete a task.</p>
@@ -856,7 +2414,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>2.12.1 Breakdown</h4>
+<h4>2.21.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -879,7 +2437,7 @@
</ul>
</li>
</ul>
-<h4>2.12.2 RNC</h4>
+<h4>2.21.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>delete_task
@@ -899,14 +2457,14 @@
}
</pre>
</div>
-<h4>2.12.1 Example: Delete a task</h4>
+<h4>2.21.1 Example: Delete a task</h4>
<b>Client:</b><br><pre> <delete_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <delete_task_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="get_notes">2.13
+<div><h3 id="get_notes">2.22
Command <tt>get_notes</tt>
</h3></div>
<p><b>In short: </b>Get all notes.</p>
@@ -915,7 +2473,7 @@
If the command sent by the client was valid, the manager will
reply with a list of notes to the client.
</p>
-<h4>2.13.1 Breakdown</h4>
+<h4>2.22.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -965,7 +2523,7 @@
</ul>
</li>
</ul>
-<h4>2.13.2 RNC</h4>
+<h4>2.22.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>get_notes
@@ -991,7 +2549,7 @@
}
</pre>
</div>
-<h4>2.13.1 Example: Get all notes</h4>
+<h4>2.22.1 Example: Get all notes</h4>
<b>Client:</b><br><pre> <get_notes/>
</pre>
<br><b>Manager:</b><br><pre> <get_notes_response status="200" status_text="OK">
@@ -1007,11 +2565,11 @@
</pre>
</div>
<div>
-<div><h3 id="get_version">2.14
+<div><h3 id="get_version">2.23
Command <tt>get_version</tt>
</h3></div>
<p><b>In short: </b>Get the OpenVAS Manager Protocol version.</p>
-<h4>2.14.1 Breakdown</h4>
+<h4>2.23.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1031,7 +2589,7 @@
</ul>
</li>
</ul>
-<h4>2.14.2 RNC</h4>
+<h4>2.23.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>get_version
@@ -1052,11 +2610,11 @@
</div>
</div>
<div>
-<div><h3 id="help">2.15
+<div><h3 id="help">2.24
Command <tt>help</tt>
</h3></div>
<p><b>In short: </b>Get the help text.</p>
-<h4>2.15.1 Breakdown</h4>
+<h4>2.24.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1076,7 +2634,7 @@
</ul>
</li>
</ul>
-<h4>2.15.2 RNC</h4>
+<h4>2.24.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>help
@@ -1097,7 +2655,7 @@
</div>
</div>
<div>
-<div><h3 id="modify_config">2.16
+<div><h3 id="modify_config">2.25
Command <tt>modify_config</tt>
</h3></div>
<p><b>In short: </b>Update an existing config.</p>
@@ -1148,7 +2706,7 @@
apply the changes to the config and will reply with a response code indicating
success.
</p>
-<h4>2.16.1 Breakdown</h4>
+<h4>2.25.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1247,7 +2805,7 @@
</ul>
</li>
</ul>
-<h4>2.16.2 RNC</h4>
+<h4>2.25.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>modify_config
@@ -1360,7 +2918,7 @@
}
</pre>
</div>
-<h4>2.16.1 Example: Modify a config preference</h4>
+<h4>2.25.1 Example: Modify a config preference</h4>
<b>Client:</b><br><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.14259"/>
@@ -1371,7 +2929,7 @@
</pre>
<br><b>Manager:</b><br><pre> <modify_config_response status="200" status_text="OK"/>
</pre>
-<h4>2.16.1 Example: Modify the families that a config selects</h4>
+<h4>2.25.1 Example: Modify the families that a config selects</h4>
<p>
The outer "growing" element sets the config to add any new families
that arrive.
@@ -1395,7 +2953,7 @@
</pre>
<br><b>Manager:</b><br><pre> <modify_config_response status="200" status_text="OK"/>
</pre>
-<h4>2.16.1 Example: Modify the NVTs that a config selects in a particular family</h4>
+<h4>2.25.1 Example: Modify the NVTs that a config selects in a particular family</h4>
<b>Client:</b><br><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<nvt_selection>
<family>Debian Local Security Checks</family>
@@ -1410,7 +2968,7 @@
</pre>
</div>
<div>
-<div><h3 id="modify_note">2.17
+<div><h3 id="modify_note">2.26
Command <tt>modify_note</tt>
</h3></div>
<p><b>In short: </b>Modify an existing note.</p>
@@ -1421,7 +2979,7 @@
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
-<h4>2.17.1 Breakdown</h4>
+<h4>2.26.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1483,7 +3041,7 @@
</ul>
</li>
</ul>
-<h4>2.17.2 RNC</h4>
+<h4>2.26.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>modify_note
@@ -1547,7 +3105,7 @@
}
</pre>
</div>
-<h4>2.17.1 Example: Modify the text and result of a note</h4>
+<h4>2.26.1 Example: Modify the text and result of a note</h4>
<b>Client:</b><br><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"/>
@@ -1557,7 +3115,7 @@
</pre>
</div>
<div>
-<div><h3 id="modify_override">2.18
+<div><h3 id="modify_override">2.27
Command <tt>modify_override</tt>
</h3></div>
<p><b>In short: </b>Modify an existing override.</p>
@@ -1569,7 +3127,7 @@
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
-<h4>2.18.1 Breakdown</h4>
+<h4>2.27.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1636,7 +3194,7 @@
</ul>
</li>
</ul>
-<h4>2.18.2 RNC</h4>
+<h4>2.27.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>modify_override
@@ -1707,7 +3265,7 @@
}
</pre>
</div>
-<h4>2.18.1 Example: Set the override threat to Low</h4>
+<h4>2.27.1 Example: Set the override threat to Low</h4>
<b>Client:</b><br><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>
@@ -1717,7 +3275,7 @@
</pre>
</div>
<div>
-<div><h3 id="modify_report">2.19
+<div><h3 id="modify_report">2.28
Command <tt>modify_report</tt>
</h3></div>
<p><b>In short: </b>Modify an existing report.</p>
@@ -1725,7 +3283,7 @@
The client uses the modify_report command to change an existing
report.
</p>
-<h4>2.19.1 Breakdown</h4>
+<h4>2.28.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1756,7 +3314,7 @@
</ul>
</li>
</ul>
-<h4>2.19.2 RNC</h4>
+<h4>2.28.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>modify_report
@@ -1783,7 +3341,7 @@
}
</pre>
</div>
-<h4>2.19.1 Example: Modify a report comment</h4>
+<h4>2.28.1 Example: Modify a report comment</h4>
<b>Client:</b><br><pre> <modify_report report_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
</modify_report>
@@ -1792,7 +3350,7 @@
</pre>
</div>
<div>
-<div><h3 id="modify_task">2.20
+<div><h3 id="modify_task">2.29
Command <tt>modify_task</tt>
</h3></div>
<p><b>In short: </b>Modify an existing task.</p>
@@ -1800,7 +3358,7 @@
The client uses the modify_task command to change an existing
task.
</p>
-<h4>2.20.1 Breakdown</h4>
+<h4>2.29.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1875,7 +3433,7 @@
</ul>
</li>
</ul>
-<h4>2.20.2 RNC</h4>
+<h4>2.29.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>modify_task
@@ -1907,7 +3465,7 @@
modify_task_name
= element name
{
- text
+ name
}
modify_task_rcfile
@@ -1941,7 +3499,7 @@
}
</pre>
</div>
-<h4>2.20.1 Example: Modify a task comment</h4>
+<h4>2.29.1 Example: Modify a task comment</h4>
<b>Client:</b><br><pre> <modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
</modify_task>
@@ -1950,14 +3508,14 @@
</pre>
</div>
<div>
-<div><h3 id="pause_task">2.21
+<div><h3 id="pause_task">2.30
Command <tt>pause_task</tt>
</h3></div>
<p><b>In short: </b>Pause a running task.</p>
<p>
The client uses the pause_task command to manually pause a running task.
</p>
-<h4>2.21.1 Breakdown</h4>
+<h4>2.30.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -1980,7 +3538,7 @@
</ul>
</li>
</ul>
-<h4>2.21.2 RNC</h4>
+<h4>2.30.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>pause_task
@@ -2000,14 +3558,14 @@
}
</pre>
</div>
-<h4>2.21.1 Example: Pause a running task</h4>
+<h4>2.30.1 Example: Pause a running task</h4>
<b>Client:</b><br><pre> <pause_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <pause_task_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="resume_or_start_task">2.22
+<div><h3 id="resume_or_start_task">2.31
Command <tt>resume_or_start_task</tt>
</h3></div>
<p><b>In short: </b>Resume task if stopped, else start task.</p>
@@ -2016,7 +3574,7 @@
an existing task, ensuring that the task will resume from its
previous position if the task is in the Stopped state.
</p>
-<h4>2.22.1 Breakdown</h4>
+<h4>2.31.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -2039,7 +3597,7 @@
</ul>
</li>
</ul>
-<h4>2.22.2 RNC</h4>
+<h4>2.31.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>resume_or_start_task
@@ -2059,14 +3617,14 @@
}
</pre>
</div>
-<h4>2.22.1 Example: Resume a running task</h4>
+<h4>2.31.1 Example: Resume a running task</h4>
<b>Client:</b><br><pre> <resume_or_start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <resume_or_start_task_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="resume_paused_task">2.23
+<div><h3 id="resume_paused_task">2.32
Command <tt>resume_paused_task</tt>
</h3></div>
<p><b>In short: </b>Resume a paused task.</p>
@@ -2074,7 +3632,7 @@
The client uses the resume_paused_task command to manually resume a
paused task.
</p>
-<h4>2.23.1 Breakdown</h4>
+<h4>2.32.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -2097,7 +3655,7 @@
</ul>
</li>
</ul>
-<h4>2.23.2 RNC</h4>
+<h4>2.32.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>resume_paused_task
@@ -2117,14 +3675,14 @@
}
</pre>
</div>
-<h4>2.23.1 Example: Resume a paused task</h4>
+<h4>2.32.1 Example: Resume a paused task</h4>
<b>Client:</b><br><pre> <resume_paused_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <resume_paused_task_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="resume_stopped_task">2.24
+<div><h3 id="resume_stopped_task">2.33
Command <tt>resume_stopped_task</tt>
</h3></div>
<p><b>In short: </b>Resume a stopped task.</p>
@@ -2132,7 +3690,7 @@
The client uses the resume_stopped_task command to manually resume a
stopped task.
</p>
-<h4>2.24.1 Breakdown</h4>
+<h4>2.33.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -2155,7 +3713,7 @@
</ul>
</li>
</ul>
-<h4>2.24.2 RNC</h4>
+<h4>2.33.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>resume_stopped_task
@@ -2175,14 +3733,14 @@
}
</pre>
</div>
-<h4>2.24.1 Example: Resume a stopped task</h4>
+<h4>2.33.1 Example: Resume a stopped task</h4>
<b>Client:</b><br><pre> <resume_stopped_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <resume_stopped_task_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="start_task">2.25
+<div><h3 id="start_task">2.34
Command <tt>start_task</tt>
</h3></div>
<p><b>In short: </b>Manually start an existing task.</p>
@@ -2190,7 +3748,7 @@
The client uses the start_task command to manually start an
existing task.
</p>
-<h4>2.25.1 Breakdown</h4>
+<h4>2.34.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -2213,7 +3771,7 @@
</ul>
</li>
</ul>
-<h4>2.25.2 RNC</h4>
+<h4>2.34.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>start_task
@@ -2233,14 +3791,14 @@
}
</pre>
</div>
-<h4>2.25.1 Example: Start a task</h4>
+<h4>2.34.1 Example: Start a task</h4>
<b>Client:</b><br><pre> <start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <start_task_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="stop_task">2.26
+<div><h3 id="stop_task">2.35
Command <tt>stop_task</tt>
</h3></div>
<p><b>In short: </b>Stop a running task.</p>
@@ -2248,7 +3806,7 @@
The client uses the stop_task command to manually stop a
running task.
</p>
-<h4>2.26.1 Breakdown</h4>
+<h4>2.35.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -2271,7 +3829,7 @@
</ul>
</li>
</ul>
-<h4>2.26.2 RNC</h4>
+<h4>2.35.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>stop_task
@@ -2291,14 +3849,14 @@
}
</pre>
</div>
-<h4>2.26.1 Example: Stop a running task</h4>
+<h4>2.35.1 Example: Stop a running task</h4>
<b>Client:</b><br><pre> <stop_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre>
<br><b>Manager:</b><br><pre> <stop_task_response status="200" status_text="OK"/>
</pre>
</div>
<div>
-<div><h3 id="test_escalator">2.27
+<div><h3 id="test_escalator">2.36
Command <tt>test_escalator</tt>
</h3></div>
<p><b>In short: </b>Run an escalator.</p>
@@ -2306,7 +3864,7 @@
The client uses the test_escalator command to invoke a test run of
an escalator.
</p>
-<h4>2.27.1 Breakdown</h4>
+<h4>2.36.1 Breakdown</h4>
<ul style="list-style: none">
<li>
<div style="font-weight:bold;">Command</div>
@@ -2329,7 +3887,7 @@
</ul>
</li>
</ul>
-<h4>2.27.2 RNC</h4>
+<h4>2.36.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 75%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<div style="font-weight:bold;">Command</div>
<pre>test_escalator
@@ -2349,7 +3907,7 @@
}
</pre>
</div>
-<h4>2.27.1 Example: Test an escalator</h4>
+<h4>2.36.1 Example: Test an escalator</h4>
<b>Client:</b><br><pre> <test_escalator escalator_id="97390ade-e075-11df-9973-002264764cea"/>
</pre>
<br><b>Manager:</b><br><pre> <test_escalator_response status="200" status_text="OK"/>
Modified: trunk/openvas-manager/doc/omp.rnc
===================================================================
--- trunk/openvas-manager/doc/omp.rnc 2010-10-27 13:46:57 UTC (rev 9300)
+++ trunk/openvas-manager/doc/omp.rnc 2010-10-27 19:49:21 UTC (rev 9301)
@@ -9,6 +9,15 @@
command
= authenticate
| commands
+ | create_agent
+ | create_config
+ | create_escalator
+ | create_lsc_credential
+ | create_note
+ | create_override
+ | create_schedule
+ | create_target
+ | create_task
| delete_agent
| delete_config
| delete_escalator
@@ -38,6 +47,15 @@
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_schedule_response
+ | create_target_response
+ | create_task_response
| delete_agent_response
| delete_config_response
| delete_escalator_response
@@ -72,6 +90,8 @@
boolean = text
boolean_atoi = text
+# An integer.
+integer = xsd:integer
name = xsd:string
@@ -82,6 +102,8 @@
status = xsd:token { pattern = "200|201|202|400|401|403|404|409|500|503" }
threat = xsd:token { pattern = "High|Medium|Low|Log|Debug" }
+# A unit of time.
+time_unit = xsd:token { pattern = "second|minute|hour|day|week|month|year|decade" }
uuid = xsd:token { pattern = "[0-9abcdefABCDEF\-]{1,40}" }
@@ -131,6 +153,647 @@
& command*
}
+## Command create_agent
+##
+## Create an agent.
+
+create_agent
+ = element create_agent
+ {
+ ""
+ & create_agent_installer
+ & create_agent_name
+ & create_agent_comment?
+ & create_agent_howto_install?
+ & create_agent_howto_use?
+ }
+
+# A file that installs the agent on a target machine.
+create_agent_installer
+ = element installer
+ {
+ base64
+ & create_agent_installer_signature
+ }
+
+# A detached OpenPGP signature of the installer.
+create_agent_installer_signature
+ = element signature
+ {
+ base64
+ }
+
+# A name for the installer.
+create_agent_name
+ = element name
+ {
+ name
+ }
+
+# A comment on the agent.
+create_agent_comment
+ = element comment
+ {
+ text
+ }
+
+# A file that describes how to install the agent.
+create_agent_howto_install
+ = element howto_install
+ {
+ base64
+ }
+
+# A file that describes how to use the agent.
+create_agent_howto_use
+ = element howto_use
+ {
+ base64
+ }
+
+## Command create_config
+##
+## Create a config.
+
+create_config
+ = element create_config
+ {
+ ""
+ & create_config_comment?
+ & ( create_config_copy
+ | get_configs_response
+ | create_config_rcfile )
+ & create_config_name
+ }
+
+# A comment on the config.
+create_config_comment
+ = element comment
+ {
+ text
+ }
+
+# The UUID of an existing config.
+create_config_copy
+ = element copy
+ {
+ uuid
+ }
+
+# A openvasrc style file that defines the config.
+create_config_rcfile
+ = element rcfile
+ {
+ base64
+ }
+
+# A name for the config.
+create_config_name
+ = element name
+ {
+ name
+ }
+
+## Command create_escalator
+##
+## Create an escalator.
+
+create_escalator
+ = element create_escalator
+ {
+ ""
+ & create_escalator_name
+ & create_escalator_comment?
+ & create_escalator_condition
+ & create_escalator_event
+ & create_escalator_method
+ }
+
+# A name for the escalator.
+create_escalator_name
+ = element name
+ {
+ name
+ }
+
+# A comment on the escalator.
+create_escalator_comment
+ = element comment
+ {
+ text
+ }
+
+# The condition that must be satisfied for escalation.
+create_escalator_condition
+ = element condition
+ {
+ text
+ & create_escalator_condition_data
+ }
+
+# Some data that defines the condition.
+create_escalator_condition_data
+ = element data
+ {
+ text
+ & create_escalator_condition_data_name
+ }
+
+# The name of the condition data.
+create_escalator_condition_data_name
+ = element name
+ {
+ text
+ }
+
+# The event that must happen for escalation.
+create_escalator_event
+ = element event
+ {
+ text
+ & create_escalator_event_data
+ }
+
+# Some data that defines the event.
+create_escalator_event_data
+ = element data
+ {
+ text
+ & create_escalator_event_data_name
+ }
+
+# The name of the event data.
+create_escalator_event_data_name
+ = element name
+ {
+ text
+ }
+
+# The method by which escalation must occur.
+create_escalator_method
+ = element method
+ {
+ text
+ & create_escalator_method_data
+ }
+
+# Some data that defines the method.
+create_escalator_method_data
+ = element data
+ {
+ text
+ & create_escalator_method_data_name
+ }
+
+# The name of the method data.
+create_escalator_method_data_name
+ = element name
+ {
+ text
+ }
+
+## Command create_lsc_credential
+##
+## Create an LSC credential.
+
+create_lsc_credential
+ = element create_lsc_credential
+ {
+ ""
+ & create_lsc_credential_name
+ & create_lsc_credential_comment?
+ & create_lsc_credential_login
+ & create_lsc_credential_password?
+ }
+
+# A name for the LSC credential.
+create_lsc_credential_name
+ = element name
+ {
+ name
+ }
+
+# A comment on the LSC credential.
+create_lsc_credential_comment
+ = element comment
+ {
+ text
+ }
+
+# The user name of the credential.
+create_lsc_credential_login
+ = element login
+ {
+ text
+ }
+
+# The password for the credential login.
+create_lsc_credential_password
+ = element password
+ {
+ text
+ }
+
+## Command create_note
+##
+## Create a note.
+
+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?
+ }
+
+# The text of the note.
+create_note_text
+ = element text
+ {
+ text
+ }
+
+# NVT to which note applies.
+create_note_nvt
+ = element nvt
+ {
+ ""
+ & attribute oid { oid }
+ }
+
+# A comment on the note.
+create_note_comment
+ = element comment
+ {
+ text
+ }
+
+# A textual list of hosts.
+create_note_hosts
+ = element hosts
+ {
+ text
+ }
+
+# Port to which note applies.
+create_note_port
+ = element port
+ {
+ text
+ }
+
+# Result to which note applies.
+create_note_result
+ = element result
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# Task to which note applies.
+create_note_task
+ = element task
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# Threat level to which note applies.
+create_note_threat
+ = element threat
+ {
+ threat
+ }
+
+## Command create_override
+##
+## Create an override.
+
+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?
+ }
+
+# The text of the override.
+create_override_text
+ = element text
+ {
+ text
+ }
+
+# NVT to which override applies.
+create_override_nvt
+ = element nvt
+ {
+ ""
+ & attribute oid { oid }
+ }
+
+# A comment on the override.
+create_override_comment
+ = element comment
+ {
+ text
+ }
+
+# A textual list of hosts.
+create_override_hosts
+ = element hosts
+ {
+ text
+ }
+
+# New threat level for result.
+create_override_new_threat
+ = element new_threat
+ {
+ threat
+ }
+
+# Port to which override applies.
+create_override_port
+ = element port
+ {
+ text
+ }
+
+# Result to which override applies.
+create_override_result
+ = element result
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# Task to which override applies.
+create_override_task
+ = element task
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# Threat level to which override applies.
+create_override_threat
+ = element threat
+ {
+ threat
+ }
+
+## Command create_schedule
+##
+## Create a schedule.
+
+create_schedule
+ = element create_schedule
+ {
+ ""
+ & create_schedule_name
+ & create_schedule_comment?
+ & create_schedule_first_time
+ & create_schedule_duration
+ & create_schedule_period
+ }
+
+# A name for the schedule.
+create_schedule_name
+ = element name
+ {
+ name
+ }
+
+# A comment on the schedule.
+create_schedule_comment
+ = element comment
+ {
+ text
+ }
+
+# The first time the schedule will run.
+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
+ }
+
+# How long the Manager will run the scheduled task for.
+create_schedule_duration
+ = element duration
+ {
+ ""
+ & create_schedule_duration_unit
+ }
+
+# Duration time unit.
+create_schedule_duration_unit
+ = element unit
+ {
+ time_unit
+ }
+
+# How often the Manager will repeat the scheduled task.
+create_schedule_period
+ = element period
+ {
+ ""
+ & create_schedule_period_unit
+ }
+
+# Period time unit.
+create_schedule_period_unit
+ = element unit
+ {
+ time_unit
+ }
+
+## Command create_target
+##
+## Create a target.
+
+create_target
+ = element create_target
+ {
+ ""
+ & create_target_name
+ & create_target_comment?
+ & create_target_hosts
+ & create_target_lsc_credential
+ & create_target_target_locator
+ }
+
+# A name for the target.
+create_target_name
+ = element name
+ {
+ name
+ }
+
+# A comment on the target.
+create_target_comment
+ = element comment
+ {
+ text
+ }
+
+# A textual list of hosts, which may be empty.
+create_target_hosts
+ = element hosts
+ {
+ text
+ }
+
+# Login credentials for target.
+create_target_lsc_credential
+ = element lsc_credential
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# Target locator (for example, for LDAP).
+create_target_target_locator
+ = element target_locator
+ {
+ ""
+ & create_target_target_locator_username?
+ & create_target_target_locator_password?
+ }
+
+# The login for the target locator.
+create_target_target_locator_username
+ = element username
+ {
+ text
+ }
+
+# The password for the target locator.
+create_target_target_locator_password
+ = element password
+ {
+ text
+ }
+
+## Command create_task
+##
+## Create a task.
+
+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_rcfile?
+ }
+
+# A name for the task.
+create_task_name
+ = element name
+ {
+ name
+ }
+
+# A comment on the task.
+create_task_comment
+ = element comment
+ {
+ text
+ }
+
+# The scan configuration used by the task.
+create_task_config
+ = element config
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# The hosts scanned by the task.
+create_task_target
+ = element target
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# An escalator that applies to the task.
+create_task_escalator
+ = element escalator
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# When the task will run.
+create_task_schedule
+ = element schedule
+ {
+ ""
+ & attribute id { uuid }
+ }
+
+# An openvasrc style file defining the task.
+create_task_rcfile
+ = element rcfile
+ {
+ base64
+ }
+
## Command delete_agent
##
## Delete an agent.
@@ -580,7 +1243,7 @@
modify_task_name
= element name
{
- text
+ name
}
# An openvasrc style file describing the task.
@@ -707,6 +1370,105 @@
& response*
}
+## Response to create_agent
+
+create_agent_response
+ = element create_agent_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_config
+
+create_config_response
+ = element create_config_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_escalator
+
+create_escalator_response
+ = element create_escalator_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_lsc_credential
+
+create_lsc_credential_response
+ = element create_lsc_credential_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_note
+
+create_note_response
+ = element create_note_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_override
+
+create_override_response
+ = element create_override_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_schedule
+
+create_schedule_response
+ = element create_schedule_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_target
+
+create_target_response
+ = element create_target_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
+## Response to create_task
+
+create_task_response
+ = element create_task_response
+ {
+ ""
+ & attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
## Response to delete_agent
delete_agent_response
Modified: trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl
===================================================================
--- trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl 2010-10-27 13:46:57 UTC (rev 9300)
+++ trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl 2010-10-27 19:49:21 UTC (rev 9301)
@@ -48,12 +48,27 @@
<xsl:template match="description">
<xsl:choose>
- <xsl:when test="(count(p) = 0) and (string-length(normalize-space(text())) > 0)">
+ <xsl:when test="(count(*) = 0) and (string-length(normalize-space(text())) > 0)">
<p><xsl:value-of select="text()"/></p>
</xsl:when>
<xsl:otherwise>
- <xsl:for-each select="p">
- <p><xsl:value-of select="text()"/></p>
+ <xsl:for-each select="*">
+ <xsl:choose>
+ <xsl:when test="name()='p'">
+ <p><xsl:value-of select="text()"/></p>
+ </xsl:when>
+ <xsl:when test="name()='l'">
+ <p>
+ <xsl:value-of select="lh"/>
+ <ul>
+ <xsl:for-each select="li">
+ <li><xsl:value-of select="text()"/></li>
+ </xsl:for-each>
+ </ul>
+ <xsl:value-of select="lf"/>
+ </p>
+ </xsl:when>
+ </xsl:choose>
</xsl:for-each>
</xsl:otherwise>
</xsl:choose>
@@ -118,9 +133,9 @@
<xsl:call-template name="newline"/>
<xsl:if test="string-length(normalize-space(text())) > 0">
<xsl:call-template name="print-space">
- <xsl:with-param name="count" select="$level * 2"/>
+ <xsl:with-param name="count" select="$level * 2 + 2"/>
</xsl:call-template>
- <xsl:value-of select="text()"/>
+ <xsl:value-of select="normalize-space(text())"/>
<xsl:call-template name="newline"/>
</xsl:if>
<xsl:for-each select="*">
@@ -170,6 +185,17 @@
</xsl:if>
</li>
</xsl:when>
+ <xsl:when test="name() = 'r'">
+ <li>
+ <xsl:variable name="element-name" select="text()"/>
+ <b>
+ <<xsl:value-of select="text()"/>><xsl:value-of select="$element-suffix"/>
+ </b>
+ <div style="margin-left: 15px; display: inline;">
+ A response to a <a href="#{$element-name}"><xsl:value-of select="$element-name"/></a> command.
+ </div>
+ </li>
+ </xsl:when>
<xsl:when test="name() = 'e'">
<li>
<xsl:variable name="element-name" select="text()"/>
Modified: trunk/openvas-manager/src/schema_formats/HTML/rnc.xsl
===================================================================
--- trunk/openvas-manager/src/schema_formats/HTML/rnc.xsl 2010-10-27 13:46:57 UTC (rev 9300)
+++ trunk/openvas-manager/src/schema_formats/HTML/rnc.xsl 2010-10-27 19:49:21 UTC (rev 9301)
@@ -63,6 +63,12 @@
<xsl:value-of select="text()"/>
</xsl:template>
+ <xsl:template name="r" match="r">
+ <xsl:param name="parent-name"/>
+ <xsl:value-of select="text()"/>
+ <xsl:text>_response</xsl:text>
+ </xsl:template>
+
<xsl:template name="t" match="t">
<xsl:value-of select="text()"/>
</xsl:template>
@@ -116,6 +122,11 @@
</xsl:for-each>
<xsl:text> )</xsl:text>
</xsl:when>
+ <xsl:when test="name()='r'">
+ <xsl:call-template name="r">
+ <xsl:with-param name="parent-name" select="$parent-name"/>
+ </xsl:call-template>
+ </xsl:when>
<xsl:when test="name()='t'">
</xsl:when>
<xsl:otherwise>
Modified: trunk/openvas-manager/src/schema_formats/RNC/rnc.xsl
===================================================================
--- trunk/openvas-manager/src/schema_formats/RNC/rnc.xsl 2010-10-27 13:46:57 UTC (rev 9300)
+++ trunk/openvas-manager/src/schema_formats/RNC/rnc.xsl 2010-10-27 19:49:21 UTC (rev 9301)
@@ -63,6 +63,12 @@
<xsl:value-of select="text()"/>
</xsl:template>
+ <xsl:template name="r" match="r">
+ <xsl:param name="parent-name"/>
+ <xsl:value-of select="text()"/>
+ <xsl:text>_response</xsl:text>
+ </xsl:template>
+
<xsl:template name="t" match="t">
<xsl:value-of select="text()"/>
</xsl:template>
@@ -116,6 +122,11 @@
</xsl:for-each>
<xsl:text> )</xsl:text>
</xsl:when>
+ <xsl:when test="name()='r'">
+ <xsl:call-template name="r">
+ <xsl:with-param name="parent-name" select="$parent-name"/>
+ </xsl:call-template>
+ </xsl:when>
<xsl:when test="name()='t'">
</xsl:when>
<xsl:otherwise>
Modified: trunk/openvas-manager/src/schema_formats/XML/OMP.xml
===================================================================
--- trunk/openvas-manager/src/schema_formats/XML/OMP.xml 2010-10-27 13:46:57 UTC (rev 9300)
+++ trunk/openvas-manager/src/schema_formats/XML/OMP.xml 2010-10-27 19:49:21 UTC (rev 9301)
@@ -43,6 +43,11 @@
<pattern>text</pattern>
</type>
<type>
+ <name>integer</name>
+ <summary>An integer</summary>
+ <pattern>xsd:integer</pattern>
+ </type>
+ <type>
<name>name</name>
<pattern>xsd:string</pattern>
</type>
@@ -63,6 +68,11 @@
<pattern>xsd:token { pattern = "High|Medium|Low|Log|Debug" }</pattern>
</type>
<type>
+ <name>time_unit</name>
+ <summary>A unit of time</summary>
+ <pattern>xsd:token { pattern = "second|minute|hour|day|week|month|year|decade" }</pattern>
+ </type>
+ <type>
<name>uuid</name>
<pattern>xsd:token { pattern = "[0-9abcdefABCDEF\-]{1,40}" }</pattern>
</type>
@@ -175,6 +185,1082 @@
</response>
</command>
<command>
+ <name>create_agent</name>
+ <summary>Create an agent</summary>
+ <description>
+ <p>
+ The client uses the create_agent command to create a new agent.
+ </p>
+ </description>
+ <pattern>
+ <e>installer</e>
+ <e>name</e>
+ <o><e>comment</e></o>
+ <o><e>howto_install</e></o>
+ <o><e>howto_use</e></o>
+ </pattern>
+ <ele>
+ <name>installer</name>
+ <summary>A file that installs the agent on a target machine</summary>
+ <pattern>
+ <t>base64</t>
+ <e>signature</e>
+ </pattern>
+ <ele>
+ <name>signature</name>
+ <summary>A detached OpenPGP signature of the installer</summary>
+ <pattern><t>base64</t></pattern>
+ </ele>
+ </ele>
+ <ele>
+ <name>name</name>
+ <summary>A name for the installer</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the agent</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>howto_install</name>
+ <summary>A file that describes how to install the agent</summary>
+ <pattern>
+ <t>base64</t>
+ </pattern>
+ </ele>
+ <ele>
+ <name>howto_use</name>
+ <summary>A file that describes how to use the agent</summary>
+ <pattern>
+ <t>base64</t>
+ </pattern>
+ </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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create an agent</summary>
+ <request>
+ <create_agent>
+ <installer>
+ asdf3235saf3kjBVF...
+ <signature>iEYEABECAAYFA...</signature>
+ </installer>
+ <name>SLAD</name>
+ </create_agent>
+ </request>
+ <response>
+ <create_agent_response status="201" status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_agent_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_config</name>
+ <summary>Create a config</summary>
+ <description>
+ <p>
+ The client uses the create_config command to create a new config.
+ </p>
+ <l>
+ <lh>This command can be called in three ways:</lh>
+ <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>
+ </l>
+ </description>
+ <pattern>
+ <o><e>comment</e></o>
+ <or>
+ <e>copy</e>
+ <r>get_configs</r>
+ <e>rcfile</e>
+ </or>
+ <e>name</e>
+ </pattern>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the config</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>copy</name>
+ <!-- TODO UUIDs are normally in attributes. -->
+ <summary>The UUID of an existing config</summary>
+ <pattern>
+ <t>uuid</t>
+ </pattern>
+ </ele>
+ <ele>
+ <name>rcfile</name>
+ <summary>A openvasrc style file that defines the config</summary>
+ <pattern>
+ <t>base64</t>
+ </pattern>
+ </ele>
+ <ele>
+ <name>name</name>
+ <summary>A name for the config</summary>
+ <pattern><t>name</t></pattern>
+ </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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Copy a config</summary>
+ <request>
+ <create_config>
+ <copy>daba56c8-73ec-11df-a475-002264764cea</copy>
+ <name>Full</name>
+ </create_config>
+ </request>
+ <response>
+ <create_config_response status="201" status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_config_response>
+ </response>
+ </example>
+ <example>
+ <summary>Create a config from an RC file</summary>
+ <request>
+ <create_config>
+ <rcfile>asdf3235saf3kjBVF...</rcfile>
+ <name>Full</name>
+ </create_config>
+ </request>
+ <response>
+ <create_config_response status="201" status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_config_response>
+ </response>
+ </example>
+ <example>
+ <summary>Create a config from a GET_CONFIGS response</summary>
+ <request>
+ <create_config>
+ <get_configs_response>
+ <config id="daba56c8-73ec-11df-a475-002264764cea">
+ <name>Full and fast</name>
+ <truncated>...</truncated>
+ </config>
+ </get_configs_response>
+ </create_config>
+ </request>
+ <response>
+ <create_config_response status="201" status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_config_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_escalator</name>
+ <summary>Create an escalator</summary>
+ <description>
+ <p>
+ The client uses the create_escalator command to create a new
+ escalator.
+ </p>
+ </description>
+ <pattern>
+ <e>name</e>
+ <o><e>comment</e></o>
+ <e>condition</e>
+ <e>event</e>
+ <e>method</e>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>A name for the escalator</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the escalator</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>condition</name>
+ <summary>The condition that must be satisfied for escalation</summary>
+ <pattern>
+ text
+ <e>data</e>
+ </pattern>
+ <ele>
+ <name>data</name>
+ <summary>Some data that defines the condition</summary>
+ <pattern>
+ text
+ <e>name</e>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>The name of the condition data</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ </ele>
+ </ele>
+ <ele>
+ <name>event</name>
+ <summary>The event that must happen for escalation</summary>
+ <pattern>
+ text
+ <e>data</e>
+ </pattern>
+ <ele>
+ <name>data</name>
+ <summary>Some data that defines the event</summary>
+ <pattern>
+ text
+ <e>name</e>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>The name of the event data</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ </ele>
+ </ele>
+ <ele>
+ <name>method</name>
+ <summary>The method by which escalation must occur</summary>
+ <pattern>
+ text
+ <e>data</e>
+ </pattern>
+ <ele>
+ <name>data</name>
+ <summary>Some data that defines the method</summary>
+ <pattern>
+ text
+ <e>name</e>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>The name of the method data</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ </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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create an escalator</summary>
+ <request>
+ <create_escalator>
+ <name>emergency</name>
+ <condition>
+ Threat level at least
+ <data>
+ <name>level</name>
+ High
+ </data>
+ </condition>
+ <event>
+ Task run status changed
+ <data>
+ <name>status</name>
+ Done
+ </data>
+ </event>
+ <method>
+ Email
+ <data>
+ <name>to_address</name>
+ sally at example.org
+ </data>
+ <data>
+ <name>from_address</name>
+ bob at example.org
+ </data>
+ </method>
+ </create_escalator>
+ </request>
+ <response>
+ <create_escalator_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_escalator_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_lsc_credential</name>
+ <summary>Create an LSC credential</summary>
+ <description>
+ <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>
+ </description>
+ <pattern>
+ <e>name</e>
+ <o><e>comment</e></o>
+ <e>login</e>
+ <o><e>password</e></o>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>A name for the LSC credential</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the LSC credential</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>login</name>
+ <summary>The user name of the credential</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>password</name>
+ <summary>The password for the credential login</summary>
+ <pattern>
+ text
+ </pattern>
+ </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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create an LSC credential</summary>
+ <request>
+ <create_lsc_credential>
+ <name>cluster sally</name>
+ <login>sally</login>
+ <password>secret</password>
+ <comment>Sally's login to the cluster.</comment>
+ </create_lsc_credential>
+ </request>
+ <response>
+ <create_lsc_credential_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_lsc_credential_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_note</name>
+ <summary>Create a note</summary>
+ <description>
+ <p>
+ The client uses the create_note command to create a new note.
+ </p>
+ </description>
+ <pattern>
+ <e>text</e>
+ <e>nvt</e>
+ <o><e>comment</e></o>
+ <o><e>hosts</e></o>
+ <o><e>port</e></o>
+ <o><e>result</e></o>
+ <o><e>task</e></o>
+ <o><e>threat</e></o>
+ </pattern>
+ <ele>
+ <name>text</name>
+ <summary>The text of the note</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>nvt</name>
+ <summary>NVT to which note applies</summary>
+ <pattern>
+ <attrib>
+ <name>oid</name>
+ <type>oid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the note</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>hosts</name>
+ <summary>A textual list of hosts</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>port</name>
+ <summary>Port to which note applies</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>result</name>
+ <summary>Result to which note applies</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>task</name>
+ <summary>Task to which note applies</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>threat</name>
+ <summary>Threat level to which note applies</summary>
+ <pattern>
+ <t>threat</t>
+ </pattern>
+ </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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create a note</summary>
+ <request>
+ <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>
+ </request>
+ <response>
+ <create_note_response status="202"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_note_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_override</name>
+ <summary>Create an override</summary>
+ <description>
+ <p>
+ The client uses the create_override command to create a new override.
+ </p>
+ </description>
+ <pattern>
+ <e>text</e>
+ <e>nvt</e>
+ <o><e>comment</e></o>
+ <o><e>hosts</e></o>
+ <o><e>new_threat</e></o>
+ <o><e>port</e></o>
+ <o><e>result</e></o>
+ <o><e>task</e></o>
+ <o><e>threat</e></o>
+ </pattern>
+ <ele>
+ <name>text</name>
+ <summary>The text of the override</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>nvt</name>
+ <summary>NVT to which override applies</summary>
+ <pattern>
+ <attrib>
+ <name>oid</name>
+ <type>oid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the override</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>hosts</name>
+ <summary>A textual list of hosts</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>new_threat</name>
+ <summary>New threat level for result</summary>
+ <pattern>
+ <t>threat</t>
+ </pattern>
+ </ele>
+ <ele>
+ <name>port</name>
+ <summary>Port to which override applies</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>result</name>
+ <summary>Result to which override applies</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>task</name>
+ <summary>Task to which override applies</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>threat</name>
+ <summary>Threat level to which override applies</summary>
+ <pattern>
+ <t>threat</t>
+ </pattern>
+ </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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create an override</summary>
+ <request>
+ <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>
+ </request>
+ <response>
+ <create_override_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_override_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_schedule</name>
+ <summary>Create a schedule</summary>
+ <description>
+ <p>
+ The client uses the create_schedule command to create a new schedule.
+ </p>
+ </description>
+ <pattern>
+ <e>name</e>
+ <o><e>comment</e></o>
+ <e>first_time</e>
+ <e>duration</e>
+ <e>period</e>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>A name for the schedule</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the schedule</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>first_time</name>
+ <summary>The first time the schedule will run</summary>
+ <pattern>
+ <e>minute</e>
+ <e>hour</e>
+ <e>day_of_month</e>
+ <e>month</e>
+ <e>year</e>
+ </pattern>
+ <ele>
+ <name>minute</name>
+ <pattern><t>integer</t></pattern>
+ </ele>
+ <ele>
+ <name>hour</name>
+ <pattern><t>integer</t></pattern>
+ </ele>
+ <ele>
+ <name>day_of_month</name>
+ <pattern><t>integer</t></pattern>
+ </ele>
+ <ele>
+ <name>month</name>
+ <pattern><t>integer</t></pattern>
+ </ele>
+ <ele>
+ <name>year</name>
+ <pattern><t>integer</t></pattern>
+ </ele>
+ </ele>
+ <ele>
+ <name>duration</name>
+ <summary>How long the Manager will run the scheduled task for</summary>
+ <description>A duration of 0 means to run to completion.</description>
+ <pattern>
+ <e>unit</e>
+ </pattern>
+ <ele>
+ <name>unit</name>
+ <summary>Duration time unit</summary>
+ <pattern><t>time_unit</t></pattern>
+ </ele>
+ </ele>
+ <ele>
+ <name>period</name>
+ <summary>How often the Manager will repeat the scheduled task</summary>
+ <description>A period of 0 means to run once.</description>
+ <pattern>
+ <e>unit</e>
+ </pattern>
+ <ele>
+ <name>unit</name>
+ <summary>Period time unit</summary>
+ <pattern><t>time_unit</t></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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create a schedule</summary>
+ <request>
+ <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>
+ </request>
+ <response>
+ <create_schedule_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_schedule_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_target</name>
+ <summary>Create a target</summary>
+ <description>
+ <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>
+ </description>
+ <pattern>
+ <e>name</e>
+ <o><e>comment</e></o>
+ <e>hosts</e>
+ <e>lsc_credential</e>
+ <e>target_locator</e>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>A name for the target</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the target</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>hosts</name>
+ <summary>A textual list of hosts, which may be empty</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>lsc_credential</name>
+ <summary>Login credentials for target</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>target_locator</name>
+ <summary>Target locator (for example, for LDAP)</summary>
+ <pattern>
+ <o><e>username</e></o>
+ <o><e>password</e></o>
+ </pattern>
+ <ele>
+ <name>username</name>
+ <summary>The login for the target locator</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>password</name>
+ <summary>The password for the target locator</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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create a target, giving a host list</summary>
+ <request>
+ <create_target>
+ <create_target>
+ <name>All GNU/Linux machines</name>
+ <hosts>192.168.1.0/24</hosts>
+ </create_target>
+ </create_target>
+ </request>
+ <response>
+ <create_target_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_target_response>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>create_task</name>
+ <summary>Create a task</summary>
+ <description>
+ <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>
+ </description>
+ <pattern>
+ <e>name</e>
+ <o><e>comment</e></o>
+ <e>config</e>
+ <e>target</e>
+ <o><e>escalator</e></o>
+ <o><e>schedule</e></o>
+ <o><e>rcfile</e></o>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>A name for the task</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>comment</name>
+ <summary>A comment on the task</summary>
+ <pattern>
+ text
+ </pattern>
+ </ele>
+ <ele>
+ <name>config</name>
+ <summary>The scan configuration used by the task</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>target</name>
+ <summary>The hosts scanned by the task</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>escalator</name>
+ <summary>An escalator that applies to the task</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>schedule</name>
+ <summary>When the task will run</summary>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </ele>
+ <ele>
+ <name>rcfile</name>
+ <summary>An openvasrc style file defining the task</summary>
+ <pattern>
+ <t>base64</t>
+ </pattern>
+ </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>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create a task, giving a host list</summary>
+ <request>
+ <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>
+ </request>
+ <response>
+ <create_task_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_task_response>
+ </response>
+ </example>
+ </command>
+ <command>
<name>delete_agent</name>
<summary>Delete an agent</summary>
<description>
@@ -1292,9 +2378,7 @@
<ele>
<name>name</name>
<summary>The name of the task</summary>
- <pattern>
- text
- </pattern>
+ <pattern><t>name</t></pattern>
</ele>
<ele>
<name>rcfile</name>
More information about the Openvas-commits
mailing list