Calix Management System (CMS)

R15.x Installation and Upgrade

Guide—Linux

September 2025

#220-00998-17

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Contents

About This Guide .......................................................................... 7

Intended Audience .......................................................................................................... 8

Guide Organization .......................................................................................................... 9

Calix Documentation Set ................................................................................................ 10

Prerequisites................................................................................................................ 12

Calix Platform Software Compatibility .............................................................................. 13

Chapter 1: Getting Started ........................................................ 15

Accessing the Host Server.............................................................................................. 16

Copying the CMS Server Installer to the Host Server ........................................................... 18

Chapter 2: Migrating CMS to a Newer Operating System ................ 21

Chapter 3: New CMS Installation Tasks....................................... 23

Quick Reference—Installing CMS ..................................................................................... 24

Before You Begin .......................................................................................................... 26

Oracle Database Recommendations .............................................................................. 26
Linux Configuration Requirements ................................................................................ 27
Installing Required Linux Packages ............................................................................... 27
RADIUS Recommendations ........................................................................................... 29
CMS Server Configuration Recommendations ................................................................ 29
Add the CMS Server Name and IP Address to the etc/hosts File...................................... 29

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
4

Installing CMS Server Software ....................................................................................... 30

Installing CMS Server Software Using the Wizard ........................................................... 30
Installing CMS Server Software Using the Console ......................................................... 32
Installing CMS Desktop .................................................................................................. 34

Service Verify MTOSI Bundling........................................................................................ 35

Chapter 4: CMS Upgrade Tasks ................................................. 37

Quick Reference—Upgrading CMS .................................................................................... 38

Logging Out CMS Users ................................................................................................. 40

Upgrading CMS Server Software (Linux) ........................................................................... 41

Upgrading CMS Server Software ................................................................................... 41
Upgrading CMS Server Software in Console Mode .......................................................... 44
Opening CMS Web ......................................................................................................... 47

Upgrading CMS Desktop on a Client Machine..................................................................... 49

Chapter 5: CMS Configuration Options........................................ 51

Quick Reference—System Configuration Tasks .................................................................. 52

Modifying the Default Synchronization Options .................................................................. 54

UNIX Scripts ................................................................................................................. 55

Performing PM Queries with a Script ............................................................................. 55
Performing a Daily PM Download with a Script ............................................................... 56
Performing Log Queries with a Script ............................................................................ 58
Backing Up Reporting Templates with a Script ............................................................... 59
Restoring a Reporting Template with a Script ................................................................. 60
Downloading ADSL Call Status Data .............................................................................. 61
Managing C7 Backup Files............................................................................................ 62

Chapter 6: Troubleshooting and Reference .................................. 63

Working with Scheduled Tasks ........................................................................................ 64
Creating a Scheduled Task ........................................................................................... 64
Viewing Scheduled Tasks ............................................................................................. 65
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 5

Modifying a Scheduled Task ......................................................................................... 66

Optimizing Scheduled Tasks ......................................................................................... 67
Troubleshooting Calix Network Element Connections ......................................................... 70
Troubleshooting a C7 Network Connection .................................................................... 70
Troubleshooting an E3/E5-100 Connection .................................................................... 70
Manually Disconnecting and Connecting an E3/E5-100 Node .......................................... 71
Troubleshooting an E-Series System Connection............................................................ 71
Manually Disconnecting and Connecting a System Node ................................................ 72
Troubleshooting a TrapRegFailed Alarm ........................................................................ 72
Troubleshooting F5 Database Synchronization .............................................................. 73
Synchronizing F5 Databases ......................................................................................... 74
CMS Server Operation.................................................................................................... 75
Manually Starting the CMS Server ................................................................................. 75
Verifying CMS Processes are Running on Host Server .................................................... 76
Verifying the CMS Server is Operating: CMS Web ........................................................... 77
Troubleshooting CMS Processes .................................................................................. 78
Viewing and Configuring the E-Mail Server ..................................................................... 78
Troubleshooting SSH ................................................................................................... 79
Enabling the CMS Server to Auto Restart—Linux ............................................................. 79
Database Tasks ............................................................................................................ 82
Exporting CMS Objects ................................................................................................. 82
Importing or Restoring CMS Objects.............................................................................. 83
Optimizing the Oracle Database .................................................................................... 84
Transferring PM and Log Data (Oracle) ......................................................................... 86
Postgres Database Maintenance................................................................................... 88
Switching Databases .................................................................................................... 89
Configuring a Primary and Secondary (Backup) Server ........................................................ 91

CMS System Configuration Settings ................................................................................. 95

Changing the Default Oracle XML Database HTTP Port .................................................. 97
Changing the Default F5/FD Web Session Timeout ......................................................... 97
Changing the Host Server Time ....................................................................................... 99

Troubleshooting the CMS Server Status.......................................................................... 100

Performing CentOS Administrative Tasks (CMS Appliance Servers) .................................... 101

Opening a Remote Management Session ..................................................................... 101
Configuring the CMS Server for DHCP Service.............................................................. 102
Configuring the CMS Server as the NTP Source............................................................ 104
Accessing AE ONT Configuration Files ........................................................................ 106
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
6

Default TFTP Configuration ........................................................................................ 106

Performing Linux Administration Tasks (CMS2GO Servers) ............................................... 107
Configuring the CMS Server as the NTP Source............................................................ 107
Enabling FTP and Telnet (CMS2GO) ............................................................................ 110
Configuring the CMS Server for TFTP .......................................................................... 110
Configuring the CMS Server for DHCP Service (Red Hat Linux) ...................................... 114
Configuring the CMS Server for SYSLOG Service (Red Hat Linux) .................................. 118
Uninstalling CMS Server Software ................................................................................. 122

Chapter 7: CMS Server Ports ................................................... 123

CMS Server Incoming Ports .......................................................................................... 124

Default Outgoing CMS Server Ports ............................................................................... 126

Changing Default CMS Server Ports ............................................................................... 127

Chapter 8: Basic Operating System Commands .......................... 129

Chapter 9: vi Editor Commands................................................ 133

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 7

About This Guide

The Calix Management System (CMS) Installation and Upgrade guide provides checklists and
instructions to complete new CMS server software installations and upgrades, as well as
information needed to configure and customize CMS for use.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
8

Intended Audience
The audience for the Calix Management System Installation and Upgrade Guide includes personnel
responsible for setting up and maintaining CMS server software. For larger Telcos, a dedicated IT
professional typically performs the required tasks at the Network Operations Center (NOC). Telcos
who have purchased the CMS Appliance server solutions can use the CMS Appliance Guide for initial
setup instructions, accessible online by logging into My Calix ([Link]/my-calix
([Link] and browsing the My Calix Documentation Library, and typically
only need to use the upgrade instructions in this manual. These customers may benefit from access
to a professional IT resource for questions and recommendations.

To install, configure, and maintain CMS server software, you must use basic Linux commands. For
novice users, this guide contains examples to assist you. To install, configure, and maintain the
optional RADIUS and LDAP server, you must be familiar with RADIUS server applications.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 9

Guide Organization
This guide is organized into the following sections:
 Getting Started: Lists examples of how to log in to the host server for novice users. Also
includes the procedure to download the CMS installer (used for upgrades) from the Calix
Resource Center.
 CMS Installation Tasks: Includes a checklist and instructions for installing the CMS server
software and CMS Desktop for the first time.
 CMS Upgrade Tasks: Includes a checklist and instructions for upgrading the CMS server
software and CMS Desktop.
 Appendices: Includes a checklist and instructions for configuring CMS, troubleshooting and
reference, basic operating system commands, and basic vi editor commands.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
10

Calix Documentation Set

You can access Calix product documentation by logging into My Calix ([Link]/my-calix
([Link] and browsing the My Calix Documentation Library. In addition, you
can view essential documentation using CMS online Help.

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

Calix E-Series platforms

 E-Series (E7 OS) Turn-Up and Transport Guide
 E-Series (E7 OS) xDSL Applications Guide
 E-Series (E7 OS) GPON Applications Guide
 E-Series (E7 OS) Maintenance and Troubleshooting Guide
 E-Series (E7 OS) System Software Upgrade Guide
 E-Series (E7 OS) GPON ONT Firmware Upgrade Guide
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 11

 E-Series (E7 OS) CLI Reference

 E5-30x/E5-520 User Guide
 E5-30x/E5-520 Monitoring and Troubleshooting Guide
 E5-30x/E5-520 Service Activation Test Guide
 E5-30x/E5-520 CLI References
 E5-400 User Guide and CLI Reference
 E7 Active Ethernet Applications Guide
 Calix E3/E5-100 Engineering and Planning Guide
 Managing Calix E3/E5-100 Service Units with CMS
 Calix E5-110/E5-111, E3-12C/E5-120/E5-121, and E3-48 User Guides and CLI References

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.
© Calix. All Rights Reserved.
12

Prerequisites
Before using the information and procedures in this guide, be sure that:
 A host server meeting the minimum CMS system requirements or a CMS Appliance server with
Internet connectivity is running. Check the CMS Release Notes to be sure that the latest system
requirements are met.
 If you are deploying CMS on a Virtual Machine, Calix recommends adding 1GB of memory above
the minimum stated requirements in the Release Notes in order to satisfy the hardware check.
 If you use an Oracle database, the database is installed, configured, and started.
Note: The advanced procedures in this guide require specific user privileges for Oracle
database administrators. For this purpose, Calix recommends creating an Oracle user with the
following privileges: Roles: CONNECT, RESOURCE; System: CREATE VIEW, UNLIMITED
TABLESPACE.
 If you use a RADIUS and LDAP server, the server is installed, configured, and started.
 Verify that you have a zip utility installed on the server to compress/decompress files.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 13

Calix Platform Software Compatibility

Support for the newest Calix equipment software releases is made available with each CMS release.

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 ([Link]/my-calix ([Link] and browsing the My Calix
Documentation Library.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
14

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Chapter 1

Getting Started
To review the current CMS host server system and client requirements, see the Calix Management
System (CMS) Release Notes, accessible online by logging into My Calix
([Link] and browsing the My Calix Documentation Library..

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
16

Accessing the Host Server

The instructions in this guide require you to access and log in to the host server running CMS.

This topic provides examples of how to access the host server in the following ways:
 Open a terminal window from the host server monitor.
 Use a remote Secure Shell (SSH) session.
 Use a remote telnet session.
The CMS2GO – Dell server uses a Linux Red Hat operating system. The CMS Appliance server uses
a Linux operating system.

To open a terminal window from the host server monitor

Note: If you are not currently logged in to Linux, when you turn on the monitor, a login prompt
displays. In this case, type the root Linux user name and password to log in.

1. Open a terminal window. From the Applications menu bar, click System Tools > Terminal.
2. Verify that you are logged in as the root user. At the prompt, type whoami, followed by <Enter>.
Example
Results similar to the following display in the terminal window:

[root@cmshost1 ~]# whoami

root
[root@cmshost1 ~]#

To access the host server from an SSH session

Note: From a Linux or Solaris client machine, type SSH hostname from a command prompt to
initiate the SSH session, where hostname is the name of the host server.

From a Windows PC, you must install an SSH utility, such as PuTTY, before you can open an SSH
session.

For example purposes, this procedure assumes that you are using PuTTY.

1. Open the SSH utility. (If you have a shortcut on your desktop, double-click the SSH client icon to
open a session window.)
2. In the Configuration dialog box:
a. In the Host Name (or IP Address) field, type the CMS host server name or IP address.
b. Accept the defaults (Port 22, and SSH as the connection type), as shown in the example
below.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 17

c. Click Open.

Tip: In PuTTY, you can save session parameters for future use. In the Saved Sessions field, type
a name for the session, and then click Save.

A command prompt window opens.

3. At the login prompt, type the Linux root user name used for logging in to the host server,
followed by <Enter>.
4. At the password prompt, type the password for the user, followed by <Enter>.
Example
The following example shows an SSH session log in. Your host server credentials may vary.
Note: The password does not display as you type it.

login as: root

root@cmshost1's password:
Last login: Thu Nov 29 13:48:56 2007 from [Link]
[root@cmshost1 ~]#

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
18

Copying the CMS Server Installer to the Host Server

The CMS installer is required to perform an installation or an upgrade of CMS server software.

To access the CMS server software on the Calix Resource Center, you must submit a request
through the Calix Service Station and have a current CMS license.

Use the Quick Reference—Installing CMS (on page 24) or Quick Reference—Upgrading CMS (on page
38) checklist as a reference for the steps to perform a successful CMS installation or upgrade. The
procedure in this section is referenced in each of the checklists.

Note: Your CMS system administrator typically performs this task.

To copy the CMS server installer to the host server

Note: This procedure assumes that you are downloading the CMS installer from the Calix Resource
Center and copying it directly to the host server. Alternatively, you can download the installer to a
PC or workstation and transfer it to the server using FTP.

There are two installation options (64-bit or 32-bit) for the CMS Server Software. You should chose
the option that is the same as your operating system.

1. To determine the Linux operating system, open a terminal program (get to a command prompt)
and type
uname -m
to get the kernel version.
 x86_64 is a 64-bit kernel
 i686 is a 32-bit kernel
2. Open a terminal window on the host server monitor, or use a remote telnet or SSH session to log
in to the host server as a root user. For examples, see Accessing the Host Server (on page 16).
3. Open a Web browser window. For example, on the Applications menu bar, click Internet >
Firefox Web Browser.
4. Launch Chrome or Firefox and log in to My Calix ([Link]/my-calix
([Link]

Note: An active Calix Advantage subscription is required for access to software. Contact your
Calix sales representative with any questions.

5. Select the Software Center tile.

6. On the Software Center home page, scroll down to the accordion view, and click Browse by
Platform > CMS > CMS to expand the accordion.
The blue bar shows the most recent major releases CMS, with the latest production minor
release version listed below each major release. To locate older major releases, such as to
establish an upgrade path to a current major release, click the right arrow above the table.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 19

Note: If the desired software is not listed, click Request Software (located below the software
table) and submit the online request form.

7. Click on the minor release software version, and then chose either the Linux 64 server or Linux
32 server file.
8. Review the license agreement, and then click Accept and Download.
The Calix Management System page opens.
a. Under Available Installers, right-click the Download link for the Linux host server platform
and in the popup menu, click Save Link As to save the file to a location on the server.

Note: The CMS installer file is several hundred megabytes in size. The time it takes to download
the file depends on your connection speed.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Chapter 2

Migrating CMS to a Newer Operating System

Beginning in 2024, CMS is supported on Red Hat Enterprise Linux 9 and Rocky Linux 9.

CMS support for CentOS 7 ended with CMS R15.1.891.

 RHEL 9 is supported for CMS R15.1.772 or higher.
 Rocky 9 is supported for CMS R15.1.891 or higher.

To migrate to a newer operating system

1. Back up your existing CMS database by scheduling a database backup task. Be sure to back up
to an FTP server that is not the CMS server. See Exporting CMS Objects (on page 82).
2. Upgrade the existing CMS instance to CMS R15.1.891. See Quick Reference—Upgrading CMS (on
page 38) and Logging Out CMS Users (on page 40).
Refer to the CMS Release Notes for supported operating systems for each CMS version..
3. Back up the CMS R15.1.891 database by scheduling a database backup task. Be sure to back up
to an FTP server that is not the CMS server. Refer to“Backing Up the CMS Database” in the Calix
Management System (CMS) R15.x User Guide.
4. Export CMS Objects from CMS Web. See Exporting CMS Objects (on page 82).
5. Install Red Hat Enterprise Linux 9.x or Rocky Linux 9.x on a new VM.
6. Install the required Linux packages. See Installing Required Linux Packages (on page 27).
7. Install and configure any additional services that were being used on the original CMS server,
such as ftp, tftp, ntp, and so on.
8. Install CMS R15.1.891 on the new VM. See Installing CMS Server Software.
9. Shut down the old CMS server or disconnect the server from the network.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
22

10. Restore the CMS R15.1.891r database by using the backup that you created in Step 4. See
Importing or Restoring CMS Objects (on page 83).
11. Upgrade the new server to the desired CMS release. Refer to the CMS Release Notes for
supported operating systems for each CMS version.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Chapter 3

New CMS Installation Tasks

This chapter covers the following topics:
 Quick reference check list for installing CMS
 Before you begin: Important reminders and recommendations for CMS and host server setup
 Installing CMS server software
 Installing CMS Desktop

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
24

Quick Reference—Installing CMS

Use the checklists below as a reference when you perform a full installation of CMS.

Notes
 Customers with CMS Appliance servers to do not typically need to perform the tasks marked
with an asterisk.
 If you are migrating Calix B6 network elements from OccamView to CMS, refer to the migration
process in the publication, Managing a B6 Network from CMS."
 For a list of CMS configuration tasks to perform after installation, see Quick Reference—System
Configuration Tasks (Linux) (on page 52).
 For a list of recommended CMS usage and maintenance tasks, see the Calix Management
System (CMS) Guide.

Pre-installation tasks
The tasks in the following table are typically performed by an IT system administrator.
Description Details Reference

Review the CMS system Be sure that your CMS server and See the Calix Management System
requirements.* client hardware and operating system (CMS) Release Notes.
meet the minimum or recommended
requirements.

Review your database setup If an Oracle database is used, the Oracle Database Recommendations
requirements.* database must be installed, (on page 26)
configured, and started.
Review your user If a RADIUS server is used, the server RADIUS Recommendations (on page
authentication and security must be installed, configured, and 29)
setup requirements. started.
Review the Disable insecure shell access and non- CMS Server Configuration
recommendations for essential network services. Recommendations (on page 29)
configuring the CMS server.*
Add the static IP address Update the etc/hosts file on the host Updating the etc/hosts File (Linux)
and the DNS name for the server. Verify that it matches the (on page 29)
CMS server.* example in the documentation.
Configure firewall access to Required settings vary based on CMS Server Ports (on page 124)
the default incoming CMS company requirements and whether
server ports. the CMS server is behind an Intranet
firewall.
Create an installation folder Assign the necessary folder
for the CMS server on the permissions.
host server.*
Copy the CMS installer onto To access the CMS server software on Copying the CMS Server Installer to
the CMS host server.* the Calix Resource Center, you must the Host Server (Linux) (on page 18)
initiate a support call to Calix and have
a current CMS license.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 25

* Not required for CMS Appliance customers

CMS full installation tasks

The tasks in the following table are typically performed by the CMS administrator.
Description Details Reference

Review the CMS Become familiar with the online Calix Log into My Calix
documentation and release documentation set, and review the list ([Link]/my-calix
notes. of open issues. ([Link]
and browse the My Calix
Documentation Library
Install CMS server The installation process includes an Installing CMS Server Software (on
software.* option to start the CMS server. page 30)
If you do not start the server during the Manually starting the CMS server (on
installation, you must start in page 75)
manually.
Verify that the CMS server is running. Verifying CMS Processes are
Running on Host Server (on page 76)
or Verifying the CMS Server is
Operating: CMS Web (on page 77)
Install CMS Desktop on user Install from CMS Web. Installing CMS Desktop (on page 34)
machines and verify that you To view the CMS server version,
are running the correct CMS open CMS Web.
version.
To view the CMS client version
number, in CMS Desktop, click Help
> About.
Optimize the PM and Log This procedure is recommended when Optimizing the Oracle Database (on
database tables in Oracle. managing more than 500 network page 84)
elements.
(Optional) Delete unused Delete the CMS installer file and older Uninstalling CMS Server Software
files. CMS installations. (on page 122)

To integrate CMS with a Calix supplies a set of MIBs for back- To access the MIBs, fill out the
back-office Operating office OSS integration. online request form on the Calix
Support System (OSS), Resource Center.
obtain the CMS MIBs and
load them into your SNMP
manager.
* Not required for CMS Appliance customers

Continue with the CMS configuration tasks. See Quick Reference—System Configuration Tasks (on
page 52).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
26

Before You Begin

Before installing CMS server software, review and complete the required and applicable steps in this
section.

In addition, review the lists of incoming and outgoing CMS server ports (on page 123) to be sure your
IT system administrator has enabled the necessary server ports.

Note: For CMS Appliance customers, CMS server configurations are pre-configured when the
product is shipped. For the setup steps, see the CMS Appliance Quick Start Guide, accessible online
by logging into My Calix ([Link]/my-calix ([Link] and browsing
the My Calix Documentation Library. If you use a RADIUS server for user authentication and security,
use the documented guidelines to configure the server.

Oracle Database Recommendations

CMS server installation includes a Postgres relational database. You can optionally configure the
CMS to use an Oracle database to increase overall system performance and scalability. Be sure to
install, configure, and start the Oracle database before installing the CMS server software.

Note for Oracle database administrators: Calix recommends creating an Oracle database user with
the following user privileges: Roles: CONNECT, RESOURCE; System Privileges: CREATE VIEW,
UNLIMITED TABLESPACE; Default tablespace: CMS_DATA.

Note: For information on changing the default Oracle HTTP port assignment to avoid a conflict
between Oracle and CMS Web, refer to Changing the Default Oracle XML Database HTTP Port (on
page 97).

Have the following information from your Oracle database administrator available during the CMS
installation:
 Hostname: Name of Oracle server host
 Port: Server port for Oracle access
 SID: System ID of Oracle database
 Username: Oracle user name
 Password: Oracle password

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 27

Linux Configuration Requirements

By default, Linux applies a lower limitation to the resources needed by CMS server to run. This limit
is intended to prevent a normal user process from forking too many child processes that could use
up all the system resources.

You need to modify the configuration file before you start a new CMS server.

To modify the configuration file

1. Open the /etc/security/[Link] file in a text editor.

2. Add the following lines at the end of the file:
* soft nofile 65536 # open files (-n)
* hard nofile 65536
* soft nproc 65565
* hard nproc 65565 # max user processes (-u)

Note: This file must be changed prior to the start of a CMS server. If the CMS server has already
been running, you will need to restart the CMS server application.

Installing Required Linux Packages

CMS requires several libraries for Rocky Linux and Red Hat Enterprise Linux.

To install and update the required libraries:

1. Open a terminal window on the host server, or use a remote telnet or SSH session to log in to
the host server as a user with root privileges. For examples, see Accessing the Host Server (on
page 16).
2. Ensure that the Bash version is 4.0 or later. Run the following command:
$ bash --version

If the version is older than V4.0, run the following command to update Bash:
yum -y update bash

3. Determine if required commands are available. Run the following command:

$ type awk basename bc cat chkconfig chmod chown crond crontab curl cut date
df dirname docker expr file find getenforce getent grep groupadd gzip head
hostname id ifconfig ls lsof md5sum mkdir mktemp mount mv netstat ps
readlink rev rm rpm sed sleep sort stat su swapon systemctl tail tar tcpdump
tee telnet timedatectl top touch tr uname unzip useradd usermod vmstat watch
wc whoami yum zip

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
28

If any of the commands are not found, run the following command to install the missing items:
yum install <command-name>

4. Add the required Rocky Linux libraries by running the following command:
yum install -y glibc.i686 libgcc.i686 libXext.i686 libX11.i686 libXtst.i686
lsof net-tools.x86_64 net-tools [Link].1 libnsl [Link].1 [Link].1
[Link].2 net-tools sysstat tar tcpdump telnet chkconfig zip

5. Update all installed packages by running the following command:

yum update
6. Disable SELinux live by entering the following command:
setenforce 0

7. Edit startup config to permanently disable SELinux.

a. Open the config file for editing by entering the following command:
nano /etc/selinux/config

b. Locate the following lines:

# This file controls the state of SELinux on the system.
# SELINUX= can take one of these three values:
# enforcing - SELinux security policy is enforced.
# permissive - SELinux prints warnings instead of enforcing.
# disabled - No SELinux policy is loaded.
SELINUX=enforcing
# SELINUXTYPE= can take one of three two values:
# targeted - Targeted processes are protected,
# minimum - Modification of targeted policy. Only selected processes are
protected.
# mls - Multi Level Security protection.
SELINUXTYPE=targeted

Change the contents of line 8 to disable SELINUX, as in the following lines:

# This file controls the state of SELinux on the system.
# SELINUX= can take one of these three values:
# enforcing - SELinux security policy is enforced.
# permissive - SELinux prints warnings instead of enforcing.
# disabled - No SELinux policy is loaded.
SELINUX=disabled
# SELINUXTYPE= can take one of three two values:
# targeted - Targeted processes are protected,
# minimum - Modification of targeted policy. Only selected processes are
protected.
# mls - Multi Level Security protection.
SELINUXTYPE=targeted

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 29

RADIUS Recommendations
CMS enables administrators to optionally use a RADIUS server for user authentication and security.
Calix strongly recommends installing your RADIUS server on a server separate from the server
hosting the CMS server software. For more information, see the Calix Management System (CMS)
Guide.

CMS Server Configuration Recommendations

Calix recommends configuring the CMS server host with the following settings:
 Disable insecure shell access, such as rsh, rlogin, and telnet.
 Disable non-essential network services.
 Check that the /tmp folder on the host server has at least 2 GB of free disk space, and write
permission for all users.

Add the CMS Server Name and IP Address to the etc/hosts File
Before you install the CMS server software, you must obtain the static IP address and DNS name for
your CMS server and update the etc/hosts file on the host server.

Note: This procedure is not required for CMS Appliance servers; for these servers, completing the
setup steps as detailed in the CMS Appliance Quick Start Guide automatically configures the
etc/hosts file.

To update the etc/hosts file

1. To view the file etc/hosts, type the following command in a terminal window or remote telnet or
SSH session:
cat /etc/hosts
2. Use vi or another text editor to edit or add the CMS server static IP address and DNS name to
match the following example:

[Link] [Link] localhost

[Link] cmsserver

where [Link] is the CMS server static IP address, and cmsserver is the name of the CMS
server.

Note: During an operating system upgrade on the host server, the local host loopback address may
be modified by adding the server name, causing CMS to fail to properly synchronize. After such an
upgrade, verify that the server name is not on the line with [Link] [Link]
localhost. If that line does not read exactly as shown above, edit it so that it does.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
30

Installing CMS Server Software

Use the Quick Reference—Installing CMS (on page 24) checklist as a reference for the steps to
perform a successful installation. The procedures in this section are referenced in the checklist.

Users with a desktop environment on their host server can install CMS using the installation wizard.
If you do not have access to a desktop environment, you can install CMS server software in console
mode.

The CMS system administrator typically installs CMS server software.

Note: These installation instructions apply to both the 32-bit and 64-bit CMS Server Software.

Installing CMS Server Software Using the Wizard

To install CMS server software using the wizard

1. Open a terminal window on the host server, or use a remote telnet or SSH session to log in to
the host server as a root user. For examples, see Accessing the Host Server (on page 16).
2. If you have not yet copied the CMS installer, complete the procedure Copying the CMS Server
Installer to the Host Server (Linux) (on page 18).
3. Navigate to the directory where you copied the CMS installer file and set ownership and
permissions for the file. Enter the following commands:
chown root:root [Link]
chmod 777 [Link]

4. Begin installing the CMS server software. Enter the following command:
sh [Link]

Example
In the following example, /cms_installer_dir indicates the directory where the CMS server
installer file was copied:

[root@cmshost1 bin]# cd /cms_installer_dir

[root@cmshost1 cms_install_dir]# chown root:root [Link]
[root@cmshost1 cms_install_dir]# chmod 777 [Link]
[root@cmshost1 cms_install_dir]# sh [Link]

Preparing to install ...

Extracting the JRE from the installer archive ...

Unpacking the JRE ...
Extracting the installation resources from the installer archive ...

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 31

Configuring the installer for this system environment ...

Launching installer ...

5. After several minutes, the installation wizard Introduction screen opens.

Note: If the physical memory size is less than 12G, CMS will prompt a warning message that
allows the end user to choose "Quit" or "Continue". Choosing “Continue” will allow the installer
process to continue.

After the first check, if the total amount of physical memory and swap size is less than 18G,
CMS will prompt another warning message and allow the end user to choose “Quit” or
“Continue”. Choosing “Continue” will allow the installer process to continue.

6. Click Next. The License Agreement window opens.

7. Click to accept the terms, and then click Next. The Choose Install Folder window opens.
Review the following note, and then type the absolute path on the local drive of the host server
to install the CMS server software. Alternatively, click Choose to browse and locate or specify
the installation directory in the Select a Folder dialog box.

Note: For CMS server processes to run, the home directory for the CMS server software cannot
be more than 45 characters in length.

Note: Do not specify a new folder inside another CMS installation directory or in the
export/home directory.

If the destination directory does not exist, the installer will automatically create it.
8. Click Next. The Select Database window opens.
Do one of the following:
 If you have not installed Oracle, click PostgresSQL Database, and then click Next.
 If you have installed Oracle, click Oracle Database, and then click Next and complete the
form with information provided by your Oracle database administrator. Click Next.
The Pre-Installation Summary window opens.
9. Click Install to complete the installation of CMS server software, or click Previous to return to
the previous screens and change the settings.
The Installing window opens showing the progress of the installation.

Note: It takes several minutes to complete the installation.

After the installation completes, the Start CMS Server on Operation System Start window opens.
10. Accept the default (Yes) to automatically restart the new version of CMS any time after the host
server reboots in the future. Click Next to continue.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
32

Note: If you select No, you must manually start the CMS server each time the host server
reboots. For instructions, see Enabling the CMS Server to Auto Restart—Linux (on page 79).

A window opens with the message: Installer has completed copying all required
files. Do you want to start Calix Management System?

11. If you are ready to start the CMS server, accept the default Start Now, otherwise select Continue
Without Starting. Click Next.
It can take up to 15 or 20 minutes for the CMS server to start, during which time the "Starting
CMS" message displays.
The Install Complete window opens.
12. Click Done to close the installation wizard.
After several seconds, the Linux prompt displays.
If you did not start the CMS server in Step 9, to do so manually, see Manually Starting the CMS
Server (on page 75).
13. Log in to CMS Web and confirm that the CMS server is running. For instructions, see Opening
CMS Web (on page 47).
14. Install CMS Desktop on each required client machine. See Installing CMS Desktop (on page 34).

Installing CMS Server Software Using the Console

To install CMS server software in console mode

1. Log in to the server used to host CMS as the root user.

2. If you have not yet copied the CMS installer, complete the procedure Copying the CMS Server
Installer to the Host Server (Linux) (on page 18).
3. Navigate to the directory where you copied the CMS installer and set ownership and
permissions for the file. Enter the following commands:
chown root:root [Link]
chmod 777 [Link]

4. Begin installing the CMS server software. Enter the following command:
sh [Link] -i console

The CMS installer launches in text mode. At the PRESS <ENTER> TO CONTINUE prompt, press
<Enter>.

Note: If the physical memory size is less than 12G, CMS will prompt you with a warning
message. Use parameter -Dramcheck=false to skip this check.

After this first check, if the total amount of physical memory and swap size is less than 18G,
CMS will prompt you with another warning message.
Use parameter -Dswapcheck=false to skip this check.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 33

5. Review the software right-to-use license agreement. Press <Enter> several times to read through
the agreement. At the DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N)
prompt, type Y and press <Enter> to continue.
6. At the prompt, type the path on the local drive of the host server to install the CMS server
software. Press <Enter> to continue.

Note: For CMS server processes to run, the home directory for the CMS server software cannot
be more than 45 characters in length.

Note: Do not specify a new folder inside another CMS installation directory or in the
export/home directory.

If the destination directory does not exist, the installer will automatically create it.
7. At the prompt, select the database type:
 For Postgres, select 1. Press <Enter> to continue.
 For Oracle, select 2. Press <Enter> to continue.
8. Pre-installation summary information displays. Press <Enter> to continue, and then wait for the
installation to complete.

Note: It takes several minutes for the installation to complete.

9. After the installation completes, the following prompt displays:

Do you want to start the CMS server on a operation system start?

Calix recommends typing 1 (Yes) to automatically restart the new version of CMS any time after
the host server reboots in the future. Press <Enter> to continue.

Note: If you choose not to enable the auto restart option, you must manually start the CMS
server each time the host server reboots. For instructions, see Enabling the CMS Server to Auto
Restart—Linux (on page 79).

10. At the Start Calix Management System prompt, Calix recommends accepting the default 1 (Start
Now) in most cases. Press <Enter> to continue.

Note: It can take up to 15 to 20 minutes for the CMS server to start.

If you did not start the CMS server, to do so manually, see Manually Starting the CMS Server (on
page 75).
11. Log in to CMS Web and confirm that the CMS server is running. For instructions, see Opening
CMS Web (on page 47).
12. Install CMS Desktop on each required client machine. See Installing CMS Desktop (on page 34).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
34

Installing CMS Desktop

You must install CMS Desktop on your Windows PC, MacOS, Sun workstation, on Linux PC for
complete access to CMS. You can download the CMS Desktop client installer in one of two ways:
 Log into My Calix ([Link]/my-calix ([Link] and browse the My
Calix Software Center.
 After installing CMS server software, log into CMS Web and use the directions below.
Tip: Once installed, CMS Desktop automatically updates to the current software version as the CMS
server. If you plan to access more than one version of CMS from the same PC or workstation,
specify a distinct installation folder name when you install CMS Desktop.

To install CMS Desktop from CMS Web

1. Open CMS Web (on page 47).

2. In the Links list on the left side of the CMS Home page, click CMS GUI Installer. The CMS GUI
Installer window opens.
If a security warning dialog box opens, click Yes to grant system access to the Java applet.
3. Under Recommended Installation for Your Platform, click Download Installer (for Windows, Sun
Solaris, or Linux). A File Download dialog box opens.
4. Click Save, navigate to a location on your local drive, and download the install file. Alternatively,
you can click Run to run the installer file without downloading it.
5. Run the installer file:
a. On your Windows PC, run: [Link]
b. On your Mac, complete the following steps.
i. After downloading, execute the AllInOneInstaller script.
ii. The compressed installer should be recognized by Stuffit Expander and should
automatically be expanded after downloading. If it is not expanded, you can expand it
manually using StuffIt Expander 6.0 or later.
iii. It is necessary to use an earlier version of the Java installer which is included with CMS.
Control-click the "[Link]." Do not double-click it since it is not from app store.
iv. Open a terminal and use chmod to add executable permissions to the script
"AllInOneInstaller" and execute it. The client installer will be launched immediately
6. Follow the on screen instructions in the installation wizard.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 35

Service Verify MTOSI Bundling

For Service Verify integration, the MTOSI interface is bundled into the CMS software. Contact your
Calix Service Verify representative to complete the MTOSI setup.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
36

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Chapter 4

CMS Upgrade Tasks

This chapter covers the following topics:
 Quick reference check list for upgrading CMS
 Exporting and Importing a Large CMS Database During a CMS Upgrade
 Logging out CMS users
 Upgrading CMS server software
 Opening CMS Web
 Upgrading CMS Desktop on a client machine

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
38

Quick Reference—Upgrading CMS

Use the checklist below as a reference when you upgrade CMS server software.

Before you begin

 Refer to the CMS Release Notes on the Calix Resource Center to review the latest system
requirements, determine the required upgrade path, and review the list of open issues. Log in at
[Link] and click Support > Documentation. Under Calix Software Products, click CMS
Network Management.
 If you are changing the host server time, be sure that you understand the implications for
connected Calix network elements. See Changing the Host Server Time (on page 99).
 CMS Appliance customers with dual (primary and secondary) host server can contact Calix TAC
for assistance with upgrading the secondary server.

Description Details Reference

Log out all active CMS client Logging Out Users (on page 40)
sessions.
Optional. Migrate the Supported in2023 releases and later. Migrating to Red Hat Enterprise
operating system to Red Hat Linux 9 or Oracle Linux 9
Enterprise Linux 9 or Oracle
Linux 9.
Verify that server meets the Review the system preparation topics Before You Begin (on page 26)
system requirements. to ensure that the server meets the
current requirements.
Copy the CMS installer file Copying the CMS Server Installer to
to the CMS host server. the Host Server (Linux) (on page 18)

Perform the CMS server The upgrade wizard prompts you to Upgrading the CMS Server Software
upgrade. start the CMS server. (Linux) (on page 41)
If you do not to start the server during Manually starting the CMS server (on
the upgrade, you must start it page 75)
manually.
Distribute or install CMS CMS Desktop users are automatically Upgrading the CMS Desktop on a
Desktop (client) for any new prompted to update to the latest client Client Machine (on page 49)
user PCs or workstations version when they next log in to CMS Installing CMS Desktop (on page 34)
(not required for current Desktop.
CMS Desktop users).
Open CMS Desktop and If you encounter problems, contact the
verify that CMS objects have Calix Technical Assistance Center
migrated to the new CMS (TAC).
installation.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 39

Description Details Reference

Review all CMS system System scheduled tasks (tasks with Working with Scheduled Tasks (on
scheduled tasks and adjust Job IDs less than 100) are not page 64)
the timing, frequency, or exported with the CMS database.
scope as needed to meet If you have customized or deleted any
your company requirements. system scheduled tasks, you must
manually re-input the changes after the
upgrade.
Verify that access is open to Check with your host system CMS Server Ports (on page 124)
the incoming ports required administrator and follow company
to support Calix network policy and procedures.
elements.

If cron jobs and UNIX scripts Modify any cron jobs and UNIX scripts, For the correct formats, see
are used, modify them with such as pmdownload, to correctly Performing a Daily PM Download
the new CMS application reference the new application. with a Script (on page 56)
location.

Review the available system System settings, if previously CMS System Configuration Settings
configuration settings based customized, must be reset after each (on page 95)
on your company needs. upgrade.

Test and verify.  Verify that the correct CMS version To view the CMS server version,
number displays. open CMS Web. To view the CMS
 Check network and node client version number, in CMS
connectivity. Desktop, click Help > About.

 Verify any optional settings you Troubleshooting Calix Network

have made. Element Connections (on page 70)

(Optional) Delete unused Calix recommends retaining the two Uninstalling CMS Server Software
files. previous CMS installations on the host (Linux) (on page 122)
server for backup purposes.

If CMS is integrated with an Load the MIBs into your SNMP To access the MIBs, fill out the
Operating Support System manager online request form on the Calix
(OSS), obtain the latest CMS Resource Center.
MIBs.

If CMS is integrated with Reinstall CMS Probe according to the Refer to Calix Operations Cloud Help
Calix Operations Cloud, instructions in "Reconnect CMS to in the Calix Documentation Library
reinstall CMS Probe. Operations Cloud After CMS Upgrade" ([Link]
in Calix Operations Cloud Help. calix/[Link] (on page 10))

If you are connecting to Calix Operations Cloud, you must reinstall CMS probe and reconnect CMS to
Calix Operations Cloud. Refer to the Calix Operations Cloud Help topic "Reconnect CMS to
Operations Cloud After CMS Upgrade" for details.

Continue with the CMS configuration tasks. See Quick Reference—System Configuration Tasks (on
page 52).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
40

Logging Out CMS Users

Logging out active CMS users requires Full CMS Security privileges.

To log out CMS users

1. On the Navigation Tree, click CMS.

2. In the Work Area, click Security > Sessions.
3. In the USERID column, click a user. To select multiple users, use Shift + click to select a range,
or Ctrl + click to select users in the list one at a time.
4. Click Action > Logout User.
5. In the Confirmation dialog box, click OK to confirm.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 41

Upgrading CMS Server Software (Linux)

Use the Quick Reference—Upgrading CMS (on page 38) checklist as a reference for the steps to
perform a successful upgrade. The procedure in this section is referenced in the checklist.

Important notes
 The procedures in this section assume that you are currently running CMS R15.1.827 or higher.
If you have an older version of CMS, refer to the CMS Release Notes or contact Calix TAC to
determine the required upgrade path.
 When upgrading CMS, default scheduled tasks (those with Job ID numbers under 100) are not
exported with the CMS database. If you have customized a system scheduled task, you must
manually update the system scheduled task after the upgrade.
 If the old version is on the same host, and the old version is CMS16 or later, there is no need to
manually export the data of the old version, and you must ensure that the old version of the
CMS is running. If the old version of CMS is not running, the old version data cannot be
automatically exported.
The CMS system administrator typically installs CMS server software.

Notes:

The installer stops the upgrade process if the following criteria are not met:

* If the operating system is not RedHat Linux 9 or Rocky Linux 9, the installer stops.

* If the machine memory is less than 32GB, the installer stops.

* If the available disk space is less than 80GB, the installer stops.

Upgrading CMS Server Software

Calix provides a convenient installation wizard to step you through an upgrade of CMS server
software. Use the following steps to complete the upgrade.

To upgrade CMS server software using the wizard

1. Log in to the host server as the root user. For tips and examples, see Accessing the Host Server
(on page 16).
2. If you have not yet copied the CMS installer file, complete the procedure, Copying the CMS
Server Installer to the Host Server (Linux) (on page 18).
3. Navigate to the directory where you copied the CMS installer file and set ownership and
permissions for the file. Enter the following commands:
chown root:root [Link]
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
42

chmod 777 [Link]

4. Begin the installation of the CMS server software by entering the following command:
sh [Link]

Example
In the following example, /home/cms_installer_dir indicates the directory where the CMS server
installer file was copied:

[root@cmshost01 bin]# cd /home/cms_installer_dir

[root@cmshost01 cms_install_dir]# sh [Link]

Preparing to install ...

Extracting the JRE from the installer archive ...

Unpacking the JRE ...
Extracting the installation resources from the installer archive ...
Configuring the installer for this system environment ...

Launching installer ...

After several minutes, the installation wizard Introduction screen opens.

Note: If the physical memory size is less than 12G, CMS will prompt a warning message that
allows the end user to choose "Quit" or "Continue". Choosing “Continue” will allow the installer
process to continue.

After the first check, if the total amount of physical memory and swap size is less than 18G,
CMS will prompt another warning message and allow the end user to choose “Quit” or
“Continue”. Choosing “Continue” will allow the installer process to continue.

5. Click Next.
The License Agreement window opens.
6. Click I Accept the Terms of the License Agreement, and then click Next.
A "CMS Server Already Running" prompt displays.
7. Click Continue.
The Export Data from Existing CMS Server Window opens.
8. Type an active CMS administration user name (such as rootgod) and password with
permissions to export CMS data, and then click Next.

Note: Do not use the log in ID of the user that the CMS server is running under.

The Choose Install Folder window opens.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 43

9. Review the following notes, and then type the absolute path on the local drive of the host server
to install the CMS server software. (If the destination directory does not exist, the installer
automatically creates it.) Alternatively, click Choose to browse and specify the installation
directory. Click Next to continue.

Note: For CMS server processes to run, the home directory for the CMS server software cannot
be more than 45 characters in length.

Note: Do not specify a folder inside the currently-running CMS installation folder or in the
export/home directory.

The Select Database window opens.

10. Do one of the following:
 If you have not installed Oracle, accept the default PostgresSQL Database, and then click
Next.

Note: CMS Appliance servers use the PostgresSQL database.

 If you have installed Oracle, click Oracle Database. Click Next and complete the form with
information provided by your Oracle database administrator. Click Next to continue.
The Pre-Installation Summary window opens.
11. Click Install to begin installing the CMS server software, or click Previous to return to the
previous screens and change the settings.

Note: It takes several minutes for the CMS server software to fully install. During this time, the
installer shuts down the current CMS application.

The Installing window opens showing the progress of the installation.

After the installation completes, the Start CMS Server on Operation System Start window opens.
12. Accept the default (Yes) to automatically restart the new version of CMS any time after the host
server reboots in the future. Click Next to continue.

Note: If you select No, you must manually start the CMS server each time the host server
reboots. For instructions, see Enabling the CMS Server to Auto Restart—Linux (on page 79).

A window opens with the message: Installer has completed copying all required
files. Do you want to start Calix Management System?

13. Calix recommends accepting the default Start Now in most cases. Click Next to continue.
It can take up to 15 or 20 minutes for the CMS server to start, during which time the "Starting
CMS" message displays:

Note: If you do not start the CMS server at this time, when you are ready to do so, see Manually
Starting the CMS Server (on page 75).

The Install Complete window opens.

14. Click Done to close the installation wizard.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
44

15. Log in to CMS Web and confirm that the CMS server is running the correct version. For
instructions, see Opening CMS Web (on page 47).
16. Upgrade CMS Desktop on each affected client machine by completing the procedure, Upgrading
CMS Desktop on a Client Machine (on page 49).
17. Run an immediate Inventory Snapshot. See "Scheduling an Inventory Snapshot" in the CMS User
Guide for details.
18. If you are connecting to Calix Operations Cloud, reinstall CMS Probe according to the
instructions in "Reconnect CMS to Operations Cloud After CMS Upgrade" in Calix Operations
Cloud Help.

Upgrading CMS Server Software in Console Mode

You can optionally use a command-line driven method to step you through an upgrade of CMS
server software.

To upgrade CMS server software in console mode

1. Export the data of the old version of CMS, then shutudown the old CMS. For tips and examples,
see Exporting CMS Objects (on page 82).
Assume that the export file name is oldcms_exportfile.zip.

Note: If the old version is on the same host, and the old version is CMS16 or later, skip this step.

2. Log in to the host server as the root user. For tips and examples, see Accessing the Host Server
(on page 16).
3. Copy the file that you exported in Step 1 to the local directory /cms_installer_dir.

Note: If the old version is on the same host, and the old version is CMS16 or later, skip this step.

4. If you have not yet copied the CMS installer file, complete the procedure, Copying the CMS
Server Installer to the Host Server (Linux) (on page 18).
5. Navigate to the directory where you copied the CMS installer file and set ownership and
permissions for the file. Enter the following commands:
cd /cms_installer_dir
chown root:root cmsx-<release-build-no>-[Link]
chmod 777 cmsx-<release-build-no>-[Link]

Where:
/cms_installer_dir indicates the directory where the CMS server installer file was copied
<release-build-no> is the CMS release build number. For example, cmsx-[Link]-linux-
[Link].

6. Begin upgrading the CMS server software. Enter the following command:
./cmsx-<release-build-no>-[Link] --mode text --import-file
/cms_installer_dir/oldcms_exportfile.zip

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 45

Note: If the old version is on the same host, and the old version is CMS16 or later, do not add
the parameter --import-file /cms_installer_dir/oldcms_exportfile.zip.

The installer displays initial progress:

-Initial installer log file: /tmp/installbuilder_installer_103963.log.
After installation is completed, installer logs will be saved to:
TARGET_DIR/logs/installer/[Link].
Using temp directory: /tmp/tmp.tJ9aerMbDN
----------------------------------------------------------------------------
Welcome to the Calix Management System Setup Wizard.

----------------------------------------------------------------------------
Please read the following License Agreement. You must accept the terms of
this
agreement before continuing with the installation.

Press [Enter] to continue:

7. At the PRESS <ENTER> TO CONTINUE prompt, press <Enter>.
8. At the upgrade confirmation prompt, type Y and press <Enter> to continue.
9. Review the software right-to-use license agreement. Press <Enter> several times to read through
the agreement. At the DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N)
prompt, type Y and press <Enter> to continue.
10. At the prompt, type the path on the local drive of the host server to install the CMS server
software. Press <Enter> to continue.

Note: Specify a directory that does not exist. If you specify an existing directory, you will be
asked to specify a new one, and the installation directory will be created automatically.

11. At the prompt, type the username and password of the old CMS. Press <Enter> to continue.
After the username and password are verified, go to the next step. If you do not enter a user
name and password, you will continue to be prompted to enter the correct username and
password.
12. At the "Ready to install" prompt, type y and press <Enter> to continue.

Note: It takes several minutes to complete the installation.

After the installation completes, the following prompt is displayed:

Do you want to start the CMS server on a operation system start?
13. Calix recommends typing Y (Yes) to automatically restart the new version of CMS any time after
the host server reboots in the future. Press <Enter> to continue.

Note: If you select No, you must manually start the CMS server each time the host server
reboots. See Enabling the CMS Server to Auto Restart—Linux (on page 79).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
46

14. At the "Installer has completed copying all all required files. Do you want to start Calix
Management System?" prompt, Calix recommends accepting the default Y (Start Now) in most
cases. Press <Enter> to continue.
It can take up to 20 minutes for the CMS server to start.
If you did not start the CMS server in this Step, you must start it manually. See Manually Starting
the CMS Server (on page 75).
15. At the "View Readme file?" prompt, type Y and press <Enter> to review the software readme file.
Press <Enter> several times to read through the readme file After reading, the installation is
over.
16. Log in to CMS Web and confirm that the CMS server is running. For instructions, see Opening
CMS Web (on page 47).
17. Install CMS Desktop on each required client machine. See Installing CMS Desktop (on page 34).
18. Run an immediate Inventory Snapshot. See "Scheduling an Inventory Snapshot" in the CMS User
Guide for details.
19. If you are connecting to Calix Operations Cloud, reinstall CMS Probe according to the
instructions in "Reconnect CMS to Operations Cloud After CMS Upgrade" in Calix Operations
Cloud Help.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 47

Opening CMS Web

Use CMS Web to:
 Verify that the CMS server is running
 Generate Performance Monitoring (PM) reports
 Generate inventory reports
 Generate business reports
 Redefine the severity and descriptions of alarms
 Perform historical log queries
 Export and import CMS objects
 Access Calix documentation

Information required for logging in to CMS Web

To log in to CMS Web, have the following information on hand:
 Your CMS user name and password, provided by your CMS system administrator.
Note: The initial default user name is rootgod and the initial default password is root.
 The IP address or DNS name of your server, provided by your CMS or UNIX system
administrator.
 The port number on the CMS server provided by your UNIX system administrator (typically
8196).

Forgotten or expired password

 You can reset a forgotten password if a valid e-mail address has been saved with the CMS user
account and the e-mail server has been configured. See Viewing and Configuring the E-Mail
Server (on page 78). After clicking the Forgot Your Password? hyperlink above the Log In button
and providing a valid user name and associated e-mail address, a new password is sent via e-
mail.
Note: If you forget the CMS administration user password and a valid e-mail is not associated
with that account, contact Calix TAC for assistance to regain administrative access to CMS.
 You can reset an expired user account password when you log in to CMS Web. After clicking the
Reset Password? hyperlink above the Log In button and providing the old user name and
password, as well as a new password, you can then log in to CMS Desktop or CMS Web using
the new password.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
48

To open CMS Web

1. In your Web browser, open a window and navigate to one of the following URLs:
 [Link]

 [Link]

where [server_ID] is the IP address or DNS name of your CMS server.

Note: If you use http instead of https, you will be redirected to https (secure connection).

2. On the CMS Log In page, do the following:

a. In the User Name, type your CMS user name.

b. In the Password box, type your CMS password.
c. In the Port Number box, type the port number you use to log in to CMS. (The default port
number is 8196.)
d. Click Log In.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 49

Upgrading CMS Desktop on a Client Machine

After a CMS server software upgrade, you are prompted to upgrade CMS Desktop when you next
open a client session.

Note: To upgrade the CMS GUI application, you may need to run the CMS GUI with the administrator
privilege.

To upgrade CMS Desktop to a more recent version

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.
© Calix. All Rights Reserved.
50

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Appendix A

CMS Configuration Options

Configuration options enable you to customize CMS based on company needs.

This section includes a checklist of the options you may need to consider. Instructions for options
that you perform on the host server are included below. Instructions for options that you perform on
CMS Desktop or CMS Web can be found in the Calix Management System (CMS) Guide.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
52

Quick Reference—System Configuration Tasks

The tasks in the following table are typically performed by the CMS administrator. The tasks need
not be completed in the order presented.
Description Details Reference

Enable RADIUS Complete this configuration step if See the Calix Management System
authentication. you use a RADIUS server. (CMS) Guide
Create CMS user groups and Review the options for topological See the Calix Management System
user accounts. and functional user access and (CMS) Guide
determine how to implement the CMS
administrative and functional tasks
within your company.
Create regions, network Create and group your network See the Calix Management System
groups, and Calix network elements in CMS Desktop by add (CMS) Guide
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 Working with Scheduled Tasks (on
needed, the system required for each of the business page 64)
scheduled tasks, or create reports (C7 only). For instructions on how to create PM
new scheduled tasks. Weekly system scheduled tasks for downloads, CMS database backups,
Note: During an upgrade, inventory snapshots are network or node backups, and
system scheduled tasks are automatically created for C7, E3/E5- inventory snapshots, see the Calix
not exported with the CMS 100, and E7 nodes. Management System (CMS) Guide.
database. You must A daily scheduled task for CMS
manually re-input any database backups is also created.
customizations.
Check for and remove any duplicate
download tasks.
Review and modify, if Customize CMS security and archive "Modifying the Default CMS Security
needed, CMS system and settings. and Archive Settings" in the Calix
administrative settings System Management (CMS) Guide
based on company
Modify the default synchronization Modifying the Default Synchronization
requirements.
options. Options (on page 54)
Review the system available CMS System Configuration Settings
configuration settings. (on page 95)
(Optional) Create cron jobs. Use cron jobs with UNIX scripts to UNIX Scripts (on page 55)
download PM data or manage C7
backup files.
For AE ONT and E-Series For CMS Appliance servers, Performing CentOS Administrative
product support, review your instructions are provided for Tasks (CMS Appliance Servers) (on
server configuration configuring DHCP and NTP services. page 101)
requirements. Performing Linux Administration
Tasks (CMS2GO Servers) (on page
107)

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 53

Description Details Reference

Test and verify.  Check network and node Troubleshooting Calix Network
connectivity. Element Connections (on page 70)
 Verify any optional settings you
have made.
 Verify that PM data can be
retrieved and cron jobs (if used)
are running.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
54

Modifying the Default Synchronization Options

CMS time represents the time on the CMS server. Note the following:
 By default, CMS synchronizes C7 network time across all managed equipment once every 24
hours. You can change the default synchronization interval from every 24 hours to an interval
between every 1 through 12 hours.
 By default, CMS begins the synchronization based on the time the CMS server was first started.
You can change the default base time used by the system to start synchronization.
Modifying synchronizing options requires Full CMS Administration privileges.

Note: You typically do not need to perform the procedure in this section.

To change the default network time synchronization options

1. On the Navigation Tree, click CMS.

2. In the Work Area, click System > System Settings.
3. In the Synchronize Network Time Every list in the Network Time Sync Options section, select the
synchronization interval. Options are from 1 through 12 or 24 hours.
4. To set the base date and time used for starting the synchronization, in the Base Time field, do
the following:
 Click in the field to open the Edit Base Time dialog box.
 Click the calendar icon and select a date, and then click OK.
 In the hour, minute and second lists, select the time to start.
 Click OK to save the settings.
5. Click Apply, and then click OK to save the new settings.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 55

UNIX Scripts
This section contains UNIX scripts for:
 Rebooting the CMS server
 Enabling the CMS server to auto restart
 Performing daily PM downloads
 Performing PM queries
 Performing log queries
 Downloading ADSL call status data
 Troubleshooting the SSH server

Performing PM Queries with a Script

You can execute a PM query using a Linux script included with your CMS server installation. All
records are sorted by time. Using the [Link] script, you can query specific PM data using the
same options available in CMS Web.

You can optionally obtain a script from Calix to use in conjunction with a cron job to schedule
downloads of PM data to occur at a specific time each day. For more information, see Performing a
Daily PM Download with a Script (on page 56).

[Link] syntax
Run the [Link] script from the bin folder in the CMS installation directory:

[Link] -p PMType [-s StartTime] [-e EndTime] [-n NetworkID] [-a AID] [-l Location] [-f Format] [-
o Output]

Instructions for each parameter follow:

 PMType (required) – Type the PM report in the format PMDT, where
- PM (performance monitoring type) options are DS1, DS3, ADSL, XDSL, HDSL, XDSLGroup, OC3,
OC12, OC48, STS1, STS3c, STS12C, STS48C, IMA, IMALink, 10GEPort, GEPort, ERPS, OntEthGe,
OntEthFe, OntEthHpna, OntDs1, ONT, ONTPWE3, ETHDSL, and DSL.
- DT (data type) options are 15Min and 1Day.
Values are not case sensitive.

Note: To query ADSL, XDSL, or XDSL group call status or Ethernet statistics, use these options
for PMType without specifying a data type: ETHERNET, ADSLCALLSTATUS, XDSLCALLSTATUS,
XDSLETHGROUPSTATUS, XDSLETHSTATUS, or XDSLGROUPCALLSTATUS.
 StartTime (optional) – Use the format "MM/DD/YY hh:mm:ss" (include the quotes). If not
supplied, the system uses a date and time 24 hours prior to the current date and time.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
56

 EndTime (optional) – Use the format "MM/DD/YY hh:mm:ss" (include the quotes). If not
supplied, the system uses the current date and time.
 NetworkID (optional) – Type a case-sensitive network name, enclosed in quotes, to include that
network, or part of a network ID to perform a Contains (like) match. If not supplied, all network
IDs are included in the download.
 AID (optional; if used, you must also specify a value for the Network ID parameter) – Type a
case-sensitive AID for the port, or type part of an AID to perform a Contains (like) match. If not
supplied, all ports are included in the download.
 Location (optional) – Valid options are 1 (for far-end data) and 2 (for near-end data). If not
supplied, both far-end and near-end data is returned in the query.
 Format (optional) – Valid options are HTML and CSV. If not supplied, HTML is used.
 Output (optional) – Type a file name for the PM download, including the file name extension. If
not supplied, a file name in the format MMDDYY-hh:mm:ss is used.

[Link] script example

./[Link] -p ADSL15min -s "07/23/12 10:31:00" -e "07/23/12 14:10:00"
-n "Baywood" -f csv -o [Link] &

The above example queries all ADSL 15-minute PM data on July 23, 2012 between 10:31 a.m. and
2:10 p.m. for the Baywood network. The query output is saved in CSV file format in a file
[Link].

Content of script output

See the topic "Understanding PM Data Results" in the Calix Management System (CMS) Guide for a
list of the PM parameters included in the output file. In addition, output files from the [Link]
script include the IP address for each data bin.

Performing a Daily PM Download with a Script

You can obtain a script from Calix for querying all Performance Monitoring (PM) data from the
previous day and uploading the data files from the CMS server to another FTP server.

The results are saved in CSV format in two files (one for 15-minute data and one for 1-day data) for
each PM data type. Each file name identifies the CMS server name, data type, data frequency, and
date of the data, as follows:

pm_PMType_DataType_TimeStamp.csv
where
PMType is DS1, DS3, ADSL, XDSL, HDSL, XDSLGroup, OC3, OC12, OC48, STS1, STS3c, STS12C,
STS48C, IMA, IMALink, 10GEPort, GEPort, ERPS, OntEthGe, OntEthFe, OntEthHpna, OntDs1, ONT,
ONTPWE3, ETHDSL, and DSL.
DataType is 1DAY and 15MIN
TimeStamp is the date and time in the format MMDDYYYY_hhmmss
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 57

Before using the pmdownload script, you must set the FTP hostname, FTP username, FTP user
password, and FTP folder. You can also schedule the pmdownload script to execute at a pre-
determined time using cron jobs. Examples are shown in the following procedure.

A UNIX administrator typically performs this task.

Tip: By default, all PM and data types are exported. You can optionally exclude data by completing
Step 4 in the following procedure.

To configure the pmdownload script

1. Open a terminal window on the host server, or use a remote telnet or SSH session to log in to
the host server.
2. Copy the pmdownload file to the CMS_install/bin directory, where CMS_install is the directory
where the currently-running CMS server is located.
3. Using a text editor such as vi, open the pmdownload file and change the following parameters
to match the FTP server settings in the first section of the script:
hostName=ftp host name
userName=ftp user name
password=ftp password
remoteDir=ftp directory
Example:
hostname=[Link]
username=cmsuser1
password=user123
remoteDir=/home/myusername/pmfiles
4. (Optional) To exclude a specific PM or data type, at the end of the script file, add a number
character (#) before the getpmdata line for that data.
Example:
#getpmdata1Day HDSL1DAY
excludes HDSL 1-day PM data.
5. Save and close the file.

To set up a cron job

Note: The user creating the cron job must also run the cron job to avoid a permission conflict with
the output file. The following procedure assumes that the root user will run the cron job. If the
"cmsuser" user is running it in your organization, switch to the cmsuser user after logging on in Step
1.

1. Log in to the host server as the root user.

2. Save the current cron job into a temporary text file, such as “mycron”.
Example:
crontab –l >mycron <ENTER>
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
58

3. Using a text editor, open the file.

4. Add or modify the cron job setting in the file to schedule the download. The first column is
minute, the second column is hour, and last column is the command.
Example:
30 08 * * * /cms_install_dir/bin/pmdownload

The example above schedules the cron job to execute the script pmdownload in directory
/cms/bin/ at 8:30 AM each day.
5. Save and close the file.
6. On the command line, call crontab to set up the cron job.
Example:
crontab mycron <ENTER>

7. Verify that the cron job is configured correctly by entering “crontab –l”.
Example:
crontab –l <ENTER>
30 08 * * * /cms_install_dir/bin/pmdownload

Content of script output

See the topic "Understanding PM Data Results" in the Calix Management System (CMS) Guide for a
list of the PM parameters included in the output file. In addition, output files from the pmdownload
script includes the IP address for each data bin.

Performing Log Queries with a Script

You can execute a log query using a UNIX script that is included with your CMS server installation.
With the [Link] script, you can use the key features available in the Log Query page of CMS
Web, including the ability to set the start and end times and filter by network name and AID. Using
the [Link] script, log entries are sorted by time.

This section includes the syntax for and an example of the [Link] script.

[Link] syntax
Instructions for using each parameter follow:
 LogType (required) – Type the short name of the log report. Options are alm (Alarm Log), evt
(Event Log), tca (Threshold Crossing Event Log), secu (Security Log), dbchg (C7 Network
Database Change Log), update (CMS Update Log). Values are not case sensitive.
 StartTime (optional) – Use the format MM/DD/YY_hh:mm:ss. If not supplied, the system uses a
date and time 24 hours prior to the current date and time.
 EndTime (optional) – Use the format MM/DD/YY_hh:mm:ss. If not supplied, the system uses the
current date and time.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 59

 NetworkName (optional) – Use one of two options: 1) Type all or part of a case-insensitive
network name to perform a Contains (like) match. 2) Type cms to include CMS-level log entries
in the query results. (Note: This option performs a Contains match that includes all networks
with cms in the network name). Leave out the parameter to include all networks and CMS log
entries in the query.
 AID (optional) – Type a case insensitive access identifier (AID), or type part of an AID to
perform a Contains (like) match. Leave out the parameter to include all AIDs in the query.
 Format (optional) – Valid options are HTML and CSV. If not supplied, HTML is used.
 Output (optional) – Type a file name for the log query file, including the file name extension
(.html or .csv). If not supplied, a file name in the format MMDDYY-hh:mm:ss is used.

[Link] script example

This example:
[Link] -t evt -s 05/10/2012 10:31:00 -e 11/23/2012 14:10:00 -n Baywood
o [Link]

queries all network events on May 10, 2012 between 10:31 a.m. and 2:10 p.m. for the Baywood
network. The query output is saved in HTML file format in a file [Link].

Backing Up Reporting Templates with a Script

You typically back up reporting templates on an as-needed basis, such as before upgrading CMS or
after making significant changes to the reporting templates in your system. The UNIX Administrator
backs up reporting templates.

To back up reporting templates

1. Log in to the server.

2. Navigate to the /bin folder on the directory where you installed CMS. If you have not already
done so, open the [Link] script using a text editor, then edit the line
#remotedir=/path

where path is the absolute path or directory where to save the node alias backup file. Save the
script.
3. From the bin folder, run the backup script, as follows:
[Link] filename

where filename is the name of the node alias backup file.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
60

Script example
This example,
[Link] MyTemplates

backs up all network node aliases and save them in CSV format in a file MyTemplates in the
directory that you specified in the backup script.

Storing the reporting templates backup file

Reporting templates backup files are saved in the directory you specified on the CMS server. You
may need to move or copy the backup file to a storage directory or disk. The file is required to
restore the reporting templates later.

Restoring a Reporting Template with a Script

After upgrading CMS, or on other occasions as needed, you may need to restore a reporting
template from a previous reporting template backup file. The UNIX Administrator restores reporting
templates.

To restore a reporting template

1. Log in to the server.

2. Copy the previously saved backup file to a directory on the CMS server.
3. Navigate to the /bin subdirectory on the directory where you installed CMS. If you have not
already done so, open the [Link] script using a text editor, then edit the line
#remotedir=/path

where path is the absolute path or directory where you saved the reporting template backup file
in Step 2.
Save the script.
4. From the bin directory, run the restore script, as follows:
[Link] filename

where filename is the name of the node alias backup file.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 61

Downloading ADSL Call Status Data

You can execute a query to download ADSL call status data using a [Link] UNIX script included
with your CMS server installation.

A UNIX system administrator typically performs this task.

Tip: You can view help for this command by typing getadsl help from the bin folder of the CMS
installation directory.

[Link] syntax
Run the [Link] script from the bin folder in the CMS installation directory:

[Link] [-n NetworkID] [-a AID] [-f Format html|csv] [-o Output File]

Instructions for each parameter follow:

 NetworkID (optional) – Type a case-sensitive network name to include that network, or part of a
network ID to perform a Contains (like) match. If not supplied, all network IDs are included in
the download.
 AID (optional; if used, you must also specify a value for the Network ID parameter) – Type a
case-sensitive AID for the port, or type part of an AID to perform a Contains (like) match. If not
supplied, all ports are included in the download.
 Format (optional) – Valid options are HTML and CSV. If not supplied, HTML is used.
 Output (optional) – Type a file name for the ADSL Call Status download, including the file name
extension. If not supplied, a file name in the format MMDDYY-hh:mm:ss is used.

[Link] script example

calix-demo% [Link] -n NTWK-Orien -f html -o demo NetworkID = NTWK-Orien Format = html
getFileName = demo

The above example queries all ADSL call status data for the Orien network. The query output is
saved in HTML file format in a file [Link]. By not specifying an AID, the PM data returns for all
AIDs in the Orien network.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
62

Managing C7 Backup Files

To better manage C7 backups, CMS provides a utility named "[Link]" to archive the
backup files once a month. The UNIX system administrator sets up a cron job to create regular
backup archives.

To set up a cron job

1. Save the current cron job into a temporary text file, such as “archivecron”. For example:
crontab –l >archivecron <ENTER>
2. Using a text editor, open the file.
3. Add or modify the cron job setting in the file to schedule the download. The first column is
minute, the second column is hour, the third column is the day of the month, and last column is
the command. For example:
30 02 01 * * perl /cms/bin/[Link] [folder_target]
where [folder_target] is the target folder for the backup.
The example above schedules the cron job to execute the script fileArchiver in directory
/cms/bin/ at 2:30 AM on the first day of each month.
4. Save and close the file.
5. On the command line, call crontab to set up the cron job. For example:
crontab archivecron <ENTER>
6. Verify that the cron job is configured correctly by entering “crontab –l”. For example:
crontab –l <ENTER>
30 02 01 * * perl /cms/bin/[Link] [folder_target]

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Appendix B

Troubleshooting and Reference

This section covers the following topics:
 Working with CMS scheduled tasks
 Troubleshooting Calix network element connections
 Manually starting the CMS server
 Verifying CMS processes are running
 Verifying the CMS server is operating
 Troubleshooting CMS processes
 Exporting and importing CMS database objects
 Postgres database maintenance
 Configuring a secondary (backup) CMS server
 Changing the host server time
 CMS system configuration settings
 Viewing and configuring the e-mail server
 Troubleshooting the CMS server status
 Performing Linux administration tasks (CMS2GO servers)
 Performing Linux administration tasks (CMS Appliance servers)
 Enabling the CMS serer to automatically restart
 Uninstalling CMS server software

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
64

Working with Scheduled 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.

For instructions on how to create each scheduled task type listed below, see the Calix Management
System (CMS) Guide.
 Scheduling a PM Download
 Scheduling a CMS Database Backup
 Scheduling Calix Network Element Backups
 Scheduling an Inventory Snapshot
 Scheduling E3/E5-100 Software Upgrades
 Scheduling E5-400 and E7 Software Upgrades

System scheduled tasks

After installing or upgrading CMS, the following scheduled tasks are automatically created:
 A C7 PM download for 1-day STSn, IMA Group, DS1, OCn, DS3, and IGMP PM data that begins at
1:00 a.m. and recurs daily.
 A CMS database backup that begins at 1:00 a.m. and recurs daily.
 An E3/E5-100 network backup (configuration save only) task that begins at 1:30 a.m. and recurs
daily.
 A C7 inventory snapshot that begins on Sunday at 3:00 a.m. and recurs weekly.
 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 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.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 65

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.

Viewing Scheduled Tasks

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.

Viewing scheduled tasks requires Min (Minimum) CMS Administration privileges.

To view scheduled tasks

1. On the Navigation Tree, click CMS.

2. In the Work Area, click System > Scheduled Tasks, and then click a task category:
 CMS DB Backup (database backup)
 PM Download (Performance Monitoring download)
 Network Backup
 Inventory Snapshot
 Network Restore
 RG Config File Management
 ONT Upgrade
 Software Upgrade
 AE ONT
3. (Optional) In the task list, click a column heading to sort the list by that heading. For example,
click Status to sort the task list by status (Scheduled, In Progress, Successful, Partial, Failed,
and Canceled).
4. Double-click a task to view the original schedule details and the results.
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.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
66

Status fields
Each scheduled task displays the following information:

Item Description

Job ID An auto-generated number assigned to each task.

Note: System scheduled tasks have Job IDs less than 100. These can be modified or deleted,
if needed.
Status Task status: Scheduled, In Progress, Successful, Partial, Failed, or Canceled.

Created By CMS user that created the task.

Start Time Date and time that the task started.

End Time Date and time that the task finished.

Note  For system scheduled tasks, this field includes "Default."

 For recurring tasks, this field includes the Job ID of the task.
 For completed tasks, this field includes the number of successful, partial, or failed
network snapshots.
 For recurring tasks, this field shows the recurrence schedule.

Modifying a Scheduled Task

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.

To view and modify scheduled tasks

1. On the Navigation Tree, click CMS.

2. In the Work Area, click System > Scheduled Tasks, and then click the category of the tasks.
3. (Optional) In the task list, click a column heading to sort the list by that heading. For example,
click Status to sort the task list by the status (Scheduled, In Progress, Successful, Partial,
Failed, and Canceled).
4. Double-click a task to view the original schedule details and the results.
5. Modify the task as needed.
6. Click OK.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 67

To delete a scheduled task

1. On the Navigation Tree, click CMS.

2. In the Work Area, click System > Scheduled Tasks, and then click the category of the tasks.
3. In the task list, select (single-click) the task you are deleting.
4. In the task bar at the top of the Work Area, click Delete, and then click OK to confirm the
deletion.

Optimizing Scheduled Tasks

Setting Up C7 PM Downloads
Performance Monitoring (PM) downloads require considerable computing resources, because large
amounts of data are copied from each C7 shelf to the CMS server database. PM downloads can use
as much as 8 GB of CMS server hard disk space for each day of archived PM data.

When scheduling PM download tasks, consider these factors:

 Port type (ADSL and xDSL PM downloads include more data).
Note: Due to the large number of statistics, you can only run ADSL or xDSL PM downloads for 1-
day bins.
 Data type (data from 15-minute bins take longer to download than data from the 1-day bins by a
factor of 30 to 1).
 Number of networks and shelves included in the download.
 Number of days that CMS archives PM data.
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.

Optimization tips for setting up PM downloads

To minimize the effect of PM downloads on CMS performance, follow these recommendations and
guidelines:
 Consolidate all PM downloads other than ADSL into one download task.
 Avoid scheduling PM download tasks to run from midnight to 2:00 a.m. The CMS server
performs database maintenance during this time.
 For 15-minute PM data bins (intra-day recurring PM downloads), use the 6-hour interval
whenever possible. On occasion, using the 8-hour download interval can cause partial bins to be
downloaded.
 The total number of ports included in a scheduled 15-minute PM data download should not
exceed 100,000, which is roughly equivalent to 500 C7 networks.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
68

 For 1-day PM data bins (daily recurring PM downloads), determine the best schedule of
distribution of 1-day downloads for your situation.
 Schedule non-recurring PM downloads as seldom as possible, and only for networks that are
critical.

Setting Up Inventory Snapshots

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.

System Data Backup Best Practices

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.

General best practices

Calix strongly recommends following these guidelines for network backups:
 Perform a system backup of all shelves in your networks once a week (for example, starting on
Friday night). Back up more frequently if you make frequent provisioning changes.
 Back up a system prior to making a significant change to the network, such as provisioning,
swapping a card, changing traffic profiles, or changing the administrative master location.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 69

 Use CMS to schedule a database backup task. You can schedule database backups to occur on
a one-time, daily, weekly, or monthly basis. See Scheduling a CMS Database Backup (CMS,
Help).
Note: Scheduling a database backup requires Full CMS Administrative privileges. See CMS User
Privileges.

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.

Calix strongly recommends following these guidelines for C7 network backups:

 C7 network backups require from two to five minutes per shelf to complete. For example,
backing up data for networks with a total of 500 shelves may take up to 40 hours to complete.
Systems supporting 1,000 or more shelves may take from two to three days to complete. Actual
times vary based on the number of cross-connections.
 Each shelf backup file can be as large as 400 KB.
 Do not overwrite or discard old backups. Save previous backups on a remote server or storage
disk.
 Follow company policy and procedures to copy the backup files from the FTP or Secure FTP
(SFTP) server to a different location for storage purposes.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
70

Troubleshooting Calix Network Element Connections

Troubleshooting a C7 Network Connection

If you cannot connect to a C7 network from CMS, ask your CMS system administrator to log on to
the CMS server and perform the following troubleshooting steps.

To troubleshoot a C7 network connection

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.

 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.

Troubleshooting an E3/E5-100 Connection

If you cannot connect to an E3/E5-100 node from CMS, perform the following troubleshooting steps.

To troubleshoot a disconnected E3/E5-100 node

1. Check the following:

 Log in to the E3 or E5-100 Web Configurator, navigate to the Basic Settings > IP Setup
screen, and verify that the IP address in the IP box matches the IP address used in CMS.
 Ask your CMS system administrator to open a shell on the CMS server and ping the IP
address of the node to confirm that it can be reached.
 If the IP address can be reached and a NTWK DROPPED (Network Dropped) alarm persists,
contact Calix TAC to troubleshoot the SNMP setup on the E3 or E5-100 node.
2. Manually connect to the E3/E5-100 node. See Manually Disconnecting and Connecting an E3/E5-
100 Node (on page 71).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 71

Manually Disconnecting and Connecting an E3/E5-100 Node

When you add an E3/E5-100 node to CMS, the system automatically confirms that the node can be
reached via SNMP approximately once every minute.

You can manually disconnect an E3/E5-100 node and reconnect it, for example, after
troubleshooting a connection issue.

To manually disconnect (connect) to an E3/E5-100 node

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.

Troubleshooting an E-Series System Connection

If you cannot connect to a node from CMS, perform the following troubleshooting steps.

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.

To troubleshoot a disconnected device

1. Check the following:

 If a TrapRegFailed alarm has been raised against the node, see the troubleshooting steps in
Troubleshooting a TrapRegFailed Alarm (on page 72).
 Log in to the Web interface, navigate to the Craft Management Interfaces screen, and verify
that the IP address in the IP box matches the IP address used in CMS.
 Ask your CMS system administrator to open a shell on the CMS server and ping the IP
address of the node to confirm that it can be reached.
 If the IP address can be reached and a NTWK DROPPED (Network Dropped) alarm persists,
contact Calix TAC to troubleshoot the SNMP setup on the node.
2. Manually connect to the node. See Manually Disconnecting and Connecting a System Node (on
page 72).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
72

Manually Disconnecting and Connecting a System Node

When you add a node to CMS, the system automatically confirms that the node can be reached via
SNMP approximately once every minute.

You can manually disconnect a unit and reconnect it, for example, after troubleshooting a
connection issue.

To manually disconnect (connect) to a node

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.

Troubleshooting a TrapRegFailed Alarm

When adding an E-Series node to CMS or manually connecting to a node that is disconnected, the
system automatically attempts to add CMS as a trap destination in the node. If successful, the node
sends SNMP traps to the CMS server using port 162. If unsuccessful (for example, the node already
contains the maximum number of trap destinations), CMS reports a TrapRegFailed alarm.

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:

[Link] [Link] localhost

[Link] cmsserver

where [Link] is the CMS server static IP address and cmsserver is the name of the
CMS server.

Note: Restarting the CMS Server is not required.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 73

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.
4. If the above steps do not clear the alarm, delete and recreate the node in CMS.

Troubleshooting F5 Database Synchronization

For an F5 node, CMS raises an EMS-System Out of Sync alarm under any of these conditions:
 CMS receives a database change event from the node, but cannot retrieve the changed data.
 CMS receives a cold start trap after the E-MGMT card is reset.
 A manual database synchronization attempt fails.
Follow the steps below to troubleshoot and clear this alarm.

To troubleshoot an F5 EMS-System Out of Sync alarm

1. Check the following:

 In CMS Desktop, F5 Node details screen, verify that the F5 displays a Connection State of
"Synchronized." Check that the correct IP address is listed for the node.
 On the Navigation Tree, click the F5 node. At the bottom of the Provision System screen, in
the Address column, verify that one of the SNMP Trap Receiver lines contains the IP
address for CMS. If you cannot view the F5 node in CMS, use the CLI to verify the
information.
 Log in to CMS Web. In the module list on the left, click Administration > Process List, and
verify in the Status column that the SnmpManager process is running.
 On the CMS server, verify that the node entries in the etc/hosts file are correct (requires
logging in as the host user).
 Using the menu-driven CLI for the F5 node, verify that the E-MGMT card is active and
running.
2. Synchronize the database with CMS. See Synchronizing F5 Databases (on page 74).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
74

Event buffer overflow alarm

An F5 node-level event buffer overflow also requires a manual database synchronization in CMS.
This condition is raised when the event buffer has overflowed and events are dropped from the
database.

For an F5 node, this is reported as the following alarm in CMS:

System trap buffer overflow. EMS-System Out of Sync

To clear an event buffer overflow condition

 Synchronize the database with CMS. See Synchronizing F5 Databases (on page 74).

Synchronizing F5 Databases
F5 nodes are added on the Navigation Tree in CMS after you create them. You must then manually
synchronize F5 nodes with CMS to view alarms and monitor and provision the nodes and shelves.
Manual synchronization is also required after specific alarm conditions, such as an EMS-System Out
of Sync alarm.

Note: Each time you restart the CMS server, the system automatically attempts to synchronize with
each F5 database.

The time it takes to synchronize F5 nodes varies from several minutes to over a half hour per node
or shelf, depending on the size of the database.

Synchronizing F5 nodes requires Full CMS Administration privileges.

To synchronize an F5 database

1. On the Navigation Tree, do one of the following:

 Click the network group to view the F5 nodes in a single network group.
 Click the root region or network group to view multiple F5 nodes.
2. In the Work Area, click F5 Nodes.
3. In the node or shelf list, use Ctrl+click to select nodes or shelves one at a time or Shift+click to
select a range of nodes or shelves to synchronize.
4. Click Action > Sync F5.

Note: Synchronizations are queued to execute two at a time. During synchronization, the F5 node
collapses on the Navigation Tree for all users running CMS Desktop. Avoid any provisioning on the
F5 node until synchronization has completed and you can expand the node or shelf on the
Navigation Tree.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 75

CMS Server Operation

Manually Starting the CMS Server

The CMS server automatically restarts after a host server reboot if you have previously enabled the
CMS Auto Restart option (on page 79).

Using the [Link] script, you can start the CMS server in either of these situations:
 The host server reboots and you have not enabled the Auto Restart option.
 You have manually shut down the CMS server using the [Link] script.
The CMS system administrator typically performs this procedure.

To manually start the CMS server

1. Log in to the host server as the root user.

2. Navigate to /bin directory of CMS installation folder and run the following command:
./sh [Link]

Example
In the following example, cms_current indicates the directory where the CMS server software is
installed:

[root@cmshost1]# cd /home/cms_current/bin
[root@cmshost1 bin]#./[Link]

Note: It takes several minutes for the CMS server to start.

3. (Recommended) Verify that the CMS processes are running.

Related topics
 Verifying the CMS Server is Operating: Solaris or Linux (on page 76)
 Troubleshooting CMS Processes (on page 78)

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
76

Verifying CMS Processes are Running on Host Server

You can verify which CMS server processes are running and what version of CMS is running in
command line mode.

To verify the CMS server processes that are running

1. Open a terminal window on the host server, or use a remote telnet or SSH session to log in to
the host server as a root user.
2. Navigate to the /bin directory for the current CMS and run following command:
./[Link]

Running indicates processes that are running. Stopped indicates processes that are not
running.

Example
In the following example, cms_current indicates the directory where the CMS server software is
installed:

[root@cmshost1]# cd /home/cms_current/bin
[root@cmshost1 bin]# ./[Link]

JBoss Running 14093 1.9 545272 Mon Jun 8 11:35:05 2009

WebServer Running 14504 0.8 420760 Mon Jun 8 11:39:38 2009
SnmpManager Running 15008 0.0 93192 Mon Jun 8 11:46:06 2009
ArchiverProcess Running 14454 0.1 62396 Mon Jun 8 11:39:33 2009
CutThrough Running 14321 0.1 48364 Mon Jun 8 11:39:02 2009
Trapd Running 14798 0.0 39204 Mon Jun 8 11:41:04 2009
Syncd Running 14665 0.0 32416 Mon Jun 8 11:41:00 2009
SbcmProcess Running 14410 0.0 56364 Mon Jun 8 11:39:18 2009
DataCollection Running 14277 0.7 246980 Mon Jun 8 11:38:47 2009
Pinger Running 14623 0.1 67408 Mon Jun 8 11:40:59 2009
DMI Running 14733 0.0 31508 Mon Jun 8 11:41:02 2009
TL1Agent Stopped
SSHD Stopped
SELT Stopped

[root@cmshost1 bin]#

Note: The [Link] command should only be used from the home directory of the currently-
running CMS.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 77

To list the version of CMS server that is running

1. Open a terminal window on the host server, or use a remote telnet or SSH session to log in to
the host server as a root user.
2. Navigate to the /bin directory for the current CMS and run following command:
sh [Link]

Example
In the following example, cms_current indicates the directory where the CMS server software is
installed:

[root@cmshost1]# cd /home/cms_current/bin
[root@cmshost1 bin]# sh [Link]

MSM Version: R12.00.185_MSM100_0001

C7 Version: R08.00.106_I61P_0098

[root@cmshost1 bin]#

Verifying the CMS Server is Operating: CMS Web

Using CMS Web, you can verify that the CMS server is up, and you can view server information such
as CMS version, database type and version, and access ports.

To verify that the CMS server is operating

1. Open CMS Web (on page 47). 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.
© Calix. All Rights Reserved.
78

Troubleshooting CMS Processes

Some UNIX servers are configured to stop all processes started by the Telnet user when that user
logs out. This can result in all CMS server processes stopping when the user that started them logs
out, or after manually starting the CMS server.

Recommended action

If the above condition occurs, restart the CMS processes as follows:

1. Log in to the host server as the root user.

2. Navigate to /bin directory of CMS installation folder and run the following command: nohup
./[Link]

Viewing and Configuring the E-Mail Server

Configuring the e-mail server information requires Full CMS Fault privileges. Viewing the e-mail
server information requires Minimum (Min) CMS Fault privileges.

To view and configure the e-mail server

1. Open CMS Web (on page 47).

2. At the top of the page, click the Site Map link. In the Administration pane, click E-Mail
Configuration.
Alternatively, in the Module list on the left, click Administration > E-Mail Configuration.
The existing configuration displays.
3. In the E-Mail Host box, type the e-mail server address.
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.
© Calix. All Rights Reserved.
 79

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.

To shut down the SSH server

1. Telnet to the CMS server and log in.

2. Navigate to the CMS bin directory.
3. Execute the following command:
[Link]

To start up the SSH server

1. Telnet to the CMS server and log in.

2. Navigate to the CMS bin directory.
3. Execute the following command:
[Link]

To restart the SSH server

1. Telnet to the CMS server and log in.

2. Navigate to the CMS bin directory.
3. Execute the following command:
[Link]

Enabling the CMS Server to Auto Restart—Linux

You can enable the CMS server to restart upon a server reboot.

Performing this procedure is not required if you have automatically configure this setting during a
CMS server software installation or upgrade.

Configuring the CMS server auto restart requires root user permissions.

For a list of basic operating system and vi editor commands, see Basic Operating System Commands
(on page 129) and vi Editor Commands (on page 133).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
80

To enable the CMS Linux server to auto restart

Note: The examples in this procedure assume that /cms/cms_current is the directory of the current
CMS installation, and that vi is used as the text editor.

1. Log in on the host server as the root user. For tips and examples, see Accessing the Host Server
(on page 16).
2. Navigate to the /bin folder of the CMS installation directory.

Example

[root@cmshost1 ~]# cd /cms/cms_current/bin

[root@cmshost1 bin]#

3. Edit the cms script to change the default CMS directory path to the current path:
a. At the command prompt, type: vi cms to open the script file.
b. Scroll down to the line that begins with CMSHOME=, and then scroll to the right so that the
cursor is located after the = sign.
c. Press the x key several times to delete each character in the default path.
d. Press i to switch to insert mode.
e. Press <End> to move the cursor directly after the = sign, and type the full path where the
current CMS is installed on the server.
f. Press <Esc> to finish editing.
g. Type :wq and press <enter> to save the changes and close the script file.

Example

[root@cmshost1 init.d]# vi cms

# chkconfig: 2345 99 30
# description: Startup/Shutdown script for Calix Management Server
#

CMSHOME=/cms/cms_current
#CMSUSER=root
export CMSHOME

case "$1" in
'start')
cd $CMSHOME/bin
# /bin/su - $CMSUSER -c $CMSHOME/bin/[Link]
rm -rf [Link]
$CMSHOME/bin/[Link]
;;
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 81

'stop')
# /bin/su - $CMSUSER -c $CMSHOME/bin/[Link]
$CMSHOME/bin/[Link]
;;

*)
echo "Usage: $0 { start | stop }"

:wq

[root@cmshost1 bin]#

4. Copy the cms script file from the /bin folder of the CMS installation directory to the /etc/init.d/
directory.

Example

[root@cmshost1 bin]# cp cms /etc/init.d

cp: overwrite '/etc/init.d/cms'? Y
[root@cmshost1 bin]#

5. Execute the command:

/sbin/chkconfig --add cms

Example

[root@cmshost1 bin]# /sbin/chkconfig --add cms

[root@cmshost1 bin]#

Note: If you subsequently uninstall the CMS server, be sure to run the command: /sbin/chkconfig
--del cms.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
82

Database Tasks

Exporting CMS Objects

With the Export feature in CMS, you can export a ZIP containing text files containing CMS objects.

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.

Guidelines for exporting CMS database objects

 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.
 After installing or upgrading CMS, a system scheduled task is created for CMS backups to begin
at 1:00 a.m. on a daily recurring basis. If you can use a backup file from a CMS backup
scheduled task, there is no need to perform a CMS database export.
 For security purposes, store export files in a safe location. An export file is required to restore
(import) the objects at a later time.
 Do not use the CMS object export and import features to resolve a connection problem with a
Calix network or node. In these cases, refer to the troubleshooting topics in the "Configuration
Management" section under each Calix platform.
 C7 data and video subscriber information is exported when either the C7 Data Subscriber
Templates or the C7 Video Subscriber Templates CMS object is selected.
 E3/E5-100 data and video subscriber information is exported when any of the E3/E5-100 data,
video, and voice subscriber templates are included in the export.
Exporting CMS database objects requires Min (Minimum) CMS Administration privileges.

Scheduling backups of CMS objects

Using the backup feature, you can also schedule backups of CMS objects to occur at a pre-
determined time on a one-time or a recurring basis.

To export CMS database objects

1. Open CMS Web (on page 47).

2. At the top of the page, click Site Map. In the Administration panel, click Export.
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.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 83

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.

Importing or Restoring CMS Objects

With the Import feature in CMS, you can restore (import) CMS objects from a completed CMS
database backup task or from data that were previously exported.

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.

Preparing to restore CMS data

Before restoring CMS data, Calix recommends that the CMS system administrator log out all current
CMS Desktop user sessions.

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.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
84

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.

To restore (import) CMS objects

1. Open CMS Web (on page 47).

2. At the top of the page, click Site Map. In the Administration panel, click Import.
Alternatively, in the Module list on the left, click Administration > Import.
On the Import Dialog page, the CMS Objects radio button is selected by default.
3. Click Browse to open the Choose File dialog box.
4. Navigate to the folder containing the data file and select it, and then click Open.
5. Click Submit.

Optimizing the Oracle Database

CMS enables you to improve the scalability and system performance when using an Oracle
database. Calix recommends completing this procedure if you are managing more than 500 C7
networks, after the CMS server software has been installed.

Database optimization and CMS server upgrades

Re-optimizing the database is not required after a CMS server upgrade if BOTH of the following
conditions apply:
 The Oracle database tables were optimized using this procedure before the upgrade.
 The same Oracle database instance used before the upgrade is specified during the upgrade
process.
If you create a different database instance during the upgrade, complete this procedure after the
upgrade to optimize the database tables.

Use the following procedure to move CMS PM and LOG tables into separate tablespaces residing on
a separate hard disk or partitioned drive.

Note: A database administrator typically performs this procedure.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 85

To move CMS PM and LOG tables into separate tablespaces

1. On the server hosting the Oracle database, create new tablespaces for PM and LOG data on a
separate hard disk or partitioned drive with the following recommended settings:

Note: Data files for PM and LOG tablespaces must be in different physical disks from the USER
tablespace.

 Initial size: 5 GB
 Increment: 2 GB
 Max size: Unlimited
 Autoextend: On
 Enable logging: N
2. Log in to the CMS host server with root user permission.
3. Shut down the CMS server. Navigate to /bin directory of CMS installation folder and run the
following command:
sh [Link]

4. Switch to the CMS administrative user (cmsuser). Run the following command:
su - cmsuser

5. Navigate to the /bin directory of the CMS installation folder and do the following:
 To move PM tables to a new tablespace, run the script:
./[Link] PM <PM tablespace name>

where <PM tablespace name> is the tablespace name created for PM tables in step 1.
 To move LOG tables to a new tablespace, run script:
./[Link] LOG <LOG tablespace name>

where <LOG tablespace name> is the tablespace name created for LOG tables in step 1.
6. Switch back to the root user, and start the CMS server. Navigate to /bin directory of CMS
installation folder and run the following command:
sh [Link]

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
86

Transferring PM and Log Data (Oracle)

You can migrate Performance Monitoring (PM) and log data from a Postgres database to an Oracle
database. You can also transfer PM and log data from one Oracle database to another (for example,
following an operating system upgrade). This section contains procedures to:
 Migrate data to an Oracle database on the same server.
 Migrate data to an Oracle database on a different server.

Notes
 Database migration is an offline process that requires the current and previous version CMS
servers to be shut down. Migrating a large amount of PM and archived log data requires a
significant amount of time. For specific guidelines and recommendations, contact Calix CMS
support.
 Only the archived C7 and E5-400 PM/E7 data is transferred to the new Postgres database.
Historical F5 PM information is not transferred.

To transfer PM and log data to an Oracle database

Note: In this procedure cms_old refers to the directory of the previous version of CMS (from which
you are migrating data), and cms_new refers to the directory of the current version of CMS (to which
you are migrating data).

1. Log in to the host server as the root user.

2. Switch to the cmsuser administrative user. Run:
su - cmsuser

3. If the CMS server from which you are migrating data is running, shut it down. Navigate to the
cms_old/bin folder, and then run:
[Link]

Note: If you are transferring data from a Postgres database, complete Step 4. If you are
transferring data from an Oracle database, skip to Step 5.

4. Navigate to the cms_old/bin folder, and then run:

[Link]

5. Switch back to the root user. At the command prompt, type:

exit

6. If the CMS server to which you are migrating data is running, shut it down. Navigate to the
folder: cms_new/bin folder, and then run:
[Link]

7. From the cms_new/bin folder, run:

[Link]

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 87

8. Follow the instructions for user input.

9. Once migration completes, start up the CMS server. Run:
[Link]

To migrate PM and log data to an Oracle database on a different host server

Note: In this procedure cms_old refers to the directory of the previous version of CMS (from which
you are migrating data), and cms_new refers to the directory of the current version of CMS (to which
you are migrating data).

1. Log in to the host server with the postgres database as the root user.
2. Switch to the cmsuser administrative user. Run:
su - cmsuser

3. If the CMS server from which you are migrating data is running, shut it down. Navigate to the
cms_old/bin folder, and then run:
[Link]

Note: If you are transferring data from a Postgres database, complete Steps 4 to 6. If you are
transferring data from an Oracle database, skip to Step 7.

4. Navigate to the folder: cms_old/db/postgres/data.

5. Using vi or another text editor, edit the file pg_hba.conf to include the server IP address of the
new database server in the bottom of file. For example:
host all all <cms_new_server_ip> [Link] trust
where <cms_new_server_ip> is the IP address of the server hosting the Oracle database.
6. Navigate to the folder: cms_old/bin, and then run:
[Link]

7. On the server hosting the new CMS server, log in as the root user and navigate to the folder:
cms_new/bin folder.
8. If the new CMS server is running, shut it down. Run:
[Link]

9. From the cms_new/bin folder, run:

[Link]

10. Follow the instructions for user input.

11. Once migration completes, run:
[Link]

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
88

Postgres Database Maintenance

For CMS servers using a Postgres database, without periodic maintenance, updates to the database
can slow down database queries as new records are added and old records are not deleted.

To optimize database performance, CMS includes a database maintenance utility that removes
unnecessary records and temporary data. By default, the utility runs nightly at 12:00 a.m. If required,
you can change disable the utility, or schedule it to run at an interval of every 2, 4, 6, or 8 hours.

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.

To modify the Postgres database maintenance utility schedule

1. Open CMS Web (on page 47).

2. In the Module list on the left, click Administration > Db Services.
3. From the drop-down list, select the maintenance schedule.
4. Click Submit.

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.

To disable the Postgres database maintenance utility

1. Open CMS Web (on page 47).

2. In the Module list on the left, click Administration > Db Services.
3. From the drop-down list, select Disabled.
4. Click Submit.

You can re-enable a disabled a scheduled database maintenance task.

To re-enable a disabled Postgres database maintenance task

1. Open CMS Web (on page 47).

2. In the Module list on the left, click Administration > Db Services.
3. Click Reset.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 89

Postgres Maintenance Log Files

For CMS servers using a Postgres database, you can view the results of the Postgres database
maintenance log file and delete unneeded log files.

To view the Postgres database maintenance log file

1. Open CMS Web (on page 47).

2. In the Module list on the left, click Administration > Db Services.
3. The Cron Job Status area in the upper right side of the screen shows the latest Postgres
database maintenance log files. Click a file to view it.

To delete a Postgres database maintenance log file

1. Open CMS Web (on page 47).

2. In the Module list on the left, click Administration > Db Services.
3. In the Cron Job Status area in the upper right side of the screen, select one or more Postgres
database maintenance log files to delete.
4. Click Delete.

Switching Databases
Use the following procedure to switch from a postgres to an Oracle database.

To switch from one database to another

1. Export the CMS database objects. For instructions, see Exporting CMS Objects (on page 82).
2. Log in to the host server as the root user.
3. Run the following command to log in as cmsuser:
su - cmsuser

4. Navigate to the folder: $CMS_HOME/bin.

5. To view the database usage arguments, run:
[Link] -help

Switch database...
usage: java DBSwitchCommand [-host hostname] [-user user] [-port port]
[-dbtype dbtype] [-cmsroot cmsroot] [-noPing] [-pass password] [-
dbname dbname] [-help]
-cmsroot <cmsroot> CMS installation path. Default: ..
-dbname <dbname> Specify database name or SID
-dbtype <dbtype> Specify database type: oracle or postgres. Default:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
90

oracle
-help print help message
-host <hostname> Specify IP address or host name of database server
-noPing do not ping database
-pass <password> Specify database password
-port <port> Specify database port number. Default: 1521 for
oracle, 5432 for postgres
-user <user> Specify database username

6. In the terminal window, run the [Link] script with modified parameters as needed.
Examples
 Switch to use an Oracle database with hostname "cms01", Oracle port number "1521",
Oracle SID "cms", username "cms" and password "cms." From the $CMS_HOME/bin folder,
run:
[Link] -host cms01 -dbname cms -user cms -pass cms

 Switch to use a Postgres database with hostname "localhost", Postgres port number
"5432", database name "postgres", username "postgres" and password "postgres" without
verifying the database connection. From the $CMS_HOME/bin folder, run:
[Link] -dbtype postgres -host localhost -dbname postgres -user
postgres -pass postgres -noPing

7. Initialize the database. Run:

[Link]

8. Restore the CMS objects from the database file that you exported in Step 1. See Restoring CMS
Objects (on page 83).
9. Restart the CMS server. See Manually Starting the CMS Server (on page 75).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 91

Configuring a Primary and Secondary (Backup) Server

For CMS host server redundancy, Calix recommends configuring a second server to act as a backup
server. When the primary server is down, you can log in to the secondary server and perform
network management tasks.

This section includes instructions for configuring a backup CMS server and importing the
configuration of the primary CMS server to synchronize the settings.

Important Considerations
 It is assumed that a qualified UNIX or Linux system administrator is available to complete the
procedures in this section. Alternatively, you can contact Calix Professional Services to obtain a
quote to perform these tasks.
 The time setting on the primary and secondary host servers should be synchronized using the
same SNTP server.
 You must repeat the steps to configure the secondary/backup CMS server for each CMS server
software upgrade.
 If required, you can make the secondary server the primary server by importing all CMS objects
including global profiles, subscriber objects, e-mail and SNMP notifications, and scheduled
tasks. You can import global profiles and subscriber services to the backup CMS server using a
script or the CMS Web import feature.

Process overview
1. Install and start the primary CMS server and secondary CMS server.
2. Configure the secondary/backup server by deleting all system scheduled tasks, creating an FTP
user, and (on the primary server) scheduling a CMS database backup task with the secondary
server designated as the FTP server.
3. Configure the upload_backup script to import CMS objects contained in the primary server CMS
database backup files.
4. Set up a cron job to run the script.
5. Export the CMS security objects from the primary CMS Appliance server and import them to
CMS on the secondary server.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
92

CMS feature limitations using the secondary server

The script imports objects exported from the daily CMS database backup task with the exception of
the following: global profiles, global subscriber templates, subscriber services, scheduled tasks, e-
mail alarm notifications, and SNMP notifications. CMS objects created on the primary server do not
display on the secondary server until after the next database backup synchronization.

The following actions performed on the primary server do not display on the secondary server:
 Activating subscribers using the subscriber activation Services screen.
 Acknowledging alarms.
 Generating CMS Web business reports.
For supported operation, the secondary or backup CMS server must not perform any management
operations or communicate with managed network elements. Doing so can cause inconsistencies
between the primary and secondary servers when CMS objects are imported and can severely
degrade operation. Therefore, the secondary server does not support the following operations:
 Add, modify, or delete a region or network.
 Add, modify, or delete subscriber services.
 Add, modify, or delete a CMS user group, user, or other CMS security related configuration
(Global, SSH, RADIUS, ACL).
 Modify CMS system settings.
 Create scheduled tasks.
 Create or modify global profiles or global subscriber templates.
 Add or modify e-mail and SNMP notifications.

To configure a backup CMS server

Note: A UNIX system administrator typically performs Step 2 below.

1. On the secondary/backup server, delete the system scheduled tasks:

Note: System scheduled tasks are designated by Job IDs less than 100.

a. Log in to CMS Desktop on the secondary/backup server as a CMS user in the

Administrators user group. In the Navigation Tree click CMS, and then in the work area click
System > Scheduled Tasks.
b. Click Network Backup.
 In the scheduled task list, select the task with Job ID 12.
 In the task bar at the top of the screen, click Delete. Click OK to confirm the deletion.
c. In the work area, click Inventory Snapshot.
 In the scheduled task list, use Ctrl+click to select the tasks with Job IDs 5, 9, 10 and 11.
 In the task bar at the top of the screen, click Delete. Click OK to confirm the deletion.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 93

d. In the work area, click CMS DB Backup.

 In the scheduled task list, select the task with Job ID 4.
 In the task bar at the top of the screen, click Delete. Click OK to confirm the deletion.
e. In the work area, click PM Download.
 In the scheduled task list, select the task with Job ID 3.
 In the task bar at the top of the screen, click Delete. Click OK to confirm the deletion.
2. Enable FTP service on the secondary server and create an FTP user with the required
permissions.
3. On the primary server, log in to CMS Desktop and modify the daily system CMS database
backup scheduled task (or create a new scheduled task) with the secondary CMS server
designated as the FTP server for downloading backup files. See Modifying a Scheduled Task (on
page 66).

To configure the upload_backup script

1. Log in (or open a Telnet session) to the secondary CMS server as the root user.
2. Navigate to the CMS /bin directory.
3. Use the “ls” command to show all files in the directory. Confirm that file upload_backup.sh
exists in this directory.
4. Using a text editor, open the upload_backup.sh file.
5. Change the following parameter values to match the import file location and CMS administrator
user credentials:
IMPORT_FILE_DIR=path/to/import_files
USERNAME=rootgod
PASSWORD=root

where:
/path/to/import_files is the folder that stores the backup files transferred via FTP from the
primary CMS server
rootgod and root are the user name and password of the CMS administrator user used to
import the backup files.

Important: If you use the rootgod CMS administrator user or another CMS administrator user
account that also exists on the primary server, and the password of that user changes on the
primary CMS server, you must update the upload_backup.sh script on the secondary server with
the new password.

6. Save and close the file.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
94

To set up a cron job

1. Log in to the secondary host server as the root user.

2. Save the current cron job as a temporary text file. For example, at the terminal window, run the
command: crontab –l >mycron
3. Using a text editor, open the file.
4. Add or modify the cron job setting in the file to schedule the upload. The first column is
minutes, the second column is hour, and last column is the command. For example:
30 08 * * * /cms/bin/upload_backup.sh

The example above schedules the cron job to execute the script upload_backup.sh in directory
/cms/bin/ at 8:30 AM every day.
5. Save and close the file.
6. On the command line, run the crontab command to set up the cron job. For example:
crontab mycron

7. Verify that the cron job is configured correctly by entering crontab –l. For example:
crontab –l
30 08 * * * /cms/bin/upload_backup.sh

Note: Each time the cron job runs on the secondary server, the upload_backup.sh script uploads the
latest CMS database file using the ls –lrt command.

To import CMS security objects from the primary server

1. On the primary server, follow the instructions in the procedure to export CMS Objects (on page
82). On the Export Dialog page, only select the following CMS object check boxes: Security
Defaults, Security Domain, User Group, and User.
2. On the secondary server, follow the instructions in the procedure to import CMS Objects (on
page 83). Use the file you exported from the primary server as the import file.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 95

CMS System Configuration Settings

Cross-platform subscriber port refresh frequency

Review the following system rules to understand how the CMS system refreshes subscriber port
information for availability in subscriber searches:
 For Calix network elements, subscriber information that is entered using the Services screen is
stored directly on the CMS database and reflects the currently provisioned data.
 For Calix C7 subscriber changes provisioned using TL1 or C7 iMS, the CMS database is updated
via C7 database change events at the time the changes are made.
 For all other Calixnetwork elements, subscriber information that is entered on the local device is
uploaded to the CMS database during scheduled inventory snapshot tasks. By default, the CMS
system refreshes the subscriber port information once a week (on Tuesday at 1:00 AM).
Depending on your company needs, it may be beneficial to increase the refresh frequency, for
example, to occur daily. To change the frequency, contact Calix Technical Support.
Important: After a CMS software server upgrade, the E-Series scheduled task frequency resets
to the default schedule. You must reset a customized refresh schedule after each CMS upgrade.

Network element alarm audit frequency

By default, the CMS system synchronizes Calix network and node and third-party device alarms
every 60 minutes to keep the Alarm Table up to date. To change the frequency, contact Calix
technical support.

Important: After a CMS software server upgrade, the frequency resets to the default. You must reset
a custom synchronization setting after each CMS upgrade.

Network auto-connect audit frequencies

CMS raises a Network Dropped alarm if the connection is lost to a Calix node (other than AE ONTs)
or third-party device. By default, CMS attempts to reconnect to the device after 5 minutes. Another
audit checks for any disconnected networks, nodes, and devices every 30 minutes, and if any are
found, attempts to reconnect. These audits check for network, nodes, and devices that were in a
connected state and for which the Auto-Connect parameter set to Y (Yes). The audits exclude
networks, nodes, and devices that have been manually disconnected or for which the Auto-Connect
parameter set to N (No). To change the frequency of the 5-minute or 30-minute audits, contact Calix
technical support.

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.
© Calix. All Rights Reserved.
96

C7 network scheduled backup timeout

By default, 30 minutes is allowed for a scheduled C7 backup to complete. If after that time the
backup has not completed, the task will fail. To increase or decrease the default number of minutes
allowed for scheduled C7 backups, contact Calix technical support.

Incoming CMS server port numbers

CMS server software is shipped configured to use specific interface port numbers. For a list of the
port numbers that can be changed, refer to the appendix, "CMS Server Ports (on page 124)" in the
Calix Management System (CMS) Installation and Upgrade Guide. To change one of the configurable
port numbers, contact Calix technical support.

Data download multithreading

The CMS server automatically performs parallel downloads of PM data from multiple C7 networks.
When the CMS server is initially installed, data from up to 20 networks are downloaded concurrently
during your scheduled task. To change the default number of networks that are multithreaded for
PM download purposes, contact Calix technical support.

Important: After a CMS software server upgrade, the multithreading setting resets to the default.
You must reset a custom setting after each CMS upgrade.

Oracle XML database HTTP port

For recommendations for installing an Oracle database on a standalone database server, review the
CMS system requirements. If you install the Oracle database on the same server as the CMS server
software, change the default XML database HTTP port to avoid a conflict between Oracle and CMS
Web.

F5 Web session timeout

By default, the system times out the user from a F5 Web session after 30 minutes. You can change
the timeout setting by editing the [Link] file to add a parameter for the number of minutes to use.
Calix recommends not exceeding one day (1440 minutes).

CMS RG Management ACS URL string limitations

When provisioning the RG management for E3-48C/E5-48/E7/ONT, the ACS URL string entry cannot
be over 63 characters long. If the entered ACS URL string is longer than the allowed 63 characters,
any characters beyond the allowed 63 will be truncated.
See: Changing the Default Oracle XML Database HTTP Port (on page 97) or Changing the Default
F5/FD Web Session Timeout (on page 97).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 97

Changing the Default Oracle XML Database HTTP Port

For recommendations for installing an Oracle database on a standalone database server, review the
CMS system requirements.

If you install the Oracle database on the same server as the CMS server software, you the following
example to change the default XML database HTTP port to avoid a conflict between Oracle and CMS
Web. You can use any Oracle client that can issue SQL commands to change the default HTTP port
from 8080 to another port.

The following example shows how to change the Oracle XML database default HTTP port from 8080
to 8081:
SQL> -- Change the HTTP/WEBDAV port from 8080 to 8081
SQL> call dbms_xdb.cfg_update(updateXML(
2 dbms_xdb.cfg_get()
3 , '/xdbconfig/sysconfig/protocolconfig/httpconfig/http-port/text()'
4 , 8081))
5 /

You can verify the change by issuing the following SQL command:
SQL> -- Verify the change
SQL> set long 100000
SQL> set pagesize 9000
SQL> SELECT dbms_xdb.cfg_get FROM dual;

Changing the Default F5/FD Web Session Timeout

By default, the system times out the user from a F5/FD Web session after 30 minutes. You can
change the timeout setting by editing the [Link] file to add a parameter for the number of minutes
to use. Calix recommends not exceeding one day (1440 minutes).

Note: You may need to increase the CMS session timeout value if you increase the F5/FD Web
session timeout.

You must restart the CMS server before the new setting takes effect.

To change the default F5/FD Web session timeout

1. Open the following file in a text or xml editor:

$CMS_INSTALL_FOLDER//jakarta-tomcat-5.0.12/webapps/cmsweb/WEB-INF/[Link]

2. Locate the following section toward the end of file:

<!-- The Usual Welcome File List -->

<welcome-file-list>
<welcome-file>[Link]</welcome-file>
<welcome-file>[Link]</welcome-file>

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
98

<welcome-file>[Link]</welcome-file>
</welcome-file-list>

Add the following section before the block:

<session-config>
<session-timeout>NUM_OF_MINUTES</session-timeout>
</session-config>

where NUM_OF_MINUTES is the number of minutes for the F5/FD Web session timeout.

3. Restart the CMS server.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 99

Changing the Host Server Time

Modifying the host server time (for example, to change time zones) does not automatically update
the time displayed in the CMS Desktop status bar.

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.
© Calix. All Rights Reserved.
100

Troubleshooting the CMS Server Status

When the CMS server does not respond, you can collect information on the server status for
analysis by the CMS support team at Calix. Use the following procedure to generate a text file
containing the server status information.

To complete this procedure, you must log in to the host server as the root user.

To generate a text file with CMS server status information

1. Log in to the server hosting CMS as the root user.

2. Navigate to the /bin folder on the directory where you installed the currently-running CMS
version.
3. Run the [Link] command.
4. Transfer or copy the [Link] file to a local machine with e-mail capability. When you
contact the Calix Technical Assistance Center (TAC) for support, you may be asked to send the
file as an e-mail attachment.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 101

Performing CentOS Administrative Tasks (CMS Appliance

Servers)
This section includes instructions for using a CMS Appliance server to perform the following:
 Opening a remote management session
 Configuring the CMS server for DHCP service
 Configuring the CMS server as the NTP source
 Accessing the AE ONT configuration files
For these additional reference topics, see the CMS Appliance Quick Start Guide:
 Accessing the CMS Appliance server using a remote SSH session
 Configuring an Ethernet port for use by the DHCP server
 Default TFTP configuration
 Configuring remote access using the iDRAC card

Opening a Remote Management Session

The CMS Appliance server comes pre-loaded with Webmin, a free utility for managing server
processes and editing configuration files from a client machine.

Other utilities, such as VNC, can be used for Linux administration tasks. In this Quick Start Guide,
Webmin is used for example purposes.

Information you need to log in

To log in to Webmin, you need the following:
 Your CMS user name and password, provided by your CMS Appliance system administrator.
 The IP address or DNS name of your server, provided by your CMS Appliance or UNIX system
administrator.
 The port number for the remote management access, provided by your UNIX system
administrator (by default, port 10000 is configured for Webmin access).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
102

To open Webmin

1. In your Web browser, open a window and navigate to

[Link]
where [server_ID] is the IP address or DNS name of your CMS Appliance server.
2. On the Log In page, do the following:
a. For the user name, type root.
b. For the password, type cmsroot.
c. Click Login.

Configuring the CMS Server for DHCP Service

The CMS Appliance server can be configured for DHCP service for Calix Active Ethernet (AE) ONUs.

This topic includes the following:

 Enable Calix AE ONUs to use the CMS server for DHCP service.
 Enable the DHCP server.

You can optionally configure an Ethernet port for use by the DHCP server. For more information, see
the Reference section of the CMS Appliance Guide.

Enabling Calix devices to use the CMS server for DHCP service
Enabling Calix devices to use the CMS server as the DHCP service requires editing the [Link]
file and turning on DHCP service.

For instructions on how to configure the DHCP server options at the network element level, refer to
the Calix user guide for the device.

The following procedure uses Webmin, which is pre-loaded on the CMS Appliance server.

To configure the CMS Appliance server for DHCP service

1. If you have not already done so, log on to the CMS Appliance server as the root user and in the
Navigation pane on the left side of the screen, expand Servers and click DHCP Server.
2. Click Configfile.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 103

3. Edit the [Link] script:

a. Specify the subnet and mask, and pool range.

Note: Recommended settings for the default and maximum lease times display in the sample
file shipped with the CMS Appliance server and in example below. Adjust these settings for your
setup.

b. (Conditional, when routing to an outside network) Specify the IP address of the router. If
this step is required for your setup, activate the option routers command by deleting the
comment symbol (denoted by the "#") that precedes the option routers line and type the
IP address of the outside network.

4. At the bottom of the screen, click Save.

5. Verify that DHCP service is running.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
104

About DHCP Lease Expiration and Service Recovery

AE ONUs remain connected to the network based on the DHCP lease time. Depending on the version
of AE ONU software you are using, the following behavior can be expected:

AE ONU R2.0 - AE ONUs continue to provide services even if the DHCP renewal for the management
interface occurs but fails. When the lease time expires, the AE ONU resets and attempts to recover a
management IP address. If the DHCP server remains unreachable, services on the AE ONU will
cease. In addition, the "Management Interface DHCP Renewal Failure" alarm is raised.

AE ONU R2.1 - AE ONUs continue to provide services even if the DHCP renewal for the management
interface occurs but fails. When the lease time expires, the AE ONU does not reset while services on
the AE ONU remain intact. In addition, the "Management Interface DHCP Renewal Failure" alarm is
raised.

Enabling the DHCP server

The following procedure uses Webmin, which is pre-loaded on the CMS Appliance server.

To enable DHCP service

1. If you have not already done so, log on to the CMS Appliance server as the root user and in the
Navigation pane on the left side of the screen, expand Servers and click DHCP Server.
2. Scroll to the bottom of the screen, and click Start Server.
3. A confirmation prompt displays indicating that the dhcpd server started successfully.

Important: To minimize possible performance issues, If using redundant DHCP servers, ensure the
DHCP server software on both machines is at the same revision level.

Configuring the CMS Server as the NTP Source

When shipped, the CMS Appliance server is configured as the NTP source, enabling Calix E3/E5-100
service units, Calix E5-400/E7 nodes, and Calix Active Ethernet (AE) ONTs to function as SNTP
clients.

By default the NTP package is installed on the CMS Appliance server and the NTP daemon is
configured to run on startup. The Webmin NTP module is not installed. For instructions on how to
configure the NTP server options at the network element level, refer to the Calix user guide for the
device.

Restricting access to specific SNTP clients requires editing the [Link] file to add the IP subnets
for the managed devices. You can then verify that NTP service is running.

Notes: For example purposes this procedure uses Webmin to edit the [Link] file, which is located
in the etc/ folder.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 105

To view and edit the NTP server ([Link]) file

1. If you have not already done so, log in to the CMS Appliance server as the root user. See
Opening a Remote Management Session.
2. In the navigation pane on the left side of the screen, expand Others and click File Manager.
3. In the navigation pane, click the etc folder.
4. In the folder pane, select (click) [Link] once. In the icon tool bar at the top of the page, click
the Edit icon.
A window opens with the contents of the [Link] file.
5. Edit the [Link] file contents, if required, so that they are similar to the example above. Consult
with your IT system administrator for the required file settings.
To restrict access to specific SNTP clients, insert one or more lines below the line beginning
with # restrict [Link] mask [Link]. For example, to enable hosts on the
subnet 10.2.11.x to use CMS as an NTP source, insert the following line:
restrict [Link] mask [Link] nomodify notrap

6. To save your changes, at the bottom of the window, click Save and Close.

To verify that NTPD service is running:

1. Log in to the SNTP client as the root user.

2. From a command line, run the command: ntpdate cmsserver
where cmsserver is the CMS server name.
A date time stamp is returned, indicating NTP service is successfully running.

Example

# ntpdate cmsserver
27 Jan 20:21:13 ntpdate[7056]: adjust time server [Link] offset
0.000254 sec

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
106

Accessing AE ONT Configuration Files

This procedure shows you how to view and edit the contents of the AE ONT configuration files.

For details regarding file contents, refer to the Calix AE ONT Configuration Guide for CMS.

See also:
 Default TFTP Configuration (on page 106)

To edit the AE ONT configuration files

1. Log in to the host server as the root user. See Opening a Remote Management Session (on page
101).
2. In the navigation pane on the left side of the screen, expand Others and click File Manager.
3. In the navigation pane, double-click (expand) the opt folder, double-click the cms folder, double-
click the ae folder, and double-click the inc folder.
4. In the folder pane, select (click once) the file that you are viewing or editing. In the icon toolbar
at the top of the page, click the Edit icon.
A window opens with the contents of the file.
5. To save your changes, at the bottom of the window, click Save and Close.

Default TFTP Configuration

CMS Appliance servers are pre-configured when shipped with an FTP user account and TFTP server
to support the deployment of AE ONTs. The default configuration is provided here for reference.

The initial default host server user account credentials are:

 User ID: cmsftp
 Password: cmsftp
 Account home directory: /home/cmsftp
To view the TFTP server information, on the Navigation Tree, select the top-level CMS. In the work
area, click System > AE ONT to open the TFTP Configuration screen.

As shown in the following illustration, the initial default setup uses a local host IP address
([Link]), the user name and password of the FTP user account as indicated above, and the
tftpboot folder.

Note: The tftp server configuration file is located in the /etc/xinetel folder on the CMS Appliance
server.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 107

Performing Linux Administration Tasks (CMS2GO Servers)

Configuring the CMS Server as the NTP Source

The CMS server can be configured as the NTP source for Calix E-Series nodes and Calix Active
Ethernet (AE) ONTs, enabling these elements to function as SNTP clients.

The procedure in this section assumes that you have the Red Hat NTP package installed on the CMS
server. By default the NTP package is installed on CMS2GO–Dell servers running Red Hat ES5.

Installing the NTP package

Tip: If your host server is running Red Hat 4, search on the Internet for instructions on
how to install the Yum installation utility.

To verify NTP is installed, log in to the host server as the root user and run the command:
yum info ntp

If NTP is not yet installed, you can install the latest version by running the command:
yum install ntp

If NTP is already installed, you can update to the latest version by running the command:
yum update ntp

Enabling Calix devices to receive NTP service from the CMS server
Enabling Calix devices to receive time updates via the CMS server requires editing the [Link] file
to add the IP subnets for the managed devices, configuring the ntp daemon to run on startup, and
starting the NTP service. You can then verify that NTP service is running.

For instructions on how to configure the NTP server options at the network element level, refer to
the Calix user guide for the device.

The following procedure assumes that you are running Red Hat ES5.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
108

To configure the CMS server as the NTP source

1. Log in on the host server as the root user. For tips and examples, see Accessing the Host Server
(on page 16).
2. Navigate to the /etc directory.

Example

[root@cmshost1 ~]# cd /etc

[root@cmshost1 etc]#

3. Edit the [Link] script, if required:

Tip: For a list of basic vi commands, see vi Editor Commands (on page 133).

a. At the command prompt, type: vi [Link] to open the file.

b. Verify that the file contents are similar to the contents in the example below.
If you are running a version of Red Hat other than ES5, consult with your IT system
administrator or resource for the required file settings.
To restrict access to specific SNTP clients, insert one or more lines below the line
beginning with # restrict [Link] mask [Link]. For example, to enable
hosts on the subnet 10.2.11.x to use CMS as an NTP source, insert the following line:
restrict [Link] mask [Link] nomodify notrap

c. Press <Esc> to finish editing.

d. Type :wq and press <enter> to save the changes and close the script file.

Example

[root@cmshost1 etc]# vi [Link]

# Permit time synchronization with our time source, but do not

# permit the source to query or modify the service on this system.
restrict default kod nomodify notrap nopeer noquery

# Permit all access over the loopback interface. This could

# be tightened as well, but to do so would effect some of
# the administrative functions.
restrict [Link]

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 109

# Hosts on local network are less restricted.

# restrict [Link] mask [Link] nomodify notrap notrust

# Use public servers from the [Link] project.

# Please consider joining the pool
([Link]
server [Link]
server [Link]
server [Link]

# Undisciplined Local Clock. This driver is intended for backup

# and when no outside source of synchronized time is available.
server [Link]
fudge [Link] stratum 10

"[Link]" 34L, 1259C

:wq
[root@cmshost1 etc]#

4. Configure the daemon to run on startup. At the command prompt, type:

chkconfig ntpd on

5. Start up the NTP service. At the command prompt, type:

service ntpd start

Example

[root@cmshost1 etc]# chkconfig ntpd on

[root@cmshost1 etc]# service ntpd start
Starting ntpd:
[root@cmshost1 etc]#

6. Verify that NTPD service is running:

a. Log in to the SNTP client as the root user.
b. From a command line, run the command: ntpdate cmsserver
where cmsserver is the CMS server name.
A date time stamp is returned, indicating NTP service is successfully running.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
110

Example

# ntpdate cmsserver
27 Jan 20:21:13 ntpdate[7056]: adjust time server [Link] offset
0.000254 sec

Enabling FTP and Telnet (CMS2GO)

For security reasons, by default, the CMS2GO - Dell server ships with sftp and ssh services enabled
and FTP and Telnet services disabled.

To enable these services, you must be logged in to the host server as the root user.

To enable FTP

1. On the Linux desktop, click System > Administration > Services.

The Configuration dialog box opens.
2. In the service list, locate and select the vsftpd check box.
3. On the menu bar, click Actions > Start Service (alternatively, on the toolbar, click Start) to start
FTP service.

To enable Telnet

Note: The following procedure assumes that you are running Red Hat ES5, 64 bit.

1. Log in to the host server as the root user.

2. Turn on the Telnet server and verify the status using the chkconfig command, as follows:
# chkconfig telnet on
# chkconfig --list telnet
telnet on
3. Open a Telnet session to the host server to verify that you have Telnet connectivity.

Note: To turn off Telnet service, use the chkconfig command, as follows: chkconfig telnet off

Configuring the CMS Server for TFTP

For security reasons, by default, the CMS2GO - Dell server ships with sftp service enabled and the
trivial file transfer protocol (TFTP) service disabled. You may need the TFTP server to be enabled to
provide access to Calix Active Ethernet (AE) ONT configuration files.

Before enabling the TFTP server, be sure that you understand the security implications by reviewing
the permissions settings and restricting write access to the TFTP download directory. The following
is an example of permission settings you can use:
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 111

drwxrwxr-x 18 root root 4096 2009-05-06 14:29 AEONT

This topic covers these high-level steps:

 Verify that you have the Red Hat TFTP package.
 Enable the TFTP server.

Verifying that the TFTP package is installed

The procedure in this section assumes that you have the Red Hat TFTP package installed on the
CMS server. By default the TFTP package is installed on CMS2GO – Dell servers running Red Hat ES
5.

Installing the TFTP package (Red Hat Enterprise System 5)

Tip: If your host server is running Red Hat 4, search on the Internet for instructions on
how to install the Yum installation utility.

To verify TFTP server is installed, log in to the host server as the root user and run the
command:
yum info tftp-server

If TFTP is not yet installed, you can install the latest version by running the command:
yum install tftp-server

If TFTP is already installed, you can update to the latest version by running the
command:
yum update tftp-server

Tip: To install the TFTP client, the command to verify, install, and update the TFTP client
is the same as above using tftp in place of tftp-server.

Settings for the SFTP download directory

Calix recommends that the SFTP and TFTP servers use the same folder so that configuration files
will be placed in the same location where they can be accessed.

Enabling the TFTP server

Red Hat Linux includes a TFTP server (/usr/sbin/[Link]) that is disabled for CMS2GO - Dell
servers by default.

Enabling the TFTP server requires editing the tftpd file, restarting the tftp daemon, and turning on
the TFTP service. You can then verify that TFTP server is running.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
112

For information about TFTP configuration at the network element level, refer to Calix 700GX Active
Ethernet (AE) ONT Configuration Guide.

The following procedure is applicable for Red Hat ES5.

To enable the TFTP sever

1. Log in on the host server as the root user. For tips and examples, see Accessing the Host Server
(on page 16).
2. Navigate to the /etc/xinetd.d directory.

Example

[root@cmshost1 ~]# cd /etc/xinetd.d

[root@cmshost1 xinetd.d]#

3. Edit the tftp script:

Tip: For a list of basic vi commands, see vi Editor Commands (on page 133).

a. At the command prompt, type: vi tftp to open the script file.

Note: Example settings are shown in the following example. Adjust the settings for your setup,
as necessary.

b. Edit the "disable" tftp parameter to no.

c. Press <Esc> to finish editing.
d. Type :wq and press <enter> to save the changes and close the script file.

Example

[root@cmshost1 xinetd.d]# vi tftp

# default: off
# description: The tftp server serves files using the trivial
# file transfer protocol. The tftp protocol is often used to
# boot diskless workstations, download configuration files to
# network-aware printers, and to start the installation process
# for some operating systems.
service tftp
{
socket_type = dgram
protocol = udp
wait = yes
user = root
server = /usr/sbin/[Link]

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 113

server_args = -s /tftpboot
disable = no
per_source = 11
cps = 100 2
flags = IPv4

:wq

[root@cmshost1 xinetd.d]#

4. After editing the file, restart the TFTP server. At the command prompt, type: service tftp
restart

Example

[root@cmshost1 xinetd.d]# service xinetd restart

Reloading configuration: [ OK ]
[root@cmshost1 xinetd]#

5. Configure the daemon to run on startup. At the command prompt, type: chkconfig tftp on

Example

[root@cmshost1 xinetd.d]# chkconfig tftp on

[root@cmshost1 xinetd.d]#

6. Verify that TFTP server is running. Run the command: service xinetd status

Example

[root@cmshost1 xinetd.d]# service xinetd status

xinetd (pid 3201) is running ...
[root@cmshost1 xinetd.d]#

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
114

Configuring the CMS Server for DHCP Service (Red Hat Linux)
The CMS server can be configured for DHCP service for Calix Active Ethernet (AE) ONTs.

This topic covers these high-level steps:

 Verify that you have the Red Hat DHCP package.
 Configure an Ethernet port for use by the DHCP server.
 Enable the Calix AE ONTs to use the CMS server for DHCP service.

Verifying that the DHCP package is installed

The procedures in this section assumes that you have the Red Hat DHCP package installed on the
CMS server. By default the DHCP package is installed on CMS2GO – Dell servers running Red Hat ES
5.

Installing the DHCP package (Red Hat Enterprise System 5)

Tip: If your host server is running Red Hat 4, search on the Internet for instructions on
how to install the Yum installation utility.

To verify DHCP is installed, log in to the host server as the root user and run the
command:
yum info dhcp

If DHCP is not yet installed, you can install the latest version by running the command:
yum install dhcp

If DHCP is already installed, you can update to the latest version by running the
command:
yum update dhcp

Configuring an Ethernet port for use

Before enabling DHCP service on the host server, you may need to configure an Ethernet port (such
as eth1) for the DHCP server. A separate Ethernet port is recommended, for example, if your CMS
deployment will manage more than 250 AE ONTs.

Consult with an IT professional to determine your port setup and requirements.

Tip: To determine what interface to use, you can run the ifconfig command to view all configured
Ethernet interfaces, and select the appropriate interface based on the IP address.

If you have not yet created a port for this purpose and your circumstances require one, complete the
following procedure.
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 115

Adding a second port for the DHCP server

1. On the Linux server monitor, close any open Terminal windows.

2. On the menu bar, open the Network Configuration dialog box:
 (Red Hat 4) On the menu bar, click Applications > System Tools > Network Device Controls.
 (Red Hat 5) On the menu bar, click System > Administration > Network. In the Network
Setup screen, click Change Network Configuration.
3. In the Devices tab, Create a new Ethernet device:
 In the tool icon bar, click New.
 In the Select Device Type dialog box, the Ethernet Connection option is highlighted by
default. Click Forward.
 Select the Ethernet card to use for the DHCP server (for example, if eth0 is already created,
select eth1), and then click Forward.
4. In the Configure Network Settings dialog box, accept the default setting (radio button selected
to the left of Automatically Obtain IP Address Settings with, and DHCP displaying in the drop-
down list):
 Click Forward.
 In the Create Ethernet Device dialog box, click Apply.
The Ethernet device displays in the Network Configuration dialog box Devices tab with an
Inactive status.
5. In the top right corner of the dialog box, click the Close button (or in the menu bar, click File >
Quit) to close the Network Configuration dialog box.
6. Open a terminal window, and verify the correct Ethernet port has been assigned to the DHCP
server in the sysconfig/dhcpd file. If necessary, add the Ethernet port to the end of the line
that begins DHCPDARGS=
In the following example, vi is used to open and edit the file.
Example

[root@cmshost1 ~]# cd /etc

[root@cmshost1 etc]# vi sysconfig/dhcpd
# Command line options here
DHCPDARGS=eth1
.
.
.

:wq

[root@cmshost1 etc]#

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
116

Enabling Calix devices to use the CMS server for DHCP service
Enabling Calix devices to use the CMS server as the DHCP service requires editing the [Link]
file, restarting the dhcp daemon, and turning on the DHCP service. You can then verify that DHCP
service is running.

For instructions on how to configure the DHCP server options at the network element level, refer to
the Calix user guide for the device.

The following procedure is applicable for Red Hat ES5.

To configure the CMS server for DHCP service

1. Log in on the host server as the root user. For tips and examples, see Accessing the Host Server
(on page 16).
2. Navigate to the /etc directory.

Example

[root@cmshost1 ~]# cd /etc

[root@cmshost1 etc]#

3. Edit the [Link] script:

Tip: For a list of basic vi commands, see vi Editor Commands (on page 133).

a. At the command prompt, type: vi [Link] to open the script file.

b. Specify the subnet and mask, broadcast address, and pool range.

Note: Recommended settings for the default and maximum lease times are shown in the
following example. Adjust these settings for your setup.

c. (Conditional, when routing to an outside network) Specify the IP address of the router. If
this step is not required for your setup, remove or uncomment the option routers line (as
shown in the following example).
d. (Conditional, for processing syslog messages) Specify the location for sending syslog
messages.
e. Press <Esc> to finish editing.
f. Type :wq and press <enter> to save the changes and close the script file.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 117

Example

[root@cmshost1 etc]# vi [Link]

# DHCP Server Configuration file.

# see /usr/share/doc/dhcp*/[Link]

ddns-update-style interim;
ignore client-updates;

# If this DHCP server is the official DHCP server for the local
# network, uncomment the authoritative directive.
authoritative;

# Use this to send dhcp log messages to a different log file.

# Use [Link] to complete the redirection).
log-facility local7;

#AE-ONT Directly connected Mgmt Network

subnet [Link] netmask [Link] {
# option routers [Link];
option broadcast-address [Link];
default-lease-time 3600;
max-lease-time 7200;
range [Link] [Link];
}

:wq

[root@cmshost1 etc]#

4. After editing the file, restart the DHCP server. At the command prompt, type: service dhcpd
restart

5. Configure the daemon to run on startup. At the command prompt, type: chkconfig dhcpd on

Example

[root@cmshost1 etc]# service dhcpd restart

[root@cmshost1 etc]# chkconfig dhcpd on
Starting dhcpd:
[root@cmshost1 etc]#

6. Verify that DHCP service is running:

a. Navigate to the /etc/init.d directory.
b. Run the command: ./dhcpd status

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
118

Example

[root@cmshost1 ~]# cd /etc/init.d

[root@cmshost1 init.d]# ./dhcpd status
dhcpd (pid 2210) is running...

Configuring the CMS Server for SYSLOG Service (Red Hat Linux)
The CMS server can be configured for SYSLOG service for Calix Active Ethernet (AE) ONTs.

This topic covers these high-level steps:

 Verify that you have the Red Hat SYSLOG package.
 Enable the Calix AE ONTs to use the CMS server for SYSLOG service.

Verifying that the SYSLOG package is installed

The procedure in this section assumes that you have the Red Hat SYSLOG package installed on the
CMS server. By default the SYSLOG package is installed on CMS2GO – Dell servers running Red Hat
ES 5.

Installing the SYSLOG package (Red Hat Enterprise System 5)

Tip: If your host server is running Red Hat 4, search on the Internet for instructions on
how to install the Yum installation utility.

To verify SYSLOG is installed, log in to the host server as the root user and run the
command:
yum info syslogd

If SYSLOG is not yet installed, you can install the latest version by running the command:
yum install syslogd

If SYSLOG is already installed, you can update to the latest version by running the
command:
yum update syslogd

Enabling Calix devices to use the CMS server for SYSLOG service
Enabling SYSLOG service requires editing the [Link] file, restarting the syslog daemon, and
turning on the SYSLOG service. You can then verify that SYSLOG service is running.

For information about SYSLOG server configuration at the network element level, refer to Calix
Active Ethernet (AE) ONT Configuration Guide.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 119

The following procedure is applicable for Red Hat ES5.

To configure the CMS server for SYSLOG service

1. Log in on the host server as the root user. For tips and examples, see Accessing the Host Server
(on page 16).
2. Navigate to the /etc directory.

Example

[root@cmshost1 ~]# cd /etc

[root@cmshost1 etc]#

3. Edit the [Link] script:

Tip: For a list of basic vi commands, see vi Editor Commands (on page 133).

a. At the command prompt, type: vi [Link] to open the script file.

Note: Example settings are shown in the following example. Adjust the settings for your setup,
as necessary.

b. Calix recommends filtering ONT Syslog messages to assist in viewing and identifying ONT
messages by separating warnings and errors. See the additional lines at the end of the
following example [Link] file. By default, the ONT uses the ‘local0’ facility.
c. Press <Esc> to finish editing.
d. Type :wq and press <enter> to save the changes and close the script file.

Example

[root@cmshost1 etc]# vi [Link]

# Log all kernel messages to the console.

# Logging much else clutters up the screen.
#kern.* /dev/console

# Log anything (except mail) of level info or higher.

# Don't log private authentication messages!
*.info;[Link];[Link];[Link] /var/log/messages

# The authpriv file has restricted access.

authpriv.* /var/log/secure

# Log all the mail messages in one place.

mail.* -/var/log/maillog

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
120

# Log cron stuff

cron.* /var/log/cron

# Everybody gets emergency messages

*.emerg *

# Save news errors of level crit and higher in a special file.

uucp,[Link] /var/log/spooler

# Save boot messages also to [Link]

local7.* /var/log/[Link]

# Calix Active Ethernet ONT Syslog message filtering

local0.=err /var/log/calix_ont_err.log
local0.=warning /var/log/calix_ont_warning.log
local0.* /var/log/calix_ont.log

:wq

[root@cmshost1 etc]#

4. After editing the file, restart the SYSLOG server. At the command prompt, type: service
syslog restart

Example

[root@cmshost1 etc]# service syslog restart

Shutting down kernel logger: [ OK ]
Shutting down system logger: [ OK ]
Starting system logger: [ OK ]
Starting kernel logger: [ OK ]
[root@cmshost1 etc]#

5. Configure the daemon to run on startup. At the command prompt, type: chkconfig syslog on

Example

[root@cmshost1 etc]# chkconfig syslog on

[root@cmshost1 etc]#

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 121

6. Verify that SYSLOG service is running. Run the command: service syslog status

Example

[root@cmshost1 etc]# service syslog status

syslogd (pid 20697) is running...
klogd (pid 20701) is running...
[root@cmshost1 etc]#

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
122

Uninstalling CMS Server Software

Follow company policy when removing CMS server software from the host server. Depending on
available disk space, Calix recommends retaining the past two previous CMS server software
releases on the host server for backup purposes.

This topic provides procedures for removing CMS server software from a previous installation and
uninstalling CMS server software for a currently-running version.

To remove software from a previous CMS installation from the host server

1. Open a terminal window on the host server, or log in via a remote session as the root Linux user.
2. Use Linux commands or the Linux user interface to delete the CMS installation directory and all
subdirectories, where CMS installation directory refers to the location on the hard drive of a
previous CMS version.

To uninstall CMS server software

1. Use CMS Web to export all CMS objects. For instructions, see Exporting CMS Objects (on page
82).
2. Open a terminal window on the host server, or log in via a remote telnet or SSH session as the
root Linux user.
3. Shut down the CMS server:
a. Navigate to the folder containing CMS files.
b. Navigate to ./bin.
c. Type ./[Link] and wait for the script to finish.
d. Type ./[Link] and verify that all processes display as Stopped, indicating that
the CMS server has shut down.
4. Remove the entire CMS installation folder from the CMS server.
5. Run the following command to remove the Auto Restart script file:
 /sbin/chkconfig --del cms

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Appendix C

CMS Server Ports

This section covers the following topics:
 CMS server incoming ports (on page 124)
 Default outgoing ports CMS server ports (on page 126)

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
124

CMS Server Incoming Ports

Calix recommends configuring your firewall to enable access to CMS server interface ports used by
CMS client applications and Calix support staff, when required.

The following table shows the default incoming CMS server interface ports:

Port Number Port Description

20 For scheduled backup tasks for E3/E5 to succeed

21 For FTP server, when used for C7 image management
67 For DHCP server for AE ONTs, when configured on the CMS host server
69 For TFTP server for AE ONTs, when configured on the CMS host server
123/UDP For Network Time Protocol (NTP) for AE ONTs, when configured on the
CMS host server
162/UDP SNMP trap for all Calix network elements
514/UDP For Syslog for AE ONTs, when configured on the CMS host server
1098 * Used for RMI Naming service (for F5 and FD device management) when
a CMS client communicates with the CMS server through an EJB remote
call
1099 JNDI Lookup for F5 and FiberDrive (FD) management
1645 For RADIUS server, authentication for C7 image management
2222/UDP FD trap receiver for database changes and alarms
2626 * Northbound CMS TL1 for C7 networks
2627 * TCP Port (TL1 in non-echo mode). Not commonly used.
5055 * Socket used by OSMINE TL1 agent (for approved customers)
5056 * Telnet connection to OSMINE TL1 agent (for approved customers)
5432 Postgres listen port (for PostgreSQL only)
8080 * CMS Web
8093 Default JMS server port used for communication between the CMS
server process and server-side auxiliary processes.
8179 Debug Console, used by Calix technical assistance during support calls
for server diagnostics
8190 * SSH Server / Secure TL1
8196 CMS Desktop / Secure CMS Desktop
8198 * Cut-Through iMS
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 125

Port Number Port Description

8443 * Secure CMS Web / HTTPS

8750 SELT service port
9199 * Cut-Through TL1 / CLI
18080 * Port used by CMS Desktop, CMS Web, and the CMS XML NBI for
provisioning of supported Calix network elements
18443 * Secure Web port for E3/E5-100, E-Series, and F5
20002/UDP FD trap receiver for responses to Synchronous requests
28080 * HTTP Cut Through
28443 * HTTPS Cut Through

* Indicates that the port number is configurable in CMS.

Note: Typically, port 22 is used by SSH service and port 23 is used by Telnet service on a UNIX host.
To open a SSH connection, you must have access to port 22. To open a Telnet connection, you must
have access to port 23.

Note: Port 20 must be open to incoming traffic in order to perform backups of E3/E5 devices.

Note: The CMS server uses port 8443 for HTTPS transmission. Be sure port 8443 is enabled before
installing the CMS. If needed, edit the /etc/services file to enable port 8443.

The CMS server software ships configured to use server port 8196 for CMS Desktop access. To
change the port number, contact the Calix Technical Assistance Center (TAC).

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
126

Default Outgoing CMS Server Ports

The following are the default outgoing CMS server interface ports:

Port Number Port Description

21 FTP server connection for CMS scheduled tasks

22 Secure connection to C7 and E7 CLI
AE ONT configuration file transfer (via SFTP)
23 TL1 connection to C7 and Telnet connection to other Calix network
elements
80 Web connection to C7, E3/E5-100, and E7 nodes (HTTP)
161/UDP * SNMP requests to AE ONT, E3, E5, E-Series, and F5 devices
443 Web connection to E3/E5-100, and E7 nodes (HTTPS)
830 * Network Configuration Protocol XML communication with E-Series
nodes
1812/UDP Radius server authentication
20002/UDP Acknowledgments for FD database changes and alarms
20012/UDP Synchronous requests to F5
50000 Type-Length Value (TLV) connection to C7

* Indicates that the port number is configurable in CMS.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 127

Changing Default CMS Server Ports

For CMS R10.1.31 and higher, you can use the shell command
:$CMS_HOME/bin/[Link] to change server ports.

Note: To change CMS server ports, you need to be logged into CMS as a cmsuser, NOT as root, and
the CMS Server needs to be shut down and restarted for the changes to take effect.

Shell command:
_./[Link] _

This will print out usage and current config ports.

Change port sample:

./[Link] -web_port 8087
./[Link] -web_port 8087 -secure_web_port 9443 -jboss_web_port
18080

Currently Changeable Ports:

See CMS Server Incoming Ports (on page 124).

Note: DO NOT manually change tomcat or jboss config files. The CMS server code will not
recognize the port changes, which will cause errors.

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
128

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Appendix D

Basic Operating System Commands

Use the following commands to navigate and perform basic functions on a Solaris or Linux
computer.

Note: Commands are case sensitive.

Navigation and Other Commands

cat Read the content of a specified file or list of files.

Syntax: cat [file name] [file name]
For example, to list the currently-running Red Hat release on a Linux operating system,
type
cat /etc/redhat-release
Tip: For other uses of the cat command, refer to an online or printed reference source.
cd Change directories to the specified directory.
Syntax: cd [directory name or path]
Example:
cd bin
If the directory you are navigating to is not in the current folder, precede the directory
name with a slash. For example,
cd /bin
To move up one directory in the current folder hierarchy, type:
cd ..
clear Clear the current command prompt window of scripts and start at a fresh prompt.
Syntax: clear

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
130

Navigation and Other Commands

cp Copy a file from to another directory.

Syntax: cp [file_name] [path]
Example:
cp cms /etc/init.d
date Set the server date and time.
Syntax: MMDDhhmm
For example, to set the date and time to Dec. 26 at 1:00, type:
date 12261300
df Check file system disk space and storage information for hard disks and the server
SWAP file.
Syntax: df [-h] [-T]
Type df -h to return a readable version of the output or df -h -T to include the file
system type.
Note: For Solaris systems, see the prstat command.
finger Return a list of users on the system.
Syntax: finger [user name]
Example:
finger johnsmith
logout Log out from the current user session.
Syntax: logout
Note: To log out of the root user account in Linux, from the server monitor desktop, click
Actions > Log Out.
ls List the files and sub-directories located in the current or a specified directory.
Syntax: ls or ls [directory]
Example:
ls /opt/cms/bin
mkdir Create a new directory.
Syntax: mkdir [new directory name]
Example:
mkdir temp
man Return information about how to use a command.
Syntax: man [-k] [command]
Example:
man ls

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 131

Navigation and Other Commands

Tip: Type man -k followed by a word to list all commands and descriptions that contain
the specified word. For example,
man -k finger
more Read the contents of a file.
Syntax: more [file name]
Example:
more [Link]
mount Enable access to a device such as a CD-ROM drive.
Syntax (Linux): mount -t auto [device type] [dir name]
Example:
mount -t auto /dev/cdrom /mnt/cdrom
Tip: Create the target directory using the mkdir command before using the mount
command.
mv Move or rename a file.
Syntax: mv [old file name] [new file name]
Example:
mv [Link] /home/cms_install_dir
passwd Change your current password. Prompts display for typing the old (current) and new
passwords, and then for verifying the new password.
Syntax: passwd
prstat Check the CPU usage (Solaris only).
Syntax: prstat
ps -ef | Display information about the current processes running.
grep
Example:
ps -ef | grep CMS_JBOSS
pwd List the name of your current directory.
Syntax: pwd
rm Remove a file.
Syntax: rm [file name]
Example:
rm [Link]

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
132

Navigation and Other Commands

rmdir Remove a directory.

Syntax: rmdir [directory name]
Example:
rmdir temp
swap -s or List the swap file size.
swapon -s
Syntax (Linux): swapon –s
Syntax (Solaris): swap –s
uname List the operating system in use.
Syntax: uname -a
vi Start a text editor included on most systems.
Syntax: vi [file name]
Example:
vi /etc/security/[Link]
Note: Other text editors may be used, such as emacs and pico.
which Find the full path of a command.
Syntax: which [command name]
Example:
which chkconfig
whoami Returns the user name of the current user.
Syntax: whoami

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 Appendix E

vi Editor Commands
Use the following commands to navigate and edit files with the vi editor on a Solaris or Linux
computer:

Movement Commands

Character
h, j, k, l Left, down, up, right
Text
w, W, b, B Forward, backward by word
e, E End of word
(, ) Beginning of next, previous sentence
{, } Beginning of next, previous paragraph
[[, ]] Beginning of next, previous section
Lines
0, $ First, last position of current line
^ First non-blank character of current line
+, - First character of next, previous line
H Top line of screen
M Middle line of screen
L Last line of screen
nH, nL Line n from top, bottom of screen

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
134

Movement Commands

Scrolling
[Ctrl]F, [Ctrl]B Scroll forward, backward one screen
[Ctrl]D, [Ctrl]U Scroll down, up one-half screen
[Ctrl]E, [Ctrl]Y Show one more line at bottom, top of window
z[Enter] Scroll until line with cursor is at top of screen
z. Scroll until line with cursor is at middle of screen
z- Scroll until line with cursor is at bottom of screen
Searches
/pattern Search forward for pattern
?pattern Search backward for pattern
n, N Repeat last search in same, opposite direction
/, ? Repeat previous search forward, backward
fx Search forward for character x in current line
Fx Search backward for character x in current line
tx Search forward for character before x in current line
Tx Search backward for character after x in current line
; Repeat previous current-line search
, Repeat previous current-line search in opposite direction
Line Number
[Ctrl]G Display current line number
nG Move to line number n
G Move to last line in file
:n Move to line number n
Marking Position
mx Mark current position as x
`x Move cursor to x
`` Return to previous mark or context
'x Move to beginning of line containing mark x
'' Return to begriming of line containing previous mark

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 135

Movement Commands

Editing Commands

Insert
i, a Insert text before, after cursor
I, A Insert text at beginning, end of line
o, O Open new line for text below, above cursor
Change
r Replace with next typed character
~ Change between uppercase and lowercase
cm Change text block defined by movement command m (for
example, cw changes next word)
cc Change current line
C Change to end of line
R Type over characters
s Delete character and continue typing
S Delete current line and continue typing
Delete or Move
x Delete character
X Delete character to the left of the cursor
dm Delete text block defined by movement command m (for example,
dw deletes next word)
dd Delete current line
D Delete to end of line
p, P Put deleted text before, after cursor
"np Put text from delete buffer number n after cursor (for last nine
deletions)
Yank
ym Yank (copy) text block defined by movement command m (for
example, yw yanks next word)
yy, Y Yank current line
"ayy Yank current line into named buffer a
p, P Put yanked text before, after cursor

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
136

Movement Commands

"aP Put text from buffer a before cursor

Other Commands
. Repeat last edit command
u Undo last edit
U Undo changes to current line
J Join two lines
[Ctrl]L, [Ctrl]R Redraw screen
Examples of ex Equivalents
:d Delete lines
:m Move lines
:co or :t Copy lines
:.,$d Delete from current line to end of file
:30,60m. Move lines 30 through 60 after current line
:.,/pattern/co$ Copy from current line through line containing pattern to end of
file

Invoking vi

vi file Invoke vi editor on file

vi file1 file2 Invoke vi editor on files sequentially
view file Invoke vi editor on file in read-only mode
vi -R file Invoke vi editor on file in read-only mode
vi -r file Recover file and recent edits after system crash
vi + file Open file at last line
vi +n file Open file at line number n
vi +/pattern file Open file at pattern
ex file Invoke ex editor on file from Solaris or Linux

Other ex Commands

ex Commands
: Invoke ex from vi editor
:sh Create a new shell
[Ctrl]D Return to editor from shell
Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
 137

Movement Commands

:! command Issue a UNIX command

:r newfile Read contents of newfile into current file
:r !command Read output of UNIX command into current file
Abbreviations
:map x sequence Define keystroke x as a command sequence
:unmap x Disable map x
:map! x sequence Define x as command sequence invoked in insert mode
:unmap! x Disable insert mode map x
:ab abbr phrase Abbreviate phrase as abbr; when abbr is typed in insert mode, it
expands into phrase
:unab abbr Disable abbreviation abbr
Setting Options
:set option Activate option
:set option=value Assign value to option
:set no option Deactivate option
:set Display options set by user
:set all Display all options
:set option? Display value of option

Edit and Save Commands

ZZ Save file and quit

:x Save file and quit
:wq Save ("write") file and quit
:w Save file
:w! Save file (overriding protection)
:30,60w newfile Save lines 30 through 60 as file newfile
:30,60w>> file Append lines 30 through 60 to file file
:w %.new Save current buffer named file as [Link]
:q Quit
:q! Quit, discarding any changes
Q Quit vi and invoke ex

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.
138

Movement Commands

:e file2 Edit file2 without leaving vi

:e! file2 Discard changes to current file, then edit file2 without leaving vi
:n Edit next file
:e! Discard all changes since last save
:e# Edit alternate file

Special Symbols in ex

. Addressing symbol for current line

$ Addressing symbol for last line of file
# Alternate file name
% Current file name
! (After an ex command) Override warning

Proprietary Information: Not for use or disclosure except by written agreement with Calix.
© Calix. All Rights Reserved.