Skip to main content
Version: 3.2

Configuring Inventory Processor

Settings Description

Inventory Processor is the executable module file responsible for populating the asset database. The standard executable file name is: moduleInventory-<version>.

Configuration File

To run Inventory Processor, a configuration file named config.yml must be present in the module folder. It contains the following parameters:

ParameterDescriptionRequired
opensearchList of OpenSearch cluster servers.Yes
usernameUsername for connection.Yes
passwordPassword for connection.Yes
certCA certificate for authentication verification.Yes
join_events_with_null_valueSkip empty keys during the aggregation stage.No
include_assetsList of asset configurations requiring processing. If not specified, all configurations will be processed.No

Example config.yml content:

opensearch: ['https://172.16.0.60:9200']
username: 'admin'
password: 'pass'
cert: 'root-ca.pem'
join_events_with_null_value: false
include_assets:
- asset_name: 'Hosts'
search_fields: ['hostname']

Launch Parameters

The Inventory Processor executable supports the following launch parameters:

  • -v - display version
  • -log - duplicate log output to console (optional)
  • -with-index - fast search for partial similarity candidates (optional)
  • -bulk-changes - send asset changes via bulk request (optional)
Example of version output
./moduleInventory-3.2.0 -v
Launch example
./moduleInventory-3.2.0 -log -with-index -bulk-changes
Launch example in the cron task
./moduleInventory-3.2.0 -with-index -bulk-changes
Example running without partial similarity search optimizations
./moduleInventory-3.2.0