The following is a listing of some commonly used properties that can be defined and modified by administrators. These properties can be copied into either <aphome>/global.properties or individual node.properties to take effect, depending on the scope.
Property Files
- <aphome>/domain.properties
Properties shared by all run-time components within a domain across all connected managed nodes. (only on domain server installation) - <aphome>/global.properties
Properties shared by all run-time components: domain server, managed node, console and web server on a local installation. - <aphome>/naming/node.properties
Properties shared by domain server and all deployed services within the domain server. - <aphome/localhost/node.properties
Properties shared by managed node and all deployed services within the managed node. - <aphome>/mconsole/node.properties
Properties shared by the console. - <webapps>/autopilot/node.properties
Properties shared by the AutoPilot/Web J2EE application.
General
- property autopilot.home=<install_dir>
This is the installation directory. Do not change or define this variable; it is set automatically upon installation. - property server.type=<type>
Server type. DO NOT change this property. The type value can be:- Domain: domain server
- Server: managed node
- Client: console.
- property installation.update.groups=console,mandatory,service_updates
List of update groups for which the installation is subscribing for updates. This property is maintained by Installation Manager.
Console
- property console.external.browser=true
Launch external web browser when clicking on links within business views. - property console.pwd.notice=true
property console.pwd.notice.days=15
Enable early password expiration notification. The early notification is console.pwd.notice.days in advance and must be at least 50% of the password life. - property gui.lookandfeel=Native
Default look and feel for the GUI:- Default: default Java look and feel
- Native: native OS look and feel
- SkinLF: skinnable look and feel based on supplied theme packs. Un-comment only one line below to enable a specific theme pack:
property gui.skinlf.themepack=../themes/aquathemepack.zip
property gui.skinlf.themepack=../themes/macosthemepack.zip
property gui.skinlf.themepack=../themes/beosthemepack.zip
property gui.skinlf.themepack=../themes/bbjthemepack.zip
property gui.skinlf.themepack=../themes/whistlerthemepack.zip
property gui.skinlf.themepack=../themes/modernthemepack.zip
property gui.skinlf.themepack=../themes/themepack.zip
property gui.skinlf.themepack=../themes/xplunathemepack.zip
property gui.skinlf.themepack=../themes/toxicthemepack.zip
Policy Performance
- property server.policy.buffer.size=500
This is the sensor fact buffer size. A lower value increases update rate, but decreases performance. Facts are buffered and then flushed when the limit is reached. - property server.policy.buffer.grace_period=3000
The sensor fact grace period in MS. Sensor facts are flushed after a define grace period regardless of the buffer size. - property server.sensor.profiler=false
global setting to enable gathering of sensor profiling metrics this property must be set to true to profile sensor performance default setting is false - property server.policy.publish.comp.mode=false
Disables the enhanced policy publishing mechanism. Disabling improves rule engine performance by ~2x. The default setting is compatibility mode off (false). - property server.sensor.notify.delay.exclude.list
Provides a list of status values that ignore the trigger delay. Can be any status value, for example:- Success: to generate the clearing of alerts immediately
- Emergency: severe events go out without delay
Rule Engine Performance
- property server.sensor.table.size=1011
Optimal number of expected child sensors for each parent sensor. - property server.sensor.rule.thread.debug=false
Enables rule engine debug mode. - property server.sensor.batch=100
The max sensor in the pipeline before forcing rule execution. - property server.sensor.idle=5000
In ms. max idle time before forcing rule execution - server.sensor.processor.limit=20000
Total number of outstanding events per policy before stopping the flow of facts to the policy. - server.sensor.db.queue.flowpct=60
Integer value 0 to 100. 0 disables database logging flow for all business views. This value specifies percentage of server.sensor.db.queue.limit before enabling sensor database logging after the usage hits 100%. - server.sensor.db.queue.limit=10000
Integer value > 0 controls the maximum depth of the database logging queue beyond which all logging activity is stopped and new logging requests are rejected (dropped). Activity is resumed when usage drops to the value specified in server.sensor.db.queue.flowpct. - property server.sensor.delivery.flowpct=0
Integer value 0 to 100. 0 disables flow control for each business view. This value specifies percentage of server.sensor.processor.limit before enabling flow to the sensors after the usage hits 100%. - property server.sensor.delivery.batch=2000 (2000 default value)
Processing of sensor events is done in batches. It is not recommended to set this value below 100 as it may create too much thread contention and decrease performance of the rule engine. - property server.sensor.load.balance=false
Turn on/off the automatic sensor load balancer. When turned on each running instance of the business view is allocated 2 dedicated processing threads. It also provides better isolation and stability for each business view. The rule/sec rate may drop however due to higher number of threads. - property server.sensor.delivery.algorithm=inline
This property controls tuning of the sensor/event delivery algorithm.- inline: default, each event is delivered one by one.
- batch: a number of events can be accumulated up to the value specified in the server.sensor.delivery.batch property. Batch mode can be beneficial when there is a high influx of facts and/or fact_delivery_backlog / fact_publish_backlog are growing.
- property server.sensor.process.nulls=true
Let sensor rules process fact values that evaluate to null. By default the property is set to false and rules are halted when one or more facts evaluate to null. Setting this property to true allows rule execution even when facts evaluate to null. This allows users to create rules around to check for existence of facts. - property server.sensor.notify.grace.period=-1
Sensor notification grace period indicates the time period (MS) after which the sensor will suppress notification. The time slice is computed from the start of the business view. If the facts monitored by the sensor changed after the grace period since the start of the bsvs, the notification/actions will be suppressed. The default value (-1) disables this logic (compatibility mode).
Communication
- property server.agent.timeout=35000
Maximum time before command times out (MS). - property server.socket.pipe.trace=false
Enable trace for all socket communication. Enable only for debugging and tracing. - property com.nastel.nfc.net.trace=true
Enable all low level communication trace. - property server.classloader.debug=false
Enable all network class loading trace. Enable only for debugging and tracing. - property server.socket.option.TCP_NODELAY=true
Enable/disable TCP_NODELAY socket option. Turns on or off the Nagles TCP algorithm. True turns it off, false turns it on. - property server.net.socket.keepalive=false (deprecated)
property server.socket.option.SO_KEEPALIVE=false
Enables TCP keep alive. enable for server running behind a firewall. - property server.net.socket.rcvbuffsize=0 (deprecated)
property server.socket.option.SO_RCVBUF=65536
Override TCP receive buffer size in bytes. Generally does not require adjustments. - property server.net.socket.sndbuffsize=0 (deprecated)
property server.socket.option.SO_SNDBUF=65536
Override TCP send buffer size in bytes. Generally does not require adjustments. - property server.io.input.buffer.size=8192
Buffered socket I/O input size in bytes. - property server.io.output.buffer.size=8192
Buffered socket I/O output size in bytes. - property server.net.sessions.poolsize=3
The max number of parallel processing sessions per server; 2 is the minimum. Generally does not require adjustments. - property server.net.agents.poolsize=1000
The max number of outstanding requests per session. Generally does not require adjustments. - property server.net.connection=hostname,ipaddress:
Override with the specified "hostname,IP" for communication. This variable is useful when host has multiple private and public interfaces. This variable should always have the value of the public interface that can be used by outside entities to establish communication. - property servlet.cache.timeout=5
AutoPilot/Web business view cache retention value. Business views are cached for a specified period of time. Older entries are invalidated and refreshed from the source servers. - property server.pipe.processor.limit=20000
Max # of queued objects for each socket connection. Connection is disabled and objects will be dropped when the limit is reached. - property server.pipe.delivery.flowpct=60
Related to the server.pipe.processor.limit property. The percentage at which the connection is re-enabled after reaching 100% capacity.
Services
- property server.services.facts.expire=0
Default fact expiration for all services. 0 is expiration disabled. This property should only be used to enable server wide expiration for all deployed services.
Security
- property server.security.algorithm=DSA
Security algorithm for key generation. Do not change once user accounts are created. - property server.security.provider=Sun
Security provider name. Do not change once user accounts are created. - property server.security.token.expiry=10000
Security session token expiration in MS. - property server.security.storage.provider=com.nastel.nfc.security.SecurityBoard
Security profile storage provider. Java implementation of the security account storage and retrieval. Do not change. - property server.security.password.length=5
Minimum password length. - property server.umask=Base/Control Base/Read Base/Change Base/Execute, Base/Read
Default user permission mask. Applied for every new user account created.
Domain Server
- property server.domain=DOMAIN
Logical name of the domain serviced by the domain server. - property server.naming.url.port=2325
TCP port for the domain server directory service. - property java.naming.provider.url=bbns://localhost:port
Directory server URL path, where port should equal to the value of server.naming.url.port. - property domain.server.name=DOMAIN_SERVER
Name of the domain server as registered in the directory service - property java.naming.failover.url=bbns://failover-server:port
The failover domain server location. Un-comment and edit this line to enable domain server failover. The port should equal to the value of alternate server.naming.url.port. - property installation.update.folder=ds://software
The URL location of all AutoPilot software for distribution to all AutoPilot installations. ds:// equals the root directory defined in business.view.dir or file.system.root properties. - property business.view.dir=./policies
The root folder where all policies and shared documents are maintained. The root is logically referenced by the ds:// URL qualifier. This property is deprecated and replaced by file.system.root. - property file.system.root=./policies
The root folder where all policies and shared documents are maintained. The root is logically referenced by the ds:// URL qualifier.
Server
- server.process.timeout=10000
Process timeout in MS. Allow only given time for each user action to complete before timeout occurs. This value applies only os native OS commands such as executable and scripts launched from business views. - property server.work.dir=<aphome/>naming
Read only. Working directory of the running server. - property server.user.url.port=3005
TCP port for server to server communication. - property server.aip.port=8889
Application Intercommunication Protocol (AIP) TCP port for external apps. This port is used by the meshIQ Workgroup server to authenticate users. Replaces the server.pcf.gateway.port property. - property server.aip.trace=false
AIP protocol trace mode. All messages incoming and outgoing AIP messages will be printed to console. - property server.log.dir=<aphome>/logs
Directory where all logs are being written (.EVT and .log files). - property server.import.dir=<workdir>/import
Service registry import directory. - property server.snmp.mibs=<aphome>/mibs
Location of all SNMP mibs. - property server.template.dir=<aphome>/templates
Location of service templates. - property server.debug=false
Server wide debug mode for extra information. - property server.sampling.rate=30000
Sampling rate for server wide statistics for <SERVER>_Facts expert. - property server.auto.gc.memory.usage=0.82
Force GC (garbage collection) when memory utilization hits a specified number. - property server.auto.gc.timeout=600000
Minimum time before auto garbage collection cycles. - property server.facts.capacity=10000
Configure the server for the specified number of expected facts. - property server.topic.request.limit=10000
Server topic request limit. Maximum number of outstanding requests for a topic. - property server.topic.cache.size=1101
Topic cache size. - property server.publish.force=false
Force publishing a bypass duplicate check. It is not recommended to set to true, it decreases performance. - property server.facts.history.maxsize=0
Server wide history size for all collected facts. - property server.facts.expire=0
Server wide fact expiration in MS. - property server.facts.expiration=false
Enable/disable fact expiration for all services. - property server.facts.log.incr=false
Enable only incremental logging for facts when logging is enabled (those that are added). - property server.service.facts.logging=false
Enable fact logging for all services that have the Logging\Record Fact option enabled. - property server.facts.expiry.rate=60000
Rate at which expiration of facts is checked. Lowering the value decreases performance. - property server.facts.expiry.debug=false
Enable/disable fact expiry debug trace. - property server.registry.backups=5
Maximum number of backups for registry files. - property server.auto.save.timeout=3000
Force auto save after registry change within the specified ms. - property server.system.facts.expire=0
Set expiration for system facts in MS. 0 is recommended. - property server.max.stdout.size=500000
Max log size in bytes for stdout and stderr output. - property java.awt.headless=true
UNIX only, enable AWT headless mode to prevent AWT/X11 related activity for server applications, which can generate exceptions at run-time.
Grid
- property server.grid.folder=<aphome>/naming/grid
Location of grid definitions. - property server.grid.vote.sample=120000
Wait interval before selecting the primary grid server. - property server.grid.vote.delay=15000
Wait before voting on a primary after primary failed. - property server.grid.dynamic.services=false
All services in the grid are dynamic - non persistent. They are removed from the directory when the hosting server is not available.
JDBC Properties
- Oracle JDBC properties:
property server.jdbc.oracle.driver=oracle.jdbc.driver.OracleDriver
property server.jdbc.oracle.url=jdbc:oracle:thin:@ - SQL Server JDBC properties:
property server.jdbc.sqlserver.driver=net.sourceforge.jtds.jdbc.Driver
property server.jdbc.sqlserver.url=jdbc:jtds:sqlserver:// - Sybase JDBC properties:
property server.jdbc.sybase.driver=net.sourceforge.jtds.jdbc.Driver
property server.jdbc.sybase.url=jdbc:jtds:sybase:// - DB2 UDB JDBC properties:
property server.jdbc.db2.driver=COM.ibm.db2.jdbc.net.DB2Driver
property server.jdbc.db2.url=jdbc:db2:// - HyperSonic SQL JDBC properties:
property server.jdbc.hypersonicsql.driver=org.hsql.jdbcDriver
property server.jdbc.hypersonicsql.url=jdbc:HypersonicSQL:hsql:// - Generic JDBC/ODBC properties:
property server.jdbc.odbc.driver=sun.jdbc.odbc.JdbcOdbcDriver
property server.jdbc.odbc.url=jdbc:odbc: - Informix JDBC properties:
property server.jdbc.informix.driver=com.informix.jdbc.IfxDriver
property server.jdbc.informix.url=jdbc:informix-sqli:// - MySQL JDBC properties:
property server.jdbc.mysql.driver=com.mysql.jdbc.Driver
property server.jdbc.mqsql.url=jdbc:mysql:// - Derby SQL JDBC properties:
property server.jdbc.derby.driver=com.ibm.db2.jcc.DB2Driver
property server.jdbc.derby.url=jdbc:derby:net://