[Openvas-commits] r11667 - in trunk/openvas-manager: . doc src/schema_formats/XML
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Thu Sep 22 17:56:45 CEST 2011
Author: hdoreau
Date: 2011-09-22 17:56:42 +0200 (Thu, 22 Sep 2011)
New Revision: 11667
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 (get_info): Relocated get_info
documentation to honor alphabetical sorting. Rewrapped lines.
* doc/omp.rnc, doc/omp.html: Update from source.
Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog 2011-09-22 15:19:26 UTC (rev 11666)
+++ trunk/openvas-manager/ChangeLog 2011-09-22 15:56:42 UTC (rev 11667)
@@ -1,5 +1,12 @@
2011-09-22 Henri Doreau <henri.doreau at greenbone.net>
+ * src/schema_formats/XML/OMP.xml (get_info): Relocated get_info
+ documentation to honor alphabetical sorting. Rewrapped lines.
+
+ * doc/omp.rnc, doc/omp.html: Update from source.
+
+2011-09-22 Henri Doreau <henri.doreau at greenbone.net>
+
* src/schema_formats/XML/OMP.xml (get_info): Document new operation.
* doc/omp.rnc, doc/omp.html: Update from source.
Modified: trunk/openvas-manager/doc/omp.html
===================================================================
--- trunk/openvas-manager/doc/omp.html 2011-09-22 15:19:26 UTC (rev 11666)
+++ trunk/openvas-manager/doc/omp.html 2011-09-22 15:56:42 UTC (rev 11667)
@@ -264,6 +264,10 @@
<td id="index"><div style="margin-left: 15px;">Get all escalators.</div></td>
</tr>
<tr id="index">
+<td id="index"><a href="#command_get_info">get_info</a></td>
+<td id="index"><div style="margin-left: 15px;">Get raw information for a given item.</div></td>
+</tr>
+<tr id="index">
<td id="index"><a href="#command_get_lsc_credentials">get_lsc_credentials</a></td>
<td id="index"><div style="margin-left: 15px;">Get all LSC credentials.</div></td>
</tr>
@@ -332,10 +336,6 @@
<td id="index"><div style="margin-left: 15px;">Get the OpenVAS Manager Protocol version.</div></td>
</tr>
<tr id="index">
-<td id="index"><a href="#command_get_info">get_info</a></td>
-<td id="index"><div style="margin-left: 15px;">Get raw information for a given item.</div></td>
-</tr>
-<tr id="index">
<td id="index"><a href="#command_help">help</a></td>
<td id="index"><div style="margin-left: 15px;">Get the help text.</div></td>
</tr>
@@ -445,6 +445,7 @@
| get_configs
| get_dependencies
| get_escalators
+ | get_info
| get_lsc_credentials
| get_notes
| get_nvts
@@ -462,7 +463,6 @@
| get_targets
| get_tasks
| get_version
- | get_info
| help
| modify_config
| modify_lsc_credential
@@ -514,6 +514,7 @@
| get_configs_response
| get_dependencies_response
| get_escalators_response
+ | get_info_response
| get_lsc_credentials_response
| get_notes_response
| get_nvts_response
@@ -531,7 +532,6 @@
| get_targets_response
| get_tasks_response
| get_version_response
- | get_info_response
| help_response
| modify_config_response
| modify_lsc_credential_response
@@ -2417,6 +2417,11 @@
</div>
</li>
<li>
+ <<b>get_info></b><div style="margin-left: 15px; display: inline;">
+<a href="#command_get_info">get_info</a> command.
+ </div>
+</li>
+<li>
<<b>get_lsc_credentials></b><div style="margin-left: 15px; display: inline;">
<a href="#command_get_lsc_credentials">get_lsc_credentials</a> command.
</div>
@@ -2497,11 +2502,6 @@
</div>
</li>
<li>
- <<b>get_info></b><div style="margin-left: 15px; display: inline;">
-<a href="#command_get_info">get_info</a> command.
- </div>
-</li>
-<li>
<<b>help></b><div style="margin-left: 15px; display: inline;">
<a href="#command_help">help</a> command.
</div>
@@ -2732,6 +2732,11 @@
</div>
</li>
<li>
+ <<b>get_info_response></b><div style="margin-left: 15px; display: inline;">
+ Response to <a href="#command_get_info">get_info</a> command.
+ </div>
+</li>
+<li>
<<b>get_lsc_credentials_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_get_lsc_credentials">get_lsc_credentials</a> command.
</div>
@@ -2812,11 +2817,6 @@
</div>
</li>
<li>
- <<b>get_info_response></b><div style="margin-left: 15px; display: inline;">
- Response to <a href="#command_get_info">get_info</a> command.
- </div>
-</li>
-<li>
<<b>help_response></b><div style="margin-left: 15px; display: inline;">
Response to <a href="#command_help">help</a> command.
</div>
@@ -2929,6 +2929,7 @@
| get_configs
| get_dependencies
| get_escalators
+ | get_info
| get_lsc_credentials
| get_notes
| get_nvts
@@ -2945,7 +2946,6 @@
| get_targets
| get_tasks
| get_version
- | get_info
| help
| modify_config
| modify_lsc_credential
@@ -2996,6 +2996,7 @@
| get_configs_response
| get_dependencies_response
| get_escalators_response
+ | get_info_response
| get_lsc_credentials_response
| get_notes_response
| get_nvts_response
@@ -3012,7 +3013,6 @@
| get_targets_response
| get_tasks_response
| get_version_response
- | get_info_response
| help_response
| modify_config_response
| modify_lsc_credential_response
@@ -6982,7 +6982,76 @@
</div>
</div>
<div>
-<div><h3 id="command_get_lsc_credentials">7.32
+<div><h3 id="command_get_info">7.32
+ Command <tt>get_info</tt>
+</h3></div>
+<p>In short: Get raw information for a given item.</p>
+<h4>7.32.1 Structure</h4>
+<ul style="list-style: none">
+<li>
+<i>Command</i><ul style="list-style: none">
+<li>
+ @<b>type</b>
+ (text)
+ Type of the requested information.
+ </li>
+<li>
+ @<b>name</b>
+ (text)
+ Name or identifier of the requested information.
+ </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.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_info
+ = element get_info
+ {
+ attribute type { text }
+ & attribute name { text }
+ }
+</pre></div>
+<i>Response</i><div style="margin-left: 5%"><pre>get_info_response
+ = element get_info_response
+ {
+ text
+ & attribute status { status }
+ & attribute status_text { text }
+ }
+</pre></div>
+</div>
+<h4>7.32.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_info type="CPE"
+ name="cpe:/o:linux:kernel:2.6.0"/>
+</pre></div>
+<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_info_response status="200"
+ status_text="OK">
+ <cpe-item name="cpe:/o:linux:kernel:2.6.0">
+ <title xml:lang="en-US">Linux Kernel 2.6.0</title>
+ <meta:item-metadata modification-date="2008-11-18T17:32:39.543"
+ status="DRAFT"
+ nvd-id="91585"/>
+ </cpe-item>
+ </get_info_response>
+</pre></div>
+</div>
+</div>
+<div>
+<div><h3 id="command_get_lsc_credentials">7.33
Command <tt>get_lsc_credentials</tt>
</h3></div>
<p>In short: Get all LSC credentials.</p>
@@ -6991,7 +7060,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.32.1 Structure</h4>
+<h4>7.33.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -7100,7 +7169,7 @@
</ul>
</li>
</ul>
-<h4>7.32.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_lsc_credentials
= element get_lsc_credentials
@@ -7198,7 +7267,7 @@
}
</pre></div>
</div>
-<h4>7.32.3 Example: Get all the LSC credentials</h4>
+<h4>7.33.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>
@@ -7228,7 +7297,7 @@
</get_lsc_credentials_response>
</pre></div>
</div>
-<h4>7.32.3 Example: Get the public key of a single LSC credential</h4>
+<h4>7.33.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"/>
@@ -7253,7 +7322,7 @@
</get_lsc_credentials_response>
</pre></div>
</div>
-<h4>7.32.3 Example: Get the Debian package of a single LSC credential</h4>
+<h4>7.33.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"/>
@@ -7278,7 +7347,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_notes">7.33
+<div><h3 id="command_get_notes">7.34
Command <tt>get_notes</tt>
</h3></div>
<p>In short: Get all notes.</p>
@@ -7287,7 +7356,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.33.1 Structure</h4>
+<h4>7.34.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -7462,7 +7531,7 @@
</ul>
</li>
</ul>
-<h4>7.33.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_notes
= element get_notes
@@ -7645,7 +7714,7 @@
}
</pre></div>
</div>
-<h4>7.33.3 Example: Get all notes</h4>
+<h4>7.34.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>
@@ -7662,7 +7731,7 @@
</get_notes_response>
</pre></div>
</div>
-<h4>7.33.3 Example: Get details of a single note</h4>
+<h4>7.34.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"
@@ -7705,7 +7774,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_nvts">7.34
+<div><h3 id="command_get_nvts">7.35
Command <tt>get_nvts</tt>
</h3></div>
<p>In short: Get all NVTs.</p>
@@ -7736,7 +7805,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.34.1 Structure</h4>
+<h4>7.35.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -7918,7 +7987,7 @@
</ul>
</li>
</ul>
-<h4>7.34.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_nvts
= element get_nvts
@@ -8124,7 +8193,7 @@
}
</pre></div>
</div>
-<h4>7.34.3 Example: Get full NVT listing</h4>
+<h4>7.35.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"
@@ -8182,7 +8251,7 @@
</get_nvts_response>
</pre></div>
</div>
-<h4>7.34.3 Example: Get minimal information about one NVT</h4>
+<h4>7.35.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>
@@ -8200,7 +8269,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_nvt_families">7.35
+<div><h3 id="command_get_nvt_families">7.36
Command <tt>get_nvt_families</tt>
</h3></div>
<p>In short: Get a list of all NVT families.</p>
@@ -8209,7 +8278,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.35.1 Structure</h4>
+<h4>7.36.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -8248,7 +8317,7 @@
</ul>
</li>
</ul>
-<h4>7.35.2 RNC</h4>
+<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_nvt_families
= element get_nvt_families
@@ -8290,7 +8359,7 @@
}
</pre></div>
</div>
-<h4>7.35.3 Example: Get the NVT families</h4>
+<h4>7.36.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>
@@ -8312,7 +8381,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_nvt_feed_checksum">7.36
+<div><h3 id="command_get_nvt_feed_checksum">7.37
Command <tt>get_nvt_feed_checksum</tt>
</h3></div>
<p>In short: Get checksum for entire NVT collection.</p>
@@ -8336,7 +8405,7 @@
files. If the manager cannot access a list of available NVTs at
present, it will reply with the 503 response.
</p>
-<h4>7.36.1 Structure</h4>
+<h4>7.37.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><li>
@@ -8364,7 +8433,7 @@
</ul>
</li>
</ul>
-<h4>7.36.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_nvt_feed_checksum
= element get_nvt_feed_checksum
@@ -8388,7 +8457,7 @@
}
</pre></div>
</div>
-<h4>7.36.3 Example: Get the NVT feed checksum</h4>
+<h4>7.37.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>
@@ -8400,7 +8469,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_overrides">7.37
+<div><h3 id="command_get_overrides">7.38
Command <tt>get_overrides</tt>
</h3></div>
<p>In short: Get all overrides.</p>
@@ -8409,7 +8478,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.37.1 Structure</h4>
+<h4>7.38.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -8589,7 +8658,7 @@
</ul>
</li>
</ul>
-<h4>7.37.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_overrides
= element get_overrides
@@ -8779,7 +8848,7 @@
}
</pre></div>
</div>
-<h4>7.37.3 Example: Get all overrides</h4>
+<h4>7.38.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>
@@ -8798,7 +8867,7 @@
</get_overrides_response>
</pre></div>
</div>
-<h4>7.37.3 Example: Get details of a single override</h4>
+<h4>7.38.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"/>
@@ -8828,7 +8897,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_preferences">7.38
+<div><h3 id="command_get_preferences">7.39
Command <tt>get_preferences</tt>
</h3></div>
<p>In short: Get all preferences.</p>
@@ -8844,7 +8913,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.38.1 Structure</h4>
+<h4>7.39.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -8912,7 +8981,7 @@
</ul>
</li>
</ul>
-<h4>7.38.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_preferences
= element get_preferences
@@ -8971,7 +9040,7 @@
}
</pre></div>
</div>
-<h4>7.38.3 Example: Get default preferences for all NVTs</h4>
+<h4>7.39.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>
@@ -8985,7 +9054,7 @@
</get_preferences_response>
</pre></div>
</div>
-<h4>7.38.3 Example: Get default preferences for a single NVT</h4>
+<h4>7.39.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>
@@ -8999,7 +9068,7 @@
</get_preferences_response>
</pre></div>
</div>
-<h4>7.38.3 Example: Get preferences from a config for all NVTs</h4>
+<h4>7.39.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>
@@ -9017,7 +9086,7 @@
</get_preferences_response>
</pre></div>
</div>
-<h4>7.38.3 Example: Get preferences from a config for a single NVT</h4>
+<h4>7.39.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"/>
@@ -9036,7 +9105,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_reports">7.39
+<div><h3 id="command_get_reports">7.40
Command <tt>get_reports</tt>
</h3></div>
<p>In short: Get all reports.</p>
@@ -9047,7 +9116,7 @@
The XML report format is sent as XML. All other formats are sent in
Base64 encoding.
</p>
-<h4>7.39.1 Structure</h4>
+<h4>7.40.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -9160,7 +9229,7 @@
</ul>
</li>
</ul>
-<h4>7.39.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_reports
= element get_reports
@@ -9206,7 +9275,7 @@
}
</pre></div>
</div>
-<h4>7.39.3 Example: Get a report in PDF</h4>
+<h4>7.40.3 Example: Get a report in PDF</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
format_id="1a60a67e-97d0-4cbf-bc77-f71b08e7043d"/>
@@ -9220,7 +9289,7 @@
</get_reports_response>
</pre></div>
</div>
-<h4>7.39.3 Example: Get a report in XML</h4>
+<h4>7.40.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>
@@ -9321,7 +9390,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_report_formats">7.40
+<div><h3 id="command_get_report_formats">7.41
Command <tt>get_report_formats</tt>
</h3></div>
<p>In short: Get all report formats.</p>
@@ -9329,7 +9398,7 @@
The client uses the get_report_formats command to get report format
information.
</p>
-<h4>7.40.1 Structure</h4>
+<h4>7.41.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -9504,7 +9573,7 @@
</ul>
</li>
</ul>
-<h4>7.40.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_report_formats
= element get_report_formats
@@ -9679,7 +9748,7 @@
}
</pre></div>
</div>
-<h4>7.40.3 Example: Get information about a report format</h4>
+<h4>7.41.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>
@@ -9705,7 +9774,7 @@
</get_report_formats_response>
</pre></div>
</div>
-<h4>7.40.3 Example: Export a report format</h4>
+<h4>7.41.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"/>
@@ -9738,7 +9807,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_results">7.41
+<div><h3 id="command_get_results">7.42
Command <tt>get_results</tt>
</h3></div>
<p>In short: Get results.</p>
@@ -9750,7 +9819,7 @@
apply_overrides flag and any of these is true, then the request
must also include a task ID.
</p>
-<h4>7.41.1 Structure</h4>
+<h4>7.42.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -9952,7 +10021,7 @@
</ul>
</li>
</ul>
-<h4>7.41.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_results
= element get_results
@@ -10160,7 +10229,7 @@
}
</pre></div>
</div>
-<h4>7.41.3 Example: Get all results</h4>
+<h4>7.42.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>
@@ -10186,7 +10255,7 @@
</get_results_response>
</pre></div>
</div>
-<h4>7.41.3 Example: Get a result, including notes and overrides</h4>
+<h4>7.42.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"
@@ -10228,14 +10297,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_schedules">7.42
+<div><h3 id="command_get_schedules">7.43
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.42.1 Structure</h4>
+<h4>7.43.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -10347,7 +10416,7 @@
</ul>
</li>
</ul>
-<h4>7.42.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_schedules
= element get_schedules
@@ -10450,7 +10519,7 @@
}
</pre></div>
</div>
-<h4>7.42.3 Example: Get all schedules</h4>
+<h4>7.43.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>
@@ -10463,7 +10532,7 @@
</get_schedules_response>
</pre></div>
</div>
-<h4>7.42.3 Example: Get full details of a single schedule</h4>
+<h4>7.43.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"/>
@@ -10490,14 +10559,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_slaves">7.43
+<div><h3 id="command_get_slaves">7.44
Command <tt>get_slaves</tt>
</h3></div>
<p>In short: Get all slaves.</p>
<p>
The client uses the get_slaves command to get slave information.
</p>
-<h4>7.43.1 Structure</h4>
+<h4>7.44.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -10600,7 +10669,7 @@
</ul>
</li>
</ul>
-<h4>7.43.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>get_slaves
= element get_slaves
@@ -10696,7 +10765,7 @@
}
</pre></div>
</div>
-<h4>7.43.3 Example: Get all slaves, including task lists</h4>
+<h4>7.44.3 Example: Get all slaves, including task lists</h4>
<div style="margin-left: 5%; margin-right: 5%;">
<i>Client</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_slaves tasks="1"/>
</pre></div>
@@ -10721,14 +10790,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_system_reports">7.44
+<div><h3 id="command_get_system_reports">7.45
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.44.1 Structure</h4>
+<h4>7.45.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -10795,7 +10864,7 @@
</ul>
</li>
</ul>
-<h4>7.44.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>get_system_reports
= element get_system_reports
@@ -10843,7 +10912,7 @@
}
</pre></div>
</div>
-<h4>7.44.3 Example: Get listing of available system reports</h4>
+<h4>7.45.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>
@@ -10865,7 +10934,7 @@
</get_system_reports_response>
</pre></div>
</div>
-<h4>7.44.3 Example: Get a system report</h4>
+<h4>7.45.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>
@@ -10884,14 +10953,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_target_locators">7.45
+<div><h3 id="command_get_target_locators">7.46
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.45.1 Structure</h4>
+<h4>7.46.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
@@ -10917,7 +10986,7 @@
</ul>
</li>
</ul>
-<h4>7.45.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>get_target_locators
= element get_target_locators
@@ -10946,7 +11015,7 @@
}
</pre></div>
</div>
-<h4>7.45.3 Example: Get target locators</h4>
+<h4>7.46.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>
@@ -10961,14 +11030,14 @@
</div>
</div>
<div>
-<div><h3 id="command_get_targets">7.46
+<div><h3 id="command_get_targets">7.47
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.46.1 Structure</h4>
+<h4>7.47.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -11111,7 +11180,7 @@
</ul>
</li>
</ul>
-<h4>7.46.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>get_targets
= element get_targets
@@ -11249,7 +11318,7 @@
}
</pre></div>
</div>
-<h4>7.46.3 Example: Get all targets</h4>
+<h4>7.47.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>
@@ -11272,7 +11341,7 @@
</get_targets_response>
</pre></div>
</div>
-<h4>7.46.3 Example: Get a single target, including tasks using the target</h4>
+<h4>7.47.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"/>
@@ -11303,7 +11372,7 @@
</div>
</div>
<div>
-<div><h3 id="command_get_tasks">7.47
+<div><h3 id="command_get_tasks">7.48
Command <tt>get_tasks</tt>
</h3></div>
<p>In short: Get all tasks.</p>
@@ -11315,7 +11384,7 @@
the values of the sort order, sort field and apply overrides flag
that the manager applied when selecting the tasks.
</p>
-<h4>7.47.1 Structure</h4>
+<h4>7.48.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none">
@@ -11739,7 +11808,7 @@
</ul>
</li>
</ul>
-<h4>7.47.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>get_tasks
= element get_tasks
@@ -12268,7 +12337,7 @@
}
</pre></div>
</div>
-<h4>7.47.3 Example: Get all tasks</h4>
+<h4>7.48.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>
@@ -12352,7 +12421,7 @@
</get_tasks_response>
</pre></div>
</div>
-<h4>7.47.3 Example: Get a single task, including all reports</h4>
+<h4>7.48.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"/>
@@ -12459,11 +12528,11 @@
</div>
</div>
<div>
-<div><h3 id="command_get_version">7.48
+<div><h3 id="command_get_version">7.49
Command <tt>get_version</tt>
</h3></div>
<p>In short: Get the OpenVAS Manager Protocol version.</p>
-<h4>7.48.1 Structure</h4>
+<h4>7.49.1 Structure</h4>
<ul style="list-style: none">
<li>
<i>Command</i><ul style="list-style: none"><i>Empty single element.</i></ul>
@@ -12485,7 +12554,7 @@
</ul>
</li>
</ul>
-<h4>7.48.2 RNC</h4>
+<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>get_version
= element get_version
@@ -12508,7 +12577,7 @@
}
</pre></div>
</div>
-<h4>7.48.3 Example: Get the version</h4>
+<h4>7.49.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>
@@ -12520,75 +12589,6 @@
</div>
</div>
<div>
-<div><h3 id="command_get_info">7.49
- Command <tt>get_info</tt>
-</h3></div>
-<p>In short: Get raw information for a given item.</p>
-<h4>7.49.1 Structure</h4>
-<ul style="list-style: none">
-<li>
-<i>Command</i><ul style="list-style: none">
-<li>
- @<b>type</b>
- (text)
- Type of the requested information.
- </li>
-<li>
- @<b>name</b>
- (text)
- Name or identifier of the requested information.
- </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>get_info
- = element get_info
- {
- attribute type { text }
- & attribute name { text }
- }
-</pre></div>
-<i>Response</i><div style="margin-left: 5%"><pre>get_info_response
- = element get_info_response
- {
- text
- & attribute status { status }
- & attribute status_text { text }
- }
-</pre></div>
-</div>
-<h4>7.49.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_info type="CPE"
- name="cpe:/o:linux:kernel:2.6.0"/>
-</pre></div>
-<i>Manager</i><div style="margin-left: 2%; margin-right: 2%;"><pre> <get_info_response status="200"
- status_text="OK">
- <cpe-item name="cpe:/o:linux:kernel:2.6.0">
- <title xml:lang="en-US">Linux Kernel 2.6.0</title>
- <meta:item-metadata modification-date="2008-11-18T17:32:39.543"
- status="DRAFT"
- nvd-id="91585"/>
- </cpe-item>
- </get_info_response>
-</pre></div>
-</div>
-</div>
-<div>
<div><h3 id="command_help">7.50
Command <tt>help</tt>
</h3></div>
Modified: trunk/openvas-manager/doc/omp.rnc
===================================================================
--- trunk/openvas-manager/doc/omp.rnc 2011-09-22 15:19:26 UTC (rev 11666)
+++ trunk/openvas-manager/doc/omp.rnc 2011-09-22 15:56:42 UTC (rev 11667)
@@ -40,6 +40,7 @@
| get_configs
| get_dependencies
| get_escalators
+ | get_info
| get_lsc_credentials
| get_notes
| get_nvts
@@ -57,7 +58,6 @@
| get_targets
| get_tasks
| get_version
- | get_info
| help
| modify_config
| modify_lsc_credential
@@ -109,6 +109,7 @@
| get_configs_response
| get_dependencies_response
| get_escalators_response
+ | get_info_response
| get_lsc_credentials_response
| get_notes_response
| get_nvts_response
@@ -126,7 +127,6 @@
| get_targets_response
| get_tasks_response
| get_version_response
- | get_info_response
| help_response
| modify_config_response
| modify_lsc_credential_response
@@ -1069,6 +1069,7 @@
| get_configs
| get_dependencies
| get_escalators
+ | get_info
| get_lsc_credentials
| get_notes
| get_nvts
@@ -1085,7 +1086,6 @@
| get_targets
| get_tasks
| get_version
- | get_info
| help
| modify_config
| modify_lsc_credential
@@ -2117,6 +2117,19 @@
& attribute sort_field { text }?
}
+## Command get_info
+##
+## Get raw information for a given item.
+
+get_info
+ = element get_info
+ {
+ # Type of the requested information.
+ attribute type { text }
+ & # Name or identifier of the requested information.
+ attribute name { text }
+ }
+
## Command get_lsc_credentials
##
## Get all LSC credentials.
@@ -2428,19 +2441,6 @@
""
}
-## Command get_info
-##
-## Get raw information for a given item.
-
-get_info
- = element get_info
- {
- # Type of the requested information.
- attribute type { text }
- & # Name or identifier of the requested information.
- attribute name { text }
- }
-
## Command help
##
## Get the help text.
@@ -3052,6 +3052,7 @@
| get_configs_response
| get_dependencies_response
| get_escalators_response
+ | get_info_response
| get_lsc_credentials_response
| get_notes_response
| get_nvts_response
@@ -3068,7 +3069,6 @@
| get_targets_response
| get_tasks_response
| get_version_response
- | get_info_response
| help_response
| modify_config_response
| modify_lsc_credential_response
@@ -3772,6 +3772,16 @@
text
}
+## Response to get_info
+
+get_info_response
+ = element get_info_response
+ {
+ text
+ & attribute status { status }
+ & attribute status_text { text }
+ }
+
## Response to get_lsc_credentials
get_lsc_credentials_response
@@ -5898,16 +5908,6 @@
text
}
-## Response to get_info
-
-get_info_response
- = element get_info_response
- {
- text
- & attribute status { status }
- & attribute status_text { text }
- }
-
## Response to help
help_response
Modified: trunk/openvas-manager/src/schema_formats/XML/OMP.xml
===================================================================
--- trunk/openvas-manager/src/schema_formats/XML/OMP.xml 2011-09-22 15:19:26 UTC (rev 11666)
+++ trunk/openvas-manager/src/schema_formats/XML/OMP.xml 2011-09-22 15:56:42 UTC (rev 11667)
@@ -1102,6 +1102,7 @@
<c>get_configs</c>
<c>get_dependencies</c>
<c>get_escalators</c>
+ <c>get_info</c>
<c>get_lsc_credentials</c>
<c>get_notes</c>
<c>get_nvts</c>
@@ -1118,7 +1119,6 @@
<c>get_targets</c>
<c>get_tasks</c>
<c>get_version</c>
- <c>get_info</c>
<c>help</c>
<c>modify_config</c>
<c>modify_lsc_credential</c>
@@ -1179,6 +1179,7 @@
<r>get_configs</r>
<r>get_dependencies</r>
<r>get_escalators</r>
+ <r>get_info</r>
<r>get_lsc_credentials</r>
<r>get_notes</r>
<r>get_nvts</r>
@@ -1195,7 +1196,6 @@
<r>get_targets</r>
<r>get_tasks</r>
<r>get_version</r>
- <r>get_info</r>
<r>help</r>
<r>modify_config</r>
<r>modify_lsc_credential</r>
@@ -4069,6 +4069,60 @@
</example>
</command>
<command>
+ <name>get_info</name>
+ <summary>Get raw information for a given item</summary>
+ <pattern>
+ <attrib>
+ <name>type</name>
+ <summary>Type of the requested information</summary>
+ <type>text</type>
+ <required>1</required>
+ </attrib>
+ <attrib>
+ <name>name</name>
+ <summary>Name or identifier of the requested information</summary>
+ <type>text</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>
+ text
+ </pattern>
+ </response>
+ <example>
+ <summary>Get the version</summary>
+ <request>
+ <get_info type="CPE" name="cpe:/o:linux:kernel:2.6.0"/>
+ </request>
+ <response>
+ <get_info_response status="200" status_text="OK">
+ <cpe-item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:meta="http://scap.nist.gov/schema/cpe-dictionary-metadata/0.2"
+ xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.3"
+ xmlns:ns6="http://scap.nist.gov/schema/scap-core/0.1"
+ xmlns:config="http://scap.nist.gov/schema/configuration/0.1"
+ xmlns="http://cpe.mitre.org/dictionary/2.0"
+ name="cpe:/o:linux:kernel:2.6.0">
+ <title xml:lang="en-US">Linux Kernel 2.6.0</title>
+ <meta:item-metadata modification-date="2008-11-18T17:32:39.543"
+ status="DRAFT" nvd-id="91585"></meta:item-metadata>
+ </cpe-item>
+ </get_info_response>
+ </response>
+ </example>
+ </command>
+ <command>
<name>get_lsc_credentials</name>
<summary>Get all LSC credentials</summary>
<description>
@@ -7870,53 +7924,6 @@
</example>
</command>
<command>
- <name>get_info</name>
- <summary>Get raw information for a given item</summary>
- <pattern>
- <attrib>
- <name>type</name>
- <summary>Type of the requested information</summary>
- <type>text</type>
- <required>1</required>
- </attrib>
- <attrib>
- <name>name</name>
- <summary>Name or identifier of the requested information</summary>
- <type>text</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>
- text
- </pattern>
- </response>
- <example>
- <summary>Get the version</summary>
- <request>
- <get_info type="CPE" name="cpe:/o:linux:kernel:2.6.0"/>
- </request>
- <response>
- <get_info_response status="200" status_text="OK">
- <cpe-item xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:meta="http://scap.nist.gov/schema/cpe-dictionary-metadata/0.2" xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.3" xmlns:ns6="http://scap.nist.gov/schema/scap-core/0.1" xmlns:config="http://scap.nist.gov/schema/configuration/0.1" xmlns="http://cpe.mitre.org/dictionary/2.0" name="cpe:/o:linux:kernel:2.6.0">
- <title xml:lang="en-US">Linux Kernel 2.6.0</title>
- <meta:item-metadata modification-date="2008-11-18T17:32:39.543" status="DRAFT" nvd-id="91585"></meta:item-metadata>
- </cpe-item>
- </get_info_response>
- </response>
- </example>
- </command>
- <command>
<name>help</name>
<summary>Get the help text</summary>
<pattern>
More information about the Openvas-commits
mailing list