Technical Support Note TS-3GBTS -SW -0180_C1
System module recovery with Restore Factory Settings –tool Radi o Networks Fl exi Multi radio BTS W CDMA RU20, RU30, RU40
This document contains following type of information Informative Preventive X
Corrective Additional categorization Urgent Security Release Upgrade SW Update Information is classified as Internal
X
Public Customer Specific
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 1
Table of Contents 1. 2. 3. 4. 5.
Validity......................................................................................................................................... 3 Compatibility ................................................................................................................................ 3 Keywords .................................................................................................................................... 3 introduction of the tool ................................................................................................................. 3 Description of the tool .................................................................................................................. 4 5.1 When to use the RFS recovery ................................................................................................ 4 5.2 Functional description ........................................................................................................ 5 5.3 Outcome of the recovery on BTS site ...................................................................................... 6 5.3.1 Commissioning and configuration...................................................................................... 6 5.3.2 SW release version ........................................................................................................ 6 5.3.3 Licensing ........................................................................................................ 6 6. Instructions .................................................................................................................................. 7 6.1 How to get the tool ........................................................................................................ 7 6.2 How to prepare – BTS site....................................................................................................... 7 6.3 How to prepare - user ........................................................................................................ 7 Contact: Contact your local Nokia Siemens Networks support
Summary of changes: dd-mmm-yyyy 31-May-2013
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
1.0
Page 2
Approved for RFS tool v. 1.0
Purpose The purpose of this TSN is to introduce an efficient tool which can be used to recover WCDMA System Module back to Factory Settings.
1. VALIDITY Product
Product code
Core Module
Flexi Multiradio System Module, FSMC Flexi Multiradio System Module, FSMD Flexi Multiradio System Module, FSME
471401A 471402A 471469A System level RU20 RU30 RU40
083761A 083780A 083833A BTS Software WN6.0 WN7.0 WN8.0
WCDMA BTS SW WCDMA BTS SW WCDMA BTS SW
2. COMPATIBILITY Restore Factory Settings (RFS) – tool version 1.0 is supporting all the HW versions of Flexi Multiradio System Module FSME, FSMD and FSMC operating with WCDMA BTS SW. Restore Factory Settings (RFS) – tool version 1.0 does not operate with:
Multiradio System Module which is operating with any LTE BTS SW release. Flexi WCDMA System Module FSMB Flexi Multiradio System Module FSMF
3. KEYWORDS WN6.0, WN7.0, WN8.0, System Module SW problem, WCDMA, Factory, Recovery, FSMC, FSMD, FSME, RFS
4. INTRODUCTION OF THE TOOL Recovering Flexi System Module (FSM) with the Restore Factory Settings (RFS) - tool introduces a powerful onsite recovery step and thus can prevent possible FSM swap for repair. The RFS - tool shall be utilized whenever the regular recovery procedures (e.g. resets, reconfiguration, sw download, etc) are not possible or they do not recover the fault state. With the RFS- tool Flexi System Module is restored to a plain, factory delivered condition. The RFS tool is an easy to use MS executable –application, which deletes all the existing configuration, database and license files from FSM memory and then restores the essential databases and default SW release binaries into FSMx module. As a result FSM databases are cleaned and fixed and FSM will start with default sw release in uncommissioned state (factory state). Now the FSM in un-commissioned state can be integrated again to a BTS Site and set to operational state with SW upgrade and commissioning steps. The RFS tool is not related to any BTS hardware or sw configuration and thus can be executed for BTS site without removing the FSM module. Furthermore, any standalone FSM can be operated with the RFS tool, which enables recovering modules in warehouses and stocks as well on test bed and pre-installation locations. Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 3
5. DESCRIPTION OF THE TOOL 5.1 When to use the RFS recovery The RFS provides a fundamental onsite recovery step for problem situations, which have not been solved by software re-installation and/or re-commissioning using BTS Site Manager. In such situation the RFS recovery should be always executed before proceeding to swapping the FSM module and dispatching it as a faulty to NSN Hardware Services. RFS is expected to recover all the fault states described below, unless they are not caused by a more severe fault e.g. HW failure in a module. 1) A problem happened during installation/commissioning phase when new/replacement unit has been installed to network. RFS will replace existing BTS configuration database and will update BTS SW to FSMx module. There is no need to remove FSMx from BTS Site in order to run RFS recovery. 2) BTS Site fault investigation cannot be done due to existing site configuration and the nonoperational state of running BTS SW. RFS will prepare a non-commissioned BTS Site (except TRS commissioning that remains). FSMx has been defaulted to a state that whole BTS Site can be rebuilt. 3) SW mismatches between different Flexi BTS HW modules. SW download progress may not start at all or is partly downloaded to BTS but not completely. BTS SW will refuse to allow any further actions. Power may have been switched off-on between upgrade attempts and BTS cannot fully recover. RFS will remove existing BTS SW configuration and will upload and flash new BTS SW files to FSMx memory. 4) Commissioning steps cannot be successfully completed. BTS cannot become operational with normal re-commissioning steps. SCF file may prevent further re-commissioning attempts or some Flexi BTS module cannot reach operational state or there is a fake Flexi BTS module visible. RFS will remove existing hardware configuration and site commissioning file(s). FSMx and whole BTS will be in not commissioned state after successful recovery scenario. 5) BTS Site Manager connection is not possible. RFS will remove existing configuration and database files and will upload new ones during recovery scenario. BTS will be restarted with new information. 6) FSMx memory content is suspected to be corrupted. A permanent failure is detected during BTS startup phase. Internal SW management self test does not allow BTS startup to proceed. RFS recovery will replace existing configuration with default BTS database and SW configuration.
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 4
7) Some units (e.g. FSPs) do not respond at all due to SW failure. SW download cannot be started/completed since all necessary units are not responding. RFS recovery can be run for FCMD and FSPs subunits one by one and complete recovery for whole FSMx unit. 8) FSMx cannot be reused in another BTS site due to existing site configuration and licensing configuration. RFS will remove existing BTS configuration completely and clears stored Target Id and the related Last Used Timestamp -value from FSMx. After BTS SW activation of RFS recovery scenario, new Target Id value will be generated for FSMx unit (because nothing is stored into FSMx memory).
5.2 Functional description RFS tool runs following procedure phases automatically and displays progress information accordingly. STEP 1 - FCMD - Establishes connection to module - FCMD - Reads unit identification and check compatibility of FSM module HW and SW type - FCMD - Read unit identification information, check RFS compatibility - Checks availability subunits (FCMD and FSP(s)) STEP 2 - FCMD - Clears existing BTS configuration, database, license and BTS SW binary files - FCMD - Uploads new BTS configuration & database files and BTS SW binaries - FCMD - Stores permanent BTS SW files to FSMx flash memory - FCMD - Clears Target ID and related Last Used Timestamp –value from FSMx memory STEP 3 - FSP - Establishes connection to module - FSP - Clears existing BTS configuration files and BTS SW binaries - FSP - Uploads new BTS SW binaries - FSP - Stores permanent BTS SW files to FSP flash memory STEP 4 - Creates and saves report of conducted actions - Activates new BTS SW – FSMx will be set to reset - Notifies to close application. Typically 16 to 17 minutes is required for RFS to recover FSME with the normal RFS-tool run. Execution duration may vary due to different - amount of FSP units in FSMx (3 FSPs in FSME, 2 FSPs in FSMD, 1 FSP in FSMC) - amount and size of existing files to be deleted - storing speed of new files due to varying in flash memory hardware - command line argument is set to pass recovery for a sub-unit (FCMD/FSP) More detailed information regarding the procedure and recovery run options is described in User Guide document delivered with the RFS tool.
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 5
5.3 Outcome of the recovery on BTS site 5.3.1 Commissioning and configuration After recovery executed with the RFS- tool, the FSM will start in un-commissioned state. In case of the RFS recovered module is a master system module, the BTS commissioning and configuration databases are removed completely and BTS will restart in un-commissioned state (factory settings – state). TRS commissioning will not be cleared during RFS recovery in case FTM transport unit is connected to FSM. Also, no operation is done on RF modules or on the extension system module, if such modules are connected to FSM.
Figure 1 Example BTS Hardware and BTS alarms view after recovery
5.3.2 SW release version The RFS-tool stores WN7.0 2.1 (WN7.0_1207_575_09) BTS SW release to FSM and the sw release will be active sw in use after recovery has been completed. No any previous sw versions will be remaining on FSM. A compatible BTS Site Manager version is accordingly WN7.0_1207_1858_00.
5.3.3 Licensing All the license key files as well the Logical Target ID of FSM for licensing will be cleared during the recovery. Later, when the module is again integrated and commissioned in to use, a new Target ID will be generated or an existing Target ID saved to Radio Module will be recalled according to rules of feature RAN1849: BTS Licensing – Logical Target ID for Flexi BTS.
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 6
6. INSTRUCTIONS 6.1 How to get the tool The RFS tool is delivered with RestoreFactorySettings.zip -file and is available on WN7.0 2.2 BTS SW release delivery page in Nokia Siemens Networks Online Services. Later, the RFS tool will be available in NOLS with all the WN7.0 2.x maintenance releases.
6.2 How to prepare – BTS site RFS tool is not related to any BTS hardware configuration and thus it can be run in flexible way.
In case of recovering the master FSM, there is no need to remove the master FSM module or any of the power/optical cabling in the existing BTS setup when using RFS tool. Recovery will manipulate only FSM; therefore the other Flexi BTS modules will stay untouched and can remain in the hardware configuration. TRS commissioning will not be cleared during RFS recovery in case FTM transport unit is connected to FSMx
In case of recovering the extension FSM, only the optical fibers (OPT-EXT1 and POT-EXT2) connecting the module to the master FSM must be disconnected.
Any standalone FSM without FTM installed can be operated with the RFS tool as well. RFStool should always work without FTM. This enables recovering modules also in warehouses and stocks as well on test bed and pre-installation locations.
No working BTS Site manager connection is required to start recovery with RFS-tool.
RFS recovery does not require any special pre-condition for sw operation state. It can be started when FSMx is up and running, or at the very same time as FSMx is started. Latter method may be required with some conditions
If the Ethernet Port Security –feature for has been active previously in the BTS, the feature need first to be set disabled to allow direct access for the tool from the local management port (LMP). Alternative is simply to disconnect the FTM from FSM.
6.3 How to prepare - user 1. Unzip the RestoreFactorySettings.zip to a local folder on PC. The file contains a MS Windows executable application and all supporting files needed for a recovery session. 2.
Open User Guide document and read the operating instructions and notes.
3. Connect PC to the LMP port of FSMx module to be recovered 4. Run recovery procedure with RFS –tool as instructed in the User Guide document
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 7
Figure 2 Content of RestoreFactorySettings.zip -delivery file
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 8
Disclaimer The information in this document is subject to change without notice and describes only the product defined in the introduction of this documentation. This documentation is intended for the use of Nokia Siemens Networks customers only for the purposes of the agreement under which the document is submitted, and no part of it may be used, reproduced, modified or transmitted in any form or means without the prior written permission of Nokia Siemens Networks. The documentation has been prepared to be used by professional and properly trained personnel, and the customer assumes full responsibility when using it. Nokia Siemens Networks welcomes customer comments as part of the process of continuous development and improvement of the documentation. The information or statements given in this documentation concerning the suitability, capacity, or performance of the mentioned hardware or software products are given “as is” and all liability arising in connection with such hardware or software products shall be defined conclusively and finally in a separate agreement between Nokia Siemens Networks and the customer. However, Nokia Siemens Networks has made all reasonable efforts to ensure that the instructions contained in the document are adequate and free of material errors and omissions. Nokia Siemens Networks will, if deemed necessary by Nokia Siemens Networks, explain issues which may not be covered by the document. Nokia Siemens Networks will correct errors in this documentation as soon as possible. IN NO EVENT WILL NOKIA SIEMENS NETWORKS BE LIABLE FOR ERRORS IN THIS DOCUMENTATION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY OR DATA, THAT MAY ARISE FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT. This documentation and the product it describes are considered protected by copyrights and other intellectual property rights according to the applicable laws. The wave logo is a trademark of Nokia Siemens Networks Oy. Nokia is a registered trademark of Nokia Corporation. Siemens is a registered trademark of Siemens AG. Other product names mentioned in this document may be trademarks of their respective owners, and they are mentioned for identification purposes only. Copyright © Nokia Siemens Networks 2013. All rights reserved.
Nokia Siemens Networks © CONFIDENTIAL Approved 1.0
Page 9