[Openvas-commits] r9351 - in trunk/openvas-manager: . doc src/schema_formats/HTML
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Wed Nov 3 18:32:55 CET 2010
Author: mattm
Date: 2010-11-03 18:32:51 +0100 (Wed, 03 Nov 2010)
New Revision: 9351
Modified:
trunk/openvas-manager/ChangeLog
trunk/openvas-manager/doc/omp.html
trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl
Log:
* src/schema_formats/HTML/HTML.xsl (type): Skip link for type "text".
* doc/omp.html: Update from source.
Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog 2010-11-03 17:29:22 UTC (rev 9350)
+++ trunk/openvas-manager/ChangeLog 2010-11-03 17:32:51 UTC (rev 9351)
@@ -1,5 +1,11 @@
2010-11-03 Matthew Mundell <matthew.mundell at greenbone.net>
+ * src/schema_formats/HTML/HTML.xsl (type): Skip link for type "text".
+
+ * doc/omp.html: Update from source.
+
+2010-11-03 Matthew Mundell <matthew.mundell at greenbone.net>
+
* src/schema_formats/HTML/HTML.xsl: Remove more bold.
2010-11-03 Matthew Mundell <matthew.mundell at greenbone.net>
Modified: trunk/openvas-manager/doc/omp.html
===================================================================
--- trunk/openvas-manager/doc/omp.html 2010-11-03 17:29:22 UTC (rev 9350)
+++ trunk/openvas-manager/doc/omp.html 2010-11-03 17:32:51 UTC (rev 9351)
@@ -420,7 +420,7 @@
<div><h3 id="command_authenticate">4.1
Command <tt>authenticate</tt>
</h3></div>
-<p><b>In short: </b>Authenticate with the manager.</p>
+<p>In short: Authenticate with the manager.</p>
<p>
The client uses the authenticate command to authenticate with the
Manager.
@@ -430,44 +430,41 @@
connection. The only commands permitted before authentication are
get_version and commands.
</p>
-<h4>4.1.1 Breakdown</h4>
+<h4>4.1.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>
- <credentials></b><ul style="list-style: none">
+<i>Command</i><ul style="list-style: none"><li>
+ <<b>credentials</b>>
+ <ul style="list-style: none">
<li>
-<b>
- <username></b><div style="margin-left: 15px; display: inline;">The login name of the user.</div>
+ <<b>username</b>>
+ <div style="margin-left: 15px; display: inline;">The login name of the user.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <password></b><div style="margin-left: 15px; display: inline;">The user's password.</div>
+ <<b>password</b>>
+ <div style="margin-left: 15px; display: inline;">The user's password.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.1.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>authenticate
+<i>Command</i><div style="margin-left: 5%"><pre>authenticate
= element authenticate
{
""
@@ -493,81 +490,80 @@
{
text
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>authenticate_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>authenticate_response
= element authenticate_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.1.1 Example: Authenticate with a good password</h4>
-<b>Client:</b><br><pre> <authenticate>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate>
<credentials>
<username>sally</username>
<password>secret</password>
</credentials>
</authenticate>
-</pre>
-<br><b>Manager:</b><br><pre> <authenticate_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate_response status="200" status_text="OK"/>
+</pre></div>
+</div>
<h4>4.1.1 Example: Authenticate with a bad password</h4>
-<b>Client:</b><br><pre> <authenticate>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate>
<credentials>
<username>sally</username>
<password>secrte</password>
</credentials>
</authenticate>
-</pre>
-<br><b>Manager:</b><br><pre> <authenticate_response status="400" status_text="Authentication failed"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <authenticate_response status="400" status_text="Authentication failed"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_commands">4.2
Command <tt>commands</tt>
</h3></div>
-<p><b>In short: </b>Run a list of commands.</p>
+<p>In short: Run a list of commands.</p>
<p>
The client uses the commands command to run a list of commands. The
elements are executed as OMP commands in the given sequence. The reply
contains the result of each command, in the same order as the given
commands.
</p>
-<h4>4.2.1 Breakdown</h4>
+<h4>4.2.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"></ul>
+<i>Command</i><ul style="list-style: none"></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.2.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>commands
+<i>Command</i><div style="margin-left: 5%"><pre>commands
= element commands
{
""
& command*
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>commands_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>commands_response
= element commands_response
{
""
@@ -575,66 +571,64 @@
& attribute status_text { text }
& response*
}
-</pre>
+</pre></div>
</div>
</div>
<div>
<div><h3 id="command_create_agent">4.3
Command <tt>create_agent</tt>
</h3></div>
-<p><b>In short: </b>Create an agent.</p>
+<p>In short: Create an agent.</p>
<p>
The client uses the create_agent command to create a new agent.
</p>
-<h4>4.3.1 Breakdown</h4>
+<h4>4.3.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <installer></b><div style="margin-left: 15px; display: inline;">A file that installs the agent on a target machine.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<b>howto_use</b>>
+ ?<div style="margin-left: 15px; display: inline;">A file that describes how to use the agent.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -642,8 +636,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_agent
= element create_agent
{
""
@@ -690,9 +683,8 @@
{
base64
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_agent_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_agent_response
= element create_agent_response
{
""
@@ -700,25 +692,27 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.3.1 Example: Create an agent</h4>
-<b>Client:</b><br><pre> <create_agent>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_agent>
<installer>
asdf3235saf3kjBVF...
<signature>iEYEABECAAYFA...</signature>
</installer>
<name>SLAD</name>
</create_agent>
-</pre>
-<br><b>Manager:</b><br><pre> <create_agent_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_agent_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_config">4.4
Command <tt>create_config</tt>
</h3></div>
-<p><b>In short: </b>Create a config.</p>
+<p>In short: Create a config.</p>
<p>
The client uses the create_config command to create a new config.
</p>
@@ -741,56 +735,53 @@
config is given this name.
</li>
</ul></p>
-<h4>4.4.1 Breakdown</h4>
+<h4>4.4.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <comment>?</b><div style="margin-left: 15px; display: inline;">A comment on the config.</div>
+ <<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>
+ <<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;">
+ <<b>get_configs></b><div style="margin-left: 15px; display: inline;">
A response to a <a href="#command_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>
+ <<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>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">A name for the config.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -798,8 +789,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_config
= element create_config
{
""
@@ -833,9 +823,8 @@
{
name
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_config_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_config_response
= element create_config_response
{
""
@@ -843,26 +832,31 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.4.1 Example: Copy a config</h4>
-<b>Client:</b><br><pre> <create_config>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config>
<copy>daba56c8-73ec-11df-a475-002264764cea</copy>
<name>Full</name>
</create_config>
-</pre>
-<br><b>Manager:</b><br><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
+</div>
<h4>4.4.1 Example: Create a config from an RC file</h4>
-<b>Client:</b><br><pre> <create_config>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config>
<rcfile>asdf3235saf3kjBVF...</rcfile>
<name>Full</name>
</create_config>
-</pre>
-<br><b>Manager:</b><br><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
+</div>
<h4>4.4.1 Example: Create a config from a GET_CONFIGS response</h4>
-<b>Client:</b><br><pre> <create_config>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config>
<get_configs_response>
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
@@ -870,88 +864,87 @@
</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>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_config_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_escalator">4.5
Command <tt>create_escalator</tt>
</h3></div>
-<p><b>In short: </b>Create an escalator.</p>
+<p>In short: Create an escalator.</p>
<p>
The client uses the create_escalator command to create a new
escalator.
</p>
-<h4>4.5.1 Breakdown</h4>
+<h4>4.5.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">A name for the escalator.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the method data.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -959,8 +952,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_escalator
= element create_escalator
{
""
@@ -1042,9 +1034,8 @@
{
text
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_escalator_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_escalator_response
= element create_escalator_response
{
""
@@ -1052,10 +1043,11 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.5.1 Example: Create an escalator</h4>
-<b>Client:</b><br><pre> <create_escalator>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_escalator>
<name>emergency</name>
<condition>
Threat level at least
@@ -1083,15 +1075,16 @@
</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>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_escalator_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_lsc_credential">4.6
Command <tt>create_lsc_credential</tt>
</h3></div>
-<p><b>In short: </b>Create an LSC credential.</p>
+<p>In short: Create an LSC credential.</p>
<p>
The client uses the create_lsc_credential command to create a new
LSC credential.
@@ -1101,46 +1094,44 @@
password only credential, otherwise the manager creates a key-based
credential.
</p>
-<h4>4.6.1 Breakdown</h4>
+<h4>4.6.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">A name for the LSC credential.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<b>password</b>>
+ ?<div style="margin-left: 15px; display: inline;">The password for the credential login.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -1148,8 +1139,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_lsc_credential
= element create_lsc_credential
{
""
@@ -1182,9 +1172,8 @@
{
text
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_lsc_credential_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_lsc_credential_response
= element create_lsc_credential_response
{
""
@@ -1192,96 +1181,96 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.6.1 Example: Create an LSC credential</h4>
-<b>Client:</b><br><pre> <create_lsc_credential>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_lsc_credential>
<name>cluster sally</name>
<login>sally</login>
<password>secret</password>
<comment>Sally's login to the cluster.</comment>
</create_lsc_credential>
-</pre>
-<br><b>Manager:</b><br><pre> <create_lsc_credential_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_lsc_credential_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_note">4.7
Command <tt>create_note</tt>
</h3></div>
-<p><b>In short: </b>Create a note.</p>
+<p>In short: Create a note.</p>
<p>
The client uses the create_note command to create a new note.
</p>
-<h4>4.7.1 Breakdown</h4>
+<h4>4.7.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <text></b><div style="margin-left: 15px; display: inline;">The text of the note.</div>
+ <<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>
+ <<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>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
<li>
-<b>
- <comment>?</b><div style="margin-left: 15px; display: inline;">A comment on the note.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <task>?</b><div style="margin-left: 15px; display: inline;">Task to which note applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <threat>?</b><div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
+ <<b>threat</b>>
+ ?<div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -1289,8 +1278,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_note
= element create_note
{
""
@@ -1354,9 +1342,8 @@
{
threat
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_note_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_note_response
= element create_note_response
{
""
@@ -1364,100 +1351,100 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.7.1 Example: Create a note</h4>
-<b>Client:</b><br><pre> <create_note>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_note>
<text>This issue should be resolved after the upgrade.</text>
<nvt>1.3.6.1.4.1.25623.1.0.10330</nvt>
<result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
</create_note>
-</pre>
-<br><b>Manager:</b><br><pre> <create_note_response status="202" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_note_response status="202" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_override">4.8
Command <tt>create_override</tt>
</h3></div>
-<p><b>In short: </b>Create an override.</p>
+<p>In short: Create an override.</p>
<p>
The client uses the create_override command to create a new override.
</p>
-<h4>4.8.1 Breakdown</h4>
+<h4>4.8.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <text></b><div style="margin-left: 15px; display: inline;">The text of the override.</div>
+ <<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>
+ <<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>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
<li>
-<b>
- <comment>?</b><div style="margin-left: 15px; display: inline;">A comment on the override.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <task>?</b><div style="margin-left: 15px; display: inline;">Task to which override applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <threat>?</b><div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
+ <<b>threat</b>>
+ ?<div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -1465,8 +1452,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_override
= element create_override
{
""
@@ -1537,9 +1523,8 @@
{
threat
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_override_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_override_response
= element create_override_response
{
""
@@ -1547,101 +1532,101 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.8.1 Example: Create an override</h4>
-<b>Client:</b><br><pre> <create_override>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_override>
<text>This is actually of little concern.</text>
<nvt>1.3.6.1.4.1.25623.1.0.10330</nvt>
<new_threat>Low</new_threat>
<result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
</create_override>
-</pre>
-<br><b>Manager:</b><br><pre> <create_override_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_override_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_schedule">4.9
Command <tt>create_schedule</tt>
</h3></div>
-<p><b>In short: </b>Create a schedule.</p>
+<p>In short: Create a schedule.</p>
<p>
The client uses the create_schedule command to create a new schedule.
</p>
-<h4>4.9.1 Breakdown</h4>
+<h4>4.9.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">A name for the schedule.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<b>minute</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <hour></b><ul style="list-style: none"></ul>
+ <<b>hour</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <day_of_month></b><ul style="list-style: none"></ul>
+ <<b>day_of_month</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <month></b><ul style="list-style: none"></ul>
+ <<b>month</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <year></b><ul style="list-style: none"></ul>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<b>unit</b>>
+ <div style="margin-left: 15px; display: inline;">Period time unit.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -1649,8 +1634,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_schedule
= element create_schedule
{
""
@@ -1739,9 +1723,8 @@
{
time_unit
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_schedule_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_schedule_response
= element create_schedule_response
{
""
@@ -1749,10 +1732,11 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.9.1 Example: Create a schedule</h4>
-<b>Client:</b><br><pre> <create_schedule>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_schedule>
<name>Every night</name>
<first_time>
<day_of_month>1</day_of_month>
@@ -1770,15 +1754,16 @@
<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>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_schedule_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_target">4.10
Command <tt>create_target</tt>
</h3></div>
-<p><b>In short: </b>Create a target.</p>
+<p>In short: Create a target.</p>
<p>
The client uses the create_target command to create a new target.
</p>
@@ -1786,65 +1771,63 @@
If the list of hosts is empty, the command must also include a
target locator.
</p>
-<h4>4.10.1 Breakdown</h4>
+<h4>4.10.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">A name for the target.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <target_locator></b><div style="margin-left: 15px; display: inline;">Target locator (for example, for LDAP).</div>
+ <<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>
+ <<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>
+ <<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 style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -1852,8 +1835,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_target
= element create_target
{
""
@@ -1908,9 +1890,8 @@
{
text
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_target_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_target_response
= element create_target_response
{
""
@@ -1918,24 +1899,26 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.10.1 Example: Create a target, giving a host list</h4>
-<b>Client:</b><br><pre> <create_target>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><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>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_target_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_create_task">4.11
Command <tt>create_task</tt>
</h3></div>
-<p><b>In short: </b>Create a task.</p>
+<p>In short: Create a task.</p>
<p>
The client uses the create_task command to create a new task.
</p>
@@ -1944,73 +1927,71 @@
left out. This form of the command is special support for
OpenVAS-Client, and will likely be removed in future versions.
</p>
-<h4>4.11.1 Breakdown</h4>
+<h4>4.11.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">A name for the task.</div>
+ <<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>
+ <<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>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <target></b><div style="margin-left: 15px; display: inline;">The hosts scanned by the task.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <escalator>?</b><div style="margin-left: 15px; display: inline;">An escalator that applies to the task.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <schedule>?</b><div style="margin-left: 15px; display: inline;">When the task will run.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <rcfile>?</b><div style="margin-left: 15px; display: inline;">An openvasrc style file defining the task.</div>
+ <<b>rcfile</b>>
+ ?<div style="margin-left: 15px; display: inline;">An openvasrc style file defining the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
</ul>
@@ -2018,8 +1999,7 @@
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>create_task
= element create_task
{
""
@@ -2077,9 +2057,8 @@
{
base64
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>create_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_task_response
= element create_task_response
{
""
@@ -2087,24 +2066,26 @@
& attribute status_text { text }
& attribute id { uuid }
}
-</pre>
+</pre></div>
</div>
<h4>4.11.1 Example: Create a task, giving a host list</h4>
-<b>Client:</b><br><pre> <create_task>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_task>
<name>Scan Webserver</name>
<comment>Hourly scan of the webserver</comment>
<config id="daba56c8-73ec-11df-a475-002264764cea"/>
<target id="b493b7a8-7489-11df-a3ec-002264764cea"/>
</create_task>
-</pre>
-<br><b>Manager:</b><br><pre> <create_task_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_task_response status="201" status_text="OK, resource created" id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_agent">4.12
Command <tt>delete_agent</tt>
</h3></div>
-<p><b>In short: </b>Delete an agent.</p>
+<p>In short: Delete an agent.</p>
<p>
The client uses the delete_agent command to delete an existing agent.
</p>
@@ -2113,60 +2094,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.12.1 Breakdown</h4>
+<h4>4.12.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@agent_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>agent_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_agent
= element delete_agent
{
""
& attribute agent_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_agent_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_agent_response
= element delete_agent_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_agent_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_config">4.13
Command <tt>delete_config</tt>
</h3></div>
-<p><b>In short: </b>Delete a config.</p>
+<p>In short: Delete a config.</p>
<p>
The client uses the delete_config command to delete an existing config.
</p>
@@ -2175,60 +2154,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.13.1 Breakdown</h4>
+<h4>4.13.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@config_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_config
= element delete_config
{
""
& attribute config_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_config_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_config_response
= element delete_config_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_config config_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_config_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_escalator">4.14
Command <tt>delete_escalator</tt>
</h3></div>
-<p><b>In short: </b>Delete an escalator.</p>
+<p>In short: Delete an escalator.</p>
<p>
The client uses the delete_escalator command to delete an existing
escalator.
@@ -2238,60 +2215,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.14.1 Breakdown</h4>
+<h4>4.14.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@escalator_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>escalator_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_escalator
= element delete_escalator
{
""
& attribute escalator_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_escalator_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_escalator_response
= element delete_escalator_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_escalator escalator_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_escalator_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_lsc_credential">4.15
Command <tt>delete_lsc_credential</tt>
</h3></div>
-<p><b>In short: </b>Delete an LSC credential.</p>
+<p>In short: Delete an LSC credential.</p>
<p>
The client uses the delete_lsc_credential command to delete an
existing LSC credential.
@@ -2301,60 +2276,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.15.1 Breakdown</h4>
+<h4>4.15.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@lsc_credential_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>lsc_credential_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_lsc_credential
= element delete_lsc_credential
{
""
& attribute lsc_credential_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_lsc_credential_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_lsc_credential_response
= element delete_lsc_credential_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_lsc_credential lsc_credential_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_lsc_credential_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_note">4.16
Command <tt>delete_note</tt>
</h3></div>
-<p><b>In short: </b>Delete a note.</p>
+<p>In short: Delete a note.</p>
<p>
The client uses the delete_note command to delete an existing note.
</p>
@@ -2363,60 +2336,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.16.1 Breakdown</h4>
+<h4>4.16.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@note_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>note_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_note
= element delete_note
{
""
& attribute note_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_note_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_note_response
= element delete_note_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_note note_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_note_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_override">4.17
Command <tt>delete_override</tt>
</h3></div>
-<p><b>In short: </b>Delete a override.</p>
+<p>In short: Delete a override.</p>
<p>
The client uses the delete_override command to delete an existing override.
</p>
@@ -2425,60 +2396,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.17.1 Breakdown</h4>
+<h4>4.17.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@override_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>override_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_override
= element delete_override
{
""
& attribute override_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_override_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_override_response
= element delete_override_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_override override_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_override_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_report">4.18
Command <tt>delete_report</tt>
</h3></div>
-<p><b>In short: </b>Delete a report.</p>
+<p>In short: Delete a report.</p>
<p>
The client uses the delete_report command to delete an existing report.
</p>
@@ -2487,60 +2456,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.18.1 Breakdown</h4>
+<h4>4.18.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@report_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>report_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_report
= element delete_report
{
""
& attribute report_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_report_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_report_response
= element delete_report_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_schedule">4.19
Command <tt>delete_schedule</tt>
</h3></div>
-<p><b>In short: </b>Delete a schedule.</p>
+<p>In short: Delete a schedule.</p>
<p>
The client uses the delete_schedule command to delete an existing schedule.
</p>
@@ -2549,60 +2516,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.19.1 Breakdown</h4>
+<h4>4.19.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@schedule_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>schedule_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_schedule
= element delete_schedule
{
""
& attribute schedule_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_schedule_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_schedule_response
= element delete_schedule_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_schedule schedule_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_schedule_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_target">4.20
Command <tt>delete_target</tt>
</h3></div>
-<p><b>In short: </b>Delete a target.</p>
+<p>In short: Delete a target.</p>
<p>
The client uses the delete_target command to delete an existing target.
</p>
@@ -2611,60 +2576,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.20.1 Breakdown</h4>
+<h4>4.20.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@target_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>target_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_target
= element delete_target
{
""
& attribute target_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_target_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_target_response
= element delete_target_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_target target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_target_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_delete_task">4.21
Command <tt>delete_task</tt>
</h3></div>
-<p><b>In short: </b>Delete a task.</p>
+<p>In short: Delete a task.</p>
<p>
The client uses the delete_task command to delete an existing task,
including all reports associated with the task.
@@ -2674,60 +2637,58 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>4.21.1 Breakdown</h4>
+<h4>4.21.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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
+<i>Command</i><div style="margin-left: 5%"><pre>delete_task
= element delete_task
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>delete_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_task_response
= element delete_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_agents">4.22
Command <tt>get_agents</tt>
</h3></div>
-<p><b>In short: </b>Get all agents.</p>
+<p>In short: Get all agents.</p>
<p>
The client uses the get_agents command to get agent information.
If the command sent by the client was valid, the manager will
@@ -2738,79 +2699,77 @@
include installer elements, otherwise they include package
elements.
</p>
-<h4>4.22.1 Breakdown</h4>
+<h4>4.22.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@agent_id</b>
+ @<b>agent_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single agent to get.
</li>
<li>
-<b>@format</b>
+ @<b>format</b>
("installer", "howto_install" or "howto_use")
</li>
<li>
-<b>@sort_order</b>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
-<b>@sort_field</b>
- (<a href="#type_text">text</a>)
+ @<b>sort_field</b>
+ (text)
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <agent>*</b><ul style="list-style: none">
+ <<b>agent</b>>
+ *<ul style="list-style: none">
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the agent.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the agent.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <comment></b><div style="margin-left: 15px; display: inline;">The comment on the agent.</div>
+ <<b>comment</b>>
+ <div style="margin-left: 15px; display: inline;">The comment on the agent.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <in_use></b><div style="margin-left: 15px; display: inline;">Whether the agent is in use.</div>
+ <<b>in_use</b>>
+ <div style="margin-left: 15px; display: inline;">Whether the agent is in use.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>One of</i><ul style="list-style: none">
<li>
-<b>
- <installer></b><ul style="list-style: none"><li>
-<b>
- <trust></b><div style="margin-left: 15px; display: inline;">Whether signature verification succeeded.</div>
+ <<b>installer</b>>
+ <ul style="list-style: none"><li>
+ <<b>trust</b>>
+ <div style="margin-left: 15px; display: inline;">Whether signature verification succeeded.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
-<b>
- <package></b><div style="margin-left: 15px; display: inline;">Either the installer or one of the HOWTOs.</div>
+ <<b>package</b>>
+ <div style="margin-left: 15px; display: inline;">Either the installer or one of the HOWTOs.</div>
<ul style="list-style: none"><li>
-<b>
- <filename></b><div style="margin-left: 15px; display: inline;">The filename of the package.</div>
+ <<b>filename</b>>
+ <div style="margin-left: 15px; display: inline;">The filename of the package.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
@@ -2823,8 +2782,7 @@
</ul>
<h4>4.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_agents
+<i>Command</i><div style="margin-left: 5%"><pre>get_agents
= element get_agents
{
""
@@ -2833,9 +2791,8 @@
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_agents_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_agents_response
= element get_agents_response
{
""
@@ -2899,12 +2856,13 @@
{
text
}
-</pre>
+</pre></div>
</div>
<h4>4.22.1 Example: Get all agents</h4>
-<b>Client:</b><br><pre> <get_agents/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_agents_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents_response status="200" status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
@@ -2915,11 +2873,13 @@
</agent>
...
</get_agents_response>
-</pre>
+</pre></div>
+</div>
<h4>4.22.1 Example: Get one agent</h4>
-<b>Client:</b><br><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_agents_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents_response status="200" status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
@@ -2929,11 +2889,13 @@
</installer>
</agent>
</get_agents_response>
-</pre>
+</pre></div>
+</div>
<h4>4.22.1 Example: Get one agent, including the installer package</h4>
-<b>Client:</b><br><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf" format="installer"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_agents_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf" format="installer"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents_response status="200" status_text="OK">
<agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>Custom Scan Agent</name>
<comment>Custom agent for use on the Web servers.</comment>
@@ -2944,174 +2906,173 @@
</package>
</agent>
</get_agents_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_configs">4.23
Command <tt>get_configs</tt>
</h3></div>
-<p><b>In short: </b>Get all configs.</p>
+<p>In short: Get all configs.</p>
<p>
The client uses the get_configs command to get config information.
If the command sent by the client was valid, the manager will
reply with a list of configs to the client.
</p>
-<h4>4.23.1 Breakdown</h4>
+<h4>4.23.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@config_id</b>
+ @<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single config to get.
</li>
<li>
-<b>@families</b>
+ @<b>families</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
-<b>@preferences</b>
+ @<b>preferences</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
-<b>@sort_order</b>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
-<b>@sort_field</b>
- (<a href="#type_text">text</a>)
+ @<b>sort_field</b>
+ (text)
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <config>*</b><ul style="list-style: none">
+ <<b>config</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the config.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <comment></b><div style="margin-left: 15px; display: inline;">The comment on the config.</div>
+ <<b>comment</b>>
+ <div style="margin-left: 15px; display: inline;">The comment on the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <family_count></b><div style="margin-left: 15px; display: inline;">The number of families selected by the config.</div>
+ <<b>family_count</b>>
+ <div style="margin-left: 15px; display: inline;">The number of families selected by the config.</div>
<ul style="list-style: none"><li>
-<b>
- <growing></b><div style="margin-left: 15px; display: inline;">Whether new families are automatically added to the config.</div>
+ <<b>growing</b>>
+ <div style="margin-left: 15px; display: inline;">Whether new families are automatically added to the config.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
-<b>
- <nvt_count></b><div style="margin-left: 15px; display: inline;">The number of NVTs selected by the config.</div>
+ <<b>nvt_count</b>>
+ <div style="margin-left: 15px; display: inline;">The number of NVTs selected by the config.</div>
<ul style="list-style: none"><li>
-<b>
- <growing></b><div style="margin-left: 15px; display: inline;">Whether new NVTs are automatically added to the config.</div>
+ <<b>growing</b>>
+ <div style="margin-left: 15px; display: inline;">Whether new NVTs are automatically added to the config.</div>
<ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
-<b>
- <in_use></b><div style="margin-left: 15px; display: inline;">Whether any tasks are using the config.</div>
+ <<b>in_use</b>>
+ <div style="margin-left: 15px; display: inline;">Whether any tasks are using the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <tasks></b><div style="margin-left: 15px; display: inline;">All tasks using the config.</div>
+ <<b>tasks</b>>
+ <div style="margin-left: 15px; display: inline;">All tasks using the config.</div>
<ul style="list-style: none"><li>
-<b>
- <task>*</b><ul style="list-style: none">
+ <<b>task</b>>
+ *<ul style="list-style: none">
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the task.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li>
-<b>
- <families>?</b><div style="margin-left: 15px; display: inline;">All families selected by the config.</div>
+ <<b>families</b>>
+ ?<div style="margin-left: 15px; display: inline;">All families selected by the config.</div>
<ul style="list-style: none"><li>
-<b>
- <family>*</b><ul style="list-style: none">
+ <<b>family</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the family.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <nvt_count></b><div style="margin-left: 15px; display: inline;">The number of NVTs selected in the family.</div>
+ <<b>nvt_count</b>>
+ <div style="margin-left: 15px; display: inline;">The number of NVTs selected in the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <max_nvt_count></b><div style="margin-left: 15px; display: inline;">The total number of NVTs in the family.</div>
+ <<b>max_nvt_count</b>>
+ <div style="margin-left: 15px; display: inline;">The total number of NVTs in the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <growing></b><div style="margin-left: 15px; display: inline;">Whether new NVTs in the family are automatically added to the selection.</div>
+ <<b>growing</b>>
+ <div style="margin-left: 15px; display: inline;">Whether new NVTs in the family are automatically added to the selection.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li>
-<b>
- <preferences>?</b><div style="margin-left: 15px; display: inline;">Preferences for all NVTs selected by the config.</div>
+ <<b>preferences</b>>
+ ?<div style="margin-left: 15px; display: inline;">Preferences for all NVTs selected by the config.</div>
<ul style="list-style: none"><li>
-<b>
- <preference>*</b><ul style="list-style: none">
+ <<b>preference</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <nvt></b><div style="margin-left: 15px; display: inline;">NVT to which override applies.</div>
+ <<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>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the family.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <type></b><div style="margin-left: 15px; display: inline;">The type of preference.</div>
+ <<b>type</b>>
+ <div style="margin-left: 15px; display: inline;">The type of preference.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <value></b><div style="margin-left: 15px; display: inline;">The value of the preference.</div>
+ <<b>value</b>>
+ <div style="margin-left: 15px; display: inline;">The value of the preference.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
@@ -3124,8 +3085,7 @@
</ul>
<h4>4.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_configs
+<i>Command</i><div style="margin-left: 5%"><pre>get_configs
= element get_configs
{
""
@@ -3135,9 +3095,8 @@
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_configs_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_configs_response
= element get_configs_response
{
""
@@ -3314,12 +3273,13 @@
{
text
}
-</pre>
+</pre></div>
</div>
<h4>4.23.1 Example: Get all configs</h4>
-<b>Client:</b><br><pre> <get_configs/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_configs_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs_response status="200" status_text="OK">
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
<comment>
@@ -3343,11 +3303,13 @@
</config>
...
</get_configs_response>
-</pre>
+</pre></div>
+</div>
<h4>4.23.1 Example: Get a single config, including preference and family lists</h4>
-<b>Client:</b><br><pre> <get_configs config_id="daba56c8-73ec-11df-a475-002264764cea" preferences="1" families="1"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_configs_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs config_id="daba56c8-73ec-11df-a475-002264764cea" preferences="1" families="1"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs_response status="200" status_text="OK">
<config id="daba56c8-73ec-11df-a475-002264764cea">
<name>Full and fast</name>
<comment>
@@ -3391,62 +3353,61 @@
</config>
...
</get_configs_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_dependencies">4.24
Command <tt>get_dependencies</tt>
</h3></div>
-<p><b>In short: </b>Get dependencies for all available NVTs.</p>
+<p>In short: Get dependencies for all available NVTs.</p>
<p>
The client uses the get_dependencies command to request the
dependencies for one or all NVTs available through this manager.
</p>
-<h4>4.24.1 Breakdown</h4>
+<h4>4.24.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@nvt_oid</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
ID of single NVT for which to get dependencies.
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <nvt>*</b><ul style="list-style: none">
+ <<b>nvt</b>>
+ *<ul style="list-style: none">
<li>
-<b>@oid</b>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <requires></b><ul style="list-style: none"><li>
-<b>
- <nvt>*</b><ul style="list-style: none">
+ <<b>requires</b>>
+ <ul style="list-style: none"><li>
+ <<b>nvt</b>>
+ *<ul style="list-style: none">
<li>
-<b>@oid</b>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
@@ -3459,16 +3420,14 @@
</ul>
<h4>4.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>get_dependencies
+<i>Command</i><div style="margin-left: 5%"><pre>get_dependencies
= element get_dependencies
{
""
& attribute nvt_oid { oid }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_dependencies_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_dependencies_response
= element get_dependencies_response
{
""
@@ -3512,12 +3471,13 @@
{
name
}
-</pre>
+</pre></div>
</div>
<h4>4.24.1 Example: Get dependencies for all NVTs</h4>
-<b>Client:</b><br><pre> <get_dependencies/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_dependencies_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies_response status="200" status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.0.114664">
<name>Dependency Test</name>
<requires>
@@ -3528,11 +3488,13 @@
</nvt>
...
</get_dependencies_response>
-</pre>
+</pre></div>
+</div>
<h4>4.24.1 Example: Get dependencies for a single NVT</h4>
-<b>Client:</b><br><pre> <get_dependencies nvt_oid="1.3.6.1.4.1.25623.1.0.114664"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_dependencies_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies nvt_oid="1.3.6.1.4.1.25623.1.0.114664"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies_response status="200" status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.0.114664">
<name>Dependency Test</name>
<requires>
@@ -3542,102 +3504,101 @@
</requires>
</nvt>
</get_dependencies_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_escalators">4.25
Command <tt>get_escalators</tt>
</h3></div>
-<p><b>In short: </b>Get all escalators.</p>
+<p>In short: Get all escalators.</p>
<p>
The client uses the get_escalators command to get escalator information.
If the command sent by the client was valid, the manager will
reply with a list of escalators to the client.
</p>
-<h4>4.25.1 Breakdown</h4>
+<h4>4.25.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@escalator_id</b>
+ @<b>escalator_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single escalator to get.
</li>
<li>
-<b>@sort_order</b>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
-<b>@sort_field</b>
- (<a href="#type_text">text</a>)
+ @<b>sort_field</b>
+ (text)
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <escalator>*</b><ul style="list-style: none">
+ <<b>escalator</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the escalator.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <comment></b><div style="margin-left: 15px; display: inline;">The comment on the escalator.</div>
+ <<b>comment</b>>
+ <div style="margin-left: 15px; display: inline;">The comment on the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <in_use></b><div style="margin-left: 15px; display: inline;">Whether any tasks are using the escalator.</div>
+ <<b>in_use</b>>
+ <div style="margin-left: 15px; display: inline;">Whether any tasks are using the escalator.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <condition></b><div style="margin-left: 15px; display: inline;">The condition that must be satisfied for escalation.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
@@ -3649,8 +3610,7 @@
</ul>
<h4>4.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>get_escalators
+<i>Command</i><div style="margin-left: 5%"><pre>get_escalators
= element get_escalators
{
""
@@ -3658,9 +3618,8 @@
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_escalators_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_escalators_response
= element get_escalators_response
{
""
@@ -3758,12 +3717,13 @@
{
text
}
-</pre>
+</pre></div>
</div>
<h4>4.25.1 Example: Get the escalators</h4>
-<b>Client:</b><br><pre> <get_escalators/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_escalators_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_escalators/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_escalators_response status="200" status_text="OK">
<escalator id="6181e65d-8ba0-4937-9c44-8f2b10b0def7">
<name>Team alert</name>
<comment/>
@@ -3800,111 +3760,110 @@
</escalator>
...
</get_escalators_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_lsc_credentials">4.26
Command <tt>get_lsc_credentials</tt>
</h3></div>
-<p><b>In short: </b>Get all LSC credentials.</p>
+<p>In short: Get all LSC credentials.</p>
<p>
The client uses the get_lsc_credentials command to get LSC credential information.
If the command sent by the client was valid, the manager will
reply with a list of LSC credentials to the client.
</p>
-<h4>4.26.1 Breakdown</h4>
+<h4>4.26.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@lsc_credential_id</b>
+ @<b>lsc_credential_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single LSC credential to get.
</li>
<li>
-<b>@format</b>
+ @<b>format</b>
("key", "rpm", "deb" or "exe")
</li>
<li>
-<b>@sort_order</b>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
-<b>@sort_field</b>
- (<a href="#type_text">text</a>)
+ @<b>sort_field</b>
+ (text)
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <lsc_credential>*</b><ul style="list-style: none">
+ <<b>lsc_credential</b>>
+ *<ul style="list-style: none">
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the LSC credential.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <login></b><div style="margin-left: 15px; display: inline;">The username of the LSC credential.</div>
+ <<b>login</b>>
+ <div style="margin-left: 15px; display: inline;">The username of the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <comment></b><div style="margin-left: 15px; display: inline;">The comment on the LSC credential.</div>
+ <<b>comment</b>>
+ <div style="margin-left: 15px; display: inline;">The comment on the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <in_use></b><div style="margin-left: 15px; display: inline;">Whether any targets are using the LSC credential.</div>
+ <<b>in_use</b>>
+ <div style="margin-left: 15px; display: inline;">Whether any targets are using the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <type></b><div style="margin-left: 15px; display: inline;">The type of the LSC credential.</div>
+ <<b>type</b>>
+ <div style="margin-left: 15px; display: inline;">The type of the LSC credential.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <targets></b><div style="margin-left: 15px; display: inline;">All targets using this LSC credential.</div>
+ <<b>targets</b>>
+ <div style="margin-left: 15px; display: inline;">All targets using this LSC credential.</div>
<ul style="list-style: none"><li>
-<b>
- <target>*</b><ul style="list-style: none">
+ <<b>target</b>>
+ *<ul style="list-style: none">
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the target.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the target.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li></ul>
</li>
<li>
-<b>
- <public_key>?</b><ul style="list-style: none"></ul>
+ <<b>public_key</b>>
+ ?<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <package>?</b><ul style="list-style: none"><li>
-<b>@format</b>
+ <<b>package</b>>
+ ?<ul style="list-style: none"><li>
+ @<b>format</b>
("rpm", "deb" or "exe")
</li></ul>
</li>
@@ -3915,8 +3874,7 @@
</ul>
<h4>4.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>get_lsc_credentials
+<i>Command</i><div style="margin-left: 5%"><pre>get_lsc_credentials
= element get_lsc_credentials
{
""
@@ -3925,9 +3883,8 @@
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_lsc_credentials_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_lsc_credentials_response
= element get_lsc_credentials_response
{
""
@@ -4014,12 +3971,13 @@
base64
& attribute format { xsd:token { pattern = "rpm|deb|exe" } }
}
-</pre>
+</pre></div>
</div>
<h4>4.26.1 Example: Get all the LSC credentials</h4>
-<b>Client:</b><br><pre> <get_lsc_credentials/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_lsc_credentials_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials_response status="200" status_text="OK">
<lsc_credential id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
<name>sally</name>
<login>sally</login>
@@ -4042,11 +4000,13 @@
</lsc_credential>
...
</get_lsc_credentials_response>
-</pre>
+</pre></div>
+</div>
<h4>4.26.1 Example: Get the public key of a single LSC credential</h4>
-<b>Client:</b><br><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15" format="key"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_lsc_credentials_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15" format="key"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials_response status="200" status_text="OK">
<lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<login>bob</login>
@@ -4063,11 +4023,13 @@
</public_key>
</lsc_credential>
</get_lsc_credentials_response>
-</pre>
+</pre></div>
+</div>
<h4>4.26.1 Example: Get the Debian package of a single LSC credential</h4>
-<b>Client:</b><br><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15" format="deb"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_lsc_credentials_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15" format="deb"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials_response status="200" status_text="OK">
<lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
<name>bob</name>
<login>bob</login>
@@ -4082,175 +4044,174 @@
<package format="deb">ITxhcmNoPgpk...DmvF0AKAAACg==</package>
</lsc_credential>
</get_lsc_credentials_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_notes">4.27
Command <tt>get_notes</tt>
</h3></div>
-<p><b>In short: </b>Get all notes.</p>
+<p>In short: Get all notes.</p>
<p>
The client uses the get_notes command to get note information.
If the command sent by the client was valid, the manager will
reply with a list of notes to the client.
</p>
-<h4>4.27.1 Breakdown</h4>
+<h4>4.27.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@note_id</b>
+ @<b>note_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single note to get.
</li>
<li>
-<b>@nvt_oid</b>
+ @<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>@task_id</b>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>@details</b>
+ @<b>details</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
-<b>@result</b>
+ @<b>result</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
-<b>@sort_order</b>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
-<b>@sort_field</b>
- (<a href="#type_text">text</a>)
+ @<b>sort_field</b>
+ (text)
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <note>*</b><ul style="list-style: none">
+ <<b>note</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <nvt></b><ul style="list-style: none">
+ <<b>nvt</b>>
+ <ul style="list-style: none">
<li>
-<b>@oid</b>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>
- <name></b><ul style="list-style: none"></ul>
+ <<b>name</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
-<b>
- <text></b><div style="margin-left: 15px; display: inline;">The text of the note.</div>
+ <<b>text</b>>
+ <div style="margin-left: 15px; display: inline;">The text of the note.</div>
<ul style="list-style: none"><li>
-<b>@excerpt</b>
+ @<b>excerpt</b>
(<a href="#type_boolean">boolean</a>)
</li></ul>
</li>
<li>
-<b>
- <orphan></b><div style="margin-left: 15px; display: inline;">Whether the note is an orphan.</div>
+ <<b>orphan</b>>
+ <div style="margin-left: 15px; display: inline;">Whether the note is an orphan.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
-<b>
- <creation_time></b><ul style="list-style: none"></ul>
+ <<b>creation_time</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <modification_time></b><ul style="list-style: none"></ul>
+ <<b>modification_time</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <hosts></b><div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
+ <<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>
+ <<b>port</b>>
+ <div style="margin-left: 15px; display: inline;">Port to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <threat></b><div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
+ <<b>threat</b>>
+ <div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <task></b><div style="margin-left: 15px; display: inline;">Task to which note applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <result>?</b><div style="margin-left: 15px; display: inline;">Result to which note applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>
- <subnet></b><ul style="list-style: none"></ul>
+ <<b>subnet</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <host></b><ul style="list-style: none"></ul>
+ <<b>host</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <port></b><ul style="list-style: none"></ul>
+ <<b>port</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <nvt></b><ul style="list-style: none">
+ <<b>nvt</b>>
+ <ul style="list-style: none">
<li>
-<b>@oid</b>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>
- <name></b><ul style="list-style: none"></ul>
+ <<b>name</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <cvss_base></b><ul style="list-style: none"></ul>
+ <<b>cvss_base</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <risk_factor></b><ul style="list-style: none"></ul>
+ <<b>risk_factor</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
-<b>
- <threat></b><ul style="list-style: none"></ul>
+ <<b>threat</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <description></b><ul style="list-style: none"></ul>
+ <<b>description</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
@@ -4263,8 +4224,7 @@
</ul>
<h4>4.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>get_notes
+<i>Command</i><div style="margin-left: 5%"><pre>get_notes
= element get_notes
{
""
@@ -4276,9 +4236,8 @@
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_notes_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_notes_response
= element get_notes_response
{
""
@@ -4437,12 +4396,13 @@
{
text
}
-</pre>
+</pre></div>
</div>
<h4>4.27.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">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes_response status="200" status_text="OK">
<note id="b76b81a7-9df8-42df-afff-baa9d4620128">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
@@ -4452,11 +4412,13 @@
</note>
...
</get_notes_response>
-</pre>
+</pre></div>
+</div>
<h4>4.27.1 Example: Get details of a single note</h4>
-<b>Client:</b><br><pre> <get_notes note_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1" result="1"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_notes_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes note_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1" result="1"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes_response status="200" status_text="OK">
<note id="7f618bbb-4664-419e-9bbf-367d93954cb0">
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
@@ -4486,13 +4448,14 @@
</note>
...
</get_notes_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_nvts">4.28
Command <tt>get_nvts</tt>
</h3></div>
-<p><b>In short: </b>Get all NVTs.</p>
+<p>In short: Get all NVTs.</p>
<p>
The client uses the get_nvts command to get NVT information.
</p>
@@ -4520,173 +4483,171 @@
NVT information. If the manager cannot access a list of available
NVTs at that time, it will reply with the 503 response.
</p>
-<h4>4.28.1 Breakdown</h4>
+<h4>4.28.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@nvt_oid</b>
+ @<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
Single NVT to get.
</li>
<li>
-<b>@details</b>
+ @<b>details</b>
(<a href="#type_boolean">boolean</a>)
Whether to include full details.
</li>
<li>
-<b>@preferences</b>
+ @<b>preferences</b>
(<a href="#type_boolean">boolean</a>)
Whether to include preference.
</li>
<li>
-<b>@preference_count</b>
+ @<b>preference_count</b>
(<a href="#type_boolean">boolean</a>)
Whether to include preference count.
</li>
<li>
-<b>@timeout</b>
+ @<b>timeout</b>
(<a href="#type_boolean">boolean</a>)
Whether to include the special timeout preference.
</li>
<li>
-<b>@config_id</b>
+ @<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
ID of config to which to limit the NVT listing.
</li>
<li>
-<b>@family</b>
- (<a href="#type_text">text</a>)
+ @<b>family</b>
+ (text)
Family to which to limit NVT listing.
</li>
<li>
-<b>@sort_order</b>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
-<b>@sort_field</b>
- (<a href="#type_text">text</a>)
+ @<b>sort_field</b>
+ (text)
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <nvt></b><ul style="list-style: none">
+ <<b>nvt</b>>
+ <ul style="list-style: none">
<li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the NVT.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <checksum></b><ul style="list-style: none"><li>
-<b>
- <algorithm></b><ul style="list-style: none"></ul>
+ <<b>checksum</b>>
+ <ul style="list-style: none"><li>
+ <<b>algorithm</b>>
+ <ul style="list-style: none"></ul>
</li></ul>
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
-<b>
- <category></b><ul style="list-style: none"></ul>
+ <<b>category</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <copyright></b><ul style="list-style: none"></ul>
+ <<b>copyright</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <description></b><ul style="list-style: none"></ul>
+ <<b>description</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <summary></b><ul style="list-style: none"></ul>
+ <<b>summary</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <family></b><ul style="list-style: none"></ul>
+ <<b>family</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <version></b><ul style="list-style: none"></ul>
+ <<b>version</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <cvss_base></b><ul style="list-style: none"></ul>
+ <<b>cvss_base</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <risk_factor></b><ul style="list-style: none"></ul>
+ <<b>risk_factor</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <cve_id></b><ul style="list-style: none"></ul>
+ <<b>cve_id</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <bugtraq_id></b><ul style="list-style: none"></ul>
+ <<b>bugtraq_id</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <xrefs></b><ul style="list-style: none"></ul>
+ <<b>xrefs</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <fingerprints></b><ul style="list-style: none"></ul>
+ <<b>fingerprints</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <tags></b><ul style="list-style: none"></ul>
+ <<b>tags</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <preference_count>?</b><ul style="list-style: none"></ul>
+ <<b>preference_count</b>>
+ ?<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <timeout>?</b><ul style="list-style: none"></ul>
+ <<b>timeout</b>>
+ ?<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <preferences>?</b><ul style="list-style: none">
+ <<b>preferences</b>>
+ ?<ul style="list-style: none">
<li>
-<b>
- <timeout></b><ul style="list-style: none"></ul>
+ <<b>timeout</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <preference>*</b><ul style="list-style: none">
+ <<b>preference</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <nvt></b><ul style="list-style: none"></ul>
+ <<b>nvt</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <name></b><ul style="list-style: none"></ul>
+ <<b>name</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <type></b><ul style="list-style: none"></ul>
+ <<b>type</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <value></b><ul style="list-style: none"></ul>
+ <<b>value</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
@@ -4701,8 +4662,7 @@
</ul>
<h4>4.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>get_nvts
+<i>Command</i><div style="margin-left: 5%"><pre>get_nvts
= element get_nvts
{
""
@@ -4716,9 +4676,8 @@
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_nvts_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_nvts_response
= element get_nvts_response
{
""
@@ -4908,12 +4867,13 @@
{
text
}
-</pre>
+</pre></div>
</div>
<h4>4.28.1 Example: Get full NVT listing</h4>
-<b>Client:</b><br><pre> <get_nvts details="1" timeout="1" preference_count="1" preferences="1"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_nvts_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts details="1" timeout="1" preference_count="1" preferences="1"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts_response status="200" status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.7.13005">
<name>Services</name>
<category>Services</category>
@@ -4961,11 +4921,13 @@
</nvt>
...
</get_nvts_response>
-</pre>
+</pre></div>
+</div>
<h4>4.28.1 Example: Get minimal information about one NVT</h4>
-<b>Client:</b><br><pre> <get_nvts nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_nvts_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts_response status="200" status_text="OK">
<nvt oid="1.3.6.1.4.1.25623.1.0.10330">
<name>Services</name>
<checksum>
@@ -4974,51 +4936,50 @@
</checksum>
</nvt>
</get_nvts_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_nvt_families">4.29
Command <tt>get_nvt_families</tt>
</h3></div>
-<p><b>In short: </b>Get a list of all NVT families.</p>
+<p>In short: Get a list of all NVT families.</p>
<p>
The client uses the get_nvt_families command to get NVT family
information. If the command sent by the client was valid, the
manager will reply with a list of NVT families to the client.
</p>
-<h4>4.29.1 Breakdown</h4>
+<h4>4.29.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@sort_order</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <families></b><ul style="list-style: none"><li>
-<b>
- <family>*</b><ul style="list-style: none">
+ <<b>families</b>>
+ <ul style="list-style: none"><li>
+ <<b>family</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the family.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the family.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <max_nvt_count></b><div style="margin-left: 15px; display: inline;">The number of NVTs in the family.</div>
+ <<b>max_nvt_count</b>>
+ <div style="margin-left: 15px; display: inline;">The number of NVTs in the family.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
@@ -5029,16 +4990,14 @@
</ul>
<h4>4.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>get_nvt_families
+<i>Command</i><div style="margin-left: 5%"><pre>get_nvt_families
= element get_nvt_families
{
""
& attribute sort_order { sort_order }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_nvt_families_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_nvt_families_response
= element get_nvt_families_response
{
""
@@ -5073,12 +5032,13 @@
{
integer
}
-</pre>
+</pre></div>
</div>
<h4>4.29.1 Example: Get the NVT families</h4>
-<b>Client:</b><br><pre> <get_nvt_families/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_nvt_families_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_families/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_families_response status="200" status_text="OK">
<families>
<family>
<name>Credentials</name>
@@ -5091,13 +5051,14 @@
...
</families>
</get_nvt_families_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_nvt_feed_checksum">4.30
Command <tt>get_nvt_feed_checksum</tt>
</h3></div>
-<p><b>In short: </b>Get checksum for entire NVT collection.</p>
+<p>In short: Get checksum for entire NVT collection.</p>
<p>
The client uses the get_nvt_feed_checksum command to request a
checksum for the complete NVT collection available through this
@@ -5118,31 +5079,29 @@
files. If the manager cannot access a list of available NVTs at
present, it will reply with the 503 response.
</p>
-<h4>4.30.1 Breakdown</h4>
+<h4>4.30.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@algorithm</b>
- (<a href="#type_text">text</a>)
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>algorithm</b>
+ (text)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <checksum></b><ul style="list-style: none"><li>
-<b>@algorithm</b>
- (<a href="#type_text">text</a>)
+ <<b>checksum</b>>
+ <ul style="list-style: none"><li>
+ @<b>algorithm</b>
+ (text)
</li></ul>
</li>
</ul>
@@ -5150,16 +5109,14 @@
</ul>
<h4>4.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>get_nvt_feed_checksum
+<i>Command</i><div style="margin-left: 5%"><pre>get_nvt_feed_checksum
= element get_nvt_feed_checksum
{
""
& attribute algorithm { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_nvt_feed_checksum_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_nvt_feed_checksum_response
= element get_nvt_feed_checksum_response
{
""
@@ -5174,188 +5131,188 @@
base64
& attribute algorithm { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.30.1 Example: Get the NVT feed checksum</h4>
-<b>Client:</b><br><pre> <get_nvt_feed_checksum/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_nvt_feed_checksum_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_feed_checksum/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_feed_checksum_response status="200" status_text="OK">
<checksum algorithm="md5">931db829a06b9a440a2ecaeb68c03715</checksum>
</get_nvt_feed_checksum_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_overrides">4.31
Command <tt>get_overrides</tt>
</h3></div>
-<p><b>In short: </b>Get all overrides.</p>
+<p>In short: Get all overrides.</p>
<p>
The client uses the get_overrides command to get override information.
If the command sent by the client was valid, the manager will
reply with a list of overrides to the client.
</p>
-<h4>4.31.1 Breakdown</h4>
+<h4>4.31.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@override_id</b>
+ @<b>override_id</b>
(<a href="#type_uuid">uuid</a>)
ID of single override to get.
</li>
<li>
-<b>@nvt_oid</b>
+ @<b>nvt_oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>@task_id</b>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>@details</b>
+ @<b>details</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
-<b>@result</b>
+ @<b>result</b>
(<a href="#type_boolean">boolean</a>)
</li>
<li>
-<b>@sort_order</b>
+ @<b>sort_order</b>
(<a href="#type_sort_order">sort_order</a>)
</li>
<li>
-<b>@sort_field</b>
- (<a href="#type_text">text</a>)
+ @<b>sort_field</b>
+ (text)
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <override>*</b><ul style="list-style: none">
+ <<b>override</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <nvt></b><ul style="list-style: none">
+ <<b>nvt</b>>
+ <ul style="list-style: none">
<li>
-<b>@oid</b>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>
- <name></b><ul style="list-style: none"></ul>
+ <<b>name</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
-<b>
- <text></b><div style="margin-left: 15px; display: inline;">The text of the override.</div>
+ <<b>text</b>>
+ <div style="margin-left: 15px; display: inline;">The text of the override.</div>
<ul style="list-style: none"><li>
-<b>@excerpt</b>
+ @<b>excerpt</b>
(<a href="#type_boolean">boolean</a>)
</li></ul>
</li>
<li>
-<b>
- <threat></b><div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
+ <<b>threat</b>>
+ <div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <new_threat></b><div style="margin-left: 15px; display: inline;">New threat for result.</div>
+ <<b>new_threat</b>>
+ <div style="margin-left: 15px; display: inline;">New threat for result.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <orphan></b><div style="margin-left: 15px; display: inline;">Whether the override is an orphan.</div>
+ <<b>orphan</b>>
+ <div style="margin-left: 15px; display: inline;">Whether the override is an orphan.</div>
<ul style="list-style: none"></ul>
</li>
<li>
<i>The group</i><b>?</b><ul style="list-style: none">
<li>
-<b>
- <creation_time></b><ul style="list-style: none"></ul>
+ <<b>creation_time</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <modification_time></b><ul style="list-style: none"></ul>
+ <<b>modification_time</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <hosts></b><div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
+ <<b>hosts</b>>
+ <div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <port></b><div style="margin-left: 15px; display: inline;">Port to which override applies.</div>
+ <<b>port</b>>
+ <div style="margin-left: 15px; display: inline;">Port to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <task></b><div style="margin-left: 15px; display: inline;">Task to which override applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <result>?</b><div style="margin-left: 15px; display: inline;">Result to which override applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li>
<li>
-<b>
- <subnet></b><ul style="list-style: none"></ul>
+ <<b>subnet</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <host></b><ul style="list-style: none"></ul>
+ <<b>host</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <port></b><ul style="list-style: none"></ul>
+ <<b>port</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <nvt></b><ul style="list-style: none">
+ <<b>nvt</b>>
+ <ul style="list-style: none">
<li>
-<b>@oid</b>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li>
<li>
-<b>
- <name></b><ul style="list-style: none"></ul>
+ <<b>name</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <cvss_base></b><ul style="list-style: none"></ul>
+ <<b>cvss_base</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <risk_factor></b><ul style="list-style: none"></ul>
+ <<b>risk_factor</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
-<b>
- <threat></b><ul style="list-style: none"></ul>
+ <<b>threat</b>>
+ <ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <description></b><ul style="list-style: none"></ul>
+ <<b>description</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
@@ -5368,8 +5325,7 @@
</ul>
<h4>4.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>get_overrides
+<i>Command</i><div style="margin-left: 5%"><pre>get_overrides
= element get_overrides
{
""
@@ -5381,9 +5337,8 @@
& attribute sort_order { sort_order }?
& attribute sort_field { text }?
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_overrides_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_overrides_response
= element get_overrides_response
{
""
@@ -5549,12 +5504,13 @@
{
text
}
-</pre>
+</pre></div>
</div>
<h4>4.31.1 Example: Get all overrides</h4>
-<b>Client:</b><br><pre> <get_overrides/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_overrides_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides_response status="200" status_text="OK">
<override id="b76b81a7-9df8-42df-afff-baa9d4620128">
<nvt oid="1.3.6.1.4.1.25623.1.0.75">
<name>Test NVT: long lines</name>
@@ -5566,11 +5522,13 @@
</override>
...
</get_overrides_response>
-</pre>
+</pre></div>
+</div>
<h4>4.31.1 Example: Get details of a single override</h4>
-<b>Client:</b><br><pre> <get_overrides override_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1"/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_overrides_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides override_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides_response status="200" status_text="OK">
<override id="7f618bbb-4664-419e-9bbf-367d93954cb0">
<nvt oid="1.3.6.1.4.1.25623.1.0.77">
<name>Test NVT: control chars in report result</name>
@@ -5590,48 +5548,45 @@
</override>
...
</get_overrides_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_get_version">4.32
Command <tt>get_version</tt>
</h3></div>
-<p><b>In short: </b>Get the OpenVAS Manager Protocol version.</p>
-<h4>4.32.1 Breakdown</h4>
+<p>In short: Get the OpenVAS Manager Protocol version.</p>
+<h4>4.32.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><i>Empty single element.</i></ul>
+<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
<li>
-<b>
- <version></b><ul style="list-style: none"></ul>
+ <<b>version</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
<h4>4.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>get_version
+<i>Command</i><div style="margin-left: 5%"><pre>get_version
= element get_version
{
""
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>get_version_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_version_response
= element get_version_response
{
""
@@ -5645,66 +5600,64 @@
{
text
}
-</pre>
+</pre></div>
</div>
<h4>4.32.1 Example: Get the version</h4>
-<b>Client:</b><br><pre> <get_version/>
-</pre>
-<br><b>Manager:</b><br><pre> <get_version_response status="200" status_text="OK">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_version/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_version_response status="200" status_text="OK">
<version>1.0</version>
</get_version_response>
-</pre>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_help">4.33
Command <tt>help</tt>
</h3></div>
-<p><b>In short: </b>Get the help text.</p>
-<h4>4.33.1 Breakdown</h4>
+<p>In short: Get the help text.</p>
+<h4>4.33.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><i>Empty single element.</i></ul>
+<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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>help
+<i>Command</i><div style="margin-left: 5%"><pre>help
= element help
{
""
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>help_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>help_response
= element help_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
</div>
<div>
<div><h3 id="command_modify_config">4.34
Command <tt>modify_config</tt>
</h3></div>
-<p><b>In short: </b>Update an existing config.</p>
+<p>In short: Update an existing config.</p>
<p>
This command can take three forms: with a preference, with a family selection
or with an NVT selection.
@@ -5752,82 +5705,81 @@
apply the changes to the config and will reply with a response code indicating
success.
</p>
-<h4>4.34.1 Breakdown</h4>
+<h4>4.34.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@config_id</b>
+ @<b>config_id</b>
(<a href="#type_uuid">uuid</a>)
ID of config to modify.
</li>
<li>
<i>One of</i><ul style="list-style: none">
<li>
-<b>
- <preference></b><ul style="list-style: none">
+ <<b>preference</b>>
+ <ul style="list-style: none">
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the preference to modify.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the preference to modify.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <nvt>?</b><div style="margin-left: 15px; display: inline;">NVT associated with preference to modify.</div>
+ <<b>nvt</b>>
+ ?<div style="margin-left: 15px; display: inline;">NVT associated with preference to modify.</div>
<ul style="list-style: none"><li>
-<b>@oid</b>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
<li>
-<b>
- <value>?</b><div style="margin-left: 15px; display: inline;">New value for preference.</div>
+ <<b>value</b>>
+ ?<div style="margin-left: 15px; display: inline;">New value for preference.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
<li>
-<b>
- <family_selection></b><ul style="list-style: none">
+ <<b>family_selection</b>>
+ <ul style="list-style: none">
<li>
-<b>
- <growing>?</b><div style="margin-left: 15px; display: inline;">Whether new families should be added to the config.</div>
+ <<b>growing</b>>
+ ?<div style="margin-left: 15px; display: inline;">Whether new families should be added to the config.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <family>*</b><ul style="list-style: none">
+ <<b>family</b>>
+ *<ul style="list-style: none">
<li>
-<b>
- <all>?</b><div style="margin-left: 15px; display: inline;">Whether to select all NVTs initially.</div>
+ <<b>all</b>>
+ ?<div style="margin-left: 15px; display: inline;">Whether to select all NVTs initially.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <growing>?</b><div style="margin-left: 15px; display: inline;">Whether to add newly arrived nvts to the selection.</div>
+ <<b>growing</b>>
+ ?<div style="margin-left: 15px; display: inline;">Whether to add newly arrived nvts to the selection.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <name></b><ul style="list-style: none"></ul>
+ <<b>name</b>>
+ <ul style="list-style: none"></ul>
</li>
</ul>
</li>
</ul>
</li>
<li>
-<b>
- <nvt_selection></b><ul style="list-style: none">
+ <<b>nvt_selection</b>>
+ <ul style="list-style: none">
<li>
-<b>
- <family></b><div style="margin-left: 15px; display: inline;">Name of family to modify.</div>
+ <<b>family</b>>
+ <div style="margin-left: 15px; display: inline;">Name of family to modify.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <nvt>*</b><ul style="list-style: none"><li>
-<b>@oid</b>
+ <<b>nvt</b>>
+ *<ul style="list-style: none"><li>
+ @<b>oid</b>
(<a href="#type_oid">oid</a>)
</li></ul>
</li>
@@ -5837,24 +5789,22 @@
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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>modify_config
+<i>Command</i><div style="margin-left: 5%"><pre>modify_config
= element modify_config
{
""
@@ -5953,28 +5903,29 @@
""
& attribute oid { oid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>modify_config_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>modify_config_response
= element modify_config_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.34.1 Example: Modify a config preference</h4>
-<b>Client:</b><br><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<preference>
<nvt oid="1.3.6.1.4.1.25623.1.0.14259"/>
<name>Nmap (NASL wrapper)[checkbox]:UDP port scan</name>
<value>eWVz</value>
</preference>
</modify_config>
-</pre>
-<br><b>Manager:</b><br><pre> <modify_config_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config_response status="200" status_text="OK"/>
+</pre></div>
+</div>
<h4>4.34.1 Example: Modify the families that a config selects</h4>
<p>
The outer "growing" element sets the config to add any new families
@@ -5986,7 +5937,8 @@
this family, and to automatically add any new NVTs in this family
to the config.
</p>
-<b>Client:</b><br><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<family_selection>
<growing>1</growing>
<family>
@@ -5996,11 +5948,13 @@
</family>
</family_selection>
</modify_config>
-</pre>
-<br><b>Manager:</b><br><pre> <modify_config_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config_response status="200" status_text="OK"/>
+</pre></div>
+</div>
<h4>4.34.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">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<nvt_selection>
<family>Debian Local Security Checks</family>
<nvt oid="1.3.6.1.4.1.25623.1.0.53797"/>
@@ -6009,15 +5963,16 @@
<nvt oid="1.3.6.1.4.1.25623.1.0.53546"/>
</nvt_selection>
</modify_config>
-</pre>
-<br><b>Manager:</b><br><pre> <modify_config_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_modify_note">4.35
Command <tt>modify_note</tt>
</h3></div>
-<p><b>In short: </b>Modify an existing note.</p>
+<p>In short: Modify an existing note.</p>
<p>
The client uses the modify_note command to change an existing note.
</p>
@@ -6025,72 +5980,69 @@
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
-<h4>4.35.1 Breakdown</h4>
+<h4>4.35.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@note_id</b>
+ @<b>note_id</b>
(<a href="#type_uuid">uuid</a>)
ID of note to modify.
</li>
<li>
-<b>
- <hosts>?</b><div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
+ <<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>
+ <<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>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <task>?</b><div style="margin-left: 15px; display: inline;">Task to which note applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <text></b><div style="margin-left: 15px; display: inline;">The text of the note.</div>
+ <<b>text</b>>
+ <div style="margin-left: 15px; display: inline;">The text of the note.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <threat>?</b><div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
+ <<b>threat</b>>
+ ?<div style="margin-left: 15px; display: inline;">Threat level to which note applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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>modify_note
+<i>Command</i><div style="margin-left: 5%"><pre>modify_note
= element modify_note
{
""
@@ -6140,31 +6092,32 @@
""
& attribute id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>modify_note_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>modify_note_response
= element modify_note_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.35.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">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_note note_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<text>This issue should be resolved after the upgrade.</text>
<result result_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c"/>
</modify_note>
-</pre>
-<br><b>Manager:</b><br><pre> <modify_note_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_note_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_modify_override">4.36
Command <tt>modify_override</tt>
</h3></div>
-<p><b>In short: </b>Modify an existing override.</p>
+<p>In short: Modify an existing override.</p>
<p>
The client uses the modify_override command to change an existing
override.
@@ -6173,77 +6126,74 @@
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
-<h4>4.36.1 Breakdown</h4>
+<h4>4.36.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@override_id</b>
+ @<b>override_id</b>
(<a href="#type_uuid">uuid</a>)
ID of override to modify.
</li>
<li>
-<b>
- <hosts>?</b><div style="margin-left: 15px; display: inline;">A textual list of hosts.</div>
+ <<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>
+ <<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>
+ <<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>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <task>?</b><div style="margin-left: 15px; display: inline;">Task to which override applies.</div>
+ <<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>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <text></b><div style="margin-left: 15px; display: inline;">Text describing the override.</div>
+ <<b>text</b>>
+ <div style="margin-left: 15px; display: inline;">Text describing the override.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <threat>?</b><div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
+ <<b>threat</b>>
+ ?<div style="margin-left: 15px; display: inline;">Threat level to which override applies.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.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>modify_override
+<i>Command</i><div style="margin-left: 5%"><pre>modify_override
= element modify_override
{
""
@@ -6300,70 +6250,68 @@
""
& attribute id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>modify_override_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>modify_override_response
= element modify_override_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.36.1 Example: Set the override threat to Low</h4>
-<b>Client:</b><br><pre> <modify_override override_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_override override_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<text>This issue is less important in our setup.</text>
<new_threat>Low</new_threat>
</modify_override>
-</pre>
-<br><b>Manager:</b><br><pre> <modify_override_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_override_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_modify_report">4.37
Command <tt>modify_report</tt>
</h3></div>
-<p><b>In short: </b>Modify an existing report.</p>
+<p>In short: Modify an existing report.</p>
<p>
The client uses the modify_report command to change an existing
report.
</p>
-<h4>4.37.1 Breakdown</h4>
+<h4>4.37.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@report_id</b>
+ @<b>report_id</b>
(<a href="#type_uuid">uuid</a>)
ID of report to modify.
</li>
<li>
-<b>
- <comment></b><div style="margin-left: 15px; display: inline;">The comment on the report.</div>
+ <<b>comment</b>>
+ <div style="margin-left: 15px; display: inline;">The comment on the report.</div>
<ul style="list-style: none"></ul>
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.37.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
+<i>Command</i><div style="margin-left: 5%"><pre>modify_report
= element modify_report
{
""
@@ -6376,87 +6324,87 @@
{
text
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>modify_report_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>modify_report_response
= element modify_report_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.37.1 Example: Modify a report comment</h4>
-<b>Client:</b><br><pre> <modify_report report_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report report_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
</modify_report>
-</pre>
-<br><b>Manager:</b><br><pre> <modify_report_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_modify_task">4.38
Command <tt>modify_task</tt>
</h3></div>
-<p><b>In short: </b>Modify an existing task.</p>
+<p>In short: Modify an existing task.</p>
<p>
The client uses the modify_task command to change an existing
task.
</p>
-<h4>4.38.1 Breakdown</h4>
+<h4>4.38.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none">
+<i>Command</i><ul style="list-style: none">
<li>
-<b>@task_id</b>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
ID of task to modify.
</li>
<li>
<i>One of</i><ul style="list-style: none">
<li>
-<b>
- <comment></b><div style="margin-left: 15px; display: inline;">The comment on the task.</div>
+ <<b>comment</b>>
+ <div style="margin-left: 15px; display: inline;">The comment on the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <escalator></b><div style="margin-left: 15px; display: inline;">Task escalator.</div>
+ <<b>escalator</b>>
+ <div style="margin-left: 15px; display: inline;">Task escalator.</div>
<ul style="list-style: none"><li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <name></b><div style="margin-left: 15px; display: inline;">The name of the task.</div>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <rcfile></b><div style="margin-left: 15px; display: inline;">An openvasrc style file describing the task.</div>
+ <<b>rcfile</b>>
+ <div style="margin-left: 15px; display: inline;">An openvasrc style file describing the task.</div>
<ul style="list-style: none"></ul>
</li>
<li>
-<b>
- <schedule></b><div style="margin-left: 15px; display: inline;">Task schedule.</div>
+ <<b>schedule</b>>
+ <div style="margin-left: 15px; display: inline;">Task schedule.</div>
<ul style="list-style: none"><li>
-<b>@id</b>
+ @<b>id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
<li>
-<b>
- <file></b><div style="margin-left: 15px; display: inline;">File to attach to task.</div>
+ <<b>file</b>>
+ <div style="margin-left: 15px; display: inline;">File to attach to task.</div>
<ul style="list-style: none">
<li>
-<b>@name</b>
- (<a href="#type_text">text</a>)
+ @<b>name</b>
+ (text)
</li>
<li>
-<b>@action</b>
+ @<b>action</b>
("update" or "remove")
</li>
</ul>
@@ -6465,24 +6413,22 @@
</li>
</ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.38.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
+<i>Command</i><div style="margin-left: 5%"><pre>modify_task
= element modify_task
{
""
@@ -6534,431 +6480,418 @@
& attribute name { text }
& attribute action { xsd:token { pattern = "update|remove" } }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>modify_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>modify_task_response
= element modify_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.38.1 Example: Modify a task comment</h4>
-<b>Client:</b><br><pre> <modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
</modify_task>
-</pre>
-<br><b>Manager:</b><br><pre> <modify_task_response status="200" status_text="OK"/>
-</pre>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_pause_task">4.39
Command <tt>pause_task</tt>
</h3></div>
-<p><b>In short: </b>Pause a running task.</p>
+<p>In short: Pause a running task.</p>
<p>
The client uses the pause_task command to manually pause a running task.
</p>
-<h4>4.39.1 Breakdown</h4>
+<h4>4.39.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.39.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
+<i>Command</i><div style="margin-left: 5%"><pre>pause_task
= element pause_task
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>pause_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>pause_task_response
= element pause_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.39.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <pause_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <pause_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_resume_or_start_task">4.40
Command <tt>resume_or_start_task</tt>
</h3></div>
-<p><b>In short: </b>Resume task if stopped, else start task.</p>
+<p>In short: Resume task if stopped, else start task.</p>
<p>
The client uses the resume_or_start_task command to manually start
an existing task, ensuring that the task will resume from its
previous position if the task is in the Stopped state.
</p>
-<h4>4.40.1 Breakdown</h4>
+<h4>4.40.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.40.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
+<i>Command</i><div style="margin-left: 5%"><pre>resume_or_start_task
= element resume_or_start_task
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>resume_or_start_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>resume_or_start_task_response
= element resume_or_start_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.40.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_or_start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_or_start_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_resume_paused_task">4.41
Command <tt>resume_paused_task</tt>
</h3></div>
-<p><b>In short: </b>Resume a paused task.</p>
+<p>In short: Resume a paused task.</p>
<p>
The client uses the resume_paused_task command to manually resume a
paused task.
</p>
-<h4>4.41.1 Breakdown</h4>
+<h4>4.41.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.41.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
+<i>Command</i><div style="margin-left: 5%"><pre>resume_paused_task
= element resume_paused_task
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>resume_paused_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>resume_paused_task_response
= element resume_paused_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.41.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_paused_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_paused_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_resume_stopped_task">4.42
Command <tt>resume_stopped_task</tt>
</h3></div>
-<p><b>In short: </b>Resume a stopped task.</p>
+<p>In short: Resume a stopped task.</p>
<p>
The client uses the resume_stopped_task command to manually resume a
stopped task.
</p>
-<h4>4.42.1 Breakdown</h4>
+<h4>4.42.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.42.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
+<i>Command</i><div style="margin-left: 5%"><pre>resume_stopped_task
= element resume_stopped_task
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>resume_stopped_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>resume_stopped_task_response
= element resume_stopped_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.42.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_stopped_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_stopped_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_start_task">4.43
Command <tt>start_task</tt>
</h3></div>
-<p><b>In short: </b>Manually start an existing task.</p>
+<p>In short: Manually start an existing task.</p>
<p>
The client uses the start_task command to manually start an
existing task.
</p>
-<h4>4.43.1 Breakdown</h4>
+<h4>4.43.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.43.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
+<i>Command</i><div style="margin-left: 5%"><pre>start_task
= element start_task
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>start_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>start_task_response
= element start_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.43.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <start_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_stop_task">4.44
Command <tt>stop_task</tt>
</h3></div>
-<p><b>In short: </b>Stop a running task.</p>
+<p>In short: Stop a running task.</p>
<p>
The client uses the stop_task command to manually stop a
running task.
</p>
-<h4>4.44.1 Breakdown</h4>
+<h4>4.44.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.44.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
+<i>Command</i><div style="margin-left: 5%"><pre>stop_task
= element stop_task
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>stop_task_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>stop_task_response
= element stop_task_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.44.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 style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <stop_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <stop_task_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div>
<div><h3 id="command_test_escalator">4.45
Command <tt>test_escalator</tt>
</h3></div>
-<p><b>In short: </b>Run an escalator.</p>
+<p>In short: Run an escalator.</p>
<p>
The client uses the test_escalator command to invoke a test run of
an escalator.
</p>
-<h4>4.45.1 Breakdown</h4>
+<h4>4.45.1 Structure</h4>
<ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Command</div>
-<ul style="list-style: none"><li>
-<b>@task_id</b>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>task_id</b>
(<a href="#type_uuid">uuid</a>)
</li></ul>
</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
<li>
-<div style="font-weight:bold;">Response</div>
-<ul style="list-style: none">
-<li>
-<b>@status</b>
+ @<b>status</b>
(<a href="#type_status">status</a>)
</li>
<li>
-<b>@status_text</b>
- (<a href="#type_text">text</a>)
+ @<b>status_text</b>
+ (text)
</li>
</ul>
</li>
</ul>
<h4>4.45.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
+<i>Command</i><div style="margin-left: 5%"><pre>test_escalator
= element test_escalator
{
""
& attribute task_id { uuid }
}
-</pre>
-<div style="font-weight:bold;">Response</div>
-<pre>test_escalator_response
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>test_escalator_response
= element test_escalator_response
{
""
& attribute status { status }
& attribute status_text { text }
}
-</pre>
+</pre></div>
</div>
<h4>4.45.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"/>
-</pre>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <test_escalator escalator_id="97390ade-e075-11df-9973-002264764cea"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <test_escalator_response status="200" status_text="OK"/>
+</pre></div>
</div>
+</div>
<div style="text-align: center; padding: 5px;">
This file was automatically generated.
</div>
Modified: trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl
===================================================================
--- trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl 2010-11-03 17:29:22 UTC (rev 9350)
+++ trunk/openvas-manager/src/schema_formats/HTML/HTML.xsl 2010-11-03 17:32:51 UTC (rev 9351)
@@ -230,6 +230,9 @@
<xsl:text>"</xsl:text>
</xsl:for-each>
</xsl:when>
+ <xsl:when test="normalize-space(text()) = 'text'">
+ <xsl:text>text</xsl:text>
+ </xsl:when>
<xsl:otherwise>
<a href="#type_{text()}"><xsl:value-of select="text()"/></a>
</xsl:otherwise>
More information about the Openvas-commits
mailing list