6 Upgrading Instant Messaging Server

This chapter explains how to upgrade your existing system to the latest release of Oracle Communications Instant Messaging Server.

About Upgrading Instant Messaging Server

The process for upgrading the Instant Messaging server and multiplexor is the same. The upgrade procedure automatically copies the pre-upgrade release product configuration and other data to the post-upgrade version. If Instant Messaging Server is configured to provide email notifications, or calendar alerts, the configuration data of these features is migrated to the post-upgrade version.

If your deployment consists of multiple Instant Messaging Server nodes, you can complete the upgrade in a "rolling" fashion by upgrading one node at a time. For example, if your deployment consists of six Instant Messaging Server nodes, you would upgrade the first node while the other five nodes were up and running, then upgrade the second node, and so on.

Supported Upgrade Paths

You can upgrade from release 9.0.x or 10.0 to 10.0.x

If you are not yet running a version of Instant Messaging Server 9, see "Upgrading Instant Messaging Server (Prior to Version 9 to 10.0.x)".

Note:

Java is no longer bundled with the Instant Messaging Server installer and requires manual installation. It is important that you install the correct version of Java for Instant Messaging Server. See "Installing Java"for information.

Upgrading Instant Messaging Server (9.0.x or 10.0 to 10.0.x)

To upgrade to 10.0.x:

  1. Download the Instant Messaging Server software for your operating system and extract the files to a temporary directory on your Instant Messaging Server hosts.

    See "Downloading the Instant Messaging Server Software" for more information.

  2. Stop Instant Messaging Server.

    imadmin stop
    
  3. Run the commpkg upgrade command.

    For more information, see "upgrade Verb Syntax".

  4. Select the Instant Messaging Server 10 component from the Product Selection list.

  5. Respond to the prompts to upgrade.

  6. (Optional) If you have deployed any Web applications, redeploy them.

    iwadmin redeploy app_name
    

    where app_name can be im, httpbind, or all.

    This step completes the upgrade process and redeploys the specified component(s).

  7. If you had previously configured your deployment to use Service Management Facility (SMF), run the following command to enable SMF, as the upgrade does not preserve SMF status.

    imadmin smf-register
    
  8. When upgrading to Instant Messaging Server 10.0.x from a release prior to 9.0.1.4.0, check if you are using any of the following items and do not want to reconfigure:

    • Components: Calendar Agent, HTTPBind, and so on

    • S2S Federation

    • Server Pool

    • Server health monitoring using Watchdog

    If you use any of these items, and if you continue to use the existing configuration file and do not want to reconfigure, then you must set the iim_server.useport property to true by using the imconfutil command. For example:

    imconfutil -c InstantMessaging_home/config set-prop iim_server.useport=true
    
  9. Uninstall the old IMAPI package/rpm:

    commpkg uninstall --components IMAPI
    
  10. For "rolling upgrades" (deployments of multiple Instant Messaging Server hosts), disable server-to-server ping support.

    InstantMessaging_home/sbin/imconfutil -u -c InstantMessaging_home/config/iim.conf.xml set-prop iim_server.peerpingtimeout=-1
    
  11. Install Java 8 and point the Java 8 installation directory to the /usr/jdk/latest directory.

    Note:

    See Table 3-2, "Instant Messaging Server Software Requirements" for more information on web containers and Java requirements.
  12. If you are using inter-domain communication, the upgrade process disables communication between domains, which is the default setting. To enable inter-domain communication, set the iim_server.hosteddomains.allowcrossdomainsaccess property to true.

  13. Restart Instant Messaging Server.

    imadmin start
    

Upgrading Instant Messaging Server (Prior to Version 9 to 10.0.x)

Upgrading to Instant Messaging Server 10.0 from an Instant Messaging Server release prior to version 9 is a two step process. You must first upgrade to Instant Messaging Server 9. Then, you upgrade to Instant Messaging Server 10.0.x.

To upgrade from a version prior to Instant Messaging Server 9:

  1. To upgrade to Instant Messaging Server 9, see the Unified Communications Suite 7 Update 2 Installation and Configuration Guide.

  2. Run the following commands for the Instant Messaging Server 8 parameters that did not get migrated:

    imconfutil set-listener-prop -u -c InstantMessaging_home/config/iim.conf.xml c2s port=45222 worker-out=muxout
    worker-in=muxin protocols=c2s
    imconfutil set-prop -u -c InstantMessaging_home/config/iim.conf.xml iim_server.deliverofflinechat=true
    iim_mux.jvm.maxmemorysize=2048 iim_ldap.conferencecontainer="ou=sunConferences" iim.policy.cachevalidity=3600
    
  3. To upgrade from Instant Messaging Server 9 to Instant Messaging Server 10.0, see "Upgrading Instant Messaging Server (9.0.x or 10.0 to 10.0.x)".

Post-Upgrade Tasks

See known problems in Instant Messaging Server Release Notes for post-upgrade tasks that might be necessary.

Upgrading from 9.0.x to 10.0.x in a Highly Available Environment

Upgrading Instant Messaging Server in an HA environment consists of upgrading the Instant Messaging Server software followed by upgrading the Instant Messaging Server Sun Cluster Agent.

To Upgrade to Instant Messaging Server 10.0.x in an HA Environment

  1. Disable the Instant Messaging Server resource.

    scswitch -n -j im-server-resource
    
  2. Make sure that the non-active node does not have access to the configuration directory.

  3. Run the commpkg upgrade command on all cluster nodes.

  4. Copy the Instant Messaging 9 configuration file iim.conf.xml to the iim.conf file with the same permissions.

    Also copy the iim.conf.xml file to iim.conf after any future configuration changes as cluster uses the iim.conf file.

  5. To use the new 'GatewayConnector' service in HA, update this service configuration with the virtual host name or IP address and port number as follows:

    imconfutil --config config_file set-prop iim_gwc.hostport=virtual host-name or ip:port
    

    For example:

    imconfutil --config /DATA1/default/config/iim.conf.xml set-prop iim_gwc.hostport=192.10.12.11:22222
    
  6. Enable the Instant Messaging server resource.

    scswitch -e -j im-server-resource
    

To Upgrade to Instant Messaging Server 10.0.x Sun Cluster Agent (IM_SCHA)

Run the commpkg upgrade command on all nodes on the cluster. If cluster node is a non-global zone, run commpkg upgrade in global zone as well as in non-global zones.

Rolling Back an Upgrade

If the upgrade fails or if you need to go back to the previously working version of Instant Messaging Server, you can roll back the upgrade process.

To roll back the upgrade process:

  1. Stop all services.

    imadmin stop
    
  2. Remove the Instant Messaging Server 10 packages.

    For example, on Solaris, use the pkgrm command.

  3. Install a prior version of Instant Messaging Server by using the installer for that software's version.