Installing Cisco Unified Communications Manager, Release 9.1(1)
Before you begin
Downloads: This chapterpdf (PDF - 384.0KB) The complete bookPDF (PDF - 3.26MB) | Feedback

Before you begin

Before you begin

This chapter discusses how you should prepare for the installation of the IM and Presence Service.

Read this first

When you install the IM and Presence Service on an existing server, the hard drive is formatted, and all existing data on the drive is overwritten.

DNS requirements

Note the following DNS requirements:

  • Mixed-mode DNS deployments not supported—Cisco does not support mixed-mode deployments. Both Cisco Unified Communications Manager (Unified CM) and IM and Presence must either use or not use DNS.
  • Unified CM and IM and Presence should use the same DNS server—If you use different DNS servers between IM and Presence and Unified CM, it is likely to cause abnormal system behavior.
  • Multi-node considerations—If you are using the multi-node feature in IM and Presence, see the section regarding multi-node deployments in the Deployment Guide for IM and Presence for DNS configuration options.

Installation time requirements

The entire IM and Presence installation process, excluding pre- and post-installation tasks, takes approximately 45 to 120 minutes per server, depending on your server type.

System requirements

Required passwords

During installation of the IM and Presence Service, you must specify the following usernames and passwords:

  • Administrator account username and password
  • Application username and password
  • Security password

Administrator account username and password

During installation, you must create an Administrator Account username and password to log into the following areas:

  • Cisco Unified Operating System Administration interface
  • Disaster Recovery System Administration interface
  • Command Line Interface (CLI)

The Administrator login must start with an alphabetic character, be at least six characters long, and can contain alphanumeric characters, hyphens, and underscores.

If you lose the Administrator password and cannot access the system, you can recover the Administrator password in Cisco Unified Communications Operating System Administration.

If you need to reset the Administrator password, use the CLI.

Application username and password

During installation, you must create an Application User user ID and password to sign into the Cisco Unified CM IM and Presence Administration interface.

If you need to reset the Application User password, use the CLI.

Security password

During installation, you must specify a system security password. This password is used to secure communication between cluster nodes. In the Post-Installation deployment wizard, which displays the first time you sign in to Cisco Unified CM IM and Presence Administration, you must reset the security password to be identical to the password used on the Cisco Unified Communications Manager (Unified CM) publisher server.


Note


The security password that you set for IM and Presence in the Post-Installation deployment wizard must be identical to the password used on the Unified CM Publisher server. The system uses this password to authorize communications between nodes, and you must ensure that this password is identical on all nodes in the cluster.


If you lose the Unified CM security password, there is no way to verify from IM and Presence what the security password is on the Unified CM server. See Cisco Unified Communications Manager documentation for information about how to retrieve the security password.

To reset the Unified CM security password after your first sign in to Cisco Unified CM IM and Presence Administration, (for example, if the password has changed on Unified CM and you need to update it on IM and Presence) select System > CUCM Publisher from Cisco Unified CM IM and Presence Administration.

Required installation information

When you install the IM and Presence Service on a server, the installation process requires certain information that you must provide. You can provide this information manually during the installation process or you can provide it using an answer file. For each IM and Presence server that you install in a cluster, you must gather this information before you begin the installation process.

The following table lists the information that you must gather before you install IM and Presence.


Note


Because some of the fields are optional, they may not apply to your configuration. For example, if you decide not to set up an SMTP host during installation, the parameter still displays, but you do not need to enter a value.


The last column in the table shows whether you can change a parameter after installation, and if you can, if provides the appropriate menu path or Command Line Interface (CLI) command.

Table 1 Required installation information

Configuration data

Description

Editable after installation

Administrator Credentials

Administrator Login

Specifies the name that you want to assign to the Administrator account.

No

Administrator Password

Specifies the password for the Administrator account.

Yes

CLI: set password admin

Application User Credentials

Application User Username

Specifies the user ID for Cisco Unified CM IM and Presence Administration.

Yes

CLI: utils reset ui administrator name

Application User Password

Specifies the password for Cisco Unified CM IM and Presence Administration.

Yes

CLI: utils reset ui administrator password

Security Password

Security password for Cisco Unified Communications Manager publisher node

The security password that you set for each IM and Presence server must be identical to the password used on the Cisco Unified Communications Manager Publisher server.

Yes

You can change the security password entered during an initial installation in one of two ways:

  • As you configure the post-installation wizard in Cisco Unified CM IM and Presence Administration.
  • In Cisco Unified CM IM and Presence Administration, select System > CUCM Publisher

Certificate Information

Organization

Used to create the Certificate Signing Request.

Yes

CLI: set web-security

Unit

Used to create the Certificate Signing Request.

Yes

CLI: set web-security

Location

Used to create the Certificate Signing Request.

Yes

CLI: set web-security

State

Used to create the Certificate Signing Request.

Yes

CLI: set web-security

Country

Used to create the Certificate Signing Request.

Yes

CLI: set web-security [orgunit] [orgname] [locality] [state]

(Optional) SMTP

SMTP Location

Specifies the name of the SMTP host that is used for outbound email.

You must fill in this field if you plan to use electronic notification. If not, you can leave it blank.

Yes

  • In Cisco Unified Communications Operating System Administration: select Settings > SMTP and enter the IP address or Hostname in the SMTP Host Field.
  • CLI: set smtp

NIC Interface Settings

NIC Speed

If you do not enable automatic negotiation of the ethernet Network Interface Card (NIC) speed, you must select the NIC speed (either 10 megabit or 100 megabit).

Yes

CLI: set network nic

NIC Duplex

If you do not enable automatic negotiation of the ethernet Network Interface Card (NIC) duplex setting, you must select the NIC duplex setting (either Full or Half).

Yes

CLI: set network nic

MTU Size

Note   

This value must be the same as the value entered on the Cisco Unified Communications Manager server. Otherwise the installation will fail.

The maximum transmission unit (MTU) represents the largest packet, in bytes, that this host will transmit on the network.

The MTU setting must be the same on all nodes in a cluster.

Yes

CLI: set network mtu

Note   

If you need to change this value for IM and Presence, you must match it with the value on Cisco Unified Communications Manager.

Network Information

DHCP

(Dynamic Host Configuration Protocol)

Select Yes if you want to use DHCP to automatically configure the network settings on your server.

If you select No, you must enter a hostname, IP Address, IP Mask, Gateway, and DNS configuration.

Yes.

  • In Cisco Unified OS Administration: select Settings > IP > Publisher
  • CLI: set network dhcp

Host Name

Note   

To change the hostname on a IM and Presence server, see IP Address, Domain and Hostname for IM and Presence Service on Cisco Unified Communications Manager.

If DHCP is set to No, you must enter a hostname for this machine.

Yes

  • In Cisco Unified Communications Operating System Administration, select Settings > IP > Ethernet
  • CLI: set network IP

IP Address

Note   

To change the IP address on a IM and Presence server, see IP Address, Domain and Hostname for IM and Presence Service on Cisco Unified Communications Manager.

If DHCP is set to No, you must enter the IP address of this machine.

Yes

  • In Cisco Unified Communications Operating System Administration, select Settings > IP > Ethernet
  • CLI: set network IP eth0 [ip-address] [ip-mask]

IP Mask

If DHCP is set to No, you must enter the IP subnet mask of this machine. The subnet mask together with the IP address defines the network address and the host address.

Yes

  • In Cisco Unified Communications Operating System Administration, select Settings > IP > Ethernet
  • CLI: set network IP eth0 [ip-address] [ip-mask]

Gateway Address

If DHCP is set to No, you must enter the gateway address.

Yes.

  • In Cisco Unified Communications Operating System Administration, select Settings > IP > Ethernet
  • CLI: set network gateway

(Optional) DNS

DNS Primary

If you have a Domain Name Server (DNS), IM and Presence contacts this DNS server first when attempting to resolve hostnames.

Yes

CLI: set network dns primary

DNS Secondary

When a primary DNS server fails, IM and Presence will attempt to connect to the secondary DNS server.

Yes

CLI: set network dns secondary

Domain

Represents the name of the domain in which this machine is located

Yes

CLI: set network domain

Timezone

Time Zone

Reflects the local time zone and offset from Greenwich Mean Time (GMT). Select the time zone that most closely matches the location of your machine.

Yes

CLI: set timezone

Network Time Protocol

NTP Server IP Address

During installation of the IM and Presence publisher node, you must specify the IP address of an external Network Time Protocol (NTP) server. Cisco recommends that you use the Cisco Unified Communications Manager publisher node as the NTP server.

Yes

In Cisco Unified Communications Operating System Administration, select Settings > NTP Servers

IM and Presence Publisher Node

IM and Presence Publisher Node Hostname

Note   

To change the host name on a IM and Presence server, see IP Address, Domain and Hostname for IM and Presence Service on Cisco Unified Communications Manager.

You need the hostname of the IM and Presence publisher node when you add a subscriber node to a cluster.

Yes

In Cisco Unified Communications Operating System Administration, select Settings > IP > Publisher

Note   

This only applies if, for network configuration purposes, you changed the hostname on the IM and Presence publisher server. If you do this, you must update the IP address of the publisher server on subsequent servers in IM and Presence.

IM and Presence Publisher Node IP Address.

Note   

To change the host name on a IM and Presence server, see IP Address, Domain and Hostname for IM and Presence Service on Cisco Unified Communications Manager.

If your network does not have DNS, you must provide the IP address of the IM and Presence publisher node when you add a subscriber node to a cluster.

Yes

In Cisco Unified Communications Operating System Administration: select Settings > IP > Publisher

Note   

This only applies if, for network configuration purposes, you changed the hostname on the IM and Presence publisher server. If you do this, you must update the IP address of the publisher server on subsequent servers in IM and Presence.

Cisco Unified Communications Manager Publisher Node

Cisco Unified Communications Manager Publisher Node Hostname

You need the hostname of the Cisco Unified Communications Manager publisher node when you complete the post-installation deployment wizard for the IM and Presence publisher node.

Yes

In Cisco Unified CM IM and Presence Administration, select System > CUCM Publisher

Cisco Unified Communications Manager Publisher Node IP Address.

You need the hostname of the Cisco Unified Communications Manager publisher node when you complete the post-installation deployment wizard for the IM and Presence publisher node.

Yes

In Cisco Unified CM IM and Presence Administration, select System > CUCM Publisher

Cisco Unified Communications Manager AXL Credentials

AXL User

AXL is the API that IM and Presence uses to communicate with Cisco Unified Communications Manager.

During the installation of the publisher node, you must supply the Cisco Unified Communications Manager AXL username in the post-installation deployment wizard.

Yes

In Cisco Unified CM IM and Presence Administration, select System > CUCM Publisher

AXL Password

During the installation of the publisher node, you must supply the Cisco Unified Communications Manager AXL password in the post-installation deployment wizard.

Note   

The AXL password must not contain any special characters.

Yes

In Cisco Unified CM IM and Presence Administration, select System > CUCM Publisher

Hardware and software requirements

Hardware requirements

You can find information regarding supported hardware for the following servers:

  • IM and Presence server For IM and Presence hardware support, see the Hardware and Software Compatibility Information for IM and Presence Service on Cisco Unified Communications Manager.
  • Cisco Unified Communications Manager server For Cisco Unified Communications Manager hardware support, see the Cisco Unified Communications Manager compatibility matrix.

If you are configuring the IM and Presence multi-node feature in your network, review the multi-node hardware recommendations in the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager.


Note


You must ensure that all MCS platforms contain a minimum of 4 GB of RAM.


Software restrictions

IM and Presence can only upload and process software that Cisco Systems approves. You cannot install or use third-party Linux or Windows-based software applications with IM and Presence. You perform valid software installations and upgrades in Cisco Unified Communications Operating System Administration.

For information about software compatibility, see the Hardware and Software Compatibility Information for IM and Presence Service on Cisco Unified Communications Manager.

Perform pre-installation tasks

You must complete the following pre-installation tasks before you begin to install the IM and Presence software.

Procedure
    Step 1   Ensure that the Cisco Unified Communications Manager (Unified CM) and IM and Presence software versions match.
    Step 2   Gather all the information you need to complete the installation and configuration of the IM and Presence software.
    Step 3   If you are installing a subscriber node, ensure that you add the subscriber node to the IM and Presence publisher node Cluster Topology.
    Step 4   Ensure that the IM and Presence server has network access to the Unified CM publisher server.

    You can ping Unified CM from other servers.

    Step 5   Ensure that you turn on the Cisco AXL Web Service on the associated Unified CM server.

    Select Tools > Service Activationin Cisco Unified Serviceability.

    Step 6   If you use DNS, ensure that you have configured the host name of the new IM and Presence server on the DNS server and that the DNS server can resolve the host name of the Unified CM publisher server and of other IM and Presence servers (if any).
    Caution   

    Cisco recommends that you use the same DNS servers between IM and Presence and Unified CM. If you use different DNS servers, it is likely to cause abnormal system behavior. Both Unified CM and IM and Presence must either use or not use DNS because Cisco does not support mixed-mode deployments. If you are using the multi-node feature in IM and Presence, see the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager for DNS configuration options.


    Cluster topology

    The system automatically assigns the first IM and Presence node that you install as the publisher node. For a multi-node IM and Presence deployment, after you install the publisher node you must create the required subclusters and subscriber nodes in your IM and Presence cluster. You perform the system topology configuration on the IM and Presence publisher node; select System > Cluster Topology in Cisco Unified CM IM and Presence Administration.

    You must create the subscriber nodes in your topology (on the publisher node) before you install the IM and Presence software on these nodes. However, you cannot assign these subscriber nodes to a subcluster until after you install IM and Presence software on these subscriber nodes. If you assign a subscriber node to a subcluster before you install it, users in remote clusters will not receive availability information. An availability outage will occur until the node is installed.

    Deploy multiple nodes in cluster

    A typical process for deploying multiple nodes in a cluster is as follows:

    For more information about configuring the cluster topology, see the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager .

    Procedure
      Step 1   Install the publisher node.
      Step 2   In Cluster Topology, on the publisher node, create all the subclusters and subscriber nodes.
      Step 3   Install each of the subscriber nodes in the cluster.
      Step 4   In Cluster Topology, on the publisher node, assign the subscriber nodes to the subcluster arrangement as required.

      Unattended installation of IM and Presence

      IM and Presence can be installed unattended using an XML answer file that reads predefined configuration values during the installation process.

      Cisco Unified Communications Answer File Generator, a web application, generates answer files for unattended installations of IM and Presence. You must generate the answer file, copy it to a USB key and use it with the IM and Presence DVD during the installation process.

      The generated XML answer file may be quite large, for example, 1 Gigabyte. Therefore, you may need to reformat the USB key to support a large storage capacity before you save the XML file to the USB key.


      Note


      You can only use answer files for fresh installations of IM and Presence and not for upgrades.


      To generate an answer file for unattended installation and configuration of IM and Presence you must access the Cisco Unified Communications Answer File Generator at the following URL:

      http:/​/​www.cisco.com/​web/​cuc_afg/​index.html

      The web application supports the following features:

      • Generates and saves answer files for unattended installations on the publisher server and all subsequent servers.
      • Provides syntactical validation of data entries.
      • Supports Internet Explorer version 6.0 or higher and Mozilla version 1.5 or higher.
      • Provides online help and documentation.

      Generate answer file

      The following procedure describes how to generate an answer file using the Cisco Unified Communications Answer File Generator.

      Before You Begin

      Gather the required installation and configuration information.

      Procedure
        Step 1   Access the Cisco Unified Communications Answer File Generator at the following URL: http:/​/​www.cisco.com/​web/​cuc_afg/​index.html.
        Step 2   Enter the required information for the node(s) that you wish to install.

        You can specify installation and configuration information for the publisher node and up to 5 subscriber nodes in a cluster.

        Note   

        If DHCP client is used on the publisher server, and subsequent server answer files are also generated, you must specify the publisher server IP address.

        Step 3   Select Generate Answer Files.
        Step 4   Follow the instructions to download the answer file(s).

        A separate answer file will be generated for each node that you want to install and configure.


        Reformat USB key to FAT32 file system

        You may need to reformat the USB key for the answer file to the FAT32 file system using the Windows XP Disk Management Utility. The FAT file system format provides for larger storage capacity (for example, 1 Gigabyte). You may need to be an Administrator or a member of the Administrators group to perform this procedure.

        Procedure
          Step 1   Insert the USB key into a USB slot on the Windows XP computer.
          Step 2   Select Start > Control Panel > Administrative Tools and double-select Computer Management.
          Step 3   Expand the Storage tree and select Disk Management.
          Step 4   Right-click the Removable Disk icon and select Format.
          Step 5   Select Yes if you are asked whether you are sure that you want to format this partition.
          Step 6   Select the File System and select FAT32 from the list box. .
          Step 7   Select OK and OK again when you are prompted to format the volume.