agent-configuration-templates-public

Here you can find the latest templates for the Snow Inventory Agent.

Warning

An incorrect configuration will result in the agent not working.

The templates are only templates. They are not “best practice” configurations, and they are not meant to work in any and every scenario.

Important

It is mandatory to have adequate knowledge of the contents of the following documentation before using the configuration file templates:
Snow Docs: Compatibility Matrix - Snow Inventory Agents
Snow Docs: Configuration of Snow Inventory Agents
Snow Docs: Configuration Reference
Snow Docs: Snow Inventory Agent for Windows
Snow Docs: Snow Inventory Agent for Linux
Snow Docs: Snow inventory Agent for macOs
Snow Docs: Snow Inventory Agent for Unix
Snow Docs: Snow Inventory Oracle Scanner
Snow Docs: System Requirements - Snow Inventory Agents and Oracle Scanners
Snow Docs: About Package Builder
Snow Globe: Inventory Agent Exclusions

Template files

How to use these templates

Make sure you have an adequate understanding of the agent configuration and information about the environment the agent will be used in. See the list of mandatory documentation above. If unsure, use the Snow Inventory Admin Console to generate the agent configuration and then export it, or reach out to Snow Support via Snow Support Hub. Note that the Snow Inventory Admin Console comes with Snow Inventory and is only available for on-premises customers.
Enter all relevant information into the configuration file. Note that if you need to generate a configuration with passwords, you must use the Snow Inventory Admin Console or reach out to Snow Support.
Add comments, where appropriate, to disable a section of the configuration file. Settings not defined in the configuration file will result in a default being applied. Defaults are described in Snow Docs: Configuration of Snow Inventory Agents or the Default behavior section of this page.
Remove any unused or empty sections from the configuration file.
Validate the configuration file against the schema file provided in the [./schemas/] folder in this repository. Read more about using it in the Schema validation chapter.

When the configuration file is ready, you can use it to create agent installation packages, either via Package Builder on Snow Atlas or via Snow Support Hub.

Note

XML does not allow nested comments.
XML is case-sensitive. For example, <Oracle> is NOT the same as <oracle>.
The configuration for Snow Inventory Oracle Middleware Scanner, Snow Inventory Oracle Hardware Scanner and Snow Inventory Java Scanner is not part of the Snow Inventory Agent configuration file.
Test the configuration before deploying it in the infrastructure. Every environment is different.

Schema validation

This repository contains XSD files in the ./schemas folder. XSD files are used to validate XML files, like the Agent configuration. Different tools offer different functionality for this task.

Visual Studio Code: This repository already contains files to configure VSCode, which are located in the [.vscode] folder. The recommended Extension is RedHat XML Extension.
Notepad++: You can use the XMLTools Plugin, you can install with the plugin management.
XMLNotepad: You can use the Microsoft XML Nptepad, which comes with schema validation.
xmllint: On linux you can use the xmllint command with the --schemafile option.

Default behavior

Every Snow Inventory Agent has a default behavior depending on the platform. If you use an item from the list below in the configuration file, that default behavior would be removed. For <SystemSettings> the granularity is set to the specific <Setting>, for everything else it is the Node level above. For example adding one <Software><IncludeCriteria><FileType> will remove the default FileTypes.

Windows

Software > IncludeCriteria > FileType

<Software>
    <IncludeCriteria>
      <FileType>exe</FileType>
      <FileType>wfd</FileType>
      <FileType>wfi</FileType>
      <FileType>wtd</FileType>
      <FileType>wti</FileType>
      <FileType>sys2</FileType>
      <FileType>lnk</FileType>
    </IncludeCriteria>
  </Software>

Registry

Please use the "Collect custom registry keys" Scanning Module referenced in Snow Docs: Package Builder - Scanning Modules instead of adding additional registry queries. Otherwise you will lose

Exchange Server details
Windows Clustering details
Virtual Machine details

and you would need to keep them updated manually.

SystemSettings

<SystemSettings>
    <Setting key="disable_all_updates" value="false" />
    <Setting key="env.is_virtual_desktop_infrastructure" value="false" />
    <Setting key="env.powershell_timeout" value="300000" />
    <Setting key="hardware.scan.device" value="true" />
    <Setting key="hardware.scan.displayadapter" value="true" />
    <Setting key="hardware.scan.enabled" value="true" />
    <Setting key="hardware.scan.expansionslot" value="true" />
    <Setting key="hardware.scan.keyboard" value="true" />
    <Setting key="hardware.scan.logicaldisk" value="true" />
    <Setting key="hardware.scan.memory" value="true" />
    <Setting key="hardware.scan.modem" value="true" />
    <Setting key="hardware.scan.monitor" value="true" />
    <Setting key="hardware.scan.mouse" value="true" />
    <Setting key="hardware.scan.multimedia" value="true" />
    <Setting key="hardware.scan.networkadapter" value="true" />
    <Setting key="hardware.scan.pci" value="true" />
    <Setting key="hardware.scan.physicaldisk" value="true" />
    <Setting key="hardware.scan.port" value="true" />
    <Setting key="hardware.scan.printer" value="true" />
    <Setting key="hardware.scan.processor" value="true" />
    <Setting key="hardware.scan.scsi" value="true" />
    <Setting key="hardware.scan.tapedrive" value="true" />
    <Setting key="hardware.scan.usb" value="true" />
    <Setting key="http.poll_interval" value="5400" />
    <Setting key="http.poll_variance" value="1800" />
    <Setting key="http.ssl_verify" value="true" />
    <Setting key="http.timeout" value="15" />
    <Setting key="legacy_webmetering.is_enabled" value="false" />
    <Setting key="log.append" value="false" />
    <Setting key="metering.is_enabled" value="true" />
    <Setting key="powershell.enabled" value="true" />
    <Setting key="powershell.encryption_key" value="" />
    <Setting key="privacy.hide_user" value="false" />
    <Setting key="privacy.hide_ip" value="false" />
    <Setting key="saas.edge.enabled" value="true" />
    <Setting key="saas.chrome.enabled" value="true" />
    <Setting key="saas.firefox.enabled" value="true" />
    <Setting key="send.max_scan_result_backlog_count" value="90" />
    <Setting key="software.scan.add_latency" value="0" />
    <Setting key="software.scan.custominfo" value="true" />
    <Setting key="software.scan.enabled" value="true" />
    <Setting key="software.scan.environmentvariables" value="true" />
    <Setting key="software.scan.fileshare" value="true" />
    <Setting key="software.scan.fonts" value="true" />
    <Setting key="software.scan.jar" value="true" />
    <Setting key="software.scan.loginuser" value="true" />
    <Setting key="software.scan.netclient" value="true" />
    <Setting key="software.scan.netprotocol" value="true" />
    <Setting key="software.scan.ntservice" value="true" />
    <Setting key="software.scan.odbc" value="true" />
    <Setting key="software.scan.swidtags" value="true" />
    <Setting key="software.scan.userscan" value="true" />
    <Setting key="software.scan.virtualsoftwareinfo" value="true" />
    <Setting key="wmi.poll_interval" value="15" />
</SystemSettings>

Linux

Software > Exclude > FileSystem

To get the latest list of excluded file systems, check Snow Docs: Snow Inventory Agent for Linux - File system types not scanned by the Agent.

<Software>
    <Exclude>
        <FileSystem>binfmt_misc</FileSystem>
        <FileSystem>cifs</FileSystem>
        <FileSystem>devpts</FileSystem>
        <FileSystem>devtmpfs</FileSystem>
        <FileSystem>fuse</FileSystem>
        <FileSystem>fuse.gvfsd-fuse</FileSystem>
        <FileSystem>fuse.vmware-vmblock</FileSystem>
        <FileSystem>fuseblk</FileSystem>
        <FileSystem>nfs</FileSystem>
        <FileSystem>nfs4</FileSystem>
        <FileSystem>none</FileSystem>
        <FileSystem>panfs</FileSystem>
        <FileSystem>proc</FileSystem>
        <FileSystem>rpc-pipes</FileSystem>
        <FileSystem>smbfs</FileSystem>
        <FileSystem>sysfs</FileSystem>
        <FileSystem>tmpfs</FileSystem>
        <FileSystem>vmblock</FileSystem>
        <FileSystem>vmhgfs</FileSystem>
    </Exclude>
</Software>

SystemSettings

<SystemSettings>
    <Setting key="disable_all_updates" value="false" />
    <Setting key="env.allowonlyonescanperday" value="false"/>
    <Setting key="env.data_dir" value="data/"/>
    <Setting key="env.log_dir" value="data/"/>
    <Setting key="env.temp_dir" value="/tmp/snow/"/>
    <Setting key="http.ssl_verify" value="true" />
    <Setting key="http.timeout" value="15" />
    <Setting key="log.append" value="false" />
    <Setting key="send.max_scan_result_backlog_count" value="90"/>
    <Setting key="software.scan.add_latency" value="0" />
    <Setting key="software.scan.dpkg" value="false" />
    <Setting key="software.scan.ignore_autofs_mounts" value="false" />
    <Setting key="software.scan.ignore_bind_mounts" value="false" />
    <Setting key="software.scan.jar" value="true" />
    <Setting key="software.scan.rpm" value="false" />
    <Setting key="software.scan.running_processes" value="true" />

</SystemSettings>

MacOs

Software > Exclude > FileSystem

To get the latest list of excluded file systems, check Snow Docs: Snow Inventory Agent for MacOs - File system types not scanned by the Agent.

<Software>
    <Exclude>
        <FileSystem>cifs</FileSystem>
        <FileSystem>nfs4</FileSystem>
        <FileSystem>devfs</FileSystem>
        <FileSystem>none</FileSystem>
        <FileSystem>fuseblk</FileSystem>
        <FileSystem>smbfs</FileSystem>
        <FileSystem>mtmfs</FileSystem>
        <FileSystem>vmhgfs</FileSystem>
        <FileSystem>nfs</FileSystem>
        <FileSystem>devfs</FileSystem>
    </Exclude>
</Software>

SystemSettings

<SystemSettings>
    <Setting key="disable_all_updates" value="false" />
    <Setting key="env.allowonlyonescanperday" value="false"/>
    <Setting key="env.data_dir" value="data/"/>
    <Setting key="env.log_dir" value="data/"/>
    <Setting key="env.temp_dir" value="/tmp/snow/"/>
    <Setting key="http.ssl_verify" value="false" />
    <Setting key="http.timeout" value="15" />
    <Setting key="log.append" value="false" />
    <Setting key="privacy.hide_ip" value="false" />
    <Setting key="privacy.hide_user" value="false" />
    <Setting key="saas.edge.enabled" value="true" />
    <Setting key="saas.chrome.enabled" value="true" />
    <Setting key="saas.chrome.enterprise.installation" value="true" />
    <Setting key="saas.firefox.enabled" value="true" />
    <Setting key="send.max_scan_result_backlog_count" value="90"/>
    <Setting key="software.scan.add_latency" value="0" />
    <Setting key="software.scan.jar" value="true" />
</SystemSettings>

Unix

Software > IncludeCriteria > FileType

<Software>
    <IncludeCriteria>
        <FileType>ELF*executable*</FileType>
        <FileType>64-bit XCOFF executable*</FileType>
        <FileType>executable (RISC System/6000)*</FileType>
        <FileType>PA-RISC*executable*</FileType>
        <FileType>java*</FileType>
    </IncludeCriteria>
</Software>

Software > Exclude > Path

<Software>
    <Exclude>
        <Path>/tmp*</Path>
        <Path>/var/tmp*</Path>
        <Path>*.au</Path>
        <Path>*.bmp</Path>
        <Path>*.bmu</Path>
        <Path>*.cfg</Path>
        <Path>*.class</Path>
        <Path>*.conf</Path>
        <Path>*.csm</Path>
        <Path>*.css</Path>
        <Path>*.dic</Path>
        <Path>*.enc</Path>
        <Path>*.gif</Path>
        <Path>*.h</Path>
        <Path>*.htm</Path>
        <Path>*.html</Path>
        <Path>*.jpg</Path>
        <Path>*.js</Path>
        <Path>*.log</Path>
        <Path>*.mo</Path>
        <Path>*.mof</Path>
        <Path>*.packlist</Path>
        <Path>*.pcf</Path>
        <Path>*.pc</Path>
        <Path>*.pf</Path>
        <Path>*.pl</Path>
        <Path>*.png</Path>
        <Path>*.po</Path>
        <Path>*.properties</Path>
        <Path>*.rdf</Path>
        <Path>*.sdl</Path>
        <Path>*.so</Path>
        <Path>*.sql</Path>
        <Path>*.ttf</Path>
        <Path>*.txe</Path>
        <Path>*.txt</Path>
        <Path>*.utf8</Path>
        <Path>*.xml</Path>
        <Path>*.xpt</Path>
        <Path>*.zip</Path>
        <Path>*/oracle/*/audit*</Path>
    </Exclude>
</Software>

SystemSettings

<SystemSettings>
    <Setting key="disable_all_updates" value="false" />
    <Setting key="env.allowonlyonescanperday" value="false"/>
    <Setting key="env.data_dir" value="data/"/>
    <Setting key="env.log_dir" value="data/"/>
    <Setting key="env.temp_dir" value="/tmp/snow/"/>
    <Setting key="http.ssl_verify" value="true" />
    <Setting key="http.timeout" value="15" />
    <Setting key="log.append" value="false" />
    <Setting key="privacy.hide_ip" value="false" />
    <Setting key="privacy.hide_user" value="false" />
    <Setting key="send.max_scan_result_backlog_count" value="90"/>
    <Setting key="software.scan.add_latency" value="0" />
    <Setting key="software.scan.ips" value="true" />
    <Setting key="software.scan.lpp" value="true" />
    <Setting key="software.scan.running_processes" value="true" />
    <Setting key="software.scan.sd" value="true" />
    <Setting key="software.scan.svr4" value="true" />
</SystemSettings>

Who is Flexera?

Flexera is the global leader in technology intelligence solutions, ensuring that organizations drive the maximum value from their technology investments. Over 4,000 organizations rely on Flexera to provide complete visibility, optimize usage and spend, and minimize regulatory risk. Find us on www.flexera.com

Contribution

If you want to contribute or suggest a change, create an idea on our ideas portal.

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
.github		.github
.vscode		.vscode
linux		linux
macos		macos
schemas/v1.0.0		schemas/v1.0.0
unix		unix
windows		windows
.gitattributes		.gitattributes
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE.md		LICENSE.md
README.md		README.md
catalog-info.yaml		catalog-info.yaml
changelog.md		changelog.md
code-of-conduct.md		code-of-conduct.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

agent-configuration-templates-public

Template files

How to use these templates

Schema validation

Default behavior

Windows

Linux

MacOs

Unix

Who is Flexera?

Contribution

About

Releases

Packages

Contributors 2

License

SnowSoftware/agent-configuration-templates-public

Folders and files

Latest commit

History

Repository files navigation

agent-configuration-templates-public

Template files

How to use these templates

Schema validation

Default behavior

Windows

Linux

MacOs

Unix

Who is Flexera?

Contribution

About

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Packages