By editing the AMServer.Properties file (available under <Applications Manager Home>/conf), users can change the default server settings used in ManageEngine Applications Manager. Under the Settings tab, click on Server Settings under Product Settings. Here is a list of keys that can be configured from the UI:
Key | Description |
---|---|
am.webserver.port | This is the web server port used by Applications Manager to connect to the browser. |
am.ssl.port | Keys to enable SSL (https) and this will be enabled by default. |
am.dbserver.type | Backend database type. Possible values : pgsql, mysql, mssql. If key not present, it will use mysql backend. |
am.db.port / am.mysql.port | Port used by the database. am.mysql.port was used before 11. |
am.enablehttp.port | Enables HTTP access to the server when set to true (default) and allows both HTTP and HTTPS connections. |
am.server.agent.ssl.port | The server agent communication port (Default value: 10099). |
am.disable.server.agent.port | Used to disable/enable the server agent communication port (True: the port is disabled; False: the port is open for communication). |
am.tomcat.shutdown.port | Tomcat ports for Applications Manager. If any of these ports is occupied when Applications Manager starts, it will be changed automatically. In builds before 11, am.tomcat.shutdown.port will not change automatically even if it is occupied and it has to be changed manually |
am.webcontainer.port | |
am.rmiregistry.port | |
am.shutdown.port | |
am.traplistener.port | Port in which Applications Manager will listen and receive traps from other device |
am.createSupportZipFile | Key for zipping of support file. Not used by Applications Manager. Only used by IT360 |
am.sslprotocols.enabletlsv1 | Enables support for the TLSv1 protocol when set to true. |
am.dbport.check | While starting up, Applications Manager will check if the DB port mentioned in am.db.port / am.mysql.port is already occupied. If the ports are occupied, it will automatically change am.db.port / am.mysql.port to next unoccupied port and start DB server in that port. This will be done for mysql and pgsql backend. By default these key(s) are true. If customer is using his own pgsql / mysql, these key(s) needs to be set to false. am.mysqlport.check was used before 11 |
am.webserverport.check | While starting up, Applications Manager will check if the web server port mentioned in am.webserver.port is already occupied. If the ports are occupied, it will alert user and shutdown Applications Manager. |
am.sockettest.timeout | Socket test timeout value (in seconds) used by various monitors like MySQL, MsSQL, DB2, JBoss, Oracle, Service monitor etc. This value can be also changed using the Availability Check: Timeout value option under Settings tab > Availability Settings. By default, actual timeout value is 60 seconds.
Note:
|
am.server.language | These keys determine the language and country of Applications Manager. Default values of language / country keys are am.server.language=en and am.server.country=US. Possible values of language / country keys are : English ( en / US ), Chinese ( zh / CN ), German ( de / DE ), Spanish ( es / ES ), French ( fr / FR ), Hungarian ( hu / HU ), Japanese ( ja / jp ), Korean ( ko / KR ), Taiwanese ( zh / TW ), Vietnamese ( vi / VN ) |
am.server.country | |
am.server.type | Key to see if its Professional edition / Enterprise Edition. Possible values are : NORM, AAM, MAS |
am.edition.type | |
am.adminserver.host | For Enterprise Edition Probe server this will have the host name of Central server |
am.adminserver.port | For Enterprise Edition Probe server this will have the SSL port of Central server |
am.server.startresidrange | The resourceid range for this Applications Manager. For Enterprise Edition this will be in range according to serverid. |
am.failover.preferredstandby | |
am.ntlm.hostname | Fully qualified Hostname of Applications Manager is required for monitoring URLs with windows NTLM authentication. If this field does not have FQHN, we need to update it manually for proper URL NTLM monitoring |
am.ntlm.hostdomainname | This has the domain name of Applications Manager server which is required for monitoring URLs with windows NTLM authentication. |
am.adminpollstry.count | For Enterprise Edition, Central server will report that probe server is down according to polls to try set in this key. By default value is 1. |
am.appmanager.hostname | Hostname of Applications Manager which is used in alert mail, alarm escalation mail, report mails sent by Applications Manager. |
am.external.hostname | If Applications Manager is in DMZ or behind firewall and has an Internal and External Hostname/IP, we can set External hostname / Ip here so that when users access JRE Thread dumps, MySQL and Ingres Process list. |
am.log.dir | Key for changing location of logs directory. Not used by Applications Manager. Only used by IT360 |
am.scheduleReports.enableSSL | |
am.user.resource.enabled | |
am.sso.enabled | |
am.wmi.encoding | Encoding to be used for parsing vbscripts output in WMI mode |
Option | Description |
---|---|
Maximum Subgroup level | The number of subgroup levels that can be created within a monitor group. The maximum number allowed is 25. |
Raw data cleanuptime (hours) * | The time period (in hours) of raw data stored in the database for all non-conf monitor's attributes can be changed by using this key. The maximum time period allowed to retain the raw data is 24 hours. |
Non-server monitor data cleanup interval (days) | To change the clean interval of data stored for monitors like Memcached, Amazon, Cassandra, Oracle, DNS Monitor, Database Query Monitor, Exchange Server, GlassFish etc., this key value is changed. |
Starting day of weekly MonitorGroup outage comparison report | For the outage comparison week report, the week starts from Sunday. |
OutOfMemoryException duration (mins) | If 30 (am.oomexception.count) out of memory error occurs in less than 30 minutes (am.oomexception.duration), Applications Manager will restart. |
OutOfMemoryException count | Number of times a retry is attempted before restarting Applications Manager when an OutOfMemoryException occurs. |
Maximum threads for scheduler * | Specifies the maximum number of threads allowed for scheduler tasks. The limit is set to 200 threads. |
Generate heap dump when free JVM memory goes below (MB) | If free JVM memory is less than 20 MB, a heap dump for Applications Manager is generated. |
Debug-Info directory size limit (MB) | The old files in the Debug-Info directory are cleared, once the limit reaches 80% of this key value. The maximum allowable size is 512 MB. |
Command length in Execute program action | Changing this key value increases the command size limit for the execute program action, which is set to 400 characters by default. The maximum allowable size is now 1000 characters. |
Audit Tables Cleanup Interval (in months) | Specifies the time period (in months) after which older entries in the audit table are automatically deleted to optimize database performance and manage storage. |
Audit Table Size (in rows) | The maximum number of rows allowed in the audit table to manage database performance and storage. |
Maximum row count for Query tool and Custom query report | The maximum number of rows to be fetched as a result in Query tool and Custom query report. |
Maximum allowed polling interval (in days) | The maximum polling interval allowed in days. |
Enable Subgroups view | When enabled, displays subgroups in Alarms, Reports and New Monitor page's Monitor Group. |
Enable Subgroups in SLA view | Lists sub groups in SLA page, if enabled along with 'Enable subgroups view'. |
Send mail on datacollection failure | Central receives email,if data collection for monitor(s) doesn't occur for more than an hour or if there are out Of memory errors or if data collection stops for 50% of monitors. |
Disable data cleanup in business hours | Enabling this key ,ensures that data cleanup doesn't happen between 8:00 am to 6:00 pm. |
Open browser on Startup * | When enabled, the browser automatically opens when Applications Manager starts. |
Perform data collection in fixed polling interval * | Schedule Data Collection for the CONF monitors, Custom Monitor Types on the given polling interval. |
View Sub Groups in Monitor Group Widget | When enabled, the widget displays the subgroups present within a monitor group, providing better visibility into the group's hierarchy and structure. |
View Monitor Groups as Status Lights in Business View (Deprecated View) | When enabled, monitor groups will be shown as status light indicators in the legacy Business View layout, providing a quick overview of their health status. |
Enable weekly stray entries cleanup | When enabled, it cleans up stray entries on Saturdays whenever Applications Manager is restarted. After the first cleanup is done, subsequent cleanups will take place on first Saturday of every month. |
Enable weekly stray entries cleanup | When enabled, stray entries from archive tables gets cleaned up on Saturday of every month at 11 PM. |
Maximum threads for scheduler | The maximum number of threads allowed for a Scheduler Task (Only available in the Enterprise Edition). |
Maximum polling load factor to add monitor | Specifies the maximum allowable polling load factor on the Probe server when adding a new monitor (Only available in the Enterprise Edition). |
Probe server maximum monitor count | The maximum number of monitors allowed per Probe server (Only available in the Enterprise Edition). |
Note: Log clean-up in Applications Manager is an automatic process and logs are cleared without any changes in settings. To make changes in clean-up intervals refer to the table above and specify necessary values to the appropriate fields.
Following are the list of options that are shown under Availability Settings. To enable/disable, click on the Edit icon, select/deselect the option and click on Save.
Option | Description |
---|---|
Alert on Ping response changes when the server is down | When enabled, it appends the ping response to the RCA when the server is down for every successive ping response changes. When disabled, appends the ping response to the RCA only once when the server is down and not for every successive ping response changes. |
Enable NativePing | Enables Native Ping to determine server monitor availability. |
Enable PortTest | Enables port test for server monitoring. |
Ports to test | Ports mentioned here will be used for port test. |
Ping / Port test timeout | Timeout value for ping and ports test (in seconds). |
Ping retries | The number of retries to execute the ping command in case of failure to check the availability of server. |
Application Server timeout | Tomcat, Apache, PHP, WebSphere monitor's connection time out value (in mins). |
Option | Description |
---|---|
Main Thread * | This thread is used for the JMX/SNMP Dashboard and Schedule Reports. |
URLMonitor Thread * | Monitors like HTTP(s) URLs,HTTP(s)-URL Sequence,SAP-CCMS use this thread for data collection. |
KeyValueMonitor Thread* | Monitors like Active Directory Amazon,Cassandra,Ceph Storage,DNS Monitor,Database Query Monitor,Exchange Server,Script Monitor etc. uses this thread for data collection. |
MQSeriesMonitor Thread * | IBM Websphere MQ monitor uses this thread for data collection |
DataCollection Thread * | This thread is used for data collection of monitors like AIX,AS400/iSeries,Apache Server,DB2,FreeBSD / OpenBSD,HP-UX / Tru64 UNIX,IIS Server etc. |
CustomMonitor Thread * | This thread used for data collection of Custom Attributes for monitors like RMI,WEBLOGIC-server,JBOSS-server,WebSphere-server,JMX1.2-MX4J-RMI. |
Web Services Monitor Thread * | This thread is used for WebServices. |
DB Query Monitor Thread * | This thread is used by the DB Query Monitor for data collection. |
Prometheus Monitor Data Collection Thread * | The monitors discovered via Prometheus Discovery will use this thread for data collection. |
Option | Description |
---|---|
No. of Database Connections * | This key is used to configure the no.of non transaction connections to be established with the database. |
Option | Description |
---|---|
Maximum Metaspace Size (MB) * | Maximum Metaspace size allocated for Applications Manager. |
Maximum Java Heap Size (MB) * | Maximum memory allocated for Applications Manager. |
Note: The * symbol indicates that any changes made will only take effect after restart of Applications Manager.
Users can choose which types of secondary-level monitors should be available for association with monitor groups. To do this, select the checkbox for each desired type and click Save.
By selecting the Associate Virtual IP Address for Failover option, users can configure a Virtual IP address for failover. The following details must be specified when this option is enabled:
Note: Refer to this help page for a step-by-step guide on how to configure Virtual IP address for Failover.
Apart from the keys specified in the AMServer.properties and <Applications Manager Home>/conf files, some of the keys have been moved to the database (AM_ServerConfig) and can be configured only by enabling/disabling the respective keys in that database. To find out whether the required key is shown/hidden from the UI, navigate to Settings → Support → Database Summary → Query Tool and execute the command: SELECT * FROM AM_ServerConfig;. Then search for the required key and check the value displayed under SHOWKEYINUI column. If the value shown is f, then the key is hidden from the UI.
Following are the list of keys that are moved to the AM_ServerConfig database:
Key | Option to configure in GUI |
---|---|
am.host.deleteDisk |
Settings → Performance Polling → Servers |
am.cli.telnet.passwordprompt | |
am.cli.telnet.loginprompt | |
am.cli.bulkcmd.exec.responsetimeout | |
am.server.cli.match.category.index | |
am.server.command.responsetimeout | |
am.cli.command.bulk.execute | |
am.cli.loginprefix | |
am.cliSession.caching | |
am.disks.ignore | |
am.spacecheck.warning | |
am.telnet.loginTimeOut | |
am.wmi.encoding | |
am.server.windows.resend.vbscripts | |
am.rawdata.enabled | |
am.rawdata.value | |
am.processinstance.equals | |
am.nosql.rediscover.interval | Settings → Performance Polling → Database Servers |
am.mssql.deleteJobs | |
am.htmldata.mysql.daystoretain | |
am.pingtest.command | Settings → Performance Polling → Ping Monitor |
am.repoll.interval | Settings → Performance Polling → HTTP(s) URLs |
am.cam.mbeanslistsize | Settings → Performance Polling → Optimize Data Collection → JMX Application |
am.dirsize.unit | Settings → Performance Polling → Optimize Data Collection → File/Directory Monitor |
am.filesize.unit | |
am.file.contentcheckcount | |
am.ftp.filesize | Settings → Performance Polling → Optimize Data Collection → FTP/SFTP Monitor |
am.htmldata.jre.daystoretain | Settings → Performance Polling → Optimize Data Collection → JavaRuntime Monitor |
am.mqseries.ccsid | Settings → Performance Polling → Optimize Data Collection → WebSphere Server |
am.mqdelrow.enabled | |
am.script.deleterow | Settings → Performance Polling → Optimize Data Collection → Script Monitor |
am.querymonitor.rowcount | Settings → Performance Polling → Optimize Data Collection → Database Query Monitor |
am.query.timeout | |
am.vsphere.connection.timeout | Settings → Performance Polling → Optimize Data Collection → VMware ESX/ESXi Monitor |
am.vsphere.read.timeout | |
am.xen.resourcepool.discovery.enable | Settings → Performance Polling → Optimize Data Collection → XenServer |
am.ssl.enabled |
Settings → Server Setting → General Settings |
am.subgroups.enabled | |
am.slasubgroups.enabled | |
am.senddcstoppedmail.enabled | |
am.detailview.show (Professional Edition and Enterprise Edition Probe Servers) # | |
am.server.deleteMonitor.comparing.csvToCmdb # | |
am.server.defaultDiscovery.enabled # | |
am.upload.enabled | |
am.userresource.onLogin.update # | |
am.admin.mgstatusview.enabled | |
am.querytracker.enable # | |
am.simple.theme.enabled # | |
am.startmonthread.enabled # | |
am.standalonesdp.enabled | |
am.cleanup.nonbusinesshours | |
am.adminserver.deletesql | |
am.sendmonerrormail.enabled | |
am.browser.startup | |
am.dbconnection.refresh # | |
am.useresource.operations.concurrent.update # | |
cmdb.xml.path | |
am.api.response.timeout | |
am.triggerheapdump.freememorymbst | |
am.mas.polling.max.loadfactor | |
am.mas.database.max.loadfactor | |
am.executeaction.size | |
am.errorpoll.count | |
am.report.weekStartDay | |
am.userResUpdateThread.schedule.interval # | |
am.subgrouplevels.count | |
am.html.dirsize | |
am.server.maximum.thread.schedulerTask (Requires restart of Applications Manager) | |
am.oomexception.duration | |
am.oomexception.count | |
am.confdata.cleanupinterval | |
am.rawdata.cleanuptime | |
am.enablenativeping |
Settings → Server Settings → Availability Settings |
am.porttestenabled | |
am.portstotest | |
am.tomcattimeout | |
am.porttest.timeout.seconds | |
am.ping.retries |
# Keys are hidden from the UI and can be displayed only by enabling in DB.
Thank you for your feedback!