[Openvas-commits] r9706 - in trunk/openvas-manager: . doc src/schema_formats/XML
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Mon Dec 13 19:03:34 CET 2010
Author: mattm
Date: 2010-12-13 19:03:30 +0100 (Mon, 13 Dec 2010)
New Revision: 9706
Modified:
trunk/openvas-manager/ChangeLog
trunk/openvas-manager/doc/omp.html
trunk/openvas-manager/doc/omp.rnc
trunk/openvas-manager/src/schema_formats/XML/OMP.xml
Log:
* src/schema_formats/XML/OMP.xml: Add some of the commands new in OMP 2.
* doc/omp.rnc, doc/omp.html: Update from source.
Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog 2010-12-13 18:01:19 UTC (rev 9705)
+++ trunk/openvas-manager/ChangeLog 2010-12-13 18:03:30 UTC (rev 9706)
@@ -1,3 +1,9 @@
+2010-12-13 Matthew Mundell <matthew.mundell at greenbone.net>
+
+ * src/schema_formats/XML/OMP.xml: Add some of the commands new in OMP 2.
+
+ * doc/omp.rnc, doc/omp.html: Update from source.
+
2010-12-10 Michael Wiegand <michael.wiegand at greenbone.net>
Post release version bump.
Modified: trunk/openvas-manager/doc/omp.html
===================================================================
--- trunk/openvas-manager/doc/omp.html 2010-12-13 18:01:19 UTC (rev 9705)
+++ trunk/openvas-manager/doc/omp.html 2010-12-13 18:03:30 UTC (rev 9706)
@@ -160,6 +160,10 @@
<td id="index"><div style="margin-left: 15px;">Create an override.</div></td>
</tr>
<tr id="index">
+<td id="index"><a href="#command_create_report_format">create_report_format</a></td>
+<td id="index"><div style="margin-left: 15px;">Create a report format.</div></td>
+</tr>
+<tr id="index">
<td id="index"><a href="#command_create_schedule">create_schedule</a></td>
<td id="index"><div style="margin-left: 15px;">Create a schedule.</div></td>
</tr>
@@ -200,6 +204,10 @@
<td id="index"><div style="margin-left: 15px;">Delete a report.</div></td>
</tr>
<tr id="index">
+<td id="index"><a href="#command_delete_report_format">delete_report_format</a></td>
+<td id="index"><div style="margin-left: 15px;">Delete a report format.</div></td>
+</tr>
+<tr id="index">
<td id="index"><a href="#command_delete_schedule">delete_schedule</a></td>
<td id="index"><div style="margin-left: 15px;">Delete a schedule.</div></td>
</tr>
@@ -260,6 +268,10 @@
<td id="index"><div style="margin-left: 15px;">Get all reports.</div></td>
</tr>
<tr id="index">
+<td id="index"><a href="#command_get_report_formats">get_report_formats</a></td>
+<td id="index"><div style="margin-left: 15px;">Get all report formats.</div></td>
+</tr>
+<tr id="index">
<td id="index"><a href="#command_get_results">get_results</a></td>
<td id="index"><div style="margin-left: 15px;">Get results.</div></td>
</tr>
@@ -308,6 +320,10 @@
<td id="index"><div style="margin-left: 15px;">Modify an existing report.</div></td>
</tr>
<tr id="index">
+<td id="index"><a href="#command_modify_report_format">modify_report_format</a></td>
+<td id="index"><div style="margin-left: 15px;">Update an existing report format.</div></td>
+</tr>
+<tr id="index">
<td id="index"><a href="#command_modify_task">modify_task</a></td>
<td id="index"><div style="margin-left: 15px;">Modify an existing task.</div></td>
</tr>
@@ -339,6 +355,14 @@
<td id="index"><a href="#command_test_escalator">test_escalator</a></td>
<td id="index"><div style="margin-left: 15px;">Run an escalator.</div></td>
</tr>
+<tr id="index">
+<td id="index"><a href="#command_verify_agent">verify_agent</a></td>
+<td id="index"><div style="margin-left: 15px;">Verify an agent.</div></td>
+</tr>
+<tr id="index">
+<td id="index"><a href="#command_verify_report_format">verify_report_format</a></td>
+<td id="index"><div style="margin-left: 15px;">Verify a report format.</div></td>
+</tr>
</table>
<h2 id="rnc_preamble">4 RNC Preamble</h2>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;"><pre>### Preamble
@@ -354,6 +378,7 @@
| create_lsc_credential
| create_note
| create_override
+ | create_report_format
| create_schedule
| create_target
| create_task
@@ -364,6 +389,7 @@
| delete_note
| delete_override
| delete_report
+ | delete_report_format
| delete_schedule
| delete_target
| delete_task
@@ -379,6 +405,7 @@
| get_overrides
| get_preferences
| get_reports
+ | get_report_formats
| get_results
| get_schedules
| get_system_reports
@@ -391,6 +418,7 @@
| modify_note
| modify_override
| modify_report
+ | modify_report_format
| modify_task
| pause_task
| resume_or_start_task
@@ -399,6 +427,8 @@
| start_task
| stop_task
| test_escalator
+ | verify_agent
+ | verify_report_format
response
= authenticate_response
@@ -409,6 +439,7 @@
| create_lsc_credential_response
| create_note_response
| create_override_response
+ | create_report_format_response
| create_schedule_response
| create_target_response
| create_task_response
@@ -419,6 +450,7 @@
| delete_note_response
| delete_override_response
| delete_report_response
+ | delete_report_format_response
| delete_schedule_response
| delete_target_response
| delete_task_response
@@ -434,6 +466,7 @@
| get_overrides_response
| get_preferences_response
| get_reports_response
+ | get_report_formats_response
| get_results_response
| get_schedules_response
| get_system_reports_response
@@ -446,6 +479,7 @@
| modify_note_response
| modify_override_response
| modify_report_response
+ | modify_report_format_response
| modify_task_response
| pause_task_response
| resume_or_start_task_response
@@ -454,6 +488,8 @@
| start_task_response
| stop_task_response
| test_escalator_response
+ | verify_agent_response
+ | verify_report_format_response
</pre></div>
<h2 id="type_details">5 Data Type Details</h2>
<div>
@@ -2868,14 +2904,95 @@
</div>
</div>
<div>
-<div><h3 id="command_create_schedule">7.9
+<div><h3 id="command_create_report_format">7.9
+ Command <tt>create_report_format</tt>
+</h3></div>
+<p>In short: Create a report format.</p>
+<p>
+ The client uses the create_report_format command to create a new report
+ format.
+ </p>
+<h4>7.9.1 Structure</h4>
+<ul style="list-style: none">
+<li>
+<i>Command</i><ul style="list-style: none"><li>
+ <<b>get_report_formats_response></b><div style="margin-left: 15px; display: inline;">
+ Response to <a href="#command_get_report_formats">get_report_formats</a> command.
+ </div>
+</li></ul>
+</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
+<li>
+ @<b>status</b>
+ (<a href="#type_status">status</a>)
+ </li>
+<li>
+ @<b>status_text</b>
+ (text)
+ </li>
+<li>
+ @<b>id</b>
+ (<a href="#type_uuid">uuid</a>)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>7.9.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<i>Command</i><div style="margin-left: 5%"><pre>create_report_format
+ = element create_report_format
+ {
+ get_report_formats_response
+ }
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>create_report_format_response
+ = element create_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+</pre></div>
+</div>
+<h4>7.9.3 Example: Create a report format</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_report_format>
+ <get_report_formats_response>
+ <report_format id="a0704abb-2120-489f-959f-251c9f4ffebd">
+ <name>CPE</name>
+ <extension>csv</extension>
+ <content_type>text/csv</content_type>
+ <summary>Common Product Enumeration CSV table.</summary>
+ <description>
+ CPE stands for Common Product Enumeration. It is a
+ ...
+ </description>
+ <global>1</global>
+ <trust>
+ yes
+ <time>Thu Dec 2 13:22:26 2010</time>
+ </trust>
+ <active>1</active>
+ </report_format>
+ </get_report_formats_response>
+ </create_report_format>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_report_format_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
+</pre></div>
+</div>
+</div>
+<div>
+<div><h3 id="command_create_schedule">7.10
Command <tt>create_schedule</tt>
</h3></div>
<p>In short: Create a schedule.</p>
<p>
The client uses the create_schedule command to create a new schedule.
</p>
-<h4>7.9.1 Structure</h4>
+<h4>7.10.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -2952,7 +3069,7 @@
</ul>
</li>
</ul>
-<h4>7.9.2 RNC</h4>
+<h4>7.10.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_schedule
= element create_schedule
@@ -3049,7 +3166,7 @@
}
</pre></div>
</div>
-<h4>7.9.3 Example: Create a schedule</h4>
+<h4>7.10.3 Example: Create a schedule</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_schedule>
<name>Every night</name>
@@ -3077,7 +3194,7 @@
</div>
</div>
<div>
-<div><h3 id="command_create_target">7.10
+<div><h3 id="command_create_target">7.11
Command <tt>create_target</tt>
</h3></div>
<p>In short: Create a target.</p>
@@ -3088,7 +3205,7 @@
If the list of hosts is empty, the command must also include a
target locator.
</p>
-<h4>7.10.1 Structure</h4>
+<h4>7.11.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -3150,7 +3267,7 @@
</ul>
</li>
</ul>
-<h4>7.10.2 RNC</h4>
+<h4>7.11.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_target
= element create_target
@@ -3214,7 +3331,7 @@
}
</pre></div>
</div>
-<h4>7.10.3 Example: Create a target, giving a host list</h4>
+<h4>7.11.3 Example: Create a target, giving a host list</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_target>
<create_target>
@@ -3230,7 +3347,7 @@
</div>
</div>
<div>
-<div><h3 id="command_create_task">7.11
+<div><h3 id="command_create_task">7.12
Command <tt>create_task</tt>
</h3></div>
<p>In short: Create a task.</p>
@@ -3242,7 +3359,7 @@
left out. This form of the command is special support for
OpenVAS-Client, and will likely be removed in future versions.
</p>
-<h4>7.11.1 Structure</h4>
+<h4>7.12.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -3312,7 +3429,7 @@
</ul>
</li>
</ul>
-<h4>7.11.2 RNC</h4>
+<h4>7.12.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>create_task
= element create_task
@@ -3377,7 +3494,7 @@
}
</pre></div>
</div>
-<h4>7.11.3 Example: Create a task, giving a host list</h4>
+<h4>7.12.3 Example: Create a task, giving a host list</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <create_task>
<name>Scan Webserver</name>
@@ -3393,7 +3510,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_agent">7.12
+<div><h3 id="command_delete_agent">7.13
Command <tt>delete_agent</tt>
</h3></div>
<p>In short: Delete an agent.</p>
@@ -3405,7 +3522,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.12.1 Structure</h4>
+<h4>7.13.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3426,7 +3543,7 @@
</ul>
</li>
</ul>
-<h4>7.12.2 RNC</h4>
+<h4>7.13.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_agent
= element delete_agent
@@ -3442,7 +3559,7 @@
}
</pre></div>
</div>
-<h4>7.12.3 Example: Delete an agent</h4>
+<h4>7.13.3 Example: Delete an agent</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3452,7 +3569,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_config">7.13
+<div><h3 id="command_delete_config">7.14
Command <tt>delete_config</tt>
</h3></div>
<p>In short: Delete a config.</p>
@@ -3464,7 +3581,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.13.1 Structure</h4>
+<h4>7.14.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3485,7 +3602,7 @@
</ul>
</li>
</ul>
-<h4>7.13.2 RNC</h4>
+<h4>7.14.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_config
= element delete_config
@@ -3501,7 +3618,7 @@
}
</pre></div>
</div>
-<h4>7.13.3 Example: Delete a config</h4>
+<h4>7.14.3 Example: Delete a config</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_config config_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3511,7 +3628,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_escalator">7.14
+<div><h3 id="command_delete_escalator">7.15
Command <tt>delete_escalator</tt>
</h3></div>
<p>In short: Delete an escalator.</p>
@@ -3524,7 +3641,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.14.1 Structure</h4>
+<h4>7.15.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3545,7 +3662,7 @@
</ul>
</li>
</ul>
-<h4>7.14.2 RNC</h4>
+<h4>7.15.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_escalator
= element delete_escalator
@@ -3561,7 +3678,7 @@
}
</pre></div>
</div>
-<h4>7.14.3 Example: Delete an escalator</h4>
+<h4>7.15.3 Example: Delete an escalator</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_escalator escalator_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3571,7 +3688,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_lsc_credential">7.15
+<div><h3 id="command_delete_lsc_credential">7.16
Command <tt>delete_lsc_credential</tt>
</h3></div>
<p>In short: Delete an LSC credential.</p>
@@ -3584,7 +3701,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.15.1 Structure</h4>
+<h4>7.16.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3605,7 +3722,7 @@
</ul>
</li>
</ul>
-<h4>7.15.2 RNC</h4>
+<h4>7.16.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_lsc_credential
= element delete_lsc_credential
@@ -3621,7 +3738,7 @@
}
</pre></div>
</div>
-<h4>7.15.3 Example: Delete an LSC credential</h4>
+<h4>7.16.3 Example: Delete an LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_lsc_credential lsc_credential_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3631,7 +3748,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_note">7.16
+<div><h3 id="command_delete_note">7.17
Command <tt>delete_note</tt>
</h3></div>
<p>In short: Delete a note.</p>
@@ -3643,7 +3760,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.16.1 Structure</h4>
+<h4>7.17.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3664,7 +3781,7 @@
</ul>
</li>
</ul>
-<h4>7.16.2 RNC</h4>
+<h4>7.17.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_note
= element delete_note
@@ -3680,7 +3797,7 @@
}
</pre></div>
</div>
-<h4>7.16.3 Example: Delete a note</h4>
+<h4>7.17.3 Example: Delete a note</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_note note_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3690,7 +3807,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_override">7.17
+<div><h3 id="command_delete_override">7.18
Command <tt>delete_override</tt>
</h3></div>
<p>In short: Delete an override.</p>
@@ -3702,7 +3819,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.17.1 Structure</h4>
+<h4>7.18.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3723,7 +3840,7 @@
</ul>
</li>
</ul>
-<h4>7.17.2 RNC</h4>
+<h4>7.18.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_override
= element delete_override
@@ -3739,7 +3856,7 @@
}
</pre></div>
</div>
-<h4>7.17.3 Example: Delete an override</h4>
+<h4>7.18.3 Example: Delete an override</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_override override_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3749,7 +3866,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_report">7.18
+<div><h3 id="command_delete_report">7.19
Command <tt>delete_report</tt>
</h3></div>
<p>In short: Delete a report.</p>
@@ -3761,7 +3878,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.18.1 Structure</h4>
+<h4>7.19.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3782,7 +3899,7 @@
</ul>
</li>
</ul>
-<h4>7.18.2 RNC</h4>
+<h4>7.19.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_report
= element delete_report
@@ -3798,7 +3915,7 @@
}
</pre></div>
</div>
-<h4>7.18.3 Example: Delete a report</h4>
+<h4>7.19.3 Example: Delete a report</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3808,7 +3925,67 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_schedule">7.19
+<div><h3 id="command_delete_report_format">7.20
+ Command <tt>delete_report_format</tt>
+</h3></div>
+<p>In short: Delete a report format.</p>
+<p>
+ The client uses the delete_report_format command to delete an existing
+ report format.
+ </p>
+<p>
+ Since this is a destructive command, the client is advised to ask
+ for confirmation from the user before sending this command to the
+ Manager.
+ </p>
+<h4>7.20.1 Structure</h4>
+<ul style="list-style: none">
+<li>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>report_format_id</b>
+ (<a href="#type_uuid">uuid</a>)
+ </li></ul>
+</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
+<li>
+ @<b>status</b>
+ (<a href="#type_status">status</a>)
+ </li>
+<li>
+ @<b>status_text</b>
+ (text)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>7.20.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<i>Command</i><div style="margin-left: 5%"><pre>delete_report_format
+ = element delete_report_format
+ {
+ attribute report_format_id { uuid }
+ }
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>delete_report_format_response
+ = element delete_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
+</pre></div>
+</div>
+<h4>7.20.3 Example: Delete a report format</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_report_format_response status="200"
+ status_text="OK"/>
+</pre></div>
+</div>
+</div>
+<div>
+<div><h3 id="command_delete_schedule">7.21
Command <tt>delete_schedule</tt>
</h3></div>
<p>In short: Delete a schedule.</p>
@@ -3820,7 +3997,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.19.1 Structure</h4>
+<h4>7.21.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3841,7 +4018,7 @@
</ul>
</li>
</ul>
-<h4>7.19.2 RNC</h4>
+<h4>7.21.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_schedule
= element delete_schedule
@@ -3857,7 +4034,7 @@
}
</pre></div>
</div>
-<h4>7.19.3 Example: Delete a schedule</h4>
+<h4>7.21.3 Example: Delete a schedule</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_schedule schedule_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3867,7 +4044,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_target">7.20
+<div><h3 id="command_delete_target">7.22
Command <tt>delete_target</tt>
</h3></div>
<p>In short: Delete a target.</p>
@@ -3879,7 +4056,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.20.1 Structure</h4>
+<h4>7.22.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3900,7 +4077,7 @@
</ul>
</li>
</ul>
-<h4>7.20.2 RNC</h4>
+<h4>7.22.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_target
= element delete_target
@@ -3916,7 +4093,7 @@
}
</pre></div>
</div>
-<h4>7.20.3 Example: Delete a target</h4>
+<h4>7.22.3 Example: Delete a target</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_target target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3926,7 +4103,7 @@
</div>
</div>
<div>
-<div><h3 id="command_delete_task">7.21
+<div><h3 id="command_delete_task">7.23
Command <tt>delete_task</tt>
</h3></div>
<p>In short: Delete a task.</p>
@@ -3939,7 +4116,7 @@
for confirmation from the user before sending this command to the
Manager.
</p>
-<h4>7.21.1 Structure</h4>
+<h4>7.23.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -3960,7 +4137,7 @@
</ul>
</li>
</ul>
-<h4>7.21.2 RNC</h4>
+<h4>7.23.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>delete_task
= element delete_task
@@ -3976,7 +4153,7 @@
}
</pre></div>
</div>
-<h4>7.21.3 Example: Delete a task</h4>
+<h4>7.23.3 Example: Delete a task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <delete_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -3986,7 +4163,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_agents">7.22
+<div><h3 id="command_get_agents">7.24
Command <tt>get_agents</tt>
</h3></div>
<p>In short: Get all agents.</p>
@@ -4000,7 +4177,7 @@
include installer elements, otherwise they include package
elements.
</p>
-<h4>7.22.1 Structure</h4>
+<h4>7.24.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -4081,7 +4258,7 @@
</ul>
</li>
</ul>
-<h4>7.22.2 RNC</h4>
+<h4>7.24.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_agents
= element get_agents
@@ -4155,7 +4332,7 @@
}
</pre></div>
</div>
-<h4>7.22.3 Example: Get all agents</h4>
+<h4>7.24.3 Example: Get all agents</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents/>
</pre></div>
@@ -4173,7 +4350,7 @@
</get_agents_response>
</pre></div>
</div>
-<h4>7.22.3 Example: Get one agent</h4>
+<h4>7.24.3 Example: Get one agent</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/>
</pre></div>
@@ -4190,7 +4367,7 @@
</get_agents_response>
</pre></div>
</div>
-<h4>7.22.3 Example: Get one agent, including the installer package</h4>
+<h4>7.24.3 Example: Get one agent, including the installer package</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
format="installer"/>
@@ -4211,7 +4388,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_configs">7.23
+<div><h3 id="command_get_configs">7.25
Command <tt>get_configs</tt>
</h3></div>
<p>In short: Get all configs.</p>
@@ -4220,7 +4397,7 @@
If the command sent by the client was valid, the manager will
reply with a list of configs to the client.
</p>
-<h4>7.23.1 Structure</h4>
+<h4>7.25.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -4384,7 +4561,7 @@
</ul>
</li>
</ul>
-<h4>7.23.2 RNC</h4>
+<h4>7.25.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_configs
= element get_configs
@@ -4566,7 +4743,7 @@
}
</pre></div>
</div>
-<h4>7.23.3 Example: Get all configs</h4>
+<h4>7.25.3 Example: Get all configs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs/>
</pre></div>
@@ -4597,7 +4774,7 @@
</get_configs_response>
</pre></div>
</div>
-<h4>7.23.3 Example: Get a single config, including preference and family lists</h4>
+<h4>7.25.3 Example: Get a single config, including preference and family lists</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_configs config_id="daba56c8-73ec-11df-a475-002264764cea"
preferences="1"
@@ -4652,7 +4829,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_dependencies">7.24
+<div><h3 id="command_get_dependencies">7.26
Command <tt>get_dependencies</tt>
</h3></div>
<p>In short: Get dependencies for all available NVTs.</p>
@@ -4660,7 +4837,7 @@
The client uses the get_dependencies command to request the
dependencies for one or all NVTs available through this manager.
</p>
-<h4>7.24.1 Structure</h4>
+<h4>7.26.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -4713,7 +4890,7 @@
</ul>
</li>
</ul>
-<h4>7.24.2 RNC</h4>
+<h4>7.26.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_dependencies
= element get_dependencies
@@ -4763,7 +4940,7 @@
}
</pre></div>
</div>
-<h4>7.24.3 Example: Get dependencies for all NVTs</h4>
+<h4>7.26.3 Example: Get dependencies for all NVTs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies/>
</pre></div>
@@ -4781,7 +4958,7 @@
</get_dependencies_response>
</pre></div>
</div>
-<h4>7.24.3 Example: Get dependencies for a single NVT</h4>
+<h4>7.26.3 Example: Get dependencies for a single NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_dependencies nvt_oid="1.3.6.1.4.1.25623.1.0.114664"/>
</pre></div>
@@ -4800,7 +4977,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_escalators">7.25
+<div><h3 id="command_get_escalators">7.27
Command <tt>get_escalators</tt>
</h3></div>
<p>In short: Get all escalators.</p>
@@ -4809,7 +4986,7 @@
If the command sent by the client was valid, the manager will
reply with a list of escalators to the client.
</p>
-<h4>7.25.1 Structure</h4>
+<h4>7.27.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -4900,7 +5077,7 @@
</ul>
</li>
</ul>
-<h4>7.25.2 RNC</h4>
+<h4>7.27.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_escalators
= element get_escalators
@@ -5008,7 +5185,7 @@
}
</pre></div>
</div>
-<h4>7.25.3 Example: Get the escalators</h4>
+<h4>7.27.3 Example: Get the escalators</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_escalators/>
</pre></div>
@@ -5054,7 +5231,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_lsc_credentials">7.26
+<div><h3 id="command_get_lsc_credentials">7.28
Command <tt>get_lsc_credentials</tt>
</h3></div>
<p>In short: Get all LSC credentials.</p>
@@ -5063,7 +5240,7 @@
If the command sent by the client was valid, the manager will
reply with a list of LSC credentials to the client.
</p>
-<h4>7.26.1 Structure</h4>
+<h4>7.28.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -5162,7 +5339,7 @@
</ul>
</li>
</ul>
-<h4>7.26.2 RNC</h4>
+<h4>7.28.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_lsc_credentials
= element get_lsc_credentials
@@ -5258,7 +5435,7 @@
}
</pre></div>
</div>
-<h4>7.26.3 Example: Get all the LSC credentials</h4>
+<h4>7.28.3 Example: Get all the LSC credentials</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials/>
</pre></div>
@@ -5288,7 +5465,7 @@
</get_lsc_credentials_response>
</pre></div>
</div>
-<h4>7.26.3 Example: Get the public key of a single LSC credential</h4>
+<h4>7.28.3 Example: Get the public key of a single LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
format="key"/>
@@ -5313,7 +5490,7 @@
</get_lsc_credentials_response>
</pre></div>
</div>
-<h4>7.26.3 Example: Get the Debian package of a single LSC credential</h4>
+<h4>7.28.3 Example: Get the Debian package of a single LSC credential</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
format="deb"/>
@@ -5338,7 +5515,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_notes">7.27
+<div><h3 id="command_get_notes">7.29
Command <tt>get_notes</tt>
</h3></div>
<p>In short: Get all notes.</p>
@@ -5347,7 +5524,7 @@
If the command sent by the client was valid, the manager will
reply with a list of notes to the client.
</p>
-<h4>7.27.1 Structure</h4>
+<h4>7.29.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -5512,7 +5689,7 @@
</ul>
</li>
</ul>
-<h4>7.27.2 RNC</h4>
+<h4>7.29.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_notes
= element get_notes
@@ -5681,7 +5858,7 @@
}
</pre></div>
</div>
-<h4>7.27.3 Example: Get all notes</h4>
+<h4>7.29.3 Example: Get all notes</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes/>
</pre></div>
@@ -5698,7 +5875,7 @@
</get_notes_response>
</pre></div>
</div>
-<h4>7.27.3 Example: Get details of a single note</h4>
+<h4>7.29.3 Example: Get details of a single note</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_notes note_id="7f618bbb-4664-419e-9bbf-367d93954cb0"
details="1"
@@ -5739,7 +5916,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_nvts">7.28
+<div><h3 id="command_get_nvts">7.30
Command <tt>get_nvts</tt>
</h3></div>
<p>In short: Get all NVTs.</p>
@@ -5770,7 +5947,7 @@
NVT information. If the manager cannot access a list of available
NVTs at that time, it will reply with the 503 response.
</p>
-<h4>7.28.1 Structure</h4>
+<h4>7.30.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -5947,7 +6124,7 @@
</ul>
</li>
</ul>
-<h4>7.28.2 RNC</h4>
+<h4>7.30.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_nvts
= element get_nvts
@@ -6152,7 +6329,7 @@
}
</pre></div>
</div>
-<h4>7.28.3 Example: Get full NVT listing</h4>
+<h4>7.30.3 Example: Get full NVT listing</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts details="1"
timeout="1"
@@ -6210,7 +6387,7 @@
</get_nvts_response>
</pre></div>
</div>
-<h4>7.28.3 Example: Get minimal information about one NVT</h4>
+<h4>7.30.3 Example: Get minimal information about one NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvts nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
</pre></div>
@@ -6228,7 +6405,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_nvt_families">7.29
+<div><h3 id="command_get_nvt_families">7.31
Command <tt>get_nvt_families</tt>
</h3></div>
<p>In short: Get a list of all NVT families.</p>
@@ -6237,7 +6414,7 @@
information. If the command sent by the client was valid, the
manager will reply with a list of NVT families to the client.
</p>
-<h4>7.29.1 Structure</h4>
+<h4>7.31.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -6276,7 +6453,7 @@
</ul>
</li>
</ul>
-<h4>7.29.2 RNC</h4>
+<h4>7.31.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_nvt_families
= element get_nvt_families
@@ -6318,7 +6495,7 @@
}
</pre></div>
</div>
-<h4>7.29.3 Example: Get the NVT families</h4>
+<h4>7.31.3 Example: Get the NVT families</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_families/>
</pre></div>
@@ -6340,7 +6517,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_nvt_feed_checksum">7.30
+<div><h3 id="command_get_nvt_feed_checksum">7.32
Command <tt>get_nvt_feed_checksum</tt>
</h3></div>
<p>In short: Get checksum for entire NVT collection.</p>
@@ -6364,7 +6541,7 @@
files. If the manager cannot access a list of available NVTs at
present, it will reply with the 503 response.
</p>
-<h4>7.30.1 Structure</h4>
+<h4>7.32.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -6392,7 +6569,7 @@
</ul>
</li>
</ul>
-<h4>7.30.2 RNC</h4>
+<h4>7.32.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_nvt_feed_checksum
= element get_nvt_feed_checksum
@@ -6416,7 +6593,7 @@
}
</pre></div>
</div>
-<h4>7.30.3 Example: Get the NVT feed checksum</h4>
+<h4>7.32.3 Example: Get the NVT feed checksum</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_nvt_feed_checksum/>
</pre></div>
@@ -6428,7 +6605,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_overrides">7.31
+<div><h3 id="command_get_overrides">7.33
Command <tt>get_overrides</tt>
</h3></div>
<p>In short: Get all overrides.</p>
@@ -6437,7 +6614,7 @@
If the command sent by the client was valid, the manager will
reply with a list of overrides to the client.
</p>
-<h4>7.31.1 Structure</h4>
+<h4>7.33.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -6607,7 +6784,7 @@
</ul>
</li>
</ul>
-<h4>7.31.2 RNC</h4>
+<h4>7.33.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_overrides
= element get_overrides
@@ -6783,7 +6960,7 @@
}
</pre></div>
</div>
-<h4>7.31.3 Example: Get all overrides</h4>
+<h4>7.33.3 Example: Get all overrides</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides/>
</pre></div>
@@ -6802,7 +6979,7 @@
</get_overrides_response>
</pre></div>
</div>
-<h4>7.31.3 Example: Get details of a single override</h4>
+<h4>7.33.3 Example: Get details of a single override</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_overrides override_id="7f618bbb-4664-419e-9bbf-367d93954cb0"
details="1"/>
@@ -6832,7 +7009,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_preferences">7.32
+<div><h3 id="command_get_preferences">7.34
Command <tt>get_preferences</tt>
</h3></div>
<p>In short: Get all preferences.</p>
@@ -6848,7 +7025,7 @@
preference applies. Otherwise, the preference element includes just the
name and value, with the NVT and type built into the name.
</p>
-<h4>7.32.1 Structure</h4>
+<h4>7.34.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -6916,7 +7093,7 @@
</ul>
</li>
</ul>
-<h4>7.32.2 RNC</h4>
+<h4>7.34.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_preferences
= element get_preferences
@@ -6975,7 +7152,7 @@
}
</pre></div>
</div>
-<h4>7.32.3 Example: Get default preferences for all NVTs</h4>
+<h4>7.34.3 Example: Get default preferences for all NVTs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences/>
</pre></div>
@@ -6989,7 +7166,7 @@
</get_preferences_response>
</pre></div>
</div>
-<h4>7.32.3 Example: Get default preferences for a single NVT</h4>
+<h4>7.34.3 Example: Get default preferences for a single NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
</pre></div>
@@ -7003,7 +7180,7 @@
</get_preferences_response>
</pre></div>
</div>
-<h4>7.32.3 Example: Get preferences from a config for all NVTs</h4>
+<h4>7.34.3 Example: Get preferences from a config for all NVTs</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea"/>
</pre></div>
@@ -7021,7 +7198,7 @@
</get_preferences_response>
</pre></div>
</div>
-<h4>7.32.3 Example: Get preferences from a config for a single NVT</h4>
+<h4>7.34.3 Example: Get preferences from a config for a single NVT</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea"
nvt_oid="1.3.6.1.4.1.25623.1.0.10330"/>
@@ -7040,7 +7217,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_reports">7.33
+<div><h3 id="command_get_reports">7.35
Command <tt>get_reports</tt>
</h3></div>
<p>In short: Get all reports.</p>
@@ -7051,7 +7228,7 @@
The XML report format is sent as XML. All other formats are sent in
Base64 encoding.
</p>
-<h4>7.33.1 Structure</h4>
+<h4>7.35.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -7380,7 +7557,7 @@
</ul>
</li>
</ul>
-<h4>7.33.2 RNC</h4>
+<h4>7.35.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_reports
= element get_reports
@@ -7712,7 +7889,7 @@
}
</pre></div>
</div>
-<h4>7.33.3 Example: Get a report in PDF</h4>
+<h4>7.35.3 Example: Get a report in PDF</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
format="PDF"/>
@@ -7723,7 +7900,7 @@
</get_reports_response>
</pre></div>
</div>
-<h4>7.33.3 Example: Get a report in XML</h4>
+<h4>7.35.3 Example: Get a report in XML</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_reports report_id="f0fdf522-276d-4893-9274-fb8699dc2270"/>
</pre></div>
@@ -7804,7 +7981,389 @@
</div>
</div>
<div>
-<div><h3 id="command_get_results">7.34
+<div><h3 id="command_get_report_formats">7.36
+ Command <tt>get_report_formats</tt>
+</h3></div>
+<p>In short: Get all report formats.</p>
+<p>
+ The client uses the get_report_formats command to get report format
+ information.
+ </p>
+<h4>7.36.1 Structure</h4>
+<ul style="list-style: none">
+<li>
+<i>Command</i><ul style="list-style: none">
+<li>
+ @<b>report_format_id</b>
+ (<a href="#type_uuid">uuid</a>)
+ ID of single report format to get.
+ </li>
+<li>
+ @<b>export</b>
+ (<a href="#type_boolean">boolean</a>)
+ Whether to get report format in importable form.
+ </li>
+<li>
+ @<b>params</b>
+ (<a href="#type_boolean">boolean</a>)
+ Whether to include report format parameters.
+ </li>
+<li>
+ @<b>sort_order</b>
+ (<a href="#type_sort_order">sort_order</a>)
+ </li>
+<li>
+ @<b>sort_field</b>
+ (text)
+ </li>
+</ul>
+</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
+<li>
+ @<b>status</b>
+ (<a href="#type_status">status</a>)
+ </li>
+<li>
+ @<b>status_text</b>
+ (text)
+ </li>
+<li>
+ <<b>report_format</b>>
+ *<ul style="list-style: none">
+<li>
+ @<b>id</b>
+ (<a href="#type_uuid">uuid</a>)
+ </li>
+<li>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the report format.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>summary</b>>
+ <ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>description</b>>
+ <ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>extension</b>>
+ <ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>content_type</b>>
+ <ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>global</b>>
+ <ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>param</b>>
+ *<ul style="list-style: none">
+<li>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the param.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>type</b>>
+ <div style="margin-left: 15px; display: inline;">The type of the param.</div>
+<ul style="list-style: none">
+<li>
+ <<b>min</b>>
+ ?<div style="margin-left: 15px; display: inline;">Minimum.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>max</b>>
+ ?<div style="margin-left: 15px; display: inline;">Maximum.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>options</b>>
+ ?<div style="margin-left: 15px; display: inline;">Selection options.</div>
+<ul style="list-style: none"><li>
+ <<b>option</b>>
+ *<div style="margin-left: 15px; display: inline;">Option value.</div>
+<ul style="list-style: none"></ul>
+</li></ul>
+</li>
+</ul>
+</li>
+<li>
+ <<b>value</b>>
+ <div style="margin-left: 15px; display: inline;">The value of the param.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>default</b>>
+ <div style="margin-left: 15px; display: inline;">The fallback value of the param.</div>
+<ul style="list-style: none"></ul>
+</li>
+</ul>
+</li>
+<li>
+<i>One of</i><b></b><ul style="list-style: none">
+<li>
+ <<b>file</b>>
+ *<div style="margin-left: 15px; display: inline;">One of the files used to generate the report.</div>
+<ul style="list-style: none"><li>
+ @<b>name</b>
+ (text)
+ </li></ul>
+</li>
+<li>
+<i>The group</i><b></b><ul style="list-style: none">
+<li>
+ <<b>trust</b>>
+ <div style="margin-left: 15px; display: inline;">Whether signature verification succeeded.</div>
+<ul style="list-style: none">
+<li>
+ @<b>name</b>
+ (text)
+ </li>
+<li>
+ <<b>time</b>>
+ <div style="margin-left: 15px; display: inline;">The time the trust was checked.</div>
+<ul style="list-style: none"></ul>
+</li>
+</ul>
+</li>
+<li>
+ <<b>active</b>>
+ <div style="margin-left: 15px; display: inline;">Whether the report format is active.</div>
+<ul style="list-style: none"></ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<h4>7.36.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<i>Command</i><div style="margin-left: 5%"><pre>get_report_formats
+ = element get_report_formats
+ {
+ attribute report_format_id { uuid }?
+ & attribute export { boolean }?
+ & attribute params { boolean }?
+ & attribute sort_order { sort_order }?
+ & attribute sort_field { text }?
+ }
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_report_formats_response
+ = element get_report_formats_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ & get_report_formats_response_report_format*
+ }
+
+get_report_formats_response_report_format
+ = element report_format
+ {
+ attribute id { uuid }
+ & get_report_formats_response_report_format_name
+ & get_report_formats_response_report_format_summary
+ & get_report_formats_response_report_format_description
+ & get_report_formats_response_report_format_extension
+ & get_report_formats_response_report_format_content_type
+ & get_report_formats_response_report_format_global
+ & get_report_formats_response_report_format_param*
+ & ( get_report_formats_response_report_format_file*
+ | ( get_report_formats_response_report_format_trust
+ & get_report_formats_response_report_format_active ) )
+ }
+
+get_report_formats_response_report_format_name
+ = element name
+ {
+ name
+ }
+
+get_report_formats_response_report_format_summary
+ = element summary
+ {
+ text
+ }
+
+get_report_formats_response_report_format_description
+ = element description
+ {
+ text
+ }
+
+get_report_formats_response_report_format_extension
+ = element extension
+ {
+ text
+ }
+
+get_report_formats_response_report_format_global
+ = element global
+ {
+ boolean
+ }
+
+get_report_formats_response_report_format_content_type
+ = element content_type
+ {
+ text
+ }
+
+get_report_formats_response_report_format_param
+ = element param
+ {
+ get_report_formats_response_report_format_param_name
+ & get_report_formats_response_report_format_param_type
+ & get_report_formats_response_report_format_param_value
+ & get_report_formats_response_report_format_param_default
+ }
+
+get_report_formats_response_report_format_param_name
+ = element name
+ {
+ name
+ }
+
+get_report_formats_response_report_format_param_type
+ = element type
+ {
+ text # RNC limitation: xsd:token { pattern = "boolean|integer|selection|string|text" }
+ & get_report_formats_response_report_format_param_type_min?
+ & get_report_formats_response_report_format_param_type_max?
+ & get_report_formats_response_report_format_param_type_options?
+ }
+
+get_report_formats_response_report_format_param_type_min
+ = element min
+ {
+ text
+ }
+
+get_report_formats_response_report_format_param_type_max
+ = element max
+ {
+ text
+ }
+
+get_report_formats_response_report_format_param_type_options
+ = element options
+ {
+ get_report_formats_response_report_format_param_type_options_option*
+ }
+
+get_report_formats_response_report_format_param_type_options_option
+ = element option
+ {
+ text
+ }
+
+get_report_formats_response_report_format_param_value
+ = element value
+ {
+ text
+ }
+
+get_report_formats_response_report_format_param_default
+ = element default
+ {
+ text
+ }
+
+get_report_formats_response_report_format_file
+ = element file
+ {
+ text # RNC limitation: base64
+ & attribute name { text }
+ }
+
+get_report_formats_response_report_format_trust
+ = element trust
+ {
+ text # RNC limitation: xsd:token { pattern = "yes|no|unknown" }
+ & attribute name { text }
+ & get_report_formats_response_report_format_trust_time
+ }
+
+get_report_formats_response_report_format_trust_time
+ = element time
+ {
+ ctime
+ }
+
+get_report_formats_response_report_format_active
+ = element active
+ {
+ boolean
+ }
+</pre></div>
+</div>
+<h4>7.36.3 Example: Get information about a report format</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats_response status="200"
+ status_text="OK">
+ <report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
+ <name>HTML</name>
+ <extension>html</extension>
+ <content_type>text/html</content_type>
+ <summary>Single page HTML report.</summary>
+ <description>
+ A single HTML page listing results of a scan. Style information
+ ...
+ </description>
+ <global>1</global>
+ <trust>
+ no
+ <time>Thu Dec 2 13:22:26 2010</time>
+ </trust>
+ <active>1</active>
+ </report_format>
+ </get_report_formats_response>
+</pre></div>
+</div>
+<h4>7.36.3 Example: Export a report format</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"
+ export="1"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_report_formats_response status="200"
+ status_text="OK">
+ <report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
+ <name>HTML</name>
+ <extension>html</extension>
+ <content_type>text/html</content_type>
+ <summary>Single page HTML report.</summary>
+ <description>
+ A single HTML page listing results of a scan. Style information
+ ...
+ </description>
+ <global>1</global>
+ <file name="HTML.xsl">
+ PD9ldD4K
+ ...
+ </file>
+ <file name="generate">
+ IyEvAk
+ ...
+ </file>
+ <signature/>
+ </report_format>
+ </get_report_formats_response>
+</pre></div>
+</div>
+</div>
+<div>
+<div><h3 id="command_get_results">7.37
Command <tt>get_results</tt>
</h3></div>
<p>In short: Get results.</p>
@@ -7816,7 +8375,7 @@
apply_overrides flag and any of these is true, then the request
must also include a task ID.
</p>
-<h4>7.34.1 Structure</h4>
+<h4>7.37.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -8008,7 +8567,7 @@
</ul>
</li>
</ul>
-<h4>7.34.2 RNC</h4>
+<h4>7.37.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_results
= element get_results
@@ -8202,7 +8761,7 @@
}
</pre></div>
</div>
-<h4>7.34.3 Example: Get all results</h4>
+<h4>7.37.3 Example: Get all results</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_results/>
</pre></div>
@@ -8226,7 +8785,7 @@
</get_results_response>
</pre></div>
</div>
-<h4>7.34.3 Example: Get a result, including notes and overrides</h4>
+<h4>7.37.3 Example: Get a result, including notes and overrides</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_results result_id="cac9e7c8-c726-49fd-a710-5f99079ab93e"
task_id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4"
@@ -8266,14 +8825,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_schedules">7.35
+<div><h3 id="command_get_schedules">7.38
Command <tt>get_schedules</tt>
</h3></div>
<p>In short: Get all schedules.</p>
<p>
The client uses the get_schedules command to get schedule information.
</p>
-<h4>7.35.1 Structure</h4>
+<h4>7.38.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -8380,7 +8939,7 @@
</ul>
</li>
</ul>
-<h4>7.35.2 RNC</h4>
+<h4>7.38.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_schedules
= element get_schedules
@@ -8482,7 +9041,7 @@
}
</pre></div>
</div>
-<h4>7.35.3 Example: Get all schedules</h4>
+<h4>7.38.3 Example: Get all schedules</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_schedules/>
</pre></div>
@@ -8495,7 +9054,7 @@
</get_schedules_response>
</pre></div>
</div>
-<h4>7.35.3 Example: Get full details of a single schedule</h4>
+<h4>7.38.3 Example: Get full details of a single schedule</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_schedules schedule_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
details="1"/>
@@ -8522,14 +9081,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_system_reports">7.36
+<div><h3 id="command_get_system_reports">7.39
Command <tt>get_system_reports</tt>
</h3></div>
<p>In short: Get all system reports.</p>
<p>
The client uses the get_system_reports command to get system reports.
</p>
-<h4>7.36.1 Structure</h4>
+<h4>7.39.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -8591,7 +9150,7 @@
</ul>
</li>
</ul>
-<h4>7.36.2 RNC</h4>
+<h4>7.39.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_system_reports
= element get_system_reports
@@ -8638,7 +9197,7 @@
}
</pre></div>
</div>
-<h4>7.36.3 Example: Get listing of available system reports</h4>
+<h4>7.39.3 Example: Get listing of available system reports</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_system_reports brief="1"/>
</pre></div>
@@ -8660,7 +9219,7 @@
</get_system_reports_response>
</pre></div>
</div>
-<h4>7.36.3 Example: Get a system report</h4>
+<h4>7.39.3 Example: Get a system report</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_system_reports name="proc"/>
</pre></div>
@@ -8679,14 +9238,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_target_locators">7.37
+<div><h3 id="command_get_target_locators">7.40
Command <tt>get_target_locators</tt>
</h3></div>
<p>In short: Get configured target locators.</p>
<p>
The client uses the get_target_locators command to get target locators.
</p>
-<h4>7.37.1 Structure</h4>
+<h4>7.40.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
@@ -8712,7 +9271,7 @@
</ul>
</li>
</ul>
-<h4>7.37.2 RNC</h4>
+<h4>7.40.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_target_locators
= element get_target_locators
@@ -8741,7 +9300,7 @@
}
</pre></div>
</div>
-<h4>7.37.3 Example: Get target locators</h4>
+<h4>7.40.3 Example: Get target locators</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_target_locators/>
</pre></div>
@@ -8756,14 +9315,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_targets">7.38
+<div><h3 id="command_get_targets">7.41
Command <tt>get_targets</tt>
</h3></div>
<p>In short: Get all targets.</p>
<p>
The client uses the get_targets command to get target information.
</p>
-<h4>7.38.1 Structure</h4>
+<h4>7.41.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -8862,7 +9421,7 @@
</ul>
</li>
</ul>
-<h4>7.38.2 RNC</h4>
+<h4>7.41.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_targets
= element get_targets
@@ -8956,7 +9515,7 @@
}
</pre></div>
</div>
-<h4>7.38.3 Example: Get all targets</h4>
+<h4>7.41.3 Example: Get all targets</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_targets/>
</pre></div>
@@ -8976,7 +9535,7 @@
</get_targets_response>
</pre></div>
</div>
-<h4>7.38.3 Example: Get a single target, including tasks using the target</h4>
+<h4>7.41.3 Example: Get a single target, including tasks using the target</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_targets target_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
tasks="1"/>
@@ -9004,7 +9563,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_tasks">7.39
+<div><h3 id="command_get_tasks">7.42
Command <tt>get_tasks</tt>
</h3></div>
<p>In short: Get all tasks.</p>
@@ -9016,7 +9575,7 @@
the values of the sort order, sort field and apply overrides flag
that the manager applied when selecting the tasks.
</p>
-<h4>7.39.1 Structure</h4>
+<h4>7.42.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -9389,7 +9948,7 @@
</ul>
</li>
</ul>
-<h4>7.39.2 RNC</h4>
+<h4>7.42.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_tasks
= element get_tasks
@@ -9868,7 +10427,7 @@
}
</pre></div>
</div>
-<h4>7.39.3 Example: Get all tasks</h4>
+<h4>7.42.3 Example: Get all tasks</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_tasks/>
</pre></div>
@@ -9956,7 +10515,7 @@
</get_tasks_response>
</pre></div>
</div>
-<h4>7.39.3 Example: Get a single task, including all reports</h4>
+<h4>7.42.3 Example: Get a single task, including all reports</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_tasks task_id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c"
details="1"/>
@@ -10067,11 +10626,11 @@
</div>
</div>
<div>
-<div><h3 id="command_get_version">7.40
+<div><h3 id="command_get_version">7.43
Command <tt>get_version</tt>
</h3></div>
<p>In short: Get the OpenVAS Manager Protocol version.</p>
-<h4>7.40.1 Structure</h4>
+<h4>7.43.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
@@ -10093,7 +10652,7 @@
</ul>
</li>
</ul>
-<h4>7.40.2 RNC</h4>
+<h4>7.43.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>get_version
= element get_version
@@ -10116,7 +10675,7 @@
}
</pre></div>
</div>
-<h4>7.40.3 Example: Get the version</h4>
+<h4>7.43.3 Example: Get the version</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_version/>
</pre></div>
@@ -10128,11 +10687,11 @@
</div>
</div>
<div>
-<div><h3 id="command_help">7.41
+<div><h3 id="command_help">7.44
Command <tt>help</tt>
</h3></div>
<p>In short: Get the help text.</p>
-<h4>7.41.1 Structure</h4>
+<h4>7.44.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -10218,7 +10777,7 @@
</ul>
</li>
</ul>
-<h4>7.41.2 RNC</h4>
+<h4>7.44.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>help
= element help
@@ -10330,7 +10889,7 @@
}
</pre></div>
</div>
-<h4>7.41.3 Example: Get the help text</h4>
+<h4>7.44.3 Example: Get the help text</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <help/>
</pre></div>
@@ -10392,7 +10951,7 @@
</help_response>
</pre></div>
</div>
-<h4>7.41.3 Example: Get the OMP schema</h4>
+<h4>7.44.3 Example: Get the OMP schema</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <help format="XML"/>
</pre></div>
@@ -10487,7 +11046,7 @@
</div>
</div>
<div>
-<div><h3 id="command_modify_config">7.42
+<div><h3 id="command_modify_config">7.45
Command <tt>modify_config</tt>
</h3></div>
<p>In short: Update an existing config.</p>
@@ -10538,7 +11097,7 @@
apply the changes to the config and will reply with a response code indicating
success.
</p>
-<h4>7.42.1 Structure</h4>
+<h4>7.45.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -10635,7 +11194,7 @@
</ul>
</li>
</ul>
-<h4>7.42.2 RNC</h4>
+<h4>7.45.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_config
= element modify_config
@@ -10738,7 +11297,7 @@
}
</pre></div>
</div>
-<h4>7.42.3 Example: Modify a config preference</h4>
+<h4>7.45.3 Example: Modify a config preference</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<preference>
@@ -10752,7 +11311,7 @@
status_text="OK"/>
</pre></div>
</div>
-<h4>7.42.3 Example: Modify the families that a config selects</h4>
+<h4>7.45.3 Example: Modify the families that a config selects</h4>
<p>
The outer "growing" element sets the config to add any new families
that arrive.
@@ -10779,7 +11338,7 @@
status_text="OK"/>
</pre></div>
</div>
-<h4>7.42.3 Example: Modify the NVTs that a config selects in a particular family</h4>
+<h4>7.45.3 Example: Modify the NVTs that a config selects in a particular family</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<nvt_selection>
@@ -10797,7 +11356,7 @@
</div>
</div>
<div>
-<div><h3 id="command_modify_note">7.43
+<div><h3 id="command_modify_note">7.46
Command <tt>modify_note</tt>
</h3></div>
<p>In short: Modify an existing note.</p>
@@ -10808,7 +11367,7 @@
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
-<h4>7.43.1 Structure</h4>
+<h4>7.46.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -10868,7 +11427,7 @@
</ul>
</li>
</ul>
-<h4>7.43.2 RNC</h4>
+<h4>7.46.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_note
= element modify_note
@@ -10926,7 +11485,7 @@
}
</pre></div>
</div>
-<h4>7.43.3 Example: Modify the text and result of a note</h4>
+<h4>7.46.3 Example: Modify the text and result of a note</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_note note_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<text>This issue should be resolved after the upgrade.</text>
@@ -10939,7 +11498,7 @@
</div>
</div>
<div>
-<div><h3 id="command_modify_override">7.44
+<div><h3 id="command_modify_override">7.47
Command <tt>modify_override</tt>
</h3></div>
<p>In short: Modify an existing override.</p>
@@ -10951,7 +11510,7 @@
If an optional element is left out, the existing value will be
cleared, generalising that constraint.
</p>
-<h4>7.44.1 Structure</h4>
+<h4>7.47.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -11016,7 +11575,7 @@
</ul>
</li>
</ul>
-<h4>7.44.2 RNC</h4>
+<h4>7.47.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_override
= element modify_override
@@ -11081,7 +11640,7 @@
}
</pre></div>
</div>
-<h4>7.44.3 Example: Set the override threat to Low</h4>
+<h4>7.47.3 Example: Set the override threat to Low</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_override override_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<text>This issue is less important in our setup.</text>
@@ -11094,7 +11653,7 @@
</div>
</div>
<div>
-<div><h3 id="command_modify_report">7.45
+<div><h3 id="command_modify_report">7.48
Command <tt>modify_report</tt>
</h3></div>
<p>In short: Modify an existing report.</p>
@@ -11102,7 +11661,7 @@
The client uses the modify_report command to change an existing
report.
</p>
-<h4>7.45.1 Structure</h4>
+<h4>7.48.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -11131,7 +11690,7 @@
</ul>
</li>
</ul>
-<h4>7.45.2 RNC</h4>
+<h4>7.48.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_report
= element modify_report
@@ -11154,7 +11713,7 @@
}
</pre></div>
</div>
-<h4>7.45.3 Example: Modify a report comment</h4>
+<h4>7.48.3 Example: Modify a report comment</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report report_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
@@ -11166,7 +11725,155 @@
</div>
</div>
<div>
-<div><h3 id="command_modify_task">7.46
+<div><h3 id="command_modify_report_format">7.49
+ Command <tt>modify_report_format</tt>
+</h3></div>
+<p>In short: Update an existing report format.</p>
+<p>
+ The client uses the modify_report_format command to change an existing
+ report format.
+ </p>
+<h4>7.49.1 Structure</h4>
+<ul style="list-style: none">
+<li>
+<i>Command</i><ul style="list-style: none">
+<li>
+ @<b>report_format_id</b>
+ (<a href="#type_uuid">uuid</a>)
+ ID of report format to modify.
+ </li>
+<li>
+<i>One of</i><b></b><ul style="list-style: none">
+<li>
+ <<b>active</b>>
+ <div style="margin-left: 15px; display: inline;">Whether the report format is active.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the report format.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>summary</b>>
+ <div style="margin-left: 15px; display: inline;">A summary of the report format.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>param</b>>
+ <ul style="list-style: none">
+<li>
+ <<b>name</b>>
+ <div style="margin-left: 15px; display: inline;">The name of the param.</div>
+<ul style="list-style: none"></ul>
+</li>
+<li>
+ <<b>value</b>>
+ ?<div style="margin-left: 15px; display: inline;">New value for the param.</div>
+<ul style="list-style: none"></ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
+<li>
+ @<b>status</b>
+ (<a href="#type_status">status</a>)
+ </li>
+<li>
+ @<b>status_text</b>
+ (text)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>7.49.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<i>Command</i><div style="margin-left: 5%"><pre>modify_report_format
+ = element modify_report_format
+ {
+ attribute report_format_id { uuid }
+ & ( modify_report_format_active
+ | modify_report_format_name
+ | modify_report_format_summary
+ | modify_report_format_param )
+ }
+
+modify_report_format_active
+ = element active
+ {
+ boolean
+ }
+
+modify_report_format_name
+ = element name
+ {
+ name
+ }
+
+modify_report_format_summary
+ = element summary
+ {
+ text
+ }
+
+modify_report_format_param
+ = element param
+ {
+ modify_report_format_param_name
+ & modify_report_format_param_value?
+ }
+
+modify_report_format_param_name
+ = element name
+ {
+ name
+ }
+
+modify_report_format_param_value
+ = element value
+ {
+ base64
+ }
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>modify_report_format_response
+ = element modify_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
+</pre></div>
+</div>
+<h4>7.49.3 Example: Modify a report format param</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <param>
+ <name>Background Colour</name>
+ <value>cmVk</value>
+ </param>
+ </modify_report_format>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format_response status="200"
+ status_text="OK"/>
+</pre></div>
+</div>
+<h4>7.49.3 Example: Modify the name of a report format</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <name>New name</name>
+ </modify_report_format>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_report_format_response status="200"
+ status_text="OK"/>
+</pre></div>
+</div>
+</div>
+<div>
+<div><h3 id="command_modify_task">7.50
Command <tt>modify_task</tt>
</h3></div>
<p>In short: Modify an existing task.</p>
@@ -11174,7 +11881,7 @@
The client uses the modify_task command to change an existing
task.
</p>
-<h4>7.46.1 Structure</h4>
+<h4>7.50.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -11247,7 +11954,7 @@
</ul>
</li>
</ul>
-<h4>7.46.2 RNC</h4>
+<h4>7.50.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>modify_task
= element modify_task
@@ -11307,7 +12014,7 @@
}
</pre></div>
</div>
-<h4>7.46.3 Example: Modify a task comment</h4>
+<h4>7.50.3 Example: Modify a task comment</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<comment>Monthly scan of the webserver.</comment>
@@ -11319,14 +12026,14 @@
</div>
</div>
<div>
-<div><h3 id="command_pause_task">7.47
+<div><h3 id="command_pause_task">7.51
Command <tt>pause_task</tt>
</h3></div>
<p>In short: Pause a running task.</p>
<p>
The client uses the pause_task command to manually pause a running task.
</p>
-<h4>7.47.1 Structure</h4>
+<h4>7.51.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -11347,7 +12054,7 @@
</ul>
</li>
</ul>
-<h4>7.47.2 RNC</h4>
+<h4>7.51.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>pause_task
= element pause_task
@@ -11363,7 +12070,7 @@
}
</pre></div>
</div>
-<h4>7.47.3 Example: Pause a running task</h4>
+<h4>7.51.3 Example: Pause a running task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <pause_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -11373,7 +12080,7 @@
</div>
</div>
<div>
-<div><h3 id="command_resume_or_start_task">7.48
+<div><h3 id="command_resume_or_start_task">7.52
Command <tt>resume_or_start_task</tt>
</h3></div>
<p>In short: Resume task if stopped, else start task.</p>
@@ -11382,7 +12089,7 @@
an existing task, ensuring that the task will resume from its
previous position if the task is in the Stopped state.
</p>
-<h4>7.48.1 Structure</h4>
+<h4>7.52.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -11403,7 +12110,7 @@
</ul>
</li>
</ul>
-<h4>7.48.2 RNC</h4>
+<h4>7.52.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>resume_or_start_task
= element resume_or_start_task
@@ -11419,7 +12126,7 @@
}
</pre></div>
</div>
-<h4>7.48.3 Example: Resume a running task</h4>
+<h4>7.52.3 Example: Resume a running task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_or_start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -11429,7 +12136,7 @@
</div>
</div>
<div>
-<div><h3 id="command_resume_paused_task">7.49
+<div><h3 id="command_resume_paused_task">7.53
Command <tt>resume_paused_task</tt>
</h3></div>
<p>In short: Resume a paused task.</p>
@@ -11437,7 +12144,7 @@
The client uses the resume_paused_task command to manually resume a
paused task.
</p>
-<h4>7.49.1 Structure</h4>
+<h4>7.53.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -11458,7 +12165,7 @@
</ul>
</li>
</ul>
-<h4>7.49.2 RNC</h4>
+<h4>7.53.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>resume_paused_task
= element resume_paused_task
@@ -11474,7 +12181,7 @@
}
</pre></div>
</div>
-<h4>7.49.3 Example: Resume a paused task</h4>
+<h4>7.53.3 Example: Resume a paused task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_paused_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -11484,7 +12191,7 @@
</div>
</div>
<div>
-<div><h3 id="command_resume_stopped_task">7.50
+<div><h3 id="command_resume_stopped_task">7.54
Command <tt>resume_stopped_task</tt>
</h3></div>
<p>In short: Resume a stopped task.</p>
@@ -11492,7 +12199,7 @@
The client uses the resume_stopped_task command to manually resume a
stopped task.
</p>
-<h4>7.50.1 Structure</h4>
+<h4>7.54.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -11513,7 +12220,7 @@
</ul>
</li>
</ul>
-<h4>7.50.2 RNC</h4>
+<h4>7.54.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>resume_stopped_task
= element resume_stopped_task
@@ -11529,7 +12236,7 @@
}
</pre></div>
</div>
-<h4>7.50.3 Example: Resume a stopped task</h4>
+<h4>7.54.3 Example: Resume a stopped task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <resume_stopped_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -11539,7 +12246,7 @@
</div>
</div>
<div>
-<div><h3 id="command_start_task">7.51
+<div><h3 id="command_start_task">7.55
Command <tt>start_task</tt>
</h3></div>
<p>In short: Manually start an existing task.</p>
@@ -11547,7 +12254,7 @@
The client uses the start_task command to manually start an
existing task.
</p>
-<h4>7.51.1 Structure</h4>
+<h4>7.55.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -11568,7 +12275,7 @@
</ul>
</li>
</ul>
-<h4>7.51.2 RNC</h4>
+<h4>7.55.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>start_task
= element start_task
@@ -11584,7 +12291,7 @@
}
</pre></div>
</div>
-<h4>7.51.3 Example: Start a task</h4>
+<h4>7.55.3 Example: Start a task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -11594,7 +12301,7 @@
</div>
</div>
<div>
-<div><h3 id="command_stop_task">7.52
+<div><h3 id="command_stop_task">7.56
Command <tt>stop_task</tt>
</h3></div>
<p>In short: Stop a running task.</p>
@@ -11602,7 +12309,7 @@
The client uses the stop_task command to manually stop a
running task.
</p>
-<h4>7.52.1 Structure</h4>
+<h4>7.56.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -11623,7 +12330,7 @@
</ul>
</li>
</ul>
-<h4>7.52.2 RNC</h4>
+<h4>7.56.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>stop_task
= element stop_task
@@ -11639,7 +12346,7 @@
}
</pre></div>
</div>
-<h4>7.52.3 Example: Stop a running task</h4>
+<h4>7.56.3 Example: Stop a running task</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <stop_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
</pre></div>
@@ -11649,7 +12356,7 @@
</div>
</div>
<div>
-<div><h3 id="command_test_escalator">7.53
+<div><h3 id="command_test_escalator">7.57
Command <tt>test_escalator</tt>
</h3></div>
<p>In short: Run an escalator.</p>
@@ -11657,7 +12364,7 @@
The client uses the test_escalator command to invoke a test run of
an escalator.
</p>
-<h4>7.53.1 Structure</h4>
+<h4>7.57.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -11678,7 +12385,7 @@
</ul>
</li>
</ul>
-<h4>7.53.2 RNC</h4>
+<h4>7.57.2 RNC</h4>
<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
<i>Command</i><div style="margin-left: 5%"><pre>test_escalator
= element test_escalator
@@ -11694,7 +12401,7 @@
}
</pre></div>
</div>
-<h4>7.53.3 Example: Test an escalator</h4>
+<h4>7.57.3 Example: Test an escalator</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <test_escalator escalator_id="97390ade-e075-11df-9973-002264764cea"/>
</pre></div>
@@ -11703,6 +12410,128 @@
</pre></div>
</div>
</div>
+<div>
+<div><h3 id="command_verify_agent">7.58
+ Command <tt>verify_agent</tt>
+</h3></div>
+<p>In short: Verify an agent.</p>
+<p>
+ The client uses the verify_agent command to verify the trust
+ level of an existing agent.
+ </p>
+<p>
+ The Manager checks whether the signature of the agent currently
+ matches the agent. This includes the agent installer file.
+ The Manager searches for the signature first in the feed, then
+ in the agent itself.
+ </p>
+<h4>7.58.1 Structure</h4>
+<ul style="list-style: none">
+<li>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>agent_id</b>
+ (<a href="#type_uuid">uuid</a>)
+ </li></ul>
+</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
+<li>
+ @<b>status</b>
+ (<a href="#type_status">status</a>)
+ </li>
+<li>
+ @<b>status_text</b>
+ (text)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>7.58.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<i>Command</i><div style="margin-left: 5%"><pre>verify_agent
+ = element verify_agent
+ {
+ attribute agent_id { uuid }
+ }
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>verify_agent_response
+ = element verify_agent_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
+</pre></div>
+</div>
+<h4>7.58.3 Example: Verify an agent</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_agent_response status="200"
+ status_text="OK"/>
+</pre></div>
+</div>
+</div>
+<div>
+<div><h3 id="command_verify_report_format">7.59
+ Command <tt>verify_report_format</tt>
+</h3></div>
+<p>In short: Verify a report format.</p>
+<p>
+ The client uses the verify_report_format command to verify the trust
+ level of an existing report format.
+ </p>
+<p>
+ The Manager checks whether the signature of the report format currently
+ matches the report format. This includes the script and files used
+ to generate reports of this format. The Manager searches for the
+ signature first in the feed, then in the report format itself.
+ </p>
+<h4>7.59.1 Structure</h4>
+<ul style="list-style: none">
+<li>
+<i>Command</i><ul style="list-style: none"><li>
+ @<b>report_format_id</b>
+ (<a href="#type_uuid">uuid</a>)
+ </li></ul>
+</li>
+<li style="margin-top: 15px;">
+<i>Response</i><ul style="list-style: none">
+<li>
+ @<b>status</b>
+ (<a href="#type_status">status</a>)
+ </li>
+<li>
+ @<b>status_text</b>
+ (text)
+ </li>
+</ul>
+</li>
+</ul>
+<h4>7.59.2 RNC</h4>
+<div style="border: 1px solid; padding:10px; width: 85%; align: center; margin-left: auto; margin-right: auto; background: #d5d5d5;">
+<i>Command</i><div style="margin-left: 5%"><pre>verify_report_format
+ = element verify_report_format
+ {
+ attribute report_format_id { uuid }
+ }
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>verify_report_format_response
+ = element verify_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
+</pre></div>
+</div>
+<h4>7.59.3 Example: Verify a report format</h4>
+<div style="margin-left: 5%; margin-right: 5%;">
+<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <verify_report_format_response status="200"
+ status_text="OK"/>
+</pre></div>
+</div>
+</div>
<div style="text-align: center; padding: 5px;">
This file was automatically generated.
</div>
Modified: trunk/openvas-manager/doc/omp.rnc
===================================================================
--- trunk/openvas-manager/doc/omp.rnc 2010-12-13 18:01:19 UTC (rev 9705)
+++ trunk/openvas-manager/doc/omp.rnc 2010-12-13 18:03:30 UTC (rev 9706)
@@ -17,6 +17,7 @@
| create_lsc_credential
| create_note
| create_override
+ | create_report_format
| create_schedule
| create_target
| create_task
@@ -27,6 +28,7 @@
| delete_note
| delete_override
| delete_report
+ | delete_report_format
| delete_schedule
| delete_target
| delete_task
@@ -42,6 +44,7 @@
| get_overrides
| get_preferences
| get_reports
+ | get_report_formats
| get_results
| get_schedules
| get_system_reports
@@ -54,6 +57,7 @@
| modify_note
| modify_override
| modify_report
+ | modify_report_format
| modify_task
| pause_task
| resume_or_start_task
@@ -62,6 +66,8 @@
| start_task
| stop_task
| test_escalator
+ | verify_agent
+ | verify_report_format
response
= authenticate_response
@@ -72,6 +78,7 @@
| create_lsc_credential_response
| create_note_response
| create_override_response
+ | create_report_format_response
| create_schedule_response
| create_target_response
| create_task_response
@@ -82,6 +89,7 @@
| delete_note_response
| delete_override_response
| delete_report_response
+ | delete_report_format_response
| delete_schedule_response
| delete_target_response
| delete_task_response
@@ -97,6 +105,7 @@
| get_overrides_response
| get_preferences_response
| get_reports_response
+ | get_report_formats_response
| get_results_response
| get_schedules_response
| get_system_reports_response
@@ -109,6 +118,7 @@
| modify_note_response
| modify_override_response
| modify_report_response
+ | modify_report_format_response
| modify_task_response
| pause_task_response
| resume_or_start_task_response
@@ -117,6 +127,8 @@
| start_task_response
| stop_task_response
| test_escalator_response
+ | verify_agent_response
+ | verify_report_format_response
### Data Types
@@ -895,6 +907,16 @@
threat
}
+## Command create_report_format
+##
+## Create a report format.
+
+create_report_format
+ = element create_report_format
+ {
+ get_report_formats_response
+ }
+
## Command create_schedule
##
## Create a schedule.
@@ -1191,6 +1213,16 @@
attribute report_id { uuid }
}
+## Command delete_report_format
+##
+## Delete a report format.
+
+delete_report_format
+ = element delete_report_format
+ {
+ attribute report_format_id { uuid }
+ }
+
## Command delete_schedule
##
## Delete a schedule.
@@ -1416,6 +1448,23 @@
attribute result_hosts_only { boolean }?
}
+## Command get_report_formats
+##
+## Get all report formats.
+
+get_report_formats
+ = element get_report_formats
+ {
+ # ID of single report format to get.
+ attribute report_format_id { uuid }?
+ & # Whether to get report format in importable form.
+ attribute export { boolean }?
+ & # Whether to include report format parameters.
+ attribute params { boolean }?
+ & attribute sort_order { sort_order }?
+ & attribute sort_field { text }?
+ }
+
## Command get_results
##
## Get results.
@@ -1784,6 +1833,63 @@
text
}
+## Command modify_report_format
+##
+## Update an existing report format.
+
+modify_report_format
+ = element modify_report_format
+ {
+ # ID of report format to modify.
+ attribute report_format_id { uuid }
+ & ( modify_report_format_active
+ | modify_report_format_name
+ | modify_report_format_summary
+ | modify_report_format_param )
+ }
+
+# Whether the report format is active.
+modify_report_format_active
+ = element active
+ {
+ boolean
+ }
+
+# The name of the report format.
+modify_report_format_name
+ = element name
+ {
+ name
+ }
+
+# A summary of the report format.
+modify_report_format_summary
+ = element summary
+ {
+ text
+ }
+
+modify_report_format_param
+ = element param
+ {
+ modify_report_format_param_name
+ & modify_report_format_param_value?
+ }
+
+# The name of the param.
+modify_report_format_param_name
+ = element name
+ {
+ name
+ }
+
+# New value for the param.
+modify_report_format_param_value
+ = element value
+ {
+ base64
+ }
+
## Command modify_task
##
## Modify an existing task.
@@ -1915,6 +2021,26 @@
attribute task_id { uuid }
}
+## Command verify_agent
+##
+## Verify an agent.
+
+verify_agent
+ = element verify_agent
+ {
+ attribute agent_id { uuid }
+ }
+
+## Command verify_report_format
+##
+## Verify a report format.
+
+verify_report_format
+ = element verify_report_format
+ {
+ attribute report_format_id { uuid }
+ }
+
### Responses
## Response to authenticate
@@ -2048,6 +2174,16 @@
& attribute id { uuid }
}
+## Response to create_report_format
+
+create_report_format_response
+ = element create_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ & attribute id { uuid }
+ }
+
## Response to create_schedule
create_schedule_response
@@ -2141,6 +2277,15 @@
& attribute status_text { text }
}
+## Response to delete_report_format
+
+delete_report_format_response
+ = element delete_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
+
## Response to delete_schedule
delete_schedule_response
@@ -3653,6 +3798,168 @@
ctime
}
+## Response to get_report_formats
+
+get_report_formats_response
+ = element get_report_formats_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ & get_report_formats_response_report_format*
+ }
+
+get_report_formats_response_report_format
+ = element report_format
+ {
+ attribute id { uuid }
+ & get_report_formats_response_report_format_name
+ & get_report_formats_response_report_format_summary
+ & get_report_formats_response_report_format_description
+ & get_report_formats_response_report_format_extension
+ & get_report_formats_response_report_format_content_type
+ & get_report_formats_response_report_format_global
+ & get_report_formats_response_report_format_param*
+ & ( get_report_formats_response_report_format_file*
+ | ( get_report_formats_response_report_format_trust
+ & get_report_formats_response_report_format_active ) )
+ }
+
+# The name of the report format.
+get_report_formats_response_report_format_name
+ = element name
+ {
+ name
+ }
+
+get_report_formats_response_report_format_summary
+ = element summary
+ {
+ text
+ }
+
+get_report_formats_response_report_format_description
+ = element description
+ {
+ text
+ }
+
+get_report_formats_response_report_format_extension
+ = element extension
+ {
+ text
+ }
+
+get_report_formats_response_report_format_global
+ = element global
+ {
+ boolean
+ }
+
+get_report_formats_response_report_format_content_type
+ = element content_type
+ {
+ text
+ }
+
+get_report_formats_response_report_format_param
+ = element param
+ {
+ get_report_formats_response_report_format_param_name
+ & get_report_formats_response_report_format_param_type
+ & get_report_formats_response_report_format_param_value
+ & get_report_formats_response_report_format_param_default
+ }
+
+# The name of the param.
+get_report_formats_response_report_format_param_name
+ = element name
+ {
+ name
+ }
+
+# The type of the param.
+get_report_formats_response_report_format_param_type
+ = element type
+ {
+ text # RNC limitation: xsd:token { pattern = "boolean|integer|selection|string|text" }
+ & get_report_formats_response_report_format_param_type_min?
+ & get_report_formats_response_report_format_param_type_max?
+ & get_report_formats_response_report_format_param_type_options?
+ }
+
+# Minimum.
+get_report_formats_response_report_format_param_type_min
+ = element min
+ {
+ text
+ }
+
+# Maximum.
+get_report_formats_response_report_format_param_type_max
+ = element max
+ {
+ text
+ }
+
+# Selection options.
+get_report_formats_response_report_format_param_type_options
+ = element options
+ {
+ get_report_formats_response_report_format_param_type_options_option*
+ }
+
+# Option value.
+get_report_formats_response_report_format_param_type_options_option
+ = element option
+ {
+ text
+ }
+
+# The value of the param.
+get_report_formats_response_report_format_param_value
+ = element value
+ {
+ text
+ }
+
+# The fallback value of the param.
+get_report_formats_response_report_format_param_default
+ = element default
+ {
+ text
+ }
+
+# One of the files used to generate the report.
+get_report_formats_response_report_format_file
+ = element file
+ {
+ text # RNC limitation: base64
+ & attribute name { text }
+ }
+
+# Whether signature verification succeeded.
+get_report_formats_response_report_format_trust
+ = element trust
+ {
+ text # RNC limitation: xsd:token { pattern = "yes|no|unknown" }
+ & attribute name { text }
+ & get_report_formats_response_report_format_trust_time
+ }
+
+# The time the trust was checked.
+get_report_formats_response_report_format_trust_time
+ = element time
+ {
+ ctime
+ }
+
+# Whether the report format is active.
+get_report_formats_response_report_format_active
+ = element active
+ {
+ boolean
+ }
+
## Response to get_results
get_results_response
@@ -4759,6 +5066,15 @@
& attribute status_text { text }
}
+## Response to modify_report_format
+
+modify_report_format_response
+ = element modify_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
+
## Response to modify_task
modify_task_response
@@ -4830,3 +5146,21 @@
attribute status { status }
& attribute status_text { text }
}
+
+## Response to verify_agent
+
+verify_agent_response
+ = element verify_agent_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
+
+## Response to verify_report_format
+
+verify_report_format_response
+ = element verify_report_format_response
+ {
+ attribute status { status }
+ & attribute status_text { text }
+ }
Modified: trunk/openvas-manager/src/schema_formats/XML/OMP.xml
===================================================================
--- trunk/openvas-manager/src/schema_formats/XML/OMP.xml 2010-12-13 18:01:19 UTC (rev 9705)
+++ trunk/openvas-manager/src/schema_formats/XML/OMP.xml 2010-12-13 18:03:30 UTC (rev 9706)
@@ -24,6 +24,29 @@
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
-->
+<!--
+ report_formats
+x new CREATE_REPORT_FORMAT, DELETE_REPORT_FORMAT, GET_REPORTS_FORMATS
+x VERIFY_REPORT_FORMAT, MODIFY_REPORT_FORMAT
+ GET_REPORTS req attrib format_id instead of attrib format
+ Add CVE and BID to RESULT.
+ in GET_RESULTS resp
+ in GET_NOTES,OVERRIDES resp when attrib result is true
+ slaves
+ CREATE_TASK req + SLAVE
+ new CREATE_SLAVE, DELETE_SLAVE, GET_SLAVES
+ GET_TASKS resp + SLAVE
+ MODIFY_TASK req + slave_id attrib
+ GET_SYSTEM_REPORTS req + slave_id attrib
+ agent trust
+ GET_AGENTS resp + TRUST and TRUST/TIME
+x new VERIFY_AGENT
+ lsc credentials
+ new MODIFY_LSC_CREDENTIAL
+ HELP req + format attrib
+ resp + SCHEMA
+-->
+
<protocol>
<name>OpenVAS Management Protocol</name>
<abbreviation>OMP</abbreviation>
@@ -1268,6 +1291,69 @@
</example>
</command>
<command>
+ <name>create_report_format</name>
+ <summary>Create a report format</summary>
+ <description>
+ <p>
+ The client uses the create_report_format command to create a new report
+ format.
+ </p>
+ </description>
+ <pattern>
+ <r>get_report_formats</r>
+ </pattern>
+ <response>
+ <pattern>
+ <attrib>
+ <name>status</name>
+ <type>status</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>status_text</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Create a report format</summary>
+ <request>
+ <create_report_format>
+ <get_report_formats_response>
+ <report_format id="a0704abb-2120-489f-959f-251c9f4ffebd">
+ <name>CPE</name>
+ <extension>csv</extension>
+ <content_type>text/csv</content_type>
+ <summary>Common Product Enumeration CSV table.</summary>
+ <description>
+ CPE stands for Common Product Enumeration. It is a
+ <truncated>...</truncated>
+ </description>
+ <global>1</global>
+ <trust>
+ yes
+ <time>Thu Dec 2 13:22:26 2010</time>
+ </trust>
+ <active>1</active>
+ </report_format>
+ </get_report_formats_response>
+ </create_report_format>
+ </request>
+ <response>
+ <create_report_format_response status="201"
+ status_text="OK, resource created"
+ id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ </create_report_format_response>
+ </response>
+ </example>
+ </command>
+ <command>
<name>create_schedule</name>
<summary>Create a schedule</summary>
<description>
@@ -1948,6 +2034,52 @@
</example>
</command>
<command>
+ <name>delete_report_format</name>
+ <summary>Delete a report format</summary>
+ <description>
+ <p>
+ The client uses the delete_report_format command to delete an existing
+ report format.
+ </p>
+ <p>
+ Since this is a destructive command, the client is advised to ask
+ for confirmation from the user before sending this command to the
+ Manager.
+ </p>
+ </description>
+ <pattern>
+ <attrib>
+ <name>report_format_id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ <response>
+ <pattern>
+ <attrib>
+ <name>status</name>
+ <type>status</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>status_text</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Delete a report format</summary>
+ <request>
+ <delete_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
+ </delete_report_format>
+ </request>
+ <response>
+ <delete_report_format_response status="200" status_text="OK"/>
+ </response>
+ </example>
+ </command>
+ <command>
<name>delete_schedule</name>
<summary>Delete a schedule</summary>
<description>
@@ -4762,6 +4894,267 @@
</example>
</command>
<command>
+ <name>get_report_formats</name>
+ <summary>Get all report formats</summary>
+ <description>
+ <p>
+ The client uses the get_report_formats command to get report format
+ information.
+ </p>
+ </description>
+ <pattern>
+ <attrib>
+ <name>report_format_id</name>
+ <summary>ID of single report format to get</summary>
+ <type>uuid</type>
+ </attrib>
+ <attrib>
+ <name>export</name>
+ <summary>Whether to get report format in importable form</summary>
+ <type>boolean</type>
+ </attrib>
+ <attrib>
+ <name>params</name>
+ <summary>Whether to include report format parameters</summary>
+ <type>boolean</type>
+ </attrib>
+ <attrib>
+ <name>sort_order</name>
+ <type>sort_order</type>
+ </attrib>
+ <attrib>
+ <name>sort_field</name>
+ <type>text</type>
+ </attrib>
+ </pattern>
+ <response>
+ <pattern>
+ <attrib>
+ <name>status</name>
+ <type>status</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>status_text</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ <any><e>report_format</e></any>
+ </pattern>
+ <ele>
+ <name>report_format</name>
+ <pattern>
+ <attrib>
+ <name>id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ <e>name</e>
+ <e>summary</e>
+ <e>description</e>
+ <e>extension</e>
+ <e>content_type</e>
+ <e>global</e>
+ <any><e>param</e></any>
+ <or>
+ <any><e>file</e></any>
+ <g>
+ <e>trust</e>
+ <e>active</e>
+ </g>
+ </or>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>The name of the report format</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>summary</name>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>description</name>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>extension</name>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>global</name>
+ <pattern><t>boolean</t></pattern>
+ </ele>
+ <ele>
+ <name>content_type</name>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>param</name>
+ <pattern>
+ <e>name</e>
+ <e>type</e>
+ <e>value</e>
+ <e>default</e>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>The name of the param</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>type</name>
+ <summary>The type of the param</summary>
+ <pattern>
+ <o><e>min</e></o>
+ <o><e>max</e></o>
+ <o><e>options</e></o>
+ <t>
+ <alts>
+ <alt>boolean</alt>
+ <alt>integer</alt>
+ <alt>selection</alt>
+ <alt>string</alt>
+ <alt>text</alt>
+ </alts>
+ </t>
+ </pattern>
+ <ele>
+ <name>min</name>
+ <summary>Minimum</summary>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>max</name>
+ <summary>Maximum</summary>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>options</name>
+ <summary>Selection options</summary>
+ <pattern><any><e>option</e></any></pattern>
+ <ele>
+ <name>option</name>
+ <summary>Option value</summary>
+ <pattern>text</pattern>
+ </ele>
+ </ele>
+ </ele>
+ <ele>
+ <name>value</name>
+ <summary>The value of the param</summary>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>default</name>
+ <summary>The fallback value of the param</summary>
+ <pattern>text</pattern>
+ </ele>
+ </ele>
+ <ele>
+ <name>file</name>
+ <summary>One of the files used to generate the report</summary>
+ <pattern>
+ <attrib>
+ <name>name</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ <t>base64</t>
+ </pattern>
+ </ele>
+ <ele>
+ <name>trust</name>
+ <summary>Whether signature verification succeeded</summary>
+ <pattern>
+ <attrib>
+ <name>name</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ <e>time</e>
+ <t>
+ <alts>
+ <alt>yes</alt>
+ <alt>no</alt>
+ <alt>unknown</alt>
+ </alts>
+ </t>
+ </pattern>
+ <ele>
+ <name>time</name>
+ <summary>The time the trust was checked</summary>
+ <pattern><t>ctime</t></pattern>
+ </ele>
+ </ele>
+ <ele>
+ <name>active</name>
+ <summary>Whether the report format is active</summary>
+ <pattern><t>boolean</t></pattern>
+ </ele>
+ </ele>
+ </response>
+ <example>
+ <summary>Get information about a report format</summary>
+ <request>
+ <get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
+ </get_report_formats>
+ </request>
+ <response>
+ <get_report_formats_response status="200" status_text="OK">
+ <report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
+ <name>HTML</name>
+ <extension>html</extension>
+ <content_type>text/html</content_type>
+ <summary>Single page HTML report.</summary>
+ <description>
+ A single HTML page listing results of a scan. Style information
+ <truncated>...</truncated>
+ </description>
+ <global>1</global>
+ <trust>
+ no
+ <time>Thu Dec 2 13:22:26 2010</time>
+ </trust>
+ <active>1</active>
+ </report_format>
+ </get_report_formats_response>
+ </response>
+ </example>
+ <example>
+ <summary>Export a report format</summary>
+ <request>
+ <get_report_formats report_format_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"
+ export="1">
+ </get_report_formats>
+ </request>
+ <response>
+ <get_report_formats_response status="200" status_text="OK">
+ <report_format id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
+ <name>HTML</name>
+ <extension>html</extension>
+ <content_type>text/html</content_type>
+ <summary>Single page HTML report.</summary>
+ <description>
+ A single HTML page listing results of a scan. Style information
+ <truncated>...</truncated>
+ </description>
+ <global>1</global>
+ <file name="HTML.xsl">
+ PD9ldD4K
+ <truncated>...</truncated>
+ </file>
+ <file name="generate">
+ IyEvAk
+ <truncated>...</truncated>
+ </file>
+ <signature></signature>
+ </report_format>
+ </get_report_formats_response>
+ </response>
+ </example>
+ </command>
+ <command>
<name>get_results</name>
<summary>Get results</summary>
<description>
@@ -7101,6 +7494,107 @@
</example>
</command>
<command>
+ <name>modify_report_format</name>
+ <summary>Update an existing report format</summary>
+ <description>
+ <p>
+ The client uses the modify_report_format command to change an existing
+ report format.
+ </p>
+ </description>
+ <pattern>
+ <attrib>
+ <name>report_format_id</name>
+ <summary>ID of report format to modify</summary>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ <or>
+ <e>active</e>
+ <e>name</e>
+ <e>summary</e>
+ <e>param</e>
+ </or>
+ </pattern>
+ <ele>
+ <name>active</name>
+ <summary>Whether the report format is active</summary>
+ <pattern><t>boolean</t></pattern>
+ </ele>
+ <ele>
+ <name>name</name>
+ <summary>The name of the report format</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>summary</name>
+ <summary>A summary of the report format</summary>
+ <pattern>text</pattern>
+ </ele>
+ <ele>
+ <name>param</name>
+ <description>
+ If the value element is missing, then the value becomes the empty
+ string.
+ </description>
+ <pattern>
+ <e>name</e>
+ <o><e>value</e></o>
+ </pattern>
+ <ele>
+ <name>name</name>
+ <summary>The name of the param</summary>
+ <pattern><t>name</t></pattern>
+ </ele>
+ <ele>
+ <name>value</name>
+ <summary>New value for the param</summary>
+ <pattern><t>base64</t></pattern>
+ </ele>
+ </ele>
+ <response>
+ <pattern>
+ <attrib>
+ <name>status</name>
+ <type>status</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>status_text</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Modify a report format param</summary>
+ <request>
+ <modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <param>
+ <name>Background Colour</name>
+ <value>cmVk</value>
+ </param>
+ </modify_report_format>
+ </request>
+ <response>
+ <modify_report_format_response status="200" status_text="OK">
+ </modify_report_format_response>
+ </response>
+ </example>
+ <example>
+ <summary>Modify the name of a report format</summary>
+ <request>
+ <modify_report_format report_format_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <name>New name</name>
+ </modify_report_format>
+ </request>
+ <response>
+ <modify_report_format_response status="200" status_text="OK">
+ </modify_report_format_response>
+ </response>
+ </example>
+ </command>
+ <command>
<name>modify_task</name>
<summary>Modify an existing task</summary>
<description>
@@ -7502,4 +7996,98 @@
</response>
</example>
</command>
+ <command>
+ <name>verify_agent</name>
+ <summary>Verify an agent</summary>
+ <description>
+ <p>
+ The client uses the verify_agent command to verify the trust
+ level of an existing agent.
+ </p>
+ <p>
+ The Manager checks whether the signature of the agent currently
+ matches the agent. This includes the agent installer file.
+ The Manager searches for the signature first in the feed, then
+ in the agent itself.
+ </p>
+ </description>
+ <pattern>
+ <attrib>
+ <name>agent_id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ <response>
+ <pattern>
+ <attrib>
+ <name>status</name>
+ <type>status</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>status_text</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Verify an agent</summary>
+ <request>
+ <verify_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
+ </verify_agent>
+ </request>
+ <response>
+ <verify_agent_response status="200" status_text="OK"/>
+ </response>
+ </example>
+ </command>
+ <command>
+ <name>verify_report_format</name>
+ <summary>Verify a report format</summary>
+ <description>
+ <p>
+ The client uses the verify_report_format command to verify the trust
+ level of an existing report format.
+ </p>
+ <p>
+ The Manager checks whether the signature of the report format currently
+ matches the report format. This includes the script and files used
+ to generate reports of this format. The Manager searches for the
+ signature first in the feed, then in the report format itself.
+ </p>
+ </description>
+ <pattern>
+ <attrib>
+ <name>report_format_id</name>
+ <type>uuid</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ <response>
+ <pattern>
+ <attrib>
+ <name>status</name>
+ <type>status</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>status_text</name>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ </pattern>
+ </response>
+ <example>
+ <summary>Verify a report format</summary>
+ <request>
+ <verify_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
+ </verify_report_format>
+ </request>
+ <response>
+ <verify_report_format_response status="200" status_text="OK"/>
+ </response>
+ </example>
+ </command>
</protocol>
More information about the Openvas-commits
mailing list