Enterprise Manager - Instance Manager

Centrally manage individual ColdFusion server instances in enterprise deployments

Overview

The Instance Manager in ColdFusion Enterprise Manager lets you create local ColdFusion server instances, register remote instances, and start, stop, restart, or delete them from a single interface. Registered instances can then be grouped into clusters in the Cluster Manager.

This feature is available in ColdFusion Enterprise Edition (and in Trial and Developer editions) with the Server configuration. ColdFusion Standard does not support multiple instances. Add New Instance asks for a server name, a server directory, and optionally Create Windows Service.

Instance Creation

Configure and deploy new ColdFusion server instances.

Instance Name

PurposeUnique identifier for the server instance
RequirementsMust be unique on the host server
RecommendationUse descriptive names indicating purpose and environment (e.g., prodapi01, devweb02)
Best Practice: Establish a consistent naming convention across your organization. Include environment, purpose, and sequence number for clarity (e.g., prodapp01, stagingapi02).

HTTP Port

PurposePort for HTTP connections to the instance's built-in web server
DefaultSelected by Instance Manager when the instance is created (the cfusion instance's built-in server uses 8500). Change it later with the instance's Edit icon.
RecommendationUse sequential ports for multiple instances (8500, 8501, 8502, etc.)
ProductionUse external web server (IIS, Apache, Nginx) instead of built-in web server
Security: The built-in web server is suitable for development only. Production deployments should use enterprise web servers with proper SSL/TLS configuration.

JVM Settings (After Creation)

PurposeThe Add New Instance form has no JVM field. Set JVM arguments after creation in the new instance's Administrator (Server Settings > Java and JVM) or its bin/jvm.config
Common Args-Xms2048m -Xmx4096m (heap size), -XX:MaxMetaspaceSize=512m
RecommendationConfigure based on application memory requirements and available RAM
Memory Configuration Best Practices:
  • Set initial heap (-Xms) equal to maximum heap (-Xmx) to prevent resize overhead
  • Allocate 50-75% of server RAM to JVM heap (leave room for OS and other processes)
  • Monitor garbage collection and adjust based on application behavior
  • Choose garbage collector flags for the JDK your ColdFusion release runs on (ColdFusion 2025 uses JDK 21). Adobe states that ColdFusion uses the parallel GC by default, even though G1 is the JDK 21 default on most hardware, so set -XX:+UseG1GC explicitly if you want G1; consider ZGC (-XX:+UseZGC) when you need low pause times, since its pause times do not grow with heap size. Sources: Oracle: Available Collectors, Oracle: The Z Garbage Collector

Instance Directory

PurposeFile system location for instance configuration, logs, and runtime files
DefaultThe Administrator appends the instance name to the existing server directory location, giving a directory alongside cfusion (for example {CF_ROOT}/{instance_name})
RecommendationUse default location unless disk space or performance requirements dictate otherwise
Storage Considerations: Ensure sufficient disk space for logs, temporary files, and cache data. Monitor disk usage regularly and implement log rotation.

Load Balancing Factor

Each instance has a load balancing factor, edited with the instance's Edit icon in Instance Manager. It applies only when the instance is part of a cluster. In Adobe's example, an instance with factor 2 receives twice as many requests as an instance with factor 1.

Instance Lifecycle Management

Control instance states and manage running instances.

Start Instance

Purpose
Launch the ColdFusion instance and make it available for requests
Startup Time
Typically 30-90 seconds depending on applications and configurations
Verification
Check instance status in Enterprise Manager or access administrator URL

Monitor logs during startup to identify initialization issues or slow-loading applications.

Stop Instance

Purpose
Gracefully shutdown the instance
Shutdown Time
Allow active requests to finish before stopping
Best Practice
Remove from load balancer before stopping to avoid user disruption

Always stop instances gracefully rather than force-killing to prevent data corruption.

Restart Instance

Purpose
Stop and start instance to apply configuration changes
When Required
JVM changes, certain administrator settings, application updates
Best Practice
Schedule restarts during maintenance windows

Some settings take effect immediately; others require restart. Check documentation for specific settings.

Delete Instance

Purpose
Permanently remove instance and its configuration
Warning
Cannot be undone. Running servers cannot be deleted, so stop the instance first; the cfusion instance itself cannot be deleted.
Before Deleting
Back up configuration, logs, and any custom files

Remove instance from clusters and load balancers before deletion to prevent routing errors.

Instance Registration

Register Remote Instance

PurposeAdd an instance running on another server so it can join a cluster
FieldsInstance name, remote host, remote port (the AJP port), HTTP port, JVM route, and load balancing factor. Ports and JVM route come from the remote instance's runtime/conf/server.xml. The JVM route must differ from every other instance in the same cluster.
Optional FieldsAdmin Component port (default 8985), username, and password, for remote start and stop over HTTP. Requires the admin component installed on the remote host.
Security: Restrict the remote (AJP) and Admin Component ports to trusted hosts with firewall rules.

Configuration and Monitoring

Instance Manager lists instances and lets you create, register, start, stop, restart, and delete them. It does not push datasources, mail servers, mappings, or security settings to other instances, and it does not collect performance metrics. To keep configuration consistent across instances, export and import Administrator settings with cfsetup or script them with the Administrator API. CAR (ColdFusion Archive) migration is deprecated in ColdFusion 2025; Adobe names cfsetup as the alternative. For CPU, memory, and request metrics, use the Performance Monitoring Toolset (PMT).

Common Issues & Solutions

Instance Won't Start

Symptom: Instance fails to start or shows error state in Enterprise Manager
Solutions:
  • Check instance logs for error messages (coldfusion-out.log, coldfusion-error.log)
  • Verify HTTP port is not already in use by another process
  • Ensure sufficient disk space for temporary files and logs
  • Check JVM memory settings are appropriate for available RAM
  • Verify file permissions on instance directory
  • Review recent configuration changes that may have caused issue

Cannot Connect to Remote Instance

Symptom: Enterprise Manager unable to register or communicate with remote instance
Solutions:
  • Verify network connectivity between Enterprise Manager and remote instance
  • Check firewall rules allow the remote instance's AJP (remote) port and HTTP port, plus the Admin Component port (default 8985) if you use it
  • Confirm remote instance is running and accessible
  • Confirm the remote port, HTTP port, and JVM route match the remote instance's server.xml
  • Check for network proxy or NAT issues

Related Resources

Enterprise Manager - Instance Manager | ColdFusion Administrator | CFGuide