Get Started > Content Pack Configuration Files > globalSettings.xml File

globalSettings.xml File

The following table describes the parameters in the globalSettings.xml configuration file (Data Flow Management > Adapter Management > Resources > Packages > AutoDiscoveryContent > Configuration Files):

Parameter

Description

AdditionalClasspath

Additional path that enables to run different patterns (that is, database patterns); all paths should be relative to the $PROBE_INSTALL/root/lib/collectors/probeManager/discoveryResources/ folder and should be semicolon separated

Example:

<property name="AdditionalClasspath">db/oracle/.;db/mssqlserver/.</property>
means that following paths will be included in the classpath:

  • $PROBE_INSTALL/root/lib/collectors/probeManager/discoveryResources/db/oracle/

  • $PROBE_INSTALL/root/lib/collectors/probeManager/discoveryResources/db/mssqlserver/

allowCaliperOnHPUX

Indicates whether to allow the execution of caliper on HP-UX. This setting will be used in the WebSphere_By_Shell adapter, to get the full command line when the ps command fails to do so.

Default: false

allowCallhome

Indicates whether to allow to call home.

Default: true

allowCallhomeInterval

The time interval in hours that is allowed between two call home requests from the same host.

Default: 24

allowDataCenterCallhome

Indicates whether to allow Data Center IP addresses to call home.

Default: true

allowGettingCredential
SecuredAttribute

Indicates whether Jython scripts are allowed to get credentials secured data (true) or not (false). If this setting is set to false, then Jython scripts are not allowed to retrieve sensitive credentials data (like passwords that are stored on the server side).

Default: true

allowPFilesOnSunOS

Indicates whether to allow the execution of pfiles on Solaris.

Default: false

Caution: Setting this parameter to true may cause problems for some processes on some Solaris systems.
allowPFilesOnHPUX

Indicates whether to allow the execution of pfiles on HP-UX.

Default: false

Caution: Setting this parameter to true may cause problems for some processes on some HP-UX systems.

autoTruncateDbEncoding

Indicates the encoding used by the CMDB underlying database. This property is used for calculating the number of characters that should be sent after truncation.

Default: UTF8

autoTruncatePercentage

If the value of the attribute (with the DDM_AUTOTRUNCATE qualifier) exceeds the size limit multiplied by this parameter it will be truncated to the specified part of the defined size.

Default: 100 percent

clearCommandLineFor
Processes

Clears the Command line for these processes.

This option is used to ensure that no private or confidential data is stored in CMDB.

Default: srvrmgr.exe, srvrmgr, xCmd.exe, HPcmd.exe, ssonsvr.exe

Syntax exceptions: Process names are case insensitive and should be split by commas.

consoleCommands

The comma-separated list of commands globally available for all PowerShell connections.

The commands specified in this list will be executed using CMD interpreter (cmd /c "command")

datacenter callhome

If the management zone is set to Data Center and this parameter is enabled, Data Flow Probe ignores call home messages from Universal Discovery Agent.

Default: Enabled

dbQueryTimeout

The timeout (in seconds) for all SQL queries. Indicates how long to wait for query results.

The timeout applies only if the value is greater than zero (0).

Default: 100 seconds

Note Some JDBC drivers cannot support this setting.

ddmagentCiphers The algorithm used by the UD Agent to encrypt or decrypt the data transferred to or from client machines.
ddmagentPrefix The prefix used by the UD Agent.
ddmagentProtocol The protocol used by the Probe to communicate with UD Agent.
ddmagentEnableDownloadResume

Specifies whether the resumable download is enabled or not.

true. The resumable download functionality is available.

false. The resumable download functionality is not available.

ddmagentDefaultBlockLen The default chunk size (in bytes) used to upload/download files to/from the UD Agent.
ddmagentResumableFileSuffix The file extension used for parts of the resumable transfer file.
ddmagentDefaultResumeBlockLen The default chunk size (in bytes) for resumable file transfer.
ddmagentEnableUploadResume

Specifies whether the resumable upload is enabled or not.

true. The resumable upload functionality is available.

false. The resumable upload functionality is not available.

defaultSapClients

When this parameter is defined, you do not need to specify the SAP Client Number parameter in the SAP ABAP protocol. Instead, you can create one or more comma-separated credentials for multiple SAP systems with different supported clients.

Example:
<property name=
"defaultSapClients">
800,500,200,300
</property>

Default: 800

desktopOperatingSystems

serverOperatingSystems

These two parameters are used to determine if the host's operating system is of type Desktop or Server. If the host's operating system name contains a value from one of these lists, its host_isdesktop is set accordingly. Otherwise the value of host_isdesktop attribute is left empty.

discovereAllListenPorts

Related to application signatures configuration.

discoveredStorageTypes

Describes storage types which have to be reported to UCMDB. Options are split by commas.

Available options are:

  • FixedDisk

  • NetworkDisk

  • CompactDisk

  • RemovableDisk

  • FloppyDisk

  • VirtualMemory

  • FlashMemory

  • RamDisk

  • Ram

  • No Root Directory

  • Other

  • UNKNOWN

enableJeeEnhancedTopology

Indicates whether to enable the reporting of the improved JEE topology.

Default: false

enableNormalizationRuleLabel

Specifies whether the label format for output values in the normalization rule is enabled or not.

If you want to display values in the label format instead of the default format that contains underscores for the normalized fields, do the following:

  1. Add <property name="enableNormalizationRuleLabel">true</property> in the globalSettings.xml file if it does not exist.
  2. Restart the probe.

Default: false

enableSSHSharedHomeDir

Setting this parameter to true enables Inventory Discovery via SSH to be able to use a user account that has the shared home directory. For example, the home directory is mounted via NFS or Samba, so that the same directory is used when the user logs into different computers.

In order for this feature to work correctly, Universal Discovery Agent cannot be installed to run under a user account that has the home directory that is shared (for example, mounted via NFS or Samba). If it is already installed, uninstall it. For more information, see the How to Completely Uninstall the Universal Discovery Agent section in the Data Flow Management section of the UCMDB Help.

To enable this feature, set this parameter value to true. The default value is false.

Caution: Enabling and then disabling this feature may cause unpredictable behavior.

Note  

  • Do not install Universal Discovery Agent to run under a user account that has the shared home directory (for example, mounted via NFS or Samba) after you enable this feature.

  • In UCMDB, you may unexpectedly see newly-created empty Node CIs. You can delete them, or wait for the aging mechanism to delete them (usually after 40 days).

  • The software utilization information cannot be reported by the Inventory Discovery by Scanner job when using the SSH protocol.

fs_discovery_method

The file system discovery method. Valid values are perl and lsawk.

  • perl (default). Run Perl scripts to discover file systems. If Perl is not installed on the target host, the lsawk discovery method is used as a fallback mechanism.
  • lsawk. Run ls + awk commands to discover file system.
IgnoreClassAttributes

Ignores the attributes in the discovery result processing.

Format: node.name, node.description

Data Flow Probe will not validate the node attribute name and description. The probe will not report these attributes to UCMDB.

Default: node.misc_info

ignoreLocalizedVirtualInterfaces
PatternList

Lists patterns for localized Windows Virtual interface description that must not take part in the Host Key creation process.

Format: Comma-separated list of strings, no additional white-spaces allowed.

ignoreVmwareInterfaces

Indicates whether to ignore the VMware MAC address.

  • When there is a Physical MAC (default). The VMware MAC address is used only if the pattern cannot find any physical MAC address.

  • Always. Always ignore VMware MAC address.

jdbcDrivers

This section enumerates driver classes used to connect to a dedicated Database server. Names of sub-keys must be the same as used in credentials (sqlprotocol_dbtype attribute of protocol).

Change them if drivers other than OOTB JDBC drivers are used.

Default values for OOTB-installation:

<property name="jdbcDrivers:>
<oracle>
oracle.jdbc.OracleDriver
</oracle>
<oracleSSL>
oracle.jdbc.OracleDriver
</oracleSSL>
<MicrosoftSQLServer>
net.sourceforge.
jtds.jdbc.Driver
</MicrosoftSQLServer>
<MicrosoftSQLServer> net.sourceforge.jtds.
jdbc.Driver
</MicrosoftSQLServerNTLM>
<MicrosoftSQLServerNTLMv2>
net.sourceforge.jtds.jdbc.Driver
</MicrosoftSQLServerNTLMv2>
<Sybase>
com.sybase.jdbc.SybDriver
</Sybase>
<db2>
com.ibm.db2.jcc.DB2Driver
</db2>
<mysql>
com.mysql.jdbc.Driver
</mysql>
</property>

jdbcPreUrls

This section enumerates URL templates used to connect to dedicated the database server. Names of sub-keys must be the same as those used in credentials (sqlprotocol_dbtype attribute of protocol). Change them if drivers other than OOTB JDBC drivers are used. Values depend on used drivers and should be taken from driver documentation.

Note The ampersand symbol (&) must be escaped according to the XML standard (&amp;).

Default values for OOTB-installation:
<property name="jdbcPreUrls">
<oracle>jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=
(PROTOCOL=tcp)
(HOST=%%ipaddress%%)(PORT=%%protocol_port%%))
(CONNECT_DATA=(%%connect_data%%=%%sqlprotocol_dbsid%%)))
</oracle>
<oracleSSL>jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=
(PROTOCOL=tcps)
(HOST=%%ipaddress%%)(PORT=%%protocol_port%%))
(CONNECT_DATA=(%%connect_data%%=%%sqlprotocol_dbsid%%)))
</oracleSSL>
<MicrosoftSQLServer>
jdbc:jtds:sqlserver://
%%ipaddress%%:%%protocol_port%%;
instanceName=%%sqlprotocol_dbname%%;
loginTimeout=%%protocol_timeout%%;
logging=false;ssl=request
</MicrosoftSQLServer>
<MicrosoftSQLServerNTLM>
jdbc:jtds:
sqlserver://%%ipaddress%%:
%%protocol_port%%;instanceName=
%%sqlprotocol_dbname%%;domain=
%%sqlprotocol_windomain%%;
loginTimeout=
%%protocol_timeout%%;logging=false
</MicrosoftSQLServerNTLM>

jdbcPreUrls

continued

<MicrosoftSQLServerNTLMv2>jdbc:jtds:sqlserver://%%
ipaddress%%:%%protocol_port%%;instanceName=%%
sqlprotocol_dbname%%;domain=%%
sqlprotocol_windomain%%;loginTimeout=%%
protocol_timeout%%;logging=false;ssl=request;useNTLMv2=true
</MicrosoftSQLServerNTLMv2>
<Sybase>
jdbc:sybase:Tds:
%%ipaddress%%
:%%protocol_port%%?DatabaseName=
%%sqlprotocol_dbname%%
</Sybase>
<db2>
jdbc:db2://%%ipaddress%%:
%%protocol_port%%/
%%sqlprotocol_dbname%%
</db2>
<mysql>
jdbc:mysql://%%ipaddress%%:
%%protocol_port%%/
%%sqlprotocol_dbname
%%</mysql>

<parameters>
<parameter type="oracle" name="connect_data">
<value>SERVICE_NAME</value>
<value>SID</value>
</parameter>
<fallbackExceptionList>
<error type="oracle">.*ORA\-12514.*</error>
<error type="oracle">.*ORA\-27101.*</error>
</fallbackExceptionList>
</parameters>
</property>

Each <parameter> element has a name attribute and one or more <value> tags. Each <parameter> can be used in the Oracle URL template by using the format “%%[parameter name]%%” (for example, %%connect_data%%).

If a <parameter> has more than one <value> tag, then the parsing engine generates all permutations of the possible values in the template string, and the client tries to connect to the database server by each of these permutations.

Since during connection errors can occur, the <fallbackExceptionList> element specifies which errors should be ignored if they occur. If the engine ignores such an error, then it tries to connect using another permutation of values in the template string. If an error occurs that is not specified by <fallbackExceptionList>, the engine does not try another permutation and the job fails with the error message that was caught.

loadExternalDTD

Used to configure file_mon_utils to prevent downloading DTD files while validating the XML.

Default: false

maxExecutionRecords

Specifies maximal number of execution records that can be in the communication log. This parameter should be used when the discovery process discovers a lot of data. The parameter can be overridden on an adapter level. In this case, add the parameter to the adapter with desired record limit (see Probe documentation).

Default: -1 means unlimited

maximumConnectionsPerSecond

Enables limiting the number of new connections per second created by the Probe to other machines.

  • 0. Unlimited number of connections allowed.

  • > 0. The maximum number of connections. If this limit is reached, any job trying to create a new connection will wait for a period of time that is determined in the timeToSleepWhenMaximumConnectionsLimitReached parameter below.

Default: 0 (unlimited)

maxStoreSentResults

Specifies maximal number of sent results that can be stored in the communication log.

This parameter can be changed if there are too many results stored in the communication log.

If this value is greater than 0, the log will store the corresponding number of results for deleted results AND updated results, meaning that the results set will contain double the value of maxStoreSentResults.

Default: -1 means unlimited

maxPingIPv6CountPerRange

Specifies the maximum IPv6 count of per range for Ping Sweep.

Default: 1000000

multipleDB2Instances

Indicates whether multiple DB2 instances are installed on the same server.

Default: true

multipleUpdateIgnoreTypes

Used by UCMDB. The Probe does not generate a Multiple updates in bulk warning for enumerated CI types.

notRecordedMethods

Specifies a list of methods that are not to be recorded in the communication log.

To remove a method from being recorded in the communication log, copy its name from the communication log and add it here.

Example:

<property name="notRecordedMethods">
<method>getLastCommandOutputBytes</method>
</property>

NtcmdAgentRetention

NTCMD agent retention mode. Specifies how to handle a remote NTCMD service and its executable file when closing the connection.

  • 0 (default). Unregister the service and delete the remote executable file.

  • 1. Unregister the service but keep the executable file on the file system.

  • 2. Leave the service running, keep the executable file.

NtcmdSessionUseProcessBuilder

This parameter is for NtcmdSessionAgent and should be always be true. This parameter tells how to create a new process.

  • true. The new process will be created by ProcessBuilder (new API from Java 5.0)

  • false. The new process will be created by Runtime.exec (old API, from Java 1.4.2). Set to false only in case of backward compatibility problems.

objectSendAmountThreshold

When the number of discovered objects exceeds this threshold, the objects are immediately sent to the server. Requires using the sendObject(s) API in jython scripts.

Default: 2000 objects

objectSendTimeThreshold

When more than the specified time (in seconds) has passed since the previous object report, the objects are immediately sent to the server. Requires using the 0sendObject(s) API in jython scripts.

Default: 300 seconds

pingClientTypeIp

(Only for the Inventory Discovery by Scanner job) Indicates whether to allow to ping Client IP addresses.

Default: false

pingHostName

(Only for the Inventory Discovery by Scanner job) Indicates whether to allow to ping host names.

Default: false

portExpirationTime

The expiration time (in seconds) of the TCP/UDP port entry in the Probe's database.

Default: 60 seconds

powershellConnectionIdleTimeout

Defines the maximum idle time (in milliseconds) for the powershellconnector.exe process.

The timer resets its state after each command execution.

Default: 3600000 milliseconds (1h)

processExpirationTime

The expiration time (in seconds) of the Process entry in the Probe database.

Default: 60 seconds

protocolConnectionOrder

The protocol connection order for the Host Connection by Shell job.

Default: ssh, telnet, ntadmin, powercmd

remoteProcessTimeout

After being launched, the remote process should connect with the Probe within the defined time (in milliseconds), otherwise the following error is produced: Failed to connect to remote process.

Default: 300000 milliseconds (5 minutes)

removeCopiedFiles

In some cases DFM copies scripts and third-party utilities on a client machine. The removeCopiedFiles parameter defines whether these files should (true) or should not (false) be deleted after discovery is finished.

reportSapAppServerDatabase

Indicates whether to report SAP Application Server databases that are based on the configuration file content.

Only affects the Host Applications by Shell, and SAP ABAP Topology by SAP JCO jobs.

Default: false

reportPhysicalSerialNumbers

Indicates whether to report physical serial numbers from hwsmbiosPhysicalAttributeSerialNumber of scan files.

Default: false

ResultProcessIsLenient

When setting to true, the discovery result processing is lenient, which is not recommended:

  • If a reported string attribute has a too large value, the string is automatically truncated according to the CMDB Class Model definition.

  • If the OSH attribute is invalid (type/nonexisting attribute/missing ID attribute), only the invalid OSH is dropped, rather than entire bulk (default).

Default: false

setBiosUuidToMicrosoftStandart

Indicates whether the BIOS UUID value for Windows operating systems should be reported in Microsoft style (some bytes order reversed) instead of the original BIOS value. Affects Host Connection jobs.

  • false (default). Converts to original BIOS stored value

  • true. Converts to Microsoft standard.

Note Setting this parameter to true may result in conflicts with the BIOS UUID value discovered by VMware jobs or some integrations.

shellGlobalBandwidthLimit

The maximum bandwidth (in kilobits per second) to upload and download files to and from the discovery node

Note If no value or 0 is assigned, all of the available bandwidth is used.

shellGlobalCommandTimeout

Global timeout (in milliseconds) for all Shell client commands. Indicates how long to wait for a command's result.

Default: 15000 milliseconds

siebelCommandTimeout

The amount of time to wait for the Siebel command's result.

Default: 3 minutes (180000 ms)

snmpGlobalRequestTimeout

This is the time, in milliseconds, after which a request using SNMP will timeout.

Default: 3,000 milliseconds

Note This value is global for all SNMP requests. If you want to override the SNMP request timeout for a specific query (where you know the query takes more time than the default timeout), provide the timeout value as a second parameter to the executeQuery method on the SNMP client: snmpClient.executeQuery(SNMP_QUERY_STRING, QUERY_TIMEOUT_IN_MILLISECONDS).

snmpTestQueries

Defines the default SNMP test query for SNMP Agent. Can be overridden for specific devices.

Default:

<property name="snmpTestQueries">

<query>
1.3.6.1.2.1.1.1,1.3.6.1.2.1.1.2,
string</query>

</property>

ssh-log-level

The SSH log level.

Levels: 1-7, where 7 is the most detailed defect level.

tcpExpirationTime

The expiration time (in hours) of TCP connection entry in probe database.

Default: 24 hours

timeToSleepWhenMaximum
ConnectionsLimitReached

Determines how long (in milliseconds) a job needs to wait until a new connection can be created, assuming the maximum connections limit has been reached. (See maximumConnectionsPerSecond above.)

Default: 1000 milliseconds (1 second)

Note If maximumConnectionsPerSecond = 0 this property is ignored.

tnsnamesFilePaths

Paths to search the tnsnames.ora file (including tnsnames.ora itself, comma separated)

Example:

<property name=
"tnsnamesFilePaths">
c:\temp\tnsnames.ora
</property>

unsetHistFile

Whether to prevent the SSH protocol from recording the executed command to the environment variable $HISTFILE on UNIX server.

If the value is true, the executed command is not recorded in the environment variable $HISTFILE on UNIX server.

Default: false

useIntermediateFileForWmic

Usage of an intermediate temporary file for data transfer by wmic command.

Default: false

useJinteropOnWindows

This property is used on Windows machines.

  • true. The Probe uses JInterop for WMI discovery.

  • false (default). The Probe uses WMIdll native code.

useMultiThreadForEventHub

Indicates whether to use multiple threads in Event Hub.

Default: true

useNtcmdModifiedMarkers

  • true. The Probe uses markers with counters in NTCMD agents' infrastructure.

  • false (default). The Probe uses old NTCMD behavior - without markers with counters.

useWinexeOnLinux

This setting is used on non-Windows machines.

  • true. The Probe uses local winexe executable for NTCMD Windows discovery.

  • false (default). The Probe uses Windows remote Proxy.