User Tools

Site Tools


api:export:externalsystemopenvas

ExportAPI: OpenVAS task

This feature is available version 0.12 or higher.

This destination creates OpenVAS scan tasks for yourCMDB objects using the OpenVAS Manager Protocol (OMP). For each object, a single scan task is built. The following name is used for the OpenVAS scan task and target:

format: <namespacePrefix><CMDB-ID> <hostname> <taskname>
example: yourCMDB_1287 server1.yourcmdb.org Admin-Michael Batz

The OpenVAS tasks and targets are created for the given OpenVAS user (parameter ompUser) and permissions are created for a specific OpenVAS role (parameter taskVisibilityRole). Each user in that role can read the exported tasks and start/stop/resume the scanning for the tasks but cannot change any tasks/targets.

Configuration

short information
class name ExternalSystemOpenvas
needed destination parameterompHost
ompPort
ompUser
ompPassword
scannerName
configName
taskVisibilityRole
needed variableshostname
taskname
ip

destination parameters

namerequireddescriptionexample
ompHostrequiredOpenVAS manager hostname/ip10.0.1.104
ompPortrequiredOpenVAS manager port9390
ompUserrequiredOpenVAS manager username admin
ompPasswordrequiredOpenVAS manager passwordadmin
scannerNamerequiredName of the OpenVAS scanner object to useOpenVAS Default
configNamerequiredName of the OpenVAS scan config to useFull and very deep ultimate
taskVisibilityRolerequiredName of the OpenVAS role, for which the created tasks are visibleUser
namespacePrefixoptionalprefix to use in names for OpenVAS tasks/targetsyourCMDB_

variables

namerequireddescriptionexample
tasknamerequiredinformation which is part of the taskname test
hostnamerequiredhostname which is part of the taskname localhost
iprequiredip address to scan127.0.01

Examples

example of export task configuration:

<task name="openvas-example">
        <sources>
                <source objecttype="server" status="A" fieldname="management-secscan" fieldvalue="true" />
        </sources>
        <destination class="ExternalSystemOpenvas">
                <parameter key="ompHost" value="10.0.1.104" />
                <parameter key="ompPort" value="9390" />
                <parameter key="ompUser" value="admin" />
                <parameter key="ompPassword" value="admin" />
                <parameter key="scannerName" value="OpenVAS Default" />
                <parameter key="configName" value="Full and very deep ultimate" />
                <parameter key="taskVisibilityRole" value="User" />
                <parameter key="namespacePrefix" value="yourCMDB_" />
        </destination>
        <variables>
                <variable name="taskname">
                        <value objecttype="server" fieldname="Name" />
                </variable>
                <variable name="ip">
                        <value objecttype="server" fieldname="management-ip" />
                </variable>
                <variable name="hostname">
                        <value objecttype="server" fieldname="hostname" />
                </variable>
        </variables>
</task>
api/export/externalsystemopenvas.txt · Last modified: 2017/07/24 11:43 (external edit)