Operation > Data Flow Management > Data Flow Management Setup > Data Flow Probe Setup > DataFlowProbe.properties Parameters

DataFlowProbe.properties Parameters

This section describes the parameters of the DataFlowProbe.properties file.

ClosedServer Connection Definitions
Parameter Name (A-Z) Description Type Value
appilog.agent.Probe.DownloadingTimeout Timeout (in ms.) for download configuration files and userExt files (that is, serverData files).

long

 Default: 300000
appilog.agent.probe.
protocol 		Defines the protocol used to communicate between the Probe Gateway and the Server.

string

HTTP or HTTPS (SSL)

Default: HTTPS
appilog.agent.Probe.ServerTimeout Timeout (in ms.) for Probe requests going to the server.

long

Default: 180000
appilog.agent.Probe.
ServerTimeoutForTouch 		Timeout (in ms.) for touch requests going to the server. long Default: 300000

appilog.agent.Probe.BasicAuth.User

appilog.agent.Probe.BasicAuth.Pwd

 Basic authentication feature of Probe to Server. These properties are supplied by the admin who configured the Web server. Deprecated: certificate-based, mutual SSL authentication should be used instead.

string

All keys must be used to indicate usage of this feature. Values can be empty to represent non-values.

Password has to be encrypted. Encrypt password using the Probe JMX (that is, the getEncryptedKeyPassword operation in the MainProbe MBean).

appilog.agent.Probe.
JMX.BasicAuth.User		 Authentication data for the Probe JMX - user name.

string

 All keys must be used to indicate usage of this feature. Values can be empty to represent non-values.
appilog.agent.Probe.
JMX.BasicAuth.Pwd 		Authentication data for the Probe JMX - password. bytes

Password has to be encrypted. Encrypt password using the Probe JMX (that is, the getEncryptedKeyPassword operation in the MainProbe MBean).

appilog.agents.probemgr.
progressSleepTime 		"Sleeping" time of the thread that is responsible for sending the progress to gateway. long Default: 40000
appilog.collectors.
domain 		The domain which the Probe Gateway belongs to (formerly known as the Domain of the Probe).

string

Default: ${DefaultDomain}
appilog.collectors.
domain.type 		The type of the domain.

string

customer (default); external
appilog.collectors.
probe.name

The Probe Gateway name used for identification by the UCMDB server

The server uses this name to pass tasks to the appropriate Probe Gateway.

string

Uses the value defined during installation.

The default value is the machine name.
com.hp.ucmdb.
discovery.Probe.JMX.
UploadAuth.User 		Authentication data for the discovery Probe JMX - user name. string Default: UploadScanFile
com.hp.ucmdb.
discovery.Probe.JMX.
UploadAuth.Pwd		 Authentication data for the discovery Probe JMX - password. bytes

Password has to be encrypted. Encrypt password using the Probe JMX (that is, the getEncryptedKeyPassword operation in the MainProbe MBean).

httpConnectionLimit The max number of connections probe establish with server. This value must be greater than 0. int Default: 5
jettyGtwHttpPort The port of the jetty server used by Probe Gateway (in separate mode), or the Probe (in union mode). int

Default: 1977;
1979 for the second probe (if installed)

 
jettyGtwHttpsPort The https port of the jetty server used by Probe Gateway (in separate mode), or the Probe (in union mode). int Default: 8453;
8455 for the second probe (if installed)
jettyMgrHttpPort The port of the jetty server used by Probe Manager (in separate mode). int Default: 1978;
1980 for the second probe (if installed)
jettyMgrHttpsPort The https port of the jetty server used by Probe Manager (in separate mode). int Default: 8454;
8456 for the second probe (if installed)
jettyHttpsEnabled

Enables using the default https server.

Starting with version 10.31, the default value for this setting is true for fresh installed probes of version 10.31 (or later). The HTTPS port 8453 is enabled for the Probe by default, and the HTTP port 1977 disabled. For details, see Using HTTPS Port 8453 as Default for Data Flow Probe.

Note For off-site scan file saving, only the HTTPS port 8453 can be used. If you want to use HTTP port 1977 for scan files saving, set jettyHttpsEnabled to false.

 Boolean

Default: true
reuseHttpConnection Probe reuses the connection with the server. boolean Default: false
server.webApp.name Name of the server Web application (.war file) responsible for the Probe.

string

 Default: mam-collectors
server.webApp.
root.context 		UCMDB server's root context, will be used by server.webApp.name and com.hp.ucmdb.discovery.
common.security.cmRest
Context.		 string Default: /
serverName Defines the Server DNS name to which the Probe Gateway connects.

string

The DNS name
serverPort The port number for HTTP communication.

int

 Default: 8080
serverPortHttps The port number for HTTPS communication.

int

Default: 8443
ClosedData Flow Probe Definitions
Parameter Name Description Type Value

appilog.agent.
callhome.port

 Communication port used by the Universal Discovery Agent Call Home functionality int Default: 80; 81 for the second probe (if installed)
appilog.collectors.
storeDomainScop
eDocument		 Specifies whether the (encrypted) DomainScope document should be stored on the Data Flow Probe's DB and file system (true) or be retrieved each time the Probe comes up and stored in memory only (false). boolean Default: true

appilog.agent.local.jdbc.user

 PostgreSQL user name string Default: mamprobe
appilog.agent.local.jdbc.pwd PostgreSQL password bytes

To change the DB password:

  1. The out-of-the-box script set_dbuser_password.cmd can be used in order to change the password of the default PostgreSQL user.

  2. The password value in the properties file should be encrypted. Encrypt the password using the Probe JMX (that is, getEncryptedKeyPassword operation in MainProbe MBean).
appilog.agent.probe.jdbc.driver Probe Gateway database information string

Default: org.postgresql.Driver
appilog.agent.probe.jdbc.uri Probe Gateway database information string

Default: jdbc:postgresql://localhost
/dataflowprobe

jdbc:postgresql://localhost:
5433/dataflowprobe for the second probe (if installed)
appilog.agent.
probe.jdbc.
useCmdbSchema 		Probe Gateway database information boolean Default: false
appilog.agent.probe.jdbc.user Probe Gateway user name string Default: mamprobe
appilog.agent.probe.jdbc.pwd Probe Gateway password bytes Password has to be encrypted. Encrypt password using the Probe JMX (that is, getEncryptedKeyPassword operation in MainProbe MBean).
appilog.agent.local.jdbc.driver Probe Manager database information string Default: org.postgresql.Driver
appilog.agent.local.jdbc.uri Probe Manager database information string

Default: jdbc:postgresql://localhost
/dataflowprobe

jdbc:postgresql://localhost:
5433/dataflowprobe for the second probe (if installed)
appilog.agent.local.
jdbc.useCmdbSchema		 Probe Manager database information boolean Default: false
appilog.agent.
normalization.
jdbc.user 		Normalization database info string Default: mamprobe
appilog.agent.
normalization.
jdbc.pwd		 Normalization database info bytes Password has to be encrypted. Encrypt password using the Probe JMX (that is, getEncryptedKeyPassword operation in MainProbe MBean).
appilog.agent.
normalization.
jdbc.driver		 Normalization database info string Default: org.postgresql.Driver
appilog.agent.
normalization.
jdbc.uri		 Normalization database info string

Default: jdbc:postgresql://localhost
/dataflowprobe

jdbc:postgresql://localhost:
5433/dataflowprobe for the second probe (if installed)
appilog.agent.
normalization.jdbc.
useCmdbSchema		 Normalization database info boolean Default: false
appilog.agent.
netflow.jdbc.uri		 Netflow database info boolean

Default: jdbc:postgresql://localhost
/dataflowprobe

jdbc:postgresql://localhost:
5433/dataflowprobe for the second probe (if installed)
appilog.collectors.probeLocalUnion

true: Probe GW process should also run a Probe Manager on same JVM.

false: Probe manager runs separately

boolean Default: true
appilog.collectors.rmi.gw.port Communication port between Probe GW and Probe Managers in case they are installed on separate processes int

Default: 1742;
1744 for the second probe (if installed)

Note This value should be the same for all installed Probe Managers belonging to this Probe Gateway.

appilog.collectors.rmi.port Internal communication port int

Default: 1741;
1743 for the second probe (if installed)

Note This value should be the same for all installed Probe Managers belonging to this Probe Gateway.

appilog.collectors.storeDomainScopeDocument

true: Encrypted DomainScope document is stored on file system and internal DB.

false: Encrypted DomainScope document is retrieved from server each startup and stored only in memory.

 boolean Default: true
appilog.collectors.local.ip The Probe Manager IP address or DNS name string DNS Name
appilog.collectors.probe.ip The Probe Gateway IP address or DNS name string DNS Name

probe.fips.status

Indicates which stage the probe is on in FIPS mode:
0 = NON-FIPS
1 = JCE is ready
2 = FIPS

Note Not present in the DataFlowProbe.properties file by default. It has no value until after users change the probe master key manually.

 int Default: 0
ClosedProbe Gateway Configurations
Parameter Name Description Type Value
appilog.agent.probe.
integrationsOnlyProbe 		Mark this probe to run integration tasks only. Intended to SaaS and local probe installations only. boolean Default: false
appilog.agent.probe.reconnection.interval The interval in ms. between reconnection attempts of the Probe Gateway to its Probe Managers. long Default: 30000
appilog.agent.probe.retrievetasksFromServer.interval The interval in ms. between task requests from the server by the Probe Gateway. long Default: 15000
appilog.agent.probe.saveResultsIn
BKPTable

true: Results sent to the Server are stored in the database in a backup table.

false: Results are not stored in a backup table.

 boolean Default: false
appilog.agent.probe.restartProbeAfter
JarDownload.interval		 Downloaded jar file resources can cause the Data Flow Probe to restart before all the other resources of an adapter package have downloaded. This parameter prevents the restart from occurring. long

Default: 180000 msec (3 minutes)

Note The delay until a restart on the first resource download (that is, for a first start or after clearing the Probe data) is 10 milliseconds.

appilog.agent.probe.
sendtouchResultsTo
Server.maxObjects

The maximum objects of the touch results to be sent to the server each time.

Note Setting this parameter higher than 500 may cause communication exceptions.

 int Default: 500

probe.master.key

Specifies probe master key for password encryption purpose.

Note: For a probe that is upgraded to version 10.21 or later, this parameter is not present by default. You can manually add this parameter and set the value for the parameter by using the changeMasterKey JMX method. For details, see the Universal CMDB JMX Reference Guide.
 string

Default:
appilog.common.
system.types.vect
ors.ObjectStateHo
lderVector

 
ClosedProbe Manager Configurations
Parameter Name Purpose Type Value Description
jettyMgrHttpsPort The https port of the jetty server used by Probe Manager (in separate mode). int Default: 8454;
8456 for the second probe (if installed)
appilog.agent.local.
max.worker.runtime		 Maximal time (in msec) which a worker thread is allowed to run. long Default: 900000
appilog.agent.local.
max.worker.stuck		 After this period it is considered as stuck. int Default: 8
appilog.agent.local.
check.stuckThreads

Maximal number of worker threads which can be considered as stuck at the same time. When the number is reached, the Probe schedules a restart to release these threads.

true - the Probe Manager should detect stuck threads.

false - otherwise.

boolean Default: true
appilog.agent.local.
discoveryAnalyzerF
romEclipse 		Setting to true enables that DiscoveryAnalyzer is executed from Eclipse. boolean Default: false
appilog.agent.local.
process.result.checkMultiUpdate		 Defines whether to check data consistency on objects. boolean Default: true
appilog.agent.local.
services.maxRemoteP
rocesses

The maximum number of remote processes allowed to be created during discovery. Remote processes are used to separate specific discovery from Probe process to prevent the Probe from possible memory issues.

Used, for example, in J2EE Discovery.

 int Default: -1 (no limit)
appilog.agent.local.
services.maxRemoteP
rocessesPerJob 		The maximum number of remote processes per job that are allowed to run simultaneously. int Default: 3
appilog.agent.local.
process.result.
dataValidation 		Checks results for invalid data. boolean Default: true
appilog.agent.local.
process.result.data
Validation.content		 Defines whether to validate data reported to the UCMDB server by content. Deals mainly with reported values (that is, attribute value), rather than metadata of objects. boolean Default: true
appilog.agent.local.
process.result.autoDelete

true - send auto-delete notification to Server for aged objects, not discovered by the Probe.

false - do not send

Note This can be enabled only if appilog.agent.local.process.
result.filterRedundant is enabled.

 boolean Default: true
appilog.agent.local.
process.result.data
Validation.validLinks

true - validate links are legal.

false - do not validate links.

boolean Default: true
appilog.agent.local.process.result.filterCI

true - filter results be predefined rules (CI types).

false - otherwise

boolean Default: true
appilog.agent.local.process.result.filterRedundant

true - filter results which have been already sent to server.

false - disable filter.

boolean Default: true
appilog.agent.local.
process.result.filterRedundant.
filterIgnoredCIs

  • true. If CIs were ignored by reconciliation on a discovery cycle, as long as they have not undergone any changes, they are filtered by the Probe on subsequent discovery cycles, and a warning is displayed on the trigger CI level. To resend these objects, you must clear the results cache.

  • false. Even if CIs that were ignored by reconciliation, they are still sent to the UCMDB on each discovery cycle, together with new and updated CIs.

 boolean Default: true
appilog.agent.local.process.result.
fixLinksDirection

true - fix direction of illegal links.

false - otherwise.

boolean Default: true
appilog.agent.local.
process.result.
storedata 		Store the result data in probe manager database when a new record is inserted. boolean Default: true
appilog.agent.local.
process.result.
updateClassModel 		Update class model (change classes and attributes name) as part of results processing chain. boolean Default: true
appilog.agent.local.process.result.
warnOnMultiUpdate

true - Reports multiple update warnings to the UCMDB server.

Note This parameter is global. It can be overridden on the adapter level by the warnOnDuplicates parameter which is absent by default, but gets its value from the global parameter.

 boolean Default: true
appilog.agent.local.
services.poolThreads		 Maximal number of concurrent threads allocated for the multi-threaded job's execution activity. int Default: 80
appilog.agent.local.
services.defaultMax
JobThreads		 Maximal number of concurrent threads running on a specific job. int Default: 8
appilog.agent.local.
services.adHocMax
Threads 		Maximal number of threads for ad hoc tasks. int Default: 20
appilog.agent.local.
discoveryAnalyzerFromEclipse

True: DiscoveryAnalyzer is executed from Eclipse.

False: DiscoveryAnalyzer is not executed from Eclipse.

boolean Default: false
appilog.agent.local.
download.erroneos.
configuration.documents.
interval 		Interval before re-download of erroneous configuration document from server. int Default: 1440
appilog.agent.local.
maxTaskResultSize		 Chunk maximal size of results being sent to the server. int

Default: 20000

Note Lowering this value lowers the number of CIs sent to the CMDB in a single bulk.
appilog.agent.local.
maxTaskResultPrint
LogSize 		Probe mgr - Bulk with more results that set on this parameter will not be printed to task results log. int Default: 2000
appilog.agent.local.
probe.restart.interval 		Interval (in ms) before auto-restarts of the Probe Manager. long Default: 900000
appilog.agent.local.
serverdata.sync.timeout 		Timeout (in msec) for the Probe to sync with Server data before starting executing tasks. long Default: 60000
appilog.agent.local.
specialCharactersRemove 		Filter characters from string attributes of result objects which are reported to server by Probe. string Default: empty string (do not filter)

appilog.collectors.
probemgr.DefaultResult
GroupMinTime

appilog.collectors.
probemgr.DefaultResult
GroupMaxObjs

 Probe Mgr - Result Grouping defaults (used when DFM adapter does not override). Grouping means holding on to results and sending them to the Gateway only upon meeting one of the grouping thresholds. This is used to control the rate of data flowing from Probes to the Server. long

Default min: 5000

Default max: 30000 (in ms.)

Relation between two keys: OR
appilog.collectors.
listenertaskmgr.load.jars.
recursive 		When building the class path, probe manager looks for jar/class files only in # listed directories (recursive=false) or search recursively (true). Default: false Default: false
appilog.agent.probe.
touchWindowMechanism.
isActive		 The touch window defines the period when touch process is allowed . The parameter defines whether the touch window mechanism is active. boolean Default: false
appilog.agent.probe.touchWindowMechanism.
startTime 		Defines the time, in hours and minutes, when the touch window starts string

Format: HH:MM

Values: 00:00-23:59

Default: 00:00
appilog.agent.probe.touchWindowMechanism.
endTime 		Defines the time, in hours and minutes, when the touch window ends string

Format: HH:MM

Values: 00:00-23:59

Default: 00:00
ClosedI18N Parameters
Parameter Name Description Type Value
appilog.collectors.
encoding.ANSI 		Default encoding used for Windows applications (requiring ANSI encoding) string Default: empty (ANSI encoding is chosen from the Data Flow Probe operating system)
appilog.collectors.
encoding.OEM 		Default encoding used for DOS/UNIX Shells/IBM encoded applications. string Default: empty (OEM encoding is chosen from the Data Flow Probe operating system)
chcpCodeToCharasetName.xxx Mapping entry between chcp code page to specific encoding name (used for cases where the cp+<code> rule is not followed) string

Syntax: chcpCodeTo
CharasetName.
<code>=<encoding_name>

Example: chcpCodeTo
CharasetName.
932=MS932
collectors_language Language settings (must be manually configured for non-English environments). string

Default: English Options: get=German

rus=Russian

Related Topics Link IconRelated Information