Cisco VCS Cluster Creation and Maintenance Deployment Guide (X6.1)

Cisco Cisco

Cisco VCS Cluster Creation and Maintenance Deployment Guide (X6.1)

Cisco TelePresence Video Communication Server (VCS) - Configuration Guides - Cisco

PDF Viewing Options

Not Your Device? Search For Manuals or Datasheets below:


File Info : application/pdf, 68 Pages, 810.24KB

Document DEVICE REPORTCisco VCS Cluster Creation and Maintenance Deployment Guide X6-1
Cluster creation and maintenance
Cisco TelePresence Deployment Guide Cisco VCS X6.1
Cisco TMS 12.6 or later
D14367.08 May 2011

Contents
Contents
Document revision history ....................................................................................................5
Introduction ............................................................................................................................6
Prerequisites ........................................................................................................................... 8
Upgrade VCS X1 / X2 Alternates to a VCS X6.1 cluster ......................................................9
Upgrade an X3 / X4 / X5.0 cluster to an X6.1 cluster.........................................................10
Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster.....................................11 Before the upgrade................................................................................................................................ 11 Un-cluster the X5.x/X6.0 cluster ready for re-clustering........................................................................ 11 Upgrade the master peer....................................................................................................................... 13 Set up the master peer of the X6.1 cluster............................................................................................ 14 Upgrade non-master peers.................................................................................................................... 15 Add an X6.1 VCS to the VCS X6.1 cluster............................................................................................ 16 Enable replication for the whole cluster................................................................................................. 20 After the upgrade................................................................................................................................... 20
Using Cisco TMS............................................................................................................................ 20 No Cisco TMS ................................................................................................................................ 21
Create a new cluster of VCS X6.1 peers.............................................................................22 Prerequisites.......................................................................................................................................... 22 Set up the master peer of the cluster .................................................................................................... 22 After the master peer configuration ....................................................................................................... 25
No Cisco TMS ................................................................................................................................ 26 Additional cluster configuration ............................................................................................................. 26
Add an X6.1 VCS to a VCS X6.1 cluster .............................................................................27 After adding the Cisco VCS peer to the cluster..................................................................................... 32 Additional cluster configuration ............................................................................................................. 33
Remove a live Cisco VCS from a VCS X6.1 cluster (permanently) ..................................34 Reconfigure Cisco TMS......................................................................................................................... 35 After the removal ................................................................................................................................... 35
Remove an out-of-service Cisco VCS from a VCS X6.1 cluster (permanently) ..............37 Reconfigure Cisco TMS......................................................................................................................... 38 After the removal ................................................................................................................................... 38 Before you reconnect the out-of-service Cisco VCS back to the network ............................................ 38
Disband a VCS X6.1 cluster.................................................................................................39 Reconfigure Cisco TMS......................................................................................................................... 41
Change the master peer of a VCS X6.1 cluster .................................................................42 Changing the master peer where the old master is or is not accessible............................................... 42 Reconfigure Cisco TMS......................................................................................................................... 42 If the old master is not available ............................................................................................................ 42

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 2 of 68

Contents
Change the IP address of a VCS X6.1 peer........................................................................43
Appendix 1 ­ Backing up a Cisco VCS ..............................................................................44 Backing up a pre X3.0 VCS................................................................................................................... 44 Backing up an X3.0 or later Cisco VCS................................................................................................. 44
Appendix 2 ­ Adding a Cisco VCS to Cisco TMS..............................................................45
Appendix 3 ­ IP port numbers ............................................................................................47
Appendix 4 ­ Impact of clustering on other Cisco VCS applications .............................48 Conference Factory (MultiwayTM) .......................................................................................................... 48 Microsoft Office Communications Server 2007 (OCS).......................................................................... 48
Appendix 5 ­ Configuring endpoints to work with a Cisco VCS cluster ........................49 H.323 endpoints .................................................................................................................................... 49
Option 1 ­ DNS SRV (preferred).................................................................................................... 49 Option 2 ­ DNS Round-Robin (2nd choice) ................................................................................... 49 Option 3 ­ Static IP (least preferred).............................................................................................. 50 SIP endpoints ........................................................................................................................................ 50 Option 1 ­ SIP Outbound (preferred) ............................................................................................. 50 Option 2 ­ DNS SRV (2nd choice) .................................................................................................. 51 Option 3 ­ DNS Round-Robin (3rd choice) ..................................................................................... 51 Option 4 ­ Static IP (least preferred).............................................................................................. 52
Appendix 6 ­ Troubleshooting............................................................................................53 Cisco VCS Warnings ............................................................................................................................. 53
"Cluster name not configured: if FindMe or clustering are in use a cluster name must be defined; see the Clustering section of the Cisco VCS Administrator Guide for more information".............. 53 "Cluster replication error: the Master peer is unreachable"............................................................ 53 "Cluster replication error: there was an error during automatic replication of configuration" ......... 53 "Cluster replication error: <details> manual synchronization of configuration is required" ............ 54 "Cluster replication error: the NTP server is unreachable" ............................................................ 55 "Cluster replication error: the local VCS does not appear in the list of peers"............................... 55 "Cluster replication error: automatic replication of configuration has been temporarily disabled because an upgrade is in progress"............................................................................................... 55 "Invalid clustering configuration: H.323 mode must be turned On - clustering uses H.323 communications between peers" ................................................................................................... 55 "Security alert: the TMS Agent database has the default LDAP password set" ............................ 55 "Security alert: the TMS Agent database has the default replication password set" ..................... 55 "VCS Database failure: Please contact your Cisco support representative" ................................. 55 Cisco TMS warnings.............................................................................................................................. 56 TMS Cluster Diagnostics................................................................................................................ 56 Conference Factory template does not replicate ........................................................................... 56 VCS's External manager protocol keeps getting set to HTTPS..................................................... 56 My cluster of Cisco VCS Expressways with dual network interfaces is not replicating correctly .......... 57 My cluster of Cisco VCS Expressways with static NAT is not replicating correctly .............................. 57
Appendix 7 ­ Upgrading Cisco TMS to 12.6 ......................................................................58
Appendix 8 ­ Upgrade VCS X5.1, X5.1.1 or X5.2 software to X6.1...................................59

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 3 of 68

Contents
Appendix 9 ­ Changing the cluster name (and keeping FindMe accounts) ...................61
Appendix 10 ­ Cluster name and DNS SRV records.........................................................62 Endpoints supporting SIP DNS SRV..................................................................................................... 63 Looking up .SRV records....................................................................................................................... 64
Nslookup......................................................................................................................................... 64 Dig .................................................................................................................................................. 64
Appendix 11 ­ NAPTR records ...........................................................................................65 NAPTR record format ............................................................................................................................ 65 Looking up NAPTR records................................................................................................................... 66
Looking up an ENUM NAPTR record............................................................................................. 66 Looking up a domain NAPTR record ............................................................................................. 67

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 4 of 68

Document revision history

Document revision history

The following table summarizes the changes that have been applied to this document.

Revision 1 2

Date

Description

Up to December 2009 Releases for earlier versions of Cisco VCS.

December 2009

Updated for VCS X5.

3

May 2010

Updated for VCS X5.1.1 and TMS 12.6.

4

August 2010

Updated for VCS X5.2.

Replace previous Appendix 12 (Upgrading debian packages - only required for X5.1.1) with a new Appendix 12 - NAPTR records overview.

5

October 2010

New document styles applied.

6

December 2010

Updated for VCS X6.

7

February 2011

Clarify this document refers to VCS X6.0 only, and to TMS 12.6 or later.

8

May 2011

Updated for VCS X6.1.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 5 of 68

Introduction
Introduction
Cisco TelePresence Video Communication Server (Cisco VCS) clusters are designed to extend the resilience and capacity of a Cisco VCS installation. Cisco VCSs in the cluster share bandwidth usage, routing, zone, FindMeTM and other configuration among themselves. Endpoints can register to any of the Cisco VCSs in the cluster; if they lose connection to their initial peer, they can re-register to another peer in the cluster. Call licensing is carried out on a per-VCS peer basis, and so enough call licenses must be applied to each peer to support the number of calls that are needed on that peer, plus any additional calls that may be required when one or more other peers become inaccessible. The same number of licenses must be applied to each peer in the cluster. Every Cisco VCS peer in the cluster must have the same routing capabilities -- if any Cisco VCS can route a call to a destination it is assumed that all Cisco VCS peers in that cluster can route the call to that destination. If the routing is different on different Cisco VCS peers, then separate VCSs / VCS clusters must be used. This deployment guide describes how to create, modify and upgrade to X6.1 VCS clusters. It provides information on how to:  Upgrade VCS X1 / X2 Alternates to a VCS X6.1 cluster  Upgrade an X3 / X4 / X5.0 cluster to an X6.1 cluster  Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster  Create a new cluster of VCS X6.1 peers  Add an X6.1 VCS to a VCS X6.1 cluster  Remove a live Cisco VCS from a VCS X6.1 cluster (permanently)  Remove an out-of-service Cisco VCS from a VCS X6.1 cluster (permanently)  Disband a VCS X6.1 cluster  Change the master peer of a VCS X6.1 cluster  Change the IP address of a VCS X6.1 peer
Note: In X3.x the use of Cisco TMS was essential to the correct operation of a VCS cluster because Cisco TMS was in control of copying configuration from the Master Cisco VCS to the non-master Cisco VCS peers.
In X4.1 the Cisco VCS performs the replication of configuration from Master Cisco VCS to non-master Cisco VCS peers and so use of Cisco TMS was optional for clustering. If provisioning was supported, Cisco TMS was needed.
In X5.x and X6.x Cisco TMS is involved in initiating the environment for FindMe replication. Although not needed to replicate FindMe data throughout the cluster in a running environment, Cisco TMS is required to perform the initial distribution of the FindMe data throughout the cluster. Cisco TMS is also required if provisioning is to be supported on Cisco VCSs.
Note: Enabling provisioning and creating a cluster are two separate processes. If you intend to enable provisioning on your cluster, either:
 follow the instructions in this guide to create the cluster of Cisco VCSs (without provisioning enabled), and then follow the instructions in the Cisco TMS Provisioning Deployment Guide to enable provisioning across the cluster, or

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 6 of 68

Introduction
 follow the instructions in the Cisco TMS Provisioning Deployment Guide to enable provisioning on what will be the Master Cisco VCS, and then follow the instructions in this guide to create the cluster of Cisco VCSs
For creating and modifying clusters that will remain X6.0 / X5 / X4.3 / X4.1 clusters, see:  Cisco VCS deployment guide - Cluster creation and maintenance (X6)  Cisco VCS deployment guide - Cluster creation and maintenance (X5)  Cisco VCS deployment guide - Cluster creation and maintenance (X5)  TANDBERG VCS deployment guide - Cluster creation and maintenance (VCS X43)  TANDBERG VCS deployment guide - Cluster creation and maintenance (VCS X41)

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 7 of 68

Prerequisites
Prerequisites
Cisco VCS clusters peers should all run the same version of code, for example all X6.1, or all X5.2. The only occasion where different peers should be allowed to run different versions of code is for the short period of time while a cluster is being upgraded from one version of code to another.
Before setting up a cluster of X6.1 VCS peers or adding an X6.1 VCS to a cluster, ensure that:
 a DNS SRV record is available for the cluster which contains A or AAA records for each peer of the cluster
 each and every Cisco VCS peer in a cluster is within a 15ms hop (30ms round trip delay) of each and every other Cisco VCS in or to be added to the cluster
 each and every Cisco VCS peer in a cluster must be directly routable to each and every other Cisco VCS in or to be added to the cluster. (There must be no NAT between cluster peers ­ if there is a firewall ensure that the required ports are opened.)
 all Cisco VCS peers have the same set of option keys installed - the Cisco VCS must be restarted after installing some option keys in order to fully activate them - the sum total of each type of option key must be the same on each peer, e.g. it is acceptable to have 1 peer with a 20 Traversal Calls option key and another with two 10 Traversal Calls option keys, as both add up to 20 Traversal Calls
 the Cisco TMS version being run is TMS 12.6 or later
 each Cisco VCS has a different system name
 H.323 mode is enabled on each Cisco VCS (VCS configuration > Protocols > H.323, and for H.323 mode select On) ­ H.323 communications are used between cluster peers
 the Cisco VCS cluster has a DNS SRV record that defines all cluster peers
 the DNS servers used by the Cisco VCS peers must support both forward and reverse DNS lookups of Cisco TMS and all Cisco VCS peer addresses; the DNS servers must also provide address lookup for any other DNS functionality required (for example: system servers like NTP and the external manager that are configured using DNS names, OCS FQDN lookup, LDAP server forward and reverse lookup); note that reverse lookups are frequently provided through PTR records

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 8 of 68

Upgrade VCS X1 / X2 Alternates to a VCS X6.1 cluster
Upgrade VCS X1 / X2 Alternates to a VCS X6.1 cluster
An upgrade from X1 / X2 alternates direct to an X6.1 cluster is not possible, an upgrade from X1 / X2 to X5.2 must happen first, then upgrade from X5.2 to X6.1. Follow the steps in "Upgrade VCS X1 / X2 Alternates to a VCS X5 cluster" in the "Cluster creation and maintenance guide (X5)", upgrading the Cisco VCSs to X5.2, then return to this guide and follow the steps "Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster" below.
Upgrading VCS X1 / X2 Alternates to a VCS X6.1 cluster is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 9 of 68

Upgrade an X3 / X4 / X5.0 cluster to an X6.1 cluster
Upgrade an X3 / X4 / X5.0 cluster to an X6.1 cluster
An upgrade from an X3 / X4 / X5.0 cluster direct to an X6.1 cluster is not possible, an upgrade from X3 / X4 /X5.0 to X5.2 must happen first, then upgrade from X5.2 to X6.1. Follow the steps in "Upgrade a Cisco VCS X3 / X4 cluster to an X5 cluster (including Cisco TMS to 12.6)", or the "Upgrade an X5.0 cluster to an X5.2 cluster" in the "Cluster creation and maintenance guide (X5)" to get to an X5.2 cluster, then follow the steps "Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster" below.
Upgrading a VCS X3 / X4 / X5.0 cluster to a VCS X6.1 cluster is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 10 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
The process of creating an X6.1 cluster from an X5.1, X5.1.1, X5.2 or X6.0 cluster requires that the cluster be un-clustered, the Master peer of the cluster needs to be upgraded and configured, then other peers need to be upgraded and added to the cluster. The procedure is documented below. Do not use this procedure if clustering is not working. Ensure that clustering is working in X5.x/X6.0 before upgrading to X6.1.
Note:
 The port ranges that the Cisco VCS uses for replication have been extended. If there is a firewall between any Cisco VCS peers, check "Appendix 3 ­ IP Port numbers".
 If the VCS is downgraded back to X6.0 or earlier from X6.1 or later, even after restoring the relevant backup, the VCSs will require re-clustering as the technique for sharing configuration data is different in X6.1.
Before the upgrade
For each VCS: 1. Check the Warnings page (Status > Warnings) and ensure that all warnings are acted upon
and cleared. If Cisco TMS is being used, verify the correct operation of TMS Agent by running TMS agent diagnostics: 1. Log into Cisco TMS. 2. Go to Administrative Tools > TMS Agent Diagnostics. 3. In the TMS Agent Browser panel on the left side of the page, select Local TMS Agent. 4. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent. 5. For each Cisco VCS peer:
a. In the TMS Agent Browser panel on the left side of the page, select the Cisco VCS peer. b. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent.
Note: If authentication is intentionally enabled on the Cisco VCS, ignore the warning `verify that authentication is disabled on the VCS'
 If all tests are successful (all green check marks), proceed with the "Un-cluster the X5.x/X6.0 cluster ready for re-clustering" instructions below.
 If any errors are found (a red `X' will appear against failing tests), do not proceed further with this upgrade, but contact your Cisco Authorized Service Provider for further assistance to resolve the issues identified.
Un-cluster the X5.x/X6.0 cluster ready for re-clustering
Note: this un-clustering process leaves Cisco TMS and Cisco VCS partially configured (ready for reclustering) ­ do not use this process to disband a cluster of Cisco VCSs. To disband a cluster follow the instructions in "Disband a VCS X6.1 cluster".
Note: FindMe and configuration replication will be stopped, as will provisioning

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 11 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
If Cisco TMS is being used, on Cisco TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Master VCS. 2. Select the Clustering tab 3. Clear the Enable TMS Agent Data Replication on all Cluster Peers. 4. Click Save Cluster Settings 5. Select the TMS Agent tab. 6. Ensure that Enable TMS Agent Data Replication is not selected; if this needs changing, change
it and click Save Settings.
Note: This disables database replication from Cisco TMS to each cluster peer.
 Provisioning data will no longer be updated from Cisco TMS to the Cisco VCSs, however provisioning of endpoints from data cached on Cisco VCSs not in maintenance mode will continue.
 VCS cluster configuration replication will continue.
 VCS FindMe replication among Cisco VCS peers will continue.
If Cisco TMS is being used, on Cisco TMS, for every non-master Cisco VCS peer: 1. Select Systems > Navigator (and any required sub folders) then select the non-master VCS. 2. Select the TMS Agent tab. 3. Ensure that Enable TMS Agent Data Replication is not selected; if this needs changing, change
it and click Save Settings. 4. Repeat for all non-master VCS peers ­ Cisco TMS may require you to pause between disabling
each peer.
On each non-master Cisco VCS: 1. Log in to the Cisco VCS CLI as root and type:
cluster The following screen will appear:

2. Choose option 3 "Disable Replication on this VCS". 3. Follow the instructions EXCEPT do not remove this VCS from the list of VCS peers. 4. When you return to the menu, choose option q to Quit.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 12 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
5. Repeat for each non-master Cisco VCS. On the Master Cisco VCS: 1. Log in to the Cisco VCS CLI as root and type:
cluster 2. Choose option 3 "Disable Replication on this VCS". 3. Follow the instructions EXCEPT do not remove this VCS from the list of VCS peers. 4. Once you are returned to the menu choose option q to Quit.
On each non-master Cisco VCS peer: 1. Log into the web interface. 2. From the Clustering page ( VCS configuration > Clustering):
a. Delete all entries in the Peer x IP address fields. 3. Click Save.
Note: A Warning similar to that shown below may appear on the web interface and CLI of the Cisco VCS being removed. This is not a problem, the warning will be cleared when the Cisco VCS is restarted:
4. Restart the Cisco VCS (Maintenance > Restart and then click Restart System). · If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
5. Repeat for each non-master Cisco VCS.
On the Master Cisco VCS: 1. Log into the web interface 2. Go to the Clustering page (VCS configuration > Clustering).
a. Delete all entries in the Peer x IP address fields. 3. Click Save.
Note: A Warning similar to that shown below may appear on the web interface and CLI of the Cisco VCS being removed. This is not a problem, the warning will be cleared when the Cisco VCS is restarted:
4. Restart the Cisco VCS (Maintenance > Restart and then click Restart System).
Upgrade the master peer
For the master peer in the cluster: 1. Backup the Cisco VCS (see "Appendix 1 ­ Backing up a Cisco VCS" for details).

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 13 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster

Note: You should backup your system before upgrading. If at a later date you need to downgrade to an earlier version you will need to restore a backup made against that previous release.
2. Enable maintenance mode. From the VCS command line type: xconfiguration SystemUnit Maintenance Mode: On
3. Wait for all calls to clear and registrations to timeout. If necessary, manually remove any calls that do not clear automatically (Status > Calls, then select the check box next to the calls you want to terminate and click Disconnect).
4. If necessary, manually remove any registrations that do not clear automatically (Status > Registrations > By device, then select the check box next to the devices you want to remove and click Unregister). You can leave the registration for the Conference Factory ­ this will not be the source of calls, and even if deleted will not roll over to another peer, as other peers have their own Conference Factory registration (if enabled).
5. Obtain the release key for the new Cisco VCS software 6. Upgrade and restart the Master Cisco VCS (Maintenance > Upgrade).
For any further details see the "Upgrading Software" section of the Cisco VCS Administrator Guide.
Note: The web browser interface may timeout during the restart process, after the progress bar has reached the end. This may occur if:
 Cisco VCS carries out a disk file system check ­ which it does approximately once every 30 restarts
 Provisioning is enabled, and database re-indexing is in progress
Upgrading of the software on the master Cisco VCS is now complete.
Note: The upgrade process disables the Cisco VCS's provisioning functionality.
 Provisioning is restored when Enable TMS Agent Data Replication is enabled later in the process.
7. Backup the master Cisco VCS (See "Appendix 1 ­ Backing up a Cisco VCS" for details).
Note: It is recommended that while Cisco VCS peers are running different versions of code, configuration changes to any Cisco VCS in the cluster are limited to the changes needed to complete the upgrade. Configuration changes will not be replicated across Cisco VCS peers that are not running the same version of software as the master Cisco VCS.

Set up the master peer of the X6.1 cluster

On the Master Cisco VCS: 1. On the Clustering page (VCS configuration > Clustering) configure the fields as follows:

Configuration master 1

Cluster pre-shared key

Enter a password (any characters)

Peer 1 IP address

Set to the IP address of this (the master peer) Cisco VCS

Note: If the Cisco VCS has dual network interfaces, the Peer IP address MUST specify the LAN 1 interface address.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 14 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
2. Click Save. To the right of the Peer 1 IP address field the words "This VCS" should appear.
3. Restart the Cisco VCS (select Maintenance > Restart, then select Restart system and confirm OK.)
On the Master Cisco VCS web interface: 4. Check that the configuration (including Zone configuration, Transforms configuration, CPL and
other configuration for items from the System, VCS configuration and Application menus) is as expected. 5. Backup the Cisco VCS (See Appendix 1 for details).
If Cisco TMS is used, on TMS: Ensure that TMS has all the correct settings for this upgraded VCS by forcing a refresh of TMS. 1. Go to Systems > Navigator (and any required sub folders) and select the Master Cisco VCS. 2. Select the Settings tab. 3. Click Force Refresh. 4. Select the TMS Agent tab
a. ensure that Enable TMS Agent Data Replication is selected. b. ensure that Authentication Scheme is set to Digest. If any changes need to be made, click Save Settings.
Note: If TMS Agent Data Replication reports Disabled then there is a problem. On Cisco TMS select Administrative Tools > Activity Status and look for the Description `Enable TMS Agent Data Replication for system(s): <VCS name(s)>'. Click on the description for a full listing of the Activity log associated with this action. Identify and fix any reported problems.
On this Master Cisco VCS: 5. Log in to the web browser of this Cisco VCS. 6. Check the Warnings page (Status > Warnings):
a. If required, restart the Cisco VCS. b. If "Security Alert: the TMS agent database has the default LDAP password set" or "Security
Alert: the TMS agent database has the default replication password set" appear, see the relevant section in `Appendix 6 ­ Troubleshooting'. 7. Disable maintenance mode. From the Cisco VCS command line type: xconfiguration SystemUnit Maintenance Mode: Off
Upgrade non-master peers
If several non-master peers need upgrading, the upgrades may be carried out one at a time, or in parallel. The downloading of software and rebooting can be carried out on all non-master peers at the same time. The process below handles the `all at the same' case, if upgrades are to be done one at a time, carry out the process "Upgrade non-master peers" and "Add an X6.1 VCS to the VCS X6.1 cluster" for the first non-master Cisco VCS, then repeat for each and every subsequent non-master Cisco VCS. For each non-master peer in the cluster: 1. Enable maintenance mode.
From the Cisco VCS command line type: xconfiguration SystemUnit Maintenance Mode: On

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 15 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
2. Wait for all calls to clear and registrations to timeout. If necessary, manually remove any calls that do not clear automatically (Status > Calls, then select the check box next to the calls you want to terminate and click Disconnect).
3. If necessary, manually remove any registrations that do not clear automatically (Status > Registrations > By device, then select the check box next to the devices you want to remove and click Unregister). You can leave the registration for the Conference Factory ­ this will not be the source of calls, and even if deleted will not roll over to another peer, as other peers have their own Conference Factory registration (if enabled).
4. Obtain the release key for the new Cisco VCS software 5. Upgrade and restart the Cisco VCS (Maintenance > Upgrade).
· If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
For any further details see the "Upgrading Software" section of the Cisco VCS Administrator Guide.
Note: The web browser interface may timeout during the restart process, after the progress bar has reached the end; this may happen if:
 Cisco VCS carries out a disk file system check ­ which it does approximately once every 30 restarts
 Provisioning is enabled, and database re-indexing is in progress
Upgrading the software on this Cisco VCS peer is now complete.
Note: The upgrade process disables the Cisco VCS's provisioning functionality.
 Provisioning is restored when Enable TMS Agent Data Replication is enabled later in the process.
6. Repeat these steps for each non-master peer.
Note: It is recommended that while Cisco VCS peers are running different versions of code, configuration changes to any Cisco VCS in the cluster are limited to the changes needed to complete the upgrade. Configuration changes will not be replicated across Cisco VCS peers that are not running the same version of software as the Master Cisco VCS.
Add an X6.1 VCS to the VCS X6.1 cluster
Note: You can have up to 6 Cisco VCSs, including the master Cisco VCS, in a cluster.
This process will add the X6.1 VCS to the cluster and replicate the cluster Master's configuration onto the Cisco VCS. Do this process for one Cisco VCS at a time and repeat this process for each non-master Cisco VCS to be added to the cluster.
Note: Cisco VCS clusters peers must all run the same version of code, for example all X6.1.
On the Cisco VCS to be added to the cluster: 1. Check the Warnings page of the Cisco VCS to be added (Status > Warnings). If there is an
alarm that the Cisco VCS must be restarted, select Maintenance > Restart and then click Restart System.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 16 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
- Warnings about TMS Agent passwords being default will be cleared when TMS Replication is enabled. 2. Backup the Cisco VCS (See Appendix 1 for details).
If Cisco TMS is being used, in Cisco TMS: a. Select Systems > Navigator (and any required sub folders), then click on the Master Cisco VCS of the cluster b. Select the Clustering tab. c. Ensure that the Enable TMS Agent Data Replication on all Cluster Peers check box is clear; if it needs changing click Save Cluster Settings.
Note: This disables database replication from Cisco TMS to each cluster peer.
 Provisioning data will no longer be updated from Cisco TMS to the Cisco VCSs, however provisioning of endpoints from data cached on Cisco VCSs not in maintenance mode will continue.
 VCS cluster configuration replication will continue.
 VCS FindMe replication among Cisco VCS peers will continue.
d. Select Systems > Navigator (and any required sub folders), then click on the non-master Cisco VCS being added to the cluster.
e. Select the TMS Agent tab. f. Clear the Enable TMS Agent Data Replication check box. g. Click Save Settings.
On the Cisco VCS being added to the cluster: 3. Enable maintenance mode.
From the Cisco VCS command line type: xconfiguration SystemUnit Maintenance Mode: On
4. Wait for all calls to clear and registrations to timeout. If necessary, manually remove any calls that do not clear automatically (Status > Calls, then select the check box next to the calls you want to terminate and click Disconnect).
5. If necessary, manually remove any registrations that do not clear automatically (Status > Registrations > By device, then select the check box next to the devices you want to remove and click Unregister). You can leave the registration for the Conference Factory ­ this will not be the source of calls, and even if deleted will not roll over to another peer, as other peers have their own Conference Factory registration (if enabled).
On the Master Cisco VCS: 6. On the Clustering page (VCS configuration > Clustering), one or more of the Peer x IP
address fields should be empty. In the first empty field, enter the IP address of the new Cisco VCS.
Note: If the Cisco VCS has dual network interfaces, the Peer IP address MUST specify the LAN 1 interface address.
7. Click Save. Peer 1 should indicate `This VCS'. The new peer may indicate `Unknown' and then with a refresh should indicate `Failed' ­ it needs the pre-shared key entered before it can go `Active'.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 17 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster

Note: Cluster configuration replication is suspended at this point until the new Cisco VCS has been completely added. Any changes made to the configuration of the cluster will not be replicated until this Cisco VCS has been completely added

On every other non-master Cisco VCS that is already included in the cluster (not the ones still to be added):
8. On the Clustering page (VCS configuration > Clustering) configure the fields as follows:

Cluster name

Identical to the Cluster name configured on the master Cisco VCS

Cluster pre-shared key

Identical to that configured on the Master Cisco VCS

Configuration master Identical to that configured on the Master Cisco VCS

Peer 1 IP address ... Peer 6 IP address

Identical to those configured on the Master Cisco VCS

9. Click Save. On the Cisco VCS being added to the cluster: 10. Log in as admin on an SSH or other CLI interface. At the command prompt type:
xcommand DefaultValuesSet Level: 2

Note: This command will wipe any LDAP Authentication configuration ­ ensure that you have the web admin password before executing this command.

11. Go to the Administrator accounts page (Maintenance > Login accounts > Administrator accounts).
12. Delete all entries except the default admin account.
13. Go to System > DNS and ensure that Local host name is the DNS hostname for this Cisco VCS (typically the same as the System name in System > System, but excluding spaces, and unique for each Cisco VCS in the cluster); if not set it up appropriately and click Save.

Note: <Local host name>.<DNS domain name> = FQDN of this Cisco VCS.

14. On the Clustering page (VCS configuration > Clustering) configure the fields as follows:

Cluster name

Identical to the Cluster name configured on the Master Cisco VCS

Cluster pre-shared key

Identical to that configured on the Master Cisco VCS

Configuration master Identical to that configured on the Master Cisco VCS

Peer 1 IP address ... Peer 6 IP address

Identical to those configured on the Master Cisco VCS

15. Click Save. 16. Restart this newly added Cisco VCS:
a. On the Maintenance > Restart page select Restart system b. Confirm the Restart by selecting OK
· If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
On the Cisco VCS being added to the cluster: 17. Wait approximately 2 minutes after restart ­ this is the frequency with which configuration is
copied from the Master.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 18 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
18. Check the Warnings page of the newly added Cisco VCS (Status > Warnings). If there is an alarm that the Cisco VCS must be restarted, go to Maintenance > Restart and then click Restart System.
· Warnings about TMS Agent passwords being default will be cleared when TMS Replication is enabled.
· If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
19. Check that the configuration (including zone configuration, transforms configuration, CPL and other configuration for items from the System, VCS configuration and Application menus) is as expected (not FindMe -- this will be replicated later) as per the Master Cisco VCS.
On other devices:  If you have any other Cisco VCSs, Gatekeepers or Border Controllers neighbored (or connected
via a traversal zone) to this cluster of VCS peers, ensure that their zone configuration for this cluster is updated to include the address of this new peer.
If Cisco TMS is used: 1. Go to Systems > Navigator (and any required sub folders) then select the new Cisco VCS to be
added to this cluster. 2. Select the TMS Agent tab
a. Set Enable TMS Agent Data Replication. b. Set Authentication Scheme to Digest. 3. Click Save Settings.
Note: This may take a while to complete (approximately 5 minutes); select the Activity Status page (see link at the top of the screen) to show the list of activities that are active, scheduled or in progress. Select the activity Enable TMS Agent Data Replication for system(s) <name of system>. This displays an activity log. Refresh this web page (button bottom left of this page) until the Activity Event completed successfully is reported.
Note: If TMS Agent Data Replication reports Disabled then there is a problem. On Cisco TMS select Administrative Tools > Activity Status and look for the Description `Enable TMS Agent Data Replication for system(s): <VCS name(s)>'. Click on the description for a full listing of the Activity log associated with this action. Identify and fix any reported problems.
On the web browser of this newly added Cisco VCS peer: 4. Check the Warnings page (Status > Warnings):
a. If required, restart the Cisco VCS.
· If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
b. If "Security Alert: the TMS agent database has the default LDAP password set" or "Security Alert: the TMS agent database has the default replication password set" appear, see the relevant section in `Appendix 6 ­ Troubleshooting'.
5. Check that the expected FindMe entries (from the Master Cisco VCS) exist on this Cisco VCS (Maintenance > Login accounts > User accounts).
On the command line interface of this newly added Cisco VCS peer: 6. Disable maintenance mode ­ from the Cisco VCS command line type:
xconfiguration SystemUnit Maintenance Mode: Off

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 19 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
Check replication status:
Note: It can take 5 or so minutes before Cisco VCS reports the successful status. If problems are seen, refresh the screen after waiting 5 minutes.
On each Cisco VCS currently added to the cluster: 7. Go to the Clustering page (VCS configuration > Clustering)
- Clustering status should show Status Enabled - VCS system configuration replication status should show Last synchronization result SUCCEEDED 8. If replication with Cisco TMS is enabled Select the link "View TMS Agent replication status" - check that the top line of the TMS Agent replication status report reports Replication Enabled
If there are other Cisco VCS peers to add to this cluster, upgrade them and add them into this cluster by completing "Upgrade non-master peers" and "Add an X6.1 VCS to the VCS X6.1 cluster" for all non-master peers.
Enable replication for the whole cluster
If Cisco TMS is used: 1. If Device Provisioning or FindMe is to be used in this cluster 2. Select Systems > Navigator (and any required sub folders) then select the Master Cisco VCS. 3. Select the Clustering tab
a. Set Enable TMS Agent Data Replication on all Cluster Peers. b. Click Save Cluster Settings.
Note: This may take a while to complete (approximately 5 minutes); select the Activity Status page (see link at the top of the screen) to show the list of activities that are active, scheduled or in progress. Select the activity Enable TMS Agent Data Replication for system(s) <name of system>. This displays an activity log. Refresh this web page (button bottom left of this page) until the Activity Event completed successfully is reported.
After the upgrade
Using Cisco TMS
If Cisco TMS is being used, verify the correct operation of TMS Agent by running TMS agent diagnostics: 1. Log into Cisco TMS. 2. Go to Administrative Tools > TMS Agent Diagnostics. 3. In the TMS Agent Browser panel on the left side of the page, select Local TMS Agent. 4. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent. 5. For each Cisco VCS peer:
a. In the TMS Agent Browser panel on the left side of the page, select the Cisco VCS peer. b. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent.
Note: If authentication is intentionally enabled on the Cisco VCS, ignore the warning `verify that authentication is disabled on the VCS'.
 If all tests are successful (all green check marks), the upgrade of an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster is complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 20 of 68

Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster
 If any errors are found (a red `X' will appear against failing tests), do not proceed further with this upgrade, but contact your Cisco Authorized Service Provider for further assistance to resolve the issues identified.
No Cisco TMS
If Cisco TMS is not used to monitor / manage Cisco VCS then check the Warnings page on the Cisco VCS (Status > Warnings) and ensure that all Warnings are acted upon and cleared.
Note: Use of Cisco TMS is required if Device Provisioning or FindMe is to be used with this cluster.
Upgrade an X5.1, X5.1.1, X5.2 or X6.0 cluster to an X6.1 cluster is complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 21 of 68

Create a new cluster of VCS X6.1 peers
Create a new cluster of VCS X6.1 peers
This process creates a cluster of a single Cisco VCS. To complete the cluster containing multiple Cisco VCSs, once this section is complete, follow the instructions in "Add an X6.1 VCS to a VCS X6.1 cluster" to add the non-master peers to the cluster. Do not use this process if the cluster already exists; instead, follow the instructions in "Add an X6.1 VCS to a VCS X6.1 cluster".
Note: If Device Provisioning or FindMe is to be used with an X6.1 VCS cluster, then use of Cisco TMS is essential. If neither Device Provisioning nor FindMe is to be used, then use of Cisco TMS is optional but recommended.
If Cisco TMS is to be used with this Cisco VCS cluster, ensure that it is running version 12.6 or later.
Prerequisites
 all Cisco VCSs to be included in the cluster must be running the same version of Cisco VCS software, and that version of software must be X6.1
 if Device Provisioning and FindMe are configured, they must have already been proven to be operational on the master Cisco VCS after its upgrade to X6.1
Set up the master peer of the cluster
This process sets up the first (Master) peer of this new cluster ­ additional peers are added afterwards using the "Add an X6.1 VCS to a VCS X6.1 cluster" process. 1. Determine which Cisco VCS will be the Master.
Note:
 The Master Cisco VCS will be the source of the configuration information for all Cisco VCS peers in the cluster. Non-master Cisco VCS peers will have their configuration deleted and replaced by that from the Master.
 FindMe information can only be kept if the relevant Cisco VCS is already configured to operate with Cisco TMS and is configured with Enable TMS Agent Data Replication. (FindMe information for clusters is stored on Cisco TMS; it is deleted on VCS and overwritten by the information from Cisco TMS when Enable TMS Agent Data Replication is first enabled.)
On neighbor Gatekeepers (GKs) and Border Controllers (BCs): 1. If the Master Cisco VCS has a traversal zone configured to connect with any GK or BC, upgrade
these systems to N6.1 or Q6.1 or later code. On this Master Cisco VCS: 1. Check that no other Cisco VCS (anywhere) has this Cisco VCS's IP address in their Alternates or
Clustering Peers list. 2. Check that the Cisco VCS is running X6.1 software. 3. Backup the Cisco VCS (See Appendix 1 for details). 4. On the web interface of this Master Cisco VCS, review the configuration to ensure that the Cisco
VCS has: · A valid Ethernet speed (System > Ethernet). · Valid IP address and IP gateway (System > IP).

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 22 of 68

Create a new cluster of VCS X6.1 peers
· The same set of option keys installed as those that will be installed on all other peers of the cluster (Maintenance > Option Keys).
· At least one valid DNS server configured, and that if unqualified DNS names are used elsewhere (e.g. for the NTP server), that the correct Domain name is also configured (Domain name is added as a suffix to an unqualified DNS name to make it into an FQDN) (System > DNS).
Note: <Local host name>.<DNS domain name> = FQDN of this Cisco VCS.
· A valid and working NTP server configured (System > Time; in the Status section, the State should be "Active").
· No peers configured (VCS configuration > Clustering ­ all Peer x IP address fields on this page should be blank. If not, delete any entries and click Save).
5. Ensure that this Cisco VCS does not list any of the Cisco VCSs that are to be peers in this new cluster in any of its neighbor zones or traversal zones (VCS configuration > Zones then check each neighbor and traversal zone).
6. Set the H.323 Time to live to 60 (seconds) so that if a Cisco VCS becomes inaccessible to an endpoint, the endpoint will re-register quickly with another peer (VCS configuration > Protocols > H.323).
7. Go to System > DNS and ensure that the Local host name is the DNS hostname for this Cisco VCS (typically the same as the System name in System > System, but excluding spaces, and unique for each Cisco VCS in the cluster); if not set it up appropriately and click Save.
Note: <Local host name>.<DNS domain name> = FQDN of this Cisco VCS.
8. Go to VCS configuration > Calls and set Call routed mode to Optimal. 9. Click Save.
Note: If Device Provisioning or FindMe is to be used with this X6.1 VCS cluster, then use of Cisco TMS is essential. If neither Device Provisioning nor FindMe is to be used, then use of Cisco TMS is optional but recommended.
If Cisco TMS is to be used, on the Master Cisco VCS: 1. Ensure that the Cisco VCS can see Cisco TMS.
To do this, select System > External Manager and in the Status section, ensure that the State is Active. (If not, follow the process on `Appendix 2 ­ Adding a Cisco VCS to Cisco TMS'). 2. Ensure that Cisco TMS can communicate with this Cisco VCS. To do this, on TMS select Systems > Navigator (and any required sub folders) then click on the name of the VCS and ensure that it says:
"System has no open or acknowledged tickets"
(If not, follow the process on `Appendix 2 ­ Adding a Cisco VCS to Cisco TMS').
On this Master Cisco VCS: 3. Check the Warnings page of the Cisco VCS to be added (Status > Warnings). If there is an
alarm that the Cisco VCS must be restarted, select Maintenance > Restart and then click Restart System.
· Warnings about TMS Agent passwords being default will be cleared when TMS Replication is enabled.
· If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
If Cisco TMS is to be used: 1. Ensure that the Host Name of this Master Cisco VCS is set up in Cisco TMS:

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 23 of 68

Create a new cluster of VCS X6.1 peers

a. Select Systems > Navigator (and any required sub folders). b. Select this Cisco VCS. c. Select the Connection tab. d. Set Host Name to be the FQDN of this Cisco VCS, for example vcs3.uk.company.com. e. Click Save/Try.
You can ignore any error messages like "DNS config failure resolving <DNS name>: Did not find system IP address () in DNS: <Server IP>" f. Ensure that Cisco TMS updates its DNS. i. Select the Settings tab. ii. Click Force Refresh.

For this Master Cisco VCS:
1. If Cisco TMS is configured to Enable TMS Agent Data Replication with this Cisco VCS (to check: on Cisco TMS go to Systems > Navigator (and any required sub folders) select this Cisco VCS and select the TMS Agent tab) then any user accounts that existed on this Cisco VCS can be kept for use in the new cluster ­ if they are not wanted, they should be deleted.
If Enable TMS Agent Data Replication is not enabled, no FindMe data will be available for merging.
If data is replicating with Cisco TMS:
a. If the user accounts held on this Cisco VCS are not wanted, delete any that exist:
i. Go to Maintenance > Login accounts > User accounts.
ii. Select all of the accounts shown and click Delete.
2. Enable maintenance mode. From the Cisco VCS command line type: xconfiguration SystemUnit Maintenance Mode: On
3. Wait for all calls to clear and registrations to timeout. If necessary, manually remove any calls that do not clear automatically (Status > Calls, then select the check box next to the calls you want to terminate and click Disconnect).
4. If necessary, manually remove any registrations that do not clear automatically (Status > Registrations > By device, then select the check box next to the devices you want to remove and click Unregister). You can leave the registration for the Conference Factory ­ this will not be the source of calls, and even if deleted will not roll over to another peer, as other peers have their own Conference Factory registration (if enabled).
5. Go to VCS configuration > Clustering and:
a. Check that Cluster name is the routable Fully Qualified Domain Name used in SRV records that address this Cisco VCS cluster, for example "cluster1.example.com". (See Appendix 10 ­ Cluster name and DNS SRV records).
b. If it is not, the Cluster name needs changing; follow the procedure in "Appendix 9 ­ Changing the cluster name".

Note: If the Cluster name is changed without following the procedure "Appendix 9 ­ Changing the cluster name" then any FindMe entries will be lost.

6. Click Save. 7. On the Clustering page (VCS configuration > Clustering) configure the fields as follows:

Configuration master 1

Cluster pre-shared key

Enter a password (any characters)

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 24 of 68

Create a new cluster of VCS X6.1 peers

Peer 1 IP address

Set to the IP address of this (the master peer) Cisco VCS

Note: If the Cisco VCS has dual network interfaces, the Peer IP address MUST specify the LAN 1 interface address.
8. Click Save. To the right of the Peer 1 IP address field the words "This VCS" should appear (though this may require the page to be refreshed before they appear).
9. Restart the Cisco VCS (select Maintenance > Restart, then select Restart system and confirm OK.).
After the restart, on the Master Cisco VCS web interface: 1. Check that the configuration (including Zone configuration, Transforms configuration, CPL and
other configuration for items from the System Configuration, VCS configuration and Application menus) is as expected. 2. Backup the Cisco VCS (See Appendix 1 for details).
On other devices:
 If you have any other Cisco VCSs, Gatekeepers or Border Controllers neighbored (or connected via a traversal zone) to this Master Cisco VCS peer, ensure that their zone configuration for this cluster is updated to only include the address of this Master Cisco VCS.
If Cisco TMS is used, on Cisco TMS: 1. Go to Systems > Navigator (and any required sub folders) and select this Master Cisco VCS 2. Select the TMS Agent tab:
a. Ensure that Enable TMS Agent Data Replication is selected. b. Ensure that Authentication Scheme is set to Digest. If any changes need to be made, click Save Settings.
Note: If TMS Agent Data Replication reports Disabled then there is a problem. On Cisco TMS select Administrative Tools > Activity Status and look for the Description `Enable TMS Agent Data Replication for system(s): <VCS name(s)>'. Click on the description for a full listing of the Activity log associated with this action. Identify and fix any reported problems.
On this Master Cisco VCS peer: 1. Log in to the web browser of this Cisco VCS. 2. Check the Warnings page (Status > Warnings):
a. If required, restart the Cisco VCS. b. If "Security Alert: the TMS agent database has the default LDAP password set" or "Security
Alert: the TMS agent database has the default replication password set" appear, see the relevant section in `Appendix 6 ­ Troubleshooting'. 3. Disable maintenance mode. From the Cisco VCS command line type: xconfiguration SystemUnit Maintenance Mode: Off

After the master peer configuration
If Cisco TMS is being used, verify the correct operation of TMS Agent by running TMS agent diagnostics: 1. Log into Cisco TMS. 2. Go to Administrative Tools > TMS Agent Diagnostics.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 25 of 68

Create a new cluster of VCS X6.1 peers
3. In the TMS Agent Browser panel on the left side of the page, select Local TMS Agent. 4. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent. 5. For this master Cisco VCS peer:
a. In the TMS Agent Browser panel on the left side of the page, select this Cisco VCS peer. b. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent.
Note: If authentication is intentionally enabled on the Cisco VCS, ignore the warning `verify that authentication is disabled on the VCS'
 If all tests are successful (all green check marks), proceed with the "Additional cluster configuration" instructions below.
 If any errors are found (a red `X' will appear against failing tests), do not proceed further with this upgrade, but contact your Cisco Authorized Service Provider for further assistance to resolve the issues identified.
No Cisco TMS
If Cisco TMS is not used to monitor / manage Cisco VCS then check the Warnings page on the Cisco VCS (Status > Warnings) and ensure that all Warnings are acted upon and cleared.
Note: Use of Cisco TMS is required if Device Provisioning or FindMe is to be used with this cluster.
Additional cluster configuration
 If Microsoft Office Communications Server 2007 (OCS) is to be connected to this cluster, see the section "Microsoft Office Communications Server 2007 (OCS)" in "Appendix 4 ­ Impact of clustering on other Cisco VCS applications".
Creation of the new cluster (of one Cisco VCS) is complete; add other Cisco VCSs to the cluster using "Add an X6.1 VCS to a VCS X6.1 cluster".

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 26 of 68

Add an X6.1 VCS to a VCS X6.1 cluster
Add an X6.1 VCS to a VCS X6.1 cluster
Follow this process if you have an existing X6.1 cluster (of one or more peers) to which you want to add another Cisco VCS peer. If you do not have an existing cluster, following the instructions in the section "Create a new cluster of VCS X6.1 peers".
Note: You can have up to 6 Cisco VCSs, including the master Cisco VCS, in a cluster.
This process will add an X6.1 VCS to the cluster and replicate the cluster Master's configuration onto the Cisco VCS.
Note:
 Cisco VCS clusters peers must all run the same version of code as the master, for example all X6.1.
 Only one Cisco VCS must be added to the cluster at a time.
On the Master Cisco VCS: 1. Ensure that the Master Cisco VCS does not list this new Cisco VCS peer in any of its neighbor
zones or traversal zones (VCS configuration > Zones then check each neighbor and traversal zone).
Note: The Master VCS will be the source of the configuration for this new VCS peer and all other VCS peers in the cluster. When a VCS is added to the cluster, its configuration will be deleted and replaced by that from the Master.
On the Cisco VCS to be added to the cluster: 1. Check that no other VCS (anywhere) has this VCS's IP address in their Alternates or Clustering
Peers list. 2. Check that the VCS software version is identical to the version running on the Master and any
other cluster peers of the existing cluster (X6.1). 3. Backup the VCS (See Appendix 1 for details).
On the web interface of the Cisco VCS being added: 4. Review the configuration to ensure that the Cisco VCS has:
· A valid Ethernet speed (System > Ethernet). · Valid IP address and IP gateway (System > IP). · The same set of Option keys as those installed on Master peer (Maintenance > Option
Keys). · At least one valid DNS server configured, and that if unqualified DNS names are used
elsewhere (e.g. for the NTP server), that the correct Domain name is also configured (Domain name is added as a suffix to an unqualified DNS name to make it into an FQDN) (System > DNS).
Note: <Local host name>.<DNS domain name> = FQDN of this Cisco VCS.
· A valid and working NTP server configured (System > Time; in the Status section, the State should be `Active').
· No peers configured (VCS configuration > Clustering ­ all Peer x IP address fields on this page should be blank. If not, delete any entries and click Save).

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 27 of 68

Add an X6.1 VCS to a VCS X6.1 cluster
If the cluster is managed by TMS, this VCS being added to the cluster must also be managed by TMS.
Note: If Device Provisioning or FindMe is to be used with an X6.1 VCS cluster, then use of Cisco TMS is essential. If neither Device Provisioning nor FindMe is to be used, then use of Cisco TMS is optional but recommended.
If Cisco TMS is to be used, on the Cisco VCS to be added to the cluster: 1. Ensure that the Cisco VCS can see Cisco TMS.
To do this, select System > External Manager and in the Status section, ensure that the State is Active. (If not, follow the process on `Appendix 2 ­ Adding a Cisco VCS to Cisco TMS'). 2. Ensure that Cisco TMS can communicate with this Cisco VCS. To do this, on TMS select Systems > Navigator (and any required sub folders) then click on the name of the VCS and ensure that it says:
"System has no open or acknowledged tickets"
(If not, follow the process on `Appendix 2 ­ Adding a Cisco VCS to Cisco TMS').
On the Cisco VCS being added to the cluster: 1. Check the Warnings page of the Cisco VCS to be added (Status > Warnings). If there is a
warning that the Cisco VCS must be restarted, select Maintenance > Restart and then click Restart System.
· Warnings about TMS Agent passwords being default can be ignored as they will be cleared when TMS Replication is enabled.
· If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
If Cisco TMS is to be used: 1. For the VCS to be added to the cluster, ensure that the Host Name of the VCS is set up in TMS:
a. Select Systems > Navigator (and any required sub folders). b. Select this Cisco VCS c. Select the Connection tab. d. Set Host Name to be the FQDN of this non-master peer, for example vcs3.uk.company.com. e. Click Save/Try.
You can ignore any error messages like "DNS config failure resolving <DNS name>: Did not find system IP address () in DNS: <Server IP>" f. Ensure that Cisco TMS updates its DNS. i. Select the Settings tab. ii. Click Force Refresh.
If Cisco TMS is configured to Enable TMS Agent Data Replication with this Cisco VCS being added to the cluster (to check this: on Cisco TMS go to Systems > Navigator - and any required sub folders - select this Cisco VCS and select the TMS Agent tab) then any user accounts that existed on the Cisco VCS should be deleted.
If Enable TMS Agent Data Replication is not enabled, no FindMe data will be stored on TMS.
If TMS Agent data is replicating with Cisco TMS: a. Delete any user accounts that exist. On the Cisco VCS being added to the cluster:
i. Go to Maintenance > Login accounts > User accounts. ii. Select all of the accounts shown and click Delete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 28 of 68

Add an X6.1 VCS to a VCS X6.1 cluster
For the master Cisco VCS in the cluster 1. Select Systems > Navigator (and any required sub folders), then click on the Master Cisco VCS
of the cluster. 2. Select the Clustering tab. 3. Clear the Enable TMS Agent Data Replication on all Cluster Peers check box (if it was set). 4. Click Save Cluster Settings.
Note: This disables database replication from Cisco TMS to each cluster peer.
 Provisioning data will no longer be updated from Cisco TMS to the Cisco VCSs, however provisioning of endpoints from data cached on Cisco VCSs will continue.
 VCS cluster configuration replication will continue.
 VCS FindMe replication among Cisco VCS peers will continue.
For each Cisco VCS in the cluster (including the Master and the Cisco VCS being added to the cluster), in Cisco TMS: 1. Select Systems > Navigator (and any required sub folders). 2. Select the Cisco VCS. 3. Select the TMS Agent tab. 4. Clear the Enable TMS Agent Data Replication check box. 5. Click Save Settings.
On the Cisco VCS being added to the cluster: 1. Enable maintenance mode.
From the Cisco VCS command line type: xconfiguration SystemUnit Maintenance Mode: On
2. Wait for all calls to clear and registrations to timeout. If necessary, manually remove any calls that do not clear automatically (Status > Calls, then select the check box next to the calls you want to terminate and click Disconnect).
3. If necessary, manually remove any registrations that do not clear automatically (Status > Registrations > By device, then select the check box next to the devices you want to remove and click Unregister). You can leave the registration for the Conference Factory ­ this will not be the source of calls, and even if deleted will not roll over to another peer, as other peers have their own Conference Factory registration (if enabled).
On the Master Cisco VCS: 1. On the Clustering page (VCS configuration > Clustering), one or more of the Peer x IP
address fields should be empty. In the first empty field, enter the IP address of the new Cisco VCS peer.
Note:
 Only one Cisco VCS must be added to the cluster at a time (repeat the whole process if multiple Cisco VCS peers are being added).
 If the new Cisco VCS peer has dual network interfaces, the peer IP address MUST specify the LAN 1 interface address.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 29 of 68

Add an X6.1 VCS to a VCS X6.1 cluster
2. Click Save. Peer 1 should indicate `This VCS'. The new peer may indicate `Unknown' and then with a refresh should indicate `Failed' as the Cisco VCS is not completely added to the cluster.
Note:
 A cluster communication failure warning will be raised on the master and on other non-master peers already in the cluster advising that this new Cisco VCS peer is not communicating ­ this will clear later.
 Cluster configuration replication is suspended at this point until the new Cisco VCS has been completely added. Any changes made to the configuration of the cluster will not be replicated until this Cisco VCS has been completely added

On every other non-master Cisco VCS already in the cluster (not the Cisco VCS being added): 1. On the Clustering page (VCS configuration > Clustering) configure the fields as follows:

Cluster name

Identical to the Cluster name configured on the master Cisco VCS

Cluster pre-shared key

Identical to that configured on the Master Cisco VCS

Configuration master Identical to that configured on the Master Cisco VCS

Peer 1 IP address ... Peer 6 IP address

Identical to those configured on the Master Cisco VCS

2. Click Save.

On the Cisco VCS being added to the cluster: 1. Log in as admin on an SSH or other CLI interface. At the Cisco VCS command prompt, type:
xcommand DefaultValuesSet Level: 2

Note: This command will wipe any LDAP Authentication configuration ­ ensure that you have the web admin password before executing this command.

2. Go to the Administrator accounts page (Maintenance > Login accounts > Administrator accounts).
3. Delete all entries except the default admin account.
4. Go to System > DNS and ensure that Local host name is the DNS hostname for this Cisco VCS (typically the same as the System name in System > System, but excluding spaces, and unique for each Cisco VCS in the cluster); if not set it up appropriately and click Save.

Note: <Local host name>.<DNS domain name> = FQDN of this Cisco VCS.

5. On the Clustering page (VCS configuration > Clustering) configure the fields as follows:

Cluster name

Identical to the Cluster name configured on the Master Cisco VCS

Cluster pre-shared key

Identical to that configured on the Master Cisco VCS

Configuration master Identical to that configured on the Master Cisco VCS

Peer 1 IP address ... Peer 6 IP address

Identical to those configured on the Master Cisco VCS

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 30 of 68

Add an X6.1 VCS to a VCS X6.1 cluster
6. Click Save.
Note: A cluster communication failure warning will be raised on this Cisco VCS peer advising that this new Cisco VCS is not communicating ­ this will clear after the restart.
7. Restart the Cisco VCS: a. On the Maintenance > Restart page, click Restart system. b. Confirm the restart by clicking OK. If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
On the Cisco VCS being added to the cluster: 8. Wait approximately 2 minutes ­ this is the frequency with which configuration is copied from the
Master. 9. Check the Warnings page of the newly added Cisco VCS (Status > Warnings). If there is an
alarm that the Cisco VCS must be restarted, select Maintenance > Restart and then click Restart System. · Warnings about TMS Agent passwords being default can be ignored; they will be cleared
when TMS Replication is enabled. · If multiple peers need restarting: restart each peer in turn, waiting for the peer to be
accessible through the web interface before restarting the next peer. 10. Check that the configuration (including zone configuration, transforms configuration, CPL and
other configuration for items from the System Configuration, VCS configuration and Application menus) is as expected (not FindMe -- this will be replicated later) as per the Master Cisco VCS.
On other devices:  If you have any other Cisco VCSs, Gatekeepers or Border Controllers neighbored (or connected
via a traversal zone) to this cluster of Cisco VCS peers, ensure that their zone configuration for this cluster is updated to include the address of this new peer.
If Cisco TMS is used, and if Device Provisioning or FindMe are to be used in this cluster, on TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Master Cisco VCS. 2. Select the Clustering tab
a. Ensure that Enable TMS Agent Data Replication on all Cluster Peers is selected, if it is not, select it and click Save Cluster Settings or Create Cluster as appropriate.
3. Go to Systems > Navigator (and any required sub folders) then select the new Cisco VCS to be added to this cluster.
4. Select the TMS Agent tab a. Ensure that Enable TMS Agent Data Replication is selected. b. Ensure that Authentication Scheme is set to Digest.
5. If any changes need to be made, click Save Settings.
Note: If TMS Agent Data Replication reports Disabled then there is a problem. On Cisco TMS select Administrative Tools > Activity Status and look for the Description `Enable TMS Agent Data Replication for system(s): <VCS name(s)>'. Click on the description for a full listing of the Activity log associated with this action. Identify and fix any reported problems.
On each Cisco VCS peer: 1. Log in to the web browser of the new Cisco VCS peer.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 31 of 68

Add an X6.1 VCS to a VCS X6.1 cluster
2. Check the Warnings page (Status > Warnings): a. If required, restart the Cisco VCS. b. If "Security Alert: the TMS agent database has the default LDAP password set" or "Security Alert: the TMS agent database has the default replication password set" appear, see the relevant section in `Appendix 6 ­ Troubleshooting'. If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
3. Check that the expected FindMe entries (from the Master Cisco VCS) exist on this Cisco VCS (Maintenance > Login accounts > User accounts).
Check replication status:
Note: It can take 5 or so minutes before Cisco VCS reports the successful status. If problems are seen, refresh the screen after waiting 5 minutes.
On Cisco VCS: 1. Go to the Clustering page (VCS configuration > Clustering):
· Clustering status should show Status Enabled. · VCS system configuration replication status should show Last synchronization result
SUCCEEDED. 2. If replication with Cisco TMS is enabled:
a. Select the link "View TMS Agent replication status". b. Check that the top line of the TMS Agent replication status report reports Replication
Enabled.
If TMS is being used, ensure that it has all the correct settings for this upgraded VCS by forcing a refresh of TMS. 1. For every Cisco VCS in the cluster (including the Master Cisco VCS):
a. Select Systems > Navigator (and any required sub folders) and click on the name of the Cisco VCS.
b. Select the Settings tab. c. Click Force Refresh. 2. Repeat for all Cisco VCS peers in the cluster.
After adding the Cisco VCS peer to the cluster
If Cisco TMS is being used, verify the correct operation of TMS Agent by running TMS agent diagnostics: 1. Log into Cisco TMS. 2. Go to Administrative Tools > TMS Agent Diagnostics. 3. In the TMS Agent Browser panel on the left side of the page, select Local TMS Agent. 4. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent. 5. For each Cisco VCS peer:
a. In the TMS Agent Browser panel on the left side of the page, select the Cisco VCS peer. b. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent.
Note: If authentication is intentionally enabled on the Cisco VCS, ignore the warning `verify that authentication is disabled on the VCS'.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 32 of 68

Add an X6.1 VCS to a VCS X6.1 cluster
 If all tests are successful (all green check marks), proceed with the "Additional cluster configuration" instructions below.
 If any errors are found (a red `X' will appear against failing tests), do not proceed further with this upgrade, but contact your Cisco Authorized Service Provider for further assistance to resolve the issues identified.
Additional cluster configuration
 If Conference Factory (MultiwayTM) is to be used, see the section "Conference Factory (MultiwayTM)" in "Appendix 4 ­ Impact of clustering on other Cisco VCS applications".
Add an X6.1 VCS to a VCS X6.1 cluster is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 33 of 68

Remove a live Cisco VCS from a VCS X6.1 cluster (permanently)
Remove a live Cisco VCS from a VCS X6.1 cluster (permanently)
This process will remove one Cisco VCS peer from an existing cluster. FindMe and configuration replication to this Cisco VCS will be stopped and the Cisco VCS will no longer be included in the list of peers in the cluster. Provisioning will also be disabled on the removed Cisco VCS.  If the whole cluster is to be disbanded then use the procedure defined in "Disband a VCS X6.1
cluster".  If the cluster peer to be removed is not accessible, use the procedure defined in "Remove an out-
of-service Cisco VCS from a VCS X6.1 cluster (permanently)".
1. Ensure that the Cisco VCS to be removed from the cluster is not indicated as the Master peer. If it is the Master, see the section "Change the master peer of a VCS X6.1 cluster" for instructions on how to make a different peer the master.
If Cisco TMS is used, on Cisco TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Cisco VCS to be
removed. 2. Select the TMS Agent tab. 3. Clear the Enable TMS Agent Data Replication check box. 4. Click Save Settings. On the Cisco VCS that is being removed: 1. Log into the web interface. 2. Go to the Clustering page ( VCS configuration > Clustering):
a. Change the Cluster name to a unique ID for this Cisco VCS (ideally to the routable Fully Qualified Domain Name used in SRV records that address this individual Cisco VCS, for example "vcs1.example.com". (See Appendix 10 ­ Cluster name and DNS SRV records.)) Note: Do NOT use the process "Appendix 9 ­ Changing the cluster name (and keeping FindMe accounts)" because FindMe accounts are to be left with the cluster that this Cisco VCS is being removed from.
b. Delete the Cluster pre-shared key. c. Delete all entries in the Peer x IP address fields. 3. Click Save.
Note:
 FindMe users will not be available on this removed Cisco VCS (they will be left available on the cluster).
 A warning similar to that shown below may appear on the web interface and CLI of the Cisco VCS being removed. This is not a problem, the warning will be cleared when the Cisco VCS is restarted:

4. Go to the OCS Relay page (Applications > OCS Relay). · If Mode = On change it to Mode = Off and click Save.
5. Restart the Cisco VCS (Maintenance > Restart and then click Restart System).

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 34 of 68

Remove a live Cisco VCS from a VCS X6.1 cluster (permanently)
On the Master Cisco VCS: 1. Log into the web interface. 2. On the Clustering page (VCS configuration > Clustering) delete the IP address of the Cisco
VCS that has been removed. 3. If the Cisco VCS being removed is not the last field in the list, move any other IP addresses up the
list so that there are no empty fields between entries. 4. If the master Cisco VCS peer's IP address has been moved up the list in the previous step, alter
the Configuration master value to match its new location. 5. Click Save.
On all the remaining non-master Cisco VCS peers: 1. Log into the web interface. 2. On the Clustering page (VCS configuration > Clustering) edit the Peer x IP address and
Configuration master fields so that they are identical to those configured on the Master Cisco VCS. 3. Click Save. 4. Repeat for all remaining non-master Cisco VCS peers until they all have identical clustering configuration.
On other devices: 1. If you have any other Cisco VCSs, Gatekeepers or Border Controllers neighbored (or connected
via a traversal zone) to this cluster of Cisco VCS peers, ensure their zone configuration for this cluster is updated to exclude the address of the removed peer. 2. If you have any endpoints registering to the Cisco VCS that has now been removed, change the configuration of the endpoint (or the configuration of the DNS server entry that points to the cluster peers) so that they register to one of the remaining clustered Cisco VCS peers instead.
Warning: The removed Cisco VCS will retain its configuration at the time it is removed from the cluster, and will continue to function as a non-clustered Cisco VCS. It is recommended that after it has been removed from the cluster it is taken out of service (e.g. perform xcommand DefaultValuesSet Level: 2 and xcommand DefaultLinksAdd) or the Cisco VCS is reconfigured with an alternative configuration, so that other devices no longer try to use it as a cluster peer.
Reconfigure Cisco TMS
If Cisco TMS is used, on Cisco TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Master Cisco VCS. 2. Select the Clustering tab. 3. Click Update Cluster in TMS.
After the removal
If Cisco TMS is being used, verify the correct operation of TMS Agent by running TMS agent diagnostics: 1. Log into Cisco TMS. 2. Go to Administrative Tools > TMS Agent Diagnostics. 3. In the TMS Agent Browser panel on the left side of the page, select Local TMS Agent.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 35 of 68

Remove a live Cisco VCS from a VCS X6.1 cluster (permanently)
4. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent. 5. For each Cisco VCS peer:
a. In the TMS Agent Browser panel on the left side of the page, select the Cisco VCS peer. b. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent.
Note: If authentication is intentionally enabled on the Cisco VCS, ignore the warning `verify that authentication is disabled on the VCS'
 If all tests are successful (all green check marks), Removing a live Cisco VCS from a cluster is now complete.
 If any errors are found (a red `X' will appear against failing tests), do not proceed further with this upgrade, but contact your Cisco Authorized Service Provider for further assistance to resolve the issues identified.
Removing a live Cisco VCS from a cluster is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 36 of 68

Remove an out-of-service Cisco VCS from a VCS X6.1 cluster (permanently)
Remove an out-of-service Cisco VCS from a VCS X6.1 cluster (permanently)
Use the following procedure if:
 the Cisco VCS is dead and needs to be RMAd, or
 the Cisco VCS cannot be accessed for some other reason If the whole cluster is to be disbanded then use the procedure defined in "Disband a VCS X6.1 cluster".
If the cluster peer to be removed is accessible, use the procedure defined in "Remove a live Cisco VCS from a VCS X6.1 cluster (permanently)" which clears up the removed Cisco VCS as well as its previous peers.
Note: This procedure does not delete clustering configuration from the removed Cisco VCS. Once removed, you must not reconnect the out-of-service Cisco VCS without first deleting all of its peers and stopping FindMe and configuration replication (see the section below "Before you reconnect the out-of-service Cisco VCS back to the network").
1. Ensure that the Cisco VCS to be removed from the cluster is not indicated as the Master Cisco VCS on Cisco TMS. If it is the Master Cisco VCS, see the section "Change the master peer of a VCS X6.1 cluster" for instructions on how to make a different peer the master.
If Cisco TMS is used, on Cisco TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Cisco VCS to be
removed. 2. Select the TMS Agent tab. 3. Clear the Enable TMS Agent Data Replication check box. 4. Click Save Settings.
On the Master Cisco VCS: 1. Log into the web interface. 2. On the Clustering page (VCS configuration > Clustering) delete the IP address of the Cisco
VCS that has been removed. 3. If the Cisco VCS being removed was not the last in the list, move any other IP addresses up the
list so that there are no empty fields between entries
· If this results in the master Cisco VCS peer's IP address moving up the list, alter the Configuration master value to match its new location.
4. Click Save. On all the remaining non-master Cisco VCS peers: 1. Log into the web interface. 2. On the Clustering page (VCS configuration > Clustering) edit the Peer x IP address and
Configuration master fields so that they are identical to that set on the Master Cisco VCS. 3. Click Save. 4. Repeat for all remaining non-master Cisco VCS peers. On other devices: 1. If you have any other Cisco VCSs, Gatekeepers or Border Controllers neighbored (or connected
via a traversal zone) to this cluster of Cisco VCS peers, ensure their zone configuration for this cluster is updated to exclude the address of the removed peer.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 37 of 68

Remove an out-of-service Cisco VCS from a VCS X6.1 cluster (permanently)
2. If you have any endpoints registering to the Cisco VCS that has now been removed, change the configuration of the endpoint (or the configuration of the DNS server entry that points to the cluster peers) so that they register to one of the remaining clustered Cisco VCS peers instead.
Reconfigure Cisco TMS
If Cisco TMS is used, on Cisco TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Master Cisco VCS. 2. Select the Clustering tab. 3. Click Update Cluster in TMS.
After the removal
If Cisco TMS is being used, verify the correct operation of TMS Agent by running TMS agent diagnostics: 1. Log into Cisco TMS. 2. Go to Administrative Tools > TMS Agent Diagnostics. 3. In the TMS Agent Browser panel on the left side of the page, select Local TMS Agent. 4. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent. 5. For each Cisco VCS peer:
a. In the TMS Agent Browser panel on the left side of the page, select the Cisco VCS peer. b. Click Run All Diagnoses to run the diagnostic tests on the Local TMS Agent.
Note: If authentication is intentionally enabled on the Cisco VCS, ignore the warning `verify that authentication is disabled on the VCS'.
 If all tests are successful (all green check marks), removing an out-of-service Cisco VCS from a cluster is now complete.
 If any errors are found (a red `X' will appear against failing tests), do not proceed further with this upgrade, but contact your Cisco Authorized Service Provider for further assistance to resolve the issues identified.
Removing an out-of-service Cisco VCS from a cluster is now complete.
Before you reconnect the out-of-service Cisco VCS back to the network
If the removed Cisco VCS is ever recovered, before you reconnect it you must: 1. Run the command xcommand DefaultValuesSet level: 2 and xcommand
DefaultLinksAdd from the CLI. This ensures that the configuration of the recovered Cisco VCS is returned to default and it will not interact with its ex-peers.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 38 of 68

Disband a VCS X6.1 cluster
Disband a VCS X6.1 cluster
This process will remove all Cisco VCS peers from an existing cluster. FindMe and configuration replication will be stopped, as will provisioning, and the cluster will be deleted from Cisco TMS. Each Cisco VCS will retain its configuration at the time the cluster was disbanded, and will function as a stand-alone Cisco VCS.
Warning: If any of the Cisco VCSs are left in operation after being removed from the cluster, calls between endpoints registered to different Cisco VCSs that were once part of the same cluster will not succeed. This is because after the cluster has been disbanded, the Cluster Subzone will no longer exist and there will not be any link between the two Cisco VCSs over which calls can be routed. To overcome this, you must create neighbor relationships between the Cisco VCSs so that there are links between them.
 If any Cisco VCS is not accessible, firstly remove it using the procedure "Remove an out-ofservice Cisco VCS from a VCS X6.1 cluster (permanently)".
If TMS is used, on Cisco TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Master Cisco VCS. 2. Select the Clustering tab. 3. Clear the Enable TMS Agent Data Replication on all Cluster Peers. 4. Click Save Cluster Settings. 5. Select the TMS Agent tab. 6. Ensure that Enable TMS Agent Data Replication is not selected; if this needs changing, change
it and click Save Settings.
If TMS is used, on Cisco TMS, for every non-master Cisco VCS peer: 1. Select Systems > Navigator (and any required sub folders) then click on the non-master Cisco
VCS. 2. Select the TMS Agent tab. 3. Ensure that Enable TMS Agent Data Replication is not selected; if this needs changing, change
it and click Save Settings. 4. Repeat for all non-master Cisco VCS peers ­ Cisco TMS may require you to pause between
disabling each peer.
On each non-master Cisco VCS peer: 1. Log into the web interface. 2. From the Clustering page ( VCS configuration > Clustering):
a. Change the Cluster name to a unique ID for this Cisco VCS (ideally to the routable Fully Qualified Domain Name used in SRV records that address this individual Cisco VCS, for example "vcs1.example.com", "vcs2.example.com". etc. (See Appendix 10 ­ Cluster name and DNS SRV records.)) Note: Do NOT use the process "Appendix 9 ­ Changing the cluster name (and keeping FindMe accounts)" because FindMe accounts are to be left with the master peer of the cluster that this Cisco VCS is being removed from.
b. Delete the Cluster pre-shared key. c. Delete all entries in the Peer x IP address fields. 3. Click Save.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 39 of 68

Disband a VCS X6.1 cluster
Note:
 FindMe users will not be available on non-master Cisco VCSs (they will only be left available on the master).
 A Warning similar to that shown below may appear on the web interface and CLI of the Cisco VCS being removed. This is not a problem, the warning will be cleared when the Cisco VCS is restarted:

4. Go to the OCS Relay page (Applications > OCS Relay).
· If Mode = On change it to Mode = Off and click Save. 5. Restart the Cisco VCS (Maintenance > Restart and then click Restart System).
If multiple peers need restarting, restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next. 6. Repeat for each non-master Cisco VCS.
On the Master Cisco VCS: 1. Log into the web interface. 2. If the Cluster name is to be changed on this Master Cisco VCS, FindMe information should be
deleted, so that the database is not left with unused user accounts. a. Delete all FindMe entries:
i. Go to Maintenance > Login accounts > User accounts. ii. Select each account and click Delete. 3. Go to the Clustering page ( VCS configuration > Clustering). a. Optionally change the Cluster name to a unique ID for this Cisco VCS (ideally to the routable Fully Qualified Domain Name used in SRV records that address this individual Cisco VCS, for example "vcs1.example.com". (See Appendix 10 ­ Cluster name and DNS SRV records.)) b. Delete the Cluster pre-shared key. c. Delete all entries in the Peer x IP address fields. 4. Click Save.
Note: A Warning similar to that shown below may appear on the web interface and CLI of the Cisco VCS being removed. This is not a problem, the warning will be cleared when the Cisco VCS is restarted:

5. Restart the Cisco VCS (Maintenance > Restart and then click Restart System).
On other devices:
1. If you have any other Cisco VCSs, Gatekeepers or Border Controllers neighbored (or connected via a traversal zone) to this cluster of Cisco VCS peers, ensure that they have those zones removed, or modified appropriately.
2. If you have any endpoints registering to this Cisco VCS cluster, change the configuration of the endpoints (or the configuration of the DNS server entry that points to the cluster peers) so that they now register with an appropriate Cisco VCS.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 40 of 68

Disband a VCS X6.1 cluster
Reconfigure Cisco TMS
If TMS is used, on Cisco TMS: 1. Select Systems > Navigator (and any required sub folders) then select the Master Cisco VCS. 2. Select the Clustering tab. 3. In the Cluster Settings section click Delete Cluster. 4. Confirm that you really want to delete the cluster by clicking Delete.
Cisco TMS will report "Cluster successfully deleted".
Disband a cluster of Cisco VCSs is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 41 of 68

Change the master peer of a VCS X6.1 cluster
Change the master peer of a VCS X6.1 cluster
Changing the master peer where the old master is or is not accessible
Note: The operations in this process should be performed in one go so that the cluster is not left in a state where there are multiple Cisco VCSs which think they are cluster Master.
On the "new" Master Cisco VCS: 1. Go to the Clustering page (VCS configuration > Clustering) and from the Configuration
master drop-down menu select the ID number of the Peer entry that says `This VCS'. 2. Click Save.
While performing this change of master peer, ignore any warnings on VCS that report `Cluster master mismatch' or `Cluster replication error' ­ they will be rectified as part of this procedure. If the "old" Master Cisco VCS is accessible, on the "old" Master Cisco VCS: 1. On the Clustering page (VCS configuration > Clustering) from the Configuration master drop-down menu select the ID number of the "new" Master Cisco VCS. 2. Click Save. For all other non-master Cisco VCS peers, on that Cisco VCS: 1. Go to the Clustering page (VCS configuration > Clustering) and from the Configuration master drop-down menu select the ID number of the "new" Master Cisco VCS. 2. Click Save. On each Cisco VCS in the cluster (including the master): 1. Confirm that the change to the Configuration master has been accepted by going to VCS configuration > Clustering and refreshing the page. 2. If any Cisco VCSs have not accepted the change, repeat the steps above. 3. Check the Status section: · Clustering status should show Status Enabled · VCS system configuration replication status should show Last synchronization result
SUCCEEDED
Note: After approximately 2 minutes any warnings raised on the Cisco VCS peers that relate to `Cluster master mismatch' and `Cluster replication error' should automatically clear.
Reconfigure Cisco TMS
No changes are required; TMS will see the master change on the VCS cluster and report this appropriately.
If the old master is not available
If you are changing the Master because the "old" Master is not accessible, remove the "old" Master using the "Remove an out-of-service Cisco VCS from a VCS X6.1 cluster (permanently)" procedure. If the "old" Master was not accessible when changing the master peer of the Cisco VCS cluster, but later becomes available, you must bring it back into the cluster using the "Add an X6.1 VCS to a VCS X6.1 cluster" procedure. Changing the master peer of a Cisco VCS cluster is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 42 of 68

Change the IP address of a VCS X6.1 peer
Change the IP address of a VCS X6.1 peer
To change the IP address of a Cisco VCS peer you must remove the Cisco VCS from the cluster, change its IP address, and then add the Cisco VCS back into the cluster. The process is as follows: 1. Ensure that the Cisco VCS whose IP address is to be changed is not the Master Cisco VCS.
If it is the Master Cisco VCS, follow the steps in the section "Change the master peer of a VCS X6.1 cluster" to make a different peer the Master. 2. Carry out the process documented in "Remove a live Cisco VCS from a VCS X6.1 cluster (permanently)". 3. Change the IP address of the Cisco VCS. 4. Carry out the process documented in "Add an X6.1 VCS to a VCS X6.1 cluster".
Changing the IP address of a Cisco VCS peer is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 43 of 68

Appendix 1 ­ Backing up a Cisco VCS
Appendix 1 ­ Backing up a Cisco VCS
Backing up a pre X3.0 VCS
To save the configuration of a Cisco VCS running a version of code prior to X3.0: 1. Log in as admin on an SSH or other CLI interface. At the command prompt type:
xconfiguration 2. Copy the results to a text file and save it.
To save the VCS FindMe data and certificates: 1. Log into the Cisco VCS CLI as root and save:
a. persistent/policy/policy.xml b. persistent/oti/*.* c. persistent/certs/*.*
Backing up an X3.0 or later Cisco VCS
1. On the Cisco VCS web interface go to Maintenance > Backup and restore. 2. Click Create System Backup File and save the file. 3. If Cisco VCS is X5 or later:
a. Click Create TMS Agent backup file and save the file (this backs up FindMe entries that are in X5 FindMe database format).
Note:
 If the TMS Agent backup is restored (uploaded) to Cisco VCS then: from a root login run "tmsagent_reindex_database" to ensure the uploaded data is linked into the database correctly.
 A TMS Agent backup contains the whole of the Cisco TMS's provisioning and FindMe database (for all clusters and non-clustered Cisco VCSs with which Cisco TMS is replicating). It is saved for emergency use only ­ if restored to a cluster it will only get overwritten by the Cisco TMS data. It can be restored to a non-clustered Cisco VCS that is not replicating with Cisco TMS.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 44 of 68

Appendix 2 ­ Adding a Cisco VCS to Cisco TMS
Appendix 2 ­ Adding a Cisco VCS to Cisco TMS
On the Cisco VCS: 1. Go to the SNMP page (System > SNMP) and ensure that:
a. SNMP mode is set to v3 plus TMS support or v2c. b. Community name is set to public. (If SNMP was previously disabled, an alarm may appear indicating the need for a restart. If a restart is required, go to Maintenance > Restart and click Restart System.) If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer. 2. Go to the External Manager page (System > External Manager) and ensure that: a. Address is set to the IP Address or FQDN of Cisco TMS. b. Path is set to tms/public/external/management/SystemManagementService.asmx. c. If the Protocol is HTTPS and Certificate verification mode is On then you must load the
relevant certificates before the connection can become `Active'. See document "D50520 Implementing Secure Management" for details. d. If the Protocol is HTTP or Certificate verification mode is Off, no certificates need to be loaded. 3. Click Save.
The Status section of the External Manager page should show a State `Active' or `Initialising'.1
On Cisco TMS: 1. Select Systems > Navigator. 2. Select (or create) an appropriate folder in which to put the Cisco VCS (in the example below the
folder has been called "Cluster"):

3. Click Add Systems.
4. In section "1. Specify Systems by IP addresses or DNS names", enter the IP address or DNS name of the Cisco VCS.
5. Click Next.

1 TMS may force protocol to be HTTPS. The configuration for this is found in TMS Administrative Tools > Configuration >
Network settings. The protocol will be forced to HTTPS if, in the TMS Services section Enforce Management Settings on Systems is set to On and in the Secure-Only Device Communication section Secure-Only Device Communication is set to On.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 45 of 68

Appendix 2 ­ Adding a Cisco VCS to Cisco TMS
 6. Look for System added.  If an error occurs, e.g. " Wrong Password", click on the Edit System link and correct the
problem (enter the root password of the Cisco VCS). 7. Click Finish Adding Systems, Add System despite warnings or Add More Systems as
appropriate. 8. If `Could not connect to system. Details: No SNMP response' is reported, go to the Connection
tab and type `public' into the SNMP Get Community Name and select Save/Try. 9. If the Cisco VCS password is not default, set this up in the Connection tab or in Settings > Edit
Settings.
 If the Cisco VCS was already configured in Cisco TMS, ensure that it has the correct IP address (in Cisco TMS, go to Systems > Navigator (and any required sub folders), select the Cisco VCS, and from the Connection tab check the IP Address field).
On Cisco VCS: 1. Go to the External Manager page (System > External Manager). The State should now show
State Active.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 46 of 68

Appendix 3 ­ IP port numbers
Appendix 3 ­ IP port numbers
For cluster communications (between Cisco VCS peers / Cisco TMS):  IP port 22 (TCP) is used for Cisco VCS cluster configuration synchronization  IP port 389 (TCP) is used for diagnostics  IP port 636 (TCP) is reserved, currently not used  IP port 8989 (TCP) is used for FindMe and provisioning data synchronization replication  IP port 4444 (TCP) is used for FindMe and provisioning data synchronization administration from
Cisco TMS to Cisco VCS
For cluster communications (between Cisco VCS peers):  IP port 500 (UDP) for PKI (Public Key Infrastructure) key exchange  Standard SIP and H.323 ports are used for calls  IP port 1719 (UDP) is used for bandwidth updates between Cisco VCS peers  IP port 4369 (TCP) from IP port 4369 or an ephemeral port for Erlang database connection control  IP port 4371 (TCP) from IP port 4371 or an ephemeral port for Erlang database communication  IP port 4372 (TCP) from IP port 4372 or an ephemeral port for Erlang database copy  IP port 4373 (TCP) from IP port 4373 or an ephemeral port for Erlang database copy
... and on to  IP port 4380 (TCP) from IP port 4380 or an ephemeral port for Erlang database copy
It is unusual to have any sort of firewall between cluster peers, but if there is, all these IP ports must be open between each and every Cisco VCS peer in the cluster.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 47 of 68

Appendix 4 ­ Impact of clustering on other Cisco VCS applications
Appendix 4 ­ Impact of clustering on other Cisco VCS applications
Conference Factory (MultiwayTM)
 The Conference Factory application configuration is NOT replicated across a cluster.  The Conference Factory template MUST be DIFFERENT on each of the Cisco VCS peers.
When configuring a cluster to support Multiway: 1. Set up the same Conference Factory alias (the alias called by the endpoint to initiate a Multiway
conference) on each peer. 2. Set up a different Conference Factory template on each peer (so that each peer generates
unique Multiway conference IDs).
For example, if the MCU service prefix for ad hoc conferences is 775 then the Master Cisco VCS may have a template of 775001%%@domain, peer 2 a template of 775002%%@domain, and peer 3 a template of 775003%%@domain. In this way whichever Cisco VCS serves the conference ID, it cannot serve a conference ID that any other Cisco VCS could have served. The same applies across a network. If there is more than one Cisco VCS or Cisco VCS cluster that provides Conference Factory functionality in a network, each and every Cisco VCS must provide values in a unique range, so that no two Cisco VCSs can serve the same conference ID.
Microsoft Office Communications Server 2007 (OCS)
If OCS is to be configured to operate with an X6.1 VCS cluster, see the "Cisco VCS deployment guide ­ Microsoft OCS 2007 (R1 and R2) and Cisco VCS Control (X6)". Some parameters on Cisco VCS, such as:  Call routed mode  H.323  SIP interworking mode need setting according to that guide rather than this clustering guide.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 48 of 68

Appendix 5 ­ Configuring endpoints to work with a Cisco VCS cluster
Appendix 5 ­ Configuring endpoints to work with a Cisco VCS cluster
When configuring endpoints it is desirable for them to know about all the Cisco VCS peers in a cluster, so that at initial registration or later, if they lose connection to their Cisco VCS peer, they have the ability to register with and use another peer in the Cisco VCS cluster. SIP and H.323 endpoints behave differently ­ the following sections show the methods that can be used, and order them in preferred order. For additional details about DNS SRV and round-robin DNS see the URI dialling section in the Cisco VCS Administrator Guide. Also see "Appendix 10 ­ Cluster name and DNS SRV records".
H.323 endpoints
The options below are listed in preference order for providing resilience of connectivity of endpoints to a cluster of Cisco VCSs where 1 or more Cisco VCS cluster peers become inaccessible. The choice of option will depend on what functionality the endpoint you are using supports.
Option 1 ­ DNS SRV (preferred)
To use this option, there must be a DNS SRV record available for the DNS name of the Cisco VCS cluster that defines an equal weighting and priority for each cluster peer. On each H.323 endpoint, configure the Gatekeeper Settings as:  Discovery = Manual  IP Address = DNS name of the Cisco VCS cluster
If the endpoint supports DNS SRV, on startup the endpoint issues a DNS SRV request and receives a DNS SRV record back defining an equal weighting and priority for each cluster peer. It may also receive a list of lower priority entries pointing at a fallback cluster. The endpoint then tries to register with a relevant cluster peer (having taken into account the priority / weightings). If that peer is not available, the endpoint will try and register to another listed peer at the same priority, or if all peers at that priority have been tried, a peer at the next lower (higher numbered) priority. This will be repeated until the endpoint can register with a Cisco VCS. On registering with the Cisco VCS, the Cisco VCS will respond with the H.323 "Alternate Gatekeepers" list containing the list of Cisco VCS Cluster peer members. The endpoint will continue to use the first Cisco VCS that it registered to for re-registrations and for calls. If it ever loses connection to its Cisco VCS then it will select an "Alternate Gatekeeper" from the list it was supplied with. DNS SRV cache timeout should be set to a fairly long time (e.g. 24 hours) to minimize DNS traffic.
Option 2 ­ DNS Round-Robin (2nd choice)
To use this option, there must be a DNS A-record available for the DNS name of the Cisco VCS cluster that supplies a round-robin list of IP addresses. On each H.323 endpoint configure the Gatekeeper Settings as:  Discovery = Manual  IP Address = DNS name of the Cisco VCS cluster

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 49 of 68

Appendix 5 ­ Configuring endpoints to work with a Cisco VCS cluster
If the endpoint does not support DNS SRV, on startup the endpoint will perform a DNS A-record lookup. The DNS server will have been configured to support round-robin DNS, with each of the cluster peer members defined in the round-robin list. The endpoint will take the address given by the DNS lookup and will then try and register with the relevant cluster peer. If that peer is not available, then the endpoint will perform another DNS lookup and will try to connect to the new Cisco VCS peer that it is given. (The DNS server will have supplied the next cluster peer's IP address.) This will be repeated until the endpoint can register with a Cisco VCS. On registering with the Cisco VCS, the Cisco VCS will respond with the H.323 `Alternate Gatekeepers' list containing the list of Cisco VCS Cluster peer members. The endpoint will continue to use the first Cisco VCS that it registered to for re-registrations and for calls. If it ever loses connection then it will select an "Alternate Gatekeeper" from the list it was supplied with. DNS cache timeout should be set to a fairly short time (e.g. 1 minute or less) so that on failure to reach a Cisco VCS at startup, the endpoint is quickly pointed at a different Cisco VCS.
Option 3 ­ Static IP (least preferred)
Use this option if the Cisco VCS cluster does not have a DNS name. On each H.323 endpoint configure the Gatekeeper Settings as:
 Discovery = Manual  IP Address = IP address of a Cisco VCS peer
On startup the endpoint will try and register with the VCS at the specified IP address. If that is not available, then the endpoint will continue trying at regular intervals.
This will be repeated until the endpoint can register with the Cisco VCS. On registering with the Cisco VCS, the Cisco VCS will respond with the H.323 "Alternate Gatekeepers" list containing the list of Cisco VCS Cluster peer members. The endpoint will continue to use the first Cisco VCS that it registered to for re-registrations and for calls. If it ever loses connection then it will select an "Alternate Gatekeeper" from the list it was supplied with.
SIP endpoints
The options below are listed in preference order for providing resilience of connectivity of endpoints to a cluster of Cisco VCSs where 1 or more Cisco VCS cluster peers become inaccessible. The choice of option will depend on what functionality the endpoint you are using supports.
Option 1 ­ SIP Outbound (preferred)
SIP outbound allows an endpoint to be configured to register to 2 or more Cisco VCS peers simultaneously. The benefit of this is that if the connection between one peer and the endpoint gets broken, then a connection from the endpoint to the other peer remains. With the endpoint registering to both peers simultaneously, there is no break in service while the endpoint realizes that its registration has failed, before it registers to a different peer. Thus, at no time is the endpoint unreachable.
Configuration of SIP outbound is endpoint specific, but typically will be:  Proxy 1
· Server discovery = Manual
· Server Address = DNS name of the Cisco VCS cluster (if DNSSRV name is available) or

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 50 of 68

Appendix 5 ­ Configuring endpoints to work with a Cisco VCS cluster
DNS name of cluster peer or IP address of cluster peer
 Proxy 2
· Server discovery = Manual
· Server Address = DNS name of the Cisco VCS cluster (if DNSSRV name is available) or DNS name of a different cluster peer or IP address of a different cluster peer
 Outbound = On
Option 2 ­ DNS SRV (2nd choice)
To use this option, there must be a DNS SRV record available for the DNS name of the Cisco VCS cluster that defines an equal weighting and priority for each cluster peer.
On each SIP endpoint configure the SIP Settings as:
 Server discovery = Manual
 Server Address = DNS name of the Cisco VCS cluster
If the endpoint supports DNS SRV, on startup the endpoint issues a DNS SRV request and receives a DNS SRV record back defining an equal weighting and priority for each cluster peer. It may also receive a list of lower priority entries pointing at a fallback cluster.
The endpoint then tries to register with a relevant cluster peer (having taken into account the priority / weightings). If that peer is not available, the endpoint will try and register to another listed peer at the same priority, or if all peers at that priority have been tried, a peer at the next lower priority.
This will be repeated until the endpoint can register with a Cisco VCS.
The endpoint will continue to use the first Cisco VCS that it registered to for re-registrations and for calls. If it ever loses connection to its Cisco VCS, it will use the DNS SRV entry to find a new Cisco VCS to register to, starting at the highest priority.
DNS SRV cache timeout should be set to a fairly long time (e.g. 24 hours) to minimize DNS traffic.
Option 3 ­ DNS Round-Robin (3rd choice)
To use this option, there must be a DNS A-record available for the DNS name of the Cisco VCS cluster that supplies a round-robin list of IP addresses.
On each SIP endpoint configure the SIP Settings as:
 Server discovery = Manual
 Server Address = DNS name of the Cisco VCS cluster
If the endpoint does not support DNS SRV, on startup the endpoint will perform a DNS A-record lookup. The DNS server will have been configured to support round-robin DNS, with each of the cluster peer members defined in the round-robin list.
The endpoint will take the address given by the DNS lookup and will then try and register with the relevant cluster peer. If that is not available, then the endpoint will perform another DNS lookup and will try to connect to the new Cisco VCS peer that it is given. (The DNS server will have supplied the next cluster peer's IP address.)
This will be repeated until the endpoint can register with a Cisco VCS.
The endpoint will continue to use the first Cisco VCS that it registered to for re-registrations and for calls. If it ever loses connection to its Cisco VCS it will perform another DNS lookup to find a new Cisco VCS to register to (the DNS server providing a Cisco VCS in the round-robin sequence).
DNS cache timeout should be set to a fairly short time (e.g. 1 minute or less) so that if a Cisco VCS is not accessible the endpoint is quickly pointed at a different Cisco VCS.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 51 of 68

Appendix 5 ­ Configuring endpoints to work with a Cisco VCS cluster
Option 4 ­ Static IP (least preferred)
Use this option if the Cisco VCS cluster does not have a DNS name. On each SIP endpoint configure the SIP Settings as:  Server discovery = Manual  Server Address = IP address of a Cisco VCS peer On startup the endpoint will try and register with the Cisco VCS at the specified IP address. If that is not available, then the endpoint will continue trying at regular intervals. This will be repeated until the endpoint can register with the Cisco VCS. The endpoint will continue to use the first Cisco VCS that it registered to for re-registrations and for calls. If it ever loses connection then it will keep on trying to register to that Cisco VCS until it is accessible again.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 52 of 68

Appendix 6 ­ Troubleshooting
Appendix 6 ­ Troubleshooting
Cisco VCS Warnings
"Cluster name not configured: if FindMe or clustering are in use a cluster name must be defined; see the Clustering section of the Cisco VCS Administrator Guide for more information"
Ensure that the same cluster name is configured on each VCS in the cluster. The Cluster name should be the routable Fully Qualified Domain Name used in SRV records that address this Cisco VCS cluster, for example "cluster1.example.com". (See Appendix 10 ­ Cluster name and DNS SRV records).
"Cluster replication error: the Master peer is unreachable"
If Cisco VCS reports an alarm: "Cluster replication error: the Master peer is unreachable":  from a root login, check the directory /tmp/x5/peerconfiguration  it should have directories for each peer, e.g. if 2 peers it should have directories 1 and 2  it should also have a file `clustermaster'  cat clustermaster tells you the master  If the file clustermaster does not exist on any member of the cluster it must be created. This can
be done by changing all Cisco VCSs in the cluster to use a new Cisco VCS as the cluster master and then returning them all to use the preferred master.
Do this on each Cisco VCS in the cluster using the web interface: 1. Go to VCS configuration > Clustering. 2. From the Configuration master drop down select the a new cluster master (make sure that this
is the same on all Cisco VCSs in the cluster). 3. Click Save. 4. Repeat for all Cisco VCSs in the cluster
then, on each Cisco VCS in the cluster: 5. From the Configuration master drop down select the preferred cluster master on all Cisco VCSs
in the cluster. 6. Click Save. 7. Repeat for all Cisco VCSs in the cluster.
"Cluster replication error: there was an error during automatic replication of configuration"
1. Check the Event Log. If it reports: <Date> logger: Event="Application Warning" Detail="Cluster watchdog had to terminate doFindMeReplication 10348." Level=1 Time=<Date/Time> then the base configuration file is too large for the automated process to copy. A manual copy can be carried out to fix this.
2. On the Cisco VCS reporting this issue, login to the Cisco VCS as root and type: cd /tmp/x5/peerconfiguration

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 53 of 68

Appendix 6 ­ Troubleshooting
ls
there should be a file `clustermaster' plus one directory for each Cisco VCS in the cluster, labeled 1, 2, ..., 6 3. Type: ls 1 ls 2 ls 3 etc
the directories 1, 2, 3 etc should have a file "alternatesconfiguration.xml". If any is missing, it needs to be manually copied.
Note: Directory 1 relates to the configuration of the Cisco VCS listed in the Cisco VCS Clustering tab as Peer 1 IP address, directory 2 relates to the configuration of the Cisco VCS listed in the Cisco VCS Clustering tab as Peer 2 IP address etc.
4. Log in as root to the IP address of the Peer X IP address that is missing the "alternatesconfiguration.xml" file.
5. Scp the file /tmp/x5/peerconfiguration/X/alternatesconfiguration.xml to root@<IP of dest VCS>/tmp/x5/peerconfiguration/X where X is the directory ID missing the file. a. The relevant username and password of the receiving Cisco VCS will have to be entered to allow it to accept the file. For example, if the Cisco VCS at 192.168.1.101 has directory 3 missing the alternatesconfiguration.xml file, and Peer 3 IP address is 192.168.1.103 then log in to 192.168.1.103 as root and type: scp /tmp/x5/peerconfiguration/3/alternatesconfiguration.xml root@<192.168.1.101>/tmp/x5/peerconfiguration/3
"Cluster replication error: <details> manual synchronization of configuration is required"
This may be:  "Cluster replication error: manual synchronization of configuration is required"  "Cluster replication error: cannot find master or this slave's peer configuration file, manual
synchronization of configuration is required"  "Cluster replication error: configuration master ID is inconsistent, manual synchronization of
configuration is required"  "Cluster replication error: this peer's configuration conflicts with the master's configuration, manual
synchronization of configuration is required" If a non-master Cisco VCS reports an alarm: "Warning, cluster replication error ­ <details> manual sync of config is required" On that non-master Cisco VCS:  Log in as admin on an SSH or other CLI interface. At the command prompt type:
xcommand ForceConfigUpdate
This will delete the non-master Cisco VCS configuration and then force it to update its configuration from the master Cisco VCS.
Warning: Never issue these commands on the Master Cisco VCS, otherwise all Cisco VCS configuration for the cluster will be lost.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 54 of 68

Appendix 6 ­ Troubleshooting
"Cluster replication error: the NTP server is unreachable"
Configure an accessible NTP server on the Cisco VCS web page System > Time.
"Cluster replication error: the local VCS does not appear in the list of peers"
Check and correct the list of peers for this Cisco VCS on the Master Cisco VCS, and copy to all other Cisco VCS peers (VCS configuration > Clustering).
"Cluster replication error: automatic replication of configuration has been temporarily disabled because an upgrade is in progress"
Wait until the upgrade has completed.
"Invalid clustering configuration: H.323 mode must be turned On clustering uses H.323 communications between peers"
Ensure that H.323 mode is on (see VCS configuration > Protocols > H.323).
"Security alert: the TMS Agent database has the default LDAP password set"
If the Cisco VCS is being managed by Cisco TMS, on Cisco TMS: 1. Go to Administrative Tools > Configuration > TMS Agent Settings. In the Global (applied to all
agents) section: a. Set up the TMS Agent LDAP Configuration Password. b. Click Save.
Note: This will configure the LDAP Configuration password on the Cisco TMS and all Cisco VCSs and their TMS Agents managed by that Cisco TMS.
If the Cisco VCS is a non-clustered Cisco VCS, follow the instructions in the Action link associated with the alarm.
"Security alert: the TMS Agent database has the default replication password set"
If the Cisco VCS is being managed by Cisco TMS, on Cisco TMS: 1. Go to Administrative Tools > Configuration > TMS Agent Settings. In the Global (applied to all
agents) section. a. Set up the TMS Agent LDAP Replication Password. 2. Click Save.
Note: This will configure the LDAP Configuration password on the Cisco TMS and all Cisco VCSs and their TMS Agents managed by that Cisco TMS.
If the Cisco VCS is a non-clustered Cisco VCS, follow the instructions in the Action link associated with the alarm.
"VCS Database failure: Please contact your Cisco support representative"
They will help you work through the following steps:

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 55 of 68

Appendix 6 ­ Troubleshooting
1. Take a system snapshot and provide to TAC 2. Remove the Cisco VCS from the cluster using: "Remove a live Cisco VCS from a VCS X6.1
cluster (permanently)" 3. Restore that Cisco VCS's database by restoring a Cisco VCS backup taken on that Cisco VCS
previously 4. Add the Cisco VCS back to the cluster using "Add an X6.1 VCS to a VCS X6.1 cluster"
A second method is possible if the database does not recover: 1. Take a system snapshot and provide to TAC 2. Remove the Cisco VCS from the cluster using: "Remove a live Cisco VCS from a VCS X6.1
cluster (permanently)" 3. Log in as root and run "clusterdb_destroy_and_purge_data.sh" 4. Restore that Cisco VCS's database by restoring a Cisco VCS backup taken on that Cisco VCS
previously 5. Add the Cisco VCS back to the cluster using "Add an X6.1 VCS to a VCS X6.1 cluster"
Note: clusterdb_destroy_and_purge_data.sh is as dangerous as it sounds ­ only use this command in conjunction with instructions from TAC.
Cisco TMS warnings
TMS Cluster Diagnostics
If TMS cluster diagnostics reports a difference in configuration on Cisco VCS peers, it is comparing the output of https://<ip address>/alternatesconfiguration.xml for each Cisco VCS. To manually check the differences, on a Unix / Linux system, run: wget --user=admin --password=<password> --no-check-certificate https://<IP
or FQDN of VCS>/alternatesconfiguration.xml
for each of the Cisco VCS peers, then use diff to check for differences.
Conference Factory template does not replicate
This is by design; the Conference Factory %% value is NOT shared between cluster peers and the Conference Factory application configuration is NOT replicated across a cluster. See the section "Conference Factory (MultiwayTM)" above.
VCS's External manager protocol keeps getting set to HTTPS
Cisco TMS can be configured to force specific management settings on connected systems. This includes ensuring that a Cisco VCS uses HTTPS for feedback. If enabled, Cisco TMS will (on a time period defined by Cisco TMS) re-configure the Cisco VCS's System > External manager Protocol to HTTPS. If HTTPS must be used for Cisco VCS to supply feedback to Cisco TMS, see details in "Appendix 2 ­ Adding a Cisco VCS to Cisco TMS" to see how to set up certificates etc. Cisco TMS will force HTTPS on Cisco VCS if:  Administrative Tools > Configuration > Network Settings, TMS Services > Enforce
Management Settings on Systems = On and  Administrative Tools > Configuration > Network Settings, Secure-Only Device Communication > Secure-Only Device Communication = On

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 56 of 68

Appendix 6 ­ Troubleshooting
Set Enforce Management Settings on Systems to Off if Cisco TMS does not need to force the management settings. Set Secure-Only Device Communication to Off if it is unnecessary for Cisco VCS to provide feedback to Cisco TMS using HTTPS (if HTTP is sufficient).
My cluster of Cisco VCS Expressways with dual network interfaces is not replicating correctly
Cisco VCS Expressways with Dual Network interfaces are only designed to replicate through their LAN 1 interface. Ensure that the Peer x IP Address entries specified in VCS configuration > Clustering all refer to LAN 1 interfaces.
My cluster of Cisco VCS Expressways with static NAT is not replicating correctly
When using Cisco VCS Expressways with static NAT the cluster replication must occur on the LAN interface which is not behind the NAT device. Therefore LAN interface 1 must be the non NAT interface and the Peer x IP Address entries specified in VCS configuration > Clustering must all refer to LAN 1 interfaces. LAN interface 2 must be configured for static NAT.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 57 of 68

Appendix 7 ­ Upgrading Cisco TMS to 12.6
Appendix 7 ­ Upgrading Cisco TMS to 12.6
To upgrade Cisco TMS from 12.2 to 12.6, follow the procedures documented in "Upgrade a VCS X3 / X4 cluster to an X5 cluster" in the Cluster creation and maintenance (X5) guide.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 58 of 68

Appendix 8 ­ Upgrade VCS X5.1, X5.1.1 or X5.2 software to X6.1
Appendix 8 ­ Upgrade VCS X5.1, X5.1.1 or X5.2 software to X6.1
To upgrade Cisco VCS Software to X6.1 it is essential that the previous code version is X5.1, X5.1.1 or X5.2. If the code is anything different, upgrade it to X5.2 before upgrading to X6.1.
Follow the procedures documented in "Upgrade an X3 / X4 / X5.0 cluster to an X6.1 cluster" ­ Cisco TMS and Cisco VCS have to be upgraded at the same time in many cases.
The process documented below is to be used in conjunction with, and where referenced by, "Upgrade an X3 / X4 / X5.0 cluster to an X6.1 cluster" in order to perform the upgrade of code on a single Cisco VCS.
From release X4.1 onwards the Cisco VCS supports a maintenance mode. When placed in this mode, the Cisco VCS will eventually be left in a state where it has no calls or registrations, at which point it can be upgraded without affecting existing calls or registrations.
When maintenance mode is enabled, the Cisco VCS will ignore all further registration requests and will reject new call requests with a license limit exceeded indication. Where endpoints support the capability to register with a different Cisco VCS if the one that it is registering to fails (see "Appendix 5 ­ Configuring endpoints to work with a Cisco VCS cluster") registrations will gradually migrate to other Cisco VCS peers in that cluster. Eventually all existing registrations on the Cisco VCS where maintenance mode has been enabled will expire and all ongoing calls will clear down. At this point the Cisco VCS can be upgraded and then maintenance mode disabled to bring it back into service.
When upgrading a cluster peer (master or non-master): 1. Enable maintenance mode. From the Cisco VCS command line type:
xconfiguration SystemUnit Maintenance Mode: On 2. Wait for all calls to clear and registrations to timeout. 3. If necessary, manually remove any calls that do not clear automatically (Status > Calls, then
check the box next to the calls you want to terminate and click Disconnect). 4. If necessary, manually remove any registrations that do not clear automatically (Status >
Registrations > By device, then select the box next to the devices you want to remove and click Unregister). You can leave the registration for the Conference Factory ­ this will not be the source of calls, and even if deleted will not roll over to another peer, as other peers have their own Conference Factory registration (if enabled). 5. Ensure that the Cisco VCS has been backed up; If at a later date you need to downgrade to this `old' version you will need to restore a backup made against this `old' code version. 6. Upgrade and restart the Cisco VCS (Maintenance > Upgrade). If multiple peers need restarting: restart each peer in turn, waiting for the peer to be accessible through the web interface before restarting the next peer.
· ensure that you have the Release key for loading VCS X5 code onto this Cisco VCS
· for any further details see the "Upgrading Software" section of the Cisco VCS Administrator Guide
Note: The web browser interface may timeout during the restart process, after the progress bar has reached the end; this may happen if:
 Cisco VCS carries out a disk file system check ­ which it does approximately once every 30 restarts
 Provisioning is enabled, and re-indexing the database takes a while
7. Disable maintenance mode. From the Cisco VCS command line type:

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 59 of 68

Appendix 8 ­ Upgrade VCS X5.1, X5.1.1 or X5.2 software to X6.1
xconfiguration SystemUnit Maintenance Mode: Off 8. At this stage you can ignore any warnings reporting:
· WARNING: Security alert: the TMS Agent database has the default password set. · WARNING: Cluster name not configured: if FindMe or clustering are in use a cluster name
must be defined; see the Clustering section of the Cisco VCS Administrator Guide for more information · WARNING: Security alert: the TMS Agent database has the default replication password set. These are handled in the remainder of the process of upgrading the VCS X3 / X4 cluster to X5.
Note: It is recommended that while Cisco VCS peers are running different versions of code, configuration changes to any Cisco VCS in the cluster are limited to the changes needed to complete the upgrade. Configuration changes will not be replicated across Cisco VCS peers that are not running the same version of software as the Master Cisco VCS.
Upgrading the software on a Cisco VCS is now complete.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 60 of 68

Appendix 9 ­ Changing the cluster name (and keeping FindMe accounts)
Appendix 9 ­ Changing the cluster name (and keeping FindMe accounts)
The cluster name specifies which data is to be used in the replicated database. Follow this process to change the cluster name in order to retain the data associated with the previous cluster name. e.g. when a new X6.1 VCS cluster is being created and the FindMe accounts are to be carried across from the Master Cisco VCS to the new cluster. 1. In the root login, at a command prompt, type:
transferfindmeaccounts <current Cluster name of this VCS> <Cluster name of the cluster being created> 2. Go to VCS configuration > Clustering and: · Set Cluster name to be <Cluster name of the cluster being created>, where <Cluster name
of the cluster being created> is the routable fully qualified domain name used in SRV records that address this Cisco VCS cluster, for example "cluster1.example.com". (See Appendix 10 ­ Cluster name and DNS SRV records).
Note:
 If transferfindmeaccounts is executed on multiple Cisco VCSs with different <current Cluster name of this VCS> to the same <Cluster name of the cluster being created>, the FindMe accounts from each of the Cisco VCSs will be merged into the new <Cluster name of the cluster being created> database.
 If a whole cluster is having its cluster name changed, the transferfindmeaccounts only needs to be run on the master Cisco VCS.
 If a Cisco VCS cluster has its name changed, go to Cisco TMS and select the Master Cisco VCS, select the clustering tab and `Cluster name has changed' should be reported. Select `Update Cluster in TMS'.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 61 of 68

Appendix 10 ­ Cluster name and DNS SRV records

Appendix 10 ­ Cluster name and DNS SRV records
Using DNS SRV to convert a domain to an IP address has a number of benefits:
 The structure of the lookup includes service type and protocol as well as the domain, so that a common domain can be used to reference multiple different services which are hosted on different machines (e.g. html, sip, h.323).
 The DNS SRV response includes priority and weighting values which allow the specification of primary, secondary, tertiary etc groups of servers, and within each priority group, the weighting defines the proportion of accesses that should use each server.
 Because the DNS SRV response contains details about priorities and weights of multiple servers, the receiving device can use a single lookup to search for an in-service server (where some servers are in-accessible) without the need to repeatedly query the DNS server (this is in contrast to using round robin DNS which does require repeated lookups into the DNS server if initial servers are found to be in-accessible).

The generic format of a DNS SRV query is:  _service._protocol.<fully.qualified.domain>

The format of DNS SRV queries for sip (RFC 3263) and h.323 used by Cisco VCS are:

 _sips._tcp.<fully.qualified.domain>

 _sip._tcp.<fully.qualified.domain>

 _sip._udp.<fully.qualified.domain> only calls

- not recommended for video calls, only for audio-

 _h323ls._udp.<fully.qualified.domain>

- for udp RAS messaging, e.g LRQ

 _h323cs._tcp.<fully.qualified.domain>

- for H.323 call signaling

The format of DNS SRV queries for sip (RFC 3263) and h.323 typically used by an endpoint are:

 _sips._tcp.<fully.qualified.domain>

 _sip._tcp.<fully.qualified.domain>

 _sip._udp.<fully.qualified.domain> only calls

- not recommended for video calls, only for audio-

 _h323ls._udp.<fully.qualified.domain>

- for udp RAS messaging, e.g LRQ

 _h323cs._tcp.<fully.qualified.domain>

- for H.323 call signaling

 _h323rs._udp.<fully.qualified.domain>

- for H.323 registrations

The DNS SRV response is a set of records in the format:  _ service. _ protocol.<fully.qualified.domain>. TTL Class SRV Priority Weight Port Target

Where Target is an A-record defining the destination
Note: UDP is not a good transport medium for video ­ SIP messaging for video systems is too large to be carried on a packet based (rather than stream based) transport. UDP is often used for audio only devices.
Further details on DNS SRV can be found in the Cisco VCS Administrator Guide and RFC 2782.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 62 of 68

Appendix 10 ­ Cluster name and DNS SRV records
The Cisco VCS Cluster name (configured on the VCS configuration > Clustering page) should be the <fully.qualified.domain> specified in the DNS SRV records that point to the Cisco VCS cluster.
Endpoints supporting SIP DNS SRV
Movi versions prior to 4.0 supports:  _sip._tls.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
Movi version 4.0 and later supports:  _sips._tcp.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
E20 version TE2.1 supports:  _sips._tls.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
MXP version F8.2 supports:  _sip._tls.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
T150 version L6.0 supports:  _sip._tls.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
C-Series versions prior to TC4.0 supports:  _sip._tls.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
C-Series from version TC4.0 supports:  _sips._tcp.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
Cisco TelePresence MCU supports:  _sips._tcp.<fully.qualified.domain>  _sip._tcp.<fully.qualified.domain>
SIP DNS SRV records required:  _sips._tcp.<fully.qualified.domain> Movi (4.0 and later), C-Series (TC4.0 and later), Cisco VCS,
MCU  _sips._tls.<fully.qualified.domain> E20 to TE2.1  _sip._tls.<fully.qualified.domain> MXP to F8.2, T150 to L6.0, Movi prior to 4.0, C-Series prior to
TC4.0  _sip._tcp.<fully.qualified.domain> All products for TCP

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 63 of 68

Appendix 10 ­ Cluster name and DNS SRV records

Note:  UDP is not a good transport medium for video ­ SIP messaging for video systems is too large to
be carried on a packet based (rather than stream based) transport. UDP is often used for audio only devices.  _sip._tls,<fully.qualified.domain> is an SRV record also used by Microsoft OCS Edge servers.
Looking up .SRV records
Nslookup
nslookup -query=SRV _sip._tcp.example.com
Dig
dig _sip._tcp.example.com SRV

; <<>> DiG 9.4.1 <<>> _sip._tcp.example.com SRV ;; global options: printcmd ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 44952 ;; flags: qr rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 2, ADDITIONAL: 4

;; QUESTION SECTION: ;_sip._tcp.example.com.

IN

SRV

;; ANSWER SECTION: _sip._tcp.example.com. 1183 _sip._tcp.example.com. 1183

IN SRV IN SRV

1 0 5060 sbc1.example.com. 1 0 5060 sbc2.example.com.

;; AUTHORITY SECTION:

example.com.

87450 IN

NS

ns1.mydyndns.org.

example.com.

87450 IN

NS

ns2.mydyndns.org.

;; ADDITIONAL SECTION:

sbc1.example.com.

1536

IN

A

sbc2.example.com.

1376

IN

A

ns1.mydyndns.org.

75

IN

A

ns2.mydyndns.org.

10037

IN

A

194.73.59.53 194.73.59.54 204.13.248.76 204.13.249.76

;; Query time: 0 msec ;; SERVER: 10.44.8.11#53(10.44.8.11) ;; WHEN: Mon Jul 26 11:09:59 2010 ;; MSG SIZE rcvd: 243

~ #

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 64 of 68

Appendix 11 ­ NAPTR records

Appendix 11 ­ NAPTR records
NAPTR records are typically used to specify various methods to connect to a destination URI, for example by email, by SIP, by H.323. They can also be used to specify the priority to use for those connection types, for example to use SIP tls in preference over using SIP tcp or SIP udp.
NAPTR records are also used in ENUM, when converting a telephone number into a dialable URI.
(For further details on ENUM see "Cisco VCS Deployment Guide - ENUM dialing on VCS", document reference D14465).
E20 video endpoints use NAPTR records to identify whether they are inside a private network (and so should request provisioning data for the internal network) or are outside in the public internet (where they should request provisioning data for devices in the public network). The flag "s" is extended to "se" to indicate to the E20 that it is "external".
(For further details see the "Cisco TMS Provisioning Deployment Guide", document reference D14368).

NAPTR record format
Example: SIP access to example.com, and for enum lookups for 557120, 557121, and 557122.

$ORIGIN example.com.

IN

NAPTR 10 100 "s" "SIPS+D2T"

""

IN

NAPTR 12 100 "s" "SIP+D2T"

""

IN

NAPTR 14 100 "s" "SIP+D2U"

""

_sips._tcp.example.com. _sip._tcp.example.com. _sip._udp.example.com.

$ORIGIN www.example.com.

IN

NAPTR 10 100 "s" "http+I2R"

""

IN

NAPTR 10 100 "s" "ftp+I2R"

""

_http._tcp.example.com. _ftp._tcp.example.com.

$ORIGIN 0.2.1.7.5.5.enum.lookup.com.

IN

NAPTR 10 100 "u" "E2U+sip"

"!^.*[email protected]!"

.

IN

NAPTR 12 100 "u" "E2U+h323"

"!^.*[email protected]!"

.

IN

NAPTR 10 100 "u" "mailto+E2U" "!^.*$!mailto:[email protected]!"

.

$ORIGIN 1.2.1.7.5.5.enum.lookup.com.

IN

NAPTR 10 100 "u" "E2U+sip"

"!^.*[email protected]!"

.

$ORIGIN 2.2.1.7.5.5.enum.lookup.com.

IN

NAPTR 10 100 "u" "E2U+h323"

"!^.*[email protected]!"

.

IN = Internet routing NAPTR = record type 10 = order value (use lowest order value first) 100 = preference value if multiple entries have the same order value "u" = the result is a routable URI "s" = the result is a DNS SRV record "a" = the result is an `A'or `AAAA' record "E2U+sip" to make SIP call "E2U+h323" to make h.323 call Regular expression: ! = delimiter "" = no expression used ... usual Regex expressions can be used Replace field; . = not used

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 65 of 68

Appendix 11 ­ NAPTR records

Looking up NAPTR records

Looking up an ENUM NAPTR record
dig 4.3.7.8.enum4.example.com. NAPTR

; <<>> ;; global options: printcmd ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 38428 ;; flags: qr aa rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 1, ADDITIONAL: 2

;; QUESTION SECTION: ;4.3.7.8.enum4.example.com. IN NAPTR

;; ANSWER SECTION: 4.3.7.8.enum4.example.com. 60 IN NAPTR 10 100 "u" "E2U+sip" "!^.*[email protected]!" . 4.3.7.8.enum4.example.com. 60 IN NAPTR 10 100 "u" "E2U+h323" "!^.*[email protected]!" .

;; AUTHORITY SECTION:

enum4.example.com. 60 IN

NS

int-server1.example.com.

;; ADDITIONAL SECTION: int-server1.example.com. 3600 IN A int-server1.example.com. 3600 IN AAAA

10.44.9.144 3ffe:80ee:3706::9:144

;; Query time: 0 msec ;; SERVER: 10.44.8.11#53(10.44.8.11) ;; WHEN: Tue Jul 13 16:51:41 2010 ;; MSG SIZE rcvd: 251

#

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 66 of 68

Appendix 11 ­ NAPTR records

Looking up a domain NAPTR record
Example: NAPTR record allowing E20 endpoints to detect that they are in the public (external) network. ~ # dig -t NAPTR example.com

; <<>> DiG 9.4.1 <<>> -t NAPTR example.com ;; global options: printcmd ;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 1895 ;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 6, ADDITIONAL: 4

;; QUESTION SECTION: ;example.com.

IN

NAPTR

;; ANSWER SECTION: example.com. example.com. example.com.

2

IN NAPTR 50 50 "se" "SIPS+D2T" "" _sips._tcp.example.com.

2

IN NAPTR 90 50 "se" "SIP+D2T" "" _sip._tcp.example.com.

2

IN NAPTR 100 50 "se" "SIP+D2U" "" _sip._udp.example.com.

;; AUTHORITY SECTION:

example.com.

320069 IN

NS

nserver2.example.com.

example.com.

320069 IN

NS

nserver.euro.example.com.

example.com.

320069 IN

NS

nserver.example.com.

example.com.

320069 IN

NS

nserver3.example.com.

example.com.

320069 IN

NS

nserver4.example.com.

example.com.

320069 IN

NS

nserver.asia.example.com.

;; ADDITIONAL SECTION:

nserver.example.com.

56190 IN

A

nserver2.example.com.

57247 IN

A

nserver3.example.com.

57581 IN

A

nserver4.example.com.

57452 IN

A

17.111.10.50 17.111.10.59 17.22.14.50 17.22.14.59

;; Query time: 11 msec ;; SERVER: 10.44.8.11#53(10.44.8.11) ;; WHEN: Tue Jul 13 17:08:40 2010 ;; MSG SIZE rcvd: 385

~ #

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 67 of 68

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED "AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
© 2011 Cisco Systems, Inc. All rights reserved.

Cisco VCS Deployment Guide: Cluster creation and maintenance (Cisco VCS X6.1)

Page 68 of 68


iText 1.4.1 (by lowagie.com) Acrobat PDFMaker 9.1 for Word

Search Any Device: