mentat-netmngr.py.conf

#-------------------------------------------------------------------------------
#
# CONFIGURATION FILE FOR MENTAT-NETMNGR.PY MODULE
#
#-------------------------------------------------------------------------------

{
    #---------------------------------------------------------------------------
    # Custom script configurations
    #---------------------------------------------------------------------------

    # Name of the host running the database.
    #   default: *__core_database* settings
    #   type: string
    #
    #"db_host": "localhost",

    # Port number for connecting to database.
    #   default: *__core_database* settings
    #   type: integer
    #
    #"db_port": 27017,

    # Socket timeout in miliseconds for communicating with database.
    #   default: *__core_database* settings
    #   type: integer
    #
    #"db_timeout": 3600000,

    # Additional database connection parameters.
    #   default: *__core_database* settings
    #   type: dict
    #
    #"db_args": null,

    # Name of the database for storing abuse group networks.
    #   default: *__core_database* settings
    #   type:    string
    #
    #"database": "mentat",

    # Name of the collection for storing abuse group networks.
    #   default: *__core_database* settings
    #   type: string
    #
    #"collection": "groups",

    # Path to whois file containing network data.
    #   default: None
    #   type: string
    #
    #"whois_file": null,

    # List of exception files containing networks for particular abuse groups.
    #   default: empty list
    #   type: list of dicts
    #
    #"exception_files": [
    #    {
    #        "path":  "/path/to/file",
    #        "abuse": "abuse_group_id"
    #    }
    #],

    #---------------------------------------------------------------------------
    # Common script configurations
    #---------------------------------------------------------------------------

    # Operational mode: regular script execution (flag).
    #   default: false
    #   type:    boolean
    #
    #"regular": false,

    # Operational mode: manual script execution from shell (flag).
    #   default: false
    #   type:    boolean
    #
    #"shell": false,

    # Name of the script command to be executed.
    #   default: "generate"
    #   type:    string
    #
    #"command": "generate",

    # Execution interval. This value should correspond with related cron script.
    #   default: daily
    #   type:    string
    #
    "interval": "6_hourly",

    # Round-up time interval threshols to interval size (flag).
    #   default: false
    #   type:    boolean
    #
    #"adjust_thresholds": false,

    # Upper time interval threshold.
    #   default: time.time()
    #   type:    float
    #
    #"time_high": null,

    #---------------------------------------------------------------------------
    # Common application configurations
    #---------------------------------------------------------------------------

    # Run in quiet mode (flag).
    #   default: false
    #   type:    boolean
    #
    #"quiet": false,

    # Application output verbosity.
    #   default: 0
    #   type:    int
    #
    #"verbosity": 0,

    # Name of the log file.
    #   default: "/var/mentat/log/mentat-netmngr.py.log"
    #   type:    string
    #
    #"log_file": "/var/mentat/log/mentat-netmngr.py.log",

    # Logging level ['debug', 'info', 'warning', 'error', 'critical'].
    #   default: "info"
    #   type:    string
    #
    #"log_level": "info",

    # Name of the runlog directory.
    #   default: "/var/mentat/run/mentat-netmngr.py"
    #   type:    string
    #
    #"runlog_dir": "/var/mentat/run/mentat-netmngr.py",

    # Dump runlog to stdout when done processing (flag).
    #   default: false
    #   type:    boolean
    #
    #"runlog_dump": false,

    # Write runlog to logging service when done processing (flag)
    #   default: false
    #   type:    boolean
    #
    #"runlog_log": false,

    # Name of the persistent state file.
    #   default: "/var/mentat/run/mentat-netmngr.py.pstate"
    #   type:    string
    #
    #"pstate_file": "/var/mentat/run/mentat-netmngr.py.pstate",

    # Dump persistent state to stdout when done processing (flag).
    #   default: false
    #   type:    boolean
    #
    #"pstate_dump": false,

    # Write persistent state to logging service when done processing (flag).
    #   default: false
    #   type:    boolean
    #
    #"pstate_log": false,

    # Name of the quick action to be performed.
    #   default: null
    #   type: string
    #
    #"action": null,

    # Name/uid of the user.
    #   default: null
    #   type:    string or integer
    #
    "user": "mentat",

    # Name/gid of the group.
    #   default: null
    #   type:    string or integer
    #
    "group": "mentat"
}