Skip to main content

Configure the scanner

Snow Inventory Oracle Middleware Scanner uses the include and exclude paths defined in the snowagent.config file for the filesystem search, as described in The scanning process.

You can make additional configurations to the scanner by using the snowmiddlewarescanner.config file, which can be included in the installation package. You only have to include the file if you want to customize any of the parameters in the file. If the file is not included, the scanner will execute the scan with the default values.

The snowmiddlewarescanner.config file contains the following elements and default values:

<Configuration>
    <UseDataOptimization>false</UseDataOptimization>
    <Anonymization>
        <File filename="config.xml">
            <Xpath>//listen-port</Xpath>
            <Xpath>//listen-address</Xpath>
            <Xpath>//credential-encrypted</Xpath>
            <Xpath>//node-manager-password-encrypted</Xpath>
        </File>
    </Anonymization>
</Configuration>

The available configurations via the snowmiddlewarescanner.config file, as well as other configurations to the Snow Inventory Oracle Middleware Scanner, are described in the following sections.

Configure the scanner to inventory only top-level Middleware components

By enabling this option in the snowmiddlewarescanner.config file, only the top-level middleware components will be inventoried, ignoring all the child middleware components. This will optimize the data volume, which can be useful when dealing with big estates. It will not affect the visibility of middleware products, but the drawback is that any additional child components related to those products will not be detected.

To enable the option, use the following configuration in the snowmiddlewarescanner.config file:

<Configuration>
    <UseDataOptimization>true</UseDataOptimization>
    <Anonymization>...</Anonymization>
</Configuration>

Configure the scanner to anonymize data

Use the Anonymization element in the snowmiddlewarescanner.config file to enable data anonymization. Wildcard characters can be used in the filename part. Both xpaths and regular expressions can be used to define the optimization rules.

  • Wildcards in the filename are supported. Example: <file filename="*.xml">

  • Absolute xpaths are supported, these are paths defined from the root element. Wildcards in the xpaths are also supported. Example: <xpath>/machine/*/name</xpath>

  • Relative xpaths are supported, all elements that match the name in the XML document will be anonymized. Example: <xpath>//listen-address</xpath>

  • Regular expressions are supported. With this example, all IP addresses found will be anonymized: <regex>^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$</regex>

Schedule the scan in a Linux or Unix environment

In a Linux environment, the scanner is triggered by the Cron configuration script. The script must be included in the installation package for Snow Inventory Agent for Linux.

In a Unix environment, the scanner is triggered through a crontab job which must be created by the user.

  • Run the following crontab to schedule the execution of the scanner:

    # run five minutes after midnight, every day

    5 0 * * * $JAVA_HOME/bin/java -jar /opt/snow/SnowMiddlewareScanner.jar

Command

Description

version

Print current version to stdout

-v

Verbose logging

Schedule the scan in a Windows environment

In a Windows environment, the scanner is triggered by the Snow Inventory Oracle Middleware Scanner Launcher PowerShell script. The script must be included in the installation package for the Snow Inventory Agent for Windows.

  • To schedule the execution of the scanner, run the following command with any option to show what options are available:

    $java -jar snowmiddlewarescanner.jar help

    Unknown arguments on the command line [help]

    Help for SnowMiddleWareScanner

    Usage: java -jar snowmiddlewarescanner.jar [options]

Command

Description

version

Print current version to stdout

-v

Verbose logging

Example 26.

From the command line, run the following script and the output file will be saved in the default location:

$JAVA_HOME/bin/java -jar snowmiddlewarescanner.jar