exwy_b_cisco-expressway-cluster-creation-and-maintenance-deployment-guide-x143
exwy_b_cisco-expressway-cluster-creation-and-maintenance-deployment-guide-x143
Guide (X14.3)
First Published: 2023-05-17
Last Modified: 2023-06-27
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
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.
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.
All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.
Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.
The documentation set for this product strives to use bias-free language. For purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on
age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that
is hardcoded in the user interfaces of the product software, language used based on standards documentation, or language that is used by a referenced third-party product.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
https://www.cisco.com/c/en/us/about/legal/trademarks.html. 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. (1721R)
© 2023 Cisco Systems, Inc. All rights reserved.
CONTENTS
Information Covered 1
Change History 2
Overview 5
Benefits of Clustering 5
About Capacity Gain 5
About Licensing 6
Overview 11
Preparing Expressway to Join a Cluster 12
Create a New Cluster of Expressway Peers 13
Next Steps 16
Add a Peer to a Cluster 17
Checks 18
Next Steps 18
CHAPTER 8 Troubleshooting 41
CHAPTER 9 Reference 47
Peer-specific Items 47
Sample Firewall Rules for Protecting Intracluster TLS Port 49
Cluster Name and DNS SRV Records 50
DNS SRV Configuration for Mobile and Remote Access 51
DNS SRV Configuration for Video Conferencing 52
Checking DNS SRV Settings 53
Clusters in Isolated Networks 54
NAPTR Records 55
NAPTR Record Format 56
Impact of Clustering in Other Expressway Applications 57
Conference Factory (Multiway™) 57
Microsoft Interoperability 58
Information Covered
From version X12.5 onwards, this guide applies only to the Cisco Expressway Series product (Expressway)
and no longer applies to the Cisco VCS product (VCS). Older VCS guides on Cisco.com are still valid for
the VCS versions they apply to—as specified on the title page of each guide.
The guide covers the following topics:
• Clustering Requirements
Describes the required network environment and minimum configuration of the peer Expressways before
you can cluster them.
• How to Form a Cluster
How to form a cluster of one, add peers to a cluster, and configure cluster address mapping if necessary.
• How to Change a Cluster
Processes like upgrading, taking peers offline, changing the primary peer, and disbanding the cluster.
• How to Connect the Expressway Cluster to Other Systems
How to connect the cluster with external systems like Cisco TMS, other Expressways, and endpoints.
• Troubleshooting
Guidance that may assist if the cluster is not working as expected.
• Reference
Additional material that may be relevant to your environment.
For information about license usage and capacity with clustered systems, refer to the Expressway Administrator
Guide on the Cisco Expressway Series Maintain and Operate Guides page.
Change History
Table 1: Change History
June 2020 • Updated for X12.6. Also X12.6 release and document
remove cluster license usage correction
and capacity guidelines, which
are now in the Expressway
Administrator Guide.
• Update Clustering
Requirements to clarify DNS
SRV record with A or AAAA
records per peer for B2B
deployments is recommended
but not required.
April 2017 Added section and related edits for X8.9.2 release
cluster address mapping.
Overview
An Expressway can be part of a cluster of up to six Expressways. Each Expressway in the cluster is a peer of
every other one in that cluster. When you create a cluster you nominate one peer as the primary, from which
its configuration is replicated to the other peers.
Every Expressway peer in the cluster must have the same routing capabilities — if any Expressway can route
a call to a destination it is assumed that all Expressway peers in that cluster can route a call to that destination.
If routing is different on different Expressway peers, then you need to use separate Expressways / Expressway
clusters.
Benefits of Clustering
Clustered Expressways can provide benefits for both capacity and resilience:
• Capacity. Clustering can increase the capacity of an Expressway deployment by a maximum factor of
four, compared with a single Expressway.
• Resilience. Clustering can provide redundancy while an Expressway is in maintenance mode, or in case
it becomes inaccessible due to a network or power outage, or other reason. The Expressway peers in a
cluster share bandwidth usage as well as routing, zone, and other configuration. Endpoints can register
to any of the peers in the cluster, so if an endpoint loses connection to its initial peer, it can re-register
to another one in the cluster.
About Licensing
Capacity licensing is done on a per-cluster basis, and all capacity licenses installed on a cluster peer are
available to any peer in the cluster. This includes Rich Media Session licenses and room system & desktop
system registration licenses. More details are provided in License Usage Within a Cluster
Note Although we support using one certificate for multiple Expressways in one cluster,
this isn't recommended due to the security risk. That is, if one private key is
compromised on one device, all devices in the cluster are compromised.
• If you have systems that still use option keys, all peers have the same set of option keys installed, with
the following exceptions:
• RMS licenses
• Room system registration licenses
• Desktop system registration licenses
• Enable H.323 mode on each peer (Configuration > Protocols > H.323, and for H.323 mode select On).
The cluster uses H.323 signaling between peers to determine the best route for calls, even if all endpoints
are SIP endpoints.
• Configure the firewall rules on each peer to block connections to clustering TLS ports, from all IP
addresses except its peers.
Note Expressway-E typically uses a public DNS, but it's undesirable to use the public
DNS to resolve private IP addresses. It's also undesirable to cluster on the public
addresses of the Expressway-E peers. For these reasons, we recommend you use
cluster address mapping to resolve the peers' FQDNs to private IP addresses.
For details, see the Cisco Expressway Cluster Creation and Maintenance Deployment Guide for your
version, on the Cisco Expressway Series Configuration Guides page.
• A DNS SRV record is recommended for the cluster, which contains A or AAAA records for each peer.
This configuration is advised for video interoperability and business to business (B2B) video calling,
but not for Mobile and Remote Access.
• (For MRA) Create a collab-edge SRV record for each peer in the Expressway-E cluster.
• (For B2B only) The Expressway-E cluster has a DNS SRV record that defines all cluster peers.
If you have clusters with mixed appliance types in them, be aware that every peer must run the same software
version. Not all appliance types support all software versions - please check first in the appliance installation
guides that the units you want to mix can all support the same software version.
Note Expressway clusters consisting of Expressway and Expressway Select peers are not supported. Instead, all
peers within a cluster must either run the Expressway software image or the Expressway Select software
image.
Overview
• You can have up to six Expressways in a cluster, including the primary.
• Add the peers to the cluster one by one.
• You should only make configuration changes on the primary Expressway.
Caution Do not adjust any cluster-wide configuration until the cluster is stable with all
peers running. Cluster database replication will be negatively impacted if any
peers are upgrading, restarting, or out of service when you change the cluster's
configuration.
Any changes made on other peers are not reflected across the cluster, and will be overwritten the next
time the primary’s configuration is replicated across the peers. The only exceptions to this are some
Peer-specific Items.
You may need to wait up to one minute before changes are updated across all peers in the cluster.
• Cluster communication failure alarms are raised while the cluster is forming. Alarms should clear when
you are finished.
• Configuration replication is suspended to new Expressways before they have properly joined the cluster.
• If the new Expressway peer has two network interfaces, the Peer N address must not specify the external
interface. If you need to enforce TLS between peers (that is, TLS verify is ON), you have to use the Peer's
FQDN as it appears on the peer's certificate for the Peer N address. You must also use Cluster Address
Mapping because the DNS resolution of the FQDN will likely resolve to the public IP address. See
Cluster Address Mapping for Expressway-E Clusters, to map FQDNs to the private IP addresses.
• If Expressway server has single NIC and static NAT enabled on the server, Peer N address must not be
the static NAT address. If you need to enforce TLS between peers (that is, TLS verify is ON), you have
to use the Peer's FQDN as it appears on the peer's certificate for the Peer N address. You must also use
Cluster Address Mapping because the DNS resolution of the FQDN will likely resolve to the public IP
address. See Cluster Address Mapping for Expressway-E Clusters, to map FQDNs to the private IP
addresses.
• Check that the address of your Expressway is not a peer of any other Expressway in your organization.
• Check that the Expressway is not a neighbor, traversal client, or traversal server of any other Expressway.
• Review and modify the configuration to ensure that the Expressway has:
• A valid Ethernet speed (System > Network interfaces > Ethernet).
• Valid IP address and IP gateway (System > Network interfaces > IP).
• A valid and working NTP server configured (System > Time; in the Status section, the State should
be “Synchronized”).
• 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).
• Go to System > DNS and ensure that System host name is the DNS hostname for this Expressway
(typically the same as the System name in System > Administration, but excluding spaces, and
unique for each Expressway in the cluster). If it is not configured correctly, set it up appropriately
and click Save.
• No peers configured (on System > Clustering – all Peer N address fields on this page should be
blank).
Caution If you clear all the peer address fields from the clustering page and save the
configuration, then the Expressway will factory reset itself the next time you do
a restart. This means you will lose all existing configuration except basic
networking for the LAN1 interface, including all configuration that you do
between when you clear the fields and the next restart.
If this Expressway is already a member of a cluster, you should remove it from that cluster and
restart it before you use it in another cluster.
• If you have systems that use option keys, ensure that the same set of option keys is installed as those
that will be installed on all other peers of the cluster (Maintenance > Option keys). The number
of call/RMS/device/room licenses may differ between peers; all other license keys must be identical
on each peer.
• H.323 Mode set to On (Configuration > Protocols > H.323)
• If this Expressway is joining a cluster that is integrated with Cisco TMSPE, Add the Expressway to Cisco
TMS, then:
1. Check that the new Expressway can see Cisco TMS.
To do this, go to System > External manager and in the Status section, ensure that the State is
'Active'.
2. Check that Cisco TMS knows the Host Name of the Expressway:
a. Go to Systems > Navigator (and any required sub folders).
b. Select this Expressway.
c. Select the Connection tab.
d. Set Host Name to be the FQDN of this subordinate peer, for example vcs3.uk.company.com.
e. Click Save/Try.
You can ignore any error messages such as “DNS
config failure resolving <DNS name>:
Did not find system IP address () in DNS: <Server IP>”
g. Check that Cisco TMS can communicate with the new Expressway.
To do this, on Cisco TMS go to System > Navigator (and any required sub folders) then click
on the name of the Expressway and ensure that it says:
“✓System has no open or acknowledged tickets”
• Go to System > Alarms. If there is an alarm that the Expressway must be restarted, go to Maintenance >
Restart options and then click Restart.
Important You must create a cluster of one (primary) peer first, and restart the primary, before you add other peers. You
can add more peers after you have established a “cluster of one”.
1. Decide which Expressway will be the primary peer. The primary Expressway peer will be the source
of the configuration information for all Expressway peers in the cluster. Subordinate Expressway peers
will have most of their configuration deleted and replaced by that from the primary.
2. Check that the Expressway is running X12.6 software.
3. Backup the Expressway (Maintenance > Back and restore).
4. Review and modify the configuration to ensure that the Expressway has:
• A valid Ethernet speed (System > Network interfaces > Ethernet).
• Valid IP address and IP gateway (System > Network interfaces > IP).
• A valid and working NTP server configured (System > Time; in the Status section, the State
should be “Synchronized”).
• 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).
• Go to System > DNS and ensure that System host name is the DNS hostname for this Expressway
(typically the same as the System name in System > Administration, but excluding spaces, and
unique for each Expressway in the cluster). If it is not configured correctly, set it up appropriately
and click Save.
• No peers configured (on System > Clustering – all Peer N address fields on this page should be
blank).
Caution If you clear all the peer address fields from the clustering page and save the
configuration, then the Expressway will factory reset itself the next time you do
a restart. This means you will lose all existing configuration except basic
networking for the LAN1 interface, including all configuration that you do
between when you clear the fields and the next restart.
If this Expressway is already a member of a cluster, you should remove it from that cluster and
restart it before you use it in another cluster.
• If you have systems that use option keys, ensure that the same set of option keys is installed as
those that will be installed on all other peers of the cluster (Maintenance > Option keys). The
number of call/RMS/device/room licenses may differ between peers; all other license keys must
be identical on each peer.
• H.323 Mode set to On (Configuration > Protocols > H.323)
5. Ensure that this Expressway does not list any of the Expressways that are to be peers in this new cluster
in any of its neighbor zones or traversal zones (Configuration > Zones > Zones, then check each
neighbor and traversal zone).
6. Set the H.323 Time to live to an appropriate value for the size of your deployment. A smaller number,
like 60 (seconds), means that if one Expressway becomes inaccessible, the endpoint will quickly register
with another peer (Configuration > Protocols > H.323).
Note By reducing the registration time to live too much, you risk flooding the Expressway with registration requests,
which will severely impact performance. This impact is proportional to the number of endpoints, so you should
balance the need for occasional quick failover against the need for continuous good performance.
7. Go to System > DNS and ensure that System host name is the DNS hostname for this Expressway
(typically the same as the System name in System > Administration, but excluding spaces, and unique
for each Expressway in the cluster). If it is not configured correctly, set it up appropriately and click
Save.
Configuration Primary 1
Cluster IP version Choose IPv4 or IPv6 to match the underlying network addressing
scheme.
Peer 1 address Enter the address of this Expressway (the primary peer).
If TLS verification mode is set to Enforce, then you must enter an
FQDN that matches the subject CN or a SAN on this peer's certificate.
Next Steps
• Go to Status > Alarms and ensure that all alarms are acted upon and cleared.
• Add other Expressways to the cluster using Add a Peer to a Cluster.
Peer 1 address …Peer 6 address The addresses should be the same, and in the same
order, as those entered on the primary Expressway
*If you intend to use cluster address mapping, all devices in the cluster should be in Permissive mode
initially. For more information, see Cluster Address Mapping for Expressway-E Clusters.
Save the new clustering configuration.
5. Repeat the previous step for each of the subordinate peers already in the cluster.
6. Go to System > Clustering on the new peer:
Peer 1 address …Peer 6 address The addresses should be the same, and in the same
order, as those entered on the primary Expressway
*If you intend to use cluster address mapping, all devices in the cluster should be in Permissive mode
initially. For more information, see Cluster Address Mapping for Expressway-E Clusters.
Checks
1. After the restart, wait approximately 2 minutes – this is the frequency with which configuration is copied
from the primary.
2. Check the Cluster database status.
3. Check that configuration data exists as expected:
• If FindMe is in use, check that the expected FindMe entries still exist (Status > Applications > TMS
Provisioning Extension Services > FindMe > Accounts).
• Check configuration for items from the System, Configuration, and Application menus.
Next Steps
• Add more peers if necessary.
• If you are using Conference Factory (Multiway™) in your cluster, see Impact of Clustering in Other
Expressway Applications.
• If you want peers to resolve their FQDNs to their private IP addresses, see Cluster Address Mapping for
Expressway-E Clusters.
• If your security policy dictates that you enforce TLS verification between the peers, and if the
Expressway-Es are using static NAT, or dual NIC, or both, then we do not recommend using the external
interfaces or the static NAT addresses to form the cluster.
Also, do not try to use the public DNS to map the peers' public FQDNs to their private IP addresses,
because you will break external connectivity.
You should use cluster address mapping in these situations.
….
Note This automatic mapping may be incorrect! If the peers' certificates do not contain these assumed FQDNs
in their SAN fields, then the cluster will not form when TLS verification mode is changed to Enforce. You
must check that the SANs contain the entries that you place in the peer FQDN fields.
Step 1 Form your cluster using IP addresses (as described in Create a New Cluster of Expressway Peers, on page 13 and Add
a Peer to a Cluster, on page 17) with TLS verification mode set to Permissive.
Step 2 Verify that the cluster is correctly formed, by checking for green Clustering status messages against the peer address
fields.
You will also see blue Certificate: Invalid ...status messages. This is because your certificates should not correspond with
internal/private IP addresses, assuming they are correctly formed to identify peers by FQDN. This is expected behavior
and does not prevent you from proceeding.
Step 3 Go to System > Clustering on the primary peer, and change the Cluster address mapping enabled drop-down to On
(default is Off).
The Cluster address mapping fields display.
Step 4 [Optional, see note above] Click Suggest mappings based on system information to autofill the mapping fields for
each cluster peer. This uses the System host name and DNS name configured on the System > DNS pages of each peer,
and maps them to the IP addresses of the inward facing NICs.
Step 5 [If you used the autofill option] Check that the suggested mappings correspond to the names in the peers' certificates,
and the IP addresses of the NICs that you want to cluster. (The data is built up from information which may not match
the certificate or DNS.)
Step 6 Edit the mappings so that the public FQDNs of the Expressway-E peers correspond to the IP addresses of their internal
facing NICs.
(You can check the public FQDNs in the certificate SAN fields, or by querying DNS).
Note While you are changing a peer address, communications between peers are temporarily impacted and you
will see alarms that persist until the changes are complete and the cluster agrees on the new addresses.
Step 1 Sign in to all the cluster peers and navigate to System > Clustering on each.
Step 2 Choose which peer address you are going to change first. We recommend starting at Peer 1 address, because you need
to repeat the following process, one by one, for all peer addresses in the list.
Step 3 On every peer in the cluster:
• Change the chosen peer address field from the IP address to the corresponding FQDN (if you did mappings, they
should be replicated in all peers at this stage).
• Click Save.
Caution Make sure you only change one peer address on each box.
Step 4 Switch to the peer that is identified by the peer address you are currently changing and restart this peer (go to
Maintenance > Restart options, then click Restart and confirm OK.
Note A single restart is needed when changing a peer address across all peers.
Step 6 Choose which peer address you are going to change next, and then repeat steps 3-5. Repeat this loop until you have
changed all peer addresses and restarted all of the peers.
The whole cluster should now be operating on FQDNs, and the cluster is still in Permissive mode.
If the cluster is an Expressway-E cluster, and you are aiming to enforce TLS verification between the peers, then the peer
address fields should match the identities presented in the certificates. Check that both Clustering and Certificate status
messages are green.
Caution Verify that your certificate SANs contain the FQDNs that are in the Peer N address fields. You should see
green status messages for clustering and certificate next to each address field before you proceed.
Step 2 Verify that TLS verification mode is now Enforce on each other peer.
Step 3 Click Save and restart the primary peer.
Step 4 Sign in to each other peer and then restart the peer.
Step 5 Wait for the cluster to stabilize, and check that Clustering and Certificate status is green for all peers.
Note With the cluster wide SAML metadata, it is not sufficient to export metadata,
you need to regenerate SAML certificate which contains FQDN information for
all expressway cluster peers.
Note For instructions about upgrading a cluster to a new software version, please refer to the release notes for the
relevant version.
Caution If you clear all the peer address fields from the clustering page and save the configuration, then the Expressway
will factory reset itself the next time you do a restart. This means you will lose all existing configuration
except basic networking for the LAN1 interface, including all configuration that you do between when you
clear the fields and the next restart.
The Expressway displays a banner to remind you that it is pending a factory reset.
If you need to prevent the factory reset, restore the clustering peer address fields exactly as they were. Replace
the original peer addresses in the same order, and then save the configuration to clear the banner and prevent
the reset.
• If you want to remove the primary peer, make a different peer the primary before you remove this one.
See Change the Primary Peer, on page 31
• If you cannot access the peer you want to remove, see Remove a Dead Peer From a Cluster (Permanently),
on page 28.
• If you want to recover an expressway cluster peer, see Recovery Of an Expressway Cluster Peer, on page
30.
If you need to avoid the factory reset, restore the clustering peer address fields as they were. Replace the original peer
addresses in the same order, and then save the configuration to clear the banner.
Step 4 Restart the Expressway (go to Maintenance > Restart options , then click Restart and confirm OK).
The factory reset is automatically triggered when the peer restarts, to remove sensitive data and clustering configuration.
The reset clears all configuration except the basic networking information listed below, which is preserved for the LAN1
interface so that you can still access the Expressway. If you use the dual-NIC option, be aware that any LAN2 configuration
is removed completely by the reset.
Configuration that is preserved (for LAN1) after the reset:
• IP addresses
• Admin and root accounts and passwords
• SSH keys
• Option keys
• HTTPS access enabled
• SSH access enabled
Note From version X12-6 the factory reset removes the server certificate, associated private key, and CA trust
store settings from the peer. In earlier Expressway software versions these settings were preserved.
Note This procedure does not clear configuration from the Expressway. If you manage to revive the system, you
must not start using it until you have reset its default configuration (factory reset).
You have removed the inaccessible peer from the Expressway cluster.
Note From version X12-6 the factory reset removes the server certificate, associated private key, and CA trust
store settings from the peer. In earlier Expressway software versions these settings were preserved.
Now you can bring it back into the cluster, see Add a Peer to a Cluster, on page 17
Disband a Cluster
This process removes all Expressway 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 Expressway will retain enough configuration to enable you to access the web interface, but all other
configuration is cleared.
The procedure involves removing peers one by one, and finally clearing the clustering configuration from the
primary peer. In X8.11 and later, clearing the clustering configuration prepares the Expressway for a factory
reset. You must be certain you want to factory reset the primary, because there are some situations where you
need to have Expressway configured as a 'cluster of one'.
To disband the cluster:
Step 1 Remove any peers that you cannot access. See Remove a Dead Peer From a Cluster (Permanently), on page 28.
Step 2 If you're using Cisco TMSPE, sign in to Cisco TMS and stop provisioning to the cluster:
a. Select Systems > Navigator (and any required sub folders), then click on any Expressway in the cluster.
b. Select the Provisioning tab.
c. Disable all 4 services (clear checkboxes).
d. Click Save.
Step 3 Remove each of the subordinate peers turn. See Remove a Live Peer From a Cluster (Permanently), on page 26.
When you remove the last subordinate peer, you should only have the primary peer remaining in the cluster.
The cluster is now a 'cluster of one' and you can stop here if you want to retain this Expressway with its configuration.
Step 4 If you want to factory reset the primary peer, sign in to it and follow the process to Remove a Live Peer From a Cluster
(Permanently), on page 26.
You've finished disbanding the cluster.
Note No changes are required for Cisco TMS, which will see the primary change on the Expressway cluster and
report this appropriately.
Step 4 On all other Expressway peers, starting with the “old” primary peer (if it is still accessible), go to System > Clustering.
Step 5 From the Configuration primary drop-down menu select the ID number of the “new” primary Expressway.
Step 6 Click Save.
Any alarms raised on the Expressway peers that relate to 'Cluster primary mismatch' and 'Cluster replication error'
should clear automatically after approximately 2 minutes
Step 7 Confirm that the change to the Configuration primary has been accepted by going to System > Clustering and
refreshing the page.
Step 8 If any Expressways have not accepted the change, repeat the steps above.
Step 9 Check that the cluster database status reports as Active.
Step 10 If you are changing the primary peer because the “old” primary is not accessible, see Remove a Dead Peer From a
Cluster (Permanently), on page 28 procedure.
Step 11 If there is any chance of reviving the “old” primary, you must isolate it from the other peers and factory reset it if
possible.
No further steps are required if you are using FQDNs, with valid cluster address mapping configured.
Step 1 Ensure that the Expressway whose IP address, hostname, or FQDN you want to change is not the primary Expressway.
If it is the primary Expressway, follow the steps in Change the Primary Peer, on page 31 to make a different peer the
primary.
Step 2 Carry out the process documented in Remove a Live Peer From a Cluster (Permanently), on page 26
Step 3 Change the IP address, hostname, or FQDN of the Expressway.
Step 4 Carry out the process documented in Add a Peer to a Cluster, on page 17.
If you are using an Expressway-E with dual NIC and want to change the IP address, hostname, or FQDN of
the External NIC, there is no need to disband the cluster, as this IP address, hostname, or FQDN is not used
for clustering.
Replace a Peer
This section summarizes the procedure for replacing a cluster peer Expressway with a different unit.
Step 1 Ensure that the Expressway to be replaced is not the primary Expressway.
If it is the primary Expressway, follow the steps in Change the Primary Peer, on page 31 to make a different peer the
primary.
Step 3 Add the replacement peer to the cluster using the procedure defined in Add a Peer to a Cluster, on page 17.
Important additional information if you have clusters with physical appliances
To add a CE1200 appliance to an existing cluster that has CE1100 models in it, configure the Type option to match the
other peers (Expressway-E or Expressway-C) through the service setup wizard on the Status > Overview page, before
you add the CE1200 to the cluster.
If you are adding a more recent model than existing appliances in the cluster, upgrade the Expressway software on the
existing peers to the same version as the new appliance, before you create the backup to be later restored onto the new
appliance. (A backup can only be restored onto the same software version that it was created on.) Not all appliance types
support all software versions - please check first in the appliance installation guides that the units you want to mix can
all support the same software version.
Step 1 Ensure that the Expressway to be replaced is not the primary Expressway.
If it is the primary Expressway, follow the steps in Change the Primary Peer, on page 31 to make a different peer the
primary.
Step 2 Remove the peer by deleting its clustering configuration, but do not restart it yet. See Remove a Live Peer From
a Cluster (Permanently), on page 26.
Step 3 Backup the configuration of the removed peer before you restart it.
Step 4 If required, generate and apply any option keys needed for the new Expressway. Apply the same set of keys that are
applied to the other peers.
Step 5 Restore the backup from the removed peer onto the new Expressway.
Step 6 Check the DNS configuration of the new Expressway is the same as the other peers, and synchronize it with the same
NTP servers.
Step 7 Add the replacement peer to the cluster using the procedure defined in Add a Peer to a Cluster, on page 17.
You should use the new peer's address in place of the removed peer's address when following that procedure.
The most important steps are summarized here:
a. Add the new peer's address to the clustering configuration on the primary, in place of the old peer's address.
b. Add the new peer's address to the clustering configuration on other existing peers, in place of the old peer's address.
c. Enter the new clustering configuration on the new peer (cluster name, shared secret, ordered peer list).
SIP Endpoints
The options are listed in preference order for providing resilience of connectivity of endpoints to a cluster of
Expressways where one or more Expressway cluster peers become inaccessible. The choice of option will
depend on what functionality the endpoint you are using supports.
Important For endpoints running Cisco Collaboration Endpoint software, this option is not supported from version CE8.0.
SIP outbound allows an endpoint to be configured to register to two or more Expressway peers simultaneously.
The benefit of this is that if the connection between one peer and the endpoint breaks, 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 cluster peer or IP address of cluster peer
• Proxy 2
• Server discovery = Manual
• Server Address =DNS name of a different cluster peer or IP address of a different cluster peer
• Outbound = On
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.
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 is repeated until
the endpoint can register with a Expressway.
The endpoint will continue to use the first Expressway that it registered to for re-registrations and for calls.
If it ever loses connection to its Expressway, it will use the DNS SRV entry to find a new Expressway to
register to, starting at the highest priority.
To minimize DNS traffic, the DNS SRV cache timeout should be set to a fairly long time, such as 24 hours.
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 Expressway peer that it is given. (The DNS server will have supplied the next cluster peer’s IP
address.) This is repeated until the endpoint can register with a Expressway.
The endpoint will continue to use the first Expressway that it registered to for re-registrations and for calls.
If it ever loses connection to its Expressway it will perform another DNS lookup to find a new Expressway
to register to (the DNS server providing a Expressway in the round-robin sequence).
DNS cache timeout should be set to a fairly short time (for example, 1 minute or less) so that if a Expressway
is not accessible the endpoint is quickly pointed at a different Expressway.
On startup the endpoint will try and register with the Expressway at the specified IP address. If that is not
available, then the endpoint will continue trying at regular intervals. This is repeated until the endpoint can
register with the Expressway.
The endpoint will continue to use the first Expressway 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 Expressway until it is accessible again.
H.323 Endpoints
The options are listed in preference order for providing resilience of connectivity of endpoints to a cluster of
Expressways where 1 or more Expressway cluster peers become inaccessible. The choice of option will depend
on what functionality the endpoint you are using supports.
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.
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 Expressway. On registering with the Expressway,
the Expressway will respond with the H.323 “Alternate Gatekeepers” list containing the list of Expressway
cluster peer members.
The endpoint will continue to use the first Expressway that it registered to for re-registrations and for calls.
If it ever loses connection to its Expressway 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.
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 Expressway 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 Expressway. On registering with the Expressway,
the Expressway will respond with the H.323 ‘Alternate Gatekeepers’ list containing the list of Expressway
cluster peer members.
The endpoint will continue to use the first Expressway 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
Expressway at startup, the endpoint is quickly pointed at a different Expressway.
On startup the endpoint will try and register with the Expressway 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 Expressway. On registering with the Expressway,
the Expressway will respond with the H.323 “Alternate Gatekeepers” list containing the list of Expressway
cluster peer members.
The endpoint will continue to use the first Expressway 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.
On the Expressway
Step 7 Click Finish Adding Systems, Add System despite warnings or Add More Systems as appropriate.
1
Cisco TMS may force the protocol to be HTTPS. The configuration for this is found in 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.
Restarting Sequence
Whenever you have formed, connected, upgraded, or changed a cluster, you should check whether any peers
need restarting. Sometimes you will need to restart only one peer, typically if you've made a peer-specific
configuration change.
When you're working with the cluster configuration, you sometimes need to restart more than one peer. In
this case, you should always restart in the following sequence:
1. Restart the primary peer, and wait for it to be accessible via web interface.
2. Check cluster replication status on the primary and status of all peers. Wait a few minutes, refreshing the
peer's web interfaces occasionally.
3. Restart other peers, if required, one at a time. Each time, wait a few minutes after it is accessible and
check its replication status.
This will delete the subordinate Expressway configuration and then force it to update its configuration
from the primary Expressway.
Caution Use this command only if the configuration on the primary Expressway is known to be in a good state. We
recommend that you take a backup before running this command.
The replication alarm clears after the primary peer has upgraded and rebooted. This normally happens within
ten minutes after reboot, but could be up to twenty minutes after reboot.
Cluster replication error: the local Expressway does not appear in the list of
peers
Check and correct the list of peers for this Expressway on the primary Expressway, and copy to all other
Expressway peers (System > Clustering).
Expresswaydatabasefailure:PleasecontactyourCiscosupportrepresentative
The support representative will help you work through the following steps:
1. Take a system snapshot and provide it to your support representative.
2. Remove the Expressway from the cluster using: Remove a Live Peer From a Cluster (Permanently), on
page 26.
3. Restore that Expressway’s database by restoring a backup taken on that Expressway previously.
4. Add the Expressway back to the cluster using Add a Peer to a Cluster, on page 17.
for each of the Expressway peers, then use diff to check for differences.
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 Expressway to provide feedback to
Cisco TMS using HTTPS (if HTTP is sufficient).
Peer-specific Items
Most items of configuration are applied via the primary peer to all peers in a cluster. However, the following
items (marked with a † on the web interface) must be specified separately on each cluster peer.
Note You should not modify configuration data that applies to all peers on any peer other than the primary peer.
At best it will result in the changes being overwritten from the primary; at worst it will cause cluster replication
to fail.
Note If you need to enable cluster address mapping, we recommend forming the cluster on IP addresses first. Then
you will only need to add the mappings on one peer.
Note that the IP protocol is applied to all peers, because each peer must support the same protocols.
Note In some cases a peer will raise an alarm that it has no key to enable licenses the peer needs, even though there
are licenses available in the cluster. You can acknowledge and ignore this category of alarm, unless the only
peer that has the required licenses is out of service.
Active Directory Service (Configuration > Authentication > Devices > Active Directory Service)
When configuring the connection to an Active Directory Service for device authentication, the NetBIOS
machine name (override), and domain administrator Username and Password are specific to each peer.
2. Add a rule to drop TCP connections to ports 4371 and 4372, for all IP addresses in the appropriate (IPv4
or IPv6) range.
3. Add lower priority rules, one for each of the other peers' IP addresses, that allow TCP connections to
those ports.
(Lower numbered rules are implemented before higher numbered rules.)
4. Activate the firewall rules.
Figure 1: Creating a custom rule to allow a specific peer to connect to this peer's clustering ports
• 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.
HTTP, 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.
• As 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 inaccessible)
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 inaccessible.)
Further details on DNS SRV can be found in Expressway Administrator Guide and RFC 2782.
Important From version X8.8 onward, you must create forward and reverse DNS entries for all Expressway-E
systems, so that systems making TLS connections to them can resolve their FQDNs and validate their
certificates.
Table 2:
Table 3:
Create internal DNS records, for both forward and reverse lookups, for all Unified Communications nodes
used with MRA. This allows Expressway-C to find the nodes when IP addresses or hostnames are used instead
of FQDNs.
Ensure that the cisco-uds SRV records are NOT resolvable outside of the internal network, otherwise the
Jabber client will not start MRA negotiation via the Expressway-E.
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> - not recommended for video calls, only use for audio-only calls
• _h323ls._udp.<fully.qualified.domain> - for UDP location (RAS) signaling, such as LRQ
• _h323cs._tcp.<fully.qualified.domain> - for H.323 call signaling
• _h323rs._udp.<fully.qualified.domain> - for H.323 registrations
UDP is not a recommended transport medium for video signaling; SIP messaging for video system is too
large to be reliably carried on datagram-based (rather than stream-based) transports.
The Expressway Cluster name (configured on the System > Clustering page) should be an FQDN, where
the domain part is the domain used for the SRV records which point to that Expressway cluster.
Example
DNS SRV records for 2 peers of an Expressway-E cluster for example.com
where:
Note • Priorities are all the same. Only use different priorities if you have different clusters allowing failover
from one primary cluster to another (secondary) cluster. In that case the primary cluster peers should
have one value and the other (secondary) cluster peers should have a larger value.
• Weights should be the same – so that there is equal use of each peer.
The Expressway queries DNS for SRV records comprised of the service, protocol and domain combinations,
for example: _sip._tcp.call.ciscospark.com and _sips._tcp.call.ciscospark.com.
By default the system will submit the query to all of the system's default DNS servers (System > DNS).
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 IN SRV 1 0 5060 expe1.example.com.
_sip._tcp.example.com. 1183 IN SRV 1 0 5060 expe2.example.com.
;; AUTHORITY SECTION:
example.com. 87450 IN NS ns1.mydyndns.org.
example.com. 87450 IN NS ns2.mydyndns.org.
;; ADDITIONAL SECTION:
expe1.example.com. 1536 IN A 194.73.59.53
expe2.example.com. 1376 IN A 194.73.59.54
ns1.mydyndns.org. 75 IN A 204.13.248.76
ns2.mydyndns.org. 10037 IN A 204.13.249.76
;; Query time: 0 msec
~ #
Note The background information in this appendix is valid, but the issue and workaround described have been
invalidated by a fix in X8.9.2. That fix allows privately mapping peer FQDNs to peer IP addresses, instead
of using the IP addresses returned by DNS lookup.
As of X8.8, Expressway peers use TLS to communicate with each other. You have the option of permissive
TLS - the certificates are not verified - or enforced TLS where the certificates are verified.
In the latter case, each peer will need to DNS look up the common name (CN), and perhaps also subject
alternate names (SANs), that they read from their peers' certificates. They compare the returned IP addresses
against the IP addresses that gave them the certificates and if they match, the connection is authenticated.
In isolated networks, the peers will not typically be able to reach the internal DNS servers, because that would
require unsolicited inbound requests. In a dual-NIC setup, you probably also don't want to put the peers' private
IP addresses into the public DNS.
The issue is compounded by not being able to use IP addresses as common names or subject alternate names
on server certificates: certificate authorities do not advocate this and probably will not issue such certificates.
The peers will now use the public DNS to verify each others' identities, as presented on their certificates.
The peers will now use the private IP addresses to form the cluster, but will not check the contents of the
certificates against the DNS records.
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 ENUM Dialing on Expressway Deployment Guide).
$ORIGIN www.example.com.
IN NAPTR 10 100 "s" "http+I2R" "" _http._tcp.example.com.
IN NAPTR 10 100 "s" "ftp+I2R" "" _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
;; AUTHORITY SECTION:
enum4.example.com. 60 IN NS int-server1.example.com.
;; ADDITIONAL SECTION:
int-server1.example.com. 3600 IN A 10.44.9.144
int-server1.example.com. 3600 IN AAAA 3ffe:80ee:3706::9:144
;; Query time: 0 msec
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 primary Expressway 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 Expressway serves the conference ID, it cannot serve a conference
ID that any other Expressway could have served.
The same applies across a network. If there is more than one Expressway or Expressway cluster that provides
Conference Factory functionality in a network, each and every Expressway must provide values in a unique
range, so that no two Expressways can serve the same conference ID.
See Cisco TelePresence Multiway Deployment Guide for more information.
Microsoft Interoperability
If Microsoft infrastructure is deployed with an Expressway cluster, see Expressway and Microsoft Infrastructure
Deployment Guide.