User Guide Cancel

Use multiple server instances

  1. ColdFusion User Guide
  2. Introduction to ColdFusion
    1. About Adobe ColdFusion
    2. Download Adobe ColdFusion
    3. What's new in ColdFusion (2023 release)
    4. ColdFusion (2023 release) Release Notes
    5. Deprecated Features
    6. REST enhancements in ColdFusion
    7. Central Configuration Server
    8. Server Auto-Lockdown
    9. Asynchronous programming
    10. Docker images for ColdFusion
    11. SAML in ColdFusion
    12. JSON Web Tokens in ColdFusion
    13. Use SAML and LDAP in Admin
  3. Cloud Services in ColdFusion
    1. ColdFusion and GCP Storage
    2. ColdFusion and GCP Firestore
    3. ColdFusion and GCP PubSub
    4. ColdFusion and Amazon S3
    5. ColdFusion and DynamoDB
    6. ColdFusion and Amazon SQS
    7. ColdFusion and Amazon SNS
    8. ColdFusion and MongoDB
    9. ColdFusion and Azure Blob
    10. ColdFusion and Azure Service Bus
    11. Multi-cloud storage services
    12. Multi-cloud RDS databases
    13. ColdFusion and Azure Cosmos DB
  4. Install ColdFusion
    1. Install the server configuration
    2. Install ColdFusion- Zip Installer
    3. Install ColdFusion- GUI Installer
    4. CFSetup configuration tool
    5. ColdFusion Licensing and Activation
    6. ColdFusion server profiles
    7. Prepare to install ColdFusion
    8. Install the JEE configuration
    9. Install ColdFusion Express
    10. Install integrated technologies
    11. Configure your system
    12. Troubleshoot installation issues
    13. Install ColdFusion silently
    14. Install Adobe ColdFusion (2016 release) hotfix
    15. ColdFusion (2018 release) - Install JEE configuration
  5. Use ColdFusion
    1. GraphQL in ColdFusion
    2. Command Line Interface (CLI)
    3. External session storage
    4. Generate Swagger documents
    5. Language enhancements
    6. NTLM support
    7. Enhanced PDF in ColdFusion
    8. Security enhancements in ColdFusion (2016 release)
  6. Performance Monitoring Toolset
    1. Overview of ColdFusion Performance Monitoring Toolset
    2. Auto-discovery of ColdFusion nodes and clusters
    3. Code profiler in ColdFusion Performance Monitoring Toolset
    4. Configure ColdFusion Performance Monitoring Toolset settings
    5. Install ColdFusion Performance Monitoring Toolset
    6. View cloud metrics
    7. Monitor GraphQL in Performance Monitoring Toolset
    8. Configure TLS/SSL and Authentication for Elasticsearch 8.x  in Performance Monitoring Toolset
    9. View cluster and node metrics
    10. View data source metrics
    11. View external services
    12. View incoming services
    13. View list of sites and busy connections
    14. View topology of sites
    15. Datastore Health Monitoring
    16. Performance Monitoring Toolset Update 1
    17. Secure Performance Monitoring Toolset with HTTPS/SSL
    18. Performance Monitoring Toolset deployment guide
  7. Adobe ColdFusion Builder extension for Visual Studio Code
    1. Getting started with Adobe ColdFusion Builder extension for Visual Studio Code
    2. Add a ColdFusion server
    3. Project Manager
    4. Work with ColdFusion code
    5. Profile preferences
    6. Debug applications
    7. Refactoring
    8. Services Browser
    9. RDS support
    10. PMT Code Profiler integration
    11. Security Analyzer report integration
    12. Known issues in this release
  8. Use ColdFusion Builder
    1. About ColdFusion Builder
    2. System requirements | ColdFusion Builder
    3. Install ColdFusion Builder
    4. Edit code in ColdFusion Builder
    5. Manage servers in ColdFusion Builder
    6. Manage projects in ColdFusion Builder
    7. What's new in Adobe ColdFusion Builder (2018 release)
    8. Frequently Asked Questions (FAQ) | Adobe ColdFusion Builder (2018 release)
    9. Debug applications in ColdFusion Builder
    10. ColdFusion Builder workbench
    11. ColdFusion Builder extensions
    12. Debugging Perspective in ColdFusion Builder
    13. Build mobile applications using ColdFusion Builder
    14. Bundled ColdFusion Server
    15. Debug mobile applications in ColdFusion Builder
    16. Use extensions in ColdFusion Builder
  9. Coldfusion API Manager
    1. Overview of Adobe ColdFusion API Manager
    2. Features in ColdFusion API Manager
    3. Get started with ColdFusion API Manager
    4. Install ColdFusion API Manager
    5. Authentication types
    6. Create and publish APIs
    7. Administrator
    8. Subscriber
    9. Throttling and rate limiting
    10. Notifications
    11. Connectors
    12. Set up cluster support
    13. Integrate ColdFusion and API Manager
    14. Metrics and Logging in API Manager
    15. Generate Swagger documents
    16. Configure SSL
    17. Known issues in this release
    18. Policies in ColdFusion API Manager
    19. Create a Redis cluster
    20. Multitenancy in API Manager
    21. Docker images for ColdFusion API Manager
  10. Configure and administer ColdFusion
    1. Administer ColdFusion
    2. Use the ColdFusion administrator
    3. Data Source Management for ColdFusion
    4. Connect to web servers
    5. Deploy ColdFusion applications
    6. Administer ColdFusion security
    7. Basic Troubleshooting and FAQs
    8. Work with Server Manager
    9. Use multiple server instances
    10. WebSocket Enhancements (ColdFusion 11)
    11. Security Enhancements (ColdFusion 11)
    12. Work with Server Monitor
    13. ColdFusion Administrator API Reference
  11. CFML Reference
    1. Introduction to CFML Reference
      1. New functions in ColdFusion (2018 release)
      2. New and changed functions/tags in Adobe ColdFusion (2016 release)
      3. Script supported tags and functions
      4. New and changed tags/functions in ColdFusion 11
    2. Reserved words and variables
      1. Reserved words and variables
      2. Reserved words
      3. Scope-specific built-in variables
      4. Custom tag variables
      5. ColdFusion tag-specific variables
      6. CGI environment (CGI Scope) variables
    3. ColdFusion tags
      1. ColdFusion tags
      2. Tags in ColdFusion 10
      3. Tag summary
      4. Tags by function
      5. Tag changes since ColdFusion 5
      6. Tags a-b
      7. Tags c
      8. Tags d-e
      9. Tags f
      10. Tags g-h
      11. Tags i
      12. Tags j-l
      13. Tags m-o
      14. Tags p-q
      15. Tags r-s
      16. Tags t
      17. Tags u-z
    4. ColdFusion functions
      1. ColdFusion functions
      2. New functions in ColdFusion 10
      3. ColdFusion functions by category
      4. Function changes since ColdFusion 5
      5. Functions a-b
      6. Functions c-d
      7. Functions e-g
      8. Functions h-im
      9. Functions in-k
      10. Functions l
      11. Functions m-r
      12. Functions s
      13. Functions t-z
      14. BooleanFormat
    5. Ajax JavaScript functions
      1. Ajax JavaScript functions
      2. Function summary Ajax
      3. ColdFusion.Ajax.submitForm
      4. ColdFusion.Autosuggest.getAutosuggestObject
      5. ColdFusion.Layout.enableSourceBind
      6. ColdFusion.MessageBox.getMessageBoxObject
      7. ColdFusion.ProgressBar.getProgressBarObject
      8. ColdFusion.MessageBox.isMessageBoxDefined
      9. JavaScriptFunctionsinColdFusion9Update1
    6. ColdFusion ActionScript functions
      1. ColdFusion ActionScript functions
      2. CF.http
      3. CF.query
    7. ColdFusion mobile functions
      1. ColdFusion Mobile Functions
      2. Accelerometer Functions
      3. Camera Functions
      4. Connection Functions
      5. Contact Functions
      6. Event Functions
      7. File System Functions
      8. Geolocation Functions
      9. Media and Capture Functions
      10. Notification Functions
      11. Splash Screen Functions
      12. Storage Functions
    8. Application.cfc reference
      1. Application.CFC reference
      2. Application variables
      3. Method summary
      4. onAbort
      5. onApplicationEnd
      6. onApplicationStart
      7. onMissingTemplate
      8. onCFCRequest
      9. onError
      10. onRequestEnd
      11. onRequest
      12. onRequestStart
      13. onServerStart
      14. onSessionEnd
      15. onSessionStart
    9. Script functions implemented as CFCs
      1. Script Functions Implemented as CFCs
      2. Accessing the functions
      3. Function summary
      4. ftp
      5. http
      6. mail
      7. pdf
      8. query
      9. Script functions implemented as CFCs in ColdFusion 9 Update 1
      10. storedproc
    10. ColdFusion Flash Form style reference
      1. Styles valid for all controls
      2. Styles for cfform
      3. Styles for cfformgroup with horizontal or vertical type attributes
      4. Styles for box-style cfformgroup elements
      5. Styles for cfformgroup with accordion type attribute
      6. Styles for cfformgroup with tabnavigator type attribute
      7. Styles for cfformitem with hrule or vrule type attributes
      8. Styles for cfinput with radio, checkbox, button, image, or submit type attributes
      9. Styles for cftextarea tag and cfinput with text, password, or hidden type attributes
      10. Styles for cfselect with size attribute value of 1
      11. Styles for cfselect with size attribute value greater than 1
      12. Styles for cfcalendar tag and cfinput with dateField type attribute
      13. Styles for the cfgrid tag
      14. Styles for the cftree tag
      15. ColdFusion Flash Form Style Reference
    11. ColdFusion event gateway reference
      1. ColdFusion Event Gateway reference
      2. addEvent
      3. CFEvent
      4. CFEventclass
      5. Constructor
      6. Gateway development interfaces and classes
      7. getStatus
      8. setCFCPath
      9. setCFCMethod
      10. getOriginatorID
      11. getLogger
      12. getBuddyList
      13. getBuddyInfo
      14. IM gateway message sending commands
      15. IM Gateway GatewayHelper class methods
      16. onIncomingMessage
      17. onIMServerMessage
      18. onBuddyStatus
      19. onAddBuddyResponse
      20. onAddBuddyRequest
      21. IM Gateway CFC incoming message methods
      22. IM gateway methods and commands
      23. CFML CFEvent structure
      24. warn
      25. info
      26. setOriginatorID
      27. data command
      28. submit Multi command
      29. submit command
      30. setGatewayType
      31. setGatewayID
      32. setData
      33. setCFCListeners
      34. outgoingMessage
      35. getStatusTimeStamp
      36. numberOfMessagesReceived
      37. numberOfMessagesSent
      38. removeBuddy
      39. removeDeny
      40. removePermit
      41. setNickName
      42. setPermitMode
      43. setStatus
      44. SMS Gateway CFEvent structure and commands
      45. SMS Gateway incoming message CFEvent structure
      46. getStatusAsString
      47. getProtocolName
      48. getPermitMode
      49. getPermitList
      50. getNickName
      51. getName
      52. getDenyList
      53. getCustomAwayMessage
      54. getQueueSize
      55. getMaxQueueSize
      56. getHelper
      57. getGatewayType
      58. getGatewayServices
      59. getGatewayID_1
      60. getGatewayID
      61. getData
      62. getCFCTimeout
      63. setCFCTimeout
      64. getCFCPath
      65. getCFCMethod
      66. GatewayServices class
      67. Gateway interface
      68. GatewayHelper interface
      69. addPermit
      70. addDeny
      71. addBuddy
      72. error
      73. debug
      74. Logger class
      75. stop
      76. start
      77. CFML event gateway SendGatewayMessage data parameter
      78. restart
      79. fatal
      80. SMS gateway message sending commands
    12. ColdFusion C++ CFX Reference
      1. C++ class overview
      2. Deprecated class methods
      3. CCFXException class
      4. CCFXQuery class
      5. CCFXRequest class
      6. CCFXStringSet class
      7. ColdFusion C++ CFX Reference
    13. ColdFusion Java CFX reference
      1. ColdFusion Java CFX reference
      2. Class libraries overview
      3. Custom tag interface
      4. Query interface
      5. Request interface
      6. Response interface
      7. Debugging classes reference
    14. WDDX JavaScript Objects
      1. WDDX JavaScript objects
      2. JavaScript object overview
      3. WddxRecordset object
      4. WddxSerializer object
  12. Develop ColdFusion applications
    1. Introducing ColdFusion
      1. Introducing ColdFusion
      2. About ColdFusion
      3. About Internet applications and web application servers
      4. About JEE and the ColdFusion architecture
    2. Changes in ColdFusion
      1. Changes in ColdFusion
      2. Replacement of JRun with Tomcat
      3. Security enhancements
      4. ColdFusion WebSocket
      5. Enhanced Java integration
      6. ColdFusion ORM search for indexing and search
      7. Solr enhancements
      8. Scheduler enhancements
      9. Integration with Microsoft Exchange Server 2010
      10. RESTful Web Services in ColdFusion
      11. Lazy loading across client and server in ColdFusion
      12. Web service enhancements
      13. Displaying geolocation
      14. Client-side charting
      15. Caching enhancements
      16. Server update using ColdFusion Administrator
      17. Secure Profile for ColdFusion Administrator
    3. Introduction to application development
      1. Introduction to application development using ColdFusion
      2. Using the Developing ColdFusion Applications guide
      3. About Adobe ColdFusion documentation for Developers
    4. The CFML programming language
      1. The CFML programming language
      2. Elements of CFML
      3. ColdFusion variables
      4. Expressions and number signs
      5. Arrays and structures
      6. Extend ColdFusion pages with CFML scripting
      7. Regular expressions in functions
      8. ColdFusion language enhancements
      9. Built-in functions as first class citizen
      10. Data types- Developing guide
    5. Building blocks of ColdFusion applications
      1. Building blocks of ColdFusion applications
      2. Create ColdFusion elements
      3. Write and call user-defined functions
      4. Build and use ColdFusion Components
      5. Create and use custom CFML tags
      6. Build custom CFXAPI tags
      7. Use the member functions
      8. Object Oriented Programming in ColdFusion
    6. Develop CFML applications
      1. Develop CFML applications
      2. Design and optimize a ColdFusion application
      3. Handle errors
      4. Use persistent data and locking
      5. Use ColdFusion threads
      6. Secure applications
      7. Client-side CFML (for mobile development)
      8. Use the ColdFusion debugger
      9. Debugging and Troubleshooting Applications
      10. Develop globalized applications
      11. REST enhancements in ColdFusion
      12. Authentication through OAuth
      13. Social enhancements
    7. Develop mobile applications
      1. Mobile application development
      2. Build mobile applications
      3. Debug mobile applications
      4. Inspect mobile applications
      5. Package mobile applications
      6. Troubleshoot mobile applications
      7. Device detection
      8. Client-side CFML
      9. Mobile Templates
      10. Code samples to build a mobile application
    8. Access and use data
      1. Access and use data
      2. Introduction to Databases and SQL
      3. Access and retrieve data
      4. Update database
      5. Use Query of Queries
      6. Manage LDAP directories
      7. Solr search support
    9. ColdFusion ORM
      1. ColdFusion ORM
      2. Introducing ColdFusion ORM
      3. ORM architecture
      4. Configure ORM
      5. Define ORM mapping
      6. Work with objects
      7. ORM session management
      8. Transaction and concurrency
      9. Use HQL queries
      10. Autogenerate database schema
      11. Support for multiple data sources for ORM
      12. ColdFusion ORM search
    10. ColdFusion and HTML5
      1. ColdFusion and HTML 5
      2. Use ColdFusion Web Sockets
      3. Media Player enhancements
      4. Client-side charting
      5. Display geolocation data
    11. Flex and AIR integration in ColdFusion
      1. Flex and AIR integration in ColdFusion
      2. Use the Flash Remoting Service
      3. Use Flash Remoting Update
      4. Offline AIR application support
      5. Proxy ActionScript classes for ColdFusion services
      6. Use LiveCycle Data Services ES assembler
      7. Use server-side ActionScript
    12. Request and present information
      1. Request and present information
      2. Retrieve and format data
      3. Build dynamic forms with cfform tags
      4. Validate data
      5. Create forms in Flash
      6. Create skinnable XML forms
      7. Use Ajax data and development features
      8. Use Ajax User Interface components and features
    13. Office file interoperability
      1. Office file interoperability
      2. Using cfdocument
      3. Using cfpresentation
      4. Using cfspreadsheet
      5. Supported Office conversion formats
      6. SharePoint integration
    14. ColdFusion portlets
      1. ColdFusion portlets
      2. Run a ColdFusion portlet on a JBoss portal server
      3. Run a ColdFusion portlet on a WebSphere portal server
      4. Common methods used in portlet.cfc
      5. ColdFusion portlet components
      6. Support for JSR-286
    15. Work with documents, charts, and reports
      1. Work with documents, charts, and reports
      2. Manipulate PDF forms in ColdFusion
      3. Assemble PDF documents
      4. Create and manipulate ColdFusion images
      5. Create charts and graphs
      6. Create reports and documents for printing
      7. Create reports with Report Builder
      8. Create slide presentations
    16. Use web elements and external objects
      1. Use web elements and external objects
      2. Use XML and WDDX
      3. Use web services
      4. Use ColdFusion web services
      5. Integrate JEE and Java elements in CFML applications
      6. Use Microsoft .NET assemblies
      7. Integrate COM and CORBA objects in CFML applications
    17. Use external resources
      1. Send and receive e-mail
      2. Interact with Microsoft Exchange servers
      3. Interact with remote servers
      4. Manage files on the server
      5. Use event gateways
      6. Create custom event gateways
      7. Use the ColdFusion extensions for Eclipse
      8. Use the data services messaging event gateway
      9. Use the data management event gateway
      10. Use the FMS event gateway
      11. Use the instant messaging event gateways
      12. Use the SMS event gateway


If you install ColdFusion with the Server configuration, you can create multiple instances and clusters, provided you have an Enterprise license or you install ColdFusion as a Trial or Developer edition. (ColdFusion Standard does not support multiple instances.)

About multiple server instances

The ColdFusion Administrator lets you create server instances and clusters. Additionally, you can connect to remote Tomcat servers and add them to clusters.

Running multiple instances of ColdFusion has the following advantages:

  • Application isolation You deploy an independent application to each server instance. Each server instance has separate settings and, because each server instance runs in its own Java Virtual Machine (JVM), problems that one application encounter have no effect on other applications.
  • Clustering (load balancing and failover) You deploy the same application to each server instance and add the instances to a cluster. The web server connector optimizes performance and stability by automatically balancing load and by switching requests to another server instance when a server instance stops running.

File location considerations

ColdFusion lets you store CFM pages either under the external web server root or under the ColdFusion web application root. The discussions here assume that you store your CFM pages under the ColdFusion web application root and specify a context root for your application.

For more information on serving CFM pages from the web server root, see Web Server Management

Defining additional server instances

You can create multiple ColdFusion instances using the ColdFusion Administrator's Enterprise Manager page, which again is available only ColdFusion Enterprise, Trial, or Developer editions.

Define a server instance

After installing ColdFusion in the Server (as opposed to JEE) configuration, create an instance of ColdFusion using the ColdFusion Administrator.

  1. In the ColdFusion Administrator, go to Enterprise Manager > Instance Manager.
  2. Click Add New Instance.
  3. Enter the server name and server directory. (When you tab from the server name field, Javascript code in the Administrator will automatically append that name to the existing server directory location.)
  4. (Optional) Check Create Windows Service.
  5. Click Submit. Wait for the new instance to be created.
  6. Once created, the new instance will be listed in the Instance Manager, where you can start, stop, restart, edit, delete, access the administrator, or access the web site for the instance (the latter two would be performed using the internal web server port for the instance, as selected by default by the Instance Manager).
  7. (Optional) Click the Edit icon to edit the instance manager. Notice that you can edit the internal webserver port as well as the load balancing factor.The load balancing factor represents the load the instance takes up and is applicable only if the instance is part of the cluster.For example, the load balancing factor for the first instance is 1 and that of the second instance is 2. The second instance receives two times more requests.
  8. Click Submit.

Deleting a cfusion instance from the Enterprise Manager page is not possible and it is not allowed. If you click the Delete icon,  the message, "Running servers cannot be deleted" displays, which means you must stop the server. But if you stop the server, you anyway cannot access the Enterprise Manager page.

Enabling application isolation

You can create separate server instances, each with its own ColdFusion applications; each application then has its own ColdFusion and JEE server resources. In this configuration, you typically have a single external web server with multiple server instances on one computer, and separate virtual hosts (or sites) for each server instance.

Note: Like ColdFusion, other JEE application servers provide equivalent capabilities, and most of the concepts apply when deploying the ColdFusion JEE configuration on those JEE servers.

Running independent applications this way has several advantages, including the following:

  • Errors at the levels of the ColdFusion application or the Tomcat server do not affect any other ColdFusion applications.
  • You can support multihomed servers, where a single web server supports multiple IP addresses or domain names, such as and, each running from a separate web root. For more information, see Multihoming.

    Note: Installing and Using ColdFusion describes creating multiple server instances on a single computer. To create multiple server instances on separate computers, each computer requires a separate license of ColdFusion Enterprise Edition.

    To achieve complete application isolation, you use web-server-specific functionality to create a separate website for each application. Web servers have different terminology for this concept. For example, in IIS, you define separate websites, while in Apache, you create multiple virtual hosts.

    These instructions apply when running ColdFusion in the Enterprise multiple instance configuration. The principles apply also when running ColdFusion on other JEE application serversl however, not all JEE application servers integrate with external web servers. For more information, see Multihoming.

    These instructions assume that you deploy each application at a named context root, which enables users to access CFM pages by specifying http://_hostname_/_context-root_/_pagename_.cfm. If other web applications are running in the server instance, each web application must use a different context root.

    For example, with a context root of cf, users access CFM pages by specifying http://_hostname_/cf/_pagename_.cfm. For more information on using a context root, see Installing ColdFusion.

    Note: Although {{cf }}is the context root, it does not relate to your web application directory structure.

Use multiple server instances for application isolation

  1. Create a separate server instance by using the instructions in Defining additional server instances. If you are using the built-in web server, proceed to step 6 in the following steps.
  2. Using your web-server-specific method, create a virtual website (or separate website) for the application. For more information, see Multihoming, or consult your web server documentation.
  3. Test each virtual website to ensure that HTML pages are served correctly.
  4. Store the ColdFusion files of your application the web root of the virtual website, or optionally in the ColdFusion web application root (for application portability).
  5. Follow the instructions for your web server to configure the connection between your virtual website and the server instance. For more information, see Web server configuration for application isolation.
  6. Test your application.
  7. Repeat these steps for each server instance.

Web server configuration for application isolation

When you use multiple server instances for application isolation, the steps you perform to configure communication between the website and the server instance differ for each web server.

Configuring application isolation in IIS

When you use multiple virtual websites with multiple server instances under IIS, you define separate filters and mappings for each virtual website and server instance combination.

It is assumed that you already created server instances and virtual websites, as described in Enabling application isolation.

Configure multiple server instances for application isolation when using IIS

Run the Web Server Configuration Tool multiple times, once for each virtual website. In ColdFusion, you must run the Web Server Configuration tool from within each instance (the wsconfig tool in cfroot\instancename\runtime\bin), and then specify the web site to connect to. use For more information on running the Web Server Configuration Tool

Configuring application isolation in Apache

When you use multiple virtual hosts with multiple server instances under Apache, you edit the httpd.conf file manually.

It is assumed that you already created server instances and virtual websites, as described in Enabling application isolation.

Configure multiple server instances for application isolation when using Apache

Assume that you have two instances: cfusion and server1.

  1. Configure Apache webserver for cfusion instance using the wsconfig tool. This step creates the connector-related files in the cf_root\config\wsconfig\1 folder. It also creates the mod_jk.conf in the <Apacheroot>\conf folder. The mod_jk.conf }}file is included in the {{httpd.conf.
  2. Configure Apache virtual hosts.
    1. In of cf-root\config\wsconfig\1, add server1 to workers.list. For example, worker.list=cfusion,server1.
    2. Add the following block:

      Note: The port is the AJP port for server1 and that can be found in server1.server.xml in the cf_root\server1\runtime\conf\server.xml.

    3. Copy the content of in cf-root\config\wsconfig\1 to{{}}. Replace the cfusion with server1.
    4. Now add the following line in each of the virtual host: For example, VH1 is the ColdFusion instance. It should have: JkMountFile "cf_root\config\wsconfig\1\" VH2 is the server1 instance. It should have JkMountFile "cf_root\config\wsconfig\1".

Configuring application isolation in Sun ONE Web Server

Under Sun ONE Web Server, each ColdFusion server instance is mapped to a Sub ONE Web Server instance, when you use multiple virtual hosts with multiple server instances.

Configure multiple server instances for application isolation when using Sun ONE Web Server

Run the Web Server Configuration Tool for each Sun ONE Web Server instance. Specify a different configuration directory and ColdFusion server instance each time. Ensure that you select the Configure Web Server for ColdFusion MX Applications option (GUI).

Enabling clustering for load balancing and failover

Load balancing is an enterprise-level feature in which the application server automatically alternates requests among the server instances in a cluster. Clustering also enables application servers to route requests to a running server instance when the original server instance goes down.

You can get New Admin API method to obtain instance name (getinstancename in runtime.cfc)load balancing and failover by deploying identical ColdFusion applications and configurations to multiple server instances and adding the instances to a cluster. Each instance must have the same applications deployed and the same resources configured (such as data sources, Solr collections, and mappings). The web server connector optimizes performance and stability by automatically balancing load and by switching requests to another server instance when a server instance stops running.

Note: You must be connected to a network for clustering to work.

For maximum failover protection, use multiple computers in a cluster. However, you must purchase a separate ColdFusion Enterprise Edition license for each computer.

To implement session failover for the server instances in a cluster, enable session replication for each server instance. Session replication coordinates session information in real time among the server instances in a cluster. Enabling session replication lets Tomcat automatically route a request to a running server if the current server is unavailable.

Note: When a cluster uses session replication, session data is copied to other servers in the cluster each time it is modified. This can degrade performance if you store a significant amount of information in session scope. If you plan to store a significant amount of information in session scope, consider storing this information in client variables saved in a database.

Configure a cluster of server instances for load balancing and failover

Manage clusters using the ColdFusion Administrator.

  1.  In the ColdFusion Administrator, click Enterprise Manager > Cluster Manager.
  2. Enter a cluster name and then click Add.
  3. Click the cluster name and move the servers to the cluster based on the requirement.
  4. (If required) Edit the multicast port.Multicast port is used to group the cluster members together. The default value of multicast port is 45564. After you create a cluster, the port is added in the cfroot\cfusion\config\cluster. xml  file. For more information on multicast port, see
  5. Specify if you need sticky session.Sticky session ensures that after a session is established on an instance, all future requests from the client are mapped to that instance. Note that if you disable sticky session, session replication will be enabled.
  6. Click Submit.

Adding a remote instance to a cluster

To add a remote instance to a cluster, add the cluster block to the remote instance's server.xml. Then, register the remote instance and add the instance to the cluster. For more information on configuring clusters on Tomcat, see

If you are using session replication, go to the Memory Variables page and enable J2EE sessions. Enable J2EE sessions for all server instances in the cluster. If J2EE sessions are not enabled in the ColdFusion Administrator, session replication does not function properly.

CFC serialization lets you use J2EE session replication in a cluster and have access to the CFCs in session data across all instances in the cluster. Session replication also ensures that that Session scope variables are replicated across the cluster. However, session replication does not support replication of arrays in Session scope CFCs or variables.You can also preserve and access data in a CFC in the case of session failover. ColdFusion structures stored inside the session scope are available in the session scope, even after failover. 

For example, if you are running multiple ColdFusion instances to balance server load, you can store useful data, including CFCs, inside the session so that you can access the data across all the pages that are served in that session. To enable CFC serialization, set the CFC in the session, as follows:

<cfset session. datasourcecomponent = cfccomponent>

After failover, you can then access and call methods in the CFC, as follows:

<cfset check = session.datasourcecomponent.verifyDSN(" testdsn ")>

  1. Register the remote instance to the local machine.
  2. Create a cluster in the local machine.
  3. Open the cfroot_instance-name_runtime\conf\server.xml file of the remote instance.
  4. Add the following block between the entries </host> }}and {{</engine>:


    1. For ColdFusion (2018 release), use the port 45564

    2. For ColdFusion (2016 release), use the port 45565

    <Manager notifyListenersOnReplication="true" expireSessionsOnShutdown="false" className="org.apache.catalina.ha.session.DeltaManager">
    <Channel className="">
    <Membership port="45565" dropTime="3000" address="" className="org.apache.catalina.tribes.membership.McastService" frequency="500">
    <Receiver port="4003" autoBind="100" address="auto" selectorTimeout="5000"
    maxThreads="6" className="org.apache.catalina.tribes.transport.nio.NioReceiver">
    <Sender className="org.apache.catalina.tribes.transport.ReplicationTransmitter">
    <Transport className="org.apache.catalina.tribes.transport.nio.PooledParallelSender">
    <Interceptor className="">
    <Interceptor className="
    <Valve className="org.apache.catalina.ha.tcp.ReplicationValve" filter="">
    <Valve className="org.apache.catalina.ha.session.JvmRouteBinderValve">

    <ClusterListener className="org.apache.catalina.ha.session.
    <ClusterListener className="org.apache.catalina.ha.session.ClusterSessionListener">



  5. In the entry, update the membership port with the multicast port of the cluster.
  6. Using the ColdFusion Administrator of the local host, add the local instance and the remote instance to the cluster.

    Note: The JVM route of the remote instance and local instance must not be the same.

  7. Restart all the instances.

Note: When running code in multiple instances, it can be useful to run CFML code that reports which instance is currently running a requested template. For security reasons, there is no function that provides the current instance name but the ColdFusion Admin API provides a method to obtain the instance name, the getInstanceName method in the Runtime CFC.  

Define remote server instances to the ColdFusion Administrator

Register a new remote instance of ColdFusion using the ColdFusion Administrator.

  1. In the ColdFusion Administrator, click Enterprise Manager > Instance Manager > Register Remote Instance.
  2. Specify the details such as instance name, remote host, remote port, http port, JVM route, and load balancing factor. 

    Instance name is a string that is used to identify the instance. Remote port and HTTP port are displayed in the Instance Manager page. These ports are provided in the server.xml file available in the runtime\conf folder of the instance. Remote port is the AJP port and the instance port is the connector port.

    JVM route is the remote instance name. The JVM route is an attribute that acts as an identifier for a particular Tomcat worker. JVM route is provided in the server.xml file available in the runtime\conf folder of the instance. For more information on JVM route, see

    Note: A remote instance and a local instance cannot have the same JVM route if they are added in a cluster.

  3. If you want remote start and stop functionality over HTTP, enter Admin Component port, Admin Component user name , and Admin Component password. The default Admin Component port is 8985.

    Note: To enable this feature, install admin component on the remote host.

    1. In the remote host, open the cfroot\cfusion\jetty\etc\jetty.xml.
    2. Search for the string,
    3. Update the host with the IP address of the remote host.
    4. Restart the jetty server.
  4. Click Submit.
Adobe logo

Sign in to your account