copy of sde fairshare install config guide r5.60 c04
TRANSCRIPT
Installation &Configuration Guide
Service Delivery Engine(SDE)
Release 5.60For Fairshare
Part Number: 05-00095 Rev. C04July 8, 2010
Installation & Configuration Guide: Service Delivery Engine Release 5.60 Rev. C04For FairsharePart Number: 05-00095-C04Last modified: July 8, 2010
The most current version of this document is available on Sandvine’s support web site athttps://support.sandvine.com/
This document and the product described within are copyrighted. Under copyright laws, neither thisdocument nor the product may be reproduced, translated or reduced to any electronic medium ormachine readable or other form without prior written authorization from Sandvine Incorporated.
Copyright 2007 - 2010, Sandvine Incorporated. All rights reserved.
Sandvine Incorporated™ and Sandvine Leaf design are trademarks of Sandvine. All other product names mentioned herein are trademarks of their respective owners.
The following are trademarks of Sandvine:
Sandvine Incorporated™
Powering IP Services™
Sandvine Virtual Switch Cluster™
Intelligent Broadband Networks™
Sandvine Incorporated shall not be liable for technical or editorial errors or omissions contained herein;nor for incidental or consequential damages resulting from the furnishing, performance or use of thismaterial.
Information in this document is subject to change without notice.
Sandvine is committed to ensuring the accuracy of our documentation and to continuous improvement.If you encounter errors or omissions in this user guide, or have comments, questions or ideas, wewelcome your feedback. Please send your comments to Sandvine via e-mail at [email protected].
ContentsList of figures...................................................................7
List of tables....................................................................9
Chapter 1 Deployment overview...................................................... 11
Installation guide overview...................................................... 13
Hardware requirements.......................................................... 14Minimum server requirements.................................................. 14Hardware verification............................................................ 14Operating system................................................................. 15
Network requirements for SDE installation................................... 16Dummy VIPs........................................................................ 16Virtual IPs for SDE services...................................................... 17
Deployment architecture........................................................ 18Data collection.................................................................... 18Fairshare enforcement........................................................... 18Sample deployment configurations............................................ 19SDE clusters........................................................................ 21
Installation prerequisites........................................................ 24Pre-installation requirements................................................... 24VIP requirements.................................................................. 26RHEL 5.4 installation packages................................................. 26
Requesting a support account.................................................. 28
Chapter 2 Installing the management cluster...................................... 29
Pre-installation check list....................................................... 31
Management cluster overview.................................................. 32
Creating RHEL accessibility to yum............................................ 33
Local yum installation............................................................ 35
Configuring yum to install the SDE from an FTP site or HTTP server..... 37
Installing the SDE software from the yum repository....................... 39
Installation verifications......................................................... 41
Installation troubleshooting..................................................... 44Missing dependencies............................................................. 44yum troubleshooting.............................................................. 44SDE machine hostname.......................................................... 45
Logging into the EMS............................................................. 46EMS access options................................................................ 46
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 105-00095-C04 July 8, 2010
Windows EMS installation........................................................ 46Installing the X Window System package group.............................. 47EMS login sequence............................................................... 47
Configuring the management machine........................................ 50Configuring the services......................................................... 50Configuring the WSAM service.................................................. 53Attaching new services to the SDE node...................................... 55
Changing the border VIP in the fsam_conf.properties file................. 57
Configuring the outbound IPDR relay.......................................... 58
Second SDE machine.............................................................. 60Adding SDE nodes................................................................. 60SDE node parameters............................................................. 61Attaching services to the new node............................................ 61Configuring a second edge VIP.................................................. 61Changing the border VIP in the fsam_conf.properties file................. 62Configuring the outbound relay................................................. 62
Installation checks and troubleshooting....................................... 63SDE system view................................................................... 63Cluster installation complete................................................... 65
Chapter 3 Adding additional clusters................................................. 67
Cluster overview.................................................................. 68
Installing the SDE software...................................................... 69
Configuring the nodes............................................................ 70Adding SDE nodes................................................................. 70Adding an edge service.......................................................... 71Attaching the services............................................................ 71Configuring the edge VIP(s)..................................................... 71Changing the border VIP in the fsam_conf.properties file................. 71Configuring the outbound IPDR relay.......................................... 72
Installation checks and troubleshooting....................................... 73Cluster installation complete................................................... 73
Chapter 4 Global SDE parameters..................................................... 75
Overview of SDE parameters.................................................... 77Configuring SDE parameters..................................................... 77
General parameters.............................................................. 78Garbage gates..................................................................... 80
Log parameters.................................................................... 81
COPS parameters.................................................................. 83
WSAM parameters................................................................. 84
Fairshare parameters............................................................. 85
2 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Data collection parameters..................................................... 86General data collection parameters........................................... 86SNMP collection parameters.................................................... 89IPDR collection parameters..................................................... 89SPB collection parameters....................................................... 90
Subscriber mapping parameters................................................ 92
Chapter 5 Import CMTSs................................................................. 95
Import CMTSs/CMTS maps overview........................................... 96
Import CMTSs...................................................................... 97CMTS XML description file....................................................... 97CSV data file..................................................................... 100CMTS and IPDR session attributes............................................. 101Importing CMTSs when using inbound IPDR relay........................... 105
Importing CMTS lists............................................................ 107Import errors..................................................................... 107Viewing CMTSs in the EMS following import................................. 108
Import CMTS maps............................................................... 109CMTS maps XML description file............................................... 109Map import process............................................................. 110
Chapter 6 Configuring SPB connections............................................ 113
SPB configuration overview.................................................... 114
IP exclusions...................................................................... 117Excluding individual IPs......................................................... 117Excluding subnets............................................................... 118
SPB configuration process...................................................... 119Configuring the SPB to the SDE................................................ 119Mapping edge services to SPBs................................................ 120
Chapter 7 Configuring additional network elements to the system.......... 123
Application managers........................................................... 124Application manager parameters............................................. 125
Application servers.............................................................. 126Application server parameters................................................ 126
Record Keeping Servers (RKSs)................................................ 127RKS parameters.................................................................. 128
Chapter 8 SNMP......................................................................... 131
SNMP agent....................................................................... 132
Configuring trap receivers..................................................... 133SNMP parameters................................................................ 133
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 305-00095-C04 July 8, 2010
Chapter 9 Reports...................................................................... 135
Reports overview................................................................ 136
Configuring SDE nodes for reports............................................ 137
Chapter 10 NetPortal.................................................................... 139
NetPortal overview.............................................................. 140
NetPortal installation........................................................... 141
Configuring the NetPortal services........................................... 142Management service............................................................ 142Edge service...................................................................... 142
Chapter 11 SDE upgrade................................................................ 143
Upgrade process................................................................. 144Post-upgrade procedures....................................................... 145
APPENDICES................................................................. 147
Appendix A Additional install procedures........................................... 149
Configuring SSL between EMS and SDE....................................... 150
Changing the location of the log files........................................ 151
Transferring files to the SDE machine........................................ 152SFTP program.................................................................... 152SCP program...................................................................... 152
Appendix B External configuration procedures.................................... 153
Application Servers.............................................................. 154
Appendix C Manually configuring CMTSs............................................. 155
Configuring CMTSs through the EMS.......................................... 156CMTS parameters................................................................ 158Configuring IPDR sessions...................................................... 162
Manually configuring CMTS interfaces and maps........................... 164Manually configuring CMTS interfaces and maps........................... 164Configuring CMTS maps......................................................... 164
Configuring CMTSs through the CLI........................................... 166Accessing the CLI................................................................ 166Using the CLI..................................................................... 166CMTS............................................................................... 167
Appendix D Example XML description files for CMTS import..................... 171
4 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Example XML description file for IPDR collection and PCMMenforcement...................................................................... 172
Example XML description file for SPB data collection and PCMM-PTSenforcement...................................................................... 174
Appendix E Uninstalling the SDE....................................................... 177
SDE uninstall procedure........................................................ 178
Appendix F SDE ports.................................................................... 179
Ports used for SDE communications.......................................... 180
Index......................................................................... 185
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 505-00095-C04 July 8, 2010
6 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
List of figuresSPB collection and PTS enforcement via the SPB................................19
Internal IPDR collection and PCMM enforcement ...............................20
External IPDR data collection and PCMM enforcement.........................21
Support registration dialog box.....................................................28
EMS login dialog box..................................................................48
Virtual IP dialog box..................................................................50
New Service dialog box..............................................................53
New Service dialog box..............................................................54
Expanded SDE node list..............................................................55
Attached SDE services...............................................................56
New SDE Node dialog box...........................................................60
New SDE Node dialog box...........................................................70
Import CMTS List dialog box.......................................................107
Import CMTS Maps dialog box.....................................................111
New IP dialog box...................................................................117
New Subnet dialog box.............................................................118
New SPB dialog box.................................................................119
New AM dialog box..................................................................124
New AS dialog box...................................................................126
New RKS dialog box.................................................................127
New Primary RKS dialog box.......................................................128
New Trap Receiver dialog box.....................................................133
Add SDE Report View dialog box..................................................137
New CMTS dialog box...............................................................156
New IPDR Session dialog box......................................................162
New Subnet dialog box.............................................................164
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 705-00095-C04 July 8, 2010
8 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
List of tablesTable 1: Hardware requirements...................................................14
Table 2: Partitions....................................................................15
Table 3: SDE cluster IP requirements for multiple subnets....................16
Table 4: Pre-installation check list................................................31
Table 5: VIP parameters.............................................................51
Table 6: Services parameters/nodes..............................................54
Table 7: SDE node parameters.....................................................61
Table 8: General parameters.......................................................78
Table 9: Log parameters............................................................81
Table 10: COPS parameters.........................................................83
Table 11: WSAM parameters........................................................84
Table 12: Fairshare parameters....................................................85
Table 13: General data collection parameters...................................86
Table 14: SNMP collection parameters............................................89
Table 15: IPDR collection parameters.............................................90
Table 16: SPB collection parameters..............................................91
Table 17: Subscriber mapping and P2SPB parameters..........................92
Table 18: Attributes for CMTS import............................................101
Table 19: SPB parameters.........................................................120
Table 20: AM attributes............................................................125
Table 21: Application server attributes.........................................126
Table 22: RKS values................................................................128
Table 23: RKS primary/secondary parameters.................................129
Table 24: SNMP parameters.......................................................133
Table 25: CMTS EMS parameters..................................................158
Table 26: IPDR session parameters...............................................162
Table 27: CMTS interfaces and maps ............................................165
Table 28: Communications ports.................................................180
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 905-00095-C04 July 8, 2010
10 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
1Deploymentoverview
This chapter provides an overview of the necessaryconcepts and procedures required for installing andconfiguring the SDE for Fairshare TrafficManagement. It also lists the installationprerequisites for each SDE machine and cluster.
The following topics are included in this chapter:
• “Installation guide overview” on page 13 — explains the purpose of this guide
• “Hardware requirements” on page 14 — presents the hardware and operating systemrequirements prior to SDE software installation
• “Network requirements for SDE installation” onpage 16 — explains the different types of IPaddresses required for the SDE machine andsoftware
• “Deployment architecture” on page 18 — describes the deployment architecture in amulti-cluster environment
• “Installation prerequisites” on page 24 — explains the necessary preparations on the SDEmachine prior to SDE software installation
• “Requesting a support account” on page 28 — explains how to open aSandvine customer support account
Chapter 1: Deployment overview
12 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Installation guide overview
This guide provides detailed instructions for installing the SDE (Service DeliveryEngine) in the service provider’s network and performing initial systemconfiguration. It also provides explanatory information, included in this chapter,regarding hardware requirements, installation prerequisites, and the services andvirtual IP addresses used by the SDE.
It is highly recommended that you familiarize yourself with the information in thischapter prior to commencing installation in order to facilitate your ability toperform the necessary procedures.
The instructions in this guide are presented in the exact order in which they shouldbe performed. They navigate the operator through the steps for installing andconfiguring an SDE cluster that contains all the management functionality. They alsoexplain how to install and configure additional SDE clusters to achieve scalabilitywithin a multi-cluster site, depending on your system’s architecture. Finally, thisguide explains how to configure all external network elements, such as CMTSs, tothe system.
Following completion of all steps in this guide, the SDE system can be configured forFairshare. For instructions, see the Fairshare Solution Guide.
Note: Details of the installation process may vary somewhat according to yoursystem’s specific architecture.
Installation guide overview
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 1305-00095-C04 July 8, 2010
Hardware requirements
Table 1: Hardware requirements displays the hardware requirements for installingthe SDE software.
Table 1: Hardware requirements
Quantity Item
1 per SDE node Industry-standard server meeting the requirements explained inthe section “Minimum server requirements” on page 14
1 Console (including monitor, keyboard, and mouse), equipped withRS232 cable and USB ports
Minimum server requirementsThe SDE can be run on industry-standard servers meeting the followingrequirements:
• Intel Xeon® 2.4GHz (EM64T) Quad Core 64-bit processor
• 16GB RAM
• Minimum 500GB HDD available capacity with a minimum supported 10K rpm
• HD SAS
• Raid 5 minimum
• 2 (minimum) 1GB Ethernet network ports (4 recommended)
• CD ROM drive
• Red Hat Enterprise Linux 5.4 64-bit implementation compatibility
Hardware verificationThe hardware used in systems is known to change frequently. Therefore, prior tocommencing the installation using third-party hardware, verify that the actualhardware included in the SDE server meets or exceeds the minimum serverrequirements listed above, rather than relying solely on the vendor's server type partnumbers.
In addition, you should verify that the hardware you are using is 100-percentcompatible with Red Hat Enterprise Linux 5.4. The most recent list of RHEL 5.4-supported hardware can be found at:
https://hardware.redhat.com/list.cgi?version=5&cf_internal_whiteboard=Server&cf_internal_whiteboard=Desktop/Workstation&cf_internal_whiteboard=Laptop
Chapter 1: Deployment overview
14 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Operating system• Red Hat Enterprise Linux 5.4, with 64-bit implementation
Recommended partitioning modelThe following partitioning model is recommended:
RAID
• Recommended - RAID 10
• Minimum - RAID 5
Installation
• No Swap
• 3 partitions (see following table)
Table 2: Partitions
Partition Contents Recommended Size
/ OS (RHEL 5.4) 10 GB
/opt SDE and MySQL database 480 GB
/var System logs, configurationand database backups
10 GB
SDE logs are stored by default in /opt, but the SDE can be configured uponinstallation so that the logs are written to a different partition. For instructions, see “Changing the location of the log files” on page 151.
Hardware requirements
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 1505-00095-C04 July 8, 2010
Network requirements for SDEinstallation
Prior to installing RHEL on the servers, check that the following networkrequirements are available and at hand for each SDE machine:
• 1 physical IP address
• Subnet mask
• Default gateway
• 1 primary name server IP
• If the physical IPs and virtual IPs used for each SDE cluster are not all in thesame subnet, each SDE machine also requires a “dummy” VIP.
Dummy VIPsWhen the physical IPs used by the SDE machines and the service VIPs used by the SDEsystem are not all in the same subnet, each SDE machine must be assigned aprimary, or “dummy” VIP. These dummy VIPs ensure that the service VIPs, which“float” between servers to address load and provide failover, have a place to“land.”
The SDE commonly is deployed in clusters of two SDE nodes to provide for failover.When the SDE is deployed in a multi-cluster configuration—e.g., the systemcomprises two or more clusters—dummy VIPs are required only to address the use ofdifferent subnets within a cluster. When subnets differ from cluster to cluster (eachcluster uses physical IPs and service VIPs within the same subnet), dummy VIPsaren’t required.
The following table displays physical IP and dummy VIP requirements on the SDEmachine for the following deployment examples when a cluster’s physical IPs andservice VIPs are in different subnets.
Table 3: SDE cluster IP requirements for multiple subnets
No. of SDE machines No. of physical IPs No. of dummy VIPs
2 (1 cluster) 2 2
4 (2 clusters) 4 4
Chapter 1: Deployment overview
16 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Virtual IPs for SDE servicesIn addition to the physical IP, and possibly the dummy VIP, required for each SDEmachine, the SDE system requires virtual IPs (VIPs) to configure the system followinginstallation of the SDE software.
VIPs are dynamic IP addresses assigned to services. Services are high-availabilitynetwork connections delivered by a group of SDE nodes to other network elements.Each service is assigned at least one VIP. Each SDE node is assigned a physical IPaddress, but is linked to at least one service and, by association, to its VIP(s).
The SDE communicates with the outer world (e.g., CMTSs, external IPDR collectors)using these VIP addresses. If an SDE host fails, its virtual IPs fail over to the secondSDE machine, along with the services—and their corresponding network elements—attached to the VIPs.
Network requirements for SDE installation
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 1705-00095-C04 July 8, 2010
Deployment architecture
Each SDE deployment consists of an SDE management cluster, as well as theadditional number of SDE clusters required for scaling to support the total number ofCMTSs provisioned within the site.
The SDE allows a number of deployment solutions, depending on the serviceprovider’s requirements.
Data collectionData collection can be either via the Sandvine SPB (Subscriber Policy Broker) or usingan IPDR collector, but not both.
When data collection is via the SPB, the nodes in each cluster receive subscriberdata directly from the SPB. The nodes also connect directly to the CMTSs provisionedto the network to receive QAM interface information via SNMP.
The SDE supports two types of IPDR data collection. In the first type, the SDE’sinternal IPDRC (IPDR collector) can receive IPDR and SNMP data directly from theCMTSs or from a third-party IPDR collector can using the SDE’s inbound IPDR relayfunction. In the second type, the SDE nodes also connect directly to the CMTSsprovisioned to the network to receive interface information via SNMP.
SNMP collection also can be disabled. When SNMP is disabled, the CMTS interfacesare configured manually in the system. Depending on the type of data collection,bandwidth is calculated using data received from the IPDR records or trafficstatistics stored in the SPB.
Fairshare enforcementFairshare enforcement can be implemented by setting a subscriber attribute in theSandvine Policy Traffic Switch (PTS), or using PacketCable™ Multimedia (PCMM). TheSDE also allows a hybrid enforcement solution in which both PTS and PCMMenforcement are used, depending on the Fairshare rule’s action.
When Fairshare is enforced by setting an attribute in the PTS, each SDE is associatedwith one or more SPBs and the SDE sets a subscriber attribute in the PTS through allSPBs associated with that SDE.
For PCMM enforcement, the SDE sends PCMM gates to the policy server based onFairshare decisions. When the SDE’s internal policy server is used, the policy serverforwards the gates directly to the relevant CMTS. A third-party policy server also canbe used for PCMM enforcement. In this case, the management cluster (first clusterconfigured to the system) sends gates for Fairshare actions to the external policyserver, which then forwards them to the designated CMTSs.
Chapter 1: Deployment overview
18 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Sample deployment configurationsThe following diagrams of the SDE within the service provider’s network portraydifferent types of data collection and enforcement, all of them configured foractive-standby mode. The first diagram illustrates SPB collection and PTSenforcement via the SPB, while the second shows IPDR collection and PCMMenforcement using the SDE’s internal IPDR collector and policy server. A thirddiagram shows IPDR data collection and PCMM enforcement using third-partynetwork elements.
The services shown in the diagrams are explained in the SDE cluster information thatfollows.
1
2Management Cluster
5
6Cluster 3
1
2
Enforcement
Enforcem
ent
Enforcement
Collection
Collectio
n
Collection
· Management Service· Edge Service
· Edge Service
3
4Cluster 2
· Edge Service
CMTSs
CMTSs
CMTSs
SNMP
SNMP
SNMP
SPB collection and PTS enforcement via the SPB
Deployment architecture
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 1905-00095-C04 July 8, 2010
· Management Service· Border Service· WSAM Service· Edge Service
Management Cluster
CMTSs
PCMM
1
2 SNMP
IPDR
· Edge Service Cluster 2
CMTSs
PCMM
3
4SNMP
IPDR
· Edge Service Cluster 3
CMTSs
PCMM
5
6SNMP
IPDR
Internal IPDR collection and PCMM enforcement
Chapter 1: Deployment overview
20 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
· Edge Service Cluster 3
5CMTSs
IPDR Collector
IPDR recordsIPDR
SNMP
Policy Server
PCMM (via border server)
PCM
M
6
· Management Service· Border Service· WSAM Service· Edge Service
Management Cluster
1
2 CMTSs
IPDR Collector
IPDR recordsIPDR
SNMP
Policy Server
PCMM (via border server)
PCM
M
· Edge Service Cluster 2
3CMTSs
IPDR Collector
IPDR recordsIPDR
SNMP
Policy Server
PCMM (via border server) PCM
M
4
External IPDR data collection and PCMM enforcement
SDE clustersAn SDE cluster consists of two SDE machines, or nodes, deployed in active-standby oractive-active mode. A Fairshare engine and MySQL database sit on each node.
When the SDE is deployed in active-standby mode, the CMTSs are all connected tothe first SDE machine. Alternatively, you can configure the CMTS load to be balancedevenly between the two SDE machines (active-active mode). In both scenarios, inthe event of failover, the CMTSs provisioned to the failed machine—and theirsubscribers—are transferred automatically to the functioning machine.
Management clusterThe management cluster is the first cluster configured to the site or, in the case of atwo-node deployment, the only cluster in the site. This cluster is in charge of thefollowing:
• The system’s management functionality. The management service, a high-availability service that provides connections to SDE’s management system, isconfigured to the first SDE node in the system. The Element Management System(EMS), which is used to configure and monitor the SDE, connects to themanagement service using a virtual IP, and the management service spreadschanges to all SDE nodes. There is only one management service and only one
Deployment architecture
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 2105-00095-C04 July 8, 2010
management VIP per site, but the management service may be attached to a fewor all nodes in the site.
• The connections to the WSAM (Web Services Application Manager) and the policyserver when Fairshare is applied using PCMM. One border service is configured tothe system. This border service is a high-availability service that supports theinternal connections to and from the WSAM. All SDE nodes in the site connect tothe WSAM using the VIP assigned to the border service. The border service isconfigured to the first SDE node, but for failover purposes is attached to bothnodes in the cluster.
When the SDE uses an external policy server, two border services are configuredto the system. The first border service’s VIP supports the internal connections toand from the WSAM. The second border service connects to the external policyserver using the policy server’s IP address. The WSAM receives service requeststhrough the first VIP and sends the gates to the external policy server throughthe second VIP.
If Fairshare will be applied by setting subscriber attributes in the PTS, no borderservice is required.
• The connection between the WSAM and the Fairshare engine when Fairshare isapplied using PCMM. One WSAM service, a high-availability service that providesthe connection between the Fairshare engine on each node and the WSAM, iscreated for the cluster. For failover purposes,the service is attached to bothnodes. No VIP is configured for the WSAM service. If Fairshare will be applied bysetting subscriber attributes in the PTS, no WSAM service is required.
All clustersEdge services support connections to CMTSs, as well as to the SPB or an externalIPDR collector, logically through one or more edge VIPs. The SDE uses edge servicesto provide for failover and high availability within every SDE cluster:
• When the SDE is deployed in active-standby mode, one edge service and one VIPis configured for each cluster.
• When each cluster is configured for active-active mode, one edge service and aminimum of two VIPs are configured for each cluster.
Although each SDE node is assigned a physical IP address, both nodes are linked tothe cluster’s edge service and, by association, to one of its VIPs. Each CMTS, as wellas any SPBs defined in the system, also are linked to the edge VIP. The SDE nodethat “owns” the VIP communicates with the CMTSs attached to this VIP address.
If the active SDE node fails, the edge service and edge VIP are transferred to theother node in the cluster, along with the CMTSs—and, if relevant, the SPB—attachedto the VIP.
Database relay and replicationA MySQL database sits on each node in the cluster. The data collector relaysbandwidth usage information (subscriber statistics or IPDR data, respectively) to the
Chapter 1: Deployment overview
22 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
SDE nodes according to the node to which each SPB or CMTS is attached according tothe edge VIP configured to the node. The SDE stores the information in the MySQLdatabase on the node. The Fairshare engine on each SDE node polls the database,also using the edge VIP, in order to make Fairshare decisions.
When an edge service is attached to both nodes in the cluster, the databases on thetwo nodes are configured automatically as master-slave/slave-master for fullreplication in the event of failover.
Deployment architecture
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 2305-00095-C04 July 8, 2010
Installation prerequisites
The procedures described in this guide assume that Red Hat Enterprise Linux 5.4 hasbeen installed as the operating system on each machine, according to any specialinstructions regarding packages provided to the operator.
Pre-installation requirementsPrior to SDE software installation, you must verify that the following installationprerequisites have been met:
• Each SDE machine has been assigned a physical IP address on the eth0 interface.
• Each SDE machine has been assigned a hostname. Do NOT use the defaulthostname, localhost.localdomain.
• The hostname has been configured properly in the following locations:
• hostname
• /etc/hosts
• /etc/sysconfig/network
• If a cluster’s IPs and VIPs are not all in the same subnet, each SDE machine hasbeen assigned a primary, virtual IP address. The machine’s primary, virtual IPensures that the VIPs assigned to services have a place to “land.”
• Each SDE has access to a DNS server.
• Each SDE node's time is synchronized with the NTP server and is modified to thecorrect time and time zone. The time and time zone on all SDE machines mustbe coordinated for the SDE to work properly.
• The time and time zone of all SPBs and PTSs deployed in the Fairshare system issynchronized with the NTP server and coordinated with the time and time zoneof all SDEs.
• The /etc/issue folder contains Red Hat Enterprise Linux Server release 5.4.
Warning: Failure to comply with the above pre-installation requirements may resultin system failure. Perform the recommended pre-installation checks, below, or usecommands or tools provided by Red Hat Enterprise Linux, as necessary, to performthe above steps.
Recommended pre-installation checksIt is highly recommended that the following checks be performed on every serverprior to SDE software installation:
Chapter 1: Deployment overview
24 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
1. If the hostname doesn’t contain a domain name, run the domainnamecommand. If the command returns (none), do not add a domain name to thehostname.
2. Check that /etc/hosts contains information similar to the following:127.0.0.1 localhost.localdomain localhost::1 localhost6.localdomain6 localhost6<SDE-IP> <SDE-hostname(as it appear in the 'hostname' command output)>
3. Check that /etc/sysconfig/network contains information similar to thefollowing:NETWORKING=yesNETWORKING_IPV6=noHOSTNAME=<SDE-hostname>Where <SDE-hostname> is as it appears in the hostname command output
4. Check that service portmap is running by using the following command:service portmap statusThe following response (with the appropriate PID) should appear:portmap (pid xxxx) is running... If portmap isn’t running, enable portmap. see “Installation verifications” onpage 41.
5. Verify in the /sbin/ethtool output for eth0 (/sbin/ethtool eth0) that the eth0interface was configured properly. The output will be similar to the following:Settings for eth0: Supported ports: [ TP ] Supported link modes: 10baseT/Half 10baseT/Full 100baseT/Half 100baseT/Full 1000baseT/Full Supports auto-negotiation: Yes Advertised link modes: 10baseT/Half 10baseT/Full 100baseT/Half 100baseT/Full 1000baseT/Full Advertised auto-negotiation: Yes Speed: 1000Mb/s Duplex: Full Port: Twisted Pair PHYAD: 0 Transceiver: internal Auto-negotiation: on Supports Wake-on: d Wake-on: d Current message level: 0x00000007 (7) Link detected: yesIf a response similar to the following appears, you should reconfigure theinterface as default:Settings for eth0:Cannot get device settings: No such deviceCannot get wake-on-lan settings: No such device
Installation prerequisites
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 2505-00095-C04 July 8, 2010
Cannot get message level: No such deviceCannot get link status: No such deviceNo data available
6. Check the RHEL is not set to secure mode by running the following command:cat /etc/selinux/configThe following line should appear:SELINUX=disabledIf the response shows that secure mode is enabled, change the line to‘SELINUX=disabled’ and then reboot the machine.
7. Check the RPC connectivity using the following command:rpcinfo -pA response similar to the following should appear:program vers proto port100000 2 tcp 111 portmapper100000 2 udp 111 portmapper100024 1 udp 791 status100024 1 tcp 794 status
VIP requirementsAs explained in the previous section, the SDE uses VIPs to provide high availabilityconnections to the various system functions, including management and theconnection between each SDE machine and its assigned CMTSs. Prior to SDEinstallation and configuration, you should have the following VIPs at hand:
• 1 VIP for the SDE management service
• 1 VIP for the border service that connects to the WSAM (PCMM only)
• 1 or more VIPs for each edge service. Each cluster is assigned 1 edge service.Therefore, 1 edge VIP is required for each cluster configured for active-standbymode. If the clusters are configured instead for active-active mode, 2 edge VIPsare required for each cluster: one for each node.
Note: It is recommended that, prior to beginning the installation process, you pingthe assigned VIPs to verify that they are not already in use. If the ping receives noresponse, the VIP is available.
RHEL 5.4 installation packagesThe Red Hat Linux 5.4 64-bit operating system should be installed as server mode onthe SDE server.
The following is a list by section of the packages that should be selected for theRHEL 5.4 installation:
Chapter 1: Deployment overview
26 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
• Desktop Environments: No packages should be installed.
• Applications: Only editors should be installed if vi is not sufficient. (Editors willautomatically install Vim and Emacs.)
• Development: no packages
• Servers: no packages
• Base System:• Administration Tools: default sub-options
• Base: default sub-options
• Optional: X Window System (if EMS Linux will be used)
• Languages: Install languages depending on the customer’s location andpreferences.
Installation prerequisites
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 2705-00095-C04 July 8, 2010
Requesting a support account
In order to download SDE software and updates, you need to create a Sandvinecustomer support account.
To request an account:
1. Navigate to https://support.sandvine.com/.
2. Click Register for Support Account. A registration dialog box appears.
Support registration dialog box
3. Fill in all mandatory fields.
4. Click Submit.
When your request has been processed, you will be emailed a confirmationindicating that your support account is active.
Chapter 1: Deployment overview
28 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
2Installing themanagementcluster
This chapter provides detailed instructions forinstalling and configuring the network architectureof both SDE machines in the management cluster.This is the first cluster installed in the site, or theonly cluster in a deployment with two SDE machines.
The following topics are included in this chapter:
• “Pre-installation check list” on page 31 — provides a mandatory checklist of requirementsthat must be met before you can begin theinstallation process
• “Management cluster overview” on page 32 — lists the step-by-step procedures for installingand configuring the management cluster
• “Creating RHEL accessibility to yum” onpage 33 — explains how to create accessibilityto the RHEL installation folder
• “Local yum installation” on page 35 — explains how to install the SDE usinga local yum installation
• “Configuring yum to install the SDE from an FTP site or HTTP server” onpage 37 — explains how to configure yum on the SDE machine so that theSDE software can be installed from an FTP site or HTTP server
• “Installing the SDE software from the yum repository” on page 39 — givesinstructions for installing the SDE software on the SDE machine from the SDEyum repository
• “Installation verifications” on page 41 — lists the procedures for verifyingthe SDE installation
• “Installation troubleshooting” on page 44 — provides procedures fortroubleshooting the SDE installation
• “Logging into the EMS” on page 46 — explains how to log into the EMS Webinterface in order to configure the SDE system
• “Configuring the management machine” on page 50 — explains how toconfigure the network architecture on the management SDE machine
• “Changing the border VIP in the fsam_conf.properties file” on page 57 — gives instructions for an additional configuration of the border VIP whenFairshare is implemented using PCMM
• “Configuring the outbound IPDR relay” on page 58 — gives instructions forconfiguring the SDE to relay IPDR data to an external data collector
• “Second SDE machine” on page 60 — provides instructions for installing theSDE software on the second machine
• “Installation checks and troubleshooting” on page 63 — provides a list ofverification procedures that should be performed after the SDE is installed andconfigured on both machines
Chapter 2: Installing the management cluster
30 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Pre-installation check list
Before reading this chapter and starting to install the SDE software, please use thefollowing checklist to make sure that your network and the target SDE machines areready to begin the process.
Table 4: Pre-installation check list
Mark if‘yes’
Prerequisite
1 Red Hat Enterprise Linux Server release 5.x 64-bit implementation isinstalled on every SDE machine
2 Each SDE machine has been assigned an IP address on the eth0 interface.
3 Each SDE machine has been assigned a hostname (do NOT use thedefault) that is configured properly in:
• hostname
• /etc/hosts
• /etc/sysconfig/network
4 Each SDE machine has been assigned a second IP address that will be usedas a primary, virtual IP address. Note: This is required ONLY if the IPsassigned to the two SDE servers in the cluster and the virtual IPs that willbe assigned through the SDE EMS later in the SDE configuration processsare not all in the same subnet.
5 Each SDE has access to a DNS server that is configured properly.
6 Every SDE machine's time and time zone are synchronized with the NTPserver and are modified to the correct time and time zone.
7 The time and time zone of all SPBs and PTSs deployed in the Fairsharesystem are synchronized with the NTP server and coordinated with thetime and time zone of all SDEs.
Pre-installation check list
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 3105-00095-C04 July 8, 2010
Management cluster overview
The management cluster is the first cluster installed in the site. For sites containingonly two SDE servers, it is the only cluster.
The management service is configured to this cluster, enabling the SDE to spreadconfiguration changes to all SDE nodes in the site. An edge service also is configuredto this cluster. If the SDE will implement Fairshare using PCMM, the WSAM andborder services are configured to the management cluster.
Step 1:
The first step in installing and configuring the management cluster is to install theSDE software on both Linux machines designated as SDE servers. As an installationprerequisite, you must create access on the Linux machine to the official Red HatEnterprise Linux 5.x installation folder. This access is required for first-time SDEinstallation, as well as SDE upgrades.
Step 2:
Once you have created access to the RHEL 5.x installation folder, the SDE uses theyum installer to install the SDE software on the machine. You can copy the SDEinstall folders to your server and install the SDE software locally. Or, you can installthe SDE software from an HTTP or FTP yum repository.
To create access to the Red Hat Enterprise Linux 5.x installation folder, see “Creating RHEL accessibility to yum” on page 33.
To perform a local yum install, see “Local yum installation” on page 35.
To install the SDE software from an HTTP or FTP repository, see “Configuring yum toinstall the SDE from an FTP site or HTTP server” on page 37.
Chapter 2: Installing the management cluster
32 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Creating RHEL accessibility to yum
All SDE installations and upgrades must be able to access a RHEL 5.x installationfolder containing the Red Hat installation RPMs. Prior to installing the SDE for thefirst time, you need to create this accessibility. You also must update accessibility tothe correct RHEL installation folder each time you update the RHEL operatingsystem.
Warning: Sandvine qualifies each SDE release against specific versions of Red HatEnterprise Linux. To ensure proper SDE functionality, you must create accessibilityto a qualified release only. Do not upgrade to a new version of the operating systemuntil Sandvine has qualified the release and sent notification to the field.
Three types of access are possible:
1. Local copy of the official RHEL installation folder
2. Installation folder on an FTP site
3. Installation folder on an HTTP server
To create the accessibility:
1. If you are creating local access to the RHEL installation folder, make an integralcopy of the /Server directory from the RHEL 5.x installation DVD (using rsync -r or cp -r) and store it on the SDE machine at /opt/RHEL5.x/.
2. For all access types, create a /etc/yum.repos.d/rhel.repo file that contains theyum repository definition for the Red Hat Enterprise Linux Server officialinstallation RPMs. Depending on the way you want to access the RHEL officialinstallation, the file will contain the following content:
Note: For all installations, keep in mind the server address (for installations usingFTP and HTTP ) and full path to the server folder of the RHEL installation. The folderneeds to be accessible.
For a local copy of the RHEL official installation:[rhel_x64]name= RHEL RPM Cachebaseurl=file:///opt/rhel5.{x}/Serverenabled=1protect=0gpgcheck=0where {x} is the exact version of RHEL 5.x
For the RHEL installation stored on an FTP site:[rhel_x64]name= RHEL RPM Cache
Creating RHEL accessibility to yum
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 3305-00095-C04 July 8, 2010
baseurl=ftp://{FTP site IP address}/${full path rhel installation disc}/Serverenabled=1protect=0gpgcheck=0
For the RHEL installation stored on an HTTP server:[rhel_x64]name= RHEL RPM Cachebaseurl=http://{MY http SERVER Ip address}/${full path rhel installation disc}/Serverenabled=1protect=0gpgcheck=0
Next step: Now that you have created accessibility to the RHEL 5.x installationfolder, proceed to “Local yum installation” on page 35 to install the softwarelocally or “Configuring yum to install the SDE from an FTP site or HTTP server” onpage 37 to install the SDE software from an HTTP or FTP site.
Chapter 2: Installing the management cluster
34 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Local yum installation
The following instructions enable operators to install the SDE software locally.
To install the SDE software locally using yum:
1. Check that you have accessibility to the Red Hat installation respository. On theSDE machine, enter the following command:yum list --showduplicates redhat-release |grep -vi installedThe output should show the available redhat-release.x86_64 package, similar tothe following example:Available Packagesredhat-release.x86_64 5Server-5.4.0.3 rhel_x64If the package is not displayed, refer to “Creating RHEL accessibility to yum” onpage 33.
2. Copy the following folder from the Sandvine FTP site to: /opt/install/:
• SDE-5.60
3. Create a file called svsde.repo under /etc/yum.repo.d/[sde]name= SDE - Sandvine SDE for \$releasever - Sandvinebaseurl=file://<install path>enabled=1protect=0gpgcheck=0
Where <install path> is the full path of the SDE RPM directory. For example:/opt/install/sde-5.60A response similar to the following, with the appropriate file path, shouldappear:baseurl=file:///opt/install/sde-5.60
4. If you want to preserve your current firewall settings following the install, enterthe following command:export sde_dont_install_firewall_table=yes
5. Confirm that your system is running with RHEL-64 bit by entering the followingcommand:uname -pThe following should appear:x86_64
6. Run the following command to cleanup the yum cache:yum clean all
7. Enter the following installation command:yum install sde-with_fs_edge.x86_64
Local yum installation
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 3505-00095-C04 July 8, 2010
After initial installation of packages, a response similar to the following shouldappear:Transaction Summary===============================================Install 40 Package(s)Update 0 Package(s)Remove 0 Package(s)Total download size: 254 MIs this ok [y/N]:
8. Type ‘y’ to continue the SDE software installation.
When the installation process is complete, a script appears that includes thefollowing notification, signifying that the installation is complete:
Complete!
Chapter 2: Installing the management cluster
36 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Configuring yum to install the SDE froman FTP site or HTTP server
The SDE uses the yum installer to automatically install or update the SDE softwarefrom the Sandvine FTP site or the service provider’s HTTP site. The yum installermust be included in the Red Hat Enterprise Linux installation. If you are installingthe SDE software from an HTTP or FTP site, the first time you install the software onthe machine you need to point the installer to the correct yum repository.
Note: This procedure is for first-time SDE installation only. If you have alreadyperformed it, proceed directly to “Installing the SDE software from the yumrepository” on page 39.
To point the installer to the yum repository:
1. Connect to the SDE machine using SSH:ssh root@<xxx.xxx.xxx.xxx>where <xxx.xxx.xxx.xxx> is the IP address of the SDE machine.
a. You will be asked whether you want to continue connecting to the machine.At the prompt, enter ‘yes’.
b. At the password prompt, enter the password you assigned during RHELinstallation.
2. Check that you have accessibility to the Red Hat installation respository. On theSDE machine, enter the following command:yum list --showduplicates redhat-release |grep -vi installedThe output should show the available redhat-release.x86_64 package, similar tothe following example:Available Packagesredhat-release.x86_64 5Server-5.4.0.3 rhel-discIf the package is not displayed, refer to “Creating RHEL accessibility to yum” onpage 33.
3. Create a file in /etc/yum.repos.d/ called svsde.repo with the followingcontents:
[sde]name= Sandvine Service Delivery Enginebaseurl=ftp://<user_name>:<password>:ftp.support.sandvine.com/SDE/SDE-5.60/sde-5.60enabled=1protect=0gpgcheck=0
where <user_name> is the customer support user name and <password> is thecustomer support password.
4. Run the following command:
Configuring yum to install the SDE from an FTP site or HTTP server
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 3705-00095-C04 July 8, 2010
yum clean allNext step: You are now ready to install the SDE software. See “Installing the SDEsoftware from the yum repository” on page 39.
Chapter 2: Installing the management cluster
38 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Installing the SDE software from the yumrepository
Caution: Make sure that the RHEL version installed on the machine is supportd bythe SDE software you want to install.
To install the SDE software on the machine:
1. If you are not already connected, connect to the SDE machine using SSH:ssh root@<xxx.xxx.xxx.xxx>where <xxx.xxx.xxx.xxx> is the IP address of the SDE machine.
a. You will be asked whether you want to continue connecting to the machine.At the prompt, enter ‘yes’.
b. At the password prompt, enter the password you assigned during RHELinstallation.
2. If you want to preserve your current firewall settings following the install, enterthe following command:export sde_dont_install_firewall_table=yes
3. Confirm that your system is running with RHEL-64 bit by entering the followingcommand:uname -pThe following should appear:x86_64
Warning: If the output is ‘i686’ or ‘i386’, your system is running with RHEL-32bitsand does not meet system specifications. Do not proceed with the installation untilthe system is running with RHEL-64bits.
4. To proceed with the install, execute the following lines:yum install sde-with_fs_edge.x86_64After initial installation of packages, a response similar to the following shouldappear:
Transaction Summary===============================================Install 40 Package(s) Update 0 Package(s) Remove 0 Package(s) Total download size: 254 MIs this ok [y/N]:
5. Type ‘y’ to continue.
When the installation process is complete, a script appears that includes thefollowing notification, signifying that the installation is complete:
End Post-Install script
Installing the SDE software from the yum repository
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 3905-00095-C04 July 8, 2010
Next step: Following software installation, verify that the software has beeninstalled correctly. See “Installation verifications”.
Chapter 2: Installing the management cluster
40 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Installation verifications
Following installation, perform the following steps to verify that the SDE installationwas successful:
1. Reload the shell variable environment by running the following command:source ~/.bashrc
2. At root, enter the following to verify that the proper system modules wereinstalled:sde_infoThe following response should appear, with the appropriate version numbers:SDE with Fairshare Edge - Version: 5.60.xxxx3dm-5.60-xxxxEMS-Linux-5.60-xxxxFSAS-5.60-xxxxIPDRC-5.60-xxxxIPDR_DB-5.60-xxxxjdk_config-5.60-xxxxNetReport-5.60-xxxxPS-5.60-xxxxSDE_Agent-5.60-xxxxSDE_CMD-5.60-xxxxsde_common_libs-5.40-xxxxSDE_CONF-5.60-xxxxsde_config-5.40-xxxxsde_ems-5.60-xxxxSDE_MIBS-5.60-xxxxSDE_Monitoring-5.60-xxxxSDE_Upgrade-5.60-xxxxsde-with_fs_edge-5.60-xxxxsvDBMaintenance-5.60-xxxxsvIp2Qam-5.60-xxxxsvupdate-1-17WSAM-5.60-xxxx
3. At root, verify that the SDE is running successfully by checking the status of theSDE and spread services with the following command:service sde statusThe following response (with the appropriate PID) should appear:ps_watchdog (pid xxxxx) is running...svPolicyServer (pid xxxxx) is running...wsam_wdog (pid xxxxx) is running...svWsam (pid xxxxx) is running...ps_agent_wdog (pid xxxxx) is running...svAgent (pid xxxxx) is running...fs_am_wdog (pid xxxxx) is running...
Installation verifications
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 4105-00095-C04 July 8, 2010
svFSAS (pid xxxxx) is running...dbm_wdog (pid xxxxx) is running...svDBMaintenance (pid xxxxx) is running...ipdr_wdog (pid xxxxx) is running...svIPDRCollector (pid xxxxx) is running...ip2qam_wdog (pid xxxxx) is running...svIp2Qam (pid xxxxx) is running...wdogReplication.sh (pid xxxxx) is running...db_wdog (pid xxxxx) is running...
Note: In the event that the above response shows that the SDE Agent is stopped(svAgent stopped....), see “Installation checks and troubleshooting” on page 63.
4. Verify that the spread watchdogs are running by entering the following:service spread statusThe following response (with the appropriate PID) should appear:spread_wdog (pid xxxx) is running...
5. Verify that portmap is running:service portmap status The following response (with the appropriate PID) should appear:portmap (pid xxxx) is running... If the appropriate response does not appear:
a. enable portmap's levels:
chkconfig --levels 35 portmap onb. Verify that the rules are enabled:
chkconfig --list | grep portmapportmap 0:off 1:off 2:off 3:on 4:off 5:on 6:off
c. Start portmap:
service portmap startd. Verify that portmap is running:
service portmap status6. Check that MySQL was correctly installed:
a. Check that MySQL is located in /opt/mysql:ll /opt/mysql
b. Verify that the /opt/tmp directory was created during the installation:ll /opt/tmp
c. If the /opt/tmp directory was not created, manually create it now:mkdir /opt/tmpchmod 777 /opt/tmp
d. Run MySQL, by executing the following:mysql SDE_DC_DB
Chapter 2: Installing the management cluster
42 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
MySQL should start with the correct my.cnf loaded.
e. If the /opt/mysql/ was not created upon SDE installation, enter the followingcommands:
cd /var/libmv mysql /optcd /var/libln -s /opt/mysql
f. If my.cnf was not loaded correctly into the database, enter the followingcommands:
rm -rf /var/lib/mysql/ib*rm -rf /var/lib/mysql/SDE_DC_DBservice mysql restart
g. Load the database schema using the following command:mysql -u root SDE_DC_DB < /opt/SDE/IPDRC_DB/SDE_DC_DB.sql
Caution: If any of the above steps failed, halt installation and contact Sandvinecustomer support.
Installation verifications
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 4305-00095-C04 July 8, 2010
Installation troubleshooting
Missing dependenciesIf net-snmp RPMs are missing during yum installation, a message similar to thefollowing appears:
1:net-snmp-perl-5.3.2.2-7.el5.x86_64 from sde-retail has depsolving problems --> Missing Dependency: net-snmp = 1:5.3.2.2-7.el5 is needed by package 1:net-snmp-perl-5.3.2.2-7.el5.x86_64 (sde-retail)Error: Missing Dependency: net-snmp = 1:5.3.2.2-7.el5 is needed by package 1:net-snmp-perl-5.3.2.2-7.el5.x86_64 (sde-retail)
To solve the problem:
1. Verify that you have access to the RHEL installation folder, as explained in “Creating RHEL accessibility to yum” on page 33.
2. Rerun the SDE install command. See “Installing the SDE software from the yumrepository” on page 39.
yum troubleshootingIf the yum installer was not configured correctly, error message 256 appears whenyou start the yum installation:
Error Downloading Packages: SDE_Monitoring - 5.40-0020.noarch: failure: SDE_Monitoring-5.40-0020.noarch.rpm from sde: [Errno 256] No more mirrors to try. SDE_CONF - 5.40-0021.noarch: failure: SDE_CONF-5.40-0021.noarch.rpm from sde-udpate: [Errno 256] No more mirrors to try.
In this case, you should clean the yum cache, then reconfigure the yum installer, asdescribed in “Configuring yum to install the SDE from an FTP site or HTTP server” onpage 37.
To clean the yum cache:
• Enter the following command:yum clean all
Chapter 2: Installing the management cluster
44 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
SDE machine hostnameIf the SDE machine’s hostname is not changed from the default(localhost.localdomain) prior to SDE software installation, the SDE agent fails tomount, and spread doesn’t work properly. To resolve the problem, change thehostname on the machine.
To change the host name:
1. Run hostname and add the hostname to the machine (example new name isshown in bold), then save the file:
hostname <sde hostname>
2. Edit and save the /etc/hosts file for the new hostname (changes shown in bold):
/etc/hostsDo not remove the following line, or various programs that require network functionality will fail.::1 localhost6.localdomain6 localhost6127.0.0.1 localhost.localdomain localhostxxx.xxx.xxx.xxx <sde hostname>
Where xxx.xxx.xxx.xxx is the IP address of the SDE node.
3. Edit and save the /etc/sysconfig/network file for the new hostname (changesshown in bold):/etc/sysconfig/network NETWORKING=yes NETWORKING_IPV6=yes HOSTNAME=<sde hostname>
4. Restart the SDE and services:
a. Stop the SDE processes:service sde stop
b. Stop Spread:service spread stop
c. Wait 5 seconds and then start Spread:service spread start
d. Wait 5 seconds and then restart the SDE:service sde start
Next step: You are now ready to log into the EMS, as explained in “Logging into theEMS” on page 46, so that you can configure the services that run on the machine.
Installation troubleshooting
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 4505-00095-C04 July 8, 2010
Logging into the EMS
Following installation of the SDE software on both machines, connect to the firstmachine in the cluster using the SDE EMS (Element Management System). The EMS isthe graphical user interface for configuring, managing and troubleshooting the SDEsystem. It enables you to configure the SDE system.
EMS access optionsThe SDE includes three EMS graphic interfaces:
• The Web EMS interface enables users to access the EMS from any Windowsmachine using a Web browser.
• The Linux EMS can be run from the SDE machine, or from a Linux host machineusing a full Linux graphic interface (e.g., KDE or GNOME) through an SSHconnection to the SDE machine. The Linux EMS also can be run from a Windowsmachine via an X Windows interface.
• The Windows EMS can be installed and run on any Windows machine.
The SDE also includes an EMS command line interface (CLI) that enables operators toconfigure network elements and view the status of different system elements in anSDE node from the command line on the local SDE machine.
Windows EMS installationThe Windows EMS install file can be accessed through the Sandvine CustomerSupport Web site.
Note: Every installation of the Windows EMS comes with JRE 1.6. This JRE is usedonly when the EMS is running.
To install the EMS on a Windows machine:
1. Log into the Sandvine Customer Support Site located at https://support.sandvine.com with your user name and password.
2. In the Software tab, select SDE > EMS from the Family of Products, then selectthe correct stream and software release.
EMS software file path
3. Click the SDE EMS version that you want to download to your machine. If you areworking with the latest SDE release, select the latest version of EMS.
Chapter 2: Installing the management cluster
46 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
4. In the dialog box that appears, click Save.
5. Double-click the downloaded SDE-EMS-x.xx.xxxx.exe file icon.
6. At the security warning, click OK or Run to run the EMS installer.
Installing the X Window System packagegroupFor systems with access to a RHEL 5.x 64- bit distribution yum repository, to installthe X Window System package group:
1. Log into the SDE machine.
2. Run the following commands:yum groupinstall "X Window System"yum install gtk2.i386 libXtst.i386
EMS login sequenceNote: The following information assumes the EMS is already installed on a Windowsmachine and/or that the X Window System package group for Red Hat EnterpriseLinux has been installed on the SDE machine. When running the SDE from a remoteLinux machine, a Linux distribution with graphic support, such as KDE or GNOME,must be installed on the machine. To run the Linux EMS from a Windows machine,make sure that an X Windows interface is installed.
To run the EMS using the Web interface from any machine:
1. Open your Web browser and go the following URL:
http://<SDE_MACHINE>:<port>/sde_ems
where <SDE_MACHINE> is the IP or FQDN of the SDE machine and <port> is theport specified during Tomcat installation. On a Linux machine, the port is usually8085.
For example, for an SDE machine with IP address 172.16.0.104, the URL mightbe: http://172.16.0.104:8085/sde_ems/.
The EMS Web portal appears.
2. Click Launch SDE EMS.
Java Web is activated, and a security warning appears.
3. Click Run. The SDE EMS login dialog box appears.
Logging into the EMS
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 4705-00095-C04 July 8, 2010
EMS login dialog box
To run the Windows EMS:
• On the Windows machine, double-click the EMS icon on the desktop. Or, fromthe Start > All Programs menu select Sandvine > SDE EMS 5.xx > SDE EMS
The EMS login dialog box appears.
To run the Linux EMS on the SDE machine or from a remote machine (Linux orWindows):
• On the SDE machine, execute the following lines:cd /opt/SDE/SDE_EMS/./ems_start
• On a remote Linux machine, execute the following lines:ssh -X <IP address of SDE machine>cd /opt/SDE/SDE_EMS/./ems_start
• From a Windows machine:1. Connect to the SDE machine using an X Windows interface.2. Execute the following lines:
cd /opt/SDE/SDE_EMS/./ems_start
The EMS login dialog box appears.
Note: To run the EMS from an SDE machine, the Red Hat Enterprise Linux X WindowSystem package group must be installed already on the machine.
To log in:
1. Type sv_admin as the user name and sv_admin as the password.
2. In the SDE Server field, type the IP address or FQDN of the machine on whichthe SDE is installed.
Note: The SDE machine’s IP address or FQDN is used for first-time EMS login only.Once the system’s management VIP is configured, log into the EMS using themanagement VIP.
3. Click OK. The EMS Manager appears.
Chapter 2: Installing the management cluster
48 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
SDE EMS manager
Next step: You are now ready to proceed to the next step, “Configuring themanagement machine” on page 50.
Logging into the EMS
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 4905-00095-C04 July 8, 2010
Configuring the management machine
The management machine is the first SDE server in the cluster. Configure themanagement machine’s network architecture before adding the second machine tothe system through the EMS.
Configuring the servicesThe SDE comes with three predefined services—one each for management, border,and edge—and one predefined SDE node (the machine whose IP you just used to loginto the EMS). Configure the VIP for the management and edge services. If the SDEwill implement Fairshare actions using PCMM, also configure a border service VIP anda WSAM service. Follow the order described in the instructions for theseconfigurations.
The different VIP parameters are explained in “VIP parameters” on page 51.
Assigning the management VIPThe management VIP is the first VIP assigned to the system. The EMS connects to themanagement service using this VIP, and the management service spreads changes toall SDE nodes. The management service MUST be assigned a VIP in order to enableoperators to add more than one node to the SDE for high availability.
To assign the management service a VIP:
1. In the Configurations tree, open Services List > Management Service. Right-click Virtual IPs, then select Add Virtual IP. The Virtual IP dialog box appears.
Virtual IP dialog box
2. Type the VIP in the Virtual IP field.
Chapter 2: Installing the management cluster
50 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
3. Select the correct netmask and default gateway from the drop-down lists. TheSDE automatically designates the first SDE node as the VIP’s primary SDE node.This is the pre-defined SDE node that assumes “ownership” of the VIP.
4. Click OK.
5. An alert appears that the EMS will automatically reconnect to the SDE using themanagement VIP. Click OK to continue. The VIP appears under the managementservice in the Configurations tree.
Use the management VIP instead of the SDE machine’s physical IP address whenlogging into the SDE EMS from any location, including a Web browser, in thefuture.
Caution: The management service must be assigned a VIP for the SDE to workproperly. You will be unable to add any additional nodes to the SDE without themanagement VIP.
VIP parametersTable 5: VIP parameters
Parameter Definition Default Value
Virtual IP Dynamic IP address assigned to a service. Assignat least one per service. The SDE communicateswith other network elements (CMTSs, SPBs, AMs,ASs) using these IP addresses. In the event offailover, the VIPs move from the failed node toan active node.
--
Netmask Netmask assigned to the VIP. It remains with theVIP if it moves from node to node.
255.255.255.255
Default Gateway IP of the node on the computer network thatserves as an access point to another network
--
Primary SDE Node IP of the predefined SDE node that assumes“ownership” of the VIP
--
Configuring the edge VIPTo configure the edge VIP:
1. In the Configurations tree, open Services List > Edge Service. Right-click VirtualIPs, then select Add Virtual IP. The Virtual IP dialog box appears.
2. Specify the virtual IP, subnet mask, and default gateway. The systemautomatically assigns the first SDE node as the primary SDE node. This is the SDEmachine that assumes ownership of the VIP.
3. Click OK.
Configuring the management machine
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 5105-00095-C04 July 8, 2010
Next step: If the SDE will apply Fairshare actions by setting attributes in the PTS,you are now ready to configure the database decimation, as explained in Configuringdatabase decimation.
If the SDE will implement Fairshare using PCMM, you should configure the borderservice VIP at this point.
Configuring the border VIPIf the SDE will implement Fairshare actions using PCMM, assign the border service aVIP.
To assign the border VIP:
1. In the Configurations tree, open Services List > Border Service. Right-clickVirtual IPs, then select Add Virtual IP. The Virtual IP dialog box appears.
2. Specify the virtual IP, subnet mask, and default gateway. The systemautomatically assigns the first SDE node as the primary SDE node. This is the SDEmachine that assumes ownership of the VIP.
3. Click OK.
If the SDE will apply Fairshare actions using an external policy server, configurethe external PS connection at this point. Otherwise, you are now ready toconfigure a WSAM service.
Configuring the external PS connectionWhen the SDE will connect to third-party policy servers for PCMM Fairshareimplementation, you are required to configure an additional border service, whichconnects to the external policy server using the policy server’s physical IP.
To configure the border VIP for the external policy server:
1. In the Configurations tree, right-click Services List, then select Add Service.The New Service dialog box appears.
Chapter 2: Installing the management cluster
52 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
New Service dialog box
2. Assign the service a name (e.g., ‘Border_2’).
3. Optionally type a description of the service (e.g., ‘External PS’).
4. Change the Use for external PS attribute to ‘Yes’.
5. Click OK. The service appears in the Services list.
6. In the Configurations tree, open the node for the border service you justcreated.
7. Right-click External PS IPs, then select Add external PS IP. The External PS IPdialog box appears.
External PS IP dialog box
8. Type the IP of the policy server, and then click OK. The IP appears under theborder service in the Configurations tree.
You are now ready to configure a WSAM service.
Configuring the WSAM serviceTo configure the WSAM service:
1. Right-click Services List, then select Add Service. The New Service dialog boxappears.
Configuring the management machine
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 5305-00095-C04 July 8, 2010
New Service dialog box
2. Click the Type field and select WSAM from the list.
3. Assign the service a name (e.g., ‘WSAM Service’).
4. Optionally type a description of the service.
5. Specify the PS Entry Point and the AM ID. The PS Entry Point is the VIP of theborder service. The WSAM uses this VIP to receive Fairshare rule actions from thedifferent SDE nodes and to communicate with the policy server. For a completelist of WSAM service parameters, see “Service parameters” on page 54.
6. Click OK. The service appears in the Services list.
Service parametersTable 6: Services parameters/nodes
Parameter Definition Default Value
Type Defines the type of service being added N/A
Border Supports connections from the FairshareEngine to the WSAM and/or from the WSAMto the policy server to achieve highavailability
Border
Edge Supports connections to CMTSs and SPBs toachieve high availability
Edge
Management Provides connections to managementsystems. Define only one managementservice per system.
Management
WSAM Defines the WSAM (Web ServicesApplication Manager)
WSAM
Chapter 2: Installing the management cluster
54 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Parameter Definition Default Value
Name Name of service as it appears in the EMS ServiceType_X
Description Optional description of the service --
OSS (edge service only) OSS to which the edge service connects none
PS Entry Point (WSAMservice only)
VIP of the border service used tocommunicate with the policy server
--
AM ID (WSAM service only) Operator-assigned ID of this AM. Used bythe policy server to send gates
--
Port (WSAM service only) HTTP port on which the WSAM receivesrequests for service from the applicationserver and sends responses in turn.
8080
Attaching new services to the SDE nodeIf you created a WSAM service so that the SDE can implement Fairshare actions usingPCMM, you need to attach this service to the SDE node:
To attach a new service:
1. In the SDE Node List, expand the SDE node and select Attached Services. A listof services appears in the EMS right pane.
Expanded SDE node list
2. Select the check box for the WSAM service. All services should be marked asattached in the EMS right pane.
Configuring the management machine
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 5505-00095-C04 July 8, 2010
Attached SDE services
Next step: For all deployments that will implement Fairshare using PCMM, continueon to “Changing the border VIP in the fsam_conf.properties file” on page 57. Fordeployments that apply Fairshare solely through the PTS, proceed to the installationand configuration of the second machine in the cluster, as described in “Second SDEmachine” on page 60. If the SDE will relay the DOCSIS 2.0 IPDR data to an externaldata collector, configure the outbound relay after changing the border VIP or beforeinstalling the second machine, as explained in “Configuring the outbound IPDR relay”on page 58.
Chapter 2: Installing the management cluster
56 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Changing the border VIP in thefsam_conf.properties file
For all deployments that will implement Fairshare using PCMM, edit thefsam_conf.properties file in order to define the border VIP that the Fairshare enginewill use to send Fairshare requests to the WSAM.
To define the border VIP:
1. Stop the SDE service if you haven’t already done so: service sde stop
2. Open the fsam_conf.properties file for editing:vi /opt/SDE/FSAS/config/fsam_conf.properties
3. The file currently is configured to send Fairshare requests to the WSAM on thelocal machine. In the WSAM Parameters section, change the parametercom.cmx.odsp.fsam.wsam_url=localhost:8080tocom.cmx.odsp.fsam.wsam_url=<border_VIP>:8080where border_VIP is the VIP defined for the border service and the PS entrypoint of the WSAM.
If the WSAM sends the gates for the Fairshare actions to an external policyserver, border_VIP is the second VIP of the border service configured to thesystem.
4. Save the file.
5. Restart the SDE service:service sde start
Next step: If the SDE will relay the DOCSIS 2.0 IPDR data to an external datacollector, configure the outbound relay after changing the border VIP or beforeinstalling the second machine, as explained in “Configuring the outbound IPDR relay”on page 58. Otherwise, proceed to the installation and configuration of the secondmachine in the cluster, as described in “Second SDE machine” on page 60.
Changing the border VIP in the fsam_conf.properties file
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 5705-00095-C04 July 8, 2010
Configuring the outbound IPDR relay
If the SDE will also relay IPDR data to an external data collector, configure theoutbound IPDR relay at this point. The SDE relays the IPDR data from all CMTSvendor types in streaming mode.
To configure the outbound relay:
1. On the SDE machine, open the /etc/sysconfig/sde file for editing: vi /etc/sysconfig/sde
2. At the end of the file, add the following line:RUN_IPDR_REDIRECT=yesThe file should appear as follows:RUN_WIMAX=noRUN_IPDR=yesRUN_FSAM=yesRUN_SPBC=yesRUN_MYSQL=yesRUN_WEBEMS=yesRUN_MYSQL=yesRUN_MYSQL_CLUSTER=yesRUN_IPDR_REDIRECT=yes
3. Save the file.
4. Execute the following commands:service sde initservice sde restart
5. Check the status of the IPDR redirect process:service sde statusThe response should include the following, with the appropriate PID, indicatingthat svIPDR redirect is running:svIPDRRedirect (pid 1234) is running...
6. In the SDE EMS, in the SDE Parameters > IPDR Collection node:
a. Set Enable File Logging to ‘Yes’.
b. Configure the IP address of the external collector in the Relay Collector IPfield.
c. Configure the port of the external collector in the Relay Collector Port field.The relay collector port is usually 6210.
Note: Make sure you also set Enable File Logging to ‘Yes’ on every CMTS configuredto the SDE. For instructions, see “Import CMTSs/CMTS maps overview” on page 96or “Configuring CMTSs through the EMS” on page 156.
Chapter 2: Installing the management cluster
58 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Next step: Proceed to the installation and configuration of the second machine inthe cluster, as described in “Second SDE machine” on page 60.
Configuring the outbound IPDR relay
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 5905-00095-C04 July 8, 2010
Second SDE machine
Following configuration of the first SDE node, configure the cluster’s high availabilityby configuring the second node to the system and attaching all services to thesecond node. In the event that the first node fails, its VIPS—and services—aretransferred to the second SDE node, along with all the CMTSs attached to the firstnode’s edge VIP.
For load balancing purposes, you can assign a second VIP to the edge service anddesignate the second SDE machine as the VIP’s primary SDE node. This enables youto configure half the CMTSs in the cluster to the first SDE node and half to thesecond SDE node. In the event the second SDE node fails, the edge VIP designatedfor the node fails over to the first SDE node.
Note: Upon recovery of a failed SDE node, the node tries to resume its originalconfiguration, and the failover node hands off the border and edge VIPs to theiroriginal owner. The management service, however, remains on the failover machine.
Adding SDE nodesTo add an SDE node to the system:
1. In the Configurations tree, right-click SDE Node List and select Add SDE Node.The New SDE Node dialog box appears.
New SDE Node dialog box
2. Type the SDE’s physical IP address or FQDN, and the net mask assigned to themachine upon OS installation.
Chapter 2: Installing the management cluster
60 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
3. Optionally give the node a name and description. The name enables you todifferentiate the different types of nodes in the EMS GUI. For a description ofthe different node parameters, see “SDE node parameters” on page 61.
4. Click OK. The configuration may take up to 2 minutes. The Progress Informationbar appears to inform you of the configuration's progress.
When the configuration is complete, the node appears in the SDE Node List.
SDE node parametersTable 7: SDE node parameters
Parameter Description Default Value
Label Defines the name of the SDE node as itappears in the SDE Node List
SDE_1
IP or FQDN Physical IP address or FQDN of the machine --
Mask The mask assigned to the machine uponinstallation
255.255.255.0
Description Optional description of the machine (typesof services it hosts, etc.)
--
Attaching services to the new nodeTo attach the services to the second SDE node:
1. In the SDE Node List, expand the second SDE node.
2. Select Attached Services. A list of services appears in the EMS right pane.
3. Select the check box for every service shown in the Attributes pane.
Configuring a second edge VIPDepending on your system’s configuration, you can optionally configure a secondedge VIP to the system for CMTS load balancing purposes and designate the secondSDE machine as the VIP’s primary SDE node. This configures the cluster for active-active mode.
When this configuration is used, half the CMTSs connect to the SDE using the first VIPand half the CMTSs connect to the second VIP.
Second SDE machine
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 6105-00095-C04 July 8, 2010
Adding an edge VIPTo add an edge VIP:
1. In the Configurations tree, open Services List > Edge Service. Right-click VirtualIPs, then select Add Virtual IP. The Virtual IP dialog box appears.
2. Specify the virtual IP, subnet mask, and default gateway.
3. The system automatically assigns the first SDE node configured to the system asthe primary SDE node. Change the primary SDE node so that the new SDE nodeassumes ownership of the VIP. To change the primary node:
a. Click Change.
b. In the Primary SDE Node dialog box, select the second node from the list;then click OK.
4. Click OK.
Changing the border VIP in thefsam_conf.properties fileFor all deployments that will implement Fairshare using PCMM, on the SDE machineedit the com.cmx.odsp.fsam.wsam_url=<border_VIP>:8080 parameter in thefsam_conf.properties file to define the border VIP that the Fairshare engine will useto send Fairshare requests to the WSAM. For instructions, see “Changing the borderVIP in the fsam_conf.properties file” on page 57.
Next step: Proceed to “Installation checks and troubleshooting” on page 63, orelse first configure the outbound IPDR relay.
Configuring the outbound relayIf the SDE will relay IPDR data to an external data collector, configure the outboundIPDR relay at this point, as described in “Configuring the outbound IPDR relay” onpage 58.
Next step: Proceed to “Installation checks and troubleshooting” on page 63.
Chapter 2: Installing the management cluster
62 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Installation checks and troubleshooting
Following configuration of the second SDE node, perform the following steps toverify that the SDE is properly configured:
1. In the EMS Status > SDE system node, verify that the SDE machines are greenand that all required VIPs are attached to them. For an explanation of the statusview for the different SDE configurations, see below.
2. In the EMS SDE Nodes List > Logs node, verify that all logs are free of errors.
3. Log into the SDE machine and verify that the VIPs are listed using the followingcommand:ifconfig If any of the above checks failed, halt installation and contact Sandvine.
SDE system viewThe Status > SDE System node displays a hierarchical diagram of the SDE system andindicates whether the different elements are connected, disconnected, or disabled.It contains the following levels:
• SDE nodes
• WSAMs and VIPs configured to the node
• Devices (CMTSs, AMs) that communicate with the node on a given VIP
The statuses of elements are displayed as follows:
• Green — element connected
• Yellow — element is operational but no services are linked to it
• Red — element is disconnected
• Gray — element is disabled
• Blue — neutral element, such as a VIP
When a cluster is configured in active-standby mode, the active SDE node shouldappear as green and the standby node should be yellow. When both nodes areactive, both should be green.
Note: SDE System also displays simulators.
Installation checks and troubleshooting
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 6305-00095-C04 July 8, 2010
SDE System: cluster in active-standby mode
SDE System: active-active mode
Chapter 2: Installing the management cluster
64 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
SDE System: failover from active-active mode
Cluster installation completeNext step: If the deployment includes more than one SDE cluster, continue on to Chapter 3: “Adding additional clusters” on page 67. For a single-clusterdeployment (2 machines), continue with Chapter 4: “Global SDE parameters” onpage 75.
Installation checks and troubleshooting
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 6505-00095-C04 July 8, 2010
Chapter 2: Installing the management cluster
66 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
3Adding additionalclusters
This chapter provides detailed instructions forinstalling and configuring additional clusters to thesite.
The following topics are included in this chapter:
• “Cluster overview” on page 68 — describesthe new SDE cluster and the requiredconfigurations
• “Installing the SDE software” on page 69 — gives instructions for installing the SDE softwareon the SDE machines
• “Configuring the nodes” on page 70 — provides instructions for configuring the cluster’shigh availability, distributed architecture
• “Installation checks and troubleshooting” onpage 73 — provides a list of verificationprocedures that should be performed after theSDE is installed and configured on both machines
Cluster overview
Every additional cluster in the regional data center contains two SDE nodes. Oneedge service is configured to the cluster. One or two VIPs are assigned to the edgeservice, depending on whether it will run in active-standby mode (1 VIP) or active-active mode (2 VIPs).
Configure each additional cluster in the system in the exact order that theinformation is provided in this chapter. The number of clusters you configure willdepending on the scaling requirements for the deployment.
Chapter 3: Adding additional clusters
68 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Installing the SDE software
Install the SDE software on both machines in the cluster prior to configuring theVIPs. On each machine you need to:
• Install the SDE software from the local yum repository. For instructions see “Local yum installation” on page 35.
or,
• Configure the SDE machine’s yum installer to point to the correct repository(first-time installation only when the yum repository is used) and install thesoftware from the yum repository. For information, see “Configuring yum toinstall the SDE from an FTP site or HTTP server” on page 37 and “Installing theSDE software from the yum repository” on page 39.
Following installation of the software, verify that the installation is correct by usingthe procedures in “Installation verifications” on page 41.
Installing the SDE software
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 6905-00095-C04 July 8, 2010
Configuring the nodes
After installing the SDE software on the machines, add both nodes to the SDEsystem. Next, create a new edge service and attach it to both nodes.
Depending on the specific configuration of your system, you also can attach themanagement service to the nodes at this point.
After the services are attached to the nodes, assign the edge service one VIP (active-standby cluster) or two VIPs (active-active cluster). Designate the VIP(s) primary SDEnode.
Adding SDE nodesTo add an SDE node to the system:
1. In the Configurations tree, right-click SDE Node List and select Add SDE Node.The New SDE Node dialog box appears.
New SDE Node dialog box
2. Type the SDE’s physical IP address or FQDN, and the net mask assigned to themachine upon OS installation.
3. Optionally give the node a name and description. The name enables you todifferentiate the different types of nodes in the EMS GUI. For a description ofthe different node parameters, see “SDE node parameters” on page 61.
4. Click OK. The configuration may take up to 2 minutes. The Progress Informationbar appears to inform you of the configuration's progress.
When the configuration is complete, the node appears in the SDE Node List.
Chapter 3: Adding additional clusters
70 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Adding an edge serviceTo create an edge service:
1. Right-click Services List, then select Add Service. The New Service dialog boxappears.
2. In the New Service dialog box, select Edge as the type of service and give theservice a name.
3. Optionally type a description of the service.
4. Click OK. The service appears in the Services list.
Attaching the servicesTo attach the services to the nodes:
1. In the SDE Node List, expand the first node in the cluster.
2. Select Attached Services. A list of services appears in the EMS right pane.
3. Select the check box for the edge service.
Note: If your system’s configuration calls for attaching the management service toall SDE nodes, do so at this time.
4. Repeat the above steps for the second node in the cluster.
Configuring the edge VIP(s)To configure the VIP(s) for the edge service:
1. In the Configurations tree, open Services List > Edge Service. Right-click VirtualIPs, then select Add Virtual IP. The Virtual IP dialog box appears.
2. Specify the virtual IP, subnet mask, and default gateway.
3. The system automatically assigns the first SDE node configured to the system asthe primary SDE node. Change the primary SDE node so that one of the nodes inthe new cluster assumes ownership of the VIP. To change the primary node:
a. Click Change.
b. In the Primary SDE Node dialog box, select the second node from the list;then click OK.
4. Click OK.
Changing the border VIP in thefsam_conf.properties fileIf the deployment will implement Fairshare using PCMM, on each SDE machine editthe com.cmx.odsp.fsam.wsam_url=<border_VIP>:8080 parameter in the
Configuring the nodes
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 7105-00095-C04 July 8, 2010
fsam_conf.properties file to define the border VIP that the Fairshare engine will useto send Fairshare requests to the WSAM. For instructions, see “Changing the borderVIP in the fsam_conf.properties file” on page 57.
Next step: Proceed to “Installation checks and troubleshooting” on page 63 to verifythat the SDE is properly installed and configured, or else first configure theoutbound IPDR relay.
Configuring the outbound IPDR relayIf the SDE will relay IPDR data to an external data collector, on each SDE machineconfigure the outbound IPDR relay, as explained in “Configuring the outbound IPDRrelay” on page 58.
Next step: Proceed to “Installation checks and troubleshooting” on page 63.
Chapter 3: Adding additional clusters
72 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Installation checks and troubleshooting
Following configuration of the second SDE node, perform the following steps toverify that the SDE is properly configured:
1. In the EMS Status > SDE system node, verify that the SDE machines are greenand that all required VIPs are attached to them. For an explanation of the statusview for the different SDE configurations, see below.
2. In the EMS SDE Nodes List > Logs node, verify that all logs are free of errors.
3. Log into the SDE machine and verify that the VIPs are listed using the followingcommand:ifconfig If any of the above checks failed, halt installation and contact Sandvine.
Cluster installation completeNext step: If the deployment includes more than two SDE clusters, repeat the stepsin this chapter for each cluster in the site.
If you have finished installing additional clusters, keep the EMS open and proceed to Chapter 4: “Global SDE parameters” on page 75.
Installation checks and troubleshooting
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 7305-00095-C04 July 8, 2010
Chapter 3: Adding additional clusters
74 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
4Global SDEparameters
This chapter provides instructions for defining theglobal SDE parameters as part of the SDEconfiguration process. These parameters define theSDE’s behavior.
The following topics are included in this chapter:
• “Overview of SDE parameters” on page 77 — contains information on configuring SDEparameters
• “General parameters” on page 78 — miscellaneous parameters common to the SDE, aswell as parameters that define system behaviorwhen the SDE policy server is deployed
• “Log parameters” on page 81 — define thebehavior of the different SDE logs
• “COPS parameters” on page 83 — protocolparameters for the COPS connection between theSDE and each AM or CMTS that connects to itwhen the SDE policy server is deployed
• “WSAM parameters” on page 84 — define theWSAM configuration parameters
• “Fairshare parameters” on page 85 — define the attributes of the differentFairshare elements
• “Data collection parameters” on page 86 — used to configure the SDE’s datacollector module, which collects subscriber usage and network topologyinformation
• “Subscriber mapping parameters” on page 92 — explains how to configurethe SDE for subscriber topology mapping
Chapter 4: Global SDE parameters
76 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Overview of SDE parameters
The SDE contains a number of global parameters that define the behavior ofdifferent system elements. Unless otherwise indicated, use the default values.
Define the global parameters only once. The SDE applies them to every cluster andnode in the system.
Configuring SDE parametersTo configure SDE parameters:
1. If necessary, log into the Web EMS.
2. In the Configurations tree, open the SDE Parameters node, then select the typeof parameters you want to configure.
3. In the attributes pane, define the parameters as necessary, according to thevalues in the parameter tables.
Overview of SDE parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 7705-00095-C04 July 8, 2010
General parameters
General parameters are miscellaneous parameters that are common to the SDEsystem. If you are using Fairshare with a third-party policy server or the SPB for datacollection, define only the RO Community and RW Community parameters.
All other general parameters are for use when the SDE policy server is used.
Note: Parameters marked with an ‘*’ require configuration when the SDE policyserver is used.
Table 8: General parameters
Parameter Description Default Value
FEID Financial Entity ID. Identifies the payingentity. Defined by the MSO according toPCMM specifications. For use with the SDEpolicy server only
Sandvine Inc.
Element ID * Network-wide unique identifier in therange of 0-99,000. For use with the SDEpolicy server only
1
Stateful Limit Maximum number of gates the edge servicekeeps in stateful storage. Range = 0 -250,000. If the number of gates in thesystem exceeds the stateful limit, no newgates are processed by the SDE forforwarding to the CMTS. For use with theSDE policy server only
100000
Stateful Sync SDE verifies a gate’s existence after CMTSreconnection by sending a Gate-Info. Foruse with PCMM I02 when the SDE policyserver is used
Yes
Sync Time Between Gate-Info (ms)
Time interval between Gate-Infos duringthe gate synchronization process followinga CMTS reconnection. For use with the SDEpolicy server only
500
Storage Gate Timeout (sec) Time interval before the SDE erases a gatefrom the gate store if the CMTS doesn’trespond to the gate. For use with the SDEpolicy server only
180 (3 min)
Garbage Gates MaximumTime (hour)
Maximum amount of time a gate can existbefore it is labeled a suspect garbage gate.
0
Chapter 4: Global SDE parameters
78 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Parameter Description Default Value
When the time is set to ‘0’ the feature isdisabled. For use with the SDE policy serveronly. See “Garbage gates”, below.
Garbage Gates Start Time Determines the starting time forcalculating the maximum amount of timein the above parameter:Creation - maximum amount of time iscalculated from when the gate was createdModification - calculation of maximumamount of time from the last time the gatewas modifiedFor use with the SDE policy server only.“See Garbage gates”, below.
Creation
Accounted Gates Determines which gates may be suspectedas garbage gates:all gates - all gates may be suspectT3=0 - only those gates without an idletime out can be suspect
All gates
Enable Security Cleans the IPsec configuration if the COPSconnection is closed because the numberof reconnect tries exceeds 10. For use withthe SDE policy server only
No
Failover on Startup Time(sec)
Amount of time that elapses after systemrestart before the lead SDE node checksthat all the nodes in his group are running.For use with the SDE policy server only
30
PSID SDE node’s ID number (I03 only). For usewith the SDE policy server only
3333333333
Remote Stateful Update If ‘yes,’ the system enables highavailability for the gate store within eachservice. For use with the SDE policy serveronly
Yes
Enable CMTS buffering If a CMTS temporarily disconnects from theSDE, the SDE buffers the gates whilewaiting for the CMTS to reconnect. For usewith the SDE policy server only
Yes
Maximum wait time inCMTS buffer (sec)
If CMTS buffering is used, the maximumtime the gate waits in the queue beforethe SDE returns the gate with an error. Foruse with the SDE policy server only
10
General parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 7905-00095-C04 July 8, 2010
Parameter Description Default Value
RO Community The read only community for the SDE SNMPagent
svPublic
RW Community The read-write community for the SDESNMP agent
svPrivate
DNS resolution retry period(sec)
The cycle between DNS resolutions when aconnection fails
60
Garbage gatesThe garbage gates feature (for use with the SDE policy server only) enables the SDEto tag gates as “suspect garbage gates” if they remain in the system unused for longperiods of time. These may be gates that remain in the system after they are nolonger needed, or the CMTS may have deleted them though they are still recognizedby the SDE.
Use the Gates status list to view or delete suspect garbage gates.
Chapter 4: Global SDE parameters
80 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Log parameters
Log parameters define the behavior of the SDE system logs. The SDE contains twocentral logs: the activity log, which displays all activity on the SDE, and the errorlog, which records system errors, warnings, debug and other information. Inaddition, the SDE generates an activity log for each CMTS (and—when the SDE policyserver is used—for each RKS and AM) defined in the system.
The log parameters also allow operators to configure the SDE so that each nodesends messages to an external Syslog server. Use the log parameters to definewhether the Syslog is enabled or disabled and, when it is enabled, the IP of theSyslog server and its threshold.
Configure the log parameters according to the values in the following table. Defaultvalues may be used, with the exception of the IP address for the Syslog server.
Table 9: Log parameters
Parameters Description Default Value
Activity Log Level No Activity: No log activity on any systeminterfaceMain Activity Log disabled: Log activatedonly for the SDE node. Network elementactivity (CMTS, etc.) appears in the SDEnode log, but not in the log specific to thenetwork element.Main Activity Log enabled: All activity logsactivated
Main Activity LogDisabled
Debug Level Defines the debug level of the differentprocesses:None, Error, Warning, Info, Debug
Info
Max Error Log Size (Bytes) The maximum size, in bytes, that a log canreach before the SDE renames it and startsa new one. Maximum size = 10MB
512000
Max COPS Log Size (Bytes)(Internal PS only)
The maximum size, in bytes, of the COPSlibrary log before the SDE stores it andstarts a new one. Maximum size = 10MB
0
COPS Debug Level (InternalPS only)
Defines the debug level:None, Alert, Critical, Error, Warning,Notice, Info, Debug
Info
Debug Mutex (Internal PSonly)
Internal debug flag. N/A No
Log parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 8105-00095-C04 July 8, 2010
Parameters Description Default Value
Debug Thread (For usewith SDE PS)
Internal debug flag. N/A No
Debug Socket (For use withSDE PS)
Internal debug flag. N/A No
Debug COPS (For use withSDE PS)
Internal debug flag. N/A No
Debug FSM (For use withSDE PS)
Internal debug flag. N/A No
Debug Gate (For use withSDE PS)
Internal debug flag. N/A No
Debug PS (For use with SDEPS)
Internal debug flag. N/A No
Debug Sharing (For usewith SDE PS)
Internal debug flag. N/A No
Debug Dump (For use withSDE PS)
Internal debug flag. N/A No
Management Log Threshold Defines the debug level of the log for theSDE agent:Error, Warning, Info, Debug
Info
Enable Syslog Enables SDE to write to the Syslog No
Syslog Server IP address of the Syslog Server --
Syslog Threshold Defines the Syslog level: Error, Warning,Info, Debug
Info
Chapter 4: Global SDE parameters
82 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
COPS parameters
COPS parameters define the protocol parameters for the COPS connections betweenthe WSAM and the policy server when the SDE’s policy server is used. All defaultparameters may be used.
Table 10: COPS parameters
Parameter Description Default Value
PCMM Client Type Defines the COPS client type according to thePCMM protocol
32778
Listening Port Port on which the AM connects to the SDE 3918
PEP ID String that identifies the SDE SV-SDE_tm
COPS OPN Timeout (ms) The amount of time in milliseconds that theSDE waits between opening a COPSconnection and waiting for the CAT message
60000
KA Timeout (sec) Keep Alive Timeout in seconds for the CMTS.This value can be changed for each CMTSthrough the CMTS attributes.
30
COPS OPN ResendTimeout (ms)
Timeout in ms when resending OPN 2000
Reconnect Timeout (ms) Time in ms before reconnecting to the CMTS 10000
Compatible PCMMVersion
The most recent PCMM version with whichthe SDE is compatible. The SDE will also becompatible with all previous versions.
PKT-SP-MM-I03
Interface name Ethernet card on which the SDE runs eth0
COPS parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 8305-00095-C04 July 8, 2010
WSAM parameters
WSAM parameters define the configuration of the WSAM in the SDE. Theseparameters are used when the SDE applies Fairshare actions using PCMM. Use alldefault parameters.
Table 11: WSAM parameters
Parameter Description Default Value
Use HTTPS Determines whether HTTPS is used tosecure the connection between the AS andWSAM or Fairshare Engine and WSAM,rather than HTTP (the default). If HTTP isused, it also must be activated in the AS.Note: If you change this value to ‘Yes’ youMUST restart the SDE.
No
Time between retries (sec) Retry interval for the persistency function 60
Retries number The number of times the persistencyfunction tries to recreate a WSAM session
30
Ignore AS Username Yes: WSAM only authorizes service requestsfrom application servers with known usernames (configured in SDE). The attributemust be set to this mode for Fairshare towork.No: Accepts service requests that arrivewithout a user name in the header or froman unknown application server. The SDEassigns a default user name in this case.
Yes
Session Store Capacity The maximum number of sessions that theWSAM can hold in its session store
100000
Enable WSAM SessionSharing
Determines whether the WSAM nodes willshare service requests among themselves.Use the default value, ‘Yes’ for thisconfiguration. Note: If you change thisvalue to ‘No’ you must restart the SDE.
Yes
Caution: The Ignore AS Username attribute must be set to ‘yes’ for Fairshare towork.
Chapter 4: Global SDE parameters
84 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Fairshare parameters
Fairshare parameters define the parameters for the different Fairshare elements.Use all default parameters.
Note: To enable IPDR logging to sFlow files, the Enable File Logging parameterMUST be set to ‘yes’.
Table 12: Fairshare parameters
Parameter Description Default Value
Realm Name Realm name of the service provider,EXACTLY as defined in the SPB. Thisparameter is required only when Fairshareuses data from the SPB.
DEFAULT
Default Duration Default number of periods for which theFairshare policy is applied (1 period = 15minutes).
1
Connections per Node The number of connections the SDEsupports between the Fairshare Engine oneach node and the WSAM. This parameteris used only for applying Fairshare actionsusing PCMM.The total number of connections in aregional data center cannot exceed 40, andthe parameter should be definedaccordingly. (For example, in a 6-node, or3 cluster, data center, the parametersshould be set to ‘6’.)
20
Fairshare parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 8505-00095-C04 July 8, 2010
Data collection parameters
Data collection parameters define the method the SDE uses to collect subscriber andnetwork topology data. Subscriber usage data can be collected using IPDR or fromthe SPB. The SDE can use SNMP to discover CMTS interfaces and retrieve bandwidthusage information, or interfaces can be configured manually and bandwidth can becalculated using IPDR data.
The data collection node contains four sets of parameters:
• General parameters: define the source of subscriber usage data and the methodof configuring interfaces and calculating bandwidth. They also containparameters that enable the NetPortal to access the subscriber usage andtopology information from a central location.
• SNMP collection: enable the operator to define the interval for polling CMTSsusing SNMP
• IPDR collection: enable the SDE to collect subscriber data using IPDR
• SPB collection: enable the SDE to collect subscriber statistics from the SPB
General data collection parametersGeneral data collection parameters define the source of subscriber usage data andthe method of configuring interfaces and calculating bandwidth. They also containparameters that enable the NetPortal to access the subscriber usage and topologyinformation from a central location.
Table 13: General data collection parameters
Parameter Description Default Value
Data Collection Defines the source of subscriber usagedata:IPDR: receives IPDR data from CMTSs or anexternal data collectorSPB: collects subscriber statistics from theSPBNone: The SDE doesn’t collect subscriberdata.
IPDR
Interface DefinitionsSource
The source of the information for CMTSinterface properties:
SNMP: SDE receives interface propertiesthrough SNMP.
SNMP
Chapter 4: Global SDE parameters
86 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Parameter Description Default Value
By Configuration: SNMP is disabled inthe SDE. Interface properties areconfigured manually through the EMS
Interface BandwidthSource
The source of interface congestioninformation:
SNMP: SDE receives the congestioninformation through SNMP
IPDR: Interface congestion information isobtained from the IPDR record
SNMP
Subscriber Tier Source The source of the SCN for determining thesubscriber’s tier.Use SCN: Retrieves the tier informationfrom the CMTS. Use this setting in a realnetwork environment.Use XML: Retrieves the SDE subscriber list(cmxSubscribers.xml). Use this setting in atest environment.Use External Source: Retrieves the tierinformation from an external source via aCSV file. (See “Data tier injection” on page88 for an explanation of this feature.)
Use SCN
Enable Central DatabaseLogging
Determines whether the contents of eachcluster’s database is copied to the centraldatabase for use by the NetPortal:Yes: Each cluster’s database is logged tothe central database.No: The SDE cluster doesn’t log to thecentral database.When the NetPortal is used, all SDEclusters except the NetPortal are set to‘Yes’. On the NetPortal cluster, thisparameter is set to ‘No’ .
Yes
Primary Central Database IP address of the primary NetPortal node.When the NetPortal is used, the PrimaryCentral Database parameter for all SDEclusters except the NetPortal should be setto the edge VIP of the NetPortal cluster.On the NetPortal cluster, this parametershould be left empty.
--
Secondary CentralDatabase
IP address of the secondary NetPortalnode. When the NetPortal is used, this
--
Data collection parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 8705-00095-C04 July 8, 2010
Parameter Description Default Value
parameter should be left empty on theNetPortal cluster.
Collecting CMTS interface informationThe SDE provides different options for collecting CMTS interface information andcalculating bandwidth usage:
• SNMP is used to discover CMTS interfaces. It may retrieve bandwidth using SNMPor IPDR (for deployments collecting data using IPDR). For this option, theInterface Definitions Source parameter is set to ‘SNMP’. The InterfaceBandwidth Source parameter can be set to ‘SNMP’ or ‘IPDR’ depending on thetype of deployment and the service provider’s needs.
• SNMP is not used. Instead, interfaces are configured manually for the CMTSthrough the EMS and bandwidth is calculated using data received from the IPDRrecords. This option can be used only if the system is configured for IPDR datacollection. The Interface Definitions Source is set to ‘By Configuration’ and theInterface Bandwidth Source is set to ‘IPDR’. If the interfaces are not configuredin the EMS , the SDE uses the interface properties acquired from the IPDR dataand the Upstream/ Downstream ifSpeed default parameters defined for theCMTS in the SDE.
To configure CMTS interfaces manually when the ‘By Configuration’ value is used forthe parameter, see Configuring CMTS interfaces. If the deployment uses IPDR datacollection, you may want to specify a different Upstream ifSpeed default andDownstream ifSpeed default for each CMTS. For information, see “CMTS and IPDRsession attributes” on page 101.
Data tier injectionIn order to apply Fairshare policies by tier, it is possible to import subscriber tierattributes directly into the SDE from a third-party source. If this option is enabled,the IPDR collector does not overwrite the field in the Fairshare database.
To import subscriber tier attributes from a third party:
1. In order to enable importing of tier attributes, in the EMS, select SDEParameters > Data Collection > General.
2. In the SCN Source field, select Use External Source.
Chapter 4: Global SDE parameters
88 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
EMS showing Subscriber Tier Source drop-down menu
3. Create a CSV file, named <csv_file_name>, that contains the data to beimported. The file should include three columns in the following exact order:<Subscriber CM MAC address >,<CMTS IP>,<Tier>.
The CSV file entries should appear in the same format as the following example:
020300083100,172.16.3.152,gold4. Place the file in the /opt/SDE/data_injection directory. The SDE imports the
subscriber tiers from the third-party source.
SNMP collection parametersSNMP collection parameters define the interval for polling CMTSs using SNMP.
Table 14: SNMP collection parameters
Parameter Description Default Value
SNMP Polling Time (ms) Polling interval when SNMP is used to fetchCMTS interface information
900000
IPDR collection parametersIPDR collection parameters define how the SDE collects subscriber data using IPDR.
Data collection parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 8905-00095-C04 July 8, 2010
Table 15: IPDR collection parameters
Parameter Description Default Value
TFTP Directory Home directory of the TFTP server. Thisvalue is used for IPDR data collection.
/opt/tftpboot/
Enable File Logging Enables the IPDR collector to write all IPDRrecords to file. When this parameter is setto ‘Yes’, Enable File Logging also has tobe enabled for each CMTS.Yes: writes to fileNo: doesn’t write to file
No
Relay Collector IP The IP to which the IPDR data will be sentwhen the SDE relays data to an theexternal IPDR collector. Used only whenthe SDE relays data to a third-partycollector
--
Relay Collector Port The port that must be opened on theexternal IPDR collector when it receivesdata from the SDE. Used only when the SDErelays data to a third-party collector
--
IPDR File Listening Port When IPDR Stream is used, the port onwhich the IPDR collector listens forincoming connections (NA for the inboundIPDR relay).
6210
IPDR SP Listening Port The SDE port used when the CMTS sendsdata over SP.
4737
Logging inbound IPDR files to the SDEYou can optionally configure the SDE so that inbound IPDR files are written both tothe Fairshare database and directly to the SDE machine.
To configure the SDE to log the inbound IPDR files to the SDE:
• In the Data Collection > IPDR Collection parameters, set Enable File Logging to‘Yes’.
Note: Make sure that Enable File Logging is also set to ‘Yes’ for each CMTS.
SPB collection parametersSPB collection parameters define how the SDE collects subscriber data from the SPB.
Chapter 4: Global SDE parameters
90 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Table 16: SPB collection parameters
Parameter Description Default Value
Check for new data every(min)
How often the SDE requests informationfrom the SPB. The value should be equal toor lower than that configured for the PTSto report to the SPB. However, theminimum value is 15 minutes.
3
PTS Reporting Period (min) How often the PTS reports to the SPB. Thisvalue must match the interval configuredon the PTS and SPB for PTS reporting.
15
SPB Request Timeout (sec) The amount of time the SDE waits after arequest to the SPB before timing out andstarting a new polling request
60
Number of SPBConnections
The maximum number of SPB collectionsessions that are allowed to runsimultaneously
1
Data collection parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 9105-00095-C04 July 8, 2010
Subscriber mapping parameters
The subscriber mapping parameters enable operators to provide full subscribermapping for the different types of data collection.
Subscriber to QAM mapping dynamically discovers subscriber IP addresses and QAMmapping based on DHCP packets teed by the PTS. It detects changes in subscribermapping and associates the subscriber’s cable modem with its upstream/downstream channels. It writes the subscriber topology information to the Fairsharedatabase to provide full subscriber mapping.
Subscriber to QAM mapping is required when SPB data collection is used. When IPDRdata collection is used and the PTS is deployed in the system, this feature can beused optionally to enable the SDE to detect changes to a subscriber’s CMTS, bondedgroup, interface or tier between IPDR reporting periods.
The P2SPB (Push to SPB) feature enables operators to map subscriber topologyinformation from the Fairshare database to the SPB. This feature can be used witheither SPB or IPDR data collection, as it enables the SPB to provide reportscontaining subscriber QAM, CMTS, SCN and tier information in a non-SDE reportingenvironment (e.g., the NDS).
When P2SPB is enabled, all P2SPB parameters must be configured.
Table 17: Subscriber mapping and P2SPB parameters
Parameter Description Default Value
Enable Subscriber To QAMMapping
Enables the SDE to dynamically discoversubscriber IPs and topology information.Required when SPB data collection is used
Yes
Enable Push to SPB Enables operators to map subscribertopology information from the Fairsharedatabase to the SPB
No
Push all subscribers to SPBon start-up
Pushes all subscriber topology data to theSPB. This operation is required when thereare long intervals between Push to SPBactivity or if the SPB was disconnected.Yes: Performs a ‘push all’ whenever theSDE detects that an SPB was reactivated.No: The SDE doesn’t perform any push all.Changing this parameter from to ‘No’ to‘Yes’ activates an immediate push all. Theresults of the push all action, including thenumber of subscribers whose topology
No
Chapter 4: Global SDE parameters
92 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Parameter Description Default Value
information was pushed to the SPB, aredisplayed in the SDE node’s Push To SPBactivity log.
Tier attribute name The attribute name of the tier as itappears on the SPB. It enables the SDE topush tier information to the correctattribute.
tier
SCN attribute name The attribute name of the SCN as itappears on the SPB. It enables the SDE topush SCN information to the correctattribute.
scn_attr
Next step: After configuring the global SDE parameters, continue on to the nextstep, configuring CMTSs to the system. See Chapter 5: “Import CMTSs” on page 95.
Subscriber mapping parameters
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 9305-00095-C04 July 8, 2010
Chapter 4: Global SDE parameters
94 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
5Import CMTSs
This chapter provides instructions for configuringlarge numbers of CMTSs and their related maps tothe system in a single action using the Import/ExportCMTSs and CMTS Maps feature.
The following topics are included in this chapter:
• “Import CMTSs/CMTS maps overview” onpage 96 — explains the Import CMTS optionand outlines the different steps in the procedure
• “Import CMTSs” on page 97 — explains how toset up a CSV data file and CMTS XML descriptionfile and import CMTS lists
• “Importing CMTS lists” on page 107
• “Import CMTS maps” on page 109 — explainshow to import CMTS map lists from a CSV file,including how to set a CMTS XML description fileto accompany the CSV file. This step is requiredonly if the SDE policy server will be used to applyFairshare actions
Import CMTSs/CMTS maps overview
The Import CMTS and Import CMTS Maps options allow operators to configure largenumbers of CMTSs and their related maps to the system in a single action byimporting them from CSV files containing the attributes for each CMTS beingimported. This feature facilitates the configuration process by eliminating the needto manually configure every CMTS using the EMS or the EMS command line interface.
The files necessary for the import can be prepared in advance. However, the actualimport should be performed after configuring the SDE clusters for services.
For instructions regarding how to manually configure individual CMTSs to the system,see Appendix C: “Manually configuring CMTSs” on page 155.
Note: The Import CMTS Maps option is required only when the SDE policy server willbe used to apply Fairshare actions.
Chapter 5: Import CMTSs
96 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Import CMTSs
In order to import a list of CMTSs or CMTS maps from a CSV data file, you need tocreate an XML file that provides metadata about each column in the CSV files thatyou also will create. Create one or more CSV files containing the attributes for eachCMTS being imported, including the metadata and parameters for the CMTSs’ IPDRsessions.
Make sure that each column matches the appropriate Index ID in the XML file.
Save both files in the directory of your choice on the machine from which you arerunning or connecting to the Web EMS.
The steps for performing the Import CMTS or Import CMTS Maps process are asfollows:
1. Create an XML description file that explains each of the attributes in each CMTSthat will be imported. For instructions, see “CMTS XML description file” on page97.
2. Create one or more CSV data files for the CMTSs provisioned to the site. You cancreate a single CSV data file for the site, or one for each edge service or CMTS.They all MUST follow the same template, as defined in the XML description fileyou create for the process. For instructions, see “CSV data file” on page 100.
3. Create a dedicated folder on the SDE machine from which you are running theEMS (the machine on which you are using the Web browser).
4. Save the CSV and XML files to the folder.
5. Import the CSV and XML files using the Import CMTS List feature. Forinformation, see “Importing CMTS lists” on page 107.
CMTS XML description fileThe CSV files contain a list of all the CMTSs you are importing, along with theattributes you want to configure for these CMTSs. They also contain the requiredvalues for each CMTS’s IPDR sessions. The corresponding XML file provides metadataabout each column in the CSV files.
It is recommended that you create the XML file first to define the specific attributes(and their corresponding column), and then build the CSV files according to the XMLfile.
• At a minimum, only the IP (Ip attribute) and vendor ( attribute) of each CMTS isrequired in the XML and CSV files. The DOCSIS type also is required for non-
Import CMTSs
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 9705-00095-C04 July 8, 2010
DOCSIS 3.0 CMTSs. All other values will fall back to the defaults defined in thesystem.
• If you also will be importing CMTS maps, it is recommended that you assign eachCMTS a unique ID (Id attribute). This unique ID is used to identify the CMTS whenimporting ranges or subnets.
• If the system contains more than 1 edge service or more than 1 VIP for the edgeservice, you also must define the edge service and VIP for each CMTS.Otherwise, each CMTS will default to the first edge service and edge VIP definedin the system. When these attributes are defined, the Service attribute mustappear before the VipId attribute.
• Depending on the specific Fairshare configuration, the XML and CSV files alsomust define the value for the CollectOnly, SnmpCollection and IpdrCollectionattributes.
• If DOCSIS 2.0 CMTSs are used, or the DOCSIS 3.0 CMTSs will send SAMIS IPDR datato the SDE (as opposed to SAMIS-TYPE-1), the DocsisVersion parameter must bedefined for DOCSIS 2.0 (‘20’).
• For deployments using IPDR collection, the IPDR session parameters are definedafter all CMTS parameters, separated by the IPDRSessions tag.
The only other requirement is that the index IDs must match the columns in the CSVfile.
Available CMTS attributesThe XML file below displays all available CMTS attribute fields that can be includedin the XML file and corresponding CSV file, depending on your system’sconfiguration. For an explanation of each of the attributes and possible values, see “CMTS and IPDR session attributes” on page 101.
Note: To see sample XML description files for different Fairshare deployment types,see Appendix D: “Example XML description files for CMTS import” on page 171.
<?xml version="1.0" encoding="UTF-8"?> <CmtsView> <Index id="0">IsEnabled</Index> <Index id="1">CmtsLabel</Index> <Index id="2">Id</Index> <Index id="3">Ip</Index> <Index id="4">IpdrIP</Index> <Index id="5">SnmpIP</Index> <Index id="6">IpdrRecordIP</Index> <Index id="7">Port</Index> <Index id="8">CmtsVendor</Index> <Index id="9">CmtsKATimeout</Index> <Index id="10">RksId</Index> <Index id="11">Service</Index> <Index id="12">VipId</Index> <Index id="13">CmtsJitter</Index>
Chapter 5: Import CMTSs
98 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
<Index id="14">CmtsUPDelay</Index> <Index id="15">CmtsDownDelay</Index> <Index id="16">RCGap</Index> <Index id="17">CollectOnly</Index> <Index id="18">community</Index> <Index id="19">AllSubnets</Index> <Index id="20">SnmpCollection</Index> <Index id="21">IpdrCollection</Index> <Index id="22">CmtsUpstreamCongestion</Index> <Index id="23">CmtsdDownstreamCongestion</Index><Index id="26">DocsisVersion</Index><Index id="27">EnableFile</Index></CmtsView>
Caution: If the Service attribute is not listed before the VipID, the import won’twork.
IPDR session definitionsIPDR sessions are configured in the CMTS XML and CSV files and are imported withthe CMTSs in a single action.
Define the IPDR attribute fields at the end of the XML file, using the IPDRSessionstag to separate them from the CMTS fields. This tag also indicates the number ofIPDR sessions added to the current CMTS.
The following XML file displays a sample XML file with the minimum CMTSparameters and one IPDR session.
<?xml version="1.0" encoding="UTF-8"?><CmtsView> <Index id="0"> CmtsLabel </Index> <Index id="1"> Ip </Index> <Index id="2"> IPDRSessions </Index> <IPDRSessionParams> <Index id=“3">SessionName</Index> <Index id=“4">DocsisType</Index> <Index id=“5">SessionId</Index> <Index id=“6">ConnectionMode</Index> <Index id=“7">SessionType</Index> <Index id=“8">Port</Index> </IPDRSessionParams></CmtsView>
In the CSV file, the IPDRSessions attribute might be assigned a value of 2, indicatingthat 2 IPDR sessions are defined for the CMTS. The values for each session are listedone after another, separated by a comma.
Import CMTSs
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 9905-00095-C04 July 8, 2010
For example, for two IPDR sessions, the values might be defined in the CSV file as:session_1,CPE-TYPE,24,CMTS,Event,1432,session_2,SAMIS-TYPE-1,22,CMTS,Event,1432
For an explanation of each of the IPDR session attributes and their possible values,see “CMTS and IPDR session attributes” on page 101.
CSV data fileEach row in the CSV file defines the attributes for a specific CMTS. Each column inthe CSV file corresponds to a specific index ID (CMTS attribute) defined in the XMLdescription file. The CSV file columns are listed in the same order as the XMLdescription file index IDs so that each consecutive CSV column maps to the nextindex ID in the XML description file. For example:
• CSV column A = <Index id="0">
• CSV column B = <Index id="1">
• CSV column C = <Index id="2">
The following figure displays the attributes contained in a sample CSV file for fiveCMTSs, while the accompanying sample XML file illustrates how these columnscorrespond to CMTS attributes.
<?xml version="1.0" encoding="UTF-8" ?> <CmtsView> <Index id ="0">IsEnabled</Index> <Index id ="1">CmtsLabel</Index> <Index id ="2">Id</Index> <Index id ="3">Ip</Index> </CmtsView>
In the above example, the Index ID explains which column of the CSV file is mappedto each CMTS attribute:
• Index id = 0, IsEnabled is mapped to column A.
• Index id = 1, CmtsLabel is mapped to column B (and used to identify the CMTSwhen importing CMTS map ranges or subnets).
• Index id = 2, Id is mapped to column C.
• Index id = 3, Ip is mapped to column D.
Chapter 5: Import CMTSs
100 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
CMTS and IPDR session attributesThe following table describes the CMTS and IPDR session attributes that may beincluded in the CSV file.
Table 18: Attributes for CMTS import
Attribute Description Value to Define DefaultValue
IsEnabled /IsDisabled
Determines whether the CMTS isenabled.
Disabled/ Enabled Enabled
CmtsLabel CMTS name, as it appears in theEMS
<alphanumeric> CMTS_<X>
Id Unique ID of the CMTS numeric --
Ip Physical IP address or FQDN ofthe CMTS. If the SDE connects tothe SPB for data collections and/or Fairshare enforcement, theformat must match the format (IPor FQDN) used to define CMTSs inthe SPB.
<000.000.000.000> or alphanumeric
--
IpdrIP When the SDE initiates the IPDR/SP connection, the IP address theSDE uses to connect to the CMTSto receive IPDR data, if differentthan the CMTS IP. If the CMTS orexternal relay initiates theconnection, this is the IP valuecontained in initiatorId field ofthe CONNECT message. If theIPDR IP is empty, the value of theCMTS IP is used.
<000.000.000.000>
--
SnmpIP The IP address the SDE uses toconnect to the CMTS to receiveSNMP data, if different from theIP address defined above for theCMTS. Used for all deploymenttypes
<000.000.000.000>
--
IpdrRecordIP The IP address sent by the CMTSin the IPDR record’sCMTSipAddress field, if differentfrom the IP address definedabove for the CMTS. Use this IPwhen the CMTS or external relay
<000.000.000.000>
--
Import CMTSs
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 10105-00095-C04 July 8, 2010
Attribute Description Value to Define DefaultValue
sends IPDR data to the SDE usingfile mode.If the IPDR Record IP is notconfigured, the SDE by defaultuses the IPDR IP. If no IPDR IP isconfigured, either, the SDE usesthe CMTS IP for the IPDR data.
Port CMTS COPS port number . Usedonly with the SDE policy server
usually ‘3918’ (thestandard)
3918
CmtsVendor CMTS vendor: Cisco, BigBand,Motorola, Arris, Relay (used forthird-party IPDR collectors)
<Vendor name> --
CmtsKATimeout Keep Alive Timeout in sec.between the CMTS and PS.Optimize the value (30s)according to the CMTS’s status.Used only with the SDE policyserver
0 = no time1 - 4294967295
--
RksId The RKS linked to this CMTS.Optional parameter used onlywith the SDE policy server
-- None
Service Name of the edge serviceconnected to the CMTS, asdefined in the cmxServices.xmlfile
<alphanumeric> Edge Service
VipId Edge VIP that the selectedservice uses to connect to theCMTS
<000.000.000.000>
--
CmtsJitter Minimum jitter guaranteecapacity. Used only with the SDEpolicy server
0 - 4294967296 200
CmtsUPDelay Minimum delay on the cablemodem. Used only with the SDEpolicy server
0 - 4294967296 30
CmtsDownDelay Minimum delay on the CMTS.Used only with the SDE policyserver
0 - 4294967296 200
RCGap Time interval in ms that the SDEwaits before forwarding the next
0 = disables therate limit feature,
0
Chapter 5: Import CMTSs
102 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Attribute Description Value to Define DefaultValue
gate command. Used only withthe SDE policy server
no delay; Mindelay range = 20ms to 2^31-1.Accuracy is ± 5ms.
CollectOnly Determines whether the SDEconnects to the CMTS as a policyserver.
No: The SDEcollects both IPDRand/or SNMP datafrom and sendspolicies to theCMTS using theSDE policy serverYes: The SDE onlycollects IPDR and/or SNMP data fromthe CMTS. Use thissetting fordeployments usingan external policyserver or only thePTS to applyFairshare actions.
No
community The SNMP community used forCMTS Discovery on this CMTS
‘Default’ or<alphanumeric>
Default
AllSubnets Determines whether thediscovery process discovers allCMTSs subnets. Optionalparameter used only with the SDEpolicy server
Yes: Discovers allsubnetsNo: Discovers onlythose subnetsbelonging to aDOCSIS MAC layer
No
SnmpCollection Determines whether the SDEcollects SNMP data from theCMTS. This parameter is usedonly when the SDE is set to SNMPcollection (the default) in the L2Topology parameters.
Yes: SDE collectsSNMP data fromthe CMTS.No: SDE doesn'tcollect SNMP data.(Use this settingwhen setting upthe relay fromthird-party IPDRcollectors.)
Yes
IpdrCollection Determines whether the SDEcollects IPDR or SPB data.
Yes: SDE collectsIPDR data fromthe CMTS or SPBstatistics.
Yes
Import CMTSs
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 10305-00095-C04 July 8, 2010
Attribute Description Value to Define DefaultValue
No: The CMTS onlysends COPSmessages andSNMP data
CmtsUpstreamCongestion
Percentage of the upstreambandwidth above which aninterface on a CMTS is consideredcongested
1 - 100 80
CmtsDownstream-Congestion
Percentage of the downstreambandwidth above which aninterface on a CMTS is consideredcongested
1 - 100 80
IfSpeedUpstreamDefault
Default ifSpeed assigned to anyunrecognized CMTS upstreaminterface in an IPDR record.
All positive valuesare accepted.
10240000
IfSpeedDownstreamDefault
Default ifSpeed assigned to anyunrecognized CMTS downstreaminterface an the IPDR record.
All positive valuesare accepted.
42884296
DocsisVersion DOCSIS version supported by theCMTS: DOCSIS 3, DOCSIS 2, orDOCSIS 1. If the CMTS will sendSAMIS data to the SDE, select‘DOCSIS 2’, even if the CMTS isDOCSIS 3.0.
11 = 1.120 = 2.030 = 3.0
30
EnableFile Enables the IPDR collector towrite the CMTS’s IPDR records tofile. This parameter is used forIPDR data collection.When using the outbound IPDRrelay function, this parametermust be set to ‘Yes’.
Yes = writes tofileNo = doesn’t writeto file
No
IPDRSessions Indicates the number of IPDRsessions added to the CMTS
<numeric> 1
SessionName Optional name assigned to theIPDR session type foridentification purposes
<alphanumeric>(maximum lengthof 50)
IPDRSession_1
DocsisType Defines the type of data sent tothe SDE: SAMIS-TYPE-1, SAMIS, orCPE-TYPE
SAMIS-TYPE-1CPE-TYPESAMIS
--
Chapter 5: Import CMTSs
104 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Attribute Description Value to Define DefaultValue
SessionId Unique ID that must match theIPDR Session ID configured on theCMTS
0 - 255 1
ConnectionMode Defines whether the SDE or CMTSinitiates the IPDR sessions,according to the CMTS’sconfiguration:
CMTS: the IPDRwaits for the CMTSto initiatesessions.SDE: the SDEinitiates theconnection.
SDE
SessionType Determines the type of IPDR flow,according to the CMTS’sconfiguration:
Time Interval: TheCMTS sends IPDRdata at intervals.Event: An eventserves as thetrigger for theCMTS to send thedata.Ad Hoc: The IPDRcloses the sessionbetween theintervals at whichthe CMTS sendsthe data (Serverconnection modeonly).
TimeInterval
Port The SDE port used when the CMTSsends data over SP (Clientconnection mode only)
1025 - 65535 4737
Importing CMTSs when using inbound IPDRrelayWhen the SDE receives IPDR data from an external IPDR collector rather thandirectly from the CMTSs, the collector initiates an IPDR connection to the SDE, andthe SDE treats the IPDR data in the same manner as if it were received directly fromthe CMTS.
The XML and CSV files for the CMTS import must contain the following attributesspecific to this deployment type:
Note: No other configurations are required on the SDE for the inbound IPDR relay.
Import CMTSs
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 10505-00095-C04 July 8, 2010
• If the relay will send the IPDR data using an IPDR/SP connection, include theIpdrIP field. The relay uses the IpdrIp value to fill the initiatorId field of theCONNECT message instead of the CMTS’s IP address.
• If the relay will send the IPDR data using file mode, include the IpdrRecordIPparameter. The parameter should match the CMTSipAddress field that the relayfills for the particular CMTS.
• Use the SnmpCollection attribute and set the value of the attribute to ‘Yes’.• Use the attribute and set its value to ’Yes’.• Include the IPDRSessions tag and define the IPDR sessions:
• The SessionName attribute is option.
• Include the DOCSISType attribute and define the type of data sent for eachCMTS (SAMIS-TYPE-1, SAMIS, or CPE-TYPE).
• Include the SessionId and SessionType attributes and define their valuesaccording to the configurations on the relay.
• Include the ConnectionMode tag and set the value to ‘CMTS’.
Chapter 5: Import CMTSs
106 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Importing CMTS lists
Note: Prior to importing a CMTS list, verify that a CMTS XML description file hasbeen created that provides metadata about the CSV data file.
To import a CMTS list:
1. In the Configurations tree of the SDE EMS, right-click CMTS List and selectImport CMTSs from CSV file. The Import CMTS List dialog box appears.
Import CMTS List dialog box
2. Set the path for the CSV and corresponding XML file to be imported.
3. Click Import. The CMTSs appear in the CMTS List > CMTS tree in theConfigurations tree.
4. Repeat the procedure for each CSV file you need to import.
Import errorsIf an error occurs during the CMTS import procedure, an error message appears onthe EMS. This message refers you to the EMS log for a list of CMTSs that were notimported successfully.
Errors are reported only for fields that are validated during the import process.Validated fields are:
• IsEnabled• ServiceID• VipId• CollectOnly• community• IpdrRecordIP
Importing CMTS lists
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 10705-00095-C04 July 8, 2010
• SnmpIp• SnmpCollection• IpdrCollectionThe EMS log is created on the machine from which you are running the EMS at thefollowing location:
• Mozilla Firefox: Firefox installation folder (e.g., C:\Program Files\MozillaFirefox)
• Windows EMS: Windows EMS installation folder (e.g.,C:\Program Files\EMS\SDE_EMS
• Linux EMS: /opt/SDE/SDE_EMS/
Viewing CMTSs in the EMS following importWhen 100 or more CMTSs are configured to the system in a single import, the EMSdisplays only the first 99 CMTSs in the CMTS list > CMTS Tree, even though thecorrect number of CMTSs is displayed in the status bar at the bottom of the screen.
Note: When viewing the SDE system through the EMS using Status > SDE System, thecorrect number of CMTSs is displayed.
To display all CMTSs in the CMTS tree, resize the EMS window using the mouse, andthen maximize it.
Chapter 5: Import CMTSs
108 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Import CMTS maps
The Import CMTS Maps feature enables you to import subscriber maps for the CMTSsyou import using the Import CMTS feature. When this feature is used, you do notneed to manually define the maps for a long list of imported CMTSs when the SDEenforces Fairshare using its internal policy server.
The Import CMTS Maps feature supports both subnets and ranges. It is enough todefine either the CMTS’s range or the subnet, but you can define multiple rangesand subnets for the same CMTS depending on your system’s requirements as long asthey don’t conflict with each other.
Prior to importing CMTS maps, you must create a CMTS map XML description file thatprovides metadata about the CSV data file. Separate XML and CSV files must becreated for importing ranges or subnets. Create one XML file for ranges and one XMLfile for subnets, but as many CSV files as required to import the different rangesand/or subnets for each CMTS.
Caution: You can import CMTS maps only after importing their related CMTSs. Whenthe SDE collects subscriber data from the SPB, you must configure the IP exclusionsfor MTA and CPE IP addresses prior to importing subnets or ranges for a CMTS. Forinformation regarding IP exclusions, see “IP exclusions” on page 117.
CMTS maps XML description fileThe EMS supports two CSV files for CMTS maps: a range file and a subnet file. Inorder to import the CMTS maps from either of these files, you first must create aCMTS map XML description file that provides metadata about the CSV data file. Thisfile resides on the EMS machine in the directory of your choice.
Sample subnet fileThe following is a sample XML file for map subnets. The MapID attribute in column 0is mapped to the MapID for the corresponding CMTS.
<?xml version="1.0" encoding="UTF-8" ?> <MapDescription> <General> <Type>Subnet</Type> <Index id="0">Id</Index> </General> <Subnet> <Index id="1">Net</Index> <Index id="2">Mask</Index> </Subnet> </MapDescription>
Where Id (Index ID 0) is the unique ID of the CMTS as specified in the CMTS CSV file.
Import CMTS maps
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 10905-00095-C04 July 8, 2010
The following sample CSV file contains a single subnet for the CMTS corresponding toMapID 1 and three subnets corresponding to MapID 2 (shown in column 0).
Sample CMTS map subnet CSV file
Sample range fileThe CSV file for map ranges closely resembles the file for map subnets. However,the XML file contains different fields, as shown in the sample map range XML file,below.
<?xml version="1.0" encoding="UTF-8" ?> <MapDescription> <General> <Type>Range</Type> <Index id="0">Id</Index> </General> <Range> <Index id="1">FirstIP</Index> <Index id="2">LastIP</Index> </Range> </MapDescription>
Where Id (Index ID 0) is the unique ID of the CMTS as specified in the CMTS CSV file.
Map import processTo import CMTS maps:
1. In the Configurations tree, select CMTS List, then click the arrow next toImport/Export on the toolbar and select Import CMTS Maps from CSV file.
Or, in the Configurations tree, right-click CMTS List and select Import CMTSMaps from CSV file. The Import CMTS Maps dialog box appears.
Chapter 5: Import CMTSs
110 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Import CMTS Maps dialog box
2. Set the path for the CSV and XML files.
3. Click Import. The CMTS maps appear under the corresponding CMTS in the CMTSlist.
Next step: If your Fairshare system includes SPB data collection or PTS enforcement,see Chapter 6: “Configuring SPB connections” on page 113 Otherwise see Chapter 7:“Configuring additional network elements to the system” on page 123 forinstructions on configuring third-party network elements to the system for use withnon-Fairshare PCMM or Chapter 8: “SNMP” on page 131 for instructions onconfiguring the connection to the SNMP trap receiver.
Import CMTS maps
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 11105-00095-C04 July 8, 2010
Chapter 5: Import CMTSs
112 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
6Configuring SPBconnections
This chapter provides detailed instructions forconfiguring SPBs to the system. Instructions areprovided for both configuring the SPB for subscriberdata collection and for applying Fairshare actions bysetting PTS attributes.
The following topics are included in this chapter:
• “SPB configuration overview” on page 114 — explains the SPB and how it is used in theFairshare system
• “IP exclusions” on page 117 — explains how toexclude MTA and CPE IPs relayed by SPBs duringdata collection from the Fairshare database
• “SPB configuration process” on page 119 — provides instructions for configuring the SandvineSPB to the SDE
SPB configuration overview
The SDE can connect to the Subscriber Policy Broker (SPB) both to collect subscribertraffic data in order to make Fairshare decisions and to apply Fairshare actions bysetting subscriber attributes in the PTS. After the SPBs are configured to the system,each SDE cluster’s edge service is mapped to an SPB for data collection and/orFairshare enforcement.
For subscriber data collection, each edge service is mapped to only one SPB.However, many edge services—and their clusters—can be mapped to the same SPB.Each cluster connects to the SPB using the VIP configured for the edge service.
The SDE also uses a cluster’s edge VIP to connect to the SPB for PTS Fairshareenforcement. The type of SDE deployment determines the manner in which edgeservices are mapped to the SPB to apply Fairshare actions using the PTS:
• When data collection is through the SPB and Fairshare actions are appliedthrough the PTS, each edge service is configured to the same SPB for bothcollection and enforcement, and only one SPB is configured to each service.Many edge services can be mapped to the same SPB.
• When data collection is through IPDR and Fairshare actions are applied throughthe PTS, each cluster’s edge service is configured to one SPB for collection, butcan be configured to many SPBs for Fairshare enforcement. The attribute usedto apply a Fairshare action is set only on the SPB containing the subscriber’sdata. Again, many edge services can be mapped to the same SPB for datacollection.
Two mappings are created, one for data collection (Collector Edge Services List) andone for Fairshare enforcement (Enforcement Edge Services List).
The following diagrams depict the different ways the SPB is connected for the twodifferent uses. In the first diagram, two SPBs are configured to the system, and eachcluster connects to only one SPB. Each SPB collects data for two SDE clusters, andeach cluster sets PTS attributes through the same SPB.
Chapter 6: Configuring SPB connections
114 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
1
2Cluster 1
1
2
Edge Service 1
Edge Service 2
Edge Service 3
Edge Service 4
3
4Cluster 2
5
6Cluster 3
7
8Cluster 4
SDE configured for SPB data collection with PTS enforcement
The second diagram is for deployments that collect data using IPDR and applyFairshare through the PTS. Two SPBs are configured to the system; both areconnected to all SDE clusters. Request to set an attribute are sent to both SPBs, butonly the SPB containing the subscriber’s data acts on it.
SPB configuration overview
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 11505-00095-C04 July 8, 2010
1
2Cluster 1
1
2
Edge Service 1
Edge Service 2
Edge Service 3
Edge Service 4
3
4Cluster 2
5
6Cluster 3
7
8Cluster 4
Edge Service 1
Edge Service 2
Edge Service 3
Edge S
ervice
4
SDE configured for SPBs used for PTS Fairshare enforcement only (IPDR collection)
Chapter 6: Configuring SPB connections
116 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
IP exclusions
Before configuring SPBs to the system, you must configure the IP exclusions in theSDE. This enables you to exclude MTA and CPE IP addresses—as well as any other IPaddresses that should be excluded (for example, transponder IPs)—from thesubscriber data collected from the SPB and entered in the Fairshare databaseActive_Users table.
The PTS collects subscriber data for each MAC address, which the SPB sends to theSDE when Fairshare is configured for SPB data collection. Each MAC address cancontain multiple IPs: MTA, CPE, and cable modem (CM) IP addresses. However, onlythe CM IP address is required because the Fairshare Engine applies Fairshare actionson this IP.
MTA and CPE IPs addresses must be excluded before the SDE begins to collect datafrom the SPB for any IP range or MAC address. This usually is when the SPB is firstconfigured to the system or new ranges of MTA or CPE IP addresses are added to thesubscriber network.
All non-MTA and non-CPE IPs that should be excluded from the Active_Users tablealso need to be excluded at this phase.
Exclude IPs ranges and IPs through the IP Settings > IP Exclusions node of the EMS.
Excluding individual IPsTo exclude individual IPs from the active users:
1. In the Configurations tree, open IP Settings > IP Exclusions.
2. Right-click IP List and select Add New IP. The New IP dialog box appears.
New IP dialog box
3. Type in the IP address of the IP address you want to exclude.
IP exclusions
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 11705-00095-C04 July 8, 2010
4. Click OK.
5. Repeat steps 2-4 for each IP address you want to add to the list.
Excluding subnetsTo exclude a subnet from the active users:
1. In the Configurations tree, open IP Settings > IP Exclusions.
2. Right-click Subnet List and select Add New Subnet. The New Subnet dialog boxappears.
New Subnet dialog box
3. Define the IP address and mask of the subnet you want to exclude.
4. Click OK.
5. Repeat steps 2-4 for each subnet you want to add to the list.
Chapter 6: Configuring SPB connections
118 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
SPB configuration process
For each SPB that will be used in the deployment, the configuration process is asfollows:
• Configure the SPB to the system. See “Configuring the SPB to the SDE” on page119.
• Map the edge service configured for each SDE cluster to SPBs to define the SPB’sFairshare roles. The mapping defines whether the SPBs will be used for datacollection, Fairshare actions, or both. See “Mapping edge services to SPBs” onpage 120.
• For each SPB that will collect subscriber data, create SPB policies in order todefine the active users in the Fairshare database. See SPB policies.
Configuring the SPB to the SDETo configure the SPB:
1. In the Configurations tree, right-click SPB List and select Add SPB.The New SPBdialog box appears.
New SPB dialog box
2. Type in the name of the SPB.
3. In the IP field, type the IP address of the SPB being configured to the SDE.
4. Define the database for storing the SBP data. This is the name of the database inthe SPB. The default database is ‘sv_stat’.
5. The defaults may be used for Database user name, SPB user name and SPBPort.
6. In the SPB Password field, type the password used to log into the SPB databaseand Web service.
7. Click OK. The SPB appears in the SPB list.
SPB configuration process
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 11905-00095-C04 July 8, 2010
SPB parametersTable 19: SPB parameters
Attribute Description Default Value
Name Name of the SPB configured to the system SPB_1
IP IP address of the SPB --
SPB user name User name for accessing the database throughthe Web service
spbadmin
SPB Password Password used to connect to the SPB databaseand Web service
sandvine
SPB Port Port the SDE uses to communicate with the SPB 8081
SPB Time Zone Time zone in which the SPB is located GMT
Mapping edge services to SPBsTo define how each SPB is used in the system, designate the purpose of each edgeservice that will be used to communicate with the SPB by mapping it to theCollector Edge Services List and/or Enforcement Edge Services List located undereach SPB node in the EMS.
SPB edge services lists
While each list can contain many edge services, you can map each edge service toonly one SPB’s Collector Edge Services List. This is the edge service that the SDEcluster uses to collect data from the SPB.
For enforcement purposes, you can map each edge service to as many SPBs as areconfigured in the system. This maps each SDE cluster to many SPBs for setting PTSattributes.
Chapter 6: Configuring SPB connections
120 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
To map edge services to SPBs:
1. In the EMS Configurations tree > SPB List, open the SPB to which you want tomap the edge service.
2. To map an edge service to the SPB for collection purposes right click CollectorEdge Services List. To map edge services to the SPB for enforcement purposes,right click Enforcement Edge Services List. Next, select Add Edge Service fromthe menu. The New Edge Service dialog box appears.
New Edge Service dialog box
3. From the drop-down list, select the edge service you want to map to the SPB.
4. To map more than one edge service to the SPB’s Enforcement Edge Services List,repeat steps 2-3.
Next step: Proceed to Chapter 7: “Configuring additional network elements to thesystem” on page 123 for instructions on configuring third-party network elementsfor use with non-Fairshare PCMM or Chapter 8: “SNMP” on page 131 for instructionson configuring the connection to the SNMP trap receiver.
SPB configuration process
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 12105-00095-C04 July 8, 2010
Chapter 6: Configuring SPB connections
122 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
7Configuringadditionalnetwork elementsto the system
This chapter provides detailed instructions forconfiguring the additional third-party networkelements that can optionally connect to the SDEsystem when the SDE policy server is used.
The following topics are included in this chapter:
• “Application managers” on page 124 — provides step-by-step instructions for configuringexternal application managers to the SDE
• “Application servers” on page 126 — providesstep-by-step instructions for configuringapplication servers to the SDE
• “Record Keeping Servers (RKSs)” on page 127 — provides step-by-step instructions foroptionally configuring RKSs to the SDE
Application managers
Note: For use when the SDE policy server is deployed for end-to-end QoS.
Application managers are devices that interface to PCMM policy servers using PCMMCOPS to request QoS-based service for applications on behalf of an end user ornetwork management system. These include PCMM-compliant session bordercontrollers and softswitches.
The SDE accepts gates only from third-party AMs configured to the system. Thisprovides an added level of security.
Each AM is linked to a border service and assigned a VIP during configuration. Theborder service supports the COPS connection from the AM, and the SDE listens to theAM using the specified VIP.
To configure an application manager:
1. In the Configurations tree, right-click AM List; then select Add ApplicationManager. The New AM dialog box appears.
New AM dialog box
2. Define the AM’s ID, as defined by PCMM.
3. Define the AM’s IP address or FQDN.
4. Define the service to which it is connected and the listening VIP.
All other attributes are optional.
The operator may optionally disable or re-enable the AM. When an AM isdisabled, it is as if it is not defined in the system. The SDE does not accept anygate commands from the AM; nor will it send any alarms on the component.
Chapter 7: Configuring additional network elements to the system
124 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
5. The Label value defines the name of the AM as it appears in the AM List.
6. Click OK. The AM appears in the AM List.
Application manager parametersTable 20: AM attributes
Attribute Description Default Value
Enabled/Disabled Determines whether the AM is enabled. Whenan AM is disabled, it is as if it is not defined inthe system. The SDE does not accept any gatecommands from the AM, nor will it send anyalarms on the component.
Enabled
AMID* Identity of the AM as defined by PCMM(included in all COPS messages)
--
Label AM label AM_1
IP or FQDN* IP address or FQDN of the AM localhost
Service* The specific service to which the AMs connects Border Service
Listening VIP* The VIP the selected service uses to listen tothe AM
--
Vendor AM Vendor none
Application managers
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 12505-00095-C04 July 8, 2010
Application servers
Note: For use when the SDE policy server is deployed for end-to-end QoS.
To configure an application server:
1. In the Configurations tree, right-click Application Servers; then select AddApplication Server. The New AS dialog box appears.
New AS dialog box
2. Define the application server’s user name.
3. Click OK. The AS appears in the Application Servers list.
Application server parametersTable 21: Application server attributes
Attributes Description Default Value
AS Username Application server’s user name, as definedin system
AS_1
Generate ContextId AS: AS generates its own ID (used forstateless application server)WSAM: WSAM generates the context IDBoth: WSAM searches for context ID. If ASsends context ID, but context ID not found,WSAM creates a new session with given ID.If AS doesn’t send contect ID, WSAMcreates new session with new ID
Both
Chapter 7: Configuring additional network elements to the system
126 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Record Keeping Servers (RKSs)
Note: For use when the SDE policy server is deployed for end-to-end QoS.
The Record Keeping Server (RKS) stores event messages generated by the CMTS andSDE regarding volume-based and time-based usage information. You can define up totwo RKSs (primary and secondary) for each CMTS, but the same RKS also may beused for many CMTSs. Use of the RKS is optional.
To configure an RKS:
1. In the Configurations tree, right-click RKS Servers and select Add RKS. The NewRKS dialog box appears.
New RKS dialog box
2. Optionally redefine the RKS’s attributes according to the RKS Values table.
3. Click OK. The RKS appears in the RKS Servers list.
4. Right-click the RKS, then select Add Primary/Secondary RKS. The New Primary/Secondary RKS dialog box appears.
Record Keeping Servers (RKSs)
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 12705-00095-C04 July 8, 2010
New Primary RKS dialog box
5. Define the RKS’s IP or FQDN. It is recommended that you also define the SharedSecret. The Port parameter is optional.
6. Click OK.
7. To create a secondary RKS, repeat steps 4-6 above.
Next step: After configuring the RKSs to the system, continue on to Chapter 8:“SNMP” on page 131 to optionally configure the SNMP trap.
RKS parametersTable 22: RKS values
Attributes Desciption Default
Label RKS label RKS_1
Vendor Vendor of the RKS none
Default RKS to which event messages are routed ifthe CMTS isn’t linked to an RKS.No: non-default CMTSYes: default CMTS.
No
Retry Number Number of times the PS retries to send anEvent Message to the RKS in case of anerror.
3
Retry Time Interval (ms) Waiting time in ms between retries whensending an Event Message.
500
Chapter 7: Configuring additional network elements to the system
128 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Table 23: RKS primary/secondary parameters
Attribute Description Default Value
IP or FQDN* IP address or FQDN of the RKS localhost
Port RADIUS accounting port 1813
Shared Secret RADIUS authentication secret(recommended)
0000000000000000(0 x 16)
Note: Parameters in the above table marked with with an ‘*’ require configuration.
Record Keeping Servers (RKSs)
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 12905-00095-C04 July 8, 2010
Chapter 7: Configuring additional network elements to the system
130 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
8SNMP
This chapter explains the SNMP agent and how tooptionally configure the trap receivers so thatexternal NOCs can receive SDE alarms.
The following topics are included in this chapter:
• “SNMP agent” on page 132 — explains the SDESNMP agent and how to change its community
• “Configuring trap receivers” on page 133 — explains how to configure the SDE to send alarmnotifications to an external trap receiver
SNMP agent
The SDE system provides SDE-specific fault notifications via SNMP, such asnotification that a network element is disconnected, using the SDE SNMP agent.
When trap receivers are configured to the system, the SDE SNMP agent forwardsalarm information to external NOCs using different interfaces. The structure andparameters in each message depend on the type of notification message sent.
The SDE supports SNMP v2c. The SNMP community for retrieving information is‘svPublic’. The read-write community is ‘svPrivate’. You can change the SDE’s ROand RW communities through the SDE general parameters in the EMS.s
Chapter 8: SNMP
132 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Configuring trap receivers
The SNMP alarm notification system can send alarms to external trap receivers. For atrap receiver to receive these alarm notifications, you must configure it in the SDE.
To configure the trap receiver:
1. In the Configurations tree, open SNMP.
2. Right-click Trap Receivers, then select Add Trap Receiver. The New TrapReceiver dialog box appears.
New Trap Receiver dialog box
3. Define the values for the trap receiver.
4. Click OK. The trap receiver appears in the Trap Receivers list.
SNMP parametersTable 24: SNMP parameters
Attribute Description Default Value
Label Identifying name of the trap receiver TrapReceiver1
IP IP of the machine receiving the trapsgenerated by the SDE
--
Community SNMP community public
SNMP Version Version of SNMP being used 2c
Configuring trap receivers
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 13305-00095-C04 July 8, 2010
Next step: After configuring trap receivers, continue on to Chapter 9: “Reports” onpage 135 to configure the system for stability monitoring reports.
Chapter 8: SNMP
134 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
9Reports
This chapter explains the SDE stability monitoringfunction, which enables operators to monitor theperformance of each SDE machine.
The following topics are included in this chapter:
• “Reports overview” on page 136 — describesthe types and frequency of reports the SDEgenerates
• “Configuring SDE nodes for reports” on page 137 — explains how to configure the nodes to createreports
Reports overview
The Reports option enables operators to view each SDE node's stability, reliability,and availability in real time through the EMS when Fairshare is applied using PCMM.The SDE stability monitoring function collects data on system memory, CPU and harddrive usage, as well as on gate and session traffic on the SDE node, and createsdaily, weekly, and monthly status reports in the form of logs and graphs.
The SDE creates two types of reports:
• Report log
• Graphs in JPEG format, broken out by data type, that enhance the operator'sunderstanding of the system's behavior:
• Gate and session traffic for each system node
• PS process CPU and memory activity (internal PS only)
• PS gate and memory consumption in KB (internal PS only)
• WSAM CPU and memory activity
• WSAM session and memory consumption in KB
System reports are generated each day at exactly 23:50. Weekly reports aregenerated each Saturday night at 23:50 and are a summary of system performancefor the week. The monthly reports are generated at 23:50 on the last day of eachmonth and are a summary of system performance for the month.
Chapter 9: Reports
136 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Configuring SDE nodes for reports
Prior to viewing reports in the EMS, you must configure each SDE node in the systemfor reports.
To configure a node for reports:
1. In the Configurations tree, right-click Reports and select Add SDE Report View.The Add SDE Report View dialog box appears.
Add SDE Report View dialog box
2. Select the node you want to monitor.
3. Click OK.
Mission accomplished: The SDE system is now fully installed and configured.However, you may need to perform additional configurations on the networkelements connected to the system.
For instructions regarding how to configure these external elements for the SDE, see Appendix B: “External configuration procedures” on page 153.
For information on configuring the Fairshare application within the SDE, see the SDEFairshare Solution Guide.
Configuring SDE nodes for reports
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 13705-00095-C04 July 8, 2010
Chapter 9: Reports
138 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
10NetPortal
This chapter provides detailed instructions forinstalling the NetPortal, which enables operators toview NetReports from all sites in a multi-sitedeployment from one central location.
The following topics are included in this chapter:
• “NetPortal overview” on page 140 — describesthe NetPortal
• “NetPortal installation” on page 141 — explains how to install and configure the SDEsoftware on the NetPortal machines
• “Configuring the NetPortal services” onpage 142 — gives instructions for configuringthe NetPortal’s management and edge services
NetPortal overview
The NetPortal provides a central location for accessing NetReports from all sites in adeployment. It consists of two SDE machines located in a national data center (NDC),configured in active-standby mode to allow for failover.
The NetPortal connects to the CMTSs or clusters within a site using the cluster’sedge VIP in order to access NetReports. You can view NetReports by cluster within aspecific site, for a specific CMTS or for a specific MAC address. The reports areexactly the same as those accessed using the NetReport application within the datacenter.
CMTS CMTSCMTS
CMTS
Site
SDE Fairshare Cluster#1
CMTS CMTSCMTS
CMTS
SDE Fairshare Cluster#2
CMTS CMTSCMTS
CMTS
SDE Fairshare Cluster#3
Site
National Data Center (NDC)
SDE NetPortal
Centralized package update server
Internet
Rsync/FTP
HTTP
Support Site
HTTP HTTP HTTPHTTP HTTP
NetPortal architecture
Chapter 10: NetPortal
140 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
NetPortal installation
The NetPortal installation process closely resembles the installation process forinstalling SDE clusters within a site. The SDE Fairshare software is installed on eachNetPortal machine, but the machine is set for NetPortal use.
Both a management and edge VIP are configured for the NetPortal cluster. The edgeVIP is used to communicate with the SDE sites and for replication within theNetPortal cluster to ensure high availability.
To install the SDE software on each NetPortal machine:
1. Follow the instructions for installing the SDE software on a machine, beginningwith Chapter 2: “Installing the management cluster” on page 29, including allinstallation verifications and concluding with the troubleshooting steps, “Installation troubleshooting” on page 44.
2. Configure both SDE machines in the NetPortal cluster to run as a NetPortal:
a. On the SDE machines, open the /opt/TOMCAT/webapps/NetReport/WEB-INF/classes/conf.properties file for editing:vi /opt/TOMCAT/webapps/NetReport/WEB-INF/classes/conf.properties
b. Set the portal property to ‘true’:
central.db=falselocal.db=falseportal=true
c. Save the file.
3. Stop and start the Tomcat server:/opt/TOMCAT/bin/shutdown.sh/opt/TOMCAT/bin/startup.sh
NetPortal installation
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 14105-00095-C04 July 8, 2010
Configuring the NetPortal services
To configure the NetPortal services, connect to the SDE EMS and configure themanagement and edge services.
Management serviceTo configure the management service:
1. Assign the management service a VIP. See “Assigning the management VIP” onpage 50.
2. Attach the management VIP to both nodes for high availability. See “Attachingservices to the new node” on page 61.
Edge serviceTo configure the edge service:
1. Assign the edge service a VIP. In addition to edge functionality, the NetPortalwill use this VIP to communicate with the SDE sites and to replicate the MySQLdatabase between the two nodes. See “Configuring the edge VIP” on page 51.
2. Attach the edge VIP to both nodes for high availability. See “Attaching servicesto the new node” on page 61.
Chapter 10: NetPortal
142 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
11SDE upgrade
This chapter provides instructions for upgrading theSDE to the current SDE release.
The following topics are included in this chapter:
• “Upgrade process” on page 144 — explains theSDE upgrade process
Upgrade process
SDE upgrade enables services providers to upgrade the SDE software from a centrallocation. The upgrade process also updates the database and system configurationsto the new version.
To upgrade the SDE:
1. On the SDE management machine, run the following command:yum -c <INSTALL_PATH>/sv.repo –y upgrade SDE_Upgrade.noarchwhere <INSTALL_PATH> is the path for the yum repository
2. Run the upgrade script by running the following command:sde_upgradeThe following result should appear:To update the components, if you want to use the default yum repository (/etc/yum.repos.d) enter [yes]else if you want to use a local directory enter [no]
3. If you are using the yum repository, enter ‘yes’.
If you are not using the yum repository, enter ‘no’. The following result shouldappear:Enter the path of the local repositoryEnter the path of the Yum local repository, then type Enter.
4. The following result should appear:Do you want to preserve your current iptables settings [yes/no]If you want to save the current iptables settings (firewall rules), enter ‘yes’. Thefollowing should appear:
iptables 0:off 1:off 2:on 3:on 4:on 5:on 6:offFlushing firewall rules: [ OK ]Setting chains to policy ACCEPT: nat mangle filter [ OK ]Unloading iptables modules: [ OK ]Applying iptables firewall rules: [ OK ]Loading additional iptables modules: ip_conntrack_netbios_n[ OK ]This system is not registered with RHN.RHN support will be disabled.
***************************************************************** Check if this node is the management node *****************************************************************************************************************************
Chapter 11: SDE upgrade
144 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
**** You are in the Management Master node , starting Upgrade ****************************************************************
5. If you are upgrading from a previous SDE stream (e.g., SDE 5.40 to SDE 5.60),repeat steps 1-4 above on all other SDE machines while the managementmachine is running the upgrade.
6. When the upgrade is finished on every machine, if the system is being upgradedto a new SDE stream the following notification appears on all non-managementmachines:***************************************************************** This is not the Master management node then exit ****************************************************************For all upgrade types, the following notification appears on the managementmachine when the upgrade is complete:***************************************************************** Finish to Upgrade all the System ****************************************************************You can verify on each machine that the upgrade was performed properly. A logof the upgrade is located at:
/opt/install/sde_install_mm_dd_yyyy_hh_min.log.
A detailed upgrade log is located at:
/opt/install/svUpgrade_mm_dd_yyyy_hh_mm.log.
A log of the database upgrade is located at: /opt/SDE/logs/svUpgrade_db.log.
Post-upgrade proceduresFollowing completion of the upgrade process, perform the installation verificationprocedures described in “Installation verifications” on page 41. After performing theinstallation verifications, it is recommended that you also perform the followingupgrade verifications:
1. On every SDE node, check the firewall rules:service iptables status
2. If you are not using the administrative group ‘sv_admin’ to receive EMSadministrator access, run the following command on every SDE node:/opt/SDE/cmd/setSDEGroupAdmin.sh <GROUP_NAME>Where <GROUP_NAME> is the group name of the administrator. For example:/opt/SDE/cmd/setSDEGroupAdmin.sh fs_admin
3. After the upgrade process is complete, if you are using the Windows EMS tomanage and monitor to the system, install the most recent release of the SDEEMS on the remote machine. See “Windows EMS installation” on page 46.
Upgrade process
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 14505-00095-C04 July 8, 2010
If you are using the Web EMS, clean the cache of the Internet browser prior toconnecting to the SDE.
Chapter 11: SDE upgrade
146 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
AppendicesThis section contains the following appendices:
• Appendix A: “Additional install procedures” onpage 149 — provides instructions forconfiguring SSL between the EMS and SDE, andfor version checks
• Appendix B: “External configuration procedures”on page 153 — explains the externalconfiguration procedures required on the third-party network elements to set up the end-to-endsystem
• Appendix C: “Manually configuring CMTSs” onpage 155 — provides instructions forconfiguring CMTSs to the system using the EMSGUI or command line interface
• Appendix D: “Example XML description files forCMTS import” on page 171 — providesexamples of XML description files for importingCMTSs
• Appendix E: “Uninstalling the SDE” on page 177 — provides the procedure foruninstalling the SDE software and packages
• Appendix F: “SDE ports” on page 179 — provides a table of ports used forcommunications between the SDE and the different system elements
Section 1: Appendices
148 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
AAdditional installprocedures
This appendix describes additional installationprocedures that may be required.
The following topics are included in this appendix:
• “Configuring SSL between EMS and SDE” onpage 150 — provides instructions forconfiguring SSL between the EMS and SDE
• “Changing the location of the log files” onpage 151 — explains how to move the SDE logsto a different partition on the machine
• “Transferring files to the SDE machine” onpage 152 — explains how to transfer files fromthe client to the SDE machine using secure FTPor SCP
Configuring SSL between EMS and SDE
The default protocol used for configuration between the EMS and the SDE system isRMI. This can be changed to RMI over SSL (with encryption) by editing the followingfile in the SDE:
/opt/SDE/SDE_Agent/config/agent_conf.properties
Change the following line:
com.cmx.odsp.agent.security.use_ssl=falseto:
com.cmx.odsp.agent.security.use_ssl=true
Appendix A: Additional install procedures
150 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Changing the location of the log files
The SDE logs are located by default at /opt/SDE/logs. However, you can optionallymove logs to any other location on the machine.
The following instructions use the example of changing the log location to /var/log/SDE.
To change the location of the log files:
1. On the SDE machine, run the following command:service sde stop
2. Move the /opt/SDE/logs folder to /var/log/SDE by entering the following:mv /opt/SDE/logs /var/log/SDE
3. Create a symlink from /opt/SDE/logs to /var/log/SDE/ by entering the following:ln -s /var/log/SDE logs /opt/SDE/logs
4. Start the SDE:service sde start
Changing the location of the log files
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 15105-00095-C04 July 8, 2010
Transferring files to the SDE machine
Files may be transferred from the client to the SDE machine using secure FTP (FTPover SSH) or the SCP program. This section contains an example use of each of thetwo tools.
SFTP programSFTP (secure file transfer program) is an interactive file transfer program, similar toFTP, that performs all operations over an encrypted SSH transport. It connects andlogs into the specified host and then enters an interactive command mode. SFTPmay use many features of SSH, such as public key authentication and compression.
Synopsis:
sftp [-vC1] [-b batchfile] [-o ssh_option] [-s subsystem | sftp_server] [-B buffer_size] [-F ssh_config] [-P sftp_server path] [-R num_requests] [-S program] host sftp [[user@]host[:file [file]]] sftp [[user@]host[:dir[/]]]
Example:
sftp [email protected]
SCP programAny file name may contain a host and user specification to indicate that the file is tobe copied to/from that host. Copies between two remote hosts are permitted.
Synopsis:
scp [-aAqQprvBCL] [-S path-to-ssh] [-o ssh-options] [-P port] [-c cipher] [-i identity][[user@]host1:]filename1... [[user@]host2:]filename2
Example:scp SourceFile user@host:directory/TargetFile scp user@host:folder/SourceFile TargetFile
Appendix A: Additional install procedures
152 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
BExternalconfigurationprocedures
This appendix describes the configuration proceduresrequired on external network devices so that theycan work in conjunction with the SDE. For detailedinstructions, refer to the specific device’s productdocumentation.
For detailed instructions, refer to the specificdevice’s product documentation.
The following topics are included in this appendix:
• “Application Servers” on page 154 — givesinstructions for configuring application servers toconnect to the SDE
Application Servers
Following installation and configuration of the SDE, configure application servers tosend requests to the WSAM. To do so, configure the virtual IP of the designated SDEborder service in the AS.
Note: The application servers must also be configured in the SDE in order for theWSAM to communicate with them.
Appendix B: External configuration procedures
154 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
CManuallyconfiguring CMTSs
This appendix describes the different methods ofmanually configuring individual CMTSs to the system.The SDE allows you to configure a CMTS to thesystem through the EMS GUI or using the EMScommand line interface (EMS CLI).
The following topics are included in this appendix:
• “Configuring CMTSs through the EMS” onpage 156 — provides step-by-step instructionsfor configuring CMTSs to the SDE
• “Manually configuring CMTS interfaces and maps”on page 164 — explains how to manuallyconfigure CMTS interfaces and maps to thesystem
• “Configuring CMTSs through the CLI” onpage 166 — explains how to configure CMTSsthrough the CLI
Configuring CMTSs through the EMS
To configure a CMTS to the system through the EMS:
1. In the Configurations tree, right-click CMTS List, then select Add CMTS. TheNew CMTS dialog box appears.
New CMTS dialog box
2. In the Enabled/Disabled field, you can optionally disable the CMTS. When aCMTS is disabled, it is as if it is not defined in the system. The SDE does not tryto connect to the CMTS; nor will it send any alarms on the component.
3. Define the CMTS’s label. The Label value defines the name of the CMTS as itappears in the CMTS List.
4. Define the CMTS’s IP address or FQDN. If the SDE connects to the SPB for datacollections and/or Fairshare enforcement, the address format must match theformat (IP or FQDN) used to define CMTSs in the SPB.
5. If a different IP address is configured on the CMTS for the SNMP relay, in theSNMP IP field configure the SNMP IP to which the SDE connects to collect thedata.
6. If the CMTS uses IPDR/SP to send IPDR data to the SDE, configure the IPDR IP ifthe IP address the SDE uses for IPDR/SP communications differs from the CMTSIP. If the CMTS sends IPDR data using using file mode, specify the IPDR Record IPif the IP address sent by the CMTS in the IPDR record’s CMTSipAddress fielddiffers from the CMTS IP.
7. Optionally define the CMTS vendor in the Vendor field. The vendor can be usedfor CMTS identification purposes when using the EMS CLI.
8. Define the edge service to which the CMTS is connected (Service field), and theconnecting VIP.
Appendix C: Manually configuring CMTSs
156 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
9. In the Disable COPS field, if the SDE only collects IPDR and/or SNMP data fromthe CMTS (the SDE applies Fairshare actions through an external PS or the PTS) ,select ‘Yes’. If Fairshare actions will be applied using the SDE policy server, setthis value to ‘No’.
Caution: When the SDE uses a third-party policy server or only uses the PTS to applyFairshare actions, the Disable COPS field MUST be set to ‘Yes’.
10. If the CMTS’s SNMP community differs from that defined for the system in theSDE general parameters, define the SNMP community for this CMTS in the SNMPCommunity field. If the wrong community is defined for this CMTS, its datacollection won’t work.
11. The AllSubnets value determines whether the discovery process discovers allCMTS subnets.
12. The SNMP Collection and Data Collection fields enable you to determine thetype of information received from a CMTS. By default, the SDE receives bothIPDR and SNMP data from a CMTS. Set the SNMP Collection parameter to ‘No’ todisable SNMP data collection, or Data Collection parameter to ‘No’ to disableIPDR collection so that no data of that type is received from the CMTS.
If SNMP is disabled in the Data Collection > General parameters (InterfaceDefinitions Source and Interface Bandwidth Source), you also need to set theSNMP Collection value to ‘No’. Otherwise, the CMTS will be displayed as beingdisconnected in the Status > CMTS node.
13. The Cmts Upstream Congestion and CMTS Downstream Congestion fieldsdefine the precentage of upstream and downstream bandwidth, respectively,above which an interface on the CMTS is considered to be congested. Thispercentage can be used to define conditions for triggering Fairshare actions onusers on the specific CMTS. It overrides the global threshold values defined inthe Fairshare parameters.
14. The Upstream ifSpeed default and Downstream ifSpeed default fields definevalues used for the interface ifSpeed in cases where the IPDR collector receivesa record for a flow on an interface that has not been configured in the EMS orhas not yet been received using SNMP.
15. The default DOCSIS version of the CMTS is 3.0. If the CMTS uses a differentDOCSIS version, you Must specify the correct version in the DOCSIS Version field.If the CMTS will send SAMIS IPDR data (as opposed to SAMIS-TYPE-1) , configurethe DOCSIS version as 2.0, even if the CMTS supports DOCSIS 3.0.
16. If you want the IPDR collector to write all records from this CMTS to file on theSDE, set the Enable File Logging parameter to ‘yes’.
Note: To enable IPDR logging on the CMTS, the Enable File Logging parameter alsomust be set to ‘yes’ in the Data Collection > IPDR Collection parameters.
17. Other fields are not applicable when the policy server is disabled (the DisableCOPS field is set to ‘Yes’). If the policy server is used, optionally configure allother attributes. Defaults may be use
Configuring CMTSs through the EMS
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 15705-00095-C04 July 8, 2010
18. Click OK. The CMTS appears in the CMTS Tree in the EMS right pane.
Note: You can optionally disable or re-enable the CMTS. When a CMTS is disabled, itis as if it is not defined in the system. The SDE does not try to connect to the CMTSor send any alarms on the component. It also doesn’t receive any IPDR data.
19. Define the CMTS interfaces and subscriber maps: Right-click the CMTS and selectMap Discovery. The interface and map information are imported from the CMTS.
Caution: If the SNMP community defined in the SDE differs from the communitydefined in the CMTS, or if SNMP is disabled (the IPDR Collector Interface DefinitionsSource parameter is configured to ‘By Configuration’), Map Discovery won’t work.
20. Configure the IPDR sessions for the CMTS. This determines the flow of the IPDRdata. For instructions, see “Configuring IPDR sessions” on page 162.
CMTS parametersThe following table explains all possible parameters used in the New CMTS dialogbox for manually configuring CMTSs to the system through the EMS.
Table 25: CMTS EMS parameters
Attribute Description Default Value
Enabled/Disabled Determines whether the CMTS isenabled
Enabled
Label CMTS name CMTS_1
IP or FQDN* Physical IP address or FQDN ofthe CMTS. If the SDE connects tothe SPB for data collections and/or Fairshare enforcement, theformat must match the format(IP or FQDN) used to defineCMTSs in the SPB.
--
IPDR IP When the SDE initiates the IPDR/SP connection, the IP address theSDE uses to connect to the CMTSto receive IPDR data, if differentthan the CMTS IP. If the CMTS orexternal relay initiates theconnection, this is the IP valuecontained in initiatorId field ofthe CONNECT message. If theIPDR IP is empty, the value ofthe CMTS IP is used.
--
Appendix C: Manually configuring CMTSs
158 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Attribute Description Default Value
SNMP IP The IP address the SDE uses toconnect to the CMTS to receiveSNMP data, if different from theIP address defined for the CMTS.Used for all deployment types
--
IPDR Record IP The IP address sent by the CMTSin the IPDR record’sCMTSipAddress field, if differentfrom the IP address definedabove for the CMTS. Use this IPwhen the CMTS or external relaysends IPDR data to the SDE usingfile mode.If the IPDR Record IP is notconfigured, the SDE by defaultuses the IPDR IP. If no IPDR IP isconfigured, either, the SDE usesthe CMTS IP for the IPDR data.
--
Port CMTS COPS port number. Usedonly with the SDE policy server
3918
Vendor CMTS vendor: Cisco, BigBand,Motorola, Arris, Relay (used forthird-party IPDR collectors)
--
KA Timeout (sec) Keep Alive Timeout in msbetween the CMTS and PS.Optimize the value (30s)according to the CMTS’s status.Used only with the SDE policyserver
--
RKS The RKS linked to this CMTS.Optional parameter used onlywith the SDE policy server
none
Service * Name of the edge serviceconnected to the CMTS, asdefined in the EMS
Edge Service
Connecting VIP * Edge VIP that the selectedservice uses to connect to theCMTS
--
Upstream Delay (ms) Minimum delay on the cablemodem. Used only with the SDEpolicy server
30
Configuring CMTSs through the EMS
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 15905-00095-C04 July 8, 2010
Attribute Description Default Value
Downstream Delay (ms) Minimum delay on the CMTSdownstream. Used only with theSDE policy server
200
Min Delay Between GateCommands (ms)
Time interval in ms that the SDEwaits before forwarding the nextgate command:0 = disables the rate limitfeature, no delay; Min delayrange = 20 ms to 2^31-1.Accuracy is ± 5 ms. Used onlywith the SDE policy server
0
Disable COPS Determines whether the SDEconnects to the CMTS as a policyserver.Yes: The SDE only collects IPDRand/or SNMP data from theCMTS.No: The SDE collects IPDR and/orSNMP data from the CMTS andsends policies to the CMTS.Change to ‘Yes’ for deploymentsusing an external policy server oronly the PTS to apply Fairshareactions.
No
SNMP Community* The SNMP community used forCMTS Discovery on this CMTS
Default
AllSubnets Determines whether thediscovery process discovers allCMTSs subnets. Optionalparameter used only with theSDE policy serverNo: Discovers only those subnetsbelonging to a DOCSIS MAC layerYes: Discovers all subnets
No
SNMP Collection* Determines whether the SDEcollects SNMP data from thespecific CMTS. This parameter isused only when the SDE is set toSNMP collection (the default) inthe L2 Topology parameters.Yes: SDE collects SNMP data fromthe CMTS.
Yes
Appendix C: Manually configuring CMTSs
160 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Attribute Description Default Value
No: SDE doesn't collect SNMPdata. (Use this setting whensetting up the relay from third-party IPDR collectors.)
Data collection* Determines whether the SDEcollects IPDR or SPB data.Yes: SDE collects IPDR data fromthe CMTS or SPB statistics.No: The CMTS only sends COPSmessages and SNMP data
Yes
Cmts Upstream Congestion(percentage)
Percentage of the upstreambandwidth above which aninterface on a CMTS isconsidered congested. Thedefault may be used.
80
Cmts DownstreamCongestion (percentage)
Percentage of the downstreambandwidth above which aninterface on a CMTS isconsidered congested. Thedefault may be used.
80
Upstream ifSpeed default Default ifSpeed assigned to anyunrecognized CMTS upstreaminterface in an IPDR record
10240000
Downstream ifSpeeddefault
Default ifSpeed assigned to anyunrecognized CMTS downstreaminterface an the IPDR record
42884296
Docsis Version* DOCSIS version supported by theCMTS: DOCSIS 3, DOCSIS 2, orDOCSIS 1.1. If the CMTS will sendSAMIS data to the SDE, select‘DOCSIS 2’, even if the CMTS isDOCSIS 3.0.
DOCSIS 3
Enable File Logging Enables the IPDR collector towrite the CMTS’s IPDR records tofile. This parameter is used forIPDR data collection.When using the outbound IPDRrelay function, this parametermust be set to ‘Yes’.
Yes = writes to fileNo = doesn’t write to file
No
Configuring CMTSs through the EMS
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 16105-00095-C04 July 8, 2010
Note: Parameters in the above table marked with an ‘*’ require configuration.
Configuring IPDR sessionsIPDR sessions enable service providers to configure the SDE to support the SAMIS andflow type of the IPDR data according to the CMTS’s configurations. When the CMTSsupports SAMIS-TYPE-1, you canconfigure two IPDR sessions: one for SAMIS-TYPE-1and one for CPE-TYPE. When SAMIS is used, only the SAMIS IPDR session isconfigured.
To configure the CMTS’s IPDR sessions:
1. Open the CMTS to which you are adding the session, and then right-click IPDRSessions and select Add IPDR Session. The New IPDR Session dialog box appears.
New IPDR Session dialog box
2. Optionally assign the session a name for identification purposes.
3. Define the session type (SAMIS-TYPE-1, SAMIS, or CPE-TYPE).
4. Configure the session ID, connection initiator and session type according to theconfigurations on the CMTS.
5. Click OK. The session appears in the IPDR Sessions list.
IPDR session parametersTable 26: IPDR session parameters
Parameter Description Default Value
IPDR Session Name Optional name assigned to theIPDR session type foridentification purposes
IPDR_Session_1
Appendix C: Manually configuring CMTSs
162 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Parameter Description Default Value
IPDR Docsis Type Defines the type of data sent tothe SDE: SAMIS-TYPE-1, SAMIS, orCPE-TYPE
--
IPDR Session Id Unique ID that must match theIPDR Session ID configured on theCMTS
1
Connection Initiator Defines whether the SDE or CMTSinitiates the IPDR sessions,according to the CMTS’sconfiguration:CMTS: the IPDR waits for theCMTS to initiate sessions.SDE: the SDE initiates theconnection.
SDE
IPDR Session Type Determines the type of IPDRflow, according to the CMTS’sconfiguration:Time Interval: The CMTS sendsIPDR data at intervals.Event: An event serves as thetrigger for the CMTS to send thedata.Ad Hoc: The SDE closes theIPDR/SP connection when it isfinished receiving data. (Usedwhen the SDE initiates theconnection)
Time Interval
Port Number of the port to which theIPDR/SP connection initiatorshould connect. If the SDE is theinitiator, it connects to this porton the CMTS. If the CMTS is theinitiator, the SDE listens to thisport.
4737
Configuring CMTSs through the EMS
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 16305-00095-C04 July 8, 2010
Manually configuring CMTS interfaces andmaps
The SDE allows you to manually configure CMTS interfaces and maps, instead ofimporting them from directly from the CMTS using SNMP.
Manually configuring CMTS interfaces andmapsThe SDE allows you to manually configure CMTS interfaces and maps, instead ofimporting them from directly from the CMTS using SNMP.
Configuring CMTS mapsCaution: When the SDE collects subscriber data from the SPB, you must configurethe IP exclusions for MTA and CPE IP addresses prior to adding new subnets or rangesfor a CMTS. For information regarding IP exclusions, see “IP exclusions” on page 117.
To manually configure the maps:
1. In the Configurations tree, open the node for the CMTS you are configuring,right-click Maps, and select Add Range or Add Subnet. The New Subnet/Rangedialog box appears.
New Subnet dialog box
2. Define the range for the CMTS, or define the net and mask. Select the interface.
3. Click OK.
4. Repeat for each range or subnet on the CMTS.
Appendix C: Manually configuring CMTSs
164 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
CMTS interface and map parametersTable 27: CMTS interfaces and maps
Node/Attribute Description Default Value
Interfaces Adds Interface --
Name Name of the interface, as defined in theCMTS
If_1
CM Capacity (bits/sec) Interface’s CM capacity, as defined in theCMTS.
--
Maps Adds map to the CMTS --
Add Range Adds map range to CMTS --
First IP First IP address in CMTS map range 0.0.0.1
Last IP Last IP address in CMTS map range (mustbe larger than first IP)
0.0.0.0
Add Subnet Adds subnet to the CMTS map --
Net Subnet net 0.0.0.0
Mask Subnet mask 255.255.255.0
Manually configuring CMTS interfaces and maps
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 16505-00095-C04 July 8, 2010
Configuring CMTSs through the CLI
The EMS CLI enables you to configure individual CMTSs to the SDE directly from thecommand line. It is for use on the SDE machine that owns the management serviceVIP.
To configure CMTSs using the CLI, you first must add the CMTS to the system usingthe ./ems_cli addconfig command. After adding the CMTS, edit its attributes usingthe ./ems_cli editconfig command.
Accessing the CLI1. Establish an SSH connection to the SDE management machine or log onto the
management machine locally.
2. At the command line, enter the following:cd /opt/SDE/SDE_EMS ./ems_cli ?
CLI conventionsCommands and command descriptions use the following conventions:
Convention Definition
Courier New font Commands
<parameter> Parameters for which you supply values are in angle brackets
[parameter] A single parameter in square brackets is optional
[1st choice|2ndchoice|3rd choice]
A ‘|’ between text indicates a choice of options
Using the CLIThe command line interface requires use of specific syntax and user input forviewing and modifying elements.
Command syntaxCLI commands use the following syntax:
./ems_cli <command type> <parameter(s)>For example:
Appendix C: Manually configuring CMTSs
166 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
./ems_cli addconfig cmts <CMTS_label> <CMTS IP> [<service name> <connecting VIP>]
Configures a CMTS to the SDE
./ems_cli editconfig cmts <CMTS label> AllSubnets YesEdits the CMTS’s parameters so that the discovery process discovers all CMTS subnets
CMTSAdd CMTS• To add a new CMTS:
./ems_cli addconfig cmts <CMTS_label> <CMTS IP> [<service name> <connecting VIP>]
• To add a subnet to the specified CMTS:./ems_cli addconfig maps <CMTS_label> Subnet <subnet IP> <mask> <interface>
• To add a range to the specified CMTS:./ems_cli addconfig maps <CMTS_label> Range <first IP> <last IP> <interface>
• To add an interface to the specified CMTS:./ems_cli addconfig interfaces <CMTS_label> interface <interface name>
Edit CMTS./ems_cli editconfig cmts <CMTS label>
Changes a parameter on the specified CMTS
• To disable/enable the CMTS:./ems_cli editconfig cmts <CMTS label> IsEnabled [Disabled|Enabled]
• To determine whether the discovery process discovers all CMTS subnets:./ems_cli editconfig cmts <CMTS label> AllSubnets [Yes|No]
• To determine whether the SDE only collects data from the CMTS:./ems_cli editconfig cmts <CMTS label> CollectOnly [Yes|No]
• To change the CMTS's name:./ems_cli editconfig cmts <CMTS label> CmtsLabel <new CMTS name>
• To change the CMTS's IP address or FQDN:./ems_cli editconfig cmts <CMTS label> ip <new IP address or FQDN>
Configuring CMTSs through the CLI
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 16705-00095-C04 July 8, 2010
• To change the CMTS's COPS port number:./ems_cli editconfig cmts <CMTS label> port <new port value>
• To change the CMTS's vendor:./ems_cli editconfig cmts <CMTS label> CmtsVendor <vendor name>
• To change the CMTS's KA timeout (ms):./ems_cli editconfig cmts <CMTS label> CmtsKATimeout <new value>
• To change the CMTS's RKS:./ems_cli editconfig cmts <CMTS label> rksid <new ID>
• To change the service to which the CMTS is connected:./ems_cli editconfig cmts <CMTS label> service <new service>
• To change the VIP used to connect to the CMTS:./ems_cli editconfig cmts <CMTS label> vipid <new IP>
• To change the CMTS's minimum delay between gate commands (ms):./ems_cli editconfig cmts <CMTS label> RCGap <new value>
• To change the CMTS's jitter:./ems_cli editconfig cmts <CMTS label> CmtsJitter <new value>
• To change the CMTS's upstream delay:./ems_cli editconfig cmts <CMTS label> CmtsUPDelay <new value>
• To change the CMTS's downstream delay:./ems_cli editconfig cmts <CMTS label> CmtsDownDelay <new value>
• To change the CMTS's Max Grant Size parameter:./ems_cli editconfig cmts <CMTS label> MaxGrantSize <new value>
• To change the CMTS's Max Grants Per Interval parameter:./ems_cli editconfig cmts <CMTS label> MaxGrantPerInterval <new value>
• To change the CMTS's SNMP community:./ems_cli editconfig cmts <CMTS label> Community <new value>
• To configure the IP address the SDE uses to connect to the CMTS to receive SNMPdata, if different from the IP address defined for the CMTS:./ems_cli editconfig cmts <CMTS label> SnmpIP <value>
• To configure the IP address sent by the CMTS in the IPDR record’s CMTSipAddressfield, if different from the IP address defined for the CMTS:
Appendix C: Manually configuring CMTSs
168 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
./ems_cli editconfig cmts <CMTS label> IpdrRecordIP <value>
• To change the percentage of the upstream bandwidth above which an interfaceon a CMTS is considered congested:./ems_cli editconfig cmts <CMTS label> CmtsUpstreamCongestion <value>
• To change the percentage of the downstream bandwidth above which aninterface on a CMTS is considered congested:./ems_cli editconfig cmts <CMTS label> CmtsDownstreamCongestion <value>
• To change the default ifSpeed assigned to any unrecognized CMTS upstreaminterface in an IPDR record./ems_cli editconfig cmts <CMTS label> ifSpeedUpstreamDefault <value>
• To change the default ifSpeed assigned to any unrecognized CMTS downstreaminterface in an IPDR record./ems_cli editconfig cmts <CMTS label> ifSpeedDownstreamDefault <value>
•./ems_cli editconfig cmts <CMTS label> Enable file <value>
• To change the CMTS's map auto discover source:./ems_cli editconfig cmts <CMTS label> discovery <new source>
• To display parameters for changing a CMTS's interface:./ems_cli editconfig cmts <CMTS label> interfaces <interface name> ?
• To change the name of the specified interface:./ems_cli editconfig cmts <CMTS label> interfaces <interface name> interfacename <new interface name>
• To change the upstream bandwidth of the specified interface (bits/sec):./ems_cli editconfig cmts <CMTS label> interfaces <interface name> UpstreamBW <value>
• To change the downstream bandwidth of the specified interface (bits/sec):./ems_cli editconfig cmts <CMTS label> interfaces <interface name> DownstreamBW <value>
• To change the interface's CM capacity:./ems_cli editconfig cmts <CMTS label> interfaces <interface name> MinInterfaceBW <value>
• To change the interface's CM capacity:./ems_cli editconfig cmts <CMTS label> IPDRSession <interface name> MinInterfaceBW <value>
Configuring CMTSs through the CLI
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 16905-00095-C04 July 8, 2010
Appendix C: Manually configuring CMTSs
170 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
DExample XMLdescription filesfor CMTS import
This appendix provides example XML description filesfor configuring large numbers of CMTSs to thesystem.
The following topics are included in this appendix:
• “Example XML description file for IPDR collectionand PCMM enforcement” on page 172 — provides an example XML description file forIPDR collection and Fairshare application usingPCMM
• “Example XML description file for SPB datacollection and PCMM-PTS enforcement” onpage 174 — provides an example XMLdescription file for SPB data collection and PCMMand PTS Fairshare application
Example XML description file for IPDRcollection and PCMM enforcement
The example XML file below displays the maximum number of CMTS and IPDR sessionattribute fields that need to be defined for Fairshare when the SDE collectssubscriber data using IPDR and applies Fairshare policies either through its policyserver using PCMM, or by using PCMM to apply Fairshare on the upstream and the PTSto apply Fairshare on the downstream.
<?xml version="1.0" encoding="UTF-8"?> <CmtsView> <Index id="0">IsEnabled</Index> <Index id="1">CmtsLabel</Index> <Index id="2">Id</Index> <Index id="3">Ip</Index> <Index id="4">IpdrIP</Index> <Index id="5">SnmpIP</Index> <Index id="6">IpdrRecordIP</Index> <Index id="7">Port</Index> <Index id="8">CmtsVendor</Index> <Index id="9">CmtsKATimeout</Index> <Index id="10">Service</Index> <Index id="11">VipId</Index> <Index id="12">community</Index> <Index id="13">AllSubnets</Index> <Index id="14">SnmpCollection</Index> <Index id="15">CmtsUpstreamCongestion</Index> <Index id="16">CmtsdDownstreamCongestion</Index><Index id="19">DocsisVersion</Index> <Index id="20"> IPDRSessions </Index> <IPDRSessionParams> <Index id=“21">SessionName</Index> <Index id=“22">DocsisType</Index> <Index id=“23">SessionId</Index> <Index id=“24">ConnectionMode</Index> <Index id=“25">SessionType</Index> <Index id=“26">Port</Index> </IPDRSessionParams></CmtsView>
• The Id parameter is optional and is recommended when CMTS maps also will beimported. CMTS maps are required to apply Fairshare actions using the SDEpolicy server. For information about importing CMTS maps, see “Import CMTSmaps” on page 109.
• If the CMTS will not collect SNMP information, the SnmpCollection value mustbe set to ‘no’.
Appendix D: Example XML description files for CMTS import
172 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
• The SnmpIP and IpdrRecordIP fields are defined only if they are different fromthe IP address defined for the CMTS.
• If the CMTS COPS port number differs from the default, define the Port attributein the file.
• If the CMTS’s DOCSIS version differs from the default (DOCSIS 3), you MUSTinclude the DocsisVersion field and define the correct DOCSIS version in the CSVfile.
• The CmtsKATimout parameter sets the Keep Alive Timeout between the CMTSand policy server.
• The RksId attribute is defined only if the system will also connect to a recordkeeping server.
• The AllSubnets parameter can be used to configure the SDE to display CMTSinterfaces and subnets.
• All other PCMM-related attributes are optional. If they are not defined in theXML and CSV files, the default values will be used:
• CmtsJitter - 200
• CmtsUPDelay - 30 ms
• CmtsDownDelay - 200 ms
• RCGap - 0 ms
• MaxGrantSize - 0
• MaxGrantPerInterval - 0
• Defaults may be used for the CmtsUpstreamCongestion andCmtsDownstreamCongestion attribute values.
Table 19: Attributes for CMTS import on page 101 explains the CMTS attributesdefined by the above Index IDs.
Example XML description file for IPDR collection and PCMM enforcement
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 17305-00095-C04 July 8, 2010
Example XML description file for SPB datacollection and PCMM-PTS enforcement
The following example XML file displays the maximum number of CMTS attributefields that need to be defined for Fairshare when the SDE collects subscriber datafrom the SPB and applies Fairshare policies using PCMM on the upstream and the PTSon the downstream.
The XML description file appears as follows:
<?xml version="1.0" encoding="UTF-8"?> <CmtsView> <Index id="0">IsEnabled</Index> <Index id="1">CmtsLabel</Index> <Index id="2">Id</Index> <Index id="3">Ip</Index> <Index id="4">Port</Index> <Index id="5">CmtsVendor</Index> <Index id="6">CmtsKATimeout</Index> <Index id="7">Service</Index> <Index id="8">VipId</Index> <Index id="9">CollectOnly</Index> <Index id="10">community</Index> <Index id="11">AllSubnets</Index> <Index id="12">SnmpCollection</Index> <Index id="13">IpdrCollection</Index> <Index id="14">CmtsUpstreamCongestion</Index> <Index id="15">CmtsdDownstreamCongestion</Index> <Index id="22">DocsisVersion</Index>
• In the CSV file, the value for the CollectOnly, attribute should be set to ‘no’ toallow the SDE to send policies to the policy server. The value forSnmpCollection should be set to ‘yes’ to allow the SDE to collect SNMP datafrom the CMTS.
• The Id parameter is optional and is recommended when CMTS maps also will beimported. CMTS maps are required to apply Fairshare actions using the SDEpolicy server. For information about importing CMTS maps, see “Import CMTSmaps” on page 109.
• If the CMTS COPS port number differs from the default (3918), the Port field alsoshould be added.
• If the CMTS’s DOCSIS version differs from the default (DOCSIS 3), you MUSTinclude the DocsisVersion field and define the correct DOCSIS version in the CSVfile.
• The SnmpIP field is defined only if it is different from the IP address defined forthe CMTS.
Appendix D: Example XML description files for CMTS import
174 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
• The CmtsKATimout parameter sets the Keep Alive Timeout between the CMTSand policy server.
• The RksId attribute is defined only if the system will also connect to a recordkeeping server.
• The AllSubnets parameter also may be used to configure the SDE to displayCMTS interfaces and subnets.
• All other PCMM-related attributes are optional. If they are not defined in theXML and CSV files, the default values will be used:
• CmtsJitter - 200
• CmtsUPDelay - 30 ms
• CmtsDownDelay - 200 ms
• RCGap - 0 ms
• MaxGrantSize - 0
• MaxGrantPerInterval - 0
• Defaults may be used for the CmtsUpstreamCongestion andCmtsDownstreamCongestion attribute values.
Table 19: Attributes for CMTS import on page 101 explains the CMTS attributesdefined by the above Index IDs.
Example XML description file for SPB data collection and PCMM-PTS enforcement
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 17505-00095-C04 July 8, 2010
Appendix D: Example XML description files for CMTS import
176 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
EUninstalling theSDE
This appendix explains the procedure for uninstallingthe SDE software
The following topics are included in this appendix:
• “SDE uninstall procedure” on page 178 — explains how to uninstall the SDE software fromthe server
SDE uninstall procedure
The following procedure should be used In cases where the SDE software must bedeleted from the server before new software can be installed. The uninstallprocedure removes all /opt/SDE files. It also gives you the option of deleting thedatabase.
Warning: The following procedures remove the SDE software from the server.
To delete the SDE software:
1. On the SDE machine, run the SDE uninstall script:/opt/install/uninstall4sde
2. Enforce removing the SDE packages if they still exist by entering the followingcommand exactly as is:rpm -qa --qf '[%{SUMMARY} :%{NAME}-%{VERSION}-%{RELEASE}\n]' | grep SDE | cut -f2- -d: | xargs rpm -e
Note: To delete a specific SDE package you can use the following command:rpm -e <package name>3. Verify that no SDE package is still installed by entering the following command
exactly as is:rpm -qa --qf '[%{SUMMARY} :%{NAME}-%{VERSION}-%{RELEASE}\n]' | grep SDE | cut -f2- -d:
4. Verify that the SDE is not running any more:service sde status
Appendix E: Uninstalling the SDE
178 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
FSDE ports
This appendix contains a table of ports the SDE usesto communicate with the EMS, NetPortal andexternal system elements through the firewall.
The following topics are included in this appendix:
• “Ports used for SDE communications” onpage 180 — describes the ports used betweenthe SDE and the different network resources
Ports used for SDE communications
The following table describes the ports used between the SDE and the differentnetwork resources:
Table 28: Communications ports
(From)Accessing
Element
(To)AccessedResource
SDE CMTS 3rd-party
PS
3rd-partyIPDRrelay
SPB NetPortal
SDE From physicalIP: ports4803,4804 -spread (UDP)
port 1138 -WSAM SessionSharing (TCP)
port 1140 -PS SessionSharing (TCP)-----------From mgmtVIP: port 22(SSH)-----------To borderVIP: port8080 - WSAMSOAP (TCP)-----------From borderVIP: port8888 WS-Eventing(FromFairshareEngine toWSAM)
FromphysicalIP toCMTS IP:161(UDP)-----------Fromedge VIPto CMTSIP: 4737-----------Fromedge VIPto CMTSIP: 3918(COPS)
FromphysicalIP to 3rdparty PSIP: 3918
Fromedge VIPto 3rdpartyIPDRrelay IP:4737
Fromedge VIPto SPBIP: 8081
Fromphysical IP:3306 toNetPortalIP (Foraccess tothe MySQLdatabaseon theNetPortalmachine)
SDE port 111 -RPC (UDP)
Appendix F: SDE ports
180 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
(From)Accessing
Element
(To)AccessedResource
SDE CMTS 3rd-party
PS
3rd-partyIPDRrelay
SPB NetPortal
port 3306 -MySQLdatabase(TCP)-----------From physicalIP: ports7000-7015 -EMS (TCP/UDP)
CMTS Fromedge VIP:port 6210(TCP)
X X X X X
3rd-Party PS From physicalIP: port 3918(UDP)
X X X X X
3rd-partyIPDR relay
Fromedge VIP:port 6210 -IPDR filestreaming(TCP)-----------From edgeVIP: port4737 - XDRrelay (TCP)
X X X X X
ApplicatonManager
SDE borderVIP: port3918
X X X X X
ApplicationServer
SDE borderVIP: port8080
X X X X X
OperatorManagementSystem
TomanagementVIP: port
X X X X
Ports used for SDE communications
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 18105-00095-C04 July 8, 2010
(From)Accessing
Element
(To)AccessedResource
SDE CMTS 3rd-party
PS
3rd-partyIPDRrelay
SPB NetPortal
161/162(UDP, SNMP)
port 1099(EMS)-----------From edgeVIP: port8085(NetReportsconnecting tothe edge VIP,as DB/NetReportsare locatedon thecluster)
ManagementService
TomanagementVIP: port 22(SSH)-----------Physical IP:port7000-7015 -EMS (TCP/UDP)
X X XX X
NetPortal FrommanagementVIP: 8085 (toNetPortalcommunicating with theNetReports
X X X X From edgeVIP toNetPortalIP: port3306(MySQLreplication)
Note: Whenno edge VIPused,communi-cations arethrough the
Appendix F: SDE ports
182 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
(From)Accessing
Element
(To)AccessedResource
SDE CMTS 3rd-party
PS
3rd-partyIPDRrelay
SPB NetPortal
on the SDEclusters)
management VIP
Accessing element (outbound) will use any local port toconnect to the accessed resource (inbound) when specificports should be allowed.
Systems belonging to the same cluster are allowed to connectto each other with no limitations—e.g., SDE-FS-1 cancommunicate with SDE-FS-2 through any port.
Ports used for SDE communications
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 18305-00095-C04 July 8, 2010
Appendix F: SDE ports
184 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Index/etc/hosts 25/etc/stscibfug/network 25
Aactive-active mode, configuring 61activity log 81application manager
configuring 124parameters 125
application serverconfiguring 126external configuration 154parameters 126
attaching services 55, 71
Bborder service
border service 52external PS connection 52
border VIPchanging in properties file 57configuring 52
CCLI
accessing 166command syntax 166conventions 166
cluster 21, 68CMTS
CLI add command 167CLI edit command 167configuring through CLI 166configuring through EMS 156default ifSpeed 157disabling 156importing 97interfaces and maps 164parameters 158
CMTS importattributes for CSV file 101available attributes 98CSV data file 100errors 107IPDR sessions 99
procedure 107XML description file 97
CMTS interfacesconfiguration parameters 165manually configuring 88
CMTS mapsconfiguration parameters 165configuring 164import process 110importing 109sample import range file 110sample import subnet file 109XML description file 109
CMTS XML description filehybrid Fairshare application 174IPDR and PCMM 172
CMTSsIPDR sessions 162
command line interface, see CLI 46COPS parameters
values 83CSV data file, CMTS 100
Ddata collection
parameters 86data tier injection 88database
excluding IPs from 117for Fairshare 22
dependencies, missing 44dummy VIPs 16
Eedge service
adding 71purpose of 22
edge VIPadding 62configuring 51, 71
EMSaccessing 46Linux GUI 47loging in 47usage 46Windows installation 46
error log 81eth0 25
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 18505-00095-C04 July 8, 2010
event messages 127external policy server 52
FFairshare enforcement 18Fairshare parameters
values 85file logging 58, 90file logging, enable 161file transfer 152fsam_conf.properties file 57FTP 152
Ggarbage gates 80gate store 79general parameters
values 78global parameter settings 75
Hhardware
minimum server requirements 14Recommended partitioning 15requirements per node 14verification 14
high availability 70
IifSpeed 88import errors, CMTS 107importing
CMTS maps 109CMTSs 97
installationadditional clusters 69local yum 35of NetPortal 141prerequisites 24troubleshooting 44verifications 41verifications on second machine 63, 73verifications prior to 24VIP requirements 26yum 39
interface congestion 88IPDR
collection parameters 89IPDR file logging 157IPDR relay
inbound 105outbound 58
IPDR sessionparameters 162
IPDR sessionsconfiguring through EMS 162importing 99
IPs, excluding from database 117
Llog parameters
values 81logs
activity 81changing location of 151error 81management 81
Mmachine hostname
troubleshooting 45management
cluster 21, 32node 50service 21, 60
management log 81management VIP
assigning 50purpose of 21
map range, sample XML import file 110
Nnet-snmp 44NetPortal
edge service 142installing 141management service 142overview of 140
Network requirements 16
Ooperating system 15
186 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
Pportmap 25ports
table 180pre-installation
checklist of requirements 31recommended checks 24requirements 24
primary SDE node 51
Rrecovery 60reports
configuring 137RHEL accessibility 33RKS
configuring 127parameters 128
RPC connectivity 26
SSCN source 87SCP program 152SDE
cluster 21SDE architecture 18SDE deployment types 19SDE node
adding 60, 70SDE node parameters 61SDE parameters
configuring 77COPS 83Fairshare 85garbage gates 80general 78log 81WSAM 84
SDE system view 63SDE uninstall 178second edge VIP 61second SDE machine 60service parameters 54services
attaching to nodes 55predefined 50
session border controller 124SFTP program 152SNMP
agent 132collection parameters 89trap receiver parameters 133trap receivers 133
softswitch 124SPB
collection parameters 90configuring to SDE 119excluding individual IPs 117mapping edge services 120parameters 120used with SDE 114
SSL, configuring 150stateful limit 78subnets
excluding from database 118sample XML import file 109
support account 28Syslog server 81system monitoring
SDE system view 63
Ttier injection, see data tier injection 88trap receiver
configuring 133parameters 133
troubleshootingmachine hostname 45yum install 44
Uuninstall procedure 178upgrade
management machine 144verification procedures 145
usage information 127
VVIP parameters 51VIPs
border 52edge 51management 50purpose of 17required 26
Virtual IP, see VIP 17
Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04 18705-00095-C04 July 8, 2010
WWSAM parameters
values 84WSAM service
configuring 53purpose of 22
XXML description file, CMTS 98
XWindow, installing 47
Yyum
configuring as client 37installation from repository 39local installation 35troubleshooting 44
188 Fairshare Installation & Configuration Guide: Release 5.60 Rev. C04July 8, 2010 05-00095-C04
sandvine®
Sandvine Incorporated408 Albert StreetWaterloo, Ontario, CanadaN2L 3V3
Phone: (+1) 519.880.2600Fax: (+1) 519.884.9892
Web Site: www.sandvine.com