"Fossies" - the Fresh Open Source Software Archive

Member "openvas-cli-1.4.5/doc/omp.8.xml" (21 Jul 2016, 7547 Bytes) of package /linux/misc/openvas/openvas-cli-1.4.5.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) XML source code syntax highlighting (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.8.xml": 1.4.4_vs_1.4.5.

    1 <?xml version="1.0" standalone='no'?>
    2 <!DOCTYPE manpage SYSTEM "/usr/share/xmltoman/xmltoman.dtd">
    3 <?xml-stylesheet type="text/xsl" href="/usr/share/xmltoman/xmltoman.xsl" ?>
    4 
    5 <!-- OpenVAS
    6  $Id$
    7  Description: omp manpage
    8 
    9  Authors:
   10  Matthew Mundell <matthew.mundell@greenbone.net>
   11  Michael Wiegand <michael.wiegand@greenbone.net>
   12 
   13  Copyright:
   14  Copyright (C) 2011, 2016 Greenbone Networks GmbH
   15 
   16  This program is free software; you can redistribute it and/or
   17  modify it under the terms of the GNU General Public License
   18  as published by the Free Software Foundation; either version 2
   19  of the License, or (at your option) any later version.
   20 
   21  This program is distributed in the hope that it will be useful,
   22  but WITHOUT ANY WARRANTY; without even the implied warranty of
   23  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   24  GNU General Public License for more details.
   25 
   26  You should have received a copy of the GNU General Public License
   27  along with this program; if not, write to the Free Software
   28  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   29 -->
   30 
   31 <manpage name="omp" section="8" desc="OMP command line client for the Open Vulnerability Assessment System (OpenVAS)">
   32 
   33   <synopsis>
   34     <cmd>omp OPTIONS</cmd>
   35   </synopsis>
   36 
   37   <description>
   38     <p>
   39       Together, OpenVAS Scanner (openvassd(8)) and OpenVAS Manager
   40       (openvasmd(8)) provide the core functionality of the Open
   41       Vulnerability Assessment System (OpenVAS), with OpenVAS Scanner
   42       handling the actual scan process and OpenVAS Manager adding
   43       various management functionalities to handle and organise scan
   44       results.
   45     </p>
   46 
   47     <p>
   48       The omp binary is a command line client which uses the OMP
   49       protocol to connect to the OpenVAS Manager and makes it easy to
   50       access the full functionality provided by the OpenVAS Manager
   51       conveniently from the command line and allows quick integration
   52       in a scripted environment.
   53     </p>
   54 
   55   </description>
   56 
   57   <options>
   58     <option>
   59       <p><opt>-h, --host=<arg>HOST</arg></opt></p>
   60       <optdesc><p>Connect to OpenVAS Manager on host HOST.</p></optdesc>
   61     </option>
   62 
   63     <option>
   64       <p><opt>-p, --port=<arg>PORT</arg></opt></p>
   65       <optdesc><p>Connect to OpenVAS Manager on port PORT.</p></optdesc>
   66     </option>
   67 
   68     <option>
   69       <p><opt>-u, --username=<arg>USER</arg></opt></p>
   70       <optdesc>
   71         <p>Use the username USER to access the OpenVAS Manager.</p>
   72       </optdesc>
   73     </option>
   74 
   75     <option>
   76       <p><opt>-w, --password=<arg>PASSWORD</arg></opt></p>
   77       <optdesc>
   78         <p>
   79           Use the password PASSWORD to access the OpenVAS Manager. If
   80           the password is not set as parameter, it will be requested
   81           interactively.
   82         </p>
   83       </optdesc>
   84     </option>
   85 
   86     <option>
   87       <p><opt>--config-file=<arg>FILE</arg></opt></p>
   88       <optdesc>
   89         <p>
   90           Use the information provided in FILE as parameters for the
   91           connection to the OpenVAS Manager.
   92         </p>
   93       </optdesc>
   94     </option>
   95 
   96     <option>
   97       <p><opt>--send-file=<arg>FILE</arg></opt></p>
   98       <optdesc>
   99         <p>
  100           Replace SENDFILE in xml string to send with base64 encoded content of FILE.
  101           Only the first occurrence is replaced.
  102         </p>
  103       </optdesc>
  104     </option>
  105 
  106     <option>
  107       <p><opt>-P, --prompt</opt></p>
  108       <optdesc>
  109         <p>Prompt to exit.</p>
  110       </optdesc>
  111     </option>
  112 
  113     <option>
  114       <p><opt>-O, --get-omp-version</opt></p>
  115       <optdesc>
  116         <p>Display the OMP version used by OpenVAS Manager.</p>
  117       </optdesc>
  118     </option>
  119 
  120     <option>
  121       <p><opt>-C, --create-task</opt></p>
  122       <optdesc>
  123         <p>Create a task.</p>
  124       </optdesc>
  125     </option>
  126 
  127     <option>
  128       <p><opt>-n, --name=<arg>NAME</arg></opt></p>
  129       <optdesc>
  130         <p>Use NAME as the name for the newly created task.</p>
  131       </optdesc>
  132     </option>
  133 
  134     <option>
  135       <p><opt>-c, --comment=<arg>COMMENT</arg></opt></p>
  136       <optdesc>
  137         <p>Use COMMENT as the comment for the newly created task.</p>
  138       </optdesc>
  139     </option>
  140 
  141     <option>
  142       <p><opt>-t, --target=<arg>TARGET</arg></opt></p>
  143       <optdesc>
  144         <p>Use TARGET as the target for the newly created task.</p>
  145       </optdesc>
  146     </option>
  147 
  148     <option>
  149       <p><opt>--file</opt></p>
  150       <optdesc>
  151         <p>Add text in stdin as file on task..</p>
  152       </optdesc>
  153     </option>
  154 
  155     <option>
  156       <p><opt>-E, --delete-report</opt></p>
  157       <optdesc>
  158         <p>Delete one or more reports.</p>
  159       </optdesc>
  160     </option>
  161 
  162     <option>
  163       <p><opt>-D, --delete-task</opt></p>
  164       <optdesc>
  165         <p>Delete one or more tasks.</p>
  166       </optdesc>
  167     </option>
  168 
  169     <option>
  170       <p><opt>-R, --get-report</opt></p>
  171       <optdesc>
  172         <p>Get report of one task.</p>
  173       </optdesc>
  174     </option>
  175 
  176     <option>
  177       <p><opt>-F, --get-report-formats</opt></p>
  178       <optdesc>
  179         <p>Get report formats (OMP 2.0 only).</p>
  180       </optdesc>
  181     </option>
  182 
  183     <option>
  184       <p><opt>-f, --format=<arg>FORMAT</arg></opt></p>
  185       <optdesc>
  186         <p>Get report in format FORMAT.</p>
  187       </optdesc>
  188     </option>
  189 
  190     <option>
  191       <p><opt>-G, --get-tasks</opt></p>
  192       <optdesc>
  193         <p>Get status of one, many or all tasks.</p>
  194       </optdesc>
  195     </option>
  196 
  197     <option>
  198       <p><opt>-g, --get-configs</opt></p>
  199       <optdesc>
  200         <p>Get configs.</p>
  201       </optdesc>
  202     </option>
  203 
  204     <option>
  205       <p><opt>-T, --get-targets</opt></p>
  206       <optdesc>
  207         <p>Get targets.</p>
  208       </optdesc>
  209     </option>
  210 
  211     <option>
  212       <p><opt>-M, --modify-task</opt></p>
  213       <optdesc>
  214         <p>Modify a task.</p>
  215       </optdesc>
  216     </option>
  217 
  218     <option>
  219       <p><opt>-S, --start-task</opt></p>
  220       <optdesc>
  221         <p>Start one or more tasks.</p>
  222       </optdesc>
  223     </option>
  224 
  225     <option>
  226       <p><opt>-X, --xml=<arg>COMMAND</arg></opt></p>
  227       <optdesc>
  228         <p>
  229           Send COMMAND as XML to the OpenVAS Manager (e.g. "&lt;help/&gt;",
  230           "&lt;get_version/&gt;").
  231         </p>
  232       </optdesc>
  233     </option>
  234 
  235     <option>
  236       <p><opt>-i, --pretty-print</opt></p>
  237       <optdesc>
  238         <p>In combination with -X, pretty print the response.</p>
  239       </optdesc>
  240     </option>
  241 
  242     <option>
  243       <p><opt>-v, --version</opt></p>
  244       <optdesc>
  245         <p>Print version.</p>
  246       </optdesc>
  247     </option>
  248 
  249     <option>
  250       <p><opt>-?, --help</opt></p>
  251       <optdesc>
  252         <p>Show help.</p>
  253       </optdesc>
  254     </option>
  255   </options>
  256 
  257   <section name="EXAMPLES">
  258     <p>omp --username foobar --get-tasks</p>
  259     <p>
  260       Connect to the OpenVAS Manager as user foobar and get the list
  261       of tasks.
  262     </p>
  263   </section>
  264 
  265   <section name="SEE ALSO">
  266     <p>
  267       <manref name="openvassd" section="8"/>
  268       <manref name="gsad" section="8"/>
  269       <manref name="openvasmd" section="8"/>
  270       <manref name="check_omp" section="8"/>
  271     </p>
  272   </section>
  273 
  274   <section name="MORE INFORMATION ABOUT THE OpenVAS PROJECT">
  275     <p>
  276       The canonical places where you will find more information
  277       about the OpenVAS project are:
  278 
  279       <url href="http://www.openvas.org/"/>
  280       (Official site)
  281 
  282       <url href="http://wald.intevation.org/projects/openvas/"/>
  283       (Development Platform)
  284     </p>
  285   </section>
  286 
  287   <section name="COPYRIGHT">
  288     <p>
  289       The omp command line client is released under the GNU GPL,
  290       version 2, or, at your option, any later version.
  291     </p>
  292   </section>
  293 
  294 </manpage>