Root element of Snow inventory configuration file.
An element with minOccurs="0" that isn't presented in the xml file will have a Null value.
Every system shall have a default settings.xml file that decides what value should be the default if none is given.
The order the client should do this is to first read the default xml file and after that write over these values with the values in the users xml file.
Note that the elements in the configuration file are case sensitive.
<Configuration> <Agent>...</Agent> <Schedule>...</Schedule> <Meter>...</Meter> <Software>...</Software> <Registry>...</Registry> <Logging>...</Logging> <Server>...</Server> <DropLocation>...</DropLocation> <Oracle>...</Oracle> <SystemSettings>...</SystemSettings> <Environment>...</Environment> <SudoCommands>...</SudoCommands> </Configuration>
None.
Element | Description |
---|---|
Required element.
|
|
Optional element. Only applicable to the Windows Agent. |
|
Optional element. Only applicable to the Windows Agent. |
|
Optional element.
|
|
Optional element. Only applicable to the Windows Agent. |
|
Control the log output. |
|
Required element.
|
|
A drop location can be a folder, HTTP endpoint or UNC file path and specifies an additional delivery location for scan results. Only used when the agent normally sends the result to the server. Drop locations are not subject to retry policies, if a drop location does not receive the scan result (for any reason) the scan result will not be resent to that drop location at a later date. |
|
Information used in the SIOS component for Oracle database inventory. |
|
System settings that override the default behavior of the agent. Use with care. |
|
Element containing control directives regarding environment data. |
|
Optional element. Only applicable to the UNIX Agent. |
Required element.
Basic information about the agent deployment. Such a site and configuration name.
<Agent> <SiteName>...</SiteName> <ConfigName>...</ConfigName> </Agent>
None.
Element | Description |
---|---|
SiteName
|
Required element.
|
ConfigName
|
Required element.
|
Optional element. Only applicable to the Windows Agent.
Schedule tasks to run on a recurring interval.
The element must be provided in the configuration for automatic scans to be performed.
<Schedule enabled="..."> <Task>...</Task> </Schedule>
Attribute | Description |
---|---|
enabled |
Acceptable value: true or false |
Element | Description |
---|---|
List of tasks that the client should perform. Can be empty. |
The task that will be run by the agent.
<Task> <Action>...</Action> <Occurance>...</Occurance> <TimeOfDay>...</TimeOfDay> <Randomize>...</Randomize> </Task>
None.
Element | Description | ||||
---|---|---|---|---|---|
Action
|
Required element.
|
||||
Required element.
|
|||||
TimeOfDay
|
Optional element. |
||||
Randomize
|
Optional element. Only applicable to daily, weekly and monthly schedule types. |
How often to stage a certain task.
<Occurance> <AtStart>...</AtStart> <Daily>...</Daily> <Weekly>...</Weekly> <Monthly>...</Monthly> </Occurance>
None.
Element | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Optional element. If used values: true/false |
|||||||||||||||
Daily
|
Optional element. If used values: true/false |
||||||||||||||
Weekly
|
Optional element.
|
||||||||||||||
Monthly
|
Optional element. |
Optional element. If used values: true/false
Will stage task at start of Agent (service init).
<AtStart />
None.
None.
Optional element. Only applicable to the Windows Agent.
Metering rules.
<Meter enabled="..."> <Exclude>...</Exclude> <Span>...</Span> <Occurance>...</Occurance> </Meter>
Attribute | Description |
---|---|
enabled |
Acceptable value: true/false |
Element | Description |
---|---|
Optional element. |
|
Required element.
|
|
Required element.
|
Optional element.
Specifies what software should be excluded from scan.
<Exclude> <Path>...</Path> </Exclude>
None.
Element | Description |
---|---|
Path
|
Optional element
|
<Span> <StartTime>...</StartTime> <EndTime>...</EndTime> </Span>
None.
Element | Description |
---|---|
StartTime
|
Required element.
|
EndTime
|
Required element.
|
<Occurance> <Weekday>...</Weekday> </Occurance>
None.
Element | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Weekday
|
Optional element.
|
Optional element.
Defines what should be included in the clients next scan.
Note software is included from the following locations by default in the Windows operating system:
Desktop, user profile, start menu, uninstall information and running processes.
<Software> <Include>...</Include> <IncludeCriteria>...</IncludeCriteria> <Exclude>...</Exclude> </Software>
None.
Element | Description |
---|---|
Optional element. |
|
Optional element. |
|
Optional element. |
Optional element.
Specifies what software should be included in scan based on file system locations.
<Include> <Path>...</Path> </Include>
None.
Element | Description |
---|---|
Each path is a search expression that is used to locate software based on the file system information. If no path is specified, software information from any locally attached (or mounted) disk will be included.
|
Each path is a search expression that is used to locate software based on the file system information.
For example:
- C:\Windows\*
matches all files located in the C:\Windows
directory
- C:\Windows\*.log
matches all .log
files located in the C:\Windows
directory
<Path recursive="..." unconditionally="..." />
Attribute | Description |
---|---|
recursive |
Optional element. Acceptable value: true or false Default: false |
unconditionally |
Optional element. If used values: true/false Acceptable value: true or false Default: false |
None.
Optional element.
Additional criteria that must be fulfilled for software to be included in the result.
For each type of criteria, at least one (if any) of the criterias must match.
For example, if multiple extensions have been specified it's enough if one extension matches but if extensions and manufacturers have both been specified there has to be at least one matching extension and manufacturer.
<IncludeCriteria enabled="..."> <Manufacturer>...</Manufacturer> <FileSystem>...</FileSystem> <FileType>...</FileType> </IncludeCriteria>
Attribute | Description |
---|---|
enabled |
Acceptable value: true/false |
Element | Description |
---|---|
Manufacturer
|
Only applicable to the Windows Agent.
Optional element. May be specified multiple times.
|
FileSystem
|
Optional element. May be specified multiple times. Only applicable to UNIX agent. |
FileType
|
Optional element. May be specified multiple times. |
Optional element.
Specifies what software should be excluded from scan.
<Exclude> <Path>...</Path> <FileSystem>...</FileSystem> </Exclude>
None.
Element | Description |
---|---|
Path
|
Optional element. May be specified multiple times.
|
FileSystem
|
Optional element. May be specified multiple times. Only applicable to the Linux and OSX Agent. |
Optional element. Only applicable to the Windows Agent.
Include additional information from the Windows Registry in the scan result.
<Registry enabled="..."> <Query>...</Query> </Registry>
Attribute | Description |
---|---|
enabled |
Acceptable value: true/false |
Element | Description |
---|---|
Represents a registry query. |
Represents a registry query (Windows specific). The query will be used to search for a set of values that will be included as custom registry information in the scan result.
<Query> <Key>...</Key> <Value>...</Value> </Query>
None.
Element | Description |
---|---|
Required element.
|
|
Value
|
Required element. May be specified multiple times. |
Required element.
The sub key (and registry hive) to scan.
Example: HKEYLOCALMACHINE\SOFTWARE\Microsoft\Windows NT
<Key recursive="..." />
Attribute | Description |
---|---|
recursive |
Optional element. If used values: true/false
|
None.
Control the log output.
<Logging> <MaxSize>...</MaxSize> <Level>...</Level> <Tag>...</Tag> <Syslog>...</Syslog> </Logging>
None.
Element | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
MaxSize
|
Optional element. |
||||||||||
Level
|
Optional element.
|
||||||||||
Tag
|
Optional element. |
||||||||||
Optional element. Only applicable to the POSIX Agent. |
Optional element. Only applicable to the POSIX Agent.
Control the syslog output.
<Syslog enabled="..."> <Level>...</Level> <Tag>...</Tag> </Syslog>
Attribute | Description |
---|---|
enabled |
Acceptable value: true or false Default: false |
Element | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Level
|
Optional element.
|
||||||||||
Tag
|
Optional element. |
Specify server endpoints. Each endpoint represents a possible path for the agent to the server.
Remarks
When establishing a connection to the server the agent simply choses an endpoint randomly from the list of available endpoints until each endpoint has been atempted at least once before giving up. The first endpoint that results in a successfull connection will be used for the remainder of the session.
<Server> <Endpoint>...</Endpoint> </Server>
None.
Element | Description |
---|---|
Required element. May be specified multiple times. |
<Endpoint> <Address>...</Address> <Proxy>...</Proxy> <ClientCertificate>...</ClientCertificate> <ServerPublicKeyHash>...</ServerPublicKeyHash> </Endpoint>
None.
Element | Description |
---|---|
Address
|
Required element.
|
Optional element. |
|
Optional element. |
|
ServerPublicKeyHash
|
Base64-encoded sha256 hash of the Inventory server certificate public key. The string should start with "sha256//" I.e.: sha256//YhKJKSzoTt2b5FP18fvpHo7fJYqQCjAa3HWY3tvRMwE= |
Optional element.
Proxy settings to use for this endpoint. If proxy settings are not specified any proxy server support is explicitly disabled for this endpoint.
<Proxy> <Server>...</Server> <Credentials>...</Credentials> </Proxy>
None.
Element | Description |
---|---|
Server
|
Required element.
|
Optional element.
|
Optional element.
Credentials used to authenticate connection with HTTP proxy server.
NOTE: Only basic authentication is supported.
<Credentials> <UserName>...</UserName> <Password>...</Password> </Credentials>
None.
Element | Description |
---|---|
UserName
|
|
Password
|
Note that the password is always stored in an encrypted form. |
Optional element.
The client certificate used to secure the connection between agent and server.
<ClientCertificate> <FileName>...</FileName> <Password>...</Password> </ClientCertificate>
None.
Element | Description |
---|---|
FileName
|
The file name of a client certificate to use (relative the current installation location). |
Password
|
The password to use if the client certificate has been password protected. |
A drop location can be a folder, HTTP endpoint or UNC file path and specifies an additional delivery location for scan results. Only used when the agent normally sends the result to the server.
Drop locations are not subject to retry policies, if a drop location does not receive the scan result (for any reason) the scan result will not be resent to that drop location at a later date.
<DropLocation> <Network>...</Network> <Path>...</Path> <Endpoint>...</Endpoint> </DropLocation>
None.
Element | Description |
---|---|
Optional element. May be specified multiple times. Only applicable to the Windows Agent. |
|
Path
|
Optional element. May be specified multiple times. Example: \server\folder |
<Network> <Credentials>...</Credentials> <Location>...</Location> </Network>
None.
Element | Description |
---|---|
Credentials to use when connecting to a network share as a specific user. |
|
Location
|
Credentials to use when connecting to a network share as a specific user.
<Credentials> <Domain>...</Domain> <UserName>...</UserName> <Password>...</Password> </Credentials>
None.
Element | Description |
---|---|
Domain
|
|
UserName
|
|
Password
|
<Endpoint> <Address>...</Address> <Proxy>...</Proxy> <ClientCertificate>...</ClientCertificate> <ServerPublicKeyHash>...</ServerPublicKeyHash> </Endpoint>
None.
Element | Description |
---|---|
Address
|
Required element.
|
Optional element. |
|
Optional element. |
|
ServerPublicKeyHash
|
Base64-encoded sha256 hash of the Inventory server certificate public key. The string should start with "sha256//" I.e.: sha256//YhKJKSzoTt2b5FP18fvpHo7fJYqQCjAa3HWY3tvRMwE= |
Optional element.
Proxy settings to use for this endpoint. If proxy settings are not specified any proxy server support is explicitly disabled for this endpoint.
<Proxy> <Server>...</Server> <Credentials>...</Credentials> </Proxy>
None.
Element | Description |
---|---|
Server
|
Required element.
|
Optional element.
|
Optional element.
Credentials used to authenticate connection with HTTP proxy server.
NOTE: Only basic authentication is supported.
<Credentials> <UserName>...</UserName> <Password>...</Password> </Credentials>
None.
Element | Description |
---|---|
UserName
|
|
Password
|
Note that the password is always stored in an encrypted form. |
Optional element.
The client certificate used to secure the connection between agent and server.
<ClientCertificate> <FileName>...</FileName> <Password>...</Password> </ClientCertificate>
None.
Element | Description |
---|---|
FileName
|
The file name of a client certificate to use (relative the current installation location). |
Password
|
The password to use if the client certificate has been password protected. |
Information used in the SIOS component for Oracle database inventory.
<Oracle enabled="..." debug="..."> <Environment>...</Environment> <DefaultInstanceCredentials>...</DefaultInstanceCredentials> <Oratab>...</Oratab> <InstancesWithConfiguration>...</InstancesWithConfiguration> <Include>...</Include> <Exclude>...</Exclude> </Oracle>
Attribute | Description |
---|---|
enabled |
Acceptable value: true/false |
debug |
Determines if additional information is included in the snowpack for diagnostic purposes. Acceptable value: true/false |
Element | Description |
---|---|
Credentials used in all oracle scans if there is no specific credentials for a SID. May be left out if automatic scan is used or instance specific credentials are entered. |
|
Oratab
|
Specifies the location of the Oratab file to be used to read ORACLE HOME from. This setting is overridden by an OracleHome-element in the Instance-element. |
List of what should be included in the Oracle database scan. |
|
List of what should be excluded from the Oracle database scan. |
<Environment> <Item>...</Item> </Environment>
None.
Element | Description |
---|---|
Specifies a single environment variable to be set. |
Specifies a single environment variable to be set.
<Item variable="..." value="..." />
Attribute | Description |
---|---|
variable | |
value |
None.
<DefaultInstanceCredentials UseTNS="..."> <UserName>...</UserName> <Password>...</Password> </DefaultInstanceCredentials>
Attribute | Description |
---|---|
UseTNS |
Element | Description |
---|---|
UserName
|
|
Password
|
<InstancesWithConfiguration> <Instance>...</Instance> </InstancesWithConfiguration>
Defines the SID and can also contain credentials for the SID. You can also point to an Oracle home path.
<Instance> <SID>...</SID> <Credentials>...</Credentials> <OracleHome>...</OracleHome> <Environment>...</Environment> <UnixUser>...</UnixUser> </Instance>
None.
Element | Description |
---|---|
SID
|
|
Optional element. |
|
OracleHome
|
Optional. Path to the Oracle home directory. Used if the scanner can’t find the path automatically. |
UnixUser
|
<Credentials UseTNS="..."> <UserName>...</UserName> <Password>...</Password> </Credentials>
Attribute | Description |
---|---|
UseTNS |
Element | Description |
---|---|
UserName
|
|
Password
|
<Environment> <Item>...</Item> </Environment>
None.
Element | Description |
---|---|
Specifies a single environment variable to be set. |
Specifies a single environment variable to be set.
<Item variable="..." value="..." />
Attribute | Description |
---|---|
variable | |
value |
None.
List of what should be included in the Oracle database scan.
<Include> <AllInstances>...</AllInstances> <Instance>...</Instance> </Include>
None.
Element | Description |
---|---|
AllInstances
|
True if all instances should be found and scanned. |
Defines the SID and can also contain credentials for the SID. You can also point to an Oracle home path.
<Instance> <SID>...</SID> <Credentials>...</Credentials> <OracleHome>...</OracleHome> <Environment>...</Environment> <UnixUser>...</UnixUser> </Instance>
None.
Element | Description |
---|---|
SID
|
|
Optional element. |
|
OracleHome
|
Optional. Path to the Oracle home directory. Used if the scanner can’t find the path automatically. |
UnixUser
|
<Credentials UseTNS="..."> <UserName>...</UserName> <Password>...</Password> </Credentials>
Attribute | Description |
---|---|
UseTNS |
Element | Description |
---|---|
UserName
|
|
Password
|
<Environment> <Item>...</Item> </Environment>
None.
Element | Description |
---|---|
Specifies a single environment variable to be set. |
Specifies a single environment variable to be set.
<Item variable="..." value="..." />
Attribute | Description |
---|---|
variable | |
value |
None.
List of what should be excluded from the Oracle database scan.
<Exclude> <Instance>...</Instance> </Exclude>
Defines the SID and can also contain credentials for the SID. You can also point to an Oracle home path.
<Instance> <SID>...</SID> <Credentials>...</Credentials> <OracleHome>...</OracleHome> <Environment>...</Environment> <UnixUser>...</UnixUser> </Instance>
None.
Element | Description |
---|---|
SID
|
|
Optional element. |
|
OracleHome
|
Optional. Path to the Oracle home directory. Used if the scanner can’t find the path automatically. |
UnixUser
|
<Credentials UseTNS="..."> <UserName>...</UserName> <Password>...</Password> </Credentials>
Attribute | Description |
---|---|
UseTNS |
Element | Description |
---|---|
UserName
|
|
Password
|
<Environment> <Item>...</Item> </Environment>
None.
Element | Description |
---|---|
Specifies a single environment variable to be set. |
Specifies a single environment variable to be set.
<Item variable="..." value="..." />
Attribute | Description |
---|---|
variable | |
value |
None.
System settings that override the default behavior of the agent. Use with care.
<SystemSettings> <Setting>...</Setting> </SystemSettings>
<Setting key="..." value="..." />
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key |
The name of a system setting to set to some value. Acceptable values depend on the type of setting. See remarks about each setting for more information.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value |
The value associated with the setting. Note that the format of this value will vary depending on the type of setting. See remarks about each setting for more information. |
None.
Element containing control directives regarding environment data.
<Environment> <Ignore>...</Ignore> </Environment>
None.
Element | Description |
---|---|
Ignore
|
Used to specify an environment variable to ignore when gathering them from the environment. Name is case-sensitive. |
Optional element. Only applicable to the UNIX Agent.
List of commands that are allowed to be elevated to root using sudo.
<SudoCommands> <Path>...</Path> </SudoCommands>
None.
Element | Description |
---|---|
Path
|
Path to command allowed to be elevated using sudo. |