[Openvas-commits] r8195 - trunk/doc/website
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Sat Jun 26 20:10:13 CEST 2010
Author: mattm
Date: 2010-06-26 20:10:12 +0200 (Sat, 26 Jun 2010)
New Revision: 8195
Modified:
trunk/doc/website/openvas-cr-28.htm4
Log:
Update get_tasks and get_reports.
Modified: trunk/doc/website/openvas-cr-28.htm4
===================================================================
--- trunk/doc/website/openvas-cr-28.htm4 2010-06-26 18:08:50 UTC (rev 8194)
+++ trunk/doc/website/openvas-cr-28.htm4 2010-06-26 18:10:12 UTC (rev 8195)
@@ -2414,63 +2414,126 @@
<b>C:</b>
</p>
-m4_dnl FIX <report> is also used in <get_tasks_response>
-m4_dnl FIX perhaps the two uses should be merged
+<pre>
+<get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e" format="PDF"/>
+</pre>
+<p>
+<b>M:</b>
+</p>
+
<pre>
-<get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
- <format>PDF</format>
-</get_reports>
+<get_reports_response status="200" status_text="OK">
+ <report id="f0fdf522-276d-4893-9274-fb8699dc2270">hsisn3qaVFhkjFRG4...</report>
+</get_reports_response>
</pre>
<p>
+<b>C:</b>
+</p>
+
+<pre>
+<get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"/>
+</pre>
+
+<p>
<b>M:</b>
</p>
<pre>
<get_reports_response status="200" status_text="OK">
- <report>hsisn3qaVFhkjFRG4...</report>
+ <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
+ <sort>
+ <field>
+ type
+ <order>descending</order>
+ </field>
+ </sort>
+ <filters>
+ hmlgd
+ <phrase></phrase>
+ <notes>0</notes>
+ <overrides>0</overrides>
+ <apply_overrides>0</apply_overrides>
+ <result_hosts_only>1</result_hosts_only>
+ <min_cvss_base></min_cvss_base>
+ <filter>High</filter>
+ <filter>Medium</filter>
+ <filter>Low</filter>
+ <filter>Log</filter>
+ <filter>Debug</filter>
+ </filters>
+ <scan_run_status>Done</scan_run_status>
+ <result_count>
+ 10
+ <filtered>10</filtered>
+ <debug>0</debug>
+ <hole>0</hole>
+ <info>7</info>
+ <log>0</log>
+ <warning>3</warning>
+ </result_count>
+ <task id="13bb418a-4220-4575-b35b-ec398bff7417">
+ <name>dik mm</name>
+ </task>
+ <ports start="1" max="-1">
+ <port>
+ general/tcp
+ <host>127.0.1.1</host>
+ <threat>Medium</threat>
+ </port>
+ ...
+ </ports>
+ <results start="1" max="-1">
+ <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 plugin: 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 Warning Port 0.</description>
+ </result>
+ ...
+ </results>
+ <scan_start>Mon Feb 1 19:11:21 2010</scan_start>
+ <host_start>Mon Feb 1 19:11:21 2010<host>127.0.1.1</host></host_start>
+ <host_end>Mon Feb 1 19:11:52 2010<host>127.0.1.1</host></host_end>
+ <scan_end>Mon Feb 1 19:11:52 2010</scan_end>
+ </report>
</get_reports_response>
</pre>
<h4 id="get_tasks">get_tasks</h4>
<p>
-The client uses the get_tasks command to request task information.
+The client uses the get_tasks command to request task information. This command
+may include a task ID, details flag, apply overrides flag, sort order and sort
+field,
</p>
<p>
-If the get_tasks command is sent without a task ID, the manager will respond with
-the number of tasks and a list of the tasks that have been stored for the user
-issuing this command. The list will include the ID of the task, the
-human-readable identifier, an element describing the state of the report
-(Running, Done etc.) and five numbers indicating the number of security holes,
-security notes, security infos, log messages and debug messages discovered
-during the last run of this task.
+If the command includes the details flag each task will include details of all
+reports on the task.
</p>
<p>
-If the get_tasks command is sent with a task ID, the manager will respond with
-detailed information on the requested task ID.
-If the task is not currently running, the response will include the number of
-reports that are available for this task and a list containing the IDs of the
-reports, a timestamp indicating when this report was created and five numbers
-indicating the number of security holes, security notes, security infos, log
-messages and debug messages described in this report. If there is a comment
-included in the report, it will be sent as well.
-If the task is currently running, the response will include the IP of the host
-currently being scanned and five numbers indicating the number of security
-holes, security notes, security infos, log messages and debug messages which
-have been received so far during this run of the task.
-In either case, the manager will include the task name and task status
-(New, Running, Done, etc) in the response.
+As a convenience for clients the response includes a task count and the values
+of the sort order, sort field and apply overrides flag that the manager applied
+when selecting the tasks.
</p>
<p>
Command attributes:
<ul>
- <li>"task_id" is the ID of the task which should be queried.
- <li>"details" is the ID of the task which should be queried.
+ <li>"task_id" is the ID of the task which should be queried.</li>
+ <li>"details" is boolean (0 is false, anything else is true).</li>
+ <li>"apply_overrides" 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>
@@ -2498,27 +2561,71 @@
<pre>
<get_tasks_response status="200" status_text="OK">
<task_count>2</task_count>
+ <sort>
+ <field>
+ ROWID
+ <order>ascending</order>
+ </field>
+ </sort>
+ <apply_overrides>0</apply_overrides>
<task id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
<name>Scan Webserver</name>
- <status>Running</status>
- <messages>
- <hole>0</hole>
+ <comment>Scan of the web server.</name>
+ <status>Done</status>
+ <progress>-1</progress>
+ <config id="daba56c8-73ec-11df-a475-002264764cea">
+ <name>Full and fast</name>
+ </config>
+ <escalator id="">
+ <name></name>
+ </escalator>
+ <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
+ <name>dik</name>
+ </target>
+ <schedule id="">
+ <name></name>
+ <next_time>over</next_time>
+ </schedule>
+ <result_count>
+ <debug>0</debug>
+ <log>0</log>
+ <info>14</info>
<warning>0</warning>
- <info>0</info>
- <log>0</log>
- <debug>0</debug>
- </messages>
+ <hole>6</hole>
+ </result_count>
+ <report_count>
+ 2
+ <finished>2</finished>
+ </report_count>
+ <trend></trend>
+ <first_report>
+ <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
+ <timestamp>Mon Feb 1 19:11:20 2010</timestamp>
+ <result_count>
+ <debug>0</debug>
+ <hole>0</hole>
+ <info>7</info>
+ <log>0</log>
+ <warning>3</warning>
+ </result_count>
+ </report>
+ </first_report>
+ <last_report>
+ <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
+ <timestamp>Mon Feb 1 19:11:20 2010</timestamp>
+ <result_count>
+ <debug>0</debug>
+ <hole>0</hole>
+ <info>7</info>
+ <log>0</log>
+ <warning>3</warning>
+ </result_count>
+ </report>
+ </last_report>
</task>
<task id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c">
<name>Scan Mailserver</name>
- <status>Done</status>
- <messages>
- <hole>0</hole>
- <warning>2</warning>
- <info>5</info>
- <log>0</log>
- <debug>7</debug>
- </messages>
+ ...
</task>
</get_tasks_response>
</pre>
@@ -2528,7 +2635,7 @@
</p>
<pre>
-<get_tasks task_id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c" />
+<get_tasks task_id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c" details="1" />
</pre>
<p>
@@ -2537,97 +2644,96 @@
<pre>
<get_tasks_response status="200" status_text="OK">
- <name>Scan Mailserver</name>
- <status>Done</status>
- <report_count>5</report_count>
- <report id="fc2ae4a9-8819-4159-b94b-5210db2f6f38">
- <timestamp>2009-03-10T10:21Z</timestamp>
- <messages>
- <hole>1</hole>
- <warning>2</warning>
- <info>5</info>
- <log>3</log>
- <debug>3</debug>
- </messages>
- <comment/>
- </report>
- <report id="bcfeca57-0068-494b-a0bc-7b056649bd8b">
- <timestamp>2009-03-10T10:29Z</timestamp>
- <messages>
- <hole>0</hole>
- <warning>1</warning>
- <info>5</info>
- <log>2</log>
- <debug>3</debug>
- </messages>
- <comment>Applied patch</comment>
- </report>
- <report id="0c176f64-faf8-4544-8de7-12dbccb3831c">
- <timestamp>2009-03-10T11:19Z</timestamp>
- <messages>
- <hole>0</hole>
- <warning>0</warning>
- <info>3</info>
- <log>2</log>
- <debug>3</debug>
- </messages>
- <comment/>
- </report>
- <report id="80d0096d-4216-42a7-b727-e6955c08f97b">
- <timestamp>2009-03-11T16:42Z</timestamp>
- <messages>
- <hole>0</hole>
- <warning>0</warning>
- <info>2</info>
- <log>2</log>
- <debug>3</debug>
- </messages>
- <comment/>
- </report>
- <report id="5d6294dd-e634-4f06-ae64-ef97e68b0e43">
- <timestamp>2009-03-11T17:02Z</timestamp>
- <messages>
- <hole>0</hole>
- <warning>0</warning>
- <info>1</info>
- <log>1</log>
- <debug>3</debug>
- </messages>
- <comment/>
- </report>
-</get_tasks_response>
-</pre>
-
-<p>
-<b>C:</b>
-</p>
-
-<pre>
-<get_tasks task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6" />
-</pre>
-
-<p>
-<b>M:</b>
-</p>
-
-<pre>
-<get_tasks_response status="200" status_text="OK">
- <task id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
+ <task_count>1</task_count>
+ <sort>
+ <field>
+ ROWID
+ <order>ascending</order>
+ </field>
+ </sort>
+ <apply_overrides>0</apply_overrides>
+ <task id="13bb418a-4220-4575-b35b-ec398bff7417">
<name>Scan Mailserver</name>
- <status>Running</status>
- <current_ip>192.168.1.5</current_ip>
- <messages>
- <hole>0</hole>
+ <comment>Scan of the web server.</name>
+ <status>Done</status>
+ <progress>-1</progress>
+ <config id="daba56c8-73ec-11df-a475-002264764cea">
+ <name>Full and fast</name>
+ </config>
+ <escalator id="">
+ <name></name>
+ </escalator>
+ <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
+ <name>dik</name>
+ </target>
+ <schedule id="">
+ <name></name>
+ <next_time>over</next_time>
+ </schedule>
+ <result_count>
+ <debug>0</debug>
+ <log>0</log>
+ <info>14</info>
<warning>0</warning>
- <info>1</info>
- <log>1</log>
- <debug>3</debug>
- </messages>
+ <hole>6</hole>
+ </result_count>
+ <report_count>
+ 2
+ <finished>2</finished>
+ </report_count>
+ <trend></trend>
+ <first_report>
+ <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
+ <timestamp>Mon Feb 1 19:11:20 2010</timestamp>
+ <result_count>
+ <debug>0</debug>
+ <hole>0</hole>
+ <info>7</info>
+ <log>0</log>
+ <warning>3</warning>
+ </result_count>
+ </report>
+ </first_report>
+ <last_report>
+ <report id="2688e6c7-db29-4505-80f1-0fd4a09e1011">
+ <timestamp>Mon Feb 1 19:11:20 2010</timestamp>
+ <result_count>
+ <debug>0</debug>
+ <hole>0</hole>
+ <info>7</info>
+ <log>0</log>
+ <warning>3</warning>
+ </result_count>
+ </report>
+ </last_report>
+ <reports>
+ <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
+ <timestamp>Mon Feb 1 18:51:38 2010</timestamp>
+ <scan_run_status>Done</scan_run_status>
+ <result_count>
+ <debug>0</debug>
+ <hole>0</hole>
+ <info>7</info>
+ <log>0</log>
+ <warning>3</warning>
+ </result_count>
+ </report>
+ <report id="2688e6c7-db29-4505-80f1-0fd4a09e1011">
+ <timestamp>Mon Feb 1 19:11:20 2010</timestamp>
+ <scan_run_status>Done</scan_run_status>
+ <result_count>
+ <debug>0</debug>
+ <hole>0</hole>
+ <info>7</info>
+ <log>0</log>
+ <warning>3</warning>
+ </result_count>
+ </report>
+ </reports>
</task>
</get_tasks_response>
</pre>
-
<h4 id="get_version">get_version</h4>
<p>
More information about the Openvas-commits
mailing list