Octoscan2 Configuration Samples

1st Official Post
    • Official Post

    About octoscan.config File
    On start Octoscan2 reads a configuration file named octoscan.config in the program directory.

    General Syntax
    Configuration parameters can be set by using the follwing syntax:
    ParameterName = value
    Boolean values can be specified as 'true/false' 'yes/no' or '1/0'

    Parameters can be set on conditions:
    if condition
    ParameterName1 = value1
    ParameterName2 = value2
    end

    Comments start with a #

    For a full list of supported parameters and conditions, see the OctoSAM Windows Scan online Documentation.

    Sample Configurations

    Code
    #
# basic configuration file example
# write generated .scan file to central shared folder 
#
OutputFolder=\\myserver\OctoSAM$\Data
#
# enable metering (Default = false)
#
Metering = true

    Depending on your GPO structure, you may want to turn off metering for server systems:

    Code
    #
# meter all systems
#
Metering = true
if server
    #except servers
    Metering = false
end

    You may choose not to report hardware and configuration when Octoscan2.exe is started in a remote session:

    Code
    #
# meter all systems
#
Metering = true
if remotesession
    # do not deliver hardware (wmi) scan if the scanner is called from a remote terminal session
    ScanHardwareInfo = false
end

    Use regular expressions for pattern matching:

    Code
    #
# do not scan users that start with adm- (our administrators)
# pattern matching uses regular expressions
#
if match user adm-.*
    Scan = false
end

    Conditions can be nested:

    Code
    # do not scan if a user called adm-* logs in on a server via terminal services
if server
    if remotesession
        if match user adm-.*
            Scan = false
        end
    end
end

    Test Configuration File Syntax
    To test a configuration file you can start octoscan2 with command-line parameters /show /keep.
    You will get notifications about configuration statements that octoscan did not understand.

    Code
    Octoscan2 /show /keep

    Test Configuration Logic
    Octoscan2 reports the setting of all configuration parameters in the generated .scan file.
    To test your configuration, run Octodump on the generated .scan file. In section octoscan_config you will see all configuration parameters with their values after the configuration file has been processed. Note that the 2 Parameters DoHardwareScan and DoSoftwareScan cannot be set explicitely, they are evalutated by the configuration parser on various conditions for the current scan.