Professional Documents
Culture Documents
Calix Management System (CMS) R15.x User Guide
Calix Management System (CMS) R15.x User Guide
Calix Management System (CMS) R15.x User Guide
#220-00991-20
August 2023
Contents
Prerequisites ............................................................................................................ 16
CMS Interfaces......................................................................................................... 24
Online Help............................................................................................................... 30
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
5
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
6
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
7
Customizing the Default CMS Security and Archive Settings ........................... 255
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
9
C7 PM Features...................................................................................................... 298
PM Data on C7 Networks ............................................................................. 298
C7 Performance Monitoring Data ................................................................. 299
C7 Port-Specific PM Parameters .................................................................. 300
Setting the Archive Days for Logs and PM Data................................................. 307
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
10
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
11
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
12
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 1
For instructions on how to install or upgrade the CMS server software, see the Calix
Management System (CMS) Installation and Upgrade Guide for Linux or Solaris, depending on your
host server operating system.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
14
Intended Audience
The primary audience for the Calix Management System Guide includes personnel
responsible for the following:
Network monitoring
User administration
Security
Node and network setup
Service configuration at the Network Operations Center (NOC) or Central Office (CO)
Calix assumes that readers of this guide have experience with computer systems and
software, and have knowledge of telecommunications and engineering standards. Calix
recommends that readers be familiar with the Calix system hardware installation.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
15
Guide Organization
This guide is organized into the following sections:
CMS Overview: Lists the hardware and software system requirements for CMS and
offers an overview of the basic features of CMS. This section also presents an overview
of basic concepts and navigation information to help you get oriented.
CMS Client Applications: Includes instructions for installing, opening, and upgrading
CMS Desktop, and using the CMS TL1 interface.
Security Management: Includes instructions for creating user groups and users; editing
user access privileges, security settings, and user details; and managing user sessions.
Configuration Management: Includes instructions for creating regions and network
groups, customizing security and archive settings, connecting to Calix network elements,
creating inventory reports, and establishing C7 TL1 and cut-through node management
and CLI sessions.
Fault Management: Includes instructions for viewing alarms, viewing events and alarm
logs, and querying historical alarm and event logs.
Performance Monitoring: Contains information for retrieving historical performance
data, scheduling PM data downloads, and querying historical PM data for Calix network
elements.
Business Reports: Includes instructions for creating business reports to monitor
network resources.
Administrative Tasks: Presents information about editing regions and networks;
scheduling CMS object and network element backups; exporting and importing CMS and
network objects; querying administrative logs; managing archival logs and PM data; and
synchronizing network alarms and timing.
Troubleshooting and Reference: Includes performance optimization tips,
troubleshooting information, UNIX scripts, system configuration settings, and
information about C7 platform release support.
Appendices: Contains useful reference materials, such as port-specific Performance
Monitoring (PM) parameters, and an acronym list.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
16
Prerequisites
Before using the information and procedures in this guide, be sure that:
Calix network element equipment is properly installed, turned up, and tested.
CMS and the Calix product documentation is readily accessible.
The CMS server has been installed and the server is running.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
17
CMS
Calix Management System (CMS) Guide
Calix Management System (CMS) Installation and Upgrade Guide—Linux
Calix Management System (CMS) Installation and Upgrade Guide—Solaris
Calix Management System (CMS) Northbound Interface API Guide
CMS Appliance Guide
Calix B6 networks
Managing a Calix B6 Network from CMS
Calix C7 networks
Calix C7 Engineering and Planning Guide
Calix Upgrade Program (CUP) Application Guide
Calix C7 Provisioning Guide
Calix C7 GPON Applications Guide
Calix C7 Ethernet and IP Services Guide
Calix C7 Broadband Data Services Guide
Calix C7 Video Services Guide
Calix C7 Voice Services Guide
Calix C7 VoIP Services Guide
Calix C7 Maintenance Guide
Calix C7 Troubleshooting Guide
Calix C7 TL1 Management Interface Reference
Calix C7 SNMP MIBs
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
18
Calix ONTs
Managing Calix AE ONTs from CMS
Managing Calix Active Ethernet ONTs from the CLI
Calix ONT Configuration Manager (OCM) User Guide
Calix 700/700G/700GX/800-Series installation, configuration, ONT accessories, and
troubleshooting guides.
Calix EXOS-powered GigaFamily (GS4227 and GS4227W) installation and operations
guides.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 2
CMS Overview
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
20
CMS Features
Calix Management System (CMS) is a client/server application for managing, monitoring,
and configuring multiple Calix Active Ethernet (AE) and GPON ONTs, E7 OS networks,
C7 networks, E3/E5-100 service units, and B6 cards..
For detailed instructions on how to manage Calix network elements, see the configuration,
services, and other guides listed in Calix documentation set (on page 17), accessible online at the
Calix Customer Resource Center at www.calix.com.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
21
CMS supports up to three versions of Calix network element software: the current version
and the two previous versions. CMS handles most version translation internally and
seamlessly.
For descriptions of and instructions for network element-level provisioning features, see the
Calix Documentation Set (on page 17). A few of the key management features only available in
CMS include:
Global profiles for Calix C7 networks, E-Series service units and platforms, AE ONTs,
and global subscriber templates for C7 networks and E3/E5-100 nodes (for details, refer
to the platform-specific documentation).
Service activation for AE ONTs; xDSL and POTS ports and ONTs for E-Series systems
and C7 networks (for details, refer to the platform-specific documentation).
A tool for configuring Ethernet services and devices across Calix platforms (for details,
see Provisioning Cross-Platform Ethernet Topologies (on page 116)).
A tool for turning up Ethernet-over-SONET transport and service drops on C7
networks (for details, refer to the Calix C7 Provisioning Guide).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
22
For a matrix of compatible Calix equipment software releases corresponding to the most
current CMS release, refer to the Calix Management System (CMS) Release Notes, accessible by
logging into My Calix (www.calix.com/my-calix (https://www.calix.com/mycalix)) and browsing the
My Calix Documentation Library.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
23
CMS Architecture
The following illustration shows how CMS clients and server connect to the Calix networks
and nodes that you manage. Descriptions of each CMS client interface follow.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
24
CMS Interfaces
CMS has five client interfaces:
CMS Desktop: A stand-alone, Java-based client for CMS server administration;
provisioning, maintaining, and troubleshooting Calix network elements; reporting
Performance Monitoring statistics; and viewing online help.
CMS Web: A Web browser-based interface for querying and reporting inventory
statistics from Calix network elements; querying and reporting Performance Monitoring
from Calix nodes; running historical alarm and event queries; downloading CMS
Desktop; and viewing online help.
CMS TL1 Interface: A Transaction Language 1 (TL1) text interface for provisioning,
maintaining, and troubleshooting C7 networks.
CMS SNMP Northbound Interface: A unified interface for alarm management
integration with back office systems.
CMS XML Northbound Interface Applications Processing Interface: An API that
provides back-office system integrators with the ability to activate service requests on C7,
E-Series, AE ONTs, and E3/E5-100 units. The interface can also use the subscriber
profiles within the CMS database. See the Calix Management System (CMS) XML
Northbound Interface API Guide.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
25
CMS Connections
Use the following methods to manage Calix equipment connections to the CMS server:
B6 networks: CMS Desktop and Web interfaces. Connections between the CMS server
and managed B6 networks consist of IP network links from the LAN to an Ethernet port
on each B6 card. For options and details about connecting to the Ethernet ports on a B6
network, see the Calix B6 platform documentation.
C7 networks: CMS Desktop, Web, and TL1. Connections between the CMS server and
the managed C7 networks consist of IP network links from the LAN to an Ethernet port
on an AMP or ATP card in the C7 network. For options and details about connecting to
the Ethernet ports on a C7 shelf, see the Calix C7 Provisioning Guide.
E3/E5-100 service units: CMS Desktop and Web interfaces. Connections between the
CMS server and E3-12C, E3-48, E5-110, E5-111, E5-120, and E5-121 nodes consist of
IP links from the LAN to an Ethernet interface on the node. For options and details
about connecting to the E3/E5-100 node, see the appropriate Calix installation
documentation.
E-Series platforms: CMS Desktop and Web interfaces. Connections between the CMS
server, E-Series, and E5-30x/E5-520 platforms consist of IP links from the LAN to the
alarm, management, and Ethernet line interfaces on the node. For details about setting
up physical connections, see the Installation Guide for each platform. For details about
setting up management interface communication with these E-Series platforms, see the
Turn-Up and Transport Guide.
700GE, 700GX and 836GE RSG Active Ethernet (AE) ONTs: CMS Desktop.
Connections between the CMS server and AE ONTs consist of auto-discovered IP links
based on SNMP traps sent from the ONTs when they boot up. For options and details
about AE ONTs, see the Calix publication, Managing AE ONTs with CMS.
A TL1 northbound interface agent is also available (requires advance setup requirements with
Calix) for specific Calix E-Series products.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
26
For instructions on how to use the Subscriber Search tool, see Performing a Subscriber Search
(on page 98).
To toggle to the CMS administrative and node configuration work area menus, at the top of
the screen, click the Previous Panel link. (To toggle back to the subscriber search pane, click
the Last Search link.)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
27
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
28
From the Navigation Tree, access and customize the region and network group views that
display in the Work Area:
At a region level: The CMS Navigation Tree contains a root region that cannot be
deleted or renamed. Under the root region, you create regions, sub-regions, and network
groups for viewing network elements.
On the CMS Region tab, view a topology of the selected region. Other options include
viewing region, network group, network, and node details within the region, as well as
organizing network elements on a map using GoogleMaps.
At a network view level: Options include viewing network and node details within the
network group, organizing network elements on a map using GoogleMaps, and creating
customized topology links between network elements to view in the Topology Work
Area.
Network view
View network element configuration settings down to the port or path level in the Work
Area.
Security view
At the CMS level, the Work Area provides access to CMS user security and system defaults.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
29
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
30
Online Help
You can access the contents of the Calix Management System (CMS) Guide online in HTML
format from either CMS Desktop or CMS Web. The online help contains a search function
for locating information quickly. Accessing online help requires no permissions other than a
CMS user account.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
31
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
32
Enable RADIUS Complete this configuration step if Enabling RADIUS Authentication (on
authentication. you use a RADIUS server. page 54)
Create CMS user groups and Review the options for topological CMS User Privileges (on page 62)
user accounts. and functional user access and
Creating CMS Users and User Groups
determine how to implement the
(on page 76)
CMS administrative and functional
tasks within your company.
Create regions, network Create and group your network Managing Regions, Networks, Nodes,
groups, and Calix network elements in CMS Desktop by add and Devices (on page 92)
elements. them to the Navigation Tree.
Each network and node managed
from CMS must be functioning, with
equipment and transport
provisioned.
Review and customize, if Review the PM data downloads Viewing Scheduled Tasks (on page
needed, the default scheduled required for each of the business 345)
tasks, or create new reports.
Scheduling a PM Download (on page
scheduled tasks.
Weekly system scheduled tasks for 308)
Note: During an upgrade, inventory snapshots are
Scheduling a CMS Database Backup
system scheduled tasks are automatically created for C7 shelves (on page 353)
not exported with the CMS and E-Series nodes.
database. You must manually Scheduling Calix Network Element
A daily scheduled task for CMS
re-input any customizations. Backups (on page 357)
database backups is also created.
Scheduling an Inventory Snapshot (on
Check for and remove any duplicate page 366)
download tasks.
Optimizing Scheduled Tasks (on page
348)
Review and modify, if needed, Customize CMS security and Customizing the Default CMS Security
CMS system and archive settings. and Archive Settings (on page 255)
administrative settings based
Modify the default synchronization Modifying the Default Synchronization
on your company
options. Options (on page 391)
requirements.
Review the available system CMS System Configuration Settings (on
configuration settings. page 407)
Create and synchronize Manage global profiles and Calix C7 Provisioning Guide
global profiles and subscriber templates for Calix network
Managing Calix 700 Active Ethernet
templates. elements.
ONTs from CMS
Manage subscriber activation
Managing Calix E3/E5-100 Service
templates for C7 networks, E3/E5-
Units from CMS
100 nodes, and AE ONTs.
E5-400, E3-48C, E5-48/E5-48C,, E5-
30x/E5-520, and E7 User Guides
(Optional) Create cron jobs. Use cron jobs with UNIX scripts to See these topics in the CMS Installation
download PM data or manage C7 and Upgrade Guide:
backup files.
Performing a Daily PM Download with a
If you have configured a secondary Script
(backup) CMS server, use a cron
Managing C7 Backup Files
job to import all CMS objects except
scheduled tasks. For details, see
the CMS Installation and Upgrade
Guide–Solaris.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
33
For Xangati customers, Refer to CMS Quick Tip 09-001 for Log in at www.calix.com and click the
configure the CMS Postgres instructions, as well as Documentation Library link. Under
database. recommendations for scheduling Service Management, click Bulletins.
CMS inventory snapshots.
Test and verify. Check network and node Troubleshooting a C7 Network
connectivity. Connection (on page 208)
Verify any optional settings you Troubleshooting an E3/E5-100
have made. Connection (on page 242)
Verify that PM data can be Troubleshooting an E Series System
retrieved and cron jobs (if used) Connection (on page 133)
are running.
Troubleshooting F5 and FD Database
Synchronization
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
34
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
35
Monitor and troubleshoot Based on company requirements, Fault Management (on page 257)
alarms and network you can:
Modifying Alarm Severity and
connectivity. Descriptions (on page 265)
Query historical alarms and
events.
Acknowledging Standing Alarms in CMS
Modify alarm attributes. (on page 262)
Acknowledge alarms. Alarm E-Mail Notification (on page 283)
Set up alarm e-mail notification. Northbound SNMP for Alarms (on page
290)
Set up SNMP subscribers.
Using the CMS TL1 Interface (on page
Set up TL1 real-time alarms.
223)
Troubleshoot CMS-specific alarms Troubleshooting CMS Alarms (on page
(for example, CMS Disk Full) and 396)
service-specific alarms (for example,
For service-specific alarms, see the Calix
loss of signal or missing equipment). documentation, accessible online at the
Calix Resource Center.
Monitor network and node Troubleshooting a C7 Network
connectivity: Connection (on page 208)
Verify that network elements are Troubleshooting an E3/E5-100
connected and synchronized. Connection (on page 242)
Verify that nodes use the auto- Troubleshooting an E-Series System
connect parameter, where Connection (on page 133)
required.
Viewing or Managing Network
Verify that alarm timestamps Parameters (on page 206)
reflect the correct time zone.
Synchronizing Network Alarms and Time
(on page 390)
Run custom reports Use the Search, Inventory, and PM Searches and Inventory Reports (on
(frequency determined by Report features. page 96)
company requirements).
Performance Monitoring (on page 293)
Run business reports. Business Reports (on page 323)
Monitor CMS server, UNIX Check CMS server processes. CMS Server Processes (on page 401)
or Linux server, and client
Check UNIX or Linux CPU Postgres Database Maintenance (on
PC or workstation
utilization and server disk space. page 378)
performance.
Check performance of CMS client Note: Refer to the CMS Installation and
Important: Check the CMS PCs or workstations. Upgrade Guide for information on
release notes or call the updating the etc/hosts file following an
Calix Technical Assistance Perform required database
maintenance and conversions. operating system upgrade.
Center (TAC) to verify that
an operating system update Update or patch the operating
is compatible with the CMS system.
version that you are running.
Save the latest CMS Move backup files to a storage disk. System Data Backup Best Practices (on
database export file and page 350)
system data backups.
Confirm scheduled tasks are Check C7, E5-400, E3-38 and E7 PM Viewing Scheduled Tasks (on page
successful and updated. download tasks, CMS database 345)
backups, inventory snapshots, and
Calix device database backups.
Monitor vital statistics on the Check UNIX or Linux CPU utilization
host and CMS servers. and check sever disk space.
Run custom reports Use the Search, Inventory, and PM Searches and Inventory Reports (on
(frequency determined by Report features. page 96)
company requirements).
C7 Performance Monitoring (on page
293)
Run business reports. Business Reports (on page 323)
Check the Calix Customer Review the current CMS service Log into My Calix (www.calix.com/my-
Resource Center. bulletins and quick tips. calix (https://www.calix.com/mycalix))
and browse the My Calix
Documentation Library.
Maintain the server file Clean up the C7 backup folder.
system.
Back up the server file system.
Verify adequate disk space is
allocated for database growth.
Run custom reports Use the Search, Inventory, and PM Searches and Inventory Reports (on
(frequency determined by Report features. page 96)
company requirements).
C7 Performance Monitoring (on page
293)
Run business reports. Business Reports (on page 323)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 3
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
38
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
39
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
40
1. Open CMS Web (on page 38). If the CMS Home page opens, the CMS server is
operating.
2. The CMS Home window displays the following server information:
CMS Build version
CMS Desktop (EWI) access port number
TL1 access port number
HTTP access port number
HTTPS access port number
Database type and version
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
41
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
42
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
43
Note: To upgrade the CMS GUI application, you may need to run the CMS GUI with the
administrator privilege.
1. Launch CMS Desktop and log on to a server that has a more recent version of CMS.
2. When prompted to upgrade the CMS client, click Yes. The client upgrades and re-
launches.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
44
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
45
1. From the Windows Start menu, click Programs > Calix > Start CMS.
2. At the Login screen, do the following:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
46
c. Expand the security domain and Administrators user group, and then click the
rootgod user account.
d. Click Action > Change Password. The Change User Password dialog box opens.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
47
To avoid a discrepancy between the time displayed in CMS Desktop and the host server
time:
After a simple date and time change on the host server, close and restart any active CMS
Desktop sessions.
After a time zone change on the host server, your CMS administrator must close and
restart the CMS server software on the server used to host CMS. Then close and restart
any active CMS Desktop sessions.
The next time you open CMS Desktop, the host server time displays in the status bar.
Note: A change in date and time (particularly, moving the date and time backwards) can
potentially restart CMS scheduled tasks that have already completed or are in progress.
Before making a date and time change on the host server, check the start times and statuses
of your scheduled tasks to understand any potential impact (on the Navigation Tree in CMS
Desktop, click CMS, and in the Work Area, click System > Scheduled Tasks).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
48
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 4
Security Management
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
50
The northbound and southbound interfaces may or may not run in the same mode. For
example, the CMS southbound interface could run on an unprotected LAN while the
northbound interfaces run on a protected LAN. In this mode, the northbound interfaces
could communicate with the protected LAN to OSSs that do not support secure interfaces,
while the southbound interfaces can talk securely over an unprotected LAN.
By default, SSH communication is always available from the CMS client to the CMS server,
regardless of security mode of the server. However, when you enable the secure mode, CMS
disables and drops all insecure (non-SSH) interface connections.
The SSH transport for CMS client communication is mostly transparent for CMS users. CMS
Desktop embeds the SSH connection libraries; therefore, it requires no additional client
software to run the application in secure mode. CMS TL1 users must use an SSH client
instead of a Telnet application.
The CMS server host is a standard Solaris or Linux workstation with network connectivity,
and therefore is accessible to any remote client running UNIX services on that host machine.
The UNIX system administrator has these responsibilities:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
51
The CMS server always adopts the security mode of the Calix node it connects with.
Therefore the icon can change when switching between different C7 networks.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
52
RADIUS
This section shows you how to configure a Remote Authentication Dial-Up Service
(RADIUS) server for user login authentication of administrative access via a centralized user
database.
The remote access server (the client) passes user information to the RADIUS servers, and
then acts upon the response. RADIUS servers receive user connection requests, authenticate
the user, and then return all configuration information necessary for the client to deliver
service to the user. All communications between the client and server are encrypted using a
shared secret known to both the client and server, but not transmitted with the login.
Note: For additional security, CMS masks the shared secret. The shared secret cannot be
retrieved, even by the administrator.
You can configure a primary and secondary external radius server for redundancy. The
RADIUS administrator enters users into the RADIUS server database outside of CMS
applications and assigns them to existing CMS user groups. After a successful login, users are
granted their appropriate CMS access permissions by the RADIUS server.
Note: When RADIUS is enabled, but no RADIUS server is available, CMS reverts to local
authentication until one or more RADIUS servers become available.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
53
IP Interface The IP address of the primary RADIUS server. IPv4 format, Class A, B, or C
Address 1 Default: 0.0.0.0
IP Port 1 The port used for sending UDP packets to the Default: 1812
primary RADIUS server.
IP Interface The IP address of the secondary RADIUS server. IPv4 format, Class A, B, or C
Address 2 Default: 0.0.0.0
IP Port 2 The port used for sending UDP packets to the Default: 1812
secondary RADIUS server.
Timeout Number of seconds to wait for a response from the Integer from 3 to 30
RADIUS server before retransmitting or aborting.
Default: 8
Retries The number of times the client tries to access the Integer from 1 to 5
primary RADIUS server before it resubmits the
Default: 3
request to the secondary RADIUS server or aborts.
Secret The "shared secret" for CMS, the C7, and the From 1 to 63 ASCII characters.
RADIUS server. This string must match the string
configured in the RADIUS server.
4. (Optional) Enter the IP address and IP port number for the secondary RADIUS server.
5. Type the timeout value, retries value, and shared secret.
Note: To mask the shared secret, an asterisk (*) displays in the text box for each
character typed.
6. Click Apply.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
55
# Attribute for user group name – required, user group name must exist in CMS
ATTRIBUTE Calix-CMS-User-Group 220 string Calix
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
56
TACACS
CMS supports TACACS+ authentication for E7.
An external TACACS server can optionally replace the local authentication service provided
by CMS. Industry standard RADIUS authentication can be implemented to consolidate user
databases for login authentication. A TACACS server supports a Lightweight Directory
Access Protocol (LDAP) directory for persistence.
The remote access server (the client) passes user information to the TACACS servers, and
then acts upon the response. TACACS servers receive user connection requests, authenticate
the user, and then return all configuration information necessary for the client to deliver
service to the user. All communications between the client and server are encrypted using a
shared secret known to both the client and server, but not transmitted with the login.
Note: For additional security, CMS masks the shared secret. The shared secret cannot be
retrieved, even by the administrator.
You can configure a primary and secondary external radius server for redundancy. The
RADIUS administrator enters users into the RADIUS server database outside of CMS
applications and assigns them to existing CMS user groups. After a successful login, users are
granted their appropriate CMS access permissions by the RADIUS server.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
57
IP Interface The IP address of the primary TACACS server. IPv4 format, Class A, B, or C
Address 1 Default: 0.0.0.0
IP Port 1 The port used for sending TCP or UDP packets to Default: 49
the primary TACACS server.
IP Interface The IP address of the secondary TACACS server. IPv4 format, Class A, B, or C
Address 2 Default: 0.0.0.0
IP Port 2 The port used for sending TCP or UDP packets to Default: 1812
the secondary TACACS server.
Timeout Number of seconds to wait for a response from the Integer from 1 to 30
TACACS server before retransmitting or aborting.
Default: 5
Retries The number of times the client tries to access the Integer from 1 to 5
primary TACACS server before it resubmits the
Default: 3
request to the secondary RADIUS server or aborts.
Secret The "shared secret" for CMS, the E7, and the Text string of 16–63 characters,
TACACS server. This mandatory parameter is used including spaces.
to encrypt/decrypt the messages between the E7
Note: The system does not
and TACACS server. This string must match the
support the following special
string configured in the TACACS server.
character: !
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
58
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
59
Note: The ACL does not limit access from the local host. You can always access services
directly by launching CMS Desktop, Web, or TL1 interfaces directly from the CMS server
machine. If needed, install CMS Desktop on the CMS server for direct access.
Configuring the CMS access control list requires Full CMS Security privileges.
You cannot modify entries in the ACL. You must delete existing entries and configure new
ones. Deleting entries in the CMS access control list requires Full CMS Security privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
60
Note: Switching security modes causes a momentary loss of connectivity to CMS Desktop
and Web users that may or may not be noticeable to the user.
1. On the Navigation Tree, click the Network.
2. In the Work Area, click Security > Global to view the C7 global security settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
61
3. In the Only Connect via Secure Shell (SSH) list select Y for a secure connection or N for
an unsecure connection.
4. Click Apply, and then click OK to save the new settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
62
For example: one user group focuses on provisioning services, another on monitoring the
health and stability of the network, while another focuses on collecting and analyzing
performance data.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
63
Topological: Includes access to the regions, networks, and network elements visible on
the Navigation Tree in CMS.
Functional: Includes access to the functions of CMS and the C7 networks that are
connected to CMS.
Topological and functional privileges work together. For example, you might have a group
responsible for user permissions (security) in Ohio. Or you could set up a user group to
access only subscriber (ADSL) services in New Jersey, thereby preventing users in the group
from accessing other services and networks.
Sample Views
The following screenshots demonstrate how different access privileges determine which
functional areas of CMS a user can view. All screens show the same network.
Administrator view
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
64
Note: For users to view the Navigation Tree and Alarm Table in CMS Desktop, the CMS
Administration privilege must be set to Min or Full.
The Fault Only view shows all alarm, event, threshold events, and configuration information.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
65
The Configuration Only view shows configuration information. Note that the alarm table
and status monitor are not visible.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
66
The Performance Only view shows performance and configuration information. Note that
the alarm table and status monitor are not visible.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
67
The Security Only view shows user and user group information. Note that the alarm table
and status monitor are not visible.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
68
Functional Privileges
Assign one of three access levels for each user group to each of four functional categories.
CMS access levels are:
Full (read/write)
Minimum (read only)
None
The following table shows CMS and Calix-network element functional categories. For C7
categories, the column on the right shows the equivalent C7 iMS security categories.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
69
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
70
B6 Web B6 Guest: Capable of viewing all information with the exception N/A
of invasive tests, such as MLT or DSL testing.
Security
B6 Privileged: Capable of viewing all information, including
invasive tests such as MLT or DSL testing.
B6 Administrator: Capable of viewing and configuration all
information.
Example Explanation
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
71
Example Explanation
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
72
To match the security privileges shown above, in the Work Area in CMS, use the following
settings:
Under Users > Functional > C7 Security:
Set C7 User to MIN.
Set C7 Testing to FULL.
Set C7 System to MIN.
Under Users > Functional > C7 Maintenance, set all services to FULL.
Under Users > Functional > C7 Provisioning, set all services to FULL.
In the table columns, R/W indicates Read Write, and R indicates Read only.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
73
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
74
The Navigation Tree in CMS contains a root (parent) region for the regions and networks
created in CMS. CMS has the following topological privileges:
When you edit a user group privilege, you can grant the group more privileges or restrict
existing ones. When set the maximum available privilege, the shape on the right appears
hollow to show that it inherits the maximum privilege from the parent level.
Note: You cannot set the permission (write, read, or no access) for logical ports such as GR-
303, GR-8, IMA, or Pseudo Ports (PPs). To customize permission for these entities, use the
shelf level in the topology tree.
Example Explanation
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
75
Example Explanation
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
76
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
77
c. To set privileges at a lower level in the permission tree, expand the root region and
any region under it, and then right-click a region or network and select a permission
level.
Note: When you first set up CMS, no regions and networks are defined. You can
customize user group privileges for individual regions and networks after you create
them.
d. Click Apply, and then click OK to save the settings.
Note: If the user group does not appear on screen right away, click Action > Refresh
Security Tree to refresh the Work Area.
Related topics
Functional Privileges (on page 68)
Topological Privileges (CMS) (on page 74)
Note: User names with the prefix USR will display improperly. Calix does not
recommend using the USR prefix for user names.
b. In the Password and Retype Password boxes, type a password.
Note: User account passwords are case-sensitive. The required password length and
minimum number of numeric and special characters are determined by the CMS security
settings (on page 86) set by your CMS system administrator. Special characters are as
follows: @.#$%{}!_?-
c. (Optional) Type information in the remaining boxes or change the values in the
remaining lists.
Tip: If the new user does not display on screen, click Action > Refresh Security Tree.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
80
Viewing user group privileges requires Min (Minimum) CMS Security privileges. Modifying
user group privileges requires Full CMS Security privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
81
User Name User ID for logging in to CMS. To change a user name, you must delete the user
and create a new one.
User Group* Defined user group to which the user belongs. If you move the user to a different
user group, the user inherits the privileges of the new user group.
First and Last Name* Optional contact information fields.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
82
Parameter Description
Timeout? (Timeout Determines whether the user session will time out after the specified period of
Enabled)* inactivity (Y = time out enabled; N = user session will not time out). Default value
is Y (Yes). See also the description for the Session Timeout parameter in
Modifying the Default CMS Security Settings (on page 86).
Password Expiring In Displays how many days are left before the user password will expire. When a
new user is created, the number of days until password expiration is equal to the
Password Aging Interval (see Modifying the Default CMS Security Settings (on
page 86)).
* Indicates that the parameter that can be modified.
Viewing user details requires Min (Minimum) CMS Security privileges. Editing user settings
requires Full CMS Security privileges.
Related topics
Viewing and Editing CMS User Group Privileges (on page 80)
Alarm E-Mail Notification (on page 283)
Note: After exceeding the maximum number of invalid login attempts, a user is locked out.
The lockout clears 20 minutes after the last invalid login attempt.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
83
1. On the Tools menu, click Change Own Password. The Change User Password dialog
box opens.
2. In the Change User Password dialog box, type the old password, and then type and
retype a new password.
Note: User passwords are case-sensitive character strings from 8 through 11 characters
that must contain at least two non-alphanumeric and one special character. Special
characters are between the following brackets [@.#$%{}!_?-].
3. Click OK.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
84
Note: If a user exceeds the number of Maximum Invalid Login Attempts, rather than
completing the procedure to allow user access to CMS, Calix recommends changing the user
password.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
85
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
86
Note: Modifying these settings will not affect users in the Administrator group. See Default
CMS User Groups (CMS) (on page 62).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
87
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
88
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
89
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 5
Configuration Management
This section covers the following topics:
Managing CMS Desktop regions and network groups
Searches and inventory reports
Managing E7 OS Nodes
Managing AXOS Networks
Managing Calix AE ONTs
Managing Calix B6 cards
Managing Calix C7 networks
Managing Calix E3 and E5-100 nodes
Managing Actelis devices
Displaying non-Calix devices
CMS database synchronization
Customizing the default CMS security and archive settings
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
92
1. On the Navigation Tree, click the parent region under which to place the new region or
network group. You can click the root region, or expand the root region and click an
existing region as the parent.
2. From the CMS Region or Map View Work Area:
Click Create > Region to create a region.
Click Create > Network Group to create a network group.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
93
3. In the New Region or New Network Group Name box, do the following:
a. Type a name for the region or network group.
Note: Names can contain alphanumeric characters, underscores, and spaces.
b. In the Parent Region list, select the parent region for the new region or network
group.
c. Click OK.
4. (Optional) In the Work Area, you can move the new region or network group icon by
clicking and dragging it.
Network elements within the network group and any topology links created between these
elements display in graphic view. Each network element is identified by name and a unique
icon for the device type.
Viewing and customizing a Network Group topology requires Read permissions for the
region that the Network Group is under as well as for the networks associated with that
Network Group.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
94
Before creating a graphical link, you must add the devices to a network group.
Creating a graphical link between devices requires Full CMS Administration privileges.
1. On the Navigation Tree, select the Network Group that contains the devices.
2. In the Topology Work Area, locate the task list to the right of the zoom ratio list. Select
Topology Links.
3. Click on a starting node, and then click on another node to terminate the link.
4. In the Topology Links dialog box, do the following:
In the From Endpoint and To Endpoint areas, specify the ports on the devices you
are creating a link from and to.
Click Add to move the endpoints to the Topology Links to be Created area.
Optionally, in the Link Type, Description, and Bandwidth fields, type the
information to be associated with the link.
At the bottom of the dialog box, click Create.
5. Click OK to confirm the action.
In the Topology and Map View Work Areas, a blue link displays between the two
devices.
Tip: Hover the mouse over the new link to display topology link information in a
Tooltip.
1. On the Navigation Tree, select the Network Group that contains the devices.
2. In the Work Area tabs, click Topology Links.
3. In the Toolbar, click Create.
4. In the Links table, do the following:
In the From Endpoint and To Endpoint areas, specify the Calix devices you are
creating a link from and to:
For C7 networks, select the network, shelf, facility, and port.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
95
For other Calix nodes, select the node in the Network field, and type a port in the
Facility field.
Click Add to move the endpoints to the Links to be Created area.
Optionally, in the Link Type, Description, and Bandwidth fields, type the
information to be associated with the link.
At the bottom of the dialog box, click Create.
5. Click OK to confirm the action.
In the Topology and Map View Work Areas, a blue link displays between the two
devices.
Tip: Hover the mouse over the new link to display the topology information in a
Tooltip.
1. On the Navigation Tree, select a Network Group with a link between devices.
2. In the Work Area, click Topology Links. In the link list, select one or more links to
delete.
3. Click Delete.
If there are two or more links, a list displays where you can select the links to be deleted.
Click OK.
4. In the Confirmation dialog box, click OK to confirm the deletion.
Modifying the parent region or network group requires Full CMS Administration privileges.
Note: The root region under the CMS level on the Navigation Tree cannot be moved.
For example:
Search for a subscriber ID or IP/MAC host across Calix ONTs and platforms.*
Select a C7 shelf, and view all ADSL ports on that shelf.
View all C7 networks or E3/E5-100 service units that are in-service.
Find a specific AE ONT based on the registration ID or FSAN serial number.
* The Subscriber Search pane opens when you launch CMS Desktop.
From the Navigation Tree, you can also search for ranges of E7 VLANs and specific
attributes of GPON and AE ONTs.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
98
MAC table
Card
ONTs
ONT services (data/video, SIP, TDM gateway, T1 PWE3,
IH.248)
Ethernet OAM
F-Series F5 ONTs
F5 nodes
F5 system searches
F5 notes and splitter searches
Region CMS regions and network groups
* Search only available in CMS Web.
Additional topics
Advanced search options (on page 104)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
99
The IP/MAC search retrieves data from Calix AE ONT, C7, E3/E5-100, E7 network
elements related to subscriber equipment devices downstream from ONT Ethernet
interfaces.
Partial matches (equivalent to a "contains" match) are acceptable search strings.
Note: The Subscriber Search pane displays in the Work Area when you launch CMS
Desktop. Step 1 below is only required if you are currently viewing the administrative and
configuration Work Area menus in CMS Desktop.
1. (Optional) To return to the results of a previous search, in the drop-down list to the right
of the Last Search link, select Subscriber or IP/MAC, depending on the search type you
are looking up.
At the top of the screen, click the Last Search link. (Alternatively, in the status bar at the
bottom of the CMS Desktop screen, click the magnifying glass icon, or on the Tools
menu, click Subscriber Search.)
2. In the Subscriber box, enter the information on which to perform the search:
Enter all or part of a subscriber ID or AID. Include any characters, such as dashes, as
used in the subscriber record or AID. For example:
7072936500
Enter the network name, followed by a colon (:) to search for all ports on an E-series
node or C7 network whose name contains the entered name. For example:
c762:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
100
Enter the network, followed by a colon (:), and then the node AID to search for only
the ports whose network name contains the entered name and AID string. For
example:
c762:N1-1-1
Enter a MAC address or IP Host address.
3. Execute the search:
Click Subscriber to view the results of a search based on subscriber information.
Click IP/MAC to view the results of a search based on an IP host or MAC address.
4. Click the subscriber ID hyperlink to view the Services screen for the port or ONT.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
101
1. Do one of the following, depending on whether you have CMS Desktop or CMS Web
open:
(CMS Desktop) On the Tools menu, click Web Site Map. Alternatively, click Tools
> Search (menu options with right-pointing triangles have submenus).
(CMS Web) Open CMS Web (on page 38). At the top of the page, click Site Map.
Alternatively, in the Module list on the left, click Configuration (menu options with
right-pointing triangles have submenus).
2. Click the type of search.
An inventory screen opens where you set the filter criteria, sort criteria, and report
parameters. If a search or query template (on page 113) has been previously saved, you can
apply it.
Optionally, set one or more of the report parameters described in Steps 3 through 7.
3. Define topology filters. Under Filter Criteria, click the arrow to the right of an available
topology list.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
102
The Region list includes both regions and network groups. To only search network
groups in the search report, select the Network Groups check box the right of the
Network list.
To only search synchronized networks in the search report, select the Synchronized
Networks check box the right of the Network list.
4. To define additional filters, click the arrow to the right of Additional Criteria to view
the available element filters:
In most cases you specify a match option (Equals, Contains, Not Equals, Starts With,
or Ends With) and then type a text string in the box to the right. Optionally, select
the Case Sensitive check box to only return results matching the case you used). For
example, in a node inventory query, to return all nodes named N1, set the AID
criterion list to Equals and type n1 (N1 with the Case Sensitive check box selected)
in the box.
SID indicates the System ID or node name. Type all or part of a node name.
For card and port inventory queries, you can filter based on service states and card
types. Service states have a Not check box option for searching all inventory that is
not in the selected state(s). For example, you can set up a card query to only return
ADSL-24 cards that are not out-of-service.
Note: Selecting more than one service state includes the cards or ports that match all of
the selected states. Selecting more than one card type includes any of the selected types.
5. Specify how to sort the search report. Click the arrow to the right of Sort Criteria, and
then do the following:
a. In the Column Name list, click the filter to use as the primary sort.
b. In the Sort Order list, click Ascending or Descending to specify the sort order.
c. Click More to list a secondary sort criterion, and then repeat Steps 5a and 5b.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
103
6. Change the default report output options. Click the arrow to the right of Report
Parameters. You have these options:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
104
Save the results displayed on the current screen in CSV format. Above the report
results, click CSV Export. The Downloading dialog box opens with options to open
the search results directly in your default spreadsheet application, or save the file to
your local hard drive.
Save the search or inventory query as a template (on page 112).
Use advanced search options (on page 104) to customize the columns displayed in the
report and the sort order, as well as set further filter criteria. Click Advanced.
Note: When using advanced search options, unless you change it, the settings are stored for
a specific query for the duration of the current user session.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
105
Display:
Hide or show column(s): Select one or more items in the Visible Columns list and
click the left arrow to hide them, or select elements in the Choose Columns list and
click the right arrow to add them to the report. Use the double arrow buttons to hide
or add all items.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
106
Change the order in which report elements display in the report: Select an element in
the Visible Columns list. Click Up or Down to move the element to a new location
in the list.
Sort: Report elements that you can use as sort criteria display in the Choose Columns list.
If you do not add any sort criteria, the results are sorted by the topology elements on the
main Search, Inventory, or PM Query page.
Add an element to the sort criteria: Select an element in the Choose Columns list.
Click the right arrow to add it to the Sorting Columns list. Repeat to add a secondary
sort, and to add additional nested sort criteria.
Change the sort priority: If you have added more than one sort criterion to the
Sorting Columns list, select an element in the list and click Up or Down to move it
to a new priority order.
Change the sort order for a selected element: By default, elements selected for sorting
sort in ascending order. To change to descending order (or back to ascending order),
select the element in the Sorting Columns list and click Asc/Desc. The arrow
indicator to the left of the element name changes to show the sort order.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
107
Select a condition and click Edit to modify its criterion. The Add button is
disabled and the Update button is enabled. Click Update to use the modified
criterion.
3. At the bottom of the screen:
Click Submit to generate the report with the customization settings you have
specified. (For PM queries, the main Search screen opens.)
Click Apply to save the customization settings and open the Display tab.
Click Reset to clear the customization settings from the current tab.
Click Cancel to return to the main Search screen.
4. In the Search or Inventory report screen, you have several options:
Scroll through the search report using Next, Last, First, and Prev above the search
report.
Return to the Search screen and modify the criteria. Above the report buttons, click
Back.
Change the parameters on screen to display those from a different tab for searches
where more than one CMS Work Area tab displays above the search results. The
currently-selected tab displays largest.
In the report table, for one of the lines in the search report:
Open a Table View by clicking the Row # hyperlink.
(In CMS Desktop only) Jump to the Work Area by clicking an ID hyperlink.
Note: After clicking an ID hyperlink, you cannot return to the search report without
regenerating the report.
Save the results displayed on the current screen only in CSV format. Above the
report results, click CSV Export. The Downloading dialog box opens with options
to open the search results directly in your default spreadsheet application, or save the
file open to a location on your PC or workstation.
Save the search or inventory query as a template (on page 112).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
109
Form view
In the HTML format view in the browser, you can view details of a selected row in a single-
screen form layout.
Tip: Hover the mouse pointer over a column header to open a pop-up window with a
description of the column contents.
Click the row number on the left side of the report table.
The form view displays with details of that row. Note that individual field description
titles display in abbreviated format in the table view, and in full format in the form view.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
110
1. From the top of the report table, click Bandwidth. The bandwidth view displays in table
view.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
111
2. To view bandwidth statistics in form view, click the row number on the left side of the
bandwidth report.
The form view displays with details of that row. Note that individual field description
titles display in abbreviated format in the table view, and in full format in the form view.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
112
Viewing and applying templates requires Minimum (Min) CMS Administration privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
113
The search results using the criteria of the selected template display on screen.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
114
3. Select the inventory or PM query template to modify. The template loads the saved
configuration and "(Currently Selected)" displays to the right of the selected template.
4. Modify the template as needed.
5. Click Submit.
To save the template with the same name, click Save Template.
To save the template with a different name, click Save Template As. In the
Template Name box, type a name for the new template.
6. Click OK.
Deleting a search or query template requires Minimum (Min) CMS Administration privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
115
Basic Search
You can use the basic search tool to locate regions, networks, facilities, and nodes on the
Navigation Tree. This is useful for provisioning service or troubleshooting based on alarm
indications. The search tool returns a list of all items searched for that are available to the
CMS server.
1. On the Tools menu, select Search, and then select Region or a Calix product and the
characteristic of the product to filter the search.
2. Click Submit to start the filtered search.
3. In the Configuration results screen, double-click the row to open its details in the Work
Area.
4. If Region or C-Series Network was the search target, do one of the following:
Double-click a region to navigate its Region view.
Double-click a C7 network to navigate to its Network view.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
116
For ERPS or LAG domains, once the domain has been defined and after creating static
links between nodes, in the Ethernet Topology Tool you can add and enable VLAN(s)
from the network element interface work area or from the static links; each network
element lists all non-ONT Ethernet interfaces.
If two C7 shelves are connected through ATM links, create a VLAN on both shelves
using the Provision Ethernet Topology tool. Then, outside the Provision Ethernet
Topology tool, create an STS cross-connect binding two Virtual Bridges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
119
4. In the tool's graphical (upper) work area, select Navigate from the tool mode list, then
do the following:
a. Arrange the node icons by clicking and dragging them into position, as required.
b. (Optional) To change the default Virtual Bridge on a C7 shelf, right-click the C7 and
in the Default VB list, select a Virtual Bridge ID to use for the VLAN provisioning.
c. Click Apply, if you made changes.
d. Select VLAN from the tool mode list.
e. In the drop-down list that appears to the right, do one of the following:
Select an existing VLAN from the list.
To search for an existing VLAN, select Search for VLAN. In the Search VLAN
dialog box that displays, enter the VLAN ID, and then click OK.
To create a new VLAN, select New VLAN. In the New VLAN dialog box that
displays, enter the VLAN ID, and then click OK.
Note: For VLAN per Port mode to support a single-tagged model, create a VLAN for
each subscriber-side port; to support a double-tagged model, create one service VLAN to
serve as the "trunk" VLAN.
f. Click the icon for each node on which to add the VLAN.
5. In the tool's table (lower) work area, click the VLAN-node listing in the table, and then
define the settings.
For C7, click the APP MODE (Application Mode) column to define a forwarding
mode of VLAN per Service or VLAN per Port, according to your application
requirements.
For E-Series systems, refer to the appropriate user guide for parameter setting details.
6. In the tool's graphical (upper) area, click each icon again to select the group or Ethernet
port(s) to add to the VLAN.
Note: To configure a protected Ethernet link, create a VLAN interface for another
Ethernet port in the same bridge.
7. In the tool's table (lower) work area, click the VLAN-IF tab and then click each node on
the tool bar to define the VLAN interface parameters.
For C7, define the following parameters:
Set the Port Type as Trunk. Or, if the port must perform any tag actions, set the
Port Type to Edge.
To configure a protected Ethernet link, set STP to 1D Addr when the C7 is
connected to an 802.1d compliant switch with redundant links, or 1AD Addr
when the C7 is connected to an 802.1ad compliant switch with redundant link.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
120
To create a CVID Action, in the bottom work area, select the tag number or
whether it is untagged, and then click Create. Click the new table entry, and then
define the CVID action attributes.
For E-Series system VLAN interfaces, add Ethernet ports (and/or link aggregation
groups or EAPS domain, as required) to the VLAN membership. Refer to the
appropriate user guides for setting details.
Set the Interface Role as Trunk. Or, if the port must perform any tag actions, set
the Interface Role to Edge.
To create a tag action on the Edge interface, click Create in the bottom work
area, click on the new table entry, and then define the tag action attributes.
8. Click Apply to apply all new provisioning updates. In the confirmation dialog box, click
OK.
Note: This tool is used exclusively for Ethernet topologies and does not provision video
over ATM/SONET on the C7 OC transport.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
121
To create a new VLAN, select New VLAN. In the New VLAN dialog box that
displays, enter the VLAN ID, and then click OK.
f. Click the icon for each node on which to add the VLAN.
5. In the tool's table (lower) work area, click the VLAN-node listing in the table, and then
configure as appropriate for the node:
For C7, click the APP MODE (Application Mode) column to define the forwarding
mode to use as Application Mode = Routed.
For E-Series systems, refer to the appropriate user guides for settings details.
Note: If IGMP proxy mode will be configured, the VLAN ID must match the video
VLAN Tag parameter (at the Network level, click Video > Provisioning to view this
parameter).
6. In the tool's graphical (upper) area, click each icon again to select the group or Ethernet
port(s) to add to the VLAN. Click Edit to open the VLAN-IF tab.
Note: To configure a protected Ethernet link, create a VLAN interface for another
Ethernet port in the same bridge.
7. In the tool's table (lower) work area, click the VLAN-IF tab and then click each node on
the tool bar to define the VLAN interface parameters.
For C7, define the following parameters:
Set the Port Type as Trunk. Or, if the port must perform any tag actions, set the
Port Type to Edge.
To configure a protected Ethernet link, set STP to 1D Addr when the C7 is
connected to an 802.1d compliant switch with redundant links, or 1AD Addr
when the C7 is connected to an 802.1ad compliant switch with redundant link.
To create a CVID Action, in the bottom work area, select the tag number or
whether it is untagged, and then click Create. Click the new table entry, and then
define the CVID action attributes.
For E-Series system VLAN interfaces, add Ethernet ports (and/or link aggregation
groups or EAPS domain, as required) to the VLAN membership. Refer to the
appropriate user guides for setting details.
Set the Port Type as Trunk. Or, if the port must perform any tag actions, set the
Port Type to Edge.
To create a tag action on the Edge interface, click Create in the bottom work
area, click on the new table entry, and then define the tag action attributes.
8. Click Apply to apply all new provisioning updates. In the confirmation dialog box, click
OK.
9. If you require more than one VLAN for other uplink applications (for example, to
separate traffic for different ISPs), repeat steps 5, 6, 7 and 8 to create additional VLANs.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
122
10. In the tool's graphical (upper) work area, right-click the C7 that has the uplink card to
associate a virtual router's IP interface to the active VLAN, select Associate IP-IF Port,
and then do one of the following:
Select an IP interface that exists on one of the listed virtual routers.
To create an IP interface, select New, define the IP address, netmask, and then click
OK.
11. In the tool's table (lower) work area, do the following:
a. Set the DHCP Relay Enable to Y (Yes).
b. Click Apply to apply all new provisioning updates. In the confirmation dialog box,
click OK.
12. In the tool's graphical (upper) work area, right-click the C7 that has the uplink card to
create a default route to the upstream (gateway) router, select Modify IP Routes, and
then do one of the following:
Hover over an IP interface that exists on a virtual router and select from the routes
displayed.
To create a default route, select New, define the IP address of 0.0.0.0, the netmask of
0.0.0.0, the upstream router IP address as the gateway address, and then click OK.
Note: The gateway IP address must belong to the same subnet as the uplink virtual
router IP interface.
13. To create at least one additional static IP route to the STB-side subnet of the IRC, do the
following:
a. Right-click the C7 that has the uplink card, select Modify IP Routes, select New
from the virtual router.
b. Define the destination network IP address, the destination subnet mask, the next-hop
IP address (the next router interface in the path to the destination network), and then
click OK.
Note: To enable forwarding to other external subnets, create additional static IP routes
as needed (if there are multiple STB subnets).
14. Click Apply to apply all new provisioning updates. In the confirmation dialog box, click
OK.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
123
Note: This tool is used exclusively for Ethernet topologies and does not provision TDM
voice transport applications on the C7.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
124
6. In the tool's graphical (upper) area, click each icon again to select the group or Ethernet
port(s) to add to the VLAN.
7. In the tool's table (lower) area, click the VLAN-IF tab and then click each node on the
tool bar to define the VLAN interface parameters.
For C7, define the following parameters:
Set the Port Type to Trunk. Or, if the port must perform any tag actions, set the
Port Type to Edge. (For Edge ports, you must also create a CVID Reg entry to
define how the port will handle tag translations.)
Set ARP Learning to Y for H.248/routed VLAN applications.
Set DHCP Directionality to None or Server for ONT SIP applications, as
required.
Set DOS Protection to N.
Set VB Port Direction to Both (Unsecure).
Set S-Tag Type to match the EtherType stamping setting at the far end of the
link.
To support RSTP on the Ethernet link, complete the additional steps below.
Otherwise, set the STP to OFF to disable RSTP.
Set the RSTP/spanning tree mode to match the far end switch (1D Addr or 1AD
Addr).
Set the STP priority value or leave the box blank to accept the default.
For E-Series system VLAN interfaces, add Ethernet ports and link aggregation
groups or EAPS domain, as required, to the VLAN membership. Refer to the
appropriate user guides for setting details.
8. Click Apply to apply all new provisioning updates. In the confirmation dialog box, click
OK.
9. If you require more than one VLAN for other uplink applications (for example, to
separate traffic for different ISPs), repeat steps 5, 6, 7 and 8 to create additional VLANs.
10. In the tool's graphical (upper) work area, right-click the C7 that has the uplink card to
associate a virtual router's IP interface to the active VLAN, select Associate IP-IF Port,
and then do one of the following:
Select an IP interface that exists on one of the listed virtual routers.
To create an IP interface, select New, define the IP address, netmask, and then click
OK.
11. In the tool's table (lower) work area, do the following:
a. Set the DHCP Relay Enable to Y (Yes).
b. Click Apply to apply all new provisioning updates. In the confirmation dialog box,
click OK.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
125
12. In the tool's graphical (upper) work area, right-click the C7 that has the uplink card to
create a default route to the upstream (gateway) router, select Modify IP Routes, and
then do one of the following:
Hover over an IP interface that exists on a virtual router and select from the routes
displayed.
To create a default route, select New, define the IP address of 0.0.0.0, the netmask of
0.0.0.0, the upstream router IP address as the gateway address, and then click OK.
Note: The gateway IP address must belong to the same subnet as the uplink virtual
router IP interface.
13. Click Apply to apply all new provisioning updates. In the confirmation dialog box, click
OK.
Configure the virtual router to support IP addressing for SIP hosts using one of the
following methods:
DHCP relay: To use DHCP relay to provide IP addresses to ONT SIP hosts, create a
DHCP server connection on the uplink virtual router.
Static hosts: To use static IP addresses for ONT SIP hosts, create static IP hosts on the
uplink virtual router's IP host table.
Configuration guidelines
For data uplinks, you must create an uplink AID.
For unicast video uplinks, you must create an uplink AID.
(Multiprotocol video) For video uplinks that provide service to subscribers on ADSL2-
based cards, you must also create an uplink AID. This will identify the EPG channel
source for a shelf (selected under 'EPG Src Address' in CMS subscriber activation tools).
For shelves with video ingress via an Ethernet uplink, create an uplink ID with
Uplink Type = VLAN.
For remote shelves with video ingress via SONET transport, create an uplink ID
with Uplink Type = OC Card.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
126
9. Click OK to add the OC card to the uplink list for CMS subscriber activation tools.
Note: In CMS versions 11.1.365 and lower, uplink AIDs for the EPG source could be
created by selecting an STS facility on an OCn card. For subscriber ports originally
provisioned with CMS versions lower than 11.1.365, uplink AIDs that specify STS
facilities may remain in effect and continue to appear in CMS subscriber activation tools
as the EPG source. However, new subscribers cannot be provisioned with such uplink
AIDs. Instead, uplink AIDs that specify an OCn card, not an STS facility, must be
created and used for the EPG source.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
128
This topic describes how to create a TDM Gateway Service Group that defines the C7
network and interface groups used for delivering the TDM Gateway service, allowing CMS
to automatically create and validate C7 gateway cross-connects.
Parameters
You can provision the following parameters for TDM Gateway service groups:
Parameter Description Valid Options
ID* Index of the TDM Gateway service group. Any value between 1-1000, inclusively.
Description Unique name that indicates the entire description of the String text
C7 network and Calix C7 gateway interface group used
If left blank, the system automatically
for this TDM service group. This value is auto-filled once enters the combination of names for the
the network name and interface groups are selected.
selected C7 network and interface groups.
C7 Network Name* Name of the C7 network where the interface groups have Any available configured C7 network
been created for C7 TDM gateway. where the required interface groups exist.
GR303/GR8 IG* GR-303/GR-8 Interface Group (IG) for CMS to use for Any available GR-303/GR-8 IG that is
automatically creating the cross-connects. established on the selected C7 Network.
SIPVCG IG* SIP Voice Concentration Group Interface Group (IG) for Any available SIP VCG IG that is
CMS to use for automatically creating the cross-connects. established on the selected C7 Network.
OSMINE-Compliant Northbound Interface use only
Parameters applicable for E7 GPON and xDSL ports when the OSMINE-compliant Northbound Interface has been installed with
CMS. If you are defining end-to-end E7 TDM voice service provisioning, enter the applicable information in the fields.
Enabled Whether the service group is enabled for use. (default)
Y = enabled, N = disabled
*Required field
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
129
Managing E7 OS Nodes
CMS support for Calix E7, E3-48C, E5-48/C and E5-400 platforms includes the following
features:
Organize E7, E3-48C, E5-48/C and E5-400 platforms in CMS network groups.
View and manage alarms in the CMS Alarm Table and perform historical queries of
alarms. See Fault Management (on page 257).
Add E-Series system nodes in CMS.
Search in the CMS database based on user-defined criteria. See Searches and Inventory
Reports (on page 96).
Open a cut-through Telnet session. See Using the Cut-Through Telnet or Web Interface (on
page 151).
For E7 system nodes, create global profiles and subscriber templates that can be shared
with the AE ONT services. See the Calix E-Series Turn-Up and Transfer Guide and Calix E-
Series GPON Applications Guide.
For E7 system nodes, use the Services screen to activate voice, data, and video subscriber
services. See the publication, Calix E-Series Applications Guide.
For configuration and other details, see the Calix E-Series user documentation.
Optionally, you can create a graphical link from another Calix network element, such as a C7
shelf, and view the link in Topology view.
You can provision the following parameters when adding an E7 OS node to CMS:
Parameter Description Valid Options
Netconf Port* The Netconf port to use for the node. 830 (default)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
130
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
131
Note: Default SNMP and network login settings are defined in the Systems Settings Work
Area.
1. On the Navigation Tree, select a network group.
2. Click Network Details > <E7 OS Type>.
3. From the menu, click Create.
Note: You must be in the Topology, Map View, or Network Details Work Area to create
a node.
4. In the New dialog box, reference the table above to provision the parameters.
5. At the bottom of the New Node dialog box, click OK to create the node.
6. (Optional) In the network group Topology Work Area, move the new node icon by
clicking and dragging it.
7. (Optional) Create a graphical link to view the device in a network topology.
Once the node has been added in CMS, if you have not already done so, set the SNMP trap
destination on the node using the System Turn Up screen. You can use CMS to access the
Web cut-through for the device.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
132
Display Name The name that displays next to the unit on the Navigation Tree.
Network Group* The parent network group under which the unit is nested on the Navigation Tree.
Connection State The current unit connection status (Connected, Connecting, Diagnosing,
Disconnected, Dynamic Synchronizing, Partially Connected, Secure Connecting,
Synchronized, Synchronizing, or Unknown).
IP Address* The IP address of the node.
SNMP Version Support The SNMP version used for this device.
SNMP Inform* Specifies whether the message type of outgoing messages is "INFORM."
Otherwise, the message type is "TRAP."
INFORM messages carry the same data as TRAPs, but are acknowledged by the
recipient or otherwise resent until they are acknowledged (5 retries, 1 second
timeout).
N (No = trap)
Y (Yes = inform)
HTTP Port* The port to use for a nonsecure connection.
Default=80
HTTPS Port* The port to use for a secure connection.
Default=443
Device Type* E7, E3-48C, E5-48/C and E5-400
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
133
Viewing and editing E7, E3-48C, E5-48/C or E5-400 details requires Full CMS
Administration privileges.
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > and the model name of the device.
3. To edit a parameter, do the following:
a. In the node list, single-click the row of the the device to edit.
b. In the Edit row, modify the editable parameters as needed.
c. Click Apply, and then click OK to save the new settings.
Deleting an E7, E3-48C, E5-48/C and E5-400 node requires Full CMS Administration
privileges.
Note: E7, E3-48C, E5-48/C and E5-400 nodes can be deleted in a synchronized or
unsynchronized (disconnected) connection state.
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > and the model name of the device.
3. In the node list, single-click the row of the the device to delete.
4. If the node displays as Connected in the Connection State column, do the following:
a. In the toolbar, click Action > Disconnect.
b. Click OK to confirm the action.
5. In the toolbar, click Delete, and then click OK to confirm the deletion.
Note: CMS uses an HTTP session to access the embedded Web interface for managing E-
Series platforms. If a CMS Desktop user session is open for more than 12 hours, the HTTP
session automatically times out. To re-access the Web interface, you must close and re-start
CMS Desktop.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
134
A TrapRegFailed alarm indicates node SNMP traps sent to the CMS server from the alarmed
Calix device are unsuccessful.
Recommended Action
1. In a terminal window or remote telnet or SSH session, log in as a root user on the host
server. Verify that the entries in the etc/hosts file are correct:
At the command prompt, type the following: cat /etc/hosts
Use a text editor to edit or add the CMS server static IP address and DNS name to
match the following example:
where 172.21.90.15 is the CMS server static IP address and cmsserver is the name of
the CMS server.
Note: Restarting the CMS Server is not required.
2. Do one of the following:
B6 node: Add the trap destination (in the B6 Web interface, click System > SNMP
Traps).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
135
E3/E5-100 node: Delete one of the trap destinations (in the Configurator interface,
click Advanced Applications > Access Control > SNMP).
E7, E3-48C, E5-48/E5-48C, E5-400 node: Add or update the trap destination (in the
E7 Web user interface, click Management > SNMP > TRAP Destination).
3. (For E-Series devices) Manually register CMS as a trap destination:
On the Navigation Tree, click the root region or the parent network group of the
node.
In the Work Area, click Network Details, and then click the node type.
In the device list, click the node(s).
Click Action > Register Trap.
4. If the above steps do not clear the alarm, delete and recreate the node in CMS.
You can manually disconnect a unit and reconnect it, for example, after troubleshooting a
connection issue.
1. On the Navigation Tree, click the parent network group of the unit.
2. In the Work Area, click Network Details, and then click the node type.
3. In the device list, select the unit(s).
4. Click Action > Disconnect or Connect.
To access and modify configuration settings, you must have Full Configuration Management
permission as well as Write permission for the region in which the parent network group is
nested.
Note: To change parameters of an existing service, first remove the service and then re-add
the service with new parameters, especially if using 3rd party provisioning equipment.
Once you have added a unit to CMS, on the Navigation Tree, expand the network group and
click the unit. Tabs for each configuration area display in the Work Area.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
136
Note: CMS uses an HTTP session to access the embedded Web interface for managing E-
Series platforms. If a CMS Desktop user session is open for more than 12 hours, the HTTP
session automatically times out. To re-access the Web interface, you must close and re-start
CMS Desktop.
For product information and provisioning instructions, log in to the Calix Resource Center and
follow the link to the Calix Documentation Library. In the navigation pane on the left, click
E-Series and locate the links to the Calix documentation.
Topics Covered
This chapter covers the following topics and tasks:
Searching for VLANs
Searching for E7 GPON ONTs
Searching for Configuration Aspects
Performing a Subscriber Search
From the Navigation Tree, CMS supports searches that filter on a range of VLANs for a
single E-Series unit.
The search tool returns a list of filtered VLANs that are available from the E-Series unit
selected in the Navigation Tree.
1. In the Navigation Tree, select the node to expand it, and then click VLANS.
2. In the Toolbar, enter values for the VLAN Start and End to define the range of VLANs
to search for and display.
3. Click Refresh to display the search results in the Work Area.
4. Click on a row of the search results to display the provisioning information of the
selected VLAN.
5. Click the Back Arrow in the upper right corner to return to the search results.
This topic describes how to search for E7 GPON ONTs from the E7 Navigation Tree and
from the CMS Tools menu. In CMS, there are also many other aspects of the E7 for which
you can perform a search.
Enter specific attributes of an ONT of which the search tool filters.
The search tool returns a list of filtered items that are available.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
137
Note: Once installed, ONTs and ONT attributes can be immediately accessed in the E7
inventory database in CMS.
1. In the Navigation Tree, select the E7 node to expand it, and then click ONTS.
2. In the Toolbar, select whether to search or filter on all of the linked and unlinked ONTs
or only the ONTs not linked to the E7.
Not linked filters on ONTs that have been discovered through the connection to an
E7 system, but have not been linked to an ONT profile.
All filters on both not linked ONTs and linked ONTs, which are discovered ONTs
that are linked to an ONT profile.
3. Click Apply to display the search results in the Work Area.
4. Double click on a listed ONT characteristic to display the provisioning information.
5. Click Table View to return to the search results.
1. In the Navigation Tree, select the E7 node to expand it, and then click ONTS.
2. In the Toolbar, enter the ONT ID.
3. Click Apply to display the information for the ONT that matches the ID.
4. In the Work Area, double click on an ONT characteristic to display the provisioning
information.
5. Click Table View to return to the search results.
1. In the Navigation Tree, select the E7 node to expand it, and then click ONTS.
2. In the Toolbar, click Advanced to open the Apply ONT Filter dialog box.
3. Enter as many attributes as you want to create a broad or narrow search. Refer to the
Calix E7 GPON Applications Guide for information on the parameters.
4. Click Apply to display the search results in the Work Area.
5. Double click on a listed ONT characteristic to display the provisioning information.
6. Click Table View to return to the search results.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
138
1. In CMS Desktop, on the Tools menu, click Search > E-series > E3-48C/E4-400/E5-
48/E7 > ONT, and then select the filter for the search:
Provisioned ONT
Discovered ONT
Quarantined ONT
2. In the Filter Criteria form, select the criteria for the various categories, if you want to
narrow the search.
3. Click Submit.
4. The search results include a hyperlink that will take you to the dialog on the PON record
in CMS. From here, the user can activate the ONT and create services using the CMS
Service dialog.
Alternatively, you can select the type of ONT port or service on which to perform the
search:
ONT Ports: ONT Services:
ONT GE DATA/VIDEO
ONT FE SIP
ONT HPNA TDMGATEWAY
ONT T1/E1 T1PWE3
ONT POTS H248SERVICE
ONT RG MGCP GATEWAY
ONT FB
ONT RF
ONT HOT RF
ONT AVO
Alternatively, you can search for cross-platform ONTs:
a. In CMS Desktop, on the Tools menu, click Search > Multi-Platform > ONTs
(C7, E7, AE).
b. In the Filter Criteria form, select the criteria for the various categories, if you want to
narrow the search.
c. Click Submit.
d. The search results include a hyperlink that will take you to the dialog on the PON
record in CMS. From here, the user can activate the ONT and create services using
the CMS Service dialog.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
139
Using the CMS Desktop, you can search across Calix ONTs or ports for two distinct types
of user interfaces:
Find a subscriber interface with provisioned services, based on the Subscriber ID and
Description search criteria.
Find a subscriber interface with or without provisioned services, based on the Network
and Port ID information search criteria.
Based on company policies and procedures, the subscriber ID can be a telephone number or
another subscriber identifier.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
140
Note: The Subscriber Search pane displays in the Work Area when you launch CMS
Desktop. Step 1 below is only required if you are currently viewing the administrative and
configuration Work Area menus in CMS Desktop.
1. (Optional) To return to the results of a previous search, in the drop-down list to the right
of the Last Search link, select Subscriber or IP/MAC, depending on the search type you
are looking up.
At the top of the screen, click the Last Search link. (Alternatively, in the status bar at the
bottom of the CMS Desktop screen, click the magnifying glass icon, or on the Tools
menu, click Subscriber Search.)
2. In the Subscriber box, enter the information on which to perform the search:
Enter all or part of a subscriber ID or AID. Include any characters, such as dashes, as
used in the subscriber record or AID. For example:
7072936500
Enter the network name, followed by a colon (:) to search for all ports on an E-series
node or C7 network whose name contains the entered name. For example:
c762:
Enter the network, followed by a colon (:), and then the node AID to search for only
the ports whose network name contains the entered name and AID string. For
example:
c762:N1-1-1
Enter a MAC address or IP Host address.
3. Execute the search:
Click Subscriber to view the results of a search based on subscriber information.
Click IP/MAC to view the results of a search based on an IP host or MAC address.
4. Click the subscriber ID hyperlink to view the Services screen for the port or ONT.
Your CMS system administrator can set the default FTP server options: IP address, user
name, and password of the FTP/SFTP host server.
Note: If you set the node's Auto Connect parameter to N (do not automatically reconnect)
and the node gets disconnected, the node is skipped when a scheduled task runs, and no
failure is reported in the task details.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
141
For instructions, see Performing Shelf and Node Backups (on page 355).
You can optionally generate an inventory report of MAC and IP hosts on Calix networks.
Related topic
Scheduling an Inventory Snapshot (on page 366)
Note: When using CMS to schedule upgrades of E-series devices, a single task should not
contain more than 50 networks. For more than 50 networks, wait for one task to complete
before scheduling another upgrade task.
This procedure assumes that you have performed an initial upgrade to software release 2.2.
Refer to the Software Upgrade Guide for the active software version on your system for
instructions. For example, if your system is running R2.1, refer to the Calix E7 and E5-400
R2.1 Software Upgrade Guide.
Upgrade Options
A scheduled CMS software upgrade task includes the following options:
Both File Distribution and Reset: Transfer the new software release and reset each
node to operate with the new software.*
File Distribution Only: Transfer the new software release to each node included in the
scheduled task without initiating a reset.
Reset Only: Reset each node to start operating with the new software.*
The upgrade options available depend on the platform and deployed GPON ONTs.
For E-Series VDSL2 systems and E3-8G OLT, there is only one upgrade process for a
system upgrade.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
142
This includes shelves with VDSL2 cards, shelves with a VCP card, or independent VDSL2
nodes (E5-48, E5-48C, E3-48C, and E3-48C r2). However, a VCP is managed as a
standalone unit that, MUST be upgraded independent of E7-2 systems. A single VCP image
supports both VCP-192 and VCP-384 cards. Note: You can only upgrade the VCP by the
inband management path of the E3-48 r2, the craft-fe can NOT be used to upgrade the
VCP.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
143
Upgrades the E7 system software, removes all existing ONT images (regardless of
how they were installed onto the system), and then installs the ONT images (P-Series
only) in the E7 package.
For R3.1 and later E7 GPON systems, Calix supports the above upgrade options and the
additional following option:
No packages of ONT firmware (Removes ONT images and then upgrades
OLT)
Removes all existing ONT images (regardless of how they were installed onto the
system) and upgrades the E7 system software. When you preload new ONT images
to the system before using this option, upon system reset the OLT and ONTs restart
using the new software and firmware.
Note: Although R3.1 does not bundle ONT images with system software, the
upgrade options above can still be used.
ONT Mode Below R3.1.0 R3.1.0 and Above
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
144
Sequentially: For ring network topologies, perform a reset on one node at a time.
In Parallel: For linear chain network topologies, perform a reset on all nodes in parallel.
Following the software reset, the new system software is committed as the default software.
Note: For a sequential upgrade, CMS acts as the master during the software reset phase. If
the CMS server shuts down before the scheduled task completes, you can re-run the task
once CMS is restored (in the scheduled task list, right-click the task and click Re-Run). This
restarts the software upgrade task from the beginning, including file distribution.
Calix recommends using the CMS “ONT Firmware Upgrade” scheduled task to automate
ONT-only upgrade process.
Service-affecting procedure
Calix recommends performing the reset phase of the upgrade during a maintenance window.
For linear chain topologies, the reset phase is service-affecting for several minutes.
For non-redundant services on ring topologies, the upgrade reset phase is service-
affecting for several minutes.
For redundant services on ring topologies, the reset phase causes a momentary disruption
in service, and the network runs without alternate path protection.
1. Identify the network topology (ring or linear-chain) for the nodes to be upgraded.
2. On the Navigation Tree, click CMS.
3. In the Work Area, click System > Scheduled Tasks > Software Upgrade.
4. In the toolbar, click Create, and then click the type of node you are upgrading.
The New Upgrade Task dialog box opens.
5. In the Schedule Options area, select Schedule for later and then click the calendar icon
to open the Select Date dialog box. Use the scroll buttons to view the next (or previous)
month or year, click the date to start the upgrade, and then click OK. In the hour (hr)
and minute (min) lists, select the time for the download to start.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
145
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
146
b. Expand or double-click the root region to view the network groups. Expand or
double-click a network group to view the nodes under it. Selecting a network group
selects all E-Series nodes under it. Selecting an E-Series node only selects a single
node.
c. Repeat Step 7b for each additional network group or node to include in the upgrade.
To remove a selected network group or node from the upgrade, right-click it and
click Un-Select.
8. At the bottom of the New Upgrade Task dialog box, click OK to save the settings.
Each node stores a database of peer nodes and interfaces that can be discovered and used by
CMS to render layer 1 topology by downloading this stored info from nodes into CMS
Database using inventory task. You can then use this topology to provision and troubleshoot
network troubles, and by Compass for network and service planning, as well as network
resource optimization.
CMS R13.1 and higher supports LLDP management of the following lines units and
platforms:
E7 GE-24x
E7 SCp-10GE
E7-GPON-4
E7 GPON-8
E7 10GE-4
E7 GE-24
E7 GE-12
E7 VDSL2-48C
E7 VDSL2-48
E3-48C
E5-48/48C
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
147
E5-30x/E5-520
1. Complete an inventory snapshot schedule (on page 366) task. This LLDP information will be
stored in the database, and CMS will create the topology links reported by the E7
automatically.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
148
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
149
b. Expand or double-click the root region to view the network groups. Expand or
double-click a network group to view the nodes under it. Selecting a network group
selects all nodes under it. Selecting a node only selects a single node.
c. Repeat Step 6b for each additional network group or node to include in the upgrade.
To remove a selected network group or node from the upgrade, right-click it and
click Un-Select.
7. At the bottom of the New ONT Firmware Upgrade Task dialog box, click OK to save
the settings.
You can schedule a file retrieve or file remove task. The file retrieve task loads an RG
configuration file onto an E7. The file removal task removes an OMCI configuration file
from the E7.
Note: Calix strongly recommends that you copy (backup) configuration files to a secure
location for future installations. Please refer to the Managing Configuration Files for more
information about this feature.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
150
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
151
b. To configure the task to recur on a daily or monthly basis, click Recurring, and then
select the task frequency by clicking the Daily or Monthly radio button. For daily
backups, click the check box next to each day of the week to schedule a backup, or
click All.
c. To specify a date and time to end a recurring backup, click Stop after and select the
date, hour, and minutes.
5. In the Config File Info area, do the following:
a. In the Vendor box enter the code "CXNK" for P-Series ONTs.
b. In the Instance box, enter the RG configuration file instance number. The E7
supports eight instances for RG configuration files (index values 17 - 24).
c. In the Version box, enter the software version.
d. In the Model box, enter the ONT model number. This field is optional.
e. In the Product box, enter a code that indicates the ONT product family. This field is
optional.
f. If the Force Remove box is checked, CMS will make a best effort attempt to remove
this specific index file, even if there is a model mismatch.
Cut-through sessions require Min (Minimum) CMS Administration privileges and Full
Provisioning privileges for the node on which you want to establish a connection.
Note: For any Calix product that CMS manages using the web cut-through facility, the IP
address of the managed node should be in the DNS database of a server that the CMS host
uses. If this task is not completed, then the Linux host where CMS is running will require an
entry for each managed element added to its /etc/host file.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
152
CMS supports E3-48R 2 and VCP-192/384 device management under a Single Management
IP address. This feature allows E7 VCP-192/384 units to share the same management IP
address as physically collocated (adjacent) E3-48R2 systems.
Considerations
The solution is similar to the E7-VCP Single-IP management. EX devices use NAT to
manage subtended E3-VCP. The difference in E3-VCP solution vs. E7-VCP is that E3-VCP
uses a VCC Port and VCC cable to connect the E3-48r2 and E3-VCP units and enable static
NAT for Single-IP Management, not a Craft-FE Port as in E7-VCP solution. So an IP
address needs to be assigned to the VCC port.
For this feature to work, both VCP and E3-48R2 needs to be running E7 R2.6.80 or
higher.
Note: This is the only release at the moment that supports this feature.
The feature only allows one E3-48r2 to manage only one E3-VCP. This is because E3-
VCP will block a link if both links are eth-admin-state enable, that blocked link may be
our management link.
Subtended E7-VCP upgrade needs more time (5~6 minutes) than previously (3 minutes).
This is because all mgmt. traffic from/to the subtended E3-VCP will be modified by the
CPU in E3-48r2 for NAT handling.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
153
Once management is setup, you can add VCP devices using E3-48r2 management IP address
and the NAT port which for NETCONF would be 30830.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
154
CMS supports managing multiple E3-48r2 devices using a single management IP address.
Clients in the diagram shown in Single IP Management for E3-48R2 and VCP (on page 152) are
subtended E3-48r2 devices from the main Site Host. A brief example:
Once you have completed provisioning from Single IP Management for E3-48R2 and VCP (on
page 152), you should now be able to add host E3-48r2 and client E3-48 devices in CMS
using a single IP address of the host with appropriate NETCONF Port numbers.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
155
CMS support for Calix AXOS platforms includes the following features:
AXOS CRUD support
AXOS global default settings
AXOS device topology. CMS R15.1 allows user to
CREATE/READ/UPDATE/DELETE for AXOS devices. Currently, the following
devices are supported:
E3-2
E7-2 AXOS NGPON2
E7-2 AXOS GPON-8r2
E7-2 AXOS VDSL2-35b
Note: E9 and Gfast devices are not currently supported.
Manual and automated Link creation between AXOS and non-AXOS systems, such as
legacy C7 network devices
AXOS Netconf log support
AXOS CLI Cut through
AXOS Network Backup, Network Restore, and Inventory Snapshot
Search in the CMS database based on user-defined criteria. See Searches and Inventory
Reports (on page 96).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
156
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
157
The topology information can then be used when provisioning services, troubleshooting
network troubles, and by other network and service planning or network resource
optimization.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
158
CMS 15.1 adds support for LLDP management of the following line units and platforms:
E3-2
E7-2 AXOS NGPON2
E7-2 AXOS GPON-8r2
To extract the topology data from nodes, run an inventory snapshot (on page 366) from CMS
Scheduled task for your AXOS nodes. With inventory snapshot, CMS downloads the LLDP
data stored on the AXOS nodes into its own database, and then creates the topology links.
Topology Example
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
159
CMS 15.1 can automatically create LLDP links between an AXOS and a non-AXOS device.
The process to download LLDP inventory from Network Elements to the CMS DB remains
the same: run the inventory snapshot (on page 366) from CMS Scheduled task for your AXOS
and non-AXOS nodes.
Topology Example
Considerations
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
160
Manual links are persistent across upgrades, while automated links are based on inventory
and NETCONF. This enables user to see links between devices even before LLDP
inventory is available.
Manual links can be created between devices that supports NETCONF and those that
don’t, e.g. C7, B6, etc.
Manual links can be created between devices that supports NETCONF but have disabled
LLDP.
Manual links can be created between CMS Supported devices and third party devices.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
161
Considerations
For day-to-day operations, e.g. network connectivity, network backup and network
restore etc. are recorded to $CMS_HOME/bin/logs/axosnetconfLogFile.txt.
For inventory snapshot activity are recorded to $CMS_HOME/jakarta-tomcat-
5.0.12/logs/axosnetconfLogFile.txt
These log files are always enabled by default. (So no debug steps to enable these logs like
netconf logs for E7)
The size of each file is 3M, and then it rolls over to another. CMS currently will save up
to 10 files, meaning if the logs grow beyond 10 files, it will start overwriting.
Considerations
This feature also enables you to provision a higher (later) version of the software, even if
the current CMS software server version does not yet support the release.
CMS supports one Telnet cut-through to each node, and up to 20 concurrent Telnet
sessions for all CMS client users.
Cut-through sessions require Full CMS Administration privileges. Additionally, the AE
ONU must be in a "Connected" status in CMS.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
162
1. From the Provisioning Tab within the Work Area, select the device to modify.
2. Click Action > Cut-Through Telnet from the drop down list.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
163
1. Navigate to CMS > System > Scheduled Task > Network Backup.
2. Select Create > AXOS Backup.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
164
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
166
4. Once the inventory snapshot is completed, the CMS Web GUI allows the user to pull the
reports for the AXOS device. Open the CMS WEB GUI by typing the URL:
http://<host-IP>:8080 > Configuration > AXOS Series.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
167
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
168
Parameters
You can provision the following parameters for Ethernet security profiles:
Parameter Description Valid Options
ID* The Registration ID or the 12-digit FSAN serial If the input value for an ONU on the network
number for the AE ONU. begins with a number, it is assumed to be a
Registration ID and is validated as having up
to 10 numeric digits. If the input value starts
with an alphabetic character, it is assumed to
be an FSAN Serial Number and is validated
to consist of the prefix "CXNK" followed by
exactly 8 alphanumeric characters.
Location The CMS Network Group to place the ONU. Dropdown List
Subscriber ID Optional Identifier for the ONU. Alphanumeric
Description Descriptive text for the ONU. Often the physical alphanumeric
location (street address) is entered.
Maximum: 30 characters
Note: An alarm is NOT raised if the maximum
character value is exceeded and the actual saved
data will be truncated.
ONU Profile* Associate the ONU with a pre-provisioning ONU Dropdown List
Global Profile
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
169
To create an AE ONU
The newly created ONU is displayed in the Network Details list and comes up as
Disconnected:
1. On the Navigation Tree, select the AE ONU Network Group.
2. In the top menu bar, click Create to open the New AE ONU dialog box.
3. Using the parameter table above as a reference, type or select the required settings.
4. Click OK.
5. Select the ONU from the List and select the provisioning tab.
The AE ONU is now added to the database. A configuration file based on the ONU pre-
provisioning has been created and uploaded to the TFTP server, waiting for the ONU to be
connected.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
170
The AE ONU is displayed in the network structure as being disconnected. The newly created
ONU has failed to obtain an IP Address, MAC Address, or FSAN Serial Number. This will
be rectified once the ONU is physically connected.
To change the default network group to use for discovered AE ONTs, or to change the
SNMP community string used, see Configuring AE ONT Administrative Settings (on page 186).
AE ONUs activated via CMS will show OCM-managed in the AE ONU table.
AE ONUs activated via OCM and then discovered manually will display a "Y" under the
"Externally Provisioned" heading in the AE ONU table.
AE ONUs that are OCM managed and externally provisioned may be upgraded,
resynchronized and reset.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
171
The IP address of the CMS server must be configured as a trap host on AE ONUs before
they can become visible on the CMS. In addition, the read-only SNMP community must be
configured as "public". This may done via the OCM or the ONU's CLI, as described below.
Note: Please refer to the ONU Configuration Manager (OCM) User Guide for more information
about how to configure ONUs via the OCM.
The SNMP trap host is configured in the ONU profile for each ONU.
1. Issue the command show subscriber ip {ONU-IP-address} in the OCM to determine
which ONU profile is managing a subscriber's ONU. For example, the following
command output shows that an ONU with the IP address of 10.3.6.143 is being
managed by ONU profile "2343_profile".
2. Issue the command ONU-profile and enter the name of the ONU profile you wish to
configure:
OCM(config)#ONU-profile {profile-name}
3. Configure the IP host of the CMS server as an SNMP trap host:
OCM(config-prof)#snmp trap-host {CMS_server_IP_address}
4. Confirm that the read-only SNMP community is set at the default value of "public":
OCM(config-prof)#snmp community ro public
5. Confirm the ONU profile configuration, as shown in the example below:
ONU(config)# do show ONU-profile {ONU-profile-name}
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
172
To configure 2300 AE ONUs for Discovery by CMS via the ONU CLI
If an ONU is not managed via the OCM, the SNMP trap host may be configured via the CLI
on 2300 ONUs. Please refer to the Calix 2300 AE ONU Configuration Guide for more
information about how to configure a 2300 AE ONU via the CLI.
1. Configure the SNMP trap host from Global configuration mode:
ONU(config)# snmp trap-host {CMS_server_IP_address}
2. Confirm that the read-only SNMP community is set at the default value of "public".
Note that this command may not be issued on the 2364 ONU:
ONU(config)#snmp community ro public
3. Confirm the SNMP configuration, as shown in the example below:
ONU(config)# do show snmp
System Entries
sysLocation: N/A
sysContact: support@calix.com
sysObjectID: 1.3.5.1.5.1.10799.250.20
sysDescription: ON2364
Traphost: Tag:
10.4.0.34 9.10.4.0.34
10.4.0.545 9.10.4.0.55
SNMP Communities
rwcommunity private
rocommunity public
Each AE ONU is assigned a unique IP address. Use the B-Series Range Discovery tool to
add 2300 AE ONUs to CMS. This tool enables you to specify IP address ranges to discover
and connect to multiple ONUs. Using the tool, you can add both inclusion and exclusion
rules in discovery criteria to pinpoint specific IP address ranges. You may also issue an IP
address for an individual ONU to add it to CMS.
If the Calix device is discovered but is already connected to CMS, a message displays in the
task results indicating that the network already exists.
Note: Full CMS Administration privileges are required to discover AE ONUs in CMS.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
173
2. In the Range Discovery dialog box, set the ONU discovery parameters, as follows:
a. In the IP Range and To boxes, type the beginning and end of the ONU IP address
range you are discovering. Values are inclusive.
b. If required, change the default Netmask value (255.255.255.0) to define the discovery
range.
c. (Optional) To exclude the specified IP range, select the Exclude check box.
3. Click Add.
To remove an IP range from the discovery range list, select the range and click Remove.
4. In the Read Community box, accept the default SNMP community string (public).
5. At the bottom of the dialog box, click OK.
A Task Progress window opens and lists the discovery activity and connection results.
6. After the Task progress window is closed, discovered AE ONUs may be viewed at the
bottom of the Navigation Tree under the AE ONUs bullet.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
174
7. Double-click on an AE ONU in the list and select a network from the drop-down menu
to change its location in the Navigation Tree.
Deleting an AE ONU
Deleting an AE ONU from the network using Provisioning screen in CMS Desktop requires
Full CMS Administration privileges. The provisioned services must first be removed before
performing the following procedure. See Removing AE ONU Service for instructions.
1. On the Navigation Tree, click an AE ONU Node from the Network Group.
2. From the list of AE ONUs in the Provisioning Tab, click the ONU to select it.
3. At the top of the Provisioning work area, click Delete, and then Apply. A confirmation
dialog box is displayed for verifying that you are ready to delete the AE ONU and save
the changes. Click Delete to confirm.
Note: If the AE ONU is disconnected, you cannot delete it. Click Action > Connect
and then perform the procedure to delete the AE ONU.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
175
Note: You can also use the Search feature (on page 100) in CMS to view a report of all ONUs
in the CMS database.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
176
Parameters
You can view the following parameters for ONUs configured on the network:
Parameter Description Valid Options
ONU ID* The Registration ID or the 12-digit FSAN serial If the input value for an ONU on the network
number for the AE ONU. begins with a number, it is assumed to be a
Registration ID and is validated as having up
to 10 numeric digits. If the input value starts
with an alphabetic character, it is assumed to
be an FSAN Serial Number and is validated
to consist of the prefix "CXNK" followed by
exactly 8 alphanumeric characters.
Location The CMS Network Group to place the ONU. Dropdown List
ONU Profile* Associate the ONU with a pre-provisioning ONU Dropdown List
Global Profile
Provision Firmware The firmware file (.rto) to apply to the ONU. calix_ae_700sfu_xx. . . Single Family SFU
ONU
calix_ae_700mdu_xx. . .Business ONUs
(76xGX)
calix_ae_700ge_xx. . .Single Family GE
ONU
FullRel_SIGNED_EXOS_PG_Rxx.xx.xx.img
GS4227
FullRel_SIGNED_EXOS_PH_Rxx.xx.xx.img
GS4227W
Registration ID The Registration ID entered during pre-provisioning alphanumeric
via Remote ONU Activation or blank if Serial number
was entered and ONU has not been discovered.
Vendor Vendor Prefix code for the ONU. Default=CXNK
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
177
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
178
1. On the Navigation Tree, expand the network group and click the AE ONU.
2. In the work area, double-click the specific AE ONU to view configuration details.
Note: If the AE ONU Connection State displays as Disconnected, the details on screen
represents the last saved information.
The synchronization process ensures configuration files located on the CMS are identical to
configuration files on the TFTP server. When you perform the synchronization, the system
does the following:
Regenerates the AE ONU configuration files and updates the TFTP servers.
Makes new service configuration files available to use in CMS Desktop (using the
Services subscriber activation screen).
Populates the profile/IG drop down boxes on the AE ONU provisioning page with the
appropriate configuration file name.
Important: If you make a provisioning change to a single ONU that is active within CMS,
the file for that ONU is immediately changed on the CMS server. This same configuration
file is transferred to the TFTP server where a reset command is immediately sent to the
ONU.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
179
Select Schedule for later to run a save task during a maintenance window, and then
do the following:
a. Click the calendar icon to the left of the date box to open the Select Date dialog
box.
b. Click the date to start the save task, using the scroll buttons to view the next (or
previous) month or year, if necessary. Click OK.
c. In the hour and minute lists, click the time for the save task to start.
d. Click OK.
5. In the AE ONU Counts area, select the method to use for synchronizing the AE ONU
configuration files.
For CMS R13.1.243 and higher (AE ONU R3.1 and higher):
Select Sync and Reboot to synchronize only those ONUs whose sync status is
changed or in error. Using this option, all affected ONUs are reset.
Select Sync All to synchronize all configuration files, firmware, and VoIP
configuration files. Using this option, ONUs are not reset.
Select Sync Configuration Dynamically to synchronize ONUs whose sync
status is changed or in error. Using this option, the affected ONUs are not reset.
For CMS R13.1.230 and lower (AE ONU R3.0 and lower):
Select Sync Configuration to synchronize only those ONUs whose sync status is
changed or in error. Using this option, all affected ONUs are reset.
Select Sync All to synchronize all configuration files, firmware, and VoIP
configuration files. Using this option, ONUs are not reset.
6. At the bottom of the New AE ONU Sync Configuration Task dialog box, click OK to
save the settings.
For information on viewing, modifying, rerunning, deleting, or aborting a task, see
Scheduling Tasks.
7. At the bottom of the New AE ONU Sync Configuration Task dialog box, click OK to
save the settings.
For information on viewing, modifying, rerunning, deleting, or aborting a task, see
Scheduling Tasks.
When restoring the CMS database, Calix recommends that the CMS Auto Upgrade
procedure be used. The auto upgrade procedure ensures that any existing provisioned AE
ONUs are imported with their respective configuration files and service provisioning fully
intact.
In the instance where previously provisioned AE ONUs must be manually imported into
CMS, perform the following:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
180
1. (Optional) Upgrade the CMS server software. For instructions, refer to the Calix
Management System (CMS) Installation and Upgrade Guide for Linux or Solaris, depending on
the host server's operating system.
2. Import the previous CMS database using CMS Web.
Note: For Steps 3 and 4, copying and pasting database files requires access to the CMS
Linux/Solaris server. Make sure you are familiar with the file structure and methods for
transferring files before proceeding. If unsure, contact Calix TAC for additional guidance.
3. Copy the old CMS AE ONU firmware files (for example, calix_ae_700ge_r2.1.0.42.rto)
from the previous location to the $CMS/ae/fw directory.
4. Copy any SIP configuration files (for example, VoipConfig.txt) from the previous location
to the $CMS/ae directory.
5. To ensure that SIP configuration files are copied to the TFTP server when you
synchronize AE ONUs in Step 6, verify that the SIP Remote profiles reference the VoIP
correct configuration files:
a. In the CMS Work Area, click Profile > E7/ONU > Service > SIP RMT.
b. View the entries in the Primary File Name [PRI-FILENAME] column.
6. Synchronize the AE ONUs per for the following procedure:
a. In the CMS Work Area, click System > Scheduled Tasks > AE ONU > Sync
Configuration.
b. In the Schedule Options section, select "Immediate one-time execution".
c. In the AE ONU Counts section, select "Sync all (configuration files, firmware, and
VoIP configuration files)."
d. Click OK.
Resetting AE ONTs
AE ONTs can be reset individually or per a pre-determined schedule.
Resetting AE ONTs requires Full CMS Administration privileges. Additionally, the AE ONT
must be in a "Connected" status in CMS.
1. On the Navigation Tree, select the AE ONT node within the Network Group.
2. From the Provisioning Tab, select the AE ONT from the list.
3. From the Actions menu, Click Reset.
Note: The AE ONTs Device Status, Management Status, and Configuration status
continues to be polled during the reset process and the current state of the AE ONT is
displayed during the reset.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
181
4. Click OK to clear the dialogue box and confirm the ONT has been reset.
Related topic
Scheduling Tasks (on page 344)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
182
This feature also enables you to provision a higher (later) version of AE ONU software, even
if the current CMS software server version does not yet support the release.
CMS supports one Telnet cut-through to each AE ONU, and up to 20 concurrent Telnet
sessions for all CMS client users.
Cut-through sessions require Full CMS Administration privileges. Additionally, the AE ONU
must be in a "Connected" status in CMS.
1. From the Provisioning Tab within the Work Area, select the AE ONU to modify.
2. Click Action > Cut-Through Telnet from the drop down list.
3. The AE ONU Telnet Cut-Through CLI window is displayed.
For scheduled upgrades, use CMS and choose to upgrade ONUs based on the following
selections:
All ONUs
Specific model type
Topology regions and network groups
Different firmware versions for different ONU models
The upgrades can be scheduled for a maintenance window or performed immediately. There
is also a downgrade capability that allows you to revert AE ONUs to a previous version of
firmware.
The AE ONU firmware upgrades are made available from Calix as new features are added
and existing issues are resolved. Upgrades are typically announced with a Calix Service
Bulletin and require submitting a request to the Calix Technical Assistance Center (TAC) to
gain access to the firmware upgrade file. Once you have permission, you can log in to the
Calix Customer Resource Center and download the file.
Only a CMS Desktop user in the Administrators user group can schedule an upgrade task.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
183
1. On the Navigation Tree, select the AE ONU Node where the ONU to be upgraded
resides.
2. From the Provisioning Tab, select the ONU.
Note: Prior to performing the procedure below, the new .rto firmware file must be
located under <cms install directory>/ae/fw using the Upload Firmware Task (CMS >
System > AE Settings > Action > Upload Firmware). If the new firmware is not located
here, the firmware file will not be added to the drop-down list of available updates.
3. From the toolbar, click Action > Firmware Update.
4. From the dropdown list, select the firmware version to update to.
Note: The following procedure assumes that you have downloaded the upgrade file from the
Calix Customer Resource Center and copied it to any location on your local drive.
1. On the Navigation Tree, click CMS.
2. In the work area, click System > Scheduled Tasks > Software Upgrade.
3. In the toolbar, click Create > AE ONU Upgrade.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
184
4. In the Schedule Options area of the New Upgrade Task dialog box, do one of the
following:
Select Immediate one-time execution to run a single upgrade task, immediately.
Select Schedule for later to run an upgrade task during a maintenance window, and
then do the following:
a. Click the calendar icon to the left of the date box to open the Select Date dialog
box.
b. Click the date to start the upgrade, using the scroll buttons to view the next (or
previous) month or year, if necessary. Click OK.
c. In the hour and minute lists, click the time for the download to start.
d. Click OK.
5. In the Firmware area of the New AE ONU Upgrade Task dialog box, do the following:
a. Select the checkbox in the upper left corner of the firmware area to schedule a
firmware upgrade for all ONUs.
b. Select individual ONU model types and/or firmware versions by clicking the
checkbox for each model.
c. In the File box, type the path and file name for the installation.bin file. In the version
field, optionally type a description to identify the upgrade.
d. (Optional) To allow a firmware downgrade if the currently-running firmware version
is higher than the version of the installation file, click the Allow downgrade check
box.
6. In the Network Selection area, select the network groups or regions to upgrade. To select
any region or network, select the line item and then right-click and choose "Select" or
Un-Select" as appropriate. The square to the left of the network group or node changes
to green to indicate that it is included.
a. Select the root region (top line item) to include all AE ONUs in the network.
b. Expand the view for various regions or networks by clicking the arrow immediately
to the left of the node box.
7. At the bottom of the New AE ONU Upgrade Task dialog box, click OK to save the
settings.
For information on viewing, modifying, rerunning, deleting, or aborting a task, see Scheduling
Tasks (on page 344).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
185
As opposed to previous releases, the Option-43 command in the DHCP server statement
is no longer required.
If Option-43 commands remain in the DHCP server statement, they take precedence
over any configuration commands located with the AE ONU configuration file.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
186
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
187
Parameters
The following table describes the various AE system component settings that can be
configured from a single location.
Parameter Description
Start Registration When enabled (the check box is selected), CMS processes registration traps from AE ONUs.
Trap Processing
By default, this feature is disabled. To enable for existing customers, do any of the following:
1. Manually turn it on from the GUI
2. Import ONU Configuration File to CMS where it is enabled already.
3. Perform an auto upgrade.
For new AE ONUs, set the flag after the ONU is brought on-line.
Once enabled, registration trap processing will remain enabled.
When disabled, a minor alarm is raised.
Enable Dynamic Enable or disable Dynamic Provisioning. Determines how dynamic changes to certain
Provisioning provisioning characteristics are executed (Sync Config, Sync and reboot)
Dynamic provisioning will cause CMS to automatically generate an ONT configuration file and
push that file to the ONT after the CMS user has created or edited AE services.
Default Network Specifies the default network group for newly discovered AE ONUs.
Group
FTP Server #1 and Test Link - executes the ping command for the FTP connection IP. Returns a Successful versus
#2 Failed status.
Enable or Disable the FTP Server
Protocol - Supports unsecure (FTP) or secure (SFTP) FTP file transfer from CMS to the AE
Configuration Server.
IP Address of the FTP Server
User Name/Password - credentials used by CMS to access the FTP server
CMS Folder Location - Default location for all system and ONU configuration Files
PWE3 Configuration Default PWE3 Configuration - Allows for setting of primary transport type (E1 or T1)
System Time Zone Can set global system timing parameters for maintaining PWE3 timing on AE ONUs.
FW Uploading Status Indicates whether firmware updates are in progress on the TFTP server.
TFTP For Inputting the IP Address of the Primary and Secondary TFTP Server
System Log For inputting the IP Address of the Primary and Secondary SysLog Server
Network Time For inputting the IP Address of the Primary and Secondary NTP Server
SNMP For inputting the IP Address of any external Trap Receivers configured on the network.
Note: The CMS server is automatically added as a trap receiver when it is managed by CMS.
Therefore, it is not necessary to add the CMS server IP address in these fields.
DHCP Option-82
Enable Enable or disable DHCP Option 82 insertion. When enabled, allows any DHCP Relay Agent to
insert circuit specific information into a request being forwarded to the DHCP server.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
188
Parameter Description
Remote ID Identifies destination (ONU side) tokens to be captured during Option-82 requests.
Voice Settings - Allows for the setting of a fixed transmit and receive gain (loss) for POTs lines at the ONU based
Voice Port Loss Plan on the ONU type being used.
ANSI plan provides fixed –3dB Transmit and –9dB Receive gain (loss).
GR-909 provides –2 dB Transmit and –4 dB Receive gain (loss).
Etsi-short provides -4 dB Transmit and -11 dB Receive gain (loss).
Management VLAN Option to change the Default Management VLAN ID for ONUs on the system. Can also be
modified using RONTA.
Enable Shaping Enable or disable the traffic shaping feature introduced in AE 3.0.
ACS Settings*
User Name User name to provide clients wanting to access the ACS Server
Connection Request Username assigned to the ONU for ACS Server personnel's use
Username
Connection Request Password assigned to the ONU for ACS Server personnel's use
Password
Inform Interval Length of time between Inform messages from the ACS Server to the ONU.
Default: 86400 sec (1 day)
*For AE ONTs running R3.1 and later, the ACS fields in the CMS AE Settings screen have no effect. For AE ONTs
running R3.1 and later, use the RG management profile to manipulate the ACS settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
189
Note: Changes to the TFTP server address must be updated on the DHCP server and
CMS.
7. Select the appropriate PWE3 configuration: T1, E1.
8. Select the appropriate location where the server resides from the System Time Zone
drop-down list.
9. For the TFTP server, System Log (Syslog Server), and the Network Time (NTP Server),
enter the IP address for each.
10. Enter a name in the Default SNMP Community field to change the default SNMP
community string.
11. For the SNMP Trap Receivers, enter hosts specified to receive alarm and event
notifications generated by the system, typically, the IP address of the CMS server.
Note: AE ONUs only support SNMP v2c.
12. Enter DHCP Option-82 parameters:
a. Choose whether to enable Option-82 service.
b. Enter the Circuit ID for Option-82 (the tokens to be inserted by the ONU).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
190
c. Enter the Remote ID for Option-82 (the tokens to be inserted by the ONU).
13. Choose the Default Voice Port Loss Plan for ONU POTS ports to use.
14. Enter a Default Management VLAN ID for the system (System Default = 85).
15. Click Apply.
Note: When AC power is restored, the Ethernet port is immediately re-enabled (assuming
the Ethernet Ports Administrative State is set to Enabled).
Note: Effective with CMS R12.0, the Disable on Battery setting is enabled by default when
an Ethernet port is provisioned.
1. In CMS Desktop, navigate to the ONU where you are updating ONU Ethernet Port
behavior.
2. In the work area, click Ports > Provisioning.
3. In Table View double-click an ONU Gigabit Ethernet, Fast Ethernet, or HPNA Port.
4. Select the Disable on BATT check box to enable power shedding, or clear the check box
to disable it.
5. Click Apply.
6. Click Sync Configuration.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
191
Note: The ONUs IP address is not persisted, meaning the DHCP server must be available in
order for the ONU to come back on-line.
The ONU then compares the locally stored configuration with the TFTP server and updates
if necessary.
1. The ONU first attempts to access its ONU specific configuration file (FSAN serial
number or RONTA Id number) from the primary TFTP server.
2. If the file is found it will be used to provision the ONU.
3. If the TFTP server is not available or the file is not provided before the time-out cutoff is
reached, the secondary TFTP server is accessed and the process is repeated.
4. If the secondary TFTP server is not available or the configuration file is not provided
before the time-out cutoff, the ONU uses its cached configuration file to bring it into
service.
5. If the first attempt to connect to the ONU's configuration file on the returns "cannot be
found" (servers are considered to be in sync so there is no need to try both servers if the
specific ONU file is not on the primary server), the ONU attempts to retrieve a generic
configuration file ("Calix-ONU.cfg").
6. If the ONU experiences a time-out condition on the TFTP server, it continues to try the
same TFTP server until it succeeds, receives an error or timeout cutoff is reached.
7. After a minute the ONU re-initiates the process with the primary TFTP server.
As additional background information, the following characteristics apply to local
provisioning persistence:
If the ONU fails to retrieve its specific TFTP configuration file, it uses the last-known
good configuration file (cached locally by the ONU). The ONU will make five attempts
to retrieve its specific configuration file at each TFTP server. This results in a two-minute
per-server delay before using the cached file.
The ONU removes its saved configuration if it is forced to factory defaults through the
RONTA process.
In the case where there is no locally cached configuration, or the TFTP server IP address
has changed, the ONU uses a 5 minute re-attempt timer after it reaches the cutoff
timeout value for the second TFTP server.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
192
The ONU generates a SYSLOG and SNMP trap when it uses the cached configuration
file.
The ONU generates a SYSLOG and SNMP trap when it uses the generic configuration
file.
The CMS supports provisioning persistence for voice, data, video and T1 services after initial
Configuration File download and set-up. It also supports provisioning persistence for SIP
Configuration Files after initial SIP Configuration File download.
In concert with CSC and CMS, you can now specify how you want the Subscriber ID field
within CMS to be mapped to facilitate automatic subscriber record creation in CSC.
Upon upgrading to ONT 11.2.1, under CSC Options, you can specify how you want to map
the Subscriber ID field within CC+. Available choices include:
N/A (Default behavior)
Account ID
Phone Number
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
193
Name
7376
Note: No action is required within CSC to affect this change. However, if you have existing
844GE GigaCenters in your network, and you change the mapping from CMS to CC+, a re-
synchronization is required before the change takes effect.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
194
Per the example above, if you choose the "Name" parameter, CSC will look up the
GigaCenter within CMS and apply the value as shown below.
7377
Note: When changing the subscriber ID mapping, a warning message may occur “Warning:
Change “Map Subscriber ID to” will cause 844GE subscriber issue. Do you want to
continue?” This message warns that the existing subscriber records within CSC will NOT be
updated automatically based on the new rule. However, if you perform an AE ONT sync in
CMS after changing the subscriber ID mapping, the related subscriber records within CSC
will be created/updated by following the new rule. Calix does not recommend changing this
rule once it has been set up.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
195
Important Note: When you select an E5-30x/E5-520 device in CMS, the product EWI
loads in the CMS work area. For information on performing operations from the EWI cut-
through, refer to the E5-30x/E5-520 User Guide.
For configuration and other details, see the Calix E5-30x and E5-520 user documentation.
Note: This procedure assumes that you have created a network group in CMS. For
instructions, refer to the Calix Management System (CMS) Guide.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
196
g. In the Network Login Username and Password boxes, leave the fields blank to use
the default settings defined in CMS, or type the user name and password specific to
the device.
h. In the Auto Connect list, accept the default Y (Yes) to automatically connect to CMS,
or select N (No) to create the device without connecting to it.
i. In the TimeZone list, select the global time zone for the E5-30x/E5-520 to use as a
reference.
j. (Optional) Specify an address or a latitude and longitude for viewing the new node
icon in Map View. Click the ellipsis button to the right of the Address Location Info
box to open the entry dialog box, and do one of the following:
Type the address location in the box provided. Click OK to save the information.
Click the Enter Lat/Lng radio button and type the latitude and longitude in the
respective boxes. Click OK to save the information.
k. At the bottom of the New Node dialog box, click OK to create the node.
5. (Optional) Click Topology, and move the new node icon by clicking and dragging it.
6. (Optional) Create a graphical link to view the node in a network topology. Refer to the
Calix Management System (CMS) Guide for instructions.
Note: The CMS uses NetConf protocol for alarm and event notification.
Display Name The name that displays next to the unit on the Navigation Tree.
Network Group* The parent network group under which the unit is nested on the Navigation Tree.
Connection State The current unit connection status (Connected, Connecting, Diagnosing,
Disconnected, Dynamic Synchronizing, Partially Connected, Secure Connecting,
Synchronized, Synchronizing, or Unknown).
IP Address* The IP address of the node.
SNMP Version Support The SNMP version used for this device.
SNMP Inform* Specifies whether the message type of outgoing messages is "INFORM."
Otherwise, the message type is "TRAP."
INFORM messages carry the same data as TRAPs, but are acknowledged by the
recipient or otherwise resent until they are acknowledged (5 retries, 1 second
timeout).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
197
N (No = trap)
Y (Yes = inform)
HTTP Port* The port to use for a nonsecure connection.
Default=80
HTTPS Port* The port to use for a secure connection.
Default=443
Device Type* E5-30x/E5-520
Viewing and editing E5-30x/E5-520 details requires Full CMS Administration privileges.
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > and the model name of the device.
3. To edit a parameter, do the following:
a. In the node list, single-click the row of the the device to edit.
b. In the Edit row, modify the editable parameters as needed.
c. Click Apply, and then click OK to save the new settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
198
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > and the model name of the device.
3. In the node list, single-click the row of the the device to delete.
4. If the node displays as Connected in the Connection State column, do the following:
a. In the toolbar, click Action > Disconnect.
b. Click OK to confirm the action.
5. In the toolbar, click Delete, and then click OK to confirm the deletion.
Before creating a graphical link, you must add the devices to a network group.
Creating a graphical link between devices requires Full CMS Administration privileges.
1. On the Navigation Tree, select the Network Group that contains the devices.
2. In the Topology Work Area, locate the task list to the right of the zoom ratio list. Select
Topology Links.
3. Click on a starting node, and then click on another node to terminate the link.
4. In the Topology Links dialog box, do the following:
In the From Endpoint and To Endpoint areas, specify the ports on the devices you
are creating a link from and to.
Click Add to move the endpoints to the Topology Links to be Created area.
Optionally, in the Link Type, Description, and Bandwidth fields, type the
information to be associated with the link.
At the bottom of the dialog box, click Create.
5. Click OK to confirm the action.
In the Topology and Map View Work Areas, a blue link displays between the two
devices.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
199
Tip: Hover the mouse over the new link to display topology link information in a
Tooltip.
1. On the Navigation Tree, select the Network Group that contains the devices.
2. In the Work Area tabs, click Topology Links.
3. In the Toolbar, click Create.
4. In the Links table, do the following:
In the From Endpoint and To Endpoint areas, specify the Calix devices you are
creating a link from and to:
For C7 networks, select the network, shelf, facility, and port.
For other Calix nodes, select the node in the Network field, and type a port in the
Facility field.
Click Add to move the endpoints to the Links to be Created area.
Optionally, in the Link Type, Description, and Bandwidth fields, type the
information to be associated with the link.
At the bottom of the dialog box, click Create.
5. Click OK to confirm the action.
In the Topology and Map View Work Areas, a blue link displays between the two
devices.
Tip: Hover the mouse over the new link to display the topology information in a
Tooltip.
1. On the Navigation Tree, select a Network Group with a link between devices.
2. In the Work Area, click Topology Links. In the link list, select one or more links to
delete.
3. Click Delete.
If there are two or more links, a list displays where you can select the links to be deleted.
Click OK.
4. In the Confirmation dialog box, click OK to confirm the deletion.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
200
Cut-through sessions require Min (Minimum) CMS Administration privileges and Full
Provisioning privileges for the node on which you want to establish a connection.
Note: For any Calix product that CMS manages using the web cut-through facility, the IP
address of the managed node should be in the DNS database of a server that the CMS host
uses. If this task is not completed, then the Linux host where CMS is running will require an
entry for each managed element added to its /etc/host file.
Calix strongly recommends that you change the default network login credentials delivered
with CMS. Failure to do so may cause auto-provisioning disablement.
Note: If the login user name or password does not match the user name or password, you
cannot connect to the device from CMS.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
201
This procedure assumes that you have performed an initial upgrade to software release 1.0.
Note: For a sequential upgrade, the CMS acts as the master during the software reload
phase. If the CMS server shuts down before the scheduled task completes, you can re-run the
task once the CMS is restored (in the scheduled task list, right-click the task and click Re-
Run). This reloads the software upgrade task from the beginning.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
202
Service-affecting procedure
Calix recommends performing the reload phase of the upgrade during a maintenance
window.
For linear chain topologies, the reload phase is service-affecting for several minutes.
For non-redundant services on ring topologies, the upgrade reset phase is service-
affecting for several minutes.
For redundant services on ring topologies, the reload phase causes a momentary
disruption in service, and the network runs without alternate path protection.
1. Identify the network topology (ring or linear-chain) for the nodes to be upgraded.
2. On the Navigation Tree, click CMS.
3. In the Work Area, click System > Scheduled Tasks > Software Upgrade.
4. In the toolbar, click Create, and then click the type of node you are upgrading.
The New Upgrade Task dialog box opens.
5. In the Schedule Options area, select Schedule for later and then click the calendar icon
to open the Select Date dialog box. Use the single scroll buttons to view the next (or
previous) month or year, click the date to start the upgrade, and then click OK. In the
hour (hr) and minute (min) lists, select the time for the download to start.
6. In the Upgrade Software area, do the following:
a. In the Upgrade Option list, select the action to perform: Both Download/Activate
and Reload, Download/Activate Only, Reload Only or Patch Upgrade.
b. In the File box, type the complete uniform resource identifier (URI) for the full
release image or patch release image file, formatted as follows:
<protocol>://[<user>:<password>]@<host>[:<port>]/<uri-path>/[<file>]
where:
♦ protocol = the transport method (HTTP, HTTPS, FTP, TFTP, SFTP, or
SCP)
♦ user = username on the upgrade server
♦ password = password on the upgrade server
♦ host = IPv4 address or host name
♦ port = logical port number on the upgrade server
♦ url-path = the directory where the software upgrade files reside on the server
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
203
♦ file = filename
The upgrade server username and password are required for SFTP and SCP; all other
parameters in brackets [] are optional.
Note: With SFTP and SCP URLs, the path name given is the absolute name on the
server. To access a file relative to the remote user's home directory, prefix the file with
/~/ , such as: sftp://user:password@home.example.com/~/upgrade-filename.run
Steps 6c to 6e are not applicable for a Download/Activate Only or Patch Upgrade
task.
c. In the How to Reset list, select one of the following:
Sequentially: For ring network topologies, perform a reload on one node at a
time.
In Parallel: For linear chain network topologies, perform a reload on all nodes in
parallel.
Note: Do not mix ring and linear chain networks in the same scheduled task.
d. (Optional, for Sequentially scheduled tasks) By default, the Abort check box is
selected. To allow a reset operation if a device fails to boot up, deselect the Abort
check box.
7. In the Network Selection area, select the network groups and nodes to upgrade. To select
a root region, network group, or a single node, right-click over it, and then click Select.
The square to the left of the network group or node changes to green to indicate that it is
included.
Note: Only include nodes configured in a ring topology for a Sequential reload, or nodes
configured in a linear-chain topology for an In-Parallel reload.
a. Select the root region to include all nodes of the same type (based on the selected
upgrade task type).
b. Expand or double-click the root region to view the network groups. Expand or
double-click a network group to view the nodes under it. Selecting a network group
selects all E5-30x/E5-520 nodes under it. Selecting an E5-30x/E5-520 node only
selects a single node.
c. Repeat Step 7b for each additional network group or node to include in the upgrade.
To remove a selected network group or node from the upgrade, right-click it and
click Un-Select.
8. At the bottom of the New Upgrade Task dialog box, click OK to save the settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
204
Managing C7 Networks
CMS support for Calix C7 networks described in this guide includes the following:
Organize C7 networks in CMS regions or network groups. See Managing Regions and
Network Groups (on page 92).
View and manage C7 alarms in the CMS Alarm Table and perform historical queries of
alarms. See Fault Management (on page 257).
Search C7 network elements in the CMS database based on user-defined criteria. See
Searches and Inventory Reports (on page 96).
View and filter IP hosts, PPPoE hosts, MAC hosts, and DHCP leases.
Open a TL1 cut-through session for management and open a cut-through C7 iMS
session.
CMS support for Calix C7 networks described in the C7 platform documentation includes
the following:
Create global C7 profiles and subscriber templates.
Using the Services screen to activate voice, data, and video subscriber services.
Note: A user security model for C7 networks enables CMS system administrators to
designate user groups for min. (viewing) access or full provisioning privileges to functional
areas of the C7. For details, see Functional Privileges (on page 68).
For configuration and other details, see the Calix C7 platform documentation.
Creating a C7 Network
When creating a C7 network, Calix recommends providing IP addresses to two separate
AMP cards to ensure redundant access to the network.
Connecting a C7 network to the CMS server assumes that you have assigned shelves and
nodes to the network and have configured a valid IP address on the Ethernet port on the
AMP or ATP card. You can launch the iMS locally at the network to verify the information.
Note: By default, in C7 Node View, CMS displays a graphic of a rack with C7 shelves in top
to bottom order. To reverse the shelf order from bottom to top, set the Reverse Shelf Order
network parameter to Y (Yes) after creating the network.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
205
To create a C7 network
1. On the Navigation Tree, click the parent region or network group for the new C7
network.
2. Click Create > C7.
Note: You must be in one of the following Work Area tabs to create a C7 network: CMS
Region (at the root region), Topology (at a network group), Map View, or Network
Detail > C7.
3. In the New C7 Network dialog box, do the following:
a. In the Network Name box, type a name for the network.
Note: Network names can contain alphanumeric characters, underscores, and spaces,
and are case-sensitive. In addition, you cannot use the same name for a network that has
already been created.
b. In the Location list, click the region to use as the parent for the new network.
c. In the IP Address 1 box, type the IP address to use to connect to the C7 network. If
there is an alternate IP address, type it in the IP Address 2 box.
d. In the Port box, leave the box blank to use the default port number (50000) used to
connect to the C7 network. To use a different port number, type the number.
e. In the Network Login Username and Network Login Password boxes, leave the
boxes blank to use the default C7 user name and password to connect to the C7
network. If the C7 network uses a unique user name and password, type them in the
boxes.
Note: Default network login user names and passwords are defined in the Systems
Settings area.
f. In the Auto Connect list, accept the default Y to automatically connect to the
network after creating it.
g. In the Synchronize CMS Time to Network list, accept the default Y to optimize
alarm and log synchronization.
h. In the Enable Global Profiles list, accept the default Y to add global CMS profiles to
the network and synchronize changes as they occur.
i. In the Time Zone list, click the local time zone for the C7 network location. CMS
translates the local C7 time to the time zone of the CMS server, and displays alarms
and events in the time zone of the CMS server.
j. (Optional) Specify an address or a latitude and longitude for viewing the new network
icon in Map View. Click the ellipsis button to the right of the Address Location Info
box to open the entry dialog box, and do one of the following.
Type the address location in the box provided. Click OK to save the information.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
206
Click the Enter Lat/Lng radio button and type the latitude and longitude in the
respective boxes. Click OK to save the information.
4. At the bottom of the New C7 Network dialog box, click OK to create the network.
5. (Optional) In the network view Work Area, move the new network icon by clicking and
dragging it. At the network level in the Navigation Tree, you can click and drag the C7
nodes.
Related topics
Viewing or Managing C7 Network Parameters (on page 206)
Changing the Default C7 Network User Name and Password (on page 371)
Display Name The name that displays next to the network on the Navigation Tree.
Region* The parent region or network group under which the network displays on the
Navigation Tree.
Connection State The current network connection status (Synchronized, Connected, or
Disconnected).
Synchronized indicates that the network inventory data and global profiles are
synchronized with CMS.
Connected indicates that database changes on the network have not
synchronized with CMS. This status can occur if the network was disconnected
from CMS or C7 database and change events were lost; it does not indicate an
error condition. Typically, the status changes to Synchronized following the next
inventory snapshot scheduled task.
Disconnected indicates that the network has disconnected from CMS. A
Network Dropped alarm is raised when the network disconnects from CMS
except in this circumstance: The CMS server restarts and the network does not
successfully connect to CMS.
For more information, see Troubleshooting a C7 Network Connection (on page
208).
IP Addresses 1 and 2* The in-band or out-of-band (or combination) IP addresses of the C7 network.
Use the second address for redundancy. Be sure each address references a
separate AMP or ATP card.
Note: To modify the C7 network IP parameter, see the procedure below, "To edit
a C7 network IP address."
Port* The port used to connect to the C7 network.
Note: Only modify this parameter if the C7 network uses a port other than the
default of 50000.
Network Login Name* The user name or ID used to log in to the C7 network. If you are using the default
C7 user name, that user name displays in this field.
Synchronize Time* To optimize alarm and log synchronization, Calix strongly recommends that you
accept the default to synchronize the network time to CMS system time on a
daily basis. CMS time represents the time on the CMS server. By default, the
Synchronize CMS Time to Network parameter is set to Y (Yes) to report network
alarms and events logs in CMS system time.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
207
Note: You can view the C7 network time for an alarm or event in the alarm and
event logs.
Auto Connect* Controls whether the system attempts to automatically reconnect if CMS detects
that the network is disconnected. By default, this parameter is set to Y
(automatically attempt to reconnect). Set it to N to manually reconnect
disconnected networks.
Note: If you set the parameter to N and the network gets disconnected, the
network is skipped for any scheduled tasks (such as C7 backups).
Note: By default, CMS system checks the network connection state every 30
minutes. If you change the Auto Connect value from N to Y, the system takes up
to 30 minutes to reconnect.
Time Zone* Specifies the network time zone in the number of hours in relation to GMT. When
you create a network, you assign it to a time zone.
Software Version The software version of the C7 network. This is a display only field. To upgrade
the software version, contact technical support.
Cache Enabled* Specifies whether or not cache is enabled on the CMS server to improve
performance of networks.
RADIUS Enabled* Specifies whether RADIUS authentication is enabled or disabled.
Global Profiles Enabled* Specifies whether global profiles are enabled or disabled.
Reverse Shelf Order* Specifies whether shelves within a rack display from top to bottom (N) or bottom
to top (Y) in Node View.
* Parameters listed above with an asterisk can be edited.
Editing network details and deleting networks require Full CMS Administration privileges.
1. On the Navigation Tree, click the parent region or network group of the C7 network you
are viewing.
2. In the Work Area, click Network Details > C7 Networks.
3. To edit a parameter, do the following:
a. In the network list, hold down the Ctrl key and click the network(s) to edit.
b. In the Edit row, modify the editable parameters as needed.
c. Click Apply, and then click OK to save the new settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
208
2. Log in to iMS on the C7 network you are updating and do the following:
a. In the Navigation Tree, select the C7 shelf with the admin master AMP or ATP card.
b. In the Work Area, click Login Channel. In the Ethernet port area of the port used
for connectivity, change the IP address to match the new address.
c. Click Apply, and then click OK to save the new setting.
Local access to this network is lost and the iMS session times out after a few minutes.
3. In CMS Desktop, update the IP address and connect to the network:
a. Select the C7 network as in Step 1a and Step 1b.
b. In the Edit row, modify the IP Address to match the new address.
c. Click Apply, and then click OK to save the new setting.
d. Manually connect to the C7 network (on page 209).
Note: C7 networks must be in a disconnected connection state (see Step 4 in the following
procedure) before they can be deleted.
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > C7 Networks.
3. In the node list, select the network(s) to delete.
4. (If the network displays as Connected in the Connection State column) In the toolbar,
click Action > Disconnect, and then click OK to confirm the action.
5. In the toolbar, click Delete, and then click OK to confirm the deletion.
Perform these troubleshooting actions in the following order until the C7 network
connection problem is cleared:
From a Telnet or X terminal session, ping the network from the CMS server using
the IP address, user name, and password used to create the network in CMS.
Note: A blank User Name field in the Network Information screen indicates that the
network was created using the default C7 user name and password.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
209
Investigate for possible LAN/firewall issues between the CMS server and the
network.
Check that the network login and password used by CMS are valid.
If the network has raised a Network Dropped alarm, delete the network from CMS
and recreate it.
Investigate for a possible admin master AMP/ATP card failure in the network.
Connecting to C7 Networks
If you set the C7 auto-connect parameter to Y (Yes) when you create a C7 network, CMS
automatically attempts to establish a network connection. Thereafter, by default, CMS checks
the network connection statuses every 30 minutes. If the system detects a disconnected
network, it automatically attempts to reconnect using the defined network parameters.
Note: After a C7 network is created and connected in CMS, the connection is set not to time
out, regardless of the C7 user account timeout setting.
To connect to one or more networks manually, or to exclude the network from automatically
reconnecting, you can set the auto-connect parameter to N (No). You can then use the
following procedure to manually connect to a single network or to multiple networks at a
time.
Option 1
1. Select a single network on the Navigation Tree:
a. On the Navigation Tree, expand or double-click a disconnected network.
b. In the confirmation dialog box that displays, click Yes.
Option 2
2. Connect to one or more networks from a list of networks:
a. On the Navigation Tree, click the parent region or network group.
Tip: From the root region, you can view a list of all C7 networks in CMS.
b. In the Work Area, click Network Details > C7 Networks.
c. In the network list, use Ctrl+click to select networks one at a time or Shift+click to
select a range of networks to connect to.
d. Click Action > Connect.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
210
For information about using the tools, see the Calix C7 Broadband Data Services Guide.
DSLAM Aggregation
The ATM-to-Ethernet Aggregation tool provides a simple way to aggregate downstream
ATM DSLAMs (on OCx, DSx and IMA interfaces) to an Ethernet uplink.
Using the VLAN per port model, the ATM to Ethernet Aggregation tool maps downstream
ATM VP/VC values to single-tagged or double-tagged (S-Tag/C-Tag) Ethernet VLANs.
When used for ATM DSLAMS, this tool simplifies the bridging of contiguous ranges of VC
values within the context of a defined VP (representing an ATM DSLAM). It supports
DSLAM-per-VP segmentation (one DSLAM per VLAN) as well as multiple DSLAMs (with
identical VP/VC values) on the same VLAN by providing VC-to-CVID (C-Tag) offsets.
For information about using the tool, see the Calix C7 Broadband Data Services Guide.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
211
Ethernet-over-SONET Provisioning
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
212
For details on how to use the Rolls tool, see the Calix C7 Maintenance Guide.
Using the VLAN per port model, the ATM to Ethernet Aggregation tool maps downstream
ATM VP/VC values to single-tagged or double-tagged (S-Tag/C-Tag) Ethernet VLANs.
When used for ATM DSLAMS, this tool simplifies the bridging of contiguous ranges of VC
values within the context of a defined VP (representing an ATM DSLAM). It supports
DSLAM-per-VP segmentation (one DSLAM per VLAN) as well as multiple DSLAMs (with
identical VP/VC values) on the same VLAN by providing VC-to-CVID (C-Tag) offsets.
For information about migrating service from BPON to GPON, see the Calix C7 Maintenance
Guide or the Calix C7 FTTP Services Guide.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
213
Deleting a C7 Shelf
CMS supports deleting a C7 shelf from a ring network. This process is typically used when
breaking a ring into smaller networks.
Process overview
1. Ensure the shelf meets the listed conditions to be deleted successfully.
2. Align end-to-end cross-connections, using the Bulk Provisioner tool.
3. Manually align any one-way cross-connections that are shown as misaligned.
4. Delete or move all cross-connections originating or terminating on this shelf.
5. Move fiber and hardware connections.
6. Delete the shelf from the network, using CMS.
For a complete procedure with detailed instructions for the steps listed above, see the Calix
C7 Maintenance Guide.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
214
Note: From an ADSL port, only the IP hosts for which the L2IFAID has a corresponding
VC endpoint are listed.
1. On the Navigation Tree, select ports from the following options:
One or more ADSL ports on an ADSL or COMBO card
One or more ONT Ethernet or HPNA ports on an ONT
One or more GE ports on a GE-2p card
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
215
Use Shift+click to select a range of ports, or Ctrl+click to select one port at a time.
2. In the Work Area, click Subscriber > IP Host.
To view and filter IP host information from an IRC card or virtual router (CMS only)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
216
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
217
Parameter Description
L2IFTAID Layer 2 interface access identifier AID: subscriber port on which the host was discovered,
OR the AID of the remote endpoint of the subscriber VC
MACADDRESS MAC Address of the host as learned from the PPPoE Discovery packet
SESSION PPPoE session (Y or N)
PPPENCAP PPP encapsulation:
ALL (both PPPoE and PPPoA)
PPPoA (Point-to-Point Protocol over ATM)
PPPoE (Point-to-Point Protocol over Ethernet)
PPPoASTATE PPPoA state (cross-network or PPPoE session search only):
CONNECTED
CONN_LCPREQ (Connected, PADS received, LCP configuration request sent to
Access Concentrator)
CONN_PADT (PADT received; session terminating)
DISC_PADI (Disconnected, PADI broadcast)
DISC_PADR (Disconnected, PADO received and PADR sent)
VLAN Virtual LAN
To view and filter PPPoE host information across C7 networks (CMS only)
To view and filter PPPoE host or session information from a virtual bridge (CMS
only)
1. On the CMS Desktop Navigation Tree, select one or more virtual bridges (VB).
2. In the Work Area, do the following, click one of the following:
For PPPoE host information, PPPoE > Host
For PPPoE session information, PPPoE > Session
3. View the results on screen, using the options in Step 4 or Step 5 to filter or customize the
list.
4. (Optional) Filter host entries based on a specific parameters. At the bottom of the Work
Area, click Unfiltered. In the Filter dialog box:
a. Specify an AC or host MAC address filter by typing it in the corresponding field.
b. Specify the PPP encapsulation method by selecting PPPoE or PPPoA from the list.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
218
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
219
To view PPPoE host information from an ADSL or ONT subscriber port (CMS only)
Note: From an ADSL port, only the PPPoE hosts for which the L2IFAID has a
corresponding VC endpoint are listed.
1. On the CMS Desktop Navigation Tree, select one of the following:
An ONT Ethernet or HPNA port.
An ADSL port.
2. In the Work Area, click Subscriber > PPPoE Host.
3. View the results on screen, using the options in Step 4 to customize the list.
4. (Optional) Customize the display using any of these features:
Sort the results by a parameter by clicking a column heading.
Customize the display order, view parameter definitions, or export the results to a
browser window or to a CSV file:
Move the cursor over the column heading row.
Right-click to display a popup menu, and then select a menu option.
Change the number of records that display on screen by entering enter a different
value in the Enter Number of Records box (default is 50) at the bottom of the Work
Area.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
220
From a virtual bridge or shelf, you can filter results based on the MAC host address,
bridge, VLAN, Layer 2 interface address, and static provisioning.
From the various points in the C7 system listed above, you can view the following
parameters.
Parameter Description
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
221
1. From CMS, expand the Navigation Tree, and do one of the following:
Click the subscriber port, and then click Subscriber > MAC Host.
Click the line card, and then click MAC Host.
Click the Shelf or VB, and then click VLANS > MAC Host.
By default, CMS shows the following MAC information for shelf and VB:
Shelf = local bridge, RAP10-GE-CSA, selected VLAN (if selected) or default
VLAN for the selected shelf
VB = virtual bridge, VLAN
To view and filter DHCP leases from an IRC card or virtual router (CMS only)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
223
Your CMS system administrator can set the default FTP server options: IP address, user
name, and password of the FTP/SFTP host server.
Note: If you set the node's Auto Connect parameter to N (do not automatically reconnect)
and the node gets disconnected, the node is skipped when a scheduled task runs, and no
failure is reported in the task details.
For instructions, see Performing Shelf and Node Backups (on page 355).
You can optionally generate an inventory report of MAC and IP hosts on Calix networks.
Related topic
Scheduling an Inventory Snapshot (on page 366)
CMS TL1 commands are similar to C7 TL1 commands, but additionally require one of the
following as the Target Identifier (TID) parameter location (between the colons after the
command verb):
The C7 network name, prefixed by NTWK- (for example, NTWK-1415 North Road
CO).
Note: The prefix and network name are case-sensitive.
The System Identifier (SID) of any node in the C7 network you are interested in.
Note: Using the node SID does not change the scope of the command. It is only used to
identify the network. Any shelf in the network can be referenced regardless of the node
SID that is used in the command.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
224
SSH client: Enter the IP address of the CMS server. The CMS secure TL1 port is
8190. At the prompts, use your CMS administrative user name and password log in.
2. At the prompt, enter the TL1 command. In the TID parameter location, use the C7
network name (prefixed by NTWK-) or the SID of any node in the C7 network you are
connecting to.
Examples
The CMS TL1 command to retrieve shelf 1 on node 1 in a C7 network named 1415 North
Road CO (with two nodes (SIDs) named 1415Node_1 and 1415Node_2) can be formed in
these two ways:
RTRV-SHELF:NTWK-1415 North Road CO:N1-1;
RTRV-SHELF:1415Node_1:N1-1;
The CMS TL1 command to retrieve equipment on shelf 1 on node 1 in the same C7 network
can be formed in these two ways:
RTRV-EQPT:NTWK-1415 North Road CO:N1-1;
RTRV-EQPT:1415Node_1:N1-1;
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
225
Future support in the iMS includes displaying the C7 future network on the Network Tree,
aggregating alarms, and accessing alarm logs. See Future Calix Platform Release Support (on page
411) for more information.
The CMS TL1 and iMS cut-through feature supports secure and insecure connections based
upon the C7 network security settings. See Connection Security Modes (on page 60) for
information about the CMS-to-C7 security mode.
With the CMS Desktop cut-through feature, you can right-click a network and start a TL1 or
C7 iMS session on that network. CMS supports one TL1 cut-through to each C7 network. If
you open a second TL1 cut-through session, the first session terminates. CMS supports up to
a total of 20 combined TL1 and iMS cut-through sessions to C7 networks managed by the
CMS server. Cut-through sessions require Full CMS Administration privileges and Full C7
Provisioning privileges on the C7 network you connect to.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
226
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
227
Managing B6 Networks
CMS support for Calix B6 networks described in this guide includes the following:
Organize B6 networks in CMS network groups. See Managing Regions and Network Groups
(on page 92).
View and manage B6 alarms in the CMS Alarm Table and perform historical queries of
alarms. See Fault Management (on page 257).
Search B6 network elements in the CMS database based on user-defined criteria (B6
nodes only). See Searches and Inventory Reports (on page 96).
Open a cut-through B6 session to the local EWI user interface.
CMS support for Calix B6 networks described in the B6 platform documentation includes
the following:
Create global profiles and subscriber templates.
Activating voice, data, and video subscriber services.
For configuration and other details, see the Calix B6 platform documentation.
If the Calix device is discovered but is already connected to CMS, a message displays in the
task results indicating that the network already exists.
Note: Full CMS Administration privileges are required to discover B6 cards and chassis in
CMS.
Note: CMS releases 12.0 and higher support B6 cards running release 7.1 and higher.
Note: CMS must be added as the SNMP trap host on B6 cards running R7.1. This
requirement does not apply to B6 cards running release 7.2 and higher:
B6(config)#snmp-server host all <cms-ip>
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
228
Parameters
You can provision the following parameters for Range Discovery:
Parameter Description Valid Options
BSERIES Select to include B6 line units.
E5-306/308/520 Select to include E5-30x/E5-520 units.
IP Range In the IP Range and To boxes, type the beginning
and end of the IP address range for the card you
wish to discover. Values are inclusive.
Netmask 255.255.255.00‡
Exclude (Optional) Excludes the specified IP range.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
229
7. After the Task progress window is closed, discovered B6 line cards and chassis may be
viewed in the Navigation Tree under the "autodiscovered" network group. They can be
moved to another regional or network group, as described in Topology (on page 230).
Creating a B6 Card
Use the following procedure to add and connect to a single B6 card to CMS. Once added,
the card displays the card within its B6 chassis in the Navigation Tree.
Note: You must be in one of the following Network Group Work Area tabs to create a B6
card: Topology, Map View, or Network Details > B6.
1. Click Create > B6.
2. In the New B6 dialog box, do the following:
a. In the Name box, type a name for the card.
Note: Names can contain alphanumeric characters, underscores, and spaces, and are
case-sensitive. In addition, you cannot use the same name for a card that has already been
created.
b. In the Location list, click the network group to use as the parent for the new card.
c. In the IP Address 1 box, type the IP address to use to connect to the B6 card.
Note: Default card login user names, passwords, and community strings are defined in
the System > B6 Work Area in CMS Desktop.
d. In the Read Community and Write Community boxes, leave the default entries in to
use the default B6 Read and Write SNMP community strings. If the B6 card uses
unique SNMP community strings type them in the boxes.
e. In the CLI and Web Username and Password boxes, leave the default entries in to
use the default B6 user names and passwords to connect to the B6. If the B6 card
uses a unique user name and password, type them in the boxes.
f. In the Auto Connect list, accept the default Y to automatically connect to the card
after creating it.
g. (Optional) Specify an address or a latitude and longitude for viewing the new card
icon in Map View. Click the ellipsis button to the right of Address Location Info to
open the entry dialog box, and do one of the following.
Type the address location in the box provided. Click OK to save the information.
Click the Enter Lat/Lng radio button and type the latitude and longitude in the
respective boxes. Click OK to save the information.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
230
3. At the bottom of the New B6 Device dialog box, click OK to create the card.
4. (Optional) In the network view Work Area, move the new card icon by clicking and
dragging it. At the card level in the Navigation Tree, you can click and drag the B6
devices.
Topology
The topology page view displays discovered B6 cards in a network, links between the B6
cards and any alarms that may be present on the B6 cards. You may change the chassis
region and name by clicking the ACTION tab in the CMS work area.
Note: The PROVISION ETHERNET TOPOGRAPHY feature is not supported for the
B6 in this release.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
231
The following steps describe how to create a new region for the B6 chassis, if required:
1. On the Navigation Tree, click the parent region under which to place the new region or
network group. You can click the root region, or expand the root region and click an
existing region as the parent.
2. From the CMS Region or Map View Work Area:
Click Create > Region to create a region.
Click Create > Network Group to create a network group.
3. In the New Region or New Network Group Name box, do the following:
a. Type a name for the region or network group.
Note: Names can contain alphanumeric characters, underscores, and spaces.
b. In the Parent Region list, select the parent region for the new region or network
group.
c. Click OK.
Topology Links
After discovering B6 cards in CMS, you can view the following information about the links
between them:
NE1 Name and Port IP address of the B6 card on one end of the link and the port number on which the
link is connected.
NE2 Name and Port IP address of the B6 card on the other end of the link and the port number on
which the link is connected.
Parent Group Name The name of the region in which the B6 cards reside.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
232
Network Details
After discovering a B6 card in CMS, you can view or edit the parameters listed in the
following table:
Name The name that displays next to the B6 card on the Navigation Tree. This is the
hostname of the B6 card, an underscore, and the B6 card's IP address.
IP Address* The IP address of the platform.
Network Group* The parent network group under which the B6 card is nested on the Navigation
Tree.
Connection State The current unit connection status (Connected or Disconnected).
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > B6.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
233
To delete a B6 device
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > B6.
3. In the device list, select the units(s) to delete.
4. (If the node displays as Connected in the Connection State column) In the toolbar, click
Action > Disconnect, and then click OK to confirm the action.
5. In the toolbar, click Delete, and then click OK to confirm the deletion.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
234
Sometimes you may need to provision a higher (later) version of B6 software though CMS,
even though such networks have not been tested on, and may not work with, that CMS
software server version. The cut-through feature of CMS enables you to do so by configuring
the CMS server to act as a proxy for the client.
Future support in the EWI includes displaying the B6 future network on the Network Tree,
aggregating alarms, and accessing alarm logs. See Future Calix Platform Release Support (on page
411) for more information.
The CMS Telnet and EWI cut-through feature supports secure and insecure connections
based upon the B6 network security settings.
With the CMS Desktop cut-through feature, you can right-click a network and start a Telnet
or B6 EWI session on that network. CMS supports one Telnet cut-through to each B6
network. If you open a second TL1 cut-through session, the first session terminates. CMS
supports up to a total of 20 combined Telnet and EWI cut-through sessions to B6 networks
managed by the CMS server. Cut-through sessions require Full CMS Administration
privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
235
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
236
Synchronizing the GPON OLT Manifest File with the GPON OLT
6. View the configured location of the repository server on the Configure Task screen. This
location was configured in the System > B6> General tab, as described in Configuring
the Manifest File Path (on page 235). Click the Next button.
7. Schedule when you want the change in the location of the GPON OLT repository path
to occur as follows:
Use the check boxes to select one of the scheduling options:
Select Execute Now to start the upgrade immediately.
Select Schedule At and click the ellipses button (...) to open a calendar window
that allows you to select a specific date and time for your upgrade. Click the OK
button on the calendar window when you are done.
Click the Finish button when you are done.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
238
Download Only radio button: Select this button alone to update the manifest file on
the repository server and download the GPON ONT software image file without
activating the software.
Activate radio button: Select this button with the Download Only button to update
the repository manifest file and activate the GPON software image after download
(reload the GPON ONT). This is the default setting.
Click the Next button.
8. Schedule when your upgrade will occur as follows:
Use the check boxes to select one of the scheduling options:
Select Execute Now to start the upgrade immediately.
Select Schedule At and click the ellipses button (...) to open a calendar window
that allows you to select a specific date and time for your upgrade. Click the OK
button on the calendar window when you are done.
Click the Finish button when you are done.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
239
Note: Management of the E3-48C is described under Managing E7, E3-48 and E5-400 Nodes
(on page 129).
E3/E5-100 nodes are added to a network group on the CMS Navigation Tree.
Add the new node to a CMS network group to enable management from CMS. This task
requires that the E3/E5-100 node is configured with a valid IP address.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
240
Note: Node names can contain alphanumeric characters, underscores, and spaces, and
are case-sensitive. In addition, you cannot use the same name for a node that has already
been created, regardless of node type.
b. In the Location list, click the network group to use as the parent for the new node.
c. In the IP Address 1 box, type the IP address of the E3/E5-100 node.
d. In the SNMP Port box, accept the default CMS port number (161) for provisioning
requests, or type a different port number to use if provided by your IT system or
CMS administrator.
e. In the Read Community and Write Community boxes, leave the fields blank to use
"public" as the community strings, or type different values if provided by your IT or
CMS administrator.
f. In the HTTP and HTTPS Port fields, accept the default ports to use for nonsecure
and secure connections between the CMS server and the Web interface.
g. In the Network Login User Name and Password boxes, leave the boxes blank to use
the default E3/E5-100 user name and password to connect to the node. If the node
uses a unique user name and password, type those in the boxes.
Note: Default login user names and passwords are defined in the System Settings (on page
376) Work Area.
h. In the Auto Connect list, accept the default Y to turn on an automatic system check
that confirms the node can be reached via SNMP.
i. In the Synchronize CMS Time to Network list, accept the default Y to synchronize
the E3/E5-100 node time with the CMS system time.
Note: If the E3/E5-100 node uses an NTP server and the Override NTP Settings
parameter (below) is set to N, the setting in this field is not used.
j. In the Enable Global Profiles list, accept the default Y to add global CMS profiles to
the node and synchronize changes as they occur.
k. (Optional) Specify an address or a latitude and longitude for viewing the new node
icon in Map View. Click the ellipsis button to the right of the Address Location Info
box to open the entry dialog box, and do one of the following.
Type the address location in the box provided, and then click OK to save the
information.
Click the Enter Lat/Lng radio button and type the latitude and longitude in the
respective boxes. Click OK to save the information.
l. In the Override NTP Settings, accept the default N to use the NTP server time if the
E3/E5-100 node uses an NTP server. Click Y to override the NTP server time with
the CMS system time.
m. At the bottom of the New Node dialog box, click OK to create the node.
5. (Optional) In the network group Work Area, move the new node icon by clicking and
dragging it.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
241
Related topics
Viewing or Modifying E3/E5-100 Node Parameters (on page 241)
Creating a Graphical Link Between Devices (on page 94)
Display Name The name that displays next to the node on the Navigation Tree.
Network Group* The parent network group under which the node is nested on the Navigation Tree.
SNMP Port* The outgoing CMS server port used for provisioning requests. Check with your IT
system or CMS administrator to determine the port number to use.
Network Login Name* The user name used to log in to the E3/E5-100 node.
Synchronize Time* Enabled (Y) optimizes E3/E5-100 alarm and log synchronization.
Override NTP* No (N) does not change the node time at the E3/E5-100 node.
Yes (Y) overrides the E3/E5-100 node time to use the CMS system time.
Note: Overriding the E3/E5-100 node time sets the local node's "Use Time Server
at Bootup" setting to None, and the Daylight Savings Time (DST) settings, when
configured, are not used.
Auto Connect* Yes (Y) automatically attempts to reach to the node via SNMP approximately once
every minute.
No (N) turns off this feature.
Note: If you set the Auto Connect parameter to N (do not automatically reconnect)
and the node gets disconnected, the node is skipped when a scheduled task runs.
Software Version Software version running on the E3/E5-100 node.
Global Profiles Enabled* Yes (Y) synchronizes global profile changes with the E3/E5-100 node as they
occur.
No (N) prevents global profile changes from synchronizing with the E3/E5-100
node.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
242
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > E3/E5-100.
3. To edit one or more of the parameters, do the following:
a. In the device list, click the device to edit.
b. In the Edit row, modify the editable parameters as needed.
4. Click Apply, and then click OK to save the new settings.
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > E3/E5-100.
3. In the node list, select the node(s) to delete.
4. (If the node displays as Connected in the Connection State column) In the toolbar, click
Action > Disconnect, and then click OK to confirm the action.
5. In the toolbar, click Delete, and then click OK to confirm the deletion.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
243
2. Manually connect to the E3/E5-100 node. See Manually Disconnecting and Connecting an
E3/E5-100 Node (on page 244).
A TrapRegFailed alarm indicates node SNMP traps sent to the CMS server from the alarmed
Calix device are unsuccessful.
Recommended Action
1. In a terminal window or remote telnet or SSH session, log in as a root user on the host
server. Verify that the entries in the etc/hosts file are correct:
At the command prompt, type the following: cat /etc/hosts
Use a text editor to edit or add the CMS server static IP address and DNS name to
match the following example:
where 172.21.90.15 is the CMS server static IP address and cmsserver is the name of
the CMS server.
Note: Restarting the CMS Server is not required.
2. Do one of the following:
B6 node: Add the trap destination (in the B6 Web interface, click System > SNMP
Traps).
E3/E5-100 node: Delete one of the trap destinations (in the Configurator interface,
click Advanced Applications > Access Control > SNMP).
E7, E3-48C, E5-48/E5-48C, E5-400 node: Add or update the trap destination (in the
E7 Web user interface, click Management > SNMP > TRAP Destination).
3. (For E-Series devices) Manually register CMS as a trap destination:
On the Navigation Tree, click the root region or the parent network group of the
node.
In the Work Area, click Network Details, and then click the node type.
In the device list, click the node(s).
Click Action > Register Trap.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
244
4. If the above steps do not clear the alarm, delete and recreate the node in CMS.
You can manually disconnect an E3/E5-100 node and reconnect it, for example, after
troubleshooting a connection issue.
1. On the Navigation Tree, click the root region or the parent network group of the device.
2. In the Work Area, click Network Details > E3/E5-100 Nodes.
3. In the device list, select one or more nodes. To select multiple nodes, use Ctrl+click to
select one at a time, or select the first node and then use Shift+click to select a range.
4. Click Action > Disconnect or Connect.
For information on how to create global profiles and subscriber templates for provisioning
service, refer to the publication, Managing Calix E3/E5-100 Service Units with CMS.
To access and modify E3/E5-100 configuration settings, you must have Full Configuration
Management permission as well as Write permission for the region in which the parent
network group is nested.
Once you have added an E3/E5-100 service unit to CMS, on the Navigation Tree, expand
the network group and click the unit. Tabs for each configuration area display in the Work
Area.
For product information and provisioning instructions, log in to the Calix Resource Center and
follow the link to the Calix Documentation Library. In the navigation pane on the left, click
E-Series and locate the links to the user documentation.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
245
The configuration file can be used to restore the E3/E5-100 database at a later date. For
details, see the appropriate Calix E3/E5-100 user documentation.
You can use CMS to schedule a database backup task to occur on a one-time, daily, weekly,
or monthly basis and send database backups to an FTP server. For details, see Scheduling Calix
Network Element Backups (on page 357).
Your CMS system administrator can set the default FTP server options: IP address, user
name, and password of the FTP/SFTP host server.
Note: If you set the node's Auto Connect parameter to N (do not automatically reconnect)
and the node gets disconnected, the node is skipped when a scheduled task runs, and no
failure is reported in the task details.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
246
For instructions, see Performing Shelf and Node Backups (on page 355).
Software upgrades are made available from Calix as new features are added and issues
resolved. Upgrades are typically announced with a Calix Service Bulletin and require
submitting a request to Calix Technical Assistance Center (TAC) to access to the software
upgrade file. Once you have permission, you can log in to the Calix Customer Resource
Center and download the file.
Only a CMS Desktop user in the Administrators user group can schedule a software upgrade.
Note: The following procedure assumes that you have downloaded the upgrade file from the
Calix Customer Resource Center and copied it to a location on your local drive.
Note: When using CMS to schedule upgrades of E-series devices, a single task should not
contain more than 50 networks. For more than 50 networks, wait for one task to complete
before scheduling another upgrade task.
1. On the Navigation Tree, click CMS.
2. In the Work Area, click System > Scheduled Tasks > Software Upgrade.
3. In the toolbar, click Create, and then click the type of service unit you are upgrading.
4. To schedule an upgrade to begin at a later time, select the Schedule for later radio
button. In date and time settings immediately below the radio button selection, do the
following:
Type the date on which to begin the upgrade, or double-click the calendar icon to
open the Select Date dialog box and select the date.
In the hour and minute lists, click the time for the upgrade to start.
To launch the upgrade immediately, select the Immediate one-time execution.
5. In the Upgrade Software area of the New Upgrade Task dialog box, do the following:
a. Select the software version that is currently running on the unit.
b. Select whether the upgrade process completes in one step, or if the file distribution
and reset portion of the process are separated.
c. In the File box, type the path and file name for the installation.bin file. In the version
field, optionally type a description to identify the upgrade.
d. (Optional) By default, the Upgrade Only check box is selected.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
247
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
248
CMS supports one Telnet or Web cut-through to each E3/E5-100 node. CMS supports up
to a total of 20 combined Telnet sessions to E3/E5-100 nodes managed by the CMS server.
Cut-through sessions require Full CMS Administration privileges and Full C7 Provisioning
privileges on the node you connect to.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
249
CMS provides topology management and cut-through access to the Actelis MetASSIST View
(MAV) EMS, supporting deep diagnostics.
Using the instructions below, you can create an Actelis device and Actelis network elements.
Before starting one of the procedures, download the Actelis JAR file from the Software
Center on the Calix Customer Resource Center.
Use this procedure to add Actelis devices for the first time. If you are already managing
Actelis devices, use the procedure below to update the Actelis JAR.
1. Install Actelis MetASSIST VIEW (MAV) software release 7.0 or later on the same PC as
CMS Desktop.
2. Create a device profile.
a. Select the CMS node on the network navigation tree. Click Profile > Device in the
Work Area, and then click Create.
b. Enter the information in the Device Profile dialog box:
Profile Identifier – unique internal ID for device profile
Device Name – Actelis
Device Jar – path and jar file name for the Actelis jar file
SNMP Version supported – NotSupported
Is Telnet Supported – N
Is HTTP Supported – No
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
250
3. Create a new Actelis network element under a Network group where the Calix platforms
are located that are intended to leverage Actelis for Ethernet over Copper transport.
a. Navigate to the target Network Group. In the Work Area, click Network Details >
Devices, and then click Create > Actelis.
b. Enter the information in the New Actelis dialog box:
Name – globally unique name within the CMS database
Location – Network group where the device is placed
IP Address 1 – IP address of the managed Actelis device
Network Login Username – username provisioned on the device
Network Login Password – password provisioned on the device
Auto Connect – Y (default) to automatically connect to the device
(Optional) Address Location info – click the ellipsis button to enter a physical
address or latitude/longitude coordinates
4. (Optional) From the Topology Map, place the device node in the Network Group where
the Calix devices whose services are transported by the Actelis transport are located.
5. (Optional) Create topology links between the Calix devices and Actelis nodes.
6. Select an Actelis device and launch the MAV EMS to provision new transport bandwidth
as well as perform diagnostics and troubleshooting. (Refer to the Actelis MAV User
Guide for details.) Do one of the following:
In the Navigation Tree, navigate to and select the device.
In the Navigation Tree, navigate to the Network Details screen. Click Network
Details > Devices, select an Actelis device, and then click Action > Launch.
Related topics
Viewing the Topology of a network Group (on page 93)
Provisioning Cross-Platform Ethernet Topologies (on page 116)
Creating a Graphical Link Between Devices (on page 94)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
251
For each device type, you can associate a graphic con to represent individual devices. If a
graphic is not associated with a third party, it will be represented by a question mark in the
map view.
Calix may provide device JAR files enabling provisioning and alarm aggregation of specific
non-Calix devices. The device profile feature includes placeholder fields for a default Telnet
port, HTTP port and cut-through suffix, and SNMP credentials. Use the settings in the
procedures below to create the device.
Note: Load the graphic file that you choose to represent the devices to your local hard drive
before completing this procedure.
1. On the Navigation Tree, select CMS.
2. In the Work Area, click Profile > Devices.
3. Click Action > Construct Icon Profile.
4. In the New Device Profile dialog box, do the following:
a. In the Device Name box, type a short name to use to identify the device. Note the
exact spelling and capitalization, as you will use this name to create the device profile.
b. In the Device Version box, type the version number to display in the CMS Profile
list. Note: Decimals are not allowed.
c. To the right of the Image File field, click the ellipsis button and browse your local PC
hard drive for the GIF or PNG file to use.
d. Click Create.
Once you create a device profile, a device JAR file is loaded on the local PC under the folder
in which the currently-running version of CMS Desktop software is installed.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
252
Note: In the following procedure, a router device name "My Router" is used for example
purposes.
1. On the Navigation Tree, select a network group.
2. In the Topology or Map View Work Area, click Create > My Router.
3. In the New Device dialog box, do the following:
a. In the Name text box, type a unique device name.
Note: Alphanumeric characters and dashes (-) are valid.
b. In the Location list, select the parent network group for the new device.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
253
c. In the IP Address 1 field, type an IP address for the device. (CMS requires an IP
address even if it is placeholder information).
d. Leave the SNMP Port field and the Network Login User Name and Password fields
blank.
e. In the Auto Connect list, select N (No).
f. Click OK to save your settings and create the device.
4. To place the device in your network topology, perform one or more of the following
actions:
a. Create a graphical link from the device to another network element. See Creating a
Graphical Link Between Devices (on page 94).
b. In Map View, use Google Map controls to place the device on the map.
c. In the Topology Work Area, move the new device icon by clicking and dragging it.
Viewing, editing, and deleting non-Calix devices require Full CMS Administration privileges.
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > Devices.
3. To edit, do the following:
a. In the node list, hold down the Ctrl key and click the device(s) to edit.
b. In the Edit row, modify the editable parameters as needed.
c. Click Apply, and then click OK to save the new settings.
1. On the Navigation Tree, click the root region, parent region, or network group.
2. In the Work Area, click Network Details > Devices.
3. In the device list, select the devices(s) to delete.
4. In the toolbar, click Delete, and then click OK to confirm the deletion.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
254
C7 networks
The system performs full database synchronization when the CMS initially connects to, or
accesses, a C7 node. CMS may perform a partial synchronization when CMS loses and
reestablishes connectivity to a C7 node or network, depending on the duration of the outage
and the number of changes that have occurred on the C7 during the outage.
After initial synchronization completes, the CMS server keeps configuration data
synchronized with the C7 network based on configuration data change events as long as
connectivity is maintained. The configuration management database also updates whenever a
“refresh” is requested from the C7.
It is possible that from time to time the CMS database could become out of synchronization
with the C7 network, even after a partial synchronization. This could happen when there is
an error with the synchronization. In this case CMS performs a full synchronization.
F5 nodes
You must manually synchronize the CMS database when F5 nodes are added to CMS. If the
database falls out of synchronization, you must perform a manual synchronization. For
instructions, see Synchronizing F5 Databases.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
255
Reminder: If you have not already done so, Calix recommends creating a new system
administration user and inhibiting the default root user.
Security settings
Review the following security settings and change per your local requirements:
The default security settings
The default C7 network user name and password
See Security Management (on page 49) for information about changing security settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
256
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 6
Fault Management
Calix Management System (CMS) provides centralized fault management for multiple Calix
Active Ethernet (AE) and GPON ONTs, E7 OS networks, C7 networks, E3/E5-100 service
units, and B6 cards., as well as supported non-Calix devices. Using the fault management
features in CMS, you can:
View a synchronized list of all standing CMS, Calix network element, and supported non-
Calix device alarms, color-coded by severity.
View real-time counts of critical, major, and minor alarms.
View real-time updates for alarm setting and clearing.
View historical logs of alarms and events that you can query based on your own filtering
criteria.
Set up E-mail notification of alarms and events, including configuring an optional alarm
delay.
Manage SNMP subscribers.
For information about customizing alarm severity and descriptions for alarms and events, see
Modifying Alarm Severity and Descriptions (on page 265).
Historical alarms and events are stored on the CMS server. For information about querying
historical alarm and event logs, see Querying Historical Alarm and Event Logs (on page 277).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
258
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
259
Viewing alarms requires Min (Minimum) CMS Fault Management, Min CMS Configuration
Management, and Min CMS Administration privileges.
Alarm Table
The Alarm Table displays standing alarms, non-alarmed events, and threshold crossing
events. The table includes the network name and ID columns for identifying the location of
each alarm or event.
Status monitor
The status monitor displays the number of critical (red), major (orange), and minor (yellow)
standing alarms currently listed in the Alarm Table.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
260
Color-coded icons
The Navigation Tree displays color-coded icons for the worst severity alarm status: critical
(red), major (orange), minor (yellow), or none (hollow white) at each level. In the Work Area,
alarm counts by severity display in the region and network icons in CMS Region View and
Network Group Topology view.
Refresh alarms
You can click the Refresh button below the Alarm Table to clear and re-load the list of
alarms or events from the CMS alarm cache. If you have cleared an alarm and the alarm does
not clear from the Alarm Table, you may need to manually synchronize alarms. See Alarm
Synchronization (on page 390) for more information about synchronizing alarms.
Alarm sources
Double-click a network or node alarm in the Alarm Table to view the provisioning details for
the network element in the Work Area. This helps to identify, isolate, diagnose, and resolve
service affecting problems.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
261
Alarm Help
All alarms other than CMS alarms are specific to a Calix network or node. Alarms display in
the Alarm Table in CMS Desktop with corresponding network IDs to help you quickly
identify the location.
CMS provides help for troubleshooting the most common alarms generated by CMS and
Calix network elements. The alarm help displays the alarm error code, description, and
recommended corrective actions.
See also
For AE ONT alarms, see the Calix 700GX Active Ethernet ONT Troubleshooting and
Maintenance Guide and the Calix 2300 AE ONT Configuration Guide.
For C7 network alarms, see the Calix C7 Troubleshooting Guide.
For E-Series node alarms, see the platform-specific Calix user guide.
For CMS-specific alarms, see Troubleshooting CMS Alarms (on page 396).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
262
You can optionally filter the CMS Alarm Table for acknowledged or non-acknowledged
alarms.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
263
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
264
In the Ack list at the bottom of the screen, select one of these options:
Blank (default): Display both acknowledged and non-acknowledged alarms.
N: Display only non-acknowledged alarms.
Y: Display only acknowledged alarms.
3. Below the Alarm Table, click Refresh.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
265
Note: CMS does not support modifying alarm severity and descriptions for non-Calix
devices.
The CMS system uses these rules to assign alarm severity and definitions:
If you do not modify an alarm: CMS uses the alarm severity and description exactly as
received from network or node.
When you modify an alarm: If the severity of a raised alarm matches the original severity
and facility type listed in the Alarm Redefinition list, CMS uses the modified alarm
definition.
If you modify an alarm, but the conditions indicated in the preceding two bullets are not
met: CMS uses the alarm severity and description exactly as received from the network or
node.
For a C7 alarm with an Equipment facility type, you can optionally add rules to use these
equipment categories: 1) AMP cards; 2) RAP cards; or 3) other plug-in cards. If the
condition in the above bullet is met and the equipment type of a raised alarm matches
that in the rule, CMS uses the modified alarm definition.
For AE ONT, B6, C7, and E-Series node alarms, you can revert back to the original alarm
definitions, if needed.
Follow these guidelines when modifying the severity or description of an alarm or event:
To avoid unintended consequences, be sure you understand the effect of any
change before modifying an alarm or event.
For many alarms and events, the default severity differs depending on field or equipment
conditions such as the service state of the card or port.
Environmental alarms in the C7 can be user-defined at the node level.
You can change an alarm description, but not an actual alarm or event name.
Modifying the default severity or description for alarms requires Full CMS Administration
privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
266
a. (Optional, for a C7 Equipment facility type alarm only) In the Equipment drop-down
list, select AMP, RAP, or Line Unit to only apply the alarm definition to alarms of
that category. You can create up to three rules for each alarm.
b. Assign the severity by clicking a different value in the Severity list.
The background color of the severity list changes to match the severity selected.
c. (Optional) Change the description by clicking in the Description text box and typing
the new description to display in CMS.
d. (Optional) Record notes about the alarm redefinition by clicking in the User Notes
text box and typing notes.
e. At the bottom of the page, click Submit to save the new settings. The new severity,
description, and time of modification display in the Severity, Description, and Last
Updated columns on the Alarm Redefinition page.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
267
To restore default alarm definitions (AE ONT, B6, C7, and E-Series platforms)
1. Open CMS Web (on page 38) and navigate to the Alarm Redefinition page.
2. At the top of the page, click Site Map. Alternatively, in the Module list on the left, click
Administration > Alarm Redefinition and then click the platform.
3. Do one of the following:
To restore a single alarm to the default setting:
On the Alarm Redefinition page, scroll to locate the alarm in the list. Click the
pencil icon on the right to open a Web page for editing the alarm details.
At the bottom of the page, click Restore Default. Click Submit to save the
settings.
To restore all alarms to the default settings, click Restore All to Default.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
268
Creating, disabling, or deleting an alarm suppression filter requires Full CMS Administration
privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
269
Tip: Define an alarm suppression rule that is as specific as possible. For filters that are
not set, all device types, networks, alarm IDs, facilities, alarm severities, or alarm types are
suppressed.
Tip: For filter criteria lists, to select multiple items, use Ctrl+click to select one item at a
time, or Shift+click to select a range of items.
In the Device Type list, select the device(s) to include.
In the Network list, select the network(s) to include.
In the ID list, select a match criterion (Contains, Ends With, Equals, Not Equals, or
Starts With), and then in the text box to the right, type the access identifier (AID)
string to match.
In the Facilities list, select the facilities(s) to include.
In the Severity list, select the alarm severity(s) to include.
In the Alarm Type, select the alarm(s) to include.
In the Service-Affect list, All is used by default. Select Yes to include only service-
affecting alarms or No to include only non-service-affecting alarms.
Note: Leave the Start Time field blank to suppress all alarms up to the end time, if
specified. Leave the End Time field blank to suppress all alarms starting from the start
time, if specified, as well as all future alarms.
(Optional) Specify a date and time to activate and deactivate the alarm filter. To the
right of the Start Time and End Time fields, click the calendar icon to open a pop-up
window for setting the time and selecting a date. Alternatively, you can enter a date
and time using the format MM/DD/YYYY HH:MM:SS.
6. At the bottom of the screen, click Save. On the Alarm Suppression page, the newly
created alarm filter displays with a Y under the Enabled column.
In the Suppression list at the bottom of the screen, select one of these options:
Blank: Display both suppressed and non-suppressed alarms.
N (default): Display only non-suppressed alarms.
Y: Display only suppressed alarms.
3. Below the Alarm Table, click Refresh.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
271
Option Details
Use the View alarms for a selected level on the Navigation Tree. For example, display the
alarms for a network, node, or shelf.
Navigation Tree
Use the Selection For C7 networks, at the network level or below on the Navigation Tree, view alarms
specific to one of the available filters. For example, display alarms relating to a
Filter facility type or interface group.
By default, all standing alarms appear in the Alarm Table. Use this procedure to display
specific alarms based on network topology, device, and selection criteria that you choose.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
272
Click Use Selection Filter to display only those alarms on the Navigation Tree level
that you selected in Step 1.
Click Use Selection Filter and Include Children to display alarms on the selected
Navigation Tree level, including all subordinate levels.
Select a device in the Device list to display network element-specific alarms.
3. (Optional, for C7 networks) At the C7 network level or below, on the Navigation Tree,
apply a Selection Filter criterion, as follows:
a. Below the Navigation Tree, click the label to the right of Filter.
b. Click C7, and then click a category (for example, Equipment) and subcategory.
Viewing Events
In the Events and Threshold Events tabs in the Alarm Table, you can view the most recent
C7 non-alarm events and conditions, including threshold crossing events. Threshold crossing
events are performance statistics that exceed defined threshold settings.
You can view the 300 most recent events and threshold crossings. For older information, you
can query the logs of historical events in CMS Web.
Threshold Value Outer limit value(s) for the parameter for threshold crossing events
Time Period Interval for threshold crossing data: 15-Minute Interval or 1-Day for threshold
crossing events.
Note: Time periods for 1-day parameters begin and end at midnight.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
273
To view events
Option Details
Perform a
quick sort by a
column
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
274
Option Details
In the Alarm Table, click an alarm row, and then click Details to
open a summary of the alarm. The Alarm Details dialog box
provides alarm information, including online help, about a single
alarm.
Note: In CMS, corrective actions for supported non-Calix devices
are not displayed in the Alarm Details window. For troubleshooting
steps, refer to the device-specific documentation.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
275
Before generating a print report, format the Alarm Table entries for printing using the
available display options.
Tip: Hovering the mouse pointer over a column header opens a pop-up window with a
more complete description of the column contents.
1. (Optional) To include only specific entries in the report, use Ctrl+click to select entries
one at a time, or Shift+click to select a range of entries.
2. Right-click anywhere in the heading row to open a pop-up menu, and then click Print
Report.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
276
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
277
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
278
Some log filters have system-determined values. You can select the value for the query (for
example, all alarms with a critical severity). Other filters have variable values. For these values
you must specify a match criterion (for example, all events for AIDs equal to N1-1).
Note: Unless otherwise specified, filters below that require specifying a match criterion use
standard database options: Equals, Not Equals, Contains, Starts With, and Ends With.
Common filters
For all alarm and event logs, you can query using one or more of the following filters:
Start and End Time: Specify a date and time range to query alarms.
Network Name or CMS: Type all or part of a network name to return network alarms,
events, or entries, or type CMS to specify CMS alarms, events, or entries.
Node System ID: Type all or part of a node name (SID).
AID: Type all or part of an Access Identifier (AID).
Severity (alarms only): Select CL (cleared), CR (critical), DBCHG (database change), MJ
(major), MN (minor), NA (not alarmed), or NR (not reported).
Action (alarms only): FAULTCLEAR (alarm cleared), FAULTSET (alarm set),
FAULTUPDATE (alarm updated), FAULTACK (alarm acknowledged),
FAULTDEACK (remove alarm-acknowledgement).
Acknowledged (alarms only): Y (alarm acknowledged) or N (alarm not acknowledged).
Last Update By (alarms only): Use a match criterion to query for a CMS user name.
Trouble Ticket Number (alarms only): Use a match criterion to query for a ticket
number.
Device Type: Select a network element type.
Suppressed (alarms only): Y (alarm suppressed) or N (alarm not suppressed).
Advanced filters
You can also query using one or more of the following Advanced filters:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
279
Alarm Log Alarm String ID: Use a match criterion to query the alarm codes. For information about
specific alarms, see the Calix C7 TL1 Message Documentation or the Calix C7
Troubleshooting Guide.
Alarm Location: FEND (far end) or NEND (near end), or ALL (both).
Description: Use a match criterion to query for an alarm long name.
Facility: Type all or part of a facility type, for example ADSL.
Observed Behavior: Type all or part of an observed behavior that might have caused a
trouble condition.
Service Affecting: Y (service affecting) or N (non-service affecting).
User Notes: Use a match criterion to query the user notes field.
Event Log Description: Use a match criterion to query for an event long name.
Effect: CL (cleared condition), SC (standing condition), or TC (transient condition).
Entry Type: Choose from the list of entry types.
Event: Choose from the list of possible events. For information about specific events, see
the Calix C7 TL1 Message Documentation or the Calix C7 Troubleshooting Guide.
Event Location: FEND (far end) or NEND (near end).
Facility: Type all or part of a facility type, for example ADSL.
Threshold Event Description: Use a match criterion to query for a threshold event long name.
Log Effect: CL (cleared condition), SC (standing condition), or TC (transient condition).
Event: Choose from the list of possible events. For information about specific events, see
the Calix C7 TL1 Message Documentation or the Calix C7 Troubleshooting Guide.
Event Location: FEND (far end) or NEND (near end).
Facility: Type all or part of a facility type, for example ADSL.
Monitor Threshold: Use Equals, Greater Than, or Less Than operators to query the monitor
threshold.
Monitor Value: Use Equals, Greater Than, or Less Than operators to query the monitor
value.
Time Period: 15-min or 1-day.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
280
3. By default, the date and time 24 hours ago appear in the Start Time box and the current
date and time appear in the End Time box. To change a date and time, do the following:
a. Click the calendar icon to the right of the box.
b. In the Select Date and Time dialog box, scroll to the month.
c. In the Time box, type the time using the format HH:MM:SS. For example, to specify
2:00 p.m., type 14:00:00.
d. Click the date. The dialog box closes and the date and time you specified appear in
the Start Time or End Time box.
Alternatively, set the date and time by typing directly in the Start Time and End Time
boxes using the format MM/DD/YYYY HH:MM:SS, for example, 09/09/2013
13:55:00.
4. Specify one or more available filter criteria:
a. In the list to the right of a filter, select a filter value or a match option.
b. For filters with match options, click a filter value or type a text string to define the
filter. For text strings, optionally select the Case Sensitive check box to only return
results matching the case you used. For example, to query for all events in nodes with
an AID of N1, set the AID match list to Equals and in the box, type n1 (N1 with the
Case Sensitive check box selected).
5. (Optional) Change the default sort by specifying one or more sort criteria.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
281
a. In the Column Name list, click the criterion to use as the primary sort.
b. In the Sort Order list, click Ascending or Descending to specify the sort order.
To display a secondary sort criterion, click More, and then repeat this step for the
additional criterion.
6. (Optional) Under Report Parameters, you have these report options:
Accept the default settings to display the search report on screen in HTML format
with 50 lines or row per page.
Save the file in CSV format by clicking CSV.
Tip: You can generate a CSV report after generating the HTML log report (in Step 7),
however, if you anticipate the search report to be large, using the option here eliminates
the processing required to generate the HTML report.
Change the number of lines per HTML page (or the number of lines to include in the
CSV file). Type a different number in the Lines Per Page box. For numbers over 999,
do not use a comma as a thousands separator.
7. At the bottom of the screen, do one of the following:
Use advanced search options (on page 104) to customize the columns displayed in the
report and the sort order, as well as set further filter criteria, by clicking Advanced.
At the bottom of the Web page or screen, click Submit. The search report displays
on screen, or if you selected CSV format in Step 6, the Downloading dialog box
opens with options to open the search report directly in your default spreadsheet
application or save the file open to a location on your PC or workstation.
Clear the Search screen of all search criteria by clicking Reset.
8. In the report screen, you have several options:
When the number of returned items exceeds the Lines Per Page set in Step 6, use the
Next, Last, First, and Prev hyperlinks to scroll through the search report.
Hover the mouse pointer over a column header to open a pop-up window with
description of the column contents.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
282
Above the report buttons, click Back to return to the Search screen and modify the
criteria.
Save the results displayed on the current screen in CSV format. Above the report
results, click CSV Export. The Downloading dialog box opens with options to open
the search results directly in your default spreadsheet application, or save the file
open to a location on your PC or workstation.
Click Advanced to use advanced search options (on page 104) to customize the columns
displayed in the report and the sort order, or set further filter criteria.
Print the log query results using the print commands in your browser or spreadsheet
application.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
283
First configure the CMS server with the mail server information, and then create e-mail
subscriptions for users or groups of users. You can optionally send a test e-mail to check the
e-mail configuration. To use this feature, a valid e-mail address must be saved with the CMS
user account.
Note: Depending on how your company e-mail server queues are processed, there may be a
delay before alarm notification actions (such as creating and deleting e-mail subscriptions, or
configuring subscriptions using the optional stop and start times) take effect.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
284
4. In the Port box, type the SMTP port to use, or leave the box empty to use the default
port.
Note: Unless you specify a different port, CMS configures the e-mail server using the
default SMTP port 25.
5. In the From Address box, type the e-mail address for the From e-mail field of the
notices.
6. In the Connection Security list, select Start TLS if e-mails are sent to a host that is
configured for SMTP with TLS. Otherwise leave the default selection (None).
7. (Optional) To record an authorization user ID and password credentials to access the
server, click the Auth radio button and type the information.
8. To send a test e-mail to the e-mail address saved with your CMS user account, click Test.
9. Click Save to save the configuration.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
285
f. (Optional) In the Delay Time box, type the number of minutes to delay.
g. In the Days list, accept the default All, or select one or more days of the week.
h. To the right of Start, in the Hour and Minute lists, accept the default All, or select an
hour and a minute to start notifications.
i. To the right of Stop, in the Hour and Minute lists, accept the default None, or select
an hour and a minute to stop notifications.
6. At the bottom of the page, click Save to save the configuration.
Viewing the e-mail subscription information requires Minimum (Min) CMS Fault privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
286
The existing subscriptions display in a table. Scroll to the right to view the subscription
status under the Enabled column.
3. In the subscriptions table, select the check box to the left of each subscription to disable,
enable, or delete in Step 4.
4. Do one of the following:
Click Disable to disable the selected subscription(s).
Click Enable to enable the selected subscription(s).
Click Refresh to reload the selected subscription(s). Use this option after adding
additional e-mail subscriptions or when e-mails are not being received (stale server
cache).
Click Delete to delete the selected subscription(s). In the Confirmation box, click
OK to confirm the deletion.
5. Click Save to save the configuration.
Parameters
You can select the following options for an Email Subscription and Alarm Closure:
Option Field Description Valid Options
Subscription Name* Enter a subscription name. Enter a subscription name up to 40
characters in length.
Email Address* Enter a valid email address for where to send the <email@example.com>
subscription information.
Description Enter a description for this subscription/alarm closure. Enter a description up to 255 characters in
length.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
287
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
288
Minute:
NONE‡
{0, 15, 30, 45}
* Required field
† Email Subscription Field only (not alarm closure affecting)
‡ Default
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
289
14. Choose the applicable day(s) from the Days list. Alternately, choose ALL of the days, or
select more than one day by clicking and holding CTRL to highlight your selections.
15. Choose the Start time Hour and Minute from their respective lists for when this
subscription should run.
16. Choose the Stop time Hour and Minute from their respective lists for when this
subscription should stop.
17. Click Save to save and activate this subscription.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
290
To integrate CMS with a back-office OSS, Calix supplies the set of CMS MIBs for loading in
your SNMP manager. To access and download the MIBs from the Calix Resource Center,
submit a technical support case online in the Calix Support Station or contact the Calix
Technical Assistance Center (TAC).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
291
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
292
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 7
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
294
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
295
Statistics
The data captured and stored as statistics accumulate until cleared. If the statistics are never
cleared, they reflect all activity since system startup. Each time you invoke the statistics
screen, the values are retrieved from the hardware, thereby providing an up-to-date snapshot
of system activity. This is in contrast to the performance monitoring data that is sampled
every few seconds.
For descriptions of these features and instructions on how to use them, refer to the Calix E-
Series system documentation.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
296
E7 Port-Specific PM Parameters
After running a PM query on E7 networks, CMS returns port-specific performance
monitoring parameters. The column headings used in the reports correspond to the
abbreviated acronyms used in TL1. The table below lists the column names and
corresponding description for each port parameter, grouped by category.
CMS uses egress PERU and TCC data from far end transport STSn interfaces and stores
them as corresponding ingress PERU and TCC data on the target STSn interface. CMS does
not collect ingress data for uplinks to non-E7 equipment.
Tip: Hover the mouse pointer over a data type to open a pop-up window with a more
complete description.
Note: All PM types except Ethernet collect in 15-minute and 1-day bins. Ethernet PM data
displays and downloads a snapshot of the Ethernet port statistics accumulated since the
counters were reset.
time Time
networkid Network ID
sid System ID
straid
bintype Bin type
num Number
starttime Start time
sec Started sec
valid Status
cv_c Code violation
cv_cfe Code violation, far end
fec_c Forward error correction
fec_cfe Forward error correction, far end
fec_l Forward error correction seconds
fec_lfe Forward error correction seconds, far end
es_l Errored seconds
es_lfe Errored seconds far end
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
297
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
298
C7 PM Features
Use the following features to obtain and manage performance monitoring data:
Download data for one or more of the following data types: ADSL/ADSL2+, HDSL,
DS1, DS3, IMA, IMA Link, Ethernet, OCn, STSn, and ADSL Call Status.
Schedule a download based on a recurrence pattern (hourly for 15-minute data or daily
for one-day data) or on a non-recurring basis.
Download PM data for specific regions and C7 networks.
View the current status of PM downloads and the original scheduling details.
Query historical PM data, which are partitioned daily on your CMS server, and print or
export the report in CSV or HTML format.
Customize the number of days to archive PM data on your CMS server.
For a description of C7 diagnostics and performance monitoring data that can be viewed in
CMS, see the Calix C7 Troubleshooting Guide.
PM viewing options
Options for viewing PM registers on the C7 include the following:
View any of the current or past 15-minute or daily interval data.
View PM data captured at the near-end or the far-end node.
Automatically poll PM registers every 3, 5, 10, 20, or 30 seconds to view increases in PM
statistics for the selected polling frequency.
Set all current PM registers (those currently accumulating data) to zero. This can be
helpful after making repairs or correcting an error condition. By clearing the PM
registers, you eliminate PM register counts prior to the repair or corrective action.
In CMS, view a real-time graph of PM statistics that you select.
In CMS, for ADSL ports, view the Diagnostics screen with selected provisioning, call
status, and PM data.
For descriptions of these features and instructions on how to use them, refer to the Calix C7
Maintenance Guide or Calix C7 Troubleshooting Guide.
PM Data on C7 Networks
Each C7 shelf automatically captures and stores PM data at the port level for two time
periods:
Incremental counts captured in 15-minute intervals for the current period and for the
past eight hours (divided into 32 separate 15-minute intervals).
Daily counts captured in one-day intervals for the current 24-Hour period, and the 6
previous 24-hour periods.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
299
PM data types
When you schedule a PM download, you choose the type of data (15-minute or 1-day) to
download from the C7 networks to the CMS server:
To download data from the 1-day PM data bins, schedule the PM downloads on a daily
basis. You can schedule the seven data sets to download on a specific day, or distribute
the download across multiple days of the week.
To download data from the 15-minute PM data bins, schedule the PM downloads on an
hourly (intra-day) basis. You can schedule downloads for every 2 hours (downloads 8
bins at a time), 4 hours (16 bins), 6 hours (24 bins) or 8 hours (32 bins).
To download the last eight hours of 15-minute data (32 bins), schedule a one-time basis
(non-recurring) download.
Note: Due to the large amount of the data, a 15-minute ADSL PM data download can
only be scheduled on a non-recurring basis using CMS, and for one C7 network at a time.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
300
C7 Port-Specific PM Parameters
After running a PM query on C7 networks, CMS returns port-specific performance
monitoring parameters. The column headings used in the reports correspond to the
abbreviated acronyms used in TL1. The table below lists the column names and
corresponding description for each port parameter, grouped by category.
CMS uses egress PERU and TCC data from far end transport STSn interfaces and stores
them as corresponding ingress PERU and TCC data on the target STSn interface. CMS does
not collect ingress data for uplinks to non-C7 equipment.
Tip: Hover the mouse pointer over a data type to open a pop-up window with a more
complete description.
Note: All PM types except Ethernet collect in 15-minute and 1-day bins. Ethernet PM data
displays and downloads a snapshot of the Ethernet port statistics accumulated since the
counters were reset.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
301
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
302
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
303
OutMulticastPkts
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
306
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
307
15-Minute PM 7 14
1-Day PM 30 90
Logs N/A 7
Log Events N/A 2
For PM data, the Archive settings determine the size of the archived database tables on the
CMS server. The CMS system uses archived database tables to divide PM data into more
than one table and thereby optimize the processing of database queries. For example, using
the default 1-day PM data settings, every 30 days, the set of 1-day PM data for the past 30
days is archived into a separate database table. Every 90 days, the oldest of the archived
database tables is deleted.
Note: As shown in the table of default archive and deletion values, the delete interval for PM
data should be a multiple of the archive interval.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
308
Scheduling a PM Download
You can schedule the following PM download tasks:
E7 OS download for all nodes in CMS or any combination of network groups and nodes.
C7 PM download, including real-time counters and video channel usage data required for
business reports, for all C7 networks in CMS or any combination of regions, network
groups, and networks. To review the C7 PM download requirements for business
reports, look under each report topic in Business Reports (on page 323).
E5-400 PM download for all E5-400 nodes in CMS or any combination of network
groups and nodes.
You can schedule a download for one time only or on a recurring basis.
Only a CMS Desktop user in the Administrators user group can schedule a PM download.
Note: Non-Ethernet PM types collect in 15-minute and 1-day bins. Ethernet PM data
download a snapshot of the current Ethernet port statistics.
Note: If you set the node's Auto Connect parameter to N (do not automatically reconnect)
and the node gets disconnected, the node is skipped when a scheduled task runs, and no
failure is reported in the task details.
Note: When upgrading CMS, system scheduled tasks (tasks with Job IDs less than 100) are
not exported with the CMS database. If you have customized any system scheduled tasks,
you must manually re-input the changes after the upgrade.
Note: If you delete a system scheduled task, it is automatically recreated if the CMS server is
restarted.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
309
4. (For C7 PM downloads only) At the top of the New PM Download Task dialog box,
click Performance Monitoring, Real-Time Counters or Video Channel, depending
on the type of PM download you need. To download data for an Ethernet Bandwidth
Utilization or ADSL Health Monitor report, click Real-Time Counters. To download
data for a Top Video Channel Count report, click Video Channel. For all other
downloads, click Performance Monitoring.
5. To launch a one-time, immediate download, do the following:
Select the Immediate one-time execution.
Select one of the download options: All 15-Min Bins, All 1-Day Bins, or Both.
Go to Step 6.
To schedule a one-time or recurring download to begin at a later time, do the following:
Select the Schedule for later radio button. In date and time settings immediately
below the radio button selection, do the following:
Type the date on which to begin the downloads, or double-click the calendar icon
to open the Select Date dialog box and select the date.
In the hour and minute lists, click the time for the download to start.
If you are setting up a recurring scheduled task, select the Recurring check box, and
then select the recurrence pattern:
Note: To optimize CMS performance, use the Daily option whenever possible.
Intra-Day (15 Minute Counters): Select the PM download frequency (2, 4, 6, or
8-hour). (This option is not available for C7 real-time counter downloads.)
Daily (24 Hour Counters): Select the check box for each day of the week to
download. Selecting fewer check boxes concentrates the daily downloads onto
the days checked. Clicking more check boxes distributes the daily downloads
more evenly throughout the week.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
310
To specify an end date and time for the recurring download, select the Stop after
check box. Type the date on which to end the downloads, or double-click the
calendar icon to open the Select Date dialog box and select the date. In the hour
and minute lists, click the time to end downloads.
6. In the Data Types area, select one or more of the data type check boxes. (The available
data types for C7 PM vary depending on the type of download selected in Step 4.)
7. In the Data Location area, select the level(s) for downloading PM data:
a. On the data location tree, double-click a region or network group to expand it, and
then click a region, network group, network or node to include. (To include all
regions, network groups, and networks or nodes in your selection, select the root
region.)
Note: For a Non-Recurring C7 PM download with ADSL data, you can only include a
single C7 network in the download task.
b. Right-click to open the pop-up menu, then click Set Download. The square to the
left of the region or network changes to green to indicate that it is included.
c. Repeat Steps 7a and 7b for each region, network group, network or node to include
in the download. To remove a location from the download, right-click it, and then
click Unset Download.
8. At the bottom of the New PM Download Task dialog box, click OK to save the settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
311
For C7 PM downloads, alternatively, you can use a UNIX script to generate a file of log
query results. For more information, refer to the Calix Management System (CMS) Installation
and Upgrade Guide.
Tip: Hovering the mouse pointer over a column header opens a pop-up window with a
more complete description of the column contents.
Navigate HTML results by clicking the first, prev, next, and last links above the table.
Note: If a query takes over 20 seconds to process, page entries that have been processed up
to that point appear on screen while the system continues processing the remainder of the
query.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
312
Generating a PM Query
You can run a customized query to obtain PM data to view or export through either CMS
Desktop or CMS Web:
C7 queries can be run for ADSL, DS1, DS3, HDSL, IMA, IMA Link, OC3, OC12,
OC48, PWE3, STS1, STS3c, STS12c, STS48c, xDSL, and xDSL Group PM data, as well
as Ethernet statistics.
E-Series system queries can be run for GE port, 10GE port, ERPS, ONT, ONT FE,
ONT GE, ONT HPNA, ONT PWE3, and ONT T1 PM data.
Generating a PM query requires Full CMS Administration privileges.
1. Do one of the following, depending on whether you have CMS Desktop or CMS Web
open:
(CMS Desktop) On the Tools menu, click Web Site Map. Alternatively, click Tools
> Performance > C-Series or E-Series (menu options with right-pointing triangles
have submenus). Click the type of report to run.
(CMS Web) Open CMS Web (on page 38). At the top of the page, click Site Map.
Alternatively, in the Module list on the left, click Performance > C-Series or E-
Series (menu options with right-pointing triangles have submenus).
2. Select the type of report to run. Selections with right-pointing triangles have options for
1-day and 15-minute bins.
3. On the Search screen, use one or more of the following options to define the PM query:
Skip to Step 4 to include all available data in the query for the past 24 hours.
Tip: The number of PM records returned for each port depends on the start and end
times that you set for the query and any filtering criteria you have applied.
Start Time and End Time: Click the calendar icon to the right of the Start Time or
End Time box. In the Select Date and Time window, use the navigation arrows to
scroll to the month and year. To modify the time, type a time in the format
HH:MM:SS. Click a date in the calendar to close the window and transfer the date
and time to the Start Time or End Time box.
Tip: Older PM data on the CMS server is purged based on your PM data archive
settings.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
313
AID: Specify access identifiers that meet the match criteria. To use this filter, specify
a match option (Equals, Contains, Not Equals, Starts With, or Ends With) and type a
string in the box to the right. Optionally select the Case-Sensitive check box to
match the case used in the string. For example, to return PM data for all ports on
node 1, shelf 1 in a network, click Starts With in the match list, then type N1-1 in the
box.
Under Filter Criteria, use the Region and Network filters to specify one or more
regions or networks for the query report. To use this filter, expand the right-pointing
arrow > and select one or more items from the list. Use Ctrl+click to select one item
at a time or Shift+click to select a range of items. (To de-select an item, Ctrl+click it
again.) Note the following:
If you do not specify this filter (default), all available network or node data is
included in the search.
To only search synchronized networks or nodes, select the Synchronized
Networks check box the right of the Network list.
To only search networks nested under a network group, select the Network
Group check box the right of the Network list.
Location: Specify near-end or far-end PM data. If you do not set this filter, both
near-end and far-end data are included in the query.
Sort on: Sort the query by the time, network ID, node ID, or the port access
identifier (AID). By default the query sorts in ascending order. To specify descending
order, click Descending. If you do not set this filter, data is sorted in random order
based on when it was added to the CMS database.
Report Parameters: Select the report format for the query results. By default, results
will display in HTML format on screen.
The default number in the Lines Per Page box is 50. You can type a number up to a
maximum of 10000 (ten thousand). (For numbers over 999, do not use a comma as a
thousands separator.)
For CSV reports, the lines per page determines the number of entries that are
exported to the CSV file. To include as many entries as possible, type 10000. (To
generate a CSV file of C7 PM query results that exceeds ten thousand entries, use the
pmdownload UNIX script. For details, refer to the Calix Management System (CSM)
Installation and Upgrade Guide.)
4. At the bottom of the screen, optionally do one of the following:
Clear the settings on the Search screen: Click Reset.
Set advanced filter criteria (on page 104) or customize the columns displayed and sort
order: Click Advanced.
5. At the bottom of the page, click Submit.
The report results appear on screen. If you selected CSV output, the File Download
dialog box opens with options for opening the report results directly in your default
spreadsheet application or saving the file to a location on your PC or workstation.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
314
You can save an inventory or PM query as a template to apply at a later time. Templates can
contain up to 80 alphanumeric characters plus the dollar sign ($) and underscore (_). Spaces
are not allowed. Saving a query as a template requires Min. CMS Administration privileges.
You can apply a previously saved inventory or PM query template to generate a new report
with the templates predefined configurations. Applying a query template requires Min. CMS
Administration privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
315
Set filter conditions for any available report parameters using standard database query
attributes
Use AND and OR operators to group multiple filter conditions
Access the advanced query options from the Search, Inventory, PM Query, or Alarm Log
screen.
Note: When using advanced search options, unless you change it, the settings are stored for
a specific query for the duration of the current user session.
Display:
Hide or show column(s): Select one or more items in the Visible Columns list and
click the left arrow to hide them, or select elements in the Choose Columns list and
click the right arrow to add them to the report. Use the double arrow buttons to hide
or add all items.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
316
Change the order in which report elements display in the report: Select an element in
the Visible Columns list. Click Up or Down to move the element to a new location
in the list.
Sort: Report elements that you can use as sort criteria display in the Choose Columns list.
If you do not add any sort criteria, the results are sorted by the topology elements on the
main Search, Inventory, or PM Query page.
Add an element to the sort criteria: Select an element in the Choose Columns list.
Click the right arrow to add it to the Sorting Columns list. Repeat to add a secondary
sort, and to add additional nested sort criteria.
Change the sort priority: If you have added more than one sort criterion to the
Sorting Columns list, select an element in the list and click Up or Down to move it
to a new priority order.
Change the sort order for a selected element: By default, elements selected for sorting
sort in ascending order. To change to descending order (or back to ascending order),
select the element in the Sorting Columns list and click Asc/Desc. The arrow
indicator to the left of the element name changes to show the sort order.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
317
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
318
Select a condition and click Edit to modify its criterion. The Add button is
disabled and the Update button is enabled. Click Update to use the modified
criterion.
3. At the bottom of the screen:
Click Submit to generate the report with the customization settings you have
specified. (For PM queries, the main Search screen opens.)
Click Apply to save the customization settings and open the Display tab.
Click Reset to clear the customization settings from the current tab.
Click Cancel to return to the main Search screen.
4. In the Search or Inventory report screen, you have several options:
Scroll through the search report using Next, Last, First, and Prev above the search
report.
Return to the Search screen and modify the criteria. Above the report buttons, click
Back.
Change the parameters on screen to display those from a different tab for searches
where more than one CMS Work Area tab displays above the search results. The
currently-selected tab displays largest.
In the report table, for one of the lines in the search report:
Open a Table View by clicking the Row # hyperlink.
(In CMS Desktop only) Jump to the Work Area by clicking an ID hyperlink.
Note: After clicking an ID hyperlink, you cannot return to the search report without
regenerating the report.
Save the results displayed on the current screen only in CSV format. Above the
report results, click CSV Export. The Downloading dialog box opens with options
to open the search results directly in your default spreadsheet application, or save the
file open to a location on your PC or workstation.
Save the search or inventory query as a template (on page 112).
PM Query Example
This example procedure for C7 PM data assumes that PM data has been downloaded to the
CMS server using a scheduled PM Download task. The example is based on the following
PM query parameters:
ADSL data type
Start time 10:00 a.m. on 8/19/12; end time 10:00 a.m. on 8/20/12
All AIDs on node 1, shelf 1 in the SONOMA network
15-minute data type
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
319
To print PM query results, use the print commands in your browser (for HTML output) or
spreadsheet application (for CSV output).
Tip: For HTML output on screen, move your cursor over a column heading to view the
parameter long name in a ToolTip.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
320
Network ID Network where the port is located, in the format NTWK-<network name>
PM Location Location of the PM download. Options are Near End or Far End
Bin Type Accumulation period or bin from which PM data was downloaded. Options are 15-
minute or 1-day.
C7 networks accumulate PM data over two time periods. Options are every 15
minutes or every day (midnight to midnight). Non-recurring PM data downloads and
downloads that recur hourly are taken from the 15-minute bin. PM data downloads
that recur once a day are taken from the 1-day bin.
Validity Status of the PM data download for the accumulation period (15 minutes or 1 day):
Completed: PM registers represent data collected over the entire time period.
Not Available: PM data were not available.
Invalid: PM data were corrupt or invalid.
Longer: PM data were collected over a time period longer than the time period in
question.
Partial: PM data were collected over a part of the time period. (When viewed on
the network using the C7 iMS or TL1, this status appears for the current time
period that has not yet completed.)
Adjusted: PM registers were re-initialized during the time period in question. For
example, this status can result from restarting the PM counts for troubleshooting
or testing purposes.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
321
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 8
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
324
Based on thresholds defined when you run the report, any values that exceed the threshold
display in red in the output. You can view the utilization history of a facility by clicking its
AID in the Web report. Viewing the history can clarify whether the threshold crossing is an
anomaly or indicate a trend of bandwidth depletion. Use this data to help determine whether
to add bandwidth immediately or delay capital expenditures to a future date.
Note: STSn transport ingress (PERU_P) data are only reported for interfaces with a C7 shelf
at the far end; data for interfaces uplinked to third-party devices do not display in the reports.
Note: If your scheduled C7 PM download task has been modified or deleted, make sure that
a scheduled task exists with these settings: In the Performance Monitoring tab, select the
Daily option under Recurring Pattern and the check boxes for the days of the week to
include in the download. In the Data Types area, click the data type check boxes for the
required report types (STSn, IMA Group, DS1, or T3).
For Ethernet bandwidth utilization reports, see Scheduling a PM Download (on page 308). You
must use the following settings when creating the PM download:
Under the Real-Time Counters tab, select the Daily option under Recurring Pattern and
the check boxes for the days of the week to include in the download. In the Data Types
area, click the Ethernet (Eth) check box.
Note: Depending upon the configuration and type of report requested, report results with a
lot of data may take a few minutes to display.
1. Open the CMS Web (on page 38).
2. In the Module list on the left, click Business Report > Bandwidth Utilization, and
then click the type of report to run. A report screen opens.
3. Under the report title, select Daily or Weekly to define the report history duration. Daily
displays by default.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
325
Options
Change the report filter criteria: Click Change Filter to view the original report criteria.
You can modify the criteria, and then click Submit to view the results.
View a Bandwidth Utilization Trend report: On the tabular report, click the AID
hyperlink of a region or network.
The following illustration shows a sample graphical report and report table.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
326
Options
View (or hide) a table of the percent utilization of the ingress and egress paths: Click
Enable Table View (Disable Table View).
View a graph and report table of the 15-minute bin data: On the tabular report, click a
date hyperlink.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
327
Service take rate reports enable you to manage subscriber line unit inventory efficiently by
monitoring service port state information on all ports. This includes primary and secondary
state information useful in determining which ports are in service and generating revenue.
The report provides a periodic count of the total number of subscriber line ports in the
network, and a count of the number of in-service ports.
You can view a history of port usage over a defined time period by clicking the port type. If
service ports are properly managed, the number of in-service ports should trend towards the
number of in-network ports. Unless you are adding ports to your network, if these numbers
diverge you could be losing subscribers, or new port inventories are not being optimally
managed.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
328
Options
View more granular detail: On the tabular report, click a hyperlink under Port Type to
display a service take report by region. You can then click a region hyperlink to drill
down to the network and node levels.
To view real-time data, above the report table, click Refresh.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
329
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
330
You can run ADSL Health Monitor reports on a daily or weekly interval.
Leave the Start and End Date fields blank to include all available data for the past
7 days in the query, or specify start and end dates by clicking the calendar icon
next to the Start Date and End Date fields, and in the Date and Time dialog box,
select the start or end date.
(Optional) Limit the query results using the available Filter Criteria.
(Optional) In the Max Records box, type the maximum number of results for the
report.
At the bottom of the page, click Submit. The report results appear on screen.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
332
You can run daily or weekly reports to summarize the upstream and downstream train rate
and upstream and downstream Signal to Noise Ratio (SNR). The report displays the
minimum and maximum values.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
333
Options
Change the report filter criteria: Click Change Filter to view the original report criteria.
After modifying the criteria, click Submit to view the results.
View a trend graph for an individual customer modem: On the tabular report, click the
AID of that equipment.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
334
The following illustration shows an example of a Modem Train Rate Downstream Trend
graph.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
335
Note: The Top Video Channel Report by View Minutes is not supported for C7 video networks
operating in AVT mode.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
336
Leave the Start and End Date fields blank to include all available data for the past
7 days in the query, or specify start and end dates by clicking the calendar icon
next to the Start Date and End Date fields, and in the Date and Time dialog box,
select the start or end date.
Use the Region or Network lists to narrow the report to a region or network.
In the TOP N box, type the number of channels to view in the report.
Use the Group list to group the output by region or time of day.
At the bottom of the page, click Submit. The report results appear on screen.
The following illustrations show sample C7 video usage reports. The first illustration
shows a report of the top 50 channels, and the second shows a top 10 channel report by
time of day.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
337
Options
Change the report filter criteria: Click Change Filter to view the original report criteria.
After modifying the criteria, click Submit to view the results.
View a trend graph for an individual video channel: On the tabular report, click the IP
address link of a channel.
The following illustration shows an example of a Video Channel Usage Trend graph.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
338
Options
Change the time period for the report: Click Change Date.
View (or hide) a table of the data: Click Enable Table View (Disable Table View).
View a graph and report table of view minutes in 15-minute increments: On the tabular
report, click a date hyperlink.
The following illustration shows an example of a view minutes in 15-minute increments.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
339
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
340
Viewer channel usage is polled periodically throughout the day. CMS collects total channel
count and provides a summary of the most frequently viewed channels for the previous 7-
day or 30-day periods, or you can define you own reporting interval. The results display the
user-defined number of most popular channels ranked according to usage. Click on the IP
address of a channel in the report to view a graphical representation of the video channel
usage trend.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
341
At the bottom of the page, click Submit. The report results appear on screen.
The following illustration shows a sample C7 video usage report:
Option
View a usage trend graph for an individual video channel: On the tabular report, click the
IP address hyperlink of a channel.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
342
1. From CMS Web, click the Business Reports hyperlink near the top of the screen. The
Business Reports page opens.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 9
Administrative Tasks
You can perform the following administrative tasks.
In CMS Desktop
Manage Calix device default passwords
Generate custom Performance Monitoring (PM) reports
Schedule the following:
C7 and E7 PM downloads
Backups of the Calix device databases
Backups of the CMS database (regions, networks, user groups, and users)
Inventory snapshots
Modify the number of days to archive CMS logs and PM data
Synchronize network alarms and time with CMS
Retain active alarms
In CMS Web
Perform log queries and generate alarm, event, and system administration logs
Modify the default alarm severity and description (see Modifying Alarm Severity and
Description (on page 265))
Export and import CMS and C7 network data (profiles, templates, and video channels)
Create custom lists of aliases for node names for each CMS user group
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
344
Scheduling Tasks
Creating a Scheduled Task
You can schedule PM downloads (for C7, E7, E5-400 and E3-48C systems); CMS database
backups; node database backups; inventory snapshots; and E-Series software upgrades.
Important: Only CMS Desktop users in the Administrators user group can create a
scheduled task.
The procedure for each scheduled task varies. For more information, see the following
topics:
Scheduling a PM Download (on page 308)
Scheduling a CMS Database Backup (on page 353)
Scheduling Calix Network Element Backups (on page 357)
Scheduling an Inventory Snapshot (on page 366)
Scheduling E3/E5-100 Software Upgrades (on page 246)
Scheduling E7/E3-48C Software Upgrades (on page 141)
Scheduling an ONT-Only Firmware Upgrade in CMS (on page 147)
Scheduling an RG Configuration Management Task in CMS (on page 149)
Scheduling Configuration Restoration for E Series Network Elements (on page 369)
Note: B6 network scheduled tasks can be created for upgrading images, reloading B6
devices, re-synchronizing inventory, upgrading GPON ONT images, and configuring
GPON OLT repository paths. For information, refer to the publication, Managing a B6
Network from CMS.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
345
An E5-400 inventory data collection scheduled task that begins at 5:00 a.m. each Sunday
and recurs weekly.
An E7 inventory data collection scheduled task that begins at 6:00 a.m. each Sunday and
recurs weekly.
In the Scheduled Task dialog box, system scheduled tasks have Job IDs less than 100. In
addition, "Default" displays in the Note field. You can customize or delete a system
scheduled task, if needed.
Note: When upgrading CMS, system scheduled tasks are not exported with the CMS
database. If you have customized a default scheduled task, you must manually re-input the
changes after the upgrade.
Note: If you delete a system scheduled task, it is automatically recreated if the CMS server is
restarted.
You can view the status of scheduled PM data downloads, CMS database backups, network
element database backups, and inventory snapshots. You can also view the details of
completed tasks.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
346
5. To see a report on the task status, in the bottom right of the screen, click Detailed
Status. The Detailed Status screen opens with details of the task.
Status fields
Each scheduled task displays the following information:
Item Description
You can modify a scheduled PM data download, CMS database backup, C7 backup, and
inventory snapshot.
Important: Only CMS Desktop users in the Administrators user group can modify or delete
a scheduled task.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
347
You can rerun any partially completed, failed, or canceled scheduled task. Rerunning a PM
download task downloads the PM statistics that did not download on the original schedule.
Rerunning a scheduled task requires Full CMS Administration privileges.
Any scheduled PM task can be deleted before its execution time. Deleting a scheduled task
requires Full CMS Administration privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
348
You can abort a task in progress. Any data already downloaded and saved are not deleted
from the database. Aborting a scheduled task in progress requires Full CMS Administration
privileges.
When you send the command to abort a task, the following rules apply:
If the task has been scheduled for one-time execution and has not yet run, the task will
never run.
If the task has been scheduled for repeated execution, the task will never run again.
If the task is running when the cancel call occurs, the task will run to completion, but the
task will never run again.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
349
You can customize scheduled PM downloads for the port types, data type, and number of
networks and shelves. You can also adjust the number of days of PM archived data based on
your system capacity and company needs.
Use the following guidelines to optimize CMS performance during inventory snapshots:
Schedule inventory snapshots so that only one task is running at a time. Do not overlap
inventory snapshot schedules.
For Calix C7 networks, inventory snapshots download to the CMS server at a rate of
approximately 30 ports per second. For example, an inventory snapshot for a network
with 3,600 ports takes approximately 2 minutes to download.
When scheduling an recurring inventory snapshot for systems supporting 1,000 or more
network elements, schedule snapshots once a week (for example, over the weekend), and
allow one to two days for the scheduled task to complete. The time requirement varies
based on the total number of ports and network topology.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
350
Backing up the CMS database can save significant time and provide potential expense savings
over time. Performing regular database backups is a strongly recommended practice,
especially for disaster recovery. If a significant number of configuration changes have been
made to the system since the last database snapshot was taken, you can do one of the
following:
Restore the old database and then re-do the same configuration updates you made
previously.
If the backup is simply too old to be usable altogether, forge ahead with other
troubleshooting options.
Performing backups in CMS mitigates this issue, saving you considerable time from
performing backups manually, and possibly saving significant time should a disaster recovery
event occur.
You can schedule multiple node backups to occur at the same time. CMS actively backs up as
many as five networks at one time. When more than five networks are scheduled for backup
at the same time, as one network backup completes, a new network backup begins. This
process continues until all scheduled network backups are finished.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
351
C7 networks
Individual C7 networks back up one shelf at a time. The files download to the designated
FTP/SFTP server during the backup process.
In the Scheduled Task Work Area, "Default" displays in the Note field for this scheduled
task. You can customize a system scheduled task, if needed.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
352
Note: When upgrading CMS, system scheduled tasks (tasks with Job IDs less than 100) are
not exported with the CMS database. If you have customized a system scheduled task, you
must manually re-input the changes after the upgrade.
Related topics
Performing Shelf Backups (on page 355)
Scheduling a CMS Database Backup (on page 353)
CMS Database Backup Files (on page 355)
Logging Out Users (on page 84)
Restoring the CMS Database (on page 381)
Restarting the CMS Server (on page 402)
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
353
You can schedule CMS database backups to occur on a one-time basis or to recur on a daily,
weekly, or monthly basis. Optionally specify a location on an FTP server to save the backup
files.
Only a CMS Desktop user in the Administrators user group can schedule a CMS database
backup. In addition, the original administrative user account shipped with CMS (rootgod)
must not be inhibited.
Notes: When upgrading CMS, system scheduled tasks (tasks with Job IDs less than 100) are
not exported with the CMS database. If you have customized a system scheduled task, you
must manually re-input the changes after the upgrade. Also, if you delete a system scheduled
task, it is automatically recreated if the CMS server is restarted.
Administrative user ID
CMS ships with a system CMS database backup task that belongs to the rootgod user. If you
inhibit the rootgod user after installing CMS, do the following to run CMS object scheduled
backups:
1. Delete the system scheduled task belonging to the rootgod user ID.
2. Create a custom scheduled task.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
354
Select the Schedule for later radio button. In date and time settings immediately
below the radio button selection, do the following:
Type the date on which to begin the downloads, or double-click the calendar icon
to open the Select Date dialog box and select the date.
In the hour and minute lists, click the time for the download to start.
If you are setting up a recurring scheduled task, select the Recurring check box, and
then do the following:
Select the Daily or Monthly recurrence pattern radio button. For the Daily
option, click the check box for each day of the week to download.
To specify an end date and time for the recurring download, select the Stop after
check box. Type the date on which to end the downloads, or double-click the
calendar icon to open the Select Date dialog box and select the date. In the hour
and minute lists, click the time to end downloads.
5. (Optional) To specify a backup file FTP location:
a. In the Backup Server Info area, select the Send to FTP Server check box to enable
entries in the fields.
b. In the FTP Server, User Name, and Password fields, type the required information.
c. To the right of the Folder field, Click the ellipsis button to browse for and select a
folder, or type the folder path in the field.
6. Click OK to save your settings.
Note: View the status of the backup in the Work Area on the Scheduled Tasks.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
355
After a successful CMS database backup, the backup file is saved on the CMS server in the
following directory:
/CMS_install_dir/jakarta-tomcat-5.0.12/webapps/reports/date/
where CMS_install_dir indicates the directory on which CMS was installed on the server and
date indicates the date of the backup in the format mm-dd-yyyy.
The file name with CMS objects is "backup_hh_mm_AM_JobID.txt", indicating the time and
Job ID of the scheduled task, for example, backup_01_00_AM_173.txt.
Note: When you view a successful backup task (at the CMS level in the Navigation Tree,
click System > Scheduled Task > CMS DB Backup), the backup file name displays in the
Note field.
Follow company policy and procedures to designate an FTP or Secure FTP (SFTP) server
for backup file storage purposes.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
356
Restore C7 databases
Should a C7 network backup fail, do one of the following:
Open an iMS cut-through session or log in to the network locally using the C7 integrated
Management Software (iMS) and perform a database back up.
Restore a previously backed up configuration for the failed network.
Related topics
Scheduling Network Element Backups (on page 357)
System Data Backup Best Practices (on page 350)
Backing Up a C7 Shelf (on page 361)
Restoring C7 Shelf Backups (on page 363)
The CMS system administrator can set the default backup FTP parameters for C7 networks
and E-Series nodes so that scheduled backups automatically log into the FTP or Secure FTP
(SFTP) server without the need to enter the user name and password. This serves the dual
purpose of convenience (no need to keep track of the login information) and security
(restricting access to the backup server).
Configuring the backup FTP/SFTP parameters requires Full CMS Administration privileges.
Note: When in SSH mode, the C7 uses SFTP to upload the backup files. If your C7
networks use a mix of secure and non-secure communications, make sure the FTP and SFTP
servers have the same IP address.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
357
You can schedule Calix device database backups to occur on a one-time, daily, weekly, or
monthly basis.
Only a CMS Desktop user in the Administrators user group can schedule Calix device
backups.
B6, C7, and The IP address, user name, and password of the FTP/SFTP host server.
E-Series
Note: When creating a scheduled backup task, CMS by default validates the FTP IP address,
user name, and password, as well as write permission to the FTP folder.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
358
Note: If you set the node's Auto Connect parameter to N (do not automatically reconnect)
and the node gets disconnected, the node is skipped when a scheduled task runs, and no
failure is reported in the task details.
For E3-48 units, a global Config Save option is also available. See Modifying the Default
E3/E5-100 Settings (on page 376).
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
359
Select the Schedule for later radio button. In date and time settings immediately
below the radio button selection, do the following:
Type the date on which to begin the downloads, or double-click the calendar icon
to open the Select Date dialog box and select the date.
In the hour and minute lists, click the time for the download to start.
If you are setting up a recurring scheduled task, select the Recurring check box, and
then do the following:
Select the Daily or Monthly recurrence pattern radio button. For the Daily
option, click the check box for each day of the week to download.
To specify an end date and time for the recurring download, select the Stop after
check box. Type the date on which to end the downloads, or double-click the
calendar icon to open the Select Date dialog box and select the date. In the hour
and minute lists, click the time to end downloads.
5. In the Backup Server Info window, do one of the following:
a. (Optional, for E3/E5-100 tasks) To create a Save Configuration Only task, click the
Save Config Only check box, and then Skip to Step 6.
b. For C7, E3/E5-100, E5, or E7 backup tasks, the FTP settings specified in the System
Settings Work Area will be used unless you choose to override them. To override the
default FTP server settings:
In the FTP Server box, enter the IP address of the FTP/SFTP host.
In the Username and Password boxes, enter the user name and password for the
FTP host.
(Recommended) Leave the FTP Server Validation check box selected to validate
the FTP IP address, user name, and password, as well as write permission to the
FTP folder.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
360
Click the ellipsis button to the right of the Folder box. In the FTP File List dialog
box, Look In list, select the folder on the FTP server to serve as the location of
the backup files, and then click OK.
c. For F5 backup tasks, enter the following information:
In the TFTP Server box, type the IP address of the TFTP host.
In the Folder box, type the relative path from the root directory of the TFTP
server to the location of the backup files.
6. In the Network Selection area, select the level(s) to back up as follows:
a. On the Network Selection tree, double-click a region or network to expand it, then
click a region or network to back up. To include all regions and networks in your
selection, click the root region.
b. Right-click to open the pop-up menu, then click Select. The square to the left of the
region or network changes to green to indicate that it has been included.
c. Repeat Steps 6a and 6b for each additional region or network to back up. To remove
a data location from the snapshot, right-click it, then click Un-Select.
7. At the bottom of the New Backup Task dialog box, click OK to save the settings.
By default, backup files are placed in the server folder on the FTP/SFTP server of the user
who scheduled the backup, using the following file format:
<filename>-<NETWORK>-<node>-<shelf>-<slot><time stamp>
where filename is the name provided when the C7 backup task was created, and <slot> is CSA
or CSB for the RAP, or the slot number of the IRC card. For example, BackupFile-TROY-
N1-1-CSA107890999, where BackupFile is the file name given, TROY is the network name,
and 107890999 is the UNIX time stamp in seconds.
You can optionally select a different folder on the FTP/SFTP server to back up the database
when scheduling the backup.
Note: CMS creates a separate backup file for each active RAP, IRC, and GE-2p card in the
backed up C7 network.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
361
Backing Up a C7 Shelf
If a snapshot fails for a C7 shelf, or you need to capture the database for a single shelf, CMS
enables you to back up an individual shelf in a C7 network without scheduling a network
backup.
Once the backup process is complete, snapshots of the active card databases are
automatically stored on the respective cards.
1. On the Navigation Tree, click the first shelf to back up, and then press the Ctrl key and
click other shelves in the network until all the shelves to include in the backup are
selected.
2. On the toolbar, click Action > Backup and Restore > Snapshot to create the backup
file(s).
Note: A Snapshot dialog box opens showing the backup progress.
Note: Export backup copies of the database to a remote server before resetting equipment
during a software upgrade.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
362
1. On the Navigation Tree, click a shelf from which to export backup data.
2. On the toolbar, click Action > Backup and Restore > Extract.
3. In the FTP dialog box, in the Slot Address list, click the slot address of the card to back
up, and then do the following:
a. In the FTP IP Address box, type the FTP address for the remote server.
b. In the FTP UserName box, type your user ID for the remote server.
c. In the FTP Password box, type your password for the remote server.
d. In the FTP File Name box, type a file name for the backup file. Include a full, valid
path to extract the file to a specific folder on the FTP server.
Tip: (CMS only) To the right of the FTP File Name field, click the ellipsis button to
open the FTP File List dialog box and navigate to a folder on the FTP server. To use this
feature, the FTP server must be accessible from the CMS client machine you are using.
e. Click OK.
Note: A Snapshot dialog box opens showing the export progress.
For shelves containing multiple database-equipped cards, repeat Steps 1 through 3 to export
backup data for each different card, as needed.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
363
In CMS, when a scheduled C7 network backup fails, use the following procedure to
troubleshoot the problem.
After you have corrected the problem, reschedule the backup task and check the results.
1. Determine the scope of the failure. Open CMS Desktop and navigate to the Detailed
Status window to view the scheduled task. See Viewing Scheduled Tasks (on page 345).
Complete Step 2, 3, or 4 below depending on whether the backups failed for all
networks, for all shelves in a network, or for a single shelf in a network.
2. If the backup failed for all networks included in the task, close the Detailed Status
window, and on the DB Backup Task window, verify that the information in the Backup
Server Info pane (FTP server, user name, password, and folder) is correct.
3. If the backup task failed for all shelves in a network and succeeded in other networks,
from a Telnet or X terminal session, ping the C7 network from the CMS server using the
IP address, user name, and password used to create the network in the CMS. Do one of
the following based on the results:
If you can successfully ping the C7 network: Manually extract one of the C7
databases to an FTP server directly connected to the network. If successful, manually
extract the C7 database using the CMS server as the FTP server, and manually extract
the C7 database to an FTP server running on the same network route as the CMS
server, and compare the results.
If you cannot ping the C7 network: Continue with the steps outlined in
Troubleshooting a C7 Network Connection (on page 208).
4. If the backup task failed for one shelf in a network and succeeded in other shelves in the
same network, investigate for a possible AMP/ATP or RAP card failure on the shelf
where the backup failed.
You cannot restore a complete C7 network at one time in CMS. CMS permits access to the
C7 Backup and Restore utility to retrieve backup copies of the provisioning database of a
single C7 shelf and restore them to the active RAP, IRC, or Ethernet uplink cards. When you
restore a database, the backup copy becomes the active database on the card.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
364
a. In the Slot Address list, select the slot number of the RAP, IRC, or GE-2p plug-in
card to restore.
b. In the FTP IP Address box, type the IP address of the FTP/SFTP host.
c. In the FTP Username and FTP Password boxes, type the user name and password
for the FTP host.
d. In the FTP Filename box, type the name of the folder, or click the box with the three
dots and navigate to the folder to restore from.
4. Click OK to restore the shelf database.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
365
You can switch RAP, IRC, and Ethernet uplink card database versions either together or
independently. Switching to the backup shelf database in a C7 network requires Full CMS
Administration privileges.
Calix strongly recommends following these guidelines for restoring backup data:
Restore backup data on all C7 shelves in the network where changes have occurred.
Switch all shelves at once, one after another, to minimize inconsistencies.
Always use backup files with a common baseline (same creation date and time) to
prevent provisioning conflicts between shelves.
Do not restore individual shelves with snapshots created at different times.
1. On the Navigation Tree, click the C7 shelf on which to switch to backup data.
2. Click Action > Backup and Restore > Switch.
3. In the BAR Switch dialog box, select one of the following radio buttons:
All (default) to backup all RAP, IRC, and GE-2p cards
Select to switch selected cards, and then click one or more cards
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
366
4. Click OK.
You can manually schedule an inventory snapshot of network elements by selecting the
regions and networks to include in the download and setting the snapshot time. One-time
inventory snapshots do not disable scheduled weekly snapshots.
When you view a search or an inventory report, the query results are based on the latest
synchronized data.
Only a CMS Desktop user in the Administrators user group can schedule an inventory
snapshot.
Note: When creating a scheduled task, the CMS user must have write permissions to the
CMS local directory specified.
Note: If you set the node's Auto Connect parameter to N (do not automatically reconnect)
and the node gets disconnected, the node is skipped when a scheduled task runs.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
367
An E3/E5-100 inventory data collection scheduled task that begins at 4:00 a.m. each
Sunday and recurs weekly.
An E5-400 inventory data collection scheduled task that begins at 5:00 a.m. each Sunday
and recurs weekly.
An E7/E3-48C/E5-48 inventory data collection scheduled task that begins at 6:00 a.m.
each Sunday and recurs weekly.
In the Scheduled Task Work Area, "Default" displays in the Note field for these scheduled
tasks. You can customize a system scheduled task, if needed.
Note: When upgrading CMS, system scheduled tasks (tasks with Job IDs less than 100) are
not exported with the CMS database. If you have customized a system scheduled task, you
must manually re-input the changes after the upgrade.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
368
Select the Schedule for later radio button. In date and time settings immediately
below the radio button selection, do the following:
Type the date on which to begin the task, or double-click the calendar icon to
open the Select Date dialog box and select the date.
In the hour and minute lists, click the time for the task to start.
If you are setting up a recurring scheduled task, select the Recurring check box, and
then do the following:
Select the Daily or Monthly recurrence pattern radio button. For the Daily
option, click the check box for each day of the week to download. Note:
Selecting fewer check boxes concentrates daily downloads onto the days checked.
Clicking more check boxes distributes daily downloads more evenly throughout
the week.
To specify an end date and time for the recurring task, select the Stop after check
box. Type the date on which to end the downloads, or double-click the calendar
icon to open the Select Date dialog box and select the date. In the hour and
minute lists, click the time to end downloads.
5. (Optional, for C7 and E7/E3-48C/E5-48 tasks) To create a snapshot task for MAC and
IP hosts, in the Data Types area of the screen, select the MAC Host and IP Host Only
check box.
6. In the Network Selection area, select the level(s) to take inventory snapshots, as follows:
a. On the Network Selection tree, double-click a region or network group to view the
region, network group, or nodes (not required when you are including all regions and
networks).
b. Right-click over a region, network group, or node to include, and then click Select.
The square to the left of the selection changes to green to indicate that it has been
included.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
369
c. Repeat Steps 5a and 5b for each additional region or network to include in the
snapshot. To remove a data location from the snapshot, right-click it, and then click
Un-Select.
7. At the bottom of the New Inventory Snapshot Task dialog box, click OK to save the
settings.
Note: Executing this procedure will cause the selected E series network elements to be
disconnected.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
370
c. Repeat Steps 5a and 5b for each additional region or network to include in the
snapshot. To remove a data location from the snapshot, right-click it, and then click
Un-Select.
6. In the Backup Server area, do the following:
a. In the FTP Server box, type the IP address of the FTP server to use. This is the FTP
folder specified in the File Backup task, as described in Scheduling Calix Network
Element Backups (on page 357).
b. Enter a Username and Password for accessing the server. Confirm the password.
c. In the Folder box, enter the folder where the backup configuration files are located.
7. In the File Selection area, select the name of the backup configuration file.
8. At the bottom of the Restore Task dialog box, click OK to save the settings.
Note: For E5-30x/E5-520 units, Calix strongly recommends that you change the default
network login credentials. Failure to do so may cause auto-provisioning disablement.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
371
Note: If the login user name or password does not match the user name or password, you
cannot connect to the device from CMS.
Modifying a device user name or password or SNMP settings requires Full CMS
Administration privileges.
Tip: If all or most of the C7 networks connected to CMS have RADIUS enabled, set the
default C7 user name and password to match the settings used.
Changing the default user name and password requires Full CMS Administration privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
372
To update C7 network connections with a new default user name and password
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
373
Note: If the CMS network password does not match the C7 user account password, you
cannot connect to the network from CMS.
Note: If a custom C7 network password is not used, the default C7 security settings (on page
371) will be used by CMS to access the network.
The following procedure assumes that you are currently connected to the C7 network and
are working in CMS. If the network is disconnected from CMS, you can change the user
account password by logging in to the network locally using the C7 iMS or TL1.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
374
Note: You must also modify these settings locally on the B6 cards. If the login user name or
password does not match the user name or password, you cannot connect to the B6 card
from CMS. Please refer to the B6 User Guide for information about how to change these
values locally.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
375
To change the B6 default user name, password, SNMP settings and manifest file
path
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
376
Note: If the login user name or password does not match the user name or password, you
cannot connect to the device from CMS.
Modifying an E3/E5-100 device user name or password requires Full CMS Administration
privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
377
Parameters
You can provision the following global E3/E5-100 parameters:
Parameter Description Valid Options
Default User Name and User name and password settings are case-sensitive and must Up to 250 characters
Password match a corresponding user name and password on the service unit. admin‡ / 1234‡
Default Read Only user Read Only user name and password settings are case-sensitive and Up to 250 characters
name and password should match a corresponding user name and password on the readonly‡ / r3ad0nly‡
service unit with Low security privileges.
Keep Port Enabled This setting controls whether E3/E5-100 subscriber ports are Y (disable after service
When Reset disabled after all services are removed. removal) or N‡ (do not
disable after service
removal)
Stop VLAN Delete on This setting controls whether E3/E5-100 VLAN are automatically Y (do not delete VLANs after
the Fly deleted after all port memberships are removed. port memberships are
removed) or N‡ (delete
Note: Blocking VLANs from being deleted may be helpful for E3/E5-
100 units that are configured in a daisy chain or ring arrangement, VLANs after port
memberships are removed)
ensuring that tagged traffic continues to be routed when a unit in the
chain or ring does not use a specific VLAN.
Auto Save Config for This setting controls whether E3-48 units perform a local Config Save Y (perform a Save Config
E3-48 operation after provisioning changes are made from the CMS operation when provisioning
management interface or via the OSMINE-compliant TL1 agent. Note changes are detected) or N‡
the following: (do not perform a Save
Config operation)
If this setting is set to N, the system relies on the nightly CMS
system scheduled task and any manually-performed Config Save
operations to save changes into non-volatile memory.
If this setting is set to Y, an hour after the CMS server starts, and
every 5 minutes thereafter, the system checks for provisioning
updates (SNMP SET messages) that have occurred in the past 5
minutes. When changes are detected, a Config Save operation is
triggered on the local unit.
‡ Default value
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
378
Modifying the database maintenance utility schedule requires Full CMS Administration
privileges.
Note: Although the database maintenance utility is non-intrusive and runs in the
background, it can slow query responses. Be sure to avoid running this utility concurrently
with scheduled PM downloads and inventory snapshots.
Avoid running the database maintenance utility during times of high database activity such as
during a CMS upgrade or while creating or connecting to Calix network elements. If
required, you can disable a scheduled database maintenance task to suspend the maintenance
activity, and then re-enable the utility when system tasks have completed.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
379
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
380
CMS objects include CMS security and user settings, regions, Calix devices, recurring
scheduled tasks (other than system scheduled tasks), global profiles and subscriber templates,
data and video subscriber information, and other system settings.
Alternatively, in the Module list on the left, click Administration > Export.
3. On the Export Dialog page, the CMS Objects radio button is selected by default.
4. In the CMS Objects area, select the check boxes to the left of each object to export, or
click the Select All check box to select all items.
Scroll to the bottom of the page, and in the Filename for Export box type a file name.
Do not include the file extension or a path.
5. Click Submit to open the File Download dialog box.
6. In the File Download dialog box, do the following:
a. Click Save to open the Save As dialog box.
b. Navigate to the location on your PC or workstation, and then click Save to save the
file.
Notes:
Do not import a CMS database from a higher CMS server software release to a
lower release.
When upgrading CMS server software, Calix recommends using the automatic import
feature for servers supporting less than 500,000 subscriber lines. For servers supporting
500,000 or more subscribers, refer to the Calix Installation and Upgrade Guide for
instructions on how to perform a full CMS installation after manually exporting CMS
database objects.
To import CMS objects from a completed CMS database backup, you must copy the
backup file to your PC or workstation.
If you import a CMS database that is older than the current database, subscriber
information for newer services may not display in the Services screen for ADSL and
ONT ports.
For Calix network elements with the Auto Connect parameter set to Y (automatically
attempt to reconnect), CMS attempts to establish a connection with the network when
the import is complete. For large databases, Calix recommends temporarily setting the
Auto Connect parameter to N before importing a CMS database, and after the import is
complete, turning the Auto Connect parameter back on for the same devices. For
instructions, see the specific device section in the "Configuration Management" chapter.
Importing CMS objects requires Full CMS Administration privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
382
Before starting the restore procedure, locate the previously saved backup or export file. If
needed, copy it to a folder on your PC or workstation. You need to know the file location in
order to complete the import procedure.
If importing a database backup into a current running CMS instance, the current Global data
will be overwritten based based on ID (or index). If there is extra provisioning within the
database to be imported that does not currently exist on the current running database, that
information will be add/appended to the Global provisioning. This applies to all Global data
including allowed Users and User Permissions, as well as all items under the Profile Tab.
Note: Take careful note of the database that is being imported. If the database is from a
completely different CMS instance, this could cause incorrect provisioning to be applied to
the existing Global Profiles, and possibly service impairment.
With the Export feature in CMS, you can export a CSV or text file containing a set of
profiles and templates from a single C7 network for backup purposes or for copying to other
networks. Network objects do not include subscriber provisioning data. For information
about provisioning data, see Performing Shelf Backups (on page 355).
Exporting and importing C7 network data requires Min (Minimum) CMS Administration
privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
383
You can copy previously exported C7 network templates and profiles to selected C7
networks that are connected to CMS. Before starting the copy procedure, you must have the
previously-saved export file on your PC or workstation.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
384
You can navigate HTML results by clicking the first, prev, next, and last links above the
table.
Note: If a query takes over 20 seconds to process, page entries that have been processed up
to that point display on screen while the system continues processing the remainder of the
query.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
385
Some log filters have system-determined values. You can select the value for the query (for
example, query for all delete changes on the CMS Update Log). Other filters have values
that are variable. For these values you can specify a match criterion (for example, query the
Security Log for all entries for the User ID DSmith).
Common filters
For all logs, you can query using one or more of the following filters:
Start and End Times: Specify the date and time range for the log report.
Network Name or CMS: Type all or part of a network name to return network alarms,
events, or entries, or type CMS to specify CMS alarms, events, or entries.
Node System ID: Type all or part of a node name (SID).
AID: Type all or part of an Access Identifier (AID).
Advanced filters
The following table shows the minimum permission level and Advanced filters available for
each log:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
386
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
387
a. In the list to the right of a filter, select a filter value or a match option.
b. For filters with match options, click a filter value or type a text string to define the
filter. For text strings, optionally select the Case Sensitive check box to only return
results matching the case you used. For example, to query for all events in nodes with
an AID of N1, set the AID match list to Equals and in the box, type n1 (N1 with the
Case Sensitive check box selected).
5. (Optional) Change the default sort by specifying one or more sort criteria.
Note: By default, log entries sort by time.
a. In the Column Name list, click the criterion to use as the primary sort.
b. In the Sort Order list, click Ascending or Descending to specify the sort order.
To display a secondary sort criterion, click More, and then repeat this step for the
additional criterion.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
388
Accept the default settings to display the search report on screen in HTML format
with 50 lines or row per page.
Save the file in CSV format by clicking CSV.
Tip: You can generate a CSV report after generating the HTML log report (in Step 7),
however, if you anticipate the search report to be large, using the option here eliminates
the processing required to generate the HTML report.
Change the number of lines per HTML page (or the number of lines to include in the
CSV file). Type a different number in the Lines Per Page box. For numbers over 999,
do not use a comma as a thousands separator.
7. At the bottom of the screen, do one of the following:
Use advanced search options (on page 104) to customize the columns displayed in the
report and the sort order, as well as set further filter criteria, by clicking Advanced.
At the bottom of the Web page or screen, click Submit. The search report displays
on screen, or if you selected CSV format in Step 6, the Downloading dialog box
opens with options to open the search report directly in your default spreadsheet
application or save the file open to a location on your PC or workstation.
Clear the Search screen of all search criteria by clicking Reset.
8. In the report screen, you have several options:
When the number of returned items exceeds the Lines Per Page set in Step 6, use the
Next, Last, First, and Prev hyperlinks to scroll through the search report.
Hover the mouse pointer over a column header to open a pop-up window with
description of the column contents.
Above the report buttons, click Back to return to the Search screen and modify the
criteria.
Save the results displayed on the current screen in CSV format. Above the report
results, click CSV Export. The Downloading dialog box opens with options to open
the search results directly in your default spreadsheet application, or save the file
open to a location on your PC or workstation.
Click Advanced to use advanced search options (on page 104) to customize the columns
displayed in the report and the sort order, or set further filter criteria.
Print the log query results using the print commands in your browser or spreadsheet
application.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
389
15-Minute PM 7 14
1-Day PM 30 90
Logs N/A 7
Log Events N/A 2
For PM data, the Archive settings determine the size of the archived database tables on the
CMS server. The CMS system uses archived database tables to divide PM data into more
than one table and thereby optimize the processing of database queries. For example, using
the default 1-day PM data settings, every 30 days, the set of 1-day PM data for the past 30
days is archived into a separate database table. Every 90 days, the oldest of the archived
database tables is deleted.
Note: As shown in the table of default archive and deletion values, the delete interval for PM
data should be a multiple of the archive interval.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
390
Alarm Synchronization
CMS synchronizes standing alarms with connected network elements every 60 minutes. On
occasion, you may need to manually synchronize, or re-load, standing alarms for specific
networks or nodes if you encounter abnormal behavior, such as an alarm that does not clear
from the Alarm Table. Alarm synchronization takes 10 to 15 seconds per network or node.
CMS time represents the time on the CMS server. If necessary, you can change the default
network time synchronization options based on your needs. Note the following:
Alarm and event times in the Alarm Table reflect CMS system time regardless of the
network time synchronization setting.
The date and time captured in the CMS logs and Alarm Table represent CMS server time.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
391
Note: You can view the node time for an alarm or event in the alarm and event logs and in
the Alarm Detail dialog box. See Fault Management (on page 257).
For C7 networks and E3/E5-100 nodes, the system automatically synchronizes the network
time to CMS time in three cases:
1. When you create a network and set the Synchronize CMS Time to Network parameter to
Y.
2. If you change the network time zone setting and set the SYNCHRONIZETIME
parameter in the Network Details area to Y.
3. If the SYNCHRONIZETIME parameter in the Network Details area is set to N, and
you change it to Y.
If the time stamps change for specific network alarms, you should manually synchronize the
network time to CMS time.
Note: You typically do not need to perform the procedure in this section.
Manually synchronizing C7 network time to CMS time requires Full CMS Administration
privileges.
Note: You typically do not need to perform the procedure in this section.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
393
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
394
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Chapter 10
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
396
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
399
discovered in CMS.
PM Process The Performance To restart the WebServer process,
Down (major) Monitoring (PM) stop and restart the CMS server using
process within the these UNIX commands: shutdown.sh
WebServer process is and startup.sh
not operating.
RADIUS Server Primary RADIUS See Troubleshooting RADIUS (on page
Fail (minor) server times out. 404).
Registration trap The AE ONT Select the check box to enable
processing Registration Trap registration trap processing in the AE
disabled (minor) Processing feature is ONT Settings screen. For
not turned on. instructions, see Configuring AE ONT
System Settings (on page 186).
SBCM Process The Southbound Stop and restart the SbcmProcess
Down (major) Connection Manager process. For instructions, see CMS
process is not Server Processes (on page 401).
operating.
SNMP Manager The process that Stop and restart the CMS application
Process Down handles E7 OS on the host server.
system alarm If the problem persists, contact Calix
reporting has TAC for assistance.
stopped.
SSHD Process The SSH server is Stop and restart SSHD. For
Down (major) down. instructions, see CMS Server Processes
(on page 401).
TrapReg B-Series or E-Series See Troubleshooting a TrapRegFailed
Failed (major) node SNMP traps Alarm (on page 134).
sent to the CMS
server are
unsuccessful.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
400
See also
For AE ONT alarms, see the Calix 700GX Active Ethernet ONT Troubleshooting and
Maintenance Guide and the Calix 2300 AE ONT Configuration Guide.
For C7 network alarms, see the Calix C7 Troubleshooting Guide.
For E-Series node alarms, see the platform-specific Calix user guide.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
401
Process Description
The CMS server requires the JBoss, WebServer, and SnmpManager processes to be running.
To restart these processes, stop and restart the CMS server using the shutdown.sh and
startup.sh UNIX commands. Other processes can be started and stopped from this page.
You can view the status of CMS server processes, as well as stop or start non-essential
processes from CMS Web.
Viewing CMS server processes requires Min (Minimum) CMS Administration privileges.
Starting or stopping CMS server processes requires Full CMS Administration privileges.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
402
To complete this procedure, you must log in to the host server as the root user.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
403
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
404
Troubleshooting RADIUS
The RADSERVFAIL alarm indicates that a single RADIUS server fails in a redundant
configuration. If both servers fail, the NORADSERVER alarm displays. For either of these
alarms, perform the following troubleshooting procedures:
Try logging in again.
Verify the shared secret, IP address, UDP port, and connectivity to the server.
Have RADIUS server administrator stop and restart the RADIUS server.
Change the user authentication mode to local.
If authentication still fails, you can query a detailed failure message from the security log. For
more information about security logs, see Generating Log Reports (on page 279) and the topic,
"Performing Log Queries with a Script," in the Calix Management System (CMS) Installation and
Upgrade Guide.
Verify that the attribute "Calix-CMS-User-Group" is configured for the user on the
RADIUS server.
Verify that the value matches a user group name configured in CMS. See Viewing CMS
User Groups (on page 78) for information about viewing user groups.
Calix also supports a third-party RADIUS test client to diagnose the CMS server RADIUS
issues. Contact technical support for more information about third-party RADIUS test
clients.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
405
The keep-alive ping setting is an integer from 1 through 60 minutes. Any user can configure
the keep-alive ping setting.
Note: The Session Timeout security setting takes precedence over the keep-alive ping
setting. For more information, see Modifying the Default CMS Security Settings (on page 86). In
the User Details Work Area, you can also set individual users to never time out. See Viewing
and Editing CMS User Details (on page 81).
1. From the Preferences menu, click Ping Settings. The Ping Preferences dialog box
opens.
2. Select or clear the Enable KeepAlive Ping check box as needed.
3. In the Ping Every ... Minutes text box, enter the number of minutes to ping the CMS
server.
4. Click OK.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
406
Troubleshooting SSH
You can manually shutdown, startup, and reset the SSH server with UNIX scripts included
in the CMS server installation. When you modify SSH server settings, the SSH server must
be reset without disconnecting the existing SSH client.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
407
Important: After a CMS software server upgrade, the frequency resets to the default. You
must reset a custom synchronization setting after each CMS upgrade.
Important: After a CMS software server upgrade, the audit frequency resets to the default.
You must reset a custom auto-connect audit frequency setting after each CMS upgrade.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
408
Important: After a CMS software server upgrade, the multithreading setting resets to the
default. You must reset a custom setting after each CMS upgrade.
For more information about the changing the default XML database HTTP port or F5 Web
session timeout, see the Calix Management System (CMS) Installation and Upgrade Guide.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
409
This procedure creates a ZIP file containing the CMS logs. You may be asked to e-mail the
ZIP file to Calix.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
410
Running Scripts
You may be requested to use a built-in TL1 script functionality to assist Calix Technical
Assistance Center (TAC) and engineering to troubleshoot problems and apply customer-
specific fixes. Scripts are supplied during the course of a customer support call.
If Calix TAC requests that you run a script, you will receive a ZIP file containing the ASCII
script file and a required MD5 hash file.
Note: The script uses the TL1 cut-through port 8199 on the CMS server.
To run a script
A Command Prompt window opens and the script runs on screen. When the script
completes, if further action is required, you may be asked to copy the text from the open
window and e-mail it to Calix TAC.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
411
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
412
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
Appendix A
Acronyms
The Calix documentation set uses the following acronyms:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.
414
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
.