<?xml version="1.0" standalone='no'?>
<!DOCTYPE manpage SYSTEM "/usr/share/xmltoman/xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="/usr/share/xmltoman/xmltoman.xsl" ?>

<!-- OpenVAS
 $Id$
 Description: omp manpage

 Authors:
 Matthew Mundell <matthew.mundell@greenbone.net>
 Michael Wiegand <michael.wiegand@greenbone.net>

 Copyright:
 Copyright (C) 2011, 2016 Greenbone Networks GmbH

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

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

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

<manpage name="omp" section="8" desc="OMP command line client for the Open Vulnerability Assessment System (OpenVAS)">

  <synopsis>
    <cmd>omp OPTIONS</cmd>
  </synopsis>

  <description>
    <p>
      Together, OpenVAS Scanner (openvassd(8)) and OpenVAS Manager
      (openvasmd(8)) provide the core functionality of the Open
      Vulnerability Assessment System (OpenVAS), with OpenVAS Scanner
      handling the actual scan process and OpenVAS Manager adding
      various management functionalities to handle and organise scan
      results.
    </p>

    <p>
      The omp binary is a command line client which uses the OMP
      protocol to connect to the OpenVAS Manager and makes it easy to
      access the full functionality provided by the OpenVAS Manager
      conveniently from the command line and allows quick integration
      in a scripted environment.
    </p>

  </description>

  <options>
    <option>
      <p><opt>-h, --host=<arg>HOST</arg></opt></p>
      <optdesc><p>Connect to OpenVAS Manager on host HOST.</p></optdesc>
    </option>

    <option>
      <p><opt>-p, --port=<arg>PORT</arg></opt></p>
      <optdesc><p>Connect to OpenVAS Manager on port PORT.</p></optdesc>
    </option>

    <option>
      <p><opt>-u, --username=<arg>USER</arg></opt></p>
      <optdesc>
        <p>Use the username USER to access the OpenVAS Manager.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-w, --password=<arg>PASSWORD</arg></opt></p>
      <optdesc>
        <p>
          Use the password PASSWORD to access the OpenVAS Manager. If
          the password is not set as parameter, it will be requested
          interactively.
        </p>
      </optdesc>
    </option>

    <option>
      <p><opt>--config-file=<arg>FILE</arg></opt></p>
      <optdesc>
        <p>
          Use the information provided in FILE as parameters for the
          connection to the OpenVAS Manager.
        </p>
      </optdesc>
    </option>

    <option>
      <p><opt>--send-file=<arg>FILE</arg></opt></p>
      <optdesc>
        <p>
          Replace SENDFILE in xml string to send with base64 encoded content of FILE.
          Only the first occurrence is replaced.
        </p>
      </optdesc>
    </option>

    <option>
      <p><opt>-P, --prompt</opt></p>
      <optdesc>
        <p>Prompt to exit.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-O, --get-omp-version</opt></p>
      <optdesc>
        <p>Display the OMP version used by OpenVAS Manager.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-C, --create-task</opt></p>
      <optdesc>
        <p>Create a task.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-n, --name=<arg>NAME</arg></opt></p>
      <optdesc>
        <p>Use NAME as the name for the newly created task.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-c, --comment=<arg>COMMENT</arg></opt></p>
      <optdesc>
        <p>Use COMMENT as the comment for the newly created task.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-t, --target=<arg>TARGET</arg></opt></p>
      <optdesc>
        <p>Use TARGET as the target for the newly created task.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--file</opt></p>
      <optdesc>
        <p>Add text in stdin as file on task..</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-E, --delete-report</opt></p>
      <optdesc>
        <p>Delete one or more reports.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-D, --delete-task</opt></p>
      <optdesc>
        <p>Delete one or more tasks.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-R, --get-report</opt></p>
      <optdesc>
        <p>Get report of one task.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-F, --get-report-formats</opt></p>
      <optdesc>
        <p>Get report formats (OMP 2.0 only).</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-f, --format=<arg>FORMAT</arg></opt></p>
      <optdesc>
        <p>Get report in format FORMAT.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-G, --get-tasks</opt></p>
      <optdesc>
        <p>Get status of one, many or all tasks.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-g, --get-configs</opt></p>
      <optdesc>
        <p>Get configs.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-T, --get-targets</opt></p>
      <optdesc>
        <p>Get targets.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-M, --modify-task</opt></p>
      <optdesc>
        <p>Modify a task.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-S, --start-task</opt></p>
      <optdesc>
        <p>Start one or more tasks.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-X, --xml=<arg>COMMAND</arg></opt></p>
      <optdesc>
        <p>
          Send COMMAND as XML to the OpenVAS Manager (e.g. "&lt;help/&gt;",
          "&lt;get_version/&gt;").
        </p>
      </optdesc>
    </option>

    <option>
      <p><opt>-i, --pretty-print</opt></p>
      <optdesc>
        <p>In combination with -X, pretty print the response.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-v, --version</opt></p>
      <optdesc>
        <p>Print version.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-?, --help</opt></p>
      <optdesc>
        <p>Show help.</p>
      </optdesc>
    </option>
  </options>

  <section name="EXAMPLES">
    <p>omp --username foobar --get-tasks</p>
    <p>
      Connect to the OpenVAS Manager as user foobar and get the list
      of tasks.
    </p>
  </section>

  <section name="SEE ALSO">
    <p>
      <manref name="openvassd" section="8"/>
      <manref name="gsad" section="8"/>
      <manref name="openvasmd" section="8"/>
      <manref name="check_omp" section="8"/>
    </p>
  </section>

  <section name="MORE INFORMATION ABOUT THE OpenVAS PROJECT">
    <p>
      The canonical places where you will find more information
      about the OpenVAS project are:

      <url href="http://www.openvas.org/"/>
      (Official site)

      <url href="http://wald.intevation.org/projects/openvas/"/>
      (Development Platform)
    </p>
  </section>

  <section name="COPYRIGHT">
    <p>
      The omp command line client is released under the GNU GPL,
      version 2, or, at your option, any later version.
    </p>
  </section>

</manpage>
