[Openvas-commits] r8204 - trunk/doc/website
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Sun Jun 27 17:37:12 CEST 2010
Author: mattm
Date: 2010-06-27 17:37:12 +0200 (Sun, 27 Jun 2010)
New Revision: 8204
Modified:
trunk/doc/website/openvas-cr-28.htm4
Log:
Add missing get commands.
Modified: trunk/doc/website/openvas-cr-28.htm4
===================================================================
--- trunk/doc/website/openvas-cr-28.htm4 2010-06-27 15:30:24 UTC (rev 8203)
+++ trunk/doc/website/openvas-cr-28.htm4 2010-06-27 15:37:12 UTC (rev 8204)
@@ -1963,6 +1963,76 @@
<delete_task_response status="500" status_text="Internal error" />
</pre>
+<h4 id="get_agents">get_agents</h4>
+
+<p>
+The client uses the get_agents command to get agent information. This command may
+include the ID of an existing agent, a format, a sort order and a sort field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of agents to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"agent_id" is the ID of an agent.
+ <li>"format" is either "installer", "howto_install" or "howto_use".
+ <li>"sort_order" is "descending" for descending, anything else for ascending.
+ <li>"sort_field" is the field to sort on.
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_agents />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_agents_response status="200" status_text="OK">
+ <agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
+ <name>Custom Scan Agent</name>
+ <comment>Custom agent for use on the Web servers.</comment>
+ <in_use>1</in_use>
+ </agent>
+ ...
+</get_agents_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_agents_response status="200" status_text="OK">
+ <agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
+ <name>Custom Scan Agent</name>
+ <comment>Custom agent for use on the Web servers.</comment>
+ <in_use>1</in_use>
+ <package format="installer">CgoKCgoKCgoKCgoKCSAgI...</package>
+ </agent>
+</get_agents_response>
+</pre>
+
<h4 id="get_certificates">get_certificates</h4>
<p>
@@ -2000,7 +2070,126 @@
</get_certificates_response>
</pre>
+<h4 id="get_configs">get_configs</h4>
+<p>
+The client uses the get_configs command to get config information. This command may
+include the ID of an existing config, a families flag, an export flag, a preferences
+flag, a sort order and a sort field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of configs to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"config_id" is the ID of a config.
+ <li>"families" is boolean (0 is false, anything else is true).
+ <li>"preferences" is boolean (0 is false, anything else is true).
+ <li>"sort_order" is "descending" for descending, anything else for ascending.
+ <li>"sort_field" is the field to sort on.
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_configs />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_configs_response status="200" status_text="OK">
+ <config id="daba56c8-73ec-11df-a475-002264764cea">
+ <name>Full and fast</name>
+ <comment>All NVT's; optimized by using previously collected information.</comment>
+ <family_count>
+ 4
+ <growing>1</growing>
+ </family_count>
+ <nvt_count>
+ 12
+ <growing>1</growing>
+ </nvt_count>
+ <in_use>1</in_use>
+ <tasks>
+ <task id="13bb418a-4220-4575-b35b-ec398bff7417">
+ <name>Web Servers</name>
+ </task>
+ ...
+ </tasks>
+ </config>
+ ...
+</get_configs_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_configs config_id="daba56c8-73ec-11df-a475-002264764cea" preferences="1" families="1" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_configs_response status="200" status_text="OK">
+ <config id="daba56c8-73ec-11df-a475-002264764cea">
+ <name>Full and fast</name>
+ <comment>All NVT's; optimized by using previously collected information.</comment>
+ <family_count>
+ 4
+ <growing>1</growing>
+ </family_count>
+ <nvt_count>
+ 12
+ <growing>1</growing>
+ </nvt_count>
+ <in_use>1</in_use>
+ <tasks>
+ <task id="13bb418a-4220-4575-b35b-ec398bff7417">
+ <name>Web Servers</name>
+ </task>
+ ...
+ </tasks>
+ <families>
+ <family>
+ <name>Credentials</name>
+ <nvt_count>8</nvt_count>
+ <max_nvt_count>8</max_nvt_count>
+ <growing>1</growing>
+ </family>
+ ...
+ </families>
+ <preferences>
+ <preference>
+ <nvt oid="1.3.6.1.4.1.25623.1.0.10330">
+ <name>Services</name>
+ </nvt>
+ <name>Network connection timeout :</name>
+ <type>entry</type>
+ <value>5</value>
+ </preference>
+ ...
+ </preferences>
+ </config>
+ ...
+</get_configs_response>
+</pre>
+
<h4 id="get_dependencies">get_dependencies</h4>
<p>
@@ -2017,7 +2206,7 @@
</p>
<p>
-Command elements:
+Command attributes:
<ul>
<li>"oid" is the OID of an NVT.
</ul>
@@ -2076,7 +2265,314 @@
</get_dependencies_response>
</pre>
+<h4 id="get_escalators">get_escalators</h4>
+<p>
+The client uses the get_escalators command to get escalator information. This
+command may include the ID of an existing escalator, a sort order and a sort
+field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of escalators to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"escalator_id" is the ID of an escalator.
+ <li>"sort_order" is "descending" for descending, anything else for ascending.
+ <li>"sort_field" is the field to sort on.
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_escalators />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_escalators_response status="200" status_text="OK">
+ <escalator id="6181e65d-8ba0-4937-9c44-8f2b10b0def7">
+ <name>Team alert</name>
+ <comment></comment>
+ <in_use>1</in_use>
+ <condition>
+ Threat level at least
+ <data>
+ <name>level</name>
+ High
+ </data>
+ </condition>
+ <event>
+ Task run status changed
+ <data>
+ <name>status</name>
+ Done
+ </data>
+ </event>
+ <method>
+ Email
+ <data>
+ <name>to_address</name>
+ team at example.org
+ </data>
+ <data>
+ <name>from_address</name>
+ admin at example.org
+ </data>
+ <data>
+ <name>notice</name>
+ 0
+ </data>
+ </method>
+ </escalator>
+ ...
+</get_escalators_response>
+</pre>
+
+<h4 id="get_lsc_credentials">get_lsc_credentials</h4>
+
+<p>
+The client uses the get_lsc_credentials command to get LSC credential
+information. This command may include the ID of an existing LSC credential,
+a format, a sort order and a sort field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of LSC credentials to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"lsc_credential_id" is the ID of an LSC credential.</li>
+ <li>"format" is a string describing the requested format.</li>
+ <li>"sort_order" is "descending" for descending, anything else for ascending.</li>
+ <li>"sort_field" is the field to sort on.</li>
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_lsc_credentials />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_lsc_credentials_response status="200" status_text="OK">
+ <lsc_credential id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
+ <name>sally</name>
+ <login>sally</login>
+ <comment></comment>
+ <in_use>0</in_use>
+ <type>gen</type>
+ <targets></targets>
+ </lsc_credential>
+ <lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
+ <name>bob</name>
+ <login>bob</login>
+ <comment>Bob on the web server.</comment>
+ <in_use>1</in_use>
+ <type>pass</type>
+ <targets>
+ <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
+ <name>Web server</name>
+ </target>
+ </targets>
+ </lsc_credential>
+ ...
+</get_lsc_credentials_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15" format="key"/>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_lsc_credentials_response status="200" status_text="OK">
+ <lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
+ <name>bob</name>
+ <login>bob</login>
+ <comment>Bob on the web server.</comment>
+ <in_use>1</in_use>
+ <type>pass</type>
+ <targets>
+ <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
+ <name>Web server</name>
+ </target>
+ </targets>
+ <public_key>
+ ssh-rsa AAAAB3...Z64IcQ== Key generated by OpenVAS Manager
+ </public_key>
+ </lsc_credential>
+</get_lsc_credentials_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_lsc_credentials lsc_credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15" format="deb"/>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_lsc_credentials_response status="200" status_text="OK">
+ <lsc_credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
+ <name>bob</name>
+ <login>bob</login>
+ <comment>Bob on the web server.</comment>
+ <in_use>1</in_use>
+ <type>pass</type>
+ <targets>
+ <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
+ <name>Web server</name>
+ </target>
+ </targets>
+ <package format="deb">ITxhcmNoPgpk...DmvF0AKAAACg==</package>
+ </lsc_credential>
+</get_lsc_credentials_response>
+</pre>
+
+<h4 id="get_notes">get_notes</h4>
+
+<p>
+The client uses the get_notes command to get note information. This command may
+include the ID of an existing note, a details flag, a result flag, an NVT, a
+task, a sort order and a sort field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of notes to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"note_id" is the ID of a note.</li>
+ <li>"details" is boolean (0 is false, anything else is true).</li>
+ <li>"result" is boolean (0 is false, anything else is true).</li>
+ <li>"sort_order" is "descending" for descending, anything else for ascending.</li>
+ <li>"sort_field" is the field to sort on.</li>
+</ul>
+</p>
+
+<p>
+Command elements:
+<ul>
+m4_dnl FIX attribute like others!?
+m4_dnl FIX give nvt/@id, get nvt/@oid
+ <li><nvt> is an empty element with an id attribute.</li>
+m4_dnl FIX attribute like others!?
+ <li><task> is an empty element with an id attribute.</li>
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_notes />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_notes_response status="200" status_text="OK">
+ <note id="b76b81a7-9df8-42df-afff-baa9d4620128">
+ <nvt oid="1.3.6.1.4.1.25623.1.0.75">
+ <name>Test NVT: long lines</name>
+ </nvt>
+ <text excerpt="0">This is the full text of the note.</text>
+ <orphan>1</orphan>
+ </note>
+ ...
+</get_notes_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_notes note_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1" result="1"/>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_notes_response status="200" status_text="OK">
+ <note id="7f618bbb-4664-419e-9bbf-367d93954cb0">
+ <nvt oid="1.3.6.1.4.1.25623.1.0.77">
+ <name>Test NVT: control chars in report result</name>
+ </nvt>
+ <creation_time>Sun Jun 27 08:49:46 2010</creation_time>
+ <modification_time>Sun Jun 27 08:49:46 2010</modification_time>
+ <text>note fixed to result</text>
+ <hosts>127.0.0.1</hosts>
+ <port>general/tcp</port>
+ <threat>Medium</threat>
+ <task id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4">
+ <name>test</name>
+ </task>
+ <orphan>0</orphan>
+ <result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de">
+ <subnet>127.0.0.1</subnet>
+ <host>127.0.0.1</host>
+ <port>general/tcp</port>
+ <nvt oid="1.3.6.1.4.1.25623.1.0.77">
+ <name>Test NVT: control chars in report result</name>
+ <cvss_base></cvss_base>
+ <risk_factor></risk_factor>
+ </nvt>
+ <threat>Medium</threat>
+ <description>Warning with control char between fullstops: . .</description>
+ </result>
+ </note>
+ ...
+</get_notes_response>
+</pre>
+
<h4 id="get_nvts">get_nvts</h4>
<p>
@@ -2212,7 +2708,56 @@
</get_nvts_response>
</pre>
+<h4 id="get_nvt_families">get_nvt_families</h4>
+<p>
+The client uses the get_nvt_families command to get NVT family information.
+This command may include a sort order.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of families to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"sort_order" is "descending" for descending, anything else for ascending.</li>
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_nvt_families />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_nvt_families_response status="200" status_text="OK">
+ <families>
+ <family>
+ <name>Credentials</name>
+ <max_nvt_count>8</max_nvt_count>
+ </family>
+ <family>
+ <name>Port scanners</name>
+ <max_nvt_count>12</max_nvt_count>
+ </family>
+ ...
+ </families>
+</get_nvt_families_response>
+</pre>
+
+
<h4 id="get_nvt_feed_checksum">get_nvt_feed_checksum</h4>
<p>
@@ -2280,6 +2825,104 @@
</get_nvt_feed_checksum_response>
</pre>
+<h4 id="get_overrides">get_overrides</h4>
+
+<p>
+The client uses the get_overrides command to get override information. This command may
+include the ID of an existing override, a details flag, a result flag, an NVT, a
+task, a sort order and a sort field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of overrides to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"override_id" is the ID of an override.</li>
+ <li>"details" is boolean (0 is false, anything else is true).</li>
+ <li>"result" is boolean (0 is false, anything else is true).</li>
+ <li>"sort_order" is "descending" for descending, anything else for ascending.</li>
+ <li>"sort_field" is the field to sort on.</li>
+</ul>
+</p>
+
+<p>
+Command elements:
+<ul>
+m4_dnl FIX attribute like others!?
+m4_dnl FIX give nvt/@id, get nvt/@oid
+ <li><nvt> is an empty element with an id attribute.</li>
+m4_dnl FIX attribute like others!?
+ <li><task> is an empty element with an id attribute.</li>
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_overrides />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_overrides_response status="200" status_text="OK">
+ <override id="b76b81a7-9df8-42df-afff-baa9d4620128">
+ <nvt oid="1.3.6.1.4.1.25623.1.0.75">
+ <name>Test NVT: long lines</name>
+ </nvt>
+ <text excerpt="0">This is the full text of the override.</text>
+ <new_threat>Log</new_threat>
+ <orphan>1</orphan>
+ </override>
+ ...
+</get_overrides_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_overrides override_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1"/>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_overrides_response status="200" status_text="OK">
+ <override id="7f618bbb-4664-419e-9bbf-367d93954cb0">
+ <nvt oid="1.3.6.1.4.1.25623.1.0.77">
+ <name>Test NVT: control chars in report result</name>
+ </nvt>
+ <creation_time>Sun Jun 27 08:49:46 2010</creation_time>
+ <modification_time>Sun Jun 27 08:49:46 2010</modification_time>
+ <text>override fixed to result</text>
+ <hosts>127.0.0.1</hosts>
+ <port>general/tcp</port>
+ <threat>Medium</threat>
+ <new_threat>Low</new_threat>
+ <task id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4">
+ <name>test</name>
+ </task>
+ <orphan>0</orphan>
+ <result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de" />
+ </override>
+ ...
+</get_overrides_response>
+</pre>
+
<h4 id="get_preferences">get_preferences</h4>
<p>
@@ -2490,7 +3133,7 @@
<host>127.0.1.1</host>
<port>general/tcp</port>
<nvt oid="1.3.6.1.4.1.25623.1.0.74">
- <name>Test plugin: fields with ISO-8859-1 chars (ü)</name>
+ <name>Test NVT: fields with ISO-8859-1 chars (ü)</name>
<cvss_base>5.0</cvss_base>
<risk_factor>Medium</risk_factor>
</nvt>
@@ -2507,6 +3150,409 @@
</get_reports_response>
</pre>
+<h4 id="get_results">get_results</h4>
+
+<p>
+The client uses the get_results command to get result information. This command
+may include the ID of an existing result, a task ID, a notes flag, a
+notes_details flag, an overrides flag, an overrides_details flag and an
+apply_overrides flag.
+</p>
+
+<p>
+If the request includes a notes flag, an overrides flag or an apply_overrides
+flag and any of these is true, then the request must also include a task ID.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of results to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"result_id" is the ID of a result.</li>
+ <li>"task_id" is the ID of a task.</li>
+ <li>"notes" is boolean (0 is false, anything else is true).</li>
+ <li>"notes_details" is boolean (0 is false, anything else is true).</li>
+ <li>"overrides" is boolean (0 is false, anything else is true).</li>
+ <li>"overrides_details" is boolean (0 is false, anything else is true).</li>
+ <li>"apply_overrides" is boolean (0 is false, anything else is true).</li>
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_results />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_results_response status="200" status_text="OK">
+ <results>
+ <result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
+ <subnet>127.0.1.1</subnet>
+ <host>127.0.1.1</host>
+ <port>general/tcp</port>
+ <nvt oid="1.3.6.1.4.1.25623.1.0.74">
+ <name>Test NVT: fields with ISO-8859-1 chars</name>
+ <cvss_base>5.0</cvss_base>
+ <risk_factor>Medium</risk_factor>
+ </nvt>
+ <threat>Medium</threat>
+ <description>Test with umlaut.</description>
+ </result>
+ ...
+ </results>
+</get_results_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_results result_id="cac9e7c8-c726-49fd-a710-5f99079ab93e"
+ task_id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4"
+ notes="1"
+ overrides="1" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_results_response status="200" status_text="OK">
+ <results>
+ <result id="cac9e7c8-c726-49fd-a710-5f99079ab93e">
+ <subnet>127.0.0.1</subnet>
+ <host>127.0.0.1</host>
+ <port>general/tcp</port>
+ <nvt oid="1.3.6.1.4.1.25623.1.0.75">
+ <name>Test NVT: long lines</name>
+ <cvss_base>9</cvss_base>
+ <risk_factor>High</risk_factor>
+ </nvt>
+ <threat>High</threat>
+ <description>Test with very long warning.</description>
+ <original_threat>Medium</original_threat>
+ <notes></notes>
+ <overrides>
+ <override id="b0832812-75f1-45eb-b676-99c6e6bf2b24">
+ <nvt oid="1.3.6.1.4.1.25623.1.0.75">
+ <name>Test NVT: long lines</name>
+ </nvt>
+ <text excerpt="0">Test override</text>
+ <new_threat>High</new_threat>
+ <orphan>0</orphan>
+ </override>
+ </overrides>
+ </result>
+ </results>
+</get_results_response>
+</pre>
+
+<h4 id="get_schedules">get_schedules</h4>
+
+<p>
+The client uses the get_schedules command to get schedule information. This command may
+include the ID of an existing schedule, a details flag, a sort order and a sort field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of schedules to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"schedule_id" is the ID of a schedule.</li>
+ <li>"details" is boolean (0 is false, anything else is true).</li>
+ <li>"sort_order" is "descending" for descending, anything else for ascending.</li>
+ <li>"sort_field" is the field to sort on.</li>
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_schedules />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_schedules_response status="200" status_text="OK">
+ <schedule id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
+ <name>Overnight</name>
+ </schedule>
+ ...
+</get_schedules_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_schedules schedule_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf" details="1"/>
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_schedules_response status="200" status_text="OK">
+ <schedule id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
+ <name>Overnight</name>
+ <comment>3 hours, starting at 12h00.</comment>
+ <first_time>Tue Jun 29 00:00:00 2010</first_time>
+ <next_time>Tue Jun 29 00:00:00 2010</next_time>
+ <period>86400</period>
+ <period_months>0</period_months>
+ <duration>10800</duration>
+ <in_use>1</in_use>
+ <tasks>
+ <task id="d4daf4c4-25c7-40ac-87d3-38e489f34330">
+ <name>kk</name>
+ </task>
+ </tasks>
+ </schedule>
+</get_schedules_response>
+</pre>
+
+<h4 id="get_system_reports">get_system_reports</h4>
+
+m4_dnl FIX plural but returns single report
+m4_dnl FIX return all if name left out, like other get ops, would be slow.
+<p>
+The client uses the get_system_reports command to get system reports. This
+command must include a name and may include a duration.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a system report to the client.
+</p>
+
+<p>
+Command elements:
+<ul>
+ <li>"name" is a string describing the requested report.</li>
+ <li>"duration" is a number of seconds.</li>
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_system_reports name="types" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_system_reports_response status="200" status_text="OK">
+ <system_report>
+ <name>types</name>
+ <report>
+ <system_report>
+ <name>proc</name>
+ <title>Processes</title>
+ </system_report>
+ <system_report>
+ <name>load</name>
+ <title>System Load</title>
+ </system_report>
+ <system_report>
+ <name>cpu_0</name>
+ <title>CPU Usage: CPU 0</title>
+ </system_report>
+ ...
+ </report>
+ </system_report>
+</get_system_reports_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_system_reports name="proc" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_system_reports_response status="200" status_text="OK">
+ <system_report>
+ <name>proc</name>
+ <report format="png" duration="86400">
+ iVBORw0KGgoAAAANSUhEUgAAArkAAAEMCAYAAADAsa7vAAAABmJLR0QA/wD/AP+gvaeTAAAAB3RJ
+ TUUH2gYbDCUmRM0cqQAAIABJREFUeJzsnXl4FFW+/t9mGRFpAiRsIZCEsIhJQAZRBAxpAoERh6DX
+ ...
+ JYQQol9Xr16Fg4PDhHdwpVeap0+frtMpegkhRF3UySWEkEksMDBQL/uloQiEEENHb1cghBBCCCFT
+ DnVyCSGEEELIlEOdXEIIIYQQMuVwbt++PSoWi3Hv3j19l4UQQgghhBCtMKIOLiGEEEIImWr+B9Md
+ 9A602bEdAAAAAElFTkSuQmCC
+ </report>
+ </system_report>
+</get_system_reports_response>
+</pre>
+
+<h4 id="get_target_locators">get_target_locators</h4>
+
+<p>
+The client uses the get_target_locators command to get target locator
+information.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of target locators to the client.
+</p>
+
+<p>
+Command elements:
+<ul>
+ <li>(n/a)
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_target_locators />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_target_locators_response status="200" status_text="OK">
+m4_dnl name should be an entity like in others
+ <target_locator name="ldap"/>
+ ...
+</get_target_locators_response>
+</pre>
+
+<h4 id="get_targets">get_targets</h4>
+
+<p>
+The client uses the get_targets command to get target information. This command
+may include the ID of an existing target, a tasks flag, a sort order and a sort
+field.
+</p>
+
+<p>
+If there was no error with the command sent by the client, the manager will
+reply with a list of targets to the client.
+</p>
+
+<p>
+Command attributes:
+<ul>
+ <li>"target_id" is the ID of a target.
+ <li>"tasks" is boolean (0 is false, anything else is true).</li>
+ <li>"sort_order" is "descending" for descending, anything else for ascending.
+ <li>"sort_field" is the field to sort on.
+</ul>
+</p>
+
+<h5>Examples:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_targets />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_targets_response status="200" status_text="OK">
+ <target id="b493b7a8-7489-11df-a3ec-002264764cea">
+ <name>Localhost</name>
+ <hosts>localhost</hosts>
+ <max_hosts>1</max_hosts>
+ <comment></comment>
+ <in_use>7</in_use>
+ <lsc_credential id="">
+ <name></name>
+ </lsc_credential>
+ </target>
+ ...
+</get_targets_response>
+</pre>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_targets target_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf" tasks="1" />
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+<get_targets_response status="200" status_text="OK">
+ <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
+ <name>dik</name>
+ <hosts>dik.example.org</hosts>
+ <max_hosts>1</max_hosts>
+ <comment>dik mm</comment>
+ <in_use>4</in_use>
+ <lsc_credential id="58ff2793-2dc7-43fe-85f9-20bfac5a87e4">
+ <name>mm</name>
+ </lsc_credential>
+ <tasks>
+ <task id="13bb418a-4220-4575-b35b-ec398bff7417">
+ <name>dik mm</name>
+ </task>
+ ...
+ </tasks>
+ </target>
+</get_targets_response>
+</pre>
+
<h4 id="get_tasks">get_tasks</h4>
<p>
More information about the Openvas-commits
mailing list