Installation, Administration, and User Guide

5529 Inventory Data Manager,

Release 9.7

Installation, Administration, and User Guide

3JL-03001-BTAA-PCZZA

Edition 01

March 2019

Nokia — Proprietary and confidential

Use pursuant to applicable agreements
 Installation, Administration, and User Guide

Nokia is a registered trademark of Nokia Corporation. Other products and company

names mentioned herein may be trademarks or tradenames of their respective
owners.
The information presented is subject to change without notice. No responsibility is
assumed for inaccuracies contained herein.
© 2019 Nokia.
Contains proprietary/trade secret information which is the property of Nokia and must
not be made available to, or copied or used by anyone outside Nokia without its
written authorization. Not to be used or disclosed except in accordance with
applicable agreements.

2 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide

Table of contents
1 Preface...........................................................................................13
1.1 Related documentation..............................................................................13
1.2 Conventions used in this guide..................................................................14
1.2.1 Important information.................................................................................15
1.2.2 Procedures with options or substeps.........................................................15
1.3 Multiple PDF file search.............................................................................16
Getting started
2 What’s new ....................................................................................21
2.1 What’s new in Release 9.7 ........................................................................21
2.2 What’s new in Release 9.6.07 ...................................................................22
2.3 What’s new in Release 9.6.05 ...................................................................24
3 Getting started ..............................................................................27
3.1 Overview of this guide ...............................................................................27
3.2 Overview of the 5529 IDM .........................................................................28
3.3 Standalone and cluster 5529 IDM deployments........................................28
3.3.1 Standalone deployment.............................................................................28
3.3.2 Cluster deployment....................................................................................29
3.3.3 Geographic redundancy ............................................................................30
3.4 Security recommendations ........................................................................31
3.5 System requirements.................................................................................31
3.6 NE support plug-ins ...................................................................................31
3.7 Technologies and standards .....................................................................31
3.8 Permissions and privileges........................................................................32
Installation, migration, and administration
4 Installation and migration ............................................................35
4.1 Installation overview ..................................................................................35
4.2 Migration overview.....................................................................................36
4.3 NE support plug-in migration .....................................................................36
4.4 5529 IDM data removal .............................................................................38
4.5 5529 IDM and NE support plug-in uninstallation .......................................38
5 Administration ..............................................................................39
5.1 User authentication and authorization .......................................................39
5.1.1 Client OS authentication............................................................................40
5.2 Licensing ...................................................................................................41
5.2.1 License validation ......................................................................................41
5.2.2 License alarms ..........................................................................................42
5.3 5529 IDM NBI settings...............................................................................42
5.4 Logs...........................................................................................................46
5.4.1 inventory.log ..............................................................................................46
5.4.2 nbi.log ........................................................................................................46
5.4.3 server.log...................................................................................................48
5.4.4 Setting inventory tracing levels..................................................................48

Edition 01 3JL-03001-BTAA-PCZZA 3
 Installation, Administration, and User Guide

5.4.5 Filtering and aggregating tracing logs by NE.............................................48

5.5 EMS license alarms...................................................................................48
5.6 5529 IDM and the 5520 AMS Software Version Mismatch
(SWVER) alarm .........................................................................................49
Using the 5529 IDM
6 Functionality and settings ...........................................................53
6.1 Perspectives ..............................................................................................53
6.1.1 Inventory Query perspective......................................................................53
6.1.2 Inventory Browser perspective ..................................................................54
6.1.3 Network perspective ..................................................................................54
6.1.4 Scheduler perspective ...............................................................................55
6.2 Icons ..........................................................................................................55
6.3 Inventory settings ......................................................................................60
6.4 Inventory job queues .................................................................................62
6.5 Users .........................................................................................................63
6.6 Managing schedules..................................................................................63
6.7 Performance monitoring ............................................................................67
7 Inventory data collection .............................................................69
7.1 Inventory data collection overview.............................................................69
7.1.1 Manual and scheduled inventory data collections .....................................70
7.1.2 Inventory database synchronization ..........................................................70
7.2 Selecting objects and attributes for inventory data collection....................71
7.3 Managing schedules for inventory data collection.....................................73
7.3.1 Inventory data collections in large networks..............................................73
7.3.2 Creating, modifying, or removing an inventory data collection
schedule ...................................................................................................74
7.4 Performing inventory data collection ........................................................74
7.5 Checking inventory data collection results ................................................77
7.5.1 Data collection failure query ......................................................................78
7.5.2 Collection failure alarms ............................................................................78
7.5.3 Collection failures ......................................................................................78
7.6 Managing inventory database synchronization based on NE events ........79
7.6.1 Operational changes for network ports......................................................79
7.6.2 Checking the status of inventory database updates..................................80
7.7 Using collection statistics...........................................................................80
8 Queries ..........................................................................................83
8.1 Query overview..........................................................................................83
8.1.1 Impact of collection selection changes on query behavior ........................83
8.1.2 Queries for objects in a hierarchy..............................................................84
8.1.2.1 Example of hierarchical names .................................................................85
8.1.3 Performing NE-level or NE agent-level queries.........................................85
8.1.4 Performing queries on sub-objects of NEs and NE agents .......................86
8.1.4.1 Retrieving NEs that are connected to NEs ................................................86
8.1.4.2 Retrieving end points.................................................................................87
8.1.5 Additional information provided in attribute values that link to other
resource names.........................................................................................87
8.1.6 Define Query and Run Query windows .....................................................88

4 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide

8.2 Performing inventory data query tasks ......................................................93

8.2.1 Configuring GUI query result settings........................................................94
8.2.2 Defining inventory data queries .................................................................95
8.2.3 Running inventory data queries immediately.............................................96
8.2.4 Scheduling inventory data queries ............................................................98
8.2.5 Reviewing an inventory data query .........................................................100
8.3 Managing inventory query results............................................................102
8.3.1 Synchronization status ............................................................................103
8.3.2 Navigating within the Inventory Query Results view................................104
8.3.3 Object shortcut menu ..............................................................................104
8.3.3.1 Add Filter option ......................................................................................105
8.3.3.2 Count option ............................................................................................105
8.3.3.3 Generate Public Key option.....................................................................106
8.3.3.4 Multiple Edit option ..................................................................................107
8.3.4 Using the Text Search box ......................................................................107
8.3.5 Using key shortcuts .................................................................................107
8.3.6 Saving data to a .csv file..........................................................................108
8.3.7 Object name and attribute value considerations .....................................110
8.4 Simple filtering for NE and NE agent-level queries .................................111
8.5 Advanced filtering for NE and NE agent-level queries ............................114
9 Network export............................................................................121
9.1 Network export overview .........................................................................121
9.2 Managing export profiles .........................................................................121
9.2.1 Object and attribute special cases...........................................................122
9.2.1.1 Complex attributes...................................................................................122
9.2.1.2 IGMP Channel object ..............................................................................123
9.2.1.3 NE object and attributes ..........................................................................123
9.2.1.4 Parent FN attribute ..................................................................................123
9.2.2 Export profiles..........................................................................................123
9.3 Performing a network export ...................................................................127
10 Inventory Browser perspective .................................................131
10.1 Inventory Browser perspective overview .................................................131
10.2 Navigation................................................................................................131
10.2.1 Navigating to the Inventory Browser perspective ....................................131
10.2.2 Navigating to the Network perspective ....................................................132
10.3 Views .......................................................................................................132
10.3.1 Inventory Tree view .................................................................................132
10.3.2 Object Details view ..................................................................................133
10.3.3 Graphical View ........................................................................................133
10.3.3.1 Automatic update of service indications ..................................................134

Edition 01 3JL-03001-BTAA-PCZZA 5
 Installation, Administration, and User Guide

6 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide

List of figures
3 Getting started ..............................................................................27
Figure 1 5529 IDM architecture—standalone deployment ......................................29
Figure 2 5529 IDM architecture—cluster deployment .............................................30
8 Queries ..........................................................................................83
Figure 3 Example of hierarchical names in the Inventory Query Results view........85

Edition 01 3JL-03001-BTAA-PCZZA 7
 Installation, Administration, and User Guide

8 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide

List of tables
1 Preface...........................................................................................13
Table 1 Related documentation..............................................................................13
Table 2 Documentation conventions ......................................................................14
2 What’s new ....................................................................................21
Table 3 What’s new in Release 9.7 ........................................................................21
Table 4 What’s new in Release 9.6.07 ...................................................................22
Table 5 What’s new in Release 9.6.05 ...................................................................24
5 Administration ..............................................................................39
Table 6 5529 IDM user functions and roles............................................................39
Table 7 5529 IDM NBI settings parameters ...........................................................43
Table 8 5529 IDM NBI settings—information parameters ......................................45
Table 9 5529 IDM log .............................................................................................46
Table 10 nbi.log file keywords ..................................................................................47
6 Functionality and settings ...........................................................53
Table 11 Inventory options available through the Network perspective ..................55
Table 12 5529 IDM icons..........................................................................................56
Table 13 Query Settings parameters........................................................................61
Table 14 Inventory job queues .................................................................................62
Table 15 Schedule procedures.................................................................................63
Table 16 Schedule window parameters ...................................................................65
7 Inventory data collection .............................................................69
Table 17 Schedule Collection window parameters...................................................75
Table 18 NE Selection window parameters..............................................................76
Table 19 Collection Statistics window components..................................................81
8 Queries ..........................................................................................83
Table 20 Impact of collection selection changes on queries ....................................84
Table 21 Hierarchical name formats.........................................................................84
Table 22 Key parameter settings to use to retrieve NEs that are connected
to NEs........................................................................................................86
Table 23 Key parameter settings to use to retrieve end points ................................87
Table 24 Configuring parameters in the Define Query and Run Query
windows.....................................................................................................88
Table 25 Inventory data query procedures...............................................................94
Table 26 5529 IDM synchronization status and colors...........................................103
Table 27 NE object navigation responses ..............................................................104
Table 28 Inventory Query Results key shortcuts....................................................107
Table 29 Attributes supported for NE-level queries................................................112
Table 30 Attributes supported for NE agent-level queries......................................113
Table 31 Attributes that can be used for advanced filtering in NE-level
queries.....................................................................................................115
Table 32 Attributes that can be used for advanced filtering in NE agent-level
queries.....................................................................................................118

Edition 01 3JL-03001-BTAA-PCZZA 9
 Installation, Administration, and User Guide

10 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide

List of procedures
1 Preface...........................................................................................13
Procedure 1 Example of options in a procedure ............................................................15
Procedure 2 Example of substeps in a procedure .........................................................16
Procedure 3 To search multiple PDF files for a term .....................................................16
4 Installation and migration ............................................................35
Procedure 4 To install and update an NE support plug-in .............................................37
Procedure 5 To roll back an NE support plug-in ............................................................37
Procedure 6 To remove 5529 IDM data.........................................................................38
5 Administration ..............................................................................39
Procedure 7 To configure the 5529 IDM OSS to use the internal database ..................41
Procedure 8 To configure 5529 IDM NBI settings..........................................................43
6 Functionality and settings ...........................................................53
Procedure 9 To configure Query Settings......................................................................60
Procedure 10 To create a schedule .................................................................................63
Procedure 11 To modify a schedule ................................................................................66
Procedure 12 To remove a schedule ...............................................................................67
Procedure 13 To view the job details associated with a schedule ...................................67
7 Inventory data collection .............................................................69
Procedure 14 To select objects and attributes for collection............................................72
Procedure 15 To perform inventory data collection ........................................................74
8 Queries ..........................................................................................83
Procedure 16 To configure GUI query result settings ......................................................94
Procedure 17 To define an inventory data query .............................................................95
Procedure 18 To run an inventory data query immediately .............................................97
Procedure 19 To schedule inventory data queries...........................................................99
Procedure 20 To review, modify, or delete an inventory data query..............................101
Procedure 21 To save the results of a query to a .csv file ............................................109
9 Network export............................................................................121
Procedure 22 To create an export profile.......................................................................124
Procedure 23 To modify an export profile ......................................................................125
Procedure 24 To delete an export profile.......................................................................127
Procedure 25 To perform a network export ...................................................................129

Edition 01 3JL-03001-BTAA-PCZZA 11
 Installation, Administration, and User Guide

12 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Preface

1 Preface
The 5529 IDM Installation, Administration, and User Guide provides information
about:
• installing the 5529 IDM
• installing 5529 IDM NE support plug-ins
• performing administration tasks (including authorization, authentication, licensing,
and configuration)
• performing inventory management tasks using the 5529 IDM application
The 5529 IDM integrates with the 5520 Access Management System application.
You can access the 5529 IDM functionality from the 5520 AMS client to perform
inventory management tasks such as data collections and queries.

1.1 Related documentation

Table 1 describes related documentation sources that you may need to reference.
Table 1 Related documentation

Customer documentation Description

5520 Access Management System

5520 AMS Administrator Guide Information about administrative functions, including

management of client-server communication, users, NE
communication, and schedules

5520 AMS Installation and Migration Guide Information about how to install, optimize, and uninstall the
5520 AMS server, client, and plug-in components, as well
as how to migrate data to the 5520 AMS from other EMSs

5520 AMS Northbound Interface Guide Information about functions that are supported by the
5520 AMS NBI

5520 AMS User Guide Information about user functions, including monitoring, fault,
and alarm management and performing tasks that are
common to the NEs

Operations and Maintenance guides for the Information about NE support plug-ins
supported NE plug-ins

5520 AMS and 5529 Enhanced Applications

5520 AMS and 5529 Enhanced Applications 5520 AMS, 5529 Enhanced Applications, and NE alarm
Alarm Search Tool descriptions

5520 AMS and 5529 Enhanced Applications Information about the product features that impact privacy
Privacy Considerations and the measures taken to protect such data

5520 AMS Solution Glossary Terms and acronyms related to the 5520 AMS and
5529 Enhanced Applications

(1 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 13
Preface Installation, Administration, and User Guide

Customer documentation Description

5529 Enhanced Applications

5529 Enhanced Applications Release Notice Information about updates to the product, software and
documentation delivery, known restrictions, and fixed
issues

5529 Inventory Data Manager

5529 IDM NE support plug-in attributes guides Information about the full set of NE object attributes that is
supported by the 5529 IDM

5529 IDM Northbound Interface Guide Information about the 5529 IDM NBI component

HTML files that are provided with the 5529 IDM Information about the subset of NE object attributes that is
supported by the NBI. See the 5529 Enhanced Applications
Release Notice for information about how to access these
files.

(2 of 2)

1.2 Conventions used in this guide

Table 2 describes the conventions that are used throughout this guide.
Table 2 Documentation conventions

Convention Description Example

Italics Identify a variable hostname

Key+Key Type the appropriate consecutive keystroke sequence. CTRL+G

Key–Key Type the appropriate simultaneous keystroke sequence. CTRL–G

↵ Press the Return key. ↵

— An em dash in a table cell indicates there is no information —

→ A right arrow graphic following the menu label indicates that a cascading File→Save
submenu results from selecting a menu item.

14 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Preface

1.2.1 Important information

The following conventions are used to indicate important information.

Warning — A warning indicates that the described task or situation

may, or will, cause equipment damage or serious performance
problems.

Caution — A caution indicates that the described task or situation may,

or will, cause a service interruption.

Note — A note provides information that is, or may be, of special

interest.

1.2.2 Procedures with options or substeps

When there are options in a procedure, they are identified by letters. When there are
substeps in a procedure, they are identified by roman numerals.

Procedure 1 Example of options in a procedure

At step 1, you can choose option a or b. At step 2, you must do what the step indicates.

1 This step offers two options. You must choose one of the following:

a This is one option.

b This is another option.

2 You must perform this step.

Edition 01 3JL-03001-BTAA-PCZZA 15
Preface Installation, Administration, and User Guide

Procedure 2 Example of substeps in a procedure

At step 1, you must perform a series of substeps within a step. At step 2, you must do what the
step indicates.

1 This step has a series of substeps that you must perform to complete the step. You must
perform the following substeps:

i This is the first substep.

ii This is the second substep.

iii This is the third substep.

2 You must perform this step.

1.3 Multiple PDF file search

You can use Adobe Reader, Release 6.0 or later, to search multiple PDF files for a
term. Adobe Reader displays the results in a display panel. The results are grouped
by PDF file. You can expand the entry for each file.

Note — The PDF files in which you search must be in the same folder.

Procedure 3 To search multiple PDF files for a term

1 Open the Adobe Reader.

2 Choose Edit→Advanced Search from the Adobe Reader main menu. The Search window
opens.

3 Enter the term to search for.

4 Select the All PDF Documents in radio button.

5 Choose the folder in which to search using the drop-down menu.

16 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Preface

6 Select the following search criteria, if required:

• Whole words only

• Case-Sensitive
• Include Bookmarks
• Include Comments

7 Click on the Search button.

Adobe Reader displays the search results. You can expand the entries for each file by
clicking on the + symbol.

Note — After you click on a hyperlink, you can right-click and choose Previous
View from the contextual menu to return to the location of the hyperlink that you
clicked on.

Edition 01 3JL-03001-BTAA-PCZZA 17
Preface Installation, Administration, and User Guide

18 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Getting started

Getting started
2 What’s new

3 Getting started

Edition 01 3JL-03001-BTAA-PCZZA 19
Getting started Installation, Administration, and User Guide

20 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide What’s new

2 What’s new
2.1 What’s new in Release 9.7

2.2 What’s new in Release 9.6.07

2.3 What’s new in Release 9.6.05

2.1 What’s new in Release 9.7

Table 3 describes the 5529 IDM features and enhancements added to the 5529 IDM
Installation, Administration, and User Guide for Release 9.7.
Table 3 What’s new in Release 9.7

Feature/enhancement Description Edition See

New features and enhancements

Show→E2E Resource Path The Show→E2E Resource Path menu option in the Object 01 See section 8.3.3 for
menu option supported for shortcut menu (right-click menu) in the Inventory Query Results more information about
learned MAC addresses for the window lets you invoke the E2E Resource Path view for a learned the Object shortcut
7302/7330/7356/7360/7362/ MAC address so that you can see end-to-end resource path menu.
7363/7367 ISAM information. The following MAC address types are supported for See the Operations and
querying through the 5529 IDM: Maintenance guide for
• GPON Current MAC Address the 7302/7330/7356/
• NGPON2 Current MAC Address 7360/7362/7363/7367
ISAM for more
• Ethernet Current MAC Address
information about the
• NT Current MAC Address end-to-end resource
• Ethernet LT Current MAC Address path for a learned MAC
• Current MAC Address address.

The Status attribute value of the MAC address must be “Learned”

to filter the search.

Documentation changes

Additional information provided Added information about how the 5529 IDM GUI does not display 01 Section 8.1.5
in attribute values that link to the additional information provided in some attribute values in the
other resource names same way as the 5520 AMS GUI does

Filtering query results using Added information that filtering on attribute values using the 01 Table 24
“begins with” or “ends with” “begins with” or “ends with” operators and not providing a value for
operators in Define Query and the operator is an invalid filter configuration in the Define Query
Run Query windows and Run Query windows and may lead to unpredictable query
results

GUI query result settings Changed the range of the number of records to be saved from 01 Procedure 16
between 0 and 2 147 483 647 to between 1 and 2 147 483 647

(1 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 21
What’s new Installation, Administration, and User Guide

Feature/enhancement Description Edition See

Managing inventory query Updated information about sorting query results by column in 01 Section 8.3
results ascending or descending order in the Inventory Query Results
window.
Added a limitation about sorting inventory query results by the NE
attribute in the Inventory Query Results window if the number of
query results exceeds the maximum allowed number of query
results per page.
Updated information about sorting query results using the Sorted
by parameter in the Order tab of the Define Query and Run Query
windows.

Added information about naming attributes and how they 01 Section 8.3.7
correspond to the friendly name of an object

Added information about the Inventory Query Results view in 01

which the naming attribute value of a queried object may not align
with the corresponding variable in the object name

Network export Added example for the Remote Directory field when using FTP to 01 Procedure 25
transfer the output file to a remote host

Added a note about the fact that the preferred method to provide 01 Section 9.1
a consistent data format for NBI processing is to use export
profiles and bulk network exports, and to avoid using inventory
query results because they are affected by 5529 IDM GUI name
changes

Saved CSV files for inventory Added a limitation about how 5529 IDM GUI names (user-friendly 01 Sections 8.2.4 and
data query results names) for objects, attributes, and attribute values, may change 8.3.6
over time with each release or update of the applicable NE
support plug-in, and that the old GUI names will be seen in the
saved CSV files for pre-defined or scheduled inventory query data
results if you do not create new pre-defined or scheduled data
queries to capture the latest GUI name changes
Also added a note about the fact that the preferred method to
provide a consistent data format for NBI processing is to use
export profiles and bulk network exports, and to avoid using
inventory query results because they are affected by 5529 IDM
GUI name changes

(2 of 2)

2.2 What’s new in Release 9.6.07

Table 4 describes the 5529 IDM features and enhancements added to the 5529 IDM
Installation, Administration, and User Guide for Release 9.6.07.
Table 4 What’s new in Release 9.6.07

Feature/enhancement Description Edition See

New features and enhancements

Generate public keys for SSH The Generate Public Key option is a choice available through the 01 Sections 8.3.3 and
Server and SSH System shortcut menu by right-clicking on one or more objects selected in 8.3.3.3
Parameters objects the Inventory Query Results view of the Inventory Query
perspective and choosing Actions→Generate Public Key.

(1 of 2)

22 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide What’s new

Feature/enhancement Description Edition See

Inventory data collection for The 5529 IDM is enhanced to collect attributes for links between 01 Chapter 7 for
attributes added by NE support agents (IACM, xHUB, and xVPS). The links are added to the information about
plug-ins system by the NE support plug-ins. inventory data
The link attributes are not currently listed in the 5529 IDM NE collection
support plug-in attributes guides. See the 5529 Enhanced 5529 Enhanced
Applications Release Notice for information about the following Applications Release
attributes: Notice
• LT Board (Actual) attribute in the Vectoring Link object
• SFP attribute in the Ethernet Port (IHUB) object

Inventory database Operational changes for network ports on SHUB-based NEs 01 Section 7.6.1
synchronization based on trigger updates in the 5529 IDM database
operational changes for network
port

nbi.log file changes Added information about the nbi.log file, including the following 01 Section 5.4.2
new log file keywords: SourceIP and X-Forwarded-For

Parent FN attribute available for The Parent FN attribute for the following ISAM objects is available 01 Section 9.2.1.4
network export for network export:
• GPON Current MAC Address
• GPON VLAN Association DHCP Session

Support NE IP instead of NE Support for the IPv6 address format is added to the Support NE 01 Table 7
name parameter IP instead of NE name parameter in the 5529 IDM NBI settings

Documentation changes

5520 AMS and 5529 Enhanced Added the 5520 AMS and 5529 Enhanced Applications Privacy 01 Table 1
Applications Privacy Considerations document to the list of related documentation
Considerations sources

Collected Objects in Inventory The message in the dialog box that opens when you click on the 01 Procedure 14
view Apply configuration icon is changed to indicate that if you modify
the objects in the Collected Objects in Inventory view and query
on the objects, the GUI will not return any data until the changes
are taken into account in the next inventory collection.

Inventory data queries Added a note that indicates that if you modify the objects in the 01 Procedures 17, 18, and
Collected Objects in Inventory view and query on the objects, the 19
GUI will not return any data until the changes are taken into
account in the next inventory collection

Inventory Query Results key Corrected descriptions of the F6 and F7 key shortcuts 01 Table 28
shortcuts

Multiple edit option Added a note about disregarding an error message that may be 01 Section 8.3.3.4
seen in the gui.log file when using the Multiple Edit option

NBI settings Added a description of the parameters in the Information tab of the 01 Procedure 8
5529 IDM NBI settings

Network export output file Added information about the output file name format 01 Section 9.3

Schedule view If the data string of a scheduled query job exceeded the maximum 01 Procedure 13
allowed length, the job did not display in the List of jobs panel of
the Schedule view. This issue is fixed in R9.6.07.

SOAP version 1.2 Added SOAP version 1.2 to the list of supported technologies and 01 Section 3.7
standards that the 5529 IDM platform is based on. SOAP 1.2 is
supported on 5529 IDM R9.6 or later.

(2 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 23
What’s new Installation, Administration, and User Guide

2.3 What’s new in Release 9.6.05

Table 5 describes the 5529 IDM features and enhancements added to the 5529 IDM
Installation, Administration, and User Guide for Release 9.6.05.
Table 5 What’s new in Release 9.6.05

Feature/enhancement Description Edition See

New features and enhancements

Comments Added the Comments functionality to the 5529 IDM for the 01 Tables 7 and 13
following inventory settings in the Administration Tree: 5520 AMS
• Basic Settings Administrator Guide for
• Query Settings information about how
to use Comments

Display format of Link object The display format of Link object names has changed in the 01 Section 8.2.3 describes
name in query results and following locations: how to run a query
network export output file • Inventory Query Results view Section 8.2.4 describes
• query results .csv file (saved or scheduled) how to schedule a
query
• network export output file
Section 8.3.6 describes
In R9.6.03 and earlier, the elements that make up the object name how to save query
were separated by a space character, but in R9.6.05 or later the results to a .csv file
object name elements are separated by a colon (:). Section 9.3 describes
how to perform a
network export

End points You can use the Define Query or Run Query window to perform a 01 Section 8.1.4.2
query to retrieve end point information.

Inventory Query Results key Added the F6 and F7 key shortcuts 01 Table 28
shortcuts

Documentation changes

Attributes that can be used for Added the default value for the NE ID attribute. 01 Table 31
advanced filtering in NE-level Added the list of Sub Type attribute values.
queries

Basic settings Moved information about using the Object Details view to view the 01 Section 6.3
Basic Settings that are provided by the 5520 AMS from the 5529
Enhanced Applications Release Notice to this guide

Display format of attribute values Added information about how an attribute value that is displayed 01 Section 9.3
in query results and network in the network export output file may not match the attribute value
export output file that is displayed in the Inventory Query Results window

Inventory Query Results key Added the arrow key shortcuts 01 Table 28
shortcuts
Updated the descriptions of the Ctrl+A and Ctrl+C key shortcuts

NE Family parameter value: Removed duplicate information from Table 24 and Procedures 01 Getting started with
SX16F (1) 14, 22, and 23 Nokia Access
Virtualizer Adaptor and
5520 AMS/5529
Enhanced Applications

(1 of 2)

24 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide What’s new

Feature/enhancement Description Edition See

NE Family parameter value: Added the UNMANAGED value to the list of values for the NE 01 Table 24
UNMANAGED Family parameter located in the Define Query and Run Query Procedures 14, 22, and
windows, Collected Objects in Inventory view, and Exported 23
Objects in Inventory view

Queries for Removed duplicate information from section 8.1.5 01 5529 IDM Lightspan
NETCONF/YANG-managed SX-16F NE Support
devices (1) Plug-in Attributes Guide
for Nokia Access
Virtualizer Adaptor
Managed NEs

Querying custom attributes Updated the description of the Output radio buttons and Filter tab 01 Table 24
in the Define Query and Run Query windows with regard to
querying custom attributes (also known as custom fields)

Read-only attributes and Device Removed duplicate information from section 7.1 01 Getting started with
object updated based on change Nokia Access
notifications for Virtualizer Adaptor and
NETCONF/YANG-managed 5520 AMS/5529
devices (1) Enhanced Applications

(2 of 2)

Note
(1) NETCONF/YANG-managed devices supervised by the 5520 AMS require that you have the Nokia Access Virtualizer Adaptor installed.
Contact your Nokia technical representative for more information.

Edition 01 3JL-03001-BTAA-PCZZA 25
What’s new Installation, Administration, and User Guide

26 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Getting started

3 Getting started
3.1 Overview of this guide

3.2 Overview of the 5529 IDM

3.3 Standalone and cluster 5529 IDM deployments

3.4 Security recommendations

3.5 System requirements

3.6 NE support plug-ins

3.7 Technologies and standards

3.8 Permissions and privileges

3.1 Overview of this guide

The 5529 IDM Installation, Administration, and User Guide contains general
information about using the 5529 IDM, and procedures for tasks that you can perform
using the 5529 IDM GUI. These tasks include:
• collect inventory data from the NEs supervised by the 5520 AMS
• configure complex queries and scheduled queries
• execute complex queries on the collected NE inventory data
• review query results directly on the GUI or in CSV files on the server
• view inventory data stored in the 5529 IDM database from the Inventory Browser
perspective
• report inventory data to an OSS client application through the NBI
• configure the application settings
Before you start using the 5529 IDM, ensure that the:
• 5529 IDM is installed and licensed on the 5520 AMS server; see chapter 4 and
the 5520 AMS Installation and Migration Guide
• 5529 IDM support plug-ins for all the NEs in your network are installed on the
5520 AMS; see the 5520 AMS Installation and Migration Guide
• NEs in your network are supervised by the 5520 AMS; see the Operations and
Maintenance guides for the NEs in your network

Edition 01 3JL-03001-BTAA-PCZZA 27
Getting started Installation, Administration, and User Guide

3.2 Overview of the 5529 IDM

The 5529 IDM is an inventory management solution that provides a centralized
repository of access network inventory information. The 5529 IDM helps you find and
identify specific objects in the access networks. The 5529 IDM covers the important
aspects of network reporting: from details about equipment configuration to
specialized listings of available ports.
The 5529 IDM integrates with the 5520 Access Management System, and can be
accessed from the 5520 AMS client.
The 5529 IDM has the following components:
• the 5520 AMS client component, which allows you to access the 5529 IDM
functionality from the 5520 AMS client to perform inventory management tasks
such as inventory data collections and queries
• the NBI component, which allows OSS client applications to perform the following
tasks:
• retrieve inventory data using SOAP as the web service messaging format to
exchange XML-based messages over HTTP/S
• subscribe to notifications of NE inventory updates by way of a JMS provider
See the 5529 IDM Northbound Interface Guide for information about the NBI
component of the 5529 IDM.

3.3 Standalone and cluster 5529 IDM

deployments
You can install the 5529 IDM in standalone and cluster deployments.

3.3.1 Standalone deployment

In the standalone deployment, a single 5529 IDM is installed on a 5520 AMS server.
In the event of a server failure, the 5529 IDM stops processing inventory information,
and restarts when the 5520 AMS restarts.
Figure 1 shows the 5529 IDM architecture in a standalone deployment.

28 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Getting started

Figure 1 5529 IDM architecture—standalone deployment

5520 AMS client OSS clients

Web services JMS provider

NE 5529 IDM
support Inventory data
repository

5520 AMS
base components

5520 AMS

JBoss

NE NE NE

Operations (HTTP/S)
Notifications (JMS)
20017

3.3.2 Cluster deployment

In a cluster deployment, multiple 5529 IDM instances run on parallel 5520 AMS
servers. In the event of a server failure, the 5529 IDM is still accessible on the active
cluster NEs. The clustering infrastructure provides a high degree of redundancy.
A cluster-aware connector manages the connection between the OSS clients and
the cluster. Figure 2 shows the cluster deployment. See the 5520 AMS Northbound
Interface Guide for more information about the OSS client connection to the cluster.

Edition 01 3JL-03001-BTAA-PCZZA 29
Getting started Installation, Administration, and User Guide

Figure 2 5529 IDM architecture—cluster deployment

OSS client

Cluster-aware
connector

Subnetwork

Cluster NE 1 Cluster NE 2 Cluster NE 3

20053

You also need to configure the OSS client applications to work in a high-availability
configuration. See the 5529 IDM Northbound Interface Guide for more information.
The connection between the 5529 IDM and the client applications (5520 AMS and
OSS clients) is different for the 5520 AMS GUI, HTTP/S, and JMS clients. The
5520 AMS GUI connection to the cluster is part of the 5520 AMS core features. See
the 5520 AMS Northbound Interface Guide for more information about the OSS
client connection to the cluster in a cluster deployment.
For information about setting up the 5520 AMS in a cluster deployment, see the
5520 AMS Solution Planning Guide and 5520 AMS Server Configuration Technical
Guidelines. For information about the 5520 AMS GUI connection to the cluster, see
the 5520 AMS Installation and Migration Guide.

3.3.3 Geographic redundancy

The 5520 AMS supports geographic redundant deployments in which the 5529 IDM
is installed on the servers in both primary and secondary sites. The primary site is
active and contains the operational servers, which share the processing load. The
secondary site is on standby and contains the inactive application servers. The
geographic redundancy provides enhanced reliability, and protects your network
from a disaster-related failure at the active site. For more information about
geographic redundancy, see the 5520 AMS Installation and Migration Guide.

30 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Getting started

3.4 Security recommendations

To ensure the security of the 5529 IDM operations, Nokia recommends the following:
• use HTTP/S exclusively
• use SFTP for file transfer
• use secure JMS only
For information about the 5520 AMS-specific security recommendations, see the
5520 AMS documentation.

3.5 System requirements

The 5529 IDM is installed on the 5520 AMS server. You need additional available
disk space and system resources on the 5520 AMS server for the 5529 Enhanced
Applications.
For more information about system requirements, see the 5520 AMS Solution
Planning Guide.

3.6 NE support plug-ins

The 5529 IDM requires NE support plug-in software to be able to process inventory
data for the NEs in your network. See the 5520 AMS Release Notice for information
about the supported NE plug-ins.
Each NE support plug-in has a Release Notice for the NE support plug-in, which
provides information about the software.

3.7 Technologies and standards

The 5529 IDM platform is based on the following technologies and standards:

• XML 1.0 • JMS 1.1

• XML Schema (XSD) 1.0 • HTTP and HTTPS 1.1
• SOAP 1.1/1.2 • MTOSI 1.1
• WSDL 1.1 • TMF OSS interfaces (TMF 854)

Edition 01 3JL-03001-BTAA-PCZZA 31
Getting started Installation, Administration, and User Guide

See the following web sites for more information:

• http://www.w3.org/TR/2004/REC-xml- • http://www.w3.org/TR/2001/NOTE-ws
20040204 (W3C standards about dl-20010315 (WSDL 1.1)
XML 1.0, third edition) • http://www.oracle.com/technetwork/jav
• http://www.w3.org/TR/2001/REC-xml a/jms/index.html (JMS 1.1)
schema-1-20010502 (XSD) • http://www.ietf.org/rfc/rfc2616.txt
• http://www.w3.org/TR/2000/NOTE-S (HTTP 1.1)
OAP-20000508 (SOAP 1.1) • http://www.tmforum.org (TMF and
• https://www.w3.org/TR/soap12/ MTOSI)
(SOAP 1.2)

3.8 Permissions and privileges

Permissions and privileges for accessing views, objects, attributes, and NEs with the
5529 IDM and for performing operations and tasks with the 5529 IDM are provided
through the following:
• 5529 IDM user functions and roles that allow you to execute certain tasks or
access specific functionality or features depending on the functions and roles
granted to you; see section 5.1
• PAPs and PAP groups that specify the NEs and NE groups that are available to
you; see the 5520 AMS Administrator Guide for more information

Note — From R9.6.03 onward, the 5529 IDM no longer reports

attributes in the GUI or in query export files for attributes for
which you do not have read permission.

32 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Installation, migration, and administration

Installation, migration, and

administration
4 Installation and migration

5 Administration

Edition 01 3JL-03001-BTAA-PCZZA 33
Installation, migration, and administration Installation, Administration, and User Guide

34 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Installation and migration

4 Installation and migration

4.1 Installation overview

4.2 Migration overview

4.3 NE support plug-in migration

4.4 5529 IDM data removal

4.5 5529 IDM and NE support plug-in uninstallation

4.1 Installation overview

This chapter describes the installation information that applies only to the 5529 IDM.
The 5529 IDM application is a software plug-in. You can install the 5529 IDM
application and NE support plug-ins only on a 5520 AMS server, in a collocated
configuration. Before you proceed, you need the software files; see the 5529
Enhanced Applications Release Notice for information about the files that you need.
See the 5520 AMS Installation and Migration Guide for information about
downloading software files and installing software plug-ins. See the 5520 AMS User
Guide for information about viewing plug-ins in the 5520 AMS GUI.
The installation of the 5529 IDM is a two-step process:
• Install the application and NE support plug-in files on the 5520 AMS server.
• Activate the application and NE support plug-ins. The activation script copies the
application files to a deployment directory.

In a cluster deployment, install and activate the 5529 IDM on each application server
in the cluster.
Caution 1 — A cluster deployment should not have two application
servers running with different plug-ins installed. After you install the
5529 IDM on one application server, stop the other servers before
starting the updated server.

Caution 2 — The 5529 IDM application cannot be installed on a

running 5520 AMS server. The 5520 AMS server must be stopped, the
5529 IDM installed, and the 5520 AMS server restarted.

Edition 01 3JL-03001-BTAA-PCZZA 35
Installation and migration Installation, Administration, and User Guide

4.2 Migration overview

For information about migrating from an earlier 5529 IDM release to the current
release, and migrating between operating systems and architectures, see the
5520 AMS Installation and Migration Guide.
For information about the supported migration paths for the current release, see the
5520 AMS Release Notice.
Coordinate the migration tasks with the 5520 AMS administrator; you need to collect
the configuration information for the earlier release before the 5520 AMS is upgraded
to the current release.

Note — Users and settings are migrated, but collected NE information

is not. After an upgrade, you need to collect the NE information again.

Before you proceed:

• The 5520 AMS release and 5529 IDM release that you are going to migrate from
must be running.
• Ensure that the Keep Configuration parameter on the IDM NBI Settings window
is enabled; see Procedure 8.

4.3 NE support plug-in migration

New versions of NE support plug-ins are released occasionally. Use the procedures
in this section to update individual plug-ins and roll back the upgrade if necessary.
Deactivation of a plug-in does not remove the configuration of objects to be collected.
The configuration will continue to apply to the new version of the plug-in. If any of the
objects you had configured for collection are not supported by the new version, they
will be removed from the list when the new version is activated.
Before you proceed:
• The 5529 IDM must be installed, configured, and running on the 5520 AMS
server; see the 5520 AMS Installation and Migration Guide.
• The applicable NE support plug-ins must be available for installation. Plug-in files
are downloaded as .tar files. For information about downloading the files, see the
Release Notice for the NE support plug-in.
• You need to be able to log in as amssys to the 5520 AMS server.
Perform Procedure 4 to install and update an NE support plug-in. Perform Procedure
5 to roll back the migration of an NE support plug-in.

36 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Installation and migration

Procedure 4 To install and update an NE support plug-in

1 Log in to the server hosting the plug-in as amssys; see the 5520 AMS Administrator Guide.

2 Install the new plug-in; see the 5520 AMS Installation and Migration Guide.

3 Remove 5529 IDM collected data by typing:

remove_idm_data.sh ↵

4 See the 5520 AMS Installation and Migration Guide to perform the following:

i Stop the 5520 AMS server.

ii Deactivate the old plug-in.

iii Activate the new plug-in.

iv Start the 5520 AMS server.

Procedure 5 To roll back an NE support plug-in

1 Log in to the server hosting the plug-in as amssys.

2 Remove 5529 IDM collected data by typing:

remove_idm_data.sh ↵

3 See the 5520 AMS Installation and Migration Guide to perform the following:

i Stop the 5520 AMS server.

ii Deactivate the new plug-in.

iii Activate the old plug-in.

iv Start the 5520 AMS server.

Edition 01 3JL-03001-BTAA-PCZZA 37
Installation and migration Installation, Administration, and User Guide

4.4 5529 IDM data removal

The 5520 AMS provides the remove_idm_data.sh script, which you can use to
remove all NE inventory data from the 5529 IDM database. You need to run the script
in emergency situations (for example, if you suspect the database results are not
correct which would indicate database corruption), or, optionally, when uninstalling
the 5529 IDM. The removed database tables that contain the NE inventory data are
logged to the remove_idm_data.log file.
The remove_idm_data.sh script is deployed on the 5520 AMS database server
during the 5520 AMS installation.
Before you proceed, you need to be able to log in as amssys to the 5520 AMS
database server.
Perform Procedure 6 to remove 5529 IDM data from the 5520 AMS database server.

Procedure 6 To remove 5529 IDM data

1 Log in as amssys to the 5520 AMS database server; see the 5520 AMS Administrator Guide.

2 Run the 5529 IDM data removal script by typing:

remove_idm_data.sh ↵

The script removes the following 5529 IDM data:

• database tables that contain collected NE inventory data

• 5529 IDM shared data stored on the database server

If you run the script to fix a database-related problem, you need to perform a new inventory
data collection on the NEs in your network after running the script. For more information
about inventory data collections, see chapter 7.

4.5 5529 IDM and NE support plug-in

uninstallation
To uninstall the 5529 IDM and NE support plug-ins, see the 5520 AMS Installation
and Migration Guide for information about uninstalling plug-ins for 5529 Enhanced
Applications.

38 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Administration

5 Administration
5.1 User authentication and authorization

5.2 Licensing

5.3 5529 IDM NBI settings

5.4 Logs

5.5 EMS license alarms

5.6 5529 IDM and the 5520 AMS Software Version Mismatch (SWVER)
alarm

5.1 User authentication and authorization

The 5529 IDM relies on the 5520 AMS security and user management to
authenticate users.
The 5520 AMS user authentication and authorization is based on roles and
functions. Users can execute certain tasks or access specific functionality depending
on the roles and functions granted to them.
Create and configure users and user associations with the roles and functions in the
Administration perspective of the 5520 AMS client; see the 5520 AMS Administrator
Guide for information about managing user functions and roles.
Table 6 describes the 5529 IDM user functions and roles.
Table 6 5529 IDM user functions and roles

Function Role Description

Administrator Constructor Operator NBI System IDM NBI

AMS NBI - ✓ ✓ Enables NBI OSS client applications to

Notify subscribe to inventory data notifications.

(1 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 39
Administration Installation, Administration, and User Guide

Function Role Description

Administrator Constructor Operator NBI System IDM NBI

Filters - Admin ✓ ✓ Enables a user to create a query, and to save

it as either a public or a private query. Private
queries are visible only to the users who
created them, while public queries are visible
to all users.
Queries created by users who do not have
this function are saved locally as private
queries, and are visible only to their authors.
See the 5520 AMS Administrator Guide for
information about the Filters - Admin function
that allows you to modify or delete public
filters that are created by any user.

IDM NBI ✓ Enables a user to configure IDM NBI Settings

Settings - Edit parameters in the Administration
perspective.

IDM NBI ✓ Enables a user to view the IDM NBI settings

Settings - View in the Administration perspective.

Inventory - ✓ ✓ ✓ Enables a user to perform an inventory

Collect collection.

Inventory - ✓ ✓ ✓ Enables a user to run inventory data queries

Query and to display query results in the Inventory
Query Results view.
You can also:
• schedule a query
• save query results to a file on the local
workstation
• configure client query result settings

Inventory NBI - ✓ Enables a user to access the 5529 IDM

Administrator admin and services web pages.

Inventory NBI - ✓ Enables NBI OSS client applications to

System perform inventory system operations.

Inventory NBI - ✓ Enables NBI OSS client applications to

View perform inventory data operations.

Inventory ✓ Enables a user to configure Inventory

Settings - Edit Settings parameters in the Administration
perspective

Inventory ✓ Enables a user to view the Inventory Settings

Settings - View in the Administration perspective.

(2 of 2)

5.1.1 Client OS authentication

If the 5520 AMS is configured for trusted host login, you need to bypass the EMS
System site authentication source setting (client OS) so that the 5529 IDM OSS
client applications can connect to the 5520 AMS.

40 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Administration

Procedure 7 describes how to configure client OS authentication. Perform the

procedure for each IDM OSS user account that has a role with the Inventory NBI
functions.

Procedure 7 To configure the 5529 IDM OSS to use the internal database

1 Log in to the 5520 AMS server as an administrator, and open the Administration perspective.

2 Navigate to EMS Administration→User Management→Users, and click on a user account

that has a role with the Inventory NBI functions. The Object Details page opens.

3 On the Advanced tab, select the Use Internal Database check box, and click on the Apply
icon ( ) to save the change.

5.2 Licensing
A license key is required to enable 5529 IDM software packages. You need to add
the 5529 IDM license key to the 5520 AMS licensing management system in the
Administration perspective. See the 5520 AMS Administrator Guide for information
about creating, managing, and viewing licenses.

5.2.1 License validation

The 5529 IDM receives notifications of any license addition or removal from the
5520 AMS licensing management system. The license addition triggers the
5529 IDM license validation. The 5529 IDM performs a license validation as follows:
• on the first startup, as soon as the connection to the 5520 AMS licensing
management system has been established
• every 24 hours after the initial startup validation (if no license change triggered a
license validation in the meantime)
• every time a 5529 IDM license is added to the 5520 AMS licensing management
system

The following considerations apply to the license validation:

• The 5529 IDM validates the license parameters one after another.
• The first invalid license parameter raises a license exception; as a result, the
5529 IDM creates a license alarm and adds it to the 5520 AMS Internal Alarm
service.

Edition 01 3JL-03001-BTAA-PCZZA 41
Administration Installation, Administration, and User Guide

You can view the result of a 5529 IDM license validation in the server.log file on the
5520 AMS server.
If a license is invalid, the 5529 IDM raises a license alarm, starts to function in invalid
license mode, and blocks the execution of all inventory operations. If a license has
been removed from the system, the 5529 IDM application continues to function in the
current license mode until the next license validation.
The 5529 IDM GUI is disabled when the limit on the number of used subscribers is
reached. Because the 5529 IDM does not receive notifications about changes to the
number of subscribers being used by the 5520 AMS, you need to restart the
5520 AMS GUI client to re-enable the 5529 IDM GUI after the number of used
subscribers is reduced to below the limit.

5.2.2 License alarms

The 5529 IDM generates the following license alarms:
• Invalid IDM License (default severity: Critical)
• Number Of IDM Subscribers Exceeded (default severity: Warning)
You can configure the severity assignment of the 5529 IDM license alarms and turn
off the reporting of these alarms; see the 5520 AMS Administrator Guide.

Note — To ensure that the 5529 IDM notifies you of any license-related
events, keep the default severity for each alarm and do not turn off the
license alarm reporting.

See section 5.5 for more information about alarms.

5.3 5529 IDM NBI settings

Perform Procedure 8 to configure the 5529 IDM NBI settings in the 5520 AMS GUI.
See the 5520 AMS Administrator Guide for information about configuring the JMS
message delivery mode.
Before you proceed, ensure that your 5520 AMS user account is assigned the
necessary functions to perform this procedure. See the 5520 AMS Administrator
Guide for more information about 5520 AMS function descriptions.

42 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Administration

Procedure 8 To configure 5529 IDM NBI settings

1 Log in to the 5520 AMS server GUI; see the 5520 AMS Administrator Guide for more
information.

2 In the 5520 AMS Administration Tree, choose EMS

Administration→Configuration→NBI→IDM NBI Settings.

3 In the Object Details view, configure the parameters as described in Table 7.

Table 7 5529 IDM NBI settings parameters

Parameter Description Value

Operation Timeout Specifies the timeout value (in seconds) elapsed between iterations of an 60 to 3600
operation The default is 180.

Heartbeat Enabled Enables the 5529 IDM to publish Heartbeat notifications to the Inventory Enabled or Disabled
topic The default is Enabled.

Heartbeat Interval Specifies the time interval (in seconds) at which the Heartbeat 1 to 900
notifications are published to the Fault topic The default is 60.

Domain Name Specifies the name of the Management Domain (the 5520 AMS server) An alphanumeric string
The default is AMS.

Keep Configuration Controls whether the user account configuration is saved or removed Enabled or Disabled
when the 5529 IDM is undeployed. The default is Enabled.
If the Keep Configuration parameter is enabled and the 5529 IDM is
undeployed, the 5529 IDM roles, functions, and configured user accounts
are saved.

Max. Number of Concurrent The number of concurrent HTTP/S client getInventory and query 1 to 20
Iterative Operations operations that are allowed. The default is 3.
There is no limit to the number of JMS durable/non-durable subscriptions.
However, there can only be one active subscriber to a durable
subscription.

Max. Number of Concurrent The number of parallel exportNetwork operations that can be executed 1 (default) to 10
‘exportNetwork’ Operations when an NE list is provided in the operation.
containing NE List When no NE list is provided, the scope of the operation is the network.
When the scope is the network, only one exportNetwork operation can be
executed at a time.

Max. Number of NE Names in The number of NE names in an exportNetwork operation for which 1 (default) to 100
‘exportNetwork’ Operations information can be retrieved

(1 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 43
Administration Installation, Administration, and User Guide

Parameter Description Value

Support NE IP instead of NE Specifies whether the value for the managed element name (meNm) NE Name (default) or IP
name attribute in the object FDN is the NE name or the IP address of the NE. Address
By default, the 5529 IDM NBI expects that the meNm attribute value is the
NE name.
You can also set the parameter to IP Address. The 5529 IDM NBI then
expects that the meNm attribute value is the IP address of the NE. When
an operation is run, the 5529 IDM NBI retrieves the NE name from the
5520 AMS using the IP address, then continues processing the
operation. In the operation response, the IP address of the NE is
displayed instead of the NE name in the object FDN. The IPv4 and IPv6
formats for IP addresses are supported.

Max. Number of Top Objects in The number of top-level objects allowed for a query operation 1 (default) to 100
‘query’ Operation

(2 of 2)

4 The Information tab displays the application and status parameters, which are described in
Table 8.

If the status parameters are correct, the 5529 IDM is running properly. If any of the status
parameters are incorrect, investigate and fix the issue, as required.

You can also obtain information about the installed 5529 IDM version by using the
getSystemInfo operation. For information about the getSystemInfo operation, see the
5529 IDM Northbound Interface Guide.

44 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Administration

Table 8 5529 IDM NBI settings—information parameters

Parameter Description Value

Product

Product Full Name Displays the full name of the Nokia 5529 Inventory Data
product. Manager

IDM Version Displays the release of the licensed Release number (for example, 9.7)
application.

Status

Application Status Displays the status of the Running

5529 IDM application. This value indicates that the
5529 IDM is up and running.

License Displays the status of the Valid or Invalid

application license.

HostID Displays the ID of the licensed local String identifying the host
5520 AMS host. 5520 AMS server

Expiration Date Displays the license expiration License expiration date and time
date.

Release Displays the main release of the Main release number (for example,
licensed application. 9.6)

NBI Displays whether the licensed Enabled or Disabled

northbound interface is enabled.

Next License Validation Displays the next license validation Date and time of the next license
time. validation

License Violation Reason Displays the license violation String indicating the reason of the
reason, if any. license violation; for example,
License Expired.

Number of Licensed Subscriber Displays the number of licensed Integer

Lines subscriber lines.

Number of Actual Subscriber Lines Displays the number of actual Integer

subscriber lines.

Installed Plugins

Installed Plugins Displays the installed NE support List of installed NE support

plug-ins. plug-ins; for example, Nokia
iSAM.5.6

5 Click on the Apply icon ( ) to save the changes.

Edition 01 3JL-03001-BTAA-PCZZA 45
Administration Installation, Administration, and User Guide

5.4 Logs
This section describes the following log files:
• inventory.log
• nbi.log
• server.log
For information about viewing logs from the GUI, see the 5520 AMS Administrator
Guide.

5.4.1 inventory.log
The 5529 IDM logs information to the inventory.log in the $AMS_LOG_DIR directory.
Table 9 describes the 5529 IDM log.
Table 9 5529 IDM log

Filename Description Default maximum Default maximum

file size (Mbytes) number of archives

inventory.log Records 5529 IDM-specific messages 20 10

5.4.2 nbi.log
The 5529 IDM logs information to the nbi.log file in the $AMS_DEBUG_DIR
directory.

Note — In a cluster deployment, log information is recorded on the

server where the authentication is done.

The nbi.log file contains 5529 IDM NBI-specific messages and JMS client
connection, disconnection, and authentication failure messages.
The 5529 IDM logs information about the result of operation requests sent by OSS
client applications to the nbi.log file. The 5529 IDM supports logging for the
operations described in the 5529 IDM Northbound Interface Guide.
Each new operation request adds a new entry to the nbi.log. Each log entry starts
with a timestamp that indicates when the operation was completed or failed, and
contains keywords that identify information blocks about the operation result. Two
adjacent information blocks are delimited by a comma.

46 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Administration

Table 10 describes the keywords that can be present in an nbi.log entry for the result
of an operation request.
Table 10 nbi.log file keywords

Keyword Description

INFO JBOSS log level information

Operation: Name of the supported operation that was sent in the request
Examples: exportNetwork, getInventory, getSystemInfo

SourceIP: Source IP address of the OSS client (or load balancer) that sent the operation
request.
When the SourceIP information is present in the log, the X-Forwarded-For
information is not present in the log.

X-Forwarded-For: Original source IP address of the OSS client that is sent the operation request.
The X-Forwarded-For is an HTTP header field that is used to identify the
originating IP address of an OSS client that originated the request through an
HTTP proxy or load balancer. For more information about the
X-Forwarded-For field, see the 5520 AMS Northbound Interface Guide.
When the X-Forwarded-For information is present in the log, the SourceIP
information is not present in the log.

Username: Name of the OSS client application that sent the operation request

Result: Result of the operation

Example: Success or Failed

ErrorCode: Error code if the operation result is Failed

The error code in the nbi.log is the same error code that is provided in the
operation response.

ErrorMessage: User-friendly description of the error if the operation result is Failed

The following logs in the nbi.log file are examples of JMS client connection,
disconnection, and authentication failure messages:
• Login: 2015-05-29 11:43:29,091 INFO [idm/oss-nbi-13834]-[IDM/OSS-NBI]
[com.alcatel.axs.container.jms.DurableSubscribersInterceptor] User IDMNBI
logged in from IP_address
• Logout: 2015-05-29 11:44:12,021 INFO [idm/oss-nbi-13834]-[IDM/OSS-NBI]
[com.alcatel.axs.container.jms.DurableSubscribersInterceptor] User IDMNBI
logged out from IP_address
• Failed connection: 2015-05-29 11:45:26,388 INFO [nbi-13834]-[NBI]
[com.alcatel.axs.container.jms.DurableSubscribersInterceptor] Failed login
attempt made for User IDMNBI from IP_address

For more information about the nbi.log file, see the 5520 AMS Administrator Guide.

Edition 01 3JL-03001-BTAA-PCZZA 47
Administration Installation, Administration, and User Guide

5.4.3 server.log
The 5529 IDM logs information to the server.log file in the $AMS_DEBUG_DIR
directory.

Note — In a cluster deployment, log information is recorded on the

server where the authentication is done.

The server.log file contains communication messages exchanged with the

5520 AMS, internal error messages, and details about processing events from the
5520 AMS.
For more information about the server.log file, see the 5520 AMS Administrator
Guide.

5.4.4 Setting inventory tracing levels

You can set the inventory tracing level for an NE from the GUI; see the 5520 AMS
Administrator Guide. To set the inventory tracing level, choose Inventory Debug.

5.4.5 Filtering and aggregating tracing logs by NE

From the GUI, you can filter inventory tracing logs by NE. For a cluster installation,
you can also aggregate all the inventory tracing logs for the application servers of an
NE. For more information about how to view inventory tracing logs by NE from the
GUI, see the 5520 AMS Administrator Guide. To view the inventory tracing logs,
choose Inventory.

5.5 EMS license alarms

See the 5520 AMS and 5529 Enhanced Applications Alarm Search Tool for
information about the EMS license alarms raised by the 5529 IDM, and about
inventory collection alarms. See the 5520 AMS Administrator Guide for information
about EMS inventory alarms.

48 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Administration

5.6 5529 IDM and the 5520 AMS Software Version

Mismatch (SWVER) alarm
The 5520 AMS uses the clear event of the Software Version Mismatch (SWVER)
alarm to refresh the active software version of the ONT in the 5529 IDM. This
process is successful when the ONT Software Version Control Table in the
5520 AMS is used. The ONT Software Version Control Table allows the 5520 AMS
to be responsible for replanning the ONT software. When other systems replan the
ONT software (for example, CLI operator, migration script, or using the ONT
Software Version Control Table in the NE), there is a risk that the clear event is
missed and the 5529 IDM may not be updated as a result.

Edition 01 3JL-03001-BTAA-PCZZA 49
Administration Installation, Administration, and User Guide

50 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Using the 5529 IDM

Using the 5529 IDM

6 Functionality and settings

7 Inventory data collection

8 Queries

9 Network export

10 Inventory Browser perspective

Edition 01 3JL-03001-BTAA-PCZZA 51
Using the 5529 IDM Installation, Administration, and User Guide

52 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

6 Functionality and settings

6.1 Perspectives

6.2 Icons

6.3 Inventory settings

6.4 Inventory job queues

6.5 Users

6.6 Managing schedules

6.7 Performance monitoring

6.1 Perspectives
You can access or use the 5529 IDM functionality from the following 5520 AMS client
perspectives:
• Inventory Query perspective
• Inventory Browser perspective
• Network perspective
• Scheduler perspective

The Network perspective and Scheduler perspective are standard 5520 AMS
perspectives. The Inventory Query and Inventory Browser perspectives are specific
to the 5529 IDM.
For more information about logging in to the 5520 AMS server, and working with
perspectives, see the 5520 AMS User Guide.

Note — When a data string is displayed in the GUI or exported to a

CSV file, the number of characters in the string is limited to 21844. If the
data string is longer than 21844 characters, only the first 21844
characters of the string are displayed and the remainder of the string is
truncated.

6.1.1 Inventory Query perspective

The Inventory Query perspective is available only if the 5529 IDM is installed on the
5520 AMS server.

Edition 01 3JL-03001-BTAA-PCZZA 53
Functionality and settings Installation, Administration, and User Guide

You can use the Inventory Query perspective to collect data, work with inventory data
queries, and export results. You need a userID with the Inventory - Query function to
be able to work with inventory data queries. For more information about 5529 IDM
user functions and roles, see section 5.1.
You can access the Inventory Query perspective through the Open perspective icon
( ) when you log in to the 5520 AMS client.
The Inventory Query perspective has the following views:
• Inventory Tasks view—has links that you click on to perform tasks to collect data,
perform query-related tasks, and perform bulk network export
• Inventory Query Results view—shows query results and has toolbar icons. See
section 8.3 for more information about the Inventory Query Results view.
• Action view —shows inventory actions and has toolbar icons
Depending on the task you are performing, you use additional views such as the
following ones from the 5520 AMS menu (through Window→Show View) in
conjunction with the Inventory Query perspective:
• Collected Objects in Inventory view
• Exported Objects in Inventory view

6.1.2 Inventory Browser perspective

The Inventory Browser perspective is available only if the 5529 IDM is installed on
the 5520 AMS server.
You can use the Inventory Browser perspective to access NE object information
when an NE becomes isolated or unsupervised.
You can access the Inventory Browser perspective through the Open perspective
icon ( ) when you log in to the 5520 AMS client. You can also access the Inventory
Browser perspective through the Network perspective as described in chapter 10.
The Inventory Browser perspective has the following views:
• Inventory Tree view
• Graphical View
• Object Details view
See chapter 10 for more information about the Inventory Browser perspective,
including information about the views.

6.1.3 Network perspective

The Network perspective is the default 5520 AMS perspective that opens after you
log in to the 5520 AMS.

54 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

From the Network perspective, you can view collection status information, launch
inventory data collections and queries, and open the Inventory Browser perspective.
You need a userID with the Inventory - Query and Inventory Settings - Edit functions
to be able to launch and perform inventory tasks from the Network perspective. For
more information about 5529 IDM user functions and roles, see section 5.1.
For general information about the Network perspective, see the 5520 AMS User
Guide.
You can use the Network perspective as an alternate navigation method for
object-related inventory tasks through a shortcut menu available by right-clicking on
an NE group or NE and choosing Inventory. Table 11 describes the contextual menu
options that are available for inventory tasks through the Network perspective.
Table 11 Inventory options available through the Network perspective

Option Action

Browser This option opens the Inventory Browser perspective, and takes you to the same NE in this
perspective; see chapter 10.

Query This option opens the Inventory Query perspective and the Run Query window so that you can run
an inventory data query immediately; see Procedure 18.

Collect This option opens the Schedule Collection window so that you can select the NEs to be included
in the inventory data collection, and either force the collection to start immediately or identify a
schedule for the collection to use; see Procedure 15.

6.1.4 Scheduler perspective

The Scheduler perspective is a standard 5520 AMS perspective that you use to
create schedules that can be used for inventory data collection, queries, and network
export.
You need a userID with the Inventory - Edit and Collect functions to be able to
perform tasks for the 5529 IDM from the Scheduler perspective. For more
information about 5529 IDM user functions and roles, see section 5.1.
For general information about the Scheduler perspective, see the 5520 AMS User
Guide.
See section 6.6 for more information about managing schedules.

6.2 Icons
Table 12 identifies and describes the icons that are specific to the 5529 IDM
application. See the 5520 AMS User Guide for information about the 5520 AMS
icons.

Edition 01 3JL-03001-BTAA-PCZZA 55
Functionality and settings Installation, Administration, and User Guide

Table 12 5529 IDM icons

Icon Icon name Icon description

Perspective icons

Inventory Query Opens the Inventory Query perspective

Inventory Browser Opens the Inventory Browser perspective

View icons

Query Identifies the Query, Inventory Query Results, and Inventory

Inventory Query Tasks views
Results
Inventory Tasks

Inventory Tree Identifies the Inventory Tree view

Collected Objects in Identifies the Collected Objects in Inventory view

Inventory

Exported Objects in Identifies the Exported Objects in Inventory view

Inventory

Action Identifies the Action view

Collection Statistics Identifies the Collection Statistics view

Toolbar icons

Make Root Makes an object in the NE tab of the Inventory Tree the root of the
subtree.
The Make Root icon is enabled only when a single sub-object is
selected in the NE tab of the Inventory Tree.

Show Quick Search Opens the text search panel in the Inventory Tree

Pin Saves a static view of the Inventory Query Results table. You can
pin multiple Inventory Query Results views to compare them.
You can also change the position of a pinned table on the screen,
as required.

Query Opens the Run Query window

(1 of 5)

56 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

Icon Icon name Icon description

Navigate to Statistic Opens the Collection Statistics view in the Administration

View perspective, from the Collected Objects in Inventory view

Navigate to Collected Navigates to the Collected Objects in Inventory view from the
Objects in Inventory Collection Statistics view

Apply configuration Saves changes made in the Collected Objects in Inventory view

Create new profile Creates an export profile in the Exported Objects in Inventory
view

Open an existing profile Opens an export profile in the Exported Objects in Inventory view.
You can choose the profile you need to open from the drop-down
menu.

Save new profile or Saves an export profile in the Exported Objects in Inventory view.
save change to You can choose Save or Save As from the drop-down menu.
selected profile

Delete selected profile Deletes an export profile from the Exported Objects in Inventory
view

View Menu In the Inventory Query Results view, provides the following
options:
• Settings option to configure the following:
• number of query results supported per page
• location where displayed query results can be saved as
.csv files on a workstation
• number of records to be saved
• Save as CSV option to save the displayed query result in a
.csv file in the location on a workstation specified in the
Settings option
• Save as CSV to Server option to save the displayed query
results in a .csv file on the server.
• Copy→Page or Copy→All option to copy the results.

In the Action view, saves the displayed information to a .csv file in

a workstation location that you specify

In the Collected Objects in Inventory and Exported Objects in

Inventory views, saves the displayed information to a .csv file in a
workstation location that you specify

Minimize Minimizes the size of the view to less than the size of the page

(2 of 5)

Edition 01 3JL-03001-BTAA-PCZZA 57
Functionality and settings Installation, Administration, and User Guide

Icon Icon name Icon description

Maximize Maximizes the size of the view to the same size as the page

First Navigates to the first page in a multi-page query result, in the

Inventory Query Results table

Previous Navigates to the previous page in a multi-page query result, in the

Inventory Query Results table

Search the previous Navigates to the previous occurrence of the search criteria, in the
occurrence text search panel of the Inventory Tree

Next Navigates to the next page in a multi-page query result, in the

Inventory Query Results table

Search the next Navigates to the next occurrence of the search criteria, in the text
occurrence search panel of the Inventory Tree

Collapse all Collapses all expanded objects

Expand all Expands all collapsed objects

Close Closes the text search panel in the Inventory Tree

Clear Active Filters Clears the active filter in the Action view

Clear Text Search and Clears the text search and closes the filter in the Inventory Query
Close Filter Results view

Pack Adjusts the column width to the content in the Inventory Query
Results view

Pack Action Adjusts the column width to the content in the Action view

Open Query Result Opens a search panel that allows you to filter the inventory query
Filter results

Action Filter Opens the Action Filter window that allows you to filter the actions
in the Action view

Display only collected Filters the Collected Objects in Inventory view to show only
objects and attributes collected objects and attributes

Display only selected Filters the Exported Objects in Inventory view to show only
objects/attributes to exported objects and attributes
export

(3 of 5)

58 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

Icon Icon name Icon description

Cancel Query Stops a query that is in progress from the Inventory Query Results
view

Cancel Action Stops an action that is in progress from the Action view

Revert back to the last Reverses changes made in the Collected Objects in Inventory
saved configuration view

Discard all profile Reverses changes made in the Exported Objects in Inventory
changes view

Suspend Action Suspends an action

Resume Action Resumes a suspended action

Retry Action Retries a failed or canceled action

Refresh Updates the Action view and Exported Objects in Inventory view

Auto Refresh Automatically updates the Action view according to a predefined

interval

Action Details Shows the details of the selected action

Move to Historical Moves the selected item to the Historical Action view

Move to First Moves an item to the top of the Export Order list, in the Exported
Objects in Inventory view

Move Up Moves an item up one position in the Export Order list, in the
Exported Objects in Inventory view

Move Down Moves an item down one position in the Export Order list, in the
Exported Objects in Inventory view

(4 of 5)

Edition 01 3JL-03001-BTAA-PCZZA 59
Functionality and settings Installation, Administration, and User Guide

Icon Icon name Icon description

Move to Last Moves an item to the bottom of the Export Order list, in the
Exported Objects in Inventory view

(5 of 5)

6.3 Inventory settings

Inventory settings allow you to configure parameters that apply to inventory tasks.
The 5529 IDM supports two sets of inventory settings:
• Basic Settings
• Query Settings
When the 5529 IDM is not installed, the 5520 AMS contains a set of inventory Basic
Settings. The 5529 IDM does not add any additional basic settings when it is
installed. For information about the 5520 AMS inventory Basic Settings, including
how to configure the parameters, see the 5520 AMS Administrator Guide.

Note — When the 5529 IDM is installed, you have the option of
opening the Object Details view for the inventory Basic Settings from
the Show View window of the 5520 AMS. The parameters in the Object
Details view are modifiable but the Apply icon is not available to allow
you to save any changes. Select the Basic Settings object in the
Administration Tree and from the 5520 AMS main menu choose
Window→Show View→Other, then choose Inventory→Object Details
in the Show View window.

When the 5529 IDM is installed, it adds the Query Settings. The Query Settings
provided by the 5529 IDM add parameters that you can use for queries and network
exports. Perform Procedure 9 to configure the Query Settings.

Procedure 9 To configure Query Settings

You must be logged in to the 5520 AMS client with a userID that has the Inventory Settings - Edit
function.

1 In the Administration Tree, choose EMS Administration→Inventory→Query Settings.

2 Make any required changes in the Object Details view; see Table 13 for parameters.

60 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

Table 13 Query Settings parameters

Parameter Description Value

Query

Maximum Number of The maximum number of concurrent inventory data The range is 1 to 100.
Concurrent Queries queries per application server. The default is 10.
This is a configurable parameter; see section 6.4.

Maximum Number of The maximum number of records in a scheduled The range is 1 to

Records in Query Result query result that are saved to a file on the 2 147 483 647.
(Scheduled Queries) 5520 AMS server. The default is 100 000.
A value of 0 removes any
limit on the number of
records in a scheduled
query result saved to a
file.

Cleaning Server Files

Clean Server Files Enabled This check box controls the ability of the user to Enabled or Disabled
delete query files saved on the server. The default is Enabled.

Clean Server Query Files The query files saved on the server that are older The range is 1 to 90.
older than than the specified value (in days) are deleted The default is 90.
automatically.

Network Export Files

Maximum Number of When the maximum number of network export files The range is 1 to 100.
Network Export Files is exceeded, the oldest file is deleted automatically. The default is 5.

Enable Header Information This check box enables headers for each object in Enabled or Disabled
In Bulk Network Export the export profile to be included in the output file for The default is Disabled.
Operation network export operations.(1)

Prepend Site Name to Bulk This check box enables site names to be included Enabled or Disabled
Export File Name in the Bulk Network Data Export file to avoid The default is Disabled.
collisions of file names when exporting from
different sites.

CSV Separator for Server Query Files

CSV Separator Select the type of separator you need from the Tab (default), Semicolon,
drop-down menu. Comma, Space, or Other

Other CSV Separator If you select Other as the CSV Separator, enter a A single character other
character to act as a CSV separator. than a tab, semicolon,
The Other CSV Separator parameter is available comma, or space
when the CSV Separator parameter is set to Other.

Note
(1) See the 5529 IDM Northbound Interface Guide for information about the format of the headers included in the
output file for network export operations.

3 Click on the Apply icon ( ) to save the changes.

Edition 01 3JL-03001-BTAA-PCZZA 61
Functionality and settings Installation, Administration, and User Guide

6.4 Inventory job queues

The 5529 IDM allows you to schedule inventory data collections, inventory queries,
and network exports and to perform them manually. For each inventory operation,
the 5529 IDM creates a job and adds it to the job queue, where it is considered to be
run concurrently. Each job queue is independent and does not interfere with other
queues.
The scheduled operations can sometimes block the execution of manual operations.
To prevent this situation from happening, the 5529 IDM enables you to configure the
EMS administration for the maximum number of jobs for the operations executed in
parallel at a time (job queues).
The value of a job queue setting is not the number of jobs that a queue can hold, but
the number of jobs that the 5529 IDM can execute in parallel at the same time in a
queue. All the job queues are configured to be able to hold an unlimited number of
jobs, and cannot be full. See the 5520 AMS User Guide for how to configure the EMS
administration for the maximum number of jobs for the operations executed in
parallel at a time (job queues).
Table 14 describes the inventory job queues.

Caution — To ensure the best application performance, do not change

the default settings for the inventory job queues.

Table 14 Inventory job queues

Job queue Description Value

Inventory Manual Collection The number of jobs that run on each application server for manual The minimum guaranteed is 0.
inventory collections. The maximum allowed is 20.

Inventory Scheduled Collection The number of jobs that run on each application server for The minimum guaranteed is 5.
scheduled inventory collections. The maximum allowed is 20.

Inventory Real Time Update The percentage of jobs that run on each application server in real The minimum guaranteed is 5.
time. The maximum allowed is 40.

Inventory Scheduled Query The number of jobs that run on each application server for The minimum guaranteed is 1.
inventory scheduled queries. The maximum allowed is 20.

See Procedure 13 for how to view the job details that are associated with a schedule.

62 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

6.5 Users
The 5529 IDM users can perform certain tasks and access specific features
depending on their roles and functions. You need to be a 5520 AMS administrator to
be able to create and configure users. Create and configure users in the
Administration perspective of the 5520 AMS client, as required. See the 5520 AMS
Administrator Guide for more information about managing user functions and roles.
For information about user functions and roles specific to the 5529 IDM, see
section 5.1.

6.6 Managing schedules

Schedules allow you to perform inventory data collection, queries, and network
exports automatically on a regular basis according to your requirements.
When you configure an inventory data collection, query, or network export, you can
identify a schedule to be used for it. The inventory data collection, query, or network
export will start at the date and time specified in the schedule.

Note — Results from scheduled queries are not displayed;

instead they are saved directly to CSV files on the server.

Table 15 lists where to find information about the schedule procedures.

Table 15 Schedule procedures

Task See

To create a schedule Procedure 10

To modify a schedule Procedure 11

To remove a schedule Procedure 12

To view the job details associated with a schedule Procedure 13

Procedure 10 To create a schedule

You must be logged in to the 5520 AMS client as an Administrator user with the Inventory - Edit
function.

1 Click on the Open perspective icon ( ) and choose Scheduler. The Scheduler perspective
opens. The Scheduler perspective has the Schedule view which lists all the schedules.

2 In the Schedule view, click on the Add Schedule button. The Schedule window opens.

Edition 01 3JL-03001-BTAA-PCZZA 63
Functionality and settings Installation, Administration, and User Guide

3 Configure the parameters in the Schedule window, as required. Table 16 describes the
information that you need to configure in the Schedule window.

64 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

Table 16 Schedule window parameters

Parameter Option Description

Schedule Details

Schedule Name — Type a name for the schedule. The name cannot contain
special characters.

Description — Type a description of the schedule.

State Active Choose Active to allow this schedule to be assigned to tasks

Suspended or jobs in the 5520 AMS.
Choose Suspended to make this schedule unavailable for
assignment in the 5520 AMS.
The default is Active.

Start Date/Time — Click on the Date/Time button to display a calendar and a

time box to set the start date and time for the schedule.

End Date/Time — Click on the Date/Time button to display a calendar and a

time box to set the end date and time for the schedule.

Simple Schedule Details

Simple Schedule — Select the Simple Schedule radio button to make the Simple
Schedule Details area active.

Interval Once Choose and set the following options, as required:

Minutes • Once: to execute this schedule once, starting at the
Hours specified start time
Days
• Minute: minute for the start time of this schedule

Weeks
• Hour: hour for the start time of this schedule
• Day: to execute this schedule every day at the specified
time
• Week: to execute this schedule every week at the
specified time

The default is Days.

Repetitions — Enter the number of times you need the schedule to run. This
field is inactive if you choose Once as the Interval detail.

Complex Schedule Details

Complex Schedule — Select the Complex Schedule radio button to make the
Complex Schedule Details area active.

Daily — Select this option to specify that the schedule is performed

daily.

Weekly — Select this option to specify that the schedule is performed

weekly.
You also need to select the days of the week on which you
need to perform the schedule.

(1 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 65
Functionality and settings Installation, Administration, and User Guide

Parameter Option Description

Days of week Sunday If you set the schedule to Weekly, select the check boxes for
Monday the days on which you need to perform the schedule.
Tuesday
Wednesday
Thursday
Friday
Saturday

Monthly — Select this radio button to specify that the schedule is

performed once a month.

Day of Month First day of the If you set the schedule to Monthly, you can configure the
month schedule to run on the first or last day of the month, every nth
Last day of the day of the month, or every x day of every y week of the
month month.
Every (Nth) day of
the month
Every x day of every
y week of the month

(2 of 2)

4 Click on the Finish button to create the schedule. The new schedule is added to the list of
schedules in the Schedule view.

See Procedure 13 for how to view schedule information, including the jobs associated with a
schedule.

Procedure 11 To modify a schedule

You must be logged in to the 5520 AMS client as an Administrator user with the Inventory - Edit
function.

1 Click on the Open perspective icon ( ) and choose Scheduler. The Scheduler perspective
opens. The Scheduler perspective has the Schedule view which lists all the schedules.

2 In the Schedule view, select the schedule you need to modify and then click on the Update
Schedule button. The Schedule window opens.

3 Update the parameters in the Schedule window, as required. Table 16 describes the
information that you can update in the Schedule window.

4 Click on the Finish button to modify the schedule.

66 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Functionality and settings

See Procedure 13 for how to view schedule information, including the jobs associated with a
schedule.

Procedure 12 To remove a schedule

You must be logged in to the 5520 AMS client as an Administrator user with the Inventory - Edit
function.

1 Click on the Open perspective icon ( ) and choose Scheduler. The Scheduler perspective
opens. The Scheduler perspective has the Schedule view which lists all the schedules.

2 In the Schedule view, select the schedule you need to delete and then click on the Delete
Schedule button. The 5529 IDM opens a window and asks you to confirm that you want to
delete the schedule.

Procedure 13 To view the job details associated with a schedule

1 Click on the Open perspective icon ( ) and choose Scheduler. The Scheduler perspective
opens. The Scheduler perspective has the Schedule view which lists all the schedules.

2 In the Schedule view, click on the schedule of interest in the list of schedules. The Schedule
details panel and the List of jobs panel open.

3 Double-click on a job in the List of jobs panel. The Job Details window opens and provides
job details. The List of Jobs table is empty for a newly created schedule.

See the 5520 AMS Administrator Guide for information about how to modify a schedule job.

6.7 Performance monitoring

You can check 5529 IDM performance statistics in the Inventory folder in the EMS
Performance Monitoring view of the 5520 AMS GUI. The 5520 AMS EMS
Performance Monitoring view displays graphs that illustrate the following 5529 IDM
statistical counter sets for a specified time interval:
• Inventory - Collections
• Inventory - IDM DB Size

Edition 01 3JL-03001-BTAA-PCZZA 67
Functionality and settings Installation, Administration, and User Guide

• Inventory - NEs Out Of Sync

• Inventory - Queries
• Inventory - Received Updates
• Inventory - Unprocessed Updates

Use the performance statistics to monitor the performance of the 5529 IDM over
time.

68 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Inventory data collection

7 Inventory data collection

7.1 Inventory data collection overview

7.2 Selecting objects and attributes for inventory data collection

7.3 Managing schedules for inventory data collection

7.4 Performing inventory data collection

7.5 Checking inventory data collection results

7.6 Managing inventory database synchronization based on NE events

7.7 Using collection statistics

7.1 Inventory data collection overview

This chapter provides information about collecting NE inventory data from a network
managed by the 5520 AMS.
Although the 5520 AMS collects inventory basic data once a day, you can use the
5529 IDM as described in this chapter to collect inventory data to populate the
5529 IDM database with current information about the NE equipment. After inventory
data has been collected as described in this chapter, you can perform queries on the
collected inventory data as described in chapter 8 or you can perform a network
export of the collected inventory data, as described in chapter 9.
The major tasks to collect inventory data include the following:
• selecting objects and attributes to be collected
• creating a schedule if applicable
• performing the collection, includes selecting the NEs or NE groups that are to be
included in the collection

Nokia recommends that you do not use more than 40 threads for a collection.

Edition 01 3JL-03001-BTAA-PCZZA 69
Inventory data collection Installation, Administration, and User Guide

The 5520 AMS also collects inventory data in real time. You can configure
parameters in the Real-Time Update panel of the Object Details view in the
5520 AMS inventory Basic Settings. For information about the 5520 AMS inventory
Basic Settings, see the 5520 AMS Administrator Guide.

Note — Only a few read-only attributes are updated in real

time. All of the other read-only attributes are updated by the NE
collection operation.
The following read-only attributes are updated based on
change notifications:
• remote inventory attributes of new LT boards that have been
detected
• protection state of NT and LT boards
• ONT active software version
Section 7.1.1 describes the methods that you can use to collect inventory data with
the 5529 IDM and section 7.1.2 describes synchronization of the inventory database
with the actual network inventory.

7.1.1 Manual and scheduled inventory data collections

The 5529 IDM provides two methods for you to collect inventory data:
• manual inventory data collection (forced collection)—use this method if NEs are
out of sync and you did not select the “Automatic Resynchronization of Out of
Sync NEs” setting. Note that a manual inventory data collection is not necessary
after an NE is added to the network because the 5529 IDM automatically performs
an inventory data collection on the NE if it is supervised successfully by the
5520 AMS.
• automated inventory data collection using schedules—use this method to
automatically capture inventory data on a regular basis according to your
requirements

7.1.2 Inventory database synchronization

After an inventory data collection, the 5529 IDM updates the inventory database
automatically, and keeps it in sync with the actual network inventory to reflect the NE
inventory events that occur in your network. See section 7.6 for a list of changes in
network equipment configuration that trigger updates in the 5529 IDM database.
However, any of the following reasons can cause the inventory database to go out of
sync with the actual network inventory:
• too many inventory changes in the NE
• the addition of an IVPS agent

70 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Inventory data collection

• a collection failure
• an error during the processing of inventory changes
For NEs that go out of sync, you can configure parameters in the Resynchronization
of Out of Sync NEs panel of the Object Details view in the 5520 AMS inventory Basic
Settings. For information about the 5520 AMS inventory Basic Settings, see the
5520 AMS Administrator Guide.

7.2 Selecting objects and attributes for inventory

data collection
You can select the objects and attributes that can be collected and therefore will be
available for subsequent querying or network export. If an object or attribute is
removed from the list, it cannot be collected, queried, or included in the network
export.
Making changes in the list of objects and attributes that can be collected can have
an impact on querying; see section 8.1.1 for more information about the impacts on
querying.
If an object or attribute is specified in an export profile so that it can be included in a
network export, it cannot be removed from the list of selected objects and attributes
for collection. You need to modify or delete the export profile; see Procedure 23 to
modify an export profile or Procedure 24 to delete an export profile.

Warning — Collection of objects and attributes has a significant impact

on the processing load on the 5520 AMS. Nokia recommends that you
select only the objects and attributes you need.

Note 1 — You can enable indexing to speed up collection on

some attributes that have high numbers of instances; for
example, physical ports. Nokia recommends that you enable
indexing on the attributes that are most frequently included in
queries. This will maximize performance.
Note 2 — Changes made to the list of selected objects and
attributes for collection are deferred to the next inventory
collection in order to prevent mass NE collections being
performed each time a change is made to the of list of objects
and attributes that can be collected.

Perform Procedure 14 to select objects and attributes for inventory data collection.
The procedure determines the objects and attributes that will be collected and
therefore available for subsequent queries and network export. The procedure
applies to objects and attributes that will be included in manual inventory data
collection (forced collection) and automated inventory data collection using
schedules. See section 7.1.1 for more information about the two methods to collect
inventory data.

Edition 01 3JL-03001-BTAA-PCZZA 71
Inventory data collection Installation, Administration, and User Guide

When you select objects and attributes for collection as described in Procedure 14,
you can create a .csv file based on the list of selected objects and attributes and save
it to a location on your workstation that you specify.

Procedure 14 To select objects and attributes for collection

You must be logged in to the 5520 AMS client as a user with the Inventory Settings - Edit function.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the 5520 AMS menu, choose Window→Show View→Collected Objects in Inventory. The
Collected Objects in Inventory view opens.

3 Perform one of the following in the Collected Objects in Inventory view:

a Choose -All- from the NE Family drop-down menu for all the NE types in your network.

The -All- option is the default. When you choose the -All- option, the NE and NE agent
objects and attributes are available to configure for collection.

b Choose an NE type from the NE Family drop-down menu; for example G6, GPON,
ISAM/FTTB/FTTN, or UNMANAGED.

When you choose an NE type from the NE Family drop-down menu, the objects and
attributes specific to the selected NE type are available to configure for collection.

Objects and attributes available for collection appear in the Object/Attribute Name column.
You can expand the objects to see their attributes by clicking on the arrow symbol to the left
of the object name.

Objects and attributes collected by the 5520 AMS by default are indicated by a check mark
in a dimmed check box in the Collected column. You cannot select or deselect objects or
attributes that have dimmed check boxes, regardless of your user privileges. An empty check
box means that you can select the object or attribute for collection.

Objects and attributes that have already been configured for indexing are indicated by a
check mark in a dimmed check box in the Indexed column. You cannot select or deselect
objects or attributes that have dimmed check boxes, regardless of your user privileges. An
empty check box means that you can select the object or attribute for indexing. Indexing
maximizes performance by letting queries run faster though the use of separate files that use
pointers, but they do take up disk space. You can use the Collection Statistics view as
described in section 7.7 to check the size of the index for each object.

Objects and attributes that have been specified in an export profile so that they can be
included in a network export are indicated by a check mark in a dimmed check box in the
Used in Export Profiles column.You cannot select or deselect objects or attributes that have
dimmed check boxes, regardless of your user privileges. When you mouse over the check
mark, the export profile name is displayed. Multiple export profile names are separated by
commas. See section 9.2 for more information about export profiles.

72 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Inventory data collection

4 Select each object or attribute that you need to include by clicking on the check box. You can
only click on check boxes that are not dimmed.

5 To create a .csv file that indicates the selected objects and attributes, and save it to your
workstation, perform the following:

i Click on the View Menu icon ( ) in the toolbar of the Collected Objects in Inventory
view and choose the Save as CSV option. The Choose file dialog box opens.

ii In the Choose file dialog box, navigate to a directory on your workstation or accessible
from your workstation, enter a name for the .csv file, and click on the Save button.

The .csv file lists all the objects and attributes and uses a Y in its Collected, Indexed,
and Used In Export Profiles columns to indicate which objects and attributes are
selected.

6 Click on the Apply configuration icon ( ) to save the changes. A dialog box opens,
indicating the objects that have been modified and that a query on the objects will not return
any data until the changes are taken into account in the next inventory collection. Click on
the OK button to confirm the changes.

7.3 Managing schedules for inventory data

collection
Schedules allow you to perform inventory data collection automatically on a regular
basis according to your requirements.
For inventory data collection, schedules are only used for automated inventory data
collection; schedules are not used for manual inventory data collection (forced
collection).

7.3.1 Inventory data collections in large networks

For large networks, it is good practice to spread the inventory data collection of NEs
across several schedules, with the collection associated with each schedule only
collecting inventory data from a subset of the network. You can define the schedules
to run during daily maintenance windows to further reduce impact.

Edition 01 3JL-03001-BTAA-PCZZA 73
Inventory data collection Installation, Administration, and User Guide

7.3.2 Creating, modifying, or removing an inventory data

collection schedule
See Table 15 for a list of the schedule procedures.

7.4 Performing inventory data collection

This section describes how to perform inventory data collection manually (forced
collection) or automatically using schedules. See section 7.1.1 for more information
about the two methods to collect inventory data.
Inventory data collection will be done on the objects and attributes selected for
collection as described in section 7.2 for the NEs or NE groups selected in Procedure
15.

Procedure 15 To perform inventory data collection

You must be logged in to the 5520 AMS client as an Administrator user with the Inventory - Collect
function.

Inventory data collection will only be done for objects and attributes selected for collection as
described in section 7.2.

As part of this procedure, you select the NEs or NE groups to be included in the collection, and
you either force the collection to start immediately or you identify a schedule for the collection to
use.

For inventory data collection using schedules, you must have already created a schedule as
described in section 6.6 or you can create the schedule as part of this procedure.

1 Perform one of the following:

a Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory
Query perspective opens (the Inventory Query perspective is described in
section 6.1.1). Click on the Collect link in the Inventory Tasks view of the Inventory
Query perspective.

b In the Network perspective, right-click on an NE and choose Inventory→Collect.

The Schedule Collection window opens

2 Configure the Schedule Collection window parameters, as required. Table 17 describes the
parameters of the Schedule Collection window.

74 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Inventory data collection

Table 17 Schedule Collection window parameters

Parameter Description

Selected NEs The Selected NEs box lists the NEs or NE groups that will be included in the inventory data collection. You use the
Add button (described below in this table) to choose the NEs or NE groups to be included.

Excluded NEs The Excluded NEs box lists NEs that belong to a selected NE group but are not being included in the inventory data
collection. You use the Add button (described below in this table) to choose the NEs that are not to be included.

Add Click on the Add button to open the NE Selection window.

Table 18 describes the parameters of the NE Selection window. Use this window to choose NEs or NE groups for
the Selected NEs or Excluded NEs box.
If you used the Add button in association with the Selected NEs box to add one or more NE groups so that the NE
groups will be included in the inventory data collection, you can use the Add button and the Excluded NEs box to
exclude one or more NEs from the inventory data collection for the NE group.

Remove Choose an entry in the Selected NEs or Excluded NEs box, then click on the Remove button to remove the NE or
NE group from the Selected NEs or Excluded NEs box.

Replace All Click on the Replace All button to remove all the NE or NE group entries in the Selected NEs or Excluded NEs box.

Description Type a description in this field.

Schedule This field contains “Schedule now” to allow you to perform a manual inventory data collection immediately (forced
collection).
If you want to perform automated inventory data collection using a schedule instead of a manual inventory data
collection, click on the Browse button.

Browse Click on the Browse button to open the Select Schedule window, in which you can choose an existing schedule or
create a new schedule. See Procedure 10 for the steps to create a schedule.
Do not click on the Browse button if you are performing a manual inventory data collection.

Go To If you clicked on the Browse button, the Go To button is activated and you can click on it to display more schedule
information.

Edition 01 3JL-03001-BTAA-PCZZA 75
Inventory data collection Installation, Administration, and User Guide

Table 18 NE Selection window parameters

Parameter Description

Radio buttons

NEs Select this option to choose the NEs that are to be included. If you select this option, you use one of
the filters described below to filter NEs and then use the Build List button to populate the NE list.

NE Groups Select this option to choose one or more NE groups.If you select this option, the NE Groups box opens
and you can choose one or more of the listed NE groups.Click on the OK button to save your selection
and close the NE Selection window.

Custom Groups This parameter and its associated drop-down menu are not supported by the 5529 IDM

Import NEs from File or Clipboard Select this option to choose one or more NEs from a file or clipboard. If you select this option, the Import
panel opens and you can click on From File or From Clipboard and then click on Browse to use the
Select NE File List window to navigate to a file or clipboard, and then use the Build List button to
populate the NE list.

Filters (the filters only apply if the NEs radio button is selected)

Name Select this check box to make the text box active.
Type the name of a specific NE (if you know it), or a keyword (letters, digits, or both) to filter by NE
name. The Name box uses “contains” to define the characters that must be contained in the NE names.
The NEs that contain the characters that you typed in the Name box are displayed in the NE list after
you click on the Build List button.
The Name box is case-sensitive.

Type/Release Select this check box to make the list of available NE types and releases active.
Select one or more NE types/releases to filter by NE type and release.
The NEs that match the selected NE types/releases are displayed in the NE list after you click on the
Build List button.

Active Software Version Select this check box to make the list of software versions active.
Type the software version to filter by active software version.
The NEs that have the software version are displayed in the NE list after you click on the Build List
button.

Custom Group Select this check box to show the custom group list and to make the Include Subtree check box active.
Navigate to a custom group and select it to filter by custom group.
The NEs that belong to the selected custom group are displayed in the NE list after you click on the
Build List button.

Group Select this check box to show the NE group list and to make the Include Subtree check box active.
Navigate to a group and select it to filter by group.
The NEs that belong to the selected group are displayed in the NE list after you click on the Build List
button.

Check box

Include Subtree The Include Subtree check box becomes active if you selected the Custom Group check box or the
Group check box. Deselect the Include Subtree check box if you do not want to include the subtree in
the group.

List

NE list The NE list provides a list of NE based on one of the above filters or the NEs selected from a file or
clipboard. The list includes information such as name and type/release for each NE. The list is
populated when you click on the Build List button. You can select or deselect one or more or all the NEs
in the list to be included.

(1 of 2)

76 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Inventory data collection

Parameter Description

Buttons

Build List After filtering NEs by using one of the above filters or after selecting NEs from a file or clipboard, click
on the Build List button to populate the NE list.

Select All Click on the Select All button to include all the NEs that are in the NE list.
You can also select the listed NEs manually by clicking on them.

Deselect All Click on the Deselect All button to exclude all NEs that are in the NE list.

Arrow buttons The arrow buttons become active when your NE list spreads over multiple pages. Use the arrow
buttons to navigate through the NE list pages:
• First (go to the first page)
• Previous (go to the previous page)
• Next (go to the next page)
• Last (go to the last page)

OK Click on the OK button to save your NE selection.

Cancel Click on the Cancel button to return to the previous window without saving your NE selection.

(2 of 2)

3 Click on the Finish button.

If you used “Schedule now” in the Schedule field of the Schedule Collection window, the
inventory data collection starts immediately for the selected NEs and:

• An Inventory Collection window opens and provides progress information

• An Action Details window opens when collection is complete

If you used the Select Schedule window to select a schedule or create a new schedule, the
inventory data collection for the selected NEs starts at the date and time specified in the
schedule. See Procedure 13 for how to view schedule information, including the jobs
associated with a schedule.

7.5 Checking inventory data collection results

After performing an inventory data collection, you need to check whether the
inventory data has been collected from the NEs or NE groups that you specified. This
ensures that your queries will run on accurate inventory data, and reflect the current
configuration of NE equipment.
You can:
• check the results of a data collection by performing a data collection failure query
(see section 7.5.1)
• investigate inventory data collection alarms (see section 7.5.2)
• investigate NE inventory data collection failures (see section 7.5.3)

Edition 01 3JL-03001-BTAA-PCZZA 77
Inventory data collection Installation, Administration, and User Guide

7.5.1 Data collection failure query

To check the results of a data collection, you should run a query to show information
about any failed inventory data collection for the NEs or NE groups from which the
5529 IDM collected inventory data.
For the query, include Collection Status as a selected attribute and Failure as the
filter for the value of the Collection Status attribute. See section 8.2.3 for information
about how to run a query.

7.5.2 Collection failure alarms

An NE inventory collection failure is associated with an alarm. You can check for NE
inventory collection failures by opening the Alarm view, and looking for inventory data
collection alarms. See the 5520 AMS and 5529 Enhanced Applications Alarm
Search Tool for information about the following inventory data collection alarms:
• Inventory Automatic Collection Stopped
• Inventory Collection Failure
• Inventory Out of Sync
• NRTU Inventory Out Of Sync

7.5.3 Collection failures

You need to investigate and resolve the NE inventory data collection failure. The
5529 IDM logs the cause of the inventory data collection failure in the inventory.log
file. You can find this log file on the 5520 AMS server, in the $AMS_LOG_DIR
directory.
There is a different log file on each cluster NE. Each cluster NE keeps a log of the
NE inventory data collections performed by the 5529 IDM instance on that NE.
The most common causes of an inventory data collection failure are:
• The NE is not supervised by the 5520 AMS.
• The 5529 IDM does not support the NE software load.
• The 5529 IDM NE support plug-in is not installed.
Take the appropriate action to address the cause of the NE inventory data collection
failure. After the issue is resolved, perform another inventory data collection.

78 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Inventory data collection

7.6 Managing inventory database

synchronization based on NE events
An inventory data collection populates the 5529 IDM database with inventory
information about the NE equipment in your network. After the first inventory data
collection performed on an NE or NE group, the 5529 IDM updates the database
automatically according to the NE events that occur in your network. The following
changes in your network equipment configuration trigger updates in the 5529 IDM
database:
• creation and deletion of NEs and sub NEs
• planning, installation, and removal of cards
• planning, installation, and removal of ONTs
• configuration changes for access/subscriber ports
• configuration changes for bonding groups
• configuration changes for network ports

The 5529 IDM database update based on NE events has the following benefits:
• The need for frequent NE collection operations is significantly reduced.
• The inventory data queries return results based on current inventory data.

7.6.1 Operational changes for network ports

Operational changes for network ports on SHUB-based NEs (Ethernet ports) can
also trigger updates in the 5529 IDM database. The SHUB-based NEs include the
7342 ISAM FTTU and 7302/7330/7356/7360/7363/7367 ISAM. When the
operational state of the Ethernet port changes to up or down, it indicates an
operational change in the port. Operational changes are caused when the
administrative state of the port changes to locked or unlocked, or the cable in the port
is disconnected.
When the operational state of the Ethernet port changes to up or down, the values
for the following Ethernet Port (SHUB) object attributes are updated in the 5529 IDM
database:
• Duplex State (ISAM NEs only)
• Interface Speed
• Operational State
• Speed

See the 5529 IDM NE support plug-in attributes guides for information about the
object attributes and values.

Edition 01 3JL-03001-BTAA-PCZZA 79
Inventory data collection Installation, Administration, and User Guide

The operational changes do not trigger the 5529 IDM database updates
automatically, so you need to make sure the following configuration requirements are
met:
• In the 5520 AMS GUI, enable the Register for Link Up/Down Traps parameter in
the EMS Administration Tree (SNMP→Trap Setting). The parameter is disabled
by default. See the 5520 AMS Administrator Guide for more information about the
parameter.
• In the NE, the Link Up/Down Trap attribute for the Ethernet port is enabled. The
attribute is enabled by default.

Note 1 — Nokia recommends that you do not enable link

up/down traps for subscriber interfaces to avoid flooding the
5520 AMS with notifications.
Note 2 — For ISAM NEs, the 5529 IDM database is not updated
when the operational state of the Ethernet port is down and the
administrative state of the port changes from unlocked to
locked.

7.6.2 Checking the status of inventory database updates

To check the status of inventory database updates that the 5529 IDM performs
automatically based on NE events, you can run an NE-level query using the Sync.
Status attribute.
Your query can filter on any of the following Sync. Status attribute values to check
whether the inventory data stored in the 5529 IDM database is synchronized with the
current NE equipment configuration or not:
• Out of Sync
• Out of Sync (Collection failure)
• In Sync
See section 8.5 for information about creating NE-level queries, including details
about the Sync. Status attribute and its values.

7.7 Using collection statistics

The Collection Statistics view allows you to monitor effects of changes in collection
configuration on performance of the 5520 AMS and to troubleshoot inventory
collection issues. For information about the impact on behavior of 5529 IDM queries
when collection configuration changes are made, see section 8.1.1.

80 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Inventory data collection

The Collection Statistics view shows statistics counted in the last week by default.
You can perform the following from the View Menu:
• copy results to the clipboard
• reset all change events counters
• reset collection times
• reset all query statistics

Table 19 describes the components of the Collection Statistics view window.

Table 19 Collection Statistics window components

Tab Description

Inventory Shows the inventory database usage, including the amount of data stored and the size of the
Database index for each object.

Change Events Shows the number of changes in collection configuration during the measurement period. The
data is shown for each attribute in the 5529 IDM database, by NE type and release.

Collection Shows the number of successful collections performed during the measurement period and
Times the average collection time, in seconds (1).

Query Shows, for each attribute, the number of queries performed during the measurement period
Statistics where the attribute was selected as a query filter or query result. The data is shown by NE
type and release.

Note
(1) The first inventory collection typically takes twice as long as subsequent collections.

Edition 01 3JL-03001-BTAA-PCZZA 81
Inventory data collection Installation, Administration, and User Guide

82 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

8 Queries
8.1 Query overview

8.2 Performing inventory data query tasks

8.3 Managing inventory query results

8.4 Simple filtering for NE and NE agent-level queries

8.5 Advanced filtering for NE and NE agent-level queries

8.1 Query overview

After collecting inventory data as described in chapter 7, you can use the 5529 IDM
to perform queries to display inventory data. An inventory data query provides you
with the tools to search for information about objects and attributes in your network
at the NE level and the NE agent level, as well as for the sub-objects of NEs and NE
agents, using a choice of simple or advanced filtering criteria. Simple filtering allows
you to perform queries that filter on attributes and advanced filtering allows you to
perform queries that filter on attribute values.
Perform the procedures provided in this chapter to create, run, schedule, modify, and
delete inventory data queries and manage inventory query results.
Note 1 — The 5529 IDM NBI query filter is not supported.

Note 2 — All of the NE attributes that could not be queried in

Release 9.1.10 or earlier can be included in an NE query in this release
but they are not available for selection in the Query Details panel of the
Define Query and Run Query windows (these windows are described
in section 8.1.6).

8.1.1 Impact of collection selection changes on query

behavior
Queries can be affected by changes made in the selection of objects and attributes
to be included in inventory data collection. Selection of objects and attributes for
inventory data collection is described in section 7.2.
Note that the impact of the change on query behavior is not immediate because
changes made in the selection of objects and attributes to be included in inventory
data collection are deferred to the next inventory collection,

Edition 01 3JL-03001-BTAA-PCZZA 83
Queries Installation, Administration, and User Guide

Table 20 describes the impact on the behavior of 5529 IDM queries when changes
made in the selection of objects and attributes identified for inventory data collection
have come into effect.
Table 20 Impact of collection selection changes on queries

Change to collection selection Impact on query behavior

Object removed from the list of collected The object is not visible in the Define Query window or the Run
objects Query window and cannot be queried.

Object added to the list of collected objects The object appears in the Define Query window or the Run Query
window and can be queried but no result will be retrieved.

Attribute removed from a collected object The collected object can still be queried but the attribute is no
longer visible in the Define Query window or the Run Query
window and cannot be queried.

Attribute added to a collected object The object can still be queried including the new attribute but the
value for the attribute will be empty.

Indexing selected or unselected on an No impact to the objects visible in the Define Query window or the
attribute Run Query window. The execution time of a query may be
affected.

8.1.2 Queries for objects in a hierarchy

In some windows and views, an attribute or column name has the @ symbol
prepended to indicate a hierarchy that contains an object, as follows:
• Define Query and Run Query windows: the @ symbol is prepended to hierarchical
attribute names in the Available Attributes and Selected Attributes lists; see
section 8.1.6 for more information about the Define Query and Run Query
windows
• Inventory Query Results view: the @ symbol is prepended to hierarchical column
names; see section 8.3 for more information about the Inventory Query Results
view

The hierarchical name formats are listed in Table 21.

Table 21 Hierarchical name formats

Type of hierarchy Format Example

Single parent @nnn @VCL

where nnn is the name of a parent

Multiple parents @nnn/nnn/... @CES IP UNI Service/VoIP UNI

where nnn is the name of a parent Service/...

Use the hierarchical name to identify the location of an object.

84 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

8.1.2.1 Example of hierarchical names

A 7342 ISAM FTTU VLAN Association can be contained in multiple hierarchies, such
as:
• CES IP UNI service and Ethernet UNI service hierarchies
• CES, VDSL2, HPNA, MoCA, and VEIP port hierarchies

For this example, when you configure a query for a 7342 ISAM FTTU VLAN
association, you move the @CES IP UNI Service/VoIP UNI Service/... attribute from
the Available Attributes list in the Define Query or Run Query window to the Selected
Attributes list; see Table 24.
When the Inventory Query Results view displays the results of the above query, it
includes an @CES IP UNI Service/VoIP UNI Service/... column that displays the
hierarchy for each object; see Figure 3.
Figure 3 Example of hierarchical names in the Inventory Query Results
view

8.1.3 Performing NE-level or NE agent-level queries

When you perform queries at the NE level or the NE agent level, you select NE or
Agent from the options listed for the Object Type parameter of the Define Query or
Run Query window as described in Table 24.
Other parameters of the Define Query or Run Query window allow you to refine your
NE-level query or NE agent-level query; configuration of these parameters for
queries at the NE level and the NE agent level is described in Table 24.

Edition 01 3JL-03001-BTAA-PCZZA 85
Queries Installation, Administration, and User Guide

8.1.4 Performing queries on sub-objects of NEs and NE

agents
When compared to NEs and NE agents, some objects can be considered to be
sub-objects of the NE or NE agent because of their relation with the NE or NE agent.
For example, a link or a slot can be considered to be a sub-object of an NE.
When you perform queries on sub-objects of NEs and NE agents, you select the
sub-object of interest from the objects listed for the Object Type parameter of the
Define Query or Run Query window (these windows are described in Table 24). The
sub-objects of NEs and NE agents are listed along with NE and Agent in the options
for the Object Type parameter.
See section 8.1.4.1 for information about performing a query to retrieve NEs that are
connected to NEs.
See section 8.1.4.2 for information about performing a query to retrieve end points.

8.1.4.1 Retrieving NEs that are connected to NEs

You can perform a query to retrieve the object names of NEs that are connected to
NEs. As part of the query, you select an NE (or a set of NEs) and indicate the type
of link (for example, NE-NE or ISAM-MDU).
You use the Define Query or Run Query window to perform a query to retrieve NEs
that are connected to NEs. See Table 22 for key parameter settings to use to retrieve
NEs that are connected to NEs (all the parameters for the Define Query and Run
Query windows are described in Table 24).
Table 22 Key parameter settings to use to retrieve NEs that are connected
to NEs

Parameter Setting

NE Family Choose the NE type that is appropriate for your query; do not choose the -All- option as it
excludes links as Object Type parameters

NE Release Choose the -All- option or the NE release that is appropriate for your query

NE Selection Choose the NE Group: Network option or the NE or NEs or NE group to retrieve connected
NEs from

Object Type Select the type of link for which you want to retrieve NE(s); for example, Link (NE-NE) or Link
(ISAM-MDU)

Output radio Select the NEs radio button

button

86 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

8.1.4.2 Retrieving end points

You can perform a query to retrieve end points. As part of the query, you select an
NE (or a set of NEs) and indicate the type of link (for example, NE-NE or ISAM-MDU)
and the type of end point(s). Results for the end point(s) will be shown in columns in
the Inventory Query Results view; see section 8.3 for more information about the
Inventory Query Results view.
You use the Define Query or Run Query window to perform a query to retrieve end
points. See Table 23 for key parameter settings to use to retrieve endpoints (all the
parameters for the Define Query and Run Query windows are described in Table 24).
Table 23 Key parameter settings to use to retrieve end points

Parameter Setting

NE Family Choose the NE type that is appropriate for your query; do not choose the -All- option as it
excludes links as Object Type parameters

NE Release Choose the -All- option or the NE release that is appropriate for your query

NE Selection Choose the NE Group: Network option or the NE or NEs or NE group to retrieve connected
NEs from

Object Type Select the type of link for which you want to retrieve end points; for example, Link (NE-NE)
or Link (ISAM-MDU)

Output radio Select the Standard radio button

button

Available Select the end point(s) that you want to retrieve; for example, NE1 End Point or MDU
Attributes Network Port

8.1.5 Additional information provided in attribute values

that link to other resource names
Some attribute values are links that refer to the names of other resources. In some
cases, the 5520 AMS provides additional information about the linked resource and
displays the information in parentheses. The 5529 IDM GUI, such as the 5529 IDM
Inventory Query Results view, does not display the additional information in
parentheses in the same way as the 5520 AMS GUI does.
For example:
• If the 5520 AMS GUI displays the value of the VPLS Service attribute in the IP
Interface (IHUB) object as “IHUB:7 (VPLS, None)”, the same value is displayed in
the 5529 IDM GUI as “IHUB:7 (VPLS, 0)”.
• If the 5520 AMS GUI displays the value of the Channel Pairs attribute in the
Channel Group object as “R1.S1.LT3.CP1 (defaultChannel1, -None-)”, the same
value is displayed in the 5529 IDM GUI as “R1.S1.LT3.CP1 (defaultChannel1,
/linkSpecialValue=none)”.

Edition 01 3JL-03001-BTAA-PCZZA 87
Queries Installation, Administration, and User Guide

8.1.6 Define Query and Run Query windows

You use the Define Query window to create an inventory data query that is made
available by the 5529 IDM to run later.
You use the Run Query window to run an available or saved query; you can also use
the Run Query window to modify an existing query or configure a new query and run
either of them immediately, with or without saving the query.
The Define Query and Run Query windows allow you create queries at the NE level
and the NE agent level, as well as queries for the sub-objects of NEs and NE agents.
The queries are done on the inventory data that was collected for the objects,
attributes, NEs, and NE groups as described in chapter 7.
The Define Query and Run Query windows allow you to perform queries that do
simple filtering on attributes and advanced filtering on attribute values.
The Define Query and Run Query windows have the same parameters, except that
the Define Query window does not have a Save button. Parameters in the Define
Query and Run Query windows are described in Table 24.
Table 24 Configuring parameters in the Define Query and Run Query windows

Parameter Description

Select a previously saved query or type a new query name panel

Query Name Type the name of a new query or click on the ... button to select an existing query from the Select Query Name window.
You can create a new query based an existing query by selecting an existing query and changing the query name. If
you run the query without providing a name, the Inventory Query Results view will indicate “Unknown” for the query.

Private Select the Private radio button to make the query available only to you (plus any users logged in with the Administrator
role).
Access to the functionality of this radio button depends on the role and functions granted to you.
Private is selected by default.

Public Select the Public radio button to make the query available to all users.
Access to the functionality of this radio button depends on the role and functions granted to you.

Save Click on the Save button to save the query. The button is available only in the Run Query window.

Delete Click on the Delete button to delete the query.

Clear Click on the Clear button to clear all parameters in the window, including parameters in the tabs. If you are creating a
new query, consider whether you should use the Clear button to remove previous query criteria.

Description Type a description of the query.

Query Scope panel

NE Family Choose an NE type from this drop-down menu; for example G6, GPON, ISAM/FTTB/FTTN, or UNMANAGED.
The -All- option selects all the NE types available in your network. If you select the -All- option, the query will be an NE
or NE agent-level query on all releases of all NE types in the network.
Note that you can perform an NE or NE agent-level query on a specific NE type by choosing the NE type instead of
the -All- option.

(1 of 6)

88 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

Parameter Description

NE Release Choose an NE release from this drop-down menu.

The -All- option selects all the NE releases available in your network.
This drop-down menu is not active if you chose -All- from the NE Family drop-down menu; all NE releases will
automatically be included.
If you are doing an NE or NE agent-level query and you did not choose -All- in the NE Family drop-down menu, you
can choose an NE release.

NE Selection The NE Selection field shows the NEs or NE groups that will be included in the query.
The default is NE Group: Network.
If you do not want the NE Selection to be NE Group: Network, see the description of the Replace All button for how to
specify NEs or NE groups that are to be included the query.
If you are doing an NE or NE agent-level query, you can use NE Group: Network or you can see the description of the
Replace All button to specify NEs or NE groups that are to be included the query.
If you used the Replace All button or the Remove button to remove NE Group: Network from the NE Selection field
and you want the NE Selection field to be NE Group: Network, use the NE Family drop-down menu to choose a
different NE type (this resets the NE Selection field to its default setting of NE Group: Network) and then use the NE
Family drop-down menu to choose the NE type that you need.

Add Click on the Add button to open the NE Selection window, in which you can specify NEs or NE groups to be added in
the NE Selection field. The NEs that are available depend on the NEs that were included in the inventory data
collection (described in section 7.4). Table 18 describes the parameters and functionality of the NE Selection window,
which uses filters to help you specify the NEs that are to be included.

Remove Click on the Remove button to remove selected NEs or NE groups from the NE Selection field.

Replace All Click on the Replace All button to open the NE Selection window, in which you can specify NEs or NE groups to replace
the ones in the NE Selection field. The NEs that are available depend on the NEs that were included in the inventory
data collection (described in section 7.4). Table 18 describes the parameters and functionality of the NE Selection
window, which uses filters to help you specify the NEs that are to be included.

Object Type Choose a type of object to query. The object types that are available depend on the object types that were included in
the inventory data collection (described in section 7.2) and on the configuration of the NE Family, NE Release, and
NE Selection parameters.
Choose NE if the query is to be an NE-level query.
Choose Agent if the query is to be an NE agent-level query.
When there are fewer than 15 object types to choose from, the field is a drop-down menu.
When there are more than 15 object types to choose from, you need to click on the ... button to open the Select Object
Type window. Choose a type of object to query and click on the OK button.

(2 of 6)

Edition 01 3JL-03001-BTAA-PCZZA 89
Queries Installation, Administration, and User Guide

Parameter Description

Query Details panel —Visible Columns tab

Output radio The Output radio buttons in this panel work in conjunction with the Available Attributes and Selected Attributes
buttons parameters that are also in this panel to determine the information that is provided by the query.
The NE attribute is added by default to the Available Attributes list.
In the query results, if a selected attribute does not exist on a selected NE release, the value for the attribute is
displayed in the following format: - no attribute_name -.
For a large data set, the Total Count and Count per Attribute Value outputs can take several minutes to complete.

Standard radio button (default):

• If you select the Standard radio button, a standard list of attributes is provided in the Available Attributes and
Selected Attributes parameters for the objects in the query scope.
• The attributes that you specify as the Selected Attributes parameter will be provided in the query results.
• The query result provides a column for each selected attribute and provides the attribute value for each object that
was queried based on the query scope.

Total Count radio button:

• If you select the Total Count radio button, the Available Attributes and Selected Attributes parameters are dimmed.
The attributes are not available for selection, but the previous selection is preserved if you decide to select a
different Output radio button.
• The query result is the total number of objects that were queried based on the query scope. No object names,
attributes, or attribute values are provided.

(3 of 6)

90 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

Parameter Description

Output radio Count per Attribute Value radio button:

buttons (continued) • If you select the Count per Attribute Value radio button, a list of attributes that have attribute values that can be
aggregated is provided in the Available Attributes and Selected Attributes parameters for the objects in the query
scope.
• The following attributes are not provided in the lists because they have attribute values that cannot be aggregated:
• Attributes with complex syntax (for example, lists and tables)
• Attributes that are custom attributes (also known as custom fields) set up through the 5520 AMS GUI and
defined on the NE object (Family parameter value is Platform and Object parameter value is NE in Create
Custom Fields window). See the 5520 AMS User Guide for more information about custom fields.
• NE attributes that are not stored in the 5529 IDM; Table 29 lists the NE attributes that are stored in the
5529 IDM and are therefore available for NE-level queries
• The query result provides counts of the attribute values for the objects that were queried based on the query
scope. A column is provided for each selected attribute. There is a row for each attribute value (or combination of
attribute values) returned in the results. For each row, the total number of objects in the query results with that
attribute value (or combination of attribute values) is provided in a Count column.
• Example of a query for the count of attribute values for a single attribute:
Suppose there are a total of eleven objects that are queried based on the query scope and you selected only the
Collection Status attribute to be included in the query results. If eight of the objects have a Success value for the
Collection Status attribute, two of the objects have a Failure value, and one object has the Not Collected value,
then the query results will provide three rows, one for each attribute value returned (Success, Failure, and Not
Collected). In the Count column, the Success value row will have the number 8, the Failure row will have the
number 2, and the Not Collected row will have the number 1, all of which add up to eleven objects.
• Example of a query for the count of attribute values for two attributes:
Suppose there are a total of seven objects that are queried based on the query scope and you selected the
Collection Status and Sub Type attributes to be included in the query results. If four of the objects have Success
as the attribute value for the Collection Status attribute and GPON as the attribute value for the Sub Type attribute,
two of the objects have Success and iSAM as the attribute values, and one object has Success and FTTN-I as the
attribute values, then the query results will provide three rows, one for each attribute value combination returned
(Success and GPON, Success and iSAM, and Success and FTTN-I). In the Count column, the Success and
GPON row will have the number 4, the Success and iSAM row will have the number 2, and the Success and
FTTN-I row will have the number 1, all of which add up to seven objects.

NEs radio button:

• Availability of the NEs radio button depends on the selected object type in the query scope.
• If you select the NEs radio button, the Available Attributes and Selected Attributes parameters are dimmed. The
attributes are not available for selection, but the previous selection is preserved if you decide to select a different
Output radio button.
• The query result is the names of the NEs that were queried based on the query scope. No attributes or attribute
values are provided. If the query was one to retrieve the NEs that are connected to an NE (or NEs) as described
in section 8.1.4.1, the query result is the object name of the NE(s) at the remote end of the link(s) connected to
the NE(s) selected in the query.
• This output can be useful in cases where you need a list of NEs for which you want to trigger NE-level actions
(such as deploying templates) all at once for the NEs in the list. You can select the entire list of NEs and right-click
on the list to display a list of operations that can be performed on the selected list of NEs at one time.

(4 of 6)

Edition 01 3JL-03001-BTAA-PCZZA 91
Queries Installation, Administration, and User Guide

Parameter Description

Available Attributes You set up simple filtering by using one of the Output radio buttons in conjunction with the Available Attributes and
and Selected Selected Attributes lists to specify attributes to be included in the query; the attributes in the Selected attributes list are
Attributes used as column headings in the Inventory Query Results view. The attributes that are available depend on the
attributes that were included in the inventory data collection (described in section 7.2).
If you chose NE as the Object Type parameter, the available attributes will automatically be ones appropriate for an
NE-level query. See section 8.4 for the supported attributes.
If you chose Agent as the Object Type parameter, the available attributes will automatically be ones appropriate for
an NE agent-level query. See Section 8.4 for the supported attributes.
Use the Right and Left arrow buttons to move attributes between the Available Attributes list and Selected Attributes
list.
• move selected attributes (single arrow)
• move all of the attributes at once (double arrow)

Double-clicking on an item in a list also moves it from one list to the other.
Use the Up and Down arrow buttons to arrange the attributes in the Selected Attributes list in the order you want their
respective columns to appear in the Inventory Query Results view.
• move selected attributes up or down one place in the list (single arrow)
• move selected attributes directly to the top or bottom of the list (double arrow)

The @ symbol is used for attributes that have a hierarchy that contains an object; see section 8.1.2 for more
information.

Query Details panel —Filter tab

Filter You set up advanced filtering through this tab so that you can filter on attribute values for attributes that have been
selected through the Visible Columns tab. You use the radio buttons in the panel to select the method of matching and
you use drop-down menus in the panel to select one or more attributes and their attribute values to filter on. Depending
on the attribute, you either select an attribute value from the drop-down menu or, for a user-defined attribute value
(such as a string), you enter an attribute value. (1)
You cannot do advanced filtering on attributes that are custom attributes (also known as custom fields) set up through
the 5520 AMS GUI and defined on the NE object (Family parameter value is Platform and Object parameter value is
NE in Create Custom Fields window). See the 5520 AMS User Guide for more information about custom fields.
You click on the plus or minus button to add or remove a row of drop-down menus for an attribute.
Note that the criteria selected for filtering will remain in effect until you remove all the drop-down menus.
Note that the attribute must be selected through the Visible Columns tab in order for the results to be included in the
query results.
Note that filtering on attribute values using the “begins with” or “ends with” operators and not providing a value for the
operator is an invalid filter configuration and may lead to unpredictable query results.
The default is no filtering criteria in the Filter tab.
See section 8.5 for information about the attribute values that are supported for advanced filtering in NE-level and NE
agent-level queries.
See the 5529 IDM NE support plug-in attributes guides for information about attribute values for attributes of
sub-objects of NEs and NE agents.
Advanced filtering cannot be done on enumerated values in the additional data for link attributes. (2)

(5 of 6)

92 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

Parameter Description

Query Details panel —Order tab

Sorted by and Use the Sorted by drop-down menu to select an attribute to sort query results by. The default is no sorting by an
Order attribute.
Use the Order drop-down menu to arrange the sorted or unsorted query results in ascending or descending order. The
default is ascending.
Note the following:
• The “Sorted by” and “'Order” selections are saved along with the query.
• The attribute you select as “Sorted by” will have a highlighted column header in the Inventory Query Results view
and the column header for that attribute in the Inventory Query Results view will allow you to change the order.
• Sorting is not applied when query results are exported to files on server or client.
• Sorting for object name uses alphabetical order instead of “natural” order.
• Link attributes cannot be selected for sorting. (3)
• For advanced filtering in NE-level and NE agent-level queries, it is possible that not all attributes selected in the
Visible Columns tab are available to sort query results by.

See section 8.3 for information about managing inventory query results.

Finish and Cancel buttons

Finish If you are using the Define Query window, see Procedure 17 for information about using the Finish button.
If you are using the Run Query window, see Procedure 18 for information about using the Finish button.
If you are using the Scheduled Query window, see Procedure 19 for information about using the Finish button.

Cancel Use the Cancel button to undo whatever you did in the window since the last save.
Cancel closes the window.

(6 of 6)

Notes
(1) Keep the following in mind when you enter a value to filter on for a user-defined attribute value:
• Advanced filtering is not case-sensitive.
• Two wild cards are supported for advanced filtering: the underscore,”_”, and the percent symbol, “%”. The underscore is used to match any
single character; the percent symbol is used to match any combination of characters, including a null or empty character.
• You can perform advanced filtering on special characters, but they need to be preceded by a backslash, “\”, for example: \%.
(2) A link attribute is an attribute that refers to the name of one or more other objects. The referred object name is known as the base name
and it may be followed by additional data. The additional data that follows the base name is in parentheses and it can be one or more strings
and/or it can be one or more enumerated values. For example, an object type such as VLAN (SHUB) can have a link attribute such as
Assigned to Egress that refers to the name of an SHUB (the base name) followed by additional data such as the Connected Board of the
port and the Port Type, as is the case for the following: SHUB:24 (nt-a:sfp:0, Network), where nt-a:sfp:0 is the Connected Board of the port
and Network is the Port Type. In this example you cannot filter on Network as an attribute value of the Assigned to Egress attribute because
Network is an enumerated value; you can filter on the base name (SHUB:24) and on the Connected Board of the port (nt and sfp) values,
as these are not enumerated values. You can use the 5529 IDM NE support plug-in attributes guides to determine if an attribute is a link
attribute or not.
(3) A link attribute is an attribute that refers to the name of one or more other objects.

8.2 Performing inventory data query tasks

Table 25 lists where to find information about inventory data query tasks.

Edition 01 3JL-03001-BTAA-PCZZA 93
Queries Installation, Administration, and User Guide

Table 25 Inventory data query procedures

Task See

To configure GUI query result settings Procedure 16

To define an inventory data query Procedure 17

To run an inventory data query immediately Procedure 18

To schedule inventory data queries Procedure 19

To review, modify, or delete an inventory data query Procedure 20

To save the results of a query to a .csv file Procedure 21

8.2.1 Configuring GUI query result settings

You can configure GUI query result settings such as the number of query results per
page, a location on your workstation where you can save displayed query results as
CSV files, and the number of records to be saved; see Procedure 16.

Procedure 16 To configure GUI query result settings

You must be logged in to the 5520 AMS client as an Administrator user with the Inventory - Query
function.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the Inventory Query Results view of the Inventory Query perspective, click on the View
Menu icon ( ) and choose Settings. The GUI Query Result Settings window opens.

3 To change the number of query results supported per page, enter a number between 1 and
12 000 (the default is 1000) in the Number of Results per Page field. The number you enter
will be saved (that is, it will not change back to the default value after a 5520 AMS client
restart).

4 To configure the location on your workstation where you can save displayed query results as
CSV files, click on the Browse button beside the Output Directory field to navigate to a
directory on your workstation. Click on the OK button. The location you enter will be saved
(that is, it will not change back to the default value after a 5520 AMS client restart).

Note — The location you enter will continue to be used even if you
rename or delete the location on your workstation. If you want the
displayed query results to be saved to a new location on your workstation,
you will need to repeat this step to configure the new location.

94 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

5 To change the number of records to be saved, enter a number between 1 and 2 147 483 647
(the default is 100 000) in the Save the first field. The number you enter will be saved (that
is, it will not change back to the default value after a 5520 AMS client restart).

6 Click on the Finish button. The query result settings are available for use.

8.2.2 Defining inventory data queries

Perform Procedure 17 to define an inventory data query and make it available
without running it.

Procedure 17 To define an inventory data query

Before you proceed:

• You must be logged in to the 5520 AMS client as a user with the Inventory - Query
function.
• An inventory data collection must have been performed on your network as described in
chapter 7.

Note — If you add or remove an object attribute in the Collected Objects

in Inventory view and run the inventory data query, the query on the
modified object will not return any data. You need to perform an inventory
data collection on your network to make the modified object configuration
available for query. See section 7.2 for information about selecting
objects and attributes for inventory data collection.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the Inventory Tasks view of the Inventory Query perspective, click on the Define Query
link. The Define Query window opens.

Edition 01 3JL-03001-BTAA-PCZZA 95
Queries Installation, Administration, and User Guide

3 See Table 24 to configure the parameters of the Define Query window.

4 Click on the Finish button. The query is made available so that you can run it immediately as
described in section 8.2.3 or you can associate it with a schedule so that it will run at a
specified date and time as described in section 8.2.4.

Note — If you run the query immediately as described in section 8.2.3,

the query results will be displayed as soon as the query is finished.

If you associate the query with a schedule as described in section 8.2.4,

the query results will be saved to a CSV file on the server.

8.2.3 Running inventory data queries immediately

Perform Procedure 18 to run an inventory data query immediately and display the
query results as soon as the query is finished.
Note 1 — The query for a Subrack-Subrack link can take up to 30 s to
complete.
Note 2 — You can also run an inventory data query immediately using
the steps in Procedure 19; however the query results will be saved to a
CSV file on the server instead of being displayed.

96 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

Procedure 18 To run an inventory data query immediately

Before you proceed:

• You must be logged in to the 5520 AMS client as a user with the Inventory - Query
function.
• An inventory data collection must have been performed on your network as described in
chapter 7.
• An inventory data query must be available as described in section 8.2.2, or you can create
a query as described in this procedure.

Note — If you add or remove an object attribute in the Collected Objects

in Inventory view and run the inventory data query, the query on the
modified object will not return any data. You need to perform an inventory
data collection on your network to make the modified object configuration
available for query. See section 7.2 for information about selecting
objects and attributes for inventory data collection.

1 Perform one of the following:

a Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory
Query perspective opens (the Inventory Query perspective is described in
section 6.1.1). In the Inventory Tasks view of the Inventory Query perspective, click on
the Query link. The Run Query window opens.

b In the Network perspective, right-click on an NE and choose Inventory→Query. The

Inventory Query perspective and the Run Query window both open (the Inventory
Query perspective is described in section 6.1.1).

2 Perform one of the following in the Run Query window:

a To run an available or saved query as is, choose the query name from the Query Name
drop-down menu.

b To modify an available or saved query, choose the query name for the Query Name
parameter and modify the applicable query parameters (see Table 24 for descriptions
of the parameters in the Run Query window).

c To create a query, enter a query name for the Query Name parameter and see Table
24 for how to configure the rest of the parameters in the Run Query window.

3 If applicable, save the query by clicking on the Save button. Note that if you have created a
new query or modified an existing query you can run the query as described in the next step,
but the new or modified query will not be kept as an available query unless you save it.

4 Click on the Finish button.

The query runs immediately and the results are displayed in the Inventory Query Results
view of the Inventory Query perspective.

Edition 01 3JL-03001-BTAA-PCZZA 97
Queries Installation, Administration, and User Guide

See section 8.3.6 for information about inventory query results, including how to save the
results of the query to a .csv file.

8.2.4 Scheduling inventory data queries

You schedule inventory data queries to run at specific dates and times by associating
queries with schedules. Section 6.6 describes how to create, modify, and delete
schedules.
You can also schedule a query or queries to run immediately.
The results from a scheduled query or queries are saved directly to CSV files in the
following directory on the server:
$AMS_EXTERNAL_SHAREDDATA_HOME/idm/queries/IDMQueryResult

The 5529 IDM GUI names (user-friendly names) for objects, attributes, and attribute
values, may change over time with each release or update of the applicable NE
support plug-in. The name changes will be seen in the saved CSV files for
pre-defined or scheduled inventory query data results.
If a GUI name change occurs in the NE support plug-in since you last generated
query results (not using a pre-defined or scheduled query) and saved them to a CSV
file, the changed GUI name will be seen in the query results CSV file when you run
the inventory data query again.
If you use a pre-defined or scheduled query that was created before the GUI name
change occurred in the NE support plug-in, the old GUI name will still be seen in the
query results CSV file when the query is run again. You need to define and save a
new query or scheduled query to display the latest 5529 IDM GUI names for objects,
attributes, and attribute values.
The GUI name changes are documented in the 5529 IDM NE support plug-in
attributes guides.

Note — Nokia recommends that you avoid using inventory

query results for NBI processing because they are affected by
5529 IDM GUI name changes. The preferred method to provide
a consistent data format for NBI processing is to use export
profiles and bulk network exports, which are not affected by
changes to the 5529 IDM GUI names.
See section 9.2 for information about creating export profiles,
and section 9.3 for information about performing network
exports from the Inventory Query perspective. See the
5529 IDM Northbound Interface Guide for information about
the exportNetwork NBI operation.

Procedure 19 describes how to schedule inventory data queries.

98 3JL-03001-BTAA-PCZZA Edition 01
Installation, Administration, and User Guide Queries

Procedure 19 To schedule inventory data queries

Before you proceed:

• You must be logged in to the 5520 AMS client as a user with the Inventory - Query
function.
• An inventory data collection must have been performed on your network as described in
chapter 7.
• At least one inventory data query must be available as described in section 8.2.2, or you
can create a query as described in this procedure
• If inventory data queries are to be run at scheduled dates and times, at least one schedule
must be created as described in Procedure 10, or you can create a schedule as described
in this procedure.

Note — If you add or remove an object attribute in the Collected Objects

in Inventory view and run the inventory data query, the query on the
modified object will not return any data. You need to perform an inventory
data collection on your network to make the modified object configuration
available for query. See section 7.2 for information about selecting
objects and attributes for inventory data collection.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the Inventory Tasks view of the Inventory Query perspective, click on the Schedule Query
link. The Scheduled Query window opens.

Edition 01 3JL-03001-BTAA-PCZZA 99
Queries Installation, Administration, and User Guide

3 Perform one of the following in the Scheduled Query window:

a Select one or more queries by clicking on the Right and Left arrow buttons to move
queries from the Available Queries list to the Selected Queries list.

You can move selected queries (single arrow) or all of the queries at once (double
arrow). Double-clicking on a query in a list also moves it from one list to the other.

b Create a query by clicking on the Create button to open the Define Query window; see
Table 24 for information about using the Define Query window to create a query. Select
Finish in the Define Query window to make the query available and then select the
query by clicking on the Right and Left arrow buttons to move it from the Available
Queries list to the Selected Queries list.

4 Perform one of the following in the Scheduled Query window:

a Run the selected queries immediately by clicking on the Finish button if “Schedule now”
is indicated as the Schedule. If “Schedule now” is not indicated as the Schedule, click
on the Browse button to open the Select Schedule window and select “Schedule now”
and then click on the Finish button. The selected queries start immediately and the
query results will be saved directly to a CSV file on the server.

b Choose an existing schedule to be associated with the selected queries by clicking on

the Browse button to open the Select Schedule window, selecting a schedule, and then
clicking on the Finish button. The selected queries will run at the date and time specified
in the selected schedule; the query results will be saved directly to a CSV file on the
server.

c Create a new schedule to be associated with the selected queries by clicking on the
Browse button to open the Select Schedule window and then by clicking on the Create
button to open the Schedule window (see Table 16 for information about using the
Schedule window to create a schedule), and then selecting the new schedule and
clicking on the Finish button. The selected queries will run at the date and time specified
in the schedule; the query results will be saved directly to a CSV file on the server.

See Procedure 13 for how to view schedule information, including the jobs associated with a
schedule.

8.2.5 Reviewing an inventory data query

Perform Procedure 20 to review, modify, or delete an inventory data query.

100 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

Procedure 20 To review, modify, or delete an inventory data query

Before you proceed:

• You must be logged in to the 5520 AMS client as a user with the Inventory - Query
function.
• At least one inventory data query must be available as described in section 8.2.2 or saved
as described in section 8.2.3.

1 Perform one of the following:

a Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory
Query perspective opens (the Inventory Query perspective is described in
section 6.1.1). In the Inventory Tasks view of the Inventory Query perspective, click on
the Query link. The Run Query window opens.

b In the Network perspective, right-click on an NE and choose Inventory→Query. The

Inventory Query perspective and the Run Query window both open (the Inventory
Query perspective is described in section 6.1.1).

2 In the Run Query window, choose the query that you need to review, modify, or delete from
the Query Name drop-down menu. The 5529 IDM loads the query information in the window.

3 Perform one or more of the following as appropriate:

a Review the query information.

b To modify the query, perform the following:

i Modify the query parameters, as required; see Table 24.

ii Click on the Save button.

When you attempt to save changes to a query, the 5529 IDM opens a window and asks
you to confirm your action. If schedules are associated with the query, the 5529 IDM
also informs you that the schedules are deleted when you save the query.

When you choose a query, modify it, and choose another query without saving the
changes, the 5529 IDM opens a window and prompts you to save or discard the
changes.

c To delete the query, click on the Delete button. The 5529 IDM removes the query from
the Query Name drop-down menu.

4 Click on the Finish button.

Edition 01 3JL-03001-BTAA-PCZZA 101

Queries Installation, Administration, and User Guide

8.3 Managing inventory query results

Results from a query that is run through the Run Query window as described in
Procedure 18 are shown in the Inventory Query Results view of the Inventory Query
perspective (the Inventory Query perspective is described in section 6.1.1).
Rows are provided in the Inventory Query Results view for each object type found by
the query.
Columns in the Inventory Query Results view provide the results for each object type
found by the query according to parameters configured, such as selected object
attributes, for the query (see Table 24). Column names that start with the @ symbol
are used to indicate a hierarchy that contains an object; see section 8.1.2 for more
information. For information about object name and attribute value considerations,
see section 8.3.7.
You can resize the widths of the columns in the table or change the column order just
like you can for other tables provided by the 5520 AMS.
You can sort the rows, in ascending or descending order, by clicking on the column
header. A down arrow at the top of the column heading indicates a descending
sorting order. An up arrow at the top of the column heading indicates an ascending
sorting order. You can only sort the query results by one column at a time. For
example, when query results are sorted in descending order by the first column on
the far left and you click on a second column heading, the 5529 IDM sorts the query
results in descending order by the second column.
If your query results contain a column for the NE attribute, which you selected in the
Define Query or Run Query window (described in Table 24), and the number of query
results exceeds the maximum allowed query results per page, you cannot sort the
query results in ascending or descending order using the NE column. For information
about configuring the maximum allowed query results per page, see section 8.2.1.
You can also sort the rows according to a selected object attribute using the Sorted
by parameter in the Order tab of the Define Query and Run Query windows. The
ascending or descending order of the column for the selected attribute is determined
by the Order parameter. See Table 24 for more information about the Order tab of
the Define Query and Run Query windows.
See Figure 3 for an example of the Inventory Query Results view.
This section describes how you can perform the following in the Inventory Query
Results view:
• determine the synchronization status of the query results (see section 8.3.1)
• navigate within the view (see section 8.3.2)
• use the object shortcut menu for object-related actions (see section 8.3.3):
• Add Filter option (see section 8.3.3.1)
• Count option (see section 8.3.3.2)
• Multiple Edit option (see section 8.3.3.4)
• use the Text Search box (see section 8.3.4)

102 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

• use key shortcuts (see section 8.3.5)

• save the displayed query results to a CSV file (see section 8.3.6)

8.3.1 Synchronization status

The 5529 IDM uses a background color in the Inventory Query Results view of the
Inventory Query perspective to indicate the accuracy of the inventory data displayed
for a standard query. The background color of a row is based on the NE or NE agent
Collection Status and Sync. Status attributes. The most critical status of these
attributes takes precedence, and dictates the background color.
Table 26 describes the background colors and their corresponding NE or NE agent
synchronization status in the Inventory Query Results view.
Table 26 5529 IDM synchronization status and colors

Color Color preview Collection status Sync. Status Remarks

No color Success In Sync The 5529 IDM database contains current

NE or agent inventory data.

Yellow In progress — An inventory data collection is in

progress.

— Out of Sync The 5529 IDM database is not updated

with the latest NE or agent inventory data
changes.

Orange Not Collected — The inventory data has not been

collected for the NE or agent.

Failure — The inventory data collection has failed.

— Out Of Sync The 5529 IDM database is not updated

(Collection failure) with the latest NE or agent inventory data
changes due to a collection failure.

— Not Available The NE or agent is not available for

inventory data collections. The 5529 IDM
displays this Sync. Status only in
NE-level or agent-level query results.
When an NE or agent is not available for
data collection, a query does not return
any results for the objects on that NE or
agent.

— Isolated The NE or agent is isolated.

— Not Applicable The inventory data real-time update is

(RTU disabled) disabled.

Edition 01 3JL-03001-BTAA-PCZZA 103

Queries Installation, Administration, and User Guide

8.3.2 Navigating within the Inventory Query Results view

You can navigate between pages and navigate to any object listed in the table of the
Inventory Query Results view.
You can navigate between pages if there are multiple pages in the table:
• Navigate to the first page of results by clicking on the First icon (
) in the toolbar
of the Inventory Query Results view.
• Navigate to the previous or next page of results by clicking on the Previous icon
( ) or the Next icon ( ) in the toolbar of the Inventory Query Results view.

You can navigate to any object listed in the table:

• Navigate to an object by double-clicking on the object row.
• Navigate to an object by right-clicking on the object row to open the shortcut
menu, and choosing Navigate To.

Successful navigation to an object from the Inventory Query Results view depends
on the status of the NE on which the object resides. Table 27 summarizes the
navigation responses.
Table 27 NE object navigation responses

NE status Navigation response

Supervised and The Network perspective opens, showing the highlighted object in the expanded
reachable Network tree, and information about the object in the Object Details view.

Isolated An Unreachable NE dialog box opens, prompting you to bookmark the object on
which you were working, and to choose to navigate to the Inventory Browser
perspective.
If you need to navigate to the NE object in the Network perspective when the NE is
reachable again, choose to bookmark the object.
If you click on the Yes button, the Inventory Browser perspective opens, showing the
highlighted object in the expanded Inventory tree, and information about the object
in the Object Details view. For more information about the Inventory Browser
perspective, see chapter 10.

Unsupervised A Cannot Navigate dialog box opens, informing you that the 5529 IDM cannot
navigate to the NE object. Click on the OK button to close the dialog box. You can
continue your work in the Inventory Query Results view.

8.3.3 Object shortcut menu

You can right-click on one or more objects selected in the Inventory Query Results
view of the Inventory Query perspective to open a shortcut menu. The shortcut menu
contains all the options that are available on the same objects in the Network
perspective, in addition to the Navigate To option.

104 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

By using the object shortcut menu, you can perform any object-related action in the
Inventory Query Results view without having to switch to the Network perspective.
The object shortcut menu options in the Inventory Query Results view are available
on a single NE or agent and on a multiple-NE or multiple-agent selection, and are
consistent with the object menu options available in the Network perspective. The
Navigate To option is available for agents, but only on a single-agent selection.
The options in the object shortcut menu combine the inventory data query
functionality with the capability to perform actions specific to the Network perspective
on objects displayed in the Inventory Query Results view.
The following options available through the object shortcut menu are ones that can
be useful when using the 5529 IDM:
• Add filter option (see section 8.3.3.1)
• Count option (see section 8.3.3.2)
• Generate Public Key option (see section 8.3.3.3)
• Multiple Edit option (see section 8.3.3.4)

8.3.3.1 Add Filter option

The Add Filter option is a choice available through the shortcut menu by right-clicking
on one or more objects selected in the Inventory Query Results view of the Inventory
Query perspective.
When you choose the Add Filter option, you can click on any of the listed
attributes/attribute values to filter the results for the selected object by the attribute
value. When you choose the Add Filter option, an equals filter is added for the
selected attribute/value pair.
You can filter results even further by using the Add Filter option again to choose an
additional attribute/attribute value for the selected object. If you use the Add Filter
option multiple times for the same object and you want to show the query results
before you used the Add Filter option, you must run the query again with the original
settings; you can access the Run Query window by clicking on the Query icon ( )
in the Inventory Query Results view tool bar. The Run Query window is described in
Table 24.
If you used the Add Filter option and you want to go back just one step, you can click
on the Back icon in the Inventory Query Results view tool bar. The Back icon is useful
if you only used the Add Filter once for the selected object or objects and you want
to show the query results before you used the Add Filter option.

8.3.3.2 Count option

The Count option is a choice available through the shortcut menu by right-clicking on
one or more objects selected in the Inventory Query Results view of the Inventory
Query perspective.

Edition 01 3JL-03001-BTAA-PCZZA 105

Queries Installation, Administration, and User Guide

When you choose the Count option, you can click on Total or you can click on any of
the listed attributes.
When you select the Count→Total option, the total number of objects in the results
is shown. The results are filtered the same way as the Total Count output option in
the Run Query window (see Table 24). The Count column displays the total number
of objects in the query results that match the filtering. You can right-click on the
results row and choose Copy or Select All or Load Results (see below for more
information about the Load Results option). You can click on the Back icon in the
Inventory Query Results view tool bar to show the query results before you used the
Count→Total option.
When you select the Count→Attribute option, the total number of objects in the
results, with a subtotal for each attribute value for the selected attribute, is shown.
The results are filtered the same way as the Count per Attribute Value output option
in the Run Query window (see Table 24). The Attribute column displays an
aggregated list of the attribute values from the query results for the selected attribute,
and the Count column displays the total number of objects that contain each attribute
value. You can right-click on one or more results rows and choose Copy or Select All
or Load Results (see below for more information about the Load Results option). You
can click on the Back icon in the Inventory Query Results view tool bar to show the
query results before you used the Count→Attribute option.
For a large data set, the Count query can take several minutes to complete.
When you are using the Count option, you can also right-click on one or more results
rows and choose Load Results to show the objects for the selected attribute value
counts. The Object Name column displays the object and the Attribute column
displays the selected attribute value.

8.3.3.3 Generate Public Key option

The Generate Public Key option is a choice available through the shortcut menu by
right-clicking on one or more objects selected in the Inventory Query Results view of
the Inventory Query perspective and choosing Actions→Generate Public Key. The
Generate Public Key option is available in the shortcut menu when the following
object type is queried:
• SSH Server (7302/7330/7356/7360/7362/7363/7367 ISAM NEs)
• SSH System Parameters (7342 ISAM FTTU)
The Generate Public Key window opens and you can configure the key type for the
selected objects.
See the Operations and Maintenance guide for the NE for more information about
generating public keys.

106 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

8.3.3.4 Multiple Edit option

The Multiple Edit option is a choice available through the shortcut menu by
right-clicking on more than one object selected in the Inventory Query Results view
of the Inventory Query perspective.
When you choose the Multiple Edit option, the Multiple Edit window opens and allows
you to edit the parameters of the selected objects at the same time.
The following considerations apply to the Multiple Edit option:
• Your 5520 AMS user account needs the GUI - Multiple Edit function.
• You can perform multiple edits only on NEs of the same type and release;
however, the NEs can be in different groups.

Note — When you use the Multiple Edit option on the following
objects and the operation is successful, you may see an error
message (error in evaluation) generated in the gui.log file. You
can disregard the error message.
• XDSL Line Service Profile
• XDSL Line Spectrum Profile

8.3.4 Using the Text Search box

The Inventory Query Results view has a Text Search box, which you can use as an
additional tool to process the inventory data returned by a query. If the Text Search
box is not visible, click on the Filter icon ( ) in the Inventory Query Results view
toolbar to show the Text Search box.
Type an alphanumeric string in the Text Search box and click on Contains or
Matches. The 5529 IDM displays in the Inventory Query Results view the rows that
contain or match that text string. If you clicked on Contains, you can start with a single
character, then add more characters to refine your search, as required.

8.3.5 Using key shortcuts

Table 28 describes the key shortcuts that you can use in the Inventory Query Results
view. See the 5520 AMS User Guide for more information about key shortcuts.
Table 28 Inventory Query Results key shortcuts

Key shortcut Description

Arrow (left and right) Highlight an individual cell to the left or right in a single row of the query results
table

(1 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 107

Queries Installation, Administration, and User Guide

Key shortcut Description

Arrow (up and down) Highlight the next or previous row of query results in the table

Ctrl+Q Query
Open the Run Query window

Ctrl+A Select All

Select all of the rows of query results in the table

Ctrl+C Copy
Copy the query results for one or more selected rows in the table

F6 Decrease the width of a column in the query results table.

You need to select a table cell in the column that you want to decrease the width of.
The column width is decreased in increments, so you may need to press the key
multiple times to adjust the columns to your preferred width.

F7 Increase the width of a column in the query results table.

You need to select a table cell in the column that you want to increase the width of.
The column width is increased in increments, so you may need to press the key
multiple times to adjust the columns to your preferred width

(2 of 2)

8.3.6 Saving data to a .csv file

You can save the results of a query as a .csv file on the server or on your workstation.
The values in the file will be in UTF-8 format.
The 5529 IDM saves the data using configurable field separators or delimiters. To be
able to process the saved data, you need to set the field separator in the 5520 AMS
GUI to match the field separator configured on the operating system of your
workstation. In the Windows environment, the value of the field separator depends
on the configured Region and Language Options, and is related to how your system
displays numeric values. Look for the List separator parameter in the Region and
Language Options, and ensure that the CSV Separator parameter in the 5520 AMS
GUI is set to the same value. See Table 13 for more information about setting the
CSV separator for files that are saved to the 5520 AMS server.
Setting the CSV separator for files that are saved to the 5520 AMS client is done by
entering data in the CSV Separator field after selecting Window → Preferences.
Query results saved as CSV files on the server will be saved to the following
directory:
$AMS_EXTERNAL_SHAREDDATA_HOME/idm/queries/IDMQueryResult

You can save displayed query results as CSV files on your workstation. See
Procedure 16 to use the GUI Query Result Settings window to configure the location
on your workstation where you can save displayed query results as CSV files. The
CSV files will be saved to the location configured in the GUI Query Result Settings
window even if you rename or delete the location on your workstation.
The name of the results file is query_name-username-yyyy-mm-dd-hh-mm-ss.csv

108 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

where
query_name is the name of the saved query that the results are for
username is the username of the 5520 AMS GUI user who ran the query
yyyy-mm-dd-hh-mm-ss is the date and time when the query was run

Note — If the query was not saved, the name of the results file will be
username-yyyy-mm-dd-hh-mm-ss.csv.

The 5529 IDM GUI names (user-friendly names) for objects, attributes, and attribute
values, may change over time with each release or update of the applicable NE
support plug-in. The name changes will be seen in the saved CSV files for
pre-defined or scheduled inventory query data results.
If a GUI name change occurs in the NE support plug-in since you last generated
query results (not using a pre-defined or scheduled query) and saved them to a CSV
file, the changed GUI name will be seen in the query results CSV file when you run
the inventory data query again.
If you use a pre-defined or scheduled query that was created before the GUI name
change occurred in the NE support plug-in, the old GUI name will still be seen in the
query results CSV file when the query is run again. You need to define and save a
new query or scheduled query to display the latest 5529 IDM GUI names for objects,
attributes, and attribute values.
The GUI name changes are documented in the 5529 IDM NE support plug-in
attributes guides.

Note — Nokia recommends that you avoid using inventory

query results for NBI processing because they are affected by
5529 IDM GUI name changes. The preferred method to provide
a consistent data format for NBI processing is to use export
profiles and bulk network exports, which are not affected by
changes to the 5529 IDM GUI names.
See section 9.2 for information about creating export profiles,
and section 9.3 for information about performing network
exports from the Inventory Query perspective. See the
5529 IDM Northbound Interface Guide for information about
the exportNetwork NBI operation.

Procedure 21 describes how to save the results of a query as a .csv file on a server
or as a .csv file on your workstation.

Procedure 21 To save the results of a query to a .csv file

You must have finished running a query and still have the Inventory Query Results view of the
Inventory Query perspective open with the results displayed as described in Procedure 18.

Edition 01 3JL-03001-BTAA-PCZZA 109

Queries Installation, Administration, and User Guide

If you will be saving query results as CSV files on your workstation, the location will be the location
specified in Procedure 16.

1 To save the results of the query to a .csv file on the server:

i Click on the View Menu icon ( ) in the Inventory Query Results view toolbar and
choose the Save as CSV to Server option. The Save Result to Server File dialog box
opens and shows the path that will be used.

ii In the Save Result to Server File dialog box, click on the OK button.

2 To save the results of the query to a .csv file on your workstation:

i Click on the View Menu icon ( ) in the Inventory Query Results view toolbar and
choose the Save as CSV option. The Save Result to Client File dialog box opens and
shows the path that will be used.

ii In the Save Result to Client File dialog box, click on the OK button.

8.3.7 Object name and attribute value considerations

The different variables that make up the friendly name of an object are represented
by naming attributes in the 5529 IDM, which collects the naming attributes as part of
the inventory data collection and allows the attributes to be used in query result filters
or for sorting query results. The naming attributes are typically not displayed in the
Object Details view for the object because they are redundant with the object name.
The following is an example of the friendly name format of an ONT object:
NE:rack.subrack.slot.port.ONT
where
• NE is the name of the NE
• rack is the rack number of the PON port, in the format Rn
• subrack is the subrack number of the PON port, in the format Sn
• slot is the slot number of the PON port, in the format LTn
• port is the PON port number, in the format PONn
• ONT is the number of the ONT that is associated with the PON port, in the format
ONTn
• n is a number
Example: MyNE:R1.S1.LT9.PON1.ONT1
The different variables in the object name are R1, S1, LT9, PON1, and ONT1. The
corresponding naming attributes that identify each variable are Rack, Subrack, Slot,
PON Port, and ONT.

110 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

In the Inventory Query Results view, the naming attribute of a queried object may not
align with the object name. For example, if the object name of a queried ONT is
MyNE:R1.S1.LT9.PON1.ONT1 and the Slot naming attribute for the ONT was also
queried, the expected value would be 9 since the Slot attribute refers to the LT9
variable in the object name; however, in the Inventory Query Results view the value
returned for the Slot attribute is 11. The 11 value takes into account that the NT-A
and NT-B slots are mapped to values 1 and 2.
Consider the following when reviewing inventory query results:
• The Slot attribute value that is returned for any queried object is provided with an
offset of 2; for example, an object name with an LT8 slot has a Slot attribute value
of 10. The NT-A and NT-B slots are mapped to values 1 and 2.
• The PON Port attribute value that is returned for any queried object under a legacy
PON port (Rn.Sn.LTn.PONLEGACYn) is provided with an offset of 100 (applies
to 7302/7330/7356/7360/7362/7363/7367 ISAM, Release 6.1 or later).
• The First ID attribute value that is returned for any queried IP Interface object is
provided with an offset of 1; for example, an IP Interface object name with ITF0
(for example, MyNE:R1.S1.LT2.P1.IPoX.ITF0) has a First ID attribute value of 1.
• The First ID attribute value that is returned for any queried IGMP Control Channel
on IPoX object is provided with an offset of 1; for example, an IGMP Control
Channel on IPoX object name with ASSN0 (for example,
MyNE:R1.S1.LT2.P1.IPoX.ITF1.ASSN0) has a First ID attribute value of 1.

8.4 Simple filtering for NE and NE agent-level

queries
Simple filtering allows you to perform queries that filter on attributes. Simple filtering
can be used for NE and NE agent-level queries.
An NE-level query is a method you can use to find specific inventory-related
information for the NEs in your network.
An NE agent-level query is a method you can use to find specific inventory-related
information for the NE agents in your network.
You use the Define Query window or the Run Query window as described in Table
24 to create an NE-level or NE agent-level query. As part of the process of creating
the query, you configure the NE Family and NE Selection parameters. You set up
simple filtering for the query by selecting one or more attributes for the query through
the Standard output or Count per Attribute Value output radio buttons and the
Selected Attributes list of the Query Details—Visible Columns tab. See the Output
row in Table 24 for more information about the Standard and Count per Attribute
Value radio buttons and the Selected Attributes list.

Edition 01 3JL-03001-BTAA-PCZZA 111

Queries Installation, Administration, and User Guide

Table 29 indicates the attributes that are supported for NE-level queries and Table
30 indicates the attributes that are supported for NE agent-level queries.
Note 1 — The Collection Status and Sync. Status attributes are
included by default in the Selected Attributes list.
Note 2 — Attributes not listed and not checked off in Table 29 are not
supported for simple filtering for NE-level queries.
Attributes not listed and not checked off in Table 30 are not supported
for simple filtering for NE agent-level queries.
Note 3 — See section 8.5 for information about advance filtering for
NE-level and NE agent-level queries, including supported attributes
and attribute values.
Table 29 Attributes supported for NE-level queries

Attribute Standard output Count per Attribute Value output

Active Software Version ✓

Agent IDs ✓ ✓

Alarm Silent Mode ✓

Alias Name ✓

Collection Status ✓ ✓

Connection Details ✓

Connection Status ✓

Connectivity ✓

Deploy at Start Supervision ✓

Detailed Tracing Category ✓

Download and Activate SW at Start ✓

Supervision

ENV Alarm Template ✓

Exclude from Collection ✓

Execute Script at Start Supervision ✓

External TL1 GW Server ✓

Group Path ✓ ✓

IP Address ✓ ✓

Last Collection End Time ✓ ✓

Last Collection Start Time ✓ ✓

Last Collection Triggered by ✓ ✓

User/Schedule

Last Real-Time Update ✓

Last Successful Collection ✓ ✓

(1 of 2)

112 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

Attribute Standard output Count per Attribute Value output

Link Role ✓

Managed by Server ✓

Name ✓ ✓

NE Family ✓

NE ID ✓

NE Type/Release ✓ ✓

OSS Provisioning ✓ ✓

Other Command Line Parameters ✓

Partition Access Profile ✓ ✓

Save a Copy of Collected Files on the ✓

Server

Sub Type ✓ ✓

Supervision State ✓ ✓

Sync. Status ✓ ✓

Target Script or Archive ✓

Target SW Release ✓

Template Group Name ✓

Time Zone ✓ ✓

TL1 Session ✓ ✓

Trap Destination ✓ ✓

User Name (CLI) ✓

User Name (TL1-Credentials) ✓

(2 of 2)

Table 30 Attributes supported for NE agent-level queries

Attribute Standard output Count per Attribute Value output

Active Software Version ✓

Bypass Type/Release Check ✓

Collection Status ✓ ✓

Connection Details ✓

Connection Status ✓

Connectivity ✓

Internal ID ✓

IP Address ✓

Name ✓

(1 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 113

Queries Installation, Administration, and User Guide

Attribute Standard output Count per Attribute Value output

NE ✓ ✓

ONT Type/Release ✓ ✓

OSS Provisioning ✓

Release ✓

SNMP Profile ✓ ✓

Supervision State ✓

Sync. Status ✓ ✓

Template ✓

TL1 Session ✓

Type ✓

Use Main Agent IP Address ✓

User Name (CLI) ✓

User Name (TL1-Credentials) ✓

(2 of 2)

8.5 Advanced filtering for NE and NE agent-level

queries
Advanced filtering allows you to perform queries that filter on attribute values rather
than on attributes. Advanced filtering can be used for NE and NE agent-level queries.
An NE-level query is a method you can use to find specific inventory-related
information for the NEs in your network.
An NE agent-level query is a method you can use to find specific inventory-related
information for the NE agents in your network.
You use the Define Query window or the Run Query window as described in section
8.1.6 to create an NE or NE agent-level query. As part of the process of creating the
NE or NE agent-level query, you configure the NE Family and NE Selection
parameters, along with selecting the attributes to be included in the query.

114 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

Also in the Define Query or Run Query window, you can set up advanced filtering on
attribute values through the Query Details—Filter tab (see Table 24 for information
on how to use the Filter tab):
• Table 31 describes the attributes that have values that you can use for advanced
filtering of NE-level queries.
• Table 32 describes the attributes that have values that you can use for advanced
filtering of NE agent-level queries.
• See the 5529 IDM NE support plug-in attributes guides for information about
attribute values that you can use for advanced filtering in queries on sub-objects
of NEs and NE agents.

Note 1 — Advanced filtering for NE and NE agent-level queries is not

case-sensitive.
Note 2 — The Collection Status and Sync. Status attributes are
included by default in the Selected Attributes list.
Table 31 Attributes that can be used for advanced filtering in NE-level queries

Attribute Attribute values Description

Agent IDs User-defined Queries the agent identifiers of the NEs in your network. You can also
choose a filtering criterion, and enter either an agent ID or part of an
agent ID.

Alarm Silent Mode Check box not selected (disabled) Queries the status of the alarm silent mode of the NEs in your network.
(default) You can also choose a filtering criterion, and select or deselect the
Check box selected (enabled) check box.

Alias Name User-defined Queries the alias names of the NEs in your network. You can also
choose a filtering criterion, and enter either an alias name or part of an
alias name.

Collection Status Not Collected (default) Queries the status of inventory data collections performed on the NE or
In Progress NE group. You can also choose a filtering criterion and value.
Success
Failure

Connection Details — (default) Queries the details about the connection status of the NEs in your
Agent Type/Release not Supported network. You can also choose a filtering criterion and value.
Dying Gasp Trap received (power failure
or switch off)
IP Connectivity but No SNMP Connectivity
NE Version Mismatch or Failure to
Communicate to SNMP Agent
NE is Booting
NO_OFCONFIG
NO_OVSDB
No Connection with NE
No IP Connectivity
PRODUCT_MISMATCH
Security Problem

(1 of 3)

Edition 01 3JL-03001-BTAA-PCZZA 115

Queries Installation, Administration, and User Guide

Attribute Attribute values Description

Connection Status Booting (default) Queries the connection status of the NEs in your network. You can also
Partially Reachable choose a filtering criterion and value.
Reachable
Security Problem
Unknown
Unreachable

External TL1 GW User-defined Queries the External TL1 GW servers that may be associated with the
Server NEs in your network. You can also choose a filtering criterion, and enter
either a server name or part of a server name.

Group Path User-defined Queries the paths to the groups in which the NEs in your network are
created. You can also choose a filtering criterion, and enter a group path
or part of a group path.

IP Address User-defined Queries the IP addresses of the NEs in your network. You can also
choose a filtering criterion, and enter either an IP address or part of an
IP address.

Last Collection End User-defined Queries the end date and time of the last inventory data collection
Time performed on an NE or NE group. You can also choose a filtering
criterion, and a date and time.

Last Collection User-defined Queries the start date and time of the last inventory data collection
Start Time performed on an NE or NE group. You can also choose a filtering
criterion, and a date and time.

Last Collection User-defined Queries the names of the last inventory data collection schedules
Triggered by triggered for an NE or NE group. You can also choose a filtering
User/Schedule criterion, and enter either a schedule name or part of a schedule name.

Last Real-Time User-defined Queries the date and time of the last real-time update to inventory data
Update the occurred on an NE or NE group. You can also choose a filtering
criterion, and a date and time.

Last Successful User-defined Queries the start date and time of the last successful inventory data
Collection collection performed on an NE or NE group. You can also choose a
filtering criterion, and a date and time.

Link Role Hub (default) Queries the status of the link role for the NEs in your network. You can
Hub and Subtended also choose a filtering criterion and value.
None
Subtended

Managed by Server User-defined Queries the server management IP addresses for the NEs in your
network. You can also choose a filtering criterion, and enter either an IP
address or part of an IP address.

Name User-defined Queries the names of the NEs in your network. You can also choose a
filtering criterion, and enter either an NE name or part of an NE name.

NE ID User-defined Queries the identifiers of the NEs in your network. You can also choose
The default is 0. a filtering criterion and enter a value.

NE Type/Release User-defined Queries the types and releases of the NEs in your network. You can also
choose a filtering criterion, and an NE type/release from the drop-down
menu.

Object Name (1) User-defined Queries the names of objects on the NEs in your network. You can also
choose a filtering criterion, and enter either an object name or part of an
object name.

(2 of 3)

116 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

Attribute Attribute values Description

OSS Provisioning Locked (default) Queries the OSS provisioning access to the NE in your network for the
Unlocked Internal TL1 GW. When the OSS provisioning is set to Locked the OSS
commands from the Internal TL1 GW are not forwarded to the NE.

Partition Access User-defined Queries the names of PAPs that the NEs in your network are associated
Profile with. You can also choose a filtering criterion, and enter either a PAP
name or part of a PAP name.

Save a Copy of Check box not selected (disabled) Queries the status of the storage of collected files, such as BFMU and
Collected Files on (default) SDC result files, for NEs in your network. You can also choose a filtering
the Server Check box selected (enabled) criterion, and select or deselect the check box.

Sub Type DF/SF (default) Queries the sub-type for the NEs in your network. You can also choose
DX/SX a filtering criterion and value.
FDREM
FTTN
FTTN-I
FX
G6
GPON
MX
iSAM
iSAM-I

Supervision State Declared (default) Queries the supervision state of the NEs in your network. You can also
Imported (was “Declared”) choose a filtering criterion and value.
Imported (was “Supervised”)
In Maintenance
Partially Supervised
Supervised
Supervising

Sync. Status In Sync (default) Queries the status of automatic inventory data updates performed on
Not Applicable (RTU disabled) the NE or NE group based on NE events. You can also choose a filtering
criterion and value.
Out of Sync
Out of Sync (Collection failure)
Isolated
Not Available

Time Zone Not Managed (default) Queries the management of time zones configured in the NEs in your
network. You can also choose a filtering criterion.

TL1 Session Disabled (default) Queries the status of the Internal TL1 GW sessions that are active on
Enabled the NEs in your network. You can also choose a filtering criterion and
value.

Trap Destination User-defined Queries the trap destination IP addresses configured in the NEs in your
network. You can also choose a filtering criterion, and enter either a trap
destination IP address or part of a trap destination IP address.

(3 of 3)

Note
(1) The NE part of the friendly name of an NE object is not stored in the 5529 IDM inventory database. To filter information by NE you need to
create a filter by selected NE, not by object name.

Edition 01 3JL-03001-BTAA-PCZZA 117

Queries Installation, Administration, and User Guide

Table 32 Attributes that can be used for advanced filtering in NE agent-level queries

Attribute Attribute values Remarks

Bypass Type/Release Check box not selected (disabled) Choose the Bypass Type/Release check attribute to query the status
Check (default) of the Bypass Type/Release setting for the NE agents in your
Check box selected (enabled) network. You can also choose a filtering criterion, and select or
deselect the check box.

Collection Status Not Collected (default) Choose the Collection Status attribute to query the status of inventory
In Progress data collections performed on the NE agents in your network. You
can also choose a filtering criterion and value.
Success
Failure

Connection Details — (default) Choose the Connection Details attribute to query the details about
Agent Type/Release not Supported the connection status of the NE agents in your network. You can also
choose a filtering criterion and value.
Booting
Dying Gasp Trap received (power failure
or switch off)
IP Connectivity but No SNMP Connectivity
NE Version Mismatch or Failure to
Communicate to SNMP Agent
NO_OFCONFIG
NO_OVSDB
No Connection with NE
No IP Connectivity
PRODUCT_MISMATCH
Security Problem

Connection Status NE is Booting (default) Choose the Connection Status attribute to query the connection
Partially Reachable status of the NE agents in your network. You can also choose a
filtering criterion and value.
Reachable
Security Problem
Unknown
Unreachable

Name User-defined Choose the Name attribute to query the names of the NE agents in
your network. You can also choose a filtering criterion, and enter
either an NE agent name or part of an NE agent name.

Object Name User-defined Choose the Object Name attribute to query the names of objects on
the NEs in your network. You can also choose a filtering criterion, and
enter either an object name or part of an object name.

ONT Type/Release User-defined Choose the ONT Type/Release attribute to query the types and
releases of the ONTs in your network. You can also choose a filtering
criterion, and an ONT type/release from the drop-down menu.

SNMP Profile User-defined Choose the SNMP Profile attribute to query the SNMP profiles
applied to the NE agents in your network. You can also choose a
filtering criterion, and enter either an SNMP profile name or part of an
SNMP profile name.

(1 of 2)

118 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Queries

Attribute Attribute values Remarks

Supervision State Declared (default) Choose the Supervision State attribute to query the supervision state
Imported (was “Declared”) of the NE agents in your network. You can also choose a filtering
criterion and value.
Imported (was “Supervised”)
In Maintenance
Partially Supervised
Supervised
Supervising

Sync. Status In Sync (default) Choose the Sync. Status attribute to query the status of automatic
Not Applicable (RTU disabled) inventory data updates performed on the NE or NE group based on
NE events. You can also choose a filtering criterion and value.
Out of Sync
Out of Sync (Collection failure)
Isolated
Not Available

Type User-defined Choose the Type attribute to query the types of NE agents in your
network. You can also choose a filtering criterion, and enter either a
type or part of a type.

Use Main Agent IP Check box not selected (disabled) Choose the Use Main Agent IP Address attribute to query the status
Address (default) of the Use Main Agent IP Address setting for the NE agents in your
Check box selected (enabled) network. You can also choose a filtering criterion, and select or
deselect the check box.

(2 of 2)

Edition 01 3JL-03001-BTAA-PCZZA 119

Queries Installation, Administration, and User Guide

120 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Network export

9 Network export
9.1 Network export overview

9.2 Managing export profiles

9.3 Performing a network export

9.1 Network export overview

After collecting inventory data as described in chapter 7, you can use the 5529 IDM
to perform network exports as described in this chapter.
Section 9.2 describes how to create an export profile to specify the objects and
attributes to be included in the network export, along with the export order.
Section 9.3 describes how to perform a network export of the objects and attributes
specified in an export profile, either immediately or at a date and time specified in a
schedule. Network exports for each export profile can be scheduled separately. For
example, if you need to export two objects at different frequencies, they can be
included in different export profiles, with each export profile having its own schedule.

Note — The 5529 IDM GUI names (user-friendly names) for

objects, attributes, and attribute values, may change over time
with each release or update of the applicable NE support
plug-in.
The preferred method to provide a consistent data format for
NBI processing is to use export profiles and bulk network
exports, which are not affected by changes to the 5529 IDM
GUI names. Nokia recommends that you avoid using inventory
query results for NBI processing because they are affected by
5529 IDM GUI name changes.
The 5529 IDM GUI name changes are documented in the 5529
IDM NE support plug-in attributes guides.
See section 9.2 for information about creating export profiles,
and section 9.3 for information about performing network
exports from the Inventory Query perspective. See the
5529 IDM Northbound Interface Guide for information about
the exportNetwork NBI operation.

9.2 Managing export profiles

You use export profiles to specify the objects and attributes to be included in the
network export; you also specify the export order.

Edition 01 3JL-03001-BTAA-PCZZA 121

Network export Installation, Administration, and User Guide

You can choose one of the following to be included in a network export:

• NE object and attributes for all NE types
• objects and attributes below the NE level for a specific NE type
You use the Exported Objects in Inventory view when creating export profiles. The
Exported Objects in Inventory view has a mode field that you use as follows:
• in the Export Selection mode, all available objects and attributes are listed in the
Object/Attribute Name column; you use the Export column to indicate whether the
object or attribute is to be specified in the export profile
• in the Export Order mode, the order of the selected objects and attributes matches
the order in the GUI by default; you can change the order for the network export

When you create or modify an export profile, a .csv file containing the profile is saved
automatically by the 5520 AMS to the following directory:
$AMS_EXTERNAL_SHAREDDATA_HOME/idm/profiles

The format of the output file containing the export profile is profile_name-date.csv
where
profile_name is the name of the saved export profile
date is the date the export profile was created
When an export profile is deleted using the 5520 AMS GUI, the .csv file for that
profile, which was created by the 5520 AMS, is also deleted.
When you create or modify an export profile, you can create the following two .csv
files based on the export profile and save them to a location on your workstation that
you specify:
• one .csv file can indicate the selected objects and attributes by a Y in the Selected
column in the file
• one .csv file can list the selected objects and attributes in the network export order

9.2.1 Object and attribute special cases

This section describes special cases regarding the objects and attributes that are
available in the Exported Objects in Inventory view.

9.2.1.1 Complex attributes

Network export does not support complex attributes, such as tables. The Exported
Objects in Inventory view does not display complex attributes.

122 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Network export

9.2.1.2 IGMP Channel object

If the export profile contains an IGMP Channel object (7342 ISAM FTTU) and the
number of IGMP Channel objects on each NE is greater than 1000, Nokia
recommends that you reduce the number of network export jobs. Set the Max.
Allowed value for the Bulk Network Export setting to 10. The Bulk Network Export
setting is located in the Object Details view for the Application Server object. The
network export performance time will increase as a result of changing the setting.
See the 5520 AMS Administrator Guide for more information about application
server settings.

9.2.1.3 NE object and attributes

The NE object and attributes are available for network export as of Release 9.2.30.
If you have migrated from an earlier release and you need to add the NE object and
attributes to an export profile, you need to create a new export profile for the NE
object and attributes or add the NE object and attributes to an existing export profile;
see Procedure 22 to create an export profile or Procedure 23 to modify an export
profile.

9.2.1.4 Parent FN attribute

The Parent FN attribute for the following ISAM objects is available for network export:
• GPON Current MAC Address
• GPON VLAN Association DHCP Session
The Parent FN attribute value provides the friendly name of the parent object of these
ISAM objects to indicate their location in the object hierarchy; for example,
UNI:R1.S1.LT1.PON6.ONT4.C14.P1.
The Parent FN attribute and value are also returned by the getExportedObject and
query operations. See the 5529 IDM Northbound Interface Guide for more
information about the operations.

9.2.2 Export profiles

You create export profiles to specify the objects and attributes for the network export
and the export order.
Perform Procedure 22 to create an export profile, Procedure 23 to modify an export
profile, or Procedure 24 to delete an export profile.

Edition 01 3JL-03001-BTAA-PCZZA 123

Network export Installation, Administration, and User Guide

Procedure 22 To create an export profile

You must be logged in to the 5520 AMS client as a user with the Inventory Settings - Edit and
Inventory - Query functions.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the 5520 AMS menu, choose Window→Show View→Exported Objects in Inventory. The
Exported Objects in Inventory view opens.

3 Click on the Create new profile icon ( ) in the toolbar of the Exported Objects in Inventory
view.

4 Choose one of the following items from the NE Family drop-down menu:

• -All- (to export the NE-level object and attributes for all NE types)
• an NE type (to export objects and attributes below the NE level for the selected NE type),
for example G6, GPON, ISAM/FTTB/FTTN, or UNMANAGED

5 Choose Export Selection from the Mode drop-down menu. The objects and attributes
available for export are listed in the Object/Attribute Name column.

You can expand the objects to see their attributes by clicking on the arrow symbol to the left
of the object name.

6 Select objects or attributes to include in the network export by clicking on the check box in
the Export column.

You can click on the Display only selected objects/attributes to export icon ( ) in the toolbar
of the Exported Objects in Inventory view to toggle between showing only the selected
objects and attributes and showing all the objects and attributes in the Export column.

7 To create a .csv file that indicates the selected objects and attributes, and save it to your
workstation, perform the following:

i Click on the View Menu icon ( ) in the toolbar of the Exported Objects in Inventory
view and choose the Save as CSV option. The Export configuration to CSV file dialog
box opens.

ii In the Export configuration to CSV file dialog box, navigate to a directory on your
workstation or accessible from your workstation, enter a name for the .csv file, and click
on the Save button.

The .csv file lists all the objects and attributes and uses a Y in its Selected column to
indicate the objects and attributes that have been selected for network export.

8 Choose Export Order from the Mode drop-down menu. The objects and attributes selected
for export are listed in the default order.

124 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Network export

You can expand the objects to see their attributes by clicking on the arrow symbol to the left
of the object name.

9 To change the export order, choose an object or attribute in the Object/Attribute Name
column, and click on the Move to First, Move Up, Move Down, or Move to Last icons ( ,
, , ) as required to move the object or attribute to the desired place in the list.

Alternatively, you can drag and drop the objects and attributes to configure the export order.

10 To create a .csv file that indicates the export order for the selected objects and attributes and
save it to your workstation, perform the following:

i Click on the View Menu icon ( ) in the toolbar of the Exported Objects in Inventory
view and choose the Save as CSV option. The Export configuration to CSV file dialog
box opens.

ii In the Export configuration to CSV file dialog box, navigate to a directory on your
workstation or accessible from your workstation, enter a name for the .csv file, and click
on the Save button.

The .csv file lists the selected objects and attributes in the export order.

11 Click on the Save new profile or save change to selected profile icon ( ) in the toolbar of the
Exported Objects in Inventory view. The Save As window opens.

12 Enter a name for the profile in the New profile name field of the Save As window and click on
the Finish button. The export profile is saved.

Procedure 23 To modify an export profile

You must be logged in to the 5520 AMS client as a user with the Inventory Settings - Edit and
Inventory - Query functions.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the 5520 AMS menu, choose Window→Show View→Exported Objects in Inventory. The
Exported Objects in Inventory view opens.

3 Click on the Open an existing profile icon ( ) in the toolbar of the Exported Objects in
Inventory view and choose the export profile that you need to modify.

Edition 01 3JL-03001-BTAA-PCZZA 125

Network export Installation, Administration, and User Guide

4 If required, change the selection of one of the following items available from the NE Family
drop-down menu:

• -All- (to export the NE-level object and attributes for all NE types)
• an NE type (to export objects and attributes below the NE level for the selected NE type),
for example G6, GPON, ISAM/FTTB/FTTN, or UNMANAGED

5 If required, change the selection or deselection of objects or attributes to include in the

network export by selecting Export Selection in the Mode drop-down menu and clicking on
the check box in the Export column. You can expand the objects to see their attributes by
clicking on the arrow symbol to the left of the object name.

You can click on the Display only selected objects/attributes to export icon ( ) in the toolbar
of the Exported Objects in Inventory view to toggle between showing only the selected
objects and attributes and showing all the objects and attributes in the Export column.

6 To create a .csv file that indicates the selected objects and attributes and save it to your
workstation, perform the following:

i Click on the View Menu icon ( ) in the toolbar of the Exported Objects in Inventory
view and choose the Save as CSV option. The Export configuration to CSV file dialog
box opens.

ii In the Export configuration to CSV file dialog box, navigate to a directory on your
workstation or accessible from your workstation, enter a name for the .csv file, and click
on the Save button.

The .csv file lists all the objects and attributes and uses a Y in its Selected column to
indicate the objects and attributes that have been selected for network export.

7 If required, change the export order by selecting Export Order in the Mode drop-down menu,
choosing an object or attribute in the Object/Attribute Name column, and clicking on the Move
to First, Move Up, Move Down, or Move to Last icons ( , , , ) as required to move
the object or attribute to the desired place in the list. You can expand the objects to see their
attributes by clicking on the arrow symbol to the left of the object name.

Alternatively, you can drag and drop the objects and attributes to change the export order.

8 To create a .csv file that indicates the export order for the selected objects and attributes and
save it to your workstation, perform the following:

i Click on the View Menu icon ( ) in the toolbar of the Exported Objects in Inventory
view and choose the Save as CSV option. The Export configuration to CSV file dialog
box opens.

ii In the Export configuration to CSV file dialog box, navigate to a directory on your
workstation or accessible from your workstation, enter a name for the .csv file, and click
on the Save button.

126 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Network export

The .csv file lists the selected objects and attributes in the export order.

9 Click on the Save new profile or save change to selected profile icon ( ) in the toolbar of
the Exported Objects in Inventory view to save the changes.

Procedure 24 To delete an export profile

You must be logged in to the 5520 AMS client as a user with the Inventory Settings - Edit and
Inventory - Query functions.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the 5520 AMS menu, choose Window→Show View→Exported Objects in Inventory. The
Exported Objects in Inventory view opens.

3 Click on the Open an existing profile icon ( ) in the toolbar of the Exported Objects in
Inventory view and choose the profile you need to delete.

4 Click on the Delete selected profile icon ( ) in the toolbar of the Exported Objects in
Inventory view to delete the export profile. A dialog box opens.

5 Click on the OK button in the dialog box to delete the export profile.

9.3 Performing a network export

This section contains information about the export of NE inventory data from a
network managed by the 5520 AMS. You can perform a network export from the
5520 AMS GUI. The network export operation extracts NE inventory data from the
5529 IDM database, and writes the information to a .csv output file that you can keep
on the local server or transfer to a remote host.
The output file name format is as follows:
username-networkexport-profilename-YYYY_MM_DD_HH_MM_SS.csv, where:
• username is the user name you used to log in to the 5520 AMS
• profilename is the name of the export profile specified in the operation
• YYYY_MM_DD_HH_MM_SS is the date and time the file was created
The values in the output file are in UTF-8 format.

Edition 01 3JL-03001-BTAA-PCZZA 127

Network export Installation, Administration, and User Guide

The inventory information included in the output file is defined by an export profile;
see section 9.2.
If you keep the output file on the local server instead of transferring it to a remote
host, the file is saved to the following location on the local server:
/var/opt/ams/shared/common/idm/queries/IDMQueryResult

If you transfer the output file to a remote host instead of keeping it on the local server,
you can use FTP or SFTP as the file transfer protocol. Authentication for SFTP can
be based on password or on key-based authentication. For key-based
authentication, the server must already be configured to use key-based
authentication (that is, the public/private keys have been generated and placed in
.ssh of the amssftp home directory of the user, and the SFTP server has been
configured with the amssftp public key file of the user).
File cleanup will be performed according to the Maximum Number of Network Export
Files parameter in the Query Settings window; see Table 13.
Procedure 25 describes how to perform a network export, either by keeping the
output file on the local server or by transferring it to a remote host, and either
performing the network export immediately or at a date and time specified in a
schedule.
Note 1 — Nokia recommends using the compress option when running
a network export for a large number of NEs.
Note 2 — An attribute value that is displayed in the network export
output file may not match the attribute value that is displayed in the
Inventory Query Results window. The value in the Inventory Query
Results window is in a user-friendly format. The value in the network
export output file is in a non-user-friendly format.
For the attributes that display values in a non-user-friendly format in the
network export output file, the attribute meta data that is defined for
them is more complex than a simple value or list of values. The meta
data can be a mix of different types or lengths of values. For this reason,
the user-friendly value format is not supported for these attributes in the
network export output file.
For example (ISAM NE):
• For the PON Loss Behavior attribute (NGPON2 Ethernet Port
object), the user-friendly value is Don't Care (Does Not Send OMCI).
The non-user-friendly value is noOmci.
• For the VSI ID attribute (BGP object), the user-friendly value is
{Type=AS Number(2Bytes):Assigned Number, Value=0:0}. The
non-user-friendly value is {type=type0, value=0:0}.

128 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Network export

Procedure 25 To perform a network export

Before you proceed:

• you need to be logged in to the 5520 AMS client as a user with the following functions
Inventory - Query and GUI - Save to file on Server
• an export profile must be available; see Procedure 22 or Procedure 23
• if network exports are to be run at scheduled dates and times, at least one schedule must
be created as described in Procedure 10, or you can create a schedule as described in
this procedure.

1 Click on the Open perspective icon ( ), and choose Inventory Query. The Inventory Query
perspective opens (the Inventory Query perspective is described in section 6.1.1).

2 In the Inventory Tasks view of the Inventory Query perspective, click on the Bulk Network
Export link. The Scheduled Bulk Network Export window opens.

3 Choose an export profile from the Export Profile drop-down menu in the Scheduled Bulk
Network Export window.

4 To keep the output file on the local server, perform the following in the Scheduled Bulk
Network Export window:

i Select the Keep on Local Server radio button.

ii To compress the output file, select the Compressed File (gzip) check box.

iii Proceed to step 6.

5 To transfer the output file to a remote host, perform the following in the Scheduled Bulk
Network Export window:

i Select the FTP or SFTP radio button to specify the file transfer protocol.

ii In the Remote Host field, enter the IP address or the host name of the server that you
need to transfer the file to.

iii In the Remote Directory field, enter the path on the remote server where you need to
save the file, for example: /var/tmp. For FTP file transfers, the directory path needs to
be for a sub-directory (child directory) of the FTP user home directory on the remote
server.

iv In the Username field, enter the username of an FTP or SFTP user on the remote host.

Edition 01 3JL-03001-BTAA-PCZZA 129

Network export Installation, Administration, and User Guide

v Do one of the following for the Password field:

• for FTP, enter the password of an FTP user on the remote host
• for SFTP that uses password for authentication, enter the password of an SFTP user
on the remote host
• for SFTP that uses key-based authentication, leave the Password field blank

vi To compress the output file before transfer, select the Compressed File (gzip) check
box.

6 Perform one of the following in the Scheduled Bulk Network Export window:

a Run the network export immediately by clicking on the Finish button if “Schedule now”
is indicated as the Schedule. If “Schedule now” is not indicated as the Schedule, click
on the Browse button to open the Select Schedule window and select “Schedule now”
and then click on the Finish button. The network export starts immediately and:

• a Network Export window opens and provides progress information

• an Action Details window opens when the export is complete

b Choose an existing schedule to be associated with the network export by clicking on the
Browse button to open the Select Schedule window, selecting a schedule, and then
clicking on the Finish button. The network export will run at the date and time specified
in the selected schedule.

c Create a new schedule to be associated with the network export by clicking on the
Browse button to open the Select Schedule window and then by clicking on the Create
button to open the Schedule window (see Table 16 for information about the Schedule
window), and then selecting the new schedule and clicking on the Finish button. The
network export will run at the date and time specified in the schedule.

See Procedure 13 for how to view schedule information, including the jobs associated with a
schedule.

130 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Inventory Browser perspective

10 Inventory Browser perspective

10.1 Inventory Browser perspective overview

10.2 Navigation

10.3 Views

10.1 Inventory Browser perspective overview

This chapter describes the 5529 IDM Inventory Browser perspective, in which you
can view inventory data stored in the 5529 IDM database.You can use the Inventory
Browser perspective to access NE object information when an NE becomes isolated
or unsupervised.

10.2 Navigation
This section describes the navigation between the Network and the Inventory
Browser perspectives.

Note — You can also navigate to the Inventory Browser perspective

from the Query Results view; for more information, see section 8.3.

10.2.1 Navigating to the Inventory Browser perspective

To navigate to the Inventory Browser perspective, right-click on an NE group or NE,
and choose Inventory→Browser. The Inventory Browser perspective opens, and
displays information about the same NE object from which you navigated.
If you are working on an NE object in the Network perspective, and the NE becomes
isolated or unsupervised, an Unreachable NE dialog box opens and prompts you to
bookmark the object on which you were working, and to navigate to the Inventory
Browser perspective. Click on the Yes button to navigate to the Inventory Browser
perspective.

Edition 01 3JL-03001-BTAA-PCZZA 131

Inventory Browser perspective Installation, Administration, and User Guide

10.2.2 Navigating to the Network perspective

As soon as the NE that you are working on in the Inventory Browser perspective
becomes reachable, a Reachable NE dialog box opens and prompts you to navigate
to the same object in the Network perspective. Click on the Yes button to navigate to
the Network perspective.
You can also navigate to an object on an NE that became reachable by using the
object contextual menu. Right-click on the object, and choose Go To→Object. The
5529 IDM takes you to the same object in the Network perspective.
If you bookmarked NE objects in the Network perspective, you can use the same
bookmarks from the Inventory Browser perspective.

10.3 Views
The Inventory Browser contains the following views:
• Inventory Tree
• Object Details
• Graphical View

10.3.1 Inventory Tree view

The Inventory Tree view is similar to the Network Tree view, and contains the same
NE groups and NEs as the Network Tree view.
To access the NE objects, you can double-click on the NE to open an NE tab in the
view and navigate to the objects within the hierarchical tree structure. The Inventory
Tree displays only a subset of the NE objects and their attributes. For example,
additional data based on operational attributes is not shown.
The contextual menu of the objects in the Inventory Tree provides the following
options:
• Find option to navigate to objects in the Inventory Tree view
• Go To option to navigate to the Network perspective
The Inventory Tree view also provides a text search function that allows you to find
objects in the Inventory Tree view. Click on the Show Quick Search icon to open the
search panel. For more information about how to use the text search function, see
the 5520 AMS User Guide.
Some objects are displayed in the Inventory Tree but they are not displayed in the
Network Tree. This is a limitation of the Inventory Browser.

132 3JL-03001-BTAA-PCZZA Edition 01

Installation, Administration, and User Guide Inventory Browser perspective

The Inventory Tree view does not provide alarm information, and does not support
navigation to the Alarms perspective. The Infrastructure information is not available
in the Inventory Tree view. However, supervision and isolation states are indicated
on the object icons in the Inventory Tree view.

10.3.2 Object Details view

The Object Details view displays the attributes of NE objects structured like in the
Object Details view of the Network perspective, with the same tabs, sections, and
subsections. The NE objects have the same names and values, but the configurable
attributes have only read-only values. Supervision and isolation states are also
indicated in the Object Details view.
The NE object attributes that are not available in the 5529 IDM database are
removed from the view. The tabs, sections, and subsections containing unavailable
object attributes are also removed.

10.3.3 Graphical View

The Graphical View displays an overview of all the collected objects and attributes in
the 5529 IDM database for the selected level in the Inventory Tree. The view shows
the objects with their state information. When you mouse over the state icons,
tooltips provide a description of the status indicator.
The Graphical View is synchronized with the other views in the Inventory Browser
perspective. When you click on parts of the graphical representation of the object,
the 5529 IDM highlights the associated location in the Inventory Tree and displays
the object parameters in the Object Details view.
Navigating to objects using the Graphical View requires you to double-click on
objects. For example, double-click on a group to navigate to the NEs in the group.
Not all objects have a graphical representation in the Graphical View. For example,
you need to use the Inventory Tree to navigate to objects under NE→Infrastructure.
When an object does not have a graphical representation, the Graphical View
displays the objects in a table view, if a table view is defined. If there is neither a
graphical representation nor a table view available for the object, then the Graphical
View displays the closest parent object that has either.
NEs are ordered alphabetically by NE name in the Graphical View, just as they are
in the Inventory Tree. When you add an NE or change the name of an NE, the list is
automatically reordered in the Inventory Tree and in the Graphical View.

Edition 01 3JL-03001-BTAA-PCZZA 133

Inventory Browser perspective Installation, Administration, and User Guide

10.3.3.1 Automatic update of service indications

In the PON Graphical view or Table view, the service indications are updated
automatically when services are added to and removed from an ONT. The update is
not immediate because the service overview is based on 5529 IDM data. A delay of
up to 35 seconds can occur between the automatic update and the time the
5520 AMS server receives a notification from the NE (which is also subject to trap
shaping). If the 5529 IDM has a lot of data to synchronize, the delay may be more
than 35 seconds.

134 3JL-03001-BTAA-PCZZA Edition 01

Customer Document and Product Support

Customer documentation
Customer Documentation Welcome Page

Technical Support
Product Support Portal

Documentation feedback
Customer Documentation Feedback
 © 2019 Nokia
3JL-03001-BTAA-PCZZA