<!--
OpenVAS Manager
$Id$
Description: OMP schema with embedded documentation, in OMP.

Authors:
Matthew Mundell <matthew.mundell@greenbone.net>

Copyright:
Copyright (C) 2010-2014 Greenbone Networks GmbH

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
-->

<protocol>
  <name>OpenVAS Management Protocol</name>
  <abbreviation>OMP</abbreviation>
  <summary>The "management" protocol of the Open Vulnerability Assessment System</summary>
  <version>@OMP_VERSION@</version>

  <!-- Types. -->

  <type>
    <name>alive_test</name>
    <summary>An alive test</summary>
    <pattern>
      xsd:token { pattern = "ICMP, TCP Service &amp; ARP Ping|TCP Service &amp; ARP Ping|ICMP &amp; ARP Ping|ICMP &amp; TCP Service Ping|ARP Ping|TCP Service Ping|ICMP Ping|Scan Config Default" }
    </pattern>
  </type>
  <type>
    <name>base64</name>
    <summary>Base64 encoded data</summary>
    <pattern>xsd:base64Binary</pattern>
  </type>
  <type>
    <name>boolean</name>
    <summary>A true or false value</summary>
    <description>
      Zero is false, anything else is true.  As a result, the empty string is
      considered true.
    </description>
    <pattern>text</pattern>
  </type>
  <type>
    <name>boolean_atoi</name>
    <summary>A true or false value, after conversion to an integer</summary>
    <description>
      Zero is false, anything else is true.  The value is first converted to
      an integer, as by the C `atoi' routine.  This means that an empty string
      is considered false.
    </description>
    <pattern>text</pattern>
  </type>
  <type>
    <name>ctime</name>
    <summary>A date and time, in the C `ctime' format</summary>
    <description>
      An example string in this format is "Wed Jun 30 21:49:08 1993\n".
    </description>
    <pattern>text</pattern>
  </type>
  <type>
    <name>type_name</name>
    <summary>A name of a data type</summary>
    <pattern>xsd:Name</pattern>
  </type>
  <type>
    <name>integer</name>
    <summary>An integer</summary>
    <pattern>xsd:integer</pattern>
  </type>
  <type>
    <name>iso_time</name>
    <summary>A date and time, in ISO 8601 format</summary>
    <description>
      An example string in this format is "2011-11-08T19:57:06+02:00".
    </description>
    <pattern>text</pattern>
  </type>
  <type>
    <name>levels</name>
    <summary>A string that may include the characters h, m, l, g and d</summary>
    <pattern>xsd:token { pattern = "h?m?l?g?d?" }</pattern>
  </type>
  <type>
    <name>name</name>
    <summary>A name</summary>
    <description>
      Typically this is the name of one of the manager resources, like a
      task or target.
    </description>
    <pattern>xsd:string</pattern>
  </type>
  <type>
    <name>port</name>
    <summary>A port</summary>
    <pattern>xsd:token { pattern = "[0-9]{1,5}" }</pattern>
  </type>
  <type>
    <name>user_list</name>
    <summary>A space separated list of users</summary>
    <pattern>text</pattern>
  </type>
  <type>
    <name>oid</name>
    <summary>An Object Identifier (OID)</summary>
    <pattern>xsd:token { pattern = "[0-9\.]{1,80}" }</pattern>
  </type>
  <type>
    <name>severity</name>
    <summary>A severity score</summary>
    <description>
      A severity score is a decimal number between 0.0 and 10.0 (inclusive) with
      one digit after the decimal point or a special negative value
      (-1.0, -2.0 or -3.0).
      If a single severity score defines a constraint, e.g. on whether an
      override applies, for values 0.0 and lower the severity must be equal
      to match while for &gt; 0.0 the compared value must be greater or equal.
    </description>
    <pattern>xsd:token { pattern = "-[1-3](\.0)?|[0-9](\.[0-9])?|10(\.0)?" }</pattern>
  </type>
  <type>
    <name>sort_order</name>
    <summary>A string describing an order for sorting</summary>
    <description>
      The string "descending" denotes descending order, anything else means
      ascending.
    </description>
    <pattern>text</pattern>
  </type>
  <type>
    <name>status</name>
    <summary>The success or failure status of a command</summary>
    <pattern>xsd:token { pattern = "200|201|202|400|401|403|404|409|500|503" }</pattern>
  </type>
  <type>
    <name>task_status</name>
    <summary>A task run status</summary>
    <pattern>
      xsd:token { pattern = "Delete Requested|Done|New|Requested|Running|Stop Requested|Stopped|Internal Error" }
    </pattern>
  </type>
  <type>
    <name>task_trend</name>
    <summary>The trend of results for a task</summary>
    <pattern>
      xsd:token { pattern = "up|down|more|less|same" }
    </pattern>
  </type>
  <type>
    <name>threat</name>
    <summary>A threat level</summary>
    <description>
      Threat levels are a textual classification of severity scores only
      supported for importing reports from OpenVAS-6 and older.
      The use of these elements is deprecated as they are otherwise replaced by
      severity elements, which should be used instead.
    </description>
    <pattern>xsd:token { pattern = "High|Medium|Low|Alarm|Log|Debug" }</pattern>
  </type>
  <type>
    <name>time_unit</name>
    <summary>A unit of time</summary>
    <pattern>xsd:token { pattern = "second|minute|hour|day|week|month|year|decade" }</pattern>
  </type>
  <type>
    <name>timezone</name>
    <summary>A timezone</summary>
    <description>
      <p>
        The format of a timezone is the same as that of the TZ environment
        variable on GNU/Linux systems.  That is, the same value accepted by the
        tzset C function.  There are three versions of the format.  Note the lack
        of spaces in the examples.
      </p>

      <p>
        "std offset" defines a simple timezone.  For example,
        "FOO+2" defines a timezone FOO which is 2 hours behind UTC.
      </p>
      <p>
        "std offset dst [offset],start[/time],end[/time]" defines a timezone,
        including daylight savings time.  For example,
        "NZST-12.00:00NZDT-13:00:00,M10.1.0,M3.3.0".
      </p>
      <p>
        ":[filespec]" refers to a predefined timezone.  For example,
        ":Africa/Johannesburg".  Note that the colon is optional.  Certain
        acronyms are predefined, such as GB, NZ and CET.
      </p>
    </description>
    <pattern>text</pattern>
  </type>
  <type>
    <name>uuid</name>
    <summary>A Universally Unique Identifier (UUID)</summary>
    <pattern>xsd:token { pattern = "[0-9abcdefABCDEF\-]{1,40}" }</pattern>
  </type>
  <type>
    <name>uuid_or_empty</name>
    <summary>A Universally Unique Identifier (UUID), or the empty string</summary>
    <pattern>xsd:token { pattern = "[0-9abcdefABCDEF\-]{0,40}" }</pattern>
  </type>

  <!-- Elements. -->

  <element>
    <name>c</name>
    <summary>A reference to a command</summary>
    <pattern>text</pattern>
  </element>
  <element>
    <name>e</name>
    <summary>A reference to an element</summary>
    <pattern>text</pattern>
  </element>
  <element>
    <name>r</name>
    <summary>A reference to a response</summary>
    <pattern>text</pattern>
  </element>
  <element>
    <name>o</name>
    <summary>An optional pattern item</summary>
    <pattern>
      <or>
        <e>c</e>
        <e>e</e>
        <e>r</e>
        <e>g</e>
      </or>
    </pattern>
  </element>
  <element>
    <name>g</name>
    <summary>A group of pattern items</summary>
    <pattern>
      <any><e>c</e></any>
      <any><e>e</e></any>
      <any><e>r</e></any>
      <any><e>o</e></any>
      <any><e>any</e></any>
    </pattern>
  </element>
  <element>
    <name>any</name>
    <summary>Pattern item indicating "any number of"</summary>
    <pattern>
      <or>
        <e>c</e>
        <e>e</e>
        <e>r</e>
        <e>g</e>
      </or>
    </pattern>
  </element>
  <element>
    <name>pattern</name>
    <summary>The pattern element of a command or command descendant</summary>
    <description>
      It's actually either a 't' element, or the word "text", or "".
    </description>
    <pattern>
      <any><e>attrib</e></any>
      <any><e>c</e></any>
      <any><e>e</e></any>
      <any><e>r</e></any>
      <any><e>o</e></any>
      <any><e>g</e></any>
      <any><e>any</e></any>
      <o><e>t</e></o>
      text
    </pattern>
    <ele>
      <name>attrib</name>
      <summary>An attribute</summary>
      <pattern>
        <e>name</e>
        <e>type</e>
        <e>required</e>
        <any><e>filter_keywords</e></any>
      </pattern>
      <ele>
        <name>name</name>
        <pattern><t>type_name</t></pattern>
      </ele>
      <ele>
        <name>type</name>
        <pattern><t>type_name</t></pattern>
      </ele>
      <ele>
        <name>required</name>
        <pattern><t>boolean</t></pattern>
      </ele>
      <ele>
        <name>filter_keywords</name>
        <pattern><t>filter_keywords</t></pattern>
        <summary>Optional description of filter keywords usable in the attribute</summary>
      </ele>
    </ele>
    <ele>
      <name>t</name>
      <summary>The type of the text of the element</summary>
      <pattern><t>type_name</t></pattern>
    </ele>
  </element>
  <element>
    <name>command_definition</name>
    <summary>Definition of a command in OMP describing HELP command</summary>
    <pattern>
      <e>name</e>
      <o><e>summary</e></o>
      <o><e>description</e></o>
      <or>
        <g>
          <e>pattern</e>
          <e>response</e>
        </g>
        <g>
          <e>type</e>
          <any><e>ele</e></any>
        </g>
      </or>
      <any><e>example</e></any>
    </pattern>
    <ele>
      <name>name</name>
      <summary>The name of the command</summary>
      <description>The name must be unique</description>
      <pattern><t>type_name</t></pattern>
    </ele>
    <ele>
      <name>summary</name>
      <summary>A summary of the command</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>description</name>
      <summary>A description of the command</summary>
      <pattern>
        <any><e>p</e></any>
        text
      </pattern>
      <ele>
        <name>p</name>
        <summary>A paragraph</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>pattern</name>
      <type>pattern</type>
    </ele>
    <ele>
      <name>response</name>
      <type>pattern</type>
    </ele>
    <ele>
      <name>example</name>
      <pattern>
        <o><e>summary</e></o>
        <o><e>description</e></o>
        <e>request</e>
        <e>response</e>
      </pattern>
      <ele>
        <name>summary</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>description</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>request</name>
        <summary>Example request</summary>
        <description>This can actually contain any XML</description>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>response</name>
        <summary>Response to example request</summary>
        <description>This can actually contain any XML</description>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>type</name>
      <summary>The type of the element</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>ele</name>
      <summary>An element</summary>
      <description>
        <p>
          This is a recursive definition.
        </p>
        <p>
          command_definition actually includes an extra response element, but
          it's convenient to use it for the elements.
        </p>
      </description>
      <type>command_definition</type>
    </ele>
  </element>
  <element>
    <name>filter_keywords</name>
    <summary>A group of filter keywords usable in an attribute or element text</summary>
    <pattern>
      <o><e>condition</e></o>
      <any><e>column</e></any>
      <any><e>option</e></any>
    </pattern>
    <ele>
      <name>condition</name>
      <pattern>text</pattern>
      <summary>Description of the condition under which the group of keywords applies</summary>
    </ele>
    <ele>
      <name>column</name>
      <pattern>
        <e>name</e>
        <e>type</e>
        <e>summary</e>
      </pattern>
      <summary>A column that can be used multiple times with operators and in sorting</summary>
      <ele>
        <name>name</name>
        <pattern>name</pattern>
        <summary>Name of the keyword as used in the filter</summary>
      </ele>
      <ele>
        <name>type</name>
        <pattern><t>type_name</t></pattern>
        <summary>Type of the values the keyword can use</summary>
      </ele>
      <ele>
        <name>summary</name>
        <pattern>text</pattern>
        <summary>Short description of the keyword</summary>
      </ele>
    </ele>
    <ele>
      <name>option</name>
      <pattern>
        <e>name</e>
        <e>type</e>
        <e>summary</e>
      </pattern>
      <summary>An option only applied once which cannot be used with operators or in sorting</summary>
      <ele>
        <name>name</name>
        <pattern>name</pattern>
        <summary>Name of the keyword as used in the filter</summary>
      </ele>
      <ele>
        <name>type</name>
        <pattern><t>type_name</t></pattern>
        <summary>Type of the values the keyword can use</summary>
      </ele>
      <ele>
        <name>summary</name>
        <pattern>text</pattern>
        <summary>Short description of the keyword</summary>
      </ele>
    </ele>
  </element>
  <element>
    <name>certificate_info</name>
    <summary>Info about a certificate</summary>
    <pattern>
      <e>time_status</e>
      <e>activation_time</e>
      <e>expiration_time</e>
      <e>issuer</e>
      <e>md5_fingerprint</e>
    </pattern>
    <ele>
      <name>time_status</name>
      <summary>
        Whether the certificate is valid, expired or not active yet
      </summary>
      <pattern>
        <t>
          <alts>
            <alt>expired</alt>
            <alt>inactive</alt>
            <alt>unknown</alt>
            <alt>valid</alt>
          </alts>
        </t>
      </pattern>
    </ele>
    <ele>
      <name>activation_time</name>
      <summary>Time before which the certificate is not valid</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>expiration_time</name>
      <summary>Time after which the certificate is no longer valid</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>issuer</name>
      <summary>DN of the issuer of the certificate</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>md5_fingerprint</name>
      <summary>MD5 fingerprint of the certificate</summary>
      <pattern>text</pattern>
    </ele>
  </element>
  <element>
    <name>note</name>
    <summary>A note</summary>
    <pattern>
      <attrib>
        <name>id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <e>permissions</e>
      <e>owner</e>
      <e>nvt</e>
      <e>text</e>
      <e>creation_time</e>
      <e>modification_time</e>
      <e>writable</e>
      <e>in_use</e>
      <e>active</e>
      <e>orphan</e>
      <e>user_tags</e>
      <o>
        <g>
          <e>hosts</e>
          <e>port</e>
          <e>severity</e>
          <e>threat</e>
          <e>task</e>
          <o><e>end_time</e></o>
          <o><e>result</e></o>
        </g>
      </o>
    </pattern>
    <ele>
      <name>permissions</name>
      <summary>Permissions that the current user has on the note</summary>
      <pattern>
        <any><e>permission</e></any>
      </pattern>
      <ele>
        <name>permission</name>
        <pattern>
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the permission</summary>
          <pattern><t>name</t></pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>owner</name>
      <summary>Owner of the note</summary>
      <pattern>
        <e>name</e>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the owner</summary>
        <pattern><t>name</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>nvt</name>
      <pattern>
        <attrib>
          <name>oid</name>
          <type>oid</type>
          <required>1</required>
        </attrib>
        <e>name</e>
        <e>type</e>
      </pattern>
      <ele>
        <name>name</name>
        <pattern><t>name</t></pattern>
      </ele>
      <ele>
        <name>type</name>
        <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>creation_time</name>
      <summary>Date and time the note was created</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>modification_time</name>
      <summary>Date and time the note was last modified</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>writable</name>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>in_use</name>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Whether the note is active</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>text</name>
      <summary>The text of the note</summary>
      <pattern>
        <attrib>
          <name>excerpt</name>
          <summary>Whether the content is an excerpt of the full text</summary>
          <type>boolean</type>
          <required>1</required>
        </attrib>
        text
      </pattern>
    </ele>
    <ele>
      <name>orphan</name>
      <summary>Whether the note is an orphan</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>user_tags</name>
      <summary>Info on tags attached to the note</summary>
      <pattern>
        <e>count</e>
        <any><e>tag</e></any>
      </pattern>
      <ele>
        <name>count</name>
        <summary>Number of attached tags</summary>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>tag</name>
        <summary>
          Short info on an individual tag
          (only if details were requested)
        </summary>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <summary>UUID of the tag</summary>
            <required>1</required>
          </attrib>
          <e>name</e>
          <e>value</e>
          <e>comment</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>Name of the tag (usually namespace:predicate)</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <summary>Value of the tag</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>Comment for the tag</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>A textual list of hosts</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>Port to which note applies</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>severity</name>
      <summary>Severity to which note applies</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>threat</name>
      <summary>Threat level to which note applies</summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>Task to which note applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Whether the note is active</summary>
      <pattern><t>integer</t></pattern>
    </ele>
    <ele>
      <name>end_time</name>
      <summary>End time of the note in case of limit, else empty</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>result</name>
      <summary>Result to which note applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <e>host</e>
        <e>port</e>
        <e>nvt</e>
        <e>severity</e>
        <e>threat</e>
        <e>qod</e>
        <e>description</e>
      </pattern>
      <ele>
        <name>host</name>
        <pattern>
          <e>asset</e>
          text
        </pattern>
        <ele>
          <name>asset</name>
          <summary>Asset linked to host</summary>
          <pattern>
            <attrib>
              <name>asset_id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
          </pattern>
        </ele>
      </ele>
      <ele>
        <name>port</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>nvt</name>
        <pattern>
          <attrib>
            <name>oid</name>
            <type>oid</type>
            <required>1</required>
          </attrib>
          <e>name</e>
          <e>type</e>
          <e>cvss_base</e>
          <o><e>cve</e></o>
          <o><e>bid</e></o>
        </pattern>
        <ele>
          <name>name</name>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>type</name>
          <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>cvss_base</name>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>cve</name>
          <summary>CVE value associated with the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>bid</name>
          <summary>BID associated with the NVT</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
      <ele>
        <name>severity</name>
        <pattern>
          <t>severity</t>
        </pattern>
      </ele>
      <ele>
        <name>threat</name>
        <pattern>
          <t>threat</t>
        </pattern>
      </ele>
      <ele>
        <name>qod</name>
        <summary>The quality of detection (QoD) of the result</summary>
        <pattern>
          <e>value</e>
          <e>type</e>
        </pattern>
        <ele>
          <name>value</name>
          <summary>The numeric QoD value</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>type</name>
          <summary>The QoD type</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
      <ele>
        <name>description</name>
        <pattern>text</pattern>
      </ele>
    </ele>
  </element>
  <element>
    <name>override</name>
    <summary>An override</summary>
    <pattern>
      <attrib>
        <name>id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <e>permissions</e>
      <e>owner</e>
      <e>nvt</e>
      <e>creation_time</e>
      <e>modification_time</e>
      <e>writable</e>
      <e>in_use</e>
      <e>active</e>
      <e>text</e>
      <e>threat</e>
      <e>severity</e>
      <e>new_threat</e>
      <e>new_severity</e>
      <e>orphan</e>
      <e>permissions</e>
      <e>user_tags</e>
      <o>
        <g>
          <e>hosts</e>
          <e>port</e>
          <e>task</e>
          <o><e>end_time</e></o>
          <o><e>result</e></o>
        </g>
      </o>
    </pattern>
    <ele>
      <name>permissions</name>
      <summary>Permissions that the current user has on the note</summary>
      <pattern>
        <any><e>permission</e></any>
      </pattern>
      <ele>
        <name>permission</name>
        <pattern>
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the permission</summary>
          <pattern><t>name</t></pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>owner</name>
      <summary>Owner of the override</summary>
      <pattern>
        <e>name</e>
      </pattern>
      <ele>
        <name>name</name>
        <pattern><t>name</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>nvt</name>
      <pattern>
        <attrib>
          <name>oid</name>
          <type>oid</type>
          <required>1</required>
        </attrib>
        <e>name</e>
        <e>type</e>
      </pattern>
      <ele>
        <name>name</name>
        <pattern><t>name</t></pattern>
      </ele>
      <ele>
        <name>type</name>
        <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>creation_time</name>
      <summary>Date and time the override was created</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>modification_time</name>
      <summary>Date and time the override was last modified</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>writable</name>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>in_use</name>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Whether the override is currently active</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>text</name>
      <summary>The text of the override</summary>
      <pattern>
        <attrib>
          <name>excerpt</name>
          <summary>Whether the contents is an excerpt of the full text</summary>
          <type>boolean</type>
          <required>1</required>
        </attrib>
        text
      </pattern>
    </ele>
    <ele>
      <name>threat</name>
      <summary>
        Threat level to which override applies, derived from severity
      </summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </ele>
    <ele>
      <name>severity</name>
      <summary>Severity score to which override applies</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>new_threat</name>
      <summary>New threat for result</summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </ele>
    <ele>
      <name>new_severity</name>
      <summary>New severity score for result</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>orphan</name>
      <summary>Whether the override is an orphan</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>user_tags</name>
      <summary>Info on tags attached to the override</summary>
      <pattern>
        <e>count</e>
        <any><e>tag</e></any>
      </pattern>
      <ele>
        <name>count</name>
        <summary>Number of attached tags</summary>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>tag</name>
        <summary>
          Short info on an individual tag
          (only if details were requested)
        </summary>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <summary>UUID of the tag</summary>
            <required>1</required>
          </attrib>
          <e>name</e>
          <e>value</e>
          <e>comment</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>Name of the tag (usually namespace:predicate)</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <summary>Value of the tag</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>Comment for the tag</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>A textual list of hosts</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>Port to which override applies</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>Task to which override applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Whether the override is active</summary>
      <pattern><t>integer</t></pattern>
    </ele>
    <ele>
      <name>end_time</name>
      <summary>Override end time in case of limit, else empty</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>result</name>
      <summary>Result to which override applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <e>host</e>
        <e>port</e>
        <e>nvt</e>
        <e>threat</e>
        <e>severity</e>
        <e>qod</e>
        <e>description</e>
      </pattern>
      <ele>
        <name>host</name>
        <pattern>
          <e>asset</e>
          text
        </pattern>
        <ele>
          <name>asset</name>
          <summary>Asset linked to host</summary>
          <pattern>
            <attrib>
              <name>asset_id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
          </pattern>
        </ele>
      </ele>
      <ele>
        <name>port</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>nvt</name>
        <pattern>
          <attrib>
            <name>oid</name>
            <type>oid</type>
            <required>1</required>
          </attrib>
          <e>name</e>
          <e>type</e>
          <e>cvss_base</e>
          <o><e>cve</e></o>
          <o><e>bid</e></o>
        </pattern>
        <ele>
          <name>name</name>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>type</name>
          <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>cvss_base</name>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>cve</name>
          <summary>CVE value associated with the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>bid</name>
          <summary>BID associated with the NVT</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
      <ele>
        <name>threat</name>
        <pattern>
          <t>threat</t>
        </pattern>
      </ele>
      <ele>
        <name>severity</name>
        <pattern>
          <t>severity</t>
        </pattern>
      </ele>
      <ele>
        <name>qod</name>
        <summary>The quality of detection (QoD) of the result</summary>
        <pattern>
          <e>value</e>
          <e>type</e>
        </pattern>
        <ele>
          <name>value</name>
          <summary>The numeric QoD value</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>type</name>
          <summary>The QoD type</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
      <ele>
        <name>description</name>
        <pattern>text</pattern>
      </ele>
    </ele>
  </element>
  <element>
    <name>result</name>
    <summary>A result</summary>
    <pattern>
      <attrib>
        <name>id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <e>name</e>
      <e>owner</e>
      <e>comment</e>
      <e>creation_time</e>
      <e>modification_time</e>
      <o><e>user_tags</e></o>
      <o><e>report</e></o>
      <o><e>task</e></o>
      <e>host</e>
      <e>port</e>
      <e>nvt</e>
      <e>scan_nvt_version</e>
      <e>threat</e>
      <e>severity</e>
      <e>qod</e>
      <o><e>original_threat</e></o>
      <o><e>original_severity</e></o>
      <e>description</e>
      <o><e>delta</e></o>
      <e>details</e>
      <e>detection</e>
      <o><e>notes</e></o>
      <o><e>overrides</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>The name of the result</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>owner</name>
      <summary>Owner of the result</summary>
      <pattern>
        <e>name</e>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the owner</summary>
        <pattern><t>name</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>comment</name>
      <summary>The comment on the result</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>creation_time</name>
      <summary>Date and time the result was created</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>modification_time</name>
      <summary>Date and time the result was last modified</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>user_tags</name>
      <summary>Info on tags attached to the result (not in delta results)</summary>
      <pattern>
        <e>count</e>
        <any><e>tag</e></any>
      </pattern>
      <ele>
        <name>count</name>
        <summary>Number of attached tags</summary>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>tag</name>
        <summary>
          Short info on an individual tag
          (only if details were requested)
        </summary>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <summary>UUID of the tag</summary>
            <required>1</required>
          </attrib>
          <e>name</e>
          <e>value</e>
          <e>comment</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>Name of the tag (usually namespace:predicate)</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <summary>Value of the tag</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>Comment for the tag</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>report</name>
      <summary>
        Report the result belongs to (only when details were requested)
      </summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <summary>UUID of the report the result belongs to</summary>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>
        Task the result applies to (only when details were requested)
      </summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <summary>UUID of the task the result applies to</summary>
          <required>1</required>
        </attrib>
        <e>name</e>
      </pattern>
      <ele>
        <name>name</name>
        <pattern>text</pattern>
        <summary>Name of the task the result applies to</summary>
      </ele>
    </ele>
    <ele>
      <name>host</name>
      <summary>The host the result applies to</summary>
      <pattern>
        <e>asset</e>
        text
      </pattern>
      <ele>
        <name>asset</name>
        <summary>Asset linked to host</summary>
        <pattern>
          <attrib>
            <name>asset_id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
    </ele>
    <ele>
      <name>port</name>
      <summary>The port on the host</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>nvt</name>
      <summary>NVT to which result applies</summary>
      <pattern>
        <attrib>
          <name>oid</name>
          <type>oid</type>
          <required>1</required>
        </attrib>
        <e>name</e>
        <e>type</e>
        <e>family</e>
        <e>cvss_base</e>
        <e>cve</e>
        <e>cpe</e>
        <e>bid</e>
        <e>tags</e>
        <e>cert</e>
        <e>xref</e>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the NVT</summary>
        <pattern><t>name</t></pattern>
      </ele>
      <ele>
        <name>type</name>
        <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>family</name>
        <summary>The family the NVT is in</summary>
        <pattern><t>name</t></pattern>
      </ele>
      <ele>
        <name>cvss_base</name>
        <summary>CVSS base value associated with the NVT</summary>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>cve</name>
        <summary>CVE associated with the NVT</summary>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>cpe</name>
        <summary>The CPE which produced the CVE (for "cve" results)</summary>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>bid</name>
        <summary>BID associated with the NVT</summary>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>tags</name>
        <summary>Tags associated with the NVT</summary>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>cert</name>
        <summary>List of CERT advisories referencing this NVT via CVEs</summary>
        <pattern>
          <any><e>cert_ref</e></any>
        </pattern>
        <ele>
          <name>cert_ref</name>
          <summary>A CERT advisory reference</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <summary>ID of the advisory</summary>
              <type>text</type>
            </attrib>
            <attrib>
              <name>type</name>
              <summary>Type of the advisory (e.g. "DFN-CERT", "CERT-BUND")</summary>
              <type>text</type>
            </attrib>
          </pattern>
        </ele>
      </ele>
      <ele>
        <name>xref</name>
        <summary>XREFs associated with the NVT</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>scan_nvt_version</name>
      <summary>Version of the NVT used in the scan</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>threat</name>
      <pattern><t>threat</t></pattern>
    </ele>
    <ele>
      <name>severity</name>
      <pattern><t>severity</t></pattern>
    </ele>
    <ele>
      <name>qod</name>
      <summary>The quality of detection (QoD) of the result</summary>
      <pattern>
        <e>value</e>
        <e>type</e>
      </pattern>
      <ele>
        <name>value</name>
        <summary>The numeric QoD value</summary>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>type</name>
        <summary>The QoD type</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>original_threat</name>
      <summary>Original threat when overridden</summary>
      <pattern><t>threat</t></pattern>
    </ele>
    <ele>
      <name>original_severity</name>
      <summary>Original severity when overridden</summary>
      <pattern><t>severity</t></pattern>
    </ele>
    <ele>
      <name>description</name>
      <summary>Description of the result</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>delta</name>
      <summary>Delta state</summary>
      <pattern>
        <o><e>result</e></o>
        <o><e>diff</e></o>
        <o><e>notes</e></o>
        <o><e>overrides</e></o>
        text
      </pattern>
      <ele>
        <name>result</name>
        <summary>Delta result</summary>
        <type>result</type>
      </ele>
      <ele>
        <name>diff</name>
        <summary>Comparison between descriptions</summary>
        <type>text</type>
      </ele>
      <ele>
        <name>notes</name>
        <summary>List of notes on the result</summary>
        <pattern>
          <any><e>note</e></any>
        </pattern>
        <ele>
          <name>note</name>
          <type>note</type>
        </ele>
      </ele>
      <ele>
        <name>overrides</name>
        <name>overrides</name>
        <summary>List of overrides on the result</summary>
        <pattern>
          <any><e>override</e></any>
        </pattern>
        <ele>
          <name>override</name>
          <type>override</type>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>details</name>
      <summary>Any details associated with the result</summary>
      <pattern>
        <any><e>detail</e></any>
      </pattern>
      <ele>
        <name>detail</name>
        <summary>A detail associated with the result</summary>
        <pattern>
          <e>name</e>
          <e>value</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the detail</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <summary>The value of the detail</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>detection</name>
      <summary>Detection details</summary>
      <pattern><e>result</e></pattern>
      <ele>
        <name>result</name>
        <summary>Detection result</summary>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of the detection result</summary>
            <required>1</required>
            <type>uuid</type>
          </attrib>
          <e>details</e>
        </pattern>
        <ele>
          <name>details</name>
          <pattern>
            <any><e>detail</e></any>
          </pattern>
          <ele>
            <name>detail</name>
            <summary>A detail associated with the detection result</summary>
            <pattern>
              <e>name</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the detail</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The value of the detail</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>notes</name>
      <summary>List of notes on the result</summary>
      <pattern>
        <any><e>note</e></any>
      </pattern>
      <ele>
        <name>note</name>
        <type>note</type>
      </ele>
    </ele>
    <ele>
      <name>overrides</name>
      <name>overrides</name>
      <summary>List of overrides on the result</summary>
      <pattern>
        <any><e>override</e></any>
      </pattern>
      <ele>
        <name>override</name>
        <type>override</type>
      </ele>
    </ele>
  </element>
  <element>
    <name>report</name>
    <summary>Actually attributes and either base64 or a report</summary>
    <pattern>
      <attrib>
        <name>id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>format_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>extension</name>
        <type>text</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>content_type</name>
        <type>text</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>type</name>
        <type>
          <alts>
            <alt>scan</alt>
            <alt>assets</alt>
            <alt>prognostic</alt>
          </alts>
        </type>
      </attrib>
      <t>base64</t>
      <e>owner</e>
      <e>name</e>
      <e>comment</e>
      <e>creation_time</e>
      <e>modification_time</e>
      <e>writable</e>
      <e>in_use</e>
      <e>task</e>
      <e>report_format</e>
      <e>report</e>
    </pattern>
    <ele>
      <name>owner</name>
      <summary>Owner of the report</summary>
      <pattern>
        <e>name</e>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the owner</summary>
        <pattern><t>name</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>name</name>
      <summary>Creation time as compatibility placeholder</summary>
      <pattern></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>The comment on the report</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>creation_time</name>
      <summary>Date and time the report was created</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>modification_time</name>
      <summary>Date and time the report was last modified</summary>
      <pattern><t>iso_time</t></pattern>
    </ele>
    <ele>
      <name>in_use</name>
      <summary>Whether the report is in use</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>writable</name>
      <summary>Whether the report is writable</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>The task the report belongs to</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <e>name</e>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the task</summary>
        <pattern><t>name</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>report_format</name>
      <summary>The report format used</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <e>name</e>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the report format</summary>
        <pattern><t>name</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>report</name>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <attrib>
          <name>type</name>
          <type>
            <alts>
              <alt>scan</alt>
              <alt>assets</alt>
              <alt>prognostic</alt>
            </alts>
          </type>
        </attrib>
        <e>omp</e>
        <e>report_format</e>
        <e>sort</e>
        <e>filters</e>
        <e>severity_class</e>
        <o><e>delta</e></o>
        <o>
          <g>
            <e>timezone</e>
            <e>timezone_abbrev</e>
            <e>permissions</e>
            <e>user_tags</e>
            <e>scan_run_status</e>
            <e>result_count</e>
            <e>severity</e>
            <o><e>host_count</e></o>
            <e>task</e>
            <e>scan</e>
            <e>ports</e>
            <e>results</e>
            <e>hosts</e>
            <e>closed_cves</e>
            <e>vulns</e>
            <e>os</e>
            <e>apps</e>
            <e>ssl_certs</e>
            <any><e>host</e></any>
            <e>timestamp</e>
            <e>scan_start</e>
            <any><e>host_start</e></any>
            <any><e>host_end</e></any>
            <e>scan_end</e>
            <e>errors</e>
          </g>
        </o>
      </pattern>
      <ele>
        <name>omp</name>
        <summary>Information of the OMP server</summary>
        <pattern>
          <e>version</e>
        </pattern>
        <ele>
          <name>version</name>
          <summary>The OMP version</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </ele>
      <ele>
        <name>report_format</name>
        <pattern>
          <e>param</e>
        </pattern>
        <ele>
          <name>param</name>
          <summary>Report format parameter</summary>
          <pattern>
            <e>name</e>
            <e>value</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>Parameter name</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>value</name>
            <summary>Parameter value</summary>
            <pattern>
              text
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>delta</name>
        <pattern>
          <e>report</e>
        </pattern>
        <ele>
          <name>report</name>
          <summary>Second report, for delta reports</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>scan_run_status</e>
            <e>timestamp</e>
            <e>scan_start</e>
            <e>scan_end</e>
          </pattern>
          <ele>
            <name>scan_run_status</name>
            <summary>Run status of task scan at time of report</summary>
            <pattern><t>task_status</t></pattern>
          </ele>
          <ele>
            <name>timestamp</name>
            <summary>The time the scan was requested</summary>
            <pattern><t>iso_time</t></pattern>
          </ele>
          <ele>
            <name>scan_start</name>
            <summary>Start time of scan</summary>
            <pattern><t>iso_time</t></pattern>
          </ele>
          <ele>
            <name>scan_end</name>
            <summary>End time of scan</summary>
            <pattern><t>iso_time</t></pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <summary>Result sorting information</summary>
        <pattern>
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <summary>Sort field</summary>
          <pattern>
            text
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <summary>Sort order of field</summary>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <summary>Result filtering information</summary>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>Filter used if any, else 0</summary>
            <type>uuid</type>
          </attrib>
          <t>levels</t>
          <e>term</e>
          <e>phrase</e>
          <e>notes</e>
          <e>overrides</e>
          <e>apply_overrides</e>
          <e>result_hosts_only</e>
          <e>min_qod</e>
          <e>autofp</e>
          <any><e>filter</e></any>
          <o><e>host</e></o>
          <o><e>delta</e></o>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>
            <t>text</t>
          </pattern>
        </ele>
        <ele>
          <name>phrase</name>
          <summary>Search phrase</summary>
          <pattern>
            <t>text</t>
          </pattern>
        </ele>
        <ele>
          <name>notes</name>
          <summary>Whether notes are included</summary>
          <pattern>
            <t><alts><alt>0</alt><alt>1</alt></alts></t>
          </pattern>
        </ele>
        <ele>
          <name>overrides</name>
          <summary>Whether overrides are included</summary>
          <pattern>
            <t><alts><alt>0</alt><alt>1</alt></alts></t>
          </pattern>
        </ele>
        <ele>
          <name>apply_overrides</name>
          <summary>Whether overrides are applied</summary>
          <pattern>
            <t><alts><alt>0</alt><alt>1</alt></alts></t>
          </pattern>
        </ele>
        <ele>
          <name>result_hosts_only</name>
          <summary>
            Whether only those hosts that have results are included
          </summary>
          <pattern>
            <t><alts><alt>0</alt><alt>1</alt></alts></t>
          </pattern>
        </ele>
        <ele>
          <name>min_qod</name>
          <summary>Minimum QoD if in effect, else empty string</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>autofp</name>
          <summary>
            Whether to trust vendor security updates.  1 full match, 2 partial
          </summary>
          <pattern>xsd:token { pattern = "0|1|2" }</pattern>
        </ele>
        <ele>
          <name>filter</name>
          <summary>Level filter</summary>
          <pattern>
            <t>
              <alts>
                <alt>High</alt>
                <alt>Medium</alt>
                <alt>Low</alt>
                <alt>Log</alt>
                <alt>Debug</alt>
              </alts>
            </t>
          </pattern>
        </ele>
        <ele>
          <name>host</name>
          <pattern><e>ip</e></pattern>
          <ele>
            <name>ip</name>
            <summary>
              IP of single host in report (for "delta" and "prognostic")
            </summary>
            <pattern>text</pattern>
          </ele>
        </ele>
        <ele>
          <name>delta</name>
          <summary>Delta states</summary>
          <pattern>
            text
            <e>changed</e>
            <e>gone</e>
            <e>new</e>
            <e>same</e>
          </pattern>
          <ele>
            <name>changed</name>
            <summary>Whether changed results are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>gone</name>
            <summary>Whether results that have vanished are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>new</name>
            <summary>Whether new results are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>same</name>
            <summary>Whether results that are equal are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>timezone</name>
        <summary>Name of timezone used for dates</summary>
        <pattern>
          timezone
        </pattern>
      </ele>
      <ele>
        <name>timezone_abbrev</name>
        <summary>Abbreviation used for timezone</summary>
        <pattern>
          text
        </pattern>
      </ele>
      <ele>
        <name>permissions</name>
        <summary>Permissions that the current user has on the report</summary>
        <pattern>
          <any><e>permission</e></any>
        </pattern>
        <ele>
          <name>permission</name>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the permission</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>user_tags</name>
        <summary>Info on tags attached to the report</summary>
        <pattern>
          <e>count</e>
          <any><e>tag</e></any>
        </pattern>
        <ele>
          <name>count</name>
          <summary>Number of attached tags</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>tag</name>
          <summary>
            Short info on an individual tag
            (only if details were requested)
          </summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <summary>UUID of the tag</summary>
              <required>1</required>
            </attrib>
            <e>name</e>
            <e>value</e>
            <e>comment</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>Name of the tag (usually namespace:predicate)</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>value</name>
            <summary>Value of the tag</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>comment</name>
            <summary>Comment for the tag</summary>
            <pattern>text</pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>scan_run_status</name>
        <summary>Run status of task scan at time of report</summary>
        <pattern><t>task_status</t></pattern>
      </ele>
      <ele>
        <name>result_count</name>
        <summary>Counts of results produced by scan</summary>
        <description>
          <p>
            The text contains the full count -- the total number of results
            produced by scan.
          </p>
        </description>
        <pattern>
          text
          <e>full</e>
          <e>filtered</e>
          <e>debug</e>
          <e>hole</e>
          <e>info</e>
          <e>log</e>
          <e>warning</e>
        </pattern>
        <ele>
          <name>full</name>
          <summary>Total number of results produced by scan</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>filtered</name>
          <summary>Number of results after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>debug</name>
          <summary>
            Number of "debug" results (threat level Debug)
          </summary>
          <pattern>
            <e>full</e>
            <e>filtered</e>
          </pattern>
          <ele>
            <name>full</name>
            <summary>Total number of results</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>filtered</name>
            <summary>Number of results after filtering</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>hole</name>
          <summary>
            Number of "hole" results (threat level High)
          </summary>
          <pattern>
            <e>full</e>
            <e>filtered</e>
          </pattern>
          <ele>
            <name>full</name>
            <summary>Total number of results</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>filtered</name>
            <summary>Number of results after filtering</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>info</name>
          <summary>
            Number of "info" results (threat level Low)
          </summary>
          <pattern>
            <e>full</e>
            <e>filtered</e>
          </pattern>
          <ele>
            <name>full</name>
            <summary>Total number of results</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>filtered</name>
            <summary>Number of results after filtering</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>log</name>
          <summary>
            Number of "log" results (threat level Log)
          </summary>
          <pattern>
            <e>full</e>
            <e>filtered</e>
          </pattern>
          <ele>
            <name>full</name>
            <summary>Total number of results</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>filtered</name>
            <summary>Number of results after filtering</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>warning</name>
          <summary>
            Number of "warning" results (threat level Medium)
          </summary>
          <pattern>
            <e>full</e>
            <e>filtered</e>
          </pattern>
          <ele>
            <name>full</name>
            <summary>Total number of results</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>filtered</name>
            <summary>Number of results after filtering</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>severity</name>
        <pattern>
          <e>full</e>
          <e>filtered</e>
        </pattern>
        <ele>
          <name>full</name>
          <pattern><t>severity</t></pattern>
          <summary>Maximum severity of the full report</summary>
        </ele>
        <ele>
          <name>filtered</name>
          <pattern><t>severity</t></pattern>
          <summary>Maximum severity of the report after filtering</summary>
        </ele>
      </ele>
      <ele>
        <name>severity_class</name>
        <pattern>
          <e>name</e>
          <e>full_name</e>
          <any><e>severity_range</e></any>
        </pattern>
        <ele>
          <name>name</name>
          <pattern>
            <alts>
              <alt>nist</alt>
              <alt>classic</alt>
              <alt>pci-dss</alt>
            </alts>
          </pattern>
          <summary>Short severity class name</summary>
        </ele>
        <ele>
          <name>full_name</name>
          <pattern>text</pattern>
          <summary>Full severity class name</summary>
        </ele>
        <ele>
          <name>severity_range</name>
          <summary>Severity range</summary>
          <pattern>
            <e>name</e>
            <e>min</e>
            <e>max</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>Name of severity range</summary>
            <pattern>
              <t>name</t>
            </pattern>
          </ele>
          <ele>
            <name>min</name>
            <summary>Minimum CVSS value</summary>
            <pattern>
              <t>integer</t>
            </pattern>
          </ele>
          <ele>
            <name>max</name>
            <summary>Maximum CVSS value</summary>
            <pattern>
              <t>integer</t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>host_count</name>
        <summary>Counts of hosts in the results</summary>
        <description>
          <p>
            This is only present in the "assets" report.
          </p>
        </description>
        <pattern>
          <e>full</e>
          <e>filtered</e>
        </pattern>
        <ele>
          <name>full</name>
          <summary>Total number of hosts</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>filtered</name>
          <summary>Number of hosts after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
      <ele>
        <name>task</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>name</e>
          <e>comment</e>
          <e>target</e>
          <e>progress</e>
          <e>user_tags</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the task</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>Comment for the task</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>target</name>
          <summary>The target of the task</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <summary>The UUID of the target</summary>
            </attrib>
            <e>trash</e>
          </pattern>
          <ele>
            <name>trash</name>
            <summary>Whether the target is in the trashcan</summary>
            <type>boolean</type>
          </ele>
        </ele>
        <ele>
          <name>progress</name>
          <summary>The percentage of the task that is complete</summary>
          <pattern>
            <t>integer</t>
          </pattern>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the task</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>scan</name>
        <summary>Info from scan time</summary>
        <pattern>
          <e>task</e>
        </pattern>
        <ele>
          <name>task</name>
          <pattern>
            <e>slave</e>
            <e>preferences</e>
          </pattern>
          <ele>
            <name>slave</name>
            <summary>The task slave</summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>host</e>
              <e>port</e>
            </pattern>
            <ele>
              <name>name</name>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>host</name>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>port</name>
              <pattern>text</pattern>
            </ele>
          </ele>
          <ele>
            <name>preferences</name>
            <summary>Currently only "source_iface"</summary>
            <pattern>
              <any><e>preference</e></any>
            </pattern>
            <ele>
              <name>preference</name>
              <pattern>
                <e>name</e>
                <e>scanner_name</e>
                <e>value</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>Full name of preference, suitable for end users</summary>
                <pattern>text</pattern>
              </ele>
              <ele>
                <name>scanner_name</name>
                <summary>Compact name of preference, from scanner</summary>
                <pattern>text</pattern>
              </ele>
              <ele>
                <name>value</name>
                <pattern>text</pattern>
              </ele>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>ports</name>
        <pattern>
          <attrib>
            <name>start</name>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <any><e>port</e></any>
        </pattern>
        <ele>
          <name>port</name>
          <pattern>
            text
            <e>host</e>
            <e>severity</e>
            <e>threat</e>
          </pattern>
          <ele>
            <name>host</name>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>severity</name>
            <pattern><t>severity</t></pattern>
          </ele>
          <ele>
            <name>threat</name>
            <pattern><t>threat</t></pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>results</name>
        <pattern>
          <attrib>
            <name>start</name>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <any><e>result</e></any>
        </pattern>
        <ele>
          <name>result</name>
          <summary>A result</summary>
          <type>result</type>
        </ele>
      </ele>
      <ele>
        <name>hosts</name>
        <description>
          <p>
            Analogous to the results element, but for hosts, in the "assets"
            report.  However to keep backward compatibility the host elements
            are siblings of this element, instead of children.
          </p>
          <p>
            Contains only the count outside the "assets" report.
          </p>
        </description>
        <pattern>
          <or>
            <g>
              <attrib>
                <name>start</name>
                <type>integer</type>
                <required>1</required>
              </attrib>
              <attrib>
                <name>max</name>
                <type>integer</type>
                <required>1</required>
              </attrib>
            </g>
            <e>count</e>
          </or>
        </pattern>
        <ele>
          <name>count</name>
          <summary>Number of hosts</summary>
        </ele>
      </ele>
      <ele>
        <name>closed_cves</name>
        <summary></summary>
        <pattern>
          <e>count</e>
        </pattern>
        <ele>
          <name>count</name>
          <summary>The number of closed CVEs</summary>
        </ele>
      </ele>
      <ele>
        <name>vulns</name>
        <summary></summary>
        <pattern>
          <e>count</e>
        </pattern>
        <ele>
          <name>count</name>
          <summary>The number of Vulnerabilities</summary>
        </ele>
      </ele>
      <ele>
        <name>os</name>
        <summary></summary>
        <pattern>
          <e>count</e>
        </pattern>
        <ele>
          <name>count</name>
          <summary>The number of operating systems</summary>
        </ele>
      </ele>
      <ele>
        <name>apps</name>
        <summary></summary>
        <pattern>
          <e>count</e>
        </pattern>
        <ele>
          <name>count</name>
          <summary>The number of Applications</summary>
        </ele>
      </ele>
      <ele>
        <name>ssl_certs</name>
        <summary></summary>
        <pattern>
          <e>count</e>
        </pattern>
        <ele>
          <name>count</name>
          <summary>The number of SSL certificates</summary>
        </ele>
      </ele>
      <ele>
        <name>host</name>
        <pattern>
          <e>ip</e>
          <e>asset</e>
          <e>start</e>
          <e>end</e>
          <e>port_count</e>
          <e>result_count</e>
          <any><e>detail</e></any>
        </pattern>
        <ele>
          <name>ip</name>
          <summary>IP of the host</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>asset</name>
          <summary>Asset linked to host</summary>
          <pattern>
            <attrib>
              <name>asset_id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
          </pattern>
        </ele>
        <ele>
          <name>start</name>
          <summary>Scan start time for this host</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>end</name>
          <summary>Scan end time for this host</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>port_count</name>
          <summary></summary>
          <pattern>
            <e>page</e>
          </pattern>
          <ele>
            <name>page</name>
            <summary>Number of ports of current host on current page</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>result_count</name>
          <summary></summary>
          <pattern>
            <e>page</e>
            <e>hole</e>
            <e>warning</e>
            <e>info</e>
            <e>log</e>
            <e>false_positive</e>
          </pattern>
          <ele>
            <name>page</name>
            <summary>Total number of results for current host on current page</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>hole</name>
            <summary>Number of "hole" results (level "High")</summary>
            <pattern>
              <e>page</e>
            </pattern>
            <ele>
              <name>page</name>
              <summary>Number of results on current page</summary>
              <pattern><t>integer</t></pattern>
            </ele>
          </ele>
          <ele>
            <name>warning</name>
            <summary>Number of "warning" results (level "Medium")</summary>
            <pattern>
              <e>page</e>
            </pattern>
            <ele>
              <name>page</name>
              <summary>Number of results on current page</summary>
              <pattern><t>integer</t></pattern>
            </ele>
          </ele>
          <ele>
            <name>info</name>
            <summary>Number of "info" results (level "Low")</summary>
            <pattern>
              <e>page</e>
            </pattern>
            <ele>
              <name>page</name>
              <summary>Number of results on current page</summary>
              <pattern><t>integer</t></pattern>
            </ele>
          </ele>
          <ele>
            <name>log</name>
            <summary>Number of "log" results</summary>
            <pattern>
              <e>page</e>
            </pattern>
            <ele>
              <name>page</name>
              <summary>Number of results on current page</summary>
              <pattern><t>integer</t></pattern>
            </ele>
          </ele>
          <ele>
            <name>false_positive</name>
            <summary>Number of "false positive" results</summary>
            <pattern>
              <e>page</e>
            </pattern>
            <ele>
              <name>page</name>
              <summary>Number of results on current page</summary>
              <pattern><t>integer</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>detail</name>
          <summary>A detail associated with the host</summary>
          <pattern>
            <e>name</e>
            <e>value</e>
            <e>source</e>
            <e>extra</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the detail</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>value</name>
            <summary>The value of the detail</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>source</name>
            <summary>Where the detail comes from</summary>
            <pattern>
              <e>type</e>
              <e>name</e>
              <e>description</e>
            </pattern>
            <ele>
              <name>type</name>
              <summary>The type of the detail source</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>name</name>
              <summary>The name of the detail source</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>description</name>
              <summary>A description of the detail source</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
          <ele>
            <name>extra</name>
            <summary>Extra info (NVT CVSS for closed CVE results)</summary>
            <pattern>text</pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>timestamp</name>
        <summary>The time the scan was requested</summary>
        <pattern><t>iso_time</t></pattern>
      </ele>
      <ele>
        <name>scan_start</name>
        <summary>Start time of scan</summary>
        <pattern><t>iso_time</t></pattern>
      </ele>
      <ele>
        <name>host_start</name>
        <summary>Start time of a particular host</summary>
        <pattern>
          <t>iso_time</t>
          <e>host</e>
        </pattern>
        <ele>
          <name>host</name>
          <pattern>text</pattern>
        </ele>
      </ele>
      <ele>
        <name>host_end</name>
        <summary>End time of a particular host</summary>
        <pattern>
          <t>iso_time</t>
          <e>host</e>
        </pattern>
        <ele>
          <name>host</name>
          <pattern>text</pattern>
        </ele>
      </ele>
      <ele>
        <name>scan_end</name>
        <summary>End time of scan</summary>
        <pattern><t>iso_time</t></pattern>
      </ele>
      <ele>
        <name>errors</name>
        <pattern>
          <e>count</e>
          <any><e>error</e></any>
        </pattern>
        <ele>
          <name>count</name>
          <summary>The number of error messages</summary>
        </ele>
        <ele>
          <name>error</name>
          <summary>An error message</summary>
          <pattern>
            <e>host</e>
            <e>port</e>
            <e>description</e>
            <e>nvt</e>
            <e>scan_nvt_version</e>
            <e>severity</e>
          </pattern>
          <ele>
            <name>host</name>
            <summary>The host of the error message</summary>
            <pattern>
              <e>asset</e>
              text
            </pattern>
            <ele>
              <name>asset</name>
              <summary>Asset linked to host</summary>
              <pattern>
                <attrib>
                  <name>asset_id</name>
                  <type>uuid</type>
                  <required>1</required>
                </attrib>
              </pattern>
            </ele>
          </ele>
          <ele>
            <name>port</name>
            <summary>The port of the error message</summary>
            <pattern><t>port</t></pattern>
          </ele>
          <ele>
            <name>description</name>
            <summary>The description of the error message</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>nvt</name>
            <summary>The NVT that generated the error message</summary>
            <pattern>
              <attrib>
                <name>oid</name>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>type</e>
              <e>cvss_base</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the NVT</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>type</name>
              <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>cvss_base</name>
              <summary>The base CVSS score of the NVT</summary>
              <pattern><t>severity</t></pattern>
            </ele>
          </ele>
          <ele>
            <name>scan_nvt_version</name>
            <summary>The NVT version that generated the error</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>severity</name>
            <summary>The severity score of the error message</summary>
            <pattern><t>severity</t></pattern>
          </ele>
        </ele>
      </ele>
    </ele>
  </element>

  <!-- Commands. -->

  <command>
    <name>authenticate</name>
    <summary>Authenticate with the manager</summary>
    <description>
      <p>
        The client uses the authenticate command to authenticate with the
        Manager.
      </p>
      <p>
        The client normally executes this command at the beginning of each
        connection.  The only commands permitted before authentication are
        get_version and commands.
      </p>
    </description>
    <pattern>
      <e>credentials</e>
    </pattern>
    <ele>
      <name>credentials</name>
      <pattern>
        <e>username</e>
        <e>password</e>
      </pattern>
      <ele>
        <name>username</name>
        <summary>The login name of the user</summary>
        <pattern>
          text
        </pattern>
      </ele>
      <ele>
        <name>password</name>
        <summary>The user's password</summary>
        <pattern>
          text
        </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>
        <e>role</e>
        <e>timezone</e>
      </pattern>
      <ele>
        <name>role</name>
        <summary>The user's role</summary>
        <type>
          <alts>
            <alt>User</alt>
            <alt>Admin</alt>
            <alt>Super Admin</alt>
            <alt>Observer</alt>
          </alts>
        </type>
      </ele>
      <ele>
        <name>timezone</name>
        <summary>The user's timezone</summary>
        <pattern>
          timezone
        </pattern>
      </ele>
    </response>
    <example>
      <summary>Authenticate with a good password</summary>
      <request>
        <authenticate>
          <credentials>
            <username>sally</username>
            <password>secret</password>
          </credentials>
        </authenticate>
      </request>
      <response>
        <authenticate_response status="200" status_text="OK">
          <role>User</role>
          <timezone>UTC</timezone>
        </authenticate_response>
      </response>
    </example>
    <example>
      <summary>Authenticate with a bad password</summary>
      <request>
        <authenticate>
          <credentials>
            <username>sally</username>
            <password>secrte</password>
          </credentials>
        </authenticate>
      </request>
      <response>
        <authenticate_response status="400"
                               status_text="Authentication failed"/>
      </response>
    </example>
  </command>
  <command>
    <name>commands</name>
    <summary>Run a list of commands</summary>
    <description>
      The client uses the commands command to run a list of commands.  The
      elements are executed as OMP commands in the given sequence.  The reply
      contains the result of each command, in the same order as the given
      commands.
    </description>
    <pattern>
      <any>
        <or>
          <c>authenticate</c>
          <c>commands</c>
          <c>create_agent</c>
          <c>create_alert</c>
          <c>create_asset</c>
          <c>create_config</c>
          <c>create_credential</c>
          <c>create_filter</c>
          <c>create_group</c>
          <c>create_note</c>
          <c>create_override</c>
          <c>create_permission</c>
          <c>create_port_list</c>
          <c>create_port_range</c>
          <c>create_report_format</c>
          <c>create_role</c>
          <c>create_scanner</c>
          <c>create_schedule</c>
          <c>create_tag</c>
          <c>create_target</c>
          <c>create_task</c>
          <c>create_user</c>
          <c>delete_agent</c>
          <c>delete_alert</c>
          <c>delete_asset</c>
          <c>delete_config</c>
          <c>delete_credential</c>
          <c>delete_filter</c>
          <c>delete_group</c>
          <c>delete_note</c>
          <c>delete_override</c>
          <c>delete_permission</c>
          <c>delete_report</c>
          <c>delete_report_format</c>
          <c>delete_role</c>
          <c>delete_port_list</c>
          <c>delete_port_range</c>
          <c>delete_scanner</c>
          <c>delete_schedule</c>
          <c>delete_tag</c>
          <c>delete_target</c>
          <c>delete_task</c>
          <c>delete_user</c>
          <c>describe_auth</c>
          <c>empty_trashcan</c>
          <c>get_agents</c>
          <c>get_alerts</c>
          <c>get_assets</c>
          <c>get_configs</c>
          <c>get_credentials</c>
          <c>get_feeds</c>
          <c>get_filters</c>
          <c>get_groups</c>
          <c>get_info</c>
          <c>get_notes</c>
          <c>get_nvts</c>
          <c>get_nvt_families</c>
          <c>get_overrides</c>
          <c>get_permissions</c>
          <c>get_port_lists</c>
          <c>get_preferences</c>
          <c>get_reports</c>
          <c>get_report_formats</c>
          <c>get_results</c>
          <c>get_roles</c>
          <c>get_scanners</c>
          <c>get_schedules</c>
          <c>get_settings</c>
          <c>get_system_reports</c>
          <c>get_tags</c>
          <c>get_targets</c>
          <c>get_tasks</c>
          <c>get_users</c>
          <c>get_version</c>
          <c>help</c>
          <c>modify_agent</c>
          <c>modify_alert</c>
          <c>modify_asset</c>
          <c>modify_auth</c>
          <c>modify_config</c>
          <c>modify_credential</c>
          <c>modify_filter</c>
          <c>modify_group</c>
          <c>modify_note</c>
          <c>modify_override</c>
          <c>modify_permission</c>
          <c>modify_port_list</c>
          <c>modify_report</c>
          <c>modify_report_format</c>
          <c>modify_role</c>
          <c>modify_scanner</c>
          <c>modify_schedule</c>
          <c>modify_setting</c>
          <c>modify_tag</c>
          <c>modify_target</c>
          <c>modify_task</c>
          <c>modify_user</c>
          <c>restore</c>
          <c>resume_task</c>
          <c>run_wizard</c>
          <c>start_task</c>
          <c>stop_task</c>
          <c>sync_feed</c>
          <c>sync_config</c>
          <c>sync_scap</c>
          <c>sync_cert</c>
          <c>test_alert</c>
          <c>verify_agent</c>
          <c>verify_report_format</c>
          <c>verify_scanner</c>
        </or>
      </any>
    </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>
          <or>
            <r>authenticate</r>
            <r>commands</r>
            <r>create_agent</r>
            <r>create_alert</r>
            <r>create_asset</r>
            <r>create_config</r>
            <r>create_credential</r>
            <r>create_filter</r>
            <r>create_group</r>
            <r>create_note</r>
            <r>create_override</r>
            <r>create_permission</r>
            <r>create_port_list</r>
            <r>create_port_range</r>
            <r>create_role</r>
            <r>create_scanner</r>
            <r>create_schedule</r>
            <r>create_tag</r>
            <r>create_target</r>
            <r>create_task</r>
            <r>create_user</r>
            <r>delete_agent</r>
            <r>delete_alert</r>
            <r>delete_asset</r>
            <r>delete_config</r>
            <r>delete_credential</r>
            <r>delete_filter</r>
            <r>delete_group</r>
            <r>delete_note</r>
            <r>delete_override</r>
            <r>delete_permission</r>
            <r>delete_port_list</r>
            <r>delete_port_range</r>
            <r>delete_report</r>
            <r>delete_report_format</r>
            <r>delete_role</r>
            <r>delete_scanner</r>
            <r>delete_schedule</r>
            <r>delete_tag</r>
            <r>delete_target</r>
            <r>delete_task</r>
            <r>delete_user</r>
            <r>describe_auth</r>
            <r>empty_trashcan</r>
            <r>get_agents</r>
            <r>get_alerts</r>
            <r>get_assets</r>
            <r>get_configs</r>
            <r>get_credentials</r>
            <r>get_groups</r>
            <r>get_info</r>
            <r>get_feeds</r>
            <r>get_filters</r>
            <r>get_notes</r>
            <r>get_nvts</r>
            <r>get_nvt_families</r>
            <r>get_overrides</r>
            <r>get_permissions</r>
            <r>get_port_lists</r>
            <r>get_preferences</r>
            <r>get_reports</r>
            <r>get_report_formats</r>
            <r>get_results</r>
            <r>get_roles</r>
            <r>get_scanners</r>
            <r>get_schedules</r>
            <r>get_settings</r>
            <r>get_system_reports</r>
            <r>get_tags</r>
            <r>get_targets</r>
            <r>get_tasks</r>
            <r>get_users</r>
            <r>get_version</r>
            <r>help</r>
            <r>modify_agent</r>
            <r>modify_alert</r>
            <r>modify_asset</r>
            <r>modify_auth</r>
            <r>modify_config</r>
            <r>modify_credential</r>
            <r>modify_filter</r>
            <r>modify_group</r>
            <r>modify_note</r>
            <r>modify_override</r>
            <r>modify_permission</r>
            <r>modify_port_list</r>
            <r>modify_report</r>
            <r>modify_report_format</r>
            <r>modify_role</r>
            <r>modify_scanner</r>
            <r>modify_schedule</r>
            <r>modify_setting</r>
            <r>modify_tag</r>
            <r>modify_target</r>
            <r>modify_task</r>
            <r>modify_user</r>
            <r>restore</r>
            <r>resume_task</r>
            <r>run_wizard</r>
            <r>start_task</r>
            <r>stop_task</r>
            <r>sync_feed</r>
            <r>sync_config</r>
            <r>sync_scap</r>
            <r>sync_cert</r>
            <r>test_alert</r>
            <r>verify_agent</r>
            <r>verify_report_format</r>
            <r>verify_scanner</r>
          </or>
        </any>
      </pattern>
    </response>
  </command>
  <command>
    <name>create_agent</name>
    <summary>Create an agent</summary>
    <description>
      <p>
        The client uses the create_agent command to create a new agent.
      </p>
    </description>
    <pattern>
      <e>installer</e>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>howto_install</e></o>
      <o><e>howto_use</e></o>
    </pattern>
    <ele>
      <name>installer</name>
      <summary>A file that installs the agent on a target machine</summary>
      <pattern>
        <t>base64</t>
        <e>signature</e>
      </pattern>
      <ele>
        <name>signature</name>
        <summary>A detached OpenPGP signature of the installer</summary>
        <pattern><t>base64</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>name</name>
      <summary>A name for the installer</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the agent</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing agent</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>howto_install</name>
      <summary>A file that describes how to install the agent</summary>
      <pattern>
        <t>base64</t>
      </pattern>
    </ele>
    <ele>
      <name>howto_use</name>
      <summary>A file that describes how to use the agent</summary>
      <pattern>
        <t>base64</t>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create an agent</summary>
      <request>
        <create_agent>
          <installer>
            asdf3235saf3kjBVF...
            <signature>iEYEABECAAYFA...</signature>
          </installer>
          <name>SLAD</name>
        </create_agent>
      </request>
      <response>
        <create_agent_response status="201" status_text="OK, resource created"
                               id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_agent_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_alert</name>
    <summary>Create an alert</summary>
    <description>
      <p>
        The client uses the create_alert command to create a new
        alert.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <e>condition</e>
      <e>event</e>
      <e>method</e>
      <e>filter</e>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the alert</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the alert</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing alert</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>condition</name>
      <summary>
        The condition that must be satisfied for the alert to occur
      </summary>
      <pattern>
        text
        <any><e>data</e></any>
      </pattern>
      <ele>
        <name>data</name>
        <summary>Some data that defines the condition</summary>
        <pattern>
          text
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the condition data</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>event</name>
      <summary>
        The event that must happen for the alert to occur
      </summary>
      <pattern>
        text
        <any><e>data</e></any>
      </pattern>
      <ele>
        <name>data</name>
        <summary>Some data that defines the event</summary>
        <pattern>
          text
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the event data</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>method</name>
      <summary>The method by which the user is alerted</summary>
      <pattern>
        text
        <any><e>data</e></any>
      </pattern>
      <ele>
        <name>data</name>
        <summary>Some data that defines the method</summary>
        <pattern>
          text
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the method data</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>filter</name>
      <summary>Filter to apply when executing alert</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create an alert</summary>
      <request>
        <create_alert>
          <name>emergency</name>
          <condition>
            Severity at least
            <data>
              <name>severity</name>
              5.5
            </data>
          </condition>
          <event>
            Task run status changed
            <data>
              <name>status</name>
              Done
            </data>
          </event>
          <method>
            Email
            <data>
              <name>to_address</name>
              sally@example.org
            </data>
            <data>
              <name>from_address</name>
              bob@example.org
            </data>
          </method>
        </create_alert>
      </request>
      <response>
        <create_alert_response status="201"
                               status_text="OK, resource created"
                               id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_alert_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_asset</name>
    <summary>Create an asset</summary>
    <description>
      <p>
        The client uses the create_asset command to create a new asset.
      </p>
    </description>
    <pattern>
      <or>
        <e>asset</e>
        <e>report</e>
      </or>
    </pattern>
    <ele>
      <name>asset</name>
      <pattern>
        <e>name</e>
        <e>comment</e>
      </pattern>
      <ele>
        <name>name</name>
        <summary>A name for the asset</summary>
        <pattern>
          <t>name</t>
        </pattern>
      </ele>
      <ele>
        <name>comment</name>
        <summary>A comment on the asset</summary>
        <pattern>
          text
        </pattern>
      </ele>
    </ele>
    <ele>
      <name>report</name>
      <summary>Report from which to import assets</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <e>filter</e>
      </pattern>
      <ele>
        <name>filter</name>
        <summary>Filter, for min_qod and apply_overrides</summary>
        <pattern>
          <e>term</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create an asset</summary>
      <request>
        <create_asset>
          <asset>
            <type>host</type>
            <name>Localhost</name>
          </asset>
        </create_asset>
      </request>
      <response>
        <create_asset_response status="201"
                                status_text="OK, resource created"
                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_asset_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_config</name>
    <summary>Create a config</summary>
    <description>
      <p>
        The client uses the create_config command to create a new config.
      </p>
      <l>
        <lh>This command can be called in three ways:</lh>
        <li>
          With a copy element.  The new config is a copy of the existing
          config, with the given name.
        </li>
        <li>
          With an embedded get_configs response element.  The config is
          created as defined by the get_configs response element.  Name is
          actually optional in this case.  The config is given the name of
          the config in the get_configs response.  If there is already a
          config with this name, then a number is attached to the name to
          make it unique.
        </li>
      </l>
    </description>
    <pattern>
      <o><e>comment</e></o>
      <or>
        <e>copy</e>
        <r>get_configs</r>
      </or>
      <e>name</e>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>A comment on the config</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <!-- TODO UUIDs are normally in attributes. -->
      <summary>The UUID of an existing config</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>A name for the config</summary>
      <pattern><t>name</t></pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Copy a config</summary>
      <request>
        <create_config>
          <copy>daba56c8-73ec-11df-a475-002264764cea</copy>
          <name>Full</name>
        </create_config>
      </request>
      <response>
        <create_config_response status="201" status_text="OK, resource created"
                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_config_response>
      </response>
    </example>
    <example>
      <summary>Create a config from a GET_CONFIGS response</summary>
      <request>
        <create_config>
          <get_configs_response>
            <config id="daba56c8-73ec-11df-a475-002264764cea">
              <name>Full and fast</name>
              <truncated>...</truncated>
            </config>
          </get_configs_response>
        </create_config>
      </request>
      <response>
        <create_config_response status="201" status_text="OK, resource created"
                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_config_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_credential</name>
    <summary>Create a credential</summary>
    <description>
      <p>
        The client uses the create_credential command to create a new
        credential for local security checks and other functions
        requiring authentication.
      </p>
      <p>
        If the command includes a key, then the manager creates a key-based
        credential from the key.  If the command includes a password, then
        the manager creates a password only credential.  Otherwise the
        manager autogenerates a key-based credential.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>allow_insecure</e></o>
      <o><e>certificate</e></o>
      <o><e>key</e></o>
      <o><e>login</e></o>
      <o><e>password</e></o>
      <o><e>auth_algorithm</e></o>
      <o><e>community</e></o>
      <o><e>privacy</e></o>
      <o><e>type</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the credential</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the credential</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing credential</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>allow_insecure</name>
      <summary>Whether to allow insecure use of the credential</summary>
      <pattern>
        <t>boolean</t>
      </pattern>
    </ele>
    <ele>
      <name>certificate</name>
      <summary>The certificate of the credential</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>key</name>
      <pattern>
        <e>phrase</e>
        <e>private</e>
      </pattern>
      <ele>
        <name>phrase</name>
        <summary>Key passphrase</summary>
        <pattern>
          text
        </pattern>
      </ele>
      <ele>
        <name>private</name>
        <summary>Private key</summary>
        <pattern>
          text
        </pattern>
      </ele>
    </ele>
    <ele>
      <name>login</name>
      <summary>The user name of the credential</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>password</name>
      <summary>The password for the credential login</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>community</name>
      <summary>The SNMP community</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>auth_algorithm</name>
      <summary>Authentication algorithm for SNMP, either md5 or sha1</summary>
      <pattern>
        <t>
          <alts>
            <alt>md5</alt>
            <alt>sha1</alt>
          </alts>
        </t>
      </pattern>
    </ele>
    <ele>
      <name>privacy</name>
      <pattern>
        <e>algorithm</e>
        <e>password</e>
      </pattern>
      <ele>
        <name>algorithm</name>
        <summary>The SNMP privacy algorithm, either aes or des</summary>
        <pattern>
          <t>
            <alts>
              <alt>aes</alt>
              <alt>des</alt>
            </alts>
          </t>
        </pattern>
      </ele>
      <ele>
        <name>password</name>
        <summary>The SNMP privacy password</summary>
        <pattern>
          text
        </pattern>
      </ele>
    </ele>
    <ele>
      <name>type</name>
      <summary>The type of credential to create</summary>
      <pattern>
        <t>
          <alts>
            <alt>cc</alt>
            <alt>snmp</alt>
            <alt>up</alt>
            <alt>usk</alt>
          </alts>
        </t>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create an LSC credential</summary>
      <request>
        <create_credential>
          <name>cluster sally</name>
          <login>sally</login>
          <password>secret</password>
          <comment>Sally's login to the cluster.</comment>
        </create_credential>
      </request>
      <response>
        <create_credential_response status="201"
                                    status_text="OK, resource created"
                                    id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_credential_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_filter</name>
    <summary>Create a filter</summary>
    <description>
      <p>
        The client uses the create_filter command to create a new filter.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>term</e></o>
      <o><e>type</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the filter</summary>
      <pattern>
        <t>name</t>
        <e>make_unique</e>
      </pattern>
      <ele>
        <name>make_unique</name>
        <summary>
          Whether to append a unique suffix if the name already exists
        </summary>
        <pattern>boolean</pattern>
      </ele>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the filter</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing filter</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>term</name>
      <summary>Filter term</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>type</name>
      <summary>Resource type</summary>
      <pattern>
        text
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a filter</summary>
      <request>
        <create_filter>
          <name>Single Targets</name>
          <comment>Targets with only one host</comment>
          <term>ips=1 first=1 rows=-2</term>
          <type>target</type>
        </create_filter>
      </request>
      <response>
        <create_filter_response status="201" status_text="OK, resource created"
                               id="254cd3ef-bbe1-4d58-859d-21b8d0c046c7">
        </create_filter_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_group</name>
    <summary>Create a group</summary>
    <description>
      <p>
        The client uses the create_group command to create a new
        group.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>specials</e></o>
      <o><e>users</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the group</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the group</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing group</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>specials</name>
      <pattern>
        <e>full</e>
      </pattern>
      <ele>
        <name>full</name>
        <summary>
          Create permission giving members full access to each other's resources
        </summary>
        <pattern></pattern>
      </ele>
    </ele>
    <ele>
      <name>users</name>
      <summary>Comma separated list of user names</summary>
      <pattern>
        text
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a group</summary>
      <request>
        <create_group>
          <name>Managers</name>
          <users>sarah, bob</users>
        </create_group>
      </request>
      <response>
        <create_group_response status="201"
                               status_text="OK, resource created"
                               id="d94211b6-ba40-11e3-bcb1-406186ea4fc5">
        </create_group_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_note</name>
    <summary>Create a note</summary>
    <description>
      <p>
        The client uses the create_note command to create a new note.
      </p>
    </description>
    <pattern>
      <e>text</e>
      <e>nvt</e>
      <o><e>active</e></o>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>hosts</e></o>
      <o><e>port</e></o>
      <o><e>result</e></o>
      <o><e>severity</e></o>
      <o><e>task</e></o>
      <o><e>threat</e></o>
    </pattern>
    <ele>
      <name>text</name>
      <summary>The text of the note</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>nvt</name>
      <summary>NVT to which note applies</summary>
      <pattern>
        <attrib>
          <name>oid</name>
          <type>oid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Seconds note will be active.  -1 on always, 0 off</summary>
      <pattern><t>integer</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the note</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing note</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>A textual list of hosts</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>Port to which note applies</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>result</name>
      <summary>Result to which note applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>severity</name>
      <summary>Severity to which note applies</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>Task to which note applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>threat</name>
      <summary>
        Threat level to which note applies. Will be converted to severity
      </summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a note</summary>
      <request>
        <create_note>
          <text>This issue should be resolved after the upgrade.</text>
          <nvt oid="1.3.6.1.4.1.25623.1.0.10330"></nvt>
          <result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
        </create_note>
      </request>
      <response>
        <create_note_response status="202"
                              status_text="OK, resource created"
                              id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_note_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_override</name>
    <summary>Create an override</summary>
    <description>
      <p>
        The client uses the create_override command to create a new override.
      </p>
    </description>
    <pattern>
      <e>text</e>
      <e>nvt</e>
      <o><e>active</e></o>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>hosts</e></o>
      <o><e>new_severity</e></o>
      <o><e>new_threat</e></o>
      <o><e>port</e></o>
      <o><e>result</e></o>
      <o><e>severity</e></o>
      <o><e>task</e></o>
      <o><e>threat</e></o>
    </pattern>
    <ele>
      <name>text</name>
      <summary>The text of the override</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Seconds override will be active.  -1 on always, 0 off</summary>
      <pattern><t>integer</t></pattern>
    </ele>
    <ele>
      <name>nvt</name>
      <summary>NVT to which override applies</summary>
      <pattern>
        <attrib>
          <name>oid</name>
          <type>oid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the override</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing override</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>A textual list of hosts</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>new_severity</name>
      <summary>New severity for result</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>new_threat</name>
      <summary>
        New threat level for result, will be converted to a new_severity
      </summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>Port to which override applies</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>result</name>
      <summary>Result to which override applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>severity</name>
      <summary>Severity score to which override applies</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>Task to which override applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>threat</name>
      <summary>
        Threat level to which override applies, will be converted to severity
      </summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create an override</summary>
      <request>
        <create_override>
          <text>This is actually of little concern.</text>
          <nvt oid="1.3.6.1.4.1.25623.1.0.10330"></nvt>
          <new_threat>Low</new_threat>
          <result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
        </create_override>
      </request>
      <response>
        <create_override_response status="201"
                                   status_text="OK, resource created"
                                   id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_override_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_permission</name>
    <summary>Create a permission</summary>
    <description>
      <p>
        The client uses the create_permission command to create a new permission.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <e>subject</e>
      <o><e>resource</e></o>
      <o><e>copy</e></o>
      <o><e>comment</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A permission name, currently the name of a command</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>subject</name>
      <summary>A subject to whom the permission is granted</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>0</required>
        </attrib>
        <e>type</e>
      </pattern>
      <ele>
        <name>type</name>
        <summary>OMP type of the subject: user, group or role</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>resource</name>
      <summary>A resource to which the permission applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>0</required>
        </attrib>
        <e>type</e>
      </pattern>
      <ele>
        <name>type</name>
        <summary>OMP type, for Super permissions: user, group or role</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>copy</name>
      <summary>UUID of an existing permission to copy</summary>
      <pattern><t>uuid</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>Comment on the permission</summary>
      <pattern>text</pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Grant a user permission to view a target</summary>
      <request>
        <create_permission>
          <name>get_target</name>
          <resource id="b493b7a8-7489-11df-a3ec-002264764cea">
          </resource>
          <subject id="66abe5ce-c011-11e3-b96e-406186ea4fc5">
            <type>user</type>
          </subject>
        </create_permission>
      </request>
      <response>
        <create_permission_response status="201"
                                    status_text="OK, resource created"
                                    id="7ee79232-c011-11e3-b560-406186ea4fc5">
        </create_permission_response>
      </response>
    </example>
    <example>
      <summary>Grant a role permission to create users</summary>
      <request>
        <create_permission>
          <name>create_user</name>
          <subject id="9b0cbd98-c011-11e3-a26e-406186ea4fc5">
            <type>role</type>
          </subject>
        </create_permission>
      </request>
      <response>
        <create_permission_response status="201"
                                    status_text="OK, resource created"
                                    id="b98ad69c-c011-11e3-b001-406186ea4fc5">
        </create_permission_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_port_list</name>
    <summary>Create a port list</summary>
    <description>
      <p>
        The client uses the create_port_list command to create a new port
        list.
      </p>
      <p>
        The get_port_lists_response element overrides the port_range
        element.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <e>port_range</e>
      <r>get_port_lists</r>
    </pattern>
    <ele>
      <name>name</name>
      <summary>The name of the port list</summary>
      <pattern>
        <t>name</t>
      </pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the port list</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing agent</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>port_range</name>
      <summary>
        Comma or newline separated list of ranges
      </summary>
      <pattern>
        text
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a port list</summary>
      <request>
        <create_port_list>
          <name>All TCP</name>
          <comment>All possible TCP ports</comment>
          <port_range>T:1-65535</port_range>
        </create_port_list>
      </request>
      <response>
        <create_port_list_response
          status="201"
          status_text="OK, resource created"
          id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_port_list_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_port_range</name>
    <summary>Create a port range</summary>
    <description>
      <p>
        The client uses the create_port_range command to create a new port
        range.
      </p>
    </description>
    <pattern>
      <o><e>comment</e></o>
      <e>port_list</e>
      <e>start</e>
      <e>end</e>
      <e>type</e>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>A comment on the port range</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>port_list</name>
      <summary>The port list to which to add the range</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>start</name>
      <summary>The first port in the range</summary>
      <pattern>
        <t>port</t>
      </pattern>
    </ele>
    <ele>
      <name>end</name>
      <summary>The last port in the range</summary>
      <pattern>
        <t>port</t>
      </pattern>
    </ele>
    <ele>
      <name>type</name>
      <summary>The type of the ports: TCP, UDP, ...</summary>
      <pattern>
        text
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Add a port range to a port list</summary>
      <request>
        <create_port_range>
          <port_list id="354cd3ef-bbe1-4d58-859d-21b8d0c046c4">
          </port_list>
          <start>777</start>
          <end>779</end>
          <type>TCP</type>
        </create_port_range>
      </request>
      <response>
        <create_port_range_response
          status="201"
          status_text="OK, resource created"
          id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_port_range_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_report</name>
    <summary>Create a report</summary>
    <description>
      <p>
        The client uses the create_report command to import a report.
      </p>
    </description>
    <pattern>
      <e>report</e>
      <e>task</e>
      <o><e>in_assets</e></o>
    </pattern>
    <ele>
      <name>report</name>
      <summary>A report wrapper, as in the GET_REPORTS response</summary>
      <type>report</type>
    </ele>
    <ele>
      <name>task</name>
      <summary>
        Task for report: id to use existing task, name to create new task
      </summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>0</required>
        </attrib>
        <o><e>name</e></o>
        <o><e>comment</e></o>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the task</summary>
        <pattern><t>name</t></pattern>
      </ele>
      <ele>
        <name>comment</name>
        <summary>Comment for the new task</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>in_assets</name>
      <summary>Whether to create or update assets using the report</summary>
      <type>boolean</type>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a report in an existing task</summary>
      <request>
        <create_report>
          <report id="f0fdf522-276d-4893-9274-fb8699dc2270"
                  format_id="d5da9f67-8551-4e51-807b-b6a873d70e34"
                  extension="xml"
                  content_type="text/xml">
            <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
              <omp>
                <version>7.0</version>
              </omp>
              <truncated>...</truncated>
              <results start="1" max="-1">
                <result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
                  <truncated>...</truncated>
                </result>
                <truncated>...</truncated>
              </results>
              <host_start>2010-02-02T19:11:21+00:00<host>127.0.1.1</host></host_start>
              <host_end>2010-02-02T19:11:52+00:00<host>127.0.1.1</host></host_end>
              <scan_end>2010-02-02T19:11:52+00:00</scan_end>
              <errors>
                <count>0</count>
              </errors>
            </report>
          </report>
          <task id="76a4f237-9984-4345-a1f4-71fbcbf0611c"/>
        </create_report>
      </request>
      <response>
        <create_report_response status="201"
                                status_text="OK, resource created"
                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_report_response>
      </response>
    </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>
      <or>
        <e>copy</e>
        <r>get_report_formats</r>
      </or>
    </pattern>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing report format</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </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>
        <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>
              <predefined>1</predefined>
              <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_role</name>
    <summary>Create a role</summary>
    <description>
      <p>
        The client uses the create_role command to create a new
        role.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>users</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the role</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the role</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing role</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>users</name>
      <summary>Comma separated list of user names</summary>
      <pattern>
        text
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a role</summary>
      <request>
        <create_role>
          <name>SCAP Observer</name>
          <users>sarah, bob</users>
        </create_role>
      </request>
      <response>
        <create_role_response status="201"
                               status_text="OK, resource created"
                               id="b64c81b2-b9de-11e3-a2e9-406186ea4fc5">
        </create_role_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_scanner</name>
    <summary>Create a scanner</summary>
    <description>
      <p>
        The client uses the create_scanner command to create a new scanner.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <e>host</e>
      <e>port</e>
      <e>type</e>
      <e>ca_pub</e>
      <e>credential</e>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the scanner</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the scanner</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing scanner</summary>
      <pattern><t>uuid</t></pattern>
    </ele>
    <ele>
      <name>host</name>
      <summary>The host of the scanner</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>The port of the scanner</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>type</name>
      <summary>The type of the scanner</summary>
      <description>
        <p>Type value of '1' for OSP, '2' for OpenVAS (classic) Scanner.</p>
      </description>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>ca_pub</name>
      <summary>Certificate of CA to verify scanner certificate.</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>credential</name>
      <summary>Client certificate credential for the Scanner</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <summary>UUID of the credential</summary>
          <required>1</required>
        </attrib>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a scanner</summary>
      <request>
        <create_scanner>
          <name>Default Scanner</name>
          <host>localhost</host>
          <port>9391</port>
          <type>2</type>
          <ca_pub>...</ca_pub>
          <credential id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
        </create_scanner>
      </request>
      <response>
        <create_scanner_response status="201" status_text="OK, resource created"
                                 id="814cd30f-dee1-4d58-851d-21b8d0c048e3">
        </create_scanner_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_schedule</name>
    <summary>Create a schedule</summary>
    <description>
      <p>
        The client uses the create_schedule command to create a new schedule.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>first_time</e></o>
      <o><e>duration</e></o>
      <o><e>period</e></o>
      <o><e>timezone</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the schedule</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the schedule</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing schedule</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>first_time</name>
      <summary>The first time the schedule will run</summary>
      <pattern>
        <e>minute</e>
        <e>hour</e>
        <e>day_of_month</e>
        <e>month</e>
        <e>year</e>
      </pattern>
      <ele>
        <name>minute</name>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>hour</name>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>day_of_month</name>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>month</name>
        <pattern><t>integer</t></pattern>
      </ele>
      <ele>
        <name>year</name>
        <pattern><t>integer</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>duration</name>
      <summary>How long the Manager will run the scheduled task for</summary>
      <description>A duration of 0 means to run to completion.</description>
      <pattern>
        <e>unit</e>
      </pattern>
      <ele>
        <name>unit</name>
        <summary>Duration time unit</summary>
        <pattern><t>time_unit</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>period</name>
      <summary>How often the Manager will repeat the scheduled task</summary>
      <description>A period of 0 means to run once.</description>
      <pattern>
        <e>unit</e>
      </pattern>
      <ele>
        <name>unit</name>
        <summary>Period time unit</summary>
        <pattern><t>time_unit</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>timezone</name>
      <summary>The timezone the schedule will follow</summary>
      <pattern>timezone</pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a schedule</summary>
      <request>
        <create_schedule>
          <name>Every night</name>
          <first_time>
            <day_of_month>1</day_of_month>
            <hour>0</hour>
            <minute>0</minute>
            <month>1</month>
            <year>2011</year>
          </first_time>
          <duration>
            3
            <unit>hour</unit>
          </duration>
          <period>
            1
            <unit>day</unit>
          </period>
        </create_schedule>
      </request>
      <response>
        <create_schedule_response status="201"
                                   status_text="OK, resource created"
                                   id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_schedule_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_tag</name>
    <summary>Create a tag</summary>
    <description>
      <p>
        The client uses the create_tag command to create a new tag.
        A name and the resource type must be provided. If a resource ID is
        also given, it must refer to an existing resource.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <e>resource</e>
      <o><e>copy</e></o>
      <o><e>value</e></o>
      <o><e>comment</e></o>
      <o><e>active</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A full tag name consisting of namespace and predicate</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>resource</name>
      <summary>Identifies a resource the tag is to be attached to</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <summary>ID of the resource the tag is to be attached to</summary>
          <type>uuid</type>
          <required>0</required>
        </attrib>
        <e>type</e>
      </pattern>
      <ele>
        <name>type</name>
        <summary>OMP type of the resource the tag is to be attached to</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>copy</name>
      <summary>UUID of an existing tag to copy</summary>
      <pattern><t>uuid</t></pattern>
    </ele>
    <ele>
      <name>value</name>
      <summary>Value associated with the tag</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>Comment to add to the tag</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Whether the tag is active</summary>
      <pattern>boolean</pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a tag attached to a target</summary>
      <request>
        <create_tag>
          <name>geo:long</name>
          <resource id="b493b7a8-7489-11df-a3ec-002264764cea">
            <type>target</type>
          </resource>
          <value>52.2788</value>
        </create_tag>
      </request>
      <response>
        <create_tag_response status="201"
                             status_text="OK, resource created"
                             id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_tag_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_target</name>
    <summary>Create a target</summary>
    <description>
      <p>
        The client uses the create_target command to create a new target.
      </p>
      <p>
        If the list of hosts is empty, the command must also include a
        target locator.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <or>
        <e>asset_hosts</e>
        <e>hosts</e>
      </or>
      <o><e>exclude_hosts</e></o>
      <o><e>ssh_credential</e></o>
      <o><e>smb_credential</e></o>
      <o><e>esxi_credential</e></o>
      <o><e>snmp_credential</e></o>
      <o><e>ssh_lsc_credential</e></o>
      <o><e>smb_lsc_credential</e></o>
      <o><e>esxi_lsc_credential</e></o>
      <o><e>alive_tests</e></o>
      <o><e>reverse_lookup_only</e></o>
      <o><e>reverse_lookup_unify</e></o>
      <o><e>port_range</e></o>
      <o><e>port_list</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the target</summary>
      <pattern>
        <t>name</t>
        <e>make_unique</e>
      </pattern>
      <ele>
        <name>make_unique</name>
        <summary>
          Whether to append a unique suffix if the name already exists
        </summary>
        <pattern>boolean</pattern>
      </ele>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the target</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing target</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>asset_hosts</name>
      <summary>Hosts from which to create the target</summary>
      <pattern>
        <attrib>
          <name>filter</name>
          <type>text</type>
          <summary>Filter term that defines the list of hosts</summary>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>A textual list of hosts, which may be empty</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>exclude_hosts</name>
      <summary>A list of hosts to exclude</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>ssh_credential</name>
      <summary>SSH login credentials for target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <o><e>port</e></o>
      </pattern>
      <ele>
        <name>port</name>
        <summary>The port the LSCs will use</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>smb_credential</name>
      <summary>SMB login credentials for target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>esxi_credential</name>
      <summary>ESXi credential to use on target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>snmp_credential</name>
      <summary>SNMP credentials to use on target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>ssh_lsc_credential</name>
      <summary>Deprecated: use ssh_credential. SSH credential</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <o><e>port</e></o>
      </pattern>
      <ele>
        <name>port</name>
        <summary>The port the LSCs will use</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>smb_lsc_credential</name>
      <summary>Deprecated: use ssh_credential. SMB credential</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>esxi_lsc_credential</name>
      <summary>Deprecated: use esxi_credential. ESXi credential</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>alive_tests</name>
      <summary>Which alive tests to use</summary>
      <pattern>
        <t>alive_test</t>
      </pattern>
    </ele>
    <ele>
      <name>reverse_lookup_only</name>
      <summary>Whether to scan only hosts that have names</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>reverse_lookup_unify</name>
      <summary>
        Whether to scan only one IP when multiple IPs have the same name
      </summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>port_range</name>
      <summary>Port range for the target</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>port_list</name>
      <summary>Port list for the target</summary>
      <description>Overrides port_range.</description>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a target, giving a host list</summary>
      <request>
        <create_target>
          <name>All GNU/Linux machines</name>
          <hosts>192.168.1.0/24</hosts>
        </create_target>
      </request>
      <response>
        <create_target_response status="201"
                                status_text="OK, resource created"
                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_target_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_task</name>
    <summary>Create a task</summary>
    <description>
      <p>
        The client uses the create_task command to create a new task.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>comment</e></o>
      <o><e>copy</e></o>
      <o><e>alterable</e></o>
      <e>config</e>
      <e>target</e>
      <o><e>hosts_ordering</e></o>
      <e>scanner</e>
      <any><e>alert</e></any>
      <o><e>schedule</e></o>
      <o><e>schedule_periods</e></o>
      <o><e>observers</e></o>
      <o><e>preferences</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the task</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the task</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing task</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>alterable</name>
      <summary>Whether the task is alterable</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>config</name>
      <summary>The scan configuration used by the task</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>target</name>
      <summary>The hosts scanned by the task</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>hosts_ordering</name>
      <summary>The order hosts are scanned in</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>scanner</name>
      <summary>The scanner to use for scanning the target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>alert</name>
      <summary>An alert that applies to the task</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>schedule</name>
      <summary>When the task will run</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>schedule_periods</name>
      <summary>
        A limit to the number of times the task will be scheduled, or 0 for no limit
      </summary>
      <pattern>
        <t>integer</t>
      </pattern>
    </ele>
    <ele>
      <name>observers</name>
      <summary>Users allowed to observe this task</summary>
      <pattern><t>user_list</t></pattern>
    </ele>
    <ele>
      <name>preferences</name>
      <pattern>
        <any><e>preference</e></any>
      </pattern>
      <ele>
        <name>preference</name>
        <pattern>
          <e>scanner_name</e>
          <e>value</e>
        </pattern>
        <ele>
          <name>scanner_name</name>
          <summary>Compact name of preference, from scanner</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <pattern>text</pattern>
        </ele>
      </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a task, giving a host list</summary>
      <request>
        <create_task>
          <name>Scan Webserver</name>
          <comment>Hourly scan of the webserver</comment>
          <config id="daba56c8-73ec-11df-a475-002264764cea"/>
          <target id="b493b7a8-7489-11df-a3ec-002264764cea"/>
          <scanner id="15348381-3180-213f-4eec-123591912388"/>
        </create_task>
      </request>
      <response>
        <create_task_response status="201"
                              status_text="OK, resource created"
                              id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
        </create_task_response>
      </response>
    </example>
  </command>
  <command>
    <name>create_user</name>
    <summary>Create a user</summary>
    <description>
      <p>
        The client uses the create_user command to create a new user.
      </p>
    </description>
    <pattern>
      <e>name</e>
      <o><e>copy</e></o>
      <o><e>hosts</e></o>
      <o><e>ifaces</e></o>
      <o><e>password</e></o>
      <any><e>role</e></any>
    </pattern>
    <ele>
      <name>name</name>
      <summary>The name of the user to be created</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>copy</name>
      <summary>The UUID of an existing user</summary>
      <pattern>
        <t>uuid</t>
      </pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>User access rules: a textual list of hosts</summary>
      <pattern>
        <attrib>
          <name>allow</name>
          <summary>If 1, allow only listed, otherwise forbid listed</summary>
          <type>boolean</type>
        </attrib>
        text
      </pattern>
    </ele>
    <ele>
      <name>ifaces</name>
      <summary>User access rules: a textual list of ifaces</summary>
      <pattern>
        <attrib>
          <name>allow</name>
          <summary>If 1, allow only listed, otherwise forbid listed</summary>
          <type>boolean</type>
        </attrib>
        text
      </pattern>
    </ele>
    <ele>
      <name>password</name>
      <summary>The password for the user</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>role</name>
      <summary>A role of the user</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </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>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </response>
    <example>
      <summary>Create a user</summary>
      <request>
        <create_user>
          <name>foobar</name>
          <password>f00bar</password>
          <role id="8d453140-b74d-11e2-b0be-406186ea4fc5"></role>
        </create_user>
      </request>
      <response>
        <create_user_response status="201" status_text="OK, resource created"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_agent</name>
    <summary>Delete an agent</summary>
    <description>
      <p>
        The client uses the delete_agent command to delete an existing agent.
      </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>agent_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 an agent</summary>
      <request>
        <delete_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_agent>
      </request>
      <response>
        <delete_agent_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_asset</name>
    <summary>Delete an asset</summary>
    <description>
      <p>
        The client uses the delete_asset command to delete an existing asset.
      </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>
      <or>
        <attrib>
          <name>asset_id</name>
          <summary>Single asset to delete</summary>
          <description>
           <p>
             Overrides report_id.
           </p>
          </description>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <attrib>
          <name>report_id</name>
          <summary>Report from which to get all assets to delete</summary>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </or>
    </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 asset</summary>
      <request>
        <delete_asset asset_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_asset>
      </request>
      <response>
        <delete_asset_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_config</name>
    <summary>Delete a config</summary>
    <description>
      <p>
        The client uses the delete_config command to delete an existing config.
      </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>config_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 config</summary>
      <request>
        <delete_config config_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_config>
      </request>
      <response>
        <delete_config_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_alert</name>
    <summary>Delete an alert</summary>
    <description>
      <p>
        The client uses the delete_alert command to delete an existing
        alert.
      </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>alert_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 an alert</summary>
      <request>
        <delete_alert alert_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_alert>
      </request>
      <response>
        <delete_alert_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_credential</name>
    <summary>Delete a credential</summary>
    <description>
      <p>
        The client uses the delete_credential command to delete an
        existing credential.
      </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>credential_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 credential</summary>
      <request>
        <delete_credential credential_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_credential>
      </request>
      <response>
        <delete_credential_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_filter</name>
    <summary>Delete a filter</summary>
    <description>
      <p>
        The client uses the delete_filter command to delete an existing filter.
      </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>filter_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 filter</summary>
      <request>
        <delete_filter filter_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_filter>
      </request>
      <response>
        <delete_filter_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_group</name>
    <summary>Delete a group</summary>
    <description>
      <p>
        The client uses the delete_group command to delete an existing
        group.
      </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>group_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 group</summary>
      <request>
        <delete_group group_id="d94211b6-ba40-11e3-bcb1-406186ea4fc5">
        </delete_group>
      </request>
      <response>
        <delete_group_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_note</name>
    <summary>Delete a note</summary>
    <description>
      <p>
        The client uses the delete_note command to delete an existing note.
      </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>note_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 note</summary>
      <request>
        <delete_note note_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_note>
      </request>
      <response>
        <delete_note_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_override</name>
    <summary>Delete an override</summary>
    <description>
      <p>
        The client uses the delete_override command to delete an existing override.
      </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>override_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 an override</summary>
      <request>
        <delete_override override_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_override>
      </request>
      <response>
        <delete_override_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_report</name>
    <summary>Delete a report</summary>
    <description>
      <p>
        The client uses the delete_report command to delete an existing report.
      </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_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</summary>
      <request>
        <delete_report report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_report>
      </request>
      <response>
        <delete_report_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_permission</name>
    <summary>Delete a permission</summary>
    <description>
      <p>
        The client uses the delete_permission command to delete an existing permission.
      </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>permission_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 permission</summary>
      <request>
        <delete_permission permission_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_permission>
      </request>
      <response>
        <delete_permission_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_port_list</name>
    <summary>Delete a port list</summary>
    <description>
      <p>
        The client uses the delete_port_list command to delete an existing
        port list.
      </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>port_list_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 port list</summary>
      <request>
        <delete_port_list port_list_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_port_list>
      </request>
      <response>
        <delete_port_list_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_port_range</name>
    <summary>Delete a port range</summary>
    <description>
      <p>
        The client uses the delete_port_range command to delete an existing
        port range.
      </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>port_range_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 port range</summary>
      <request>
        <delete_port_range port_range_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_port_range>
      </request>
      <response>
        <delete_port_range_response status="200" status_text="OK"/>
      </response>
    </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>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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_role</name>
    <summary>Delete a role</summary>
    <description>
      <p>
        The client uses the delete_role command to delete an existing
        role.
      </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>role_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 role</summary>
      <request>
        <delete_role role_id="b64c81b2-b9de-11e3-a2e9-406186ea4fc5">
        </delete_role>
      </request>
      <response>
        <delete_role_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_scanner</name>
    <summary>Delete a scanner</summary>
    <description>
      <p>
        The client uses the delete_scanner command to delete an existing scanner.
      </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>scanner_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 scanner</summary>
      <request>
        <delete_scanner scanner_id="817a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_scanner>
      </request>
      <response>
        <delete_scanner_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_schedule</name>
    <summary>Delete a schedule</summary>
    <description>
      <p>
        The client uses the delete_schedule command to delete an existing schedule.
      </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>schedule_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 schedule</summary>
      <request>
        <delete_schedule schedule_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_schedule>
      </request>
      <response>
        <delete_schedule_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_tag</name>
    <summary>Delete a tag</summary>
    <description>
      <p>
        The client uses the delete_tag command to delete an existing tag.
      </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>tag_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 tag</summary>
      <request>
        <delete_tag target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_tag>
      </request>
      <response>
        <delete_tag_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_target</name>
    <summary>Delete a target</summary>
    <description>
      <p>
        The client uses the delete_target command to delete an existing target.
      </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>target_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 target</summary>
      <request>
        <delete_target target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_target>
      </request>
      <response>
        <delete_target_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_task</name>
    <summary>Delete a task</summary>
    <description>
      <p>
        The client uses the delete_task command to delete an existing task,
        including all reports associated with the task.
      </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>task_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>ultimate</name>
        <summary>Whether to remove entirely, or to the trashcan</summary>
        <type>boolean</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 task</summary>
      <request>
        <delete_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </delete_task>
      </request>
      <response>
        <delete_task_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>delete_user</name>
    <summary>Delete a user</summary>
    <description>
      <p>
        The client uses the delete_user command to delete an existing user.
      </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
        Administrator.
      </p>
    </description>
    <pattern>
      <or>
        <attrib>
          <name>user_id</name>
          <summary>The ID of the user to be deleted.  Overrides name</summary>
          <type>uuid</type>
          <required>1</required>
        </attrib>
        <attrib>
          <name>name</name>
          <summary>The name of the user to be deleted</summary>
          <type>text</type>
          <required>1</required>
        </attrib>
      </or>
      <or>
        <attrib>
          <name>inheritor_id</name>
          <summary>The ID of the inheriting user or "self".  Overrides inheritor_name</summary>
          <type>text</type>
          <required>1</required>
        </attrib>
        <attrib>
          <name>inheritor_name</name>
          <summary>The name of the inheriting user</summary>
          <type>text</type>
          <required>1</required>
        </attrib>
      </or>
    </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 user</summary>
      <request>
        <delete_user name="foobar">
        </delete_user>
      </request>
      <response>
        <delete_user_response status="200" status_text="OK">
        </delete_user_response>
      </response>
    </example>
  </command>
  <command>
    <name>describe_auth</name>
    <summary>Describe authentication methods</summary>
    <description>
      <p>
        The client uses the "describe_auth" command to get details about the
        used authentication methods.
      </p>
      <p>
        The Manager will reply with a list of all used authentication
        methods if such a list is available.
      </p>
    </description>
    <pattern>
    </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>
        <e>group</e>
      </pattern>
      <ele>
        <name>group</name>
        <summary>Config group</summary>
        <pattern>
          <attrib>
            <name>name</name>
            <type>text</type>
            <required>1</required>
          </attrib>
          <e>auth_conf_setting</e>
        </pattern>
        <ele>
          <name>auth_conf_setting</name>
          <pattern>
            <e>key</e>
            <e>value</e>
            <o><e>certificate_info</e></o>
          </pattern>
          <ele>
            <name>key</name>
            <summary>Setting name</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>value</name>
            <summary>Setting value</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>certificate_info</name>
            <summary>Info about the certificate</summary>
            <type>certificate_info</type>
          </ele>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Describe the authentication methods</summary>
      <request>
        <describe_auth>
        </describe_auth>
      </request>
      <response>
        <describe_auth_response status="200" status_text="OK">
          <group name="Foo">
            <auth_conf_setting>
              <key>Bar</key>
              <value>Baz</value>
            </auth_conf_setting>
          </group>
        </describe_auth_response>
      </response>
    </example>
  </command>
  <command>
    <name>empty_trashcan</name>
    <summary>Empty the trashcan</summary>
    <description>
      <p>
        The client uses the empty_trashcan command to empty the trashcan.
      </p>
    </description>
    <pattern>
    </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>Empty the trashcan</summary>
      <request>
        <empty_trashcan>
        </empty_trashcan>
      </request>
      <response>
        <empty_trashcan_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>get_agents</name>
    <summary>Get one or many agents</summary>
    <description>
      <p>
        The client uses the get_agents command to get agent information.
        If the command sent by the client was valid, the manager will
        reply with a list of agents to the client.
      </p>
      <p>
        If the request includes a format then the agents in the response
        include installer elements, otherwise they include trust state and
        time. If the details attribute is set, the response will include
        the installer.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>agent_id</name>
        <summary>ID of single agent to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>trust</name>
            <type>boolean</type>
            <summary>Whether the the agent is trusted</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan agents instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>
          Whether to include agents package information when no format
          was provided
        </summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>format</name>
        <type>
          <alts>
            <alt>installer</alt>
            <alt>howto_install</alt>
            <alt>howto_use</alt>
          </alts>
        </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>agent</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>agents</e>
        <e>agent_count</e>
      </pattern>
      <ele>
        <name>agent</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>in_use</e>
          <e>writable</e>
          <e>permissions</e>
          <e>user_tags</e>
          <or>
            <e>installer</e>
            <e>package</e>
          </or>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the agent</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the agent</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the agent</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the agent was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the agent was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether the agent is in use</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the agent is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the agent</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the agent</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>installer</name>
          <pattern>
            <e>trust</e>
          </pattern>
          <ele>
            <name>trust</name>
            <summary>Whether signature verification succeeded</summary>
            <pattern>
              <t>
                <alts>
                  <alt>yes</alt>
                  <alt>no</alt>
                  <alt>unknown</alt>
                </alts>
              </t>
              <e>time</e>
            </pattern>
            <ele>
              <name>time</name>
              <summary>When the signature was verified</summary>
              <pattern><t>iso_time</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>package</name>
          <summary>Either the installer or one of the HOWTOs</summary>
          <pattern>
            <e>filename</e>
            <t>base64</t>
          </pattern>
          <ele>
            <name>filename</name>
            <summary>The filename of the package</summary>
            <pattern>text</pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>agents</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First agent</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of agents</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>agent_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of agents after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of agents on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many agents</summary>
      <request>
        <get_agents></get_agents>
      </request>
      <response>
        <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>
            <creation_time>2012-01-23T10:44:00+01:00</creation_time>
            <modification_time>2013-01-23T10:44:00+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <installer>
              <trust>
                yes
                <time>Wed Jun 30 21:49:08 2012</time>
              </trust>
            </installer>
          </agent>
          <truncated>...</truncated>
        </get_agents_response>
      </response>
    </example>
    <example>
      <summary>Get one agent</summary>
      <request>
        <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
        </get_agents>
      </request>
      <response>
        <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>
            <creation_time>2012-01-23T10:44:00+01:00</creation_time>
            <modification_time>2013-01-23T10:44:00+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <installer>
              <trust>
                yes
                <time>Wed Jun 30 21:49:08 2012</time>
              </trust>
            </installer>
          </agent>
        </get_agents_response>
      </response>
    </example>
    <example>
      <summary>Get one agent, including the installer package</summary>
      <request>
        <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
                    format="installer">
        </get_agents>
      </request>
      <response>
        <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>
            <creation_time>2012-01-23T10:44:00+01:00</creation_time>
            <modification_time>2013-01-23T10:44:00+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <package format="installer">
              <filename>agent.deb</filename>
              CgoKCgoKCgoKCgoKCSAgI...
            </package>
          </agent>
        </get_agents_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_configs</name>
    <summary>Get one or many configs</summary>
    <description>
      The client uses the get_configs command to get config information.
      If the command sent by the client was valid, the manager will
      reply with a list of configs to the client.
    </description>
    <pattern>
      <attrib>
        <name>config_id</name>
        <summary>ID of single config to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>nvt_selector</name>
            <type>uuid</type>
            <summary>NVT selector UUID</summary>
          </column>
          <column>
            <name>families_total</name>
            <type>integer</type>
            <summary>Total number of selected NVT families</summary>
          </column>
          <column>
            <name>nvts_total</name>
            <type>integer</type>
            <summary>Total number of selected NVTs</summary>
          </column>
          <column>
            <name>families_trend</name>
            <type>boolean</type>
            <summary>Whether new NVT families will be added</summary>
          </column>
          <column>
            <name>nvts_trend</name>
            <type>boolean</type>
            <summary>Whether new NVTs will be added</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan configs instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Whether to get config families, preferences, nvt selectors and tasks</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>families</name>
        <summary>Whether to include the families if no details are requested</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>preferences</name>
        <summary>Whether to include the preferences if no details are requested</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>tasks</name>
        <summary>Whether to get tasks using this config</summary>
        <type>boolean</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>config</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>configs</e>
        <e>config_count</e>
      </pattern>
      <ele>
        <name>config</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>family_count</e>
          <e>nvt_count</e>
          <e>type</e>
          <e>max_nvt_count</e>
          <e>known_nvt_count</e>
          <e>in_use</e>
          <e>writable</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>tasks</e>
          <o><e>families</e></o>
          <o><e>preferences</e></o>
          <o><e>nvt_selectors</e></o>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the config</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the config</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the config</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Creation time of the config</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Last time the config was modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>family_count</name>
          <summary>The number of families selected by the config</summary>
          <pattern>
            <t>integer</t>
            <e>growing</e>
          </pattern>
          <ele>
            <name>growing</name>
            <summary>
              Whether new families are automatically added to the
              config
            </summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>nvt_count</name>
          <summary>The number of NVTs selected by the config</summary>
          <pattern>
            <t>integer</t>
            <e>growing</e>
          </pattern>
          <ele>
            <name>growing</name>
            <summary>
              Whether new NVTs are automatically added to the config
            </summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>type</name>
          <summary>The type the config.</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>max_nvt_count</name>
          <summary>Total number of NVTs in the families selected by the config</summary>
          <pattern>
            <t>integer</t>
          </pattern>
        </ele>
        <ele>
          <name>known_nvt_count</name>
          <summary>Total number of known NVTs selected by the config</summary>
          <pattern>
            <t>integer</t>
          </pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the config</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>
            Whether any tasks are using the config, including trashcan tasks
          </summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the target</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the config</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>tasks</name>
          <summary>All tasks using the config</summary>
          <pattern>
            <any><e>task</e></any>
          </pattern>
          <ele>
            <name>task</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the task</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the task</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>families</name>
          <summary>All families selected by the config</summary>
          <pattern>
            <any><e>family</e></any>
          </pattern>
          <ele>
            <name>family</name>
            <pattern>
              <e>name</e>
              <e>nvt_count</e>
              <e>max_nvt_count</e>
              <e>growing</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the family</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>type</name>
              <summary>The type of the config. 0 = OpenVAS scanner, 1 = OSP Scanner</summary>
              <pattern><t>integer</t></pattern>
            </ele>
            <ele>
              <name>nvt_count</name>
              <summary>The number of NVTs selected in the family</summary>
              <pattern><t>integer</t></pattern>
            </ele>
            <ele>
              <name>max_nvt_count</name>
              <summary>The total number of NVTs in the family</summary>
              <pattern><t>integer</t></pattern>
            </ele>
            <ele>
              <name>growing</name>
              <summary>
                Whether new NVTs in the family are automatically added to the selection
              </summary>
              <pattern><t>boolean</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>preferences</name>
          <summary>Preferences for all NVTs selected by the config</summary>
          <pattern>
            <any><e>preference</e></any>
          </pattern>
          <ele>
            <name>preference</name>
            <pattern>
              <e>nvt</e>
              <e>hr_name</e>
              <e>name</e>
              <e>type</e>
              <e>value</e>
              <e>default</e>
              <any><e>alt</e></any>
            </pattern>
            <ele>
              <name>nvt</name>
              <summary>NVT to which preference applies</summary>
              <pattern>
                <attrib>
                  <name>oid</name>
                  <type>oid</type>
                  <required>1</required>
                </attrib>
                <e>name</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>The name of the NVT</summary>
                <pattern><t>name</t></pattern>
              </ele>
            </ele>
            <ele>
              <name>hr_name</name>
              <summary>The full, more "human readable" name of the preference</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>name</name>
              <summary>The compact name of the preference as used by the scanner</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>type</name>
              <summary>The type of preference</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The value of the preference</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>default</name>
              <summary>The default value of the preference</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>alt</name>
              <summary>An alternate value for the preference</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>nvt_selectors</name>
          <summary>All NVT selectors of the config</summary>
          <pattern>
            <any><e>nvt_selector</e></any>
          </pattern>
          <ele>
            <name>nvt_selector</name>
            <summary>An NVT selector</summary>
            <pattern>
              <e>name</e>
              <e>include</e>
              <e>type</e>
              <e>family_or_nvt</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the selector</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>include</name>
              <summary>Whether the selector is an include selector</summary>
              <pattern>
                <t>boolean</t>
              </pattern>
            </ele>
            <ele>
              <name>type</name>
              <summary>Selector type: 0 = all, 1 = family, 2 = NVT</summary>
              <pattern>
                <t>integer</t>
              </pattern>
            </ele>
            <ele>
              <name>family_or_nvt</name>
              <summary>Name of the family or OID of the NVT</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>configs</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First config</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of configs</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>config_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of configs after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of configs on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many configs</summary>
      <request>
        <get_configs></get_configs>
      </request>
      <response>
        <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>
            <creation_time>2012-11-23T10:44:00+01:00</creation_time>
            <modification_time>2013-01-23T10:44:00+01:00</modification_time>
            <family_count>
              4
              <growing>1</growing>
            </family_count>
            <nvt_count>
              12
              <growing>1</growing>
            </nvt_count>
            <in_use>1</in_use>
            <writable>0</writable>
            <user_tags>
              <count>0</count>
            </user_tags>
          </config>
          <truncated>...</truncated>
        </get_configs_response>
      </response>
    </example>
    <example>
      <summary>Get a single config, including preference, family lists and tasks using this config</summary>
      <request>
        <get_configs config_id="daba56c8-73ec-11df-a475-002264764cea" preferences="1" families="1" tasks="1">
        </get_configs>
      </request>
      <response>
        <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>
            <user_tags>
              <count>0</count>
            </user_tags>
            <tasks>
              <task id="13bb418a-4220-4575-b35b-ec398bff7417">
                <name>Web Servers</name>
              </task>
              <truncated>...</truncated>
            </tasks>
            <families>
              <family>
                <name>Credentials</name>
                <nvt_count>8</nvt_count>
                <max_nvt_count>8</max_nvt_count>
                <growing>1</growing>
              </family>
              <truncated>...</truncated>
            </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>
              <truncated>...</truncated>
            </preferences>
          </config>
          <truncated>...</truncated>
        </get_configs_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_aggregates</name>
    <summary>Get aggregates of various resources</summary>
    <description>
      <p>
        The client uses the get_aggregate command to get aggregated data like
        counts or averages of various resources.
      </p>
      <p>
        Unlike other get_... commands, get_aggregates ignores the filter
        keywords "first" and "rows". It also does not support selecting single
        items by id or getting items from the trashcan.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query of the resources to aggregate (see get_... commands of selected type for keywords)</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query of the resources to aggregate</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>type</name>
        <summary>The OMP resource type to gather data from</summary>
        <type>text</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>data_column</name>
        <summary>A single column to get the data to aggregate from</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>group_column</name>
        <summary>The field to group the resources by</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>subgroup_column</name>
        <summary>The field to further group the resources inside groups by</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>sort_field</name>
        <summary>The column to sort the aggregated rows by.
        With a subgroup column, groups will be sorted by the group_column first.</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>sort_order</name>
        <summary>The order to sort by</summary>
        <type>
          <alts>
            <alt>ascending</alt>
            <alt>descending</alt>
          </alts>
        </type>
      </attrib>
      <attrib>
        <name>sort_stat</name>
        <summary>The statistic to sort the aggregated rows by</summary>
        <type>
          <alts>
            <alt>min</alt>
            <alt>max</alt>
            <alt>mean</alt>
            <alt>sum</alt>
            <alt>count</alt>
            <alt>value</alt>
          </alts>
        </type>
      </attrib>
      <attrib>
        <name>first_group</name>
        <summary>The index of the first aggregate group to return</summary>
        <type>integer</type>
      </attrib>
      <attrib>
        <name>max_groups</name>
        <summary>The maximum number of aggregate groups to return, -1 for all</summary>
        <type>integer</type>
      </attrib>
      <attrib>
        <name>mode</name>
        <summary>Special mode for aggregation</summary>
        <type>
          <alts>
            <alt></alt>
            <alt>word_counts</alt>
          </alts>
        </type>
      </attrib>
      <any><e>sort</e></any>
      <any><e>data_column</e></any>
      <any><e>text_column</e></any>
    </pattern>
    <ele>
      <name>sort</name>
      <summary>Optional tuples of sort criteria</summary>
      <pattern>
        <attrib>
          <name>sort_field</name>
          <summary>The column to sort the aggregated rows by.
          With a subgroup column, groups will be sorted by the group_column first.</summary>
          <type>text</type>
        </attrib>
        <attrib>
          <name>sort_order</name>
          <summary>The order to sort by</summary>
          <type>
            <alts>
              <alt>ascending</alt>
              <alt>descending</alt>
            </alts>
          </type>
        </attrib>
        <attrib>
          <name>sort_stat</name>
          <summary>The statistic to sort the aggregated rows by</summary>
          <type>
            <alts>
              <alt>min</alt>
              <alt>max</alt>
              <alt>mean</alt>
              <alt>sum</alt>
              <alt>count</alt>
              <alt>value</alt>
            </alts>
          </type>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>data_column</name>
      <summary>A column to get the data to aggregate from</summary>
      <type>text</type>
    </ele>
    <ele>
      <name>text_column</name>
      <summary>A simple text column which no statistics are calculated for</summary>
      <type>text</type>
    </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>
        <any><e>aggregate</e></any>
        <e>filters</e>
      </pattern>
      <ele>
        <name>aggregate</name>
        <summary>A collection of aggregated data of the selected type</summary>
        <pattern>
          <e>data_type</e>
          <any><e>data_column</e></any>
          <o><e>group_column</e></o>
          <any><e>text_column</e></any>
          <or>
            <any><e>group</e></any>
            <e>overall</e>
          </or>
          <o><e>subgroups</e></o>
          <e>column_info</e>
        </pattern>
        <ele>
          <name>data_type</name>
          <summary>The resource type the data is aggregated from</summary>
          <pattern><t>text</t></pattern>
        </ele>
        <ele>
          <name>data_column</name>
          <summary>A column the data is aggregated from</summary>
          <pattern><t>text</t></pattern>
        </ele>
        <ele>
          <name>group_column</name>
          <summary>The column the data is grouped by</summary>
          <pattern><t>text</t></pattern>
        </ele>
        <ele>
          <name>text_column</name>
          <summary>A simple text column</summary>
          <pattern><t>text</t></pattern>
        </ele>
        <ele>
          <name>group</name>
          <summary>Aggregate data for a group of resources</summary>
          <pattern>
            <e>value</e>
            <any><e>subgroup</e></any>
            <e>count</e>
            <e>c_count</e>
            <any><e>stats</e></any>
            <any><e>text</e></any>
          </pattern>
          <ele>
            <name>value</name>
            <summary>Value of the group column</summary>
            <pattern><t>text</t></pattern>
          </ele>
          <ele>
            <name>subgroup</name>
            <summary>Aggregate data for a subgroup of resources</summary>
            <pattern>
              <e>value</e>
              <e>count</e>
              <e>c_count</e>
              <any><e>stats</e></any>
            </pattern>
            <ele>
              <name>value</name>
              <summary>Value of the subgroup column</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>count</name>
              <summary>Number of resources in the subgroup</summary>
              <pattern><t>integer</t></pattern>
            </ele>
            <ele>
              <name>c_count</name>
              <summary>Cumulative number of resources in the current subgroup</summary>
              <pattern><t>integer</t></pattern>
            </ele>
            <ele>
              <name>stats</name>
              <summary>Statistics of a data column for the current subgroup</summary>
              <pattern>
                <attrib>
                  <name>column</name>
                  <summary>Name of the column the stats apply to</summary>
                  <type>text</type>
                </attrib>
                <e>min</e>
                <e>max</e>
                <e>mean</e>
                <e>sum</e>
                <e>c_sum</e>
              </pattern>
              <ele>
                <name>min</name>
                <summary>Minimum value of the data column</summary>
                <pattern><t>text</t></pattern>
              </ele>
              <ele>
                <name>max</name>
                <summary>Maximum value of the data column</summary>
                <pattern><t>text</t></pattern>
              </ele>
              <ele>
                <name>mean</name>
                <summary>Arithmetic mean of the numeric values of the data</summary>
                <pattern><t>text</t></pattern>
              </ele>
              <ele>
                <name>sum</name>
                <summary>Sum of the numeric values of the data column</summary>
                <pattern><t>text</t></pattern>
              </ele>
              <ele>
                <name>c_sum</name>
                <summary>Cumulative sum of the data column</summary>
                <pattern><t>text</t></pattern>
              </ele>
            </ele>
          </ele>
          <ele>
            <name>count</name>
            <summary>Number of resources in the group</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>c_count</name>
            <summary>Cumulative number of resources in all groups up to and including the current one</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>text</name>
            <summary>The value of a simple text column.</summary>
            <pattern>
              <attrib>
                <name>name</name>
                <summary>Name of the text column</summary>
                <type>text</type>
              </attrib>
              text
            </pattern>
          </ele>
          <ele>
            <name>stats</name>
            <summary>Statistics of a data column</summary>
            <pattern>
              <attrib>
                <name>column</name>
                <summary>Name of the column the stats apply to</summary>
                <type>text</type>
              </attrib>
              <e>min</e>
              <e>max</e>
              <e>mean</e>
              <e>sum</e>
              <e>c_sum</e>
            </pattern>
            <ele>
              <name>min</name>
              <summary>Minimum value of the data column</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>max</name>
              <summary>Maximum value of the data column</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>mean</name>
              <summary>Arithmetic mean of the numeric values of the data</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>sum</name>
              <summary>Sum of the numeric values of the data column</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>c_sum</name>
              <summary>Cumulative sum of the numeric values of the data column for all groups up to and including the current one</summary>
              <pattern><t>text</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>overall</name>
          <summary>Aggregate data for all resources of the selected type</summary>
          <pattern>
            <e>count</e>
            <e>min</e>
            <e>max</e>
            <e>mean</e>
            <e>sum</e>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Overall number of resources</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>min</name>
            <summary>Overall minimum value of the data column</summary>
            <pattern><t>text</t></pattern>
          </ele>
          <ele>
            <name>max</name>
            <summary>Overall maximum value of the data column</summary>
            <pattern><t>text</t></pattern>
          </ele>
          <ele>
            <name>mean</name>
            <summary>Overall arithmetic mean of the numeric values of the data</summary>
            <pattern><t>text</t></pattern>
          </ele>
          <ele>
            <name>sum</name>
            <summary>Overall sum of the numeric values of the data column</summary>
            <pattern><t>text</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>subgroups</name>
          <summary>Overview of all subgroup values</summary>
          <pattern>
            <any><e>value</e></any>
          </pattern>
          <ele>
            <name>value</name>
            <summary>Value of the subgroup column</summary>
            <pattern><t>text</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>column_info</name>
          <summary>Info on the aggregate columns</summary>
          <pattern>
            <any><e>aggregate_column</e></any>
          </pattern>
          <ele>
            <name>aggregate_column</name>
            <summary>Info on one column of the aggregate</summary>
            <pattern>
              <e>name</e>
              <e>stat</e>
              <e>type</e>
              <e>column</e>
              <e>data_type</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the column as it appears in the group or overall element</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>stat</name>
              <summary>The type of statistic in the column, e.g. min, max, mean</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>type</name>
              <summary>The resource type</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>column</name>
              <summary>Name of the column in the non-aggregated table</summary>
              <pattern><t>text</t></pattern>
            </ele>
            <ele>
              <name>data_type</name>
              <summary>The data type of the column, e.g. integer, text, cvss</summary>
              <pattern><t>text</t></pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get severity statistics of NVTs by family</summary>
      <request>
        <get_aggregates type="nvt" group_column="family" data_column="severity">
        </get_aggregates>
      </request>
      <response>
        <get_aggregates_response status_text="OK" status="200">
          <aggregate>
            <data_type>nvt</data_type>
            <data_column>severity</data_column>
            <group_column>family</group_column>
            <group>
              <value>AIX Local Security Checks</value>
              <count>1</count>
              <c_count>1</c_count>
              <min>3.3</min>
              <max>3.3</max>
              <mean>3.3</mean>
              <sum>3.3</sum>
              <c_sum>3.3</c_sum>
            </group>
            <group>
              <value>Brute force attacks</value>
              <count>8</count>
              <c_count>9</c_count>
              <min>0</min>
              <max>7.8</max>
              <mean>6.275</mean>
              <sum>50.2</sum>
              <c_sum>53.5</c_sum>
            </group>
            <group>
              <value>Buffer overflow</value>
              <count>519</count>
              <c_count>528</c_count>
              <min>10</min>
              <max>9.7</max>
              <mean>8.63083</mean>
              <sum>4479.4</sum>
              <c_sum>4532.9</c_sum>
            </group>
            <truncated>...</truncated>
            <column_info>
              <aggregate_column>
                <name>value</name>
                <stat>value</stat>
                <type>nvt</type>
                <column>family</column>
                <data_type>text</data_type>
              </aggregate_column>
              <aggregate_column>
                <name>count</name>
                <stat>count</stat>
                <type>nvt</type>
                <column></column>
                <data_type>integer</data_type>
              </aggregate_column>
              <aggregate_column>
                <name>c_count</name>
                <stat>c_count</stat>
                <type>nvt</type>
                <column></column>
                <data_type>integer</data_type>
              </aggregate_column>
              <aggregate_column>
                <name>min</name>
                <stat>min</stat>
                <type>nvt</type>
                <column>severity</column>
                <data_type>cvss</data_type>
              </aggregate_column>
              <truncated>...</truncated>
            </column_info>
          </aggregate>
          <filters id="">
            <term>first=1 rows=-1 sort=name</term>
            <keywords>
              <keyword>
                <column>first</column>
                <relation>=</relation>
                <value>1</value>
              </keyword>
              <keyword>
                <column>rows</column>
                <relation>=</relation>
                <value>-1</value>
              </keyword>
              <keyword>
                <column>sort</column>
                <relation>=</relation>
                <value>name</value>
              </keyword>
            </keywords>
          </filters>
        </get_aggregates_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_alerts</name>
    <summary>Get one or many alerts</summary>
    <description>
      The client uses the get_alerts command to get alert information.
      If the command sent by the client was valid, the manager will
      reply with a list of alerts to the client.
    </description>
    <pattern>
      <attrib>
        <name>alert_id</name>
        <summary>ID of single alert to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>event</name>
            <type>integer</type>
            <summary>The event that triggers the alert</summary>
          </column>
          <column>
            <name>condition</name>
            <type>integer</type>
            <summary>The condition for the alert</summary>
          </column>
          <column>
            <name>method</name>
            <type>integer</type>
            <summary>The method of the alert</summary>
          </column>
          <column>
            <name>filter</name>
            <type>uuid</type>
            <summary>UUID of the filter applied to the report</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan alerts instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>tasks</name>
        <summary>Whether to get the tasks using the alerts</summary>
        <type>boolean</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>alert</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>alerts</e>
        <e>alert_count</e>
      </pattern>
      <ele>
        <name>alert</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>in_use</e>
          <e>writable</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>condition</e>
          <e>event</e>
          <e>method</e>
          <e>filter</e>
          <o><e>tasks</e></o>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the alert</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the alert</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the alert</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the alert</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the alert is writable or not</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Creation time of the alert</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Last time the alert was modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the alert</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the alert</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>condition</name>
          <summary>
            The condition that must be satisfied for the alert to occur
          </summary>
          <pattern>
            text
            <any><e>data</e></any>
          </pattern>
          <ele>
            <name>data</name>
            <summary>Some data that defines the condition</summary>
            <pattern>
              text
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the condition data</summary>
              <pattern>
                text
              </pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>event</name>
          <summary>The event that must happen for the alert to occur</summary>
          <pattern>
            text
            <any><e>data</e></any>
          </pattern>
          <ele>
            <name>data</name>
            <summary>Some data that defines the event</summary>
            <pattern>
              text
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the event data</summary>
              <pattern>
                text
              </pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>method</name>
          <summary>The method by which he alert must occur</summary>
          <pattern>
            text
            <any><e>data</e></any>
          </pattern>
          <ele>
            <name>data</name>
            <summary>Some data that defines the method</summary>
            <pattern>
              text
              <e>name</e>
              <o><e>credential</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the method data</summary>
              <pattern>
                text
              </pattern>
            </ele>
            <ele>
              <name>credential</name>
              <summary>Credential information if the data is a credential ID</summary>
              <pattern>
                <attrib>
                  <name>id</name>
                  <type>uuid</type>
                  <summary>UUID of the credential</summary>
                </attrib>
                <e>name</e>
                <e>login</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>The name of the credential</summary>
                <pattern><t>name</t></pattern>
              </ele>
              <ele>
                <name>login</name>
                <summary>The username of the credential</summary>
                <pattern><t>name</t></pattern>
              </ele>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>filter</name>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the filter</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the filter</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the filter is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>tasks</name>
          <summary>Tasks using the alert</summary>
          <pattern>
            <any><e>task</e></any>
          </pattern>
          <ele>
            <name>task</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the task</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the task</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>alerts</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First alert</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of alerts</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>alert_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of alerts after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of alerts on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get the alerts</summary>
      <request>
        <get_alerts></get_alerts>
      </request>
      <response>
        <get_alerts_response status="200" status_text="OK">
          <alert id="6181e65d-8ba0-4937-9c44-8f2b10b0def7">
            <name>Team alert</name>
            <comment></comment>
            <creation_time>2012-04-27T12:44:00+01:00</creation_time>
            <modification_time>2012-08-28T12:14:00+01:00</modification_time>
            <writable>1</writable>
            <in_use>1</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <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@example.org
              </data>
              <data>
                <name>from_address</name>
                admin@example.org
              </data>
              <data>
                <name>notice</name>
                0
              </data>
            </method>
          </alert>
          <truncated>...</truncated>
        </get_alerts_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_assets</name>
    <summary>Get one or many assets</summary>
    <description>
      The client uses the get_assets command to get asset information.
    </description>
    <pattern>
      <attrib>
        <name>asset_id</name>
        <summary>ID of single asset to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is "host"</condition>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Highest severity of the asset from latest report</summary>
          </column>
          <column>
            <name>os</name>
            <type>text</type>
            <summary>Best matching OS</summary>
          </column>
          <column>
            <name>oss</name>
            <type>text</type>
            <summary>Comma-separated list of all OSs of the host</summary>
          </column>
          <column>
            <name>hostname</name>
            <type>text</type>
            <summary>Hostname</summary>
          </column>
          <column>
            <name>ip</name>
            <type>ip</type>
            <summary>IP address</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is "os"</condition>
          <column>
            <name>title</name>
            <type>text</type>
            <summary>CPE title of the asset</summary>
          </column>
          <column>
            <name>hosts</name>
            <type>integer</type>
            <summary>Number of hosts using the asset</summary>
          </column>
          <column>
            <name>latest_severity</name>
            <type>severity</type>
            <summary>Latest severity score of the asset</summary>
          </column>
          <column>
            <name>highest_severity</name>
            <type>severity</type>
            <summary>Latest severity score of the asset</summary>
          </column>
          <column>
            <name>average_severity</name>
            <type>severity</type>
            <summary>Average severity score of the asset</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>ignore_pagination</name>
        <summary>
          Whether to ignore info used to split the report into pages
          like the filter terms "first" and "rows"
        </summary>
        <type>boolean</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>asset</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>assets</e>
        <e>asset_count</e>
      </pattern>
      <ele>
        <name>asset</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <o><e>identifiers</e></o>
          <or>
            <e>host</e>
            <e>os</e>
          </or>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the asset</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the asset</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the asset</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the asset was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the asset was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>identifiers</name>
          <summary>Host identifiers</summary>
          <pattern>
            <e>identifier</e>
          </pattern>
          <ele>
            <name>identifier</name>
            <summary>A single identifier</summary>
            <pattern>
              <e>name</e>
              <e>value</e>
              <e>creation_time</e>
              <e>modification_time</e>
              <e>source</e>
              <o><e>os</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the identifier</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The value of the identifier</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>creation_time</name>
              <summary>Date and time the identifier was created</summary>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>modification_time</name>
              <summary>Date and time the identifier was last modified</summary>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>source</name>
              <summary>The source of the identifier</summary>
              <pattern>
                <attrib>
                  <name>id</name>
                  <type>uuid</type>
                  <required>1</required>
                </attrib>
                <e>type</e>
                <e>data</e>
                <e>deleted</e>
              </pattern>
              <ele>
                <name>type</name>
                <summary>Type of source</summary>
                <pattern>text</pattern>
              </ele>
              <ele>
                <name>data</name>
                <summary>Extra data, depends on type of source</summary>
                <pattern>text</pattern>
              </ele>
              <ele>
                <name>deleted</name>
                <summary>Whether the source has been deleted</summary>
                <pattern>boolean</pattern>
              </ele>
            </ele>
            <ele>
              <name>os</name>
              <pattern>
                <attrib>
                  <name>id</name>
                  <type>uuid</type>
                  <required>1</required>
                </attrib>
                <e>title</e>
              </pattern>
              <ele>
                <name>title</name>
                <summary>Title of OS</summary>
                <pattern>text</pattern>
              </ele>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>host</name>
          <summary>A host</summary>
          <pattern>
            <e>severity</e>
            <any><e>detail</e></any>
            <e>routes</e>
          </pattern>
          <ele>
            <name>severity</name>
            <summary>Severity of the host</summary>
            <pattern>
              <e>value</e>
            </pattern>
            <ele>
              <name>value</name>
              <pattern><t>severity</t></pattern>
            </ele>
          </ele>
          <ele>
            <name>detail</name>
            <summary>A host detail</summary>
            <pattern>
              <e>name</e>
              <e>value</e>
              <e>source</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the detail</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The value of the detail</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>source</name>
              <summary>The source of the detail</summary>
              <pattern>
                <attrib>
                  <name>id</name>
                  <type>uuid</type>
                  <required>1</required>
                </attrib>
                <e>type</e>
              </pattern>
              <ele>
                <name>type</name>
                <summary>Type of source</summary>
                <pattern>text</pattern>
              </ele>
            </ele>
          </ele>
          <ele>
            <name>routes</name>
            <summary>List of routes to the host, with most recent ones first</summary>
            <pattern>
              <any><e>route</e></any>
            </pattern>
            <ele>
              <name>route</name>
              <summary>List of hosts on the route to the host</summary>
              <pattern>
                <any><e>host</e></any>
              </pattern>
              <ele>
                <name>host</name>
                <summary>A host on the route</summary>
                <pattern>
                  <attrib>
                    <name>id</name>
                    <summary>UUID if the host is in the asset management</summary>
                    <type>uuid</type>
                  </attrib>
                  <attrib>
                    <name>distance</name>
                    <summary>Distance from the scanner</summary>
                    <type>number</type>
                  </attrib>
                  <attrib>
                    <name>same_source</name>
                    <summary>Whether the current host asset has the same source as the target host</summary>
                    <type>boolean</type>
                  </attrib>
                  <e>ip</e>
                </pattern>
                <ele>
                  <name>ip</name>
                  <summary>IP address of the host</summary>
                  <pattern>text</pattern>
                </ele>
              </ele>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>os</name>
          <summary>An OS</summary>
          <pattern>
            <e>title</e>
            <e>installs</e>
            <e>latest_severity</e>
            <e>highest_severity</e>
            <e>average_severity</e>
            <e>hosts</e>
          </pattern>
          <ele>
            <name>title</name>
            <summary>Title of the OS</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
<!-- FIX hosts/host_count? -->
            <name>installs</name>
            <summary>Number of hosts on which OS has been detected</summary>
            <pattern>integer</pattern>
          </ele>
          <ele>
            <name>latest_severity</name>
            <summary>Latest severity</summary>
            <pattern>
              <e>value</e>
            </pattern>
            <ele>
              <name>value</name>
              <pattern>text</pattern>
            </ele>
          </ele>
          <ele>
            <name>highest_severity</name>
            <summary>Highest severity</summary>
            <pattern>
              <e>value</e>
            </pattern>
            <ele>
              <name>value</name>
              <pattern>text</pattern>
            </ele>
          </ele>
          <ele>
            <name>average_severity</name>
            <summary>Average severity</summary>
            <pattern>
              <e>value</e>
            </pattern>
            <ele>
              <name>value</name>
              <pattern>text</pattern>
            </ele>
          </ele>
          <ele>
            <name>hosts</name>
            <summary>Hosts on which this OS has been detected</summary>
            <pattern>
              <e>asset</e>
            </pattern>
            <ele>
              <name>asset</name>
              <summary>The host</summary>
              <pattern>
                <attrib>
                  <name>id</name>
                  <type>uuid</type>
                  <required>1</required>
                </attrib>
                <e>name</e>
                <e>severity</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>The name of the host</summary>
                <pattern><t>name</t></pattern>
              </ele>
              <ele>
                <name>severity</name>
                <summary>Severity of the host</summary>
                <pattern>
                  <e>value</e>
                </pattern>
                <ele>
                  <name>value</name>
                  <pattern>text</pattern>
                </ele>
              </ele>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the asset</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the asset is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the asset</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the asset</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>assets</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First asset</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of assets</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>asset_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of assets after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of assets on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many assets</summary>
      <request>
        <get_assets></get_assets>
      </request>
      <response>
        <get_assets_response status="200" status_text="OK">
          <asset id="b493b7a8-7489-11df-a3ec-002264764cea">
            <name>Localhost</name>
            <comment></comment>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <writable>0</writable>
            <in_use>7</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <hosts>localhost</hosts>
            <max_hosts>1</max_hosts>
            <ssh_credential id="">
              <name></name>
            </ssh_credential>
            <smb_credential id="">
              <name></name>
            </smb_credential>
            <esxi_credential id="">
              <name></name>
            </esxi_credential>
          </asset>
          <truncated>...</truncated>
        </get_assets_response>
      </response>
    </example>
    <example>
      <summary>Get a single asset, including tasks using the asset</summary>
      <request>
        <get_assets asset_id="1f28d970-17ef-4c69-ba8a-13827059f2b9" tasks="1">
        </get_assets>
      </request>
      <response>
        <get_assets_response status="200" status_text="OK">
          <asset id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
            <name>dik</name>
            <comment>dik mm</comment>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <writable>0</writable>
            <in_use>4</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <hosts>dik.example.org</hosts>
            <max_hosts>1</max_hosts>
            <ssh_credential id="58ff2793-2dc7-43fe-85f9-20bfac5a87e4">
              <name>mm</name>
            </ssh_credential>
            <smb_credential id="">
              <name></name>
            </smb_credential>
            <esxi_credential id="">
              <name></name>
            </esxi_credential>
            <tasks>
              <task id="13bb418a-4220-4575-b35b-ec398bff7417">
                <name>dik mm</name>
              </task>
              <truncated>...</truncated>
            </tasks>
          </asset>
        </get_assets_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_credentials</name>
    <summary>Get one or many credentials</summary>
    <description>
      The client uses the get_credentials command to get credentials information.
      If the command sent by the client was valid, the manager will
      reply with a list of credentials to the client.
    </description>
    <pattern>
      <attrib>
        <name>credential_id</name>
        <summary>ID of single credential to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>login</name>
            <type>text</type>
            <summary>The login username</summary>
          </column>
          <column>
            <name>type</name>
            <type>text</type>
            <summary>The type abbreviation</summary>
          </column>
          <column>
            <name>allow_insecure</name>
            <type>boolean</type>
            <summary>Whether insecure use is allowed</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>scanners</name>
        <summary>Whether to include a list of scanners using the credentials</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan credentials instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>targets</name>
        <summary>Whether to include a list of targets using the credentials</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>format</name>
        <type>
          <alts>
            <alt>key</alt>
            <alt>rpm</alt>
            <alt>deb</alt>
            <alt>exe</alt>
          </alts>
        </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>credential</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>credentials</e>
        <e>credential_count</e>
      </pattern>
      <ele>
        <name>credential</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>allow_insecure</e>
          <e>login</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>type</e>
          <e>full_type</e>
          <o><e>auth_algorithm</e></o>
          <o><e>privacy</e></o>
          <o><e>certificate_info</e></o>
          <o><e>scanners</e></o>
          <o><e>targets</e></o>
          <or>
            <e>public_key</e>
            <e>package</e>
          </or>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the credential</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the credential</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>allow_insecure</name>
          <summary>Whether insecure use of the credential is allowed</summary>
          <pattern>
            <t>boolean</t>
          </pattern>
        </ele>
        <ele>
          <name>login</name>
          <summary>The username of the credential</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the credential</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the credential was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the credential was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether this credential is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any targets are using the credential</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the credential
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the credential</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>type</name>
          <summary>The type of the credential</summary>
          <pattern>
            <t>
              <alts>
                <alt>up</alt>
                <alt>usk</alt>
              </alts>
            </t>
          </pattern>
        </ele>
        <ele>
          <name>full_type</name>
          <summary>The type of the credential written out</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>auth_algorithm</name>
          <summary>The SNMP authentication algorithm</summary>
          <pattern>
            <t>
              <alts>
                <alt>md5</alt>
                <alt>sha1</alt>
              </alts>
            </t>
          </pattern>
        </ele>
        <ele>
          <name>privacy</name>
          <pattern>
            <e>algorithm</e>
          </pattern>
          <ele>
            <name>algorithm</name>
            <summary>The SNMP privacy algorithm</summary>
            <pattern>
              <t>
                <alts>
                  <alt>aes</alt>
                  <alt>des</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>certificate_info</name>
          <summary>
            Info about the certificate
          </summary>
          <type>certificate_info</type>
        </ele>
        <ele>
          <name>scanners</name>
          <summary>All scanners using this credential</summary>
          <pattern>
            <any><e>scanner</e></any>
          </pattern>
          <ele>
            <name>scanner</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the scanner</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the scanner</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>targets</name>
          <summary>All targets using this credential</summary>
          <pattern>
            <any><e>target</e></any>
          </pattern>
          <ele>
            <name>target</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the target</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the target</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>public_key</name>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>package</name>
          <pattern>
            <attrib>
              <name>format</name>
              <type>
                <alts>
                  <alt>rpm</alt>
                  <alt>deb</alt>
                  <alt>exe</alt>
                </alts>
              </type>
              <required>1</required>
            </attrib>
            base64
          </pattern>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>credentials</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First credential</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of credentials</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>credential_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of credentials after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of credentials on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many the credentials</summary>
      <request>
        <get_credentials></get_credentials>
      </request>
      <response>
        <get_credentials_response status="200" status_text="OK">
          <credential id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
            <name>sally</name>
            <login>sally</login>
            <comment></comment>
            <creation_time>2012-12-14T17:11:25+01:00</creation_time>
            <modification_time>2012-05-28T11:19:20+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <type>usk</type>
            <full_type>username + SSH key</full_type>
          </credential>
          <credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
            <name>bob</name>
            <comment>Bob on the web server.</comment>
            <creation_time>2013-01-03T15:49:35+01:00</creation_time>
            <modification_time>2013-01-18T12:07:00+01:00</modification_time>
            <writable>1</writable>
            <in_use>1</in_use>
            <login>bob</login>
            <type>up</type>
            <full_type>username + password</full_type>
          </credential>
          <truncated>...</truncated>
        </get_credentials_response>
      </response>
    </example>
    <example>
      <summary>Get a single credential, its public key and targets using it</summary>
      <request>
        <get_credentials
          credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
          format="key" targets="1">
        </get_credentials>
      </request>
      <response>
        <get_credentials_response status="200" status_text="OK">
          <credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
            <name>bob</name>
            <comment>Bob on the web server.</comment>
            <creation_time>2012-11-03T15:41:35+01:00</creation_time>
            <modification_time>2012-11-18T13:17:00+01:00</modification_time>
            <writable>1</writable>
            <in_use>1</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <login>bob</login>
            <type>up</type>
            <full_type>username + password</full_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>
          </credential>
        </get_credentials_response>
      </response>
    </example>
    <example>
      <summary>Get the Debian package of a single credential</summary>
      <request>
        <get_credentials
          credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
          format="deb">
        </get_credentials>
      </request>
      <response>
        <get_credentials_response status="200" status_text="OK">
          <credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
            <name>bob</name>
            <login>bob</login>
            <comment>Bob on the web server.</comment>
            <creation_time>2012-11-03T15:41:35+01:00</creation_time>
            <modification_time>2012-11-18T13:17:00+01:00</modification_time>
            <writable>1</writable>
            <in_use>1</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <type>up</type>
            <full_type>username + password</full_type>
            <targets>
              <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
                <name>Web server</name>
              </target>
            </targets>
            <package format="deb">ITxhcmNoPgpk...DmvF0AKAAACg==</package>
          </credential>
        </get_credentials_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_feeds</name>
    <summary>Get one or many feeds</summary>
    <description>
      <p>
        The client uses the get_feeds command to get feed information.
        If the command sent by the client was valid, the manager will
        reply with a list of feeds to the client.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>type</name>
        <summary>Type of single feed to get: NVT, CERT or SCAP</summary>
        <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>feed</e></any>
      </pattern>
      <ele>
        <name>feed</name>
        <pattern>
          <e>type</e>
          <e>name</e>
          <e>version</e>
          <e>description</e>
          <o><e>sync_not_available</e></o>
          <o><e>currently_syncing</e></o>
        </pattern>
        <ele>
          <name>type</name>
          <summary>The type of feed: NVT, CERT or SCAP</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the feed</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>version</name>
          <summary>The version of the feed</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>description</name>
          <summary>A description of the feed</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>sync_not_available</name>
          <summary>Present if syncing is not available</summary>
          <pattern>
            <e>error</e>
          </pattern>
          <ele>
            <name>error</name>
            <summary>Description of why sync is not available</summary>
          </ele>
        </ele>
        <ele>
          <name>currently_syncing</name>
          <summary>Present if a sync of this type is underway</summary>
          <pattern>
            <e>timestamp</e>
            <e>user</e>
          </pattern>
          <ele>
            <name>timestamp</name>
            <summary>Time sync started</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>user</name>
            <summary>Name of user who is performing sync</summary>
            <pattern>text</pattern>
          </ele>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get the feeds</summary>
      <request>
        <get_feeds>
        </get_feeds>
      </request>
      <response>
        <get_feeds_response status_text="OK" status="200">
          <feed>
            <type>NVT</type>
            <name>Greenbone Security Feed</name>
            <version>201608180124</version>
            <description>This script synchronizes an NVT collection with...</description>
          </feed>
          <feed>
            <type>CERT</type>
            <name>Greenbone CERT Feed</name>
            <version>201609130000</version>
            <description>This script synchronizes a CERT collection with...</description>
          </feed>
          <feed>
            <type>SCAP</type>
            <name>Greenbone SCAP Feed</name>
            <version>201608172300</version>
            <description>This script synchronizes a SCAP collection with...</description>
          </feed>
        </get_feeds_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_filters</name>
    <summary>Get one or many filters</summary>
    <description>
      The client uses the get_filters command to get filter information.
    </description>
    <pattern>
      <attrib>
        <name>filter_id</name>
        <summary>ID of single filter to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>type</name>
            <type>text</type>
            <summary>Resource type the filter is restricted to</summary>
          </column>
          <column>
            <name>term</name>
            <type>text</type>
            <summary>The filter term</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan filters instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>alerts</name>
        <summary>Whether to include list of alerts that use the filter</summary>
        <type>boolean</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>filter</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>filters</e>
        <e>filter_count</e>
      </pattern>
      <ele>
        <name>filter</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>term</e>
          <e>type</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>in_use</e>
          <e>writable</e>
          <e>permissions</e>
          <e>user_tags</e>
          <o><e>alerts</e></o>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the filter</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the filter</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the filter</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>term</name>
          <summary>The filter term</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>type</name>
          <summary>Resource type filter applies to.  Blank for all</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the filter was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the filter was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the filter</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the filter is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the filter</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the filter</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>alerts</name>
          <summary>All alerts using the filter</summary>
          <pattern>
            <any><e>alert</e></any>
          </pattern>
          <ele>
            <name>alert</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the alert</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the alert</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First filter</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of filters</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>filter_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of filters after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of filters on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many filters</summary>
      <request>
        <get_filters></get_filters>
      </request>
      <response>
        <get_filters_response status="200" status_text="OK">
          <filter id="b493b7a8-7489-11df-a3ec-001164764cea">
            <name>Single Targets</name>
            <comment>Targets with only one host</comment>
            <term>ips=1 first=1 rows=-2</term>
            <type>target</type>
            <in_use>1</in_use>
            <writable>1</writable>
            <user_tags>
              <count>0</count>
            </user_tags>
            <creation_time>Sun Jun 27 08:49:46 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:46 2010</modification_time>
          </filter>
          <truncated>...</truncated>
        </get_filters_response>
      </response>
    </example>
    <example>
      <summary>Get single filter, including alerts that use the filter</summary>
      <request>
        <get_filters filter_id="c33864a9-d3fd-44b3-8717-972bfb01dfc0" tasks="1">
        </get_filters>
      </request>
      <response>
        <get_filters_response status="200" status_text="OK">
          <filter id="c33864a9-d3fd-44b3-8717-972bfb01dfc0">
            <name>Local</name>
            <comment>Any item with name containing 'local'.</comment>
            <term>name~local first=1 rows=-2</term>
            <type></type>
            <in_use>1</in_use>
            <writable>1</writable>
            <user_tags>
              <count>0</count>
            </user_tags>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <alerts>
              <alert id="13bb418a-4220-4575-b35b-ec398bff7418">
                <name>Local Mailer</name>
              </alert>
              <truncated>...</truncated>
            </alerts>
          </filter>
        </get_filters_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_groups</name>
    <summary>Get one or many groups</summary>
    <description>
      The client uses the get_groups command to get group information.
    </description>
    <pattern>
      <attrib>
        <name>group_id</name>
        <summary>ID of single group to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan groups instead</summary>
        <type>boolean</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>group</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>groups</e>
        <e>group_count</e>
      </pattern>
      <ele>
        <name>group</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>users</e>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the group</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the group</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the group</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the group was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the group was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>users</name>
          <summary>
            A comma-separated list of the users in the group
          </summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the group is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether the group is in use</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the group</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the group</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>groups</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First group</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of groups</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>group_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of groups after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of groups on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many groups</summary>
      <request>
        <get_groups></get_groups>
      </request>
      <response>
        <get_groups_response status="200" status_text="OK">
          <group id="b493b7a8-7489-11df-a3ec-002264764cea">
            <name>Management</name>
            <comment>Managers</comment>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <users>sarah, frank</users>
          </group>
          <truncated>...</truncated>
          <filters id="">
            <term>first=1 rows=-1 sort=name</term>
            <keywords>
              <keyword>
                <column>first</column>
                <relation>=</relation>
                <value>1</value>
              </keyword>
              <truncated>...</truncated>
            </keywords>
          </filters>
          <sort>
            <field>
              name
              <order>ascending</order>
            </field>
          </sort>
          <groups max="-1" start="1"></groups>
          <group_count>
            1
            <filtered>1</filtered>
            <page>1</page>
          </group_count>
        </get_groups_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_info</name>
    <summary>Get information for items of given type</summary>
    <description>
      The client uses the get_info command to get information about
      static data from an external source, like CVE or CPE.
      If the command sent by the client was valid, the manager will
      reply with a list of info elements of a given type to the client.
    </description>
    <pattern>
      <attrib>
        <name>type</name>
        <summary>Type must be either CERT_BUND_ADV, CPE, CVE, DFN_CERT_ADV, OVALDEF, NVT or ALLINFO</summary>
        <type>text</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>name</name>
        <summary>Name or identifier of the requested information</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>info_id</name>
        <summary>ID of single info to get. Conflicts with name</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Severity of the SecInfo</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is "nvt"</condition>
          <column>
            <name>version</name>
            <type>text</type>
            <summary>Version of the NVT</summary>
          </column>
          <column>
            <name>summary</name>
            <type>text</type>
            <summary>Summary text of the NVT</summary>
          </column>
          <column>
            <name>cve</name>
            <type>text</type>
            <summary>List of BIDs of the NVT</summary>
          </column>
          <column>
            <name>xref</name>
            <type>text</type>
            <summary>List of XREFs of the NVT</summary>
          </column>
          <column>
            <name>family</name>
            <type>text</type>
            <summary>Family of the NVT</summary>
          </column>
          <column>
            <name>cvss</name>
            <type>severity</type>
            <summary>Alias for severity</summary>
          </column>
          <column>
            <name>cvss_base</name>
            <type>severity</type>
            <summary>Alias for severity</summary>
          </column>
          <column>
            <name>script_tags</name>
            <type>text</type>
            <summary>List of script tags</summary>
          </column>
          <column>
            <name>qod</name>
            <type>integer</type>
            <summary>Numerical QoD</summary>
          </column>
          <column>
            <name>qod_type</name>
            <type>text</type>
            <summary>QoD type</summary>
          </column>
          <column>
            <name>solution_type</name>
            <type>text</type>
            <summary>Solution type</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is "cve"</condition>
          <column>
            <name>vector</name>
            <type>text</type>
            <summary>"Vector" component of the CVSS base vector</summary>
          </column>
          <column>
            <name>complexity</name>
            <type>text</type>
            <summary>"Complexity" component of the CVSS base vector</summary>
          </column>
          <column>
            <name>authentication</name>
            <type>text</type>
            <summary>"Authentication" component of the CVSS base vector</summary>
          </column>
          <column>
            <name>confidentiality_impact</name>
            <type>text</type>
            <summary>"Confidentiality Impact" component of the CVSS base vector</summary>
          </column>
          <column>
            <name>integrity_impact</name>
            <type>text</type>
            <summary>"Integrity Impact" component of the CVSS base vector</summary>
          </column>
          <column>
            <name>availability_impact</name>
            <type>text</type>
            <summary>"Availability Impact" component of the CVSS base vector</summary>
          </column>
          <column>
            <name>products</name>
            <type>text</type>
            <summary>Space separated list CPEs the CVE applies to</summary>
          </column>
          <column>
            <name>cvss</name>
            <type>severity</type>
            <summary>Alias for severity</summary>
          </column>
          <column>
            <name>description</name>
            <type>text</type>
            <summary>Description text of the CVE</summary>
          </column>
          <column>
            <name>published</name>
            <type><t>iso_time</t></type>
            <summary>Time the CVE was published, alias for created</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is "cpe"</condition>
          <column>
            <name>title</name>
            <type>text</type>
            <summary>Title text of the CPE</summary>
          </column>
          <column>
            <name>status</name>
            <type>text</type>
            <summary>Status of the CPE</summary>
          </column>
          <column>
            <name>deprecated_by_id</name>
            <type>text</type>
            <summary>NVD ID that has deprecated this CPE</summary>
          </column>
          <column>
            <name>max_cvss</name>
            <type>severity</type>
            <summary>Alias for severity</summary>
          </column>
          <column>
            <name>cves</name>
            <type>integer</type>
            <summary>Number of CVEs referencing this CPE</summary>
          </column>
          <column>
            <name>nvd_id</name>
            <type>integer</type>
            <summary>NVD ID of the CVE</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is "ovaldef"</condition>
          <column>
            <name>version</name>
            <type>integer</type>
            <summary>Version number of the OVAL Definition</summary>
          </column>
          <column>
            <name>deprecated</name>
            <type>boolean</type>
            <summary>Whether the OVAL Definition is deprecated</summary>
          </column>
          <column>
            <name>class</name>
            <type>text</type>
            <summary>Class of the OVAL Definition</summary>
          </column>
          <column>
            <name>title</name>
            <type>text</type>
            <summary>Title of the OVAL Definition</summary>
          </column>
          <column>
            <name>description</name>
            <type>text</type>
            <summary>Longer description of the OVAL Definition</summary>
          </column>
          <column>
            <name>file</name>
            <type>text</type>
            <summary>Name of the file containing the OVAL Definition</summary>
          </column>
          <column>
            <name>status</name>
            <type>text</type>
            <summary>Status of the OVAL Definition</summary>
          </column>
          <column>
            <name>max_cvss</name>
            <type>severity</type>
            <summary>Alias for severity</summary>
          </column>
          <column>
            <name>cves</name>
            <type>integer</type>
            <summary>Number of CVEs referencing this CPE</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is either "cert_bund_adv" or "dfn_cert_adv"</condition>
          <column>
            <name>title</name>
            <type>text</type>
            <summary>Title text of the CERT advisory</summary>
          </column>
          <column>
            <name>summary</name>
            <type>text</type>
            <summary>Summary text of the CERT advisory</summary>
          </column>
          <column>
            <name>cves</name>
            <type>integer</type>
            <summary>Number of CVEs referenced by the CERT advisory</summary>
          </column>
          <column>
            <name>max_cvss</name>
            <type>severity</type>
            <summary>Alias for severity</summary>
          </column>
        </filter_keywords>
        <filter_keywords>
          <condition>type is "allinfo"</condition>
          <column>
            <name>type</name>
            <type>text</type>
            <summary>Type of SecInfo as given in the "type" parameter</summary>
          </column>
          <column>
            <name>extra</name>
            <type>text</type>
            <summary>Title or similar text</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Whether to include information about references to this information</summary>
        <type>boolean</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>info</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>details</e>
        <e>info_count</e>
      </pattern>
      <ele>
        <name>info</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>integer</type>
            <summary>A unique number identifying this info, if available</summary>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>update_time</e>
          <or>
            <e>cert_bund_adv</e>
            <e>cpe</e>
            <e>cve</e>
            <e>dfn_cert_adv</e>
            <e>ovaldef</e>
            <e>nvt</e>
            <e>allinfo</e>
          </or>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the info</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the info</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the info</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the info was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the info was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>update_time</name>
          <summary>Date and time the source of the info was read</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the info</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the info</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>cert_bund_adv</name>
          <pattern>
            <e>title</e>
            <e>summary</e>
            <e>max_cvss</e>
            <e>cve_refs</e>
            <o><e>raw_data</e></o>
          </pattern>
          <summary>An CERT-Bund advisory info element</summary>
          <ele>
            <name>title</name>
            <summary>Title of the advisory</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>summary</name>
            <summary>Summary text of the advisory</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>max_cvss</name>
            <summary>Highest CVSS score of CVEs referenced by the advisory</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>cve_refs</name>
            <summary>Number of CVEs referenced by this advisory</summary>
            <pattern>
              <t>integer</t>
            </pattern>
          </ele>
          <ele>
            <name>raw_data</name>
            <summary>Source representation of the information. Only when details were requested</summary>
            <pattern>
              text
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>cpe</name>
          <pattern>
            <e>nvd_id</e>
            <o><e>title</e></o>
            <e>max_cvss</e>
            <e>cve_refs</e>
            <e>status</e>
            <o><e>cves</e></o>
            <o><e>raw_data</e></o>
          </pattern>
          <summary>A CPE info element</summary>
          <ele>
            <name>nvd_id</name>
            <summary>The NVD ID of the CPE</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>title</name>
            <summary>The title of the CPE</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>max_cvss</name>
            <summary>The highest CVSS recorder for this CPE</summary>
            <pattern>
              <t>integer</t>
            </pattern>
          </ele>
          <ele>
            <name>cve_refs</name>
            <summary>The number CVE of references to this CPE</summary>
            <pattern>
              <t>integer</t>
            </pattern>
          </ele>
          <ele>
            <name>status</name>
            <summary>The status of this CPE</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>cves</name>
            <summary>CVEs referring to this CPE. Only when details were requested</summary>
            <pattern>
              <any><e>cve</e></any>
            </pattern>
            <ele>
              <name>cve</name>
              <summary>CVE referring to this CPE</summary>
              <pattern>
                text
              </pattern>
            </ele>
          </ele>
          <ele>
            <name>raw_data</name>
            <summary>Source representation of the information. Only when details were requested</summary>
            <pattern>
              text
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>nvt</name>
          <pattern>
            text
          </pattern>
          <summary>A NVT info element</summary>
        </ele>
        <ele>
          <name>cve</name>
          <pattern>
            <e>cvss</e>
            <e>vector</e>
            <e>complexity</e>
            <e>authentication</e>
            <e>confidentiality_impact</e>
            <e>integrity_impact</e>
            <e>availability_impact</e>
            <e>description</e>
            <e>products</e>
            <o><e>nvts</e></o>
            <o><e>cert</e></o>
            <o><e>raw_data</e></o>
          </pattern>
          <summary>A CVE info element</summary>
          <ele>
            <name>cvss</name>
            <summary>CVSS Base Score</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>vector</name>
            <summary>CVSS Access Vector metric</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>complexity</name>
            <summary>CVSS Attack Complexity metric</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>authentication</name>
            <summary>CVSS Authentication metric</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>confidentiality_impact</name>
            <summary>CVSS Confidentiality impact metric</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>integrity_impact</name>
            <summary>CVSS Integrity impact metric</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>availability_impact</name>
            <summary>CVSS Availability impact metric</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>description</name>
            <summary>The CVE's description</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>products</name>
            <summary>Space separated list of CPEs affected by this</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>nvts</name>
            <summary>NVTs addressing this CVE. Only when details were requested</summary>
            <pattern>
              <any><e>nvt</e></any>
            </pattern>
            <ele>
              <name>nvt</name>
              <summary>NVT referring to this CPE</summary>
              <pattern>
                <attrib>
                  <name>oid</name>
                  <type>oid</type>
                </attrib>
                <e>name</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>Name of the NVT</summary>
                <pattern>
                  text
                </pattern>
              </ele>
            </ele>
          </ele>
          <ele>
            <name>cert</name>
            <summary>List of CERT advisories referencing this CVE</summary>
            <pattern>
              <any><e>cert_ref</e></any>
              <o><e>warning</e></o>
            </pattern>
            <ele>
              <name>cert_ref</name>
              <summary>A CERT advisory reference</summary>
              <pattern>
                <attrib>
                  <name>type</name>
                  <summary>Type of the advisory (e.g. "DFN-CERT", "CERT-BUND")</summary>
                  <type>text</type>
                </attrib>
                <e>name</e>
                <e>title</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>The name / ID of the advisory</summary>
                <pattern>
                  text
                </pattern>
              </ele>
              <ele>
                <name>title</name>
                <summary>The title of the advisory</summary>
                <pattern>
                  text
                </pattern>
              </ele>
            </ele>
            <ele>
              <name>warning</name>
              <summary>A warning message, e.g. when the database is unavailable</summary>
              <pattern>
                text
              </pattern>
            </ele>
          </ele>
          <ele>
            <name>raw_data</name>
            <summary>Source representation of the information. Only when details were requested</summary>
            <pattern>
              text
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>dfn_cert_adv</name>
          <pattern>
            <e>title</e>
            <e>summary</e>
            <e>max_cvss</e>
            <e>cve_refs</e>
            <o><e>raw_data</e></o>
          </pattern>
          <summary>An DFN-CERT advisory info element</summary>
          <ele>
            <name>title</name>
            <summary>Title of the advisory</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>summary</name>
            <summary>Summary text of the advisory</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>max_cvss</name>
            <summary>Highest CVSS score of CVEs referenced by the advisory</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>cve_refs</name>
            <summary>Number of CVEs referenced by this advisory</summary>
            <pattern>
              <t>integer</t>
            </pattern>
          </ele>
          <ele>
            <name>raw_data</name>
            <summary>Source representation of the information. Only when details were requested</summary>
            <pattern>
              text
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>ovaldef</name>
          <pattern>
            <e>version</e>
            <e>deprecated</e>
            <e>status</e>
            <e>class</e>
            <e>title</e>
            <e>max_cvss</e>
            <e>cve_refs</e>
            <e>file</e>
            <o><e>description</e></o>
            <o><e>raw_data</e></o>
          </pattern>
          <summary>An OVAL definition info element</summary>
          <ele>
            <name>version</name>
            <summary>Version number of the OVAL definition</summary>
            <pattern>
              <t>integer</t>
            </pattern>
          </ele>
          <ele>
            <name>deprecated</name>
            <summary>Whether the definition is deprecated</summary>
            <pattern>
              <t>boolean</t>
            </pattern>
          </ele>
          <ele>
            <name>status</name>
            <summary>Lifecycle status text of the definition</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>class</name>
            <summary>Definition class of the definition</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>title</name>
            <summary>Title of the definition</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>max_cvss</name>
            <summary>Highest CVSS score of CVEs referenced by the definition</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>cve_refs</name>
            <summary>Number of CVEs referenced by the definition</summary>
            <pattern>integer</pattern>
          </ele>
          <ele>
            <name>file</name>
            <summary>Path to the source xml file, relative to the SCAP data directory</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>description</name>
            <summary>Longer description of the definition. Only when details were requested</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>raw_data</name>
            <summary>Source representation of the information. Only when details were requested</summary>
            <pattern>
              text
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>allinfo</name>
          <pattern>
            <e>type</e>
            <e>extra</e>
            <e>severity</e>
          </pattern>
          <summary>A SecInfo entry. Could be CPE, CVE, NVT, OVALDEF or DFN-CERT Advisory</summary>
          <ele>
            <name>type</name>
            <summary>Type of SecInfo entry</summary>
            <pattern>
              <t>text</t>
            </pattern>
          </ele>
          <ele>
            <name>extra</name>
            <summary>Extra information from the entry like title or description</summary>
            <pattern>
              <t>text</t>
            </pattern>
          </ele>
          <ele>
            <name>severity</name>
            <summary>Severity rating (CVSS score) of the entry</summary>
            <pattern>
              <t>severity</t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <type>text</type>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>info_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of info elements after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of info elements on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
      <ele>
        <name>details</name>
        <summary>Are details included in this response</summary>
        <type>boolean</type>
      </ele>
    </response>
    <example>
      <summary>Get a info about cpe:/a:gnu:gzip:1.3.3 with all details</summary>
      <request>
        <get_info type="CPE" name="cpe:/a:gnu:gzip:1.3.3" details="1"/>
      </request>
      <response>
        <get_info_response status_text="OK" status="200">
          <info id="28139">
            <name>cpe:/a:gnu:gzip:1.3.3</name>
            <comment/>
            <creation_time>2007-09-14T17:36:49Z</creation_time>
            <modification_time>2007-09-14T17:36:49Z</modification_time>
            <writable>0</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <update_time>2012-10-26T13:18:00.000+0000</update_time>
            <cpe>
              <title>GNU Gzip 1.3.3</title>
              <max_cvss>10.0</max_cvss>
              <cve_refs>5</cve_refs>
              <status>DRAFT</status>
              <cves>
                <cve>
                  <entry xmlns:vuln="http://scap.nist.gov/schema/vulnerability/0.4"
                    xmlns="http://scap.nist.gov/schema/feed/vulnerability/2.0"
                    xmlns:patch="http://scap.nist.gov/schema/patch/0.1"
                    xmlns:cpe-lang="http://cpe.mitre.org/language/2.0"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.1"
                    xmlns:cvss="http://scap.nist.gov/schema/cvss-v2/0.2"
                    id="CVE-2004-0603">
                    <vuln:cvss>
                      <cvss:base_metrics>
                        <cvss:score>10.0</cvss:score>
                      </cvss:base_metrics>
                    </vuln:cvss>
                  </entry>
                </cve>
                <cve>
                  <entry xmlns:vuln="http://scap.nist.gov/schema/vulnerability/0.4"
                    xmlns="http://scap.nist.gov/schema/feed/vulnerability/2.0"
                    xmlns:patch="http://scap.nist.gov/schema/patch/0.1"
                    xmlns:cpe-lang="http://cpe.mitre.org/language/2.0"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.1"
                    xmlns:cvss="http://scap.nist.gov/schema/cvss-v2/0.2"
                    id="CVE-2010-0001">
                    <vuln:cvss>
                      <cvss:base_metrics>
                        <cvss:score>6.8</cvss:score>
                      </cvss:base_metrics>
                    </vuln:cvss>
                  </entry>
                </cve>
                <cve>
                  <entry xmlns:vuln="http://scap.nist.gov/schema/vulnerability/0.4"
                    xmlns="http://scap.nist.gov/schema/feed/vulnerability/2.0"
                    xmlns:patch="http://scap.nist.gov/schema/patch/0.1"
                    xmlns:cpe-lang="http://cpe.mitre.org/language/2.0"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.1"
                    xmlns:cvss="http://scap.nist.gov/schema/cvss-v2/0.2"
                    id="CVE-2009-2624">
                    <vuln:cvss>
                      <cvss:base_metrics>
                        <cvss:score>6.8</cvss:score>
                      </cvss:base_metrics>
                    </vuln:cvss>
                  </entry>
                </cve>
                <cve>
                  <entry xmlns:vuln="http://scap.nist.gov/schema/vulnerability/0.4"
                    xmlns="http://scap.nist.gov/schema/feed/vulnerability/2.0"
                    xmlns:patch="http://scap.nist.gov/schema/patch/0.1"
                    xmlns:cpe-lang="http://cpe.mitre.org/language/2.0"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.1"
                    xmlns:cvss="http://scap.nist.gov/schema/cvss-v2/0.2"
                    id="CVE-2005-1228">
                    <vuln:cvss>
                      <cvss:base_metrics>
                        <cvss:score>5.0</cvss:score>
                      </cvss:base_metrics>
                    </vuln:cvss>
                  </entry>
                </cve>
                <cve>
                  <entry xmlns:vuln="http://scap.nist.gov/schema/vulnerability/0.4"
                    xmlns="http://scap.nist.gov/schema/feed/vulnerability/2.0"
                    xmlns:patch="http://scap.nist.gov/schema/patch/0.1"
                    xmlns:cpe-lang="http://cpe.mitre.org/language/2.0"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.1"
                    xmlns:cvss="http://scap.nist.gov/schema/cvss-v2/0.2"
                    id="CVE-2005-0988">
                    <vuln:cvss>
                      <cvss:base_metrics>
                        <cvss:score>3.7</cvss:score>
                      </cvss:base_metrics>
                    </vuln:cvss>
                  </entry>
                </cve>
              </cves>
              <raw_data>
                <cpe-item xmlns:ns6="http://scap.nist.gov/schema/scap-core/0.1"
                  xmlns:config="http://scap.nist.gov/schema/configuration/0.1"
                  xmlns:meta="http://scap.nist.gov/schema/cpe-dictionary-metadata/0.2"
                  xmlns="http://cpe.mitre.org/dictionary/2.0"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:scap-core="http://scap.nist.gov/schema/scap-core/0.3"
                  name="cpe:/a:gnu:gzip:1.3.3">
                  <title xml:lang="en-US">GNU Gzip 1.3.3</title>
                  <meta:item-metadata nvd-id="28139" status="DRAFT" modification-date="2007-09-14T17:36:49.090Z"/>
                </cpe-item>
              </raw_data>
            </cpe>
          </info>
          <details>1</details>
          <filters id="(null)">
            <term/>
          </filters>
          <sort>
            <field>name<order>ascending</order></field>
          </sort>
          <info max="-1" start="1"/>
          <info_count>
            <filtered>1</filtered>
            <page>1</page>
          </info_count>
        </get_info_response>
      </response>
    </example>
    <example>
      <summary>Get a info CVE-1999-0010 without details</summary>
      <request>
        <get_info name="CVE-2011-0018" type="cve"/>
      </request>
      <response>
        <get_info_response status_text="OK" status="200">
          <info id="CVE-2011-0018">
            <name>CVE-2011-0018</name>
            <comment/>
            <creation_time>2011-01-28T16:00:02Z</creation_time>
            <modification_time>2011-02-05T07:01:22Z</modification_time>
            <writable>0</writable>
            <in_use>0</in_use>
            <update_time>2012-10-26T13:18:00.000+0000</update_time>
            <user_tags>
              <count>0</count>
            </user_tags>
            <cve>
              <cvss>9.0</cvss>
              <vector>NETWORK</vector>
              <complexity>LOW</complexity>
              <authentication>SINGLE_INSTANCE</authentication>
              <confidentiality_impact>COMPLETE</confidentiality_impact>
              <integrity_impact>COMPLETE</integrity_impact>
              <availability_impact>COMPLETE</availability_impact>
              <description>The email function in manage_sql.c in ...(truncated for example)</description>
              <products>cpe:/a:openvas:openvas_manager:1.0.1 ...(truncated for example)</products>
            </cve>
          </info>
          <filters id="(null)">
            <term/>
          </filters>
          <sort>
            <field>name<order>ascending</order></field>
          </sort>
          <info max="-1" start="1"/>
          <info_count>
            <filtered>1</filtered>
            <page>1</page>
          </info_count>
        </get_info_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_notes</name>
    <summary>Get one or many notes</summary>
    <description>
      The client uses the get_notes command to get note information.
      If the command sent by the client was valid, the manager will
      reply with a list of notes to the client.
    </description>
    <pattern>
      <attrib>
        <name>note_id</name>
        <summary>ID of single note to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>nvt</name>
            <type>oid</type>
            <summary>OID of the NVT the Note applies to</summary>
          </column>
          <column>
            <name>text</name>
            <type>text</type>
            <summary>Text of the Note</summary>
          </column>
          <column>
            <name>nvt_id</name>
            <type>oid</type>
            <summary>Alias of nvt</summary>
          </column>
          <column>
            <name>task_name</name>
            <type>text</type>
            <summary>Name of the Task the Note applies to</summary>
          </column>
          <column>
            <name>task_id</name>
            <type>uuid</type>
            <summary>UUID of the Task the Note applies to</summary>
          </column>
          <column>
            <name>hosts</name>
            <type>text</type>
            <summary>Hosts the Note applies to</summary>
          </column>
          <column>
            <name>port</name>
            <type>text</type>
            <summary>Port the Note applies to</summary>
          </column>
          <column>
            <name>active</name>
            <type>boolean</type>
            <summary>Whether the Note is active</summary>
          </column>
          <column>
            <name>result</name>
            <type>uuid</type>
            <summary>UUID of the result the Note applies to</summary>
          </column>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Minimum severity of results the Note applies to</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>nvt_oid</name>
        <type>oid</type>
      </attrib>
      <attrib>
        <name>task_id</name>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>details</name>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>result</name>
        <type>boolean</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>note</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>notes</e>
        <e>note_count</e>
      </pattern>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>notes</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First note</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of notes</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>note_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of notes after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of notes on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
      <ele>
        <name>note</name>
        <type>note</type>
      </ele>
    </response>
    <example>
      <summary>Get one or many notes</summary>
      <request>
        <get_notes></get_notes>
      </request>
      <response>
        <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>
            <creation_time>2013-01-09T09:47:41+01:00</creation_time>
            <modification_time>2013-01-09T09:47:41+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <active>1</active>
            <orphan>1</orphan>
            <user_tags>
              <count>0</count>
            </user_tags>
            <text excerpt="0">This is the full text of the note.</text>
          </note>
          <truncated>...</truncated>
        </get_notes_response>
      </response>
    </example>
    <example>
      <summary>Get details of a single note and result to which it applies</summary>
      <request>
        <get_notes note_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1" result="1">
        </get_notes>
      </request>
      <response>
        <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>
            <writable>1</writable>
            <in_use>0</in_use>
            <active>1</active>
            <end_time></end_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>
            <user_tags>
              <count>0</count>
            </user_tags>
            <result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de">
              <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>
                <cve></cve>
                <bid></bid>
              </nvt>
              <threat>Medium</threat>
              <description>Warning with control char between fullstops: . .</description>
            </result>
          </note>
          <truncated>...</truncated>
        </get_notes_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_nvts</name>
    <summary>Get one or many NVTs</summary>
    <description>
      <p>
        The client uses the get_nvts command to get NVT information.
      </p>
      <!-- TODO The RNC should specify that some flags require others. -->
      <p>
        This command may always include a details flag, a config, a sort
        order and a sort field.  If the command includes a details flag, the
        manager also consults the timeout, preference_count and preferences
        flags.
      </p>
      <p>
        The NVT OID, family name and config attributes limit the listing to
        a single NVT or all NVTs in a particular family and/or config.
      </p>
      <p>
        If the details flag is present the manager will send full details
        of the NVT, otherwise it will send just the NVT name.
      </p>
      <p>
        With the preferences flag the manager includes in the listing, the
        values of each listed NVT's preferences for the given config.  The
        timeout flag does the same for the special timeout preference.
        If the config contains no values for a preference, the default value
        of the preference is returned. The same applies if no config is given.
      </p>
      <p>
        If the manager possesses an NVT collection, it will reply with the
        NVT information.  If the manager cannot access a list of available
        NVTs at that time, it will reply with the 503 response.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>nvt_oid</name>
        <summary>Single NVT to get</summary>
        <type>oid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Whether to include full details</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>preferences</name>
        <summary>Whether to include preference</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>preference_count</name>
        <summary>Whether to include preference count</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>timeout</name>
        <summary>Whether to include the special timeout preference</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>config_id</name>
        <summary>ID of config to which to limit the NVT listing</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>preferences_config_id</name>
        <summary>ID of config to use for preference values</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>family</name>
        <summary>Family to which to limit NVT listing</summary>
        <type>text</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>
        <e>nvt</e>
      </pattern>
      <ele>
        <name>nvt</name>
        <pattern>
          <attrib>
            <name>oid</name>
            <type>oid</type>
            <required>1</required>
          </attrib>
          <e>name</e>
          <e>user_tags</e>
          <o>
            <g>
              <e>creation_time</e>
              <e>modification_time</e>
              <e>category</e>
              <e>copyright</e>
              <e>summary</e>
              <e>family</e>
              <e>version</e>
              <e>cvss_base</e>
              <e>qod</e>
              <e>cve_id</e>
              <e>cert_refs</e>
              <e>bugtraq_id</e>
              <e>xrefs</e>
              <e>tags</e>
              <o><e>preference_count</e></o>
              <o><e>timeout</e></o>
              <o><e>preferences</e></o>
            </g>
          </o>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the NVT</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>category</name>
          <summary>The category of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>The creation time of the NVT</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>The modification time of the NVT</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the NVT</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>copyright</name>
          <summary>Copyright info of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>summary</name>
          <summary>Short description of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>family</name>
          <summary>Name of the family the NVT belongs to</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>version</name>
          <summary>Version of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>cvss_base</name>
          <summary>CVSS base score of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>qod</name>
          <summary>The quality of detection (QoD) of the NVT</summary>
          <pattern>
            <e>value</e>
            <e>type</e>
          </pattern>
          <ele>
            <name>value</name>
            <summary>The numeric QoD value</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>type</name>
            <summary>The QoD type</summary>
            <pattern>text</pattern>
          </ele>
        </ele>
        <ele>
          <name>cve_id</name>
          <summary>IDs of the CVEs the NVT adresses</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>bugtraq_id</name>
          <summary>List of Bugtraq IDs of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>cert_refs</name>
          <summary>List of CERT advisories referencing this NVT via CVEs</summary>
          <pattern>
            <any><e>cert_ref</e></any>
            <o><e>warning</e></o>
          </pattern>
          <ele>
            <name>cert_ref</name>
            <summary>A CERT advisory reference</summary>
            <pattern>
              <attrib>
                <name>id</name>
                <summary>ID of the advisory</summary>
                <type>text</type>
              </attrib>
              <attrib>
                <name>type</name>
                <summary>Type of the advisory (e.g. "DFN-CERT", "CERT-BUND")</summary>
                <type>text</type>
              </attrib>
            </pattern>
          </ele>
          <ele>
            <name>warning</name>
            <summary>A warning message, e.g. when the database is not</summary>
            <pattern>
              text
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>xrefs</name>
          <summary>List of other references of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>tags</name>
          <summary>The tags of the NVT, separated by vertical bars</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>preference_count</name>
          <summary>The number of preferences for the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>timeout</name>
          <summary>The timeout of the NVT</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>preferences</name>
          <summary>List of preferences of the NVT</summary>
          <pattern>
            <e>timeout</e>
            <any><e>preference</e></any>
            text
          </pattern>
          <ele>
            <name>timeout</name>
            <summary>The timeout of the NVT</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>preference</name>
            <pattern>
              <e>nvt</e>
              <e>name</e>
              <e>type</e>
              <e>value</e>
              <any><e>alt</e></any>
              <e>default</e>
            </pattern>
            <ele>
              <name>nvt</name>
              <summary>NVT to which preference applies</summary>
              <pattern>
                <attrib>
                  <name>oid</name>
                  <type>oid</type>
                  <required>1</required>
                </attrib>
                <e>name</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>The name of the NVT</summary>
                <pattern><t>name</t></pattern>
              </ele>
            </ele>
            <ele>
              <name>name</name>
              <summary>The name of the preference</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>type</name>
              <summary>The type of the preference</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The value of the preference</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>alt</name>
              <summary>An alternate value of the preference</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>default</name>
              <summary>The default value of the preference</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get full NVT listing with details</summary>
      <request>
        <get_nvts details="1">
        </get_nvts>
      </request>
      <response>
        <get_nvts_response status="200" status_text="OK">
          <nvt oid="1.3.6.1.4.1.25623.1.7.13005">
            <name>Services</name>
            <creation_time>2011-01-14T10:12:23+01:00</creation_time>
            <modification_time>2012-09-19T20:56:15+02:00</modification_time>
            <user_tags>
              <count>0</count>
            </user_tags>
            <category>Services</category>
            <copyright>GNU GPL v2</copyright>
            <summary>Find what is listening on which port</summary>
            <family>Service detection</family>
            <version>$Revision: 1852 $</version>
            <cvss_base></cvss_base>
            <cve_id>NOCVE</cve_id>
            <bugtraq_id>NOBID</bugtraq_id>
            <cert_refs/>
            <xrefs>NOXREF</xrefs>
            <tags>NOTAG</tags>
            <preference_count>-1</preference_count>
            <timeout></timeout>

            <preferences>
              <timeout></timeout>
              <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>
                <default>5</default>
              </preference>
              <truncated>...</truncated>
            </preferences>
          </nvt>
          <nvt oid="1.3.6.1.4.1.25623.1.7.13006">
            <name>FooBar 21</name>
            <creation_time>2011-01-14T10:12:23+01:00</creation_time>
            <modification_time>2012-09-19T20:56:15+02:00</modification_time>
            <category>Services</category>
            <copyright>GNU GPL v2</copyright>
            <description>This script detects whether the FooBar 2.1 XSS vulnerability is present.</description>
            <truncated>...</truncated>
          </nvt>
          <truncated>...</truncated>
        </get_nvts_response>
      </response>
    </example>
    <example>
      <summary>Get minimal information about one NVT</summary>
      <request>
        <get_nvts nvt_oid="1.3.6.1.4.1.25623.1.0.10330">
        </get_nvts>
      </request>
      <response>
        <get_nvts_response status="200" status_text="OK">
          <nvt oid="1.3.6.1.4.1.25623.1.0.10330">
            <name>Services</name>
            <user_tags>
              <count>0</count>
            </user_tags>
          </nvt>
        </get_nvts_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_nvt_families</name>
    <summary>Get a list of all NVT families</summary>
    <description>
      <p>
        The client uses the get_nvt_families command to get NVT family
        information.  If the command sent by the client was valid, the
        manager will reply with a list of NVT families to the client.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>sort_order</name>
        <type>sort_order</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>
        <e>families</e>
      </pattern>
      <ele>
        <name>families</name>
        <pattern><any><e>family</e></any></pattern>
        <ele>
          <name>family</name>
          <pattern>
            <e>name</e>
            <e>max_nvt_count</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the family</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>max_nvt_count</name>
            <summary>The number of NVTs in the family</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get the NVT families</summary>
      <request>
        <get_nvt_families></get_nvt_families>
      </request>
      <response>
        <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>
            <truncated>...</truncated>
          </families>
        </get_nvt_families_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_overrides</name>
    <summary>Get one or many overrides</summary>
    <description>
      The client uses the get_overrides command to get override information.
      If the command sent by the client was valid, the manager will
      reply with a list of overrides to the client.
    </description>
    <pattern>
      <attrib>
        <name>override_id</name>
        <summary>ID of single override to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>nvt</name>
            <type>oid</type>
            <summary>OID of the NVT the Override applies to</summary>
          </column>
          <column>
            <name>text</name>
            <type>text</type>
            <summary>Text of the Override</summary>
          </column>
          <column>
            <name>nvt_id</name>
            <type>oid</type>
            <summary>Alias of nvt</summary>
          </column>
          <column>
            <name>task_name</name>
            <type>text</type>
            <summary>Name of the Task the Override applies to</summary>
          </column>
          <column>
            <name>task_id</name>
            <type>uuid</type>
            <summary>UUID of the Task the Override applies to</summary>
          </column>
          <column>
            <name>hosts</name>
            <type>text</type>
            <summary>Hosts the Override applies to</summary>
          </column>
          <column>
            <name>port</name>
            <type>text</type>
            <summary>Port the Override applies to</summary>
          </column>
          <column>
            <name>threat</name>
            <type>threat</type>
            <summary>Minimum severity level the Override applies to</summary>
          </column>
          <column>
            <name>new_threat</name>
            <type>threat</type>
            <summary>Severity level results are changed to by the Override</summary>
          </column>
          <column>
            <name>active</name>
            <type>boolean</type>
            <summary>Whether the Override is active</summary>
          </column>
          <column>
            <name>result</name>
            <type>uuid</type>
            <summary>UUID of the result the Override applies to</summary>
          </column>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Minimum severity of results the Override applies to</summary>
          </column>
          <column>
            <name>new_severity</name>
            <type>severity</type>
            <summary>Severity level results are changed to by the Override</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>nvt_oid</name>
        <type>oid</type>
      </attrib>
      <attrib>
        <name>task_id</name>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>details</name>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>result</name>
        <type>boolean</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>override</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>overrides</e>
        <e>override_count</e>
      </pattern>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>overrides</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First override</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of overrides</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>override_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of overrides after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of overrides on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
      <ele>
        <name>override</name>
        <type>override</type>
      </ele>
    </response>
    <example>
      <summary>Get one or many overrides</summary>
      <request>
        <get_overrides></get_overrides>
      </request>
      <response>
        <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>
            <creation_time>2013-01-09T09:50:10+01:00</creation_time>
            <modification_time>2013-01-09T09:50:10+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <active>1</active>
            <text excerpt="0">This is the full text of the override.</text>
            <new_threat>Log</new_threat>
            <new_severity>0.0</new_severity>
            <orphan>1</orphan>
            <user_tags>
              <count>0</count>
            </user_tags>
          </override>
          <truncated>...</truncated>
        </get_overrides_response>
      </response>
    </example>
    <example>
      <summary>Get details of a single override</summary>
      <request>
        <get_overrides override_id="7f618bbb-4664-419e-9bbf-367d93954cb0" details="1">
        </get_overrides>
      </request>
      <response>
        <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>
            <writable>1</writable>
            <in_use>0</in_use>
            <active>1</active>
            <end_time></end_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>
            <new_severity>2.0</new_severity>
            <task id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4">
              <name>test</name>
            </task>
            <orphan>0</orphan>
            <user_tags>
              <count>0</count>
            </user_tags>
            <result id="0c95e6b3-1100-4dfd-88f1-4bed1fad29de" />
          </override>
          <truncated>...</truncated>
        </get_overrides_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_permissions</name>
    <summary>Get one or many permissions</summary>
    <description>
      The client uses the get_permissions command to get permission information.
    </description>
    <pattern>
      <attrib>
        <name>permission_id</name>
        <summary>ID of single permission to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>type</name>
            <type>text</type>
            <summary>The resource type the permission is for</summary>
          </column>
          <column>
            <name>resource_uuid</name>
            <type>text</type>
            <summary>UUID of the resource the permission is for</summary>
          </column>
          <column>
            <name>subject_type</name>
            <type>text</type>
            <summary>Type of the subject of the permission</summary>
          </column>
          <column>
            <name>subject</name>
            <type>text</type>
            <summary>Name of the subject of the permission</summary>
          </column>
          <column>
            <name>resource</name>
            <type>text</type>
            <summary>Name of the resource the permission is for</summary>
          </column>
          <column>
            <name>subject_uuid</name>
            <type>text</type>
            <summary>UUID of the subject of the permission</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan permissions instead</summary>
        <type>boolean</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>permission</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>permissions</e>
        <e>permission_count</e>
      </pattern>
      <ele>
        <name>permission</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>

          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>resource</e>
          <e>subject</e>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the permission</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the permission</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the permission</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the permission was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the permission was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>resource</name>
          <summary>The resource the permission applies to</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <summary>UUID if permission applies to a resource, else 0</summary>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>type</e>
            <e>trash</e>
            <e>deleted</e>
          </pattern>
          <ele>
            <name>name</name>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the resource</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>type</name>
            <summary>The OMP type of the resource</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the resource is in the trash</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>deleted</name>
            <summary>Whether the resource has been deleted</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>subject</name>
          <summary>The subject the permission applies to</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <summary>UUID of the subject</summary>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>type</e>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the subject</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>type</name>
            <summary>The OMP type of the subject: group, role or user</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the subject is in the trash</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>deleted</name>
            <summary>Whether the subject has been deleted</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the permission is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether the permission is in use</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the permission
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the permission</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>permissions</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First permission</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of permissions</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>permission_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of permissions after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of permissions on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many permissions</summary>
      <request>
        <get_permissions></get_permissions>
      </request>
      <response>
        <get_permissions_response status="200" status_text="OK">
          <permission id="b493b7a8-7489-11df-a3ec-002264764cea">
            <name>Management</name>
            <comment>Managers</comment>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <users>sarah, frank</users>
          </permission>
          <truncated>...</truncated>
          <filters id="">
            <term>first=1 rows=-1 sort=name</term>
            <keywords>
              <keyword>
                <column>first</column>
                <relation>=</relation>
                <value>1</value>
              </keyword>
              <truncated>...</truncated>
            </keywords>
          </filters>
          <sort>
            <field>
              name
              <order>ascending</order>
            </field>
          </sort>
          <permissions max="-1" start="1"></permissions>
          <permission_count>
            1
            <filtered>1</filtered>
            <page>1</page>
          </permission_count>
        </get_permissions_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_port_lists</name>
    <summary>Get one or many port lists</summary>
    <description>
      <p>
        The client uses the get_port_lists command to get port list
        information.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>port_list_id</name>
        <summary>ID of single port list to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>total</name>
            <type>integer</type>
            <summary>Total number of ports in the Port List</summary>
          </column>
          <column>
            <name>tcp</name>
            <type>integer</type>
            <summary>Number of TCP ports in the Port List</summary>
          </column>
          <column>
            <name>udp</name>
            <type>integer</type>
            <summary>Number of UDP ports in the Port List</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Whether to include full port list details</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>targets</name>
        <summary>Whether to include targets using this port list</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan port lists instead</summary>
        <type>boolean</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>port_list</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>port_lists</e>
        <e>port_list_count</e>
      </pattern>
      <ele>
        <name>port_list</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>port_count</e>
          <o><e>port_ranges</e></o>
          <o><e>targets</e></o>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the port list</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the port list</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the port list</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the port list is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any targets are using the port list</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the port list
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the port list</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>port_count</name>
          <pattern>
            <e>all</e>
            <e>tcp</e>
            <e>udp</e>
          </pattern>
          <ele>
            <name>all</name>
            <summary>Total number of ports</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tcp</name>
            <summary>Total number of TCP ports</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>udp</name>
            <summary>Total number of UDP ports</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>port_ranges</name>
          <pattern>
            <any><e>port_range</e></any>
          </pattern>
          <ele>
            <name>port_range</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>start</e>
              <e>end</e>
              <e>type</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>start</name>
              <summary>First port in range</summary>
              <pattern><t>integer</t></pattern>
            </ele>
            <ele>
              <name>end</name>
              <summary>Last port in range</summary>
              <pattern><t>integer</t></pattern>
            </ele>
            <ele>
              <name>type</name>
              <summary>The type of port: TCP, UDP, ...</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>The comment on the port range</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>targets</name>
          <summary>The targets using the port list</summary>
          <pattern>
            <any><e>target</e></any>
          </pattern>
          <ele>
            <name>target</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the target</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the target</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>port_lists</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First port list</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of port lists</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>port_list_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of port lists after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of port lists on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Export a port list</summary>
      <request>
        <get_port_lists port_list_id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d"
                        details="1" targets="1">
        </get_port_lists>
      </request>
      <response>
        <get_port_lists_response status="200" status_text="OK">
          <port_list id="b993b6f5-f9fb-4e6e-9c94-dd46c00e058d">
            <name>All TCP</name>
            <comment>Every single TCP port.</comment>
            <creation_time>2012-12-31T16:38:45+01:00</creation_time>
            <modification_time>2012-12-31T16:38:45+01:00</modification_time>
            <writable>0</writable>
            <in_use>1</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <port_count>
              <all>65535</all>
              <tcp>65535</tcp>
              <udp>0</udp>
            </port_count>
            <port_ranges>
              <port_range>
                <type>TCP</type>
                <start>1</start>
                <end>65535</end>
              </port_range>
            </port_ranges>
            <targets>
              <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
                <name>Web server</name>
              </target>
            </targets>
          </port_list>
        </get_port_lists_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_preferences</name>
    <summary>Get one or many preferences</summary>
    <description>
      <p>
        The client uses the get_preferences command to get preference information.
        If the command sent by the client was valid, the manager will reply with
        a list of preferences to the client.  If the manager cannot access a list
        of available NVTs at present, it will reply with the 503 response.
      </p>
      <p>
        When the command includes a config_id attribute, the preference element
        includes the preference name, type and value, and the NVT to which the
        preference applies.  Otherwise, the preference element includes just the
        name and value, with the NVT and type built into the name.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>nvt_oid</name>
        <type>oid</type>
      </attrib>
      <attrib>
        <name>config_id</name>
        <summary>ID of config of which to show preference values</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>preference</name>
        <summary>The name of a particular preference to get</summary>
        <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>preference</e></any>
      </pattern>
      <ele>
        <name>preference</name>
        <pattern>
          <e>nvt</e>
          <e>name</e>
          <e>type</e>
          <e>value</e>
          <any><e>alt</e></any>
          <e>default</e>
        </pattern>
        <ele>
          <name>nvt</name>
          <summary>NVT to which preference applies</summary>
          <pattern>
            <attrib>
              <name>oid</name>
              <type>oid</type>
              <required>1</required>
            </attrib>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the NVT</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the preference</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>type</name>
          <summary>The type of preference</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <summary>The value of the preference</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>alt</name>
          <summary>An alternate value of the preference</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>default</name>
          <summary>The default value of the preference</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get default preferences for all NVTs</summary>
      <request>
        <get_preferences></get_preferences>
      </request>
      <response>
        <get_preferences_response status="200" status_text="OK">
          <preference>
            <name>Services[entry]:Network connection timeout :</name>
            <value>5</value>
          </preference>
          <truncated>...</truncated>
        </get_preferences_response>
      </response>
    </example>
    <example>
      <summary>Get default preferences for a single NVT</summary>
      <request>
        <get_preferences nvt_oid="1.3.6.1.4.1.25623.1.0.10330">
        </get_preferences>
      </request>
      <response>
        <get_preferences_response status="200" status_text="OK">
          <preference>
            <name>Services[entry]:Network connection timeout :</name>
            <value>5</value>
            <default>5</default>
          </preference>
          <truncated>...</truncated>
        </get_preferences_response>
      </response>
    </example>
    <example>
      <summary>Get preferences from a config for all NVTs</summary>
      <request>
        <get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea">
        </get_preferences>
      </request>
      <response>
        <get_preferences_response status="200" status_text="OK">
          <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>
          <truncated>...</truncated>
        </get_preferences_response>
      </response>
    </example>
    <example>
      <summary>Get preferences from a config for a single NVT</summary>
      <request>
        <get_preferences config_id="daba56c8-73ec-11df-a475-002264764cea"
                         nvt_oid="1.3.6.1.4.1.25623.1.0.10330">
        </get_preferences>
      </request>
      <response>
        <get_preferences nvt_oid="1.3.6.1.4.1.25623.1.0.10330">
          <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>
            <default>5</default>
          </preference>
        </get_preferences>
      </response>
    </example>
  </command>
  <command>
    <name>get_reports</name>
    <summary>Get one or many reports</summary>
    <description>
      <p>
        The client uses the get_reports command to get report information.
      </p>
      <p>
        The XML report format is sent as XML.  All other formats are sent in
        Base64 encoding.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>report_id</name>
        <summary>ID of single report to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter results, when getting a single report</summary>
        <type>text</type>
        <filter_keywords>
          <option>
            <name>apply_overrides</name>
            <type>boolean</type>
            <summary>Whether to apply Overrides</summary>
          </option>
          <option>
            <name>autofp</name>
            <type>
              <alts>
                <alt>0</alt>
                <alt>1</alt>
                <alt>2</alt>
              </alts>
            </type>
            <summary>Whether to trust vendor security updates.
            1 full match, 2 partial</summary>
          </option>
          <option>
            <name>levels</name>
            <type>levels</type>
            <summary>Severity levels to select</summary>
          </option>
          <option>
            <name>min_qod</name>
            <type>integer</type>
            <summary>Minimum QoD of the results</summary>
          </option>
          <option>
            <name>notes</name>
            <type>boolean</type>
            <summary>Whether to include Notes in the report</summary>
          </option>
          <option>
            <name>overrides</name>
            <type>boolean</type>
            <summary>Whether to include Override descriptions in the report</summary>
          </option>
          <option>
            <name>timezone</name>
            <type>text</type>
            <summary>The timezone to use for the report</summary>
          </option>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name of the NVT</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>host</name>
            <type>text</type>
            <summary>Host IP address of the result</summary>
          </column>
          <column>
            <name>hostname</name>
            <type>text</type>
            <summary>Hostname of the result</summary>
          </column>
          <column>
            <name>location</name>
            <type>text</type>
            <summary>Port and protocol of the result</summary>
          </column>
          <column>
            <name>nvt</name>
            <type>text</type>
            <summary>Unique ID of the test that produced the result</summary>
          </column>
          <column>
            <name>type</name>
            <type>threat</type>
            <summary>Severity type of the result with overrides and autofp</summary>
          </column>
          <column>
            <name>original_type</name>
            <type>threat</type>
            <summary>Original severity type of the result</summary>
          </column>
          <column>
            <name>auto_type</name>
            <type>boolean</type>
            <summary>Whether autofp applies to the result</summary>
          </column>
          <column>
            <name>description</name>
            <type>text</type>
            <summary>Description of the result</summary>
          </column>
          <column>
            <name>task</name>
            <type>text</type>
            <summary>Name of the task</summary>
          </column>
          <column>
            <name>report</name>
            <type>number</type>
            <summary>Internal ID of the report</summary>
          </column>
          <column>
            <name>cvss_base</name>
            <type>severity</type>
            <summary>CVSS base score of the NVT that generated the result</summary>
          </column>
          <column>
            <name>nvt_version</name>
            <type>text</type>
            <summary>Version of the NVT that generated the result</summary>
          </column>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Severity of the result with overrides and autofp</summary>
          </column>
          <column>
            <name>original_severity</name>
            <type>severity</type>
            <summary>Original severity of the result</summary>
          </column>
          <column>
            <name>vulnerability</name>
            <type>text</type>
            <summary>Name of the NVT that generated result</summary>
          </column>
          <column>
            <name>date</name>
            <type>iso_time</type>
            <summary>Time the result was generated</summary>
          </column>
          <column>
            <name>report_id</name>
            <type>uuid</type>
            <summary>UUID of the report</summary>
          </column>
          <column>
            <name>solution_type</name>
            <type>text</type>
            <summary>Solution type of the result</summary>
          </column>
          <column>
            <name>qod</name>
            <type>integer</type>
            <summary>QoD of the result</summary>
          </column>
          <column>
            <name>qod_type</name>
            <type>text</type>
            <summary>QoD type of the result</summary>
          </column>
          <column>
            <name>task_id</name>
            <type>uuid</type>
            <summary>UUID of the task</summary>
          </column>
          <column>
            <name>cve</name>
            <type>text</type>
            <summary>List of CVEs of the result</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter results, when getting a single report</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>report_filter</name>
        <summary>Filter term to use to filter reports</summary>
        <type>text</type>
        <filter_keywords>
          <option>
            <name>apply_overrides</name>
            <type>boolean</type>
            <summary>Whether to apply Overrides</summary>
          </option>
          <option>
            <name>min_qod</name>
            <type>integer</type>
            <summary>Minimum QoD of the results</summary>
          </option>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>task_id</name>
            <type>uuid</type>
            <summary>UUID of the Task of the Report</summary>
          </column>
          <column>
            <name>name</name>
            <type>iso_time</type>
            <summary>Time the scan was started</summary>
          </column>
          <column>
            <name>date</name>
            <type>iso_time</type>
            <summary>Time of the scan</summary>
          </column>
          <column>
            <name>status</name>
            <type>text</type>
            <summary>Status of scan</summary>
          </column>
          <column>
            <name>task</name>
            <type>text</type>
            <summary>Name of the Task the report belongs to</summary>
          </column>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Highest severity of the results in the report</summary>
          </column>
          <column>
            <name>false_positive</name>
            <type>integer</type>
            <summary>Number of false positive results</summary>
          </column>
          <column>
            <name>log</name>
            <type>integer</type>
            <summary>Number of log results</summary>
          </column>
          <column>
            <name>low</name>
            <type>integer</type>
            <summary>Number of low severity results</summary>
          </column>
          <column>
            <name>medium</name>
            <type>integer</type>
            <summary>Number of medium severity results</summary>
          </column>
          <column>
            <name>high</name>
            <type>integer</type>
            <summary>Number of high severity results</summary>
          </column>
          <column>
            <name>hosts</name>
            <type>integer</type>
            <summary>Total number of hosts</summary>
          </column>
          <column>
            <name>result_hosts</name>
            <type>integer</type>
            <summary>Number of hosts with results matching the min_qod</summary>
          </column>
          <column>
            <name>fp_per_host</name>
            <type>integer</type>
            <summary>Number of false positive results per host with results</summary>
          </column>
          <column>
            <name>log_per_host</name>
            <type>integer</type>
            <summary>Number of log results per host with results</summary>
          </column>
          <column>
            <name>low_per_host</name>
            <type>integer</type>
            <summary>Number of low severity results per host with results</summary>
          </column>
          <column>
            <name>medium_per_host</name>
            <type>integer</type>
            <summary>Number of medium severity results per host with results</summary>
          </column>
          <column>
            <name>high_per_host</name>
            <type>integer</type>
            <summary>Number of high severity results per host with results</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>report_filt_id</name>
        <summary>ID of filter to use to filter reports</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>type</name>
        <summary>Type of report to get</summary>
        <type>
          <alts>
            <alt>scan</alt>
            <alt>assets</alt>
            <alt>prognostic</alt>
          </alts>
        </type>
      </attrib>
      <attrib>
        <name>format_id</name>
        <summary>ID of required report format</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>alert_id</name>
        <summary>ID of alert to pass generated report to</summary>
        <description>
          <p>
            In this case the response is empty, and simply indicates success
            via the status code.
          </p>
        </description>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>note_details</name>
        <summary>If notes are included, whether to include note details</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>override_details</name>
        <summary>If overrides are included, whether to include override details</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>host</name>
        <summary>For "assets" or "prognostic", single host to retrieve</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>host_first_result</name>
        <summary>For "assets" or "prognostic", first host to retrieve</summary>
        <type>integer</type>
      </attrib>
      <attrib>
        <name>host_max_results</name>
        <summary>
          For "assets" or "prognostic", maximum hosts to retrieve
        </summary>
        <type>integer</type>
      </attrib>
      <attrib>
        <name>host_levels</name>
        <summary>
          For "assets" or "prognostic", which threat levels to include in hosts
        </summary>
        <type>levels</type>
      </attrib>
      <attrib>
        <name>host_search_phrase</name>
        <summary>
          For "assets" or "prognostic", the search phrase to limit hosts to
        </summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>pos</name>
        <summary>For type "assets", position of report used, from end</summary>
        <type>integer</type>
      </attrib>
      <attrib>
        <name>delta_report_id</name>
        <summary>ID of second report, for producing a delta report</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>ignore_pagination</name>
        <summary>
          Whether to ignore info used to split the report into pages
          like the filter terms "first" and "rows".
        </summary>
        <type>boolean</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</e></any>
        <o>
          <g>
            <e>filters</e>
            <e>sort</e>
            <e>reports</e>
            <e>report_count</e>
          </g>
        </o>
      </pattern>
      <ele>
        <name>report</name>
        <summary>Actually attributes and either base64 or a report</summary>
        <type>report</type>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <any><e>filter</e></any>
          <o><e>host</e></o>
          <o><e>delta</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>filter</name>
          <summary>A severity level that is included in the report</summary>
          <pattern>
            <t>
              <alts>
                <alt>High</alt>
                <alt>Medium</alt>
                <alt>Low</alt>
                <alt>Log</alt>
                <alt>Debug</alt>
              </alts>
            </t>
          </pattern>
        </ele>
        <ele>
          <name>host</name>
          <summary>Single host selected for prognostic or delta report</summary>
          <pattern>
            <e>ip</e>
          </pattern>
          <ele>
            <name>ip</name>
            <summary>IP address of the host</summary>
            <pattern>text</pattern>
          </ele>
        </ele>
        <ele>
          <name>delta</name>
          <summary>Delta states</summary>
          <pattern>
            text
            <e>changed</e>
            <e>gone</e>
            <e>new</e>
            <e>same</e>
          </pattern>
          <ele>
            <name>changed</name>
            <summary>Whether changed results are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>gone</name>
            <summary>Whether results that have vanished are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>new</name>
            <summary>Whether new results are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>same</name>
            <summary>Whether results that are equal are included</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>reports</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First report</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of reports</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>report_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of reports after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of reports on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get a report in PDF</summary>
      <request>
        <get_reports report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
                     format_id="1a60a67e-97d0-4cbf-bc77-f71b08e7043d">
        </get_reports>
      </request>
      <response>
        <get_reports_response status="200" status_text="OK">
          <report id="267a3405-e84a-47da-97b2-5fa0d2e8995e"
                  format_id="1a60a67e-97d0-4cbf-bc77-f71b08e7043d"
                  extension="pdf"
                  content_type="application/pdf">
            hsisn3qaVFhkjFRG4...
          </report>
        </get_reports_response>
      </response>
    </example>
    <example>
      <summary>Get a report in XML</summary>
      <request>
        <get_reports report_id="f0fdf522-276d-4893-9274-fb8699dc2270">
        </get_reports>
      </request>
      <response>
        <get_reports_response status="200" status_text="OK">
          <report id="f0fdf522-276d-4893-9274-fb8699dc2270"
                  format_id="d5da9f67-8551-4e51-807b-b6a873d70e34"
                  extension="xml"
                  content_type="text/xml">
            <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
              <omp>
                <version>@OMP_VERSION@</version>
              </omp>
              <sort>
                <field>
                  type
                  <order>descending</order>
                </field>
              </sort>
              <filters id="0">
                <term>first=1 rows=-1 sort=name</term>
                <filter>High</filter>
                <filter>Medium</filter>
                <filter>Low</filter>
                <filter>Log</filter>
                <filter>Debug</filter>
                <keywords>
                  <keyword>
                    <column>first</column>
                    <relation>=</relation>
                    <value>1</value>
                  </keyword>
                  <keyword>
                    <column>rows</column>
                    <relation>=</relation>
                    <value>-1</value>
                  </keyword>
                  <keyword>
                    <column>sort</column>
                    <relation>=</relation>
                    <value>name</value>
                  </keyword>
                </keywords>
              </filters>
              <user_tags>
                <count>0</count>
              </user_tags>
              <scan_run_status>Done</scan_run_status>
              <hosts>
                <count>1</count>
              </hosts>
              <closed_cves>
                <count>0</count>
              </closed_cves>
              <vulns>
                <count>3</count>
              </vulns>
              <os>
                <count>1</count>
              </os>
              <apps>
                <count>2</count>
              </apps>
              <ssl_certs>
                <count>0</count>
              </ssl_certs>
              <result_count>
                <full>10</full>
                <filtered>10</filtered>
                <debug>
                  <full>0</full>
                  <filtered>0</filtered>
                </debug>
                <hole>
                  <full>0</full>
                  <filtered>0</filtered>
                </hole>
                <info>
                  <full>7</full>
                  <filtered>7</filtered>
                </info>
                <log>
                  <full>0</full>
                  <filtered>0</filtered>
                </log>
                <warning>
                  <full>3</full>
                  <filtered>3</filtered>
                </warning>
              </result_count>
              <task id="13bb418a-4220-4575-b35b-ec398bff7417">
                <name>dik mm</name>
              </task>
              <scan>
                <task>
                </task>
              </scan>
              <timestamp>2010-02-02T19:11:21+00:00</timestamp>
              <scan_start>2010-02-02T19:11:21+00:00</scan_start>
              <timezone>UTC</timezone>
              <timezone_abbrev>UTC</timezone_abbrev>
              <ports start="1" max="-1">
                <port>
                  general/tcp
                  <host>127.0.1.1</host>
                  <severity>5.0</severity>
                  <threat>Medium</threat>
                </port>
                <truncated>...</truncated>
              </ports>
              <results start="1" max="-1">
                <result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
                  <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>
                    <cve>CVE-2013-1406</cve>
                    <bid>51702</bid>
                    <tags>NOTAGS</tags>
                    <cert>
                      <cert_ref id="DFN-CERT-2013-0246" type="DFN-CERT"/>
                    </cert>
                    <xref>NOXREF</xref>
                  </nvt>
                  <threat>Medium</threat>
                  <description>Test with  umlaut Warning Port 0.</description>
                </result>
                <truncated>...</truncated>
              </results>
              <host_start>2010-02-02T19:11:21+00:00<host>127.0.1.1</host></host_start>
              <host_end>2010-02-02T19:11:52+00:00<host>127.0.1.1</host></host_end>
              <scan_end>2010-02-02T19:11:52+00:00</scan_end>
              <errors>
                <count>0</count>
              </errors>
            </report>
          </report>
        </get_reports_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_report_formats</name>
    <summary>Get one or many 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>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>extension</name>
            <type>text</type>
            <summary>File extension of the report format</summary>
          </column>
          <column>
            <name>content_type</name>
            <type>text</type>
            <summary>Content type of the report format</summary>
          </column>
          <column>
            <name>summary</name>
            <type>text</type>
            <summary>Short summary of the report format</summary>
          </column>
          <column>
            <name>description</name>
            <type>text</type>
            <summary>Description of the report format</summary>
          </column>
          <column>
            <name>trust</name>
            <type>boolean</type>
            <summary>Whether the the report format is trusted</summary>
          </column>
          <column>
            <name>trust_time</name>
            <type>iso_time</type>
            <summary>Time the report format was last verified</summary>
          </column>
          <column>
            <name>active</name>
            <type>boolean</type>
            <summary>Whether the the report format is active</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan report formats instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>alerts</name>
        <summary>Whether to include alerts that use the report format</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>params</name>
        <summary>Whether to include report format parameters</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Include report format file, signature and parameters</summary>
        <type>boolean</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>
        <e>filters</e>
        <e>sort</e>
        <e>report_formats</e>
        <e>report_format_count</e>
      </pattern>
      <ele>
        <name>report_format</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>extension</e>
          <e>content_type</e>
          <e>summary</e>
          <e>description</e>
          <e>predefined</e>
          <o><e>alerts</e></o>
          <o>
            <g>
              <any><e>file</e></any>
              <e>signature</e>
            </g>
          </o>
          <e>trust</e>
          <e>active</e>
          <any><e>param</e></any>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the report format</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the report format</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the report format is global or in use</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any alerts are using the report format</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the report format
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the report format</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </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>content_type</name>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>predefined</name>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>alerts</name>
          <summary>Alerts using the report format</summary>
          <pattern>
            <any><e>alert</e></any>
          </pattern>
          <ele>
            <name>alert</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the alert</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the alert</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the permission</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </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>
                  <alt>report_format_list</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>
              <any><e>report_format</e></any>
            </pattern>
            <ele>
              <name>report_format</name>
              <summary>Report format info if type is report_format_list</summary>
              <pattern>
                <attrib>
                  <name>id</name>
                  <type>uuid</type>
                  <required>1</required>
                </attrib>
                <e>name</e>
              </pattern>
              <ele>
                <name>name</name>
                <summary>Name of the report format if available</summary>
                <pattern>text</pattern>
              </ele>
            </ele>
          </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>signature</name>
          <summary>The report format signature</summary>
          <pattern>text</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>iso_time</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>active</name>
          <summary>Whether the report format is active</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>report_formats</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First report format</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of report formats</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>report_format_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of report formats after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of report formats on current page</summary>
          <pattern><t>integer</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>
            <creation_time>2013-01-31T16:46:32+01:00</creation_time>
            <modification_time>2013-01-31T16:46:32+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <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>
            <predefined>1</predefined>
            <trust>
              no
              <time>Thu Dec  2 13:22:26 2010</time>
            </trust>
            <active>1</active>
          </report_format>
          <truncated> ... </truncated>
        </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"
                            details="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>
            <comment></comment>
            <creation_time>2013-01-18T18:23:53+01:00</creation_time>
            <modification_time>2013-01-18T18:24:10+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <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>
            <predefined>1</predefined>
            <file name="HTML.xsl">
              PD9ldD4K
              <truncated>...</truncated>
            </file>
            <file name="generate">
              IyEvAk
              <truncated>...</truncated>
            </file>
            <signature></signature>
          </report_format>
          <truncated>...</truncated>
        </get_report_formats_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_results</name>
    <summary>Get results</summary>
    <description>
      <p>
        The client uses the get_results command to get result information.
      </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>
    </description>
    <pattern>
      <attrib>
        <name>result_id</name>
        <summary>ID of single result to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <option>
            <name>apply_overrides</name>
            <type>boolean</type>
            <summary>Whether to apply Overrides</summary>
          </option>
          <option>
            <name>autofp</name>
            <type>
              <alts>
                <alt>0</alt>
                <alt>1</alt>
                <alt>2</alt>
              </alts>
            </type>
            <summary>Whether to trust vendor security updates.
            1 full match, 2 partial</summary>
          </option>
          <option>
            <name>levels</name>
            <type>levels</type>
            <summary>Severity levels to select</summary>
          </option>
          <option>
            <name>min_qod</name>
            <type>integer</type>
            <summary>Minimum QoD of the results</summary>
          </option>
          <option>
            <name>notes</name>
            <type>boolean</type>
            <summary>Whether to include Notes in the report</summary>
          </option>
          <option>
            <name>overrides</name>
            <type>boolean</type>
            <summary>Whether to include Override descriptions in the report</summary>
          </option>
          <option>
            <name>timezone</name>
            <type>text</type>
            <summary>The timezone to use for the report</summary>
          </option>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name of the NVT</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>host</name>
            <type>text</type>
            <summary>Host IP address of the result</summary>
          </column>
          <column>
            <name>hostname</name>
            <type>text</type>
            <summary>Hostname of the result</summary>
          </column>
          <column>
            <name>location</name>
            <type>text</type>
            <summary>Port and protocol of the result</summary>
          </column>
          <column>
            <name>nvt</name>
            <type>text</type>
            <summary>Unique ID of the test that produced the result</summary>
          </column>
          <column>
            <name>type</name>
            <type>threat</type>
            <summary>Severity type of the result with overrides and autofp</summary>
          </column>
          <column>
            <name>original_type</name>
            <type>threat</type>
            <summary>Original severity type of the result</summary>
          </column>
          <column>
            <name>auto_type</name>
            <type>boolean</type>
            <summary>Whether autofp applies to the result</summary>
          </column>
          <column>
            <name>description</name>
            <type>text</type>
            <summary>Description of the result</summary>
          </column>
          <column>
            <name>task</name>
            <type>text</type>
            <summary>Name of the task</summary>
          </column>
          <column>
            <name>report</name>
            <type>number</type>
            <summary>Internal ID of the report</summary>
          </column>
          <column>
            <name>cvss_base</name>
            <type>severity</type>
            <summary>CVSS base score of the NVT that generated the result</summary>
          </column>
          <column>
            <name>nvt_version</name>
            <type>text</type>
            <summary>Version of the NVT that generated the result</summary>
          </column>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Severity of the result with overrides and autofp</summary>
          </column>
          <column>
            <name>original_severity</name>
            <type>severity</type>
            <summary>Original severity of the result</summary>
          </column>
          <column>
            <name>vulnerability</name>
            <type>text</type>
            <summary>Name of the NVT that generated result</summary>
          </column>
          <column>
            <name>date</name>
            <type>iso_time</type>
            <summary>Time the result was generated</summary>
          </column>
          <column>
            <name>report_id</name>
            <type>uuid</type>
            <summary>UUID of the report</summary>
          </column>
          <column>
            <name>solution_type</name>
            <type>text</type>
            <summary>Solution type of the result</summary>
          </column>
          <column>
            <name>qod</name>
            <type>integer</type>
            <summary>QoD of the result</summary>
          </column>
          <column>
            <name>qod_type</name>
            <type>text</type>
            <summary>QoD type of the result</summary>
          </column>
          <column>
            <name>task_id</name>
            <type>uuid</type>
            <summary>UUID of the task</summary>
          </column>
          <column>
            <name>cve</name>
            <type>text</type>
            <summary>List of CVEs of the result</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>task_id</name>
        <summary>ID of task for note and override handling</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>note_details</name>
        <summary>If notes are included, whether to include note details</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>override_details</name>
        <summary>If overrides are included, whether to include override details</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Whether to include additional details of the results</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>get_counts</name>
        <summary>Whether to include result counts</summary>
        <type>boolean</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>result</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>results</e>
        <o><e>result_count</e></o>
      </pattern>
      <ele>
        <name>result</name>
        <type>result</type>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>results</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First result</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of results</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>result_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of results after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of results on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many results</summary>
      <request>
        <get_results></get_results>
      </request>
      <response>
        <get_results_response status="200" status_text="OK">
          <result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
            <owner>
              <name>admin</name>
            </owner>
            <comment/>
            <creation_time>2014-05-23T09:22:12Z</creation_time>
            <modification_time>2014-05-23T09:22:12Z</modification_time>
            <user_tags>
              <count>0</count>
            </user_tags>
            <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>
              <cve>CVE-2009-3095</cve>
              <bid>36254</bid>
              <tags>NOTAGS</tags>
              <cert></cert>
              <xref>NOXREF</xref>
            </nvt>
            <threat>Medium</threat>
            <description>Test with umlaut.</description>
          </result>
          <truncated>...</truncated>
          <filters id="">
            <term>first=1 rows=-1 sort=name</term>
            <keywords>
              <keyword>
                <column>first</column>
                <relation>=</relation>
                <value>1</value>
              </keyword>
              <truncated>...</truncated>
            </keywords>
          </filters>
          <sort>
            <field>
              name
              <order>ascending</order>
            </field>
          </sort>
          <results max="-1" start="1"></results>
          <result_count>
            124
            <filtered>124</filtered>
            <page>124</page>
          </result_count>
        </get_results_response>
      </response>
    </example>
    <example>
      <summary>Get a result, including notes and overrides</summary>
      <request>
        <get_results result_id="cac9e7c8-c726-49fd-a710-5f99079ab93e"
                     task_id="40b236a9-2b0f-4813-b8c7-bc2b98d9d7e4"
                     filter="notes=1 overrides=1">
        </get_results>
      </request>
      <response>
        <get_results_response status="200" status_text="OK">
          <result id="cac9e7c8-c726-49fd-a710-5f99079ab93e">
            <owner>
              <name>admin</name>
            </owner>
            <comment/>
            <creation_time>2014-05-23T09:22:12Z</creation_time>
            <modification_time>2014-05-23T09:22:12Z</modification_time>
            <user_tags>
              <count>0</count>
            </user_tags>
            <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>
              <cve>CVE-2009-3095</cve>
              <bid>36254</bid>
              <tags>NOTAGS</tags>
              <cert></cert>
              <xref>NOXREF</xref>
            </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>
          <filters id="">
            <term>first=1 rows=-1 sort=name</term>
            <keywords>
              <keyword>
                <column>first</column>
                <relation>=</relation>
                <value>1</value>
              </keyword>
              <truncated>...</truncated>
            </keywords>
          </filters>
          <sort>
            <field>
              name
              <order>ascending</order>
            </field>
          </sort>
          <results max="-1" start="1"></results>
          <result_count>
            1
            <filtered>1</filtered>
            <page>1</page>
          </result_count>
        </get_results_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_roles</name>
    <summary>Get one or many roles</summary>
    <description>
      The client uses the get_roles command to get role information.
    </description>
    <pattern>
      <attrib>
        <name>role_id</name>
        <summary>ID of single role to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan roles instead</summary>
        <type>boolean</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>role</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>roles</e>
        <e>role_count</e>
      </pattern>
      <ele>
        <name>role</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>users</e>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the role</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the role</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the role</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the role was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the role was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>users</name>
          <summary>
            A comma-separated list of the users who have this role
          </summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the role is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether the role is in use</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the role</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the role</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>roles</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First role</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of roles</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>role_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of roles after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of roles on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many roles</summary>
      <request>
        <get_roles></get_roles>
      </request>
      <response>
        <get_roles_response status="200" status_text="OK">
          <role id="b493b7a8-7489-11df-a3ec-002264764cea">
            <name>Management</name>
            <comment>Managers</comment>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <users>sarah, frank</users>
          </role>
          <truncated>...</truncated>
          <filters id="">
            <term>first=1 rows=-1 sort=name</term>
            <keywords>
              <keyword>
                <column>first</column>
                <relation>=</relation>
                <value>1</value>
              </keyword>
              <truncated>...</truncated>
            </keywords>
          </filters>
          <sort>
            <field>
              name
              <order>ascending</order>
            </field>
          </sort>
          <roles max="-1" start="1"></roles>
          <role_count>
            1
            <filtered>1</filtered>
            <page>1</page>
          </role_count>
        </get_roles_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_scanners</name>
    <summary>Get one or many scanners</summary>
    <description>
      <p>
        The client uses the get_scanners command to get scanner information.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>scanner_id</name>
        <summary>ID of single scanner to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>host</name>
            <type>text</type>
            <summary>Host of the scanner</summary>
          </column>
          <column>
            <name>port</name>
            <type>integer</type>
            <summary>Port of the scanner</summary>
          </column>
         <column>
            <name>type</name>
            <type>
              <alts>
                <alt>1</alt>
                <alt>2</alt>
              </alts>
            </type>
            <summary>Scanner type: '1' for OSP, '2' for OpenVAS (classic)</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan scanners instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Whether to include extra details like tasks using this scanner</summary>
        <type>boolean</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>scanner</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>scanners</e>
        <e>scanner_count</e>
      </pattern>
      <ele>
        <name>scanner</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>ca_pub_info</e>
          <e>certificate_info</e>
          <e>host</e>
          <e>port</e>
          <e>type</e>
          <e>ca_pub</e>
          <e>credential</e>
          <o><e>tasks</e></o>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the scanner</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the scanner</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the scanner</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the scanner is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the scanner</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>Permissions that the current user has on the scanner</summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the chedule</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>ca_pub_info</name>
          <summary>
            Info about the CA certificate
          </summary>
          <type>certificate_info</type>
        </ele>
        <ele>
          <name>certificate_info</name>
          <summary>
            Info about the certificate
          </summary>
          <type>certificate_info</type>
        </ele>
        <ele>
          <name>host</name>
          <summary>Host of the scanner</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>port</name>
          <summary>Port of the scanner</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>type</name>
          <summary>Type of the scanner</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>ca_pub</name>
          <summary>CA Certificate to verify the scanner's certificate</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>credential</name>
          <summary>Client certificate credential for the Scanner</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>Name of the credential</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>login</name>
            <summary>Username from credential used to login</summary>
            <pattern>
              text
            </pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the credential is in the trashcan</summary>
            <pattern>
              <t>boolean</t>
            </pattern>
          </ele>
        </ele>
        <ele>
          <name>tasks</name>
          <pattern>
            <any><e>task</e></any>
          </pattern>
          <ele>
            <name>task</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the task</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the task</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>scanners</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First scanner</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of scanners</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>scanner_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of scanners after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of scanners on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get full details of a single scanner</summary>
      <request>
        <get_scanners details='1' scanner_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"/>
      </request>
      <response>
        <get_scanners_response status="200" status_text="OK">
          <scanner id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
            <name>Default Scanner</name>
            <comment></comment>
            <creation_time>2014-01-01T13:57:25+01:00</creation_time>
            <modification_time>2014-01-18T12:07:36+01:00</modification_time>
            <writable>0</writable>
            <in_use>1</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <host>localhost</host>
            <port>9391</port>
            <type>2</type>
            <ca_pub>...</ca_pub>
            <key_pub>...</key_pub>
            <tasks>
              <task id="813864a9-d3fd-44b3-8717-972bfb01dfc0">
                <name>Debian desktops</name>
              </task>
              <truncated>...</truncated>
            </tasks>
          </scanner>
          <truncate>...</truncate>
        </get_scanners_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_schedules</name>
    <summary>Get one or many schedules</summary>
    <description>
      <p>
        The client uses the get_schedules command to get schedule information.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>schedule_id</name>
        <summary>ID of single schedule to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>first_time</name>
            <type>iso_time</type>
            <summary>First time the schedule ran or will run</summary>
          </column>
          <column>
            <name>period</name>
            <type>integer</type>
            <summary>Time period between runs in seconds</summary>
          </column>
          <column>
            <name>period_months</name>
            <type>integer</type>
            <summary>Time period between runs in months</summary>
          </column>
          <column>
            <name>duration</name>
            <type>integer</type>
            <summary>Maximum duration of scans run with the schedule</summary>
          </column>
          <column>
            <name>timezone</name>
            <type>text</type>
            <summary>Timezone the schedule uses</summary>
          </column>
          <column>
            <name>initial_offset</name>
            <type>integer</type>
            <summary>Initial offset in seconds</summary>
          </column>
          <column>
            <name>first_run</name>
            <type>iso_time</type>
            <summary>Alias for first_time</summary>
          </column>
          <column>
            <name>next_run</name>
            <type>iso_time</type>
            <summary>The next time the schedule will run</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan schedules instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>tasks</name>
        <summary>Whether to include tasks using the schedules</summary>
        <type>boolean</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>schedule</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>schedules</e>
        <e>schedule_count</e>
      </pattern>
      <ele>
        <name>schedule</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>first_time</e>
          <e>next_time</e>
          <e>timezone</e>
          <e>timezone_abbrev</e>
          <e>period</e>
          <e>period_months</e>
          <e>simple_period</e>
          <e>duration</e>
          <e>simple_duration</e>
          <o>
            <e>tasks</e>
          </o>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the schedule</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the schedule</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the schedule</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the schedule is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the schedule</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the schedule
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the schedule</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>first_time</name>
          <summary>First time the task ran or will run</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>next_time</name>
          <summary>The next time the task will run</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>timezone</name>
          <summary>The timezone that the schedule follows</summary>
          <pattern>timezone</pattern>
        </ele>
        <ele>
          <name>timezone_abbrev</name>
          <summary>The abbreviated name of the timezone</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>period</name>
          <summary>How often the task will run, in seconds</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>period_months</name>
          <summary>How often the task will run, months portion</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>simple_period</name>
          <summary>Simple representation of period, if available</summary>
          <pattern>
            text
            <o><e>unit</e></o>
          </pattern>
          <ele>
            <name>unit</name>
            <pattern><t>time_unit</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>duration</name>
          <summary>How long the task will run for (0 for entire task)</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>simple_duration</name>
          <summary>Simple representation of duration, if available</summary>
          <pattern>
            text
            <o><e>unit</e></o>
          </pattern>
          <ele>
            <name>unit</name>
            <pattern><t>time_unit</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>tasks</name>
          <pattern>
            <any><e>task</e></any>
          </pattern>
          <ele>
            <name>task</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the task</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the task</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>schedules</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First schedule</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of schedules</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>schedule_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of schedules after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of schedules on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get full details of a single schedule</summary>
      <request>
        <get_schedules schedule_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
        </get_schedules>
      </request>
      <response>
        <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>
            <creation_time>2013-01-01T13:57:25+01:00</creation_time>
            <modification_time>2013-01-18T12:07:36+01:00</modification_time>
            <writable>0</writable>
            <in_use>1</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <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>
            <simple_period>1<unit>day</unit></simple_period>
            <duration>10800</duration>
            <simple_duration>3<unit>hour</unit></simple_duration>
            <timezone>Europe/Berlin</timezone>
            <timezone_abbrev>CEST</timezone_abbrev>
            <tasks>
              <task id="d4daf4c4-25c7-40ac-87d3-38e489f34330">
                <name>Task 1</name>
              </task>
            </tasks>
          </schedule>
          <truncate>...</truncate>
        </get_schedules_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_settings</name>
    <summary>Get one or many settings</summary>
    <description>
      <p>
        The client uses the get_settings command to get the settings.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>setting_id</name>
        <summary>ID of single setting to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>value</name>
            <type>text</type>
            <summary>Current value of the setting</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>first</name>
        <summary>First result</summary>
        <type>integer</type>
      </attrib>
      <attrib>
        <name>max</name>
        <summary>Maximum number of results in response</summary>
        <type>integer</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>
        <e>filters</e>
        <e>settings</e>
        <any><e>setting</e></any>
        <e>setting_count</e>
      </pattern>
      <ele>
        <name>filters</name>
        <pattern>
          <e>term</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
      </ele>
      <ele>
        <name>settings</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First setting</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of settings</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>setting</name>
        <pattern>
          <e>name</e>
          <e>comment</e>
          <e>value</e>
        </pattern>
        <ele>
          <name>name</name>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>comment</name>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <pattern>text</pattern>
        </ele>
      </ele>
      <ele>
        <name>setting_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of settings after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of settings on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many settings</summary>
      <request>
        <get_settings></get_settings>
      </request>
      <response>
        <get_settings_response status="200" status_text="OK">
          <settings>
            <setting id="5f5a8712-8017-11e1-8556-406186ea4fc5">
              <name>Rows Per Page</name>
              <value>15</value>
            </setting>
          </settings>
        </get_settings_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_system_reports</name>
    <summary>Get one or many system reports</summary>
    <description>
      <p>
        The client uses the get_system_reports command to get system reports.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>name</name>
        <summary>A string describing the required report</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>duration</name>
        <summary>
          The number of seconds into the past that the report should include
        </summary>
        <type>integer</type>
      </attrib>
      <attrib>
        <name>start_time</name>
        <summary>
          The start of the time interval the report should include
        </summary>
        <type>iso_time</type>
      </attrib>
      <attrib>
        <name>end_time</name>
        <summary>
          The end of the time interval the report should include
        </summary>
        <type>iso_time</type>
      </attrib>
      <attrib>
        <name>brief</name>
        <summary>Whether to include the actual reports</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>slave_id</name>
        <summary>OMP scanner from which to get report</summary>
        <type>uuid</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>system_report</e></any>
      </pattern>
      <ele>
        <name>system_report</name>
        <pattern>
          <e>name</e>
          <e>title</e>
          <o><e>report</e></o>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the system report</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>title</name>
          <summary>The title of the system report</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>report</name>
          <pattern>
            <attrib>
              <name>format</name>
              <type>
                <alts>
                  <alt>png</alt>
                  <alt>txt</alt>
                </alts>
              </type>
              <required>1</required>
            </attrib>
            <attrib>
              <name>duration</name>
              <type>integer</type>
              <required>1</required>
            </attrib>
            <t>base64</t>
          </pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get listing of available system reports</summary>
      <request>
        <get_system_reports brief="1">
        </get_system_reports>
      </request>
      <response>
        <get_system_reports_response status="200" status_text="OK">
          <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>
          <truncated>...</truncated>
        </get_system_reports_response>
      </response>
    </example>
    <example>
      <summary>Get a system report</summary>
      <request>
        <get_system_reports name="proc">
        </get_system_reports>
      </request>
      <response>
        <get_system_reports_response status="200" status_text="OK">
          <system_report>
            <name>proc</name>
            <title>Processes</title>
            <report format="png" duration="86400">
              iVBORw0KGgoAAAANSUhEUgAAArkAAAE...2bEdAAAAAElFTkSuQmCC
            </report>
          </system_report>
        </get_system_reports_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_tags</name>
    <summary>Get one or many tags</summary>
    <description>
      <p>
        The client uses the get_tags command to get tag information.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>tag_id</name>
        <summary>ID of single tag to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>resource_type</name>
            <type>text</type>
            <summary>Type of resource the tag applies to</summary>
          </column>
          <column>
            <name>resource</name>
            <type>name</type>
            <summary>Internal ID of resource the tag applies to</summary>
          </column>
          <column>
            <name>resource_uuid</name>
            <type>text</type>
            <summary>Unique ID of resource the tag applies to</summary>
          </column>
          <column>
            <name>resource_location</name>
            <type>boolean</type>
            <summary>Whether the resource is in the trash</summary>
          </column>
          <column>
            <name>active</name>
            <type>boolean</type>
            <summary>Whether the tag is active</summary>
          </column>
          <column>
            <name>value</name>
            <type>name</type>
            <summary>Value of the tag</summary>
          </column>
          <column>
            <name>orphan</name>
            <type>boolean</type>
            <summary>Whether the tag is an orphan</summary>
          </column>
          <column>
            <name>resource_name</name>
            <type>name</type>
            <summary>Name of resource the tag applies to</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>text</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get tags from the trashcan instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>names_only</name>
        <summary>Whether to get only distinct tag names</summary>
        <type>boolean</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>tag</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>tags</e>
        <e>tag_count</e>
      </pattern>
      <ele>
        <name>tag</name>
        <summary>Information on a single tag</summary>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>uuid of the tag (omitted when using names_only)</summary>
            <type>uuid</type>
          </attrib>
          <e>name</e>
          <o>
            <g>
              <e>permissions</e>
              <e>owner</e>
              <e>comment</e>
              <e>creation_time</e>
              <e>modification_time</e>
              <e>writable</e>
              <e>in_use</e>
              <e>resource</e>
              <e>value</e>
              <e>active</e>
              <e>orphan</e>
            </g>
          </o>
        </pattern>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the tag
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>owner</name>
          <summary>Owner of the tag</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>Name of the tag (usually namespace:predicate)</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>Comment for the tag</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the tag was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the tag was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the tag is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the tag</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>resource</name>
          <summary>Identifies a resource the tag is attached to</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <summary>ID of the resource the tag is attached to</summary>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>type</e>
            <e>name</e>
            <e>trash</e>
            <o><e>permissions</e></o>
          </pattern>
          <ele>
            <name>type</name>
            <summary>OMP type of the resource the tag is attached to</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>name</name>
            <summary>Name of the attach resource if available, empty otherwise</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the resource is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the resource</summary>
            <pattern></pattern>
          </ele>
        </ele>
        <ele>
          <name>value</name>
          <summary>Value associated with the tag</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>active</name>
          <summary>Whether the tag is active</summary>
          <pattern>boolean</pattern>
        </ele>
        <ele>
          <name>orphan</name>
          <summary>Whether the tag is attached to a nonexistent resource</summary>
          <pattern>boolean</pattern>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>tags</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First tag</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of tags</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>tag_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of tags after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of tags on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many tags</summary>
      <request>
        <get_tags></get_tags>
      </request>
      <response>
        <get_tags_response status="200" status_text="OK">
          <tag id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
            <name>geo:long</name>
            <comment></comment>
            <creation_time>Fri Apr 12 08:49:43 2013</creation_time>
            <modification_time>Fri Apr 12 08:49:43 2013</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <resource id="b493b7a8-7489-11df-a3ec-002264764cea">
              <type>target</type>
              <name>Server 1</name>
              <trash>0</trash>
            </resource>
            <value>52.2788</value>
            <active>1</active>
            <orphaned>0</orphaned>
          </tag>
          <truncated>...</truncated>
        </get_tags_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_targets</name>
    <summary>Get one or many targets</summary>
    <description>
      The client uses the get_targets command to get target information.
    </description>
    <pattern>
      <attrib>
        <name>target_id</name>
        <summary>ID of single target to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>hosts</name>
            <type>text</type>
            <summary>List of hosts</summary>
          </column>
          <column>
            <name>exclude_hosts</name>
            <type>text</type>
            <summary>List of excluded hosts</summary>
          </column>
          <column>
            <name>ips</name>
            <type>integer</type>
            <summary>Number of hosts</summary>
          </column>
          <column>
            <name>port_list</name>
            <type>name</type>
            <summary>Name of the port list</summary>
          </column>
          <column>
            <name>ssh_credential</name>
            <type>name</type>
            <summary>Name of the SSH credential</summary>
          </column>
          <column>
            <name>smb_credential</name>
            <type>name</type>
            <summary>Name of the SMB credential</summary>
          </column>
          <column>
            <name>esxi_credential</name>
            <type>name</type>
            <summary>Name of the ESXi credential</summary>
          </column>
          <column>
            <name>snmp_credential</name>
            <type>name</type>
            <summary>Name of the SNMP credential</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan targets instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>tasks</name>
        <summary>Whether to include list of tasks that use the target</summary>
        <type>boolean</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>target</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>targets</e>
        <e>target_count</e>
      </pattern>
      <ele>
        <name>target</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>hosts</e>
          <e>exclude_hosts</e>
          <e>max_hosts</e>
          <e>ssh_credential</e>
          <e>smb_credential</e>
          <e>esxi_credential</e>
          <e>snmp_credential</e>
          <e>permissions</e>
          <e>port_range</e>
          <e>port_list</e>
          <e>alive_tests</e>
          <e>reverse_lookup_only</e>
          <e>reverse_lookup_unify</e>
          <o><e>tasks</e></o>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the target</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the target</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the target</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Date and time the target was created</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Date and time the target was last modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>hosts</name>
          <summary>A list of hosts</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>exclude_hosts</name>
          <summary>A list of hosts to exclude</summary>
          <pattern>
            text
          </pattern>
        </ele>
        <ele>
          <name>max_hosts</name>
          <summary>The maximum number of hosts defined by the target</summary>
          <pattern>
            <t>integer</t>
          </pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the target is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether any tasks are using the target</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the target
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the target</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>ssh_credential</name>
          <pattern>
            <attrib>
              <name>id</name>
              <comment>
                A UUID if there is a credential, otherwise the empty string
              </comment>
              <type>uuid_or_empty</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>port</e>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the SSH LSC credential</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the task</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>port</name>
            <summary>The port the LSCs will use</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the LSC credential is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>smb_credential</name>
          <pattern>
            <attrib>
              <name>id</name>
              <comment>
                A UUID if there is a credential, otherwise the empty string
              </comment>
              <type>uuid_or_empty</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the SMB LSC credential</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the task</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the LSC credential is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
        <name>esxi_credential</name>
          <pattern>
            <attrib>
              <name>id</name>
              <comment>
                A UUID if there is a credential, otherwise the empty string
              </comment>
              <type>uuid_or_empty</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the ESXi LSC credential</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the task</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the LSC credential is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>snmp_credential</name>
          <pattern>
            <attrib>
              <name>id</name>
              <comment>
                A UUID if there is a credential, otherwise the empty string
              </comment>
              <type>uuid_or_empty</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the SNMP credential</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the credential</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the credential is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>port_range</name>
          <summary>Port range of the target</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>port_list</name>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the port_list</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the task</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the port_list is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>alive_tests</name>
          <summary>Which alive tests to use</summary>
          <pattern>
            <t>alive_test</t>
          </pattern>
        </ele>
        <ele>
          <name>reverse_lookup_only</name>
          <summary>Whether to scan only hosts that have names</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>reverse_lookup_unify</name>
          <summary>
            Whether to scan only one IP when multiple IPs have the same name
          </summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>tasks</name>
          <summary>All tasks using the target</summary>
          <pattern>
            <any><e>task</e></any>
          </pattern>
          <ele>
            <name>task</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the task</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the task</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>targets</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First target</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of targets</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>target_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of targets after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of targets on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many targets</summary>
      <request>
        <get_targets></get_targets>
      </request>
      <response>
        <get_targets_response status="200" status_text="OK">
          <target id="b493b7a8-7489-11df-a3ec-002264764cea">
            <name>Localhost</name>
            <comment></comment>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <writable>0</writable>
            <in_use>7</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <hosts>localhost</hosts>
            <max_hosts>1</max_hosts>
            <ssh_credential id="">
              <name></name>
            </ssh_credential>
            <smb_credential id="">
              <name></name>
            </smb_credential>
            <esxi_credential id="">
              <name></name>
            </esxi_credential>
          </target>
          <truncated>...</truncated>
        </get_targets_response>
      </response>
    </example>
    <example>
      <summary>Get a single target, including tasks using the target</summary>
      <request>
        <get_targets target_id="1f28d970-17ef-4c69-ba8a-13827059f2b9" tasks="1">
        </get_targets>
      </request>
      <response>
        <get_targets_response status="200" status_text="OK">
          <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
            <name>dik</name>
            <comment>dik mm</comment>
            <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
            <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
            <writable>0</writable>
            <in_use>4</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <hosts>dik.example.org</hosts>
            <max_hosts>1</max_hosts>
            <ssh_credential id="58ff2793-2dc7-43fe-85f9-20bfac5a87e4">
              <name>mm</name>
            </ssh_credential>
            <smb_credential id="">
              <name></name>
            </smb_credential>
            <esxi_credential id="">
              <name></name>
            </esxi_credential>
            <tasks>
              <task id="13bb418a-4220-4575-b35b-ec398bff7417">
                <name>dik mm</name>
              </task>
              <truncated>...</truncated>
            </tasks>
          </target>
        </get_targets_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_tasks</name>
    <summary>Get one or many tasks</summary>
    <description>
      <p>
        The client uses the get_tasks command to get task information.
      </p>
      <p>
        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>
    </description>
    <pattern>
      <attrib>
        <name>task_id</name>
        <summary>ID of single task to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <option>
            <name>apply_overrides</name>
            <type>boolean</type>
            <summary>Whether to apply Overrides</summary>
          </option>
          <option>
            <name>min_qod</name>
            <type>integer</type>
            <summary>Minimum QoD of the results</summary>
          </option>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>status</name>
            <type>text</type>
            <summary>Status of the current scan</summary>
          </column>
          <column>
            <name>total</name>
            <type>integer</type>
            <summary>Total number of results</summary>
          </column>
          <column>
            <name>first_report</name>
            <type>uuid</type>
            <summary>UUID of the first report</summary>
          </column>
          <column>
            <name>last_report</name>
            <type>uuid</type>
            <summary>UUID of the last finished report</summary>
          </column>
          <column>
            <name>threat</name>
            <type>threat</type>
            <summary>Severity level of the last finished report</summary>
          </column>
          <column>
            <name>trend</name>
            <type>
              <alts>
                <alt>up</alt>
                <alt>down</alt>
                <alt>more</alt>
                <alt>less</alt>
                <alt>same</alt>
              </alts>
            </type>
            <summary>Trend of the task</summary>
          </column>
          <column>
            <name>severity</name>
            <type>severity</type>
            <summary>Severity of the last finished report</summary>
          </column>
          <column>
            <name>schedule</name>
            <type>name</type>
            <summary>Name of the schedule</summary>
          </column>
          <column>
            <name>next_due</name>
            <type>iso_time</type>
            <summary>Time the task is next due to run</summary>
          </column>
          <column>
            <name>first</name>
            <type>iso_time</type>
            <summary>Timestamp of the first report</summary>
          </column>
          <column>
            <name>last</name>
            <type>iso_time</type>
            <summary>Timestamp of the last finished report</summary>
          </column>
          <column>
            <name>false_positive</name>
            <type>integer</type>
            <summary>Number of false positive results</summary>
          </column>
          <column>
            <name>log</name>
            <type>integer</type>
            <summary>Number of log results</summary>
          </column>
          <column>
            <name>low</name>
            <type>integer</type>
            <summary>Number of low severity results</summary>
          </column>
          <column>
            <name>medium</name>
            <type>integer</type>
            <summary>Number of medium severity results</summary>
          </column>
          <column>
            <name>high</name>
            <type>integer</type>
            <summary>Number of high severity results</summary>
          </column>
          <column>
            <name>hosts</name>
            <type>integer</type>
            <summary>Total number of hosts</summary>
          </column>
          <column>
            <name>result_hosts</name>
            <type>integer</type>
            <summary>Number of hosts with results matching the min_qod</summary>
          </column>
          <column>
            <name>fp_per_host</name>
            <type>integer</type>
            <summary>Number of false positive results per host with results</summary>
          </column>
          <column>
            <name>log_per_host</name>
            <type>integer</type>
            <summary>Number of log results per host with results</summary>
          </column>
          <column>
            <name>low_per_host</name>
            <type>integer</type>
            <summary>Number of low severity results per host with results</summary>
          </column>
          <column>
            <name>medium_per_host</name>
            <type>integer</type>
            <summary>Number of medium severity results per host with results</summary>
          </column>
          <column>
            <name>high_per_host</name>
            <type>integer</type>
            <summary>Number of high severity results per host with results</summary>
          </column>
          <column>
            <name>target</name>
            <type>name</type>
            <summary>Name of the target</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>trash</name>
        <summary>Whether to get the trashcan tasks instead</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>details</name>
        <summary>Whether to include full task details</summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>ignore_pagination</name>
        <summary>
          Whether to ignore info used to split the report into pages
          like the filter terms "first" and "rows".
        </summary>
        <type>boolean</type>
      </attrib>
      <attrib>
        <name>schedules_only</name>
        <summary>Whether to only include id, name and schedule details</summary>
        <type>boolean</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>
        <e>apply_overrides</e>
        <any><e>task</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>tasks</e>
        <e>task_count</e>
      </pattern>
      <ele>
        <name>apply_overrides</name>
        <pattern>
          <t><alts><alt>0</alt><alt>1</alt></alts></t>
        </pattern>
      </ele>
      <ele>
        <name>task</name>
        <pattern>
          <attrib>
            <name>id</name>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <or>
            <g>
              <e>owner</e>
              <e>name</e>
              <e>comment</e>
              <e>creation_time</e>
              <e>modification_time</e>
              <e>writable</e>
              <e>in_use</e>
              <e>permissions</e>
              <e>user_tags</e>
              <e>status</e>
              <e>progress</e>
              <e>alterable</e>
              <e>config</e>
              <e>target</e>
              <e>hosts_ordering</e>
              <e>scanner</e>
              <e>alert</e>
              <e>observers</e>
              <e>schedule</e>
              <e>schedule_periods</e>
              <e>report_count</e>
              <e>trend</e>
              <o><e>current_report</e></o>
              <o><e>first_report</e></o>
              <o><e>last_report</e></o>
              <o><e>second_last_report</e></o>
              <any><e>reports</e></any>
              <o><e>average_duration</e></o>
              <e>result_count</e>
              <e>preferences</e>
            </g>
            <g>
              <e>name</e>
              <e>schedule</e>
              <e>schedule_periods</e>
            </g>
          </or>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the task</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the task</summary>
          <pattern><t>name</t></pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the task</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Creation time of the task</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Last time the task was modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the task is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether this task is currently in use</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the task
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the task</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>status</name>
          <summary>The run status of the task</summary>
          <pattern><t>task_status</t></pattern>
        </ele>
        <ele>
          <name>progress</name>
          <summary>The percentage of the task that is complete</summary>
          <pattern>
            <t>integer</t>
            <any><e>host_progress</e></any>
          </pattern>
          <ele>
            <name>host_progress</name>
            <summary>Percentage complete for a particular host</summary>
            <pattern>
              <t>integer</t>
              <e>host</e>
            </pattern>
            <ele>
              <name>host</name>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>alterable</name>
          <summary>Whether the task is an Alterable Task</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>config</name>
          <summary>The scan configuration used by the task</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the config</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the config</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the config is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>target</name>
          <summary>The hosts scanned by the task</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the target</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the target</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the target is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>hosts_ordering</name>
          <summary>The order hosts are scanned in</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>scanner</name>
          <summary>The scanner used to scan the target</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>type</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the scanner</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>type</name>
            <summary>Type of the scanner</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the task</summary>
            <pattern></pattern>
          </ele>
        </ele>
        <ele>
          <name>alert</name>
          <summary>An alert that applies to the task</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid_or_empty</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
            <e>trash</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the alert</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the alert</summary>
            <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the alert is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>observers</name>
          <summary>Users allowed to observe this task</summary>
          <pattern>
            <t>user_list</t>
            <any><e>group</e></any>
            <any><e>role</e></any>
          </pattern>
          <ele>
            <name>group</name>
            <summary>Group allowed to observe this task</summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the group</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
          <ele>
            <name>role</name>
            <summary>Role allowed to observe this task</summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the role</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>schedule</name>
          <summary>When the task will run</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid_or_empty</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>next_time</e></o>
            <o><e>permissions</e></o>
            <e>trash</e>
            <o><e>first_time</e></o>
            <o><e>period</e></o>
            <o><e>period_months</e></o>
            <o><e>duration</e></o>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the schedule</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>next_time</name>
            <summary>The next date and time the schedule will be run in ISO format or "over".</summary>
            <pattern><t>iso_time</t></pattern>
          </ele>
          <ele>
          <name>permissions</name>
          <summary>Permissions the user has on the schedule</summary>
          <pattern></pattern>
          </ele>
          <ele>
            <name>trash</name>
            <summary>Whether the schedule is in the trashcan</summary>
            <pattern><t>boolean</t></pattern>
          </ele>
          <ele>
            <name>first_time</name>
            <summary>The first time was or will be run</summary>
            <pattern><t>iso_time</t></pattern>
          </ele>
          <ele>
            <name>period</name>
            <summary>The time period between repeated runs of the schedule. Run only once if this and period_months is 0</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>period_months</name>
            <summary>The number of months between repeated runs of the schedule. Run only once if this and period is 0</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>duration</name>
            <summary>The maximum duration of the task in seconds or 0 for unlimited</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>schedule_periods</name>
          <summary>
            A limit to the number of times the task will be scheduled, or 0 for no limit
          </summary>
          <pattern>
            <t>integer</t>
          </pattern>
        </ele>
        <ele>
          <name>report_count</name>
          <summary>Number of reports</summary>
          <pattern>
            <t>integer</t>
            <e>finished</e>
          </pattern>
          <ele>
            <name>finished</name>
            <summary>Number of reports where the scan completed</summary>
            <pattern><t>integer</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>trend</name>
          <pattern><t>task_trend</t></pattern>
        </ele>
        <ele>
          <name>current_report</name>
          <pattern>
            <e>report</e>
          </pattern>
          <ele>
            <name>report</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>timestamp</e>
            </pattern>
            <ele>
              <name>timestamp</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>first_report</name>
          <pattern>
            <e>report</e>
          </pattern>
          <ele>
            <name>report</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>timestamp</e>
              <e>scan_end</e>
              <e>result_count</e>
              <e>severity</e>
            </pattern>
            <ele>
              <name>timestamp</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>scan_end</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>result_count</name>
              <summary>Result counts for this report</summary>
              <pattern>
                <e>debug</e>
                <e>false_positive</e>
                <e>log</e>
                <e>info</e>
                <e>warning</e>
                <e>hole</e>
              </pattern>
              <ele>
                <name>debug</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>false_positive</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>log</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>info</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>warning</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>hole</name>
                <pattern><t>integer</t></pattern>
              </ele>
            </ele>
            <ele>
              <name>severity</name>
              <pattern><t>severity</t></pattern>
              <summary>Maximum severity of the report</summary>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>last_report</name>
          <pattern>
            <e>report</e>
          </pattern>
          <ele>
            <name>report</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>timestamp</e>
              <e>scan_end</e>
              <e>result_count</e>
              <e>severity</e>
            </pattern>
            <ele>
              <name>timestamp</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>scan_end</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>result_count</name>
              <summary>Result counts for this report</summary>
              <pattern>
                <e>debug</e>
                <e>false_positive</e>
                <e>log</e>
                <e>info</e>
                <e>warning</e>
                <e>hole</e>
              </pattern>
              <ele>
                <name>debug</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>false_positive</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>log</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>info</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>warning</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>hole</name>
                <pattern><t>integer</t></pattern>
              </ele>
            </ele>
            <ele>
              <name>severity</name>
              <pattern><t>severity</t></pattern>
              <summary>Maximum severity of the report</summary>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>second_last_report</name>
          <pattern>
            <e>report</e>
          </pattern>
          <ele>
            <name>report</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>timestamp</e>
              <e>scan_end</e>
              <e>result_count</e>
              <e>severity</e>
            </pattern>
            <ele>
              <name>timestamp</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>scan_end</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>result_count</name>
              <summary>Result counts for this report</summary>
              <pattern>
                <e>debug</e>
                <e>false_positive</e>
                <e>log</e>
                <e>info</e>
                <e>warning</e>
                <e>hole</e>
              </pattern>
              <ele>
                <name>debug</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>false_positive</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>log</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>info</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>warning</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>hole</name>
                <pattern><t>integer</t></pattern>
              </ele>
            </ele>
            <ele>
              <name>severity</name>
              <pattern><t>severity</t></pattern>
              <summary>Maximum severity of the report</summary>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>reports</name>
          <pattern>
            <any><e>report</e></any>
          </pattern>
          <ele>
            <name>report</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>timestamp</e>
              <e>scan_end</e>
              <e>scan_run_status</e>
              <e>result_count</e>
              <e>severity</e>
            </pattern>
            <ele>
              <name>timestamp</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>scan_end</name>
              <pattern><t>iso_time</t></pattern>
            </ele>
            <ele>
              <name>scan_run_status</name>
              <summary>Run status of task scan</summary>
              <pattern><t>task_status</t></pattern>
            </ele>
            <ele>
              <name>result_count</name>
              <summary>Result counts for this report</summary>
              <pattern>
                <e>debug</e>
                <e>false_positive</e>
                <e>log</e>
                <e>info</e>
                <e>warning</e>
                <e>hole</e>
              </pattern>
              <ele>
                <name>debug</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>false_positive</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>log</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>info</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>warning</name>
                <pattern><t>integer</t></pattern>
              </ele>
              <ele>
                <name>hole</name>
                <pattern><t>integer</t></pattern>
              </ele>
            </ele>
            <ele>
              <name>severity</name>
              <pattern><t>severity</t></pattern>
              <summary>Maximum severity of the report</summary>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>average_duration</name>
          <summary>Average scan duration in seconds</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>result_count</name>
          <summary>Result count for the entire task</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>preferences</name>
          <pattern>
            <any><e>preference</e></any>
          </pattern>
          <ele>
            <name>preference</name>
            <pattern>
              <e>name</e>
              <e>scanner_name</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Full name of preference, suitable for end users</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>scanner_name</name>
              <summary>Compact name of preference, from scanner</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>tasks</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First task</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of tasks</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>task_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of tasks after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of tasks on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get one or many tasks</summary>
      <request>
        <get_tasks></get_tasks>
      </request>
      <response>
        <get_tasks_response status="200" status_text="OK">
          <apply_overrides>0</apply_overrides>
          <task id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
            <name>Scan Webserver</name>
            <comment>Scan of the web server.</comment>
            <creation_time>2013-01-03T13:50:03+01:00</creation_time>
            <modification_time>2013-01-11T16:03:24+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <owner>
              <name>admin</name>
            </owner>
            <observers/>
            <alterable>0</alterable>
            <config id="daba56c8-73ec-11df-a475-002264764cea">
              <name>Full and fast</name>
            </config>
            <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
              <name>dik</name>
            </target>
            <scanner id="34891919-37ff-5c69-1a2a-089e9018308a">
              <name>foo scanner</name>
              <type>2</type>
            </scanner>
            <status>Done</status>
            <progress>-1</progress>
            <report_count>2<finished>2</finished></report_count>
            <trend></trend>
            <schedule id="">
              <name></name>
              <next_time>over</next_time>
            </schedule>
            <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>
                <severity>5.0</severity>
              </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>
                <severity>5.0</severity>
              </report>
            </last_report>
            <second_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>
                <severity>5.0</severity>
              </report>
            </second_last_report>
            <alert id="">
              <name></name>
            </alert>
            <preferences>
              <preference>
                <name>Maximum concurrently executed NVTs per host</name>
                <scanner_name>max_checks</scanner_name>
                <value>4</value>
              </preference>
              <preference>
                <name>Maximum concurrently scanned hosts</name>
                <scanner_name>max_hosts</scanner_name>
                <value>20</value>
              </preference>
              <preference>
                <name>Add results to Asset Management</name>
                <scanner_name>in_assets</scanner_name>
                <value>yes</value>
              </preference>
            </preferences>
          </task>
          <task id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c">
            <name>Scan Mailserver</name>
            <truncated>...</truncated>
          </task>
        </get_tasks_response>
      </response>
    </example>
    <example>
      <summary>Get a single task, including all reports</summary>
      <request>
        <get_tasks task_id="f14747d3-a4d7-4e79-99bb-a0a1276cb78c" details="1">
        </get_tasks>
      </request>
      <response>
        <get_tasks_response status="200" status_text="OK">
          <apply_overrides>0</apply_overrides>
          <task id="13bb418a-4220-4575-b35b-ec398bff7417">
            <name>Scan Mailserver</name>
            <comment>Scan of the web server.</comment>
            <creation_time>2013-01-03T13:50:03+01:00</creation_time>
            <modification_time>2013-01-11T16:03:24+01:00</modification_time>
            <writable>1</writable>
            <in_use>0</in_use>
            <user_tags>
              <count>0</count>
            </user_tags>
            <owner>
              <name>admin</name>
            </owner>
            <observers/>
            <alterable>1</alterable>
            <config id="daba56c8-73ec-11df-a475-002264764cea">
              <name>Full and fast</name>
            </config>
            <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
              <name>dik</name>
            </target>
            <status>Done</status>
            <progress>-1</progress>
            <report_count>2<finished>2</finished></report_count>
            <trend></trend>
            <schedule id="">
              <name></name>
              <next_time>over</next_time>
            </schedule>
            <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>
                <severity>5.0</severity>
              </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>
                <severity>5.0</severity>
              </report>
            </last_report>
            <second_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>
                <severity>5.0</severity>
              </report>
            </second_last_report>
            <alert id="">
              <name></name>
            </alert>
            <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>
                <severity>5.0</severity>
              </report>
              <preferences>
                <preference>
                  <name>Maximum concurrently executed NVTs per host</name>
                  <scanner_name>max_checks</scanner_name>
                  <value>4</value>
                </preference>
                <preference>
                  <name>Maximum concurrently scanned hosts</name>
                  <scanner_name>max_hosts</scanner_name>
                  <value>20</value>
                </preference>
                <preference>
                  <name>Add results to Asset Management</name>
                  <scanner_name>in_assets</scanner_name>
                  <value>yes</value>
                </preference>
              </preferences>
            </reports>
          </task>
          <filters id="0">
            <term/>
          </filters>
          <sort>
            <field>name<order>ascending</order></field>
          </sort>
          <tasks max="-1" start="1"/>
          <task_count>3<filtered>1</filtered><page>1</page></task_count>
        </get_tasks_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_users</name>
    <summary>Get one or many users</summary>
    <description>
      <p>
        The client uses the "get_users" command to retrieve the list of user
        accounts on the Scanner.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>user_id</name>
        <summary>ID of single user to get</summary>
        <type>uuid</type>
      </attrib>
      <attrib>
        <name>filter</name>
        <summary>Filter term to use to filter query</summary>
        <type>text</type>
        <filter_keywords>
          <column>
            <name>uuid</name>
            <type>uuid</type>
            <summary>Unique ID</summary>
          </column>
          <column>
            <name>name</name>
            <type>name</type>
            <summary>Name</summary>
          </column>
          <column>
            <name>comment</name>
            <type>text</type>
            <summary>Comment text</summary>
          </column>
          <column>
            <name>created</name>
            <type>iso_time</type>
            <summary>Creation time</summary>
          </column>
          <column>
            <name>modified</name>
            <type>iso_time</type>
            <summary>Modification time</summary>
          </column>
          <column>
            <name>owner</name>
            <type>name</type>
            <summary>Name of the owner</summary>
          </column>
          <column>
            <name>method</name>
            <type>text</type>
            <summary>Methods allowed for authentication</summary>
          </column>
          <column>
            <name>roles</name>
            <type>text</type>
            <summary>Comma-separated list of roles</summary>
          </column>
          <column>
            <name>groups</name>
            <type>text</type>
            <summary>Comma-separated list of groups</summary>
          </column>
          <column>
            <name>hosts</name>
            <type>text</type>
            <summary>List of host that are either allowed of forbidden</summary>
          </column>
          <column>
            <name>ifaces</name>
            <type>text</type>
            <summary>List of ifaces that are either allowed of forbidden</summary>
          </column>
        </filter_keywords>
      </attrib>
      <attrib>
        <name>filt_id</name>
        <summary>ID of filter to use to filter query</summary>
        <type>uuid</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>user</e></any>
        <e>filters</e>
        <e>sort</e>
        <e>users</e>
        <e>user_count</e>
      </pattern>
      <ele>
        <name>user</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>ID of user</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>owner</e>
          <e>name</e>
          <e>comment</e>
          <e>creation_time</e>
          <e>modification_time</e>
          <e>writable</e>
          <e>in_use</e>
          <any><e>role</e></any>
          <e>groups</e>
          <e>hosts</e>
          <e>ifaces</e>
          <e>permissions</e>
          <e>user_tags</e>
          <e>sources</e>
        </pattern>
        <ele>
          <name>owner</name>
          <summary>Owner of the user</summary>
          <pattern>
            <e>name</e>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The name of the owner</summary>
            <pattern><t>name</t></pattern>
          </ele>
        </ele>
        <ele>
          <name>name</name>
          <summary>The name of the user</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>comment</name>
          <summary>The comment on the user</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>creation_time</name>
          <summary>Creation time of the user</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>modification_time</name>
          <summary>Last time the user was modified</summary>
          <pattern><t>iso_time</t></pattern>
        </ele>
        <ele>
          <name>writable</name>
          <summary>Whether the user is writable</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>in_use</name>
          <summary>Whether this user is currently in use</summary>
          <pattern><t>boolean</t></pattern>
        </ele>
        <ele>
          <name>role</name>
          <summary>The role of the user</summary>
          <pattern>
            <attrib>
              <name>id</name>
              <type>uuid</type>
              <required>1</required>
            </attrib>
            <e>name</e>
            <o><e>permissions</e></o>
          </pattern>
          <ele>
            <name>name</name>
            <summary>Name of role</summary>
            <pattern><t>name</t></pattern>
          </ele>
          <ele>
            <name>permissions</name>
            <summary>Permissions the user has on the role</summary>
            <pattern></pattern>
          </ele>
        </ele>
        <ele>
          <name>groups</name>
          <summary>The groups the user belongs to</summary>
          <pattern>
            <e>group</e>
          </pattern>
          <ele>
            <name>group</name>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <required>1</required>
              </attrib>
              <e>name</e>
              <o><e>permissions</e></o>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of group</summary>
              <pattern><t>name</t></pattern>
            </ele>
            <ele>
              <name>permissions</name>
              <summary>Permissions the user has on the group</summary>
              <pattern></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>hosts</name>
          <summary>Host access rule for the user</summary>
          <pattern>
            <attrib>
              <name>allow</name>
              <summary>0 forbidden, 1 allowed, 2 all allowed, 3 custom</summary>
              <type>
                <alts>
                  <alt>0</alt>
                  <alt>1</alt>
                  <alt>2</alt>
                  <alt>3</alt>
                </alts>
              </type>
              <required>1</required>
            </attrib>
            text
          </pattern>
        </ele>
        <ele>
          <name>ifaces</name>
          <summary>Iface access rule for the user</summary>
          <pattern>
            <attrib>
              <name>allow</name>
              <summary>0 forbidden, 1 allowed, 2 all allowed, 3 custom</summary>
              <type>
                <alts>
                  <alt>0</alt>
                  <alt>1</alt>
                  <alt>2</alt>
                  <alt>3</alt>
                </alts>
              </type>
              <required>1</required>
            </attrib>
            text
          </pattern>
        </ele>
        <ele>
          <name>permissions</name>
          <summary>
            Permissions that the current user has on the user
          </summary>
          <pattern>
            <any><e>permission</e></any>
          </pattern>
          <ele>
            <name>permission</name>
            <pattern>
              <e>name</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the permission</summary>
              <pattern><t>name</t></pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>user_tags</name>
          <summary>Info on tags attached to the user</summary>
          <pattern>
            <e>count</e>
            <any><e>tag</e></any>
          </pattern>
          <ele>
            <name>count</name>
            <summary>Number of attached tags</summary>
            <pattern><t>integer</t></pattern>
          </ele>
          <ele>
            <name>tag</name>
            <summary>
              Short info on an individual tag
              (only if details were requested)
            </summary>
            <pattern>
              <attrib>
                <name>id</name>
                <type>uuid</type>
                <summary>UUID of the tag</summary>
                <required>1</required>
              </attrib>
              <e>name</e>
              <e>value</e>
              <e>comment</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>Name of the tag (usually namespace:predicate)</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>Value of the tag</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>comment</name>
              <summary>Comment for the tag</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
        <ele>
          <name>sources</name>
          <summary>Sources allowed for authentication for this user</summary>
          <type>sources</type>
        </ele>
      </ele>
      <ele>
        <name>filters</name>
        <pattern>
          <attrib>
            <name>id</name>
            <summary>UUID of filter if any, else 0</summary>
            <type>uuid</type>
            <required>1</required>
          </attrib>
          <e>term</e>
          <o><e>name</e></o>
          <e>keywords</e>
        </pattern>
        <ele>
          <name>term</name>
          <summary>Filter term</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>name</name>
          <summary>Filter name, if applicable</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>keywords</name>
          <summary>Filter broken down into keywords</summary>
          <pattern><any><e>keyword</e></any></pattern>
          <ele>
            <name>keyword</name>
            <pattern>
              <e>column</e>
              <e>relation</e>
              <e>value</e>
            </pattern>
            <ele>
              <name>column</name>
              <summary>Column prefix</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>relation</name>
              <summary>Relation operator</summary>
              <pattern>
                <alts>
                  <alt>=</alt>
                  <alt>:</alt>
                  <alt>~</alt>
                  <alt>&gt;</alt>
                  <alt>&lt;</alt>
                </alts>
              </pattern>
            </ele>
            <ele>
              <name>value</name>
              <summary>The filter text</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>sort</name>
        <pattern>
          text
          <e>field</e>
        </pattern>
        <ele>
          <name>field</name>
          <pattern>
            <e>order</e>
          </pattern>
          <ele>
            <name>order</name>
            <pattern>
              <t>
                <alts>
                  <alt>ascending</alt>
                  <alt>descending</alt>
                </alts>
              </t>
            </pattern>
          </ele>
        </ele>
      </ele>
      <ele>
        <name>users</name>
        <pattern>
          <attrib>
            <name>start</name>
            <summary>First user</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
          <attrib>
            <name>max</name>
            <summary>Maximum number of users</summary>
            <type>integer</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>user_count</name>
        <pattern>
          <e>filtered</e>
          <e>page</e>
        </pattern>
        <ele>
          <name>filtered</name>
          <summary>Number of users after filtering</summary>
          <pattern><t>integer</t></pattern>
        </ele>
        <ele>
          <name>page</name>
          <summary>Number of users on current page</summary>
          <pattern><t>integer</t></pattern>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get the users</summary>
      <request>
        <get_users></get_users>
      </request>
      <response>
        <get_users_response status="200" status_text="OK">
          <user>
            <name>foobar</name>
            <role id="8d453140-b74d-11e2-b0be-406186ea4fc5">
              <name>User</name>
            </role>
            <hosts allow="2"></hosts>
            <user_tags>
              <count>0</count>
            </user_tags>
            <sources><source>file</source></sources>
          </user>
        </get_users_response>
      </response>
    </example>
  </command>
  <command>
    <name>get_version</name>
    <summary>Get the OpenVAS Manager Protocol version</summary>
    <pattern></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>
        <e>version</e>
      </pattern>
      <ele>
        <name>version</name>
        <pattern>text</pattern>
      </ele>
    </response>
    <example>
      <summary>Get the version</summary>
      <request>
        <get_version></get_version>
      </request>
      <response>
        <get_version_response status="200" status_text="OK">
          <version>1.0</version>
        </get_version_response>
      </response>
    </example>
  </command>
  <command>
    <name>help</name>
    <summary>Get the help text</summary>
    <pattern>
      <attrib>
        <name>format</name>
        <summary>Required help format</summary>
        <type>
          <alts>
            <alt>html</alt>
            <alt>HTML</alt>
            <alt>rnc</alt>
            <alt>RNC</alt>
            <alt>text</alt>
            <alt>TEXT</alt>
            <alt>xml</alt>
            <alt>XML</alt>
          </alts>
        </type>
      </attrib>
      <attrib>
        <name>type</name>
        <summary>Help type, currently only blank or "brief" for XML format</summary>
        <type>
          <alts>
            <alt>brief</alt>
            <alt></alt>
          </alts>
        </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>
        <o><e>schema</e></o>
        text
      </pattern>
      <ele>
        <name>schema</name>
        <pattern><e>protocol</e></pattern>
        <ele>
          <name>protocol</name>
          <pattern>
            <attrib>
              <name>format</name>
              <summary>The help format</summary>
              <type>
                text
              </type>
            </attrib>
            <attrib>
              <name>extension</name>
              <summary>The suggested file extension for the help</summary>
              <type>
                text
              </type>
            </attrib>
            <attrib>
              <name>content_type</name>
              <summary>The MIME content-type of the help</summary>
              <type>
                text
              </type>
            </attrib>
            <e>name</e>
            <o><e>abbreviation</e></o>
            <o><e>summary</e></o>
            <o><e>version</e></o>
            <any><e>type</e></any>
            <any><e>command</e></any>
          </pattern>
          <ele>
            <name>name</name>
            <summary>The full name of the protocol</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>abbreviation</name>
            <summary>The abbreviated name of the protocol</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>summary</name>
            <summary>A summary of the protocol</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>version</name>
            <summary>The version number of the protocol</summary>
            <pattern>text</pattern>
          </ele>
          <ele>
            <name>type</name>
            <summary>A data type</summary>
            <pattern>
              <e>name</e>
              <o><e>summary</e></o>
              <o><e>description</e></o>
              <e>pattern</e>
            </pattern>
            <ele>
              <name>name</name>
              <summary>The name of the data type</summary>
              <pattern><t>type_name</t></pattern>
            </ele>
            <ele>
              <name>summary</name>
              <summary>A summary of the data type</summary>
              <pattern>text</pattern>
            </ele>
            <ele>
              <name>description</name>
              <summary>A description of the data type</summary>
              <pattern>
                <any><e>p</e></any>
                text
              </pattern>
              <ele>
                <name>p</name>
                <summary>A paragraph</summary>
                <pattern>text</pattern>
              </ele>
            </ele>
            <ele>
              <name>pattern</name>
              <summary>The RNC pattern for the data type</summary>
              <pattern>text</pattern>
            </ele>
          </ele>
          <ele>
            <name>command</name>
            <summary>A command</summary>
            <type>command_definition</type>
          </ele>
        </ele>
      </ele>
    </response>
    <example>
      <summary>Get the help text</summary>
      <request>
        <help></help>
      </request>
      <response>
        <help_response status="200" status_text="OK">
            AUTHENTICATE           Authenticate with the manager.
            COMMANDS               Run a list of commands.
            CREATE_AGENT           Create an agent.
            CREATE_ALERT           Create an alert.
            CREATE_ASSET           Create an asset.
            CREATE_CONFIG          Create a config.
            CREATE_CREDENTIAL      Create a credential.
            CREATE_FILTER          Create a filter.
            CREATE_GROUP           Create a group.
            CREATE_NOTE            Create a note.
            CREATE_OVERRIDE        Create an override.
            CREATE_PERMISSION      Create a permission.
            CREATE_PORT_LIST       Create a port list.
            CREATE_PORT_RANGE      Create a port range in a port list.
            CREATE_REPORT          Create a report.
            CREATE_REPORT_FORMAT   Create a report format.
            CREATE_ROLE            Create a role.
            CREATE_SCANNER         Create a scanner.
            CREATE_SCHEDULE        Create a schedule.
            CREATE_TAG             Create a tag.
            CREATE_TARGET          Create a target.
            CREATE_TASK            Create a task.
            CREATE_USER            Create a new user.
            DELETE_AGENT           Delete an agent.
            DELETE_ALERT           Delete an alert.
            DELETE_ASSET           Delete an asset.
            DELETE_CONFIG          Delete a config.
            DELETE_CREDENTIAL      Delete a credential.
            DELETE_FILTER          Delete a filter.
            DELETE_GROUP           Delete a group.
            DELETE_NOTE            Delete a note.
            DELETE_OVERRIDE        Delete an override.
            DELETE_PERMISSION      Delete a permission.
            DELETE_PORT_LIST       Delete a port list.
            DELETE_PORT_RANGE      Delete a port range.
            DELETE_REPORT          Delete a report.
            DELETE_REPORT_FORMAT   Delete a report format.
            DELETE_ROLE            Delete a role.
            DELETE_SCANNER         Delete a scanner.
            DELETE_SCHEDULE        Delete a schedule.
            DELETE_TAG             Delete a tag.
            DELETE_TARGET          Delete a target.
            DELETE_TASK            Delete a task.
            DELETE_USER            Delete an existing user.
            DESCRIBE_AUTH          Get details about the used authentication methods.
            EMPTY_TRASHCAN         Empty the trashcan.
            GET_AGENTS             Get all agents.
            GET_AGGREGATES         Get aggregates of resources.
            GET_ALERTS             Get all alerts.
            GET_ASSETS             Get all assets.
            GET_CONFIGS            Get all configs.
            GET_CREDENTIALS        Get all credentials.
            GET_FEEDS              Get details of one or all feeds this Manager uses.
            GET_FILTERS            Get all filters.
            GET_GROUPS             Get all groups.
            GET_INFO               Get raw information for a given item.
            GET_NOTES              Get all notes.
            GET_NVTS               Get one or all available NVTs.
            GET_NVT_FAMILIES       Get a list of all NVT families.
            GET_OVERRIDES          Get all overrides.
            GET_PERMISSIONS        Get all permissions.
            GET_PORT_LISTS         Get all port lists.
            GET_PREFERENCES        Get preferences for all available NVTs.
            GET_REPORTS            Get all reports.
            GET_REPORT_FORMATS     Get all report formats.
            GET_RESULTS            Get results.
            GET_ROLES              Get all roles.
            GET_SCANNERS           Get all scanners.
            GET_SCHEDULES          Get all schedules.
            GET_SETTINGS           Get all settings.
            GET_SYSTEM_REPORTS     Get all system reports.
            GET_TAGS               Get all tags.
            GET_TARGETS            Get all targets.
            GET_TASKS              Get all tasks.
            GET_USERS              Get all users.
            GET_VERSION            Get the OpenVAS Manager Protocol version.
            HELP                   Get this help text.
            MODIFY_AGENT           Modify an existing agent.
            MODIFY_ALERT           Modify an existing alert.
            MODIFY_ASSET           Modify an existing asset.
            MODIFY_AUTH            Modify the authentication methods.
            MODIFY_CONFIG          Update an existing config.
            MODIFY_CREDENTIAL      Modify an existing credential.
            MODIFY_FILTER          Modify an existing filter.
            MODIFY_GROUP           Modify an existing group.
            MODIFY_NOTE            Modify an existing note.
            MODIFY_OVERRIDE        Modify an existing override.
            MODIFY_PERMISSION      Modify an existing permission.
            MODIFY_PORT_LIST       Modify an existing port list.
            MODIFY_REPORT          Modify an existing report.
            MODIFY_REPORT_FORMAT   Modify an existing report format.
            MODIFY_ROLE            Modify an existing role.
            MODIFY_SCANNER         Modify an existing scanner.
            MODIFY_SCHEDULE        Modify an existing schedule.
            MODIFY_SETTING         Modify an existing setting.
            MODIFY_TAG             Modify an existing tag.
            MODIFY_TARGET          Modify an existing target.
            MODIFY_TASK            Update an existing task.
            MODIFY_USER            Modify a user.
            MOVE_TASK              Assign task to another slave scanner, even while running.
            RESTORE                Restore a resource.
            RESUME_TASK            Resume a stopped task.
            RUN_WIZARD             Run a wizard.
            START_TASK             Manually start an existing task.
            STOP_TASK              Stop a running task.
            SYNC_CERT              Synchronize with a CERT feed.
            SYNC_CONFIG            Synchronize a config with a scanner.
            SYNC_FEED              Synchronize with an NVT feed.
            SYNC_SCAP              Synchronize with a SCAP feed.
            TEST_ALERT             Run an alert.
            VERIFY_AGENT           Verify an agent.
            VERIFY_REPORT_FORMAT   Verify a report format.
            VERIFY_SCANNER         Verify a scanner.
        </help_response>
      </response>
    </example>
    <example>
      <summary>Get the OMP schema</summary>
      <request>
        <help format="XML"></help>
      </request>
      <response>
        <help_response status="200" status_text="OK">
          <schema format="XML" extension="xml" content_type="text/xml">
            <protocol>
              <name>OpenVAS Management Protocol</name>
              <abbreviation>OMP</abbreviation>
              <summary>The "management" protocol of the Open Vulnerability Assessment System</summary>
              <version>1.0</version>
              <type>
                <name>base64</name>
                <summary>Base64 encoded data</summary>
                <pattern>xsd:base64Binary</pattern>
              </type>
              <truncated>...</truncated>
              <command>
                <name>authenticate</name>
                <summary>Authenticate with the manager</summary>
                <description>
                  <p>
                    The client uses the authenticate command to authenticate with the
                    Manager.
                  </p>
                  <p>
                    The client normally executes this command at the beginning of each
                    connection.  The only commands permitted before authentication are
                    get_version and commands.
                  </p>
                </description>
                <pattern>
                  <e>credentials</e>
                </pattern>
                <ele>
                  <name>credentials</name>
                  <pattern>
                    <e>username</e>
                    <e>password</e>
                  </pattern>
                  <ele>
                    <name>username</name>
                    <summary>The login name of the user</summary>
                    <pattern>
                      text
                    </pattern>
                  </ele>
                  <ele>
                    <name>password</name>
                    <summary>The user's password</summary>
                    <pattern>
                      text
                    </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>Authenticate with a good password</summary>
                  <request>
                    <authenticate>
                      <credentials>
                        <username>sally</username>
                        <password>secret</password>
                      </credentials>
                    </authenticate>
                  </request>
                  <response>
                    <authenticate_response status="200" status_text="OK">
                      <role>User</role>
                      <timezone>UTC</timezone>
                    </authenticate_response>
                  </response>
                </example>
                <truncated>...</truncated>
              </command>
              <truncated>...</truncated>
            </protocol>
          </schema>
        </help_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_agent</name>
    <summary>Modify an existing agent</summary>
    <description>
      <p>
        The client uses the modify_agent command to change an existing agent.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>agent_id</name>
        <summary>ID of agent to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>name</e></o>
      <o><e>comment</e></o>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>Comment on agent</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>Name of agent</summary>
      <pattern><t>name</t></pattern>
    </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 the comment on an agent</summary>
      <request>
        <modify_agent agent_id="c737f787-9473-410d-8956-9d7b57bdd11f">
          <comment>Old Agent 1</comment>
        </modify_agent>
      </request>
      <response>
        <modify_agent_response status="200" status_text="OK">
        </modify_agent_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_alert</name>
    <summary>Modify an existing alert</summary>
    <description>
      <p>
        The client uses the modify_alert command to change an existing alert.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>alert_id</name>
        <summary>ID of alert to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>name</e></o>
      <o><e>comment</e></o>
      <o><e>filter</e></o>
      <o><e>event</e></o>
      <o><e>condition</e></o>
      <o><e>method</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>Name of alert</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>Comment on alert</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>condition</name>
      <summary>
        The condition that must be satisfied for the alert to occur
      </summary>
      <pattern>
        text
        <any><e>data</e></any>
      </pattern>
      <ele>
        <name>data</name>
        <summary>Some data that defines the condition</summary>
        <pattern>
          text
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the condition data</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>event</name>
      <summary>
        The event that must happen for the alert to occur
      </summary>
      <pattern>
        text
        <any><e>data</e></any>
      </pattern>
      <ele>
        <name>data</name>
        <summary>Some data that defines the event</summary>
        <pattern>
          text
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the event data</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>method</name>
      <summary>The method by which the user is alerted</summary>
      <pattern>
        text
        <any><e>data</e></any>
      </pattern>
      <ele>
        <name>data</name>
        <summary>Some data that defines the method</summary>
        <pattern>
          text
          <e>name</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>The name of the method data</summary>
          <pattern>
            text
          </pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>filter</name>
      <summary>Filter to apply when executing alert</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </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 the name and report filter of an alert and the condition that triggers it</summary>
      <request>
        <modify_alert alert_id='914b59f8-25f5-4c8f-832c-2379cd625236'>
            <name>Low Level Alert 2</name>
            <condition>
              Threat level at least
              <data>
                Low
                <name>level</name>
              </data>
            </condition>
            <filter id='7a06bd00-7e4a-4669-b7d7-8fe65ec64a41'/>
        </modify_alert>
      </request>
      <response>
        <modify_alert_response status="200" status_text="OK">
        </modify_alert_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_asset</name>
    <summary>Modify an existing asset</summary>
    <description>
      <p>
        The client uses the modify_asset command to change an existing asset.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>asset_id</name>
        <summary>ID of asset to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>comment</e></o>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>Comment on asset</summary>
      <pattern>text</pattern>
    </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 the comment of an asset</summary>
      <request>
        <modify_asset asset_id='914b59f8-25f5-4c8f-832c-2379cd625236'>
          <comment>New comment</comment>
        </modify_asset>
      </request>
      <response>
        <modify_asset_response status="200" status_text="OK">
        </modify_asset_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_auth</name>
    <summary>Modify the authentication methods</summary>
    <description>
      <p>
        The client uses the "modify_auth" command to modify the authentication
        methods.
      </p>
    </description>
    <pattern>
      <e>group</e>
    </pattern>
    <ele>
      <name>group</name>
      <pattern>
        <any><e>auth_conf_setting</e></any>
      </pattern>
      <ele>
        <name>auth_conf_setting</name>
        <pattern>
          <e>key</e>
          <e>value</e>
        </pattern>
        <ele>
          <name>key</name>
          <summary>Setting name</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <summary>Setting value</summary>
          <pattern>text</pattern>
        </ele>
      </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 single setting for an authentication method</summary>
      <request>
        <modify_auth>
          <group name="Foo">
            <auth_conf_setting>
              <key>Bar</key>
              <value>Baz</value>
            </auth_conf_setting>
          </group>
        </modify_auth>
      </request>
      <response>
        <modify_auth_response status="200" status_text="OK">
        </modify_auth_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_config</name>
    <summary>Modify an existing config</summary>
    <description>
      <p>
        This command can take five forms: with a preference, with a family
        selection, with an NVT selection, or with a name or comment.
      </p>
      <p>
        The first form modifies a preference on the config.
        If the preference includes an NVT, then the preference is an NVT preference,
        otherwise the preference is a scanner preference.  If the preference includes
        a value then the manager updates the value of the preference, otherwise the
        manager removes the preference.  The value must be base64 encoded.
      </p>

      <p>
        The second form, with a family selection, lets the client modify the
        NVTs selected by the config at a family level.  The idea is that the
        client modifies the entire family selection at once, so a client will
        often need to include many families in a family selection.
      </p>

      <p>
        The family_selection may include a growing element to indicate whether new
        families should be added to the selection.  It may also include any number
        of family elements.
      </p>

      <p>
        A family element must always include a name and may include a growing element
        and an all element.  The all element indicates whether all NVTs in the family
        should be selected.  The growing element indicates whether new NVTs in the
        family should be added to the selection as they arrive.  Leaving a family
        out of the family_selection is equivalent to including the family with all
        0 and growing 0.
      </p>

      <p>
        The effect of the all 0 and growing 0 case is subtle: if
        all NVTs were selected then all are removed (effectively removing the
        family from the config).  However if some NVTs were selected then they
        remain selected.  As a result the client must include in the
        family_selection all families that must have all NVTs selected.
      </p>

      <p>
        The third option, an NVT selection, must include a family and may include any
        number of NVTs.  The manager updates the given family in the config to
        include only the given NVTs.
      </p>

      <p>
        If there was no error with the command sent by the client, the manager will
        apply the changes to the config and will reply with a response code indicating
        success.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>config_id</name>
        <summary>ID of config to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <or>
        <e>name</e>
        <e>comment</e>
        <e>scanner</e>
        <e>preference</e>
        <e>family_selection</e>
        <e>nvt_selection</e>
      </or>
    </pattern>
    <ele>
      <name>name</name>
      <summary>New name for the config</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>New comment for the config</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>scanner</name>
      <summary>New scanner's UUID for the config</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>preference</name>
      <pattern>
        <e>name</e>
        <o><e>nvt</e></o>
        <o><e>value</e></o>
      </pattern>
      <ele>
        <name>name</name>
        <summary>The name of the preference to modify</summary>
        <pattern><t>name</t></pattern>
      </ele>
      <ele>
        <name>nvt</name>
        <summary>NVT associated with preference to modify</summary>
        <description>
          If this element is present then the preference is an NVT
          preference, otherwise it is a Scanner preference.
        </description>
        <pattern>
          <attrib>
            <name>oid</name>
            <type>oid</type>
            <required>1</required>
          </attrib>
        </pattern>
      </ele>
      <ele>
        <name>value</name>
        <summary>New value for preference</summary>
        <pattern><t>base64</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>family_selection</name>
      <pattern>
        <o><e>growing</e></o>
        <any><e>family</e></any>
      </pattern>
      <ele>
        <name>growing</name>
        <summary>Whether new families should be added to the config</summary>
        <pattern><t>boolean_atoi</t></pattern>
      </ele>
      <ele>
        <name>family</name>
        <pattern>
          <o><e>all</e></o>
          <o><e>growing</e></o>
          <e>name</e>
        </pattern>
        <ele>
          <name>all</name>
          <summary>Whether to select all NVTs initially</summary>
          <pattern><t>boolean_atoi</t></pattern>
        </ele>
        <ele>
          <name>growing</name>
          <summary>Whether to add newly arrived nvts to the selection</summary>
          <pattern><t>boolean_atoi</t></pattern>
        </ele>
        <ele>
          <name>name</name>
          <pattern><t>name</t></pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>nvt_selection</name>
      <pattern>
        <e>family</e>
        <any><e>nvt</e></any>
      </pattern>
      <ele>
        <name>family</name>
        <summary>Name of family to modify</summary>
        <pattern><t>name</t></pattern>
      </ele>
      <ele>
        <name>nvt</name>
        <pattern>
          <attrib>
            <name>oid</name>
            <type>oid</type>
            <required>1</required>
          </attrib>
        </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 config NVT preference</summary>
      <request>
        <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <preference>
            <nvt oid="1.3.6.1.4.1.25623.1.0.14259"></nvt>
            <name>Nmap (NASL wrapper)[checkbox]:UDP port scan</name>
            <value>eWVz</value>
          </preference>
        </modify_config>
      </request>
      <response>
        <modify_config_response status="200" status_text="OK">
        </modify_config_response>
      </response>
    </example>
    <example>
      <summary>Modify a config Scanner preference</summary>
      <request>
        <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <preference>
            <name>scanner[scanner]:vhosts</name>
            <value>ZXhhbXBsZQ==</value>
          </preference>
        </modify_config>
      </request>
      <response>
        <modify_config_response status="200" status_text="OK">
        </modify_config_response>
      </response>
    </example>
    <example>
      <summary>Modify the families that a config selects</summary>
      <description>
        <p>
          The outer "growing" element sets the config to add any new families
          that arrive.
        </p>
        <p>
          The client requests the Manager to keep a single selected
          family (Debian Local Security Checks), to select all NVTs in
          this family, and to automatically add any new NVTs in this family
          to the config.
        </p>
      </description>
      <request>
        <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <family_selection>
            <growing>1</growing>
            <family>
              <name>Debian Local Security Checks</name>
              <all>1</all>
              <growing>1</growing>
            </family>
          </family_selection>
        </modify_config>
      </request>
      <response>
        <modify_config_response status="200" status_text="OK">
        </modify_config_response>
      </response>
    </example>
    <example>
      <summary>Modify the NVTs that a config selects in a particular family</summary>
      <request>
        <modify_config config_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <nvt_selection>
            <family>Debian Local Security Checks</family>
            <nvt oid="1.3.6.1.4.1.25623.1.0.53797"></nvt>
            <nvt oid="1.3.6.1.4.1.25623.1.0.63272"></nvt>
            <nvt oid="1.3.6.1.4.1.25623.1.0.55615"></nvt>
            <nvt oid="1.3.6.1.4.1.25623.1.0.53546"></nvt>
          </nvt_selection>
        </modify_config>
      </request>
      <response>
        <modify_config_response status="200" status_text="OK">
        </modify_config_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_credential</name>
    <summary>Modify an existing credential</summary>
    <description>
      <p>
        The client uses the modify_credential command to change an
        existing credential.
      </p>
      <p>
        The login and password can only be changed for password credentials.
        Modification of login or password on package credentials is forbidden.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>credential_id</name>
        <summary>ID of credential to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>comment</e></o>
      <o><e>name</e></o>
      <o><e>allow_insecure</e></o>
      <o><e>certificate</e></o>
      <o><e>key</e></o>
      <o><e>login</e></o>
      <o><e>password</e></o>
      <o><e>community</e></o>
      <o><e>auth_algorithm</e></o>
      <o><e>privacy</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A name for the credential</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>A comment on the credential</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>allow_insecure</name>
      <summary>Whether to allow insecure use of the credential</summary>
      <pattern>
        <t>boolean</t>
      </pattern>
    </ele>
    <ele>
      <name>certificate</name>
      <summary>The certificate for the credential</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>key</name>
      <pattern>
        <e>phrase</e>
        <e>private</e>
      </pattern>
      <ele>
        <name>phrase</name>
        <summary>Key passphrase</summary>
        <pattern>
          text
        </pattern>
      </ele>
      <ele>
        <name>private</name>
        <summary>Private key</summary>
        <pattern>
          text
        </pattern>
      </ele>
    </ele>
    <ele>
      <name>login</name>
      <summary>The user name of the credential</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>password</name>
      <summary>The password for the credential login</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>community</name>
      <summary>The SNMP community</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>auth_algorithm</name>
      <summary>Authentication algorithm for SNMP, either md5 or sha1</summary>
      <pattern>
        <t>
          <alts>
            <alt>md5</alt>
            <alt>sha1</alt>
          </alts>
        </t>
      </pattern>
    </ele>
    <ele>
      <name>privacy</name>
      <pattern>
        <e>algorithm</e>
        <e>password</e>
      </pattern>
      <ele>
        <name>algorithm</name>
        <summary>The SNMP privacy algorithm, either aes or des</summary>
        <pattern>
          <t>
            <alts>
              <alt>aes</alt>
              <alt>des</alt>
            </alts>
          </t>
        </pattern>
      </ele>
      <ele>
        <name>password</name>
        <summary>The SNMP privacy password</summary>
        <pattern>
          text
        </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 the comment of an credential</summary>
      <request>
        <modify_credential credential_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <comment>Credential for all machines in lab 4.</comment>
        </modify_credential>
      </request>
      <response>
        <modify_credential_response status="200" status_text="OK">
        </modify_credential_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_filter</name>
    <summary>Modify an existing filter</summary>
    <description>
      <p>
        The client uses the modify_filter command to change an existing filter.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>filter_id</name>
        <summary>ID of filter to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>comment</e></o>
      <o><e>name</e></o>
      <o><e>term</e></o>
      <o><e>type</e></o>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>Comment on filter</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>Name of filter</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>term</name>
      <summary>Filter term</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>type</name>
      <summary>Resource type filter applies to</summary>
      <pattern>text</pattern>
    </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 the term of a filter</summary>
      <request>
        <modify_filter filter_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <term>name=local</term>
        </modify_filter>
      </request>
      <response>
        <modify_filter_response status="200" status_text="OK">
        </modify_filter_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_group</name>
    <summary>Modify an existing group</summary>
    <description>
      <p>
        The client uses the modify_group command to change an existing group.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>group_id</name>
        <summary>ID of group to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>name</e></o>
      <o><e>comment</e></o>
      <o><e>users</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>Name of group</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>Comment on group</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>users</name>
      <summary>Comma separated list of user names</summary>
      <pattern>text</pattern>
    </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 the name of a group</summary>
      <request>
        <modify_group group_id='d94211b6-ba40-11e3-bcb1-406186ea4fc5'>
          <name>Line Managers</name>
        </modify_group>
      </request>
      <response>
        <modify_group_response status="200" status_text="OK">
        </modify_group_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_note</name>
    <summary>Modify an existing note</summary>
    <description>
      <p>
        The client uses the modify_note command to change an existing note.
      </p>
      <p>
        If an optional element is left out, the existing value will be
        cleared, generalising that constraint.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>note_id</name>
        <summary>ID of note to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>active</e></o>
      <o><e>hosts</e></o>
      <o><e>port</e></o>
      <o><e>result</e></o>
      <o><e>severity</e></o>
      <o><e>task</e></o>
      <e>text</e>
      <o><e>threat</e></o>
    </pattern>
    <ele>
      <name>active</name>
      <summary>Seconds note will be active.  -1 on always, 0 off</summary>
      <pattern><t>integer</t></pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>A textual list of hosts</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>Port to which note applies</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>severity</name>
      <summary>Severity to which note applies</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>text</name>
      <summary>The text of the note</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>threat</name>
      <summary>Threat level to which note applies</summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>Task to which note applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>result</name>
      <summary>Result to which note applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </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 the text and result of a note</summary>
      <request>
        <modify_note note_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <text>This issue should be resolved after the upgrade.</text>
          <result result_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c"/>
        </modify_note>
      </request>
      <response>
        <modify_note_response status="200" status_text="OK">
        </modify_note_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_override</name>
    <summary>Modify an existing override</summary>
    <description>
      <p>
        The client uses the modify_override command to change an existing
        override.
      </p>
      <p>
        If an optional element is left out, the existing value will be
        cleared, generalising that constraint.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>override_id</name>
        <summary>ID of override to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>active</e></o>
      <o><e>hosts</e></o>
      <o><e>new_severity</e></o>
      <o><e>new_threat</e></o>
      <o><e>port</e></o>
      <o><e>result</e></o>
      <o><e>task</e></o>
      <e>text</e>
      <o><e>severity</e></o>
      <o><e>threat</e></o>
    </pattern>
    <ele>
      <name>active</name>
      <summary>Seconds override will be active.  -1 on always, 0 off</summary>
      <pattern><t>integer</t></pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>A textual list of hosts</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>new_severity</name>
      <summary>New severity score for result</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>new_threat</name>
      <summary>New threat level for result</summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>Port to which override applies</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>text</name>
      <summary>Text describing the override</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>severity</name>
      <summary>Severity score to which override applies</summary>
      <pattern>
        <t>severity</t>
      </pattern>
    </ele>
    <ele>
      <name>threat</name>
      <summary>Threat level to which override applies</summary>
      <pattern>
        <t>threat</t>
      </pattern>
    </ele>
    <ele>
      <name>task</name>
      <summary>Task to which override applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>result</name>
      <summary>Result to which override applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </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>Set the override threat to Low</summary>
      <request>
        <modify_override override_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <text>This issue is less important in our setup.</text>
          <new_threat>Low</new_threat>
        </modify_override>
      </request>
      <response>
        <modify_override_response status="200" status_text="OK">
        </modify_override_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_permission</name>
    <summary>Modify a permission</summary>
    <description>
      <p>
        The client uses the modify_permission command to change an existing permission.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>permission_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>name</e></o>
      <o><e>comment</e></o>
      <o><e>resource</e></o>
      <o><e>subject</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>Permission name, currently the name of a command</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>The comment on the permission</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>resource</name>
      <summary>A resource to which the permission applies</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <summary>UUID if permission applies to resource, else 0</summary>
          <type>uuid</type>
          <required>0</required>
        </attrib>
        <e>type</e>
      </pattern>
      <ele>
        <name>type</name>
        <summary>OMP type, for Super permissions: user, group or role</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>subject</name>
      <summary>A subject to whom the permission is granted</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>0</required>
        </attrib>
        <e>type</e>
      </pattern>
      <ele>
        <name>type</name>
        <summary>OMP type of the subject: user, group or role</summary>
        <pattern>text</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>Change user of a permission</summary>
      <request>
        <modify_permission permission_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <subject id="76e47468-c095-11e3-9285-406186ea4fc5">
            <type>user</type>
          </subject>
        </modify_permission>
      </request>
      <response>
        <modify_permission_response status="200"
                             status_text="OK">
        </modify_permission_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_port_list</name>
    <summary>Modify an existing port list</summary>
    <description>
      <p>
        The client uses the modify_port_list command to change an existing port list.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>port_list_id</name>
        <summary>ID of port list to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>name</e></o>
      <o><e>comment</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>Name of port list</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>Comment on port list</summary>
      <pattern>text</pattern>
    </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 the name of a port list</summary>
      <request>
        <modify_port_list port_list_id='27140836-05ae-4e8b-9abf-f725ddc2888f'>
          <name>PL-WS1</name>
          <comment>Port List for Web Server 1</comment>
        </modify_port_list>
      </request>
      <response>
        <modify_port_list_response status="200" status_text="OK">
        </modify_port_list_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_report</name>
    <summary>Modify an existing report</summary>
    <description>
      <p>
        The client uses the modify_report command to change an existing
        report.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>report_id</name>
        <summary>ID of report to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <e>comment</e>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>The comment on the report</summary>
      <pattern>
        text
      </pattern>
    </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 comment</summary>
      <request>
        <modify_report report_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <comment>Monthly scan of the webserver.</comment>
        </modify_report>
      </request>
      <response>
        <modify_report_response status="200" status_text="OK">
        </modify_report_response>
      </response>
    </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_role</name>
    <summary>Modify an existing role</summary>
    <description>
      <p>
        The client uses the modify_role command to change an existing role.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>role_id</name>
        <summary>ID of role to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>name</e></o>
      <o><e>comment</e></o>
      <o><e>users</e></o>
    </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>
    <ele>
      <name>name</name>
      <summary>Name of role</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>Comment on role</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>users</name>
      <summary>Comma separated list of user names</summary>
      <pattern>text</pattern>
    </ele>
    <example>
      <summary>Modify the name of a role</summary>
      <request>
        <modify_role role_id='914b59f8-25f5-4c8f-832c-2379cd625236'>
          <name>SCAP User</name>
        </modify_role>
      </request>
      <response>
        <modify_role_response status="200" status_text="OK">
        </modify_role_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_scanner</name>
    <summary>Modify an existing scanner</summary>
    <description>
      <p>
        The client uses the modify_scanner command to change an existing scanner.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>scanner_id</name>
        <summary>ID of scanner to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>comment</e></o>
      <o><e>name</e></o>
      <e>host</e>
      <e>port</e>
      <e>type</e>
      <o><e>ca_pub</e></o>
      <o><e>credential</e></o>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>Comment on scanner</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>Name of scanner</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>host</name>
      <summary>Host of the scanner</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>port</name>
      <summary>Port of the scanner</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>type</name>
      <summary>Type of the scanner. '1' for OSP, '2' for OpenVAS (classic) Scanner</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>ca_pub</name>
      <summary>Certificate of CA to verify scanner's certificate</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>credential</name>
      <summary>Client certificate credential for the Scanner</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <summary>UUID of the credential</summary>
          <required>1</required>
        </attrib>
      </pattern>
    </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 the name of a scanner</summary>
      <request>
        <modify_scanner scanner_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <name>Weekly Scan</name>
        </modify_scanner>
      </request>
      <response>
        <modify_scanner_response status="200" status_text="OK">
        </modify_scanner_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_schedule</name>
    <summary>Modify an existing schedule</summary>
    <description>
      <p>
        The client uses the modify_schedule command to change an existing schedule.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>schedule_id</name>
        <summary>ID of schedule to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>comment</e></o>
      <o><e>name</e></o>
      <o><e>first_time</e></o>
      <o><e>duration</e></o>
      <o><e>period</e></o>
      <o><e>timezone</e></o>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>Comment on schedule</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>Name of schedule</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>first_time</name>
      <summary>First time the task will run. Missing subelements default to current system time</summary>
      <pattern>
        <o><e>day_of_month</e></o>
        <o><e>hour</e></o>
        <o><e>minute</e></o>
        <o><e>month</e></o>
        <o><e>year</e></o>
      </pattern>
      <ele>
        <name>day_of_month</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>hour</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>minute</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>month</name>
        <pattern>text</pattern>
      </ele>
      <ele>
        <name>year</name>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>timezone</name>
      <summary>The timezone the schedule will follow. User's timezone is used if omitted</summary>
      <pattern>timezone</pattern>
    </ele>
    <ele>
      <name>duration</name>
      <summary>How long the task will run for</summary>
      <pattern>
        text
        <o><e>unit</e></o>
      </pattern>
      <ele>
        <name>unit</name>
        <pattern><t>time_unit</t></pattern>
      </ele>
    </ele>
    <ele>
      <name>period</name>
      <summary>How often the task will run</summary>
      <pattern>
        text
        <o><e>unit</e></o>
      </pattern>
      <ele>
        <name>unit</name>
        <pattern><t>time_unit</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 the name of a schedule</summary>
      <request>
        <modify_schedule schedule_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <name>Weekly Scan</name>
        </modify_schedule>
      </request>
      <response>
        <modify_schedule_response status="200" status_text="OK">
        </modify_schedule_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_setting</name>
    <summary>Modify an existing setting</summary>
    <description>
      <p>
        The client uses the modify_setting command to change an existing
        setting.  These are user settings that can be controlled via OMP.
        The settings "Password" and "Timezone" can be modified by name, the
        rest by UUID.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>setting_id</name>
        <type>uuid</type>
      </attrib>
      <e>name</e>
      <e>value</e>
    </pattern>
    <ele>
      <name>name</name>
      <summary>The name of the setting</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>value</name>
      <summary>The value of the setting</summary>
      <pattern>
        text
      </pattern>
    </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 the timezone</summary>
      <request>
        <modify_setting>
          <name>Timezone</name>
          <value>Africa/Johannesburg</value>
        </modify_setting>
      </request>
      <response>
        <modify_setting_response status="200" status_text="OK">
        </modify_setting_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_target</name>
    <summary>Modify an existing target</summary>
    <description>
      <p>
        The client uses the modify_target command to change an existing target.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>target_id</name>
        <summary>ID of target to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>comment</e></o>
      <o><e>name</e></o>
      <o><e>hosts</e></o>
      <o><e>hosts_ordering</e></o>
      <o><e>exclude_hosts</e></o>
      <o><e>ssh_credential</e></o>
      <o><e>smb_credential</e></o>
      <o><e>esxi_credential</e></o>
      <o><e>snmp_credential</e></o>
      <o><e>ssh_lsc_credential</e></o>
      <o><e>smb_lsc_credential</e></o>
      <o><e>esxi_lsc_credential</e></o>
      <o><e>port_list</e></o>
      <o><e>alive_tests</e></o>
      <o><e>reverse_lookup_only</e></o>
      <o><e>reverse_lookup_unify</e></o>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>Comment on target</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>Name of target</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>Target hosts</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>hosts_ordering</name>
      <summary>The order hosts are scanned in</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>exclude_hosts</name>
      <summary>A list of hosts to exclude</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>ssh_credential</name>
      <summary>SSH credential to use on target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>smb_credential</name>
      <summary>SMB credential to use on target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>esxi_credential</name>
      <summary>ESXi credential to use on target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>snmp_credential</name>
      <summary>SNMP credential to use on target</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>ssh_lsc_credential</name>
      <summary>Deprecated: use ssh_credential. SSH credential</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>smb_lsc_credential</name>
      <summary>Deprecated: use ssh_credential. SMB credential</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>esxi_lsc_credential</name>
      <summary>Deprecated: use esxi_credential. ESXi credential</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>port_list</name>
      <summary>Port List describing ports to scan</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>alive_tests</name>
      <summary>Which alive tests to use</summary>
      <pattern>
        <t>alive_test</t>
      </pattern>
    </ele>
    <ele>
      <name>reverse_lookup_only</name>
      <summary>Whether to scan only hosts that have names</summary>
      <pattern><t>boolean</t></pattern>
    </ele>
    <ele>
      <name>reverse_lookup_unify</name>
      <summary>
        Whether to scan only one IP when multiple IPs have the same name
      </summary>
      <pattern><t>boolean</t></pattern>
    </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 the name of a target</summary>
      <request>
        <modify_target target_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <name>Upstairs Lab</name>
        </modify_target>
      </request>
      <response>
        <modify_target_response status="200" status_text="OK">
        </modify_target_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_tag</name>
    <summary>Modify a tag</summary>
    <description>
      <p>
        The client uses the modify_tag command to change an existing tag.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>tag_id</name>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <o><e>name</e></o>
      <o><e>resource</e></o>
      <o><e>value</e></o>
      <o><e>comment</e></o>
      <o><e>active</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>A full tag name consisting of namespace and predicate</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>resource</name>
      <summary>Identifies a resource the tag is to be attached to</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <summary>ID of the resource the tag is to be attached to</summary>
          <type>uuid</type>
          <required>0</required>
        </attrib>
        <e>type</e>
      </pattern>
      <ele>
        <name>type</name>
        <summary>OMP type of the resource the tag is to be attached to</summary>
        <pattern>text</pattern>
      </ele>
    </ele>
    <ele>
      <name>value</name>
      <summary>Value associated with the tag</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>comment</name>
      <summary>Comment to add to the tag</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>active</name>
      <summary>Whether the tag is active</summary>
      <pattern>boolean</pattern>
    </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>Deactivate a tag</summary>
      <request>
        <modify_tag tag_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <active>0</active>
        </modify_tag>
      </request>
      <response>
        <modify_tag_response status="200"
                             status_text="OK">
        </modify_tag_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_task</name>
    <summary>Modify an existing task</summary>
    <description>
      <p>
        The client uses the modify_task command to change an existing
        task.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>task_id</name>
        <summary>ID of task to modify</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <or>
        <e>comment</e>
        <!-- Actually at least one, else command is empty. -->
        <any><e>alert</e></any>
        <e>name</e>
        <e>observers</e>
        <e>preferences</e>
        <e>schedule</e>
        <e>schedule_periods</e>
        <e>scanner</e>
        <e>file</e>
      </or>
    </pattern>
    <ele>
      <name>comment</name>
      <summary>The comment on the task</summary>
      <pattern>
        text
      </pattern>
    </ele>
    <ele>
      <name>alert</name>
      <summary>Task alert</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>The name of the task</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>observers</name>
      <summary>Users allowed to observe this task</summary>
      <pattern><t>user_list</t></pattern>
    </ele>
    <ele>
      <name>preferences</name>
      <pattern>
        <any><e>preference</e></any>
      </pattern>
      <ele>
        <name>preference</name>
        <pattern>
          <e>scanner_name</e>
          <e>value</e>
        </pattern>
        <ele>
          <name>scanner_name</name>
          <summary>Compact name of preference, from scanner</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <pattern>text</pattern>
        </ele>
      </ele>
    </ele>
    <ele>
      <name>schedule</name>
      <summary>Task schedule</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>schedule_periods</name>
      <summary>
        A limit to the number of times the task will be scheduled, or 0 for no limit
      </summary>
      <pattern>
        <t>integer</t>
      </pattern>
    </ele>
    <ele>
      <name>scanner</name>
      <summary>Task scanner</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>file</name>
      <summary>File to attach to task</summary>
      <pattern>
        <attrib>
          <name>name</name>
          <type>text</type>
          <required>1</required>
        </attrib>
        <t>base64</t>
        <attrib>
          <name>action</name>
          <type>
            <alts>
              <alt>update</alt>
              <alt>remove</alt>
            </alts>
          </type>
          <required>1</required>
        </attrib>
      </pattern>
    </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 task comment</summary>
      <request>
        <modify_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
          <comment>Monthly scan of the webserver.</comment>
        </modify_task>
      </request>
      <response>
        <modify_task_response status="200" status_text="OK">
        </modify_task_response>
      </response>
    </example>
  </command>
  <command>
    <name>modify_user</name>
    <summary>Modify a user</summary>
    <description>
      <p>
        The client uses the "modify_user" command to modify an user account
        on the OpenVAS server.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>user_id</name>
        <summary>ID of the user to be modified.  Overrides NAME element</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <e>name</e>
      <o><e>new_name</e></o>
      <o><e>password</e></o>
      <any><e>role</e></any>
      <o><e>hosts</e></o>
      <o><e>ifaces</e></o>
      <o><e>sources</e></o>
    </pattern>
    <ele>
      <name>name</name>
      <summary>The name of the user to be modified</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>new_name</name>
      <summary>The new name for the user</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>hosts</name>
      <summary>User access rules: a textual list of hosts</summary>
      <description>
        User is allowed to access any host if this element is missing.
      </description>
      <pattern>
        <attrib>
          <name>allow</name>
          <summary>If 1, allow only listed, otherwise forbid listed</summary>
          <type>boolean</type>
        </attrib>
        text
      </pattern>
    </ele>
    <ele>
      <name>ifaces</name>
      <summary>User access rules: a textual list of ifaces</summary>
      <pattern>
        <attrib>
          <name>allow</name>
          <summary>If 1, allow only listed, otherwise forbid listed</summary>
          <type>boolean</type>
        </attrib>
        text
      </pattern>
    </ele>
    <ele>
      <name>password</name>
      <summary>The password for the user</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>role</name>
      <summary>A role of the user</summary>
      <pattern>
        <attrib>
          <name>id</name>
          <type>uuid</type>
          <required>1</required>
        </attrib>
      </pattern>
    </ele>
    <ele>
      <name>sources</name>
      <summary>List of authentication sources for this user (if omitted, no changes)</summary>
      <type>sources</type>
    </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 user</summary>
      <request>
        <modify_user>
          <name>Foobar</name>
          <password modify="0"></password>
          <role id="8d453140-b74d-11e2-b0be-406186ea4fc5"></role>
          <hosts allow="0"></hosts>
        </modify_user>
      </request>
      <response>
        <modify_user_response status="200" status_text="OK">
        </modify_user_response>
      </response>
    </example>
  </command>
  <command>
    <name>move_task</name>
    <summary>
      Moves an existing task to another OMP slave scanner or the master
    </summary>
    <description>
      <p>
        If a scan is running, this command will stop the task and resume it
        after reassigning to the new OMP scanner or master.
        Note that in this case, the command will wait until the task has been
        requested to resume.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>task_id</name>
        <summary>ID of task to reassign</summary>
        <type>uuid</type>
        <required>1</required>
      </attrib>
      <attrib>
        <name>slave_id</name>
        <summary>ID of slave to reassign to, empty for master</summary>
        <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>Move a task to a slave</summary>
      <request>
        <move_task task_id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"
                   slave_id="97390ade-e075-11df-9973-002264764cea">
        </move_task>
      </request>
      <response>
        <move_task_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>restore</name>
    <summary>Restore a resource</summary>
    <description>
      <p>
        The client uses the restore a resource from the trashcan.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>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>Restore a target</summary>
      <request>
        <restore id="97390ade-e075-11df-9973-002264764cea">
        </restore>
      </request>
      <response>
        <restore_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>resume_task</name>
    <summary>Resume a task</summary>
    <description>
      <p>
        The client uses the resume_task command to manually resume a
        stopped task.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>task_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>
        <e>report_id</e>
      </pattern>
      <ele>
        <name>report_id</name>
        <summary>The id of the report</summary>
        <pattern>
          <t>uuid</t>
        </pattern>
      </ele>
    </response>
    <example>
      <summary>Resume a task</summary>
      <request>
        <resume_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </resume_task>
      </request>
      <response>
        <resume_task_response status="200" status_text="OK">
          <report_id>330ee785-c2c0-4d4c-ab96-725142c9b789</report_id>
        </resume_task_response>
      </response>
    </example>
  </command>
  <command>
    <name>run_wizard</name>
    <summary>Run a wizard</summary>
    <description>
      <p>
        The client uses the run_wizard command to run a wizard.
      </p>
    </description>
    <pattern>
      <o><e>mode</e></o>
      <e>name</e>
      <e>params</e>
      <attrib>
        <name>read_only</name>
        <type>boolean</type>
        <summary>Whether to only run wizards marked as read only</summary>
        <required>0</required>
      </attrib>
    </pattern>
    <ele>
      <name>mode</name>
      <summary>The mode to run the wizard in</summary>
      <pattern>text</pattern>
    </ele>
    <ele>
      <name>name</name>
      <summary>The name of the wizard</summary>
      <pattern><t>name</t></pattern>
    </ele>
    <ele>
      <name>params</name>
      <summary>Parameters for the wizard</summary>
      <pattern><any><e>param</e></any></pattern>
      <ele>
        <name>param</name>
        <pattern>
          <e>name</e>
          <e>value</e>
        </pattern>
        <ele>
          <name>name</name>
          <summary>Parameter name</summary>
          <pattern>text</pattern>
        </ele>
        <ele>
          <name>value</name>
          <summary>Value of parameter</summary>
          <pattern>text</pattern>
        </ele>
      </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>
        <e>response</e>
      </pattern>
      <ele>
        <name>response</name>
        <summary>Contains the response of the command run in the last step</summary>
        <pattern></pattern>
      </ele>
    </response>
    <example>
      <summary>Run the Quick Start wizard to scan localhost</summary>
      <request>
        <run_wizard>
          <name>quick_first_scan</name>
          <params>
            <param>
              <name>hosts</name>
              <value>localhost</value>
            </param>
          </params>
        </run_wizard>
      </request>
      <response>
        <run_wizard_response status="202" status_text="OK, request submitted">
          <response>
            <start_task_response status="202" status_text="OK, request submitted">
              <report_id>a06d21f7-8e2f-4d7f-bceb-1df852d8b37d</report_id>
            </start_task_response>
          </response>
        </run_wizard_response>
      </response>
    </example>
  </command>
  <command>
    <name>start_task</name>
    <summary>Manually start an existing task</summary>
    <description>
      <p>
        The client uses the start_task command to manually start an
        existing task.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>task_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>
        <e>report_id</e>
      </pattern>
      <ele>
        <name>report_id</name>
        <summary>The id of the report</summary>
        <pattern>
          <t>uuid</t>
        </pattern>
      </ele>
    </response>
    <example>
      <summary>Start a task</summary>
      <request>
        <start_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </start_task>
      </request>
      <response>
        <start_task_response status="200" status_text="OK">
          <report_id>330ee785-c2c0-4d4c-ab96-725142c9b789</report_id>
        </start_task_response>
      </response>
    </example>
  </command>
  <command>
    <name>stop_task</name>
    <summary>Stop a running task</summary>
    <description>
      <p>
        The client uses the stop_task command to manually stop a
        running task.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>task_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>Stop a running task</summary>
      <request>
        <stop_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
        </stop_task>
      </request>
      <response>
        <stop_task_response status="200" status_text="OK"/>
      </response>
    </example>
  </command>
  <command>
    <name>sync_cert</name>
    <summary>Synchronize with a CERT feed</summary>
    <description>
      <p>
        The client uses the "sync_cert" command to request a
        synchronization with the CERT feed service the Manager uses.
      </p>
    </description>
    <pattern>
    </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>Sync the feed</summary>
      <request>
        <sync_cert>
        </sync_cert>
      </request>
      <response>
        <sync_cert_response status="202" status_text="OK, request submitted"/>
      </response>
    </example>
  </command>
  <command>
    <name>sync_feed</name>
    <summary>Synchronize with an NVT feed</summary>
    <description>
      <p>
        The client uses the "sync_feed" command to request a
        synchronization with the NVT feed service the Manager uses.
      </p>
    </description>
    <pattern>
    </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>Sync the feed</summary>
      <request>
        <sync_feed>
        </sync_feed>
      </request>
      <response>
        <sync_feed_response status="202" status_text="OK, request submitted"/>
      </response>
    </example>
  </command>
  <command>
    <name>sync_config</name>
    <summary>Synchronize a config with a scanner</summary>
    <description>
      <p>
        The client uses the "sync_config" command to request an OSP
        config synchronization with a scanner, adding new parameters and
        removing old ones.
      </p>
    </description>
    <pattern>
    </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>Sync the config</summary>
      <request>
        <sync_config>
        </sync_config>
      </request>
      <response>
        <sync_config_response status="202" status_text="OK, request submitted"/>
      </response>
    </example>
  </command>
  <command>
    <name>sync_scap</name>
    <summary>Synchronize with a SCAP feed</summary>
    <description>
      <p>
        The client uses the "sync_scap" command to request a
        synchronization with the SCAP feed service the Manager uses.
      </p>
    </description>
    <pattern>
    </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>Sync the feed</summary>
      <request>
        <sync_scap>
        </sync_scap>
      </request>
      <response>
        <sync_scap_response status="202" status_text="OK, request submitted"/>
      </response>
    </example>
  </command>
  <command>
    <name>test_alert</name>
    <summary>Run an alert</summary>
    <description>
      <p>
        The client uses the test_alert command to invoke a test run of
        an alert.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>alert_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>
        <o><e>status_details</e></o>
      </pattern>
      <elem>
        <name>status_details</name>
        <summary>
          Detailed error message when the test fails
        </summary>
        <type>text</type>
      </elem>
    </response>
    <example>
      <summary>Test an alert</summary>
      <request>
        <test_alert alert_id="97390ade-e075-11df-9973-002264764cea">
        </test_alert>
      </request>
      <response>
        <test_alert_response status="200" status_text="OK"/>
      </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>
  <command>
    <name>verify_scanner</name>
    <summary>Verify a scanner</summary>
    <description>
      <p>
        The client uses the verify_scanner command to verify whether it is
        possible to connect to an existing scanner.
      </p>
    </description>
    <pattern>
      <attrib>
        <name>scanner_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 scanner</summary>
      <request>
        <verify_scanner scanner_id="6acd0832-df90-11e4-b9d5-28d24461215b">
        </verify_scanner>
      </request>
      <response>
        <verify_scanner_response status="200" status_text="OK">
          <version>OTP/2.0</version>
        </verify_scanner_response>
      </response>
    </example>
  </command>

  <!-- Compatibility changes between versions. -->

  <change>
    <command>GET_NVT_FEED_VERSION</command>
    <summary>Command removed</summary>
    <description>
      <p>
        The GET_NVT_FEED_VERSION command has been removed, as it has been
        superseded by the GET_FEEDS command.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_TASKS, MODIFY_TASK</command>
    <summary>Element SLAVE removed</summary>
    <description>
      <p>
        Slaves have been replaced by OMP Scanners, therefore the SLAVE
        elements of commands GET_TASKS and MODIFY_TASK have been removed.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_CREDENTIALS</command>
    <summary>Attribute "slaves" and element SLAVES removed</summary>
    <description>
      <p>
        Slaves have been replaced by OMP Scanners, therefore the "slaves"
        attribute and CREDENTIAL/SLAVES element of GET_CREDENTIALS have been
        removed.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>CREATE_TASK</command>
    <summary>Element SLAVE removed</summary>
    <description>
      <p>
        Slaves have been replaced by OMP Scanners, therefore the SLAVE element
        of CREATE_TASK has been removed.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>CREATE_SLAVE, DELETE_SLAVE, GET_SLAVES, MODIFY_SLAVE</command>
    <summary>Commands removed</summary>
    <description>
      <p>
        Slaves have been replaced by OMP Scanners, therefore the CREATE_SLAVE,
        DELETE_SLAVE, GET_SLAVES and MODIFY_SLAVE commands have been removed.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>DESCRIBE_FEED, DESCRIBE_SCAP, DESCRIBE_CERT</command>
    <summary>Commands replaced with GET_FEEDS</summary>
    <description>
      <p>
        The commands DESCRIBE_FEED, DESCRIBE_SCAP and DESCRIBE_CERT have been
        replaced with a single command, GET_FEEDS.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_REPORT_FORMATS, CREATE_REPORT_FORMAT</command>
    <summary>Element GLOBAL removed</summary>
    <description>
      <p>
        The GLOBAL element has been removed from REPORT_FORMAT.  The element
        will simply be ignored by CREATE_REPORT_FORMAT.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>DESCRIBE_AUTH, MODIFY_AUTH</command>
    <summary>Response attributes "key" and "value" moved to elements</summary>
    <description>
      <p>
        The attributes "key" and "value" of AUTH_CONF_SETTING have been moved
        to new child elements of AUTH_CONF_SETTING, KEY and VALUE.  This is in order
        to preserve whitespace in the settings.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>All GET_... commands</command>
    <summary>Limit on number of returned rows introduced</summary>
    <description>
      <p>
        The new setting "Max Rows Per Page" introduces a hard upper limit
        on the number of rows return by any GET command, regardless of the
        value of the "rows" term in the filter.
      </p>
      <p>
        The setting defaults to 1000 and can be changed globally via the
        --max-rows option.  A value of 0 indicates no limit, which is the
        previous behaviour.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_RESULTS</command>
    <summary>Redundant filtering attributes removed</summary>
    <description>
      <p>
        The command attributes "apply_overrides", "autofp", "notes" and
        "overrides" were removed.
        Equivalent functionality is available using filters
        (with the filter and filt_id attributes).
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_REPORTS</command>
    <summary>Redundant filtering attributes removed</summary>
    <description>
      <p>
        The command attributes "first_result", "max_results", "sort_order",
        "sort_field", "apply_overrides", "levels", "search_phrase",
        "min_cvss_base", "min_qod", "notes", "overrides", "delta_states",
        "autofp", "result_hosts_only" and "timezone" were removed.
        Equivalent functionality is available using filters
        (with the filter and filt_id attributes).
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_REPORTS</command>
    <summary>Filter keywords in response changed to common format</summary>
    <description>
      <p>
        The elements "phrase", "autofp", "notes", "overrides",
        "apply_overrides", "result_hosts_only", "min_cvss_base",
        "min_qod", "timezone" were removed from the "filters" element in the
        report and replaced with a "keywords" element using the same
        syntax as other GET_... commands.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_CREDENTIALS</command>
    <summary>Credential types renamed</summary>
    <description>
      <p>
        The TYPE element in the response will contain "up" instead of "pass"
         for username + password credentials and "usk" instead of "gen" for
         username + SSH key ones.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>CREATE_LSC_CREDENTIAL, DELETE_LSC_CREDENTIAL, GET_LSC_CREDENTIALS, MODIFY_LSC_CREDENTIAL</command>
    <summary>Resource type and commands renamed</summary>
    <description>
      <p>
        The type LSC_CREDENTIAL has been renamed to CREDENTIAL, so
        the CREATE_LSC_CREDENTIAL command is now named CREATE_CREDENTIAL,
        GET_LSC_CREDENTIALS is named GET_CREDENTIALS, etc.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>CREATE_SCANNER, GET_SCANNERS, MODIFY_SCANNER</command>
    <summary>key_priv and key_pub replaced by credential</summary>
    <description>
      <p>
        The key_priv and key_pub elements have been replaced by a credential
        one referencing a "cc" (client certificate) type credential.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>CREATE_SLAVE, GET_SLAVES, MODIFY_SLAVE</command>
    <summary>username and password replaced by credential</summary>
    <description>
      <p>
        The username and password elements have been replaced by a credential
        one referencing a "up" (username + password) type credential.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>GET_TARGETS</command>
    <summary>&quot;lsc_&quot; removed from credential element names</summary>
    <description>
      <p>
        The elements ssh_lsc_credential, smb_lsc_credential and
        esxi_lsc_credential have been renamed to ssh_credential, smb_credential
        and esxi_credential.
      </p>
    </description>
    <version>7.0</version>
  </change>
  <change>
    <command>PAUSE_TASK, RESUME_PAUSED_TASK</command>
    <summary>Commands removed</summary>
    <description>
      <p>
        The task pausing feature has been removed and thus, the PAUSE_TASK and
        RESUME_PAUSED_TASK commands don't exist anymore.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>GET_NOTES, GET_OVERRIDES, GET_REPORTS, GET_RESULTS</command>
    <summary>Element RISK_FACTOR removed from element NVT</summary>
    <description>
      <p>
        Risk factors have been replaced by CVSS scores in all NVTs, so the
        RISK_FACTOR element has been removed from the NVT elements in
        various commands.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>RESUME_STOPPED_TASK, RESUME_TASK</command>
    <summary>RESUME_STOPPED_TASK renamed to RESUME_TASK</summary>
    <description>
      <p>
        The resuming of tasks is now done via the new command RESUME_TASK,
    which is the former RESUME_STOPPED_TASK. There is no other resumable
    status than "stopped" anymore and thus the command names are
        consolidated for consistency and to avoid confusion.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>RESUME_OR_START_TASK</command>
    <summary>Command removed</summary>
    <description>
      <p>
        As part of the consolidation of the start/resume handling of tasks,
        the command RESUME_OR_START_TASK was removed. Use a combination of
        START_TASK and RESUME_TASK to establish the same functionality.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>CREATE_TARGET, MODIFY_TARGET</command>
    <summary>Element TARGET_LOCATOR removed</summary>
    <description>
      <p>
        The element TARGET_LOCATOR was removed from CREATE_TARGET and
        MODIFY_TARGET.  This was an older, unused feature.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>GET_RESULTS</command>
    <summary>"result" elements moved to response root element</summary>
    <description>
      <p>
        The "result" elements returned by the GET_RESULTS command are no
        longer nested inside a "results" element but directly inside the
        "get_results_response". The "results" element is used to return the
        "max" and "start" attributes like similar elements for other types.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>GET_TARGET_LOCATORS</command>
    <summary>Command removed</summary>
    <description>
      <p>
        The command GET_TARGET_LOCATORS was removed.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>GET_TASKS</command>
    <summary>Attribute "rcfile" and associate RCFILE removed</summary>
    <description>
      <p>
        The attribute "rcfile" and associate response element RCFILE were
        removed.  It is no longer possible to get an openvasrc configuration
        for a task.  This feature was primarily introduced to support the
        GTK frontend openvas-client, which is no longer maintained.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>CREATE_CONFIG, CREATE_TASK, MODIFY_TASK</command>
    <summary>RCFILE removed</summary>
    <description>
      <p>
        The element RCFILE was removed.  It is no longer possible to create
        or modify a config or task from an openvasrc file.  This feature was
        primarily introduced to support the GTK frontend openvas-client, which
        is no longer maintained.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>CREATE_LSC_CREDENTIAL</command>
    <summary>KEY/PUBLIC removed</summary>
    <description>
      <p>
        The child PUBLIC of element KEY was removed, because public keys are
        now extracted from the private key.
      </p>
    </description>
    <version>6.0</version>
  </change>
  <change>
    <command>GET_FILTERS, CREATE_FILTER, MODIFY_FILTER</command>
    <summary>Filter type "report" is now "result"</summary>
    <description>
      <p>
        The filter type "report" has been renamed to "result".  Filters of
        this type apply to the results in a report, as used for example on
        the GSA "Report: Results" page.
      </p>
      <p>
        The name "report" is now used for a new filter type.  This filter
        type applies to lists of reports, as used for example on the GSA
        "Reports" page.
      </p>
    </description>
    <version>5.0</version>
  </change>
  <change>
    <command>CREATE_USER, MODIFY_USER</command>
    <summary>ROLE is identified by "id" attribute</summary>
    <description>
      <p>
        In OMP 4.0 these commands were served by OpenVAS Administrator.
      </p>
      <p>
        The attribute "id" is now used to specify a user's role, in the
        ROLE element.  Previously this was done using the NAME element inside
        ROLE.
      </p>
    </description>
    <version>5.0</version>
  </change>
  <change>
    <command>GET_USERS</command>
    <summary>Attributes name and sort_order removed</summary>
    <description>
      <p>
        In OMP 4.0 this command was served by OpenVAS Administrator.
      </p>
      <p>
        The attributes name and sort_order have been remove from the
        GET_USERS in OpenVAS Manager.  Equivalent functionality is available
        using filters (with the filter and filt_id attributes).
      </p>
    </description>
    <version>5.0</version>
  </change>
  <change>
    <command>GET_USERS</command>
    <summary>ROLE is optional, and role name has moved into NAME</summary>
    <description>
      <p>
        In OMP 4.0 this command was served by OpenVAS Administrator.
      </p>
      <p>
        With the new role management, zero or more ROLEs may be present in
        USER.  The name of the role is now in ROLE/NAME instead of directly
        in the text of ROLE.
      </p>
    </description>
    <version>5.0</version>
  </change>
  <change>
    <command>GET_NVTS</command>
    <summary>Fingerprint element removed</summary>
    <description>
      <p>
        The fingerprint element has been removed as signature keys aren't sent
        by the scanner anymore and thus, aren't stored in Manager DB anymore.
      </p>
    </description>
    <version>5.0</version>
  </change>
  <change>
    <command>GET_DEPENDENCIES</command>
    <summary>
      Command removed
    </summary>
    <description>
      <p>
        The command GET_DEPENDENCIES has been removed.
      </p>
    </description>
    <version>5.0</version>
  </change>
  <change>
    <command>MODIFY_TARGET</command>
    <summary>
      Missing elements now leave the associate target property alone
    </summary>
    <description>
      <p>
        MODIFY_TARGET now allows the user to modify one or more of the
        Target elements in a single command, instead of requiring all
        elements to be modified at once.
      </p>
      <p>
        As a side effect of this, leaving out an element will no longer
        set the associated target value to a default, but will leave the
        associated target value untouched.  For example, if SSH_LSC_CREDENTIAL
        is omitted from the MODIFY_TARGET command, the command will no
        longer reset the SSH credential of the target, but will leave the
        target's current SSH credential intact.
      </p>
    </description>
    <version>5.0</version>
  </change>
  <change>
    <command>All standard GET commands</command>
    <summary>Attribute "actions" replaced with owner filtering</summary>
    <description>
      <p>
        The attribute "actions" in GET commands has been removed.  The only
        implemented function of this attribute was to include observed
        resources in the listings.  For example, specifying actions="g" in a
        GET_TASKS command would include tasks that other users had made
        visible to the caller.  The new way to do this is to include
        "owner=any" in the filter.
      </p>
    </description>
    <version>4.0</version>
  </change>
  <change>
    <command>All standard GET commands</command>
    <summary>
      Attributes "sort_field" and "sort_order" replaced by filtering
    </summary>
    <description>
      <p>
        The attributes "sort_field" and "sort_order" have been removed from
        the standard GET commands.  The new way to do this is to include
        keywords like "sort=name" and "sort-reverse=name" in the filter.
      </p>
    </description>
    <version>4.0</version>
  </change>
  <change>
    <command>CREATE_ALERT, GET_ALERTS, MODIFY_ALERT</command>
    <summary>"Threat level" replaced with "Severity" in alert conditions</summary>
    <description>
      <p>
        The alert conditions "Threat level changed" and "Threat level at least"
        have been replaced with "Severity changed" and "Severity at least"
        respectively.<br/>
        The latter now expects a data entity named "severity"
        instead of "level". Both conditions now use a numeric severity value
        instead of the old threat levels like "High", "Medium" etc.
      </p>
    </description>
    <version>4.0</version>
  </change>
  <change>
    <command>GET_REPORTS</command>
    <summary>THREAT removed from PORT in response</summary>
    <version>4.0</version>
    <description>
      <p>
        In the response to GET_REPORTS the element THREAT in REPORTS/PORTS/PORT
        has been replaced with the element CVSS.
      </p>
    </description>
  </change>
  <change>
    <command>GET_TARGETS</command>
    <summary>PORT_RANGE not always returned within TARGET</summary>
    <version>4.0</version>
    <description>
      <p>
        In the response to GET_TARGETS the element PORT_RANGE in TARGETS
        is only included when details attribute is set in REQUEST.
      </p>
    </description>
  </change>
  <change>
    <command>GET_SCANNERS</command>
    <summary>Add mandatory value for OSP parameters</summary>
    <version>4.0</version>
    <description>
      <p>
        The param element now contains a mandatory element that equals 0 if
        false, 1 if true.
      </p>
    </description>
  </change>
  <change>
    <command>GET_NVTS</command>
    <summary>Remove summary element</summary>
    <version>4.0</version>
    <description>
      <p>
        Remove summary element as the nvt tag includes a summary already.
      </p>
    </description>
  </change>

  <!-- Changes between 1.0 and 2.0.

     report_formats
         new  CREATE_REPORT_FORMAT, DELETE_REPORT_FORMAT, GET_REPORTS_FORMATS
              VERIFY_REPORT_FORMAT, MODIFY_REPORT_FORMAT
         GET_REPORTS  req  attrib format_id instead of attrib format
                      resp  + attribs id, format_id, extension, content_type
                            entire xml report inside report entity, like others
     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
         GET_SYSTEM_REPORTS  req  + slave_id attrib
     agent trust
         GET_AGENTS  resp  + TRUST and TRUST/TIME
         new  VERIFY_AGENT
     lsc credentials
         new  MODIFY_LSC_CREDENTIAL
     HELP  req  + format attrib
           resp  + SCHEMA
     report filtered result counts
        GET_REPORTS/REPORT/RESULT_COUNT  + FILTERED and FULL
     target port ranges
        CREATE_TARGET,GET_TARGETS  + PORT_RANGE
     per-protocol target credentials
        CREATE_TARGET,GET_TARGETS  + SSH,SMB_LSC_CREDENTIAL, - LSC_CREDENTIAL
     GET_TASKS  - RESULT_COUNT
  -->

</protocol>
