hdm webconsole create user access

Alcatel-Lucent 9353 Wireless Management System Small Cells Home Device Manager 4.3 Adaptation Kit Installation Guide

9YZ-05614-0630-RJZZA ISSUE 01/ EN August 2013

Alcatel-Lucent Confidential

2003-2013 Alcatel-Lucent

All rights reserved.

UNCONTROLLED COPY

The master of this document is stored on an electronic database and is write protected; it may be altered only by authorized persons. While

copies may be printed, it is not recommended. Viewing of the master electronically ensures access to the current issue. Any hardcopies taken

must be regarded as uncontrolled copies.

ALCATEL-LUCENT CONFIDENTIAL

The information contained in this document is the property of Alcatel-Lucent. Except as expressly authorized in writing by Alcatel-Lucent,

the holder shall keep all information contained herein confidential, shall disclose the information only to its employees with a need to know,

and shall protect the information from disclosure and dissemination to third parties. Except as expressly authorized in writing by Alcatel-

Lucent, the holder is granted no rights to use the information contained herein. If you have received this document in error, please notify the

sender and destroy it immediately.

HDM AK User Guide Alcatel-Lucent Confidential 9YZ-05614-0630-RJZZA ISSUE 01/ EN August 2013

i

About This Document

Purpose

This publication contains step-by-step installation and upgrade instructions of Home

Device Manager Adaptation Kit.

Reason for Revision

The issue reasons are:

Issue Number Issue Date Reason for Reissue

EDITION 01 / EN Aug 2013 SCMS Version 4.3 First

Release


ii

Contents

About This Document i

List of Figures iv

List of Tables vi

Part I: Introduction 1

1 Prerequisites 2

Prerequisites for HDM 3.1/4.1.x ........................................................................................................... 2

Part II: Reference Documents 3

Part III: Installing HDM Adaptation Kit for the First Time 4

2 Multi Domain Support for HDM 4.1.x 5

Defining The Multi Domain Support .................................................................................................... 5

3 The Adapting HDM to Femto 10

Defining The Device Type ................................................................................................................. 10

Importing Criteria Templates, Actions, Policies, Alarms and Custom Functions via Bundle

for HDM 4.1.x ................................................................................................................................... 21

Importing Criteria Templates.............................................................................................................. 23

Importing The Custom Functions ....................................................................................................... 27

Importing Actions .............................................................................................................................. 33

Importing Policies .............................................................................................................................. 38

Setting SCE Parameters ...................................................................................................................... 45

Assignment Of The nbi_alarm_mgr Role To The nbi_user ................................................................. 48

Defining Alarms ................................................................................................................................ 49

Defining Reports ................................................................................................................................ 49

Defining HDM Dashboard Alarm XML ............................................................................................. 49

Defining Jobs ..................................................................................................................................... 49

Part IV: Upgrading HDM Adaptation Kit to SCMS4.3 50

1 Prerequisites 51

Prerequisites for HDM3.1/HDM4.1.x ................................................................................................. 51

2 Upgrade Procedure 52

Deleting Actions and Policies ............................................................................................................. 52

Contents

HDM AK User Guide Alcatel-Lucent Confidential iii 9YZ-05614-0630-RJZZA ISSUE 01/ EN August 2013

Deleting Criteria Templates ................................................................................................................ 56

Upgrading the DeviceTypes ............................................................................................................... 57

Upgrading via Bundle package for HDM 4.1.x ................................................................................... 57

Upgrading Criteria Templates ............................................................................................................ 58

Upgrading Custom Functions ............................................................................................................. 58

Upgrading Actions ............................................................................................................................. 60

Upgrading Policies ............................................................................................................................. 60

Upgrading Alarms .............................................................................................................................. 61

Upgrading Reports ............................................................................................................................. 61

Upgrading SCE Parameters ................................................................................................................ 61

Part V: Removing the HDM Adaptation Kit 62

Part VI: Adding Device Type Based on Software Version 66

Part VII: Assignment of the NBI_ALARM_MGR Role to the NBI User 71

Part VIII: Alarms 79

1 Adding Alarm Definitions 80

Adding Alarm Definitions for HDM3.1, HDM 4.1.x .......................................................................... 80

2 Listing Alarm Definitions 88

3 Deleting Alarm Definitions 89

Part IX: Reports 90

1 Adding Report Groups (Optional) 92

2 Importing Reports 93

3 Exporting Report .zip File 95

4 Deleting Reports 96

5 Command Line Report Script 97

Part X: PKI Server Script (Optional) 98

Part XI: Dashboard Alarm Configuration (Optional) 99

Part XII: Jobs 102

1 Creating Jobs 103

2 Listing Jobs 104

3 Deleting Jobs 105

Part XIII: User Tips 107

1 Usage of Actions 108

Setting PM File Transfer Time ......................................................................................................... 108

Contents

HDM AK User Guide Alcatel-Lucent Confidential iv 9YZ-05614-0630-RJZZA ISSUE 01/ EN August 2013

Rebooting Femtos ............................................................................................................................ 109

Part XIV: Terminology 110

1 Abbreviations 111

List of Figures

Figure 1 Click on the netopmgr user .................................................................................... 6 Figure 2 Add the HDM_DomainManager to the Chosen field .............................................. 6 Figure 3 Login to SCE ......................................................................................................... 7 Figure 4 Add the SCE parameter ......................................................................................... 7 Figure 5 Logon to the hdmadin console ............................................................................... 8 Figure 6 Click on Manage Domains ..................................................................................... 8 Figure 7 Assign both users to super-domain ........................................................................ 9 Figure 8 Default Values in HDM Adaptation Kit ................................................................. 11 Figure 9 - Device type file example after default value update. ............................................. 11 Figure 10 - Logon Form for HDM 3.1 and HDM 4.0.x ........................................................... 12 Figure 11 - Logon Form for HDM 4.1.x ................................................................................. 12 Figure 12 - Creating Device Type ......................................................................................... 13 Figure 13 - Providing Device Type Info ................................................................................. 14 Figure 14 - Selecting XML File ............................................................................................. 14 Figure 15 - Loading XML File ............................................................................................... 15 Figure 16 - Activation Settings .............................................................................................. 16 Figure 17 - Entering the ACS URL ........................................................................................ 17 Figure 18 - Provisioning Mode .............................................................................................. 17 Figure 19 - Connection Request Method .............................................................................. 18 Figure 20 - Creating Device Type ......................................................................................... 19 Figure 21 - Device Types List ............................................................................................... 19 Figure 22 - Software Version Warning .................................................................................. 20 Figure 23 Bundle Import .................................................................................................... 21 Figure 24 Select file Bundle zip file .................................................................................... 22 Figure 25 Import ................................................................................................................ 22 Figure 26 Close ................................................................................................................. 23 Figure 27 - Manage Device Selection Criteria ....................................................................... 25 Figure 28 - Upload Criteria Templates .................................................................................. 26 Figure 29 - Uploaded Criteria Templates .............................................................................. 26 Figure 30 - Search Profile ..................................................................................................... 27 Figure 31 Manage Custom Functions ................................................................................ 28

List of Figures

HDM AK User Guide Alcatel-Lucent Confidential v 9YZ-05614-0630-RJZZA ISSUE 01/ EN August 2013

Figure 32 Importing Custom Functions .............................................................................. 29 Figure 33 Selecting Custom Functions File........................................................................ 30 Figure 34 Uploading Custom Functions ............................................................................. 31 Figure 35 - Uploaded Custom Functions .............................................................................. 32 Figure 36 - Imported Custom Functions ................................................................................ 32 Figure 37 - Importing Actions ................................................................................................ 35 Figure 38 - Uploading FemtoActions.xml File ....................................................................... 36 Figure 39 - Uploading Actions .............................................................................................. 36 Figure 40 - Uploaded Actions ............................................................................................... 37 Figure 41 - Imported Actions ................................................................................................ 38 Figure 42 - Importing Policies ............................................................................................... 40 Figure 43 - Uploading FemtoPolicies.xml File ....................................................................... 41 Figure 44 - Uploading Policies .............................................................................................. 42 Figure 45 - Uploaded Policies ............................................................................................... 42 Figure 46 - Imported Policies ................................................................................................ 43 Figure 47 - Enabling Policies ................................................................................................ 44 Figure 48 - Enabled Policies ................................................................................................. 45 Figure 49 - SCE Console ...................................................................................................... 46 Figure 50 - Update SCE Variable ......................................................................................... 48 Figure 51 - Existing Policies in SCMS................................................................................... 53 Figure 52 - Deleting Existing Policies ................................................................................... 54 Figure 53 - Existing Actions in FMS 2.2 ................................................................................ 55 Figure 54 - Deleting Actions ................................................................................................. 56 Figure 55 Manage Custom Functions ................................................................................ 59 Figure 56 Deleting Custom Functions ................................................................................ 60 Figure 57 - Selecting Device Type ........................................................................................ 67 Figure 58 - Selecting XML File ............................................................................................. 68 Figure 59 - Adding XML file .................................................................................................. 68 Figure 60 - Device Types (Based On Software Version) List ................................................ 69 Figure 61 Setting Default Device Type .............................................................................. 70 Figure 62 - Logon Form ........................................................................................................ 71 Figure 63 - Security Realms ................................................................................................. 72 Figure 64 - Realms ............................................................................................................... 72 Figure 65 - Global Roles ....................................................................................................... 73 Figure 66 - Roles .................................................................................................................. 75 Figure 67 - Selecting NBI_ALARM_MGR ............................................................................. 75 Figure 68 - Check HDM_NBI_Manager group ...................................................................... 75 Figure 69 - Selecting Predicate List ...................................................................................... 76 Figure 70 - Adding Group ..................................................................................................... 77 Figure 71 - Finishing Process ............................................................................................... 77 Figure 72 - Process finished ................................................................................................. 78 Figure 73 Define Alarms .................................................................................................... 81 Figure 74 Importing Alarms ............................................................................................... 81 Figure 75 Selecting Alarms File ......................................................................................... 82 Figure 76 Uploading Alarms .............................................................................................. 83 Figure 77 - Uploaded Custom Functions .............................................................................. 84 Figure 78 - Imported Alarms ................................................................................................. 85 Figure 79 - Selecting Alarms ................................................................................................ 86 Figure 80 Alarms List ......................................................................................................... 87 Figure 81 - Alarms ................................................................................................................ 88

List of Figures

HDM AK User Guide Alcatel-Lucent Confidential vi 9YZ-05614-0630-RJZZA ISSUE 01/ EN August 2013

Figure 82 - Deleting Alarm Definitions .................................................................................. 89 Figure 83 - PM file transfer time window ............................................................................. 108

List of Tables

Table 1 - Custom functions ................................................................................................... 32 Table 2 - SCE Parameters for Femto Support ...................................................................... 46 Table 3 - Default values for SCE parameters........................................................................ 64


1

Part I: Introduction

A5580 HDM (Home Device Manager) will be used for managing the Femto

BSR devices. HDM offers quite flexible management interface. For the Femto

BSR management, HDM needs to be configured with some Femto specific

features.


2

1 Prerequisites

Prerequisites for HDM 3.1/4.1.x

A5580 HDM 3.1/4.1.x should be installed to your system. Please refer to [R3]

for this purpose.

Java Runtime Environment (JRE) 1.6 is required for HDM 4.1.x and JRE 1.5 is

required for HDM 3.1.

Reporting Module is required only for reports to be used. Please refer to [R4]

for this purpose.


3

Part II: Reference Documents

NOTE: The following links to be updated

[R1] 3JB-00029-ADAA-PCZZA HDM Programming Guide

[R2] 3JB-00029-ABAA-PCZZA HDM Deployment Guide

[R3] 9YZ-04190-0624-RJZZA A5580 HDM Light Installation Guide

[R4] 3JB-00047-AAAY-PCZZA HDM Reporting Deployment Guide


4

Part III: Installing HDM Adaptation Kit for the First Time


5

2 Multi Domain Support

for HDM 4.1.x

This section describes how to configure the multi domain support for HDM

4.1.x. If you do not have a multi domain support license, skip this section.

Defining The Multi Domain Support

First login to WebLogic console page "https://:9002/console"

where HDM_IP is the HDM servers IP address via the hdm_admin user.

Goto the netopmgr users page: Home>Summary of Security Realms

>myrealm >Users and Groups >netopmgr. Add the HDM_DomainManager

group into the netopmgrs Groups. Fellow below figures.

Multi Domain Support for HDM 4.1.x

HDM AK User Guide Alcatel-Lucent Confidential 6 9YZ-05614-0630-RJZZA ISSUE 01/ EN August 2013

Figure 1 Click on the netopmgr user

Figure 2 Add the HDM_DomainManager to the Chosen field

To enable the multi domain feature set the SCE parameter

hdm.domains.enabled to true. This can be set http://:7003/sce/

via the user netopmgr.



Figure 3 Login to SCE

Figure 4 Add the SCE parameter

Assign both netopmgr and nbi_user users to the super-domains domain.

To perform this action, login to HDMAdmin Page (http://:7003/hdmadmin) via the netopmgr user. And add these users to the

super-domains domain. Follow below screenshots.



Figure 5 Logon to the hdmadin console

Figure 6 Click on Manage Domains



Figure 7 Assign both users to super-domain

Note: Domains have to be manually created by the operator on HDM and

SCMS. Domain name in HDM should match with the RDNId in SCMS. For

example if HDMDomain/Domain_1 is set as the DN in SCMS, then in HDM

side the domain should be be defined as Domain_1. Also, different users

should be created for each domain. The Super users (nbi_user and

netopmgr) should not be added to all domains. Also, fill only domain name

and description in HDM. Do not enter any device qualifiers (device types,

user/service tags or IP addresses); Automatic domain assignment from

HDM is not supported.

The Adapting HDM to Femto


3 The Adapting HDM to

Femto

This section describes how to install HDM Adaptation Kit (AK) for the first

time.

Defining The Device Type

In order for HDM to manage Femto BSR devices, a device type must be

created for Femto BSR. With HDM 3.1, a device type can support multiple

software versions by adding deviceType.xml files based on the software

version.

In SCMS-04.3, HDM Adaptation Kit contains six deviceType.xml files.

Four of them are used for the Femto BSR 2.4 and Femto BSR 3.0 backward

compatibility which are generated from BCR02.4-BSR XMIM 4.1f and BCR-

03-00-BSR-XMIM-06.00 model and named as

tr069BSR_fms2.4_bsr_xmim4.1f.xml,

tr069BSR_fms2.4_bsr_xmim4.1f_2.xml,

tr069BSR_fms3.0_bsr_xmim6.0.xml and

tr069BSR_fms3.0_bsr_xmim6.0_2.xml

Two deviceType.xml files are used for Femto BSR 4.x. The file names are

tr069BSR_fms4.0_bsr_xmim6.0.xml and

tr069BSR_fms4.0_bsr_xmim6.0_2.xml which are generated from BCR-04-

00-BSR-XMIM-06.00 model.



Device Type Values:

Before creating a new device type, change the Manufacturer, Device Type

OUI, Product Class and software version values in deviceType.xml file. The

default values in HDM Adaptation Kit is a warning text like in the following

figures.

Figure 8 Default Values in HDM Adaptation Kit

You should changes these values with the appropriate value of BSR Femto

devices Manufacturer, Device Type OUI, Product Class and software version.

(Exp: Manufacture = Alcatel-Lucent, OUI = 001D4C, Product Class = 9365

BSR Femto or Alcatel-Lucent 9360 Small Cell Solution, Software Version =

BSR-04.00.00.00). To do this, open device type file with a text editor program,

edit software version value, then save the file. After that, the device type file

should look like the following figure.

Figure 9 - Device type file example after default value update.

For adding new device types based on software version, please refer to section

ADDING DEVICE TYPE BASED ON SOFTWARE VERSION.

Step-by-step importing new device type procedure:



1 Change software version in device type file as explained above.

2 Log on to HDM Management Console. For HDM 4.1.x, if multi domain

support is enabled, select super-domain in the domain input.

Figure 10 - Logon Form for HDM 3.1 and HDM 4.0.x

Figure 11 - Logon Form for HDM 4.1.x

3 After logging on to the HDM you will be on the Welcome tab. Go to

Device Types tab.



4 Select New button at the bottom left.

Figure 12 - Creating Device Type

On the new page:

5 Give a name for the device type definition.

6 Enter a Description.



Figure 13 - Providing Device Type Info

7 Click on the Browse button to select the device type file.

Figure 14 - Selecting XML File



8 Then click on the Load XML File button. After this operation Device Type

Attributes panel should be automatically filled.

Figure 15 - Loading XML File

Activation settings should be filled manually as follows:

9 Enter fbsrpass as HTTP Default Password.

10 To define the ACS URL, click on the ACS URL icon.



Figure 16 - Activation Settings

11 At the pop-up window enter the public HDM URL to the ACS URL textbox

(http://:/cwmpWeb/CPEMgt) (https should be used instead of http if you

will be working with outside tunnel femtos). HDM has two interfaces called

OAM-OAM and OAM-NE therefore there are two IP addresses. OAM-NE IP

address of the HDM server must be used in this URL.

See Figure 17 - Entering the ACS URL



Figure 17 - Entering the ACS URL

12 Select Provisioning Mode as Zero Touch.

Figure 18 - Provisioning Mode



13 Select Connection Request Method as Direct.

Figure 19 - Connection Request Method

14 Enable connection request.

15 Click on the Create button at the bottom right side.



Figure 20 - Creating Device Type

16 The newly created device type should be listed under the Device Types tab.

Figure 21 - Device Types List



17 Return to step 4 and repeat the steps one more time with Device Type Name as

Femto_2 and xml file which has the same name ending with _2.xml.

18 You should update the software version of your device type before you create

it, otherwise, you can see a warning message like in the below figure:

Figure 22 - Software Version Warning

19 Add other device type models. Please refer to section ADDING DEVICE

TYPE BASED ON SOFTWARE VERSION.



Importing Criteria Templates, Actions, Policies, Alarms and Custom Functions via Bundle for HDM 4.1.x

Criteria Templates, Actions, Policies and Custom Functions can be import as a

bundle for HDM 4.1.x

Step-by-step importing bundle:

1 Log on HDM Management Console. For HDM 4.1.x, if multi domain support

is enabled, select super-domain in the domain input.

2 Go to Welcome tab.

3 On the System Settings, click on the Bundle Import.

Figure 23 Bundle Import

4 In the following window, click on the browse button to select Bundle. Check

bundle.zip delivered within the HDM Adaptation Kit 4.1.x release.



Figure 24 Select file Bundle zip file

5 Select Import.

Figure 25 Import

6 Check Bundle Import completed successfully. Ignore errors caused by

template/default items. Click on the Close button.



Figure 26 Close

7 Continue below importing selections without processing the import steps. Do

only the enable or activition steps, if available.

Note that the unfiltered Alarm.xml file is delivered within the bundle. For

using the filtered one, re-import the alarm dictionary with

Alarms_with_filter.xml file (Delete Alarms, import

Alarms_with_filter.xml file and enable imported Alarms).

Importing Criteria Templates

Two criteria templates (Find All TR-069v1 Devices, Find All SNMP Devices) are installed by

default on HDM. Dont delete these two criteria templates.

Criteria Templates in HDM Adaptation Kit:

1. Find Devices By Location

2. Find Devices By Cluster ID

3. Find Devices Within List

4. Find All Small Cell Devices



5. Find Small Cell Devices By Alarm Management

6. Find Small Cell Devices By Cluster ID

7. Find Small Cell Devices Without Service Tag Inside Last Contact Time Interval

8. Find Small Cell Devices By FM Expiration Date

9. Find Small Cell Devices By IMSEI In Guest

10. Find Small Cell Devices By IMSEI In Owner

11. Find Small Cell Devices By Performance Attribute

12. Find Small Cell Devices By RFTrace Attribute

13. Find Small Cell Devices By Serial Number

14. Find Small Cell Devices By Service Tag

15. Find Small Cell Devices By Service Tag and Software Version

16. Find Small Cell Devices By Software Version

17. Find Small Cell Devices in a Cluster with Software Version Lower Than

18. Find Small Cell Devices in a Cluster with Software Version Lower Than Between Contact Time

19. Find Small Cell Devices Out Of The Last Contact Time Interval

20. Find Small Cell Devices Without Service Tag

21. Find Small Cell Devices By BsrGroupId

22. Find Small Cell Devices Within List

23. Find Small Cell Devices With Realtime SCN

Step-by-step importing criteria templates:

8 Log on HDM Management Console. For HDM 4.1, if multi domain support is

enabled, select super-domain in the domain input.

9 Go to Welcome tab.

10 On the System Settings, click on the Manage Device Selection Criteria.



Figure 27 - Manage Device Selection Criteria

11 In the following window, click on the browse button to select criteria

templates. Check criterias directory delivered within the HDM Adaptation

Kit release. For HDM 3.1 use criterias_for_hdm3.1 folder and for HDM 4.1.x

use criterias_for_hdm4.1 folder)



Figure 28 - Upload Criteria Templates

12 Select one by one and click on the Upload button. After that you will see all

criteria templates are on the list.

Figure 29 - Uploaded Criteria Templates



13 Click on the close button.

14 Browse Devices tab. These Criteria Templates are shown on the Search

Profile list.

Figure 30 - Search Profile

Importing The Custom Functions

Importing The Custom Functions from HDM3.1.x/HDM4.1.x GUI

To do this procedure, HDM Custom Function Management GUI license is

needed. Otherwise follow selection: Importing The Custom Functions from

Solaris. Step-by-step importing custom functions:





2 Select Manage Custom Functions from Welcome tab.

Figure 31 Manage Custom Functions

3 Select Import.



Figure 32 Importing Custom Functions

4 In the Import Custom Function window, click on the Browse button and

go to the customFunction directory in HDM Adaptation Kit delivery. Select the

customFunction.zip file.



Figure 33 Selecting Custom Functions File

5 Click on the Upload button. Custom Functions will appear in the box.



Figure 34 Uploading Custom Functions

6 The uploaded custom functions will be listed on the result list. Click on the

Close button.



Figure 35 - Uploaded Custom Functions

7 Now you will be able to see the imported custom functions in the Custom

Functions tab.

Figure 36 - Imported Custom Functions

The custom functions created for BSR Small Cell Management Solution are:

Table 1 - Custom functions

Display Name JavaScript File Metadata File Function Name

Femto

Activation

Function_05

initialActivationFunction.js initialActivationFunction.xml initialActivation (1140)

Custom

Download

Function_05

customDownlaodFunction.js customDownloadFunction.xml customDownload (1142)

Set ACL setACLFunction.js setACLFunction.xml setACLFunction (1116)



Function

Bulk Set On

Line Function

bulkSetOnLine.js bulkSetOnLine.xml bulkSetOnLine (1118)

Factory Reset

Custom

Function

customFactoryReset.js customFactoryReset.xml customFactoryReset (1124)

Trigger Manual

Alarm

Synchronization

triggerManualAlarmResynch.js triggerManualAlarmResynch.xml triggerManualAlarmResynch

(1130)

PM Enable

Action

pmEnableAction.js pmEnableAction.xml pmEnableAction (1199)

PM Disable

Action

pmDisableAction.js pmDisableAction.xml pmDisableAction (1200)

Perform Single

SPV

performSingleSPVCF.js performSingleSPVCF.xml performSingleSPVCF

(1333)

Importing Actions

Some actions need to be defined in HDM to support BSR Femto. These actions

have already constructed but they have to be imported to HDM manually. The

actions in HDM must be backed-up separately. General backup of the HDM

will not include the actions. These actions are:

1. CM Download Action: This action is performed to make BSR Femto devices, download the configuration files, which are created by FAL from

a specific location.

2. FM Deactivate Action: This action executes a Set Parameter Values operation which disables the fault notifications.

3. Femto Activation Action: Femto devices have many parameters, which need to be configured when the devices are activated. This action performs

several functions consecutively and fulfills the initial configuration of BSR

Femto devices.

4. Femto SetACL Action: By the execution of this action, you can update the femtoACLlist parameter in the Femto BSR devices.



5. PM Disable Action: This action disables BSR Femto devices to upload performance files periodically. By default, collection of PM files is disabled.

6. PM Enable Action: By the execution of this action, BSR Femto devices upload performance files to the file server periodically.

7. RFTrace Disable Action: This action disables Femto devices to upload RFtrace files periodically. By default, collection of RFtrace files is

disabled.

8. RFTrace Enable Action: By the execution of this action, Femto devices upload RFTrace files to the file server periodically.

9. SDF Download Action: This action is performed to make BSR Femto devices to download software description files, which are created by FAL,

from a specific location.

10. Sync Operational States Action: This action synchronizes Femto devices operational states in HDM database.

11. Trigger CM File Creation Action: When executed, Femto devices send an Inform message with a vendor specific event (M X_001D4C_rebuildDb) and FAL creates the CM file by receiving this

notification.

12. Trigger SDF File Creation Action: When executed, Femto devices send an Inform message with a vendor specific event (M

X_001D4C_upgradeWithMib) and FAL creates the SDF file by receiving

this notification.

Before executing this action, Device.Services.BSR.1.SDM.1.targetSoftwareRelease

parameter must be set manually for target software version.

13. Reboot Action: When executed, a reboot request sent to the femto device.

14. Enable Fault Notification Action: Enables fault notification on Femto by setting Device.Services.BSR.1.faultNotificationEnabled value to true.

15. Trigger Manual Alarm Synchronization: Calls the Trigger Manual Alarm Synchronization custom function. When executed, it triggers (set faultResyncRequired attribute to true) the manual alarm synchronization

with respect to the value of the

Device.Services.BSR.1.faultNotificationEnabled attribute. If fault notification is not enabled, it gives an error (You need to enable fault

notification first).

16. Perform Single SPV Action: Performs one by one the SPV action.

17. Update Administrative state: Lock/Unlock Femtos.



NOTE: Before importing the actions into the HDM, be sure that you have

successfully imported the custom functions. Otherwise, you can get invalid

xml error while importing the actions.

To import the actions mentioned above, perform the following procedures

step-by-step:

1 Log on to the HDM management console (For HDM 4.1, if multi domain

support is enabled, select super-domain in the domain input.) and go to the

Actions tab

2 Click on the Import button.

Figure 37 - Importing Actions

3 In the Import Action window, click on the Browse button and go to the

actions directory in HDM Adaptation Kit delivery. Select the

actions/FemtoActions.xml file.



Figure 38 - Uploading FemtoActions.xml File

4 Click on the Upload button. Actions will appear in the box.

Figure 39 - Uploading Actions



5 The uploaded actions will be listed on the result list. Click on the Close

button.

Figure 40 - Uploaded Actions

6 Now you will be able to see the imported actions in the Actions tab.



Figure 41 - Imported Actions

Importing Policies

Some policies need to be defined in HDM to support BSR Femto. These

policies have already constructed but they have to be imported to HDM

manually. The policies in HDM must be backed-up separately. General backup

of the HDM will not include the policies. These policies are:

1. Activate PM File Upload: This is an instant-triggered policy that is manually started after WMS upgrade and fileserver backup. This policy

calls PM Enable Action action.

2. Activate RFTrace File Upload: This is an instant-triggered policy that is manually started after WMS upgrade and fileserver backup. This policy

calls RFTrace Enable Action action.

3. Automatic Femto re-sync with HDM: This is an event-triggered policy whose aim of the re-synchronization is to keep up-to-date the Femto

configuration parameter value in HDM when an update is performed in

SCMS.



4. CM Download Policy: Boot, Value Change, Periodic and Connection Request events trigger this policy. It applies on a specific group of devices. This group of devices is tagged by FAL after the execution of Trigger CM

File Creation Action. This policy calls CM Download Action action.

5. Deactivate PM File Upload: This is an instant-triggered policy that is manually started before WMS upgrade and fileserver backup. This policy

calls PM Disable Action action.

6. Deactivate RFTrace File Upload: This is an instant-triggered policy that is manually started before WMS upgrade and fileserver backup. This

policy calls RFTrace Disable Action action.

7. Femto Activation Policy: This policy is triggered by the event Activation. It executes predefined Femto Activation Action. All Femto

devices are targeted by this policy.

8. Femto SetACL: This is an instant-triggered policy whose aim to update femtoACLlist parameter value of the Femto.

9. FM Deactivate: This policy is triggered by periodic informs. Target devices of this policy are filtered by the Find Devices By FM Expiration

Date criteria template. Devices which have a service tag FMexpirationDate and as the value of the service tag which have a date

value maximum 7 days past than the current date are targeted by this

policy. It executes FM Deactivate Action action. It sets FMexpirationDate service tags value to-1 as an exit option on

successful operations.

10. SDF Download Policy: Boot, Value Change, Periodic and Connection Request events trigger this policy, which applies on a specific group of

devices. This group of devices is tagged by FAL after the execution of Trigger SDF File Creation Action. This policy executes SDF Download

Action action.

11. Sync Operational States: Reboot event of Femto devices triggers this policy. It executes predefined Sync operational States Action action.

12. Reboot All Femtos: This is an instant-triggered policy which can be used

for sending a reboot request to all of the femto devices.

13. Reboot All Untouched Femtos: See Rebooting Femtos.

14. Reboot NOK Femtos: See Rebooting Femtos.

15. Reboot Untouched Femtos: See Rebooting Femtos.

16. Update Administrative state Policy: Used by SCMS.

17. Perform Single SPV: Used by SCMS.



18. Update Administrative state: Used by SCMS; Lock and unlock Femtos

19. Outside Tunnel Femto Activation: This policy is triggered by the event

Activation for outside tunnel Femos.

20. Outside Tunnel Femto Settings: Triggered by outside tunnel Femtos.

NOTE: Before importing the policies, be sure that you have successfully

imported the actions and criteria templates.

To import policies in to the HDM, perform the following procedures step-by-

step:

1 Log on to the HDM management console. For HDM 4.1, if multi domain

support is enabled, select super-domain in the domain input.

2 Go to the Policies tab

3 Click on the Import button. Import Policy window will appear.

Figure 42 - Importing Policies



4 In the Import Policy window click on the browse button and go to policies

directory in HDM Adaptation Kit delivery. Select the

policies/FemtoPolicies.xml file.

Figure 43 - Uploading FemtoPolicies.xml File

5 Click on the Upload button (See Figure 44 - Uploading Policies). Policies

will appear in the box. Close the window.



Figure 44 - Uploading Policies

Figure 45 - Uploaded Policies



6 Imported policies can be seen at the Polices tab. If the policies dont appear,

click on the Find Policies button at the top right side of the console.

Figure 46 - Imported Policies

7 Check the boxes near the policies and click on the Enable button at the

bottom left side of the window. Now, the policies are enabled. Select the

following policies to enable:

Femto Activation Policy

Sync Operational States

CM Download Policy

SDF Download Policy

FM Deactivate Policy

Update ACL Policy

Automatic Femto re-sync with HDM



Update Administrative state Policy

Perform Single SPV Policy

If you are going to use HDM server with outside-tunnel femto (small cell)

CPE devices, enable following polices:

Outside Tunnel Femto Settings

Outside Tunnel Femto Activation Policy

Figure 47 - Enabling Policies



Figure 48 - Enabled Policies

Setting SCE Parameters

HDM has some configuration parameters, which needs to be updated for the

BSR Femto deployments. These parameters must be set from Server

Configuration Editor. See Figure 49 - SCE Console.

SCE (Server Configuration Editor) URL = http://:/sce



Figure 49 - SCE Console

Update following SCE parameter values as in the table, if the parameter does

not exist in SCE, create it.

Table 2 - SCE Parameters for Femto Support

Parameter Name Value

hdm.app.banner.msg HDM Adaptation Kit 4.3.0.1_13w34

Installed.

nbi.notification.send.DeviceEvent true (default is false)

nbi.notification.blocked.inform.eventcodes

0 BOOTSTRAP,2 PERIODIC,3

SCHEDULED,5 KICKED,6

CONNECTION REQUEST,8

DIAGNOSTICS COMPLETE (default is 2

PERIODIC,6 CONNECTION REQUEST)

activation.gpvDeviceParamsOnFirstInform false (default is true)

nbi.notification.send.UnknownGatewayEvent false (default is true)

nbi.notification.send.EventTriggeredPolicyResultEvent false (default is true)

nbi.notification.jms.blocked.results

NBIBulkOperationResult,NBIEventTrigge

redPolicyResult,NBIInitiateConnectionRe

sult

nbi.notification.jms.blocked.events NBIDeviceActivationNotification,NBIDevi



ceReplacementEvent,NBIUnknownGatew

ayEvent,NBIUnmatchingHttpUsernameEv

ent

activation.gpvDeviceParamsOnFirstInform.LAN false (default is true)

nbi.notification.alarm.send.Alarm true (default is false)

nbi.notification.send.DeviceActionResultEvent true (default is true)

nbi.notification.send.single.device.action.result true (default is true)

Activation.waitForOSSDataTimeoutSecs 3600 (default is 43200)

nbi.set.tags.max.devices 1000 (default is 500)

If you are going to use HDM server with outside-tunnel femto (small cell)

devices, update/add the following SCE parameters (if not, make sure

following parameters are setted to their default values):


Activation.setTempPeriodicinformInterval true (default is true)

Activation.tempPeriodicInformIntervalSecs 300 (default is 3600)

Optionally you can make the following changes on SCE.


hdm.actions.records.per.page 20

hdm.policies.records.per.page 20

Step-by-step updating SCE parameters

1 Go to SCE (Server Configuration Editor) Console. Check HDM 3.1/4.1

Deployment Guide for more information [R2].

2 Select the Global Configuration view.



3 Find all parameters given above on the list and click on variable name to

update their values. See Figure 50 - Update SCE Variable.

4 If you cant find a parameter on the list, click on the New button and add the

parameter.

5 On the following window, update values according to the Table 2 - SCE

Parameters for Femto Support.

6 Then click on the OK button to save changes.

Figure 50 - Update SCE Variable

Assignment Of The nbi_alarm_mgr Role To The nbi_user

The global alarm synchronization is based on HDM NBI web service calls. To

use this service, the NBI user needs to be assigned the NBI_ALARM_MGR



role. How to assign this role to the NBI_USER, please refer to section

Assignment of the NBI_ALARM_MGR role to the NBI user.

Defining Alarms

In order HDM to handle alarms generated by the BSR, alarms should be

defined on HDM. For defining the alarms please refer to section Alarms.

Defining Reports

In order to view built-in and custom reports, HDM Reporting Module should

be installed and these reports should be defined in HDM. For defining the

custom reports and built-in reports please refer to section Reports.

Defining HDM Dashboard Alarm XML

In order to setup the interface status alarm configuration, HDM Dashboard

Module should be installed and for defining the alarm counter please refer to

section HDM Dashboard.

Defining Jobs

In order HDM to clean unused policies and actions created by FAL, a

periodically executed job should be defined on HDM. For defining the jobs

please refer to section Jobs.


50

Part IV: Upgrading HDM Adaptation Kit to SCMS4.3

This section describes how to upgrade HDM adaptation Kit from

SCMS3.0/SCMS4.0/SCMS4.1 to SCMS4.3 without affecting any existing

devices.


51

1 Prerequisites

Prerequisites for HDM3.1/HDM4.1.x

A5580 HDM 3.1/HDM 4.1.x should be installed to your system. Please refer to

[R1] for this purpose.

HDM adaptation kit must be applied to HDM 3.1/HDM 4.1.x.

Ensure that there is no registered femto device in HDM.


52

2 Upgrade Procedure

This section describes the upgrade procedure. If you follow this procedure,

your devices will be protected in the HDM. However, you will lose the

statistical data about policies (like Results Summary).

Deleting Actions and Policies

While deleting the policies and actions make sure only the policies and actions

that were installed with HDM Adaptation Kit are selected. If you have user

created policies, dont use the select all box on top of the list. Delete process is

permanent and there is no way to undelete.

1 Be sure that HDM 3.1.x/HDM 4.1.x correctly installed.

2 Go to the Policies tab.

Upgrade Procedure


Figure 51 - Existing Policies in SCMS

3 Select the policies that were delivered with HDM Adaptation Kit. Then click

on the Delete button.

List of policies that were delivered with HDM Adaptation Kit:

Activate PM File Upload

Activate RFTrace File Upload

Automatic Femto re-sync with HDM

CM Download Policy

Deactivate PM File Upload

Deactivate RFTrace File Upload

Femto Activation Policy

Femto SetACL

FM Deactivate Policy

Reboot All Femtos

Reboot All Untouched Femtos

Upgrade Procedure


Reboot NOK Femtos

Reboot Untouched Femtos

SDF Download Policy

Sync Operational States Policy

Outside Tunnel Femto Activation

Outside Tunnel Femto Settings

Update ACL Policy

Update Administrative state Policy

Perform Single SPV Policy

Figure 52 - Deleting Existing Policies

4 Go to the Actions tab.

Upgrade Procedure


Figure 53 - Existing Actions in FMS 2.2

5 Select the actions that were delivered with HDM Adaptation Kit. Click on the

Delete button.

List of actions that were delivered with HDM Adaptation Kit:

CM Download Action

Enable Fault Notification Action

FM Deactivate Action

Femto Activation Action

Femto SetACL Action

PM Disable Action

PM Enable Action

RFTrace Disable Action

RFTrace Enable Action

Reboot Action

SDF Download Action

Upgrade Procedure


Sync Operational States Action

Trigger CM File Creation Action

Trigger Manual Alarm Synchronization

Trigger SDF File Creation Action

Outside Tunnel Femto Activation Action

Update ACL Action

Update Administrative state Action

Perform Single SPV Action

Figure 54 - Deleting Actions

Deleting Criteria Templates

Two criteria templates (Find All TR-069v1 Devices, Find All SNMP Devices) are installed by

default on HDM. Dont delete these two criteria templates.

Apply the following steps to delete Criteria Templates.

Upgrade Procedure


1 On the Welcome tab, click Manage Device Selection Criteria.

2 In the Criteria Manager, select the check box next to the criteria template to

delete.

To delete multiple criteria templates at once, select the check boxes next to the

templates to delete. To delete all criteria templates, select the check box in the

header area of the Manage Criteria table. You should check boxes near the

criteria templates included in HDM Adaptation Kit.

3 Click Delete.

The selected criteria template is deleted. If multiple criteria templates were

chosen, all selected templates are deleted.

4 Click Close to exit.

Upgrading the DeviceTypes

1 Add the new device type (for SCMS 4.1) included in HDM adaptation kit

delivery. Please refer to section ADDING DEVICE TYPE BASED ON

SOFTWARE VERSION.

2 Preserve existing SCMS 4.1 device type definitions.

3 Delete existing SCMS 4.1 device type definitions from HDM.

Upgrading via Bundle package for HDM 4.1.x

If exist delete all alarms: Deleting Alarm Definitions and perform only the step 1-

3 from selection Upgrading Custom Functions. Import criteria templates, Custom

Functions, Actions, Policies and Alarms by applying the section Importing

Upgrade Procedure


Criteria Templates, Actions, Policies, Alarms and Custom Functions via Bundle

for HDM 4.0. Follow below selections without import any items.

Upgrading Criteria Templates

Caution: If bundle package imported successfully, please ignore these steps.

Import all criteria templates included in HDM Adaptation Kit by applying the

section Importing Criteria Templates.

Upgrading Custom Functions


Upgrading Custom Functions for HDM3.1.x/HDM4.1.x

Delete existing HDM Adaptation Kit Custom Functions by applying these

steps:

1 Log on HDM Management Console.

2 Select Manage Custom Functions from Welcome tab.

Upgrade Procedure


Figure 55 Manage Custom Functions

3 Select the custom functions that came with HDM Adaptation Kit (ones with

Function Code higher than 1000) and click on Delete

Upgrade Procedure


Figure 56 Deleting Custom Functions

4 Please apply section Importing The Custom Functions to import all custom

functions.

Upgrading Actions


Please apply section Importing Actions to upgrade actions in HDM Adaptation

Kit.

Upgrading Policies

Caution: If bundle package imported successfully, only perform step 7 @

Importing Policies

Upgrade Procedure


Please apply section Importing Policies to upgrade policies in HDM

Adaptation Kit.

Upgrading Alarms

Caution: If bundle package imported successfully, only perform step 8 @

Adding Alarm Definitions.

You should first delete all alarm definitions as described in Deleting Alarm

Definitions section and then re-create new alarm definitions as described in

Adding Alarm Definitions section.

Upgrading Reports

If HDM Reporting Module is installed, you should first delete all reports as

described in Deleting Reports section and then import new reports as described

in Importing Reports section. If HDM Reporting Module is not installed, skip

this section.

Upgrading SCE Parameters

Update/add SCE parameters by applying the section Setting SCE Parameters.


62

Part V: Removing the HDM Adaptation Kit

This section describes how to remove HDM Adaptation Kit. Since there are

dependencies between the objects, the order of the removal process is

important. For example, policies are dependent to actions. You cannot remove

an action if you dont remove the policies first which depends to it.

The step-by-step procedure for removing the layer:

1 Removing the device

1. Go to the Devices tab

2. Check the boxes near the device records that belong to the Femto BSR.

3. Click on the Delete button.

4. If the device cannot be removed, disable first and retry the procedure.

2 Removing the policies:

1. Go to the Policies tab

2. Check the boxes near the policy records that youve imported for Femto BSR management.


3 Removing the actions:

1. Go to the Actions tab

2. Check the boxes near the action records that youve imported for Femto BSR management.

Upgrade Procedure



4 Removing the custom functions:

Custom functions could not be removed in HDM 3.1/HDM 4.x.x if they are

used in Actions or executed on any device. You should not delete custom

functions.

5 Removing criteria templates:

1. Go to the Welcome tab of the HDM Management Console

2. Select Manage Device Selection Criteria

3. Select the criteria templates that you imported before (which are included in HDM Adaptation Kit).

4. Click on the Delete button

6 Removing the firmware images if exist:

1. Go to the Firmware tab.

2. Check the box near the firmware images that is created for Femto BSR.


7 Removing device type xml:

1. Go to the Device Types tab.

2. Check the box near the device type record that you want to remove.


8 Default values for SCE Parameters:

1. Go to the SCE console (http://:/sce)

2. Set the following parameters to their default values:

Upgrade Procedure


Table 3 - Default values for SCE parameters

Parameter Name Default Value

activation.setTempPeriodicinformInterval true

nbi.notification.send.DeviceEvent false

nbi.notification.blocked.inform.eventcodes 2 PERIODIC,6 CONNECTION REQUEST

activation.gpvDeviceParamsOnFirstInform true

nbi.notification.send.DeviceActionResultEvent true

nbi.notification.send.UnknownGatewayEvent true

nbi.notification.send.EventTriggeredPolicyResultEvent true

nbi.notification.send.single.device.action.result true

nbi.notification.jms.blocked.results (empty)*

nbi.notification.jms.blocked.events (empty)*

activation.gpvDeviceParamsOnFirstInform.LAN true

nbi.notification.alarm.send.Alarm false

Activation.waitForOSSDataTimeoutSecs 43200

nbi.set.tags.max.devices 500

*Null values are not accepted in SCE; enter a space character ( ) for empty fields.

9 Removing the alarms

1. Go to the Alarms tab

2. Select the alarms that you want to remove

3. Click on the Delete button

10 Removing the reports

Refer to section Deleting Reports.

11 Removing the jobs

Refer to section Deleting Jobs.

Upgrade Procedure


After you perform the steps mentioned above, whole HDM adaptation layer

will be removed from HDM.


66

Part VI: Adding Device Type Based on Software Version

You can add software version of your device type for SCMS 4.1. Then you

should select one of the device type models as default device type model.

Hereafter when a Femto device comes to HDM to be registered; if any device

type model that have the same software version with the incoming Femto

device is created before, the device is going to be registered with that device

type model(not with the default model). If any device type model (that have the

same software version with incoming device) is not created before, then

incoming device will be registered with the default device type model.

For example, if you select an SCMS 4.1 device type model as the default

device type, all devices will be registered with that device type model unless a

device type model is not created with the same software version with the

incoming device.

You must repeat all of the steps below for both Femto and Femto_2 device

types with both devicemodel.xml and devicemodel_2.xml files

respectively.

Step-by-step adding device type based on software version:

1 Add Manufacturer, OUI, Product Class and softwareVersion tags of

your device type into device type attribute file if not exists. See selection

Defining The Device Type.

Upgrade Procedure


2 Click Device Types tab. Then click on the Manage button of the device

type which you want to add based on software version. See Figure 57 -

Selecting Device Type.

Figure 57 - Selecting Device Type

3 Click Browse button. Select device type attribute file. See Figure 58 -

Selecting XML File

Upgrade Procedure


Figure 58 - Selecting XML File

4 Click Add button. See Figure 59 - Adding XML file

Figure 59 - Adding XML file

Upgrade Procedure


5 Software version of device type is added to the list. See Figure 60 - Device

Types (Based On Software Version) List.

Figure 60 - Device Types (Based On Software Version) List

6 If needed, modify the default device type.

Upgrade Procedure


Figure 61 Setting Default Device Type


71

Part VII: Assignment of the NBI_ALARM_MGR Role to the NBI User

NBI user needs to be assigned to NBI_ALARM_MGR role to use

getActiveAlarms() and getActiveAlarmsCount(). Check whether this role is

assigned.

1 Log on web logic server console. See Figure 62 - Logon Form.

Figure 62 - Logon Form

2 After logging on to the weblogic server you will be on the main page. Click on

Security Realms link. See Figure 63 - Security Realms.

Upgrade Procedure


Figure 63 - Security Realms

3 On opened page click on myrealms link. See Figure 64 - Realms.

Figure 64 - Realms

4 Go to the Roles and Policies tab. Then click Global Roles link. See Figure

65 - Global Roles.

Upgrade Procedure


Figure 65 - Global Roles

5 Click Roles link under Global Roles. See Figure 66 - Roles.

Upgrade Procedure


Upgrade Procedure


Figure 66 - Roles

6 Find NBI_ALARM_MGR from the list. Then click View Role Conditions.

See Figure 67 - Selecting NBI_ALARM_MGR.

Figure 67 - Selecting NBI_ALARM_MGR

7 You should see HDM_NBI_Manager group in Role Conditions.

Figure 68 - Check HDM_NBI_Manager group

Upgrade Procedure


8 If HDM_NBI_Manager group does not exist, do the following after clicking

Add Conditions button.

9 Select Predicate List. Then click on Next button. See Figure 69 - Selecting

Predicate List.

Figure 69 - Selecting Predicate List

10 Enter HDM_NBI_Manager and press Add button. Iterate this step for each

group you want to add. See Figure 70 - Adding Group.

Upgrade Procedure


Figure 70 - Adding Group

11 After adding group or groups to condition press Finish button. See Figure 71

- Finishing Process.

Figure 71 - Finishing Process

12 HDM_NBI_Manager group is assigned.

Upgrade Procedure


Figure 72 - Process finished


79

Part VIII: Alarms

Set nbi.notification.alarm.send.Alarm parameter to true in SCE to be able to

send alarm notifications. See section Setting SCE Parameters.


80

1 Adding Alarm

Definitions

Adding Alarm Definitions for HDM3.1, HDM 4.1.x

Step-by-step importing alarm definitions:



2 Select Define Alarms from Welcome tab.

Adding Alarm Definitions


Figure 73 Define Alarms

3 Select Import.

Figure 74 Importing Alarms



4 In the Import Alarm Definition window, click on the Browse button and

go to the Alarms directory in HDM Adaptation Kit delivery. There are two

different Alarm dictionaries: Alarms.xml and Alarms_with_filter.xml. The

Alarms.xml filter has no any applied filtering. Whreas by the

Alarms_with_filter.xml filters following paramters in the alarms detail body:

Device.Services.BSR.*.clusterId

Device.Services.BSR.*.SDM.*.mimVersion

Device.Services.BSR.*.activeFaultList.*

Device.Services.BSR.*.bsrGroupId

Device.Services.BSR.*.locationName

Device.Services.BSR.*.bSRName

Import the Alarms.xml file for handling with rare (non-filtered) Femto

alarms. Or select the Alarms_with_filter.xml file for using parameter filtering

in the Alarms detail body.

Figure 75 Selecting Alarms File



5 Click on the Upload button. Alarms will appear in the box(It is normal for

this loading to take some time).

Figure 76 Uploading Alarms

6 The uploaded alarms will be listed on the result list. Click on the Close

button.



Figure 77 - Uploaded Custom Functions

7 Now you will be able to see the imported alarms in the Alarms tab but they

will be disabled.



Figure 78 - Imported Alarms

8 Select all the Alarms by clicking the empty box on top of the Alarms List and

select Enable.



Figure 79 - Selecting Alarms

9 Now you will be able to see all the alarms and they will be enabled.



Figure 80 Alarms List


88

2 Listing Alarm

Definitions

Step-by-step listing alarms:

1 Go to Alarms tab. See Figure 81 - Alarms. Click on the column "alarm

name" or 'alarm type" or "perceived severity" to display inserted alarm

definitions.

In case it is not functional (you are not able to display the alarms), use filtering

(under Show Alarms->Perceived Severity).

Figure 81 - Alarms


89

3 Deleting Alarm

Definitions

Step-by-step deleting alarms:

1 Go to Alarms tab. See below figure - Deleting Alarm Definitions. Select all

of the HDM Adaptation Kit alarm definitions. Then, click delete button. All

selected alarm definitions should be deleted.

Figure 82 - Deleting Alarm Definitions


90

Part IX: Reports

HDM Reporting provides operational reporting capabilities on HDM data.

With HDM Reporting, you can view, print, import and export reports, as well

as manage groups of reports. You can also use it to initiate and monitor ETL

(extract, transform, load) processes used to refresh report data.

The following custom reports are provided with the HDM Adaptation Kit:

1. Number of Femto AP up & running: Provides number of devices with Device.Services.BSR.1.operationalState and Device.Services.BSR.1.LCell.1.operationalState parameters set to

enabled

2. Number of Femto AP Up with radio transmission OFF: Provides number of devices with Device.Services.BSR.1.operationalState parameter

enabled and Device.Services.BSR.1.LCell.1.operationalState

parameter disabled

3. Number of customers authorized declared (access control): Provides the number of devices with user setted service tag of femtoACLList

4. GPS Report: Provides list of devices with their GPS data details.

5. Carrier Report: Provides list of devices with their carrier related data details.

6. Femto List Report: List offline/online Femtos.

7. QUIProductClass: Provides number of devices of OUI and Product Class.

The following built-in reports are provided with since HDM 3.1 Reporting

Module:

8. Contact Failure. Identifies devices that have not contacted Home Device Manager within a specified period. Optionally, you can specify a device

type as a parameter for the report.

Deleting Alarm Definitions


9. Detailed CPE Summary. Provides a summary of the number of activated devices and total device count, broken out by software version. The report also shows the last contact time interval in four ranges: less than one day,

one day to one week, one week to one month, and more than one month.

10. Detailed Device History. Summarizes historical data for a specific device.

11. Detailed Device Status. Summarizes devices based on last contact time.

12. General CPE Summary. Provides a summary of the number of activated devices and total device count.

13. Policy Inventory Status. Lists enabled policies by date. Both event-triggered and instant-triggered policies are listed.

14. Policy Summary. Provides the current status of a specific policy.

15. Device Alarm History Summary. Provides a summary of device alarms listed by alarm type.

16. Device Alarm History Details. Provides a view of details about device alarms raised.

17. Device Alarm Status Summary. Provides a summary of the status of device alarms in the system, categorized by alarm type.

18. Device Alarm Status Details. Provides details of the status of device alarms in the system, categorized by alarm type.

You can log on to the HDM Reporting Console as reportsmgr (default

password: password) or netopmgr using the following URLs:

http://:/report-console/

or for secure access:

https://:/report-

console/

where:

PUBLIC SERVER PORT is the clear (non-SSL) port of the Managed Server.

PUBLIC SERVER SSL PORT is the secure (SSL) port of the Managed Server.

If you cannot see the login page or welcome page when you entered the above

URLs, be sure that HDM Reporting Module is installed on the server.


92

1 Adding Report Groups

(Optional)

Report groups are categories of reports which may be added or deleted. As the

number of reports in the system grows over time, it is convenient to have

report groups to ease navigation.

Add the following three groups by applying the following steps.

Groups to add:

1. Device Reports

2. Policy Reports

3. Device Alarm Reports

To add a report group

1. Log on to HDM Reporting Console.

2. From the Manage tab, click Manage Groups.

3. The Manage Report Groups dialog box is displayed.

4. In the Group Name field, type the name of the new report group.

5. Click Add.

6. The report group is added.

7. When you are finished adding report groups, click Close.


93

2 Importing Reports

A report to be imported consists of a .zip format file containing:

A .rptdesign file (a report definition XML document)

A .properties file (localizable strings in Java properties file format)

Apply the following steps for all of the custom reports in HDM Adaptation Kit.

You can also import the built-in reports provided with the reporting module.

2 Log on to HDM Reporting Console.

3 From the Manage tab, click Import. The Import Report dialog box is displayed.

4 Click the Browse button next to the Report .zip file field. The Choose file

dialog box is displayed.

5 Navigate to and select the .zip file for the report to be imported, and then click

Open.

6 Optionally, from the Select a group for the report list, click a report group

under which to put the new report. If no report groups have been created, this

list is not activated.

7 In the Report Name field, type a name for the report.

8 Optionally, in the Description field, type a description of the report.

Importing Reports


9 Click Import.

The report is imported. If the report name does not appear immediately in the

list on the Manage page, check to see if the report group with which it is

associated is selected in the Show Group list, and select it if it is not.


95

3 Exporting Report .zip

File

Apply the following steps to export a reports .zip file.

1 Log on to HDM Reporting Console.

2 From the Manage tab, select the report group from the Show Group list that

contains the report to export.

3 Find the report name in the list, and click Download in the same row. The File

Download dialog box is displayed.

4 Click Save. The Save As dialog box is displayed.

5 Navigate to the directory in which to save the report .zip file, and click Save.

The report .zip file is saved.


96

4 Deleting Reports

Apply the following steps to delete a report.

6 From the Manage tab, select the report group from the Show Group list that

contains the report to delete.

7 Find the report name in the list, and select the corresponding check box at the

beginning of the same row. To delete multiple reports at once, select multiple

check boxes. To delete all reports, select the check box in the header of the

reports list.

8 Click Delete.

9 In the confirmation dialog box, click OK.

The report is deleted.

Command Line Report Script


5 Command Line Report

Script

See the Using the command-line report generation utility selection in the

PUBS-9YZ -05167-AAAAP HOME DEVICE MANAGERREPORTING

DEPLOYMENT GUIDE.


98

Part X: PKI Server Script (Optional)

Find PKI server installation instructions in 3MN-01516-0624-RJZZA 5580 HDM Light Installation Guide - Installation Method for SCMS on Solaris.



Part XI: Dashboard Alarm Configuration (Optional)

Dashboard Console is a web-based application that enables users to monitor

health metrics on systems that use JMX datasources, such as individual

Managed Servers as well as the entire Cluster. Monitoring results are stored in

a relational database that handles time-series data, from which Dashboard

Console generates graphs. The graphs, whose data you can export, show views

of Managed Server and cluster health data over the past hour, day, or week

from JDBC, Northbound Interface (NBI), Southbound Interface (SBI), and

server-related sources. With Dashboard Console, HDMs interface health setup

should proceed as follows:

1 Log on to Login to HDM Dashboard. HDM Dashboard URL: http://:/dashboard/

2 In the Configuration section, click the on Manage Configuration and

download HDM Dashboard configure XML file.



3 Edit the dashboad-config.xml and change change the target parameter on the

line below from server to cluster

4 First, to set the warning threshold value, make sure that all required interfaces

are in UP and RUNNING state. Then, execute below command in the HDM

server to find threshold value:

# /sbin/ifconfig a | grep UP| grep RUNNING | wc l | awk '{print expr $1*3}'

# 9

The warning threshold value should be:

warning threshold value = - 1 = 9 1 = 8

and set the critical threshold value set as follows,

critical threshold value = 1 =8 - 1= 7

Please note that, you have to update the warning threshold value, if the

intended UP and RUNNING interface number has changed. Also you can

find this command in the dashboard folder. Also, if needed please look at the

command examples selection below, for other counter commands.



5 Append the following osDataSource counter reachable.device.count with

updated waringThreshold (2) value near to Osdatasourcecounters field:

6 Finally, append the counter parameter to display of dashboard under following

XML tag:

7 Save the dashboard-config.xml file, upload this configuration file to HDM

Dashboard.

Script Examples:

To monitor only the south bound interface status:

/sbin/ifconfig bge1|grep RUNNING| grep UP |wc -l|awk '{print

expr $1*3}'

where bge1 is the south bound interface and 3 is alarm trigger value.



Part XII: Jobs

During the resynchronization of the HDM, WMS and the Femto itself, an

action and a policy is created in HDM with a name like nbi bulk operation

00000123-3167-5DF7-3167-5D8EAC1D0295. These actions and policies are

seen in the GUI and they are not used anymore. So, a cleanup script is created

to delete these unused actions and policies.


103

1 Creating Jobs

1 From the HDM Adaptation Kit directory, copy the

delete_nbi_generated_actions_and_policies.sql file (located in the

hdmadaptation/jobs/ directory) into a temporary directory on the

Admi

hdm webconsole create user access

Documents

rjzza issue

property of alcatel

hdm adaptation kit

issue reasons

current issue

adapting hdm

issue number issue date

device type