Default global.properties file
This topic lists the default settings in the TrueSight Network Automation global.properties file and the Network Automation – Multi-Server Administration global.properties file.
- TrueSight Network Automation global.properties file
- TrueSight Network Automation – Multi-Server Administration global.properties file
TrueSight Network Automation global.properties file
This file controls many of the basic characteristics of the Network Automation application server. The global.properties file is located in the BCAN_DATA directory. Ensure that you restart the Network Automation web service each time you modify the global.properties file.
Click here to view the global properties file for version TrueSight Network Automation 21.08
# BMC Software, Inc.
# Confidential and Proprietary
# (c) Copyright 2007-2021 BMC Software, Inc.
# All Rights Reserved
# The source code embodied herein is a trade secret of BMC Software, Inc.
# All use, disclosure, and/or reproduction not specifically and expressly
# authorized, in writing, by BMC Software, Inc. is prohibited.
#
#
# Contains miscellaneous global properties. Note that any changes to this
# file (e.g. new properties, or new default values) need to be synchronized
# with changes to the corresponding Globals.java class in the util package
# which wraps access to these properties at runtime. The unit tester for
# the Globals class can be run to verify that things are synchronized.
#
# Note that properties shared between bcan server and device agents are
# encapsulated separately in global.properties.imported and
# global.properties.installed.
#
# The additional number of db connections required in excess of twice
# the number of maxConcurrentDeviceActions threads allowed. These excess
# connections are reserved for other misc system activity (e.g. browser and web
# service connections, system background activities).
# Affects versant.maxActive in database.properties. See the description of
# versant.maxActive for details.
#additionalDBConnections=30
#
# Specifies which include files to download during agent initialization.
# These will be looked for in the include subdirectory under the server
# process working directory.
# Default = DeviceCommandElement.xsd
#
#agentIncludeDownloads=DeviceCommandElement.xsd
#
# Specifies which jar files to download during agent initialization. Wildcards
# are allowed here, in order to not have to update this property every time
# a jar file version suffix changes. These will be looked for in the directory
# specified by the agentJarDownloadsDir property on the bcan server platform.
# Default = agentJarDownloads=beanshell2*.jar,
# commons-beanutils*.jar,
# commons-cli*.jar,
# commons-codec*.jar,
# commons-collections*.jar,
# commons-digester*.jar,
# commons-exec*.jar,
# commons-httpclient*.jar,
# commons-logging*.jar,
# commons-net*.jar,
# commons-validator*.jar,
# bcan-agent-exclusive-imported*.jar,
# bcan-agent-shared-imported*.jar,
# bcan-crypto*.jar,
# maverick-client*.jar,
# maverick-common*.jar,
# slf4j-api*.jar,
# httpclient*.jar,
# httpcore*.jar,
# dom4j*.jar,
# yavijava*.jar,
# jaxb-api*.jar,
# log4j*.jar,
# xalan*.jar,
# serializer*.jar
#
#agentJarDownloads=beanshell2*.jar,commons-beanutils*.jar,commons-cli*.jar,commons-codec*.jar,commons-collections*.jar,commons-digester*.jar,commons-exec*.jar,commons-httpclient*.jar,commons-logging*.jar,commons-net*.jar,commons-validator*.jar,bcan-agent-exclusive-imported*.jar,bcan-agent-shared-imported*.jar,bcan-crypto*.jar,maverick-client*.jar,maverick-common*.jar,slf4j-api*.jar,httpclient*.jar,httpcore*.jar,dom4j*.jar,yavijava*.jar,jaxb-api*.jar,log4j*.jar,xalan*.jar,serializer*.jar
#
# Specifies the directory at the bcan server in which to find the jar files
# listed in agentJarDownloads. The DEPLOYED_ROOT system property value will be
# concatenated with agentJarDownloadsDir to specify the full directory path in
# which to look. DEPLOYED_ROOT defaults to "." if unset, which is the case in
# development mode. In the field DEPLOYED_ROOT will be set to the location
# where bcan was installed. Note if agentJarDownloadsDir contains the pattern
# "*.war:*", then the first portion is taken as the name of a war file, and the
# second portion is taken as the directory within the war file to look in
# (e.g. "/a/foo.war:b/").
# Default = /tomcat/webapps/bca-networks/WEB-INF/lib/
#
#agentJarDownloadsDir=/tomcat/webapps/bca-networks/WEB-INF/lib/
#
# Specifies which license files to download during agent initialization.
# These will be looked for in user.dir, user.home, and in the / directory in
# the classpath.
# Default = maverick.license
#
#agentLicenseDownloads=maverick.license
#
# Specifies amount of time the DeviceAgentManager bcan thread will sleep
# between agent heartbeat check cycles.
# Default = 120 seconds
#
#agentPingIntervalSeconds=120
#
# Specifies which resource files to download during agent initialization.
# These will be looked for in user.dir, user.home, and in the
# /com/bmc/bcan/resources directory in the classpath.
# Default = DeviceTypeMap.xml,DeviceTypeMap_rules.xml,DeviceTypeMap.xsd,
# InjectableDeviceCommandElements.xsd,
# SmartMergeSettingsMap.xml,SmartMergeSettingsMap_rules.xml,
# SmartMergeSettingsMap.xsd,global.properties.imported,
# DeviceTypeMap*.properties,component*.properties
#
#agentResourceDownloads=DeviceTypeMap.xml,DeviceTypeMap_rules.xml,DeviceTypeMap.xsd,InjectableDeviceCommandElements.xsd,SmartMergeSettingsMap.xml,SmartMergeSettingsMap_rules.xml,SmartMergeSettingsMap.xsd,error.properties,global.properties.imported,DeviceTypeMap*.properties,component*.properties
#
# This field refers to a multi-value dynamic field. This field is usually a
# CAP which will capture any additional numeric IP addresses declared in
# the devices config file.
# Default = Alternate Addresses
#
#alternateAddressesDeviceFieldName=Alternate Addresses
#
# TrueSight Orchestration webservice workflow properties
#
# Flags whether or not Remedy Change Request Tasks are updated as Completed when
# Terminal jobs complete execution. Applies to both GUI and Proxy based Terminal
# sessions.
# Default = false
#
#aoCloseTaskForTerminalJobs=false
# Configuration name that TrueSight Orchestration uses to perform TrueSight Network
# Automation related operations.
# Some workflows use defaults that have been configured for TrueSight Network Automation.
# Default = BCAN
#
#aoConfigurationName=BCAN
# Flags whether or not enhanced validation checks should be made for the
# Change and Task fields when creating Terminal Job.
# The aoTerminalJobsValidation global property specifies which checks should
# be made in particular.
# Default = false
#
#aoEnforceTerminalJobValidation=false
# Lists the validation checks that need to be performed for the Change and
# Task when creating Terminal Job.
# These checks will only be made when the aoEnforceTerminalJobsValidation global
# property is true.
# When specifying what checks should be made, list each one separated by comma.
# Valid options are the following -
# validateChangeTaskExist (validates the Change ID and Task ID exist in ITSM)
# validateTaskStatusAssigned (validates Change is Scheduled and Task is Assigned)
# validateTaskUser (validates Job originator is User assigned to Task)
# validateTaskDate (validates Job run time falls between the Task's Scheduled Start and Stop dates)
# validateTaskCI (validates device in Job is in the Task)
#
# Default = aoTerminalJobValidation=validateChangeTaskExist,validateTaskStatusAssigned,validateTaskUser,validateTaskDate,validateTaskCI
#
#aoTerminalJobValidation=validateChangeTaskExist,validateTaskStatusAssigned,validateTaskUser,validateTaskDate,validateTaskCI
#
# The amount of time for which TrueSight Network Automation will wait before timing out
# if it cannot receive a response from the TrueSight Orchestration server or workflows.
# TrueSight Network Automation uses TrueSight Orchestration integrations with
# third-party IPAMs and for Continuous Compliance for Network (CCN) functionality.
# If the user observes exceptions due to timeout in TrueSight Orchestration-related
# integrations, increasing the value of this property might help.
# Note that the time specified needs to be in millisecond unit.
# Default = 900000 (15 minutes computed to millisec value)
#
#aoServerTimeout=900000
#
# Flags whether or not the devices in the job actions are associated with
# the Remedy Change Request Task during TrueSight Orchestration Job Submission
# workflow when the job is first created. For performance improvement, this is not done
# by default.
# Default = false
#
#aoIncludeCIsForJobCreate=false
#
# Flags whether or not the devices in the job actions are associated with
# the Remedy Change Request Task during TrueSight Orchestration Job Submission
# workflow when the job is edited. For performance improvement, this is not done
# by default.
# Default = false
#
#aoIncludeCIsForJobUpdate=false
#
# Flags whether or not the devices in the job actions are associated with
# the Remedy Change Request Task during TrueSight Orchestration Job Completion
# workflow when the job reaches one of the final states.
# Default = true
#
#aoIncludeCIsForJobComplete=true
#
# Flags whether or not devices in the job actions are associated with
# the Remedy Change Request Task during TrueSight Orchestration Job Submission
# workflow when the job is Reconciled.
# Default = true
#
#aoIncludeCIsForJobReconcile=true
#
# TrueSight Orchestration webservice properties for UDDI registry
#
#
# Application name for TrueSight Orchestration
# Default = BAO
#
#aoApplicationName=BAO
#
# Service name for TrueSight Orchestration web services
# Default = Atrium Orchestrator Service
#
#aoServiceName=Atrium Orchestrator Service
#
# Priority level to use for background report generation threads. Takes values
# between 1 and 10, with 10 being highest priority. We want background report
# generation threads to run at lower than other normal TrueSight Network
# Automation threads so that even when a bunch of them are running, the rest of
# the system remains relatively responsive. The normal java thread priority level is 5.
# The garbage collection thread runs at priority level 1.
#
# Note on linux, thread priorities are ignored unless one is using the
# "aggressive" thread priority policy (via "-XX:ThreadPriorityPolicy=1" while
# running as root). On windows, thread priorities are honored, even when
# using the "normal" thread priority policy (though a priority of 10 is ignored
# unless you are using the "aggressive" policy).
# Default = 2
#
#backgroundReportThreadPriority=2
#
# BMC Business Name
# Default = BMC
#
#bmcBusinessName=BMC
#
# Application name for TrueSight Network Automation
# Default = BNA
#
#bcanApplicationName=BNA
#
# TrueSight Network Automation Service Interface version. This will change only
# when the web services interface changes.
# Default = 1.0
#
#bcanWebServicesInterfaceVersion=1.0
#
# TrueSight Network Automation web services location
# Default = bca-networks/services
#
#bcanWebServicesLocation=bca-networks/services
#
# Comma separated list of TrueSight Network Automation web services that we publish in the UDDI registry.
# Default = Authentication Service, Addressing Service, Container Service, \
# Container Blueprint Service, Compliance Service, Device Service, \
# Device Security Profile Service, DNS Service, Endpoint Action Service, Event Service, \
# External Script Action Service, Group Service, Import Export Service, \
# IPAM Service, Job Approval Type Service, Job Service, \
# Load Balancer Service, Pod Service, Predefined Job Service, Realm Service, \
# Report Service, Rule Service, RuleSet Service, Security Service, \
# Security Vulnerability Service, Span Action Service, Substitution Parameter Service, Template Group Service,
# User Service
#
#bcanWebServices=Authentication Service, Addressing Service, Container Service, Container Blueprint Service, Compliance Service, Device Service, Device Security Profile Service, DNS Service, Endpoint Action Service, Event Service, External Script Action Service, Group Service, Import Export Service, IPAM Service, Job Approval Type Service, Job Service, Load Balancer Service, Pod Service, Predefined Job Service, Realm Service, Report Service, Rule Service, RuleSet Service, Security Service, Security Vulnerability Service, Span Action Service, Substitution Parameter Service, Template Group Service, User Service
#
# Mask for ChangeID (15 characters long)
# Default = CRQ000000000000
#
#cidMask=CRQ000000000000
#
# Application name for Atrium
# Default = Atrium
#
#cmdbApplicationName=Atrium
#
# Business Name used by CMDB web services during registration.
# This should be BMC Software but it is not for some reason.
# Default = BMC
#
#cmdbBusinessName=BMC
#
# Service name for CMDB web services
# Default = cmdbws
#
#cmdbServiceName=cmdbws
#
# The data set that will be queried for CMDB import
# Default = BMC_BaseRelationship
#
#cmdbQueryRelationshipClassName=BMC_BaseRelationship
#
# Base element as used in the graph query with the additional qualification:
# ClassId="BMC_ComputerSystem"
# Default = BMC_BaseElement
#
#cmdbBaseElementClassName=BMC_BaseElement
#
# Business service class name
# Default = BMC_BusinessService
#
#cmdbBusinessServiceClassName=BMC_BusinessService
#
# The name of the multi select dynamic field which will be populated with business
# service names
# Default = Business Services
#
#cmdbBusinessServicesDynamicField=Business Services
#
# The CMDB can be queried to return results in batches and this property
# defines the maximum no. of CIs retrieved from CMDB in every batch.
# Default = 1000
#
#cmdbMaxBatchSize=1000
#
# The name space within which TrueSight Network Automation will look for network CIs and business
# services
# Default = BMC.CORE
#
#cmdbNamespace=BMC.CORE
#
# Network CIs are instances of this class
# Default = BMC_ComputerSystem
#
#cmdbNetworkCIClassName= BMC_ComputerSystem
#
# Physical Locations are instances of this class
# Default = BMC_PhysicalLocation
#
#cmdbPhysicalLocationClassName= BMC_PhysicalLocation
#
# The data set that will be queried for CMDB import
# Default = BMC.ASSET
#
#cmdbCIDatasetId= BMC.ASSET
#
# TrueSight Network Automation retrieves network CIs from CMDB. That certain computer system instances
# represent network devices is determined by values that their
# PrimaryCapability attribute has, such Router (4), Switch (5), Layer 3 Switch (6)
# Central Office Switch (7), Hub (8), Access Server (9), Firewall (10),
# Web Caching (13), Repeater (19), Bridge/Extender (20), Gateway (21),
# LoadBalancer (22), SANSwitch (24), SANHub (25), SANBridge (26),
# SANRouter (27) and SANDirector (28).
# Default=PrimaryCapability=4 || PrimaryCapability=5\
# || PrimaryCapability=6 || PrimaryCapability=7 || PrimaryCapability=8\
# || PrimaryCapability=9 || PrimaryCapability=10 || PrimaryCapability=13\
# || PrimaryCapability=19 || PrimaryCapability=20 || PrimaryCapability=21\
# || PrimaryCapability=22 || PrimaryCapability=24 || PrimaryCapability=25\
# || PrimaryCapability=26 || PrimaryCapability=27 || PrimaryCapability=28\
#
#cmdbNetworkCIQuery=PrimaryCapability=4 || PrimaryCapability=5 || PrimaryCapability=6 || PrimaryCapability=7 || PrimaryCapability=8 || PrimaryCapability=9 || PrimaryCapability=10 || PrimaryCapability=13 || PrimaryCapability=19 || PrimaryCapability=20 || PrimaryCapability=21 || PrimaryCapability=22 || PrimaryCapability=24 || PrimaryCapability=25 || PrimaryCapability=26 || PrimaryCapability=27 || PrimaryCapability=28
#
# Directory where exported configurations are deposited. Note that this
# is edited by the installation scripts to be based at the BCA-Networks data
# dir.
# Default = /configs
#
configExportDirectory=/var/bca-networks-data/configs
#
# Directory where imported configurations are read from. Note that this
# is edited by the installation scripts to be based at the BCA-Networks data
# dir.
# Default = /configs
#
configImportDirectory=/var/bca-networks-data/configs
#
# Mask for matching filenames to determine which files will be imported.
# Default = *.cfg
#
#configImportFilenameMask=*.cfg
#
# Priority level to use for device action threads executing within the thread
# pool of our DeviceTaskManager. Takes values between 1 and 10, with 10 being
# highest priority. We want device action threads to run at lower than other
# normal TrueSight Network Automation threads so that even when a bunch of
# them are running, the rest of the system remains relatively responsive.
# The normal java thread priority level is 5.
# The garbage collection thread runs at priority level 1.
#
# Note on linux, thread priorities are ignored unless one is using the
# "aggressive" thread priority policy (via "-XX:ThreadPriorityPolicy=1" while
# running as root). On windows, thread priorities are honored, even when
# using the "normal" thread priority policy (though a priority of 10 is ignored
# unless you are using the "aggressive" policy).
#
# Default = 2
#
deviceActionThreadPriority=2
# The adapters present in the following files will be enabled by default.
# More adapters can be enabled on FRESH install by tweaking the property below.
# Never, ever remove DeviceTypeMap.xml from the list. Changing the property to
# include additional files makes sense only before running populator or upgrade
# of <5.4.00 database.
#deviceAdapterFilesToEnable=DeviceTypeMap.xml,DeviceTypeMap-custom.xml,DeviceTypeMap-endOfLife.xml
#
# Directory used by the import task.
# Default = /devices
#
deviceImportDirectory=/var/bca-networks-data/devices
#
# File Name used by import task
# Default = devices.xml
#
#deviceImportFileName=devices.xml
#
# Which version of various 3rd party differencing engines we should use when
# calculating configuration and other deltas. By default, we use org.incava
# JavaDiff. However, it runs slowly on certain file sizes and certain types of
# changes. You can switch the system to use the superior BMSI GnuDiff package
# by dropping the jar file into TSNA's tomcat/lib directory and setting this
# property to "BMSI". Before upgrading the TSNA release, you need to backup
# this jar file and after upgrade again need to put it back into tomcat/lib
# directory. Due to licensing restrictions, this jar file does not ship with
# the system; you can obtain it from:
# http://search.maven.org/#search|ga|1|gnudiff
# Default = default
# (anything except "BMSI" equates to default)
#
#differencingEngine=default
#
# Flag to control whether we dump DBSession cache information to the log file
# or not after DBSessionManager.commitTransaction is called. Doing this can
# help troubleshoot any transaction collision exceptions that occur, since it
# includes version information for entries in the cache. If enabled, you must
# enable INFO level logging in the DBSession class to see the output in the log
# file.
# Default = false
#
#dumpDBSessionCache=false
#
# Directory where authorized executables are located. These executables can
# be invoked via the ${exec ...} substitution parameter syntax embedded in
# templates and rules. This is also where binary data decoders live. Note
# that this is edited by the installation scripts to be based at the
# BCA-Networks data directory.
# Default = /endorsed
#
endorsedExecDirectory=/var/bca-networks-data/endorsed
#
# Amount of time to wait when executing an external process in an ${exec ...}
# embedded substitution parameter before aborting the process. Note setting
# this value to 0 or less means no timeout will be enforced.
# Default = 60 seconds
#
#execProcessTimeoutSeconds=60
#
# Name of the external source that can approve a job.
# Default = Remedy
#
#externalChangeManager=Remedy
#
# Whether TrueSight Network Automation holds change requests opened on the
# external change management system (like BMC Remedy ITSM server) that require
# action to be taken by a user, or group of users, working with TrueSight Network
# Automation.
# If it set to true then under Network -> Actions the <externalChangeManager> Inbox menu will appear.
# Default = true
#
#externalChangeManagerSupportsInbox=true
#
# Maximum number of filtered messages (i.e. syslog messages that passed thru
# at least one enabled external event filter) to process within a given
# DB transaction. Keeping this relatively small will avoid the possibility of
# syslog events appearing in the DB in large bursts, even if they are being
# received at the agent in large bursts.
# Default = 10
#
#filteredMessageBatchSize=10
#
# Fully qualified class name for the IPAM Provider
# Default = com.bmc.bcan.engine.network.ipam.impl.IpAddressManagerImpl
# Valid values for this property are:
# com.bmc.bcan.engine.network.ipam.impl.IpAddressManagerImpl for TrueSight Network Automation embedded IPAM provider
# com.bmc.bcan.engine.network.ipam.ao.ThirdPartyIpamImpl for TrueSight Orchestration based Thirdparty IPAM provider
#
#ipamProvider=com.bmc.bcan.engine.network.ipam.impl.IpAddressManagerImpl
#
# Flag to control whether to serialize the third party IPAM calls for acquireAddress operation.
# Default = false
# Valid values for this property are: false, true
#
#ipamSerializeThirdPartyRequests=false
#
# Whether or not IPAM lets us know a particular IP address is used or not, and also whether
# a particular IP address is free or not. However, for VitalQIP and Infoblox, this support is not added yet.
# Default = false
#
#ipamSupportsSpecificIpAddressStatus=false
#
# Prefix for the auto generated Job ID attribute of a job. This prefix
# can be up to 6 characters in length.
# Default = JOB
#
#jobIDPrefix=JOB
#
# When sending a job state change notification to an HTTP-based service, the
# number of seconds to allow the system to connect to the remote service and
# to receive responses to requests made to the service. This should not be
# very long, since job execution will be hung during this timeout period if
# the remote service is unresponsive.
# Default = 30 seconds
#
#jobStateChangeHttpNotificationTimeoutSeconds=30
#
# Whether or not we keep IOS "show inventory" entities that have no PID, VID,
# or SN values. Some devices on every little internal component, but
# these won't have PID, VID, or SN. Default is to discard these entities and
# not include them in the IOS hardware inventory.
# Default = false
#
#keepEmptyIosInventoryEntities=false
#
# Amount of time to wait when executing LocateRegistry.getRegistry to find
# the RMI registry at a remote agent. The default timeout on that call can
# be as long as 4 minutes, so we enforce our own potentially shorter timeout
# as specified by this property.
# Default = 15 seconds
#
#locateAgentTimeoutSeconds=15
#
# Specifies a custom header on the login page.
#
# Also includes HTML DIV opening tags which contain the header and footer.
# Margins can be defined in terms of px(pixel) OR %(percentage).
#
# Example of HTML tag format is:
# <div style="width:100%;background-color:lightgreen;margin-left:0px;margin-right:0px;color:#00427e;font-size:16px;font-weight:normal;text-align:center">DYNAMIC PAGE - HIGHEST POSSIBLE CLASSIFICATIONS</div><div style="width:100%;background-color:lightgray;margin-left:0px;margin-right:0px;color:#00427e;font-size:16px;font-weight:normal;text-align:center">FOR OFFICIAL USE ONLY</div>
#
# Default = none/empty
#
#loginHtmlTagHeader=
#
# Specifies a custom footer on the login page.
#
# Example of HTML tag format is as specified for header - loginHtmlTagHeader.
# Default = none/empty
#
#loginHtmlTagFooter=
#
# Maximum number of threads the TrueSight Network Automation engine will spawn
# to process incoming filtered events in event policies and other listeners.
# That is, this is now many different event policies can run concurrently as
# new events and changes are logged (where an event policy run just builds
# and queues a job). Each thread uses a database session while it is
# processing the new event.
# Default = 15
#
#maxDispatcherThreadCount=15
#
# When resolving template substitution parameters, how many levels
# of nested references we allow, to prevent infinite recursion. Since
# we allow a template to refer to other templates, we want to make
# sure that we don't cycle through a loop forever; we will stop at
# N levels as specified by this property. I picked 10 as the default
# because it seems more than any sane user would ever want to nest and
# still be able to follow what's going on. If set to less than 1, will
# disable resolution of template substitution parameters altogether.
# Default = 10
#
#maxTemplateNestingLevels=10
#
# Default value of the regex for finding the default gateway
# Default = ^(?:0.0.0.0|default|Default Gateway:)\\s*(\\S*)[\\s|\\S]*$
#
#netstatRegex=^(?:0.0.0.0|default|Default Gateway:)\\s*(\\S*)[\\s|\\S]*$
#
# Days that a temporary component stays in the system before it is disposed of.
# Currently used to purge temporary SimpleGroups and Ad-hoc Templates.
# SimpleGroups are created as temporary when user creates a span action
# with a multi-device network span; ad-hoc templates are temporarily created
# when user creates a merge action. The SimpleGroups and Ad-hoc Template
# become permanent when the user saves the job or policy. If the user abandons
# the job/policy edit session, then groups and templates can be left hanging
# around the database and need to be purged away.
# Default = 5
#
#orphanedComponentAgeDays=5
#
# Flag to specify whether to perform DNS registration or not.
# If this is set to false, even though CLM asks to add the DNS entry via registerDNS flag
# in the acquire*Address API call, DNS registration will not be done.
# Default = false
#
#performDnsOperation=false
#
# Name of the permanent dynamic field that represents Rule "Category", used
# for organizing or classifying rules. This name will appear in the dynamic
# fields list and the rule edit/view.
# Default = Category
#
#permanentFieldName.Rule.Category=Category
#
# Flags whether messages (e.g. syslog) from unknown devices are written to
# event log. When false, these messages are silently discarded.
# Default = false
#
#permitEventFromUnknownDevice=false
#
# When profileMemory or profileThreads is set to true, indicates how often
# (in seconds) the profiling information is written to the log file.
# Default = 5 seconds
# Minimum value = 5 seconds
#
#profileIntervalSeconds=5
#
# Flags whether to log JVM memory usage every few seconds, with an optional
# explicit garbage collection request every tenth time. Remember to enable
# info level logging by the bcan Utility class if you want to be able to see
# these messages.
# Default = false
#
#profileMemory=false
#
# When profileMemory is set to true, flags whether or not explicit garbage
# collection should be requested. When true, garbage collection will be done
# every tenth profiling interval. When false, no explicit garbage collection
# will be done (to allow JVM to do its own thing). GC will be done before the
# memory usage is printed.
# Default = true
#
#profileMemoryGarbageCollection=true
#
# When profileMemory and profileMemoryGarbageCollection are both true, this
# property determines how often the garbage collection request is made, counted
# in profiling calls. So if the profilingInterval is 5 seconds and the gc
# frequency is 10, the gc will be requested every 50 seconds (every 10th
# memory profiling call).
# Default = 10
#
#profileMemoryGarbageCollectionFrequency=10
#
# Flags whether to log information about currently active threads every few
# seconds. Thread information includes the thread ID, name and state.
# Remember to enable info level logging by the bcan Utility class if you want
# to be able to see these messages.
# Default = false
#
#profileThreads=false
#
# When profileThreads is true, flags whether or not the TOP of the stack is
# included with the other thread information in the log file.
# Default = false
#
#profileThreadStacks=false
#
# Start time at which purge manager runs daily. Note that if you specify an
# empty string for this value, daily purging will be skipped entirely.
# Format: "HH:mm"; H - hour in day (00-23); m - minute in hour
# Default = 00:00
#
#purgeTime=00:00
#
# Flags whether or not to relax the logic in the isValid methods to accommodate
# for the possibility of objects in the database not having default dynamic
# field values populated yet. Set this flag to true when you need to run the
# BcanValidator class to validate the database contents and skip ignore any
# violations due to missing default dynamic field values.
# Default = false
#
#relaxedValidation=false
#
# Events to be displayed in the Change Summary Report. Comma-separated
# list of Category.Severity tuples.
# Default = 5.5, 2.4, 3.5
# (External.Info, Device.Warning and Job.Info)
#
# Categories: Severities:
# SYSTEM = 1 CRITICAL = 1
# DEVICE = 2 MAJOR = 2
# JOB = 3 MINOR = 3
# USER = 4 WARNING = 4
# EXTERNAL = 5 INFO = 5
#
#reportChangeSummaryEvents=5.5, 2.4, 3.5
# Events to be counted in the Discrepancy Summary Report. Comma-separated list
# of Category.Severity tuples; severity is the minimum severity to include in
# the counts.
# Default = 5.5, 2.4
# (External.Info and Device.Warning)
#
#reportDiscrepancySummaryEvents=5.5, 2.4
#
# Maximum number of display rows in a report. Reports are generated to
# this max capacity, to limit how many rows the client-side display has to
# manage, how much memory is consumed during report generation and export,
# and how much space is used in the database for a stored report. When a
# report exceeds this number of rows, the system aborts its generation; you
# will be able to view the partial report.
#
# Not all reports have a row limit. Some reports are naturally limited by the
# number of devices in the system (discrepancy summary and configuration
# comparison). Some reports are not reporting on large component databases
# (system diagnostics, device adapter capabilities, and quarantine). Thus
# there are no reportMaxRows_* properties for these reports.
#
# The size of a row varies widely between the types of reports, and varies
# based on the names present in your database for components that appear in
# the reports (devices, realms, models, OS images, users, rule sets, rules,
# span actions, and action annotations). Search criteria in the ACL,
# configuration, and transcript search reports greatly affect the number of
# matched lines, which affects the sizing of each row in those reports. The
# default values are based on serialized row sizing using the BMC lab
# database with modestly sized names and search results.
#
# If you make any of these values too large, server may throw OutOfMemoryError
# and you may encounter web browser issues, including hangs. Note that an
# OutOfMemoryError may indicate a 2GB size limit is reached in the java
# ByteArrayOutputStream object (used while storing and exporting reports),
# which does not always mean you should increase your max heap size. If the
# OutOfMemoryError stack trace shows a ByteArrayOutputStream originated it,
# then the report is simply too large and cannot be generated, no matter what
# your max heap is set to. You must make different selections to reduce the
# size (such as fewer rules or a smaller network span).
#
# Note that these limits do NOT prevent OutOfMemoryError conditions from
# occurring during report generation. They only help to prevent CPU and memory
# usage from being wasted generating a large report that will not fit into the
# 2GB ByteArrayOutputStream limit. That is, your heap setting might allow a
# very large report to be generated, but it will fail to be serialized for
# storage into the allowed 2GB size. The system has thus wasted time and
# memory in the generation stage on something useless, and cannot even let you
# see a partial report. These limits reduce (but do not eliminate) that
# wastefulness.
#
# Default reportMaxRows_aclSearch = 1000000
# Default reportMaxRows_changeSummary = 1000000
# Default reportMaxRows_complianceSummary = 357000
# Default reportMaxRows_configurationSearch = 429000
# Default reportMaxRows_deviceInventory = 300000
# Default reportMaxRows_jobConflicts = 1000000
# Default reportMaxRows_jobSummary = 1000000
# Default reportMaxRows_osImageHistory = 1000000
# Default reportMaxRows_transcriptComparison = 1000000
# Default reportMaxRows_transcriptSearch = 50000
#
#reportMaxRows_aclSearch=1000000
#reportMaxRows_changeSummary=1000000
#reportMaxRows_complianceSummary=357000
#reportMaxRows_configurationSearch=429000
#reportMaxRows_deviceInventory=300000
#reportMaxRows_jobConflicts=1000000
#reportMaxRows_jobSummary=1000000
#reportMaxRows_osImageHistory=1000000
#reportMaxRows_transcriptComparison=1000000
#reportMaxRows_transcriptSearch=50000
#
# Maximum size of the thread pool to use for generating reports. Refer to the
# TrueSight Network Automation docs for the list of which reports are generating
# using the thread pool.
#
# Note that a single thread pool is used for all such reports. If the size is
# set to zero (or less), thread pool will be disabled and we will instead use a
# separate dedicated thread for each report, just like we did prior to adding
# this feature.
# Default = 10
#
#reportThreadPoolSize=10
# This property has been resurrected now into 8.5.01 for reasons related to
# backward compatibility with CLM, but its meaning is slightly different now.
# Now this boolean property flags whether to proceed with reprovisioning even if
# it involves non-reversible changes (e.g. adding a new NAT pool or infrastructure
# switch unconditionally), otherwise exception will be thrown.
# Default = true
#
#restrictedReprovisioningMode=true
#
# Flag for whether to cache the results of rights checking in memory, for
# certain components. Doing this can boost performance significantly for
# users who do not belong to any root-role (especially if the group ACL
# mechanism has been enabled).
# Default = true
#
#rightsCachingEnabled=true
#
# WHen a user logs in, we spin off a background thread to pre-load the user's
# access rights cache for jobs. This property limits how many jobs are
# pre-loaded, as this process can be CPU-intensive and interfere with the
# general usability of the system. The most recent N jobs created in the past
# seven days are pre-loaded. A limit of zero or less means don't pre-load jobs
# at all. Any job not pre-loaded into the rights cache is loaded when it is
# first needed.
# Default = 50000
#
#rightsCachingJobPreloadLimit=50000
#
# Priority level to use for background threads which initially build out
# the cache of rights checks for a user after he logs in. Only applicable
# if rightsCachingEnabled is true. Takes values between 1 and 10, with 10
# being highest priority.
# Default = 3
#
#rightsCachingThreadPriority=3
# This boolean property indicates whether to use round-robin
# rather than capacity-based algorithm when choosing the pod node
# to host a container node.
# Default = false
#
#roundrobinPodNodeSelection=false
# This boolean property indicates whether to use round-robin
# rather than capacity-based algorithm when choosing the pod pair
# to host a container pair.
# Default = false
#
#roundrobinPodPairSelection=false
#
# File Name used by rule export task
# Default = rules.xml
#
#ruleExportFileName=rules.xml
#
# Name of the (hidden) dynamic field used to perform auto-grouping of the
# security context devices that live within the same piece of equipment.
# The value will be the base hostname set in the admin or system context
# and shared by all the user-defined contexts.
# Default = MultiContextDevice
#
#securityContextAutoGroupPrefix=MultiContextDevice
#
# Whether or not to display the trusted discepancy-related columns on the
# per-device/per-group discrepancy and violation dashboard report. When false,
# the two Running Vs Trusted, and Startup Vs Trusted discrepancy columns are not displayed,
# for systems where maintaining trustedness is not feasible (when discrepancies cannot be eliminated).
# Default = true
#
#showTrustedColumnsOnDashboard=true
#
# Number of seconds to wait, beyond the system parameter for device actions,
# for a clean system shutdown to occur before EnaLoader simply exits. This
# number is added to the system param seconds, just to be safe. A shutdown
# will wait for the max of reboot timeout, access timeout, and command
# timeout, plus this much.
# Default = 15
#
#shutdownExtraWaitSeconds=15
#
# Flags whether to skip server authentication during SSL handshaking. If true,
# then you don't have to import agent (server) certificates at bcan (client)
# ahead of time.
# Default = true
#
#skipAgentAuthenticationByEna=true
#
# Skips automatic backup performed when you add a device or when you
# change its vendor. Skipping the backup allows a lot of the device
# related unit tests to run faster.
# Default = false
#
#skipAutomaticBackup=false
#
# The default value of the Commit checkbox in the span action forms
# Allowed options: true/false.
# Default = false
#
#spanActionCommitCheckboxDefault=false
#
# The default value of the Mark as trusted checkbox in the span action forms
# Allowed options: true/false.
# Default = false
#
#spanActionMakeTrustedCheckboxDefault=false
#
# Flag to indicate whether the SSH Proxy functionality will be enabled or
# disabled in the product. When disabled, server will not be listening for
# connections on the sshProxyPort. By default this will be enabled.
# Default = true
#
#sshProxyEnabled=true
#
# The listen for port the ssh proxy daemon.
# Default = 4000
#
#sshProxyPort=4000
#
# The banner for the ssh proxy.
# Default = "Welcome to TrueSight Network Automation. \
# This server is for authorized users only."
#
#sshProxyBanner=Welcome to TrueSight Network Automation. \
#This server is for authorized users only.
#
# The Preferred Client->Server Cipher for the ssh proxy.
# Default = aes128-ctr
# Legal values = aes192-ctr,
# aes256-ctr,
# 3des-ctr,
# aes128-ctr
#sshProxyPreferredCipherCS=aes128-ctr
#
# The Preferred Server->Client Cipher for the ssh proxy.
# Default = aes128-ctr
# Legal values = aes192-ctr,
# aes256-ctr,
# 3des-ctr,
# aes128-ctr
#sshProxyPreferredCipherSC=aes128-ctr
#
# Preferred Key Exchange algorithm for the ssh proxy.
# Default = diffie-hellman-group-exchange-sha256
# Legal values = diffie-hellman-group14-sha1,
# ecdh-sha2-nistp384,
# ecdh-sha2-nistp256,
# diffie-hellman-group-exchange-sha256
#sshProxyPreferredKeyExchange=diffie-hellman-group-exchange-sha256
#
# The prompt for the ssh proxy. The default value contains a blank at the end
# Default = "${server}:bca-networks$ "
#
#sshProxyPrompt=${server}:bca-networks$
#
# The prefix that indicates a substitution parameter belongs to the
# "agent" namespace, where its value is derived from a DeviceAgent attribute.
# Default = agent
#
#substitutionNamespaceAgent=agent
#
# The prefix that indicates a substitution parameter belongs to the
# "container" namespace, where its value is derived from a Container attribute.
# Default = container
#
#substitutionNamespaceContainer=container
#
# The prefix that indicates a substitution parameter belongs to the
# "device" namespace, where its value is derived from a Device attribute.
# Default = device
#
#substitutionNamespaceDevice=device
#
# The prefix that indicates a substitution parameter belongs to the
# "eval" namespace.
# Default = eval
#
#substitutionNamespaceEval=eval
#
# The prefix that indicates a substitution parameter belongs to the
# "exec" namespace.
# Default = exec
#
#substitutionNamespaceExec=exec
# The prefix that indicates a substitution parameter belongs to the "file"
# namespace.
# (1) This namespace is only applicable in the context of external script actions.
# (2) Allowed substitution parameters in the namespace:
# (a) ${file.trailName.current/trusted}- This indicates that external script
# takes device configuration as a parameter, where 'trailName' is the name
# of the configuration trail and 'current/trusted' decides whether it is
# current or trusted.
# (b) ${file.spanList} - This indicates that external script takes a file
# containing device and agent attributes as a parameter.
# (c) ${file.osImage) - This indicates that external script takes a device
# osImage as a parameter.
# (3) The value is name of the temporary file into which the corresponding
# configuration trail/osImage/list of device attributes is read.
# Default = file
#
#substitutionNamespaceFile=file
#
# The prefix that indicates a substitution parameter belongs to the
# "global" namespace, where its value is derived from a user-defined
# substitution parameter object stored in the database.
# Default = global
#
#substitutionNamespaceGlobal=global
#
# The prefix that indicates a substitution parameter belongs to the
# "label" namespace, where its value is derived from the localized display
# labels for entries in the device attributes configuration (the part of
# each attribute setting line to the left of the colon).
# Default = label
#
#substitutionNamespaceLabel=label
#
# The prefix that indicates a substitution parameter belongs to the
# "pod" namespace, where its value is derived from a Pod attribute.
# Default = pod
#
#substitutionNamespacePod=pod
#
# The prefix that indicates a substitution parameter belongs to the
# "runtime" namespace, where its value is specified by the user when a
# template that contains it is selected for a merge or restore action.
# Default = runtime
#
#substitutionNamespaceRuntime=runtime
#
# The prefix that indicates a substitution parameter belongs to the
# "template" namespace, where its value is derived from the contents of
# a template (matched by device type and os version).
# Default = template
#
#substitutionNamespaceTemplate=template
#
# The prefix that indicates a substitution parameter belongs to the
# "trigger" namespace, where its value is captured by a rule trigger
# pattern regular expression.
# Default = trigger
#
#substitutionNamespaceTrigger=trigger
#
# Mask for TaskID (15 characters long)
# Default = TAS000000000000
#
#tidMask=TAS000000000000
#
# The traceroute related properties. The values change depending on the
# operating system. Uncomment one of the following set of values.
#
# Following are the values for Windows
#tracerouteCmd=tracert -d
#tracerouteRegex=^\\d+[\\s*|\\S*]*?(\\S*)$
#tracerouteLastLine=3
#
# Following are the values for Linux
#tracerouteCmd=tracepath -n
#tracerouteRegex=^\\d+\\??:\\s*(\\S*)[\\s*|\\S*]*$
#tracerouteLastLine=3
#
# The timeout (in seconds) for running a traceroute command.
# Default = 60
#
#tracerouteTimeout=60
#
# Indicates the type of authentication being used.
# Default is local authentication where username and password information
# reside in the TrueSight Network Automation database. Others are remote authenticators
# configured as a Realm in the server.xml file.
# Allowed options: local/activeDirectory/ldap/radius/tacacs/sso
# Default = local
#
userAuthMode=local
#
# Indicates if merge actions created as part of ContainerService implementation
# commit the changes or not.
# Default = true
#
#vdcCommitContainerActions=true
#
# Indicates if virtual datacenter functionality is enabled.
# Default = false
#
#vdcEnabled=false
#
# Indicates if firewall rule sorting is enabled. If enabled, TrueSight Network Automation will
# sort the firewall rules, else the end user is responsible for maintaining the
# order of the firewall rules. This property is only meaningful in the context
# of the virtual data center functionality being enabled.
# Default = true
#
#vdcFirewallRuleSortingEnabled=true
#
# Flags whether to force the use of tunneled transfer mode when pushing ACL
# updates out to a CSR VFW. This works around a problem in the CSR operating
# system where it sometimes crashes and reboots when ACL updates are pushed
# out using file transfer.
# Default = true
#
#vdcForceTunneledCsrUpdates=true
#
# Specifies how many seconds to wait before giving up when attempting to
# acquire an object lock during a VDC operation (e.g. locking a pod,
# container, or container node). A value of null will cause there to be
# no timeout enforced.
# Default = null
#
#vdcLockTimeoutSeconds=null
#
# Indicates if the system should push the firewall rule description to the
# device. If enabled, TrueSight Network Automation will push the firewall rule
# description to the device.
# This property is only meaningful in the context of the virtual data center
# functionality being enabled.
# Default = false
#
#vdcPushFwRuleDescriptionToDevice=false
#
# Flags whether we should automatically attempt to rollback (deprovision) a
# container after a failed provision attempt. Setting this to true is useful
# when troubleshooting a new container blueprint, since it allows one to
# inspect the resulting partial container state.
# Default = false
#
#vdcSkipProvisioningRollback=false
#
# Indicate the maximum number of characters for virtual guest device name.
# The length of the virtual guest device name should not exceed the maximum limit
# set by vdcMaxVirtualGuestFullNameLength. In case guest device name contains
# substitution parameter then length will be calculated after its resolution.
# Default = 32.
#
#vdcMaxVirtualGuestFullNameLength=32
#
# Enable logging when session is initialized – using the session-init and/or session-close
# option for the log command. Its values could be: one of session-init, session-close
# and session-init-and-close.
# Default = session-init
#
#vdcJuniperFirewallRuleLogging=session-init
TrueSight Network Automation – Multi-Server Administration global.properties file
This file controls many of the basic characteristics of the Network Automation – Multi-Server Administration The global.properties file is located in the MSA_DATA (C:\Program Files\BMC Software\BCA-Networks-MSA\data) directory. Ensure that you restart the Network Automation – Multi-Server Administration web service each time you modify the global.properties file.
Click here to view the global.properties file for TrueSight Network Automation -- Multi-Server Administration 21.08
# BMC Software, Inc.
# Confidential and Proprietary
# (c) Copyright 2007-2019 BMC Software, Inc.
# All Rights Reserved
# The source code embodied herein is a trade secret of BMC Software, Inc.
# All use, disclosure, and/or reproduction not specifically and expressly
# authorized, in writing, by BMC Software, Inc. is prohibited.
# This is the limit of combo groups can be pushed on
# one target site at a time.
# Default = 100
#comboGroupPushLimit = 100
# This is the limit of device security profiles can be pushed on
# one target site at a time.
# Default = 100
#deviceSecurityProfilePushLimit = 100
# This is the limit of templates can be pushed on
# one target site at a time.
# Default = 100
#templatePushLimit = 100
# This is the limit of rule sets can be pushed on
# one target site at a time.
# Default = 100
#ruleSetPushLimit = 100
# This is the limit of global substitution parameters can be pushed on
# one target site at a time.
# Default = 100
#globalSubstitutionParameterPushLimit = 100
# This is the limit of rules can be pushed on
# one target site at a time.
# Default = 100
#rulePushLimit = 100
# This is the limit of dynamicFields can be pushed on
# one target site at a time.
# Default = 100
#dynamicFieldPushLimit = 100
# Timeout value for the inactive user sessions.
# Default = 30
#sessionTimeOutMinutes = 30
# Whether or not our HttpClient validates SSL certificates from server. If set
# to false then explicitly need to import SSL certificates in keystore.
# Default = false
#ignoreSSLCertificates= false
# Name of the dynamic fields from the TSNA instances using which devices can be filtered.
# Default =
#deviceSearchByDynamicField =
# Name of the dynamic fields which suppose to be display as column in device search
# result list page.
# Default =
#displayDynamicFieldsInList =
# Whether the user wants to enable strict checking for authentication mechanism for
# TSNA site instances.
# This property is to avoid account lockout if the sites are using the same external authentication server.
#
# To set this to true, it is recommended that all the sites should be configured to use same external authentication server.
# In case of true, it will give error message for first invalid login on site to avoid unnecessary login attempts on other
# sites which are using the same external authentication server to avoid lockout for that user.
#
# By default it is set to false and it will try to do the authentication on all the registered sites till it gets a login success.
# If login fails on all the sites then the site user is not allowed to login in to MSA.
#
# Default = false
#strictCheckForSiteAuthentication = false