"Fossies" - the Fresh Open Source Software Archive

Member "gvm-7.0.3/src/schema_formats/XML/OMP.xml.in" (29 Mar 2018, 753018 Bytes) of package /linux/misc/openvas/openvas-manager-7.0.3.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "OMP.xml.in": 7.0.2_vs_7.0.3.

    1 <!--
    2 OpenVAS Manager
    3 $Id$
    4 Description: OMP schema with embedded documentation, in OMP.
    5 
    6 Authors:
    7 Matthew Mundell <matthew.mundell@greenbone.net>
    8 
    9 Copyright:
   10 Copyright (C) 2010-2014 Greenbone Networks GmbH
   11 
   12 This program is free software; you can redistribute it and/or
   13 modify it under the terms of the GNU General Public License
   14 as published by the Free Software Foundation; either version 2
   15 of the License, or (at your option) any later version.
   16 
   17 This program is distributed in the hope that it will be useful,
   18 but WITHOUT ANY WARRANTY; without even the implied warranty of
   19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   20 GNU General Public License for more details.
   21 
   22 You should have received a copy of the GNU General Public License
   23 along with this program; if not, write to the Free Software
   24 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   25 -->
   26 
   27 <protocol>
   28   <name>OpenVAS Management Protocol</name>
   29   <abbreviation>OMP</abbreviation>
   30   <summary>The "management" protocol of the Open Vulnerability Assessment System</summary>
   31   <version>@OMP_VERSION@</version>
   32 
   33   <!-- Types. -->
   34 
   35   <type>
   36     <name>alive_test</name>
   37     <summary>An alive test</summary>
   38     <pattern>
   39       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" }
   40     </pattern>
   41   </type>
   42   <type>
   43     <name>base64</name>
   44     <summary>Base64 encoded data</summary>
   45     <pattern>xsd:base64Binary</pattern>
   46   </type>
   47   <type>
   48     <name>boolean</name>
   49     <summary>A true or false value</summary>
   50     <description>
   51       Zero is false, anything else is true.  As a result, the empty string is
   52       considered true.
   53     </description>
   54     <pattern>text</pattern>
   55   </type>
   56   <type>
   57     <name>boolean_atoi</name>
   58     <summary>A true or false value, after conversion to an integer</summary>
   59     <description>
   60       Zero is false, anything else is true.  The value is first converted to
   61       an integer, as by the C `atoi' routine.  This means that an empty string
   62       is considered false.
   63     </description>
   64     <pattern>text</pattern>
   65   </type>
   66   <type>
   67     <name>ctime</name>
   68     <summary>A date and time, in the C `ctime' format</summary>
   69     <description>
   70       An example string in this format is "Wed Jun 30 21:49:08 1993\n".
   71     </description>
   72     <pattern>text</pattern>
   73   </type>
   74   <type>
   75     <name>type_name</name>
   76     <summary>A name of a data type</summary>
   77     <pattern>xsd:Name</pattern>
   78   </type>
   79   <type>
   80     <name>integer</name>
   81     <summary>An integer</summary>
   82     <pattern>xsd:integer</pattern>
   83   </type>
   84   <type>
   85     <name>iso_time</name>
   86     <summary>A date and time, in ISO 8601 format</summary>
   87     <description>
   88       An example string in this format is "2011-11-08T19:57:06+02:00".
   89     </description>
   90     <pattern>text</pattern>
   91   </type>
   92   <type>
   93     <name>levels</name>
   94     <summary>A string that may include the characters h, m, l, g and d</summary>
   95     <pattern>xsd:token { pattern = "h?m?l?g?d?" }</pattern>
   96   </type>
   97   <type>
   98     <name>name</name>
   99     <summary>A name</summary>
  100     <description>
  101       Typically this is the name of one of the manager resources, like a
  102       task or target.
  103     </description>
  104     <pattern>xsd:string</pattern>
  105   </type>
  106   <type>
  107     <name>port</name>
  108     <summary>A port</summary>
  109     <pattern>xsd:token { pattern = "[0-9]{1,5}" }</pattern>
  110   </type>
  111   <type>
  112     <name>user_list</name>
  113     <summary>A space separated list of users</summary>
  114     <pattern>text</pattern>
  115   </type>
  116   <type>
  117     <name>oid</name>
  118     <summary>An Object Identifier (OID)</summary>
  119     <pattern>xsd:token { pattern = "[0-9\.]{1,80}" }</pattern>
  120   </type>
  121   <type>
  122     <name>severity</name>
  123     <summary>A severity score</summary>
  124     <description>
  125       A severity score is a decimal number between 0.0 and 10.0 (inclusive) with
  126       one digit after the decimal point or a special negative value
  127       (-1.0, -2.0 or -3.0).
  128       If a single severity score defines a constraint, e.g. on whether an
  129       override applies, for values 0.0 and lower the severity must be equal
  130       to match while for &gt; 0.0 the compared value must be greater or equal.
  131     </description>
  132     <pattern>xsd:token { pattern = "-[1-3](\.0)?|[0-9](\.[0-9])?|10(\.0)?" }</pattern>
  133   </type>
  134   <type>
  135     <name>sort_order</name>
  136     <summary>A string describing an order for sorting</summary>
  137     <description>
  138       The string "descending" denotes descending order, anything else means
  139       ascending.
  140     </description>
  141     <pattern>text</pattern>
  142   </type>
  143   <type>
  144     <name>status</name>
  145     <summary>The success or failure status of a command</summary>
  146     <pattern>xsd:token { pattern = "200|201|202|400|401|403|404|409|500|503" }</pattern>
  147   </type>
  148   <type>
  149     <name>task_status</name>
  150     <summary>A task run status</summary>
  151     <pattern>
  152       xsd:token { pattern = "Delete Requested|Done|New|Requested|Running|Stop Requested|Stopped|Internal Error" }
  153     </pattern>
  154   </type>
  155   <type>
  156     <name>task_trend</name>
  157     <summary>The trend of results for a task</summary>
  158     <pattern>
  159       xsd:token { pattern = "up|down|more|less|same" }
  160     </pattern>
  161   </type>
  162   <type>
  163     <name>threat</name>
  164     <summary>A threat level</summary>
  165     <description>
  166       Threat levels are a textual classification of severity scores only
  167       supported for importing reports from OpenVAS-6 and older.
  168       The use of these elements is deprecated as they are otherwise replaced by
  169       severity elements, which should be used instead.
  170     </description>
  171     <pattern>xsd:token { pattern = "High|Medium|Low|Alarm|Log|Debug" }</pattern>
  172   </type>
  173   <type>
  174     <name>time_unit</name>
  175     <summary>A unit of time</summary>
  176     <pattern>xsd:token { pattern = "second|minute|hour|day|week|month|year|decade" }</pattern>
  177   </type>
  178   <type>
  179     <name>timezone</name>
  180     <summary>A timezone</summary>
  181     <description>
  182       <p>
  183         The format of a timezone is the same as that of the TZ environment
  184         variable on GNU/Linux systems.  That is, the same value accepted by the
  185         tzset C function.  There are three versions of the format.  Note the lack
  186         of spaces in the examples.
  187       </p>
  188 
  189       <p>
  190         "std offset" defines a simple timezone.  For example,
  191         "FOO+2" defines a timezone FOO which is 2 hours behind UTC.
  192       </p>
  193       <p>
  194         "std offset dst [offset],start[/time],end[/time]" defines a timezone,
  195         including daylight savings time.  For example,
  196         "NZST-12.00:00NZDT-13:00:00,M10.1.0,M3.3.0".
  197       </p>
  198       <p>
  199         ":[filespec]" refers to a predefined timezone.  For example,
  200         ":Africa/Johannesburg".  Note that the colon is optional.  Certain
  201         acronyms are predefined, such as GB, NZ and CET.
  202       </p>
  203     </description>
  204     <pattern>text</pattern>
  205   </type>
  206   <type>
  207     <name>uuid</name>
  208     <summary>A Universally Unique Identifier (UUID)</summary>
  209     <pattern>xsd:token { pattern = "[0-9abcdefABCDEF\-]{1,40}" }</pattern>
  210   </type>
  211   <type>
  212     <name>uuid_or_empty</name>
  213     <summary>A Universally Unique Identifier (UUID), or the empty string</summary>
  214     <pattern>xsd:token { pattern = "[0-9abcdefABCDEF\-]{0,40}" }</pattern>
  215   </type>
  216 
  217   <!-- Elements. -->
  218 
  219   <element>
  220     <name>c</name>
  221     <summary>A reference to a command</summary>
  222     <pattern>text</pattern>
  223   </element>
  224   <element>
  225     <name>e</name>
  226     <summary>A reference to an element</summary>
  227     <pattern>text</pattern>
  228   </element>
  229   <element>
  230     <name>r</name>
  231     <summary>A reference to a response</summary>
  232     <pattern>text</pattern>
  233   </element>
  234   <element>
  235     <name>o</name>
  236     <summary>An optional pattern item</summary>
  237     <pattern>
  238       <or>
  239         <e>c</e>
  240         <e>e</e>
  241         <e>r</e>
  242         <e>g</e>
  243       </or>
  244     </pattern>
  245   </element>
  246   <element>
  247     <name>g</name>
  248     <summary>A group of pattern items</summary>
  249     <pattern>
  250       <any><e>c</e></any>
  251       <any><e>e</e></any>
  252       <any><e>r</e></any>
  253       <any><e>o</e></any>
  254       <any><e>any</e></any>
  255     </pattern>
  256   </element>
  257   <element>
  258     <name>any</name>
  259     <summary>Pattern item indicating "any number of"</summary>
  260     <pattern>
  261       <or>
  262         <e>c</e>
  263         <e>e</e>
  264         <e>r</e>
  265         <e>g</e>
  266       </or>
  267     </pattern>
  268   </element>
  269   <element>
  270     <name>pattern</name>
  271     <summary>The pattern element of a command or command descendant</summary>
  272     <description>
  273       It's actually either a 't' element, or the word "text", or "".
  274     </description>
  275     <pattern>
  276       <any><e>attrib</e></any>
  277       <any><e>c</e></any>
  278       <any><e>e</e></any>
  279       <any><e>r</e></any>
  280       <any><e>o</e></any>
  281       <any><e>g</e></any>
  282       <any><e>any</e></any>
  283       <o><e>t</e></o>
  284       text
  285     </pattern>
  286     <ele>
  287       <name>attrib</name>
  288       <summary>An attribute</summary>
  289       <pattern>
  290         <e>name</e>
  291         <e>type</e>
  292         <e>required</e>
  293         <any><e>filter_keywords</e></any>
  294       </pattern>
  295       <ele>
  296         <name>name</name>
  297         <pattern><t>type_name</t></pattern>
  298       </ele>
  299       <ele>
  300         <name>type</name>
  301         <pattern><t>type_name</t></pattern>
  302       </ele>
  303       <ele>
  304         <name>required</name>
  305         <pattern><t>boolean</t></pattern>
  306       </ele>
  307       <ele>
  308         <name>filter_keywords</name>
  309         <pattern><t>filter_keywords</t></pattern>
  310         <summary>Optional description of filter keywords usable in the attribute</summary>
  311       </ele>
  312     </ele>
  313     <ele>
  314       <name>t</name>
  315       <summary>The type of the text of the element</summary>
  316       <pattern><t>type_name</t></pattern>
  317     </ele>
  318   </element>
  319   <element>
  320     <name>command_definition</name>
  321     <summary>Definition of a command in OMP describing HELP command</summary>
  322     <pattern>
  323       <e>name</e>
  324       <o><e>summary</e></o>
  325       <o><e>description</e></o>
  326       <or>
  327         <g>
  328           <e>pattern</e>
  329           <e>response</e>
  330         </g>
  331         <g>
  332           <e>type</e>
  333           <any><e>ele</e></any>
  334         </g>
  335       </or>
  336       <any><e>example</e></any>
  337     </pattern>
  338     <ele>
  339       <name>name</name>
  340       <summary>The name of the command</summary>
  341       <description>The name must be unique</description>
  342       <pattern><t>type_name</t></pattern>
  343     </ele>
  344     <ele>
  345       <name>summary</name>
  346       <summary>A summary of the command</summary>
  347       <pattern>text</pattern>
  348     </ele>
  349     <ele>
  350       <name>description</name>
  351       <summary>A description of the command</summary>
  352       <pattern>
  353         <any><e>p</e></any>
  354         text
  355       </pattern>
  356       <ele>
  357         <name>p</name>
  358         <summary>A paragraph</summary>
  359         <pattern>text</pattern>
  360       </ele>
  361     </ele>
  362     <ele>
  363       <name>pattern</name>
  364       <type>pattern</type>
  365     </ele>
  366     <ele>
  367       <name>response</name>
  368       <type>pattern</type>
  369     </ele>
  370     <ele>
  371       <name>example</name>
  372       <pattern>
  373         <o><e>summary</e></o>
  374         <o><e>description</e></o>
  375         <e>request</e>
  376         <e>response</e>
  377       </pattern>
  378       <ele>
  379         <name>summary</name>
  380         <pattern>text</pattern>
  381       </ele>
  382       <ele>
  383         <name>description</name>
  384         <pattern>text</pattern>
  385       </ele>
  386       <ele>
  387         <name>request</name>
  388         <summary>Example request</summary>
  389         <description>This can actually contain any XML</description>
  390         <pattern>text</pattern>
  391       </ele>
  392       <ele>
  393         <name>response</name>
  394         <summary>Response to example request</summary>
  395         <description>This can actually contain any XML</description>
  396         <pattern>text</pattern>
  397       </ele>
  398     </ele>
  399     <ele>
  400       <name>type</name>
  401       <summary>The type of the element</summary>
  402       <pattern>text</pattern>
  403     </ele>
  404     <ele>
  405       <name>ele</name>
  406       <summary>An element</summary>
  407       <description>
  408         <p>
  409           This is a recursive definition.
  410         </p>
  411         <p>
  412           command_definition actually includes an extra response element, but
  413           it's convenient to use it for the elements.
  414         </p>
  415       </description>
  416       <type>command_definition</type>
  417     </ele>
  418   </element>
  419   <element>
  420     <name>filter_keywords</name>
  421     <summary>A group of filter keywords usable in an attribute or element text</summary>
  422     <pattern>
  423       <o><e>condition</e></o>
  424       <any><e>column</e></any>
  425       <any><e>option</e></any>
  426     </pattern>
  427     <ele>
  428       <name>condition</name>
  429       <pattern>text</pattern>
  430       <summary>Description of the condition under which the group of keywords applies</summary>
  431     </ele>
  432     <ele>
  433       <name>column</name>
  434       <pattern>
  435         <e>name</e>
  436         <e>type</e>
  437         <e>summary</e>
  438       </pattern>
  439       <summary>A column that can be used multiple times with operators and in sorting</summary>
  440       <ele>
  441         <name>name</name>
  442         <pattern>name</pattern>
  443         <summary>Name of the keyword as used in the filter</summary>
  444       </ele>
  445       <ele>
  446         <name>type</name>
  447         <pattern><t>type_name</t></pattern>
  448         <summary>Type of the values the keyword can use</summary>
  449       </ele>
  450       <ele>
  451         <name>summary</name>
  452         <pattern>text</pattern>
  453         <summary>Short description of the keyword</summary>
  454       </ele>
  455     </ele>
  456     <ele>
  457       <name>option</name>
  458       <pattern>
  459         <e>name</e>
  460         <e>type</e>
  461         <e>summary</e>
  462       </pattern>
  463       <summary>An option only applied once which cannot be used with operators or in sorting</summary>
  464       <ele>
  465         <name>name</name>
  466         <pattern>name</pattern>
  467         <summary>Name of the keyword as used in the filter</summary>
  468       </ele>
  469       <ele>
  470         <name>type</name>
  471         <pattern><t>type_name</t></pattern>
  472         <summary>Type of the values the keyword can use</summary>
  473       </ele>
  474       <ele>
  475         <name>summary</name>
  476         <pattern>text</pattern>
  477         <summary>Short description of the keyword</summary>
  478       </ele>
  479     </ele>
  480   </element>
  481   <element>
  482     <name>certificate_info</name>
  483     <summary>Info about a certificate</summary>
  484     <pattern>
  485       <e>time_status</e>
  486       <e>activation_time</e>
  487       <e>expiration_time</e>
  488       <e>issuer</e>
  489       <e>md5_fingerprint</e>
  490     </pattern>
  491     <ele>
  492       <name>time_status</name>
  493       <summary>
  494         Whether the certificate is valid, expired or not active yet
  495       </summary>
  496       <pattern>
  497         <t>
  498           <alts>
  499             <alt>expired</alt>
  500             <alt>inactive</alt>
  501             <alt>unknown</alt>
  502             <alt>valid</alt>
  503           </alts>
  504         </t>
  505       </pattern>
  506     </ele>
  507     <ele>
  508       <name>activation_time</name>
  509       <summary>Time before which the certificate is not valid</summary>
  510       <pattern>text</pattern>
  511     </ele>
  512     <ele>
  513       <name>expiration_time</name>
  514       <summary>Time after which the certificate is no longer valid</summary>
  515       <pattern>text</pattern>
  516     </ele>
  517     <ele>
  518       <name>issuer</name>
  519       <summary>DN of the issuer of the certificate</summary>
  520       <pattern>text</pattern>
  521     </ele>
  522     <ele>
  523       <name>md5_fingerprint</name>
  524       <summary>MD5 fingerprint of the certificate</summary>
  525       <pattern>text</pattern>
  526     </ele>
  527   </element>
  528   <element>
  529     <name>note</name>
  530     <summary>A note</summary>
  531     <pattern>
  532       <attrib>
  533         <name>id</name>
  534         <type>uuid</type>
  535         <required>1</required>
  536       </attrib>
  537       <e>permissions</e>
  538       <e>owner</e>
  539       <e>nvt</e>
  540       <e>text</e>
  541       <e>creation_time</e>
  542       <e>modification_time</e>
  543       <e>writable</e>
  544       <e>in_use</e>
  545       <e>active</e>
  546       <e>orphan</e>
  547       <e>user_tags</e>
  548       <o>
  549         <g>
  550           <e>hosts</e>
  551           <e>port</e>
  552           <e>severity</e>
  553           <e>threat</e>
  554           <e>task</e>
  555           <o><e>end_time</e></o>
  556           <o><e>result</e></o>
  557         </g>
  558       </o>
  559     </pattern>
  560     <ele>
  561       <name>permissions</name>
  562       <summary>Permissions that the current user has on the note</summary>
  563       <pattern>
  564         <any><e>permission</e></any>
  565       </pattern>
  566       <ele>
  567         <name>permission</name>
  568         <pattern>
  569           <e>name</e>
  570         </pattern>
  571         <ele>
  572           <name>name</name>
  573           <summary>The name of the permission</summary>
  574           <pattern><t>name</t></pattern>
  575         </ele>
  576       </ele>
  577     </ele>
  578     <ele>
  579       <name>owner</name>
  580       <summary>Owner of the note</summary>
  581       <pattern>
  582         <e>name</e>
  583       </pattern>
  584       <ele>
  585         <name>name</name>
  586         <summary>The name of the owner</summary>
  587         <pattern><t>name</t></pattern>
  588       </ele>
  589     </ele>
  590     <ele>
  591       <name>nvt</name>
  592       <pattern>
  593         <attrib>
  594           <name>oid</name>
  595           <type>oid</type>
  596           <required>1</required>
  597         </attrib>
  598         <e>name</e>
  599         <e>type</e>
  600       </pattern>
  601       <ele>
  602         <name>name</name>
  603         <pattern><t>name</t></pattern>
  604       </ele>
  605       <ele>
  606         <name>type</name>
  607         <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
  608         <pattern>text</pattern>
  609       </ele>
  610     </ele>
  611     <ele>
  612       <name>creation_time</name>
  613       <summary>Date and time the note was created</summary>
  614       <pattern><t>iso_time</t></pattern>
  615     </ele>
  616     <ele>
  617       <name>modification_time</name>
  618       <summary>Date and time the note was last modified</summary>
  619       <pattern><t>iso_time</t></pattern>
  620     </ele>
  621     <ele>
  622       <name>writable</name>
  623       <pattern><t>boolean</t></pattern>
  624     </ele>
  625     <ele>
  626       <name>in_use</name>
  627       <pattern><t>boolean</t></pattern>
  628     </ele>
  629     <ele>
  630       <name>active</name>
  631       <summary>Whether the note is active</summary>
  632       <pattern><t>boolean</t></pattern>
  633     </ele>
  634     <ele>
  635       <name>text</name>
  636       <summary>The text of the note</summary>
  637       <pattern>
  638         <attrib>
  639           <name>excerpt</name>
  640           <summary>Whether the content is an excerpt of the full text</summary>
  641           <type>boolean</type>
  642           <required>1</required>
  643         </attrib>
  644         text
  645       </pattern>
  646     </ele>
  647     <ele>
  648       <name>orphan</name>
  649       <summary>Whether the note is an orphan</summary>
  650       <pattern><t>boolean</t></pattern>
  651     </ele>
  652     <ele>
  653       <name>user_tags</name>
  654       <summary>Info on tags attached to the note</summary>
  655       <pattern>
  656         <e>count</e>
  657         <any><e>tag</e></any>
  658       </pattern>
  659       <ele>
  660         <name>count</name>
  661         <summary>Number of attached tags</summary>
  662         <pattern><t>integer</t></pattern>
  663       </ele>
  664       <ele>
  665         <name>tag</name>
  666         <summary>
  667           Short info on an individual tag
  668           (only if details were requested)
  669         </summary>
  670         <pattern>
  671           <attrib>
  672             <name>id</name>
  673             <type>uuid</type>
  674             <summary>UUID of the tag</summary>
  675             <required>1</required>
  676           </attrib>
  677           <e>name</e>
  678           <e>value</e>
  679           <e>comment</e>
  680         </pattern>
  681         <ele>
  682           <name>name</name>
  683           <summary>Name of the tag (usually namespace:predicate)</summary>
  684           <pattern>text</pattern>
  685         </ele>
  686         <ele>
  687           <name>value</name>
  688           <summary>Value of the tag</summary>
  689           <pattern>text</pattern>
  690         </ele>
  691         <ele>
  692           <name>comment</name>
  693           <summary>Comment for the tag</summary>
  694           <pattern>text</pattern>
  695         </ele>
  696       </ele>
  697     </ele>
  698     <ele>
  699       <name>hosts</name>
  700       <summary>A textual list of hosts</summary>
  701       <pattern>
  702         text
  703       </pattern>
  704     </ele>
  705     <ele>
  706       <name>port</name>
  707       <summary>Port to which note applies</summary>
  708       <pattern>
  709         text
  710       </pattern>
  711     </ele>
  712     <ele>
  713       <name>severity</name>
  714       <summary>Severity to which note applies</summary>
  715       <pattern>
  716         <t>severity</t>
  717       </pattern>
  718     </ele>
  719     <ele>
  720       <name>threat</name>
  721       <summary>Threat level to which note applies</summary>
  722       <pattern>
  723         <t>threat</t>
  724       </pattern>
  725     </ele>
  726     <ele>
  727       <name>task</name>
  728       <summary>Task to which note applies</summary>
  729       <pattern>
  730         <attrib>
  731           <name>id</name>
  732           <type>uuid</type>
  733           <required>1</required>
  734         </attrib>
  735       </pattern>
  736     </ele>
  737     <ele>
  738       <name>active</name>
  739       <summary>Whether the note is active</summary>
  740       <pattern><t>integer</t></pattern>
  741     </ele>
  742     <ele>
  743       <name>end_time</name>
  744       <summary>End time of the note in case of limit, else empty</summary>
  745       <pattern>text</pattern>
  746     </ele>
  747     <ele>
  748       <name>result</name>
  749       <summary>Result to which note applies</summary>
  750       <pattern>
  751         <attrib>
  752           <name>id</name>
  753           <type>uuid</type>
  754           <required>1</required>
  755         </attrib>
  756         <e>host</e>
  757         <e>port</e>
  758         <e>nvt</e>
  759         <e>severity</e>
  760         <e>threat</e>
  761         <e>qod</e>
  762         <e>description</e>
  763       </pattern>
  764       <ele>
  765         <name>host</name>
  766         <pattern>
  767           <e>asset</e>
  768           text
  769         </pattern>
  770         <ele>
  771           <name>asset</name>
  772           <summary>Asset linked to host</summary>
  773           <pattern>
  774             <attrib>
  775               <name>asset_id</name>
  776               <type>uuid</type>
  777               <required>1</required>
  778             </attrib>
  779           </pattern>
  780         </ele>
  781       </ele>
  782       <ele>
  783         <name>port</name>
  784         <pattern>text</pattern>
  785       </ele>
  786       <ele>
  787         <name>nvt</name>
  788         <pattern>
  789           <attrib>
  790             <name>oid</name>
  791             <type>oid</type>
  792             <required>1</required>
  793           </attrib>
  794           <e>name</e>
  795           <e>type</e>
  796           <e>cvss_base</e>
  797           <o><e>cve</e></o>
  798           <o><e>bid</e></o>
  799         </pattern>
  800         <ele>
  801           <name>name</name>
  802           <pattern><t>name</t></pattern>
  803         </ele>
  804         <ele>
  805           <name>type</name>
  806           <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
  807           <pattern>text</pattern>
  808         </ele>
  809         <ele>
  810           <name>cvss_base</name>
  811           <pattern>text</pattern>
  812         </ele>
  813         <ele>
  814           <name>cve</name>
  815           <summary>CVE value associated with the NVT</summary>
  816           <pattern>text</pattern>
  817         </ele>
  818         <ele>
  819           <name>bid</name>
  820           <summary>BID associated with the NVT</summary>
  821           <pattern><t>integer</t></pattern>
  822         </ele>
  823       </ele>
  824       <ele>
  825         <name>severity</name>
  826         <pattern>
  827           <t>severity</t>
  828         </pattern>
  829       </ele>
  830       <ele>
  831         <name>threat</name>
  832         <pattern>
  833           <t>threat</t>
  834         </pattern>
  835       </ele>
  836       <ele>
  837         <name>qod</name>
  838         <summary>The quality of detection (QoD) of the result</summary>
  839         <pattern>
  840           <e>value</e>
  841           <e>type</e>
  842         </pattern>
  843         <ele>
  844           <name>value</name>
  845           <summary>The numeric QoD value</summary>
  846           <pattern><t>integer</t></pattern>
  847         </ele>
  848         <ele>
  849           <name>type</name>
  850           <summary>The QoD type</summary>
  851           <pattern>text</pattern>
  852         </ele>
  853       </ele>
  854       <ele>
  855         <name>description</name>
  856         <pattern>text</pattern>
  857       </ele>
  858     </ele>
  859   </element>
  860   <element>
  861     <name>override</name>
  862     <summary>An override</summary>
  863     <pattern>
  864       <attrib>
  865         <name>id</name>
  866         <type>uuid</type>
  867         <required>1</required>
  868       </attrib>
  869       <e>permissions</e>
  870       <e>owner</e>
  871       <e>nvt</e>
  872       <e>creation_time</e>
  873       <e>modification_time</e>
  874       <e>writable</e>
  875       <e>in_use</e>
  876       <e>active</e>
  877       <e>text</e>
  878       <e>threat</e>
  879       <e>severity</e>
  880       <e>new_threat</e>
  881       <e>new_severity</e>
  882       <e>orphan</e>
  883       <e>permissions</e>
  884       <e>user_tags</e>
  885       <o>
  886         <g>
  887           <e>hosts</e>
  888           <e>port</e>
  889           <e>task</e>
  890           <o><e>end_time</e></o>
  891           <o><e>result</e></o>
  892         </g>
  893       </o>
  894     </pattern>
  895     <ele>
  896       <name>permissions</name>
  897       <summary>Permissions that the current user has on the note</summary>
  898       <pattern>
  899         <any><e>permission</e></any>
  900       </pattern>
  901       <ele>
  902         <name>permission</name>
  903         <pattern>
  904           <e>name</e>
  905         </pattern>
  906         <ele>
  907           <name>name</name>
  908           <summary>The name of the permission</summary>
  909           <pattern><t>name</t></pattern>
  910         </ele>
  911       </ele>
  912     </ele>
  913     <ele>
  914       <name>owner</name>
  915       <summary>Owner of the override</summary>
  916       <pattern>
  917         <e>name</e>
  918       </pattern>
  919       <ele>
  920         <name>name</name>
  921         <pattern><t>name</t></pattern>
  922       </ele>
  923     </ele>
  924     <ele>
  925       <name>nvt</name>
  926       <pattern>
  927         <attrib>
  928           <name>oid</name>
  929           <type>oid</type>
  930           <required>1</required>
  931         </attrib>
  932         <e>name</e>
  933         <e>type</e>
  934       </pattern>
  935       <ele>
  936         <name>name</name>
  937         <pattern><t>name</t></pattern>
  938       </ele>
  939       <ele>
  940         <name>type</name>
  941         <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
  942         <pattern>text</pattern>
  943       </ele>
  944     </ele>
  945     <ele>
  946       <name>creation_time</name>
  947       <summary>Date and time the override was created</summary>
  948       <pattern><t>iso_time</t></pattern>
  949     </ele>
  950     <ele>
  951       <name>modification_time</name>
  952       <summary>Date and time the override was last modified</summary>
  953       <pattern><t>iso_time</t></pattern>
  954     </ele>
  955     <ele>
  956       <name>writable</name>
  957       <pattern><t>boolean</t></pattern>
  958     </ele>
  959     <ele>
  960       <name>in_use</name>
  961       <pattern><t>boolean</t></pattern>
  962     </ele>
  963     <ele>
  964       <name>active</name>
  965       <summary>Whether the override is currently active</summary>
  966       <pattern><t>boolean</t></pattern>
  967     </ele>
  968     <ele>
  969       <name>text</name>
  970       <summary>The text of the override</summary>
  971       <pattern>
  972         <attrib>
  973           <name>excerpt</name>
  974           <summary>Whether the contents is an excerpt of the full text</summary>
  975           <type>boolean</type>
  976           <required>1</required>
  977         </attrib>
  978         text
  979       </pattern>
  980     </ele>
  981     <ele>
  982       <name>threat</name>
  983       <summary>
  984         Threat level to which override applies, derived from severity
  985       </summary>
  986       <pattern>
  987         <t>threat</t>
  988       </pattern>
  989     </ele>
  990     <ele>
  991       <name>severity</name>
  992       <summary>Severity score to which override applies</summary>
  993       <pattern>
  994         <t>severity</t>
  995       </pattern>
  996     </ele>
  997     <ele>
  998       <name>new_threat</name>
  999       <summary>New threat for result</summary>
 1000       <pattern>
 1001         <t>threat</t>
 1002       </pattern>
 1003     </ele>
 1004     <ele>
 1005       <name>new_severity</name>
 1006       <summary>New severity score for result</summary>
 1007       <pattern>
 1008         <t>severity</t>
 1009       </pattern>
 1010     </ele>
 1011     <ele>
 1012       <name>orphan</name>
 1013       <summary>Whether the override is an orphan</summary>
 1014       <pattern><t>boolean</t></pattern>
 1015     </ele>
 1016     <ele>
 1017       <name>user_tags</name>
 1018       <summary>Info on tags attached to the override</summary>
 1019       <pattern>
 1020         <e>count</e>
 1021         <any><e>tag</e></any>
 1022       </pattern>
 1023       <ele>
 1024         <name>count</name>
 1025         <summary>Number of attached tags</summary>
 1026         <pattern><t>integer</t></pattern>
 1027       </ele>
 1028       <ele>
 1029         <name>tag</name>
 1030         <summary>
 1031           Short info on an individual tag
 1032           (only if details were requested)
 1033         </summary>
 1034         <pattern>
 1035           <attrib>
 1036             <name>id</name>
 1037             <type>uuid</type>
 1038             <summary>UUID of the tag</summary>
 1039             <required>1</required>
 1040           </attrib>
 1041           <e>name</e>
 1042           <e>value</e>
 1043           <e>comment</e>
 1044         </pattern>
 1045         <ele>
 1046           <name>name</name>
 1047           <summary>Name of the tag (usually namespace:predicate)</summary>
 1048           <pattern>text</pattern>
 1049         </ele>
 1050         <ele>
 1051           <name>value</name>
 1052           <summary>Value of the tag</summary>
 1053           <pattern>text</pattern>
 1054         </ele>
 1055         <ele>
 1056           <name>comment</name>
 1057           <summary>Comment for the tag</summary>
 1058           <pattern>text</pattern>
 1059         </ele>
 1060       </ele>
 1061     </ele>
 1062     <ele>
 1063       <name>hosts</name>
 1064       <summary>A textual list of hosts</summary>
 1065       <pattern>
 1066         text
 1067       </pattern>
 1068     </ele>
 1069     <ele>
 1070       <name>port</name>
 1071       <summary>Port to which override applies</summary>
 1072       <pattern>
 1073         text
 1074       </pattern>
 1075     </ele>
 1076     <ele>
 1077       <name>task</name>
 1078       <summary>Task to which override applies</summary>
 1079       <pattern>
 1080         <attrib>
 1081           <name>id</name>
 1082           <type>uuid</type>
 1083           <required>1</required>
 1084         </attrib>
 1085       </pattern>
 1086     </ele>
 1087     <ele>
 1088       <name>active</name>
 1089       <summary>Whether the override is active</summary>
 1090       <pattern><t>integer</t></pattern>
 1091     </ele>
 1092     <ele>
 1093       <name>end_time</name>
 1094       <summary>Override end time in case of limit, else empty</summary>
 1095       <pattern>text</pattern>
 1096     </ele>
 1097     <ele>
 1098       <name>result</name>
 1099       <summary>Result to which override applies</summary>
 1100       <pattern>
 1101         <attrib>
 1102           <name>id</name>
 1103           <type>uuid</type>
 1104           <required>1</required>
 1105         </attrib>
 1106         <e>host</e>
 1107         <e>port</e>
 1108         <e>nvt</e>
 1109         <e>threat</e>
 1110         <e>severity</e>
 1111         <e>qod</e>
 1112         <e>description</e>
 1113       </pattern>
 1114       <ele>
 1115         <name>host</name>
 1116         <pattern>
 1117           <e>asset</e>
 1118           text
 1119         </pattern>
 1120         <ele>
 1121           <name>asset</name>
 1122           <summary>Asset linked to host</summary>
 1123           <pattern>
 1124             <attrib>
 1125               <name>asset_id</name>
 1126               <type>uuid</type>
 1127               <required>1</required>
 1128             </attrib>
 1129           </pattern>
 1130         </ele>
 1131       </ele>
 1132       <ele>
 1133         <name>port</name>
 1134         <pattern>text</pattern>
 1135       </ele>
 1136       <ele>
 1137         <name>nvt</name>
 1138         <pattern>
 1139           <attrib>
 1140             <name>oid</name>
 1141             <type>oid</type>
 1142             <required>1</required>
 1143           </attrib>
 1144           <e>name</e>
 1145           <e>type</e>
 1146           <e>cvss_base</e>
 1147           <o><e>cve</e></o>
 1148           <o><e>bid</e></o>
 1149         </pattern>
 1150         <ele>
 1151           <name>name</name>
 1152           <pattern><t>name</t></pattern>
 1153         </ele>
 1154         <ele>
 1155           <name>type</name>
 1156           <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
 1157           <pattern>text</pattern>
 1158         </ele>
 1159         <ele>
 1160           <name>cvss_base</name>
 1161           <pattern>text</pattern>
 1162         </ele>
 1163         <ele>
 1164           <name>cve</name>
 1165           <summary>CVE value associated with the NVT</summary>
 1166           <pattern>text</pattern>
 1167         </ele>
 1168         <ele>
 1169           <name>bid</name>
 1170           <summary>BID associated with the NVT</summary>
 1171           <pattern><t>integer</t></pattern>
 1172         </ele>
 1173       </ele>
 1174       <ele>
 1175         <name>threat</name>
 1176         <pattern>
 1177           <t>threat</t>
 1178         </pattern>
 1179       </ele>
 1180       <ele>
 1181         <name>severity</name>
 1182         <pattern>
 1183           <t>severity</t>
 1184         </pattern>
 1185       </ele>
 1186       <ele>
 1187         <name>qod</name>
 1188         <summary>The quality of detection (QoD) of the result</summary>
 1189         <pattern>
 1190           <e>value</e>
 1191           <e>type</e>
 1192         </pattern>
 1193         <ele>
 1194           <name>value</name>
 1195           <summary>The numeric QoD value</summary>
 1196           <pattern><t>integer</t></pattern>
 1197         </ele>
 1198         <ele>
 1199           <name>type</name>
 1200           <summary>The QoD type</summary>
 1201           <pattern>text</pattern>
 1202         </ele>
 1203       </ele>
 1204       <ele>
 1205         <name>description</name>
 1206         <pattern>text</pattern>
 1207       </ele>
 1208     </ele>
 1209   </element>
 1210   <element>
 1211     <name>result</name>
 1212     <summary>A result</summary>
 1213     <pattern>
 1214       <attrib>
 1215         <name>id</name>
 1216         <type>uuid</type>
 1217         <required>1</required>
 1218       </attrib>
 1219       <e>name</e>
 1220       <e>owner</e>
 1221       <e>comment</e>
 1222       <e>creation_time</e>
 1223       <e>modification_time</e>
 1224       <o><e>user_tags</e></o>
 1225       <o><e>report</e></o>
 1226       <o><e>task</e></o>
 1227       <e>host</e>
 1228       <e>port</e>
 1229       <e>nvt</e>
 1230       <e>scan_nvt_version</e>
 1231       <e>threat</e>
 1232       <e>severity</e>
 1233       <e>qod</e>
 1234       <o><e>original_threat</e></o>
 1235       <o><e>original_severity</e></o>
 1236       <e>description</e>
 1237       <o><e>delta</e></o>
 1238       <e>details</e>
 1239       <e>detection</e>
 1240       <o><e>notes</e></o>
 1241       <o><e>overrides</e></o>
 1242     </pattern>
 1243     <ele>
 1244       <name>name</name>
 1245       <summary>The name of the result</summary>
 1246       <pattern>text</pattern>
 1247     </ele>
 1248     <ele>
 1249       <name>owner</name>
 1250       <summary>Owner of the result</summary>
 1251       <pattern>
 1252         <e>name</e>
 1253       </pattern>
 1254       <ele>
 1255         <name>name</name>
 1256         <summary>The name of the owner</summary>
 1257         <pattern><t>name</t></pattern>
 1258       </ele>
 1259     </ele>
 1260     <ele>
 1261       <name>comment</name>
 1262       <summary>The comment on the result</summary>
 1263       <pattern>text</pattern>
 1264     </ele>
 1265     <ele>
 1266       <name>creation_time</name>
 1267       <summary>Date and time the result was created</summary>
 1268       <pattern><t>iso_time</t></pattern>
 1269     </ele>
 1270     <ele>
 1271       <name>modification_time</name>
 1272       <summary>Date and time the result was last modified</summary>
 1273       <pattern><t>iso_time</t></pattern>
 1274     </ele>
 1275     <ele>
 1276       <name>user_tags</name>
 1277       <summary>Info on tags attached to the result (not in delta results)</summary>
 1278       <pattern>
 1279         <e>count</e>
 1280         <any><e>tag</e></any>
 1281       </pattern>
 1282       <ele>
 1283         <name>count</name>
 1284         <summary>Number of attached tags</summary>
 1285         <pattern><t>integer</t></pattern>
 1286       </ele>
 1287       <ele>
 1288         <name>tag</name>
 1289         <summary>
 1290           Short info on an individual tag
 1291           (only if details were requested)
 1292         </summary>
 1293         <pattern>
 1294           <attrib>
 1295             <name>id</name>
 1296             <type>uuid</type>
 1297             <summary>UUID of the tag</summary>
 1298             <required>1</required>
 1299           </attrib>
 1300           <e>name</e>
 1301           <e>value</e>
 1302           <e>comment</e>
 1303         </pattern>
 1304         <ele>
 1305           <name>name</name>
 1306           <summary>Name of the tag (usually namespace:predicate)</summary>
 1307           <pattern>text</pattern>
 1308         </ele>
 1309         <ele>
 1310           <name>value</name>
 1311           <summary>Value of the tag</summary>
 1312           <pattern>text</pattern>
 1313         </ele>
 1314         <ele>
 1315           <name>comment</name>
 1316           <summary>Comment for the tag</summary>
 1317           <pattern>text</pattern>
 1318         </ele>
 1319       </ele>
 1320     </ele>
 1321     <ele>
 1322       <name>report</name>
 1323       <summary>
 1324         Report the result belongs to (only when details were requested)
 1325       </summary>
 1326       <pattern>
 1327         <attrib>
 1328           <name>id</name>
 1329           <type>uuid</type>
 1330           <summary>UUID of the report the result belongs to</summary>
 1331           <required>1</required>
 1332         </attrib>
 1333       </pattern>
 1334     </ele>
 1335     <ele>
 1336       <name>task</name>
 1337       <summary>
 1338         Task the result applies to (only when details were requested)
 1339       </summary>
 1340       <pattern>
 1341         <attrib>
 1342           <name>id</name>
 1343           <type>uuid</type>
 1344           <summary>UUID of the task the result applies to</summary>
 1345           <required>1</required>
 1346         </attrib>
 1347         <e>name</e>
 1348       </pattern>
 1349       <ele>
 1350         <name>name</name>
 1351         <pattern>text</pattern>
 1352         <summary>Name of the task the result applies to</summary>
 1353       </ele>
 1354     </ele>
 1355     <ele>
 1356       <name>host</name>
 1357       <summary>The host the result applies to</summary>
 1358       <pattern>
 1359         <e>asset</e>
 1360         text
 1361       </pattern>
 1362       <ele>
 1363         <name>asset</name>
 1364         <summary>Asset linked to host</summary>
 1365         <pattern>
 1366           <attrib>
 1367             <name>asset_id</name>
 1368             <type>uuid</type>
 1369             <required>1</required>
 1370           </attrib>
 1371         </pattern>
 1372       </ele>
 1373     </ele>
 1374     <ele>
 1375       <name>port</name>
 1376       <summary>The port on the host</summary>
 1377       <pattern>text</pattern>
 1378     </ele>
 1379     <ele>
 1380       <name>nvt</name>
 1381       <summary>NVT to which result applies</summary>
 1382       <pattern>
 1383         <attrib>
 1384           <name>oid</name>
 1385           <type>oid</type>
 1386           <required>1</required>
 1387         </attrib>
 1388         <e>name</e>
 1389         <e>type</e>
 1390         <e>family</e>
 1391         <e>cvss_base</e>
 1392         <e>cve</e>
 1393         <e>cpe</e>
 1394         <e>bid</e>
 1395         <e>tags</e>
 1396         <e>cert</e>
 1397         <e>xref</e>
 1398       </pattern>
 1399       <ele>
 1400         <name>name</name>
 1401         <summary>The name of the NVT</summary>
 1402         <pattern><t>name</t></pattern>
 1403       </ele>
 1404       <ele>
 1405         <name>type</name>
 1406         <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
 1407         <pattern>text</pattern>
 1408       </ele>
 1409       <ele>
 1410         <name>family</name>
 1411         <summary>The family the NVT is in</summary>
 1412         <pattern><t>name</t></pattern>
 1413       </ele>
 1414       <ele>
 1415         <name>cvss_base</name>
 1416         <summary>CVSS base value associated with the NVT</summary>
 1417         <pattern><t>integer</t></pattern>
 1418       </ele>
 1419       <ele>
 1420         <name>cve</name>
 1421         <summary>CVE associated with the NVT</summary>
 1422         <pattern>text</pattern>
 1423       </ele>
 1424       <ele>
 1425         <name>cpe</name>
 1426         <summary>The CPE which produced the CVE (for "cve" results)</summary>
 1427         <pattern>text</pattern>
 1428       </ele>
 1429       <ele>
 1430         <name>bid</name>
 1431         <summary>BID associated with the NVT</summary>
 1432         <pattern>text</pattern>
 1433       </ele>
 1434       <ele>
 1435         <name>tags</name>
 1436         <summary>Tags associated with the NVT</summary>
 1437         <pattern>text</pattern>
 1438       </ele>
 1439       <ele>
 1440         <name>cert</name>
 1441         <summary>List of CERT advisories referencing this NVT via CVEs</summary>
 1442         <pattern>
 1443           <any><e>cert_ref</e></any>
 1444         </pattern>
 1445         <ele>
 1446           <name>cert_ref</name>
 1447           <summary>A CERT advisory reference</summary>
 1448           <pattern>
 1449             <attrib>
 1450               <name>id</name>
 1451               <summary>ID of the advisory</summary>
 1452               <type>text</type>
 1453             </attrib>
 1454             <attrib>
 1455               <name>type</name>
 1456               <summary>Type of the advisory (e.g. "DFN-CERT", "CERT-BUND")</summary>
 1457               <type>text</type>
 1458             </attrib>
 1459           </pattern>
 1460         </ele>
 1461       </ele>
 1462       <ele>
 1463         <name>xref</name>
 1464         <summary>XREFs associated with the NVT</summary>
 1465         <pattern>text</pattern>
 1466       </ele>
 1467     </ele>
 1468     <ele>
 1469       <name>scan_nvt_version</name>
 1470       <summary>Version of the NVT used in the scan</summary>
 1471       <pattern>text</pattern>
 1472     </ele>
 1473     <ele>
 1474       <name>threat</name>
 1475       <pattern><t>threat</t></pattern>
 1476     </ele>
 1477     <ele>
 1478       <name>severity</name>
 1479       <pattern><t>severity</t></pattern>
 1480     </ele>
 1481     <ele>
 1482       <name>qod</name>
 1483       <summary>The quality of detection (QoD) of the result</summary>
 1484       <pattern>
 1485         <e>value</e>
 1486         <e>type</e>
 1487       </pattern>
 1488       <ele>
 1489         <name>value</name>
 1490         <summary>The numeric QoD value</summary>
 1491         <pattern><t>integer</t></pattern>
 1492       </ele>
 1493       <ele>
 1494         <name>type</name>
 1495         <summary>The QoD type</summary>
 1496         <pattern>text</pattern>
 1497       </ele>
 1498     </ele>
 1499     <ele>
 1500       <name>original_threat</name>
 1501       <summary>Original threat when overridden</summary>
 1502       <pattern><t>threat</t></pattern>
 1503     </ele>
 1504     <ele>
 1505       <name>original_severity</name>
 1506       <summary>Original severity when overridden</summary>
 1507       <pattern><t>severity</t></pattern>
 1508     </ele>
 1509     <ele>
 1510       <name>description</name>
 1511       <summary>Description of the result</summary>
 1512       <pattern>text</pattern>
 1513     </ele>
 1514     <ele>
 1515       <name>delta</name>
 1516       <summary>Delta state</summary>
 1517       <pattern>
 1518         <o><e>result</e></o>
 1519         <o><e>diff</e></o>
 1520         <o><e>notes</e></o>
 1521         <o><e>overrides</e></o>
 1522         text
 1523       </pattern>
 1524       <ele>
 1525         <name>result</name>
 1526         <summary>Delta result</summary>
 1527         <type>result</type>
 1528       </ele>
 1529       <ele>
 1530         <name>diff</name>
 1531         <summary>Comparison between descriptions</summary>
 1532         <type>text</type>
 1533       </ele>
 1534       <ele>
 1535         <name>notes</name>
 1536         <summary>List of notes on the result</summary>
 1537         <pattern>
 1538           <any><e>note</e></any>
 1539         </pattern>
 1540         <ele>
 1541           <name>note</name>
 1542           <type>note</type>
 1543         </ele>
 1544       </ele>
 1545       <ele>
 1546         <name>overrides</name>
 1547         <name>overrides</name>
 1548         <summary>List of overrides on the result</summary>
 1549         <pattern>
 1550           <any><e>override</e></any>
 1551         </pattern>
 1552         <ele>
 1553           <name>override</name>
 1554           <type>override</type>
 1555         </ele>
 1556       </ele>
 1557     </ele>
 1558     <ele>
 1559       <name>details</name>
 1560       <summary>Any details associated with the result</summary>
 1561       <pattern>
 1562         <any><e>detail</e></any>
 1563       </pattern>
 1564       <ele>
 1565         <name>detail</name>
 1566         <summary>A detail associated with the result</summary>
 1567         <pattern>
 1568           <e>name</e>
 1569           <e>value</e>
 1570         </pattern>
 1571         <ele>
 1572           <name>name</name>
 1573           <summary>The name of the detail</summary>
 1574           <pattern>text</pattern>
 1575         </ele>
 1576         <ele>
 1577           <name>value</name>
 1578           <summary>The value of the detail</summary>
 1579           <pattern>text</pattern>
 1580         </ele>
 1581       </ele>
 1582     </ele>
 1583     <ele>
 1584       <name>detection</name>
 1585       <summary>Detection details</summary>
 1586       <pattern><e>result</e></pattern>
 1587       <ele>
 1588         <name>result</name>
 1589         <summary>Detection result</summary>
 1590         <pattern>
 1591           <attrib>
 1592             <name>id</name>
 1593             <summary>UUID of the detection result</summary>
 1594             <required>1</required>
 1595             <type>uuid</type>
 1596           </attrib>
 1597           <e>details</e>
 1598         </pattern>
 1599         <ele>
 1600           <name>details</name>
 1601           <pattern>
 1602             <any><e>detail</e></any>
 1603           </pattern>
 1604           <ele>
 1605             <name>detail</name>
 1606             <summary>A detail associated with the detection result</summary>
 1607             <pattern>
 1608               <e>name</e>
 1609               <e>value</e>
 1610             </pattern>
 1611             <ele>
 1612               <name>name</name>
 1613               <summary>The name of the detail</summary>
 1614               <pattern>text</pattern>
 1615             </ele>
 1616             <ele>
 1617               <name>value</name>
 1618               <summary>The value of the detail</summary>
 1619               <pattern>text</pattern>
 1620             </ele>
 1621           </ele>
 1622         </ele>
 1623       </ele>
 1624     </ele>
 1625     <ele>
 1626       <name>notes</name>
 1627       <summary>List of notes on the result</summary>
 1628       <pattern>
 1629         <any><e>note</e></any>
 1630       </pattern>
 1631       <ele>
 1632         <name>note</name>
 1633         <type>note</type>
 1634       </ele>
 1635     </ele>
 1636     <ele>
 1637       <name>overrides</name>
 1638       <name>overrides</name>
 1639       <summary>List of overrides on the result</summary>
 1640       <pattern>
 1641         <any><e>override</e></any>
 1642       </pattern>
 1643       <ele>
 1644         <name>override</name>
 1645         <type>override</type>
 1646       </ele>
 1647     </ele>
 1648   </element>
 1649   <element>
 1650     <name>report</name>
 1651     <summary>Actually attributes and either base64 or a report</summary>
 1652     <pattern>
 1653       <attrib>
 1654         <name>id</name>
 1655         <type>uuid</type>
 1656         <required>1</required>
 1657       </attrib>
 1658       <attrib>
 1659         <name>format_id</name>
 1660         <type>uuid</type>
 1661         <required>1</required>
 1662       </attrib>
 1663       <attrib>
 1664         <name>extension</name>
 1665         <type>text</type>
 1666         <required>1</required>
 1667       </attrib>
 1668       <attrib>
 1669         <name>content_type</name>
 1670         <type>text</type>
 1671         <required>1</required>
 1672       </attrib>
 1673       <attrib>
 1674         <name>type</name>
 1675         <type>
 1676           <alts>
 1677             <alt>scan</alt>
 1678             <alt>assets</alt>
 1679             <alt>prognostic</alt>
 1680           </alts>
 1681         </type>
 1682       </attrib>
 1683       <t>base64</t>
 1684       <e>owner</e>
 1685       <e>name</e>
 1686       <e>comment</e>
 1687       <e>creation_time</e>
 1688       <e>modification_time</e>
 1689       <e>writable</e>
 1690       <e>in_use</e>
 1691       <e>task</e>
 1692       <e>report_format</e>
 1693       <e>report</e>
 1694     </pattern>
 1695     <ele>
 1696       <name>owner</name>
 1697       <summary>Owner of the report</summary>
 1698       <pattern>
 1699         <e>name</e>
 1700       </pattern>
 1701       <ele>
 1702         <name>name</name>
 1703         <summary>The name of the owner</summary>
 1704         <pattern><t>name</t></pattern>
 1705       </ele>
 1706     </ele>
 1707     <ele>
 1708       <name>name</name>
 1709       <summary>Creation time as compatibility placeholder</summary>
 1710       <pattern></pattern>
 1711     </ele>
 1712     <ele>
 1713       <name>comment</name>
 1714       <summary>The comment on the report</summary>
 1715       <pattern>text</pattern>
 1716     </ele>
 1717     <ele>
 1718       <name>creation_time</name>
 1719       <summary>Date and time the report was created</summary>
 1720       <pattern><t>iso_time</t></pattern>
 1721     </ele>
 1722     <ele>
 1723       <name>modification_time</name>
 1724       <summary>Date and time the report was last modified</summary>
 1725       <pattern><t>iso_time</t></pattern>
 1726     </ele>
 1727     <ele>
 1728       <name>in_use</name>
 1729       <summary>Whether the report is in use</summary>
 1730       <pattern><t>boolean</t></pattern>
 1731     </ele>
 1732     <ele>
 1733       <name>writable</name>
 1734       <summary>Whether the report is writable</summary>
 1735       <pattern><t>boolean</t></pattern>
 1736     </ele>
 1737     <ele>
 1738       <name>task</name>
 1739       <summary>The task the report belongs to</summary>
 1740       <pattern>
 1741         <attrib>
 1742           <name>id</name>
 1743           <type>uuid</type>
 1744           <required>1</required>
 1745         </attrib>
 1746         <e>name</e>
 1747       </pattern>
 1748       <ele>
 1749         <name>name</name>
 1750         <summary>The name of the task</summary>
 1751         <pattern><t>name</t></pattern>
 1752       </ele>
 1753     </ele>
 1754     <ele>
 1755       <name>report_format</name>
 1756       <summary>The report format used</summary>
 1757       <pattern>
 1758         <attrib>
 1759           <name>id</name>
 1760           <type>uuid</type>
 1761           <required>1</required>
 1762         </attrib>
 1763         <e>name</e>
 1764       </pattern>
 1765       <ele>
 1766         <name>name</name>
 1767         <summary>The name of the report format</summary>
 1768         <pattern><t>name</t></pattern>
 1769       </ele>
 1770     </ele>
 1771     <ele>
 1772       <name>report</name>
 1773       <pattern>
 1774         <attrib>
 1775           <name>id</name>
 1776           <type>uuid</type>
 1777           <required>1</required>
 1778         </attrib>
 1779         <attrib>
 1780           <name>type</name>
 1781           <type>
 1782             <alts>
 1783               <alt>scan</alt>
 1784               <alt>assets</alt>
 1785               <alt>prognostic</alt>
 1786             </alts>
 1787           </type>
 1788         </attrib>
 1789         <e>omp</e>
 1790         <e>report_format</e>
 1791         <e>sort</e>
 1792         <e>filters</e>
 1793         <e>severity_class</e>
 1794         <o><e>delta</e></o>
 1795         <o>
 1796           <g>
 1797             <e>timezone</e>
 1798             <e>timezone_abbrev</e>
 1799             <e>permissions</e>
 1800             <e>user_tags</e>
 1801             <e>scan_run_status</e>
 1802             <e>result_count</e>
 1803             <e>severity</e>
 1804             <o><e>host_count</e></o>
 1805             <e>task</e>
 1806             <e>scan</e>
 1807             <e>ports</e>
 1808             <e>results</e>
 1809             <e>hosts</e>
 1810             <e>closed_cves</e>
 1811             <e>vulns</e>
 1812             <e>os</e>
 1813             <e>apps</e>
 1814             <e>ssl_certs</e>
 1815             <any><e>host</e></any>
 1816             <e>timestamp</e>
 1817             <e>scan_start</e>
 1818             <any><e>host_start</e></any>
 1819             <any><e>host_end</e></any>
 1820             <e>scan_end</e>
 1821             <e>errors</e>
 1822           </g>
 1823         </o>
 1824       </pattern>
 1825       <ele>
 1826         <name>omp</name>
 1827         <summary>Information of the OMP server</summary>
 1828         <pattern>
 1829           <e>version</e>
 1830         </pattern>
 1831         <ele>
 1832           <name>version</name>
 1833           <summary>The OMP version</summary>
 1834           <pattern>
 1835             text
 1836           </pattern>
 1837         </ele>
 1838       </ele>
 1839       <ele>
 1840         <name>report_format</name>
 1841         <pattern>
 1842           <e>param</e>
 1843         </pattern>
 1844         <ele>
 1845           <name>param</name>
 1846           <summary>Report format parameter</summary>
 1847           <pattern>
 1848             <e>name</e>
 1849             <e>value</e>
 1850           </pattern>
 1851           <ele>
 1852             <name>name</name>
 1853             <summary>Parameter name</summary>
 1854             <pattern>
 1855               text
 1856             </pattern>
 1857           </ele>
 1858           <ele>
 1859             <name>value</name>
 1860             <summary>Parameter value</summary>
 1861             <pattern>
 1862               text
 1863             </pattern>
 1864           </ele>
 1865         </ele>
 1866       </ele>
 1867       <ele>
 1868         <name>delta</name>
 1869         <pattern>
 1870           <e>report</e>
 1871         </pattern>
 1872         <ele>
 1873           <name>report</name>
 1874           <summary>Second report, for delta reports</summary>
 1875           <pattern>
 1876             <attrib>
 1877               <name>id</name>
 1878               <type>uuid</type>
 1879               <required>1</required>
 1880             </attrib>
 1881             <e>scan_run_status</e>
 1882             <e>timestamp</e>
 1883             <e>scan_start</e>
 1884             <e>scan_end</e>
 1885           </pattern>
 1886           <ele>
 1887             <name>scan_run_status</name>
 1888             <summary>Run status of task scan at time of report</summary>
 1889             <pattern><t>task_status</t></pattern>
 1890           </ele>
 1891           <ele>
 1892             <name>timestamp</name>
 1893             <summary>The time the scan was requested</summary>
 1894             <pattern><t>iso_time</t></pattern>
 1895           </ele>
 1896           <ele>
 1897             <name>scan_start</name>
 1898             <summary>Start time of scan</summary>
 1899             <pattern><t>iso_time</t></pattern>
 1900           </ele>
 1901           <ele>
 1902             <name>scan_end</name>
 1903             <summary>End time of scan</summary>
 1904             <pattern><t>iso_time</t></pattern>
 1905           </ele>
 1906         </ele>
 1907       </ele>
 1908       <ele>
 1909         <name>sort</name>
 1910         <summary>Result sorting information</summary>
 1911         <pattern>
 1912           <e>field</e>
 1913         </pattern>
 1914         <ele>
 1915           <name>field</name>
 1916           <summary>Sort field</summary>
 1917           <pattern>
 1918             text
 1919             <e>order</e>
 1920           </pattern>
 1921           <ele>
 1922             <name>order</name>
 1923             <summary>Sort order of field</summary>
 1924             <pattern>
 1925               <t>
 1926                 <alts>
 1927                   <alt>ascending</alt>
 1928                   <alt>descending</alt>
 1929                 </alts>
 1930               </t>
 1931             </pattern>
 1932           </ele>
 1933         </ele>
 1934       </ele>
 1935       <ele>
 1936         <name>filters</name>
 1937         <summary>Result filtering information</summary>
 1938         <pattern>
 1939           <attrib>
 1940             <name>id</name>
 1941             <summary>Filter used if any, else 0</summary>
 1942             <type>uuid</type>
 1943           </attrib>
 1944           <t>levels</t>
 1945           <e>term</e>
 1946           <e>phrase</e>
 1947           <e>notes</e>
 1948           <e>overrides</e>
 1949           <e>apply_overrides</e>
 1950           <e>result_hosts_only</e>
 1951           <e>min_qod</e>
 1952           <e>autofp</e>
 1953           <any><e>filter</e></any>
 1954           <o><e>host</e></o>
 1955           <o><e>delta</e></o>
 1956         </pattern>
 1957         <ele>
 1958           <name>term</name>
 1959           <summary>Filter term</summary>
 1960           <pattern>
 1961             <t>text</t>
 1962           </pattern>
 1963         </ele>
 1964         <ele>
 1965           <name>phrase</name>
 1966           <summary>Search phrase</summary>
 1967           <pattern>
 1968             <t>text</t>
 1969           </pattern>
 1970         </ele>
 1971         <ele>
 1972           <name>notes</name>
 1973           <summary>Whether notes are included</summary>
 1974           <pattern>
 1975             <t><alts><alt>0</alt><alt>1</alt></alts></t>
 1976           </pattern>
 1977         </ele>
 1978         <ele>
 1979           <name>overrides</name>
 1980           <summary>Whether overrides are included</summary>
 1981           <pattern>
 1982             <t><alts><alt>0</alt><alt>1</alt></alts></t>
 1983           </pattern>
 1984         </ele>
 1985         <ele>
 1986           <name>apply_overrides</name>
 1987           <summary>Whether overrides are applied</summary>
 1988           <pattern>
 1989             <t><alts><alt>0</alt><alt>1</alt></alts></t>
 1990           </pattern>
 1991         </ele>
 1992         <ele>
 1993           <name>result_hosts_only</name>
 1994           <summary>
 1995             Whether only those hosts that have results are included
 1996           </summary>
 1997           <pattern>
 1998             <t><alts><alt>0</alt><alt>1</alt></alts></t>
 1999           </pattern>
 2000         </ele>
 2001         <ele>
 2002           <name>min_qod</name>
 2003           <summary>Minimum QoD if in effect, else empty string</summary>
 2004           <pattern>
 2005             text
 2006           </pattern>
 2007         </ele>
 2008         <ele>
 2009           <name>autofp</name>
 2010           <summary>
 2011             Whether to trust vendor security updates.  1 full match, 2 partial
 2012           </summary>
 2013           <pattern>xsd:token { pattern = "0|1|2" }</pattern>
 2014         </ele>
 2015         <ele>
 2016           <name>filter</name>
 2017           <summary>Level filter</summary>
 2018           <pattern>
 2019             <t>
 2020               <alts>
 2021                 <alt>High</alt>
 2022                 <alt>Medium</alt>
 2023                 <alt>Low</alt>
 2024                 <alt>Log</alt>
 2025                 <alt>Debug</alt>
 2026               </alts>
 2027             </t>
 2028           </pattern>
 2029         </ele>
 2030         <ele>
 2031           <name>host</name>
 2032           <pattern><e>ip</e></pattern>
 2033           <ele>
 2034             <name>ip</name>
 2035             <summary>
 2036               IP of single host in report (for "delta" and "prognostic")
 2037             </summary>
 2038             <pattern>text</pattern>
 2039           </ele>
 2040         </ele>
 2041         <ele>
 2042           <name>delta</name>
 2043           <summary>Delta states</summary>
 2044           <pattern>
 2045             text
 2046             <e>changed</e>
 2047             <e>gone</e>
 2048             <e>new</e>
 2049             <e>same</e>
 2050           </pattern>
 2051           <ele>
 2052             <name>changed</name>
 2053             <summary>Whether changed results are included</summary>
 2054             <pattern><t>boolean</t></pattern>
 2055           </ele>
 2056           <ele>
 2057             <name>gone</name>
 2058             <summary>Whether results that have vanished are included</summary>
 2059             <pattern><t>boolean</t></pattern>
 2060           </ele>
 2061           <ele>
 2062             <name>new</name>
 2063             <summary>Whether new results are included</summary>
 2064             <pattern><t>boolean</t></pattern>
 2065           </ele>
 2066           <ele>
 2067             <name>same</name>
 2068             <summary>Whether results that are equal are included</summary>
 2069             <pattern><t>boolean</t></pattern>
 2070           </ele>
 2071         </ele>
 2072       </ele>
 2073       <ele>
 2074         <name>timezone</name>
 2075         <summary>Name of timezone used for dates</summary>
 2076         <pattern>
 2077           timezone
 2078         </pattern>
 2079       </ele>
 2080       <ele>
 2081         <name>timezone_abbrev</name>
 2082         <summary>Abbreviation used for timezone</summary>
 2083         <pattern>
 2084           text
 2085         </pattern>
 2086       </ele>
 2087       <ele>
 2088         <name>permissions</name>
 2089         <summary>Permissions that the current user has on the report</summary>
 2090         <pattern>
 2091           <any><e>permission</e></any>
 2092         </pattern>
 2093         <ele>
 2094           <name>permission</name>
 2095           <pattern>
 2096             <e>name</e>
 2097           </pattern>
 2098           <ele>
 2099             <name>name</name>
 2100             <summary>The name of the permission</summary>
 2101             <pattern><t>name</t></pattern>
 2102           </ele>
 2103         </ele>
 2104       </ele>
 2105       <ele>
 2106         <name>user_tags</name>
 2107         <summary>Info on tags attached to the report</summary>
 2108         <pattern>
 2109           <e>count</e>
 2110           <any><e>tag</e></any>
 2111         </pattern>
 2112         <ele>
 2113           <name>count</name>
 2114           <summary>Number of attached tags</summary>
 2115           <pattern><t>integer</t></pattern>
 2116         </ele>
 2117         <ele>
 2118           <name>tag</name>
 2119           <summary>
 2120             Short info on an individual tag
 2121             (only if details were requested)
 2122           </summary>
 2123           <pattern>
 2124             <attrib>
 2125               <name>id</name>
 2126               <type>uuid</type>
 2127               <summary>UUID of the tag</summary>
 2128               <required>1</required>
 2129             </attrib>
 2130             <e>name</e>
 2131             <e>value</e>
 2132             <e>comment</e>
 2133           </pattern>
 2134           <ele>
 2135             <name>name</name>
 2136             <summary>Name of the tag (usually namespace:predicate)</summary>
 2137             <pattern>text</pattern>
 2138           </ele>
 2139           <ele>
 2140             <name>value</name>
 2141             <summary>Value of the tag</summary>
 2142             <pattern>text</pattern>
 2143           </ele>
 2144           <ele>
 2145             <name>comment</name>
 2146             <summary>Comment for the tag</summary>
 2147             <pattern>text</pattern>
 2148           </ele>
 2149         </ele>
 2150       </ele>
 2151       <ele>
 2152         <name>scan_run_status</name>
 2153         <summary>Run status of task scan at time of report</summary>
 2154         <pattern><t>task_status</t></pattern>
 2155       </ele>
 2156       <ele>
 2157         <name>result_count</name>
 2158         <summary>Counts of results produced by scan</summary>
 2159         <description>
 2160           <p>
 2161             The text contains the full count -- the total number of results
 2162             produced by scan.
 2163           </p>
 2164         </description>
 2165         <pattern>
 2166           text
 2167           <e>full</e>
 2168           <e>filtered</e>
 2169           <e>debug</e>
 2170           <e>hole</e>
 2171           <e>info</e>
 2172           <e>log</e>
 2173           <e>warning</e>
 2174         </pattern>
 2175         <ele>
 2176           <name>full</name>
 2177           <summary>Total number of results produced by scan</summary>
 2178           <pattern><t>integer</t></pattern>
 2179         </ele>
 2180         <ele>
 2181           <name>filtered</name>
 2182           <summary>Number of results after filtering</summary>
 2183           <pattern><t>integer</t></pattern>
 2184         </ele>
 2185         <ele>
 2186           <name>debug</name>
 2187           <summary>
 2188             Number of "debug" results (threat level Debug)
 2189           </summary>
 2190           <pattern>
 2191             <e>full</e>
 2192             <e>filtered</e>
 2193           </pattern>
 2194           <ele>
 2195             <name>full</name>
 2196             <summary>Total number of results</summary>
 2197             <pattern><t>integer</t></pattern>
 2198           </ele>
 2199           <ele>
 2200             <name>filtered</name>
 2201             <summary>Number of results after filtering</summary>
 2202             <pattern><t>integer</t></pattern>
 2203           </ele>
 2204         </ele>
 2205         <ele>
 2206           <name>hole</name>
 2207           <summary>
 2208             Number of "hole" results (threat level High)
 2209           </summary>
 2210           <pattern>
 2211             <e>full</e>
 2212             <e>filtered</e>
 2213           </pattern>
 2214           <ele>
 2215             <name>full</name>
 2216             <summary>Total number of results</summary>
 2217             <pattern><t>integer</t></pattern>
 2218           </ele>
 2219           <ele>
 2220             <name>filtered</name>
 2221             <summary>Number of results after filtering</summary>
 2222             <pattern><t>integer</t></pattern>
 2223           </ele>
 2224         </ele>
 2225         <ele>
 2226           <name>info</name>
 2227           <summary>
 2228             Number of "info" results (threat level Low)
 2229           </summary>
 2230           <pattern>
 2231             <e>full</e>
 2232             <e>filtered</e>
 2233           </pattern>
 2234           <ele>
 2235             <name>full</name>
 2236             <summary>Total number of results</summary>
 2237             <pattern><t>integer</t></pattern>
 2238           </ele>
 2239           <ele>
 2240             <name>filtered</name>
 2241             <summary>Number of results after filtering</summary>
 2242             <pattern><t>integer</t></pattern>
 2243           </ele>
 2244         </ele>
 2245         <ele>
 2246           <name>log</name>
 2247           <summary>
 2248             Number of "log" results (threat level Log)
 2249           </summary>
 2250           <pattern>
 2251             <e>full</e>
 2252             <e>filtered</e>
 2253           </pattern>
 2254           <ele>
 2255             <name>full</name>
 2256             <summary>Total number of results</summary>
 2257             <pattern><t>integer</t></pattern>
 2258           </ele>
 2259           <ele>
 2260             <name>filtered</name>
 2261             <summary>Number of results after filtering</summary>
 2262             <pattern><t>integer</t></pattern>
 2263           </ele>
 2264         </ele>
 2265         <ele>
 2266           <name>warning</name>
 2267           <summary>
 2268             Number of "warning" results (threat level Medium)
 2269           </summary>
 2270           <pattern>
 2271             <e>full</e>
 2272             <e>filtered</e>
 2273           </pattern>
 2274           <ele>
 2275             <name>full</name>
 2276             <summary>Total number of results</summary>
 2277             <pattern><t>integer</t></pattern>
 2278           </ele>
 2279           <ele>
 2280             <name>filtered</name>
 2281             <summary>Number of results after filtering</summary>
 2282             <pattern><t>integer</t></pattern>
 2283           </ele>
 2284         </ele>
 2285       </ele>
 2286       <ele>
 2287         <name>severity</name>
 2288         <pattern>
 2289           <e>full</e>
 2290           <e>filtered</e>
 2291         </pattern>
 2292         <ele>
 2293           <name>full</name>
 2294           <pattern><t>severity</t></pattern>
 2295           <summary>Maximum severity of the full report</summary>
 2296         </ele>
 2297         <ele>
 2298           <name>filtered</name>
 2299           <pattern><t>severity</t></pattern>
 2300           <summary>Maximum severity of the report after filtering</summary>
 2301         </ele>
 2302       </ele>
 2303       <ele>
 2304         <name>severity_class</name>
 2305         <pattern>
 2306           <e>name</e>
 2307           <e>full_name</e>
 2308           <any><e>severity_range</e></any>
 2309         </pattern>
 2310         <ele>
 2311           <name>name</name>
 2312           <pattern>
 2313             <alts>
 2314               <alt>nist</alt>
 2315               <alt>classic</alt>
 2316               <alt>pci-dss</alt>
 2317             </alts>
 2318           </pattern>
 2319           <summary>Short severity class name</summary>
 2320         </ele>
 2321         <ele>
 2322           <name>full_name</name>
 2323           <pattern>text</pattern>
 2324           <summary>Full severity class name</summary>
 2325         </ele>
 2326         <ele>
 2327           <name>severity_range</name>
 2328           <summary>Severity range</summary>
 2329           <pattern>
 2330             <e>name</e>
 2331             <e>min</e>
 2332             <e>max</e>
 2333           </pattern>
 2334           <ele>
 2335             <name>name</name>
 2336             <summary>Name of severity range</summary>
 2337             <pattern>
 2338               <t>name</t>
 2339             </pattern>
 2340           </ele>
 2341           <ele>
 2342             <name>min</name>
 2343             <summary>Minimum CVSS value</summary>
 2344             <pattern>
 2345               <t>integer</t>
 2346             </pattern>
 2347           </ele>
 2348           <ele>
 2349             <name>max</name>
 2350             <summary>Maximum CVSS value</summary>
 2351             <pattern>
 2352               <t>integer</t>
 2353             </pattern>
 2354           </ele>
 2355         </ele>
 2356       </ele>
 2357       <ele>
 2358         <name>host_count</name>
 2359         <summary>Counts of hosts in the results</summary>
 2360         <description>
 2361           <p>
 2362             This is only present in the "assets" report.
 2363           </p>
 2364         </description>
 2365         <pattern>
 2366           <e>full</e>
 2367           <e>filtered</e>
 2368         </pattern>
 2369         <ele>
 2370           <name>full</name>
 2371           <summary>Total number of hosts</summary>
 2372           <pattern><t>integer</t></pattern>
 2373         </ele>
 2374         <ele>
 2375           <name>filtered</name>
 2376           <summary>Number of hosts after filtering</summary>
 2377           <pattern><t>integer</t></pattern>
 2378         </ele>
 2379       </ele>
 2380       <ele>
 2381         <name>task</name>
 2382         <pattern>
 2383           <attrib>
 2384             <name>id</name>
 2385             <type>uuid</type>
 2386             <required>1</required>
 2387           </attrib>
 2388           <e>name</e>
 2389           <e>comment</e>
 2390           <e>target</e>
 2391           <e>progress</e>
 2392           <e>user_tags</e>
 2393         </pattern>
 2394         <ele>
 2395           <name>name</name>
 2396           <summary>The name of the task</summary>
 2397           <pattern><t>name</t></pattern>
 2398         </ele>
 2399         <ele>
 2400           <name>comment</name>
 2401           <summary>Comment for the task</summary>
 2402           <pattern>text</pattern>
 2403         </ele>
 2404         <ele>
 2405           <name>target</name>
 2406           <summary>The target of the task</summary>
 2407           <pattern>
 2408             <attrib>
 2409               <name>id</name>
 2410               <type>uuid</type>
 2411               <summary>The UUID of the target</summary>
 2412             </attrib>
 2413             <e>trash</e>
 2414           </pattern>
 2415           <ele>
 2416             <name>trash</name>
 2417             <summary>Whether the target is in the trashcan</summary>
 2418             <type>boolean</type>
 2419           </ele>
 2420         </ele>
 2421         <ele>
 2422           <name>progress</name>
 2423           <summary>The percentage of the task that is complete</summary>
 2424           <pattern>
 2425             <t>integer</t>
 2426           </pattern>
 2427         </ele>
 2428         <ele>
 2429           <name>user_tags</name>
 2430           <summary>Info on tags attached to the task</summary>
 2431           <pattern>
 2432             <e>count</e>
 2433             <any><e>tag</e></any>
 2434           </pattern>
 2435           <ele>
 2436             <name>count</name>
 2437             <summary>Number of attached tags</summary>
 2438             <pattern><t>integer</t></pattern>
 2439           </ele>
 2440           <ele>
 2441             <name>tag</name>
 2442             <summary>
 2443               Short info on an individual tag
 2444             </summary>
 2445             <pattern>
 2446               <attrib>
 2447                 <name>id</name>
 2448                 <type>uuid</type>
 2449                 <summary>UUID of the tag</summary>
 2450                 <required>1</required>
 2451               </attrib>
 2452               <e>name</e>
 2453               <e>value</e>
 2454               <e>comment</e>
 2455             </pattern>
 2456             <ele>
 2457               <name>name</name>
 2458               <summary>Name of the tag (usually namespace:predicate)</summary>
 2459               <pattern>text</pattern>
 2460             </ele>
 2461             <ele>
 2462               <name>value</name>
 2463               <summary>Value of the tag</summary>
 2464               <pattern>text</pattern>
 2465             </ele>
 2466             <ele>
 2467               <name>comment</name>
 2468               <summary>Comment for the tag</summary>
 2469               <pattern>text</pattern>
 2470             </ele>
 2471           </ele>
 2472         </ele>
 2473       </ele>
 2474       <ele>
 2475         <name>scan</name>
 2476         <summary>Info from scan time</summary>
 2477         <pattern>
 2478           <e>task</e>
 2479         </pattern>
 2480         <ele>
 2481           <name>task</name>
 2482           <pattern>
 2483             <e>slave</e>
 2484             <e>preferences</e>
 2485           </pattern>
 2486           <ele>
 2487             <name>slave</name>
 2488             <summary>The task slave</summary>
 2489             <pattern>
 2490               <attrib>
 2491                 <name>id</name>
 2492                 <type>uuid</type>
 2493                 <required>1</required>
 2494               </attrib>
 2495               <e>name</e>
 2496               <e>host</e>
 2497               <e>port</e>
 2498             </pattern>
 2499             <ele>
 2500               <name>name</name>
 2501               <pattern><t>name</t></pattern>
 2502             </ele>
 2503             <ele>
 2504               <name>host</name>
 2505               <pattern>text</pattern>
 2506             </ele>
 2507             <ele>
 2508               <name>port</name>
 2509               <pattern>text</pattern>
 2510             </ele>
 2511           </ele>
 2512           <ele>
 2513             <name>preferences</name>
 2514             <summary>Currently only "source_iface"</summary>
 2515             <pattern>
 2516               <any><e>preference</e></any>
 2517             </pattern>
 2518             <ele>
 2519               <name>preference</name>
 2520               <pattern>
 2521                 <e>name</e>
 2522                 <e>scanner_name</e>
 2523                 <e>value</e>
 2524               </pattern>
 2525               <ele>
 2526                 <name>name</name>
 2527                 <summary>Full name of preference, suitable for end users</summary>
 2528                 <pattern>text</pattern>
 2529               </ele>
 2530               <ele>
 2531                 <name>scanner_name</name>
 2532                 <summary>Compact name of preference, from scanner</summary>
 2533                 <pattern>text</pattern>
 2534               </ele>
 2535               <ele>
 2536                 <name>value</name>
 2537                 <pattern>text</pattern>
 2538               </ele>
 2539             </ele>
 2540           </ele>
 2541         </ele>
 2542       </ele>
 2543       <ele>
 2544         <name>ports</name>
 2545         <pattern>
 2546           <attrib>
 2547             <name>start</name>
 2548             <type>integer</type>
 2549             <required>1</required>
 2550           </attrib>
 2551           <attrib>
 2552             <name>max</name>
 2553             <type>integer</type>
 2554             <required>1</required>
 2555           </attrib>
 2556           <any><e>port</e></any>
 2557         </pattern>
 2558         <ele>
 2559           <name>port</name>
 2560           <pattern>
 2561             text
 2562             <e>host</e>
 2563             <e>severity</e>
 2564             <e>threat</e>
 2565           </pattern>
 2566           <ele>
 2567             <name>host</name>
 2568             <pattern>text</pattern>
 2569           </ele>
 2570           <ele>
 2571             <name>severity</name>
 2572             <pattern><t>severity</t></pattern>
 2573           </ele>
 2574           <ele>
 2575             <name>threat</name>
 2576             <pattern><t>threat</t></pattern>
 2577           </ele>
 2578         </ele>
 2579       </ele>
 2580       <ele>
 2581         <name>results</name>
 2582         <pattern>
 2583           <attrib>
 2584             <name>start</name>
 2585             <type>integer</type>
 2586             <required>1</required>
 2587           </attrib>
 2588           <attrib>
 2589             <name>max</name>
 2590             <type>integer</type>
 2591             <required>1</required>
 2592           </attrib>
 2593           <any><e>result</e></any>
 2594         </pattern>
 2595         <ele>
 2596           <name>result</name>
 2597           <summary>A result</summary>
 2598           <type>result</type>
 2599         </ele>
 2600       </ele>
 2601       <ele>
 2602         <name>hosts</name>
 2603         <description>
 2604           <p>
 2605             Analogous to the results element, but for hosts, in the "assets"
 2606             report.  However to keep backward compatibility the host elements
 2607             are siblings of this element, instead of children.
 2608           </p>
 2609           <p>
 2610             Contains only the count outside the "assets" report.
 2611           </p>
 2612         </description>
 2613         <pattern>
 2614           <or>
 2615             <g>
 2616               <attrib>
 2617                 <name>start</name>
 2618                 <type>integer</type>
 2619                 <required>1</required>
 2620               </attrib>
 2621               <attrib>
 2622                 <name>max</name>
 2623                 <type>integer</type>
 2624                 <required>1</required>
 2625               </attrib>
 2626             </g>
 2627             <e>count</e>
 2628           </or>
 2629         </pattern>
 2630         <ele>
 2631           <name>count</name>
 2632           <summary>Number of hosts</summary>
 2633         </ele>
 2634       </ele>
 2635       <ele>
 2636         <name>closed_cves</name>
 2637         <summary></summary>
 2638         <pattern>
 2639           <e>count</e>
 2640         </pattern>
 2641         <ele>
 2642           <name>count</name>
 2643           <summary>The number of closed CVEs</summary>
 2644         </ele>
 2645       </ele>
 2646       <ele>
 2647         <name>vulns</name>
 2648         <summary></summary>
 2649         <pattern>
 2650           <e>count</e>
 2651         </pattern>
 2652         <ele>
 2653           <name>count</name>
 2654           <summary>The number of Vulnerabilities</summary>
 2655         </ele>
 2656       </ele>
 2657       <ele>
 2658         <name>os</name>
 2659         <summary></summary>
 2660         <pattern>
 2661           <e>count</e>
 2662         </pattern>
 2663         <ele>
 2664           <name>count</name>
 2665           <summary>The number of operating systems</summary>
 2666         </ele>
 2667       </ele>
 2668       <ele>
 2669         <name>apps</name>
 2670         <summary></summary>
 2671         <pattern>
 2672           <e>count</e>
 2673         </pattern>
 2674         <ele>
 2675           <name>count</name>
 2676           <summary>The number of Applications</summary>
 2677         </ele>
 2678       </ele>
 2679       <ele>
 2680         <name>ssl_certs</name>
 2681         <summary></summary>
 2682         <pattern>
 2683           <e>count</e>
 2684         </pattern>
 2685         <ele>
 2686           <name>count</name>
 2687           <summary>The number of SSL certificates</summary>
 2688         </ele>
 2689       </ele>
 2690       <ele>
 2691         <name>host</name>
 2692         <pattern>
 2693           <e>ip</e>
 2694           <e>asset</e>
 2695           <e>start</e>
 2696           <e>end</e>
 2697           <e>port_count</e>
 2698           <e>result_count</e>
 2699           <any><e>detail</e></any>
 2700         </pattern>
 2701         <ele>
 2702           <name>ip</name>
 2703           <summary>IP of the host</summary>
 2704           <pattern>text</pattern>
 2705         </ele>
 2706         <ele>
 2707           <name>asset</name>
 2708           <summary>Asset linked to host</summary>
 2709           <pattern>
 2710             <attrib>
 2711               <name>asset_id</name>
 2712               <type>uuid</type>
 2713               <required>1</required>
 2714             </attrib>
 2715           </pattern>
 2716         </ele>
 2717         <ele>
 2718           <name>start</name>
 2719           <summary>Scan start time for this host</summary>
 2720           <pattern>text</pattern>
 2721         </ele>
 2722         <ele>
 2723           <name>end</name>
 2724           <summary>Scan end time for this host</summary>
 2725           <pattern>text</pattern>
 2726         </ele>
 2727         <ele>
 2728           <name>port_count</name>
 2729           <summary></summary>
 2730           <pattern>
 2731             <e>page</e>
 2732           </pattern>
 2733           <ele>
 2734             <name>page</name>
 2735             <summary>Number of ports of current host on current page</summary>
 2736             <pattern><t>integer</t></pattern>
 2737           </ele>
 2738         </ele>
 2739         <ele>
 2740           <name>result_count</name>
 2741           <summary></summary>
 2742           <pattern>
 2743             <e>page</e>
 2744             <e>hole</e>
 2745             <e>warning</e>
 2746             <e>info</e>
 2747             <e>log</e>
 2748             <e>false_positive</e>
 2749           </pattern>
 2750           <ele>
 2751             <name>page</name>
 2752             <summary>Total number of results for current host on current page</summary>
 2753             <pattern><t>integer</t></pattern>
 2754           </ele>
 2755           <ele>
 2756             <name>hole</name>
 2757             <summary>Number of "hole" results (level "High")</summary>
 2758             <pattern>
 2759               <e>page</e>
 2760             </pattern>
 2761             <ele>
 2762               <name>page</name>
 2763               <summary>Number of results on current page</summary>
 2764               <pattern><t>integer</t></pattern>
 2765             </ele>
 2766           </ele>
 2767           <ele>
 2768             <name>warning</name>
 2769             <summary>Number of "warning" results (level "Medium")</summary>
 2770             <pattern>
 2771               <e>page</e>
 2772             </pattern>
 2773             <ele>
 2774               <name>page</name>
 2775               <summary>Number of results on current page</summary>
 2776               <pattern><t>integer</t></pattern>
 2777             </ele>
 2778           </ele>
 2779           <ele>
 2780             <name>info</name>
 2781             <summary>Number of "info" results (level "Low")</summary>
 2782             <pattern>
 2783               <e>page</e>
 2784             </pattern>
 2785             <ele>
 2786               <name>page</name>
 2787               <summary>Number of results on current page</summary>
 2788               <pattern><t>integer</t></pattern>
 2789             </ele>
 2790           </ele>
 2791           <ele>
 2792             <name>log</name>
 2793             <summary>Number of "log" results</summary>
 2794             <pattern>
 2795               <e>page</e>
 2796             </pattern>
 2797             <ele>
 2798               <name>page</name>
 2799               <summary>Number of results on current page</summary>
 2800               <pattern><t>integer</t></pattern>
 2801             </ele>
 2802           </ele>
 2803           <ele>
 2804             <name>false_positive</name>
 2805             <summary>Number of "false positive" results</summary>
 2806             <pattern>
 2807               <e>page</e>
 2808             </pattern>
 2809             <ele>
 2810               <name>page</name>
 2811               <summary>Number of results on current page</summary>
 2812               <pattern><t>integer</t></pattern>
 2813             </ele>
 2814           </ele>
 2815         </ele>
 2816         <ele>
 2817           <name>detail</name>
 2818           <summary>A detail associated with the host</summary>
 2819           <pattern>
 2820             <e>name</e>
 2821             <e>value</e>
 2822             <e>source</e>
 2823             <e>extra</e>
 2824           </pattern>
 2825           <ele>
 2826             <name>name</name>
 2827             <summary>The name of the detail</summary>
 2828             <pattern>text</pattern>
 2829           </ele>
 2830           <ele>
 2831             <name>value</name>
 2832             <summary>The value of the detail</summary>
 2833             <pattern>text</pattern>
 2834           </ele>
 2835           <ele>
 2836             <name>source</name>
 2837             <summary>Where the detail comes from</summary>
 2838             <pattern>
 2839               <e>type</e>
 2840               <e>name</e>
 2841               <e>description</e>
 2842             </pattern>
 2843             <ele>
 2844               <name>type</name>
 2845               <summary>The type of the detail source</summary>
 2846               <pattern>text</pattern>
 2847             </ele>
 2848             <ele>
 2849               <name>name</name>
 2850               <summary>The name of the detail source</summary>
 2851               <pattern>text</pattern>
 2852             </ele>
 2853             <ele>
 2854               <name>description</name>
 2855               <summary>A description of the detail source</summary>
 2856               <pattern>text</pattern>
 2857             </ele>
 2858           </ele>
 2859           <ele>
 2860             <name>extra</name>
 2861             <summary>Extra info (NVT CVSS for closed CVE results)</summary>
 2862             <pattern>text</pattern>
 2863           </ele>
 2864         </ele>
 2865       </ele>
 2866       <ele>
 2867         <name>timestamp</name>
 2868         <summary>The time the scan was requested</summary>
 2869         <pattern><t>iso_time</t></pattern>
 2870       </ele>
 2871       <ele>
 2872         <name>scan_start</name>
 2873         <summary>Start time of scan</summary>
 2874         <pattern><t>iso_time</t></pattern>
 2875       </ele>
 2876       <ele>
 2877         <name>host_start</name>
 2878         <summary>Start time of a particular host</summary>
 2879         <pattern>
 2880           <t>iso_time</t>
 2881           <e>host</e>
 2882         </pattern>
 2883         <ele>
 2884           <name>host</name>
 2885           <pattern>text</pattern>
 2886         </ele>
 2887       </ele>
 2888       <ele>
 2889         <name>host_end</name>
 2890         <summary>End time of a particular host</summary>
 2891         <pattern>
 2892           <t>iso_time</t>
 2893           <e>host</e>
 2894         </pattern>
 2895         <ele>
 2896           <name>host</name>
 2897           <pattern>text</pattern>
 2898         </ele>
 2899       </ele>
 2900       <ele>
 2901         <name>scan_end</name>
 2902         <summary>End time of scan</summary>
 2903         <pattern><t>iso_time</t></pattern>
 2904       </ele>
 2905       <ele>
 2906         <name>errors</name>
 2907         <pattern>
 2908           <e>count</e>
 2909           <any><e>error</e></any>
 2910         </pattern>
 2911         <ele>
 2912           <name>count</name>
 2913           <summary>The number of error messages</summary>
 2914         </ele>
 2915         <ele>
 2916           <name>error</name>
 2917           <summary>An error message</summary>
 2918           <pattern>
 2919             <e>host</e>
 2920             <e>port</e>
 2921             <e>description</e>
 2922             <e>nvt</e>
 2923             <e>scan_nvt_version</e>
 2924             <e>severity</e>
 2925           </pattern>
 2926           <ele>
 2927             <name>host</name>
 2928             <summary>The host of the error message</summary>
 2929             <pattern>
 2930               <e>asset</e>
 2931               text
 2932             </pattern>
 2933             <ele>
 2934               <name>asset</name>
 2935               <summary>Asset linked to host</summary>
 2936               <pattern>
 2937                 <attrib>
 2938                   <name>asset_id</name>
 2939                   <type>uuid</type>
 2940                   <required>1</required>
 2941                 </attrib>
 2942               </pattern>
 2943             </ele>
 2944           </ele>
 2945           <ele>
 2946             <name>port</name>
 2947             <summary>The port of the error message</summary>
 2948             <pattern><t>port</t></pattern>
 2949           </ele>
 2950           <ele>
 2951             <name>description</name>
 2952             <summary>The description of the error message</summary>
 2953             <pattern>text</pattern>
 2954           </ele>
 2955           <ele>
 2956             <name>nvt</name>
 2957             <summary>The NVT that generated the error message</summary>
 2958             <pattern>
 2959               <attrib>
 2960                 <name>oid</name>
 2961                 <required>1</required>
 2962               </attrib>
 2963               <e>name</e>
 2964               <e>type</e>
 2965               <e>cvss_base</e>
 2966             </pattern>
 2967             <ele>
 2968               <name>name</name>
 2969               <summary>The name of the NVT</summary>
 2970               <pattern>text</pattern>
 2971             </ele>
 2972             <ele>
 2973               <name>type</name>
 2974               <summary>The type of the NVT: nvt, cve, ovaldef, ...</summary>
 2975               <pattern>text</pattern>
 2976             </ele>
 2977             <ele>
 2978               <name>cvss_base</name>
 2979               <summary>The base CVSS score of the NVT</summary>
 2980               <pattern><t>severity</t></pattern>
 2981             </ele>
 2982           </ele>
 2983           <ele>
 2984             <name>scan_nvt_version</name>
 2985             <summary>The NVT version that generated the error</summary>
 2986             <pattern>text</pattern>
 2987           </ele>
 2988           <ele>
 2989             <name>severity</name>
 2990             <summary>The severity score of the error message</summary>
 2991             <pattern><t>severity</t></pattern>
 2992           </ele>
 2993         </ele>
 2994       </ele>
 2995     </ele>
 2996   </element>
 2997 
 2998   <!-- Commands. -->
 2999 
 3000   <command>
 3001     <name>authenticate</name>
 3002     <summary>Authenticate with the manager</summary>
 3003     <description>
 3004       <p>
 3005         The client uses the authenticate command to authenticate with the
 3006         Manager.
 3007       </p>
 3008       <p>
 3009         The client normally executes this command at the beginning of each
 3010         connection.  The only commands permitted before authentication are
 3011         get_version and commands.
 3012       </p>
 3013     </description>
 3014     <pattern>
 3015       <e>credentials</e>
 3016     </pattern>
 3017     <ele>
 3018       <name>credentials</name>
 3019       <pattern>
 3020         <e>username</e>
 3021         <e>password</e>
 3022       </pattern>
 3023       <ele>
 3024         <name>username</name>
 3025         <summary>The login name of the user</summary>
 3026         <pattern>
 3027           text
 3028         </pattern>
 3029       </ele>
 3030       <ele>
 3031         <name>password</name>
 3032         <summary>The user's password</summary>
 3033         <pattern>
 3034           text
 3035         </pattern>
 3036       </ele>
 3037     </ele>
 3038     <response>
 3039       <pattern>
 3040         <attrib>
 3041           <name>status</name>
 3042           <type>status</type>
 3043           <required>1</required>
 3044         </attrib>
 3045         <attrib>
 3046           <name>status_text</name>
 3047           <type>text</type>
 3048           <required>1</required>
 3049         </attrib>
 3050         <e>role</e>
 3051         <e>timezone</e>
 3052       </pattern>
 3053       <ele>
 3054         <name>role</name>
 3055         <summary>The user's role</summary>
 3056         <type>
 3057           <alts>
 3058             <alt>User</alt>
 3059             <alt>Admin</alt>
 3060             <alt>Super Admin</alt>
 3061             <alt>Observer</alt>
 3062           </alts>
 3063         </type>
 3064       </ele>
 3065       <ele>
 3066         <name>timezone</name>
 3067         <summary>The user's timezone</summary>
 3068         <pattern>
 3069           timezone
 3070         </pattern>
 3071       </ele>
 3072     </response>
 3073     <example>
 3074       <summary>Authenticate with a good password</summary>
 3075       <request>
 3076         <authenticate>
 3077           <credentials>
 3078             <username>sally</username>
 3079             <password>secret</password>
 3080           </credentials>
 3081         </authenticate>
 3082       </request>
 3083       <response>
 3084         <authenticate_response status="200" status_text="OK">
 3085           <role>User</role>
 3086           <timezone>UTC</timezone>
 3087         </authenticate_response>
 3088       </response>
 3089     </example>
 3090     <example>
 3091       <summary>Authenticate with a bad password</summary>
 3092       <request>
 3093         <authenticate>
 3094           <credentials>
 3095             <username>sally</username>
 3096             <password>secrte</password>
 3097           </credentials>
 3098         </authenticate>
 3099       </request>
 3100       <response>
 3101         <authenticate_response status="400"
 3102                                status_text="Authentication failed"/>
 3103       </response>
 3104     </example>
 3105   </command>
 3106   <command>
 3107     <name>commands</name>
 3108     <summary>Run a list of commands</summary>
 3109     <description>
 3110       The client uses the commands command to run a list of commands.  The
 3111       elements are executed as OMP commands in the given sequence.  The reply
 3112       contains the result of each command, in the same order as the given
 3113       commands.
 3114     </description>
 3115     <pattern>
 3116       <any>
 3117         <or>
 3118           <c>authenticate</c>
 3119           <c>commands</c>
 3120           <c>create_agent</c>
 3121           <c>create_alert</c>
 3122           <c>create_asset</c>
 3123           <c>create_config</c>
 3124           <c>create_credential</c>
 3125           <c>create_filter</c>
 3126           <c>create_group</c>
 3127           <c>create_note</c>
 3128           <c>create_override</c>
 3129           <c>create_permission</c>
 3130           <c>create_port_list</c>
 3131           <c>create_port_range</c>
 3132           <c>create_report_format</c>
 3133           <c>create_role</c>
 3134           <c>create_scanner</c>
 3135           <c>create_schedule</c>
 3136           <c>create_tag</c>
 3137           <c>create_target</c>
 3138           <c>create_task</c>
 3139           <c>create_user</c>
 3140           <c>delete_agent</c>
 3141           <c>delete_alert</c>
 3142           <c>delete_asset</c>
 3143           <c>delete_config</c>
 3144           <c>delete_credential</c>
 3145           <c>delete_filter</c>
 3146           <c>delete_group</c>
 3147           <c>delete_note</c>
 3148           <c>delete_override</c>
 3149           <c>delete_permission</c>
 3150           <c>delete_report</c>
 3151           <c>delete_report_format</c>
 3152           <c>delete_role</c>
 3153           <c>delete_port_list</c>
 3154           <c>delete_port_range</c>
 3155           <c>delete_scanner</c>
 3156           <c>delete_schedule</c>
 3157           <c>delete_tag</c>
 3158           <c>delete_target</c>
 3159           <c>delete_task</c>
 3160           <c>delete_user</c>
 3161           <c>describe_auth</c>
 3162           <c>empty_trashcan</c>
 3163           <c>get_agents</c>
 3164           <c>get_alerts</c>
 3165           <c>get_assets</c>
 3166           <c>get_configs</c>
 3167           <c>get_credentials</c>
 3168           <c>get_feeds</c>
 3169           <c>get_filters</c>
 3170           <c>get_groups</c>
 3171           <c>get_info</c>
 3172           <c>get_notes</c>
 3173           <c>get_nvts</c>
 3174           <c>get_nvt_families</c>
 3175           <c>get_overrides</c>
 3176           <c>get_permissions</c>
 3177           <c>get_port_lists</c>
 3178           <c>get_preferences</c>
 3179           <c>get_reports</c>
 3180           <c>get_report_formats</c>
 3181           <c>get_results</c>
 3182           <c>get_roles</c>
 3183           <c>get_scanners</c>
 3184           <c>get_schedules</c>
 3185           <c>get_settings</c>
 3186           <c>get_system_reports</c>
 3187           <c>get_tags</c>
 3188           <c>get_targets</c>
 3189           <c>get_tasks</c>
 3190           <c>get_users</c>
 3191           <c>get_version</c>
 3192           <c>help</c>
 3193           <c>modify_agent</c>
 3194           <c>modify_alert</c>
 3195           <c>modify_asset</c>
 3196           <c>modify_auth</c>
 3197           <c>modify_config</c>
 3198           <c>modify_credential</c>
 3199           <c>modify_filter</c>
 3200           <c>modify_group</c>
 3201           <c>modify_note</c>
 3202           <c>modify_override</c>
 3203           <c>modify_permission</c>
 3204           <c>modify_port_list</c>
 3205           <c>modify_report</c>
 3206           <c>modify_report_format</c>
 3207           <c>modify_role</c>
 3208           <c>modify_scanner</c>
 3209           <c>modify_schedule</c>
 3210           <c>modify_setting</c>
 3211           <c>modify_tag</c>
 3212           <c>modify_target</c>
 3213           <c>modify_task</c>
 3214           <c>modify_user</c>
 3215           <c>restore</c>
 3216           <c>resume_task</c>
 3217           <c>run_wizard</c>
 3218           <c>start_task</c>
 3219           <c>stop_task</c>
 3220           <c>sync_feed</c>
 3221           <c>sync_config</c>
 3222           <c>sync_scap</c>
 3223           <c>sync_cert</c>
 3224           <c>test_alert</c>
 3225           <c>verify_agent</c>
 3226           <c>verify_report_format</c>
 3227           <c>verify_scanner</c>
 3228         </or>
 3229       </any>
 3230     </pattern>
 3231     <response>
 3232       <pattern>
 3233         <attrib>
 3234           <name>status</name>
 3235           <type>status</type>
 3236           <required>1</required>
 3237         </attrib>
 3238         <attrib>
 3239           <name>status_text</name>
 3240           <type>text</type>
 3241           <required>1</required>
 3242         </attrib>
 3243         <any>
 3244           <or>
 3245             <r>authenticate</r>
 3246             <r>commands</r>
 3247             <r>create_agent</r>
 3248             <r>create_alert</r>
 3249             <r>create_asset</r>
 3250             <r>create_config</r>
 3251             <r>create_credential</r>
 3252             <r>create_filter</r>
 3253             <r>create_group</r>
 3254             <r>create_note</r>
 3255             <r>create_override</r>
 3256             <r>create_permission</r>
 3257             <r>create_port_list</r>
 3258             <r>create_port_range</r>
 3259             <r>create_role</r>
 3260             <r>create_scanner</r>
 3261             <r>create_schedule</r>
 3262             <r>create_tag</r>
 3263             <r>create_target</r>
 3264             <r>create_task</r>
 3265             <r>create_user</r>
 3266             <r>delete_agent</r>
 3267             <r>delete_alert</r>
 3268             <r>delete_asset</r>
 3269             <r>delete_config</r>
 3270             <r>delete_credential</r>
 3271             <r>delete_filter</r>
 3272             <r>delete_group</r>
 3273             <r>delete_note</r>
 3274             <r>delete_override</r>
 3275             <r>delete_permission</r>
 3276             <r>delete_port_list</r>
 3277             <r>delete_port_range</r>
 3278             <r>delete_report</r>
 3279             <r>delete_report_format</r>
 3280             <r>delete_role</r>
 3281             <r>delete_scanner</r>
 3282             <r>delete_schedule</r>
 3283             <r>delete_tag</r>
 3284             <r>delete_target</r>
 3285             <r>delete_task</r>
 3286             <r>delete_user</r>
 3287             <r>describe_auth</r>
 3288             <r>empty_trashcan</r>
 3289             <r>get_agents</r>
 3290             <r>get_alerts</r>
 3291             <r>get_assets</r>
 3292             <r>get_configs</r>
 3293             <r>get_credentials</r>
 3294             <r>get_groups</r>
 3295             <r>get_info</r>
 3296             <r>get_feeds</r>
 3297             <r>get_filters</r>
 3298             <r>get_notes</r>
 3299             <r>get_nvts</r>
 3300             <r>get_nvt_families</r>
 3301             <r>get_overrides</r>
 3302             <r>get_permissions</r>
 3303             <r>get_port_lists</r>
 3304             <r>get_preferences</r>
 3305             <r>get_reports</r>
 3306             <r>get_report_formats</r>
 3307             <r>get_results</r>
 3308             <r>get_roles</r>
 3309             <r>get_scanners</r>
 3310             <r>get_schedules</r>
 3311             <r>get_settings</r>
 3312             <r>get_system_reports</r>
 3313             <r>get_tags</r>
 3314             <r>get_targets</r>
 3315             <r>get_tasks</r>
 3316             <r>get_users</r>
 3317             <r>get_version</r>
 3318             <r>help</r>
 3319             <r>modify_agent</r>
 3320             <r>modify_alert</r>
 3321             <r>modify_asset</r>
 3322             <r>modify_auth</r>
 3323             <r>modify_config</r>
 3324             <r>modify_credential</r>
 3325             <r>modify_filter</r>
 3326             <r>modify_group</r>
 3327             <r>modify_note</r>
 3328             <r>modify_override</r>
 3329             <r>modify_permission</r>
 3330             <r>modify_port_list</r>
 3331             <r>modify_report</r>
 3332             <r>modify_report_format</r>
 3333             <r>modify_role</r>
 3334             <r>modify_scanner</r>
 3335             <r>modify_schedule</r>
 3336             <r>modify_setting</r>
 3337             <r>modify_tag</r>
 3338             <r>modify_target</r>
 3339             <r>modify_task</r>
 3340             <r>modify_user</r>
 3341             <r>restore</r>
 3342             <r>resume_task</r>
 3343             <r>run_wizard</r>
 3344             <r>start_task</r>
 3345             <r>stop_task</r>
 3346             <r>sync_feed</r>
 3347             <r>sync_config</r>
 3348             <r>sync_scap</r>
 3349             <r>sync_cert</r>
 3350             <r>test_alert</r>
 3351             <r>verify_agent</r>
 3352             <r>verify_report_format</r>
 3353             <r>verify_scanner</r>
 3354           </or>
 3355         </any>
 3356       </pattern>
 3357     </response>
 3358   </command>
 3359   <command>
 3360     <name>create_agent</name>
 3361     <summary>Create an agent</summary>
 3362     <description>
 3363       <p>
 3364         The client uses the create_agent command to create a new agent.
 3365       </p>
 3366     </description>
 3367     <pattern>
 3368       <e>installer</e>
 3369       <e>name</e>
 3370       <o><e>comment</e></o>
 3371       <o><e>copy</e></o>
 3372       <o><e>howto_install</e></o>
 3373       <o><e>howto_use</e></o>
 3374     </pattern>
 3375     <ele>
 3376       <name>installer</name>
 3377       <summary>A file that installs the agent on a target machine</summary>
 3378       <pattern>
 3379         <t>base64</t>
 3380         <e>signature</e>
 3381       </pattern>
 3382       <ele>
 3383         <name>signature</name>
 3384         <summary>A detached OpenPGP signature of the installer</summary>
 3385         <pattern><t>base64</t></pattern>
 3386       </ele>
 3387     </ele>
 3388     <ele>
 3389       <name>name</name>
 3390       <summary>A name for the installer</summary>
 3391       <pattern><t>name</t></pattern>
 3392     </ele>
 3393     <ele>
 3394       <name>comment</name>
 3395       <summary>A comment on the agent</summary>
 3396       <pattern>
 3397         text
 3398       </pattern>
 3399     </ele>
 3400     <ele>
 3401       <name>copy</name>
 3402       <summary>The UUID of an existing agent</summary>
 3403       <pattern>
 3404         <t>uuid</t>
 3405       </pattern>
 3406     </ele>
 3407     <ele>
 3408       <name>howto_install</name>
 3409       <summary>A file that describes how to install the agent</summary>
 3410       <pattern>
 3411         <t>base64</t>
 3412       </pattern>
 3413     </ele>
 3414     <ele>
 3415       <name>howto_use</name>
 3416       <summary>A file that describes how to use the agent</summary>
 3417       <pattern>
 3418         <t>base64</t>
 3419       </pattern>
 3420     </ele>
 3421     <response>
 3422       <pattern>
 3423         <attrib>
 3424           <name>status</name>
 3425           <type>status</type>
 3426           <required>1</required>
 3427         </attrib>
 3428         <attrib>
 3429           <name>status_text</name>
 3430           <type>text</type>
 3431           <required>1</required>
 3432         </attrib>
 3433         <attrib>
 3434           <name>id</name>
 3435           <type>uuid</type>
 3436           <required>1</required>
 3437         </attrib>
 3438       </pattern>
 3439     </response>
 3440     <example>
 3441       <summary>Create an agent</summary>
 3442       <request>
 3443         <create_agent>
 3444           <installer>
 3445             asdf3235saf3kjBVF...
 3446             <signature>iEYEABECAAYFA...</signature>
 3447           </installer>
 3448           <name>SLAD</name>
 3449         </create_agent>
 3450       </request>
 3451       <response>
 3452         <create_agent_response status="201" status_text="OK, resource created"
 3453                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 3454         </create_agent_response>
 3455       </response>
 3456     </example>
 3457   </command>
 3458   <command>
 3459     <name>create_alert</name>
 3460     <summary>Create an alert</summary>
 3461     <description>
 3462       <p>
 3463         The client uses the create_alert command to create a new
 3464         alert.
 3465       </p>
 3466     </description>
 3467     <pattern>
 3468       <e>name</e>
 3469       <o><e>comment</e></o>
 3470       <o><e>copy</e></o>
 3471       <e>condition</e>
 3472       <e>event</e>
 3473       <e>method</e>
 3474       <e>filter</e>
 3475     </pattern>
 3476     <ele>
 3477       <name>name</name>
 3478       <summary>A name for the alert</summary>
 3479       <pattern><t>name</t></pattern>
 3480     </ele>
 3481     <ele>
 3482       <name>comment</name>
 3483       <summary>A comment on the alert</summary>
 3484       <pattern>
 3485         text
 3486       </pattern>
 3487     </ele>
 3488     <ele>
 3489       <name>copy</name>
 3490       <summary>The UUID of an existing alert</summary>
 3491       <pattern>
 3492         <t>uuid</t>
 3493       </pattern>
 3494     </ele>
 3495     <ele>
 3496       <name>condition</name>
 3497       <summary>
 3498         The condition that must be satisfied for the alert to occur
 3499       </summary>
 3500       <pattern>
 3501         text
 3502         <any><e>data</e></any>
 3503       </pattern>
 3504       <ele>
 3505         <name>data</name>
 3506         <summary>Some data that defines the condition</summary>
 3507         <pattern>
 3508           text
 3509           <e>name</e>
 3510         </pattern>
 3511         <ele>
 3512           <name>name</name>
 3513           <summary>The name of the condition data</summary>
 3514           <pattern>
 3515             text
 3516           </pattern>
 3517         </ele>
 3518       </ele>
 3519     </ele>
 3520     <ele>
 3521       <name>event</name>
 3522       <summary>
 3523         The event that must happen for the alert to occur
 3524       </summary>
 3525       <pattern>
 3526         text
 3527         <any><e>data</e></any>
 3528       </pattern>
 3529       <ele>
 3530         <name>data</name>
 3531         <summary>Some data that defines the event</summary>
 3532         <pattern>
 3533           text
 3534           <e>name</e>
 3535         </pattern>
 3536         <ele>
 3537           <name>name</name>
 3538           <summary>The name of the event data</summary>
 3539           <pattern>
 3540             text
 3541           </pattern>
 3542         </ele>
 3543       </ele>
 3544     </ele>
 3545     <ele>
 3546       <name>method</name>
 3547       <summary>The method by which the user is alerted</summary>
 3548       <pattern>
 3549         text
 3550         <any><e>data</e></any>
 3551       </pattern>
 3552       <ele>
 3553         <name>data</name>
 3554         <summary>Some data that defines the method</summary>
 3555         <pattern>
 3556           text
 3557           <e>name</e>
 3558         </pattern>
 3559         <ele>
 3560           <name>name</name>
 3561           <summary>The name of the method data</summary>
 3562           <pattern>
 3563             text
 3564           </pattern>
 3565         </ele>
 3566       </ele>
 3567     </ele>
 3568     <ele>
 3569       <name>filter</name>
 3570       <summary>Filter to apply when executing alert</summary>
 3571       <pattern>
 3572         <attrib>
 3573           <name>id</name>
 3574           <type>uuid</type>
 3575           <required>1</required>
 3576         </attrib>
 3577       </pattern>
 3578     </ele>
 3579     <response>
 3580       <pattern>
 3581         <attrib>
 3582           <name>status</name>
 3583           <type>status</type>
 3584           <required>1</required>
 3585         </attrib>
 3586         <attrib>
 3587           <name>status_text</name>
 3588           <type>text</type>
 3589           <required>1</required>
 3590         </attrib>
 3591         <attrib>
 3592           <name>id</name>
 3593           <type>uuid</type>
 3594           <required>1</required>
 3595         </attrib>
 3596       </pattern>
 3597     </response>
 3598     <example>
 3599       <summary>Create an alert</summary>
 3600       <request>
 3601         <create_alert>
 3602           <name>emergency</name>
 3603           <condition>
 3604             Severity at least
 3605             <data>
 3606               <name>severity</name>
 3607               5.5
 3608             </data>
 3609           </condition>
 3610           <event>
 3611             Task run status changed
 3612             <data>
 3613               <name>status</name>
 3614               Done
 3615             </data>
 3616           </event>
 3617           <method>
 3618             Email
 3619             <data>
 3620               <name>to_address</name>
 3621               sally@example.org
 3622             </data>
 3623             <data>
 3624               <name>from_address</name>
 3625               bob@example.org
 3626             </data>
 3627           </method>
 3628         </create_alert>
 3629       </request>
 3630       <response>
 3631         <create_alert_response status="201"
 3632                                status_text="OK, resource created"
 3633                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 3634         </create_alert_response>
 3635       </response>
 3636     </example>
 3637   </command>
 3638   <command>
 3639     <name>create_asset</name>
 3640     <summary>Create an asset</summary>
 3641     <description>
 3642       <p>
 3643         The client uses the create_asset command to create a new asset.
 3644       </p>
 3645     </description>
 3646     <pattern>
 3647       <or>
 3648         <e>asset</e>
 3649         <e>report</e>
 3650       </or>
 3651     </pattern>
 3652     <ele>
 3653       <name>asset</name>
 3654       <pattern>
 3655         <e>name</e>
 3656         <e>comment</e>
 3657       </pattern>
 3658       <ele>
 3659         <name>name</name>
 3660         <summary>A name for the asset</summary>
 3661         <pattern>
 3662           <t>name</t>
 3663         </pattern>
 3664       </ele>
 3665       <ele>
 3666         <name>comment</name>
 3667         <summary>A comment on the asset</summary>
 3668         <pattern>
 3669           text
 3670         </pattern>
 3671       </ele>
 3672     </ele>
 3673     <ele>
 3674       <name>report</name>
 3675       <summary>Report from which to import assets</summary>
 3676       <pattern>
 3677         <attrib>
 3678           <name>id</name>
 3679           <type>uuid</type>
 3680           <required>1</required>
 3681         </attrib>
 3682         <e>filter</e>
 3683       </pattern>
 3684       <ele>
 3685         <name>filter</name>
 3686         <summary>Filter, for min_qod and apply_overrides</summary>
 3687         <pattern>
 3688           <e>term</e>
 3689         </pattern>
 3690         <ele>
 3691           <name>term</name>
 3692           <summary>Filter term</summary>
 3693           <pattern>
 3694             text
 3695           </pattern>
 3696         </ele>
 3697       </ele>
 3698     </ele>
 3699     <response>
 3700       <pattern>
 3701         <attrib>
 3702           <name>status</name>
 3703           <type>status</type>
 3704           <required>1</required>
 3705         </attrib>
 3706         <attrib>
 3707           <name>status_text</name>
 3708           <type>text</type>
 3709           <required>1</required>
 3710         </attrib>
 3711         <attrib>
 3712           <name>id</name>
 3713           <type>uuid</type>
 3714           <required>1</required>
 3715         </attrib>
 3716       </pattern>
 3717     </response>
 3718     <example>
 3719       <summary>Create an asset</summary>
 3720       <request>
 3721         <create_asset>
 3722           <asset>
 3723             <type>host</type>
 3724             <name>Localhost</name>
 3725           </asset>
 3726         </create_asset>
 3727       </request>
 3728       <response>
 3729         <create_asset_response status="201"
 3730                                 status_text="OK, resource created"
 3731                                 id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 3732         </create_asset_response>
 3733       </response>
 3734     </example>
 3735   </command>
 3736   <command>
 3737     <name>create_config</name>
 3738     <summary>Create a config</summary>
 3739     <description>
 3740       <p>
 3741         The client uses the create_config command to create a new config.
 3742       </p>
 3743       <l>
 3744         <lh>This command can be called in three ways:</lh>
 3745         <li>
 3746           With a copy element.  The new config is a copy of the existing
 3747           config, with the given name.
 3748         </li>
 3749         <li>
 3750           With an embedded get_configs response element.  The config is
 3751           created as defined by the get_configs response element.  Name is
 3752           actually optional in this case.  The config is given the name of
 3753           the config in the get_configs response.  If there is already a
 3754           config with this name, then a number is attached to the name to
 3755           make it unique.
 3756         </li>
 3757       </l>
 3758     </description>
 3759     <pattern>
 3760       <o><e>comment</e></o>
 3761       <or>
 3762         <e>copy</e>
 3763         <r>get_configs</r>
 3764       </or>
 3765       <e>name</e>
 3766     </pattern>
 3767     <ele>
 3768       <name>comment</name>
 3769       <summary>A comment on the config</summary>
 3770       <pattern>
 3771         text
 3772       </pattern>
 3773     </ele>
 3774     <ele>
 3775       <name>copy</name>
 3776       <!-- TODO UUIDs are normally in attributes. -->
 3777       <summary>The UUID of an existing config</summary>
 3778       <pattern>
 3779         <t>uuid</t>
 3780       </pattern>
 3781     </ele>
 3782     <ele>
 3783       <name>name</name>
 3784       <summary>A name for the config</summary>
 3785       <pattern><t>name</t></pattern>
 3786     </ele>
 3787     <response>
 3788       <pattern>
 3789         <attrib>
 3790           <name>status</name>
 3791           <type>status</type>
 3792           <required>1</required>
 3793         </attrib>
 3794         <attrib>
 3795           <name>status_text</name>
 3796           <type>text</type>
 3797           <required>1</required>
 3798         </attrib>
 3799         <attrib>
 3800           <name>id</name>
 3801           <type>uuid</type>
 3802           <required>1</required>
 3803         </attrib>
 3804       </pattern>
 3805     </response>
 3806     <example>
 3807       <summary>Copy a config</summary>
 3808       <request>
 3809         <create_config>
 3810           <copy>daba56c8-73ec-11df-a475-002264764cea</copy>
 3811           <name>Full</name>
 3812         </create_config>
 3813       </request>
 3814       <response>
 3815         <create_config_response status="201" status_text="OK, resource created"
 3816                                 id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 3817         </create_config_response>
 3818       </response>
 3819     </example>
 3820     <example>
 3821       <summary>Create a config from a GET_CONFIGS response</summary>
 3822       <request>
 3823         <create_config>
 3824           <get_configs_response>
 3825             <config id="daba56c8-73ec-11df-a475-002264764cea">
 3826               <name>Full and fast</name>
 3827               <truncated>...</truncated>
 3828             </config>
 3829           </get_configs_response>
 3830         </create_config>
 3831       </request>
 3832       <response>
 3833         <create_config_response status="201" status_text="OK, resource created"
 3834                                 id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 3835         </create_config_response>
 3836       </response>
 3837     </example>
 3838   </command>
 3839   <command>
 3840     <name>create_credential</name>
 3841     <summary>Create a credential</summary>
 3842     <description>
 3843       <p>
 3844         The client uses the create_credential command to create a new
 3845         credential for local security checks and other functions
 3846         requiring authentication.
 3847       </p>
 3848       <p>
 3849         If the command includes a key, then the manager creates a key-based
 3850         credential from the key.  If the command includes a password, then
 3851         the manager creates a password only credential.  Otherwise the
 3852         manager autogenerates a key-based credential.
 3853       </p>
 3854     </description>
 3855     <pattern>
 3856       <e>name</e>
 3857       <o><e>comment</e></o>
 3858       <o><e>copy</e></o>
 3859       <o><e>allow_insecure</e></o>
 3860       <o><e>certificate</e></o>
 3861       <o><e>key</e></o>
 3862       <o><e>login</e></o>
 3863       <o><e>password</e></o>
 3864       <o><e>auth_algorithm</e></o>
 3865       <o><e>community</e></o>
 3866       <o><e>privacy</e></o>
 3867       <o><e>type</e></o>
 3868     </pattern>
 3869     <ele>
 3870       <name>name</name>
 3871       <summary>A name for the credential</summary>
 3872       <pattern><t>name</t></pattern>
 3873     </ele>
 3874     <ele>
 3875       <name>comment</name>
 3876       <summary>A comment on the credential</summary>
 3877       <pattern>
 3878         text
 3879       </pattern>
 3880     </ele>
 3881     <ele>
 3882       <name>copy</name>
 3883       <summary>The UUID of an existing credential</summary>
 3884       <pattern>
 3885         <t>uuid</t>
 3886       </pattern>
 3887     </ele>
 3888     <ele>
 3889       <name>allow_insecure</name>
 3890       <summary>Whether to allow insecure use of the credential</summary>
 3891       <pattern>
 3892         <t>boolean</t>
 3893       </pattern>
 3894     </ele>
 3895     <ele>
 3896       <name>certificate</name>
 3897       <summary>The certificate of the credential</summary>
 3898       <pattern>
 3899         text
 3900       </pattern>
 3901     </ele>
 3902     <ele>
 3903       <name>key</name>
 3904       <pattern>
 3905         <e>phrase</e>
 3906         <e>private</e>
 3907       </pattern>
 3908       <ele>
 3909         <name>phrase</name>
 3910         <summary>Key passphrase</summary>
 3911         <pattern>
 3912           text
 3913         </pattern>
 3914       </ele>
 3915       <ele>
 3916         <name>private</name>
 3917         <summary>Private key</summary>
 3918         <pattern>
 3919           text
 3920         </pattern>
 3921       </ele>
 3922     </ele>
 3923     <ele>
 3924       <name>login</name>
 3925       <summary>The user name of the credential</summary>
 3926       <pattern>
 3927         text
 3928       </pattern>
 3929     </ele>
 3930     <ele>
 3931       <name>password</name>
 3932       <summary>The password for the credential login</summary>
 3933       <pattern>
 3934         text
 3935       </pattern>
 3936     </ele>
 3937     <ele>
 3938       <name>community</name>
 3939       <summary>The SNMP community</summary>
 3940       <pattern>
 3941         text
 3942       </pattern>
 3943     </ele>
 3944     <ele>
 3945       <name>auth_algorithm</name>
 3946       <summary>Authentication algorithm for SNMP, either md5 or sha1</summary>
 3947       <pattern>
 3948         <t>
 3949           <alts>
 3950             <alt>md5</alt>
 3951             <alt>sha1</alt>
 3952           </alts>
 3953         </t>
 3954       </pattern>
 3955     </ele>
 3956     <ele>
 3957       <name>privacy</name>
 3958       <pattern>
 3959         <e>algorithm</e>
 3960         <e>password</e>
 3961       </pattern>
 3962       <ele>
 3963         <name>algorithm</name>
 3964         <summary>The SNMP privacy algorithm, either aes or des</summary>
 3965         <pattern>
 3966           <t>
 3967             <alts>
 3968               <alt>aes</alt>
 3969               <alt>des</alt>
 3970             </alts>
 3971           </t>
 3972         </pattern>
 3973       </ele>
 3974       <ele>
 3975         <name>password</name>
 3976         <summary>The SNMP privacy password</summary>
 3977         <pattern>
 3978           text
 3979         </pattern>
 3980       </ele>
 3981     </ele>
 3982     <ele>
 3983       <name>type</name>
 3984       <summary>The type of credential to create</summary>
 3985       <pattern>
 3986         <t>
 3987           <alts>
 3988             <alt>cc</alt>
 3989             <alt>snmp</alt>
 3990             <alt>up</alt>
 3991             <alt>usk</alt>
 3992           </alts>
 3993         </t>
 3994       </pattern>
 3995     </ele>
 3996     <response>
 3997       <pattern>
 3998         <attrib>
 3999           <name>status</name>
 4000           <type>status</type>
 4001           <required>1</required>
 4002         </attrib>
 4003         <attrib>
 4004           <name>status_text</name>
 4005           <type>text</type>
 4006           <required>1</required>
 4007         </attrib>
 4008         <attrib>
 4009           <name>id</name>
 4010           <type>uuid</type>
 4011           <required>1</required>
 4012         </attrib>
 4013       </pattern>
 4014     </response>
 4015     <example>
 4016       <summary>Create an LSC credential</summary>
 4017       <request>
 4018         <create_credential>
 4019           <name>cluster sally</name>
 4020           <login>sally</login>
 4021           <password>secret</password>
 4022           <comment>Sally's login to the cluster.</comment>
 4023         </create_credential>
 4024       </request>
 4025       <response>
 4026         <create_credential_response status="201"
 4027                                     status_text="OK, resource created"
 4028                                     id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 4029         </create_credential_response>
 4030       </response>
 4031     </example>
 4032   </command>
 4033   <command>
 4034     <name>create_filter</name>
 4035     <summary>Create a filter</summary>
 4036     <description>
 4037       <p>
 4038         The client uses the create_filter command to create a new filter.
 4039       </p>
 4040     </description>
 4041     <pattern>
 4042       <e>name</e>
 4043       <o><e>comment</e></o>
 4044       <o><e>copy</e></o>
 4045       <o><e>term</e></o>
 4046       <o><e>type</e></o>
 4047     </pattern>
 4048     <ele>
 4049       <name>name</name>
 4050       <summary>A name for the filter</summary>
 4051       <pattern>
 4052         <t>name</t>
 4053         <e>make_unique</e>
 4054       </pattern>
 4055       <ele>
 4056         <name>make_unique</name>
 4057         <summary>
 4058           Whether to append a unique suffix if the name already exists
 4059         </summary>
 4060         <pattern>boolean</pattern>
 4061       </ele>
 4062     </ele>
 4063     <ele>
 4064       <name>comment</name>
 4065       <summary>A comment on the filter</summary>
 4066       <pattern>
 4067         text
 4068       </pattern>
 4069     </ele>
 4070     <ele>
 4071       <name>copy</name>
 4072       <summary>The UUID of an existing filter</summary>
 4073       <pattern>
 4074         <t>uuid</t>
 4075       </pattern>
 4076     </ele>
 4077     <ele>
 4078       <name>term</name>
 4079       <summary>Filter term</summary>
 4080       <pattern>
 4081         text
 4082       </pattern>
 4083     </ele>
 4084     <ele>
 4085       <name>type</name>
 4086       <summary>Resource type</summary>
 4087       <pattern>
 4088         text
 4089       </pattern>
 4090     </ele>
 4091     <response>
 4092       <pattern>
 4093         <attrib>
 4094           <name>status</name>
 4095           <type>status</type>
 4096           <required>1</required>
 4097         </attrib>
 4098         <attrib>
 4099           <name>status_text</name>
 4100           <type>text</type>
 4101           <required>1</required>
 4102         </attrib>
 4103         <attrib>
 4104           <name>id</name>
 4105           <type>uuid</type>
 4106           <required>1</required>
 4107         </attrib>
 4108       </pattern>
 4109     </response>
 4110     <example>
 4111       <summary>Create a filter</summary>
 4112       <request>
 4113         <create_filter>
 4114           <name>Single Targets</name>
 4115           <comment>Targets with only one host</comment>
 4116           <term>ips=1 first=1 rows=-2</term>
 4117           <type>target</type>
 4118         </create_filter>
 4119       </request>
 4120       <response>
 4121         <create_filter_response status="201" status_text="OK, resource created"
 4122                                id="254cd3ef-bbe1-4d58-859d-21b8d0c046c7">
 4123         </create_filter_response>
 4124       </response>
 4125     </example>
 4126   </command>
 4127   <command>
 4128     <name>create_group</name>
 4129     <summary>Create a group</summary>
 4130     <description>
 4131       <p>
 4132         The client uses the create_group command to create a new
 4133         group.
 4134       </p>
 4135     </description>
 4136     <pattern>
 4137       <e>name</e>
 4138       <o><e>comment</e></o>
 4139       <o><e>copy</e></o>
 4140       <o><e>specials</e></o>
 4141       <o><e>users</e></o>
 4142     </pattern>
 4143     <ele>
 4144       <name>name</name>
 4145       <summary>A name for the group</summary>
 4146       <pattern><t>name</t></pattern>
 4147     </ele>
 4148     <ele>
 4149       <name>comment</name>
 4150       <summary>A comment on the group</summary>
 4151       <pattern>
 4152         text
 4153       </pattern>
 4154     </ele>
 4155     <ele>
 4156       <name>copy</name>
 4157       <summary>The UUID of an existing group</summary>
 4158       <pattern>
 4159         <t>uuid</t>
 4160       </pattern>
 4161     </ele>
 4162     <ele>
 4163       <name>specials</name>
 4164       <pattern>
 4165         <e>full</e>
 4166       </pattern>
 4167       <ele>
 4168         <name>full</name>
 4169         <summary>
 4170           Create permission giving members full access to each other's resources
 4171         </summary>
 4172         <pattern></pattern>
 4173       </ele>
 4174     </ele>
 4175     <ele>
 4176       <name>users</name>
 4177       <summary>Comma separated list of user names</summary>
 4178       <pattern>
 4179         text
 4180       </pattern>
 4181     </ele>
 4182     <response>
 4183       <pattern>
 4184         <attrib>
 4185           <name>status</name>
 4186           <type>status</type>
 4187           <required>1</required>
 4188         </attrib>
 4189         <attrib>
 4190           <name>status_text</name>
 4191           <type>text</type>
 4192           <required>1</required>
 4193         </attrib>
 4194         <attrib>
 4195           <name>id</name>
 4196           <type>uuid</type>
 4197           <required>1</required>
 4198         </attrib>
 4199       </pattern>
 4200     </response>
 4201     <example>
 4202       <summary>Create a group</summary>
 4203       <request>
 4204         <create_group>
 4205           <name>Managers</name>
 4206           <users>sarah, bob</users>
 4207         </create_group>
 4208       </request>
 4209       <response>
 4210         <create_group_response status="201"
 4211                                status_text="OK, resource created"
 4212                                id="d94211b6-ba40-11e3-bcb1-406186ea4fc5">
 4213         </create_group_response>
 4214       </response>
 4215     </example>
 4216   </command>
 4217   <command>
 4218     <name>create_note</name>
 4219     <summary>Create a note</summary>
 4220     <description>
 4221       <p>
 4222         The client uses the create_note command to create a new note.
 4223       </p>
 4224     </description>
 4225     <pattern>
 4226       <e>text</e>
 4227       <e>nvt</e>
 4228       <o><e>active</e></o>
 4229       <o><e>comment</e></o>
 4230       <o><e>copy</e></o>
 4231       <o><e>hosts</e></o>
 4232       <o><e>port</e></o>
 4233       <o><e>result</e></o>
 4234       <o><e>severity</e></o>
 4235       <o><e>task</e></o>
 4236       <o><e>threat</e></o>
 4237     </pattern>
 4238     <ele>
 4239       <name>text</name>
 4240       <summary>The text of the note</summary>
 4241       <pattern>
 4242         text
 4243       </pattern>
 4244     </ele>
 4245     <ele>
 4246       <name>nvt</name>
 4247       <summary>NVT to which note applies</summary>
 4248       <pattern>
 4249         <attrib>
 4250           <name>oid</name>
 4251           <type>oid</type>
 4252           <required>1</required>
 4253         </attrib>
 4254       </pattern>
 4255     </ele>
 4256     <ele>
 4257       <name>active</name>
 4258       <summary>Seconds note will be active.  -1 on always, 0 off</summary>
 4259       <pattern><t>integer</t></pattern>
 4260     </ele>
 4261     <ele>
 4262       <name>comment</name>
 4263       <summary>A comment on the note</summary>
 4264       <pattern>
 4265         text
 4266       </pattern>
 4267     </ele>
 4268     <ele>
 4269       <name>copy</name>
 4270       <summary>The UUID of an existing note</summary>
 4271       <pattern>
 4272         <t>uuid</t>
 4273       </pattern>
 4274     </ele>
 4275     <ele>
 4276       <name>hosts</name>
 4277       <summary>A textual list of hosts</summary>
 4278       <pattern>
 4279         text
 4280       </pattern>
 4281     </ele>
 4282     <ele>
 4283       <name>port</name>
 4284       <summary>Port to which note applies</summary>
 4285       <pattern>
 4286         text
 4287       </pattern>
 4288     </ele>
 4289     <ele>
 4290       <name>result</name>
 4291       <summary>Result to which note applies</summary>
 4292       <pattern>
 4293         <attrib>
 4294           <name>id</name>
 4295           <type>uuid</type>
 4296           <required>1</required>
 4297         </attrib>
 4298       </pattern>
 4299     </ele>
 4300     <ele>
 4301       <name>severity</name>
 4302       <summary>Severity to which note applies</summary>
 4303       <pattern>
 4304         <t>severity</t>
 4305       </pattern>
 4306     </ele>
 4307     <ele>
 4308       <name>task</name>
 4309       <summary>Task to which note applies</summary>
 4310       <pattern>
 4311         <attrib>
 4312           <name>id</name>
 4313           <type>uuid</type>
 4314           <required>1</required>
 4315         </attrib>
 4316       </pattern>
 4317     </ele>
 4318     <ele>
 4319       <name>threat</name>
 4320       <summary>
 4321         Threat level to which note applies. Will be converted to severity
 4322       </summary>
 4323       <pattern>
 4324         <t>threat</t>
 4325       </pattern>
 4326     </ele>
 4327     <response>
 4328       <pattern>
 4329         <attrib>
 4330           <name>status</name>
 4331           <type>status</type>
 4332           <required>1</required>
 4333         </attrib>
 4334         <attrib>
 4335           <name>status_text</name>
 4336           <type>text</type>
 4337           <required>1</required>
 4338         </attrib>
 4339         <attrib>
 4340           <name>id</name>
 4341           <type>uuid</type>
 4342           <required>1</required>
 4343         </attrib>
 4344       </pattern>
 4345     </response>
 4346     <example>
 4347       <summary>Create a note</summary>
 4348       <request>
 4349         <create_note>
 4350           <text>This issue should be resolved after the upgrade.</text>
 4351           <nvt oid="1.3.6.1.4.1.25623.1.0.10330"></nvt>
 4352           <result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
 4353         </create_note>
 4354       </request>
 4355       <response>
 4356         <create_note_response status="202"
 4357                               status_text="OK, resource created"
 4358                               id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 4359         </create_note_response>
 4360       </response>
 4361     </example>
 4362   </command>
 4363   <command>
 4364     <name>create_override</name>
 4365     <summary>Create an override</summary>
 4366     <description>
 4367       <p>
 4368         The client uses the create_override command to create a new override.
 4369       </p>
 4370     </description>
 4371     <pattern>
 4372       <e>text</e>
 4373       <e>nvt</e>
 4374       <o><e>active</e></o>
 4375       <o><e>comment</e></o>
 4376       <o><e>copy</e></o>
 4377       <o><e>hosts</e></o>
 4378       <o><e>new_severity</e></o>
 4379       <o><e>new_threat</e></o>
 4380       <o><e>port</e></o>
 4381       <o><e>result</e></o>
 4382       <o><e>severity</e></o>
 4383       <o><e>task</e></o>
 4384       <o><e>threat</e></o>
 4385     </pattern>
 4386     <ele>
 4387       <name>text</name>
 4388       <summary>The text of the override</summary>
 4389       <pattern>
 4390         text
 4391       </pattern>
 4392     </ele>
 4393     <ele>
 4394       <name>active</name>
 4395       <summary>Seconds override will be active.  -1 on always, 0 off</summary>
 4396       <pattern><t>integer</t></pattern>
 4397     </ele>
 4398     <ele>
 4399       <name>nvt</name>
 4400       <summary>NVT to which override applies</summary>
 4401       <pattern>
 4402         <attrib>
 4403           <name>oid</name>
 4404           <type>oid</type>
 4405           <required>1</required>
 4406         </attrib>
 4407       </pattern>
 4408     </ele>
 4409     <ele>
 4410       <name>comment</name>
 4411       <summary>A comment on the override</summary>
 4412       <pattern>
 4413         text
 4414       </pattern>
 4415     </ele>
 4416     <ele>
 4417       <name>copy</name>
 4418       <summary>The UUID of an existing override</summary>
 4419       <pattern>
 4420         <t>uuid</t>
 4421       </pattern>
 4422     </ele>
 4423     <ele>
 4424       <name>hosts</name>
 4425       <summary>A textual list of hosts</summary>
 4426       <pattern>
 4427         text
 4428       </pattern>
 4429     </ele>
 4430     <ele>
 4431       <name>new_severity</name>
 4432       <summary>New severity for result</summary>
 4433       <pattern>
 4434         <t>severity</t>
 4435       </pattern>
 4436     </ele>
 4437     <ele>
 4438       <name>new_threat</name>
 4439       <summary>
 4440         New threat level for result, will be converted to a new_severity
 4441       </summary>
 4442       <pattern>
 4443         <t>threat</t>
 4444       </pattern>
 4445     </ele>
 4446     <ele>
 4447       <name>port</name>
 4448       <summary>Port to which override applies</summary>
 4449       <pattern>
 4450         text
 4451       </pattern>
 4452     </ele>
 4453     <ele>
 4454       <name>result</name>
 4455       <summary>Result to which override applies</summary>
 4456       <pattern>
 4457         <attrib>
 4458           <name>id</name>
 4459           <type>uuid</type>
 4460           <required>1</required>
 4461         </attrib>
 4462       </pattern>
 4463     </ele>
 4464     <ele>
 4465       <name>severity</name>
 4466       <summary>Severity score to which override applies</summary>
 4467       <pattern>
 4468         <t>severity</t>
 4469       </pattern>
 4470     </ele>
 4471     <ele>
 4472       <name>task</name>
 4473       <summary>Task to which override applies</summary>
 4474       <pattern>
 4475         <attrib>
 4476           <name>id</name>
 4477           <type>uuid</type>
 4478           <required>1</required>
 4479         </attrib>
 4480       </pattern>
 4481     </ele>
 4482     <ele>
 4483       <name>threat</name>
 4484       <summary>
 4485         Threat level to which override applies, will be converted to severity
 4486       </summary>
 4487       <pattern>
 4488         <t>threat</t>
 4489       </pattern>
 4490     </ele>
 4491     <response>
 4492       <pattern>
 4493         <attrib>
 4494           <name>status</name>
 4495           <type>status</type>
 4496           <required>1</required>
 4497         </attrib>
 4498         <attrib>
 4499           <name>status_text</name>
 4500           <type>text</type>
 4501           <required>1</required>
 4502         </attrib>
 4503         <attrib>
 4504           <name>id</name>
 4505           <type>uuid</type>
 4506           <required>1</required>
 4507         </attrib>
 4508       </pattern>
 4509     </response>
 4510     <example>
 4511       <summary>Create an override</summary>
 4512       <request>
 4513         <create_override>
 4514           <text>This is actually of little concern.</text>
 4515           <nvt oid="1.3.6.1.4.1.25623.1.0.10330"></nvt>
 4516           <new_threat>Low</new_threat>
 4517           <result>254cd3ef-bbe1-4d58-859d-21b8d0c046c6</result>
 4518         </create_override>
 4519       </request>
 4520       <response>
 4521         <create_override_response status="201"
 4522                                    status_text="OK, resource created"
 4523                                    id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 4524         </create_override_response>
 4525       </response>
 4526     </example>
 4527   </command>
 4528   <command>
 4529     <name>create_permission</name>
 4530     <summary>Create a permission</summary>
 4531     <description>
 4532       <p>
 4533         The client uses the create_permission command to create a new permission.
 4534       </p>
 4535     </description>
 4536     <pattern>
 4537       <e>name</e>
 4538       <e>subject</e>
 4539       <o><e>resource</e></o>
 4540       <o><e>copy</e></o>
 4541       <o><e>comment</e></o>
 4542     </pattern>
 4543     <ele>
 4544       <name>name</name>
 4545       <summary>A permission name, currently the name of a command</summary>
 4546       <pattern>text</pattern>
 4547     </ele>
 4548     <ele>
 4549       <name>subject</name>
 4550       <summary>A subject to whom the permission is granted</summary>
 4551       <pattern>
 4552         <attrib>
 4553           <name>id</name>
 4554           <type>uuid</type>
 4555           <required>0</required>
 4556         </attrib>
 4557         <e>type</e>
 4558       </pattern>
 4559       <ele>
 4560         <name>type</name>
 4561         <summary>OMP type of the subject: user, group or role</summary>
 4562         <pattern>text</pattern>
 4563       </ele>
 4564     </ele>
 4565     <ele>
 4566       <name>resource</name>
 4567       <summary>A resource to which the permission applies</summary>
 4568       <pattern>
 4569         <attrib>
 4570           <name>id</name>
 4571           <type>uuid</type>
 4572           <required>0</required>
 4573         </attrib>
 4574         <e>type</e>
 4575       </pattern>
 4576       <ele>
 4577         <name>type</name>
 4578         <summary>OMP type, for Super permissions: user, group or role</summary>
 4579         <pattern>text</pattern>
 4580       </ele>
 4581     </ele>
 4582     <ele>
 4583       <name>copy</name>
 4584       <summary>UUID of an existing permission to copy</summary>
 4585       <pattern><t>uuid</t></pattern>
 4586     </ele>
 4587     <ele>
 4588       <name>comment</name>
 4589       <summary>Comment on the permission</summary>
 4590       <pattern>text</pattern>
 4591     </ele>
 4592     <response>
 4593       <pattern>
 4594         <attrib>
 4595           <name>status</name>
 4596           <type>status</type>
 4597           <required>1</required>
 4598         </attrib>
 4599         <attrib>
 4600           <name>status_text</name>
 4601           <type>text</type>
 4602           <required>1</required>
 4603         </attrib>
 4604         <attrib>
 4605           <name>id</name>
 4606           <type>uuid</type>
 4607           <required>1</required>
 4608         </attrib>
 4609       </pattern>
 4610     </response>
 4611     <example>
 4612       <summary>Grant a user permission to view a target</summary>
 4613       <request>
 4614         <create_permission>
 4615           <name>get_target</name>
 4616           <resource id="b493b7a8-7489-11df-a3ec-002264764cea">
 4617           </resource>
 4618           <subject id="66abe5ce-c011-11e3-b96e-406186ea4fc5">
 4619             <type>user</type>
 4620           </subject>
 4621         </create_permission>
 4622       </request>
 4623       <response>
 4624         <create_permission_response status="201"
 4625                                     status_text="OK, resource created"
 4626                                     id="7ee79232-c011-11e3-b560-406186ea4fc5">
 4627         </create_permission_response>
 4628       </response>
 4629     </example>
 4630     <example>
 4631       <summary>Grant a role permission to create users</summary>
 4632       <request>
 4633         <create_permission>
 4634           <name>create_user</name>
 4635           <subject id="9b0cbd98-c011-11e3-a26e-406186ea4fc5">
 4636             <type>role</type>
 4637           </subject>
 4638         </create_permission>
 4639       </request>
 4640       <response>
 4641         <create_permission_response status="201"
 4642                                     status_text="OK, resource created"
 4643                                     id="b98ad69c-c011-11e3-b001-406186ea4fc5">
 4644         </create_permission_response>
 4645       </response>
 4646     </example>
 4647   </command>
 4648   <command>
 4649     <name>create_port_list</name>
 4650     <summary>Create a port list</summary>
 4651     <description>
 4652       <p>
 4653         The client uses the create_port_list command to create a new port
 4654         list.
 4655       </p>
 4656       <p>
 4657         The get_port_lists_response element overrides the port_range
 4658         element.
 4659       </p>
 4660     </description>
 4661     <pattern>
 4662       <e>name</e>
 4663       <o><e>comment</e></o>
 4664       <o><e>copy</e></o>
 4665       <e>port_range</e>
 4666       <r>get_port_lists</r>
 4667     </pattern>
 4668     <ele>
 4669       <name>name</name>
 4670       <summary>The name of the port list</summary>
 4671       <pattern>
 4672         <t>name</t>
 4673       </pattern>
 4674     </ele>
 4675     <ele>
 4676       <name>comment</name>
 4677       <summary>A comment on the port list</summary>
 4678       <pattern>
 4679         text
 4680       </pattern>
 4681     </ele>
 4682     <ele>
 4683       <name>copy</name>
 4684       <summary>The UUID of an existing agent</summary>
 4685       <pattern>
 4686         <t>uuid</t>
 4687       </pattern>
 4688     </ele>
 4689     <ele>
 4690       <name>port_range</name>
 4691       <summary>
 4692         Comma or newline separated list of ranges
 4693       </summary>
 4694       <pattern>
 4695         text
 4696       </pattern>
 4697     </ele>
 4698     <response>
 4699       <pattern>
 4700         <attrib>
 4701           <name>status</name>
 4702           <type>status</type>
 4703           <required>1</required>
 4704         </attrib>
 4705         <attrib>
 4706           <name>status_text</name>
 4707           <type>text</type>
 4708           <required>1</required>
 4709         </attrib>
 4710         <attrib>
 4711           <name>id</name>
 4712           <type>uuid</type>
 4713           <required>1</required>
 4714         </attrib>
 4715       </pattern>
 4716     </response>
 4717     <example>
 4718       <summary>Create a port list</summary>
 4719       <request>
 4720         <create_port_list>
 4721           <name>All TCP</name>
 4722           <comment>All possible TCP ports</comment>
 4723           <port_range>T:1-65535</port_range>
 4724         </create_port_list>
 4725       </request>
 4726       <response>
 4727         <create_port_list_response
 4728           status="201"
 4729           status_text="OK, resource created"
 4730           id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 4731         </create_port_list_response>
 4732       </response>
 4733     </example>
 4734   </command>
 4735   <command>
 4736     <name>create_port_range</name>
 4737     <summary>Create a port range</summary>
 4738     <description>
 4739       <p>
 4740         The client uses the create_port_range command to create a new port
 4741         range.
 4742       </p>
 4743     </description>
 4744     <pattern>
 4745       <o><e>comment</e></o>
 4746       <e>port_list</e>
 4747       <e>start</e>
 4748       <e>end</e>
 4749       <e>type</e>
 4750     </pattern>
 4751     <ele>
 4752       <name>comment</name>
 4753       <summary>A comment on the port range</summary>
 4754       <pattern>
 4755         text
 4756       </pattern>
 4757     </ele>
 4758     <ele>
 4759       <name>port_list</name>
 4760       <summary>The port list to which to add the range</summary>
 4761       <pattern>
 4762         <attrib>
 4763           <name>id</name>
 4764           <type>uuid</type>
 4765           <required>1</required>
 4766         </attrib>
 4767       </pattern>
 4768     </ele>
 4769     <ele>
 4770       <name>start</name>
 4771       <summary>The first port in the range</summary>
 4772       <pattern>
 4773         <t>port</t>
 4774       </pattern>
 4775     </ele>
 4776     <ele>
 4777       <name>end</name>
 4778       <summary>The last port in the range</summary>
 4779       <pattern>
 4780         <t>port</t>
 4781       </pattern>
 4782     </ele>
 4783     <ele>
 4784       <name>type</name>
 4785       <summary>The type of the ports: TCP, UDP, ...</summary>
 4786       <pattern>
 4787         text
 4788       </pattern>
 4789     </ele>
 4790     <response>
 4791       <pattern>
 4792         <attrib>
 4793           <name>status</name>
 4794           <type>status</type>
 4795           <required>1</required>
 4796         </attrib>
 4797         <attrib>
 4798           <name>status_text</name>
 4799           <type>text</type>
 4800           <required>1</required>
 4801         </attrib>
 4802         <attrib>
 4803           <name>id</name>
 4804           <type>uuid</type>
 4805           <required>1</required>
 4806         </attrib>
 4807       </pattern>
 4808     </response>
 4809     <example>
 4810       <summary>Add a port range to a port list</summary>
 4811       <request>
 4812         <create_port_range>
 4813           <port_list id="354cd3ef-bbe1-4d58-859d-21b8d0c046c4">
 4814           </port_list>
 4815           <start>777</start>
 4816           <end>779</end>
 4817           <type>TCP</type>
 4818         </create_port_range>
 4819       </request>
 4820       <response>
 4821         <create_port_range_response
 4822           status="201"
 4823           status_text="OK, resource created"
 4824           id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 4825         </create_port_range_response>
 4826       </response>
 4827     </example>
 4828   </command>
 4829   <command>
 4830     <name>create_report</name>
 4831     <summary>Create a report</summary>
 4832     <description>
 4833       <p>
 4834         The client uses the create_report command to import a report.
 4835       </p>
 4836     </description>
 4837     <pattern>
 4838       <e>report</e>
 4839       <e>task</e>
 4840       <o><e>in_assets</e></o>
 4841     </pattern>
 4842     <ele>
 4843       <name>report</name>
 4844       <summary>A report wrapper, as in the GET_REPORTS response</summary>
 4845       <type>report</type>
 4846     </ele>
 4847     <ele>
 4848       <name>task</name>
 4849       <summary>
 4850         Task for report: id to use existing task, name to create new task
 4851       </summary>
 4852       <pattern>
 4853         <attrib>
 4854           <name>id</name>
 4855           <type>uuid</type>
 4856           <required>0</required>
 4857         </attrib>
 4858         <o><e>name</e></o>
 4859         <o><e>comment</e></o>
 4860       </pattern>
 4861       <ele>
 4862         <name>name</name>
 4863         <summary>The name of the task</summary>
 4864         <pattern><t>name</t></pattern>
 4865       </ele>
 4866       <ele>
 4867         <name>comment</name>
 4868         <summary>Comment for the new task</summary>
 4869         <pattern>text</pattern>
 4870       </ele>
 4871     </ele>
 4872     <ele>
 4873       <name>in_assets</name>
 4874       <summary>Whether to create or update assets using the report</summary>
 4875       <type>boolean</type>
 4876     </ele>
 4877     <response>
 4878       <pattern>
 4879         <attrib>
 4880           <name>status</name>
 4881           <type>status</type>
 4882           <required>1</required>
 4883         </attrib>
 4884         <attrib>
 4885           <name>status_text</name>
 4886           <type>text</type>
 4887           <required>1</required>
 4888         </attrib>
 4889         <attrib>
 4890           <name>id</name>
 4891           <type>uuid</type>
 4892           <required>1</required>
 4893         </attrib>
 4894       </pattern>
 4895     </response>
 4896     <example>
 4897       <summary>Create a report in an existing task</summary>
 4898       <request>
 4899         <create_report>
 4900           <report id="f0fdf522-276d-4893-9274-fb8699dc2270"
 4901                   format_id="d5da9f67-8551-4e51-807b-b6a873d70e34"
 4902                   extension="xml"
 4903                   content_type="text/xml">
 4904             <report id="f0fdf522-276d-4893-9274-fb8699dc2270">
 4905               <omp>
 4906                 <version>7.0</version>
 4907               </omp>
 4908               <truncated>...</truncated>
 4909               <results start="1" max="-1">
 4910                 <result id="634f7a2e-8ca1-43b7-b6d7-0d4841449508">
 4911                   <truncated>...</truncated>
 4912                 </result>
 4913                 <truncated>...</truncated>
 4914               </results>
 4915               <host_start>2010-02-02T19:11:21+00:00<host>127.0.1.1</host></host_start>
 4916               <host_end>2010-02-02T19:11:52+00:00<host>127.0.1.1</host></host_end>
 4917               <scan_end>2010-02-02T19:11:52+00:00</scan_end>
 4918               <errors>
 4919                 <count>0</count>
 4920               </errors>
 4921             </report>
 4922           </report>
 4923           <task id="76a4f237-9984-4345-a1f4-71fbcbf0611c"/>
 4924         </create_report>
 4925       </request>
 4926       <response>
 4927         <create_report_response status="201"
 4928                                 status_text="OK, resource created"
 4929                                 id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 4930         </create_report_response>
 4931       </response>
 4932     </example>
 4933   </command>
 4934   <command>
 4935     <name>create_report_format</name>
 4936     <summary>Create a report format</summary>
 4937     <description>
 4938       <p>
 4939         The client uses the create_report_format command to create a new report
 4940         format.
 4941       </p>
 4942     </description>
 4943     <pattern>
 4944       <or>
 4945         <e>copy</e>
 4946         <r>get_report_formats</r>
 4947       </or>
 4948     </pattern>
 4949     <ele>
 4950       <name>copy</name>
 4951       <summary>The UUID of an existing report format</summary>
 4952       <pattern>
 4953         <t>uuid</t>
 4954       </pattern>
 4955     </ele>
 4956     <response>
 4957       <pattern>
 4958         <attrib>
 4959           <name>status</name>
 4960           <type>status</type>
 4961           <required>1</required>
 4962         </attrib>
 4963         <attrib>
 4964           <name>status_text</name>
 4965           <type>text</type>
 4966           <required>1</required>
 4967         </attrib>
 4968         <attrib>
 4969           <name>id</name>
 4970           <type>uuid</type>
 4971           <required>1</required>
 4972         </attrib>
 4973       </pattern>
 4974     </response>
 4975     <example>
 4976       <summary>Create a report format</summary>
 4977       <request>
 4978         <create_report_format>
 4979           <get_report_formats_response>
 4980             <report_format id="a0704abb-2120-489f-959f-251c9f4ffebd">
 4981               <name>CPE</name>
 4982               <extension>csv</extension>
 4983               <content_type>text/csv</content_type>
 4984               <summary>Common Product Enumeration CSV table.</summary>
 4985               <description>
 4986                 CPE stands for Common Product Enumeration.  It is a
 4987                 <truncated>...</truncated>
 4988               </description>
 4989               <predefined>1</predefined>
 4990               <trust>
 4991                 yes
 4992                 <time>Thu Dec  2 13:22:26 2010</time>
 4993               </trust>
 4994               <active>1</active>
 4995             </report_format>
 4996           </get_report_formats_response>
 4997         </create_report_format>
 4998       </request>
 4999       <response>
 5000         <create_report_format_response status="201"
 5001                                       status_text="OK, resource created"
 5002                                       id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 5003         </create_report_format_response>
 5004       </response>
 5005     </example>
 5006   </command>
 5007   <command>
 5008     <name>create_role</name>
 5009     <summary>Create a role</summary>
 5010     <description>
 5011       <p>
 5012         The client uses the create_role command to create a new
 5013         role.
 5014       </p>
 5015     </description>
 5016     <pattern>
 5017       <e>name</e>
 5018       <o><e>comment</e></o>
 5019       <o><e>copy</e></o>
 5020       <o><e>users</e></o>
 5021     </pattern>
 5022     <ele>
 5023       <name>name</name>
 5024       <summary>A name for the role</summary>
 5025       <pattern><t>name</t></pattern>
 5026     </ele>
 5027     <ele>
 5028       <name>comment</name>
 5029       <summary>A comment on the role</summary>
 5030       <pattern>
 5031         text
 5032       </pattern>
 5033     </ele>
 5034     <ele>
 5035       <name>copy</name>
 5036       <summary>The UUID of an existing role</summary>
 5037       <pattern>
 5038         <t>uuid</t>
 5039       </pattern>
 5040     </ele>
 5041     <ele>
 5042       <name>users</name>
 5043       <summary>Comma separated list of user names</summary>
 5044       <pattern>
 5045         text
 5046       </pattern>
 5047     </ele>
 5048     <response>
 5049       <pattern>
 5050         <attrib>
 5051           <name>status</name>
 5052           <type>status</type>
 5053           <required>1</required>
 5054         </attrib>
 5055         <attrib>
 5056           <name>status_text</name>
 5057           <type>text</type>
 5058           <required>1</required>
 5059         </attrib>
 5060         <attrib>
 5061           <name>id</name>
 5062           <type>uuid</type>
 5063           <required>1</required>
 5064         </attrib>
 5065       </pattern>
 5066     </response>
 5067     <example>
 5068       <summary>Create a role</summary>
 5069       <request>
 5070         <create_role>
 5071           <name>SCAP Observer</name>
 5072           <users>sarah, bob</users>
 5073         </create_role>
 5074       </request>
 5075       <response>
 5076         <create_role_response status="201"
 5077                                status_text="OK, resource created"
 5078                                id="b64c81b2-b9de-11e3-a2e9-406186ea4fc5">
 5079         </create_role_response>
 5080       </response>
 5081     </example>
 5082   </command>
 5083   <command>
 5084     <name>create_scanner</name>
 5085     <summary>Create a scanner</summary>
 5086     <description>
 5087       <p>
 5088         The client uses the create_scanner command to create a new scanner.
 5089       </p>
 5090     </description>
 5091     <pattern>
 5092       <e>name</e>
 5093       <o><e>comment</e></o>
 5094       <o><e>copy</e></o>
 5095       <e>host</e>
 5096       <e>port</e>
 5097       <e>type</e>
 5098       <e>ca_pub</e>
 5099       <e>credential</e>
 5100     </pattern>
 5101     <ele>
 5102       <name>name</name>
 5103       <summary>A name for the scanner</summary>
 5104       <pattern><t>name</t></pattern>
 5105     </ele>
 5106     <ele>
 5107       <name>comment</name>
 5108       <summary>A comment on the scanner</summary>
 5109       <pattern>text</pattern>
 5110     </ele>
 5111     <ele>
 5112       <name>copy</name>
 5113       <summary>The UUID of an existing scanner</summary>
 5114       <pattern><t>uuid</t></pattern>
 5115     </ele>
 5116     <ele>
 5117       <name>host</name>
 5118       <summary>The host of the scanner</summary>
 5119       <pattern>text</pattern>
 5120     </ele>
 5121     <ele>
 5122       <name>port</name>
 5123       <summary>The port of the scanner</summary>
 5124       <pattern>text</pattern>
 5125     </ele>
 5126     <ele>
 5127       <name>type</name>
 5128       <summary>The type of the scanner</summary>
 5129       <description>
 5130         <p>Type value of '1' for OSP, '2' for OpenVAS (classic) Scanner.</p>
 5131       </description>
 5132       <pattern>text</pattern>
 5133     </ele>
 5134     <ele>
 5135       <name>ca_pub</name>
 5136       <summary>Certificate of CA to verify scanner certificate.</summary>
 5137       <pattern>text</pattern>
 5138     </ele>
 5139     <ele>
 5140       <name>credential</name>
 5141       <summary>Client certificate credential for the Scanner</summary>
 5142       <pattern>
 5143         <attrib>
 5144           <name>id</name>
 5145           <type>uuid</type>
 5146           <summary>UUID of the credential</summary>
 5147           <required>1</required>
 5148         </attrib>
 5149       </pattern>
 5150     </ele>
 5151     <response>
 5152       <pattern>
 5153         <attrib>
 5154           <name>status</name>
 5155           <type>status</type>
 5156           <required>1</required>
 5157         </attrib>
 5158         <attrib>
 5159           <name>status_text</name>
 5160           <type>text</type>
 5161           <required>1</required>
 5162         </attrib>
 5163         <attrib>
 5164           <name>id</name>
 5165           <type>uuid</type>
 5166           <required>1</required>
 5167         </attrib>
 5168       </pattern>
 5169     </response>
 5170     <example>
 5171       <summary>Create a scanner</summary>
 5172       <request>
 5173         <create_scanner>
 5174           <name>Default Scanner</name>
 5175           <host>localhost</host>
 5176           <port>9391</port>
 5177           <type>2</type>
 5178           <ca_pub>...</ca_pub>
 5179           <credential id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6"/>
 5180         </create_scanner>
 5181       </request>
 5182       <response>
 5183         <create_scanner_response status="201" status_text="OK, resource created"
 5184                                  id="814cd30f-dee1-4d58-851d-21b8d0c048e3">
 5185         </create_scanner_response>
 5186       </response>
 5187     </example>
 5188   </command>
 5189   <command>
 5190     <name>create_schedule</name>
 5191     <summary>Create a schedule</summary>
 5192     <description>
 5193       <p>
 5194         The client uses the create_schedule command to create a new schedule.
 5195       </p>
 5196     </description>
 5197     <pattern>
 5198       <e>name</e>
 5199       <o><e>comment</e></o>
 5200       <o><e>copy</e></o>
 5201       <o><e>first_time</e></o>
 5202       <o><e>duration</e></o>
 5203       <o><e>period</e></o>
 5204       <o><e>timezone</e></o>
 5205     </pattern>
 5206     <ele>
 5207       <name>name</name>
 5208       <summary>A name for the schedule</summary>
 5209       <pattern><t>name</t></pattern>
 5210     </ele>
 5211     <ele>
 5212       <name>comment</name>
 5213       <summary>A comment on the schedule</summary>
 5214       <pattern>
 5215         text
 5216       </pattern>
 5217     </ele>
 5218     <ele>
 5219       <name>copy</name>
 5220       <summary>The UUID of an existing schedule</summary>
 5221       <pattern>
 5222         <t>uuid</t>
 5223       </pattern>
 5224     </ele>
 5225     <ele>
 5226       <name>first_time</name>
 5227       <summary>The first time the schedule will run</summary>
 5228       <pattern>
 5229         <e>minute</e>
 5230         <e>hour</e>
 5231         <e>day_of_month</e>
 5232         <e>month</e>
 5233         <e>year</e>
 5234       </pattern>
 5235       <ele>
 5236         <name>minute</name>
 5237         <pattern><t>integer</t></pattern>
 5238       </ele>
 5239       <ele>
 5240         <name>hour</name>
 5241         <pattern><t>integer</t></pattern>
 5242       </ele>
 5243       <ele>
 5244         <name>day_of_month</name>
 5245         <pattern><t>integer</t></pattern>
 5246       </ele>
 5247       <ele>
 5248         <name>month</name>
 5249         <pattern><t>integer</t></pattern>
 5250       </ele>
 5251       <ele>
 5252         <name>year</name>
 5253         <pattern><t>integer</t></pattern>
 5254       </ele>
 5255     </ele>
 5256     <ele>
 5257       <name>duration</name>
 5258       <summary>How long the Manager will run the scheduled task for</summary>
 5259       <description>A duration of 0 means to run to completion.</description>
 5260       <pattern>
 5261         <e>unit</e>
 5262       </pattern>
 5263       <ele>
 5264         <name>unit</name>
 5265         <summary>Duration time unit</summary>
 5266         <pattern><t>time_unit</t></pattern>
 5267       </ele>
 5268     </ele>
 5269     <ele>
 5270       <name>period</name>
 5271       <summary>How often the Manager will repeat the scheduled task</summary>
 5272       <description>A period of 0 means to run once.</description>
 5273       <pattern>
 5274         <e>unit</e>
 5275       </pattern>
 5276       <ele>
 5277         <name>unit</name>
 5278         <summary>Period time unit</summary>
 5279         <pattern><t>time_unit</t></pattern>
 5280       </ele>
 5281     </ele>
 5282     <ele>
 5283       <name>timezone</name>
 5284       <summary>The timezone the schedule will follow</summary>
 5285       <pattern>timezone</pattern>
 5286     </ele>
 5287     <response>
 5288       <pattern>
 5289         <attrib>
 5290           <name>status</name>
 5291           <type>status</type>
 5292           <required>1</required>
 5293         </attrib>
 5294         <attrib>
 5295           <name>status_text</name>
 5296           <type>text</type>
 5297           <required>1</required>
 5298         </attrib>
 5299         <attrib>
 5300           <name>id</name>
 5301           <type>uuid</type>
 5302           <required>1</required>
 5303         </attrib>
 5304       </pattern>
 5305     </response>
 5306     <example>
 5307       <summary>Create a schedule</summary>
 5308       <request>
 5309         <create_schedule>
 5310           <name>Every night</name>
 5311           <first_time>
 5312             <day_of_month>1</day_of_month>
 5313             <hour>0</hour>
 5314             <minute>0</minute>
 5315             <month>1</month>
 5316             <year>2011</year>
 5317           </first_time>
 5318           <duration>
 5319             3
 5320             <unit>hour</unit>
 5321           </duration>
 5322           <period>
 5323             1
 5324             <unit>day</unit>
 5325           </period>
 5326         </create_schedule>
 5327       </request>
 5328       <response>
 5329         <create_schedule_response status="201"
 5330                                    status_text="OK, resource created"
 5331                                    id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 5332         </create_schedule_response>
 5333       </response>
 5334     </example>
 5335   </command>
 5336   <command>
 5337     <name>create_tag</name>
 5338     <summary>Create a tag</summary>
 5339     <description>
 5340       <p>
 5341         The client uses the create_tag command to create a new tag.
 5342         A name and the resource type must be provided. If a resource ID is
 5343         also given, it must refer to an existing resource.
 5344       </p>
 5345     </description>
 5346     <pattern>
 5347       <e>name</e>
 5348       <e>resource</e>
 5349       <o><e>copy</e></o>
 5350       <o><e>value</e></o>
 5351       <o><e>comment</e></o>
 5352       <o><e>active</e></o>
 5353     </pattern>
 5354     <ele>
 5355       <name>name</name>
 5356       <summary>A full tag name consisting of namespace and predicate</summary>
 5357       <pattern>text</pattern>
 5358     </ele>
 5359     <ele>
 5360       <name>resource</name>
 5361       <summary>Identifies a resource the tag is to be attached to</summary>
 5362       <pattern>
 5363         <attrib>
 5364           <name>id</name>
 5365           <summary>ID of the resource the tag is to be attached to</summary>
 5366           <type>uuid</type>
 5367           <required>0</required>
 5368         </attrib>
 5369         <e>type</e>
 5370       </pattern>
 5371       <ele>
 5372         <name>type</name>
 5373         <summary>OMP type of the resource the tag is to be attached to</summary>
 5374         <pattern>text</pattern>
 5375       </ele>
 5376     </ele>
 5377     <ele>
 5378       <name>copy</name>
 5379       <summary>UUID of an existing tag to copy</summary>
 5380       <pattern><t>uuid</t></pattern>
 5381     </ele>
 5382     <ele>
 5383       <name>value</name>
 5384       <summary>Value associated with the tag</summary>
 5385       <pattern>text</pattern>
 5386     </ele>
 5387     <ele>
 5388       <name>comment</name>
 5389       <summary>Comment to add to the tag</summary>
 5390       <pattern>text</pattern>
 5391     </ele>
 5392     <ele>
 5393       <name>active</name>
 5394       <summary>Whether the tag is active</summary>
 5395       <pattern>boolean</pattern>
 5396     </ele>
 5397     <response>
 5398       <pattern>
 5399         <attrib>
 5400           <name>status</name>
 5401           <type>status</type>
 5402           <required>1</required>
 5403         </attrib>
 5404         <attrib>
 5405           <name>status_text</name>
 5406           <type>text</type>
 5407           <required>1</required>
 5408         </attrib>
 5409         <attrib>
 5410           <name>id</name>
 5411           <type>uuid</type>
 5412           <required>1</required>
 5413         </attrib>
 5414       </pattern>
 5415     </response>
 5416     <example>
 5417       <summary>Create a tag attached to a target</summary>
 5418       <request>
 5419         <create_tag>
 5420           <name>geo:long</name>
 5421           <resource id="b493b7a8-7489-11df-a3ec-002264764cea">
 5422             <type>target</type>
 5423           </resource>
 5424           <value>52.2788</value>
 5425         </create_tag>
 5426       </request>
 5427       <response>
 5428         <create_tag_response status="201"
 5429                              status_text="OK, resource created"
 5430                              id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 5431         </create_tag_response>
 5432       </response>
 5433     </example>
 5434   </command>
 5435   <command>
 5436     <name>create_target</name>
 5437     <summary>Create a target</summary>
 5438     <description>
 5439       <p>
 5440         The client uses the create_target command to create a new target.
 5441       </p>
 5442       <p>
 5443         If the list of hosts is empty, the command must also include a
 5444         target locator.
 5445       </p>
 5446     </description>
 5447     <pattern>
 5448       <e>name</e>
 5449       <o><e>comment</e></o>
 5450       <o><e>copy</e></o>
 5451       <or>
 5452         <e>asset_hosts</e>
 5453         <e>hosts</e>
 5454       </or>
 5455       <o><e>exclude_hosts</e></o>
 5456       <o><e>ssh_credential</e></o>
 5457       <o><e>smb_credential</e></o>
 5458       <o><e>esxi_credential</e></o>
 5459       <o><e>snmp_credential</e></o>
 5460       <o><e>ssh_lsc_credential</e></o>
 5461       <o><e>smb_lsc_credential</e></o>
 5462       <o><e>esxi_lsc_credential</e></o>
 5463       <o><e>alive_tests</e></o>
 5464       <o><e>reverse_lookup_only</e></o>
 5465       <o><e>reverse_lookup_unify</e></o>
 5466       <o><e>port_range</e></o>
 5467       <o><e>port_list</e></o>
 5468     </pattern>
 5469     <ele>
 5470       <name>name</name>
 5471       <summary>A name for the target</summary>
 5472       <pattern>
 5473         <t>name</t>
 5474         <e>make_unique</e>
 5475       </pattern>
 5476       <ele>
 5477         <name>make_unique</name>
 5478         <summary>
 5479           Whether to append a unique suffix if the name already exists
 5480         </summary>
 5481         <pattern>boolean</pattern>
 5482       </ele>
 5483     </ele>
 5484     <ele>
 5485       <name>comment</name>
 5486       <summary>A comment on the target</summary>
 5487       <pattern>
 5488         text
 5489       </pattern>
 5490     </ele>
 5491     <ele>
 5492       <name>copy</name>
 5493       <summary>The UUID of an existing target</summary>
 5494       <pattern>
 5495         <t>uuid</t>
 5496       </pattern>
 5497     </ele>
 5498     <ele>
 5499       <name>asset_hosts</name>
 5500       <summary>Hosts from which to create the target</summary>
 5501       <pattern>
 5502         <attrib>
 5503           <name>filter</name>
 5504           <type>text</type>
 5505           <summary>Filter term that defines the list of hosts</summary>
 5506           <required>1</required>
 5507         </attrib>
 5508       </pattern>
 5509     </ele>
 5510     <ele>
 5511       <name>hosts</name>
 5512       <summary>A textual list of hosts, which may be empty</summary>
 5513       <pattern>
 5514         text
 5515       </pattern>
 5516     </ele>
 5517     <ele>
 5518       <name>exclude_hosts</name>
 5519       <summary>A list of hosts to exclude</summary>
 5520       <pattern>
 5521         text
 5522       </pattern>
 5523     </ele>
 5524     <ele>
 5525       <name>ssh_credential</name>
 5526       <summary>SSH login credentials for target</summary>
 5527       <pattern>
 5528         <attrib>
 5529           <name>id</name>
 5530           <type>uuid</type>
 5531           <required>1</required>
 5532         </attrib>
 5533         <o><e>port</e></o>
 5534       </pattern>
 5535       <ele>
 5536         <name>port</name>
 5537         <summary>The port the LSCs will use</summary>
 5538         <pattern>text</pattern>
 5539       </ele>
 5540     </ele>
 5541     <ele>
 5542       <name>smb_credential</name>
 5543       <summary>SMB login credentials for target</summary>
 5544       <pattern>
 5545         <attrib>
 5546           <name>id</name>
 5547           <type>uuid</type>
 5548           <required>1</required>
 5549         </attrib>
 5550       </pattern>
 5551     </ele>
 5552     <ele>
 5553       <name>esxi_credential</name>
 5554       <summary>ESXi credential to use on target</summary>
 5555       <pattern>
 5556         <attrib>
 5557           <name>id</name>
 5558           <type>uuid</type>
 5559           <required>1</required>
 5560         </attrib>
 5561       </pattern>
 5562     </ele>
 5563     <ele>
 5564       <name>snmp_credential</name>
 5565       <summary>SNMP credentials to use on target</summary>
 5566       <pattern>
 5567         <attrib>
 5568           <name>id</name>
 5569           <type>uuid</type>
 5570           <required>1</required>
 5571         </attrib>
 5572       </pattern>
 5573     </ele>
 5574     <ele>
 5575       <name>ssh_lsc_credential</name>
 5576       <summary>Deprecated: use ssh_credential. SSH credential</summary>
 5577       <pattern>
 5578         <attrib>
 5579           <name>id</name>
 5580           <type>uuid</type>
 5581           <required>1</required>
 5582         </attrib>
 5583         <o><e>port</e></o>
 5584       </pattern>
 5585       <ele>
 5586         <name>port</name>
 5587         <summary>The port the LSCs will use</summary>
 5588         <pattern>text</pattern>
 5589       </ele>
 5590     </ele>
 5591     <ele>
 5592       <name>smb_lsc_credential</name>
 5593       <summary>Deprecated: use ssh_credential. SMB credential</summary>
 5594       <pattern>
 5595         <attrib>
 5596           <name>id</name>
 5597           <type>uuid</type>
 5598           <required>1</required>
 5599         </attrib>
 5600       </pattern>
 5601     </ele>
 5602     <ele>
 5603       <name>esxi_lsc_credential</name>
 5604       <summary>Deprecated: use esxi_credential. ESXi credential</summary>
 5605       <pattern>
 5606         <attrib>
 5607           <name>id</name>
 5608           <type>uuid</type>
 5609           <required>1</required>
 5610         </attrib>
 5611       </pattern>
 5612     </ele>
 5613     <ele>
 5614       <name>alive_tests</name>
 5615       <summary>Which alive tests to use</summary>
 5616       <pattern>
 5617         <t>alive_test</t>
 5618       </pattern>
 5619     </ele>
 5620     <ele>
 5621       <name>reverse_lookup_only</name>
 5622       <summary>Whether to scan only hosts that have names</summary>
 5623       <pattern><t>boolean</t></pattern>
 5624     </ele>
 5625     <ele>
 5626       <name>reverse_lookup_unify</name>
 5627       <summary>
 5628         Whether to scan only one IP when multiple IPs have the same name
 5629       </summary>
 5630       <pattern><t>boolean</t></pattern>
 5631     </ele>
 5632     <ele>
 5633       <name>port_range</name>
 5634       <summary>Port range for the target</summary>
 5635       <pattern>text</pattern>
 5636     </ele>
 5637     <ele>
 5638       <name>port_list</name>
 5639       <summary>Port list for the target</summary>
 5640       <description>Overrides port_range.</description>
 5641       <pattern>
 5642         <attrib>
 5643           <name>id</name>
 5644           <type>uuid</type>
 5645           <required>1</required>
 5646         </attrib>
 5647       </pattern>
 5648     </ele>
 5649     <response>
 5650       <pattern>
 5651         <attrib>
 5652           <name>status</name>
 5653           <type>status</type>
 5654           <required>1</required>
 5655         </attrib>
 5656         <attrib>
 5657           <name>status_text</name>
 5658           <type>text</type>
 5659           <required>1</required>
 5660         </attrib>
 5661         <attrib>
 5662           <name>id</name>
 5663           <type>uuid</type>
 5664           <required>1</required>
 5665         </attrib>
 5666       </pattern>
 5667     </response>
 5668     <example>
 5669       <summary>Create a target, giving a host list</summary>
 5670       <request>
 5671         <create_target>
 5672           <name>All GNU/Linux machines</name>
 5673           <hosts>192.168.1.0/24</hosts>
 5674         </create_target>
 5675       </request>
 5676       <response>
 5677         <create_target_response status="201"
 5678                                 status_text="OK, resource created"
 5679                                 id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 5680         </create_target_response>
 5681       </response>
 5682     </example>
 5683   </command>
 5684   <command>
 5685     <name>create_task</name>
 5686     <summary>Create a task</summary>
 5687     <description>
 5688       <p>
 5689         The client uses the create_task command to create a new task.
 5690       </p>
 5691     </description>
 5692     <pattern>
 5693       <e>name</e>
 5694       <o><e>comment</e></o>
 5695       <o><e>copy</e></o>
 5696       <o><e>alterable</e></o>
 5697       <e>config</e>
 5698       <e>target</e>
 5699       <o><e>hosts_ordering</e></o>
 5700       <e>scanner</e>
 5701       <any><e>alert</e></any>
 5702       <o><e>schedule</e></o>
 5703       <o><e>schedule_periods</e></o>
 5704       <o><e>observers</e></o>
 5705       <o><e>preferences</e></o>
 5706     </pattern>
 5707     <ele>
 5708       <name>name</name>
 5709       <summary>A name for the task</summary>
 5710       <pattern><t>name</t></pattern>
 5711     </ele>
 5712     <ele>
 5713       <name>comment</name>
 5714       <summary>A comment on the task</summary>
 5715       <pattern>
 5716         text
 5717       </pattern>
 5718     </ele>
 5719     <ele>
 5720       <name>copy</name>
 5721       <summary>The UUID of an existing task</summary>
 5722       <pattern>
 5723         <t>uuid</t>
 5724       </pattern>
 5725     </ele>
 5726     <ele>
 5727       <name>alterable</name>
 5728       <summary>Whether the task is alterable</summary>
 5729       <pattern><t>boolean</t></pattern>
 5730     </ele>
 5731     <ele>
 5732       <name>config</name>
 5733       <summary>The scan configuration used by the task</summary>
 5734       <pattern>
 5735         <attrib>
 5736           <name>id</name>
 5737           <type>uuid</type>
 5738           <required>1</required>
 5739         </attrib>
 5740       </pattern>
 5741     </ele>
 5742     <ele>
 5743       <name>target</name>
 5744       <summary>The hosts scanned by the task</summary>
 5745       <pattern>
 5746         <attrib>
 5747           <name>id</name>
 5748           <type>uuid</type>
 5749           <required>1</required>
 5750         </attrib>
 5751       </pattern>
 5752     </ele>
 5753     <ele>
 5754       <name>hosts_ordering</name>
 5755       <summary>The order hosts are scanned in</summary>
 5756       <pattern>text</pattern>
 5757     </ele>
 5758     <ele>
 5759       <name>scanner</name>
 5760       <summary>The scanner to use for scanning the target</summary>
 5761       <pattern>
 5762         <attrib>
 5763           <name>id</name>
 5764           <type>uuid</type>
 5765           <required>1</required>
 5766         </attrib>
 5767       </pattern>
 5768     </ele>
 5769     <ele>
 5770       <name>alert</name>
 5771       <summary>An alert that applies to the task</summary>
 5772       <pattern>
 5773         <attrib>
 5774           <name>id</name>
 5775           <type>uuid</type>
 5776           <required>1</required>
 5777         </attrib>
 5778       </pattern>
 5779     </ele>
 5780     <ele>
 5781       <name>schedule</name>
 5782       <summary>When the task will run</summary>
 5783       <pattern>
 5784         <attrib>
 5785           <name>id</name>
 5786           <type>uuid</type>
 5787           <required>1</required>
 5788         </attrib>
 5789       </pattern>
 5790     </ele>
 5791     <ele>
 5792       <name>schedule_periods</name>
 5793       <summary>
 5794         A limit to the number of times the task will be scheduled, or 0 for no limit
 5795       </summary>
 5796       <pattern>
 5797         <t>integer</t>
 5798       </pattern>
 5799     </ele>
 5800     <ele>
 5801       <name>observers</name>
 5802       <summary>Users allowed to observe this task</summary>
 5803       <pattern><t>user_list</t></pattern>
 5804     </ele>
 5805     <ele>
 5806       <name>preferences</name>
 5807       <pattern>
 5808         <any><e>preference</e></any>
 5809       </pattern>
 5810       <ele>
 5811         <name>preference</name>
 5812         <pattern>
 5813           <e>scanner_name</e>
 5814           <e>value</e>
 5815         </pattern>
 5816         <ele>
 5817           <name>scanner_name</name>
 5818           <summary>Compact name of preference, from scanner</summary>
 5819           <pattern>text</pattern>
 5820         </ele>
 5821         <ele>
 5822           <name>value</name>
 5823           <pattern>text</pattern>
 5824         </ele>
 5825       </ele>
 5826     </ele>
 5827     <response>
 5828       <pattern>
 5829         <attrib>
 5830           <name>status</name>
 5831           <type>status</type>
 5832           <required>1</required>
 5833         </attrib>
 5834         <attrib>
 5835           <name>status_text</name>
 5836           <type>text</type>
 5837           <required>1</required>
 5838         </attrib>
 5839         <attrib>
 5840           <name>id</name>
 5841           <type>uuid</type>
 5842           <required>1</required>
 5843         </attrib>
 5844       </pattern>
 5845     </response>
 5846     <example>
 5847       <summary>Create a task, giving a host list</summary>
 5848       <request>
 5849         <create_task>
 5850           <name>Scan Webserver</name>
 5851           <comment>Hourly scan of the webserver</comment>
 5852           <config id="daba56c8-73ec-11df-a475-002264764cea"/>
 5853           <target id="b493b7a8-7489-11df-a3ec-002264764cea"/>
 5854           <scanner id="15348381-3180-213f-4eec-123591912388"/>
 5855         </create_task>
 5856       </request>
 5857       <response>
 5858         <create_task_response status="201"
 5859                               status_text="OK, resource created"
 5860                               id="254cd3ef-bbe1-4d58-859d-21b8d0c046c6">
 5861         </create_task_response>
 5862       </response>
 5863     </example>
 5864   </command>
 5865   <command>
 5866     <name>create_user</name>
 5867     <summary>Create a user</summary>
 5868     <description>
 5869       <p>
 5870         The client uses the create_user command to create a new user.
 5871       </p>
 5872     </description>
 5873     <pattern>
 5874       <e>name</e>
 5875       <o><e>copy</e></o>
 5876       <o><e>hosts</e></o>
 5877       <o><e>ifaces</e></o>
 5878       <o><e>password</e></o>
 5879       <any><e>role</e></any>
 5880     </pattern>
 5881     <ele>
 5882       <name>name</name>
 5883       <summary>The name of the user to be created</summary>
 5884       <pattern>text</pattern>
 5885     </ele>
 5886     <ele>
 5887       <name>copy</name>
 5888       <summary>The UUID of an existing user</summary>
 5889       <pattern>
 5890         <t>uuid</t>
 5891       </pattern>
 5892     </ele>
 5893     <ele>
 5894       <name>hosts</name>
 5895       <summary>User access rules: a textual list of hosts</summary>
 5896       <pattern>
 5897         <attrib>
 5898           <name>allow</name>
 5899           <summary>If 1, allow only listed, otherwise forbid listed</summary>
 5900           <type>boolean</type>
 5901         </attrib>
 5902         text
 5903       </pattern>
 5904     </ele>
 5905     <ele>
 5906       <name>ifaces</name>
 5907       <summary>User access rules: a textual list of ifaces</summary>
 5908       <pattern>
 5909         <attrib>
 5910           <name>allow</name>
 5911           <summary>If 1, allow only listed, otherwise forbid listed</summary>
 5912           <type>boolean</type>
 5913         </attrib>
 5914         text
 5915       </pattern>
 5916     </ele>
 5917     <ele>
 5918       <name>password</name>
 5919       <summary>The password for the user</summary>
 5920       <pattern>text</pattern>
 5921     </ele>
 5922     <ele>
 5923       <name>role</name>
 5924       <summary>A role of the user</summary>
 5925       <pattern>
 5926         <attrib>
 5927           <name>id</name>
 5928           <type>uuid</type>
 5929           <required>1</required>
 5930         </attrib>
 5931       </pattern>
 5932     </ele>
 5933     <response>
 5934       <pattern>
 5935         <attrib>
 5936           <name>status</name>
 5937           <type>status</type>
 5938           <required>1</required>
 5939         </attrib>
 5940         <attrib>
 5941           <name>status_text</name>
 5942           <type>text</type>
 5943           <required>1</required>
 5944         </attrib>
 5945         <attrib>
 5946           <name>id</name>
 5947           <type>uuid</type>
 5948           <required>1</required>
 5949         </attrib>
 5950       </pattern>
 5951     </response>
 5952     <example>
 5953       <summary>Create a user</summary>
 5954       <request>
 5955         <create_user>
 5956           <name>foobar</name>
 5957           <password>f00bar</password>
 5958           <role id="8d453140-b74d-11e2-b0be-406186ea4fc5"></role>
 5959         </create_user>
 5960       </request>
 5961       <response>
 5962         <create_user_response status="201" status_text="OK, resource created"/>
 5963       </response>
 5964     </example>
 5965   </command>
 5966   <command>
 5967     <name>delete_agent</name>
 5968     <summary>Delete an agent</summary>
 5969     <description>
 5970       <p>
 5971         The client uses the delete_agent command to delete an existing agent.
 5972       </p>
 5973       <p>
 5974         Since this is a destructive command, the client is advised to ask
 5975         for confirmation from the user before sending this command to the
 5976         Manager.
 5977       </p>
 5978     </description>
 5979     <pattern>
 5980       <attrib>
 5981         <name>agent_id</name>
 5982         <type>uuid</type>
 5983         <required>1</required>
 5984       </attrib>
 5985       <attrib>
 5986         <name>ultimate</name>
 5987         <summary>Whether to remove entirely, or to the trashcan</summary>
 5988         <type>boolean</type>
 5989         <required>1</required>
 5990       </attrib>
 5991     </pattern>
 5992     <response>
 5993       <pattern>
 5994         <attrib>
 5995           <name>status</name>
 5996           <type>status</type>
 5997           <required>1</required>
 5998         </attrib>
 5999         <attrib>
 6000           <name>status_text</name>
 6001           <type>text</type>
 6002           <required>1</required>
 6003         </attrib>
 6004       </pattern>
 6005     </response>
 6006     <example>
 6007       <summary>Delete an agent</summary>
 6008       <request>
 6009         <delete_agent agent_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6010         </delete_agent>
 6011       </request>
 6012       <response>
 6013         <delete_agent_response status="200" status_text="OK"/>
 6014       </response>
 6015     </example>
 6016   </command>
 6017   <command>
 6018     <name>delete_asset</name>
 6019     <summary>Delete an asset</summary>
 6020     <description>
 6021       <p>
 6022         The client uses the delete_asset command to delete an existing asset.
 6023       </p>
 6024       <p>
 6025         Since this is a destructive command, the client is advised to ask
 6026         for confirmation from the user before sending this command to the
 6027         Manager.
 6028       </p>
 6029     </description>
 6030     <pattern>
 6031       <or>
 6032         <attrib>
 6033           <name>asset_id</name>
 6034           <summary>Single asset to delete</summary>
 6035           <description>
 6036            <p>
 6037              Overrides report_id.
 6038            </p>
 6039           </description>
 6040           <type>uuid</type>
 6041           <required>1</required>
 6042         </attrib>
 6043         <attrib>
 6044           <name>report_id</name>
 6045           <summary>Report from which to get all assets to delete</summary>
 6046           <type>uuid</type>
 6047           <required>1</required>
 6048         </attrib>
 6049       </or>
 6050     </pattern>
 6051     <response>
 6052       <pattern>
 6053         <attrib>
 6054           <name>status</name>
 6055           <type>status</type>
 6056           <required>1</required>
 6057         </attrib>
 6058         <attrib>
 6059           <name>status_text</name>
 6060           <type>text</type>
 6061           <required>1</required>
 6062         </attrib>
 6063       </pattern>
 6064     </response>
 6065     <example>
 6066       <summary>Delete a asset</summary>
 6067       <request>
 6068         <delete_asset asset_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6069         </delete_asset>
 6070       </request>
 6071       <response>
 6072         <delete_asset_response status="200" status_text="OK"/>
 6073       </response>
 6074     </example>
 6075   </command>
 6076   <command>
 6077     <name>delete_config</name>
 6078     <summary>Delete a config</summary>
 6079     <description>
 6080       <p>
 6081         The client uses the delete_config command to delete an existing config.
 6082       </p>
 6083       <p>
 6084         Since this is a destructive command, the client is advised to ask
 6085         for confirmation from the user before sending this command to the
 6086         Manager.
 6087       </p>
 6088     </description>
 6089     <pattern>
 6090       <attrib>
 6091         <name>config_id</name>
 6092         <type>uuid</type>
 6093         <required>1</required>
 6094       </attrib>
 6095       <attrib>
 6096         <name>ultimate</name>
 6097         <summary>Whether to remove entirely, or to the trashcan</summary>
 6098         <type>boolean</type>
 6099         <required>1</required>
 6100       </attrib>
 6101     </pattern>
 6102     <response>
 6103       <pattern>
 6104         <attrib>
 6105           <name>status</name>
 6106           <type>status</type>
 6107           <required>1</required>
 6108         </attrib>
 6109         <attrib>
 6110           <name>status_text</name>
 6111           <type>text</type>
 6112           <required>1</required>
 6113         </attrib>
 6114       </pattern>
 6115     </response>
 6116     <example>
 6117       <summary>Delete a config</summary>
 6118       <request>
 6119         <delete_config config_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6120         </delete_config>
 6121       </request>
 6122       <response>
 6123         <delete_config_response status="200" status_text="OK"/>
 6124       </response>
 6125     </example>
 6126   </command>
 6127   <command>
 6128     <name>delete_alert</name>
 6129     <summary>Delete an alert</summary>
 6130     <description>
 6131       <p>
 6132         The client uses the delete_alert command to delete an existing
 6133         alert.
 6134       </p>
 6135       <p>
 6136         Since this is a destructive command, the client is advised to ask
 6137         for confirmation from the user before sending this command to the
 6138         Manager.
 6139       </p>
 6140     </description>
 6141     <pattern>
 6142       <attrib>
 6143         <name>alert_id</name>
 6144         <type>uuid</type>
 6145         <required>1</required>
 6146       </attrib>
 6147       <attrib>
 6148         <name>ultimate</name>
 6149         <summary>Whether to remove entirely, or to the trashcan</summary>
 6150         <type>boolean</type>
 6151         <required>1</required>
 6152       </attrib>
 6153     </pattern>
 6154     <response>
 6155       <pattern>
 6156         <attrib>
 6157           <name>status</name>
 6158           <type>status</type>
 6159           <required>1</required>
 6160         </attrib>
 6161         <attrib>
 6162           <name>status_text</name>
 6163           <type>text</type>
 6164           <required>1</required>
 6165         </attrib>
 6166       </pattern>
 6167     </response>
 6168     <example>
 6169       <summary>Delete an alert</summary>
 6170       <request>
 6171         <delete_alert alert_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6172         </delete_alert>
 6173       </request>
 6174       <response>
 6175         <delete_alert_response status="200" status_text="OK"/>
 6176       </response>
 6177     </example>
 6178   </command>
 6179   <command>
 6180     <name>delete_credential</name>
 6181     <summary>Delete a credential</summary>
 6182     <description>
 6183       <p>
 6184         The client uses the delete_credential command to delete an
 6185         existing credential.
 6186       </p>
 6187       <p>
 6188         Since this is a destructive command, the client is advised to ask
 6189         for confirmation from the user before sending this command to the
 6190         Manager.
 6191       </p>
 6192     </description>
 6193     <pattern>
 6194       <attrib>
 6195         <name>credential_id</name>
 6196         <type>uuid</type>
 6197         <required>1</required>
 6198       </attrib>
 6199       <attrib>
 6200         <name>ultimate</name>
 6201         <summary>Whether to remove entirely, or to the trashcan</summary>
 6202         <type>boolean</type>
 6203         <required>1</required>
 6204       </attrib>
 6205     </pattern>
 6206     <response>
 6207       <pattern>
 6208         <attrib>
 6209           <name>status</name>
 6210           <type>status</type>
 6211           <required>1</required>
 6212         </attrib>
 6213         <attrib>
 6214           <name>status_text</name>
 6215           <type>text</type>
 6216           <required>1</required>
 6217         </attrib>
 6218       </pattern>
 6219     </response>
 6220     <example>
 6221       <summary>Delete a credential</summary>
 6222       <request>
 6223         <delete_credential credential_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6224         </delete_credential>
 6225       </request>
 6226       <response>
 6227         <delete_credential_response status="200" status_text="OK"/>
 6228       </response>
 6229     </example>
 6230   </command>
 6231   <command>
 6232     <name>delete_filter</name>
 6233     <summary>Delete a filter</summary>
 6234     <description>
 6235       <p>
 6236         The client uses the delete_filter command to delete an existing filter.
 6237       </p>
 6238       <p>
 6239         Since this is a destructive command, the client is advised to ask
 6240         for confirmation from the user before sending this command to the
 6241         Manager.
 6242       </p>
 6243     </description>
 6244     <pattern>
 6245       <attrib>
 6246         <name>filter_id</name>
 6247         <type>uuid</type>
 6248         <required>1</required>
 6249       </attrib>
 6250       <attrib>
 6251         <name>ultimate</name>
 6252         <summary>Whether to remove entirely, or to the trashcan</summary>
 6253         <type>boolean</type>
 6254         <required>1</required>
 6255       </attrib>
 6256     </pattern>
 6257     <response>
 6258       <pattern>
 6259         <attrib>
 6260           <name>status</name>
 6261           <type>status</type>
 6262           <required>1</required>
 6263         </attrib>
 6264         <attrib>
 6265           <name>status_text</name>
 6266           <type>text</type>
 6267           <required>1</required>
 6268         </attrib>
 6269       </pattern>
 6270     </response>
 6271     <example>
 6272       <summary>Delete a filter</summary>
 6273       <request>
 6274         <delete_filter filter_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6275         </delete_filter>
 6276       </request>
 6277       <response>
 6278         <delete_filter_response status="200" status_text="OK"/>
 6279       </response>
 6280     </example>
 6281   </command>
 6282   <command>
 6283     <name>delete_group</name>
 6284     <summary>Delete a group</summary>
 6285     <description>
 6286       <p>
 6287         The client uses the delete_group command to delete an existing
 6288         group.
 6289       </p>
 6290       <p>
 6291         Since this is a destructive command, the client is advised to ask
 6292         for confirmation from the user before sending this command to the
 6293         Manager.
 6294       </p>
 6295     </description>
 6296     <pattern>
 6297       <attrib>
 6298         <name>group_id</name>
 6299         <type>uuid</type>
 6300         <required>1</required>
 6301       </attrib>
 6302       <attrib>
 6303         <name>ultimate</name>
 6304         <summary>Whether to remove entirely, or to the trashcan</summary>
 6305         <type>boolean</type>
 6306         <required>1</required>
 6307       </attrib>
 6308     </pattern>
 6309     <response>
 6310       <pattern>
 6311         <attrib>
 6312           <name>status</name>
 6313           <type>status</type>
 6314           <required>1</required>
 6315         </attrib>
 6316         <attrib>
 6317           <name>status_text</name>
 6318           <type>text</type>
 6319           <required>1</required>
 6320         </attrib>
 6321       </pattern>
 6322     </response>
 6323     <example>
 6324       <summary>Delete a group</summary>
 6325       <request>
 6326         <delete_group group_id="d94211b6-ba40-11e3-bcb1-406186ea4fc5">
 6327         </delete_group>
 6328       </request>
 6329       <response>
 6330         <delete_group_response status="200" status_text="OK"/>
 6331       </response>
 6332     </example>
 6333   </command>
 6334   <command>
 6335     <name>delete_note</name>
 6336     <summary>Delete a note</summary>
 6337     <description>
 6338       <p>
 6339         The client uses the delete_note command to delete an existing note.
 6340       </p>
 6341       <p>
 6342         Since this is a destructive command, the client is advised to ask
 6343         for confirmation from the user before sending this command to the
 6344         Manager.
 6345       </p>
 6346     </description>
 6347     <pattern>
 6348       <attrib>
 6349         <name>note_id</name>
 6350         <type>uuid</type>
 6351         <required>1</required>
 6352       </attrib>
 6353       <attrib>
 6354         <name>ultimate</name>
 6355         <summary>Whether to remove entirely, or to the trashcan</summary>
 6356         <type>boolean</type>
 6357         <required>1</required>
 6358       </attrib>
 6359     </pattern>
 6360     <response>
 6361       <pattern>
 6362         <attrib>
 6363           <name>status</name>
 6364           <type>status</type>
 6365           <required>1</required>
 6366         </attrib>
 6367         <attrib>
 6368           <name>status_text</name>
 6369           <type>text</type>
 6370           <required>1</required>
 6371         </attrib>
 6372       </pattern>
 6373     </response>
 6374     <example>
 6375       <summary>Delete a note</summary>
 6376       <request>
 6377         <delete_note note_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6378         </delete_note>
 6379       </request>
 6380       <response>
 6381         <delete_note_response status="200" status_text="OK"/>
 6382       </response>
 6383     </example>
 6384   </command>
 6385   <command>
 6386     <name>delete_override</name>
 6387     <summary>Delete an override</summary>
 6388     <description>
 6389       <p>
 6390         The client uses the delete_override command to delete an existing override.
 6391       </p>
 6392       <p>
 6393         Since this is a destructive command, the client is advised to ask
 6394         for confirmation from the user before sending this command to the
 6395         Manager.
 6396       </p>
 6397     </description>
 6398     <pattern>
 6399       <attrib>
 6400         <name>override_id</name>
 6401         <type>uuid</type>
 6402         <required>1</required>
 6403       </attrib>
 6404       <attrib>
 6405         <name>ultimate</name>
 6406         <summary>Whether to remove entirely, or to the trashcan</summary>
 6407         <type>boolean</type>
 6408         <required>1</required>
 6409       </attrib>
 6410     </pattern>
 6411     <response>
 6412       <pattern>
 6413         <attrib>
 6414           <name>status</name>
 6415           <type>status</type>
 6416           <required>1</required>
 6417         </attrib>
 6418         <attrib>
 6419           <name>status_text</name>
 6420           <type>text</type>
 6421           <required>1</required>
 6422         </attrib>
 6423       </pattern>
 6424     </response>
 6425     <example>
 6426       <summary>Delete an override</summary>
 6427       <request>
 6428         <delete_override override_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6429         </delete_override>
 6430       </request>
 6431       <response>
 6432         <delete_override_response status="200" status_text="OK"/>
 6433       </response>
 6434     </example>
 6435   </command>
 6436   <command>
 6437     <name>delete_report</name>
 6438     <summary>Delete a report</summary>
 6439     <description>
 6440       <p>
 6441         The client uses the delete_report command to delete an existing report.
 6442       </p>
 6443       <p>
 6444         Since this is a destructive command, the client is advised to ask
 6445         for confirmation from the user before sending this command to the
 6446         Manager.
 6447       </p>
 6448     </description>
 6449     <pattern>
 6450       <attrib>
 6451         <name>report_id</name>
 6452         <type>uuid</type>
 6453         <required>1</required>
 6454       </attrib>
 6455     </pattern>
 6456     <response>
 6457       <pattern>
 6458         <attrib>
 6459           <name>status</name>
 6460           <type>status</type>
 6461           <required>1</required>
 6462         </attrib>
 6463         <attrib>
 6464           <name>status_text</name>
 6465           <type>text</type>
 6466           <required>1</required>
 6467         </attrib>
 6468       </pattern>
 6469     </response>
 6470     <example>
 6471       <summary>Delete a report</summary>
 6472       <request>
 6473         <delete_report report_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6474         </delete_report>
 6475       </request>
 6476       <response>
 6477         <delete_report_response status="200" status_text="OK"/>
 6478       </response>
 6479     </example>
 6480   </command>
 6481   <command>
 6482     <name>delete_permission</name>
 6483     <summary>Delete a permission</summary>
 6484     <description>
 6485       <p>
 6486         The client uses the delete_permission command to delete an existing permission.
 6487       </p>
 6488       <p>
 6489         Since this is a destructive command, the client is advised to ask
 6490         for confirmation from the user before sending this command to the
 6491         Manager.
 6492       </p>
 6493     </description>
 6494     <pattern>
 6495       <attrib>
 6496         <name>permission_id</name>
 6497         <type>uuid</type>
 6498         <required>1</required>
 6499       </attrib>
 6500       <attrib>
 6501         <name>ultimate</name>
 6502         <summary>Whether to remove entirely, or to the trashcan</summary>
 6503         <type>boolean</type>
 6504         <required>1</required>
 6505       </attrib>
 6506     </pattern>
 6507     <response>
 6508       <pattern>
 6509         <attrib>
 6510           <name>status</name>
 6511           <type>status</type>
 6512           <required>1</required>
 6513         </attrib>
 6514         <attrib>
 6515           <name>status_text</name>
 6516           <type>text</type>
 6517           <required>1</required>
 6518         </attrib>
 6519       </pattern>
 6520     </response>
 6521     <example>
 6522       <summary>Delete a permission</summary>
 6523       <request>
 6524         <delete_permission permission_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6525         </delete_permission>
 6526       </request>
 6527       <response>
 6528         <delete_permission_response status="200" status_text="OK"/>
 6529       </response>
 6530     </example>
 6531   </command>
 6532   <command>
 6533     <name>delete_port_list</name>
 6534     <summary>Delete a port list</summary>
 6535     <description>
 6536       <p>
 6537         The client uses the delete_port_list command to delete an existing
 6538         port list.
 6539       </p>
 6540       <p>
 6541         Since this is a destructive command, the client is advised to ask
 6542         for confirmation from the user before sending this command to the
 6543         Manager.
 6544       </p>
 6545     </description>
 6546     <pattern>
 6547       <attrib>
 6548         <name>port_list_id</name>
 6549         <type>uuid</type>
 6550         <required>1</required>
 6551       </attrib>
 6552       <attrib>
 6553         <name>ultimate</name>
 6554         <summary>Whether to remove entirely, or to the trashcan</summary>
 6555         <type>boolean</type>
 6556         <required>1</required>
 6557       </attrib>
 6558     </pattern>
 6559     <response>
 6560       <pattern>
 6561         <attrib>
 6562           <name>status</name>
 6563           <type>status</type>
 6564           <required>1</required>
 6565         </attrib>
 6566         <attrib>
 6567           <name>status_text</name>
 6568           <type>text</type>
 6569           <required>1</required>
 6570         </attrib>
 6571       </pattern>
 6572     </response>
 6573     <example>
 6574       <summary>Delete a port list</summary>
 6575       <request>
 6576         <delete_port_list port_list_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6577         </delete_port_list>
 6578       </request>
 6579       <response>
 6580         <delete_port_list_response status="200" status_text="OK"/>
 6581       </response>
 6582     </example>
 6583   </command>
 6584   <command>
 6585     <name>delete_port_range</name>
 6586     <summary>Delete a port range</summary>
 6587     <description>
 6588       <p>
 6589         The client uses the delete_port_range command to delete an existing
 6590         port range.
 6591       </p>
 6592       <p>
 6593         Since this is a destructive command, the client is advised to ask
 6594         for confirmation from the user before sending this command to the
 6595         Manager.
 6596       </p>
 6597     </description>
 6598     <pattern>
 6599       <attrib>
 6600         <name>port_range_id</name>
 6601         <type>uuid</type>
 6602         <required>1</required>
 6603       </attrib>
 6604     </pattern>
 6605     <response>
 6606       <pattern>
 6607         <attrib>
 6608           <name>status</name>
 6609           <type>status</type>
 6610           <required>1</required>
 6611         </attrib>
 6612         <attrib>
 6613           <name>status_text</name>
 6614           <type>text</type>
 6615           <required>1</required>
 6616         </attrib>
 6617       </pattern>
 6618     </response>
 6619     <example>
 6620       <summary>Delete a port range</summary>
 6621       <request>
 6622         <delete_port_range port_range_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6623         </delete_port_range>
 6624       </request>
 6625       <response>
 6626         <delete_port_range_response status="200" status_text="OK"/>
 6627       </response>
 6628     </example>
 6629   </command>
 6630   <command>
 6631     <name>delete_report_format</name>
 6632     <summary>Delete a report format</summary>
 6633     <description>
 6634       <p>
 6635         The client uses the delete_report_format command to delete an existing
 6636         report format.
 6637       </p>
 6638       <p>
 6639         Since this is a destructive command, the client is advised to ask
 6640         for confirmation from the user before sending this command to the
 6641         Manager.
 6642       </p>
 6643     </description>
 6644     <pattern>
 6645       <attrib>
 6646         <name>report_format_id</name>
 6647         <type>uuid</type>
 6648         <required>1</required>
 6649       </attrib>
 6650       <attrib>
 6651         <name>ultimate</name>
 6652         <summary>Whether to remove entirely, or to the trashcan</summary>
 6653         <type>boolean</type>
 6654         <required>1</required>
 6655       </attrib>
 6656     </pattern>
 6657     <response>
 6658       <pattern>
 6659         <attrib>
 6660           <name>status</name>
 6661           <type>status</type>
 6662           <required>1</required>
 6663         </attrib>
 6664         <attrib>
 6665           <name>status_text</name>
 6666           <type>text</type>
 6667           <required>1</required>
 6668         </attrib>
 6669       </pattern>
 6670     </response>
 6671     <example>
 6672       <summary>Delete a report format</summary>
 6673       <request>
 6674         <delete_report_format report_format_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6675         </delete_report_format>
 6676       </request>
 6677       <response>
 6678         <delete_report_format_response status="200" status_text="OK"/>
 6679       </response>
 6680     </example>
 6681   </command>
 6682   <command>
 6683     <name>delete_role</name>
 6684     <summary>Delete a role</summary>
 6685     <description>
 6686       <p>
 6687         The client uses the delete_role command to delete an existing
 6688         role.
 6689       </p>
 6690       <p>
 6691         Since this is a destructive command, the client is advised to ask
 6692         for confirmation from the user before sending this command to the
 6693         Manager.
 6694       </p>
 6695     </description>
 6696     <pattern>
 6697       <attrib>
 6698         <name>role_id</name>
 6699         <type>uuid</type>
 6700         <required>1</required>
 6701       </attrib>
 6702       <attrib>
 6703         <name>ultimate</name>
 6704         <summary>Whether to remove entirely, or to the trashcan</summary>
 6705         <type>boolean</type>
 6706         <required>1</required>
 6707       </attrib>
 6708     </pattern>
 6709     <response>
 6710       <pattern>
 6711         <attrib>
 6712           <name>status</name>
 6713           <type>status</type>
 6714           <required>1</required>
 6715         </attrib>
 6716         <attrib>
 6717           <name>status_text</name>
 6718           <type>text</type>
 6719           <required>1</required>
 6720         </attrib>
 6721       </pattern>
 6722     </response>
 6723     <example>
 6724       <summary>Delete a role</summary>
 6725       <request>
 6726         <delete_role role_id="b64c81b2-b9de-11e3-a2e9-406186ea4fc5">
 6727         </delete_role>
 6728       </request>
 6729       <response>
 6730         <delete_role_response status="200" status_text="OK"/>
 6731       </response>
 6732     </example>
 6733   </command>
 6734   <command>
 6735     <name>delete_scanner</name>
 6736     <summary>Delete a scanner</summary>
 6737     <description>
 6738       <p>
 6739         The client uses the delete_scanner command to delete an existing scanner.
 6740       </p>
 6741       <p>
 6742         Since this is a destructive command, the client is advised to ask
 6743         for confirmation from the user before sending this command to the
 6744         Manager.
 6745       </p>
 6746     </description>
 6747     <pattern>
 6748       <attrib>
 6749         <name>scanner_id</name>
 6750         <type>uuid</type>
 6751         <required>1</required>
 6752       </attrib>
 6753       <attrib>
 6754         <name>ultimate</name>
 6755         <summary>Whether to remove entirely, or to the trashcan</summary>
 6756         <type>boolean</type>
 6757         <required>1</required>
 6758       </attrib>
 6759     </pattern>
 6760     <response>
 6761       <pattern>
 6762         <attrib>
 6763           <name>status</name>
 6764           <type>status</type>
 6765           <required>1</required>
 6766         </attrib>
 6767         <attrib>
 6768           <name>status_text</name>
 6769           <type>text</type>
 6770           <required>1</required>
 6771         </attrib>
 6772       </pattern>
 6773     </response>
 6774     <example>
 6775       <summary>Delete a scanner</summary>
 6776       <request>
 6777         <delete_scanner scanner_id="817a3405-e84a-47da-97b2-5fa0d2e8995e">
 6778         </delete_scanner>
 6779       </request>
 6780       <response>
 6781         <delete_scanner_response status="200" status_text="OK"/>
 6782       </response>
 6783     </example>
 6784   </command>
 6785   <command>
 6786     <name>delete_schedule</name>
 6787     <summary>Delete a schedule</summary>
 6788     <description>
 6789       <p>
 6790         The client uses the delete_schedule command to delete an existing schedule.
 6791       </p>
 6792       <p>
 6793         Since this is a destructive command, the client is advised to ask
 6794         for confirmation from the user before sending this command to the
 6795         Manager.
 6796       </p>
 6797     </description>
 6798     <pattern>
 6799       <attrib>
 6800         <name>schedule_id</name>
 6801         <type>uuid</type>
 6802         <required>1</required>
 6803       </attrib>
 6804       <attrib>
 6805         <name>ultimate</name>
 6806         <summary>Whether to remove entirely, or to the trashcan</summary>
 6807         <type>boolean</type>
 6808         <required>1</required>
 6809       </attrib>
 6810     </pattern>
 6811     <response>
 6812       <pattern>
 6813         <attrib>
 6814           <name>status</name>
 6815           <type>status</type>
 6816           <required>1</required>
 6817         </attrib>
 6818         <attrib>
 6819           <name>status_text</name>
 6820           <type>text</type>
 6821           <required>1</required>
 6822         </attrib>
 6823       </pattern>
 6824     </response>
 6825     <example>
 6826       <summary>Delete a schedule</summary>
 6827       <request>
 6828         <delete_schedule schedule_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6829         </delete_schedule>
 6830       </request>
 6831       <response>
 6832         <delete_schedule_response status="200" status_text="OK"/>
 6833       </response>
 6834     </example>
 6835   </command>
 6836   <command>
 6837     <name>delete_tag</name>
 6838     <summary>Delete a tag</summary>
 6839     <description>
 6840       <p>
 6841         The client uses the delete_tag command to delete an existing tag.
 6842       </p>
 6843       <p>
 6844         Since this is a destructive command, the client is advised to ask
 6845         for confirmation from the user before sending this command to the
 6846         Manager.
 6847       </p>
 6848     </description>
 6849     <pattern>
 6850       <attrib>
 6851         <name>tag_id</name>
 6852         <type>uuid</type>
 6853         <required>1</required>
 6854       </attrib>
 6855       <attrib>
 6856         <name>ultimate</name>
 6857         <summary>Whether to remove entirely, or to the trashcan</summary>
 6858         <type>boolean</type>
 6859         <required>1</required>
 6860       </attrib>
 6861     </pattern>
 6862     <response>
 6863       <pattern>
 6864         <attrib>
 6865           <name>status</name>
 6866           <type>status</type>
 6867           <required>1</required>
 6868         </attrib>
 6869         <attrib>
 6870           <name>status_text</name>
 6871           <type>text</type>
 6872           <required>1</required>
 6873         </attrib>
 6874       </pattern>
 6875     </response>
 6876     <example>
 6877       <summary>Delete a tag</summary>
 6878       <request>
 6879         <delete_tag target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6880         </delete_tag>
 6881       </request>
 6882       <response>
 6883         <delete_tag_response status="200" status_text="OK"/>
 6884       </response>
 6885     </example>
 6886   </command>
 6887   <command>
 6888     <name>delete_target</name>
 6889     <summary>Delete a target</summary>
 6890     <description>
 6891       <p>
 6892         The client uses the delete_target command to delete an existing target.
 6893       </p>
 6894       <p>
 6895         Since this is a destructive command, the client is advised to ask
 6896         for confirmation from the user before sending this command to the
 6897         Manager.
 6898       </p>
 6899     </description>
 6900     <pattern>
 6901       <attrib>
 6902         <name>target_id</name>
 6903         <type>uuid</type>
 6904         <required>1</required>
 6905       </attrib>
 6906       <attrib>
 6907         <name>ultimate</name>
 6908         <summary>Whether to remove entirely, or to the trashcan</summary>
 6909         <type>boolean</type>
 6910         <required>1</required>
 6911       </attrib>
 6912     </pattern>
 6913     <response>
 6914       <pattern>
 6915         <attrib>
 6916           <name>status</name>
 6917           <type>status</type>
 6918           <required>1</required>
 6919         </attrib>
 6920         <attrib>
 6921           <name>status_text</name>
 6922           <type>text</type>
 6923           <required>1</required>
 6924         </attrib>
 6925       </pattern>
 6926     </response>
 6927     <example>
 6928       <summary>Delete a target</summary>
 6929       <request>
 6930         <delete_target target_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6931         </delete_target>
 6932       </request>
 6933       <response>
 6934         <delete_target_response status="200" status_text="OK"/>
 6935       </response>
 6936     </example>
 6937   </command>
 6938   <command>
 6939     <name>delete_task</name>
 6940     <summary>Delete a task</summary>
 6941     <description>
 6942       <p>
 6943         The client uses the delete_task command to delete an existing task,
 6944         including all reports associated with the task.
 6945       </p>
 6946       <p>
 6947         Since this is a destructive command, the client is advised to ask
 6948         for confirmation from the user before sending this command to the
 6949         Manager.
 6950       </p>
 6951     </description>
 6952     <pattern>
 6953       <attrib>
 6954         <name>task_id</name>
 6955         <type>uuid</type>
 6956         <required>1</required>
 6957       </attrib>
 6958       <attrib>
 6959         <name>ultimate</name>
 6960         <summary>Whether to remove entirely, or to the trashcan</summary>
 6961         <type>boolean</type>
 6962         <required>1</required>
 6963       </attrib>
 6964     </pattern>
 6965     <response>
 6966       <pattern>
 6967         <attrib>
 6968           <name>status</name>
 6969           <type>status</type>
 6970           <required>1</required>
 6971         </attrib>
 6972         <attrib>
 6973           <name>status_text</name>
 6974           <type>text</type>
 6975           <required>1</required>
 6976         </attrib>
 6977       </pattern>
 6978     </response>
 6979     <example>
 6980       <summary>Delete a task</summary>
 6981       <request>
 6982         <delete_task task_id="267a3405-e84a-47da-97b2-5fa0d2e8995e">
 6983         </delete_task>
 6984       </request>
 6985       <response>
 6986         <delete_task_response status="200" status_text="OK"/>
 6987       </response>
 6988     </example>
 6989   </command>
 6990   <command>
 6991     <name>delete_user</name>
 6992     <summary>Delete a user</summary>
 6993     <description>
 6994       <p>
 6995         The client uses the delete_user command to delete an existing user.
 6996       </p>
 6997       <p>
 6998         Since this is a destructive command, the client is advised to ask
 6999         for confirmation from the user before sending this command to the
 7000         Administrator.
 7001       </p>
 7002     </description>
 7003     <pattern>
 7004       <or>
 7005         <attrib>
 7006           <name>user_id</name>
 7007           <summary>The ID of the user to be deleted.  Overrides name</summary>
 7008           <type>uuid</type>
 7009           <required>1</required>
 7010         </attrib>
 7011         <attrib>
 7012           <name>name</name>
 7013           <summary>The name of the user to be deleted</summary>
 7014           <type>text</type>
 7015           <required>1</required>
 7016         </attrib>
 7017       </or>
 7018       <or>
 7019         <attrib>
 7020           <name>inheritor_id</name>
 7021           <summary>The ID of the inheriting user or "self".  Overrides inheritor_name</summary>
 7022           <type>text</type>
 7023           <required>1</required>
 7024         </attrib>
 7025         <attrib>
 7026           <name>inheritor_name</name>
 7027           <summary>The name of the inheriting user</summary>
 7028           <type>text</type>
 7029           <required>1</required>
 7030         </attrib>
 7031       </or>
 7032     </pattern>
 7033     <response>
 7034       <pattern>
 7035         <attrib>
 7036           <name>status</name>
 7037           <type>status</type>
 7038           <required>1</required>
 7039         </attrib>
 7040         <attrib>
 7041           <name>status_text</name>
 7042           <type>text</type>
 7043           <required>1</required>
 7044         </attrib>
 7045       </pattern>
 7046     </response>
 7047     <example>
 7048       <summary>Delete a user</summary>
 7049       <request>
 7050         <delete_user name="foobar">
 7051         </delete_user>
 7052       </request>
 7053       <response>
 7054         <delete_user_response status="200" status_text="OK">
 7055         </delete_user_response>
 7056       </response>
 7057     </example>
 7058   </command>
 7059   <command>
 7060     <name>describe_auth</name>
 7061     <summary>Describe authentication methods</summary>
 7062     <description>
 7063       <p>
 7064         The client uses the "describe_auth" command to get details about the
 7065         used authentication methods.
 7066       </p>
 7067       <p>
 7068         The Manager will reply with a list of all used authentication
 7069         methods if such a list is available.
 7070       </p>
 7071     </description>
 7072     <pattern>
 7073     </pattern>
 7074     <response>
 7075       <pattern>
 7076         <attrib>
 7077           <name>status</name>
 7078           <type>status</type>
 7079           <required>1</required>
 7080         </attrib>
 7081         <attrib>
 7082           <name>status_text</name>
 7083           <type>text</type>
 7084           <required>1</required>
 7085         </attrib>
 7086         <e>group</e>
 7087       </pattern>
 7088       <ele>
 7089         <name>group</name>
 7090         <summary>Config group</summary>
 7091         <pattern>
 7092           <attrib>
 7093             <name>name</name>
 7094             <type>text</type>
 7095             <required>1</required>
 7096           </attrib>
 7097           <e>auth_conf_setting</e>
 7098         </pattern>
 7099         <ele>
 7100           <name>auth_conf_setting</name>
 7101           <pattern>
 7102             <e>key</e>
 7103             <e>value</e>
 7104             <o><e>certificate_info</e></o>
 7105           </pattern>
 7106           <ele>
 7107             <name>key</name>
 7108             <summary>Setting name</summary>
 7109             <pattern>text</pattern>
 7110           </ele>
 7111           <ele>
 7112             <name>value</name>
 7113             <summary>Setting value</summary>
 7114             <pattern>text</pattern>
 7115           </ele>
 7116           <ele>
 7117             <name>certificate_info</name>
 7118             <summary>Info about the certificate</summary>
 7119             <type>certificate_info</type>
 7120           </ele>
 7121         </ele>
 7122       </ele>
 7123     </response>
 7124     <example>
 7125       <summary>Describe the authentication methods</summary>
 7126       <request>
 7127         <describe_auth>
 7128         </describe_auth>
 7129       </request>
 7130       <response>
 7131         <describe_auth_response status="200" status_text="OK">
 7132           <group name="Foo">
 7133             <auth_conf_setting>
 7134               <key>Bar</key>
 7135               <value>Baz</value>
 7136             </auth_conf_setting>
 7137           </group>
 7138         </describe_auth_response>
 7139       </response>
 7140     </example>
 7141   </command>
 7142   <command>
 7143     <name>empty_trashcan</name>
 7144     <summary>Empty the trashcan</summary>
 7145     <description>
 7146       <p>
 7147         The client uses the empty_trashcan command to empty the trashcan.
 7148       </p>
 7149     </description>
 7150     <pattern>
 7151     </pattern>
 7152     <response>
 7153       <pattern>
 7154         <attrib>
 7155           <name>status</name>
 7156           <type>status</type>
 7157           <required>1</required>
 7158         </attrib>
 7159         <attrib>
 7160           <name>status_text</name>
 7161           <type>text</type>
 7162           <required>1</required>
 7163         </attrib>
 7164       </pattern>
 7165     </response>
 7166     <example>
 7167       <summary>Empty the trashcan</summary>
 7168       <request>
 7169         <empty_trashcan>
 7170         </empty_trashcan>
 7171       </request>
 7172       <response>
 7173         <empty_trashcan_response status="200" status_text="OK"/>
 7174       </response>
 7175     </example>
 7176   </command>
 7177   <command>
 7178     <name>get_agents</name>
 7179     <summary>Get one or many agents</summary>
 7180     <description>
 7181       <p>
 7182         The client uses the get_agents command to get agent information.
 7183         If the command sent by the client was valid, the manager will
 7184         reply with a list of agents to the client.
 7185       </p>
 7186       <p>
 7187         If the request includes a format then the agents in the response
 7188         include installer elements, otherwise they include trust state and
 7189         time. If the details attribute is set, the response will include
 7190         the installer.
 7191       </p>
 7192     </description>
 7193     <pattern>
 7194       <attrib>
 7195         <name>agent_id</name>
 7196         <summary>ID of single agent to get</summary>
 7197         <type>uuid</type>
 7198       </attrib>
 7199       <attrib>
 7200         <name>filter</name>
 7201         <summary>Filter term to use to filter query</summary>
 7202         <type>text</type>
 7203         <filter_keywords>
 7204           <column>
 7205             <name>uuid</name>
 7206             <type>uuid</type>
 7207             <summary>Unique ID</summary>
 7208           </column>
 7209           <column>
 7210             <name>name</name>
 7211             <type>name</type>
 7212             <summary>Name</summary>
 7213           </column>
 7214           <column>
 7215             <name>comment</name>
 7216             <type>text</type>
 7217             <summary>Comment text</summary>
 7218           </column>
 7219           <column>
 7220             <name>created</name>
 7221             <type>iso_time</type>
 7222             <summary>Creation time</summary>
 7223           </column>
 7224           <column>
 7225             <name>modified</name>
 7226             <type>iso_time</type>
 7227             <summary>Modification time</summary>
 7228           </column>
 7229           <column>
 7230             <name>owner</name>
 7231             <type>name</type>
 7232             <summary>Name of the owner</summary>
 7233           </column>
 7234           <column>
 7235             <name>trust</name>
 7236             <type>boolean</type>
 7237             <summary>Whether the the agent is trusted</summary>
 7238           </column>
 7239         </filter_keywords>
 7240       </attrib>
 7241       <attrib>
 7242         <name>filt_id</name>
 7243         <summary>ID of filter to use to filter query</summary>
 7244         <type>uuid</type>
 7245       </attrib>
 7246       <attrib>
 7247         <name>trash</name>
 7248         <summary>Whether to get the trashcan agents instead</summary>
 7249         <type>boolean</type>
 7250       </attrib>
 7251       <attrib>
 7252         <name>details</name>
 7253         <summary>
 7254           Whether to include agents package information when no format
 7255           was provided
 7256         </summary>
 7257         <type>boolean</type>
 7258       </attrib>
 7259       <attrib>
 7260         <name>format</name>
 7261         <type>
 7262           <alts>
 7263             <alt>installer</alt>
 7264             <alt>howto_install</alt>
 7265             <alt>howto_use</alt>
 7266           </alts>
 7267         </type>
 7268       </attrib>
 7269     </pattern>
 7270     <response>
 7271       <pattern>
 7272         <attrib>
 7273           <name>status</name>
 7274           <type>status</type>
 7275           <required>1</required>
 7276         </attrib>
 7277         <attrib>
 7278           <name>status_text</name>
 7279           <type>text</type>
 7280           <required>1</required>
 7281         </attrib>
 7282         <any><e>agent</e></any>
 7283         <e>filters</e>
 7284         <e>sort</e>
 7285         <e>agents</e>
 7286         <e>agent_count</e>
 7287       </pattern>
 7288       <ele>
 7289         <name>agent</name>
 7290         <pattern>
 7291           <attrib>
 7292             <name>id</name>
 7293             <type>uuid</type>
 7294             <required>1</required>
 7295           </attrib>
 7296           <e>owner</e>
 7297           <e>name</e>
 7298           <e>comment</e>
 7299           <e>creation_time</e>
 7300           <e>modification_time</e>
 7301           <e>in_use</e>
 7302           <e>writable</e>
 7303           <e>permissions</e>
 7304           <e>user_tags</e>
 7305           <or>
 7306             <e>installer</e>
 7307             <e>package</e>
 7308           </or>
 7309         </pattern>
 7310         <ele>
 7311           <name>owner</name>
 7312           <summary>Owner of the agent</summary>
 7313           <pattern>
 7314             <e>name</e>
 7315           </pattern>
 7316           <ele>
 7317             <name>name</name>
 7318             <summary>The name of the owner</summary>
 7319             <pattern><t>name</t></pattern>
 7320           </ele>
 7321         </ele>
 7322         <ele>
 7323           <name>name</name>
 7324           <summary>The name of the agent</summary>
 7325           <pattern><t>name</t></pattern>
 7326         </ele>
 7327         <ele>
 7328           <name>comment</name>
 7329           <summary>The comment on the agent</summary>
 7330           <pattern>text</pattern>
 7331         </ele>
 7332         <ele>
 7333           <name>creation_time</name>
 7334           <summary>Date and time the agent was created</summary>
 7335           <pattern><t>iso_time</t></pattern>
 7336         </ele>
 7337         <ele>
 7338           <name>modification_time</name>
 7339           <summary>Date and time the agent was last modified</summary>
 7340           <pattern><t>iso_time</t></pattern>
 7341         </ele>
 7342         <ele>
 7343           <name>in_use</name>
 7344           <summary>Whether the agent is in use</summary>
 7345           <pattern><t>boolean</t></pattern>
 7346         </ele>
 7347         <ele>
 7348           <name>writable</name>
 7349           <summary>Whether the agent is writable</summary>
 7350           <pattern><t>boolean</t></pattern>
 7351         </ele>
 7352         <ele>
 7353           <name>permissions</name>
 7354           <summary>Permissions that the current user has on the agent</summary>
 7355           <pattern>
 7356             <any><e>permission</e></any>
 7357           </pattern>
 7358           <ele>
 7359             <name>permission</name>
 7360             <pattern>
 7361               <e>name</e>
 7362             </pattern>
 7363             <ele>
 7364               <name>name</name>
 7365               <summary>The name of the permission</summary>
 7366               <pattern><t>name</t></pattern>
 7367             </ele>
 7368           </ele>
 7369         </ele>
 7370         <ele>
 7371           <name>user_tags</name>
 7372           <summary>Info on tags attached to the agent</summary>
 7373           <pattern>
 7374             <e>count</e>
 7375             <any><e>tag</e></any>
 7376           </pattern>
 7377           <ele>
 7378             <name>count</name>
 7379             <summary>Number of attached tags</summary>
 7380             <pattern><t>integer</t></pattern>
 7381           </ele>
 7382           <ele>
 7383             <name>tag</name>
 7384             <summary>
 7385               Short info on an individual tag
 7386               (only if details were requested)
 7387             </summary>
 7388             <pattern>
 7389               <attrib>
 7390                 <name>id</name>
 7391                 <type>uuid</type>
 7392                 <summary>UUID of the tag</summary>
 7393                 <required>1</required>
 7394               </attrib>
 7395               <e>name</e>
 7396               <e>value</e>
 7397               <e>comment</e>
 7398             </pattern>
 7399             <ele>
 7400               <name>name</name>
 7401               <summary>Name of the tag (usually namespace:predicate)</summary>
 7402               <pattern>text</pattern>
 7403             </ele>
 7404             <ele>
 7405               <name>value</name>
 7406               <summary>Value of the tag</summary>
 7407               <pattern>text</pattern>
 7408             </ele>
 7409             <ele>
 7410               <name>comment</name>
 7411               <summary>Comment for the tag</summary>
 7412               <pattern>text</pattern>
 7413             </ele>
 7414           </ele>
 7415         </ele>
 7416         <ele>
 7417           <name>installer</name>
 7418           <pattern>
 7419             <e>trust</e>
 7420           </pattern>
 7421           <ele>
 7422             <name>trust</name>
 7423             <summary>Whether signature verification succeeded</summary>
 7424             <pattern>
 7425               <t>
 7426                 <alts>
 7427                   <alt>yes</alt>
 7428                   <alt>no</alt>
 7429                   <alt>unknown</alt>
 7430                 </alts>
 7431               </t>
 7432               <e>time</e>
 7433             </pattern>
 7434             <ele>
 7435               <name>time</name>
 7436               <summary>When the signature was verified</summary>
 7437               <pattern><t>iso_time</t></pattern>
 7438             </ele>
 7439           </ele>
 7440         </ele>
 7441         <ele>
 7442           <name>package</name>
 7443           <summary>Either the installer or one of the HOWTOs</summary>
 7444           <pattern>
 7445             <e>filename</e>
 7446             <t>base64</t>
 7447           </pattern>
 7448           <ele>
 7449             <name>filename</name>
 7450             <summary>The filename of the package</summary>
 7451             <pattern>text</pattern>
 7452           </ele>
 7453         </ele>
 7454       </ele>
 7455       <ele>
 7456         <name>filters</name>
 7457         <pattern>
 7458           <attrib>
 7459             <name>id</name>
 7460             <summary>UUID of filter if any, else 0</summary>
 7461             <type>uuid</type>
 7462             <required>1</required>
 7463           </attrib>
 7464           <e>term</e>
 7465           <o><e>name</e></o>
 7466           <e>keywords</e>
 7467         </pattern>
 7468         <ele>
 7469           <name>term</name>
 7470           <summary>Filter term</summary>
 7471           <pattern>text</pattern>
 7472         </ele>
 7473         <ele>
 7474           <name>name</name>
 7475           <summary>Filter name, if applicable</summary>
 7476           <pattern>text</pattern>
 7477         </ele>
 7478         <ele>
 7479           <name>keywords</name>
 7480           <summary>Filter broken down into keywords</summary>
 7481           <pattern><any><e>keyword</e></any></pattern>
 7482           <ele>
 7483             <name>keyword</name>
 7484             <pattern>
 7485               <e>column</e>
 7486               <e>relation</e>
 7487               <e>value</e>
 7488             </pattern>
 7489             <ele>
 7490               <name>column</name>
 7491               <summary>Column prefix</summary>
 7492               <pattern>text</pattern>
 7493             </ele>
 7494             <ele>
 7495               <name>relation</name>
 7496               <summary>Relation operator</summary>
 7497               <pattern>
 7498                 <alts>
 7499                   <alt>=</alt>
 7500                   <alt>:</alt>
 7501                   <alt>~</alt>
 7502                   <alt>&gt;</alt>
 7503                   <alt>&lt;</alt>
 7504                 </alts>
 7505               </pattern>
 7506             </ele>
 7507             <ele>
 7508               <name>value</name>
 7509               <summary>The filter text</summary>
 7510               <pattern>text</pattern>
 7511             </ele>
 7512           </ele>
 7513         </ele>
 7514       </ele>
 7515       <ele>
 7516         <name>sort</name>
 7517         <pattern>
 7518           text
 7519           <e>field</e>
 7520         </pattern>
 7521         <ele>
 7522           <name>field</name>
 7523           <pattern>
 7524             <e>order</e>
 7525           </pattern>
 7526           <ele>
 7527             <name>order</name>
 7528             <pattern>
 7529               <t>
 7530                 <alts>
 7531                   <alt>ascending</alt>
 7532                   <alt>descending</alt>
 7533                 </alts>
 7534               </t>
 7535             </pattern>
 7536           </ele>
 7537         </ele>
 7538       </ele>
 7539       <ele>
 7540         <name>agents</name>
 7541         <pattern>
 7542           <attrib>
 7543             <name>start</name>
 7544             <summary>First agent</summary>
 7545             <type>integer</type>
 7546             <required>1</required>
 7547           </attrib>
 7548           <attrib>
 7549             <name>max</name>
 7550             <summary>Maximum number of agents</summary>
 7551             <type>integer</type>
 7552             <required>1</required>
 7553           </attrib>
 7554         </pattern>
 7555       </ele>
 7556       <ele>
 7557         <name>agent_count</name>
 7558         <pattern>
 7559           <e>filtered</e>
 7560           <e>page</e>
 7561         </pattern>
 7562         <ele>
 7563           <name>filtered</name>
 7564           <summary>Number of agents after filtering</summary>
 7565           <pattern><t>integer</t></pattern>
 7566         </ele>
 7567         <ele>
 7568           <name>page</name>
 7569           <summary>Number of agents on current page</summary>
 7570           <pattern><t>integer</t></pattern>
 7571         </ele>
 7572       </ele>
 7573     </response>
 7574     <example>
 7575       <summary>Get one or many agents</summary>
 7576       <request>
 7577         <get_agents></get_agents>
 7578       </request>
 7579       <response>
 7580         <get_agents_response status="200" status_text="OK">
 7581           <agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
 7582             <name>Custom Scan Agent</name>
 7583             <comment>Custom agent for use on the Web servers.</comment>
 7584             <creation_time>2012-01-23T10:44:00+01:00</creation_time>
 7585             <modification_time>2013-01-23T10:44:00+01:00</modification_time>
 7586             <writable>1</writable>
 7587             <in_use>0</in_use>
 7588             <user_tags>
 7589               <count>0</count>
 7590             </user_tags>
 7591             <installer>
 7592               <trust>
 7593                 yes
 7594                 <time>Wed Jun 30 21:49:08 2012</time>
 7595               </trust>
 7596             </installer>
 7597           </agent>
 7598           <truncated>...</truncated>
 7599         </get_agents_response>
 7600       </response>
 7601     </example>
 7602     <example>
 7603       <summary>Get one agent</summary>
 7604       <request>
 7605         <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
 7606         </get_agents>
 7607       </request>
 7608       <response>
 7609         <get_agents_response status="200" status_text="OK">
 7610           <agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
 7611             <name>Custom Scan Agent</name>
 7612             <comment>Custom agent for use on the Web servers.</comment>
 7613             <creation_time>2012-01-23T10:44:00+01:00</creation_time>
 7614             <modification_time>2013-01-23T10:44:00+01:00</modification_time>
 7615             <writable>1</writable>
 7616             <in_use>0</in_use>
 7617             <user_tags>
 7618               <count>0</count>
 7619             </user_tags>
 7620             <installer>
 7621               <trust>
 7622                 yes
 7623                 <time>Wed Jun 30 21:49:08 2012</time>
 7624               </trust>
 7625             </installer>
 7626           </agent>
 7627         </get_agents_response>
 7628       </response>
 7629     </example>
 7630     <example>
 7631       <summary>Get one agent, including the installer package</summary>
 7632       <request>
 7633         <get_agents agent_id="c33864a9-d3fd-44b3-8717-972bfb01dfcf"
 7634                     format="installer">
 7635         </get_agents>
 7636       </request>
 7637       <response>
 7638         <get_agents_response status="200" status_text="OK">
 7639           <agent id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
 7640             <name>Custom Scan Agent</name>
 7641             <comment>Custom agent for use on the Web servers.</comment>
 7642             <creation_time>2012-01-23T10:44:00+01:00</creation_time>
 7643             <modification_time>2013-01-23T10:44:00+01:00</modification_time>
 7644             <writable>1</writable>
 7645             <in_use>0</in_use>
 7646             <package format="installer">
 7647               <filename>agent.deb</filename>
 7648               CgoKCgoKCgoKCgoKCSAgI...
 7649             </package>
 7650           </agent>
 7651         </get_agents_response>
 7652       </response>
 7653     </example>
 7654   </command>
 7655   <command>
 7656     <name>get_configs</name>
 7657     <summary>Get one or many configs</summary>
 7658     <description>
 7659       The client uses the get_configs command to get config information.
 7660       If the command sent by the client was valid, the manager will
 7661       reply with a list of configs to the client.
 7662     </description>
 7663     <pattern>
 7664       <attrib>
 7665         <name>config_id</name>
 7666         <summary>ID of single config to get</summary>
 7667         <type>uuid</type>
 7668       </attrib>
 7669       <attrib>
 7670         <name>filter</name>
 7671         <summary>Filter term to use to filter query</summary>
 7672         <type>text</type>
 7673         <filter_keywords>
 7674           <column>
 7675             <name>uuid</name>
 7676             <type>uuid</type>
 7677             <summary>Unique ID</summary>
 7678           </column>
 7679           <column>
 7680             <name>name</name>
 7681             <type>name</type>
 7682             <summary>Name</summary>
 7683           </column>
 7684           <column>
 7685             <name>comment</name>
 7686             <type>text</type>
 7687             <summary>Comment text</summary>
 7688           </column>
 7689           <column>
 7690             <name>created</name>
 7691             <type>iso_time</type>
 7692             <summary>Creation time</summary>
 7693           </column>
 7694           <column>
 7695             <name>modified</name>
 7696             <type>iso_time</type>
 7697             <summary>Modification time</summary>
 7698           </column>
 7699           <column>
 7700             <name>owner</name>
 7701             <type>name</type>
 7702             <summary>Name of the owner</summary>
 7703           </column>
 7704           <column>
 7705             <name>nvt_selector</name>
 7706             <type>uuid</type>
 7707             <summary>NVT selector UUID</summary>
 7708           </column>
 7709           <column>
 7710             <name>families_total</name>
 7711             <type>integer</type>
 7712             <summary>Total number of selected NVT families</summary>
 7713           </column>
 7714           <column>
 7715             <name>nvts_total</name>
 7716             <type>integer</type>
 7717             <summary>Total number of selected NVTs</summary>
 7718           </column>
 7719           <column>
 7720             <name>families_trend</name>
 7721             <type>boolean</type>
 7722             <summary>Whether new NVT families will be added</summary>
 7723           </column>
 7724           <column>
 7725             <name>nvts_trend</name>
 7726             <type>boolean</type>
 7727             <summary>Whether new NVTs will be added</summary>
 7728           </column>
 7729         </filter_keywords>
 7730       </attrib>
 7731       <attrib>
 7732         <name>filt_id</name>
 7733         <summary>ID of filter to use to filter query</summary>
 7734         <type>uuid</type>
 7735       </attrib>
 7736       <attrib>
 7737         <name>trash</name>
 7738         <summary>Whether to get the trashcan configs instead</summary>
 7739         <type>boolean</type>
 7740       </attrib>
 7741       <attrib>
 7742         <name>details</name>
 7743         <summary>Whether to get config families, preferences, nvt selectors and tasks</summary>
 7744         <type>boolean</type>
 7745       </attrib>
 7746       <attrib>
 7747         <name>families</name>
 7748         <summary>Whether to include the families if no details are requested</summary>
 7749         <type>boolean</type>
 7750       </attrib>
 7751       <attrib>
 7752         <name>preferences</name>
 7753         <summary>Whether to include the preferences if no details are requested</summary>
 7754         <type>boolean</type>
 7755       </attrib>
 7756       <attrib>
 7757         <name>tasks</name>
 7758         <summary>Whether to get tasks using this config</summary>
 7759         <type>boolean</type>
 7760       </attrib>
 7761     </pattern>
 7762     <response>
 7763       <pattern>
 7764         <attrib>
 7765           <name>status</name>
 7766           <type>status</type>
 7767           <required>1</required>
 7768         </attrib>
 7769         <attrib>
 7770           <name>status_text</name>
 7771           <type>text</type>
 7772           <required>1</required>
 7773         </attrib>
 7774         <any><e>config</e></any>
 7775         <e>filters</e>
 7776         <e>sort</e>
 7777         <e>configs</e>
 7778         <e>config_count</e>
 7779       </pattern>
 7780       <ele>
 7781         <name>config</name>
 7782         <pattern>
 7783           <attrib>
 7784             <name>id</name>
 7785             <type>uuid</type>
 7786             <required>1</required>
 7787           </attrib>
 7788           <e>owner</e>
 7789           <e>name</e>
 7790           <e>comment</e>
 7791           <e>creation_time</e>
 7792           <e>modification_time</e>
 7793           <e>family_count</e>
 7794           <e>nvt_count</e>
 7795           <e>type</e>
 7796           <e>max_nvt_count</e>
 7797           <e>known_nvt_count</e>
 7798           <e>in_use</e>
 7799           <e>writable</e>
 7800           <e>permissions</e>
 7801           <e>user_tags</e>
 7802           <e>tasks</e>
 7803           <o><e>families</e></o>
 7804           <o><e>preferences</e></o>
 7805           <o><e>nvt_selectors</e></o>
 7806         </pattern>
 7807         <ele>
 7808           <name>owner</name>
 7809           <summary>Owner of the config</summary>
 7810           <pattern>
 7811             <e>name</e>
 7812           </pattern>
 7813           <ele>
 7814             <name>name</name>
 7815             <summary>The name of the owner</summary>
 7816             <pattern><t>name</t></pattern>
 7817           </ele>
 7818         </ele>
 7819         <ele>
 7820           <name>name</name>
 7821           <summary>The name of the config</summary>
 7822           <pattern><t>name</t></pattern>
 7823         </ele>
 7824         <ele>
 7825           <name>comment</name>
 7826           <summary>The comment on the config</summary>
 7827           <pattern>text</pattern>
 7828         </ele>
 7829         <ele>
 7830           <name>creation_time</name>
 7831           <summary>Creation time of the config</summary>
 7832           <pattern><t>iso_time</t></pattern>
 7833         </ele>
 7834         <ele>
 7835           <name>modification_time</name>
 7836           <summary>Last time the config was modified</summary>
 7837           <pattern><t>iso_time</t></pattern>
 7838         </ele>
 7839         <ele>
 7840           <name>family_count</name>
 7841           <summary>The number of families selected by the config</summary>
 7842           <pattern>
 7843             <t>integer</t>
 7844             <e>growing</e>
 7845           </pattern>
 7846           <ele>
 7847             <name>growing</name>
 7848             <summary>
 7849               Whether new families are automatically added to the
 7850               config
 7851             </summary>
 7852             <pattern><t>boolean</t></pattern>
 7853           </ele>
 7854         </ele>
 7855         <ele>
 7856           <name>nvt_count</name>
 7857           <summary>The number of NVTs selected by the config</summary>
 7858           <pattern>
 7859             <t>integer</t>
 7860             <e>growing</e>
 7861           </pattern>
 7862           <ele>
 7863             <name>growing</name>
 7864             <summary>
 7865               Whether new NVTs are automatically added to the config
 7866             </summary>
 7867             <pattern><t>boolean</t></pattern>
 7868           </ele>
 7869         </ele>
 7870         <ele>
 7871           <name>type</name>
 7872           <summary>The type the config.</summary>
 7873           <pattern>
 7874             text
 7875           </pattern>
 7876         </ele>
 7877         <ele>
 7878           <name>max_nvt_count</name>
 7879           <summary>Total number of NVTs in the families selected by the config</summary>
 7880           <pattern>
 7881             <t>integer</t>
 7882           </pattern>
 7883         </ele>
 7884         <ele>
 7885           <name>known_nvt_count</name>
 7886           <summary>Total number of known NVTs selected by the config</summary>
 7887           <pattern>
 7888             <t>integer</t>
 7889           </pattern>
 7890         </ele>
 7891         <ele>
 7892           <name>in_use</name>
 7893           <summary>Whether any tasks are using the config</summary>
 7894           <pattern><t>boolean</t></pattern>
 7895         </ele>
 7896         <ele>
 7897           <name>writable</name>
 7898           <summary>
 7899             Whether any tasks are using the config, including trashcan tasks
 7900           </summary>
 7901           <pattern><t>boolean</t></pattern>
 7902         </ele>
 7903         <ele>
 7904           <name>permissions</name>
 7905           <summary>Permissions that the current user has on the target</summary>
 7906           <pattern>
 7907             <any><e>permission</e></any>
 7908           </pattern>
 7909           <ele>
 7910             <name>permission</name>
 7911             <pattern>
 7912               <e>name</e>
 7913             </pattern>
 7914             <ele>
 7915               <name>name</name>
 7916               <summary>The name of the permission</summary>
 7917               <pattern><t>name</t></pattern>
 7918             </ele>
 7919           </ele>
 7920         </ele>
 7921         <ele>
 7922           <name>user_tags</name>
 7923           <summary>Info on tags attached to the config</summary>
 7924           <pattern>
 7925             <e>count</e>
 7926             <any><e>tag</e></any>
 7927           </pattern>
 7928           <ele>
 7929             <name>count</name>
 7930             <summary>Number of attached tags</summary>
 7931             <pattern><t>integer</t></pattern>
 7932           </ele>
 7933           <ele>
 7934             <name>tag</name>
 7935             <summary>
 7936               Short info on an individual tag
 7937               (only if details were requested)
 7938             </summary>
 7939             <pattern>
 7940               <attrib>
 7941                 <name>id</name>
 7942                 <type>uuid</type>
 7943                 <summary>UUID of the tag</summary>
 7944                 <required>1</required>
 7945               </attrib>
 7946               <e>name</e>
 7947               <e>value</e>
 7948               <e>comment</e>
 7949             </pattern>
 7950             <ele>
 7951               <name>name</name>
 7952               <summary>Name of the tag (usually namespace:predicate)</summary>
 7953               <pattern>text</pattern>
 7954             </ele>
 7955             <ele>
 7956               <name>value</name>
 7957               <summary>Value of the tag</summary>
 7958               <pattern>text</pattern>
 7959             </ele>
 7960             <ele>
 7961               <name>comment</name>
 7962               <summary>Comment for the tag</summary>
 7963               <pattern>text</pattern>
 7964             </ele>
 7965           </ele>
 7966         </ele>
 7967         <ele>
 7968           <name>tasks</name>
 7969           <summary>All tasks using the config</summary>
 7970           <pattern>
 7971             <any><e>task</e></any>
 7972           </pattern>
 7973           <ele>
 7974             <name>task</name>
 7975             <pattern>
 7976               <attrib>
 7977                 <name>id</name>
 7978                 <type>uuid</type>
 7979                 <required>1</required>
 7980               </attrib>
 7981               <e>name</e>
 7982               <o><e>permissions</e></o>
 7983             </pattern>
 7984             <ele>
 7985               <name>name</name>
 7986               <summary>The name of the task</summary>
 7987               <pattern><t>name</t></pattern>
 7988             </ele>
 7989             <ele>
 7990               <name>permissions</name>
 7991               <summary>Permissions the user has on the task</summary>
 7992               <pattern></pattern>
 7993             </ele>
 7994           </ele>
 7995         </ele>
 7996         <ele>
 7997           <name>families</name>
 7998           <summary>All families selected by the config</summary>
 7999           <pattern>
 8000             <any><e>family</e></any>
 8001           </pattern>
 8002           <ele>
 8003             <name>family</name>
 8004             <pattern>
 8005               <e>name</e>
 8006               <e>nvt_count</e>
 8007               <e>max_nvt_count</e>
 8008               <e>growing</e>
 8009             </pattern>
 8010             <ele>
 8011               <name>name</name>
 8012               <summary>The name of the family</summary>
 8013               <pattern><t>name</t></pattern>
 8014             </ele>
 8015             <ele>
 8016               <name>type</name>
 8017               <summary>The type of the config. 0 = OpenVAS scanner, 1 = OSP Scanner</summary>
 8018               <pattern><t>integer</t></pattern>
 8019             </ele>
 8020             <ele>
 8021               <name>nvt_count</name>
 8022               <summary>The number of NVTs selected in the family</summary>
 8023               <pattern><t>integer</t></pattern>
 8024             </ele>
 8025             <ele>
 8026               <name>max_nvt_count</name>
 8027               <summary>The total number of NVTs in the family</summary>
 8028               <pattern><t>integer</t></pattern>
 8029             </ele>
 8030             <ele>
 8031               <name>growing</name>
 8032               <summary>
 8033                 Whether new NVTs in the family are automatically added to the selection
 8034               </summary>
 8035               <pattern><t>boolean</t></pattern>
 8036             </ele>
 8037           </ele>
 8038         </ele>
 8039         <ele>
 8040           <name>preferences</name>
 8041           <summary>Preferences for all NVTs selected by the config</summary>
 8042           <pattern>
 8043             <any><e>preference</e></any>
 8044           </pattern>
 8045           <ele>
 8046             <name>preference</name>
 8047             <pattern>
 8048               <e>nvt</e>
 8049               <e>hr_name</e>
 8050               <e>name</e>
 8051               <e>type</e>
 8052               <e>value</e>
 8053               <e>default</e>
 8054               <any><e>alt</e></any>
 8055             </pattern>
 8056             <ele>
 8057               <name>nvt</name>
 8058               <summary>NVT to which preference applies</summary>
 8059               <pattern>
 8060                 <attrib>
 8061                   <name>oid</name>
 8062                   <type>oid</type>
 8063                   <required>1</required>
 8064                 </attrib>
 8065                 <e>name</e>
 8066               </pattern>
 8067               <ele>
 8068                 <name>name</name>
 8069                 <summary>The name of the NVT</summary>
 8070                 <pattern><t>name</t></pattern>
 8071               </ele>
 8072             </ele>
 8073             <ele>
 8074               <name>hr_name</name>
 8075               <summary>The full, more "human readable" name of the preference</summary>
 8076               <pattern><t>name</t></pattern>
 8077             </ele>
 8078             <ele>
 8079               <name>name</name>
 8080               <summary>The compact name of the preference as used by the scanner</summary>
 8081               <pattern><t>name</t></pattern>
 8082             </ele>
 8083             <ele>
 8084               <name>type</name>
 8085               <summary>The type of preference</summary>
 8086               <pattern>text</pattern>
 8087             </ele>
 8088             <ele>
 8089               <name>value</name>
 8090               <summary>The value of the preference</summary>
 8091               <pattern>text</pattern>
 8092             </ele>
 8093             <ele>
 8094               <name>default</name>
 8095               <summary>The default value of the preference</summary>
 8096               <pattern>text</pattern>
 8097             </ele>
 8098             <ele>
 8099               <name>alt</name>
 8100               <summary>An alternate value for the preference</summary>
 8101               <pattern>text</pattern>
 8102             </ele>
 8103           </ele>
 8104         </ele>
 8105         <ele>
 8106           <name>nvt_selectors</name>
 8107           <summary>All NVT selectors of the config</summary>
 8108           <pattern>
 8109             <any><e>nvt_selector</e></any>
 8110           </pattern>
 8111           <ele>
 8112             <name>nvt_selector</name>
 8113             <summary>An NVT selector</summary>
 8114             <pattern>
 8115               <e>name</e>
 8116               <e>include</e>
 8117               <e>type</e>
 8118               <e>family_or_nvt</e>
 8119             </pattern>
 8120             <ele>
 8121               <name>name</name>
 8122               <summary>Name of the selector</summary>
 8123               <pattern>text</pattern>
 8124             </ele>
 8125             <ele>
 8126               <name>include</name>
 8127               <summary>Whether the selector is an include selector</summary>
 8128               <pattern>
 8129                 <t>boolean</t>
 8130               </pattern>
 8131             </ele>
 8132             <ele>
 8133               <name>type</name>
 8134               <summary>Selector type: 0 = all, 1 = family, 2 = NVT</summary>
 8135               <pattern>
 8136                 <t>integer</t>
 8137               </pattern>
 8138             </ele>
 8139             <ele>
 8140               <name>family_or_nvt</name>
 8141               <summary>Name of the family or OID of the NVT</summary>
 8142               <pattern>text</pattern>
 8143             </ele>
 8144           </ele>
 8145         </ele>
 8146       </ele>
 8147       <ele>
 8148         <name>filters</name>
 8149         <pattern>
 8150           <attrib>
 8151             <name>id</name>
 8152             <summary>UUID of filter if any, else 0</summary>
 8153             <type>uuid</type>
 8154             <required>1</required>
 8155           </attrib>
 8156           <e>term</e>
 8157           <o><e>name</e></o>
 8158           <e>keywords</e>
 8159         </pattern>
 8160         <ele>
 8161           <name>term</name>
 8162           <summary>Filter term</summary>
 8163           <pattern>text</pattern>
 8164         </ele>
 8165         <ele>
 8166           <name>name</name>
 8167           <summary>Filter name, if applicable</summary>
 8168           <pattern>text</pattern>
 8169         </ele>
 8170         <ele>
 8171           <name>keywords</name>
 8172           <summary>Filter broken down into keywords</summary>
 8173           <pattern><any><e>keyword</e></any></pattern>
 8174           <ele>
 8175             <name>keyword</name>
 8176             <pattern>
 8177               <e>column</e>
 8178               <e>relation</e>
 8179               <e>value</e>
 8180             </pattern>
 8181             <ele>
 8182               <name>column</name>
 8183               <summary>Column prefix</summary>
 8184               <pattern>text</pattern>
 8185             </ele>
 8186             <ele>
 8187               <name>relation</name>
 8188               <summary>Relation operator</summary>
 8189               <pattern>
 8190                 <alts>
 8191                   <alt>=</alt>
 8192                   <alt>:</alt>
 8193                   <alt>~</alt>
 8194                   <alt>&gt;</alt>
 8195                   <alt>&lt;</alt>
 8196                 </alts>
 8197               </pattern>
 8198             </ele>
 8199             <ele>
 8200               <name>value</name>
 8201               <summary>The filter text</summary>
 8202               <pattern>text</pattern>
 8203             </ele>
 8204           </ele>
 8205         </ele>
 8206       </ele>
 8207       <ele>
 8208         <name>sort</name>
 8209         <pattern>
 8210           text
 8211           <e>field</e>
 8212         </pattern>
 8213         <ele>
 8214           <name>field</name>
 8215           <pattern>
 8216             <e>order</e>
 8217           </pattern>
 8218           <ele>
 8219             <name>order</name>
 8220             <pattern>
 8221               <t>
 8222                 <alts>
 8223                   <alt>ascending</alt>
 8224                   <alt>descending</alt>
 8225                 </alts>
 8226               </t>
 8227             </pattern>
 8228           </ele>
 8229         </ele>
 8230       </ele>
 8231       <ele>
 8232         <name>configs</name>
 8233         <pattern>
 8234           <attrib>
 8235             <name>start</name>
 8236             <summary>First config</summary>
 8237             <type>integer</type>
 8238             <required>1</required>
 8239           </attrib>
 8240           <attrib>
 8241             <name>max</name>
 8242             <summary>Maximum number of configs</summary>
 8243             <type>integer</type>
 8244             <required>1</required>
 8245           </attrib>
 8246         </pattern>
 8247       </ele>
 8248       <ele>
 8249         <name>config_count</name>
 8250         <pattern>
 8251           <e>filtered</e>
 8252           <e>page</e>
 8253         </pattern>
 8254         <ele>
 8255           <name>filtered</name>
 8256           <summary>Number of configs after filtering</summary>
 8257           <pattern><t>integer</t></pattern>
 8258         </ele>
 8259         <ele>
 8260           <name>page</name>
 8261           <summary>Number of configs on current page</summary>
 8262           <pattern><t>integer</t></pattern>
 8263         </ele>
 8264       </ele>
 8265     </response>
 8266     <example>
 8267       <summary>Get one or many configs</summary>
 8268       <request>
 8269         <get_configs></get_configs>
 8270       </request>
 8271       <response>
 8272         <get_configs_response status="200" status_text="OK">
 8273           <config id="daba56c8-73ec-11df-a475-002264764cea">
 8274             <name>Full and fast</name>
 8275             <comment>All NVT's; optimized by using previously collected information.</comment>
 8276             <creation_time>2012-11-23T10:44:00+01:00</creation_time>
 8277             <modification_time>2013-01-23T10:44:00+01:00</modification_time>
 8278             <family_count>
 8279               4
 8280               <growing>1</growing>
 8281             </family_count>
 8282             <nvt_count>
 8283               12
 8284               <growing>1</growing>
 8285             </nvt_count>
 8286             <in_use>1</in_use>
 8287             <writable>0</writable>
 8288             <user_tags>
 8289               <count>0</count>
 8290             </user_tags>
 8291           </config>
 8292           <truncated>...</truncated>
 8293         </get_configs_response>
 8294       </response>
 8295     </example>
 8296     <example>
 8297       <summary>Get a single config, including preference, family lists and tasks using this config</summary>
 8298       <request>
 8299         <get_configs config_id="daba56c8-73ec-11df-a475-002264764cea" preferences="1" families="1" tasks="1">
 8300         </get_configs>
 8301       </request>
 8302       <response>
 8303         <get_configs_response status="200" status_text="OK">
 8304           <config id="daba56c8-73ec-11df-a475-002264764cea">
 8305             <name>Full and fast</name>
 8306             <comment>All NVT's; optimized by using previously collected information.</comment>
 8307             <family_count>
 8308               4
 8309               <growing>1</growing>
 8310             </family_count>
 8311             <nvt_count>
 8312               12
 8313               <growing>1</growing>
 8314             </nvt_count>
 8315             <in_use>1</in_use>
 8316             <user_tags>
 8317               <count>0</count>
 8318             </user_tags>
 8319             <tasks>
 8320               <task id="13bb418a-4220-4575-b35b-ec398bff7417">
 8321                 <name>Web Servers</name>
 8322               </task>
 8323               <truncated>...</truncated>
 8324             </tasks>
 8325             <families>
 8326               <family>
 8327                 <name>Credentials</name>
 8328                 <nvt_count>8</nvt_count>
 8329                 <max_nvt_count>8</max_nvt_count>
 8330                 <growing>1</growing>
 8331               </family>
 8332               <truncated>...</truncated>
 8333             </families>
 8334             <preferences>
 8335               <preference>
 8336                 <nvt oid="1.3.6.1.4.1.25623.1.0.10330">
 8337                   <name>Services</name>
 8338                 </nvt>
 8339                 <name>Network connection timeout :</name>
 8340                 <type>entry</type>
 8341                 <value>5</value>
 8342               </preference>
 8343               <truncated>...</truncated>
 8344             </preferences>
 8345           </config>
 8346           <truncated>...</truncated>
 8347         </get_configs_response>
 8348       </response>
 8349     </example>
 8350   </command>
 8351   <command>
 8352     <name>get_aggregates</name>
 8353     <summary>Get aggregates of various resources</summary>
 8354     <description>
 8355       <p>
 8356         The client uses the get_aggregate command to get aggregated data like
 8357         counts or averages of various resources.
 8358       </p>
 8359       <p>
 8360         Unlike other get_... commands, get_aggregates ignores the filter
 8361         keywords "first" and "rows". It also does not support selecting single
 8362         items by id or getting items from the trashcan.
 8363       </p>
 8364     </description>
 8365     <pattern>
 8366       <attrib>
 8367         <name>filter</name>
 8368         <summary>Filter term to use to filter query of the resources to aggregate (see get_... commands of selected type for keywords)</summary>
 8369         <type>text</type>
 8370       </attrib>
 8371       <attrib>
 8372         <name>filt_id</name>
 8373         <summary>ID of filter to use to filter query of the resources to aggregate</summary>
 8374         <type>uuid</type>
 8375       </attrib>
 8376       <attrib>
 8377         <name>type</name>
 8378         <summary>The OMP resource type to gather data from</summary>
 8379         <type>text</type>
 8380         <required>1</required>
 8381       </attrib>
 8382       <attrib>
 8383         <name>data_column</name>
 8384         <summary>A single column to get the data to aggregate from</summary>
 8385         <type>text</type>
 8386       </attrib>
 8387       <attrib>
 8388         <name>group_column</name>
 8389         <summary>The field to group the resources by</summary>
 8390         <type>text</type>
 8391       </attrib>
 8392       <attrib>
 8393         <name>subgroup_column</name>
 8394         <summary>The field to further group the resources inside groups by</summary>
 8395         <type>text</type>
 8396       </attrib>
 8397       <attrib>
 8398         <name>sort_field</name>
 8399         <summary>The column to sort the aggregated rows by.
 8400         With a subgroup column, groups will be sorted by the group_column first.</summary>
 8401         <type>text</type>
 8402       </attrib>
 8403       <attrib>
 8404         <name>sort_order</name>
 8405         <summary>The order to sort by</summary>
 8406         <type>
 8407           <alts>
 8408             <alt>ascending</alt>
 8409             <alt>descending</alt>
 8410           </alts>
 8411         </type>
 8412       </attrib>
 8413       <attrib>
 8414         <name>sort_stat</name>
 8415         <summary>The statistic to sort the aggregated rows by</summary>
 8416         <type>
 8417           <alts>
 8418             <alt>min</alt>
 8419             <alt>max</alt>
 8420             <alt>mean</alt>
 8421             <alt>sum</alt>
 8422             <alt>count</alt>
 8423             <alt>value</alt>
 8424           </alts>
 8425         </type>
 8426       </attrib>
 8427       <attrib>
 8428         <name>first_group</name>
 8429         <summary>The index of the first aggregate group to return</summary>
 8430         <type>integer</type>
 8431       </attrib>
 8432       <attrib>
 8433         <name>max_groups</name>
 8434         <summary>The maximum number of aggregate groups to return, -1 for all</summary>
 8435         <type>integer</type>
 8436       </attrib>
 8437       <attrib>
 8438         <name>mode</name>
 8439         <summary>Special mode for aggregation</summary>
 8440         <type>
 8441           <alts>
 8442             <alt></alt>
 8443             <alt>word_counts</alt>
 8444           </alts>
 8445         </type>
 8446       </attrib>
 8447       <any><e>sort</e></any>
 8448       <any><e>data_column</e></any>
 8449       <any><e>text_column</e></any>
 8450     </pattern>
 8451     <ele>
 8452       <name>sort</name>
 8453       <summary>Optional tuples of sort criteria</summary>
 8454       <pattern>
 8455         <attrib>
 8456           <name>sort_field</name>
 8457           <summary>The column to sort the aggregated rows by.
 8458           With a subgroup column, groups will be sorted by the group_column first.</summary>
 8459           <type>text</type>
 8460         </attrib>
 8461         <attrib>
 8462           <name>sort_order</name>
 8463           <summary>The order to sort by</summary>
 8464           <type>
 8465             <alts>
 8466               <alt>ascending</alt>
 8467               <alt>descending</alt>
 8468             </alts>
 8469           </type>
 8470         </attrib>
 8471         <attrib>
 8472           <name>sort_stat</name>
 8473           <summary>The statistic to sort the aggregated rows by</summary>
 8474           <type>
 8475             <alts>
 8476               <alt>min</alt>
 8477               <alt>max</alt>
 8478               <alt>mean</alt>
 8479               <alt>sum</alt>
 8480               <alt>count</alt>
 8481               <alt>value</alt>
 8482             </alts>
 8483           </type>
 8484         </attrib>
 8485       </pattern>
 8486     </ele>
 8487     <ele>
 8488       <name>data_column</name>
 8489       <summary>A column to get the data to aggregate from</summary>
 8490       <type>text</type>
 8491     </ele>
 8492     <ele>
 8493       <name>text_column</name>
 8494       <summary>A simple text column which no statistics are calculated for</summary>
 8495       <type>text</type>
 8496     </ele>
 8497     <response>
 8498       <pattern>
 8499         <attrib>
 8500           <name>status</name>
 8501           <type>status</type>
 8502           <required>1</required>
 8503         </attrib>
 8504         <attrib>
 8505           <name>status_text</name>
 8506           <type>text</type>
 8507           <required>1</required>
 8508         </attrib>
 8509         <any><e>aggregate</e></any>
 8510         <e>filters</e>
 8511       </pattern>
 8512       <ele>
 8513         <name>aggregate</name>
 8514         <summary>A collection of aggregated data of the selected type</summary>
 8515         <pattern>
 8516           <e>data_type</e>
 8517           <any><e>data_column</e></any>
 8518           <o><e>group_column</e></o>
 8519           <any><e>text_column</e></any>
 8520           <or>
 8521             <any><e>group</e></any>
 8522             <e>overall</e>
 8523           </or>
 8524           <o><e>subgroups</e></o>
 8525           <e>column_info</e>
 8526         </pattern>
 8527         <ele>
 8528           <name>data_type</name>
 8529           <summary>The resource type the data is aggregated from</summary>
 8530           <pattern><t>text</t></pattern>
 8531         </ele>
 8532         <ele>
 8533           <name>data_column</name>
 8534           <summary>A column the data is aggregated from</summary>
 8535           <pattern><t>text</t></pattern>
 8536         </ele>
 8537         <ele>
 8538           <name>group_column</name>
 8539           <summary>The column the data is grouped by</summary>
 8540           <pattern><t>text</t></pattern>
 8541         </ele>
 8542         <ele>
 8543           <name>text_column</name>
 8544           <summary>A simple text column</summary>
 8545           <pattern><t>text</t></pattern>
 8546         </ele>
 8547         <ele>
 8548           <name>group</name>
 8549           <summary>Aggregate data for a group of resources</summary>
 8550           <pattern>
 8551             <e>value</e>
 8552             <any><e>subgroup</e></any>
 8553             <e>count</e>
 8554             <e>c_count</e>
 8555             <any><e>stats</e></any>
 8556             <any><e>text</e></any>
 8557           </pattern>
 8558           <ele>
 8559             <name>value</name>
 8560             <summary>Value of the group column</summary>
 8561             <pattern><t>text</t></pattern>
 8562           </ele>
 8563           <ele>
 8564             <name>subgroup</name>
 8565             <summary>Aggregate data for a subgroup of resources</summary>
 8566             <pattern>
 8567               <e>value</e>
 8568               <e>count</e>
 8569               <e>c_count</e>
 8570               <any><e>stats</e></any>
 8571             </pattern>
 8572             <ele>
 8573               <name>value</name>
 8574               <summary>Value of the subgroup column</summary>
 8575               <pattern><t>text</t></pattern>
 8576             </ele>
 8577             <ele>
 8578               <name>count</name>
 8579               <summary>Number of resources in the subgroup</summary>
 8580               <pattern><t>integer</t></pattern>
 8581             </ele>
 8582             <ele>
 8583               <name>c_count</name>
 8584               <summary>Cumulative number of resources in the current subgroup</summary>
 8585               <pattern><t>integer</t></pattern>
 8586             </ele>
 8587             <ele>
 8588               <name>stats</name>
 8589               <summary>Statistics of a data column for the current subgroup</summary>
 8590               <pattern>
 8591                 <attrib>
 8592                   <name>column</name>
 8593                   <summary>Name of the column the stats apply to</summary>
 8594                   <type>text</type>
 8595                 </attrib>
 8596                 <e>min</e>
 8597                 <e>max</e>
 8598                 <e>mean</e>
 8599                 <e>sum</e>
 8600                 <e>c_sum</e>
 8601               </pattern>
 8602               <ele>
 8603                 <name>min</name>
 8604                 <summary>Minimum value of the data column</summary>
 8605                 <pattern><t>text</t></pattern>
 8606               </ele>
 8607               <ele>
 8608                 <name>max</name>
 8609                 <summary>Maximum value of the data column</summary>
 8610                 <pattern><t>text</t></pattern>
 8611               </ele>
 8612               <ele>
 8613                 <name>mean</name>
 8614                 <summary>Arithmetic mean of the numeric values of the data</summary>
 8615                 <pattern><t>text</t></pattern>
 8616               </ele>
 8617               <ele>
 8618                 <name>sum</name>
 8619                 <summary>Sum of the numeric values of the data column</summary>
 8620                 <pattern><t>text</t></pattern>
 8621               </ele>
 8622               <ele>
 8623                 <name>c_sum</name>
 8624                 <summary>Cumulative sum of the data column</summary>
 8625                 <pattern><t>text</t></pattern>
 8626               </ele>
 8627             </ele>
 8628           </ele>
 8629           <ele>
 8630             <name>count</name>
 8631             <summary>Number of resources in the group</summary>
 8632             <pattern><t>integer</t></pattern>
 8633           </ele>
 8634           <ele>
 8635             <name>c_count</name>
 8636             <summary>Cumulative number of resources in all groups up to and including the current one</summary>
 8637             <pattern><t>integer</t></pattern>
 8638           </ele>
 8639           <ele>
 8640             <name>text</name>
 8641             <summary>The value of a simple text column.</summary>
 8642             <pattern>
 8643               <attrib>
 8644                 <name>name</name>
 8645                 <summary>Name of the text column</summary>
 8646                 <type>text</type>
 8647               </attrib>
 8648               text
 8649             </pattern>
 8650           </ele>
 8651           <ele>
 8652             <name>stats</name>
 8653             <summary>Statistics of a data column</summary>
 8654             <pattern>
 8655               <attrib>
 8656                 <name>column</name>
 8657                 <summary>Name of the column the stats apply to</summary>
 8658                 <type>text</type>
 8659               </attrib>
 8660               <e>min</e>
 8661               <e>max</e>
 8662               <e>mean</e>
 8663               <e>sum</e>
 8664               <e>c_sum</e>
 8665             </pattern>
 8666             <ele>
 8667               <name>min</name>
 8668               <summary>Minimum value of the data column</summary>
 8669               <pattern><t>text</t></pattern>
 8670             </ele>
 8671             <ele>
 8672               <name>max</name>
 8673               <summary>Maximum value of the data column</summary>
 8674               <pattern><t>text</t></pattern>
 8675             </ele>
 8676             <ele>
 8677               <name>mean</name>
 8678               <summary>Arithmetic mean of the numeric values of the data</summary>
 8679               <pattern><t>text</t></pattern>
 8680             </ele>
 8681             <ele>
 8682               <name>sum</name>
 8683               <summary>Sum of the numeric values of the data column</summary>
 8684               <pattern><t>text</t></pattern>
 8685             </ele>
 8686             <ele>
 8687               <name>c_sum</name>
 8688               <summary>Cumulative sum of the numeric values of the data column for all groups up to and including the current one</summary>
 8689               <pattern><t>text</t></pattern>
 8690             </ele>
 8691           </ele>
 8692         </ele>
 8693         <ele>
 8694           <name>overall</name>
 8695           <summary>Aggregate data for all resources of the selected type</summary>
 8696           <pattern>
 8697             <e>count</e>
 8698             <e>min</e>
 8699             <e>max</e>
 8700             <e>mean</e>
 8701             <e>sum</e>
 8702           </pattern>
 8703           <ele>
 8704             <name>count</name>
 8705             <summary>Overall number of resources</summary>
 8706             <pattern><t>integer</t></pattern>
 8707           </ele>
 8708           <ele>
 8709             <name>min</name>
 8710             <summary>Overall minimum value of the data column</summary>
 8711             <pattern><t>text</t></pattern>
 8712           </ele>
 8713           <ele>
 8714             <name>max</name>
 8715             <summary>Overall maximum value of the data column</summary>
 8716             <pattern><t>text</t></pattern>
 8717           </ele>
 8718           <ele>
 8719             <name>mean</name>
 8720             <summary>Overall arithmetic mean of the numeric values of the data</summary>
 8721             <pattern><t>text</t></pattern>
 8722           </ele>
 8723           <ele>
 8724             <name>sum</name>
 8725             <summary>Overall sum of the numeric values of the data column</summary>
 8726             <pattern><t>text</t></pattern>
 8727           </ele>
 8728         </ele>
 8729         <ele>
 8730           <name>subgroups</name>
 8731           <summary>Overview of all subgroup values</summary>
 8732           <pattern>
 8733             <any><e>value</e></any>
 8734           </pattern>
 8735           <ele>
 8736             <name>value</name>
 8737             <summary>Value of the subgroup column</summary>
 8738             <pattern><t>text</t></pattern>
 8739           </ele>
 8740         </ele>
 8741         <ele>
 8742           <name>column_info</name>
 8743           <summary>Info on the aggregate columns</summary>
 8744           <pattern>
 8745             <any><e>aggregate_column</e></any>
 8746           </pattern>
 8747           <ele>
 8748             <name>aggregate_column</name>
 8749             <summary>Info on one column of the aggregate</summary>
 8750             <pattern>
 8751               <e>name</e>
 8752               <e>stat</e>
 8753               <e>type</e>
 8754               <e>column</e>
 8755               <e>data_type</e>
 8756             </pattern>
 8757             <ele>
 8758               <name>name</name>
 8759               <summary>Name of the column as it appears in the group or overall element</summary>
 8760               <pattern><t>text</t></pattern>
 8761             </ele>
 8762             <ele>
 8763               <name>stat</name>
 8764               <summary>The type of statistic in the column, e.g. min, max, mean</summary>
 8765               <pattern><t>text</t></pattern>
 8766             </ele>
 8767             <ele>
 8768               <name>type</name>
 8769               <summary>The resource type</summary>
 8770               <pattern><t>text</t></pattern>
 8771             </ele>
 8772             <ele>
 8773               <name>column</name>
 8774               <summary>Name of the column in the non-aggregated table</summary>
 8775               <pattern><t>text</t></pattern>
 8776             </ele>
 8777             <ele>
 8778               <name>data_type</name>
 8779               <summary>The data type of the column, e.g. integer, text, cvss</summary>
 8780               <pattern><t>text</t></pattern>
 8781             </ele>
 8782           </ele>
 8783         </ele>
 8784       </ele>
 8785       <ele>
 8786         <name>filters</name>
 8787         <pattern>
 8788           <attrib>
 8789             <name>id</name>
 8790             <summary>UUID of filter if any, else 0</summary>
 8791             <type>uuid</type>
 8792             <required>1</required>
 8793           </attrib>
 8794           <e>term</e>
 8795           <o><e>name</e></o>
 8796           <e>keywords</e>
 8797         </pattern>
 8798         <ele>
 8799           <name>term</name>
 8800           <summary>Filter term</summary>
 8801           <pattern>text</pattern>
 8802         </ele>
 8803         <ele>
 8804           <name>name</name>
 8805           <summary>Filter name, if applicable</summary>
 8806           <pattern>text</pattern>
 8807         </ele>
 8808         <ele>
 8809           <name>keywords</name>
 8810           <summary>Filter broken down into keywords</summary>
 8811           <pattern><any><e>keyword</e></any></pattern>
 8812           <ele>
 8813             <name>keyword</name>
 8814             <pattern>
 8815               <e>column</e>
 8816               <e>relation</e>
 8817               <e>value</e>
 8818             </pattern>
 8819             <ele>
 8820               <name>column</name>
 8821               <summary>Column prefix</summary>
 8822               <pattern>text</pattern>
 8823             </ele>
 8824             <ele>
 8825               <name>relation</name>
 8826               <summary>Relation operator</summary>
 8827               <pattern>
 8828                 <alts>
 8829                   <alt>=</alt>
 8830                   <alt>:</alt>
 8831                   <alt>~</alt>
 8832                   <alt>&gt;</alt>
 8833                   <alt>&lt;</alt>
 8834                 </alts>
 8835               </pattern>
 8836             </ele>
 8837             <ele>
 8838               <name>value</name>
 8839               <summary>The filter text</summary>
 8840               <pattern>text</pattern>
 8841             </ele>
 8842           </ele>
 8843         </ele>
 8844       </ele>
 8845     </response>
 8846     <example>
 8847       <summary>Get severity statistics of NVTs by family</summary>
 8848       <request>
 8849         <get_aggregates type="nvt" group_column="family" data_column="severity">
 8850         </get_aggregates>
 8851       </request>
 8852       <response>
 8853         <get_aggregates_response status_text="OK" status="200">
 8854           <aggregate>
 8855             <data_type>nvt</data_type>
 8856             <data_column>severity</data_column>
 8857             <group_column>family</group_column>
 8858             <group>
 8859               <value>AIX Local Security Checks</value>
 8860               <count>1</count>
 8861               <c_count>1</c_count>
 8862               <min>3.3</min>
 8863               <max>3.3</max>
 8864               <mean>3.3</mean>
 8865               <sum>3.3</sum>
 8866               <c_sum>3.3</c_sum>
 8867             </group>
 8868             <group>
 8869               <value>Brute force attacks</value>
 8870               <count>8</count>
 8871               <c_count>9</c_count>
 8872               <min>0</min>
 8873               <max>7.8</max>
 8874               <mean>6.275</mean>
 8875               <sum>50.2</sum>
 8876               <c_sum>53.5</c_sum>
 8877             </group>
 8878             <group>
 8879               <value>Buffer overflow</value>
 8880               <count>519</count>
 8881               <c_count>528</c_count>
 8882               <min>10</min>
 8883               <max>9.7</max>
 8884               <mean>8.63083</mean>
 8885               <sum>4479.4</sum>
 8886               <c_sum>4532.9</c_sum>
 8887             </group>
 8888             <truncated>...</truncated>
 8889             <column_info>
 8890               <aggregate_column>
 8891                 <name>value</name>
 8892                 <stat>value</stat>
 8893                 <type>nvt</type>
 8894                 <column>family</column>
 8895                 <data_type>text</data_type>
 8896               </aggregate_column>
 8897               <aggregate_column>
 8898                 <name>count</name>
 8899                 <stat>count</stat>
 8900                 <type>nvt</type>
 8901                 <column></column>
 8902                 <data_type>integer</data_type>
 8903               </aggregate_column>
 8904               <aggregate_column>
 8905                 <name>c_count</name>
 8906                 <stat>c_count</stat>
 8907                 <type>nvt</type>
 8908                 <column></column>
 8909                 <data_type>integer</data_type>
 8910               </aggregate_column>
 8911               <aggregate_column>
 8912                 <name>min</name>
 8913                 <stat>min</stat>
 8914                 <type>nvt</type>
 8915                 <column>severity</column>
 8916                 <data_type>cvss</data_type>
 8917               </aggregate_column>
 8918               <truncated>...</truncated>
 8919             </column_info>
 8920           </aggregate>
 8921           <filters id="">
 8922             <term>first=1 rows=-1 sort=name</term>
 8923             <keywords>
 8924               <keyword>
 8925                 <column>first</column>
 8926                 <relation>=</relation>
 8927                 <value>1</value>
 8928               </keyword>
 8929               <keyword>
 8930                 <column>rows</column>
 8931                 <relation>=</relation>
 8932                 <value>-1</value>
 8933               </keyword>
 8934               <keyword>
 8935                 <column>sort</column>
 8936                 <relation>=</relation>
 8937                 <value>name</value>
 8938               </keyword>
 8939             </keywords>
 8940           </filters>
 8941         </get_aggregates_response>
 8942       </response>
 8943     </example>
 8944   </command>
 8945   <command>
 8946     <name>get_alerts</name>
 8947     <summary>Get one or many alerts</summary>
 8948     <description>
 8949       The client uses the get_alerts command to get alert information.
 8950       If the command sent by the client was valid, the manager will
 8951       reply with a list of alerts to the client.
 8952     </description>
 8953     <pattern>
 8954       <attrib>
 8955         <name>alert_id</name>
 8956         <summary>ID of single alert to get</summary>
 8957         <type>uuid</type>
 8958       </attrib>
 8959       <attrib>
 8960         <name>filter</name>
 8961         <summary>Filter term to use to filter query</summary>
 8962         <type>text</type>
 8963         <filter_keywords>
 8964           <column>
 8965             <name>uuid</name>
 8966             <type>uuid</type>
 8967             <summary>Unique ID</summary>
 8968           </column>
 8969           <column>
 8970             <name>name</name>
 8971             <type>name</type>
 8972             <summary>Name</summary>
 8973           </column>
 8974           <column>
 8975             <name>comment</name>
 8976             <type>text</type>
 8977             <summary>Comment text</summary>
 8978           </column>
 8979           <column>
 8980             <name>created</name>
 8981             <type>iso_time</type>
 8982             <summary>Creation time</summary>
 8983           </column>
 8984           <column>
 8985             <name>modified</name>
 8986             <type>iso_time</type>
 8987             <summary>Modification time</summary>
 8988           </column>
 8989           <column>
 8990             <name>owner</name>
 8991             <type>name</type>
 8992             <summary>Name of the owner</summary>
 8993           </column>
 8994           <column>
 8995             <name>event</name>
 8996             <type>integer</type>
 8997             <summary>The event that triggers the alert</summary>
 8998           </column>
 8999           <column>
 9000             <name>condition</name>
 9001             <type>integer</type>
 9002             <summary>The condition for the alert</summary>
 9003           </column>
 9004           <column>
 9005             <name>method</name>
 9006             <type>integer</type>
 9007             <summary>The method of the alert</summary>
 9008           </column>
 9009           <column>
 9010             <name>filter</name>
 9011             <type>uuid</type>
 9012             <summary>UUID of the filter applied to the report</summary>
 9013           </column>
 9014         </filter_keywords>
 9015       </attrib>
 9016       <attrib>
 9017         <name>filt_id</name>
 9018         <summary>ID of filter to use to filter query</summary>
 9019         <type>uuid</type>
 9020       </attrib>
 9021       <attrib>
 9022         <name>trash</name>
 9023         <summary>Whether to get the trashcan alerts instead</summary>
 9024         <type>boolean</type>
 9025       </attrib>
 9026       <attrib>
 9027         <name>tasks</name>
 9028         <summary>Whether to get the tasks using the alerts</summary>
 9029         <type>boolean</type>
 9030       </attrib>
 9031     </pattern>
 9032     <response>
 9033       <pattern>
 9034         <attrib>
 9035           <name>status</name>
 9036           <type>status</type>
 9037           <required>1</required>
 9038         </attrib>
 9039         <attrib>
 9040           <name>status_text</name>
 9041           <type>text</type>
 9042           <required>1</required>
 9043         </attrib>
 9044         <any><e>alert</e></any>
 9045         <e>filters</e>
 9046         <e>sort</e>
 9047         <e>alerts</e>
 9048         <e>alert_count</e>
 9049       </pattern>
 9050       <ele>
 9051         <name>alert</name>
 9052         <pattern>
 9053           <attrib>
 9054             <name>id</name>
 9055             <type>uuid</type>
 9056             <required>1</required>
 9057           </attrib>
 9058           <e>owner</e>
 9059           <e>name</e>
 9060           <e>comment</e>
 9061           <e>creation_time</e>
 9062           <e>modification_time</e>
 9063           <e>in_use</e>
 9064           <e>writable</e>
 9065           <e>permissions</e>
 9066           <e>user_tags</e>
 9067           <e>condition</e>
 9068           <e>event</e>
 9069           <e>method</e>
 9070           <e>filter</e>
 9071           <o><e>tasks</e></o>
 9072         </pattern>
 9073         <ele>
 9074           <name>owner</name>
 9075           <summary>Owner of the alert</summary>
 9076           <pattern>
 9077             <e>name</e>
 9078           </pattern>
 9079           <ele>
 9080             <name>name</name>
 9081             <summary>The name of the owner</summary>
 9082             <pattern><t>name</t></pattern>
 9083           </ele>
 9084         </ele>
 9085         <ele>
 9086           <name>name</name>
 9087           <summary>The name of the alert</summary>
 9088           <pattern><t>name</t></pattern>
 9089         </ele>
 9090         <ele>
 9091           <name>comment</name>
 9092           <summary>The comment on the alert</summary>
 9093           <pattern>
 9094             text
 9095           </pattern>
 9096         </ele>
 9097         <ele>
 9098           <name>in_use</name>
 9099           <summary>Whether any tasks are using the alert</summary>
 9100           <pattern><t>boolean</t></pattern>
 9101         </ele>
 9102         <ele>
 9103           <name>writable</name>
 9104           <summary>Whether the alert is writable or not</summary>
 9105           <pattern><t>boolean</t></pattern>
 9106         </ele>
 9107         <ele>
 9108           <name>creation_time</name>
 9109           <summary>Creation time of the alert</summary>
 9110           <pattern><t>iso_time</t></pattern>
 9111         </ele>
 9112         <ele>
 9113           <name>modification_time</name>
 9114           <summary>Last time the alert was modified</summary>
 9115           <pattern><t>iso_time</t></pattern>
 9116         </ele>
 9117         <ele>
 9118           <name>permissions</name>
 9119           <summary>Permissions that the current user has on the alert</summary>
 9120           <pattern>
 9121             <any><e>permission</e></any>
 9122           </pattern>
 9123           <ele>
 9124             <name>permission</name>
 9125             <pattern>
 9126               <e>name</e>
 9127             </pattern>
 9128             <ele>
 9129               <name>name</name>
 9130               <summary>The name of the permission</summary>
 9131               <pattern><t>name</t></pattern>
 9132             </ele>
 9133           </ele>
 9134         </ele>
 9135         <ele>
 9136           <name>user_tags</name>
 9137           <summary>Info on tags attached to the alert</summary>
 9138           <pattern>
 9139             <e>count</e>
 9140             <any><e>tag</e></any>
 9141           </pattern>
 9142           <ele>
 9143             <name>count</name>
 9144             <summary>Number of attached tags</summary>
 9145             <pattern><t>integer</t></pattern>
 9146           </ele>
 9147           <ele>
 9148             <name>tag</name>
 9149             <summary>
 9150               Short info on an individual tag
 9151               (only if details were requested)
 9152             </summary>
 9153             <pattern>
 9154               <attrib>
 9155                 <name>id</name>
 9156                 <type>uuid</type>
 9157                 <summary>UUID of the tag</summary>
 9158                 <required>1</required>
 9159               </attrib>
 9160               <e>name</e>
 9161               <e>value</e>
 9162               <e>comment</e>
 9163             </pattern>
 9164             <ele>
 9165               <name>name</name>
 9166               <summary>Name of the tag (usually namespace:predicate)</summary>
 9167               <pattern>text</pattern>
 9168             </ele>
 9169             <ele>
 9170               <name>value</name>
 9171               <summary>Value of the tag</summary>
 9172               <pattern>text</pattern>
 9173             </ele>
 9174             <ele>
 9175               <name>comment</name>
 9176               <summary>Comment for the tag</summary>
 9177               <pattern>text</pattern>
 9178             </ele>
 9179           </ele>
 9180         </ele>
 9181         <ele>
 9182           <name>condition</name>
 9183           <summary>
 9184             The condition that must be satisfied for the alert to occur
 9185           </summary>
 9186           <pattern>
 9187             text
 9188             <any><e>data</e></any>
 9189           </pattern>
 9190           <ele>
 9191             <name>data</name>
 9192             <summary>Some data that defines the condition</summary>
 9193             <pattern>
 9194               text
 9195               <e>name</e>
 9196             </pattern>
 9197             <ele>
 9198               <name>name</name>
 9199               <summary>The name of the condition data</summary>
 9200               <pattern>
 9201                 text
 9202               </pattern>
 9203             </ele>
 9204           </ele>
 9205         </ele>
 9206         <ele>
 9207           <name>event</name>
 9208           <summary>The event that must happen for the alert to occur</summary>
 9209           <pattern>
 9210             text
 9211             <any><e>data</e></any>
 9212           </pattern>
 9213           <ele>
 9214             <name>data</name>
 9215             <summary>Some data that defines the event</summary>
 9216             <pattern>
 9217               text
 9218               <e>name</e>
 9219             </pattern>
 9220             <ele>
 9221               <name>name</name>
 9222               <summary>The name of the event data</summary>
 9223               <pattern>
 9224                 text
 9225               </pattern>
 9226             </ele>
 9227           </ele>
 9228         </ele>
 9229         <ele>
 9230           <name>method</name>
 9231           <summary>The method by which he alert must occur</summary>
 9232           <pattern>
 9233             text
 9234             <any><e>data</e></any>
 9235           </pattern>
 9236           <ele>
 9237             <name>data</name>
 9238             <summary>Some data that defines the method</summary>
 9239             <pattern>
 9240               text
 9241               <e>name</e>
 9242               <o><e>credential</e></o>
 9243             </pattern>
 9244             <ele>
 9245               <name>name</name>
 9246               <summary>The name of the method data</summary>
 9247               <pattern>
 9248                 text
 9249               </pattern>
 9250             </ele>
 9251             <ele>
 9252               <name>credential</name>
 9253               <summary>Credential information if the data is a credential ID</summary>
 9254               <pattern>
 9255                 <attrib>
 9256                   <name>id</name>
 9257                   <type>uuid</type>
 9258                   <summary>UUID of the credential</summary>
 9259                 </attrib>
 9260                 <e>name</e>
 9261                 <e>login</e>
 9262               </pattern>
 9263               <ele>
 9264                 <name>name</name>
 9265                 <summary>The name of the credential</summary>
 9266                 <pattern><t>name</t></pattern>
 9267               </ele>
 9268               <ele>
 9269                 <name>login</name>
 9270                 <summary>The username of the credential</summary>
 9271                 <pattern><t>name</t></pattern>
 9272               </ele>
 9273             </ele>
 9274           </ele>
 9275         </ele>
 9276         <ele>
 9277           <name>filter</name>
 9278           <pattern>
 9279             <attrib>
 9280               <name>id</name>
 9281               <type>uuid</type>
 9282             </attrib>
 9283             <e>name</e>
 9284             <o><e>permissions</e></o>
 9285             <e>trash</e>
 9286           </pattern>
 9287           <ele>
 9288             <name>name</name>
 9289             <summary>The name of the filter</summary>
 9290             <pattern><t>name</t></pattern>
 9291           </ele>
 9292           <ele>
 9293             <name>permissions</name>
 9294             <summary>Permissions the user has on the filter</summary>
 9295             <pattern></pattern>
 9296           </ele>
 9297           <ele>
 9298             <name>trash</name>
 9299             <summary>Whether the filter is in the trashcan</summary>
 9300             <pattern><t>boolean</t></pattern>
 9301           </ele>
 9302         </ele>
 9303         <ele>
 9304           <name>tasks</name>
 9305           <summary>Tasks using the alert</summary>
 9306           <pattern>
 9307             <any><e>task</e></any>
 9308           </pattern>
 9309           <ele>
 9310             <name>task</name>
 9311             <pattern>
 9312               <attrib>
 9313                 <name>id</name>
 9314                 <type>uuid</type>
 9315                 <required>1</required>
 9316               </attrib>
 9317               <e>name</e>
 9318               <o><e>permissions</e></o>
 9319             </pattern>
 9320             <ele>
 9321               <name>name</name>
 9322               <summary>The name of the task</summary>
 9323               <pattern><t>name</t></pattern>
 9324             </ele>
 9325             <ele>
 9326               <name>permissions</name>
 9327               <summary>Permissions the user has on the task</summary>
 9328               <pattern></pattern>
 9329             </ele>
 9330           </ele>
 9331         </ele>
 9332       </ele>
 9333       <ele>
 9334         <name>filters</name>
 9335         <pattern>
 9336           <attrib>
 9337             <name>id</name>
 9338             <summary>UUID of filter if any, else 0</summary>
 9339             <type>uuid</type>
 9340             <required>1</required>
 9341           </attrib>
 9342           <e>term</e>
 9343           <o><e>name</e></o>
 9344           <e>keywords</e>
 9345         </pattern>
 9346         <ele>
 9347           <name>term</name>
 9348           <summary>Filter term</summary>
 9349           <pattern>text</pattern>
 9350         </ele>
 9351         <ele>
 9352           <name>name</name>
 9353           <summary>Filter name, if applicable</summary>
 9354           <pattern>text</pattern>
 9355         </ele>
 9356         <ele>
 9357           <name>keywords</name>
 9358           <summary>Filter broken down into keywords</summary>
 9359           <pattern><any><e>keyword</e></any></pattern>
 9360           <ele>
 9361             <name>keyword</name>
 9362             <pattern>
 9363               <e>column</e>
 9364               <e>relation</e>
 9365               <e>value</e>
 9366             </pattern>
 9367             <ele>
 9368               <name>column</name>
 9369               <summary>Column prefix</summary>
 9370               <pattern>text</pattern>
 9371             </ele>
 9372             <ele>
 9373               <name>relation</name>
 9374               <summary>Relation operator</summary>
 9375               <pattern>
 9376                 <alts>
 9377                   <alt>=</alt>
 9378                   <alt>:</alt>
 9379                   <alt>~</alt>
 9380                   <alt>&gt;</alt>
 9381                   <alt>&lt;</alt>
 9382                 </alts>
 9383               </pattern>
 9384             </ele>
 9385             <ele>
 9386               <name>value</name>
 9387               <summary>The filter text</summary>
 9388               <pattern>text</pattern>
 9389             </ele>
 9390           </ele>
 9391         </ele>
 9392       </ele>
 9393       <ele>
 9394         <name>sort</name>
 9395         <pattern>
 9396           text
 9397           <e>field</e>
 9398         </pattern>
 9399         <ele>
 9400           <name>field</name>
 9401           <pattern>
 9402             <e>order</e>
 9403           </pattern>
 9404           <ele>
 9405             <name>order</name>
 9406             <pattern>
 9407               <t>
 9408                 <alts>
 9409                   <alt>ascending</alt>
 9410                   <alt>descending</alt>
 9411                 </alts>
 9412               </t>
 9413             </pattern>
 9414           </ele>
 9415         </ele>
 9416       </ele>
 9417       <ele>
 9418         <name>alerts</name>
 9419         <pattern>
 9420           <attrib>
 9421             <name>start</name>
 9422             <summary>First alert</summary>
 9423             <type>integer</type>
 9424             <required>1</required>
 9425           </attrib>
 9426           <attrib>
 9427             <name>max</name>
 9428             <summary>Maximum number of alerts</summary>
 9429             <type>integer</type>
 9430             <required>1</required>
 9431           </attrib>
 9432         </pattern>
 9433       </ele>
 9434       <ele>
 9435         <name>alert_count</name>
 9436         <pattern>
 9437           <e>filtered</e>
 9438           <e>page</e>
 9439         </pattern>
 9440         <ele>
 9441           <name>filtered</name>
 9442           <summary>Number of alerts after filtering</summary>
 9443           <pattern><t>integer</t></pattern>
 9444         </ele>
 9445         <ele>
 9446           <name>page</name>
 9447           <summary>Number of alerts on current page</summary>
 9448           <pattern><t>integer</t></pattern>
 9449         </ele>
 9450       </ele>
 9451     </response>
 9452     <example>
 9453       <summary>Get the alerts</summary>
 9454       <request>
 9455         <get_alerts></get_alerts>
 9456       </request>
 9457       <response>
 9458         <get_alerts_response status="200" status_text="OK">
 9459           <alert id="6181e65d-8ba0-4937-9c44-8f2b10b0def7">
 9460             <name>Team alert</name>
 9461             <comment></comment>
 9462             <creation_time>2012-04-27T12:44:00+01:00</creation_time>
 9463             <modification_time>2012-08-28T12:14:00+01:00</modification_time>
 9464             <writable>1</writable>
 9465             <in_use>1</in_use>
 9466             <user_tags>
 9467               <count>0</count>
 9468             </user_tags>
 9469             <condition>
 9470               Threat level at least
 9471               <data>
 9472                 <name>level</name>
 9473                 High
 9474               </data>
 9475             </condition>
 9476             <event>
 9477               Task run status changed
 9478               <data>
 9479                 <name>status</name>
 9480                 Done
 9481               </data>
 9482             </event>
 9483             <method>
 9484               Email
 9485               <data>
 9486                 <name>to_address</name>
 9487                 team@example.org
 9488               </data>
 9489               <data>
 9490                 <name>from_address</name>
 9491                 admin@example.org
 9492               </data>
 9493               <data>
 9494                 <name>notice</name>
 9495                 0
 9496               </data>
 9497             </method>
 9498           </alert>
 9499           <truncated>...</truncated>
 9500         </get_alerts_response>
 9501       </response>
 9502     </example>
 9503   </command>
 9504   <command>
 9505     <name>get_assets</name>
 9506     <summary>Get one or many assets</summary>
 9507     <description>
 9508       The client uses the get_assets command to get asset information.
 9509     </description>
 9510     <pattern>
 9511       <attrib>
 9512         <name>asset_id</name>
 9513         <summary>ID of single asset to get</summary>
 9514         <type>uuid</type>
 9515       </attrib>
 9516       <attrib>
 9517         <name>filter</name>
 9518         <summary>Filter term to use to filter query</summary>
 9519         <type>text</type>
 9520         <filter_keywords>
 9521           <column>
 9522             <name>uuid</name>
 9523             <type>uuid</type>
 9524             <summary>Unique ID</summary>
 9525           </column>
 9526           <column>
 9527             <name>name</name>
 9528             <type>name</type>
 9529             <summary>Name</summary>
 9530           </column>
 9531           <column>
 9532             <name>comment</name>
 9533             <type>text</type>
 9534             <summary>Comment text</summary>
 9535           </column>
 9536           <column>
 9537             <name>created</name>
 9538             <type>iso_time</type>
 9539             <summary>Creation time</summary>
 9540           </column>
 9541           <column>
 9542             <name>modified</name>
 9543             <type>iso_time</type>
 9544             <summary>Modification time</summary>
 9545           </column>
 9546           <column>
 9547             <name>owner</name>
 9548             <type>name</type>
 9549             <summary>Name of the owner</summary>
 9550           </column>
 9551         </filter_keywords>
 9552         <filter_keywords>
 9553           <condition>type is "host"</condition>
 9554           <column>
 9555             <name>severity</name>
 9556             <type>severity</type>
 9557             <summary>Highest severity of the asset from latest report</summary>
 9558           </column>
 9559           <column>
 9560             <name>os</name>
 9561             <type>text</type>
 9562             <summary>Best matching OS</summary>
 9563           </column>
 9564           <column>
 9565             <name>oss</name>
 9566             <type>text</type>
 9567             <summary>Comma-separated list of all OSs of the host</summary>
 9568           </column>
 9569           <column>
 9570             <name>hostname</name>
 9571             <type>text</type>
 9572             <summary>Hostname</summary>
 9573           </column>
 9574           <column>
 9575             <name>ip</name>
 9576             <type>ip</type>
 9577             <summary>IP address</summary>
 9578           </column>
 9579         </filter_keywords>
 9580         <filter_keywords>
 9581           <condition>type is "os"</condition>
 9582           <column>
 9583             <name>title</name>
 9584             <type>text</type>
 9585             <summary>CPE title of the asset</summary>
 9586           </column>
 9587           <column>
 9588             <name>hosts</name>
 9589             <type>integer</type>
 9590             <summary>Number of hosts using the asset</summary>
 9591           </column>
 9592           <column>
 9593             <name>latest_severity</name>
 9594             <type>severity</type>
 9595             <summary>Latest severity score of the asset</summary>
 9596           </column>
 9597           <column>
 9598             <name>highest_severity</name>
 9599             <type>severity</type>
 9600             <summary>Latest severity score of the asset</summary>
 9601           </column>
 9602           <column>
 9603             <name>average_severity</name>
 9604             <type>severity</type>
 9605             <summary>Average severity score of the asset</summary>
 9606           </column>
 9607         </filter_keywords>
 9608       </attrib>
 9609       <attrib>
 9610         <name>filt_id</name>
 9611         <summary>ID of filter to use to filter query</summary>
 9612         <type>uuid</type>
 9613       </attrib>
 9614       <attrib>
 9615         <name>ignore_pagination</name>
 9616         <summary>
 9617           Whether to ignore info used to split the report into pages
 9618           like the filter terms "first" and "rows"
 9619         </summary>
 9620         <type>boolean</type>
 9621       </attrib>
 9622     </pattern>
 9623     <response>
 9624       <pattern>
 9625         <attrib>
 9626           <name>status</name>
 9627           <type>status</type>
 9628           <required>1</required>
 9629         </attrib>
 9630         <attrib>
 9631           <name>status_text</name>
 9632           <type>text</type>
 9633           <required>1</required>
 9634         </attrib>
 9635         <any><e>asset</e></any>
 9636         <e>filters</e>
 9637         <e>sort</e>
 9638         <e>assets</e>
 9639         <e>asset_count</e>
 9640       </pattern>
 9641       <ele>
 9642         <name>asset</name>
 9643         <pattern>
 9644           <attrib>
 9645             <name>id</name>
 9646             <type>uuid</type>
 9647             <required>1</required>
 9648           </attrib>
 9649           <e>owner</e>
 9650           <e>name</e>
 9651           <e>comment</e>
 9652           <e>creation_time</e>
 9653           <e>modification_time</e>
 9654           <e>writable</e>
 9655           <e>in_use</e>
 9656           <e>permissions</e>
 9657           <e>user_tags</e>
 9658           <o><e>identifiers</e></o>
 9659           <or>
 9660             <e>host</e>
 9661             <e>os</e>
 9662           </or>
 9663         </pattern>
 9664         <ele>
 9665           <name>owner</name>
 9666           <summary>Owner of the asset</summary>
 9667           <pattern>
 9668             <e>name</e>
 9669           </pattern>
 9670           <ele>
 9671             <name>name</name>
 9672             <summary>The name of the owner</summary>
 9673             <pattern><t>name</t></pattern>
 9674           </ele>
 9675         </ele>
 9676         <ele>
 9677           <name>name</name>
 9678           <summary>The name of the asset</summary>
 9679           <pattern><t>name</t></pattern>
 9680         </ele>
 9681         <ele>
 9682           <name>comment</name>
 9683           <summary>The comment on the asset</summary>
 9684           <pattern>text</pattern>
 9685         </ele>
 9686         <ele>
 9687           <name>creation_time</name>
 9688           <summary>Date and time the asset was created</summary>
 9689           <pattern><t>iso_time</t></pattern>
 9690         </ele>
 9691         <ele>
 9692           <name>modification_time</name>
 9693           <summary>Date and time the asset was last modified</summary>
 9694           <pattern><t>iso_time</t></pattern>
 9695         </ele>
 9696         <ele>
 9697           <name>identifiers</name>
 9698           <summary>Host identifiers</summary>
 9699           <pattern>
 9700             <e>identifier</e>
 9701           </pattern>
 9702           <ele>
 9703             <name>identifier</name>
 9704             <summary>A single identifier</summary>
 9705             <pattern>
 9706               <e>name</e>
 9707               <e>value</e>
 9708               <e>creation_time</e>
 9709               <e>modification_time</e>
 9710               <e>source</e>
 9711               <o><e>os</e></o>
 9712             </pattern>
 9713             <ele>
 9714               <name>name</name>
 9715               <summary>The name of the identifier</summary>
 9716               <pattern><t>name</t></pattern>
 9717             </ele>
 9718             <ele>
 9719               <name>value</name>
 9720               <summary>The value of the identifier</summary>
 9721               <pattern>text</pattern>
 9722             </ele>
 9723             <ele>
 9724               <name>creation_time</name>
 9725               <summary>Date and time the identifier was created</summary>
 9726               <pattern><t>iso_time</t></pattern>
 9727             </ele>
 9728             <ele>
 9729               <name>modification_time</name>
 9730               <summary>Date and time the identifier was last modified</summary>
 9731               <pattern><t>iso_time</t></pattern>
 9732             </ele>
 9733             <ele>
 9734               <name>source</name>
 9735               <summary>The source of the identifier</summary>
 9736               <pattern>
 9737                 <attrib>
 9738                   <name>id</name>
 9739                   <type>uuid</type>
 9740                   <required>1</required>
 9741                 </attrib>
 9742                 <e>type</e>
 9743                 <e>data</e>
 9744                 <e>deleted</e>
 9745               </pattern>
 9746               <ele>
 9747                 <name>type</name>
 9748                 <summary>Type of source</summary>
 9749                 <pattern>text</pattern>
 9750               </ele>
 9751               <ele>
 9752                 <name>data</name>
 9753                 <summary>Extra data, depends on type of source</summary>
 9754                 <pattern>text</pattern>
 9755               </ele>
 9756               <ele>
 9757                 <name>deleted</name>
 9758                 <summary>Whether the source has been deleted</summary>
 9759                 <pattern>boolean</pattern>
 9760               </ele>
 9761             </ele>
 9762             <ele>
 9763               <name>os</name>
 9764               <pattern>
 9765                 <attrib>
 9766                   <name>id</name>
 9767                   <type>uuid</type>
 9768                   <required>1</required>
 9769                 </attrib>
 9770                 <e>title</e>
 9771               </pattern>
 9772               <ele>
 9773                 <name>title</name>
 9774                 <summary>Title of OS</summary>
 9775                 <pattern>text</pattern>
 9776               </ele>
 9777             </ele>
 9778           </ele>
 9779         </ele>
 9780         <ele>
 9781           <name>host</name>
 9782           <summary>A host</summary>
 9783           <pattern>
 9784             <e>severity</e>
 9785             <any><e>detail</e></any>
 9786             <e>routes</e>
 9787           </pattern>
 9788           <ele>
 9789             <name>severity</name>
 9790             <summary>Severity of the host</summary>
 9791             <pattern>
 9792               <e>value</e>
 9793             </pattern>
 9794             <ele>
 9795               <name>value</name>
 9796               <pattern><t>severity</t></pattern>
 9797             </ele>
 9798           </ele>
 9799           <ele>
 9800             <name>detail</name>
 9801             <summary>A host detail</summary>
 9802             <pattern>
 9803               <e>name</e>
 9804               <e>value</e>
 9805               <e>source</e>
 9806             </pattern>
 9807             <ele>
 9808               <name>name</name>
 9809               <summary>The name of the detail</summary>
 9810               <pattern><t>name</t></pattern>
 9811             </ele>
 9812             <ele>
 9813               <name>value</name>
 9814               <summary>The value of the detail</summary>
 9815               <pattern>text</pattern>
 9816             </ele>
 9817             <ele>
 9818               <name>source</name>
 9819               <summary>The source of the detail</summary>
 9820               <pattern>
 9821                 <attrib>
 9822                   <name>id</name>
 9823                   <type>uuid</type>
 9824                   <required>1</required>
 9825                 </attrib>
 9826                 <e>type</e>
 9827               </pattern>
 9828               <ele>
 9829                 <name>type</name>
 9830                 <summary>Type of source</summary>
 9831                 <pattern>text</pattern>
 9832               </ele>
 9833             </ele>
 9834           </ele>
 9835           <ele>
 9836             <name>routes</name>
 9837             <summary>List of routes to the host, with most recent ones first</summary>
 9838             <pattern>
 9839               <any><e>route</e></any>
 9840             </pattern>
 9841             <ele>
 9842               <name>route</name>
 9843               <summary>List of hosts on the route to the host</summary>
 9844               <pattern>
 9845                 <any><e>host</e></any>
 9846               </pattern>
 9847               <ele>
 9848                 <name>host</name>
 9849                 <summary>A host on the route</summary>
 9850                 <pattern>
 9851                   <attrib>
 9852                     <name>id</name>
 9853                     <summary>UUID if the host is in the asset management</summary>
 9854                     <type>uuid</type>
 9855                   </attrib>
 9856                   <attrib>
 9857                     <name>distance</name>
 9858                     <summary>Distance from the scanner</summary>
 9859                     <type>number</type>
 9860                   </attrib>
 9861                   <attrib>
 9862                     <name>same_source</name>
 9863                     <summary>Whether the current host asset has the same source as the target host</summary>
 9864                     <type>boolean</type>
 9865                   </attrib>
 9866                   <e>ip</e>
 9867                 </pattern>
 9868                 <ele>
 9869                   <name>ip</name>
 9870                   <summary>IP address of the host</summary>
 9871                   <pattern>text</pattern>
 9872                 </ele>
 9873               </ele>
 9874             </ele>
 9875           </ele>
 9876         </ele>
 9877         <ele>
 9878           <name>os</name>
 9879           <summary>An OS</summary>
 9880           <pattern>
 9881             <e>title</e>
 9882             <e>installs</e>
 9883             <e>latest_severity</e>
 9884             <e>highest_severity</e>
 9885             <e>average_severity</e>
 9886             <e>hosts</e>
 9887           </pattern>
 9888           <ele>
 9889             <name>title</name>
 9890             <summary>Title of the OS</summary>
 9891             <pattern>text</pattern>
 9892           </ele>
 9893           <ele>
 9894 <!-- FIX hosts/host_count? -->
 9895             <name>installs</name>
 9896             <summary>Number of hosts on which OS has been detected</summary>
 9897             <pattern>integer</pattern>
 9898           </ele>
 9899           <ele>
 9900             <name>latest_severity</name>
 9901             <summary>Latest severity</summary>
 9902             <pattern>
 9903               <e>value</e>
 9904             </pattern>
 9905             <ele>
 9906               <name>value</name>
 9907               <pattern>text</pattern>
 9908             </ele>
 9909           </ele>
 9910           <ele>
 9911             <name>highest_severity</name>
 9912             <summary>Highest severity</summary>
 9913             <pattern>
 9914               <e>value</e>
 9915             </pattern>
 9916             <ele>
 9917               <name>value</name>
 9918               <pattern>text</pattern>
 9919             </ele>
 9920           </ele>
 9921           <ele>
 9922             <name>average_severity</name>
 9923             <summary>Average severity</summary>
 9924             <pattern>
 9925               <e>value</e>
 9926             </pattern>
 9927             <ele>
 9928               <name>value</name>
 9929               <pattern>text</pattern>
 9930             </ele>
 9931           </ele>
 9932           <ele>
 9933             <name>hosts</name>
 9934             <summary>Hosts on which this OS has been detected</summary>
 9935             <pattern>
 9936               <e>asset</e>
 9937             </pattern>
 9938             <ele>
 9939               <name>asset</name>
 9940               <summary>The host</summary>
 9941               <pattern>
 9942                 <attrib>
 9943                   <name>id</name>
 9944                   <type>uuid</type>
 9945                   <required>1</required>
 9946                 </attrib>
 9947                 <e>name</e>
 9948                 <e>severity</e>
 9949               </pattern>
 9950               <ele>
 9951                 <name>name</name>
 9952                 <summary>The name of the host</summary>
 9953                 <pattern><t>name</t></pattern>
 9954               </ele>
 9955               <ele>
 9956                 <name>severity</name>
 9957                 <summary>Severity of the host</summary>
 9958                 <pattern>
 9959                   <e>value</e>
 9960                 </pattern>
 9961                 <ele>
 9962                   <name>value</name>
 9963                   <pattern>text</pattern>
 9964                 </ele>
 9965               </ele>
 9966             </ele>
 9967           </ele>
 9968         </ele>
 9969         <ele>
 9970           <name>in_use</name>
 9971           <summary>Whether any tasks are using the asset</summary>
 9972           <pattern><t>boolean</t></pattern>
 9973         </ele>
 9974         <ele>
 9975           <name>writable</name>
 9976           <summary>Whether the asset is writable</summary>
 9977           <pattern><t>boolean</t></pattern>
 9978         </ele>
 9979         <ele>
 9980           <name>permissions</name>
 9981           <summary>Permissions that the current user has on the asset</summary>
 9982           <pattern>
 9983             <any><e>permission</e></any>
 9984           </pattern>
 9985           <ele>
 9986             <name>permission</name>
 9987             <pattern>
 9988               <e>name</e>
 9989             </pattern>
 9990             <ele>
 9991               <name>name</name>
 9992               <summary>The name of the permission</summary>
 9993               <pattern><t>name</t></pattern>
 9994             </ele>
 9995           </ele>
 9996         </ele>
 9997         <ele>
 9998           <name>user_tags</name>
 9999           <summary>Info on tags attached to the asset</summary>
10000           <pattern>
10001             <e>count</e>
10002             <any><e>tag</e></any>
10003           </pattern>
10004           <ele>
10005             <name>count</name>
10006             <summary>Number of attached tags</summary>
10007             <pattern><t>integer</t></pattern>
10008           </ele>
10009           <ele>
10010             <name>tag</name>
10011             <summary>
10012               Short info on an individual tag
10013               (only if details were requested)
10014             </summary>
10015             <pattern>
10016               <attrib>
10017                 <name>id</name>
10018                 <type>uuid</type>
10019                 <summary>UUID of the tag</summary>
10020                 <required>1</required>
10021               </attrib>
10022               <e>name</e>
10023               <e>value</e>
10024               <e>comment</e>
10025             </pattern>
10026             <ele>
10027               <name>name</name>
10028               <summary>Name of the tag (usually namespace:predicate)</summary>
10029               <pattern>text</pattern>
10030             </ele>
10031             <ele>
10032               <name>value</name>
10033               <summary>Value of the tag</summary>
10034               <pattern>text</pattern>
10035             </ele>
10036             <ele>
10037               <name>comment</name>
10038               <summary>Comment for the tag</summary>
10039               <pattern>text</pattern>
10040             </ele>
10041           </ele>
10042         </ele>
10043       </ele>
10044       <ele>
10045         <name>filters</name>
10046         <pattern>
10047           <attrib>
10048             <name>id</name>
10049             <summary>UUID of filter if any, else 0</summary>
10050             <type>uuid</type>
10051             <required>1</required>
10052           </attrib>
10053           <e>term</e>
10054           <o><e>name</e></o>
10055           <e>keywords</e>
10056         </pattern>
10057         <ele>
10058           <name>term</name>
10059           <summary>Filter term</summary>
10060           <pattern>text</pattern>
10061         </ele>
10062         <ele>
10063           <name>name</name>
10064           <summary>Filter name, if applicable</summary>
10065           <pattern>text</pattern>
10066         </ele>
10067         <ele>
10068           <name>keywords</name>
10069           <summary>Filter broken down into keywords</summary>
10070           <pattern><any><e>keyword</e></any></pattern>
10071           <ele>
10072             <name>keyword</name>
10073             <pattern>
10074               <e>column</e>
10075               <e>relation</e>
10076               <e>value</e>
10077             </pattern>
10078             <ele>
10079               <name>column</name>
10080               <summary>Column prefix</summary>
10081               <pattern>text</pattern>
10082             </ele>
10083             <ele>
10084               <name>relation</name>
10085               <summary>Relation operator</summary>
10086               <pattern>
10087                 <alts>
10088                   <alt>=</alt>
10089                   <alt>:</alt>
10090                   <alt>~</alt>
10091                   <alt>&gt;</alt>
10092                   <alt>&lt;</alt>
10093                 </alts>
10094               </pattern>
10095             </ele>
10096             <ele>
10097               <name>value</name>
10098               <summary>The filter text</summary>
10099               <pattern>text</pattern>
10100             </ele>
10101           </ele>
10102         </ele>
10103       </ele>
10104       <ele>
10105         <name>sort</name>
10106         <pattern>
10107           text
10108           <e>field</e>
10109         </pattern>
10110         <ele>
10111           <name>field</name>
10112           <pattern>
10113             <e>order</e>
10114           </pattern>
10115           <ele>
10116             <name>order</name>
10117             <pattern>
10118               <t>
10119                 <alts>
10120                   <alt>ascending</alt>
10121                   <alt>descending</alt>
10122                 </alts>
10123               </t>
10124             </pattern>
10125           </ele>
10126         </ele>
10127       </ele>
10128       <ele>
10129         <name>assets</name>
10130         <pattern>
10131           <attrib>
10132             <name>start</name>
10133             <summary>First asset</summary>
10134             <type>integer</type>
10135             <required>1</required>
10136           </attrib>
10137           <attrib>
10138             <name>max</name>
10139             <summary>Maximum number of assets</summary>
10140             <type>integer</type>
10141             <required>1</required>
10142           </attrib>
10143         </pattern>
10144       </ele>
10145       <ele>
10146         <name>asset_count</name>
10147         <pattern>
10148           <e>filtered</e>
10149           <e>page</e>
10150         </pattern>
10151         <ele>
10152           <name>filtered</name>
10153           <summary>Number of assets after filtering</summary>
10154           <pattern><t>integer</t></pattern>
10155         </ele>
10156         <ele>
10157           <name>page</name>
10158           <summary>Number of assets on current page</summary>
10159           <pattern><t>integer</t></pattern>
10160         </ele>
10161       </ele>
10162     </response>
10163     <example>
10164       <summary>Get one or many assets</summary>
10165       <request>
10166         <get_assets></get_assets>
10167       </request>
10168       <response>
10169         <get_assets_response status="200" status_text="OK">
10170           <asset id="b493b7a8-7489-11df-a3ec-002264764cea">
10171             <name>Localhost</name>
10172             <comment></comment>
10173             <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
10174             <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
10175             <writable>0</writable>
10176             <in_use>7</in_use>
10177             <user_tags>
10178               <count>0</count>
10179             </user_tags>
10180             <hosts>localhost</hosts>
10181             <max_hosts>1</max_hosts>
10182             <ssh_credential id="">
10183               <name></name>
10184             </ssh_credential>
10185             <smb_credential id="">
10186               <name></name>
10187             </smb_credential>
10188             <esxi_credential id="">
10189               <name></name>
10190             </esxi_credential>
10191           </asset>
10192           <truncated>...</truncated>
10193         </get_assets_response>
10194       </response>
10195     </example>
10196     <example>
10197       <summary>Get a single asset, including tasks using the asset</summary>
10198       <request>
10199         <get_assets asset_id="1f28d970-17ef-4c69-ba8a-13827059f2b9" tasks="1">
10200         </get_assets>
10201       </request>
10202       <response>
10203         <get_assets_response status="200" status_text="OK">
10204           <asset id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
10205             <name>dik</name>
10206             <comment>dik mm</comment>
10207             <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
10208             <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
10209             <writable>0</writable>
10210             <in_use>4</in_use>
10211             <user_tags>
10212               <count>0</count>
10213             </user_tags>
10214             <hosts>dik.example.org</hosts>
10215             <max_hosts>1</max_hosts>
10216             <ssh_credential id="58ff2793-2dc7-43fe-85f9-20bfac5a87e4">
10217               <name>mm</name>
10218             </ssh_credential>
10219             <smb_credential id="">
10220               <name></name>
10221             </smb_credential>
10222             <esxi_credential id="">
10223               <name></name>
10224             </esxi_credential>
10225             <tasks>
10226               <task id="13bb418a-4220-4575-b35b-ec398bff7417">
10227                 <name>dik mm</name>
10228               </task>
10229               <truncated>...</truncated>
10230             </tasks>
10231           </asset>
10232         </get_assets_response>
10233       </response>
10234     </example>
10235   </command>
10236   <command>
10237     <name>get_credentials</name>
10238     <summary>Get one or many credentials</summary>
10239     <description>
10240       The client uses the get_credentials command to get credentials information.
10241       If the command sent by the client was valid, the manager will
10242       reply with a list of credentials to the client.
10243     </description>
10244     <pattern>
10245       <attrib>
10246         <name>credential_id</name>
10247         <summary>ID of single credential to get</summary>
10248         <type>uuid</type>
10249       </attrib>
10250       <attrib>
10251         <name>filter</name>
10252         <summary>Filter term to use to filter query</summary>
10253         <type>text</type>
10254         <filter_keywords>
10255           <column>
10256             <name>uuid</name>
10257             <type>uuid</type>
10258             <summary>Unique ID</summary>
10259           </column>
10260           <column>
10261             <name>name</name>
10262             <type>name</type>
10263             <summary>Name</summary>
10264           </column>
10265           <column>
10266             <name>comment</name>
10267             <type>text</type>
10268             <summary>Comment text</summary>
10269           </column>
10270           <column>
10271             <name>created</name>
10272             <type>iso_time</type>
10273             <summary>Creation time</summary>
10274           </column>
10275           <column>
10276             <name>modified</name>
10277             <type>iso_time</type>
10278             <summary>Modification time</summary>
10279           </column>
10280           <column>
10281             <name>owner</name>
10282             <type>name</type>
10283             <summary>Name of the owner</summary>
10284           </column>
10285           <column>
10286             <name>login</name>
10287             <type>text</type>
10288             <summary>The login username</summary>
10289           </column>
10290           <column>
10291             <name>type</name>
10292             <type>text</type>
10293             <summary>The type abbreviation</summary>
10294           </column>
10295           <column>
10296             <name>allow_insecure</name>
10297             <type>boolean</type>
10298             <summary>Whether insecure use is allowed</summary>
10299           </column>
10300         </filter_keywords>
10301       </attrib>
10302       <attrib>
10303         <name>filt_id</name>
10304         <summary>ID of filter to use to filter query</summary>
10305         <type>uuid</type>
10306       </attrib>
10307       <attrib>
10308         <name>scanners</name>
10309         <summary>Whether to include a list of scanners using the credentials</summary>
10310         <type>boolean</type>
10311       </attrib>
10312       <attrib>
10313         <name>trash</name>
10314         <summary>Whether to get the trashcan credentials instead</summary>
10315         <type>boolean</type>
10316       </attrib>
10317       <attrib>
10318         <name>targets</name>
10319         <summary>Whether to include a list of targets using the credentials</summary>
10320         <type>boolean</type>
10321       </attrib>
10322       <attrib>
10323         <name>format</name>
10324         <type>
10325           <alts>
10326             <alt>key</alt>
10327             <alt>rpm</alt>
10328             <alt>deb</alt>
10329             <alt>exe</alt>
10330           </alts>
10331         </type>
10332       </attrib>
10333     </pattern>
10334     <response>
10335       <pattern>
10336         <attrib>
10337           <name>status</name>
10338           <type>status</type>
10339           <required>1</required>
10340         </attrib>
10341         <attrib>
10342           <name>status_text</name>
10343           <type>text</type>
10344           <required>1</required>
10345         </attrib>
10346         <any><e>credential</e></any>
10347         <e>filters</e>
10348         <e>sort</e>
10349         <e>credentials</e>
10350         <e>credential_count</e>
10351       </pattern>
10352       <ele>
10353         <name>credential</name>
10354         <pattern>
10355           <attrib>
10356             <name>id</name>
10357             <type>uuid</type>
10358             <required>1</required>
10359           </attrib>
10360           <e>owner</e>
10361           <e>name</e>
10362           <e>allow_insecure</e>
10363           <e>login</e>
10364           <e>comment</e>
10365           <e>creation_time</e>
10366           <e>modification_time</e>
10367           <e>writable</e>
10368           <e>in_use</e>
10369           <e>permissions</e>
10370           <e>user_tags</e>
10371           <e>type</e>
10372           <e>full_type</e>
10373           <o><e>auth_algorithm</e></o>
10374           <o><e>privacy</e></o>
10375           <o><e>certificate_info</e></o>
10376           <o><e>scanners</e></o>
10377           <o><e>targets</e></o>
10378           <or>
10379             <e>public_key</e>
10380             <e>package</e>
10381           </or>
10382         </pattern>
10383         <ele>
10384           <name>owner</name>
10385           <summary>Owner of the credential</summary>
10386           <pattern>
10387             <e>name</e>
10388           </pattern>
10389           <ele>
10390             <name>name</name>
10391             <summary>The name of the owner</summary>
10392             <pattern><t>name</t></pattern>
10393           </ele>
10394         </ele>
10395         <ele>
10396           <name>name</name>
10397           <summary>The name of the credential</summary>
10398           <pattern><t>name</t></pattern>
10399         </ele>
10400         <ele>
10401           <name>allow_insecure</name>
10402           <summary>Whether insecure use of the credential is allowed</summary>
10403           <pattern>
10404             <t>boolean</t>
10405           </pattern>
10406         </ele>
10407         <ele>
10408           <name>login</name>
10409           <summary>The username of the credential</summary>
10410           <pattern><t>name</t></pattern>
10411         </ele>
10412         <ele>
10413           <name>comment</name>
10414           <summary>The comment on the credential</summary>
10415           <pattern>text</pattern>
10416         </ele>
10417         <ele>
10418           <name>creation_time</name>
10419           <summary>Date and time the credential was created</summary>
10420           <pattern><t>iso_time</t></pattern>
10421         </ele>
10422         <ele>
10423           <name>modification_time</name>
10424           <summary>Date and time the credential was last modified</summary>
10425           <pattern><t>iso_time</t></pattern>
10426         </ele>
10427         <ele>
10428           <name>writable</name>
10429           <summary>Whether this credential is writable</summary>
10430           <pattern><t>boolean</t></pattern>
10431         </ele>
10432         <ele>
10433           <name>in_use</name>
10434           <summary>Whether any targets are using the credential</summary>
10435           <pattern><t>boolean</t></pattern>
10436         </ele>
10437         <ele>
10438           <name>permissions</name>
10439           <summary>
10440             Permissions that the current user has on the credential
10441           </summary>
10442           <pattern>
10443             <any><e>permission</e></any>
10444           </pattern>
10445           <ele>
10446             <name>permission</name>
10447             <pattern>
10448               <e>name</e>
10449             </pattern>
10450             <ele>
10451               <name>name</name>
10452               <summary>The name of the permission</summary>
10453               <pattern><t>name</t></pattern>
10454             </ele>
10455           </ele>
10456         </ele>
10457         <ele>
10458           <name>user_tags</name>
10459           <summary>Info on tags attached to the credential</summary>
10460           <pattern>
10461             <e>count</e>
10462             <any><e>tag</e></any>
10463           </pattern>
10464           <ele>
10465             <name>count</name>
10466             <summary>Number of attached tags</summary>
10467             <pattern><t>integer</t></pattern>
10468           </ele>
10469           <ele>
10470             <name>tag</name>
10471             <summary>
10472               Short info on an individual tag
10473               (only if details were requested)
10474             </summary>
10475             <pattern>
10476               <attrib>
10477                 <name>id</name>
10478                 <type>uuid</type>
10479                 <summary>UUID of the tag</summary>
10480                 <required>1</required>
10481               </attrib>
10482               <e>name</e>
10483               <e>value</e>
10484               <e>comment</e>
10485             </pattern>
10486             <ele>
10487               <name>name</name>
10488               <summary>Name of the tag (usually namespace:predicate)</summary>
10489               <pattern>text</pattern>
10490             </ele>
10491             <ele>
10492               <name>value</name>
10493               <summary>Value of the tag</summary>
10494               <pattern>text</pattern>
10495             </ele>
10496             <ele>
10497               <name>comment</name>
10498               <summary>Comment for the tag</summary>
10499               <pattern>text</pattern>
10500             </ele>
10501           </ele>
10502         </ele>
10503         <ele>
10504           <name>type</name>
10505           <summary>The type of the credential</summary>
10506           <pattern>
10507             <t>
10508               <alts>
10509                 <alt>up</alt>
10510                 <alt>usk</alt>
10511               </alts>
10512             </t>
10513           </pattern>
10514         </ele>
10515         <ele>
10516           <name>full_type</name>
10517           <summary>The type of the credential written out</summary>
10518           <pattern>
10519             text
10520           </pattern>
10521         </ele>
10522         <ele>
10523           <name>auth_algorithm</name>
10524           <summary>The SNMP authentication algorithm</summary>
10525           <pattern>
10526             <t>
10527               <alts>
10528                 <alt>md5</alt>
10529                 <alt>sha1</alt>
10530               </alts>
10531             </t>
10532           </pattern>
10533         </ele>
10534         <ele>
10535           <name>privacy</name>
10536           <pattern>
10537             <e>algorithm</e>
10538           </pattern>
10539           <ele>
10540             <name>algorithm</name>
10541             <summary>The SNMP privacy algorithm</summary>
10542             <pattern>
10543               <t>
10544                 <alts>
10545                   <alt>aes</alt>
10546                   <alt>des</alt>
10547                 </alts>
10548               </t>
10549             </pattern>
10550           </ele>
10551         </ele>
10552         <ele>
10553           <name>certificate_info</name>
10554           <summary>
10555             Info about the certificate
10556           </summary>
10557           <type>certificate_info</type>
10558         </ele>
10559         <ele>
10560           <name>scanners</name>
10561           <summary>All scanners using this credential</summary>
10562           <pattern>
10563             <any><e>scanner</e></any>
10564           </pattern>
10565           <ele>
10566             <name>scanner</name>
10567             <pattern>
10568               <attrib>
10569                 <name>id</name>
10570                 <type>uuid</type>
10571                 <required>1</required>
10572               </attrib>
10573               <e>name</e>
10574               <o><e>permissions</e></o>
10575             </pattern>
10576             <ele>
10577               <name>name</name>
10578               <summary>The name of the scanner</summary>
10579               <pattern><t>name</t></pattern>
10580             </ele>
10581             <ele>
10582               <name>permissions</name>
10583               <summary>Permissions the user has on the scanner</summary>
10584               <pattern></pattern>
10585             </ele>
10586           </ele>
10587         </ele>
10588         <ele>
10589           <name>targets</name>
10590           <summary>All targets using this credential</summary>
10591           <pattern>
10592             <any><e>target</e></any>
10593           </pattern>
10594           <ele>
10595             <name>target</name>
10596             <pattern>
10597               <attrib>
10598                 <name>id</name>
10599                 <type>uuid</type>
10600                 <required>1</required>
10601               </attrib>
10602               <e>name</e>
10603               <o><e>permissions</e></o>
10604             </pattern>
10605             <ele>
10606               <name>name</name>
10607               <summary>The name of the target</summary>
10608               <pattern><t>name</t></pattern>
10609             </ele>
10610             <ele>
10611               <name>permissions</name>
10612               <summary>Permissions the user has on the target</summary>
10613               <pattern></pattern>
10614             </ele>
10615           </ele>
10616         </ele>
10617         <ele>
10618           <name>public_key</name>
10619           <pattern>text</pattern>
10620         </ele>
10621         <ele>
10622           <name>package</name>
10623           <pattern>
10624             <attrib>
10625               <name>format</name>
10626               <type>
10627                 <alts>
10628                   <alt>rpm</alt>
10629                   <alt>deb</alt>
10630                   <alt>exe</alt>
10631                 </alts>
10632               </type>
10633               <required>1</required>
10634             </attrib>
10635             base64
10636           </pattern>
10637         </ele>
10638       </ele>
10639       <ele>
10640         <name>filters</name>
10641         <pattern>
10642           <attrib>
10643             <name>id</name>
10644             <summary>UUID of filter if any, else 0</summary>
10645             <type>uuid</type>
10646             <required>1</required>
10647           </attrib>
10648           <e>term</e>
10649           <o><e>name</e></o>
10650           <e>keywords</e>
10651         </pattern>
10652         <ele>
10653           <name>term</name>
10654           <summary>Filter term</summary>
10655           <pattern>text</pattern>
10656         </ele>
10657         <ele>
10658           <name>name</name>
10659           <summary>Filter name, if applicable</summary>
10660           <pattern>text</pattern>
10661         </ele>
10662         <ele>
10663           <name>keywords</name>
10664           <summary>Filter broken down into keywords</summary>
10665           <pattern><any><e>keyword</e></any></pattern>
10666           <ele>
10667             <name>keyword</name>
10668             <pattern>
10669               <e>column</e>
10670               <e>relation</e>
10671               <e>value</e>
10672             </pattern>
10673             <ele>
10674               <name>column</name>
10675               <summary>Column prefix</summary>
10676               <pattern>text</pattern>
10677             </ele>
10678             <ele>
10679               <name>relation</name>
10680               <summary>Relation operator</summary>
10681               <pattern>
10682                 <alts>
10683                   <alt>=</alt>
10684                   <alt>:</alt>
10685                   <alt>~</alt>
10686                   <alt>&gt;</alt>
10687                   <alt>&lt;</alt>
10688                 </alts>
10689               </pattern>
10690             </ele>
10691             <ele>
10692               <name>value</name>
10693               <summary>The filter text</summary>
10694               <pattern>text</pattern>
10695             </ele>
10696           </ele>
10697         </ele>
10698       </ele>
10699       <ele>
10700         <name>sort</name>
10701         <pattern>
10702           text
10703           <e>field</e>
10704         </pattern>
10705         <ele>
10706           <name>field</name>
10707           <pattern>
10708             <e>order</e>
10709           </pattern>
10710           <ele>
10711             <name>order</name>
10712             <pattern>
10713               <t>
10714                 <alts>
10715                   <alt>ascending</alt>
10716                   <alt>descending</alt>
10717                 </alts>
10718               </t>
10719             </pattern>
10720           </ele>
10721         </ele>
10722       </ele>
10723       <ele>
10724         <name>credentials</name>
10725         <pattern>
10726           <attrib>
10727             <name>start</name>
10728             <summary>First credential</summary>
10729             <type>integer</type>
10730             <required>1</required>
10731           </attrib>
10732           <attrib>
10733             <name>max</name>
10734             <summary>Maximum number of credentials</summary>
10735             <type>integer</type>
10736             <required>1</required>
10737           </attrib>
10738         </pattern>
10739       </ele>
10740       <ele>
10741         <name>credential_count</name>
10742         <pattern>
10743           <e>filtered</e>
10744           <e>page</e>
10745         </pattern>
10746         <ele>
10747           <name>filtered</name>
10748           <summary>Number of credentials after filtering</summary>
10749           <pattern><t>integer</t></pattern>
10750         </ele>
10751         <ele>
10752           <name>page</name>
10753           <summary>Number of credentials on current page</summary>
10754           <pattern><t>integer</t></pattern>
10755         </ele>
10756       </ele>
10757     </response>
10758     <example>
10759       <summary>Get one or many the credentials</summary>
10760       <request>
10761         <get_credentials></get_credentials>
10762       </request>
10763       <response>
10764         <get_credentials_response status="200" status_text="OK">
10765           <credential id="c33864a9-d3fd-44b3-8717-972bfb01dfcf">
10766             <name>sally</name>
10767             <login>sally</login>
10768             <comment></comment>
10769             <creation_time>2012-12-14T17:11:25+01:00</creation_time>
10770             <modification_time>2012-05-28T11:19:20+01:00</modification_time>
10771             <writable>1</writable>
10772             <in_use>0</in_use>
10773             <user_tags>
10774               <count>0</count>
10775             </user_tags>
10776             <type>usk</type>
10777             <full_type>username + SSH key</full_type>
10778           </credential>
10779           <credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
10780             <name>bob</name>
10781             <comment>Bob on the web server.</comment>
10782             <creation_time>2013-01-03T15:49:35+01:00</creation_time>
10783             <modification_time>2013-01-18T12:07:00+01:00</modification_time>
10784             <writable>1</writable>
10785             <in_use>1</in_use>
10786             <login>bob</login>
10787             <type>up</type>
10788             <full_type>username + password</full_type>
10789           </credential>
10790           <truncated>...</truncated>
10791         </get_credentials_response>
10792       </response>
10793     </example>
10794     <example>
10795       <summary>Get a single credential, its public key and targets using it</summary>
10796       <request>
10797         <get_credentials
10798           credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
10799           format="key" targets="1">
10800         </get_credentials>
10801       </request>
10802       <response>
10803         <get_credentials_response status="200" status_text="OK">
10804           <credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
10805             <name>bob</name>
10806             <comment>Bob on the web server.</comment>
10807             <creation_time>2012-11-03T15:41:35+01:00</creation_time>
10808             <modification_time>2012-11-18T13:17:00+01:00</modification_time>
10809             <writable>1</writable>
10810             <in_use>1</in_use>
10811             <user_tags>
10812               <count>0</count>
10813             </user_tags>
10814             <login>bob</login>
10815             <type>up</type>
10816             <full_type>username + password</full_type>
10817             <targets>
10818               <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
10819                 <name>Web server</name>
10820               </target>
10821             </targets>
10822             <public_key>
10823               ssh-rsa AAAAB3...Z64IcQ== Key generated by OpenVAS Manager
10824             </public_key>
10825           </credential>
10826         </get_credentials_response>
10827       </response>
10828     </example>
10829     <example>
10830       <summary>Get the Debian package of a single credential</summary>
10831       <request>
10832         <get_credentials
10833           credential_id="8e305b0b-260d-450d-91a8-dadf0b144e15"
10834           format="deb">
10835         </get_credentials>
10836       </request>
10837       <response>
10838         <get_credentials_response status="200" status_text="OK">
10839           <credential id="8e305b0b-260d-450d-91a8-dadf0b144e15">
10840             <name>bob</name>
10841             <login>bob</login>
10842             <comment>Bob on the web server.</comment>
10843             <creation_time>2012-11-03T15:41:35+01:00</creation_time>
10844             <modification_time>2012-11-18T13:17:00+01:00</modification_time>
10845             <writable>1</writable>
10846             <in_use>1</in_use>
10847             <user_tags>
10848               <count>0</count>
10849             </user_tags>
10850             <type>up</type>
10851             <full_type>username + password</full_type>
10852             <targets>
10853               <target id="1f28d970-17ef-4c69-ba8a-13827059f2b9">
10854                 <name>Web server</name>
10855               </target>
10856             </targets>
10857             <package format="deb">ITxhcmNoPgpk...DmvF0AKAAACg==</package>
10858           </credential>
10859         </get_credentials_response>
10860       </response>
10861     </example>
10862   </command>
10863   <command>
10864     <name>get_feeds</name>
10865     <summary>Get one or many feeds</summary>
10866     <description>
10867       <p>
10868         The client uses the get_feeds command to get feed information.
10869         If the command sent by the client was valid, the manager will
10870         reply with a list of feeds to the client.
10871       </p>
10872     </description>
10873     <pattern>
10874       <attrib>
10875         <name>type</name>
10876         <summary>Type of single feed to get: NVT, CERT or SCAP</summary>
10877         <type>text</type>
10878       </attrib>
10879     </pattern>
10880     <response>
10881       <pattern>
10882         <attrib>
10883           <name>status</name>
10884           <type>status</type>
10885           <required>1</required>
10886         </attrib>
10887         <attrib>
10888           <name>status_text</name>
10889           <type>text</type>
10890           <required>1</required>
10891         </attrib>
10892         <any><e>feed</e></any>
10893       </pattern>
10894       <ele>
10895         <name>feed</name>
10896         <pattern>
10897           <e>type</e>
10898           <e>name</e>
10899           <e>version</e>
10900           <e>description</e>
10901           <o><e>sync_not_available</e></o>
10902           <o><e>currently_syncing</e></o>
10903         </pattern>
10904         <ele>
10905           <name>type</name>
10906           <summary>The type of feed: NVT, CERT or SCAP</summary>
10907           <pattern>text</pattern>
10908         </ele>
10909         <ele>
10910           <name>name</name>
10911           <summary>The name of the feed</summary>
10912           <pattern>text</pattern>
10913         </ele>
10914         <ele>
10915           <name>version</name>
10916           <summary>The version of the feed</summary>
10917           <pattern>text</pattern>
10918         </ele>
10919         <ele>
10920           <name>description</name>
10921           <summary>A description of the feed</summary>
10922           <pattern>text</pattern>
10923         </ele>
10924         <ele>
10925           <name>sync_not_available</name>
10926           <summary>Present if syncing is not available</summary>
10927           <pattern>
10928             <e>error</e>
10929           </pattern>
10930           <ele>
10931             <name>error</name>
10932             <summary>Description of why sync is not available</summary>
10933           </ele>
10934         </ele>
10935         <ele>
10936           <name>currently_syncing</name>
10937           <summary>Present if a sync of this type is underway</summary>
10938           <pattern>
10939             <e>timestamp</e>
10940             <e>user</e>
10941           </pattern>
10942           <ele>
10943             <name>timestamp</name>
10944             <summary>Time sync started</summary>
10945             <pattern>text</pattern>
10946           </ele>
10947           <ele>
10948             <name>user</name>
10949             <summary>Name of user who is performing sync</summary>
10950             <pattern>text</pattern>
10951           </ele>
10952         </ele>
10953       </ele>
10954     </response>
10955     <example>
10956       <summary>Get the feeds</summary>
10957       <request>
10958         <get_feeds>
10959         </get_feeds>
10960       </request>
10961       <response>
10962         <get_feeds_response status_text="OK" status="200">
10963           <feed>
10964             <type>NVT</type>
10965             <name>Greenbone Security Feed</name>
10966             <version>201608180124</version>
10967             <description>This script synchronizes an NVT collection with...</description>
10968           </feed>
10969           <feed>
10970             <type>CERT</type>
10971             <name>Greenbone CERT Feed</name>
10972             <version>201609130000</version>
10973             <description>This script synchronizes a CERT collection with...</description>
10974           </feed>
10975           <feed>
10976             <type>SCAP</type>
10977             <name>Greenbone SCAP Feed</name>
10978             <version>201608172300</version>
10979             <description>This script synchronizes a SCAP collection with...</description>
10980           </feed>
10981         </get_feeds_response>
10982       </response>
10983     </example>
10984   </command>
10985   <command>
10986     <name>get_filters</name>
10987     <summary>Get one or many filters</summary>
10988     <description>
10989       The client uses the get_filters command to get filter information.
10990     </description>
10991     <pattern>
10992       <attrib>
10993         <name>filter_id</name>
10994         <summary>ID of single filter to get</summary>
10995         <type>uuid</type>
10996       </attrib>
10997       <attrib>
10998         <name>filter</name>
10999         <summary>Filter term to use to filter query</summary>
11000         <type>text</type>
11001         <filter_keywords>
11002           <column>
11003             <name>uuid</name>
11004             <type>uuid</type>
11005             <summary>Unique ID</summary>
11006           </column>
11007           <column>
11008             <name>name</name>
11009             <type>name</type>
11010             <summary>Name</summary>
11011           </column>
11012           <column>
11013             <name>comment</name>
11014             <type>text</type>
11015             <summary>Comment text</summary>
11016           </column>
11017           <column>
11018             <name>created</name>
11019             <type>iso_time</type>
11020             <summary>Creation time</summary>
11021           </column>
11022           <column>
11023             <name>modified</name>
11024             <type>iso_time</type>
11025             <summary>Modification time</summary>
11026           </column>
11027           <column>
11028             <name>owner</name>
11029             <type>name</type>
11030             <summary>Name of the owner</summary>
11031           </column>
11032           <column>
11033             <name>type</name>
11034             <type>text</type>
11035             <summary>Resource type the filter is restricted to</summary>
11036           </column>
11037           <column>
11038             <name>term</name>
11039             <type>text</type>
11040             <summary>The filter term</summary>
11041           </column>
11042         </filter_keywords>
11043       </attrib>
11044       <attrib>
11045         <name>filt_id</name>
11046         <summary>ID of filter to use to filter query</summary>
11047         <type>uuid</type>
11048       </attrib>
11049       <attrib>
11050         <name>trash</name>
11051         <summary>Whether to get the trashcan filters instead</summary>
11052         <type>boolean</type>
11053       </attrib>
11054       <attrib>
11055         <name>alerts</name>
11056         <summary>Whether to include list of alerts that use the filter</summary>
11057         <type>boolean</type>
11058       </attrib>
11059     </pattern>
11060     <response>
11061       <pattern>
11062         <attrib>
11063           <name>status</name>
11064           <type>status</type>
11065           <required>1</required>
11066         </attrib>
11067         <attrib>
11068           <name>status_text</name>
11069           <type>text</type>
11070           <required>1</required>
11071         </attrib>
11072         <any><e>filter</e></any>
11073         <e>filters</e>
11074         <e>sort</e>
11075         <e>filters</e>
11076         <e>filter_count</e>
11077       </pattern>
11078       <ele>
11079         <name>filter</name>
11080         <pattern>
11081           <attrib>
11082             <name>id</name>
11083             <type>uuid</type>
11084             <required>1</required>
11085           </attrib>
11086           <e>owner</e>
11087           <e>name</e>
11088           <e>comment</e>
11089           <e>term</e>
11090           <e>type</e>
11091           <e>creation_time</e>
11092           <e>modification_time</e>
11093           <e>in_use</e>
11094           <e>writable</e>
11095           <e>permissions</e>
11096           <e>user_tags</e>
11097           <o><e>alerts</e></o>
11098         </pattern>
11099         <ele>
11100           <name>owner</name>
11101           <summary>Owner of the filter</summary>
11102           <pattern>
11103             <e>name</e>
11104           </pattern>
11105           <ele>
11106             <name>name</name>
11107             <summary>The name of the owner</summary>
11108             <pattern><t>name</t></pattern>
11109           </ele>
11110         </ele>
11111         <ele>
11112           <name>name</name>
11113           <summary>The name of the filter</summary>
11114           <pattern><t>name</t></pattern>
11115         </ele>
11116         <ele>
11117           <name>comment</name>
11118           <summary>The comment on the filter</summary>
11119           <pattern>text</pattern>
11120         </ele>
11121         <ele>
11122           <name>term</name>
11123           <summary>The filter term</summary>
11124           <pattern>
11125             text
11126           </pattern>
11127         </ele>
11128         <ele>
11129           <name>type</name>
11130           <summary>Resource type filter applies to.  Blank for all</summary>
11131           <pattern>
11132             text
11133           </pattern>
11134         </ele>
11135         <ele>
11136           <name>creation_time</name>
11137           <summary>Date and time the filter was created</summary>
11138           <pattern><t>iso_time</t></pattern>
11139         </ele>
11140         <ele>
11141           <name>modification_time</name>
11142           <summary>Date and time the filter was last modified</summary>
11143           <pattern><t>iso_time</t></pattern>
11144         </ele>
11145         <ele>
11146           <name>in_use</name>
11147           <summary>Whether any tasks are using the filter</summary>
11148           <pattern><t>boolean</t></pattern>
11149         </ele>
11150         <ele>
11151           <name>writable</name>
11152           <summary>Whether the filter is writable</summary>
11153           <pattern><t>boolean</t></pattern>
11154         </ele>
11155         <ele>
11156           <name>permissions</name>
11157           <summary>Permissions that the current user has on the filter</summary>
11158           <pattern>
11159             <any><e>permission</e></any>
11160           </pattern>
11161           <ele>
11162             <name>permission</name>
11163             <pattern>
11164               <e>name</e>
11165             </pattern>
11166             <ele>
11167               <name>name</name>
11168               <summary>The name of the permission</summary>
11169               <pattern><t>name</t></pattern>
11170             </ele>
11171           </ele>
11172         </ele>
11173         <ele>
11174           <name>user_tags</name>
11175           <summary>Info on tags attached to the filter</summary>
11176           <pattern>
11177             <e>count</e>
11178             <any><e>tag</e></any>
11179           </pattern>
11180           <ele>
11181             <name>count</name>
11182             <summary>Number of attached tags</summary>
11183             <pattern><t>integer</t></pattern>
11184           </ele>
11185           <ele>
11186             <name>tag</name>
11187             <summary>
11188               Short info on an individual tag
11189               (only if details were requested)
11190             </summary>
11191             <pattern>
11192               <attrib>
11193                 <name>id</name>
11194                 <type>uuid</type>
11195                 <summary>UUID of the tag</summary>
11196                 <required>1</required>
11197               </attrib>
11198               <e>name</e>
11199               <e>value</e>
11200               <e>comment</e>
11201             </pattern>
11202             <ele>
11203               <name>name</name>
11204               <summary>Name of the tag (usually namespace:predicate)</summary>
11205               <pattern>text</pattern>
11206             </ele>
11207             <ele>
11208               <name>value</name>
11209               <summary>Value of the tag</summary>
11210               <pattern>text</pattern>
11211             </ele>
11212             <ele>
11213               <name>comment</name>
11214               <summary>Comment for the tag</summary>
11215               <pattern>text</pattern>
11216             </ele>
11217           </ele>
11218         </ele>
11219         <ele>
11220           <name>alerts</name>
11221           <summary>All alerts using the filter</summary>
11222           <pattern>
11223             <any><e>alert</e></any>
11224           </pattern>
11225           <ele>
11226             <name>alert</name>
11227             <pattern>
11228               <attrib>
11229                 <name>id</name>
11230                 <type>uuid</type>
11231                 <required>1</required>
11232               </attrib>
11233               <e>name</e>
11234               <o><e>permissions</e></o>
11235             </pattern>
11236             <ele>
11237               <name>name</name>
11238               <summary>The name of the alert</summary>
11239               <pattern><t>name</t></pattern>
11240             </ele>
11241             <ele>
11242               <name>permissions</name>
11243               <summary>Permissions the user has on the alert</summary>
11244               <pattern></pattern>
11245             </ele>
11246           </ele>
11247         </ele>
11248       </ele>
11249       <ele>
11250         <name>filters</name>
11251         <pattern>
11252           <attrib>
11253             <name>id</name>
11254             <summary>UUID of filter if any, else 0</summary>
11255             <type>uuid</type>
11256             <required>1</required>
11257           </attrib>
11258           <e>term</e>
11259           <o><e>name</e></o>
11260           <e>keywords</e>
11261         </pattern>
11262         <ele>
11263           <name>term</name>
11264           <summary>Filter term</summary>
11265           <pattern>text</pattern>
11266         </ele>
11267         <ele>
11268           <name>name</name>
11269           <summary>Filter name, if applicable</summary>
11270           <pattern>text</pattern>
11271         </ele>
11272         <ele>
11273           <name>keywords</name>
11274           <summary>Filter broken down into keywords</summary>
11275           <pattern><any><e>keyword</e></any></pattern>
11276           <ele>
11277             <name>keyword</name>
11278             <pattern>
11279               <e>column</e>
11280               <e>relation</e>
11281               <e>value</e>
11282             </pattern>
11283             <ele>
11284               <name>column</name>
11285               <summary>Column prefix</summary>
11286               <pattern>text</pattern>
11287             </ele>
11288             <ele>
11289               <name>relation</name>
11290               <summary>Relation operator</summary>
11291               <pattern>
11292                 <alts>
11293                   <alt>=</alt>
11294                   <alt>:</alt>
11295                   <alt>~</alt>
11296                   <alt>&gt;</alt>
11297                   <alt>&lt;</alt>
11298                 </alts>
11299               </pattern>
11300             </ele>
11301             <ele>
11302               <name>value</name>
11303               <summary>The filter text</summary>
11304               <pattern>text</pattern>
11305             </ele>
11306           </ele>
11307         </ele>
11308       </ele>
11309       <ele>
11310         <name>sort</name>
11311         <pattern>
11312           text
11313           <e>field</e>
11314         </pattern>
11315         <ele>
11316           <name>field</name>
11317           <pattern>
11318             <e>order</e>
11319           </pattern>
11320           <ele>
11321             <name>order</name>
11322             <pattern>
11323               <t>
11324                 <alts>
11325                   <alt>ascending</alt>
11326                   <alt>descending</alt>
11327                 </alts>
11328               </t>
11329             </pattern>
11330           </ele>
11331         </ele>
11332       </ele>
11333       <ele>
11334         <name>filters</name>
11335         <pattern>
11336           <attrib>
11337             <name>start</name>
11338             <summary>First filter</summary>
11339             <type>integer</type>
11340             <required>1</required>
11341           </attrib>
11342           <attrib>
11343             <name>max</name>
11344             <summary>Maximum number of filters</summary>
11345             <type>integer</type>
11346             <required>1</required>
11347           </attrib>
11348         </pattern>
11349       </ele>
11350       <ele>
11351         <name>filter_count</name>
11352         <pattern>
11353           <e>filtered</e>
11354           <e>page</e>
11355         </pattern>
11356         <ele>
11357           <name>filtered</name>
11358           <summary>Number of filters after filtering</summary>
11359           <pattern><t>integer</t></pattern>
11360         </ele>
11361         <ele>
11362           <name>page</name>
11363           <summary>Number of filters on current page</summary>
11364           <pattern><t>integer</t></pattern>
11365         </ele>
11366       </ele>
11367     </response>
11368     <example>
11369       <summary>Get one or many filters</summary>
11370       <request>
11371         <get_filters></get_filters>
11372       </request>
11373       <response>
11374         <get_filters_response status="200" status_text="OK">
11375           <filter id="b493b7a8-7489-11df-a3ec-001164764cea">
11376             <name>Single Targets</name>
11377             <comment>Targets with only one host</comment>
11378             <term>ips=1 first=1 rows=-2</term>
11379             <type>target</type>
11380             <in_use>1</in_use>
11381             <writable>1</writable>
11382             <user_tags>
11383               <count>0</count>
11384             </user_tags>
11385             <creation_time>Sun Jun 27 08:49:46 2010</creation_time>
11386             <modification_time>Sun Jun 27 08:49:46 2010</modification_time>
11387           </filter>
11388           <truncated>...</truncated>
11389         </get_filters_response>
11390       </response>
11391     </example>
11392     <example>
11393       <summary>Get single filter, including alerts that use the filter</summary>
11394       <request>
11395         <get_filters filter_id="c33864a9-d3fd-44b3-8717-972bfb01dfc0" tasks="1">
11396         </get_filters>
11397       </request>
11398       <response>
11399         <get_filters_response status="200" status_text="OK">
11400           <filter id="c33864a9-d3fd-44b3-8717-972bfb01dfc0">
11401             <name>Local</name>
11402             <comment>Any item with name containing 'local'.</comment>
11403             <term>name~local first=1 rows=-2</term>
11404             <type></type>
11405             <in_use>1</in_use>
11406             <writable>1</writable>
11407             <user_tags>
11408               <count>0</count>
11409             </user_tags>
11410             <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
11411             <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
11412             <alerts>
11413               <alert id="13bb418a-4220-4575-b35b-ec398bff7418">
11414                 <name>Local Mailer</name>
11415               </alert>
11416               <truncated>...</truncated>
11417             </alerts>
11418           </filter>
11419         </get_filters_response>
11420       </response>
11421     </example>
11422   </command>
11423   <command>
11424     <name>get_groups</name>
11425     <summary>Get one or many groups</summary>
11426     <description>
11427       The client uses the get_groups command to get group information.
11428     </description>
11429     <pattern>
11430       <attrib>
11431         <name>group_id</name>
11432         <summary>ID of single group to get</summary>
11433         <type>uuid</type>
11434       </attrib>
11435       <attrib>
11436         <name>filter</name>
11437         <summary>Filter term to use to filter query</summary>
11438         <type>text</type>
11439         <filter_keywords>
11440           <column>
11441             <name>uuid</name>
11442             <type>uuid</type>
11443             <summary>Unique ID</summary>
11444           </column>
11445           <column>
11446             <name>name</name>
11447             <type>name</type>
11448             <summary>Name</summary>
11449           </column>
11450           <column>
11451             <name>comment</name>
11452             <type>text</type>
11453             <summary>Comment text</summary>
11454           </column>
11455           <column>
11456             <name>created</name>
11457             <type>iso_time</type>
11458             <summary>Creation time</summary>
11459           </column>
11460           <column>
11461             <name>modified</name>
11462             <type>iso_time</type>
11463             <summary>Modification time</summary>
11464           </column>
11465           <column>
11466             <name>owner</name>
11467             <type>name</type>
11468             <summary>Name of the owner</summary>
11469           </column>
11470         </filter_keywords>
11471       </attrib>
11472       <attrib>
11473         <name>filt_id</name>
11474         <summary>ID of filter to use to filter query</summary>
11475         <type>uuid</type>
11476       </attrib>
11477       <attrib>
11478         <name>trash</name>
11479         <summary>Whether to get the trashcan groups instead</summary>
11480         <type>boolean</type>
11481       </attrib>
11482     </pattern>
11483     <response>
11484       <pattern>
11485         <attrib>
11486           <name>status</name>
11487           <type>status</type>
11488           <required>1</required>
11489         </attrib>
11490         <attrib>
11491           <name>status_text</name>
11492           <type>text</type>
11493           <required>1</required>
11494         </attrib>
11495         <any><e>group</e></any>
11496         <e>filters</e>
11497         <e>sort</e>
11498         <e>groups</e>
11499         <e>group_count</e>
11500       </pattern>
11501       <ele>
11502         <name>group</name>
11503         <pattern>
11504           <attrib>
11505             <name>id</name>
11506             <type>uuid</type>
11507             <required>1</required>
11508           </attrib>
11509           <e>owner</e>
11510           <e>name</e>
11511           <e>comment</e>
11512           <e>creation_time</e>
11513           <e>modification_time</e>
11514           <e>writable</e>
11515           <e>in_use</e>
11516           <e>permissions</e>
11517           <e>user_tags</e>
11518           <e>users</e>
11519         </pattern>
11520         <ele>
11521           <name>owner</name>
11522           <summary>Owner of the group</summary>
11523           <pattern>
11524             <e>name</e>
11525           </pattern>
11526           <ele>
11527             <name>name</name>
11528             <summary>The name of the owner</summary>
11529             <pattern><t>name</t></pattern>
11530           </ele>
11531         </ele>
11532         <ele>
11533           <name>name</name>
11534           <summary>The name of the group</summary>
11535           <pattern><t>name</t></pattern>
11536         </ele>
11537         <ele>
11538           <name>comment</name>
11539           <summary>The comment on the group</summary>
11540           <pattern>text</pattern>
11541         </ele>
11542         <ele>
11543           <name>creation_time</name>
11544           <summary>Date and time the group was created</summary>
11545           <pattern><t>iso_time</t></pattern>
11546         </ele>
11547         <ele>
11548           <name>modification_time</name>
11549           <summary>Date and time the group was last modified</summary>
11550           <pattern><t>iso_time</t></pattern>
11551         </ele>
11552         <ele>
11553           <name>users</name>
11554           <summary>
11555             A comma-separated list of the users in the group
11556           </summary>
11557           <pattern>
11558             text
11559           </pattern>
11560         </ele>
11561         <ele>
11562           <name>writable</name>
11563           <summary>Whether the group is writable</summary>
11564           <pattern><t>boolean</t></pattern>
11565         </ele>
11566         <ele>
11567           <name>in_use</name>
11568           <summary>Whether the group is in use</summary>
11569           <pattern><t>boolean</t></pattern>
11570         </ele>
11571         <ele>
11572           <name>permissions</name>
11573           <summary>Permissions that the current user has on the group</summary>
11574           <pattern>
11575             <any><e>permission</e></any>
11576           </pattern>
11577           <ele>
11578             <name>permission</name>
11579             <pattern>
11580               <e>name</e>
11581             </pattern>
11582             <ele>
11583               <name>name</name>
11584               <summary>The name of the permission</summary>
11585               <pattern><t>name</t></pattern>
11586             </ele>
11587           </ele>
11588         </ele>
11589         <ele>
11590           <name>user_tags</name>
11591           <summary>Info on tags attached to the group</summary>
11592           <pattern>
11593             <e>count</e>
11594             <any><e>tag</e></any>
11595           </pattern>
11596           <ele>
11597             <name>count</name>
11598             <summary>Number of attached tags</summary>
11599             <pattern><t>integer</t></pattern>
11600           </ele>
11601           <ele>
11602             <name>tag</name>
11603             <summary>
11604               Short info on an individual tag
11605               (only if details were requested)
11606             </summary>
11607             <pattern>
11608               <attrib>
11609                 <name>id</name>
11610                 <type>uuid</type>
11611                 <summary>UUID of the tag</summary>
11612                 <required>1</required>
11613               </attrib>
11614               <e>name</e>
11615               <e>value</e>
11616               <e>comment</e>
11617             </pattern>
11618             <ele>
11619               <name>name</name>
11620               <summary>Name of the tag (usually namespace:predicate)</summary>
11621               <pattern>text</pattern>
11622             </ele>
11623             <ele>
11624               <name>value</name>
11625               <summary>Value of the tag</summary>
11626               <pattern>text</pattern>
11627             </ele>
11628             <ele>
11629               <name>comment</name>
11630               <summary>Comment for the tag</summary>
11631               <pattern>text</pattern>
11632             </ele>
11633           </ele>
11634         </ele>
11635       </ele>
11636       <ele>
11637         <name>filters</name>
11638         <pattern>
11639           <attrib>
11640             <name>id</name>
11641             <summary>UUID of filter if any, else 0</summary>
11642             <type>uuid</type>
11643             <required>1</required>
11644           </attrib>
11645           <e>term</e>
11646           <o><e>name</e></o>
11647           <e>keywords</e>
11648         </pattern>
11649         <ele>
11650           <name>term</name>
11651           <summary>Filter term</summary>
11652           <pattern>text</pattern>
11653         </ele>
11654         <ele>
11655           <name>name</name>
11656           <summary>Filter name, if applicable</summary>
11657           <pattern>text</pattern>
11658         </ele>
11659         <ele>
11660           <name>keywords</name>
11661           <summary>Filter broken down into keywords</summary>
11662           <pattern><any><e>keyword</e></any></pattern>
11663           <ele>
11664             <name>keyword</name>
11665             <pattern>
11666               <e>column</e>
11667               <e>relation</e>
11668               <e>value</e>
11669             </pattern>
11670             <ele>
11671               <name>column</name>
11672               <summary>Column prefix</summary>
11673               <pattern>text</pattern>
11674             </ele>
11675             <ele>
11676               <name>relation</name>
11677               <summary>Relation operator</summary>
11678               <pattern>
11679                 <alts>
11680                   <alt>=</alt>
11681                   <alt>:</alt>
11682                   <alt>~</alt>
11683                   <alt>&gt;</alt>
11684                   <alt>&lt;</alt>
11685                 </alts>
11686               </pattern>
11687             </ele>
11688             <ele>
11689               <name>value</name>
11690               <summary>The filter text</summary>
11691               <pattern>text</pattern>
11692             </ele>
11693           </ele>
11694         </ele>
11695       </ele>
11696       <ele>
11697         <name>sort</name>
11698         <pattern>
11699           text
11700           <e>field</e>
11701         </pattern>
11702         <ele>
11703           <name>field</name>
11704           <pattern>
11705             <e>order</e>
11706           </pattern>
11707           <ele>
11708             <name>order</name>
11709             <pattern>
11710               <t>
11711                 <alts>
11712                   <alt>ascending</alt>
11713                   <alt>descending</alt>
11714                 </alts>
11715               </t>
11716             </pattern>
11717           </ele>
11718         </ele>
11719       </ele>
11720       <ele>
11721         <name>groups</name>
11722         <pattern>
11723           <attrib>
11724             <name>start</name>
11725             <summary>First group</summary>
11726             <type>integer</type>
11727             <required>1</required>
11728           </attrib>
11729           <attrib>
11730             <name>max</name>
11731             <summary>Maximum number of groups</summary>
11732             <type>integer</type>
11733             <required>1</required>
11734           </attrib>
11735         </pattern>
11736       </ele>
11737       <ele>
11738         <name>group_count</name>
11739         <pattern>
11740           <e>filtered</e>
11741           <e>page</e>
11742         </pattern>
11743         <ele>
11744           <name>filtered</name>
11745           <summary>Number of groups after filtering</summary>
11746           <pattern><t>integer</t></pattern>
11747         </ele>
11748         <ele>
11749           <name>page</name>
11750           <summary>Number of groups on current page</summary>
11751           <pattern><t>integer</t></pattern>
11752         </ele>
11753       </ele>
11754     </response>
11755     <example>
11756       <summary>Get one or many groups</summary>
11757       <request>
11758         <get_groups></get_groups>
11759       </request>
11760       <response>
11761         <get_groups_response status="200" status_text="OK">
11762           <group id="b493b7a8-7489-11df-a3ec-002264764cea">
11763             <name>Management</name>
11764             <comment>Managers</comment>
11765             <creation_time>Sun Jun 27 08:49:43 2010</creation_time>
11766             <modification_time>Sun Jun 27 08:49:43 2010</modification_time>
11767             <writable>1</writable>
11768             <in_use>0</in_use>
11769             <user_tags>
11770               <count>0</count>
11771             </user_tags>
11772             <users>sarah, frank</users>
11773           </group>
11774           <truncated>...</truncated>
11775           <filters id="">
11776             <term>first=1 rows=-1 sort=name</term>
11777             <keywords>
11778               <keyword>
11779                 <column>first</column>
11780                 <relation>=</relation>
11781                 <value>1</value>
11782               </keyword>
11783               <truncated>...</truncated>
11784             </keywords>
11785           </filters>
11786           <sort>
11787             <field>
11788               name
11789               <order>ascending</order>
11790             </field>
11791           </sort>
11792           <groups max="-1" start="1"></groups>
11793           <group_count>
11794             1
11795             <filtered>1</filtered>
11796             <page>1</page>
11797           </group_count>
11798         </get_groups_response>
11799       </response>
11800     </example>
11801   </command>
11802   <command>
11803     <name>get_info</name>
11804     <summary>Get information for items of given type</summary>
11805     <description>
11806       The client uses the get_info command to get information about
11807       static data from an external source, like CVE or CPE.
11808       If the command sent by the client was valid, the manager will
11809       reply with a list of info elements of a given type to the client.
11810     </description>
11811     <pattern>
11812       <attrib>
11813         <name>type</name>
11814         <summary>Type must be either CERT_BUND_ADV, CPE, CVE, DFN_CERT_ADV, OVALDEF, NVT or ALLINFO</summary>
11815         <type>text</type>
11816         <required>1</required>
11817       </attrib>
11818       <attrib>
11819         <name>name</name>
11820         <summary>Name or identifier of the requested information</summary>
11821         <type>text</type>
11822       </attrib>
11823       <attrib>
11824         <name>info_id</name>
11825         <summary>ID of single info to get. Conflicts with name</summary>
11826         <type>text</type>
11827       </attrib>
11828       <attrib>
11829         <name>filter</name>
11830         <summary>Filter term to use to filter query</summary>
11831         <type>text</type>
11832         <filter_keywords>
11833           <column>
11834             <name>uuid</name>
11835             <type>uuid</type>
11836             <summary>Unique ID</summary>
11837           </column>
11838           <column>
11839             <name>name</name>
11840             <type>name</type>
11841             <summary>Name</summary>
11842           </column>
11843           <column>
11844             <name>comment</name>
11845             <type>text</type>
11846             <summary>Comment text</summary>
11847           </column>
11848           <column>
11849             <name>created</name>
11850             <type>iso_time</type>
11851             <summary>Creation time</summary>
11852           </column>
11853           <column>
11854             <name>modified</name>
11855             <type>iso_time</type>
11856             <summary>Modification time</summary>
11857           </column>
11858           <column>
11859             <name>owner</name>
11860             <type>name</type>
11861             <summary>Name of the owner</summary>
11862           </column>
11863           <column>
11864             <name>severity</name>
11865             <type>severity</type>
11866             <summary>Severity of the SecInfo</summary>
11867           </column>
11868         </filter_keywords>
11869         <filter_keywords>
11870           <condition>type is "nvt"</condition>
11871           <column>
11872             <name>version</name>
11873             <type>text</type>
11874             <summary>Version of the NVT</summary>
11875           </column>
11876           <column>
11877             <name>summary</name>
11878             <type>text</type>
11879             <summary>Summary text of the NVT</summary>
11880           </column>
11881           <column>
11882             <name>cve</name>
11883             <type>text</type>
11884             <summary>List of BIDs of the NVT</summary>
11885           </column>
11886           <column>
11887             <name>xref</name>
11888             <type>text</type>
11889             <summary>List of XREFs of the NVT</summary>
11890           </column>
11891           <column>
11892             <name>family</name>
11893             <type>text</type>
11894             <summary>Family of the NVT</summary>
11895           </column>
11896           <column>
11897             <name>cvss</name>
11898             <type>severity</type>
11899             <summary>Alias for severity</summary>
11900           </column>
11901           <column>
11902             <name>cvss_base</name>
11903             <type>severity</type>
11904             <summary>Alias for severity</summary>
11905           </column>
11906           <column>
11907             <name>script_tags</name>
11908             <type>text</type>
11909             <summary>List of script tags</summary>
11910           </column>
11911           <column>
11912             <name>qod</name>
11913             <type>integer</type>
11914             <summary>Numerical QoD</summary>
11915           </column>
11916           <column>
11917             <name>qod_type</name>
11918             <type>text</type>
11919             <summary>QoD type</summary>
11920           </column>
11921           <column>
11922             <name>solution_type</name>
11923             <type>text</type>
11924             <summary>Solution type</summary>
11925           </column>
11926         </filter_keywords>
11927         <filter_keywords>
11928           <condition>type is "cve"</condition>
11929           <column>
11930             <name>vector</name>
11931             <type>text</type>
11932             <summary>"Vector" component of the CVSS base vector</summary>
11933           </column>
11934           <column>
11935             <name>complexity</name>
11936             <type>text</type>
11937             <summary>"Complexity" component of the CVSS base vector</summary>
11938           </column>
11939           <column>
11940             <name>authentication</name>
11941             <type>text</type>
11942             <summary>"Authentication" component of the CVSS base vector</summary>
11943           </column>
11944           <column>
11945             <name>confidentiality_impact</name>
11946             <type>text</type>
11947             <summary>"Confidentiality Impact" component of the CVSS base vector</summary>
11948           </column>
11949           <column>
11950             <name>integrity_impact</name>
11951             <type>text</type>
11952             <summary>"Integrity Impact" component of the CVSS base vector</summary>
11953           </column>
11954           <column>
11955             <name>availability_impact</name>
11956             <type>text</type>
11957             <summary>"Availability Impact" component of the CVSS base vector</summary>
11958           </column>
11959           <column>
11960             <name>products</name>
11961             <type>text</type>
11962             <summary>Space separated list CPEs the CVE applies to</summary>
11963           </column>
11964           <column>
11965             <name>cvss</name>
11966             <type>severity</type>
11967             <summary>Alias for severity</summary>
11968           </column>
11969           <column>
11970             <name>description</name>
11971             <type>text</type>
11972             <summary>Description text of the CVE</summary>
11973           </column>
11974           <column>
11975             <name>published</name>
11976             <type><t>iso_time</t></type>
11977             <summary>Time the CVE was published, alias for created</summary>
11978           </column>
11979         </filter_keywords>
11980         <filter_keywords>
11981           <condition>type is "cpe"</condition>
11982           <column>
11983             <name>title</name>
11984             <type>text</type>
11985             <summary>Title text of the CPE</summary>
11986           </column>
11987           <column>
11988             <name>status</name>
11989             <type>text</type>
11990             <summary>Status of the CPE</summary>
11991           </column>
11992           <column>
11993             <name>deprecated_by_id</name>
11994             <type>text</type>
11995             <summary>NVD ID that has deprecated this CPE</summary>
11996           </column>
11997           <column>
11998             <name>max_cvss</name>
11999             <type>severity</type>
12000             <summary>Alias for severity</summary>
12001           </column>
12002           <column>
12003             <name>cves</name>
12004             <type>integer</type>
12005             <summary>Number of CVEs referencing this CPE</summary>
12006           </column>
12007           <column>
12008             <name>nvd_id</name>
12009             <type>integer</type>
12010             <summary>NVD ID of the CVE</summary>
12011           </column>
12012         </filter_keywords>
12013         <filter_keywords>
12014           <condition>type is "ovaldef"</condition>
12015           <column>
12016             <name>version</name>
12017             <type>integer</type>
12018             <summary>Version number of the OVAL Definition</summary>
12019           </column>
12020           <column>
12021             <name>deprecated</name>
12022             <type>boolean</type>
12023             <summary>Whether the OVAL Definition is deprecated</summary>
12024           </column>
12025           <column>
12026             <name>class</name>
12027             <type>text</type>
12028             <summary>Class of the OVAL Definition</summary>
12029           </column>
12030           <column>
12031             <name>title</name>
12032             <type>text</type>
12033             <summary>Title of the OVAL Definition</summary>
12034           </column>
12035           <column>
12036             <name>description</name>
12037             <type>text</type>
12038             <summary>Longer description of the OVAL Definition</summary>
12039           </column>
12040           <column>
12041             <name>file</name>
12042             <type>text</type>
12043             <summary>Name of the file containing the OVAL Definition</summary>
12044           </column>
12045           <column>
12046             <name>status</name>
12047             <type>text</type>
12048             <summary>Status of the OVAL Definition</summary>
12049           </column>
12050           <column>
12051             <name>max_cvss</name>
12052             <type>severity</type>
12053             <summary>Alias for severity</summary>
12054           </column>
12055           <column>
12056             <name>cves</name>
12057             <type>integer</type>
12058             <summary>Number of CVEs referencing this CPE</summary>
12059           </column>
12060         </filter_keywords>
12061         <filter_keywords>
12062           <condition>type is either "cert_bund_adv" or "dfn_cert_adv"</condition>
12063           <column>
12064             <name>title</name>
12065             <type>text</type>
12066             <summary>Title text of the CERT advisory</summary>
12067           </column>
12068           <column>
12069             <name>summary</name>
12070             <type>text</type>
12071             <summary>Summary text of the CERT advisory</summary>
12072           </column>
12073           <column>
12074             <name>cves</name>
12075             <type>integer</type>
12076             <summary>Number of CVEs referenced by the CERT advisory</summary>
12077           </column>
12078           <column>
12079             <name>max_cvss</name>
12080             <type>severity</type>
12081             <summary>Alias for severity</summary>
12082           </column>
12083         </filter_keywords>
12084         <filter_keywords>
12085           <condition>type is "allinfo"</condition>
12086           <column>
12087             <name>type</name>
12088             <type>text</type>
12089             <summary>Type of SecInfo as given in the "type" parameter</summary>
12090           </column>
12091           <column>
12092             <name>extra</name>
12093             <type>text</type>
12094             <summary>Title or similar text</summary>
12095           </column>
12096         </filter_keywords>
12097       </attrib>
12098       <attrib>
12099         <name>filt_id</name>
12100         <summary>ID of filter to use to filter query</summary>
12101         <type>uuid</type>
12102       </attrib>
12103       <attrib>
12104         <name>details</name>
12105         <summary>Whether to include information about references to this information</summary>
12106         <type>boolean</type>
12107       </attrib>
12108     </pattern>
12109     <response>
12110       <pattern>
12111         <attrib>
12112           <name>status</name>
12113           <type>status</type>
12114           <required>1</required>
12115         </attrib>
12116         <attrib>
12117           <name>status_text</name>
12118           <type>text</type>
12119           <required>1</required>
12120         </attrib>
12121         <any><e>info</e></any>
12122         <e>filters</e>
12123         <e>sort</e>
12124         <e>details</e>
12125         <e>info_count</e>
12126       </pattern>
12127       <ele>
12128         <name>info</name>
12129         <pattern>
12130           <attrib>
12131             <name>id</name>
12132             <type>integer</type>
12133             <summary>A unique number identifying this info, if available</summary>
12134           </attrib>
12135           <e>owner</e>
12136           <e>name</e>
12137           <e>comment</e>
12138           <e>creation_time</e>
12139           <e>modification_time</e>
12140           <e>permissions</e>
12141           <e>user_tags</e>
12142           <e>update_time</e>
12143           <or>
12144             <e>cert_bund_adv</e>
12145             <e>cpe</e>
12146             <e>cve</e>
12147             <e>dfn_cert_adv</e>
12148             <e>ovaldef</e>
12149             <e>nvt</e>
12150             <e>allinfo</e>
12151           </or>
12152         </pattern>
12153         <ele>
12154           <name>owner</name>
12155           <summary>Owner of the info</summary>
12156           <pattern>
12157             <e>name</e>
12158           </pattern>
12159           <ele>
12160             <name>name</name>
12161             <summary>The name of the owner</summary>
12162             <pattern><t>name</t></pattern>
12163           </ele>
12164         </ele>
12165         <ele>
12166           <name>name</name>
12167           <summary>The name of the info</summary>
12168           <pattern><t>name</t></pattern>
12169         </ele>
12170         <ele>
12171           <name>comment</name>
12172           <summary>The comment on the info</summary>
12173           <pattern>text</pattern>
12174         </ele>
12175         <ele>
12176           <name>creation_time</name>
12177           <summary>Date and time the info was created</summary>
12178           <pattern><t>iso_time</t></pattern>
12179         </ele>
12180         <ele>
12181           <name>modification_time</name>
12182           <summary>Date and time the info was last modified</summary>
12183           <pattern><t>iso_time</t></pattern>
12184         </ele>
12185         <ele>
12186           <name>update_time</name>
12187           <summary>Date and time the source of the info was read</summary>
12188           <pattern><t>iso_time</t></pattern>
12189         </ele>
12190         <ele>
12191           <name>permissions</name>
12192           <summary>Permissions that the current user has on the info</summary>
12193           <pattern>
12194             <any><e>permission</e></any>
12195           </pattern>
12196           <ele>
12197             <name>permission</name>
12198             <pattern>
12199               <e>name</e>
12200             </pattern>
12201             <ele>
12202               <name>name</name>
12203               <summary>The name of the permission</summary>
12204               <pattern><t>name</t></pattern>
12205             </ele>
12206           </ele>
12207         </ele>
12208         <ele>
12209           <name>user_tags</name>
12210           <summary>Info on tags attached to the info</summary>
12211           <pattern>
12212             <e>count</e>
12213             <any><e>tag</e></any>
12214           </pattern>
12215           <ele>
12216             <name>count</name>
12217             <summary>Number of attached tags</summary>
12218             <pattern><t>integer</t></pattern>
12219           </ele>
12220           <ele>
12221             <name>tag</name>
12222             <summary>
12223               Short info on an individual tag
12224               (only if details were requested)
12225             </summary>
12226             <pattern>
12227               <attrib>
12228                 <name>id</name>
12229                 <type>uuid</type>
12230                 <summary>UUID of the tag</summary>
12231                 <required>1</required>
12232               </attrib>
12233               <e>name</e>
12234               <e>value</e>
12235               <e>comment</e>
12236             </pattern>
12237             <ele>
12238               <name>name</name>
12239               <summary>Name of the tag (usually namespace:predicate)</summary>
12240               <pattern>text</pattern>
12241             </ele>
12242             <ele>
12243               <name>value</name>
12244               <summary>Value of the tag</summary>
12245               <pattern>text</pattern>
12246             </ele>
12247             <ele>
12248               <name>comment</name>
12249               <summary>Comment for the tag</summary>
12250               <pattern>text</pattern>
12251             </ele>
12252           </ele>
12253         </ele>
12254         <ele>
12255           <name>cert_bund_adv</name>
12256           <pattern>
12257             <e>title</e>
12258             <e>summary</e>
12259             <e>max_cvss</e>
12260             <e>cve_refs</e>
12261             <o><e>raw_data</e></o>
12262           </pattern>
12263           <summary>An CERT-Bund advisory info element</summary>
12264           <ele>
12265             <name>title</name>
12266             <summary>Title of the advisory</summary>
12267             <pattern>
12268               text
12269             </pattern>
12270           </ele>
12271           <ele>
12272             <name>summary</name>
12273             <summary>Summary text of the advisory</summary>
12274             <pattern>
12275               text
12276             </pattern>
12277           </ele>
12278           <ele>
12279             <name>max_cvss</name>
12280             <summary>Highest CVSS score of CVEs referenced by the advisory</summary>
12281             <pattern>text</pattern>
12282           </ele>
12283           <ele>
12284             <name>cve_refs</name>
12285             <summary>Number of CVEs referenced by this advisory</summary>
12286             <pattern>
12287               <t>integer</t>
12288             </pattern>
12289           </ele>
12290           <ele>
12291             <name>raw_data</name>
12292             <summary>Source representation of the information. Only when details were requested</summary>
12293             <pattern>
12294               text
12295             </pattern>
12296           </ele>
12297         </ele>
12298         <ele>
12299           <name>cpe</name>
12300           <pattern>
12301             <e>nvd_id</e>
12302             <o><e>title</e></o>
12303             <e>max_cvss</e>
12304             <e>cve_refs</e>
12305             <e>status</e>
12306             <o><e>cves</e></o>
12307             <o><e>raw_data</e></o>
12308           </pattern>
12309           <summary>A CPE info element</summary>
12310           <ele>
12311             <name>nvd_id</name>
12312             <summary>The NVD ID of the CPE</summary>
12313             <pattern>
12314               text
12315             </pattern>
12316           </ele>
12317           <ele>
12318             <name>title</name>
12319             <summary>The title of the CPE</summary>
12320             <pattern>
12321               text
12322             </pattern>
12323           </ele>
12324           <ele>
12325             <name>max_cvss</name>
12326             <summary>The highest CVSS recorder for this CPE</summary>
12327             <pattern>
12328               <t>integer</t>
12329             </pattern>
12330           </ele>
12331           <ele>
12332             <name>cve_refs</name>
12333             <summary>The number CVE of references to this CPE</summary>
12334             <pattern>
12335               <t>integer</t>
12336             </pattern>
12337           </ele>
12338           <ele>
12339             <name>status</name>
12340             <summary>The status of this CPE</summary>
12341             <pattern>
12342               text
12343             </pattern>
12344           </ele>
12345           <ele>
12346             <name>cves</name>
12347             <summary>CVEs referring to this CPE. Only when details were requested</summary>
12348             <pattern>
12349               <any><e>cve</e></any>
12350             </pattern>
12351             <ele>
12352               <name>cve</name>
12353               <summary>CVE referring to this CPE</summary>
12354               <pattern>
12355                 text
12356               </pattern>
12357             </ele>
12358           </ele>
12359           <ele>
12360             <name>raw_data</name>
12361             <summary>Source representation of the information. Only when details were requested</summary>
12362             <pattern>
12363               text
12364             </pattern>
12365           </ele>
12366         </ele>
12367         <ele>
12368           <name>nvt</name>
12369           <pattern>
12370             text
12371           </pattern>
12372           <summary>A NVT info element</summary>
12373         </ele>
12374         <ele>
12375           <name>cve</name>
12376           <pattern>
12377             <e>cvss</e>
12378             <e>vector</e>
12379             <e>complexity</e>
12380             <e>authentication</e>
12381             <e>confidentiality_impact</e>
12382             <e>integrity_impact</e>
12383             <e>availability_impact</e>
12384             <e>description</e>
12385             <e>products</e>
12386             <o><e>nvts</e></o>
12387             <o><e>cert</e></o>
12388             <o><e>raw_data</e></o>
12389           </pattern>
12390           <summary>A CVE info element</summary>
12391           <ele>
12392             <name>cvss</name>
12393             <summary>CVSS Base Score</summary>
12394             <pattern>
12395               text
12396             </pattern>
12397           </ele>
12398           <ele>
12399             <name>vector</name>
12400             <summary>CVSS Access Vector metric</summary>
12401             <pattern>
12402               text
12403             </pattern>
12404           </ele>
12405           <ele>
12406             <name>complexity</name>
12407             <summary>CVSS Attack Complexity metric</summary>
12408             <pattern>
12409               text
12410             </pattern>
12411           </ele>
12412           <ele>
12413             <name>authentication</name>
12414             <summary>CVSS Authentication metric</summary>
12415             <pattern>
12416               text
12417             </pattern>
12418           </ele>
12419           <ele>
12420             <name>confidentiality_impact</name>
12421             <summary>CVSS Confidentiality impact metric</summary>
12422             <pattern>
12423               text
12424             </pattern>
12425           </ele>
12426           <ele>
12427             <name>integrity_impact</name>
12428             <summary>CVSS Integrity impact metric</summary>
12429             <pattern>
12430               text
12431             </pattern>
12432           </ele>
12433           <ele>
12434             <name>availability_impact</name>
12435             <summary>CVSS Availability impact metric</summary>
12436             <pattern>
12437               text
12438             </pattern>
12439           </ele>
12440           <ele>
12441             <name>description</name>
12442             <summary>The CVE's description</summary>
12443             <pattern>
12444               text
12445             </pattern>
12446           </ele>
12447           <ele>
12448             <name>products</name>
12449             <summary>Space separated list of CPEs affected by this</summary>
12450             <pattern>
12451               text
12452             </pattern>
12453           </ele>
12454           <ele>
12455             <name>nvts</name>
12456             <summary>NVTs addressing this CVE. Only when details were requested</summary>
12457             <pattern>
12458               <any><e>nvt</e></any>
12459             </pattern>
12460             <ele>
12461               <name>nvt</name>
12462               <summary>NVT referring to this CPE</summary>
12463               <pattern>
12464                 <attrib>
12465                   <name>oid</name>
12466                   <type>oid</type>
12467                 </attrib>
12468                 <e>name</e>
12469               </pattern>
12470               <ele>
12471                 <name>name</name>
12472                 <summary>Name of the NVT</summary>
12473                 <pattern>
12474                   text
12475                 </pattern>
12476               </ele>
12477             </ele>
12478           </ele>