Calix CMS - ONT Software Upgrade through CMS
This article shows how to upgrade the ONT software on single or multiple E7 shelves from the CMS interface. This process applies to EXA (non-AXOS) E7s. Upgrading from CMS is generally easier because it can batch download to a number of E7s at once
High Level Process
First, it's important to understand the steps of the E7 upgrade process. They are:
- Retrieve ONT software to E7 from CMS FTP server
- The software is generally transferred via FTP, such as an FTP service running on CMS or SMX server
- Download ONT software from the E7 to the connected ONT's
- Reboot (Activate) ONTs into the new software version
-
Unless otherwise approved, the reboot is done during a maintenance window. Exceptions would be for new shelves not yet part of a ring or in service.
- This can be done manually, or via CMS
- Commit the software release to make it permanent
- This step is usually performed manually as the last step
Get ONT Software ont CMS FTP server
Before we can start the upgrade process, we need to get the new software onto the CMS server.
- First, obtain the desired software release and ensure that the E7 OLT node is running the appropriate minimum release or higher when deploying the desired software for the ONTs. This information will be in the release notes for the new software.
- Unzip and upload the release file to the FTP server, usually CMS
- The filename should look something like CALX_PS_P1_12.2.12.2.3
- On your PC, extract the contents of the file using a program like 7-zip
- You can use something like Filezilla or WinSCP for the upload
- You can also complete this process through the CLI of the FTP server if you are familiar with Linux
- Move the unzipped folder to a directory under the cmsftp user, for example, at SCATUI, E7 software is saved in /home/cmsftp/ontsw. You can use something like Filezilla or WinSCP for the upload
- Obtain the official release version by opening the manifest file with notepad and noting the information in the version release tag such as <Version release="CALX_PS_P1_12.2.12.2.3" />
Performing an upgrade in One Step
One method of upgrading ONT software on an E7 is to complete the entire process during a maintenance window. The following steps outline how to do this.
- Open CMS and go to SYSTEM->SCHEDULED TASKS->ONT Upgrade->ONT Firmware Upgrade
- Click Create
- Select the network, network group, or nodes that you wish to upgrade using the tree on the left. Green means that the item has been selected. Right click on an item or group and choose Select to select it.
- The following example shows what it would look like to select a single node for an upgrade
- Fill in the following information
- Release Name: The exact release name noted in the manifest.xml file
- System Version: You can leave this blank
- Ftp Server: CMS Server IP Address
- Username: usually cmsftp
- Password: usually cmsftp or ftpcms
- Path: relative path of release files from FTP root, for example at SCATUI /ontsw/CALX_PS_P1_12.2.12.2.3
- FTP Server Validation should have a checkmark
- Retrieve Y
- Download Y
- Activate Y
- Operation Commit
- Click OK to start the task
- Wait for the E7 to retrieve the new software and for the ONTs to download the new software. The download time depends on how many connected ONTS are being upgraded on the E7.
- You can check the progress of the upgrade by clicking on the E7 node under its network group then go to Action->Upgrade->Upgrade Status. You can also check the status in the devices CLI by running a show upgrade command.
- Once the upgrade looks to have completed, you can verify its completion by clicking on the E7 node under its network group. Click on ONTS then click on Release Management. You should see the new software version for the ONT's. If there is a Y under the column that says COMMITED then the upgrade is complete.
Multi Step Process
Another method of upgrading the ONT's on an E7 is to retrieve the software to the E7 shelf or shelves and download it to the ONT's during the day, then Activate and Commit the software during a maintenance window. This method should allow for a shorter maintenance window.
To do this, the process will be the same except you will choose not to activate or commit when you are creating your ONT upgrade task, like in the following example. This step is not service affecting so you can do this part during the day.
The following steps are service affecting and must be done during an approved maintenance window.
- Once the E7 has completed downloading the software to the ONT's, navigate to an E7 that you wish to reboot into the new software.
- Click ONTs->RELEASE MANAGEMENT->ACTION->Activate.
3. You will see a window pop up, enter the release name and click ACTIVATE.
4. Once the software has been activated, you will need to commit the software. go to ONTs->RELEASE MANAGEMENT->ACTION->Commit.
5. You will see a window pop up, enter the release name and click COMMIT.
6.Once the upgrade looks to have completed, you can verify its completion by clicking on the E7 node under its network group. Click on ONTS then click on Release Management. You should see the new software version for the ONT's. If there is a Y under the column that says COMMITTED then the upgrade is complete.
7. Repeat this process until every node has been upgraded.