SHM, Software Hardware Manager, User Guide [PDF]

Zitiervorschau

SHM, Software Hardware Manager, User Guide USER GUIDE

1/1553-CNA 403 2428 Uen H

Copyright © Ericsson LMI 2014. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner. Disclaimer The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document. Trademark List All trademarks mentioned herein are the property of their respective owners. These are shown in the document Trademark Information.

1/1553-CNA 403 2428 Uen H | 2014-10-10

Contents

Contents 1

About This Document

1

1.1

Purpose

1

1.2

Target Groups

1

1.3

Prerequisites

1

1.4

Typographic Conventions

1

2

SHM Overview

3

2.1

Supported Managed Elements

3

2.2

Basic Functions of SHM

4

2.3

Concepts

4

3

Getting Started

5

3.1 3.1.1

Starting and Exiting Starting SHM through OSS Explorer

5 6

3.2 3.2.1 3.2.1.1 3.2.1.2 3.2.1.3 3.2.2 3.2.2.1 3.2.2.2 3.2.2.3 3.2.2.4 3.2.2.5 3.2.2.6 3.2.2.7 3.2.3 3.2.3.1 3.2.3.2 3.2.3.3 3.2.3.4 3.2.4 3.2.4.1 3.2.4.2 3.2.4.3 3.2.4.4 3.2.4.5 3.2.4.6 3.2.4.7 3.2.5 3.2.5.1

Navigating SHM Topology Simple Topology Search Export and Import Topology Selection Subnetwork Selection Options Jobs View Job Filtering Housekeeping of Jobs Clone Job Refresh Job Delete Job Cancel Job for Backup and Restore Job Scheduling Inventory View Hardware Inventory Software Inventory Upgrade Packages Backup Upgrade View Import Upgrade Package Prepare Upgrade Activate Upgrade Prepare and activate upgrade Cancel Upgrade Job View Upgrade Packages Delete Upgrade Packages Backup View Create Backup

1/1553-CNA 403 2428 Uen H | 2014-10-10

7 8 11 12 18 19 22 27 27 30 30 31 31 41 41 46 51 51 51 53 56 58 61 64 66 70 71 72

SHM, Software Hardware Manager, User Guide

3.2.5.2 3.2.5.3 3.2.5.4 3.2.5.5 3.2.5.6 3.2.5.7 3.2.5.8 3.2.5.9 3.2.5.10 3.2.5.11 3.2.5.12 3.2.5.13 3.2.5.14 3.2.5.15 3.2.5.16 3.2.5.17 3.2.5.18 3.2.5.19

Create and Export Backup Create, Export and Delete Backup Configure Scheduling of Backup on Node View Backup Schedule on Node Configure Housekeeping on Node Resume Backup Suspend Backup Auto Export View Backup Export Backup View Backup Exported to OSS View backup label stored information on ME Import Backup Import and Restore Backup Delete Backup Restore Backup Cancel Backup and Restore Search Backup

74 75 77 89 91 93 95 97 98 101 103 104 105 107 109 111 114 120

4

Using SHM

125

4.1 4.1.1 4.1.2

Workflows Inventory Workflows Upgrade Workflows

125 125 125

4.2 4.2.1 4.2.2 4.2.3

SHM Task List Export SW Inventory Import SW Package Upgrade SW

125 125 126 126

5

Troubleshooting

129

6

Frequently Asked Questions (FAQ)

131

6.1

Terminology

131

6.2 6.2.1 6.2.2 6.2.3 6.2.4

Functions Inventory Jobs Topology Upgrade

132 132 132 133 133

6.3

Access Rights and Authority

134

6.4

Performance and Characteristics

135

6.5

Further Information

135

Glossary

137

Reference List

139

1/1553-CNA 403 2428 Uen H | 2014-10-10

About This Document

1

About This Document This document describes how to use the Software Hardware Manager (SHM) Graphical User Interface (GUI). This chapter contains the following parts:

1.1

•

Purpose

•

Target groups

•

Prerequisites

•

Typographic conventions

Purpose This document describes features, concepts, and procedures of Software Hardware Manager (SHM) in general. SHM supports software management of Network Elements (NEs) compliant with the Ericsson Common Information Model (ECIM). NEs managed in this model are called Managed Elements (MEs).

1.2

Target Groups The intended target groups for this document are network engineers using SHM.

1.3

Prerequisites It is assumed that the reader of this document is familiar with the following:

1.4

•

Solaris workstations

•

Operations Support System, Radio and Core (OSS-RC)

•

ECIM compliant MEs.

Typographic Conventions The typographic conventions for all Customer Product Information (CPI) are found in Typographic Conventions, Reference [2].

1/1553-CNA 403 2428 Uen H | 2014-10-10

1

SHM, Software Hardware Manager, User Guide

2

1/1553-CNA 403 2428 Uen H | 2014-10-10

SHM Overview

2

SHM Overview SHM is an application for remote software management of different types of ECIM compliant MEs. It provides a process-oriented working environment for the user and uniform software handling for different ME types. With the Graphical User Interface (GUI) of SHM, the users can supervise multiple jobs toward multiple MEs from a single client.

2.1

Supported Managed Elements The supported managed elements and the level of support provided are described in Table 1

Table 1

Supported Functionality and Managed Elements

Function ality

Managed Elements DSC

SGSN

TCU03

pRBS

pRBS

(pLTE)

(pWCDM A)

BSP

WCG

DUAS

Step by Step upgra de of ME(s)

X

X

X

X

X

X

X

X

One go upgrade of ME(s)

X

√

√

√

√

X

X

X

View upgrade packages on ME

X

√

√

√

√

X

X

X

Delete upgrade package from ME

X

√

√

√

√

X

X

X

Display backup inventory of ME(s)

√

√

√

√

X

√

√

√

Create backup of ME(s)

√

√

√

√

X

√

√

√

Delete backup(s) on ME

√

√

√

√

X

√

√

√

Restore backup

√

√

√

√

X

√

√

√

Software Inventory

√

√

√

√

√

X

X

X

Hardware Inventory

X

X

√

X

X

√

X

X

(1)

(1) Backup name should be less than 26 characters, otherwise the backup will fail

1/1553-CNA 403 2428 Uen H | 2014-10-10

3

SHM, Software Hardware Manager, User Guide

Note:

2.2

2.3

For non COM/ECIM nodes, please refer to Reference [8]

Basic Functions of SHM •

Viewing, filtering and scheduling jobs

•

Remote software upgrade that includes planning, starting and monitoring the upgrade process

•

Importing upgrade packages

•

Creating backup and restore

•

Software (SW) inventory, including viewing and exporting the inventory

Concepts The following general concepts, listed in alphabetical order, are central for understanding SHM: Batch

A number of MEs that are grouped together in SHM. The operator can execute SHM jobs on the batch.

ECIM

Ericsson Common Information Model is the new standardized operation and maintenance (O&M) interface for Ericsson Managed Elements.

Job

A job comprises one or more activities that are executed for one or more MEs.

Managed Element It is an object in a network which can handle a signal in various ways and which can be remote-controlled by a centralized management system. It can also be either a real switch, or the managed object for a switch. View

4

Views are sub-windows of the main GUI.

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3

Getting Started This chapter describes the interface and the steps for performing the below mentioned tasks,

3.1

•

Starting and exiting SHM

•

Navigating the SHM GUI

Starting and Exiting SHM provides a web-based client, which can be opened in Mozilla Firefox browser. Prerequisites •

SHM must be installed and running. Refer to SHM, Software Hardware Manager Installation Instructions, Reference [3], for SHM installation.

•

The user must be registered in OSS-RC. Refer to SHM, Software Hardware Manager System Administrator Guide Reference [6], to find out more about Authority Handling.

•

To launch SHM, log into the Unix Application Server (UAS) with an OSS-RC username.

1. Open the application in the Firefox browser window: http://mashost:50503/NSS-Client 2. When the login screen appears, as seen in Figure 1, log in to SHM. Your login access depends on your personal access rights to the application. 3. To exit SHM, click Sign out in the top right corner.

1/1553-CNA 403 2428 Uen H | 2014-10-10

5

SHM, Software Hardware Manager, User Guide

Figure 1

3.1.1

Login

Starting SHM through OSS Explorer User can log in to SHM application through OSS Explorer (OEX) application by following the given steps: 1. Log in to the Unix Application Server (UAS) with an OSS-RC user name. 2. Click on Launch->Applications->Ericsson-OSS Explorer and launch the OEX application. 3. Click on Tools in OEX application. 4. Click on Hardware and Software Inventory. 5. Click on SHM.

6

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

6. SHM application will open in a Firefox browser window. 7. When the login screen appears, as shown in Figure 1, log in to SHM. Your login access depends on your personal access rights to the application. 8. To exit SHM, click Sign out in the top right corner.

3.2

Navigating SHM The SHM GUI consists of five major components. •

Topology

•

Jobs

•

Inventory

•

Upgrade

•

Backup

In the upper right corner of the SHM view, a round icon shows the server status. Green indicates that the connection is alive, red indicates there is no connection, in which case an error message is also displayed. See Figure 2 and Figure 3 for more information.

Figure 2

Main View after Login

Figure 3

Server Status

1/1553-CNA 403 2428 Uen H | 2014-10-10

7

SHM, Software Hardware Manager, User Guide

3.2.1

Topology The topology view displays all the imported MEs that are available. The topology tree becomes visible on the left hand side of the main view. The sidebar can be resized and minimized by clicking the arrow (arrow pointing left: Close sidebar, arrow pointing right: Open sidebar) next to the top of the topology sidebar on the right. See alsoFigure 4 .

Figure 4

Close sidebar arrow in Topology View

In the Topology sidebar, two different topology formats can be selected: nex:onrm and nex:site. In both topology formats when arrow beside ONRM_ROOT_MO is clicked, the following elements are visible and can be further expanded. , which as shown in Figure 5.

8

•

FTP Servers

•

Groups

•

Management Nodes

•

Network Elements

•

Subnetworks

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 5

Topology- onrm

Subnetwork elements are nested under Subnetworks. When Subnetwork object is expanded, the list of MEs are displayed. When one or more MEs are selected, they become visible in the Inventory, Upgrade and Backup view, depending on which view the user has selected. In the site under the Subnetworks, the MEs are listed. For more information, see Figure 6. Only ECIM compliant MEs are visible and can be selected.

1/1553-CNA 403 2428 Uen H | 2014-10-10

9

SHM, Software Hardware Manager, User Guide

Figure 6 Note:

10

Topology- site

By default, all users assigned to a predefined OSS-RC user role, can view all MEs managed by SHM. However, company policies can require the definition of several target groups (TGs). The users can be assigned to one or more TGs, but may not have the authority to view all the MEs. To learn more about the Target Based Access Control (TBAC) concept, refer to Getting Started Guide of Reference [4]. Authority handling specific to SHM is summarized in SHM, Software Hardware Manager System Administrator Guide, Reference [6]

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.1.1

Simple Topology Search Users can search for an ME using the topology search function. The search text box is visible at the top of the topology tree. To search for an ME follow the given steps: 1. Select Inventory tab to view the topology sidebar. 2. Enter name of required ME in topology search text box. 3. Click search icon or press Enter. The ME is displayed in topology tree.

Figure 7

Simple Topology search

When an ME is selected, it is displayed in all tabs of Inventory view. For example, Hardware, Software and so on. Users can also search for multiple MEs by following the given steps: 1. Enter names of required MEs separated by "|" symbol as shown in Figure 8. 2. Click search icon or press Enter. The MEs are displayed in the topology tree.

Figure 8

Multiple ME search

1/1553-CNA 403 2428 Uen H | 2014-10-10

11

SHM, Software Hardware Manager, User Guide

3.2.1.2

Export and Import Topology Selection With these options, users can export and import the topology selection. The Export and Load buttons can be seen in the topology tree. By default, Export is disabled.

Figure 9 3.2.1.2.1

Hardware Inventory view with disabled Export button

Using topology search To export and import a topology selection using topology search, follow the given steps: 1. Click Inventory tab. The topology side bar opens. 2.

Enter name of required ME in topology search text box and click search icon or press enter. The ME is displayed in topology tree.

3. Click Export visible below the topology search box.

12

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

4. An Export-Topology-Nodes dialog box opens. It displays the default file name. Click Save.

5. The file will be stored in /var/opt/ericsson/nms_shm/shm_file_st ore/topology_selection. Click Ok.

6. Click Load.

1/1553-CNA 403 2428 Uen H | 2014-10-10

13

SHM, Software Hardware Manager, User Guide

An Import-Topology-Nodes dialog box opens. It displays saved file name.

The drop down list displays saved files.

7. Select the required file from the list and click Import button.

14

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

The MEs are displayed in topology side bar.

Figure 10 3.2.1.2.2

Display of Imported MEs

Using topology tree To export and import a topology selection using topology tree, follow the given steps: 1. Click Inventory tab. The topology side bar opens. 2. Select required ME from the topology tree. 3. Click Export. An Export-Topology-Nodes dialog box opens. It displays the default file name.

1/1553-CNA 403 2428 Uen H | 2014-10-10

15

SHM, Software Hardware Manager, User Guide

4. Click Save. The file will be stored in /var/opt/ericsson/nms_shm/sh m_file_store/topology_selection. Click Ok.

5. Click Load. An Import-Topology-Nodes dialog box opens. It displays saved file name.

The drop down list displays saved files.

16

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

6. Select required file from the list and click Import.

The MEs are displayed in topology side bar.

Figure 11

Display of Imported MEs

1/1553-CNA 403 2428 Uen H | 2014-10-10

17

SHM, Software Hardware Manager, User Guide

3.2.1.3

Subnetwork Selection Options When a subnetwork is selected in topology tree, all the MEs under it are automatically selected and reflected in main view. User can deselect a subnetwork and also deselect specific MEs under that subnetwork. To select a subnetwork, expand Subnetworks in topology tree and select the subnetwork. All MEs of that subnetwork are selected and displayed in the main view as shown in Figure 12

Figure 12

Selection of Subnetworks

To deselect a subnetwork, uncheck its checkbox. The MEs under it are deselected and removed from the main view as shown in Figure 13

Figure 13

18

Deselection of Subnetworks

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

To deselect specific MEs of a subnetwork, uncheck the respective checkboxes. They are then deselected and removed from the main view as shown in Figure 14

Figure 14

3.2.2

Deselection of specific MEs under selected Subnetwork

Jobs View Jobs view is the default view of SHM application. In this view, users can view jobs already created, see detailed information about jobs, start and delete jobs. Select Jobs tab to view the list of jobs in an expandable list as shown in Figure 15.

Figure 15

Jobs View

Name

1/1553-CNA 403 2428 Uen H | 2014-10-10

displays job names. Jobs can be expanded to see the subjobs, which can be further expanded.

19

SHM, Software Hardware Manager, User Guide

Type

shows type in the following format: . The type can be ECIM Create Upgrade Package, ECIM Prepare, ECIM Verify, ECIM Activate, ECIM Confirm, ECIM Rollback, Local, Complex Prepare, Activate, Parallel, Upgrade, Sequential.

Managed Element lists managed element names, on which the job is running. Created by

displays name of the user who created the job.

Progress

indicates status of the progress graphically by a progress bar and a percentage number. Note:

Progress information is not available for a scheduled job but it is available for its subjobs.

Status

can be NOT_STARTED, RUNNING, WAITING, RUNNING_WAITING, SCHEDULED, CANCELLED or FINISHED.

Result

displays icons to show the result of the job. Hold the cursor on the icon to see the meaning of the icon. The results can be either of the following: •

success

•

failed

•

unknown

•

warnings

Start Time

is the time the job is started.

End Time

is the time the job ends.

icon at header to arrange the data in ascending In Jobs table, you can use or descending order as shown in Figure 15. Under the job list table, two tabs are displayed: Report and Detailed Info. Select a job and click on a tab to get further details on the job. The Report tab gives the Date, Managed Element , Type and Message about progress steps logged in the system as shown in Figure 15. The Detailed Info tab gives the following information about the selected job as shown in Figure 16:

20

•

Name

•

Created By

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

•

Progress

•

Start Time

•

End Time

•

Granularity

•

Status

•

Result

•

Type

•

ME FDN

Figure 16

Jobs View with Detailed info Tab

Under Value, information is displayed about the following Key elements: •

Name

•

Created By

•

Progress

•

Start Time

•

End Time

•

Granularity

•

Status

•

Result

•

Type

•

ME FDN

1/1553-CNA 403 2428 Uen H | 2014-10-10

21

SHM, Software Hardware Manager, User Guide

3.2.2.1

Job Filtering Users can filter jobs based on different options. The job filtering window is visible on the left side of the Jobs view. Jobs can be filtered on the basis of:

3.2.2.1.1

•

Job

•

Criteria

•

Result

•

Time

•

State

•

User

Job Jobs are filtered based on type. The options are: •

Upgrade Jobs

•

Backup Jobs

To see upgrade jobs, check Upgrade Jobs and click Filter. All upgrade jobs are displayed in the view.

Figure 17

Job Filtering by Upgrade Jobs

Similarly to view backup jobs, check Backup Jobs. At a time, users can select more than one option for filtering jobs based on Job type. 3.2.2.1.2

Criteria Jobs are filtered based on their name. Enter name of job in text box and click Filter. All jobs which have the entered text in their Name get displayed. For

22

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

example, as shown in Page 23, the entered job name is Remove. When Filter is clicked, jobs are displayed as shown. The job result has the text Remove in its name and is hence displayed. Note:

This option is case-sensitive.

Figure 18 3.2.2.1.3

Filtering Jobs by name

Result Jobs are filtered based on their result. The options are: •

SUCCESS

•

FAIL

•

WARNINGS

•

UNKNOWN

To see jobs with result SUCCESS, check SUCCESS and click Filter. All successful jobs are displayed in the view.

1/1553-CNA 403 2428 Uen H | 2014-10-10

23

SHM, Software Hardware Manager, User Guide

Figure 19

Filtering Jobs by Result

Similarly to view jobs with result FAIL, check FAIL and so on for other options. At a time, users can select more than one option for filtering jobs based on Result. 3.2.2.1.4

Filter Subjobs Users can filter subjobs using this option. This option is enabled only when a Criteria is given and a Result option is selected. Enter job name under Criteria and check option under Result. Click Filter. Jobs with entered job name and subjobs with checked result are displayed. For example, as shown in Page 24, job name entered is TestJob and result checked is FAIL. When Filter is clicked, jobs with TestJob text in their name and failed subjobs are displayed.

Figure 20

24

Filtering Subjobs by Job name and Result

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.2.1.5

State Jobs are filtered based on their state. The options are: •

NOT_STARTED

•

RUNNING

•

WAITING

•

FINISHED

•

RUNNING_WAITING

•

SCHEDULED

To see scheduled jobs, check SCHEDULED and click Filter. All jobs in SCHEDULED state are displayed in the view.

Figure 21

Job Filtering by State

Similarly to view jobs that have not started, check NOT_STARTED and so on for other options. At a time, users can select more than one option for filtering jobs based on State. 3.2.2.1.6

Time Jobs are filtered based on the time at which they start. The options are: •

Any Time

•

Past Hour

•

Past 24 Hour

•

Past 2 Days

•

Past Week

1/1553-CNA 403 2428 Uen H | 2014-10-10

25

SHM, Software Hardware Manager, User Guide

To see jobs started in the past week, select Past Week and click Filter. All jobs started in the last one week are displayed.

Figure 22

Job Filtering by Time

Similarly select Any Time to view all jobs and so on for other options. At a time, users can select only one option for filtering jobs based on Time. 3.2.2.1.7

User Jobs are filtered to display only those jobs created by the user who is currently logged in. Check My Jobs and click Filter. All jobs created by user are displayed in the view.

Figure 23

26

Job Filtering by User

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.2.2

Housekeeping of Jobs Housekeeping of jobs is a feature that enables SHM application to automatically delete non-periodic jobs that are older than 60 days. Housekeeping operation runs on every Saturday 12.00 A.M. This can be changed in following path: /opt/ericsson/nms_shm/properties/ScheduledConfigration.p roperties The content of this file is as follows: jobs=id:NA|purpose:HouseKeeping of Jobs|name:NA|Owner:NA|s cheduleState:NA|type:RECURRING|createTime:NA|JobList:NA|st artTime:NA|endTime:NA|dayOfWeek:Sat|dayOfMonth:*|year:2013 |hours:0|aged:60|seconds:0|minutes:0|month:* The following parameters are required from above file for housekeeping of jobs: purpose, dayOfWeek, year, hours, aged, seconds, minutes and month Note:

3.2.2.3

•

After the property file is modified, restart the glassfish server to reflect the changes.

•

At the time of initial installation of SHM package, the scheduler configuration properties are reset to original values.

Clone Job User can clone finished upgrade jobs. In Jobs view, every upgrade job has a clone job button. To clone a job, follow the given steps: 1. Go to Jobs tab. 2. Click clone job button for the job to be cloned.

3. A Confirmation dialog box opens. Click Yes to proceed.

1/1553-CNA 403 2428 Uen H | 2014-10-10

27

SHM, Software Hardware Manager, User Guide

4. The page redirects to Upgrade page and Job Name is displayed as Copy-Job Name. This job name is the name given to the upgrade job while creating it. Users can edit the name here.

5. The ME(s) for which the original upgrade job was performed is selected by default under Selected Managed Elements table. Users can select more MEs from the topology tree. 6. The upgrade package with which the original upgrade job was performed is selected by default under Select Upgrade Package in OSS table. If required, users can select a different package.

28

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

7. Click Start button. 8. A Scheduler dialog box opens which allows user to schedule the job. Select the required option and click Ok. To know how to schedule a job, refer to Section 3.2.2.7 on page 31.

9. The page redirects to Jobs view where new clone job is created.

1/1553-CNA 403 2428 Uen H | 2014-10-10

29

SHM, Software Hardware Manager, User Guide

3.2.2.4

Refresh Job Users can refresh running jobs. In Jobs view, refresh icon is available for all jobs but is enabled only for jobs in RUNNING state as seen in Figure 24.

Figure 24

Refresh Job

To refresh a job, click refresh icon. A Confirmation dialog box opens. Click Yes to continue. For jobs with 0% progress, the status is changed to Finished and the result is Failed. For jobs with more than 0% progress, state of the node is read and job status and result is updated accordingly. 3.2.2.5

Delete Job Users can delete jobs manually. Deletion is possible for finished jobs and jobs that have not started. A trash bin icon is visible for top level jobs and the icon is activated for jobs that are in FINISHED or NOT_STARTED state.

Figure 25

Job List with Delete (Trash Bin) Icons

Click the trash bin icon to delete a job. When top level jobs are deleted, all their subjobs are also deleted.

30

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.2.6

Cancel Job for Backup and Restore Users can perform cancel current action of backup and restore

3.2.2.7

Job Scheduling Users can schedule upgrade and backup jobs to start immediately, manually and periodically. In this section, a prepare upgrade job is scheduled by following the given steps: 1. Click Upgrade view. 2. Select an ME from the topology tree. 3. In the Job name text box, enter the job name, or default name is displayed. 4. Select the Prepare upgrade option. 5. Select the package from Select Upgrade Package table in main view and click Start. The Scheduler dialog box opens and the following options are displayed: •

Start Immediately

•

Start Manually

•

Date and Time

Figure 26 3.2.2.7.1

Scheduler dialog box

Start Immediately To start a job immediately, follow the given steps:

1/1553-CNA 403 2428 Uen H | 2014-10-10

31

SHM, Software Hardware Manager, User Guide

1. Select Start Immediately from the Scheduler dialog box. Click OK.

2. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where a new job is created.

Figure 27 3.2.2.7.2

Jobs view when a job is started immediately

Start Manually To start a job manually, follow the given steps: 1. Select Start Manually from the Scheduler dialog box and click Ok.

32

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

2. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where a new job is created. The job status is displayed as WAITING. 3. Start the job by clicking the play icon.

Figure 28 3.2.2.7.3

Jobs view when a job is started manually

Date and Time To start a job at a specific time, follow the given steps: 1. Select Date and Time option in Scheduler dialog box.

1/1553-CNA 403 2428 Uen H | 2014-10-10

33

SHM, Software Hardware Manager, User Guide

2. Click the calendar icon and select the date on which job should be started.

3. Edit the default time to the time at which the job should be started. Note that the default time zone cannot be edited. 4. Do not check Repeat . Click OK. 5. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the new job is created. The job status is displayed as SCHEDULED and it will start automatically on the mentioned date and time.

34

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 29

Jobs view when job is scheduled to start on specified date and time

Repeating a job: When Date and Time option is selected, users have the option to repeat the job. Check Repeat and the following options are displayed as shown in Figure 30: •

Daily

•

Weekly

•

Monthly

Daily: This option is selected by default. Users can schedule the jobs to repeat on a daily basis by following given steps: 1. Select Daily from the Scheduler dialog box. 2. Enter the number of days after which the job should be repeated in Every Day(s) text box. For example, every 2 days.

1/1553-CNA 403 2428 Uen H | 2014-10-10

35

SHM, Software Hardware Manager, User Guide

Figure 30

Select Date and Time option with Repeat

Weekly: Users can schedule the job to repeat on a weekly basis by following given steps: 1. Select Weekly from the Scheduler dialog box. 2. Check the day(s) on which the job should be repeated.

36

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 31

Select Weekly option

Monthly: Users can schedule the job to repeat on a monthly basis, by following given steps: 1. Select Monthly from the Scheduler dialog box. 2. Select the number of months after which the job should be repeated from drop down.

1/1553-CNA 403 2428 Uen H | 2014-10-10

37

SHM, Software Hardware Manager, User Guide

Figure 32

Select Monthly option

Ending a Job: Users will have the following options to end the job: •

Never

•

After

•

On

Never: This option is selected by default. Users can schedule a job to never end by following given steps: 1. Select Never from the Scheduler dialog box and click Ok.

38

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

2. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the new job is created. The job status is displayed as SCHEDULED and it will start automatically on the mentioned date and time as shown in Figure 29. After: Users can schedule the job to end after a certain number of occurrences by following the given steps: 1. Select After. Enter the number of occurrences after which the job must end in Occurrence(s) text box and click Ok.

1/1553-CNA 403 2428 Uen H | 2014-10-10

39

SHM, Software Hardware Manager, User Guide

2. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the new job is created. The job status is displayed as SCHEDULED and it will start automatically on the mentioned date and time as shown in Figure 29. On: Users can schedule to end the job on a particular date and time by following the given steps: 1. Select On and click the calendar icon.

40

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

2. Select the date on which job should end. 3. Edit the default time to the time at which the job should end and click Ok. 4. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the new job is created. The job status is displayed as SCHEDULED and it will start automatically on the mentioned date and time as shown in Figure 29.

3.2.3

Inventory View Select Inventory tab in main view to open inventory view. In this view, Hardware, Software, Upgrade Packages and Backup tabs are available.

3.2.3.1

Hardware Inventory The Hardware Inventory view displays hardware inventory for one or more Managed Elements. Click Hardware tab to open this view. Select a managed

1/1553-CNA 403 2428 Uen H | 2014-10-10

41

SHM, Software Hardware Manager, User Guide

element from topology tree and it becomes visible in the view. User can also select multiple managed elements from the topology tree. The MEs are displayed in an expandable hierarchical form. As shown in this view, the following properties of an ME are displayed: • •

Managed Element Type

•

Release

•

Site

•

Connection Status

•

Synchronization Status

Figure 33

Hardware Inventory View

Click More info to see more properties in the Managed Element Details dialog box. The properties are:

42

•

Source Type

•

Vendor Name

•

DN Prefix

•

Site Reference

•

Synchronization Status

•

Managed Element ID

•

Managed By

•

Time Zone

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

•

Location Name

•

Managed Element Type

•

User Label

•

User Defined State

•

Managed Element Id

•

Connection Status

•

Mirror Release

•

Date-Time Offset

•

Site Location

•

Release

•

Local Date-Time

•

Hardware Version

Expand the MEs to see the HW versions. The following properties of the HW versions are displayed: •

Product Name

•

Product Number

•

Product Revision

•

State

Figure 34

Hardware Versions

Click More info to see the HW version details in the HW Version details dialog box. The properties are:

1/1553-CNA 403 2428 Uen H | 2014-10-10

43

SHM, Software Hardware Manager, User Guide

•

Product name

•

User Label

•

Description

•

Time of prepare

•

Time of deactivation

•

Status

•

Production date

•

Product number

•

Product revision

•

Product type

Expand the HW versions to see the HW items. The following properties of the HW items are displayed: •

Product Name

•

Product Number

•

Product Revision

•

State

Figure 35

Hardware Items

Click More info to see the HW item details in the HW Item details dialog box. The properties are:

44

•

Product name

•

Label

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.3.1.1

•

Description

•

Production date

•

Product number

•

Product revision

•

Product type

•

Additional information

Export Inventory Users can export hardware inventory of managed elements. The Export button is visible on the top right side of the view. To export a hardware inventory, follow the given steps: 1. Select an ME and click Export . 2. Export inventory dialog box appears with File name text box and Software inventory and Hardware inventory check boxes. By default, Hardware inventory is checked. Enter file name or default file name is displayed. Click Export.

3. A dialog box opens with options to open the file or save it. Select an option and click OK. The file opens and is saved in /tmp folder.

1/1553-CNA 403 2428 Uen H | 2014-10-10

45

SHM, Software Hardware Manager, User Guide

The export process runs in the background. As a result, the hardware inventory of selected ME becomes available in a 3gpp compliant XML file format. 3.2.3.2

Software Inventory The Software Inventory view displays software inventory for one or more Managed Elements. Click Software tab to open this view. Select a managed element from topology tree and it becomes visible in the view. User can also select multiple managed elements from the topology tree. The MEs are displayed in an expandable hierarchical form. As shown in this view, the following properties of an ME are displayed: • •

46

Managed Element Type

•

Release

•

Site

•

Connection Status

•

Synchronization Status

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 36

Software Inventory View

Click More info to see more properties in the Managed Element Details dialog box. The properties are: •

Source Type

•

Vendor Name

•

DN Prefix

•

Site Reference

•

Synchronization Status

•

Managed Element ID

•

Managed By

•

Time Zone

•

Location Name

•

Managed Element Type

•

User Label

•

User Defined State

•

Managed Element Id

•

Connection Status

•

Mirror Release

•

Date-Time Offset

•

Site Location

1/1553-CNA 403 2428 Uen H | 2014-10-10

47

SHM, Software Hardware Manager, User Guide

•

Release

•

Local Date-Time

•

Software Version

Expand the MEs to see the SW versions. The following properties of the SW versions are displayed: •

Product Name

•

Product Number

•

Product Revision

•

State

Figure 37

Software Versions

Click More info to see the SW version details in the SW Version details dialog box. The properties are:

48

•

Product name

•

User Label

•

Description

•

Time of prepare

•

Time of deactivation

•

Status

•

Production date

•

Product number

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

•

Product revision

•

Product type

Expand the SW versions to see the SW items. The following properties of the SW items are displayed: •

Product Name

•

Product Number

•

Product Revision

•

State

Figure 38

Software Items

Click More info to see the SW item details in the SW Item details dialog box. The properties are: •

Product name

•

Label

•

Description

•

Production date

•

Product number

•

Product revision

•

Product type

•

Additional information

1/1553-CNA 403 2428 Uen H | 2014-10-10

49

SHM, Software Hardware Manager, User Guide

3.2.3.2.1

Export Inventory Users can export software inventory of managed elements. The Export button is visible on the top right side of the view. To export a software inventory, follow the given steps: 1. Select an ME and click Export . 2. Export inventory dialog box appears with File name text box and Software inventory and Hardware inventory check boxes. By default, Software inventory is checked. Enter file name or default file name is displayed. Click Export.

3. A dialog box opens with options to open the file or save it. Select an option and click OK. The file opens and is saved in /tmp folder.

The export process runs in the background. As a result, the software inventory of selected ME becomes available in a 3gpp compliant XML file format.

50

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.3.3

Upgrade Packages The Upgrade Packages view displays upgrade packages for one or more Managed Elements. Click Upgrade Packages tab to open this view. Select a managed element from topology tree and it becomes visible in the view. User can also select multiple managed elements from the topology tree. The MEs are displayed in an expandable hierarchical form. For more details on upgrade, see Section 3.2.4 on page 51.

3.2.3.4

Backup The Backup view displays upgrade packages for one or more Managed Elements. Click Backup tab to open this view. Select a managed element from topology tree and it becomes visible in the view. User can also select multiple managed elements from the topology tree. The MEs are displayed in an expandable hierarchical form. For more details on backup, see Section 3.2.5 on page 71.

3.2.4

Upgrade View In this view, users can perform upgrade related functions. The remote software upgrade process has the following phases: •

Planning

•

Starting

•

Monitoring

Select Upgrade tab in the main view to open upgrade view.

Figure 39

Upgrade View

Users can set up and start the upgrade process in this view. The name of the new upgrade process is entered in the Job Name textbox.

1/1553-CNA 403 2428 Uen H | 2014-10-10

51

SHM, Software Hardware Manager, User Guide

There are three upgrade options to choose from: •

Prepare upgrade (SW download & verify) -

0 0 0 •

As a result, it is ensured that the managed element can be upgraded with the respective package. This is not a critical operation as it does not endanger the operational state of the managed element.

Activate upgrade (verify, activate & commit) -

0 0 0 0 •

The specified upgrade package is downloaded to the managed element and it is verified if the managed element can be upgraded with the selected package.

Users can activate a previously prepared upgrade package on a set of managed elements in one step. Before activation, the upgrade service also verifies if the managed element can be upgraded with the specified upgrade package. After all the activation steps are successfully completed, the commit operation is executed. The commit operation makes all the changes permanent and gives a confirmation that the upgrade procedure is complete. This process may contain critical operations such as restart, which may affect the capacity or availability of the managed element services.

Prepare and activate upgrade-

0

The prepare upgrade operation and activation steps are performed sequentially.

The Activate upgrade and Prepare and activate upgrade operations can be executed in the followings modes•

One Go

•

Step by step activation

One Go is the default mode of these operations. In this mode, the operation is executed without user interaction. The Step by step activation option is enabled only if Activate upgrade or Prepare and activate upgrade are selected. In this mode, the execution of the activation job is temporarily suspended before each activation step and before the commit operation and needs to be manually resumed. This provides users time to perform managed element specific supervision before continuing with the next activation step or confirm. The Wait for Confirm option is available in One Go mode. It is enabled only if Activate upgrade or Prepare and activate upgrade are selected. When

52

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

this option is selected, the execution of the job is suspended before confirm and needs to be manually resumed. Note:

When Step by step activation is selected, Wait for Confirm is disabled and when Wait for Confirm is selected, Step by step activation is disabled.

The Selected managed elements table contains the following information about the MEs selected from the topology tree: •

Managed Element

•

Type

•

Release

•

Status

The Select Upgrade Package in OSS table contains the upgrade packages that can be selected for the ME or MEs. The information provided about the package is as follows: •

Name

•

ME Type

•

Description

Click More info to get additional details on package. The following information are displayed: •

Name

•

Description

•

Imported by

•

Date Imported

•

Package Content

It is possible to delete upgrade packages, but only those that are in FINISHED state. For more details on deleting upgrade package go to Section 3.2.4.7 on page 69. If the user tries to delete an upgrade package that is in RUNNING, WAITING or NOT_STARTED state, an error message appears. Note: 3.2.4.1

If the file size to be imported is more than 2GB, Firefox 17 version should be used.

Import Upgrade Package Before setting up the upgrade job, users have to import the software upgrade package applicable to the selected managed element to the SHM application. To import a package, follow the given steps:

1/1553-CNA 403 2428 Uen H | 2014-10-10

53

SHM, Software Hardware Manager, User Guide

1. Click Import visible on the right hand side of the view to upload the new software package.

2. In the Import new software package dialog box, click Browse to select the upgrade package file from the desire location. Note that the upgrade package must be in a compressed zip file format.

3. Enter a short description and click Import. When the upload process is complete, the new software package is available under Select Upgrade Package table. The package can imported using a different method by following the given steps: 1. Click Upgrade packages in the tool bar. In this view, you can see the list of upgrade packages.

54

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

2. Click Import new visible on right hand top corner.

3. In the Import new software package dialog box, click Browse to select the upgrade package file from the desire location. Note that the upgrade package must be in a compressed zip file format. 4. Enter a short description and click Import. Note:

If the file size to be imported is more than 2GB, Firefox 17 version should be used.

In this view, you can also delete the imported upgrade package by following the given steps: 1. Click Upgrade packages in the tool bar. In this view, you can see the list of upgrade packages. 2. Select the package and click the trash bin at the end of the entry.

1/1553-CNA 403 2428 Uen H | 2014-10-10

55

SHM, Software Hardware Manager, User Guide

3. In the confirmation box, click delete to complete the process or cancel to stop the process.

The upgrade package is deleted. 3.2.4.2

Prepare Upgrade After importing an upgrade package, to perform a prepare operation, follow the given steps: 1. Select the managed element from topology tree. 2. In the Job name text box, enter the job name, or default name is displayed. 3. Select the Prepare upgrade option. 4. Select the package from Select Upgrade Package table in main view.

56

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

The MEs without SwM fragment are disabled and unchecked along with an icon. When the cursor is moved over the icon, a tool tip appears as “Unsupported ME”.

5. Click Start. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and click Ok. 6. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the prepare upgrade job is created. The prepare upgrade process does not require any user interaction.

1/1553-CNA 403 2428 Uen H | 2014-10-10

57

SHM, Software Hardware Manager, User Guide

Figure 40 3.2.4.3

Jobs View with Upgrade Job

Activate Upgrade The prerequisite for performing Activate is that the prepare operation should have been successfully executed on the Managed Element, that is, the upgrade package should have been downloaded and verified for the particular ME. The activate operation can be performed using one go activation or step by step activation.

3.2.4.3.1

Using One Go To perform an activate operation using one go, follow the given steps: 1. Select the managed element from topology tree. 2. In the Job name text box, enter the job name, or default name is displayed. 3. Select the Activate upgrade option. 4. Select the package from Select Upgrade Package table in main view and click Start.

58

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

5. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and click Ok. 6. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the activate upgrade job is created. This process does not require any user interaction. Users have the option to select Wait for Confirm as shown below.

In this case, the job is suspended before the confirm operation. It can be resumed by clicking the play icon. 3.2.4.3.2

Using Step by Step Activation To perform an activate operation using step by step activation, follow the given steps: 1. Select the managed element from topology tree. 2. In the Job name text box, enter the job name, or default name is displayed.

1/1553-CNA 403 2428 Uen H | 2014-10-10

59

SHM, Software Hardware Manager, User Guide

3. Select the Activate upgrade option. Check Step by Step Activation. 4. Select the package from Select Upgrade Package table in main view and click Start.

5. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and click Ok. 6. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the activate upgrade job is created. 7. Expand the upgrade job to view the subjob which can be further expanded to view the Activate and Confirm subjobs.

The Activate process has three steps- ECIM Verify and ECIM Activate. After the job starts, the verification step completes automatically without user intervention. The job is then suspended and needs to be manually resumed by clicking the play icon either at the subjob level or top level. The next subjob in sequence is executed.

60

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

The Confirm process has one step- ECIM Confirm. After the activate subjob is completed, the job is suspended and needs to be manually resumed for the confirm subjob to be executed.

8. Click the play icon to resume the process. After completion of every subjob, the process is suspended and needs to be resumed manually till the job is finished. If more than one managed element is upgraded, each managed element upgrade is handled as a separate subjob. These subjobs are executed in parallel. 3.2.4.4

Prepare and activate upgrade In this option, the prepare upgrade steps and the activation steps are executed one after the other. This operation can be performed using one go activation or step by step activation.

1/1553-CNA 403 2428 Uen H | 2014-10-10

61

SHM, Software Hardware Manager, User Guide

3.2.4.4.1

Using One Go To perform a prepare and activate operation using one go, follow the given steps: 1. Select the managed element from topology tree. 2. In the Job name text box, enter the job name, or default name is displayed. 3. Select the Prepare and activate upgrade option. 4. Select the package from Select Upgrade Package table in main view and click Start.

5. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and click Ok. 6. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the prepare and activate upgrade job is created. This process does not require any user interaction. Users have the option to select Wait for Confirm as shown below.

62

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

In this case, the job is suspended before the confirm operation. It can be resumed by clicking the play icon. 3.2.4.4.2

Using Step by Step Activation To perform a prepare and activate operation using step by step activation, follow the given steps: 1. Select the managed element on which the upgrade is to be performed, from the topology tree. 2. In the Job name text box, enter the job name, or default name is displayed. 3. Select the Prepare and activate upgrade option. Check Step by Step Activation. 4. Select the package from Select Upgrade Package table in main view and click Start.

5. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and click Ok.

1/1553-CNA 403 2428 Uen H | 2014-10-10

63

SHM, Software Hardware Manager, User Guide

6. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the prepare and activate upgrade job is created. 7. Expand the upgrade job to view the subjob which can be further expanded to view the Prepare, Activate and Confirm subjobs. After the job starts, the prepare subjob and verification step of activate subjob completes automatically without user intervention. For more information on activate and confirm subjobs, refer to Section 3.2.4.3.2 on page 59. The job is then suspended and needs to be manually resumed by clicking the play icon either at the subjob level or top level. The next subjob in sequence is executed.

8. Click the play icon to resume the process. After completion of every subjob, the process is suspended and needs to be resumed manually till the job is finished. If more than one managed element is upgraded, each managed element upgrade is handled as a separate subjob. These subjobs are executed in parallel. 3.2.4.5

Cancel Upgrade Job Upgrade jobs can be canceled in the following cases :

64

•

Prepare Upgrade job- When the job has been initiated in Jobs view. The state of the respective upgrade package is PREPARE_IN_PROGRESS in Upgrade Packages tab under Inventory view.

•

Activate Upgrade job- When the job has been initiated in Jobs view. The state of the respective upgrade package is ACTIVATION_IN_PROGRESS in Upgrade Packages tab under Inventory view.

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

•

Activate Upgrade job- When the job has been completed in Jobs view and the result is FAILED. The state of the respective upgrade package is ACTIVATION_STEP_COMPLETED in Upgrade Packages tab under Inventory view.

To cancel a job in these states, follow the given steps: •

Click on Jobs tab.

•

Expand the upgrade job to see its subjob of type sequential.

•

Click the cancel icon

of this subjob. As a result, the job details change.

1/1553-CNA 403 2428 Uen H | 2014-10-10

65

SHM, Software Hardware Manager, User Guide

Figure 41

Jobs View after Job is cancelled

In Upgrade packages view, the progress report of the package can be viewed through the More info link. Here the details displayed are: •

Action Name- Cancel

•

Progress Info- FINISHED

•

Progress Percentage- 100

•

Result- SUCCESS

•

Result Info- Upgrade process cancelled

•

State- FINISHED

Note:

3.2.4.6

When an activate job in ACTIVATION_STEP_COMPLETED state is canceled, only the status of sequential job and last subjob under activate subjob change as seen in Figure 41.

View Upgrade Packages The upgrade packages can be viewed in Upgrade Packages which can be opened by clicking Upgrade Packages tab under Inventory view. Select a managed element from topology tree and it becomes visible in the view. Users can also select multiple managed elements from the topology tree. The MEs are displayed in an expandable hierarchical form.

66

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 42

Upgrade Packages View

In this view, the following properties of an ME are displayed: •

Managed Element

•

Type

•

Release

•

Site

•

Connection Status

•

Synchronization Status

Click More info to see more properties in the Managed Element Details dialog box. The properties are: •

Source Type

•

Vendor Name

•

DN Prefix

•

Site Reference

•

Synchronization Status

•

Managed By

•

Time Zone

•

Location Name

•

Managed Element Type

•

User Label

1/1553-CNA 403 2428 Uen H | 2014-10-10

67

SHM, Software Hardware Manager, User Guide

•

User Defined State

•

Managed Element Id

•

Connection Status

•

Mirror Release

•

Date Time offset

•

Site Location

•

Release

•

Local Date-Time

•

Software Version

Expand the MEs to see their upgrade packages. The following properties of the package are displayed: •

Id

•

Name

•

State

•

Date Created

Figure 43

Upgrade Packages of selected ME

Click More info to see the package details in the Upgrade Package details dialog box. The details are:

68

•

User label

•

Upgrade Package ID

•

State

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

•

Created

•

URI

•

Ignore Break points

•

Administrative Product Data

•

Activation Steps

•

Progress Report

Activation Steps, Progress Report are in collapse mode by default. Expand Activation Steps, Progress Report for more information. The properties displayed rare: Activation Steps •

Serial Number

•

Name

•

Description

Progress Report •

Action Id

•

Action Name

•

Progress Info

•

Progress Percentage

•

Result

•

Result Info

•

State

•

Action Started

•

Action Completed

•

Last Status Update

•

Additional Information

By default, the upgrade packages are sorted by Date Created. They can also be sorted based on State, Name and Id by clicking on the icon beside the column.

1/1553-CNA 403 2428 Uen H | 2014-10-10

69

SHM, Software Hardware Manager, User Guide

3.2.4.7

Delete Upgrade Packages In the Upgrade Packages view, upgrade packages which are in finished state can be deleted. The upgrade packages for each selected ME are displayed in an expandable hierarchical view with check boxes for ME and corresponding upgrade packages. To delete an upgrade package, follow the given steps: 1. Select the package to be deleted. When a managed element is checked, all the upgrade packages for that managed element are automatically selected.

If no package is selected, the Delete Upgrade Packages button is disabled.

2. Click Delete Upgrade Packages which is visible on the top right side of the view. 3. A Delete Upgrade Packages dialog box opens. Enter job name or default name is displayed.

70

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

4. If you check Run in Background and click Ok, package is deleted and the page is refreshed. 5. If you do not check Run in Background and click Ok, the view is redirected to the Jobs view where the new job is created.

The Upgrade Packages view refreshes automatically to get latest upgrade packages for the selected ME.

3.2.5

Backup View In this view, users can perform backup related functions. Select Backup tab in the main view to open backup view.

1/1553-CNA 403 2428 Uen H | 2014-10-10

71

SHM, Software Hardware Manager, User Guide

Figure 44

Backup View

Users can set up and start the backup process in this view. The description of the new backup process is entered in the Job Description textbox. The name of the new backup process is entered in the Backup Name textbox. The Selected managed elements table contains the following information about the MEs selected from the topology tree: •

Managed Element

•

Type

•

Release

•

Status

The Domain and Type of Backup table contains the domain and type attributes of all MEs selected in the topology tree. 3.2.5.1

Create Backup Users can create a backup by following the given steps: 1. Select MEs for which backup has to be created from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed. 3. Select the domain and type of backup from Domain and Type of Backup table.

72

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. 4. Uncheck the MEs with red icon to enable start button and click Start. 5. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and click Ok. Do not check the Export option. 6. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the new job is created.

Figure 45

Jobs View with Create Backup Job

1/1553-CNA 403 2428 Uen H | 2014-10-10

73

SHM, Software Hardware Manager, User Guide

Note:

3.2.5.2

The Create Backup job can fail due to following conditions: •

If the user does not have permission to access the selected ME, the security log gets updated with the message “Error during Get BackupDomain and BackupType for Create Backup: the user does not have permission to perform OSS_ACCESS_NE activity for given target”.

•

If the user does not have permission to create backups on given MEs, the security log is updated with the message ”Error during Create Backup for MEs: the user does not have permission to perform 'Create Backup' activity for given target”.

•

If the backup name is duplicate for the given ME, the backup subjob fails with system event log.

Create and Export Backup Users can create and export backup by following the given steps: 1. Select MEs for which backup has to be created from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed. 3. Select the domain and type of backup from Domain and Type of Backup table. If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. Uncheck the MEs with red icon to enable start button. 4. Click Start. 5. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and check Export to OSS. Click Ok.

74

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Note:

The Export to OSS checkbox is only available in the Scheduler dialog box which opens on starting a create backup job.

6. In the Confirmation dialog box, click Yes. Exported Backup is stored at /var/opt/ericsson/smrsstore/CORE/ CommonPersistent/Backup// The view is redirected to Jobs view where the new job is created. Expand the backup job to view the subjob which can be further expanded to view the Create and Export subjobs.

Figure 46 3.2.5.3

Jobs View with Create and Export Backup Job

Create, Export and Delete Backup Users can create and export backup to an external location by following the given steps. After the export process, the original backup on the node is deleted: 1. Select MEs for which backup has to be created from topology tree.

1/1553-CNA 403 2428 Uen H | 2014-10-10

75

SHM, Software Hardware Manager, User Guide

The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed. 3. Select the domain and type of backup from Domain and Type of Backup table. If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. Uncheck the MEs with red icon to enable start button. 4. Click Start. 5. The Scheduler dialog box opens. To know how to schedule a job, refer to Section 3.2.2.7 on page 31. Select the desired option and check Export to OSS and Delete Original. Click Ok.

Note:

The Export to OSS and Delete Original checkboxes are available only in the Scheduler dialog box which opens on starting a create backup job.

6. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the new job is created. Expand the backup job to view the subjob which can be further expanded to view the Create, Export and Delete subjobs.

76

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 47 3.2.5.4

Jobs View with Create, Export and Delete original Backup Job

Configure Scheduling of Backup on Node Users can configure scheduling of backup on a node with version higher than 2.1. This scheduling is of the following three types:

3.2.5.4.1

•

Single Event on node

•

Periodic Event on node

•

Calender based Periodic Event on node

Single Event on node Follow the given steps to configure scheduling of single event on node: 1. Select MEs for which backup has to be created from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed. 3. Select Configure Scheduling on Node option. 4. Select the domain and type of backup from Domain and Type of Backup table.

1/1553-CNA 403 2428 Uen H | 2014-10-10

77

SHM, Software Hardware Manager, User Guide

If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. 5. Uncheck the MEs with red icon to enable start button and click Start. 6. The Scheduler on Node dialog box opens. The Date and Time option is selected by default. Click the calendar icon and select the date on which the job should be started. 7. Edit the default time to the time at which the job should be started. Note that the default time zone cannot be edited. Click Ok.

8. In the Confirmation dialog box, click Yes. The view is redirected to Jobs view where the new job is created.

78

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 48 3.2.5.4.2

Jobs View with Configure Scheduler Backup Job

Periodic Event on node Users can configure scheduling for the following types of periodic events: •

Hourly

•

Weekly

•

Daily

•

Monthly

To configure scheduling for periodic events, follow the given steps: 1. Select MEs for which backup has to be created from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed. 3. Select Configure Scheduling on Node option. 4. Select the domain and type of backup from Domain and Type of Backup table.

1/1553-CNA 403 2428 Uen H | 2014-10-10

79

SHM, Software Hardware Manager, User Guide

If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. 5. Uncheck the MEs with red icon to enable start button and click Start. 6. The Scheduler on Node dialog box opens. The Date and Time option is selected by default. Click the calendar icon and select the date on which the job should be started. 7. Edit the default time to the time at which the job should be started. Note that the default time zone cannot be edited.

8. Check Repeat. When Repeat is checked, the following options are displayed:

80

•

Hourly

•

Daily

•

Weekly

•

Monthly

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 49

Scheduler On Node dialog box with Repeat option checked

Hourly: This option is selected by default. Users can schedule the jobs to repeat on an hourly basis by following the given steps: 1. Enter the number of hours after which the job should be repeated in Every Hours text box. For example, every two hours.

2. Click Ends. 3. Click the calendar icon and select the date on which the job should be ended.

1/1553-CNA 403 2428 Uen H | 2014-10-10

81

SHM, Software Hardware Manager, User Guide

4. Edit the default time to the time at which the job should be ended. Note:

The default end date and time is last date and time of the century.

5. Click Ok. The view is redirected to Jobs view where the new job is created. Daily: Users can schedule the jobs to repeat on a daily basis by following given steps: 1. Select Daily from the Scheduler On Node dialog box. 2. Enter the number of days after which the job should be repeated in Every Day(s) text box. For example, every two days.

82

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3. Click Ends. 4. Click the calendar icon and select the date on which the job should be ended. 5. Edit the default time to the time at which the job should be ended. Note:

The default end date and time is last date and time of the century.

6. Click Ok. The view is redirected to Jobs view where the new job is created. Weekly with selection of Every Week(s) option: Users can schedule the jobs to repeat on a weekly basis by following given steps: 1. Select Weekly from the Scheduler On Node dialog box.

1/1553-CNA 403 2428 Uen H | 2014-10-10

83

SHM, Software Hardware Manager, User Guide

2. Select Every Week(s) option.

3. Enter the number of weeks after which the job should be repeated in Every Week(s) text box. For example, every three weeks.

4. Click Ends.

84

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

5. Click the calendar icon and select the date on which the job should be ended. 6. Edit the default time to the time at which the job should be ended. Note:

The default end date and time is last date and time of the century.

7. Click Ok. The view is redirected to Jobs view where the new job is created. Weekly with selection of day option: Users can schedule the jobs to repeat on a weekly basis by following given steps: 1. Select Weekly from the Scheduler On Node dialog box. 2. Check the day(s) on which the job should be repeated. 3. Set the time at which the job should start in Hour(s), Minute(s) and Second(s).

4. Click Ends. 5. Click the calendar icon and select the date on which the job should be ended. 6. Edit the default time to the time at which the job should be ended. Note:

The default end date and time is last date and time of the century.

1/1553-CNA 403 2428 Uen H | 2014-10-10

85

SHM, Software Hardware Manager, User Guide

7. Click Ok. The view is redirected to Jobs view where the new job is created. Monthly: Users can schedule the job to repeat on a monthly basis, by following given steps: 1. Select Monthly from the Scheduler On Node dialog box. 2. Select Every Month(s) option. 3. Enter the number of months after which the job should be repeated in Every Month(s) text box. For example, every six months.

4. Click Ends. 5. Click the calendar icon and select the date on which the job should be ended. 6. Edit the default time to the time at which the job should be ended. Note:

The default end date and time is last date and time of the century.

7. Click Ok. The view is redirected to Jobs view where the new job is created.

86

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Monthly with selection of Day of every Month(s) option: Users can schedule the job to repeat on a monthly basis, by following given steps: 1. Select Monthly from the Scheduler On Node dialog box. 2. Select Day of every Month(s) option. 3. Select the day and number of months in which the job should be repeated. For example, every ninth day of every three months. 4. Set the time at which the job should start in Hour(s), Minute(s) and Second(s).

5. Click Ends. 6. Click the calendar icon and select the date on which the job should be ended. 7. Edit the default time to the time at which the job should be ended. Note:

The default end date and time is last date and time of the century.

The view is redirected to Jobs view where the new job is created. Monthly with selection of The of every Month(s) option: Users can schedule the job to repeat on a monthly basis, by following given steps: 1. Select Monthly from the Scheduler On Node dialog box.

1/1553-CNA 403 2428 Uen H | 2014-10-10

87

SHM, Software Hardware Manager, User Guide

2. Select The of every Month(s) option. 3. Select the day of the week and number of months in which the job should be repeated. For example, every third monday of every three months. 4. Set the time at which the job should start in Hour(s), Minute(s) and Second(s).

5. Click Ends. 6. Click the calendar icon and select the date on which the job should be ended. 7. Edit the default time to the time at which the job should be ended. Note:

The default end date and time is last date and time of the century.

The view is redirected to Jobs view where the new job is created. Note:

Scheduled back up will be create according to the time on Node.

Example 1

Scheduled Back Up

In the GUI if the Schedule backup is configured to create backup at 21-07-2014 10:00 AM and if the Node also has same time then backup will be created at the scheduled time. If the time difference is there between the GUI and Node time, scheduled backup will be created +/- hour difference of scheduled time.

88

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.5.5

View Backup Schedule on Node The scheduling of backups can be viewed in View Schedules which can be opened by clicking View Schedules tab under Backup view. Select a managed element from topology tree and it becomes visible in the view. Users can also select multiple managed elements from the topology tree.

Figure 50

View Backup Schedule on Node

In this view, the following properties of an ME are displayed: •

Managed Element

•

Type

•

Admin State

•

Auto Export

•

Next Scheduled Time

•

Scheduler State

•

Max Stored Scheduled Backups

Click More info to see more properties in the Managed Element Scheduler Event Details dialog box. The Scheduler Events categorized in three sections as mentioned below: •

Calendar Based Periodic Events

•

Periodic Events

•

Single Scheduled Events

Click on ">" to see more properties in the Calendar Based Periodic Events. The properties are :

1/1553-CNA 403 2428 Uen H | 2014-10-10

89

SHM, Software Hardware Manager, User Guide

Figure 51

Calendar Based Periodic Events

•

EventId

•

DayOfMonth

•

DayOfWeek

•

DayOfWeekOccurence

•

Month

•

Start Time

•

Stop Time

•

Scheduled Time

Click on ">" to see more properties in the Periodic Events. The properties are :

Figure 52 •

90

Periodic Events

EventId

•

No Of Days To Repeat

•

No Of Hours To Repeat

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

•

No Of Minutes To Repeat

•

No Of Months To Repeat

•

No Of Weeks To Repeat

•

Start Time

•

Stop Time

Click on ">" to see more properties in the Single Scheduled Events. The properties are :

Figure 53

3.2.5.6

Single Scheduled Events

•

EventId

•

Scheduled Time

Configure Housekeeping on Node Users can configure housekeeping of backups on nodes with versions higher than 2.1 by following the given steps: 1. Select MEs for which backup has to be created from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Select Configure Housekeeping on Node option. After selecting Configure Housekeeping on Node , Backup Name disappears. 3. Enter the Job Descriptionor else default values are displayed. 4. Select the domain and type of backup from Domain and Type of Backup table.

1/1553-CNA 403 2428 Uen H | 2014-10-10

91

SHM, Software Hardware Manager, User Guide

If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. 5. Uncheck the MEs with red icon to enable start button and click Start. 6. The Housekeeping On Node dialog box opens.

7. If AutoDelete is ON, and the number of backups already stored on the ME is equal to the value of MaxStoredManualBackups, then the oldest backup will be removed before creating a new one. 8. If AutoDelete is OFF, no backup will be removed and instead the invocation of createBackup() action will return failure. 9. The value of MaxStoredManualBackups can be a maximum of 100. It is the maximum number of manual backups (per backup type) that are stored store in the ME. When this limit is reached, if AutoDelete is ON, BrM removes the oldest manual backup before creating a new one; otherwise, an error is returned when createBackup() is invoked and the NSS must do the required housekeeping before attempting to create a new backup. 10. Click Ok.

92

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

11. In the Confirmation dialog box, click Yes. Once the attributes are successfully configured on the node, a success message appears.

Figure 54 3.2.5.7

Success Message

Resume Backup Users can resume a backup on nodes for version 2.1or above by following the given steps: 1. Select MEs on which backup has to be resumed from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed. 3. Select the domain and type of backup from Domain and Type of Backup table. If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. 4. Uncheck the MEs with red icon to enable start button. 5. Select Configure Scheduling on Node.

1/1553-CNA 403 2428 Uen H | 2014-10-10

93

SHM, Software Hardware Manager, User Guide

6. Click Start. 7. The Scheduler dialog box opens. Check Edit Scheduled Configuration Information. When this option is checked, the date and time radio button will be unselected. 8. In Admin State drop down select ON and click Ok.

94

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

9. In the Confirmation dialog box, click Yes. Once the attributes are successfully configured on the node, a success message appears. 3.2.5.8

Suspend Backup Users can suspend a backup on nodes for version l2.1 and above by following the given steps: 1. Select MEs on which backup has to be suspended from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed.

1/1553-CNA 403 2428 Uen H | 2014-10-10

95

SHM, Software Hardware Manager, User Guide

3. Select the domain and type of backup from Domain and Type of Backup table. If the selected domain and backup type is incompatible for an ME, then a red icon is displayed beside that ME. 4. Uncheck the MEs with red icon to enable start button. 5. Select Configure Scheduling on Node.

6. Click Start. 7. The Scheduler dialog box opens. Check Edit Scheduled Configuration Information. When this option is checked, the Date and Time is unselected. 8. In Admin State drop down, select OFF and click Ok.

96

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

9. In the Confirmation dialog box, click Yes. Once the attributes are successfully configured on the node, a success message appears. 3.2.5.9

Auto Export Users can auto export a scheduler backup to external location once the scheduler triggered on node for BrM version 3.1or above 1. Select MEs on which backup has to be resumed from topology tree. The selected ME is displayed in Selected Managed Elements table. If a gray icon is displayed beside an ME, then backup cannot be created for that ME and the Start button is disabled. 2. Enter the Job Description and the Backup Name or else default values are displayed.

1/1553-CNA 403 2428 Uen H | 2014-10-10

97

SHM, Software Hardware Manager, User Guide

3. Select the domain and type of backup from Domain and Type of Backup table. 4. Uncheck the MEs with red icon to enable start button 5. Select Configure Scheduling on Node.

6. Click Start. 7. The Scheduler dialog box opens. Check Edit Scheduled Configuration Information. When this option is checked, the date and time radio button will be unselected. 8. In AutoExport drop down select ENABLE and click OK.

9. In the Confirmation dialog box, click Yes. Once the attributes are successfully configured on the node, a success message appears. 3.2.5.10

View Backup The backups can be viewed in Backup which can be opened by clicking Backup tab under Inventory view. Select a managed element from topology tree and it becomes visible in the view. Users can also select multiple managed elements from the topology tree. The MEs are displayed in an expandable hierarchical form.

98

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 55

Backup Inventory View

In this view, the following properties of an ME are displayed: •

Managed Element

•

Type

•

Release

•

Site

•

Connection Status

•

Synchronization Status

Click More info to see more properties in the Managed Element Details dialog box. The properties are: •

getPropertiesSuccess

•

Managed Element Id

•

Dn Prefix

•

Connection Status

•

Date-Time Offset

•

mirrorRelease

•

Synchronization Status

•

Time Zone

•

Managed Element Type

•

Site Location

•

Release

•

User Label

1/1553-CNA 403 2428 Uen H | 2014-10-10

99

SHM, Software Hardware Manager, User Guide

Expand the MEs to see their backup packages. The properties displayed are: •

Backup Name

•

Domain/Type

•

Create Time

•

Created By

Figure 56

Backups on Selected Managed Elements

Click More info to see the package details in the Backup details dialog box as shown in. The details are: •

Backup Id

•

Backup Name

•

Backup Type

•

Backup Domain

•

Status

•

Created Time

•

Created By

•

Creation Type

•

Creator Job Id

The backup dialog box also contains Progress Report. Expand Progress Report to see the following properties.

100

•

Action Id

•

Action Name

•

Progress Info

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.5.11

•

Progress Percentage

•

Result

•

State

•

Action Started Time

•

Action Completed Time

•

Last Status Updated Time

•

Additional Info

Export Backup Backups can be exported in Backup tab in Inventory view. The backups for each selected ME are displayed in an expandable hierarchical view with check boxes for ME and corresponding backups. To export a backup, follow the given steps: 1. Select the backup to be exported. User can select multiple backups and backups from multiple managed elements. When a managed element is checked, all the backups for that managed element are automatically selected.

2. Click Export to OSS which is visible on the top right side of the view.

1/1553-CNA 403 2428 Uen H | 2014-10-10

101

SHM, Software Hardware Manager, User Guide

Note:

The Export to OSS button is disabled in the following cases: •

If no backup is selected.

•

If the BRM version of the selected backup is less than 3.0.

3. An Export Backup Inventory dialog box opens. Enter job name or default name is displayed.

4. If you check Run in Background and click Ok, the job runs in the background and backup is exported to external location. 5. If you do not check Run in Background and click Ok, the view is redirected to the Jobs view where the new job is created.

102

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

Figure 57

Jobs view with Export Backup job

User can view status of export process in Backup tab in Inventory view. Click More info link of the backup and view status under Progress Report.

Figure 58 3.2.5.12

Progress Report of Exported Backup

View Backup Exported to OSS The exported backups can be viewed in Backup which can be opened by clicking Backup tab under Inventory view. Select a managed element from topology tree and it becomes visible in the view. Users can also select multiple managed elements from the topology tree. The MEs are displayed in an expandable hierarchical form. Select Backup on OSS as shown in following figure.

1/1553-CNA 403 2428 Uen H | 2014-10-10

103

SHM, Software Hardware Manager, User Guide

Figure 59

Backup Inventory View

Expand the MEs to see their backup packages. The properties displayed are: •

Backup Name

•

Domain/Type

•

Created Time

•

Export Time

Figure 60 3.2.5.13

Backups on OSS of Selected Managed Elements

View backup label stored information on ME User can perform a disclosure action on the backup history of a node to view label store details for 3.1 Version.

3.2.5.13.1

Opening Managed Element Details for 3.1 Version 1. Open the SHM application. 2. Navigate to the Inventory tab.

104

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3. Navigate to Backup from the Inventory. 4. Select a node with version 3.1 from the topology. 5. Click on the more info link in the backup tab for Managed Element Details dialog box to pop up. 6. Click on the backup history disclosure. All domain/type related to the node will be displayed in disclosure form 7. Click on the domain/type disclosure. Label store attributes are displayed along with the values.

Figure 61 Note: 3.2.5.13.2

Backup History

Backup history disclosure is not displayed for versions less than 3.1.

Label Store Attributes The Label store attributes are:

3.2.5.14

•

Last created backup: The name of the last created backup

•

Last Exported Backup: The name of the last exported backup from the ME

•

Last Imported backup: The name of the last imported backup to the ME.

•

Last restored Backup: The name of the backup that has been last used to restore the ME

•

Restore Escalation List: The list really contains three slots: last system created backup, post upgrade backup, pre upgrade backup. Immediately after the upgrade, the last system created backup is also the post upgrade backup. But when scheduled backup is enabled, the last created backup would soon be replaced by a more fresh backup.

Import Backup Backups from an external location can be imported onto the node. This can be done in Backup tab in Inventory view.

1/1553-CNA 403 2428 Uen H | 2014-10-10

105

SHM, Software Hardware Manager, User Guide

The backups for each selected ME are displayed in an expandable hierarchical view with check boxes for ME and corresponding backups. To import a backup, follow the given steps: 1. 1. Select Backups on OSS from the drop down list. 2. Select the backup to be imported. User can select multiple backups and backups from multiple managed elements. When a managed element is checked, all the backups for that managed element are automatically selected.

3. Click Import which is visible on the top right side of the view.

Note:

The Import button is disabled in the following cases: •

If no backup is selected.

•

If the BRM version of the selected backup is less than 3.0.

•

If Backups on OSS is not selected from the drop down list.

4. An Import to OSS dialog box opens. Do not check the available check boxes. Click Start.

106

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

5. The view is redirected to the Jobs view where the new job is created.

Figure 62 3.2.5.15

Jobs view with Import Backup job

Import and Restore Backup Backups from an external location can be imported and restored onto the node. This can be done in Backup tab in Inventory view. The backups for each selected ME are displayed in an expandable hierarchical view with check boxes for ME and corresponding backups. To import and restore a backup, follow the given steps: 1. 1. Select Backups on OSS from the drop down list. 2. Select the backup to be imported and restored. User can select multiple backups and backups from multiple managed elements. When a managed element is checked, all the backups for that managed element are automatically selected.

1/1553-CNA 403 2428 Uen H | 2014-10-10

107

SHM, Software Hardware Manager, User Guide

3. Click Import to OSS which is visible on the top right side of the view.

Note:

The Import button is disabled in the following cases: •

If no backup is selected.

•

If the BRM version of the selected backup is less than 3.0.

•

If Backups on external location is not selected from the drop down list.

4. An Import dialog box opens. Check Restore imported backup. Click Start.

108

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

5. The view is redirected to the Jobs view where the new job is created.

6. Confirm Restore later enables users to restore the backup on the ME later. If you check Confirm Restore later and click OK, the view is redirected to the Jobs view where the new job is created. The job is in WAITING state and play button is enabled. Click on play button to complete the restore process on the ME. 3.2.5.16

Delete Backup Backups can be deleted in Backup in Inventory view. The backups for each selected ME are displayed in an expandable hierarchical view with check boxes for ME and corresponding backups. To delete a backup, follow the given steps: 1. Select the backup to be deleted. When a managed element is checked, all the backups for that managed element are automatically selected.

1/1553-CNA 403 2428 Uen H | 2014-10-10

109

SHM, Software Hardware Manager, User Guide

If no backup is selected, the Delete Backups button is disabled.

2. Click Delete Backups which is visible on the top right side of the view. 3. A Delete Backups dialog box opens. Enter job name or default name is displayed.

110

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

4. If you check Run in Background and click Ok, backup is deleted and the page is refreshed. 5. If you do not check Run in Background and click Ok, the view is redirected to the Jobs view where the new job is created.

Figure 63 3.2.5.17

Jobs view with Remove Backup job

Restore Backup Backups for selected MEs can be restored in Backup in Inventory view.

1/1553-CNA 403 2428 Uen H | 2014-10-10

111

SHM, Software Hardware Manager, User Guide

The backups for each selected ME are displayed in an expandable hierarchical view with check boxes for ME and corresponding backups. Only one backup of a selected ME can be restored at a time. To restore a backup, follow the given steps: 1. Select the backup to be restored. When a managed element is checked, all the backups for that managed element are automatically selected.

If no backup is selected, the Restore Backups button is disabled. It is also disabled if a corrupt or incomplete backup is selected.

2. Click Restore Backups which is visible on the top right side of the view beside Delete Backups. 3. A Restore Backups dialog box opens. Enter job name or default name is displayed.

112

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

4. If you check Run in Background and click Ok, backup is restored and the page is refreshed. 5. If you do not check Run in Background and click Ok, the view is redirected to the Jobs view where the new job is created.

6. Confirm Restore later enables users to restore the backup on the ME later. If you check Confirm Restore later and click OK, the view is redirected to the Jobs view where the new job is created. The job is in WAITING state and play button is enabled. Click on play button to complete the restore process on the ME.

1/1553-CNA 403 2428 Uen H | 2014-10-10

113

SHM, Software Hardware Manager, User Guide

Figure 64 3.2.5.18

Jobs view when Confirm Restore Later option is checked

Cancel Backup and Restore This feature allows the users to cancel backup and restore.

3.2.5.18.1

Cancel Create Backup 1. Open the SHM application. 2. Click on Create Backup job. Job structure opens up and Cancel option appears for all sequential jobs.

3. Click on Cancel. All jobs in sequence are canceled.

114

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.5.18.2

Cancel Restore Backup 1. Open the SHM application. 2. Click on Create Backup job. Job structure opens up and Cancel option appears for all sequential jobs.

3. Click on Cancel. All jobs in sequence are canceled.

4. Click on Inventory tab

1/1553-CNA 403 2428 Uen H | 2014-10-10

115

SHM, Software Hardware Manager, User Guide

5. Go to Backup tab of inventory tab then click on More info of Backup of corresponding node . 6. Click on progressReport. 7. It displays the ActioName as cancelCurrentAction, ProgressInfo as FINISHED, ProgressPercentage as 100, ResultInfo as Backup Job Canceled and State as FINISHED.

3.2.5.18.3

Cancel Import Backup 1. Open the SHM application. 2. Click on Create Backup job. Job structure opens up and Cancel option appears for all sequential jobs.

3. Click on Cancel. All jobs in sequence are canceled.

116

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.5.18.4

Cancel Remove Backup 1. Open the SHM application. 2. Click on Create Backup job. Job structure opens up and Cancel option appears for all sequential jobs.

3. Click on Cancel. All jobs in sequence are canceled.

4. Click on Inventory tab

1/1553-CNA 403 2428 Uen H | 2014-10-10

117

SHM, Software Hardware Manager, User Guide

5. Go to Backup tab of inventory tab then click on More info of Backup of corresponding node . 6. Click on progressReport. 7. It displays the ActioName as cancelCurrentAction, ProgressInfo as FINISHED, ProgressPercentage as 100, ResultInfo as Backup Job Canceled and State as FINISHED.

3.2.5.18.5

Cancel Export Backup 1. Open the SHM application. 2. Click on Create Backup job. Job structure opens up and Cancel option appears for all sequential jobs.

3. Click on Cancel. All jobs in sequence are canceled.

118

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

4. Click on Inventory tab 5. Go to Backup tab of inventory tab then click on More info of Backup of corresponding node . 6. Click on progressReport. 7. It displays the ActioName as cancelCurrentAction, ProgressInfo as FINISHED, ProgressPercentage as 100, ResultInfo as Backup Job Canceled and State as FINISHED.

3.2.5.18.6

Cancel One Node for Create Backup Create Backup job is in running state for two Managed Elements 1. Open the SHM application. 2. Click on Create Backup job. Job structure opens up and Cancel option appears for all sequential jobs.

1/1553-CNA 403 2428 Uen H | 2014-10-10

119

SHM, Software Hardware Manager, User Guide

3. Click on cancel . 4. The running sub jobs in sequence change to Canceled. 5. Another sequential job changes to Finished. 6. If one sequential level job is shown as Canceled and another sequential level job is shown as Finished , then the parent job changes to Finished state.

3.2.5.19

Search Backup Users can search for backups of selected Managed Elements in Backup in Inventory view. The search operation can be performed using the following search strings:

120

•

Backup Name

•

Backup Type

•

Backup Domain

•

Additional Search Options

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

3.2.5.19.1

Backup Name To search for backups using the backup name, follow the given steps 1. Select MEs from topology tree. 2. Enter backup name in name: format in backup search text box. For example, name:B1OFM1. Click search icon or press enter. Backups with the entered name are displayed.

Figure 65 3.2.5.19.2

Search backup inventory using backup name

Backup Domain To search for backups using the backup domain, follow the given steps 1. Select MEs from topology tree. 2. Enter backup domain in domain: format in backup search text box. For example, domain:Domain1. Click search icon or press enter. Backups of the entered domain are displayed.

1/1553-CNA 403 2428 Uen H | 2014-10-10

121

SHM, Software Hardware Manager, User Guide

Figure 66 3.2.5.19.3

Search backup inventory using backup domain

Backup Type To search for backups using the backup type, follow the given steps 1. Select MEs from topology tree. 2. Enter backup name in type: format in backup search text box. For example, type:Type1. Click search icon or press enter. Backups of the entered type are displayed.

Figure 67 3.2.5.19.4

Search backup inventory using backup type

Additional Search Options User can also search for backups in the following ways•

Backup Name&Backup Domain For example: B1OFM1&Domain1

122

1/1553-CNA 403 2428 Uen H | 2014-10-10

Getting Started

•

Backup Type&Backup Domain For example: Type1&Domain1

•

Backup Name|Backup Domain For example: B1OFM1|Domain1

•

Backup Type|Backup Domain For example: Type1|Domain1

•

Backup Domain|Backup Type|Backup Name For example: Domain1|Type1|B1OFM1

•

Backup Domain&Backup Type&Backup Name For example: Domain1&Type1&B1OFM1

1/1553-CNA 403 2428 Uen H | 2014-10-10

123

SHM, Software Hardware Manager, User Guide

124

1/1553-CNA 403 2428 Uen H | 2014-10-10

Using SHM

4

Using SHM A number of workflows are described in Workflows below. The detailed tasks that are performed in the workflows are described in SHM Task List.

4.1

Workflows The following workflows exist:

4.1.1

•

Inventory workflows

•

Upgrade workflows

Inventory Workflows Export SW Inventory

4.1.2

Upgrade Workflows 1. Import SW package 2. Upgrade SW

4.2

SHM Task List The tasks are listed in alphabetical order. The order in Workflows decide the order in which to execute the tasks. The following tasks exist:

4.2.1

•

Export SW Inventory

•

Import SW Package

•

Upgrade SW

Export SW Inventory To export Software Inventory with the items for MEs as XML files, follow the given steps: 1. Click Inventory tab to open Inventory view. 2. Select one or more MEs. 3. Click Export.

1/1553-CNA 403 2428 Uen H | 2014-10-10

125

SHM, Software Hardware Manager, User Guide

4. In the Export Inventory dialog box, specify the file name. 5. Check if the SW Inventory checkbox is selected. 6. Click Export. 7. Open or save the file. The export process runs in the background. Return to one of the following workflows:

4.2.2

•

Inventory workflows

•

Upgrade workflows

Import SW Package In Upgrade view, the user can import new SW packages to SHM. Prerequisites: •

The software upgrade package must be in .zip file format.

The procedure for Import SW package is as follows: 1. Click Upgrade tab to open Upgrade view. 2. Click Import. 3. In the Import new software package dialog box, click Browse to select the file to be imported from directory. 4. Click Import to upload the file, or Close to stop the upload process. If the upload is complete, the Upgrade package information is available in the Select Upgrade Package in OSS list. If the file upload is not successful, an error message is displayed. Return to one of the following workflows:

4.2.3

•

Inventory workflows

•

Upgrade workflows

Upgrade SW Prerequisites: •

126

The upgrade package must be imported to SHM before the upgrade process to administer the upgrade.

1/1553-CNA 403 2428 Uen H | 2014-10-10

Using SHM

•

The upgrade package must be compatible with the ME and with the already installed software package.

In Upgrade view, the user can upgrade the software. 1. Click Upgrade tab to open the Upgrade view. 2. Select the MEs to be upgraded. They are displayed in the Selected managed elements table. 3. In the Select Upgrade Package in OSS table, check the upgrade package to be used. 4. Click Start. 5. In the Scheduler dialog box, select the desired option and click Ok. 6. In the Confirmation dialog, click Yes to start the upgrade or No to cancel the upgrade process. After clicking Yes, the user is directed to the Jobs view page. Return to one of the following workflows: •

Inventory workflows

•

Upgrade workflows

1/1553-CNA 403 2428 Uen H | 2014-10-10

127

SHM, Software Hardware Manager, User Guide

128

1/1553-CNA 403 2428 Uen H | 2014-10-10

Troubleshooting

5

Troubleshooting This chapter describes some possible problems that can occur in the SHM and presents possible solutions. See Table 2. Table 2

Troubleshooting SHM

Description

Possible Cause(s)

Action

403 error

Lack of authority for the user to perform the operation.

Check the authority settings of the user.

404 error

• Network connection problem

• Check if there are any network problems.

• Server access problem

• Check Glassfish: enter http://:50503/ in Firefox. If you see the string "Your server is now running" on the resulting page, Glassfish is properly set up for SHM.

• Lack of authority • Modules have not been loaded in glassfish admin console under nms_shm application.

• Check if SHM is online. Refer to SHM Insta llation Instructions, Reference [3], to see how. • Check the authority settings for the user. For more information about Authority Handling, refer to SHM, Software Hardware Manager System Administrator Guide, Reference [6]

1/1553-CNA 403 2428 Uen H | 2014-10-10

129

SHM, Software Hardware Manager, User Guide

Description

Possible Cause(s)

Action

ME is not visible in Topology

• ME version is not ECIM compliant.

• For more information on how to add an ME to topology, refer to OSS Explorer (OEX) GUI User Guide, Reference [5].

• ME is not added to topology. • User has no authority to view ME.

javax.jms.JMSExceptio n: Failed to build body from bytes. Reason: java.io.InvalidClassExc eption: com.ericsson.os s.domain.modetails.EC IM_SysM.SchemaImpl; local class incompatible: stream classdesc serialVersionUID = 661269803854554 3613, local class serialVersionUID = 27480082776028918 99. See the logs for details. Note:

130

Jar incompatibility because of installation of Hot EC of any dependent application mentioned in SHM, Software Hardware Manager System Installation InstructionsReference [3]

• Check the authority settings for the user. For more information about Authority Handling, refer to SHM, Software Hardware Manager System Administrator Guide, Reference [6] Restart Glassfish. Refer to note on Page 130 to see how to.

Glassfish can be restarted by entering the following commands on the server: •

/opt/glassfish3/glassfish/bin/asadmin stop-domain domain1

•

/opt/glassfish3/glassfish/bin/asadmin start-domain domain1

1/1553-CNA 403 2428 Uen H | 2014-10-10

Frequently Asked Questions (FAQ)

6

Frequently Asked Questions (FAQ)

6.1

Terminology 1

What is a job? What can I do with a job? A job comprises one or more sub-jobs that are executed in sequence for one or more Managed Elements (MEs).

2

What is an Upgrade Package (UP)? An UP contains new or corrected software delivered from Ericsson, which includes Load Modules (LM) and an upgrade control file (UCF) that targets the node. The UCF specifies the software included in the UP, compatible hardware and software, and the upgrade sequence in the node. An UP is delivered to the customer in a Software Package (SWP).

3

What is a Managed Element (ME)? An ME is an ECIM compliant Network Element (NE). An ME is an entity presented to an operator as a single element from a management topology or administrative view. It is an object in a network which can handle a signal in various ways and which can be remotely controlled by a centralized management system. It can be either a real switch or the managed object for a switch.

4

In what format does SHM export inventory data? Inventory data is exported as an XML file.

5

What are the phases of an upgrade? An upgrade has the following phases in the ECIM model:

6

a

Prepare

b

Verify

c

Activate

d

Commit

What does “prepare” mean in upgrade? This operation prepares the ME for the activation of the current upgrade package.

1/1553-CNA 403 2428 Uen H | 2014-10-10

131

SHM, Software Hardware Manager, User Guide

Various checks are performed on the ME, the UP is partly or fully downloaded to the ME. No decrease in capacity can be experienced on the ME and the software version does not change. 7

What does “verify” mean in upgrade? This operation verifies the ability to activate the current upgrade package.

8

What does “activation” mean in upgrade? The activation of a UP means that it is taken into operation. This is the most critical part of the upgrade. During activation, the capacity of the ME decreases temporarily and after it, the software version normally changes.

9

What does “commit” mean in upgrade? This operation confirms the upgrade.

10 What is ECIM? Ericsson Common Information Model is the new standardized operation and maintenance (O&M) interface for Ericsson Managed Elements.

6.2

Functions

6.2.1

Inventory 1

How can I view software inventory? Select one or more MEs and the Inventory tab.

2

How can I export SW inventory? See Section 4.2.1 on page 125.

3

Why is the exported file empty? Make sure the Software inventory checkbox is selected before you press the Export button.

6.2.2

Jobs 1

Can I change a job? No. Currently, once the job is created, it starts immediately. No modification of the job is implemented yet.

2

132

Can I retrieve a deleted job?

1/1553-CNA 403 2428 Uen H | 2014-10-10

Frequently Asked Questions (FAQ)

No. 3

Why has the job failed? There are various reasons why a job can fail: such as bad software version, network problems. See the Report and Detailed Info tabs for the exact reason why the job failed.

4

Can I save a job to run later? No. Currently, once the job is created, it starts immediately. No save function is implemented yet.

5

Can I schedule a job to run at a later date? No. Job scheduling is not implemented yet.

6.2.3

Topology 1

What is a topology in SHM? The topology in OEX includes all the imported MEs available and accessible to the user. In SHM only those ECIM compliant MEs are shown which meet the minimum requirements in SHM.

2

How do I view topologies? Topology information comes from OEX. Two topologies exist, nex:onrm and nex:site. A topology can be selected in the Topologies selection list.

3

How do I view all MEs? MEs can be viewed by opening the subnetwork and their substructures one by one.

4

Why cannot I select an ME? Only MEs supported by SHM can be selected.

5

How do I select all MEs? MEs can only be selected one by one.

6

Why cannot I see all the network elements in SHM I can see in OEX? The network elements are filtered for ECIM and SHM compatibility.

6.2.4

Upgrade 1

What is an upgrade package?

1/1553-CNA 403 2428 Uen H | 2014-10-10

133

SHM, Software Hardware Manager, User Guide

See the identical question in Section 6.1 on page 131. 2

How can I import an upgrade package? See Section 4.2.2 on page 126.

3

Can there be more than one upgrade package on an ME? Yes. There can be more than one UP at the same time on the ME. One UP represents the software executing on the ME.

4

How can I prepare an upgrade package? This operation is a part of the SHM Upgrade job.

5

How can I activate an upgrade package? This operation is a part of the SHM Upgrade job.

6

Which upgrade package can I use to upgrade an ME? Check the ME type section in the Package info dialog for information which MEs, platforms, and Product Numbers and Revisions are supported by the UP.

7

What is the difference between Prepare Upgrade and Activate Upgrade? The most important difference is that "prepare" does not influence node capacity but "activate" can cause a temporary deterioration in capacity. Another important difference is that the software version can change only after "activate".

8

Are there any packages that are common for all MEs? If so, where can I check them? It depends on what MEs and UPs are imported. Check the Package info page of the UPs for information.

9

Can I view all packages for all MEs? Yes. If no ME is selected, all available UPs are listed. There are two ways of viewing UPs: directly on the Upgrade tab and in the Upgrade software packages view opening from the Upgrade tab after the Upgrade packages button is pressed. The latter displays more information about the UPs.

6.3

Access Rights and Authority 1

134

What rights do I need to start SHM?

1/1553-CNA 403 2428 Uen H | 2014-10-10

Frequently Asked Questions (FAQ)

Currently, any OSS-RC user can start SHM client. 2

What rights do I need to see an ME in the topology tree? By default, any OSS-RC user can view all the MEs should be updated as the user must have Default Network Access role to view nodes under topology Limitations can be set by the administrator. For further information on authority handling, refer to the SAG, Reference [6].

3

Roles of Operators A user needs to have the OPE or NWOPE role to be able to upgrade MEs. OPE, NWOPE, SYSADM: Users with OPE, NWOPE and Sysadm roles can perform any operation. Other users can perform create backup, restore backup and view inventory

6.4

Performance and Characteristics 1

How many MEs can I put in an upgrade job? Maximum 100 MEs can be placed in a single job.

2

How many ME inventories can I export? There is no limitation on the number of selectable MEs. There is no limitation on the number of ME inventories that can be exported either.

6.5

Further Information 1

Where can I find information on the installation of the product? Installation information is available in the SHM, Software Hardware Manager Installation Instructions, Reference [3]

2

Where can I find a general overview of the functions of the product? A functional overview is available in the SHM, Software Hardware Manager, Facility Description, Reference [7].

3

Where can I get information about the configuration of the product? The configuration of the product is described in the SHM, Software Hardware Manager System Administrator Guide, Reference [6].

1/1553-CNA 403 2428 Uen H | 2014-10-10

135

SHM, Software Hardware Manager, User Guide

136

1/1553-CNA 403 2428 Uen H | 2014-10-10

Glossary

Glossary Glossary The Glossary is included in Glossary of Terms, Reference [1].

1/1553-CNA 403 2428 Uen H | 2014-10-10

137

SHM, Software Hardware Manager, User Guide

138

1/1553-CNA 403 2428 Uen H | 2014-10-10

Reference List

Reference List

[1]

Glossary of Terms, 0033-AOM 901 017/2

[2]

Typographic Conventions, 1/154 43-AOM 901 017/4

[3]

SHM, Software Hardware Manager, Installation Instructions INSTALLATION INSTRUCTIONS, 1/1531-CNA 403 2428

[4]

TBAC, Target Based Access Control GETTING STARTED GUIDE, 22/1551-AOM 901 075

[5]

OSS Explorer (OEX) GUI User Guide USER GUIDE, 1/1553-CNA 403 8635

[6]

SHM, Software Hardware Manager, System Administrator Guide SYSTEM ADM. GUIDE, 1/1543-CNA 403 2428

[7]

SHM, Software Hardware Manager, Facility Description FACILITY DESCRIPTION, 1/155 34-CNA 403 2428

[8]

SMO, Software Management Organizer USER GUIDE, 1553-APR 901 0135

1/1553-CNA 403 2428 Uen H | 2014-10-10

139