Register servers

Register each ColdFusion server instance to manage it from the Server Manager.

Note: The Server Manager AIR application supports only ColdFusion instances.

To register a ColdFusion server:

  1. Click the (+) sign in the right-pane of the Server Manager.

  2. Enter the server details including the server name, host name/IP address, port number, context root (for J2EE servers), and its user name and password.

    You can configure the host by specifying any either the hostname or the IP address. It is recommended that you register a particular server either using hostname or IP address only once from Server Manager AIR application. If you register the same server more than once, you might experience the following exception:

    [BlazeDS]Unhandled error when processing a message: flex.messaging.LocalizedException: 
    The FlexSession is invalid. 
    message =  There was an unhandled failure on the server. The FlexSession is invalid. 
    Exception: flex.messaging.LocalizedException: The FlexSession is invalid.
  3. Click Apply. After the server is registered, it appears in the All Servers list of the Server Manager. If the server details and authentication details are correct then the server status is displayed as 'Logged In' otherwise 'Login Failed' or 'Unreachable' status is displayed.

  4. Select the icon adjacent to the Server drop-down list in the left-pane to fetch details of the registered ColdFusion server instance.

    To get the latest information about a server instance, fetch these details from the main ColdFusion server.

Note: For server clusters, register each instance in the cluster with the Server Manager.

By default, the registered servers appear in Quick View in the right-pane of the All Servers tab. If you have associated the server instance or cluster to a group, then it appears under the group tab also.

After you register a server instance, you can apply a hot fix or clear the server template cache. You can perform these tasks for an individual server instance or for multiple servers. For details on performing these tasks, see Apply hot fix and Clear template cache.

Start and stop ColdFusion server instance

While reconfiguring some settings in ColdFusion, you may need to restart the server. With Server Manager, you can restart the server without logging into host.

You can configure the start and stop functionality for any of the following server types that has a ColdFusion instance deployed:

  • Tomcat (Standalone)

  • WebLogic

  • WebSphere

  • JBoss

For more information on deploying ColdFusion on an application server, see ColdFusion J2EE deployment and configuration in the Installing ColdFusion.

The general approach to implement the start and stop operation for a server is as follows:

  1. For starting/stopping server, deploy the WAR file specific to the application server on the application server to run start and stop operations.

  2. The deployed WAR instance should be in running state in the application server to be able to start or stop a ColdFusion server instance from the Server Manager.

For details on the WAR files corresponding to each application server and the parameters required to run start/stop operations, see:

Note: Options such as start, stop, or restart would be enabled only after you provide the required details under Start/Stop Details tab.

Tomcat parameters

You can set up start and stop remote instance functionality using HTTPS in Server Manager. To enable this feature, install Remote Instance Administrator while installing ColdFusion.

  1. Do the following in the remote host.

    1. In the remote host, generate a private key in a keystore file. Provide the details at prompt.

      <CF_installation>\jre\bin\keytool -genkeypair -alias certificatekey -keyalg RSA -validity 7 -keystore keystore.jks
    2. Export the certificate. You should have a self-signed certificate or a certificate from a Certificate Authority.

      <CF_installation>\jre\bin\keytool -export -alias certificatekey -keystore keystore.jks -rfc -file selfsignedcert.cer
    3. Copy the .jks file created in the remote host to the jetty\etc directory.

    4. Open the jetty\etc\jetty.xml file.

    5. Search for the string, To add a HTTPS SSL Listener and then add the following entry:

       <Call name="addConnector"> 
          <Arg> 
          <New class="org.mortbay.jetty.security.SslSocketConnector"> 
              <Set name="Port">8443</Set> 
              <Set name="maxIdleTime">30000</Set> 
              <Set name="keystore"><SystemProperty name="jetty.home" default="." />/etc/server.jks</Set> 
              <Set name="password">changeit</Set> 
              <Set name="keyPassword">changeit</Set> 
              <Set name="truststore"><SystemProperty name="jetty.home" default="." />/etc/server.jks</Set> 
              <Set name="trustPassword">changeit</Set> 
          </New> 
          </Arg> 
      </Call>
    6. Update the keystore name, password, key password, and jks file in the entry.

    7. Search for the string, org.mortbay.jetty.bio.SocketConnector.

    8. Update the host with the port number of the remote host.

    9. Restart the jetty server.

      Note: If the remote server is running on Windows Vista, Windows 7, or Windows Server 2008, start the jetty sever with admin privileges.
  2. Do the following in the local host from where you add remote instance:

    1. Copy the .cer file created in the remote host to any of the locations.

    2. Import the certificate.

      <CF_installation>\jre\bin\keytool.exe -importcert -keystore "<CF_installation>\jre\lib\security\cacerts" -file selfsignedcert.cer -storepass password
  3. Open wwwroot\CFIDE\ServerManager\ServerManager.air on the local host.

  4. Specify the connection details.

  5. Click Start/Stop Details.

  6. Select HTTPS.

  7. Provide the following information:

    • App Server Username: User name for the admin component that you specified while installing ColdFusion. Default value is admin.

    • App Server Password: Password for the admin component.

    • Port: ColdFusion remote instance’s HTTPS port.

    • Server: ColdFusion remote instance name.

    • ColdFusion Version: For ColdFusion Zeus, 10.

    • Admin Server Port: Default https port is 8443. Port of the Jetty server.

    • Context Root: Value is AdminServlet.

  8. Click Apply.

Setting up remote start and stop functionality using HTTP in Server Manager

You can set up start and stop remote instance functionality in Server Manager. To enable this feature, install Remote Instance Administrator while installing ColdFusion.

  1. Do the following in the remote host:

    1. In the remote host, open the ColdFusion_installtion\cfusion\jetty\etc\jetty.xml.

    2. Search for the string, org.mortbay.jetty.bio.SocketConnector.

    3. Update the host with the IP address of the remote host.

    4. Start the jetty server. Go to the ColdFusion_installation\cfusion\jetty directory and use jetty.exe. You can also use the jetty services in the Windows services.

  2. Open wwwroot\CFIDE\ServerManager\ServerManager.air on the local host.

  3. Specify the connection details.

  4. Click Start / Stop Details.

  5. Select HTTP.

  6. Provide the following information:

    • App Server Username: User name for the admin component that you specified while installing ColdFusion. The default value is admin.

    • App Server Password: Password for the admin component.

    • Port: ColdFusion remote instance’s HTTP port.

    • Server: ColdFusion remote instance name.

    • ColdFusion Version: For ColdFusion Zeus, 10.

    • Admin Server Port: Default https port is 8985. Port of the Jetty server.

    • Context Root: Value is AdminServlet.

  7. Click Apply.

WebLogic Server-specific parameters

Deploy the wlogicappstartup.war file on WebLogic server, either in admin or non-admin server but to the same domain where ColdFusion is deployed.

The WebLogic parameters in the Start/Stop Details tab of Server Manager are:

  • User name (user name of the domain on which ColdFusion application is deployed on WebLogic Server)

  • Password (password corresponding to the user name)

  • Port (port number for accessing the admin console)

  • Context root (name of the WAR file when no context root is specified)

  • ColdFusion Application Name (name of ColdFusion application deployed on WebLogic Server.)

  • Admin Port (port number for accessing the deployed WAR file, which is typically the administrator server port)

WebSphere-specific parameters

Deploy the wsappstartup.war file on WebSphere in the same profile where the ColdFusion instance is deployed.

The WebSphere parameters in the Start/Stop Details tab of Server Manager are:

  • User name (WebSphere Admin user name)

  • Password (WebSphere Admin password)

  • Context root (context root of the deployed WAR file)

  • ColdFusion Application Name (Name of ColdFusion application deployed on WebSphere.)

  • Admin Port (port number for accessing the deployed WAR file, which is typically the administrator server port)

JBoss specific parameters

For JBoss, deploy the jbossappstartup.war file on JBoss server.

The start/stop operations work only when secure access of JNDI over HTTP is enabled.

To configure secure access of JNDI over HTTP:

  1. In <jboss-home>/server/default/deploy/http-invoker.sar/invoker.war/WEB-INF/web.xml, uncomment the servlet mapping

    <servlet-mapping> 
            <servlet-name>JNDIFactory</servlet-name> 
            <url-pattern>/restricted/JNDIFactory/*</url-pattern> 
        </servlet-mapping>
  2. In <jboss-home>/server/default/deploy/http-invoker.sar/invoker.war/WEB-INF/jboss-web.xml, uncomment the line:

    <security-domain>java:/jaas/jmx-console</security-domain>
  3. In <jboss-home>/server/default/conf/login-config.xml, add the following <policy> if it does not exist.

    <application-policy name = "jmx-console"> 
           <authentication> 
              <login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule" 
                 flag = "required"> 
                 <module-option name="usersProperties">props/jmx-console-users.properties</module-option> 
                 <module-option name="rolesProperties">props/jmx-console-roles.properties</module-option> 
              </login-module> 
           </authentication> 
        </application-policy>

The files props/jmx-console-users.properties and props/jmx-console-roles.properties must contain the entries in the following format:

/jmx-console-users.properties:

Format: {username}={password}

/jmx-console-roles.properties

Format: {username}={comma-separated list of roles}

For more information on enabling secure access of JNDI over HTTP, see Securing Access to JNDI over HTTP.

The JBoss parameters in the Start/Stop Details tab of Server Manager are:

  • User name (user name mentioned in jmx-console-users.properties)

  • Password (password of the corresponding user)

  • Port (port number for accessing the admin console)

  • Context root (name of the deployed WAR file)

  • Admin Port (port number from where the deployed WAR file can be accessed, which is usually the admin server port)

View diff of two server settings

You can find out the differences in configuration of two server instances or clusters using the Diff With option available with Server Manager. This option allows you to check for differences in the configuration settings of two server instances. You can run Diff With on any two servers with the Logged In status.

To run Diff With:

  1. Right-click any one of the servers that you need to run Diff With on.

  2. Click Diff With and select the other server to compare your selected server instance.

  3. In the Diff of Setting between <server A> and <server B> dialog box, select the settings that you need to compare.

  4. Click Next.

  5. Expand the settings by clicking the (+) sign. Any settings that are different for the two server instances, are highlighted.