<?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: check_omp manpage

 Authors:
 Jan-Oliver Wagner <jan-oliver.wagner@greenbone.net>

 Copyright:
 Copyright (C) 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="check_omp" section="8" desc="OMP command line tool to support Nagios core for OpenVAS">

  <synopsis>
    <cmd>check_omp OPTIONS</cmd>
  </synopsis>

  <description>
    <p>
      check_omp is a OMP command line tool specifically designed to
      support Nagios core in order to integrate vulnerability scan
      results into system monitoring.
    </p>

    <p>
    Basically, check_omp works the same like the "omp" command line tool.
    </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>-O, --ping</opt></p>
      <optdesc>
        <p>Ping the manager.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-t, --timout=<ARG>SECONDS</ARG></opt></p>
      <optdesc>
        <p>Wait SECONDS for response (0 disables timeout).</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>-T, --task=<arg>TASK</arg></opt></p>
      <optdesc>
        <p>Report status of task TASK.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-F, --host-filter=<arg>IP</arg></opt></p>
      <optdesc>
        <p>Report last report status of host IP.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--overrides=<arg>N</arg></opt></p>
      <optdesc>
        <p>Include overrides (N: 0=no, 1=yes).</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-d, --details</opt></p>
      <optdesc>
        <p>Include connection details in output.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-l, --report-link</opt></p>
      <optdesc>
        <p>Include URL of report in output.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--dfn</opt></p>
      <optdesc>
        <p>Include DFN-CERT IDs on vulnerabilities in output.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--oid</opt></p>
      <optdesc>
        <p>Include OIDs of NVTs finding vulnerabilities in output.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--descr</opt></p>
      <optdesc>
        <p>Include descriptions of NVTs finding vulnerabilities in output.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--showlog</opt></p>
      <optdesc>
        <p>Include log messages in output.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--scanend</opt></p>
      <optdesc>
        <p>Include timestamp of scan end in output.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--autofp=<arg>N</arg></opt></p>
      <optdesc>
        <p>Trust vendor security updates for automatic false positive filtering (0=No, 1=full match, 2=partial).</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-e, --empty-as-unknown</opt></p>
      <optdesc>
        <p>Respond with UNKNOWN on empty results.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--status</opt></p>
      <optdesc>
        <p>Report status of task.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>-A, --use-asset-management</opt></p>
      <optdesc>
        <p>Request host status via Asset Management.</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--trend</opt></p>
      <optdesc>
        <p>Report status by trend (default).</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--last-report</opt></p>
      <optdesc>
        <p>Report status by last report.</p>
      </optdesc>
    </option>

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

    <option>
      <p><opt>-v, --verbose</opt></p>
      <optdesc>
        <p>Verbose messages (WARNING: may reveal passwords).</p>
      </optdesc>
    </option>

    <option>
      <p><opt>--Werror</opt></p>
      <optdesc>
        <p>Turn status UNKNOWN into status CRITICIAL.</p>
      </optdesc>
    </option>

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

  <section name="EXAMPLES">
    <p>omp --username foobar --trend</p>
    <p>
      Connect to the OpenVAS Manager as user foobar and ask for trend.
    </p>
  </section>

  <section name="SEE ALSO">
    <p>
      <manref name="openvassd" section="8"/>
      <manref name="gsad" section="8"/>
      <manref name="openvasmd" section="8"/>
      <manref name="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 check_omp command line client is released under the GNU GPL,
      version 2, or, at your option, any later version.
    </p>
  </section>

</manpage>
