Prime Network OSS Integration Guide-2-0

Americas Headquarters
Cisco Systems, Inc.

170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883

Text Part Number: OL-30201-01

Cisco Prime Network OSS Integration
Guide for MTOSI and 3GPP
Version 2.0

January, 2014

1

Abstract

The Cisco Prime Network OSS Integration Guide for MTOSI and 3GPP gives information on OSS
Integration using 3GPP and MTOSI north bound interfaces.

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE
SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND
RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY
FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET
FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE
INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE
LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF
THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED
SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-
INFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL,
CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR
LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF
CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and
other countries. To view a list of Cisco trademarks, go to this URL:www.cisco.com/go/trademarks. Third-party
trademarks mentioned are the property of their respective owners. The use of the word partner does not
imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual
addresses and phone numbers. Any examples, command display output, network topology diagrams, and
other figures included in the document are shown for illustrative purposes only. Any use of actual IP
addresses or phone numbers in illustrative content is unintentional and coincidental.

Prime OSS Integration Guide for MTOSI and 3GPP
19992014 Cisco Systems, Inc. All rights reserved.
Contents

Cisco Prime Network OSS Integration Guide for MTOSI and 3GPP
OL-30201-01 iii

1 Table of Contents
List Of Tables .......................................................................................................................... vi
2 Preface ............................................................................................................................ vii
3 Conventions ................................................................................................................... viii
4 Additional User Documentation .......................................................................................ix
5 Obtaining Documentation, Obtaining Support, and Security Guidelines .......................... x
6 Technologies .................................................................................................................. 11
7 3GPP OSS Integration ..................................................................................................... 12
7.1 Supported Devices for 3GPP Interface ............................................................................... 12
7.2 3GPPIntegration Reference Point (IRP) .............................................................................. 12
7.3 3GPP Integration Layer ...................................................................................................... 13
7.4 Overview of 3GPP Inventory Management ........................................................................ 13
7.4.1 Physical Inventory ................................................................................................................................ 13
7.4.2 Logical Inventory .................................................................................................................................. 14
7.5 3GPP Inventory IRP InterfaceDetails .................................................................................. 14
7.5.1 InventoryIRP:: getAllInventory ............................................................................................................. 14
7.5.2 InventoryIRP:: getAllManagedElementNames .................................................................................... 17
7.5.3 InventoryIRP:: getManagedElement .................................................................................................... 18
7.6 Overview of 3GPP File Transfer IRP .................................................................................... 20
7.7 3GPP File Transfer IRP Interface Details ............................................................................. 20
7.7.1 File Transfer IRP::listAvailableFiles ...................................................................................................... 21
7.8 Overview of 3GPP Notification IRP .................................................................................... 24
7.9 3GPP Notification IRP Details ............................................................................................. 25
7.9.1 Notification IRP::subscribe ................................................................................................................... 25
7.9.2 Notification IRP::unsubscribe .............................................................................................................. 28
7.9.3 3GPP FT Notification Consumer ........................................................................................................... 29
7.10 Overview of 3GPP Notifications ......................................................................................... 29
7.10.1 3GPP File Ready Notification........................................................................................................... 29
7.10.2 3GPP File Preparation Error Notification ........................................................................................ 29
7.10.3 3GPP FT Notification Multi-DM Behavior ....................................................................................... 30
7.11 Scheduling Web Services ................................................................................................... 31
7.12 3GPP Standard Compliance ............................................................................................... 31
7.13 Trouble Shooting 3GPP ................................................................................................... 31
8 MTOSI OSS Integration .................................................................................................. 35
8.1 Supported Devices for MTOSI Interface ............................................................................. 35
Contents

iv OL-30201-01
8.2 MTOSI Inventory Management .......................................................................................... 35
8.3 MTOSI Interface Details ..................................................................................................... 36
8.3.1 Managed Element Retrieval Interface ................................................................................................. 36
8.3.2 Equipment Retrieval Interface ............................................................................................................. 36
8.3.3 Physical Termination Point Retrieval Interface .................................................................................... 36
8.3.4 Ethernet Virtual Connection (EVC) Resource Inventory APIs .............................................................. 39
8.3.5 DataCenter ........................................................................................................................................... 41
8.3.6 L3 MPLS VPN ........................................................................................................................................ 48
8.3.7 Floating termination point ................................................................................................................... 51
8.3.8 Inventory Notification .......................................................................................................................... 52
8.4 Delta Inventory Management ............................................................................................ 60
8.4.1 Managed Element Names Retrieval Interface details ........................................................................ 60
8.5 MTOSI Standard Compliance ............................................................................................. 62
8.6 Trouble Shooting - MTOSI .................................................................................................. 63
9 Cisco Specific Interfaces ................................................................................................. 64
9.1 Alarm Life Cycle Management ........................................................................................... 64
9.1.1 AlarmMgmt::Acknowlege .................................................................................................................... 64
9.1.2 AlarmMgmt::De-Acknowlege .............................................................................................................. 66
9.1.3 AlarmMgmt::Clear ............................................................................................................................... 67
9.1.4 AlarmMgmt::Retire .............................................................................................................................. 68
9.1.5 AlarmMgmt::Add Note ........................................................................................................................ 70
9.2 Alarm Retrieval ................................................................................................................. 71
9.2.1 AlarmRetrieval::getsubtendingEvents ................................................................................................. 71
9.3 Trouble Shooting Cisco Specific Interfaces....................................................................... 73
10 Appendix I References to WSDL Documents ................................................................ 75
10.1 3GPP WSDL Documents ..................................................................................................... 75
10.1.1 3GPP Inventory WSDL ................................................................................................... 75
10.1.2 3GPP FT IRP WSDL ......................................................................................................... 75
10.1.3 3GPP Notification IRP WSDL .......................................................................................... 75
10.1.4 3GPP Notification Consumer WSDL................................................................................ 76
10.2 MTOSI WSDL Documents ................................................................................................... 76
10.2.1 Managed Element Retrieval WSDL ................................................................................. 76
10.2.2 Managed Element Names Retrieval WSDL ..................................................................... 77
10.2.3 Equipment Inventory Retrieval WSDL ............................................................................ 77
10.2.4 Termination Point Retrieval WSDL ................................................................................. 77
10.2.5 Resource Inventory Retrieval WSDL ............................................................................... 77
10.2.6 Connection Retrieval WSDL ........................................................................................... 78
10.2.7 Ethernet Virtual Connection (EVC) Resource Retrieval WSDL ......................................... 78
Contents

OL-30201-01 v
10.3 Cisco Specific Extensions WSDL Documents ....................................................................... 78
10.3.1 Alarm Life Cycle Management WSDL ............................................................................. 78
10.3.2 Alarm Retrieval Management WSDL .............................................................................. 79
11 Appendix II 3GPP-Miscellaneous ................................................................................. 79
11.1 3GPP InventoryNrm Schema File ....................................................................................... 79
11.2 3GPP Inventory File ........................................................................................................... 83
11.2.1 Inventory File Contents ................................................................................................................... 83
11.3 3GPP Detailed Inventory Information .............................................................................. 107
11.3.1 Physical Inventory attributes ........................................................................................................ 107
11.3.2 Logical Inventory attributes .......................................................................................................... 111
11.4 3GPP Status File ............................................................................................................... 139
11.4.1 Status File Name ........................................................................................................................... 139
11.4.2 Status File Contents ...................................................................................................................... 140
11.5 3GPP FT-IRP Inventory Notifications ................................................................................ 140
11.5.1 File Ready Notification .................................................................................................................. 140
11.5.2 File Preparation Error Notification ................................................................................................ 141
11.6 FTP Configuration ............................................................................................................ 142
11.7 Useful Code Snippets for 3GPP ........................................................................................ 143
11.7.1 Code Snippet for 3GPP Request Response ................................................................................... 143
11.7.2 Code Snippet for 3GPP Notification Consumer ............................................................................. 144
12 References ................................................................................................................... 147

List Of Tables

vi OL-30201-01
List Of Tables

Table 5-1 Technologies to Facilitate the OSS Integration ............................................................. 11
Table 6-1: Supported Devices for 3GPP and MTOSI ..................................................................... 12
Table 6-2: Functional Area Supported by 3GPP ............................................................................ 13
Table 6-3: 3GPP Interfaces Names ................................................................................................ 14
Table 6-4: Input Parameters to Retreive Physical and Logical Inventory Information ................ 15
Table 6-5: input Paramters to Retreive List of Managed Elements .............................................. 17
Table 6-6: Input Parameters to Retreive Specific Managed Element .......................................... 19
Table 6-7: OSS Integration Problems and Troubleshooting Procedure ........................................ 32
Table 7-1: Supported Devices for 3GPP and MTOSI ..................................................................... 35
Table 7-2: Supported APIs for Managed Elements, Equipment Inventory .................................. 37
Table 7-3: APIs for Retreiving EVC ................................................................................................ 40
Table 7-4: OSS Integration Problems and Troubleshooting Procedure ........................................ 63
Table 8-1: OSS Integration Problems and Troubleshooting Procedures for Cisco Specific
Interfaces ...................................................................................................................................... 73
Table 9-1: Physical Inventory Attributes for Managed Element ............................................... 107
Table 9-2: Physical Inventory Attribute for Chassis .................................................................... 108
Table 9-3: Physical Inventory Attribute for Card ........................................................................ 108
Table 9-4: Physical Inventory Attribute for Slot ......................................................................... 109
Table 9-5: Physical Inventory Attribute for Port ......................................................................... 109
Table 9-6: Physical Inventory Attribute for Sub-port ................................................................. 110
Table 9-7: Physical Inventory Attribute for Power ..................................................................... 110
Table 9-8: Physical Inventory Attribute for Fan .......................................................................... 111
Table 9-9: Logical Attribute for PGW ......................................................................................... 112
Table 9-10: Logical Attribute for SGW ........................................................................................ 113
Table 9-11: Logical Attribute for APN ......................................................................................... 114
Table 9-12: Logical Attribute for SAEGW .................................................................................... 118
Table 9-13: Logical Attribute for GGSN ...................................................................................... 118
Table 9-14: Logical Attribute for ACS .......................................................................................... 121
Table 9-15: Attribute for AAA Group .......................................................................................... 129
Table 9-16: Attribute for AAADiameterEndpoint ....................................................................... 133
Table 9-17: Attribute for GTPP ................................................................................................... 135
Table 9-18: Attribute for OperatorPolicy .................................................................................... 138

Preface

OL-30201-01 vii
2 Preface
This documentation provides information about the 3GPP and MTOSI OSS Integration. It
describes the associated network management of its supported devices. This document is
applicable for Prime Central release 1.2 and Prime Network release 4.0.

Thisprefacecontainsthefollowingsections:

Conventions
Additional User Documentation
Obtaining Documentation, Obtaining Support, and Security Guidelines
Conventions

viii OL-30201-01
3 Conventions
This document usesthe following conventions:

Convention Indication
boldfont Commands andkeywordsanduser-enteredtextappearinbold font.
italicfont Documenttitles,neworemphasizedterms,andargumentsforwhichyousupply
valuesareinitalicfont.
[] Elements insquare brackets areoptional.
{x|y|z} Requiredalternative keywordsaregroupedinbracesand separated by
verticalbars.
[x|y|z] Optional alternativekeywordsaregrouped inbracketsandseparated by
verticalbars.
String Anonquotedset ofcharacters.Donotuse quotationmarksaround
thestringor thestringwill includethequotationmarks.
courierfont For code snippets and XML
<> Nonprintingcharacterssuch aspasswordsareinangle brackets.
[ ] Defaultresponsestosystempromptsareinsquarebrackets.
!,# An exclamationpoint(!) orapoundsign(#)atthe beginningofaline ofcode
indicatesacommentline.
Note Means reader take note. Notes contain helpful suggestions or references to
material not covered in the publication.

Additional User Documentation

OL-30201-01 ix
4 Additional User Documentation
We sometimes update the documentation after original publication. Therefore, you should
also reviewthe documentation on Cisco.com for any updates.

Other related documents are:
ASR 5000 Product page
3GPP Telecom Management
MTOSI at TMForum
Addendum: Prime Network OSS Integration Sample SOAP Request Response on
Cisco Developer Network
Obtaining Documentation, Obtaining Support, and Security Guidelines

x OL-30201-01
5 Obtaining Documentation, Obtaining Support, and Security
Guidelines
For information on obtaining documentation, submitting a service request, and
gathering additional information, see the monthly Whats New in Cisco Product
Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the Whats New in Cisco Product Documentation as a Really Simple
Syndication (RSS) feed and set content to be delivered directly to your desktop using a
reader application. The RSS feeds are a free service and Cisco currently supports RSS
version 2.0.
Technologies

OL-30201-01 11
6 Technologies

The NMS / EMS uses SOAP / WSDL to implement the Web Services. This requires the OSS
clients to use SOAP understandable clients to communicate and access the interfaces
supported. The below table list thetechnologies used to facilitate the OSS integration.

Table 5-1 Technologies to Facilitate the OSS Integration
Technology Explanation
ESB Enterprise Service Bus. The apache Service Mix environment
OSGi Open Software Gateway Interface, The Karaf environment.
JMS Java Messaging Service, Queues and topics for communicating
across integration layer and prime networks.
SOAP Simple Object Access Protocol, Used for communicating with
the Web Service end point
Web Service Technology that exposes a SOAP / WSDL for accessing the 3GPP
interfaces.

3GPP OSS Integration

12 OL-30201-01
7 3GPP OSS Integration
The 3GPP standard provides APIs to integrate EMS / NMS systems with OSS. The standard
supports SOAP/XML, CORBA and CMIP based interface for the OSS to access the EMS /
NMS systems.

The 3GPP standard can be extended to support vendor specific attributes. The OSS client
applications that integrate with the 3GPP OSS interface can perform network management
functions as defined by 3GPP specification called Interface Reference Points (IRP).

This document describes the 3GPP interfaces to support the following IRPs via., SOAP
interface:

Inventory Management IRP
File Transfer ( FT ) IRP
Notification IRP

As part of Mobility 1.0 and Prime Network 4.0, 3GPP interface will be provided to support
ASR5000 and ASR5500 devices.

For a sample SOAP Request and Response for all the APIs defined in these interfaces, refer
to the Prime Network OSS Integration Guide SOAP Request Response document on Cisco
Developer Network.

7.1 Supported Devices for 3GPP Interface

The below table list of supported devices for 3GPP and MTOSI.

Table 6-1: Supported Devices for 3GPP and MTOSI
OSS NBI Interface Supported DM Versions Supported Devices
3GPP PN 4.0, PC 12 ASR5500, ASR5000

7.2 3GPPIntegration Reference Point (IRP)

The Integration Reference Point (IRP) defines a standard way for the OSS client (IRP
Manager) to refer and access the EMS / NMS (IRP Agents).

The 3GPP Integration Layer will support an IRP Agent that provides support for the
InventoryIRP, File Transfer IRP and Notification IRP. The Inventory IRP is a complete Cisco
extension.The File Transfer IRP and Notification IRP has a restricted support in this release.
This section includes the details on:

OL-30201-01 13
3GPP Integration Layer
Overview of 3GPP Inventory Management
3GPP Inventory IRP InterfaceDetails
Overview of 3GPP File Transfer IRP
3GPP File Transfer IRP Interface Details
7.3 3GPP Integration Layer
The Integration layer is a component that can be installed on the Prime Network box as a
separate entity. The Integration Layer communicates with the Prime Network system using
a proprietary communication mechanism. The Integration layer exposes the 3GPP
Interface via a Web Services Interface. The Web Service request processed with the data
being collected from the Prime Network system.
7.4 Overview of 3GPP Inventory Management
Inventory Management SOAP interface is a vendor extension Web Service used to retrieve
the physical and logical inventory data for ASR 5000 and ASR5500 devices manufactured by
Cisco. The Inventory management Web Service provides three interfaces to retrieve
physical and logical inventory data from the devices.The Interfaces are described in detail
in this document under 3GPP OSS Integration.

The below table gives a list of functional areas supported along with the management data
type.

Table 6-2: Functional Area Supported by 3GPP
Functional Area Management
Data Type
Description
Inventory
Management
IM This functional area covers the inventory
management needs of the OSS. The IRP Agents
implement interfaces that enables the IRP
Managers ( OSS clients ) to collect inventory data
from IRP Agents ( EMS / NMS )
7.4.1 Physical Inventory
Inventory Management includes information on following physical inventory data.
Managed element
Chassis
Card
Slot
Port
Sub-port

14 OL-30201-01
Power unit
Fan
The attributes of the physical inventory units can be found in Appendix section.
7.4.2 Logical Inventory
Inventory Management also captures information on following logical entities:
PGW
SGW
SAEGW
APN
GGSN
ACS ( Active Charging Service )
AAA
GTPP
Operator Policy

Logical entities have both 3GPP prescribed data and Cisco specific vendor extensions. The
attributes details are available in Appendix section.
7.5 3GPP Inventory IRP InterfaceDetails
This section gives a description of all the interfaces with their input, output and the
description in detail. An OSS user can go through this section to better understand the
interface and to use it according to their business needs.

The WSDL document describing the details of the Interface can be accessed from the
Appendix section.

Table 6-3: 3GPP Interfaces Names
Sl.No Interface Name Description
1 getAllInventory This API is used to retrieve Inventory data for all
supported devices under the management
domain
2 getAllManagedElementNames This API is used to retrieve the managed element
name and types for all managed elements
present in the management domain.
3 getManagedElement This API is used to retrieve the inventory data for
a specific Managed Element.
7.5.1 InventoryIRP:: getAllInventory
This interface is invoked by the OSS client to retrieve the Physical and Logical Inventory
information for the managed elements present under the management domain.
The below table gives the list of parameters that should be used as input to retrieve
physical and logical inventory information.

OL-30201-01 15

Description:
This interface will be used to generate Inventory files according to 3GPP format. The
inventory data will contain both physical and logical inventory information. Physical
inventory will contain information about the hardware details and the logical inventory has
information about the following types of services running on the devices.
PGateway
SGateway
SAEGW
GGSN
APN Profile
ACS ( Active Charging Service )
AAA
GTPP
Operator Policy

The Inventory data will be stored in XML files under preconfigured directories. Details
about this configuration will be captured under the FTP Configuration Section in this
document. The inventory collection status will be indicated with a status file present under
the output directory. The status file will contain the information about the managed
elements, the device type, its status and the inventory file location.

If FTP/SFTP servers are configured, the inventory data file will be moved to the respective
macmhines depending on the availability of the primary and secondary FTP servers. If both
the FTP and SFTP servers are not reachable, the inventory data files will be written to the
local machine.
A copy of the status file will be available under the INSTALL_DIR/sildata directory on the
host where the Integration Layer is installed. The detail of the status file is explained in this
document under the Appendix section.

Table 6-4: Input Parameters to Retreive Physical and Logical Inventory Information
Sl.No Parameter Data Type Description
1 InvokeIdentifierIn String This is an optional parameter passed
by the OSS client user. The invoke
Identifier value passed as input to this
interface will be returned
(InvokeIdentifierOut) by the Web
Services Interface. The invoke
Identifier can be used by the OSS client
for correlation purpose. The value
passed to this is not validated and is
returned to the user as is.
2 queryXpathExp String An XPath query string containing the

16 OL-30201-01
Management Domain. The value
expected is /MD=CISCO_PRIME. The
Interface will return an
IllegalArgument Exception if this
parameter is not specified or any value
other than /MD=CISCO_PRIME is
specified.

Output:
The output will be in three parts:
1. A regular SOAP response to the Web Service request which will contain the invoke
identifier passed originally in the input and a response string indicating that the
Inventory request is initiated with a request ID.
2. One or more inventory XML files containing the physical and logical inventory data
for the supported devices in the domain. The request ID will be part of the
Inventory file name that is generated. The user can use the request ID to retrieve
the inventory files generated for a given request.
3. A Status file to indicate the status ( IN-PROGRESS, COMPLETED, FAILED ) for an
inventory request. The Status file has the request ID as part of its name.
Error:
Any error that happens during the inventory file generation process will be notified to the
caller via., a Inventory File Preparation Error. In addition to this the following SOAP
responses will be returned for the Error conditions described below.

Sl.No Error Condition Error Response
1 Unable to reach the EMS system SOAP response indicating
No DMs available will be
returned.
2 No Managed Elements exist in the network SOAP response indicating
No Managed Elements exist
in the network will be
returned.

NOTE:
There will be one Inventory XML file per supported managed element. For a list of
supported network equipments, please refer to the section Supported Devices for 3GPP
Interface.
7.5.1.1 InventoryIRP:: getAllInventory Multi DM behaviour
This section explains the API behavior in multi-DM environment. The following responses
will be returned to the user under the specified conditions

Sl.No Condition Behavior
1 When All associated The request to collect inventory will be

OL-30201-01 17
Domain Managers ( DMs )
are free to take the request
initiated to all DMs and the response indicating
that the request is intiated will be sent with a
request ID.
2 When atleast one of the
associated DMs is
processing a previous
inventory request
The request will not be intiated. A reponse
indicating that another request is in progress
will be sent to the user.

7.5.2 InventoryIRP:: getAllManagedElementNames
This interface is used to get a list of managed element names supported under the
CISCO_PRIME management domain
1
. The interface returns a list of managed element
names and their device family / device type.

Description:

This interface will be used to retrieve a list of managed elements for the given
management domain. The response will contain the managed element name and the
device family.
The response of this interface can at a later point be used by the OSS client to selectively
issue request to collect inventory for specific nodes using the getManagedElement
interface.


Input:

Table 6-5: input Paramters to Retreive List of Managed Elements
1 InvokeIdentifierIn String This is an optional parameter passed
by the OSS client user. The invoke
Identifier value passed as input to this
interface will be returned
(InvokeIdentifierOut) by the Web
Services Interface. The invoke
Identifier can be used by the OSS client
for correlation purpose. The value
passed to this is not validated and is
returned to the user as is.

1
In Prime Network 4.0, this interface will only return the name of devices that are managed by Prime Network.

18 OL-30201-01
Management Domain. The value
expected is /MD=CISCO_PRIME. The
Interface will return an
IllegalArgument Exception if this
parameter is not specified or any value
other than /MD=CISCO_PRIME is
specified.

Output:

The output for this method will be a SOAP response with a list of managed element names
and their device family types.

Error:

Any error that happens during the inventory file generation process will be notified to the
caller via., a Inventory File Preparation Error. In addition to this_SOAP responses will
indicate the error conditions as described below.

Sl.No Error Conditon Error Response
1 Unable to reach the EMS system SOAP response indicating
No DMs available will be
returned.
2 No Managed Elements SOAP response indicating
No Managed Elements are
found will be returned.
7.5.2.1 InventoryIRP:: getAllManagedElementNames Multi DM behavior

This section describes the API behavior in a multiDM environment.
The Request for retrieving all ManagedElement Names will be sent to all participating DMs.
The response from each of the DM will be aggregated and the information will be sent to
the requesting user.
7.5.3 InventoryIRP:: getManagedElement
This interface is used to get inventory data for a specific managed element. The inventory
data will be stored in XML files on the configured FTP / SFTP server or on the local
machine.
Description:
The inventory data will be stored in an XML file. The XML file will contain both physical and
logical inventory data according to 3GPP format. The file will be stored under the
configured storage location.


OL-30201-01 19
If file transfer is enabled and both the primary and secondary destinations are not
accessible, the XML file will be generated on the local machine under preconfigured folder.

Input:

Table 6-6: Input Parameters to Retreive Specific Managed Element
1 InvokeIdentifier String This is an optional parameter passed by the
OSS client user. The invoke Identifier value
passed as input to this interface will be
returned (InvokeIdentifierOut) by the Web
Services Interface. The invoke Identifier can
be used by the OSS client for correlation
purpose. The value passed to this is not
validated and is returned to the user as is.
Management Domain. The value expected
is /MD=CISCO_PRIME/ME=<ME Name>
2
.
The Interface will return an Exception if:
The management domain is NOT
CISCO_PRIME.
The managed element is NOT specified OR
managed.

Output:
The output will be in three parts:
1. A regular SOAP response to the Web Service request which will contain the invoke
identifier passed originally in the input and a response string indicating that the
Inventory request is initiated with a request ID.
2. Inventory XML file containing the physical and logical inventory data for the
specified managed element. The request ID will be part of the Inventory file name
that is generated. The user can use the request ID to retrieve the inventory file
generated for a given request.
3. A Status file to indicate the status (IN-PROGRESS, COMPLETED, FAILED) for an
inventory request. The Status file has the request ID as part of its name.

Error:

The following Errors will be reported.

2
The Managed Element name should be identical with that of Prime Network Administration GUI

20 OL-30201-01
Sl.No Error Condition Error Response
1 Unable to read the DMs SOAP reponse indicating
NO DMs available will be
reported.
2 Managed Element does not exist SOAP reponse indicating
Managed Element does not
exist will be returned.

7.5.3.1 InventoryIRP:: getManagedElement Multi DM behaviour
This APIs behavior in a Multi DM environment is given below

Sl.No Condition Behavior
1 When All associated
Domain Managers ( DMs )
are free to take the request
The request to collect inventory will be
initiated to all DMs and the response indicating
that the request is intiated will be sent with a
request ID.
2 When atleast one of the
associated DMs is
processing a previous
inventory request
The request will not be intiated. A reponse
indicating that another request is in progress
will be sent to the user.

7.6 Overview of 3GPP File Transfer IRP
The 3GPP interface for File Transfer IRP provides APIs to retrieve file information. The API
allows user to list files that gets generated as an output of Inventory IRPs getAllInventory and
getManagedElement WS request. The File Transfer IRP also adds support for generating a
FileReady and File Preparation Error Notification. The details of which will be discussed in the
Notification section of this document.
The FT IRP support the following file transfer protocols,
SFTP
FTP
7.7 3GPP File Transfer IRP Interface Details

This section describes the 3GPP File Transfer IRP Interface in details. The operations supported
in File Transfer IRP, input, out put and functionality will be explained.

Appendix section.

OL-30201-01 21

7.7.1 File Transfer IRP::listAvailableFiles
The API details with the input, output and their data types with the description is given
below

Description:
The API will be used to list all available files that were generated by the getAIlInventory or
getManagedElement call from the Inventory IRP agent.Input :

1 managementDataType String This is a mandatory paramenter, should be
provided by the OSS user. It specifies the
type of the management data stored in the
file.
Different management data types are PM,
CM, IM, TE, CT, NL, CG, OT,BASE.
Currently we are supporting only IM
Inventory Management.
2 beginTime DateTime This is an optional parameter and is
expressed in UTC time.
Format : YYYY-MM-DDThh:mm:ss

If user specifies in
YYYY-MM-DDThh:mm:ss:mmm+/-TZ
format, millisecond & timezone part will be
ignored.
This parameter specifies list of available
files whose ready time are later or equal to
this time.
Note : OSS user has to provide the date
time w.r.t management domain timezone.
3 endTime DateTime This is an optional parameter and is
expressed in UTC time.
Format : YYYY-MM-DDThh:mm:ss

If user specifies in
YYYY-MM-DDThh:mm:ss:mmm+/-TZ
format, millisecond & timezone part will be
ignored.
This parameter specifies list of available
files whose ready time are earlier than this
time.

22 OL-30201-01

NOTE:
Output will list a unique set of files from both primary and seconday
OSS user has to provide the input date time for beginTime and endTime w.r.t management
domain timezone.

Output:
This API will list the set of available files from the configured local, primary and secondary FTP
servers
Output paraments
1 fileInfoList fileInfo This specifies the list of files
information retrieved between the
provided beginTime and endTime by
the OSS user.
2 Status String This parameter specifies the status of
the operation.
Possible values are
OperationSucceeded and
OperationFailed.

Output paraments FileInfo object

1 managementDataType String It specifies the type of the
management data stored in the file
which is provided by the OSS user in
request.
Different management data types are
PM, CM, IM, TE, CT, NL, CG, OT,BASE.
Currently we are supporting only IM
Inventory Management.
2 fileLocation String This specifies the complete path of the
IM file located on the disk along with
filename.
Format : IP:/<full path>_<filename>
3 fileSize Long It identifies the size of the file in bytes.
4 fileReadyTime DateTime It identifies the date and time when
the file was created.
5 fileExpirationTime DateTime It identifies the date and time beyond
which the file may be deleted.
6 fileCompression String It identifies the name of the

OL-30201-01 23
compression algorithm used for the
file.
Currently this will be empty as we are
not supporting this.
7 fileFormat String It identifies the encodeing technique
used by the file.
Currently we support XML-schema.

Error:
The following error scenarios will be handled and reported by the API:
Sl.No Condition Error
1. No files are available If no files present in the specified duration,
FileInfoList in soap response will be empty
with status OperationSucceeded.
2 Empty begin time or endTime The response should contain an error message
saying Please enter beginTime in standard
UTC format YYYY-MM-DDThh:mm:ss
3 Invalid Management Datatype The response will have an error message
Invalid management data type.
4 Invalid endTime (EndTime >
BeginTime)
The response should contain an errror
"Endtime greater than beginTime".
5 No beginTime & endTime . The response will list all the files present the
directory
6 . No endTime input . The response should list all the available files
in the directory whose time of creation lies
between user provided beginTime and current
system time (as endTime is not mentioned by
user).
7 . No input beginTime . The response will list all the available files
which are created before the specified
endTime.
8 . Non UTC format of begin or
endTime
. The response will contain an error Please
provide the begin time in standard UTC format
: YYYY-MM-DDThh:mm:ss..
9 . Large volume of files, potential
timeout candidate
. The response willl list all the available files for
the duration provided from the primary and
secondary directory. In case of huge data, an
error will be shown like Could not list the
contents of folder, <path>
10 . Timeout due to FTP server un-
reachable.
. The response willl list all the available files for
secondary directory. In case of connection
timeout from both the servers, an error will be
shown like Both Primary and Secondary are

24 OL-30201-01
Not reachable
11 . Replication enabled between FTP
servers but directory paths are
incorrect.
. The response will list all the available files for
secondary directory. In case directory paths
are not properly mentioned, error will be
shown like Could not list the contents of
<path>.

7.7.1.1 ListAvailableFiles Multi DM Environment:

Description :
ListAvailable files operation in multi DM environment will be aggregated output of result from
each DM.
Input :
ListAvailable files operation input for multi DM environment is same as input in standalone
environment.
Output:
ListAvailable files operation output in multi DM environment will be aggregated output from
each DM.
1 Exception occurred in DM1 or
DM2
If any exception happens in DM1 but the same
operation is successful in DM2, the the final
result will be from DM2

Error :
The error conditions in standalone are applicable for multi DM environment as well.
7.8 Overview of 3GPP Notification IRP
The Notification IRP support provides support for subscribing and unsubscribing to 3GPP
notifications. The current release supports File Transfer Notifications ONLY. Once the
Inventory file generation completes successfully a File Ready Notification will be sent. If
the inventory collection or file generation encounters an issue a File Preparation Error
Notification will be sent.


OL-30201-01 25
7.9 3GPP Notification IRP Details
This interface supports APIs that will allow an OSS user to subscribe and unsubscribe for
various notification categories.

Appendix section.

7.9.1 Notification IRP::subscribe
This interface is used to subscribe to 3GPP notifications. This request will enable an OSS
user to receive any 3GPP notifications that is supported by the IRP agent. Currently we
support the following categories

File Transfer IRP Notifications ( 32347-900 )

Description:
The subscribe call can be issued by an OSS user to register for 3GPP notifications and
enables the OSS user to receive the registered 3GPP notification. If the optional
parameters are not given, the API registers the OSS user for all supported notification
categories ( current release supports the File Ready and File Preparation Error
Notifications ). The Notification consumer should be active when notifications are sent.
Notifications will NOT be stored for future forwards.

Input:

The following table lists the input arguments for the request

1 managerReference URL A valid URL where the
OSS client / IRP
manager will be
listening to.
The URL validation will
not be done during the
registration process.
This is a mandatory
field.
2 timeTicks Long A long value indicating
the time when this
subscription request
should expire.
This is an optional
value and is NOT
supported in this

26 OL-30201-01
release ( PN 4.0 ).
Giving a non-numeric
value will throw a
SOAP / Web Service
exception.
3 notificationCategories ntfIRPData:NotificationCategorySetType This is a set of strings
that can be specified
for which the
subscription will be
done.
This is an optional
parameter. In this
release ( PN 4.0 ), we
support the value
32347-900
indicating the FT IRP
version 9.0.0.
Being an optional
parameter the user is
not expected to give
this as an input which
will automatically
subscribe the OSS user
to receive the
currently supported (
FT Notifications ) only.
4 Filter String This is an optional field
and is NOT supported
int this release ( PN
4.0 ). Any value
specified in this field
will be ignored.
If supported the user
can use this field to
have a customer
filtering for specified
Notification
categories.
5 ntfTrsnsServiceNS anyURI This parameter is used
to specif the
namespace of the
Web Notification
Transmission Service
that will be used for
sending notification.
This is a mandatory
field, but in the

OL-30201-01 27
current release ( PN
4.0 ), this field will not
be used.

NOTE: The managerReference and ntfTrsnsServiceNS are the only mandatory paramters.

Output:

The API gives the subscription ID as an output. This subscription ID will be used to
unsubscribe for notifications.

1 subscriptionID String The subscription ID
will be returned upon
a successful subscribe
request. The
subscription ID along
with the manager
Reference can be used
to un-subscribe for
notifications.

Error:

The following error conditions will be reported by the API

1. Invalid Category Exception indicating an
invalid manager Reference
or category
2 Already registered category Exception indicating that
any of the categories
passed as input is already
registered for this manager
Reference.
3 One or more categories are
not supported
An exception will be
returned If any of the
category entries passed

7.9.1.1 Multi-DM Behaviour
N/A

28 OL-30201-01
7.9.2 Notification IRP::unsubscribe
Description:
This API is used to unsubscribe to any 3GPP notification. The manager Reference that is
passed as input will be used to un-subscribe the OSS / requesting user. The
managerReference is a mandatory parameter.
The operation will un-subscribe the Notification consumer from all subscribed categories
associated with the manager reference.

Input

1 managerReference URL A valid URL where the
OSS client / IRP
manager will be
listening to.
This is a mandatory
field. This value will be
used to remove the
2 subscriptionID String This is an optional
parameter.

Output:

Upon successful completion of un-subscribe operation the manager reference will be
returned.

1 managerReference String The manager
reference that was un-
subscribed.

Error:

The following error will be thrown under the specified conditions:

Condition Error
Invalid Manager Reference Exception indicating an invalid manager Reference
or category


OL-30201-01 29
7.9.2.1 Multi-DM environment behavior
N/A
7.9.3 3GPP FT Notification Consumer

The 3GPP Notification consumer endpoint will be exposed as a Web Service endpoint. This
endpoint can be used by the OSS users who wish to receive notifications to download the
Notification Consumer Interface WSDL.
This Endpoint will not support any operation and is deployed for getting the 3GPP FT IRP
Notificaiton Consumer WSDL.
The WSDL document can be accessed from the Appendix section.

7.10 Overview of 3GPP Notifications
The current version of Notification IRP will allow a subscribed user to receive the
following notifications:

3GPP File Ready Notification
3GPP File Preparation Error Notification

7.10.1 3GPP File Ready Notification
A File Ready Notification will be generated for getAllInventory and
getManagedElement API calls on the Inventory IRP. Only one File Ready Notification will
be sent upon a successful completion of the inventory file creation.
7.10.1.1 3GPP File Ready Notification SOAP Format

The SOAP format for the File Ready Notification is shown below. One File Ready
Notification will be generated per request if atleast one file was generated. The
notification contains information about all the successfully generated files.
A notification sample is shown in the Appendix section.

7.10.2 3GPP File Preparation Error Notification
A File Preparation Error Notification will be generated for getAllInventory and
getManagedElement API calls on the Inventory IRP. Only one File
PreparationNotification will be sent if an error is encountered when inventory collection
or file generation.

7.10.2.1 3GPP File Preparation Error Notification SOAP Format


30 OL-30201-01
This SOAP message for 3GPP File Preparation Error Notification is shown below. The SOAP
message will not contain any information about the files. This notification will be
generated if the file creation process encounters any error.
A notification sample is shown in the Appendix section.
7.10.3 3GPP FT Notification Multi-DM Behavior
Multi-DM environment when all participating DMs generate inventory files for all supported
devices without encountering failure.
1. Notification Consumer ( eg: OSS Client ) subscribes to notifications.
2. Issues request to getAllInventory to Web Serice on PC host
3. All participating DMs are free to handle request.
4. Request initiated on all participating DMs
5. File Generation is successful on each of the DMs
6. Each DM sends a FileReadyNotification
7. Notification consumer receives one FileReadyNotification per DM instance.
Multi-DM environment when no files are generated and DM encounters failure when
generating inventory files for all managed devices
5. File Generation is un-successful on each of the DMs
6. Each DM sends a FilePreparationErrorNotification
7. Notification consumer receives one FilePreparationErrorNotification per DM instance.
Multi-DM environment with partial success and partial failure use case, when some files gets
generated for a set of managed devices and fails for a sub-set of the devices.
5. File Generation is successful for a sub-set of DMs and un-successful for a sub-set on
each / some of the DMs
6. Each DM sends a FileReadyNotification containing those files which were successfully
created AND a FilePreparationErrorNotification for those devices where the DM fails
to generate any file.

OL-30201-01 31
7. Notification consumer receives one FileReadyNotification for a set of successful file
creation and ONE FilePreparationErrorNotification for all the failed file creation per
DM instance.
7.11 Scheduling Web Services
Prime Network Integration Layer uses Prime Network Scheduling framework to schedule
the following 3GPP Web Services.
getAllInventory
getManagedElement
For Scheduling Web Services, User has to use the options available in the Prime Network
Component.
For more details on the Prime Network Web Scheduler , see Cisco Prime Network 4.0 User
Guide.
7.12 3GPP Standard Compliance

This version of 3GPP inventory management is based on 3GPP Release 10 specification (TS
32.690 V10.0.0). The interfaces to retrieve inventory information from the IRP Agent
follow the inventoryNRM.xsd schema described in TS 32.696 V10.3.0.

The 3GPP standard does not define a SOAP solution set for Inventory Management. This is
a Cisco extension for the SOAP solution. The XML output conforms to the 3GPP standard
based inventoryNRM schema. The inventory file contains both the physical and logical
inventory information.

The Logical inventory data contains both standard based and vendor (Cisco) extension
data. The Vendor extension data will be present under the vendor specific data container
(VsDataContainer) section inside the logical inventory section in the XML data file. For
more details on these 3GPP vendor extensions, see Appendix section.

Refer to the 3GPP and MTOSI standards in the link http://www.3gpp.org/specifications.

7.13 Trouble Shooting 3GPP
The below table includes the issues that might be encountered while setting up OSS
integration layer and steps to troubleshoot the problem.


32 OL-30201-01
Table 6-7: OSS Integration Problems and Troubleshooting Procedure
Problem
Description
Indication Probable Cause Troubleshooting Procedure
Web Services
Security
Exception

Web Service call to
any of the Interfaces
will throw a WS
Security exception
with authentication
failure message

The user ID / password
provided for the web
service call might not
be correct.

Use a proper User ID / password for
the web services call.
No DMs
Available
Exception

Exception message
from the Web Service
call, stating that no
DMs are available.

The communication to
PN is not proper. The
Integration layer was
not able to
communicate with the
domain manager ( DM
).

Verify that the Prime
Networks application is
running.
Network Connectivity to the
Prime Networks machine is
proper.
Exception
indicating No
Managed
Element in
Network

A call to
getAllInventory
returns a Web
Services exception
stating that there are
no Managed
Elements in the
network.

The PN system is not
configured to have any
managed elements
Verify if the PN system
contains any managed
elements.
Add network elements that
can be managed by PN.
Issue the Web Service request.
Verify if the Exception
message disappears and Web
Service response indicating
start of inventory collection
appears.
Verify if Inventory files are
getting created

Inventory files
are not copied
to FTP servers

Inventory files are
not present on the
FTP server (primary
and secondary)
configured.

The FTP server
configuration is not
proper.

Verify the FTP server
hostname is reachable.
FTP / SFTP service is running
on the configured hosts.
Login and password is
properly specified during the
FTP configuration setup.

Note: The password will be encrypted
in the configuration file.
getManagedEle
ment returns a
SOAP Exception

A call to
getManagedElement
returns a Web
Services exception
The device name
specified in request is
incorrect

Cross check the device name in
getAllManagedElementNames
response and verify if the device is
not in up state

OL-30201-01 33
stating that the
device is not in up-
state though it is
actually up.

getManagedEle,
ent returns an
ME not in up
state message
Call to
getManagedElement
returns with
exception indicating
the ME is not in up-
state
The Managed Element
is either not managed
by the EMS or is not a
valid name.
This is a valid condition. The managed
element is expected to be managed by
the EMS.
Call to any
WebService
operation
returns a
timeout
exception.
JMS did not get
response in specified
time 3000
milliseconds ( time
out )
There might be an
exception in the
processing on the
server.
Please check the log file under the
INSTALL_DIR/data/log, in the
servicemix.log file for any exceptions.
Call to any
WebService
operation
returns an
authentication
failure error
Exception is received
by the SOAP client.
Exception:
java.lang.Exception:
java.lang.IllegalStateE
xception: Error
communicating with
ANA host
10.105.39.39

The credential given
does not match with
the PN credential.
Please make sure that the credentials
given to the Web Service all is
consistent with the PN credentials.
FTIRP
Webservice
does not list any
files for a call to
listAvailableFiles
Message indicating :
No files to display is
given as a SOAP
response

No files exists on the
system to be displayed
Log on to the PN host, primary and
secondary FTP server. Match the files
based on the start time and end time
supplied for the API.
FTIRP
Webservice gets
files present on
the local file
system.
FTP is configured on
PN host. The File list
info lists the files
indicating the host IP
where the Web
Service is deployed
instead of the FTP
servers name.
Probable cause:
(s)FTP servers
are down.
(s)FTP
credentials are
not correct.
(s)FTP access is
not allowed to
the FTP
servers.
Check the FTP access
Check the FTP permissions
Check the FTP credentials.
FTIRP
WebService gets
files present
under the
primary FTP
Files listed are only
from the primary FTP
server.
Replication is not
configured.
The replication of FTP servers
is not configured.

34 OL-30201-01
server only.
Web Service
Scheduler:
getAllInventory
and
getManagedEle
ment Web
services are
scheduled but
the jobs are not
executed.
The inventory files
are not getting
generated after the
scheduled time
elapses.
The scheduler might be
down on the Prime
network DM.
Log on to the PN system on
which the scheduling is done.
Verify in the scheduler logs to
check if the job is scheduled.
Verify if the Web Service is
accessible.

MTOSI OSS Integration

OL-30201-01 35
8 MTOSI OSS Integration
Cisco implementation of MTOSI APIs provide North Bound Interface support for the
retrieval of physical inventory, Carrier Ethernet connection resources and notifications of
respecitive resource changes.

Managed Elements and Equipment Inventory
Ethernet Virtual Connection Resource Inventory
Inventory Object Create/Delete/Update and Attribute Value Change Notifications

Cisco MTOSI Information Model is designed to conform to MTOSI 2.0 information model
and operational API's. Cisco reference implementation extensions are introduced to
support proprietary APIs and name space as per Cisco PrimeSuite release.

Developer Network.

8.1 Supported Devices for MTOSI Interface

The below table list of supported devices for 3GPP and MTOSI.

Table 7-1: Supported Devices for 3GPP and MTOSI
Supported DM Versions Supported Devices
MTOSI PN 4.0, PC 12 Device support is based on PN
4.0
Mention Cable device support

8.2 MTOSI Inventory Management
Cisco Prime Network support the following features.

Managed Elements and Equipment Inventory
Inventory Object Create/Delete/Update and Attribute Value Change Notifications
Ethernet Virtual Connection Resource Inventory

Cisco MTOSI Information Model is designed to conform to MTOSI 2.0 information model
and operational API's. Cisco reference implementation extensions are introduced to
support proprietary APIs and name space as per Cisco PRIME Release requirements.


36 OL-30201-01
The sections below document all the APIs supported by Cisco Prime Central and Prime
Network. Interfaces are defined in the WSDL and the corresponding data types can be
found in XSD files.
8.3 MTOSI Interface Details

This section describes the MTOSI Interfaces supported.
8.3.1 Managed Element Retrieval Interface

Managed Element retrieval is supported by these APIs:
getAllManagedElementNames
getManagedElement

Appendix section.

8.3.2 Equipment Retrieval Interface
Equipment entity retrieval is supported by these APIs:
getAllEquipment
getEquipment
getContainedEquipment

Appendix section.

8.3.3 Physical Termination Point Retrieval Interface

Physical termination point retrieval is supported by following API:
getAllSupportedPhysicalTermiminationPoints

Appendix section.

The below table list the Notification related APIs on inventory object and attribute
value changes. This table contains the API's supported for Managed Elements, Equipment
Inventory and Notication of the relevant entities and attributes.


OL-30201-01 37
Table 7-2: Supported APIs for Managed Elements, Equipment Inventory
API Response

Request

Description

getAllManagedElementNam
es( ... )
getAllManagedElement
NamesResponse - a list
Managed Element
Names
getAllManaged
ElementNames
Request
Returns all Managed Element
Names. This is a proprietory API
to facilitate getManagedElement
API for a specific managed
element retrieval.
getManagedElement(...) getManagedElementRe
sponse - a specific
Management Element
instance
getManagedEle
mentRequest -
a list of RDN
consisting of
MD/ME name
value pairs
Returns a requested Managed
Element instance. See the
corresponding wsdl/xsd files for
more details.
ManageResourceInv
entory/IIS/wsdl/Ma
nagedElementRetrie
val/ManagedElemen
tRetrievalHttp.wsdl
ManageResourceInv
entory/IIS/xsd/Man
agedElementRetriev
alMessages.xsd
ME Attribute Extension as per
requirement are defined in
NetworkResourceFulfillm
ent/IIS/xsd/Cisco_ME_EQ
_Inventory.xsd
getAllEquipment(..) getAllEquipmentRespo
nse
- a list of all of the
equipment and
equipment holders
contained in a
managed element or
equipment holders
getAllEquipme
ntRequest
- name of the
ME or
equipment
holder for
which to
retrieve
contained
equipment and
equipment
holders
Returns a list of Equipment
Holder, Equipment. See the
more details.
ManageResourceInvento
ry/IIS/wsdl/EquipmentInv
entoryRetrieval/Equipme
ntInventoryRetrievalHttp.
wsdl
ry/IIS/xsd/EquipmentInve
ntoryRetrievalMessages.x
sd
Equipment Attribute Extension as
per requirement are defined in

38 OL-30201-01
_Inventory.xsd
getContainedEquipment(...) getAllEquipmentRespo
nse - a list of all of the
equipment and
equipment holders
contained in the
equipment holders
getAllEquipme
ntRequest
- name of the
equipment
holder to
retrieve the
next level
contained
equipment and
equipment
holders
Returns the next level contained
Equipment Holder
and Equipment list. See the
more details.
ManageResourceInventory/IIS/w
sdl/EquipmentInventoryRetrieval
/EquipmentInventoryRetrievalHtt
p.wsdl
ManageResourceInventory/IIS/xs
d/EquipmentInventoryRetrievalM
essages.xsd
Equipment Attribute Extension as
per requirement are defined in
NetworkResourceFulfillment/IIS/
xsd/Cisco_ME_EQ_Inventory.xsd
getAllSupportedPhysicalTer
minationPoints( ... )
getAllSupportedPhysica
lTerminationPointsRes
ponse - a list of physical
termination endpoints
(PTP) of the specified
equipment
getAllSupporte
dPhysicalTermi
nationPointsRe
quest - a list of
RDNs that
specify the
containing
equipment:
MD/ME/EH[/E
H/EH]/EQ
Returns a list PTPs. See the
more details.
ry/IIS/wsdl/TerminationP
ointRetrieval/Terminatio
nPointRetrievalMessages.
wsdl
ry/IIS/xsd/TerminationPo
intRetrievalMessages.xsd

PTP Attribute Extensions per
requirements are defined in
_Inventory.xsd
subscribe(...) subscribeResponse
- an unique
subscription identifier
is returned to the
Client OS to be used
when invoking the
unsubscribe() for the
given topic. Note that
it must uniquely
identify the request
signature by its three
subscribeRequ
est - This
operation
allows the
Client to
subscribe for
notifications
The subscribe operation used to
receive subscriptions from
consumers . See the
more details.

Framework/IIS/wsdl/Noti
ficationProducer/Notifica
tionProducerHttp.wsdl
Framework/IIS/xsd/Notifi
cationMessages.xsd

OL-30201-01 39
elements:
consumerEPR, topic,
and selector.
unsubscribe(...) unsubscribeResponse
- response message
structure of the
unsubscribe operation.
Note that it is an empty
payload. Failure should
be handled as an
exception.
unsubscribeRe
quest
- This
operation
allows the
Client to
unsubscribe
from a previous
subscribed
notification
channel.
The unsubscribe operation used
to receive subscription
cancellations from consumers.
See the corresponding wsdl/xsd
files for more details.
Framework/IIS/wsdl/Noti
ficationProducer/Notifica
tionProducerHttp.wsdl
Framework/IIS/xsd/Notifi
cationMessages.xsd
notify(...) not applicable not applicable One way (notification) message
structure of the notify operation.
This operation allows event
notification to a client OS for the
following event types:
AttributeValueChangeTy
pe
ObjectCreationType
ObjectDeletionType
For more details, see
Framework/IIS/wsdl/Notification
Producer/NotificationProducerHt
tp.wsdl file.
8.3.4 Ethernet Virtual Connection (EVC) Resource Inventory APIs

EVC resource retrieval is supported by these APIs:
getFlowDomainFragment
getFlowDomainFragmentRoute
getAllFlowDomainFragmentNames

Appendix section.

More details of the interfaces and data type are described in these files below.
ManagedResourceInventory/FlowDomainFragmentRetrieval wsdl file
ManagedResourceInventory/FlowDomainFragmentRetrieval xsd file

The below table lists the APIs for the retrieval of Ethernet Virtual Connections (EVC).

40 OL-30201-01
MTOSI Extension Points andExtensions are described below. Service topologies
supported include point to point, multipoint to mulitpoint and point to multipoint (E-Tree).

Table 7-3: APIs for Retreiving EVC
API

Function

Extension Point and
Extension

getFlowDomainFragme
nt()

Retrieval of Flow Domain
Fragment entities, CTP
entity, and Matrix Flow
Domain
Fragment reference list.
Upon success of this
operation, EVC, service
parameters, EFP and its
parameters, and
Forwarding reference
list will be returned
Extension Points -
FlowDomainFragmentType-
>LayeredParametersType->LayerRateType
>LayeredParametersType-
>vendorExtensions
>TerminationPointDataListType-
>TerminationPointDataType-
>LayeredParametersType-
>vendorExtensions
Extensions are defined in -
NetworkResourcesBasic/IIS/xsd/LayerRates
.xsd
NetworkResourcesBasic/IIS/xsd/Cisco_CE_
LayeredParam.xsd
getFlowDomainFragme
ntRoute()

Retrieval of Matrix Flow
Domain Fragment. Upon
success of this
operation, EoMPLS
Forwarding Entities
including Ethernet PW
edge instances/cross-
connects and VFI when
applicable will be
returned.
Extension Points -
FlowDomainFragmentRouteType ->
MatrixFlowDomainFragmentType -
>LayeredParameterType-
>vendorExtensions
FlowDomainFragmentRouteType ->
MatrixFlowDomainFragmentType-
>vendorExtensions
Extensions are defined in
NetworkResourcesBasic/IIS/xsd/Cisco_CE_Layered
Param.xsd
getAllFlowDomainFrag
mentNames()

Retrieval of names
of all the managed Flow
Domain Fragments . Upon
success of this
operation, all Ethernet
connection names will be
returned.
This is a proprietory API introduced to facilitate the
client to performance subsequent retrieval of a
named Ethernet connection.


OL-30201-01 41
8.3.5 DataCenter
This section covers the details of the Datacenter inventory retrieval functionality.This
functionality was implemented as part of getInventory operation defined in Resource
Inventory Retrieval Interface.

Following are the datacenter inventory retrievals that are supported

List all Available Virtual Data Centers in Prime Network
List of Hosts (under a given datacenter)
List of HostCluster (under a given datacenter)
List of DataStore (under a given datacenter)
List of VMs (includes only names under a vCenter)
Details of aHost
Details of a HostCluster
Details of a DataStore
Details of a VM

8.3.5.1 Resource Inventory Retrieval Interface

Interface Name Description
GetInventory This API is used for Data Center inventory
retrieval

Appendix section.

The various operations using getInventory request are give below:
8.3.5.1.1 List of all available data center names

Input to getInventory API:

Sl.No Request parameter Type Description
1 MD

String This is the Management Domain name.
2 ObjectType String The value expected is Cisco_DC
3 Granularity String The value expected is FULL
Output:
The output will contain all available data centers.
Some of the response parameters are explained below.


42 OL-30201-01
Sl.No Response parameter Type Description
1 dcNm String Data Center name in the following
format:
<VCenter Name>:-:<Data Center
name>
2 name NamingAttributeType RDN of Data Center
3 DM Specific Info Alias
3.1 aliasName String PN Instance Identifier
3.2 aliasValue String Identifier inside PN for the specific
DataCenter instance
4 VendorExtension
VCenter Information

4.1 name String Cisco_vCenter
4.2 value String VCenter Name

8.3.5.1.2 List of all available Host name from a particular Data center.


1 MD

String Management Domain name.
2 Cisco_DC String The value for this should contain the
DataCenter name as reported in
response section of 4.1.5.1.1
3 ObjectType String The value expected is Cisco_V_Host
4 Granularity String The value expected is NAME

Output:
The output will contain list of host names. The parameters in response is explained below.

Response parameter Type Description
hostNm String Host server name.

8.3.5.1.3 Details of a particular host


1 MD

String Management Domain name

OL-30201-01 43
3 Cisco_V_Host String The value for this parameter should
contain the Host Server Name
4 ObjectType String The value expected is Cisco_V_Host

Output:
The output will contain full details of the given host
Some of the parameters in response are explained below.

1 hostNm String Host Server name.
2 name NamingAttributeType RDN of Host Server
3 discoveredName String Host Server name
4 DMSpecificInfo Alias
4.2 aliasValue String Identifier inside PN for the
specific Host server instance
5 VendorExtension
VCenter Information

6 description String
7 management_IP String IP Address of the Host server
specified in the request
8 dnsName String
9 macAddress String
10 state String
11 softwareType String
12 softwareVersion String
13 uuid String
14 dataStoreAllocation CiscoVStoreAllocListType Details of associated data stores
15 vNetwkIntfList CiscoVNetwkTPListType Detail of associated network
interfaces
15 vMotionEnabled boolean
16 evcMode String
17 model String Host Server model name
18 vendor String Host Server vendor name
19 hypervisorProperty CiscoVHypervisorType
20 hostClusterRef NamingAttributeType RDN of Host Cluster in which the
host is participating
21 faultToleranceVersion String
22 faultToleranceEnabled Boolean
23 processPower CiscoVProcessingPwrType

44 OL-30201-01
8.3.5.1.4 List of available Host cluster Name from a particular Data Center


1 MD

4 ObjectType String The value expected is
Cisco_V_HostCluster

Output:
The output will contain list of Host Clusters from a particular Data Center. The parameters in
response is explained below.

hostClusterNm String Host Cluster name.

8.3.5.1.5 Detail information of a Host cluster


1 MD

3 Cisco_V_HostCluster String The value for this parameter should
contain the Host Cluster Name
Cisco_V_HostCluster

Output:
Response will contain detailed information of requested Host Cluster
Some of the parameters are explained in the table below.


OL-30201-01 45
Sl.No Response
parameter
Type Description
1 hostClusterNm String Host Cluster name.
2 name NamingAttributeType RDN of Host Cluster
3 discoveredName String Host Cluster name
4 DMSpecificInfo
specific Host Cluster instance
5 VendorExtension
VCenter Information

6 state String
7 cpuAllocation CiscoVRsrcAllocType CPU allocation details
8 memoryAllocation CiscoVRsrcAllocType
9 isHaEnabled Boolean
10 isDrsEnabled Boolean
11 vmMigrationCount Int
12 evcMotion String
13 isDpmEnabled Boolean

8.3.5.1.6 List of Data Store Name


1 MD

Cisco_V_DataStore

Output:
The output will contain list of all available Data Store names from a particular data center. The
parameter is explained below.

dataStoreNm String This is the Data Store name.


46 OL-30201-01
8.3.5.1.7 Detail information of a particular data store.


1 MD

3 Cisco_V_DataStore String The value for this parameter should
contain the Data Store Name
Cisco_V_DataStore

Output:
Response will contain detailed information of requested Data Store. Some of the
parameters are explained below.

1 dataStoreNm String Data Store name.
2 name NamingAttributeType RDN of Data Store
3 discoveredName String Name of the data Store from the
request
4 DMSpecificInfo
specific Data Store instance
5 VendorExtension
VCenter Information

6 storeType String
7 storeLocation String
8 freeSpace CiscoQuantityUnitType
9 provisionedSpace CiscoQuantityUnitType
10 capacity CiscoQuantityUnitType
11 isAccessible String
12 isMultiHostAccess String
13 uuid String


OL-30201-01 47
8.3.5.1.8 List of available Virtual machine ID


1 MD

4 ObjectType String The value expected is Cisco_VM

Output:
The output will contain list of all available virtual machine names from VCenter. The
parameter is explained below.

vmNm String Virtual Machine Name

8.3.5.1.9 Detail information of a particular data store


1 MD

String This is the Management Domain name
3 Cisco_VM String The value for this parameter should
contain the VM ID
4 ObjectType String The value expected is Cisco_VM

Output:
Response contains detailed information of the requested Virtual machine
1 name NamingAttributeType RDN of Virtual machine
2 discoveredName String Virtual machine name
3 DMSpecificInfo
specific VM instance

48 OL-30201-01
4 VendorExtension
VCenter Information

5 state String
6 productType String
7 softwareType String
8 softwareVersion String
9 cpuAllocation CiscoVRsrcAllocType
10 uuid String
11 memoryAllocation CiscoVRsrcAllocType
12 dataStoreAllocation CiscoVStoreAllocListType Associated data store details
13 serviceId String
14 vmVersion String
15 virtualCPU String
16 minRequiredEVCMode String
17 supportingHostRef NamingAttributeType Host server RDN

8.3.6 L3 MPLS VPN
MPLS VPN functionality is supported as part of two mtosi interfaces.
Resource Inventory Retrieval Interface
Connection Retrieval Interface

Following is the flow to get MPLS inventory.
1- Execute getInventory operation(for exact inputs please check the below
table) implemented as part of ResourceInventoryRetrieval Interface to get all
the configured L3 MPLS-VPN names
2- Execute getSubNetworkConnection operation implemented as part of
Connection Retrieval Interface to get the specific VPN details (for exact
inputs please check the below table)
3- Execute getRoute operation implemented as part of Connection Retrieval
interface to get the available route table entries for the specific VPN.

Appendix section.


OL-30201-01 49
8.3.6.1.1 Retrieving list of configured L3 MPLS-VPN names


1 MD

2 ObjectType String The value expected is SNC

Output:
The output will contain list of all configured VPN IDs. The parameter is explained below.

1 sncNm String This contains the VPN Id Information.
For example:
{"dmIdentifier":"net://net:1","vpnId":"1"}
where net://net:1 is the DM Identifier
and 1 is the VPN Id

8.3.6.2 ConnectionRetrieval Interface

MPLS/VPN attribute retrieval is supported by these APIs:
getSubNetworkConnection
getRoute

Appendix section.

8.3.6.2.1 Retrieving details of a VPN
Input to getSubNetworkConnection API:

1 MD

String This is the Management Domain name
2 MLSN String This is Multi Layer SubNetwork
3 SNC String A VPN name as returned in the
response section of 4.6.1.1

Output:
The output contains detailed information about a VPN. Some of the parameters are
explained below.

50 OL-30201-01

Sl.No Response
parameter
Type Description
1 name NamingAttributeType RDN of SNC
2 discoveredName String VPN name
3 DMSpecificInfo
3.2 aliasValue String VPN Object ID
4 vendorExtensions
4.1 Cisco_MPLS-
VPNAttrName
CiscoMPLSVPNAttrNameType MPLS VPN Naming Attribute
Type
5 direction ConnectionDirectionType The value is CD_BI i.e bi-
directional
6 layerRate LayerRateType
7 aEndTpDataList TerminationPointDataListType
8 correlationIdentifier String
9 callName String
10 connectionId String

8.3.6.2.2 Retrieving route details

Input to getRoute API:

1 MD

2 MLSN String This is Multi Layer SubNetwork
3 SNC String A VPN name as returned in the
response section of 4.6.1.1

Output:
The output contains information related to route tables and enpoints.
Some of the parameters in the response are explained below:

Sl.No Response
parameter
Type Description
1 direction ConnectionDirectionType The value is CD_BI
i.e bi-directional
2 aEndName NamingAttributeType RDN of Interfaces
associated with VRF
3 connectionId String
4 vendorExtensions
4.1 . Cisco_MPLS-
VPNRouteAttrName
. CiscoMPLSVPNRouteAttrNameType
4.1.1 VRF_Name . Naming attribute type RDN of VRF

OL-30201-01 51
4.1.2 VRF_RouteTable . CiscoMPLSVPNRouteType VRF Route table
4.1.3 DMSpecificInfo
4.1.3.1 aliasName . String PN Instance Identifier
4.1.3.2 aliasValue . String Identifier inside PN for
the specific VRF
instance

8.3.7 Floating termination point
This functionality is implemented as part of getInventory operation defined in Resource
Inventory Retrieval Interface.


Appendix section.

8.3.7.1.1 Retrieving details of all available port channels in a device


1 MD

2 ME String Managed Element name
3 ObjectType String The value should be FTP
4 Granularity String The value should be FULL

Output:
The output will contain detailed information of all the available port channels in a device. Some of
the parameters in the response are explained below:

1 ftpInv FloatingTerminationPointInventoryType
2 name NamingAttributeType RDN of FTP
3 DM Specific Info
3.1 aliasName String PN_DM_OID
3.2 aliasValue String Identifier inside PN
for the specific
DataLinkAggregation
instance
4 vendorExtensions

52 OL-30201-01
4.1 Cisco_FTP_AttrName CiscoFTPAttrNameType FTP Attribute
Naming type
4.1.1 aggrProtocolType CiscoFTPAggrProtocolEnumType
4..1.2 adminState CiscoFTPAdminStateEnumType
4.1.3 bandwidth String
4.1.4 grpNumber String
4.1.5 memberIpAddrList CiscoIPAddressListType
4.1.6 macAddress String
4.1.7 ftpMemberList PhysicalTerminationPointListType List of PTP RDN
4.1.8 dot3adLacpAttrs CiscoFTPLACPNameAttrType

8.3.8 Inventory Notification
The Integration Layer (IL) will expose interfaces for enabling clients of the IL to register and
receive notifications of interest. The currently supported IL interfaces consist of the
following:

WS-SOAP interface that supports MTOSI-conformant operations
JMS interface that supports the same MTOSI operations using serialized Java
objects
The IL notification framework should be based on the above interfaces. This entails the
following:

Support the MTOSI-style notification topic registration pattern for the WS-SOAP
interface:
SubscribeResponse subscribe
(Holder<Header> mtopHeader,
SubscribeRequest mtopBody ) throws SubscribeException;
UnsubscribeResponse unsubscribe
(Holder<Header> mtopHeader,
UnsubscribeRequest mtopBody ) throws UnsubscribeException;

The subscribe request specifies the following:
Consumer - URI
Topic - The string indicating the classification of events of interest
Selector - Notification Filter

The subscribe response contains a subscriptionID. The unsubscribe request requires the
subscriptionID(s) and topic(s) provided at the time of registration.Support for standard JMS
topic subscription for the JMS interface.

On the notification consumer side, each client type (WS-SOAP or JMS) is expected to
support a slightly different flow.


OL-30201-01 53
WS-SOAP clients will need to perform the following
Expose the NotificationConsumer API as defined by the
NotificationConsumerHttp.wsdl and documented in the MTOSI R2.0 Framework
DDP
Use the Subscribe operation to register for notifications.

JMS clients will be consuming POJOs with the following format.
ArrayList<Object> consisting of following in this order:
1. com.cisco.prime.esb.fmw.api.Header
2. org.tmforum.mtop.fmw.xsd.notmsg.v1.Notify

For Prime 1.0, the supported notification types will include:
Object Creation Notification
Object Deletion Notification
Attribute Value Change Notification
8.3.8.1 VRF related Notifications
Consumers who have subscribed to the INVENTORY_NOTIFICATIONS topic will receive
notifications related to VRF under the following circumstances

Whenever a VRF gets added
Whenever a VRF gets added
Whenever a CTP gets associated with a VRF
Whenever a CTP gets dissociated with a VRF
Whenever the IP Address of the CTP changes

The following table gives a quick overview about the information received for the
supported notifications. Only the important attributes are detailed in the table below.


54 OL-30201-01
Operation

Notification Type
ObjectType
attribute value
Object Name(FDN)
Type of Object
sent in
Notification
VRF Addition
Object Creation Cisco_V_Route HINTS= TIME:<Date in seconds
format>;DMLIST:<comURI>
MD=CISCO_PRIME
ME=<ME Name>
MLSN=Prime Network
Cisco_V_Route=<VRF Name>
ObjectCreationType.
Cisco_routeList

VRF Deletion
Object Deletion Cisco_V_Route HINTS= TIME:<Date in seconds
MD=CISCO_PRIME
ME=<ME Name>
MLSN=Prime Network
Cisco_V_Route=<VRF Name>
NA
IP Interface(Site)
Association with a
VRF
Object Creation CTP HINTS= TIME:<Date in seconds
MD=CISCO_PRIME
ME=<ME Name>
CTP=<CTP Name>
ObjectCreationType.o
bject

Contained Object:
ctp
IP Interface(Site)
Disassociation with
a VRF
Object Deletion. CTP HINTS= TIME:<Date in seconds
MD=CISCO_PRIME
ME=<ME Name>
CTP=<CTP Name>
NA
IP Interface(Site)
Changes
Attribute Value
Change
CTP HINTS= TIME:<Date in seconds
MD=CISCO_PRIME
ME=<ME Name>
CTP=<CTP Name>
ObjectCreationType.o
bject

Contained Object:
ctp

8.3.8.2 Datacenter Logical Inventory related Notifications

Consumers who have subscribed to the INVENTORY_NOTIFICATIONS topic will receive
notifications for the following changes in DataCenter logical Inventory.


OL-30201-01 55
Logical Inventory
Type
Change Notification Type
Host
Addition of a Host Object Creation
Deletion of a Host
Object Deletion
Changes in Host
Attribute value Change
Changes in HostHypervisor
Attribute Value Change
Changes in HostProcessor Attribute Value Change
Changes in HostCPUCapacityProvision Attribute Value Change
Changes in HostDiskCapacityProvision Attribute Value Change
Changes in HostMemoryCapacityProvision Attribute Value Change
Association of a Virtual Network Entity to a Host Object Creation
Dis-association of a Virtual Network Entity to a Host Object Deletion
Changes in Host Virtual Network Entity Attribute Value Change
Association of a Data Store with a Host Object Creation
Dis-association of a Data Store with a Host Object Creation
Changes in the Data Store Associated with the Host Attribute Value Change
Virtual Machine
Migration of Virtual Machine to a new Host/
Addition of a new Virtual Machine under a Host
Object Creation
Disassociation of a Virtual Machine with Host Object Deletion
Changes in Virtual Machine Attribute Value Change
Changes in VMMemoryCapacityAllocation Attribute Value Change
Changes in of a VMCPUCapacityAllocation Attribute Value Change
Association of a Virtual Network Entity with a Virtual Machine Object Creation
Dis-association of a Virtual Network Entity with a Virtual
Machine
Object Deletion
Changes in Virtual Machine Virtual network entity Attribute Value Change
Association of a Data Store with a Virtual Machine Object Creation
Dis-association of a Data Store with a Virtual Machine Object Creation
Changes in the Data Store Associated with the Virtual Machine Attribute Value Change
Host Cluster
Addition of a Host Cluster Object Creation
Deletion of a Host Cluster Object Deletion
Changes in Host Cluster Attribute Value Change
Changes in HostClusterCPUCapacityProvision Attribute Value Change
Changes in HostClusterDiskCapacityProvision Attribute Value Change
Changes in HostClusterMemoryCapacityProvision Attribute Value Change
Data Store
Addition of a new Data Store Object Creation
Deleteion of a Data Store Object Deletion
Changes in the DataStore Attribute Value Change

The following table gives a quick overview about the information received for the
supported notifications. Only the important attributes are detailed here.


56 OL-30201-01

Operation
Notification
Type
ObjectType
attribute value
Object Name(FDN)
Type of Object sent in
Notification
Addition of a
Host
Object Creation Cisco_V_Host HINTS= TIME:<Date in seconds
MD=CISCO_PRIME
Cisco_DC=<ME Name>:-:<DC
Name> Cisco_V_Host=<Host
Name>
ObjectCreationType.
Cisco_hostList

Deletion of a
Host

Object Deletion
Cisco_V_Host HINTS= TIME:<Date in seconds
MD=CISCO_PRIME
Name>

NA

Changes in Host

Attribute value
Change
MD=CISCO_PRIME
Name>
AttributeValueChangeType.
Cisco_hostList

Changes in
HostHypervisor

Attribute Value
Change
MD=CISCO_PRIME
Name>
Cisco_hostList

Changes in
HostProcessor
Attribute Value
Change
MD=CISCO_PRIME
Name>
Cisco_hostList

Changes in
HostCPUCapacity
Provision
Attribute Value
Change
Cisco_V_Host HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_hostList

Changes in
HostDiskCapacity
Provision
Attribute Value
Change
MD=CISCO_PRIME
Name>
Cisco_hostList

Changes in
HostMemoryCap
acityProvision
Attribute Value
Change
MD=CISCO_PRIME
Name>
Cisco_hostList


OL-30201-01 57
Association of a
Virtual Network
Entity to a Host
Object Creation Cisco_V_networkTP HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_V_networkTP=<Virtual
Network Entity Name>
ObjectCreationType.object

Contained object:
Cisco_V_NetworkTPType

Dis-association of
a Virtual
Network Entity
to a Host
Object Deletion Cisco_V_networkTP HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
NA
Changes in Host
Virtual Network
Entity
Attribute Value
Change
Cisco_V_networkTP HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
attributeList

Contained object:
Cisco_V_NetworkTPType

Association of a
Data Store with a
Host
Object Creation Cisco_V_dataStoreAlloca
tion
HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_V_dataStoreAllocation=<
Allocated Datastore Name>

Contained object:
Cisco_V_StoreAllocType

Dis-association of
a Data Store with
a Host
tion
MD=CISCO_PRIME
Name>
NA
Changes in the
Data Store
Associated with
the Host
Attribute Value
Change
Cisco_V_dataStoreAlloca
tion
MD=CISCO_PRIME
Name>
attributeList

Contained object:

Migration of
Virtual Machine
to a new Host/
Addition of a
Object Creation Cisco_VM HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Cisco_DC=<ME Name>
ObjectCreationType.Cisco_v
MList


58 OL-30201-01
new Virtual
Machine under a
Host
Cisco_VM=<VM ID>
Disassociation of
a Virtual
Machine with
Host
Object Deletion Cisco_VM HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Cisco_DC=<ME Name>
Cisco_VM=<VM ID>
NA
Changes in
Virtual Machine
Attribute Value
Change
Cisco_VM HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Cisco_DC=<ME Name>
Cisco_VM=<VM ID>
Cisco_vMList

Changes in
VMMemoryCapa
cityAllocation
Attribute Value
Change
MD=CISCO_PRIME
Cisco_DC=<ME Name>
Cisco_VM=<VM ID>
Cisco_vMList

Changes in of a
VMCPUCapacityA
llocation
Attribute Value
Change
MD=CISCO_PRIME
Cisco_DC=<ME Name>
Cisco_VM=<VM ID>
Cisco_vMList

Association of a
Virtual Network
Entity with a
Virtual Machine
Object Creation Cisco_V_networkTP HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_VM=<VM ID>

Contained object:

Dis-association of
a Virtual
Network Entity
with a Virtual
Machine
Object Deletion Cisco_V_networkTP HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_VM=<VM ID>
NA
Changes in
Virtual Machine
Virtual network
entity
Attribute Value
Change
Cisco_V_networkTP HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_VM=<VM ID>
attributeList

Contained object:

Association of a
Data Store with a
Virtual Machine
tion
MD=CISCO_PRIME
Name>

Contained object:


OL-30201-01 59
Cisco_VM=<VM ID>
Dis-association of
a Data Store with
a Virtual
Machine
tion
MD=CISCO_PRIME
Name>
Cisco_VM=<VM ID>
NA
Addition of a
Host Cluster
Object Creation Cisco_V_HostCluster HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_V_HostCluster=<Host
Cluster Name>
ObjectCreationType.Cisco_h
ostClusterList

Deletion of a
Host Cluster
Object Deletion Cisco_V_HostCluster HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cluster Name>
NA
Changes in Host
Cluster
Attribute Value
Change
Cisco_V_HostCluster H HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cluster Name>
Cisco_hostClusterList

Changes in
HostClusterCPUC
apacityProvision
Attribute Value
Change
Cisco_V_HostCluster HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cluster Name>

Changes in
HostClusterDiskC
apacityProvision
Attribute Value
Change
MD=CISCO_PRIME
Name>
Cluster Name>

Changes in
HostClusterMem
oryCapacityProvi
sion
Attribute Value
Change
MD=CISCO_PRIME
Name>


60 OL-30201-01
Cluster Name>
Addition of a
new Data Store
Object Creation Cisco_V_DataStore HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Cisco_V_DataStore=<Datastore
Name>
Cisco_dataStoreList

Deleteion of a
Data Store
Object Deletion Cisco_V_DataStore H HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Name>
NA
Changes in the
DataStore
Attribute Value
Change
Cisco_V_DataStore HINTS=TIME:<Date in seconds
MD=CISCO_PRIME
Name>
Name>
Cisco_dataStoreList

8.4 Delta Inventory Management
Delta Inventory provides a facility to retrieve all Managed Elements whose physical
inventory has changed since a specified time.
There are 2 steps involved in performing delta inventory management:
a) Start Tracking Inventory Changes- This will initiate tracking of inventory changes.
b) Get Delta Inventory changes This will retrieve the list of all Managed Elements with
inventory changes.

8.4.1 Managed Element Names Retrieval Interface details

Interface Name Description
getAllManagedElementNamesTS This API is used for delta inventory management

getAllManagedElementNamesTS API is used for Delta Inventory Management.

Appendix section.
8.4.1.1 Start Tracking Inventory Changes
To start tracking Inventory changes, getAllManagedElementNamesTS request has to be
issued without <timestamp> tag.


OL-30201-01 61
The response contains a message, regarding the outcome of Start Tracking Delta Inventory
Request, in addition to the list of Managed Elements. From this point on, any physical
inventory changes to the Managed Elements will be tracked.

Input to getAllManagedElementNamesTS for start tracking inventory changes :

Request parameter Type Description
Nil NA No parameters needed to initiate Start tracking
inventory changes

Output:
1 name String Name of the ME
2 operation OperationType Type of change on the Managed
Element.
This value will be set to UNKNOWN
in this response as this is the initial
request to list all Managed Elements
3 Hints String Contains current time in millis followed
by comURI

4 status String Contains the status of the Start
Tracking Inventory changes request.
On success the status displayed is:
Start Tracking Executed successfully
On failure, the status displayed is:
Start Tracking Execution failed.

NOTE: Any failure in sending the Start Tracking request will not stop this API from listing
devices. However the status label will clearly capture the information that start tracking
failed.

8.4.1.2 Get Delta Inventory changes
To get the list of Managed Elemets whose inventory has changed, the
getAllManagedElementNamesTS request needs to be issued with <timestamp> value in
UTC Format.
The response will contain a list of all managed elements which have been added, deleted
or modified since the time specified in the request. Explaining one such entry from the
response here.

Input to getAllManagedElementNamesTS for get delta inventory changes :

Request parameter Type Description
timestamp Date Valid time in UTC Format i.e
dd-MMM-yyyy HH:mm:ss

62 OL-30201-01
For example:
2013-02-28T14:15:30

Output:

1 name String Name of the ME
2 timestamp Date Last inventory updated time
3 operation OperationType Type of change in the ME i.e ADD,
DELETE or UPDATE
4 Hints String Current time in millis followed by
comURI

Error:
Condition Error
Blank value in <timestamp> tag
-or-
Incorrect format in <timestamp> tag
-or-
Empty timestamp tag <timestamp/>
Umarshalling Error

NOTE:
Sl.No Scenario Result
1 Prime Network restarts
after a Start Tracking
Inventory changes
request is issued.
If a Prime Network restarts,then all the Managed
Elements will be shown as dirty i.e UPDATE in the
operation field in response.
2 When there are no
changes after Start
Tracking was invoked
successfully
-or-
When Start Tracking itself
has failed
The response will contain the message "No changes
detected or Start tracking not issued."
8.5 MTOSI Standard Compliance

Cisco MTOSI Information Model is designed to conform to MTOSI 2.0 specifications.
Cisco reference implementation extensions are introduced to support proprietary APIs and
name space as per Cisco Prime Release requirements. Refer to the MTOSI standards in the
link: http://www.tmforum.org/MultiTechnologyOperations/2319/home.html

OL-30201-01 63

8.6 Trouble Shooting - MTOSI

The below table includes the issues that might be encountered while setting up OSS

Table 7-4: OSS Integration Problems and Troubleshooting Procedure
Problem
Description
Web Services
Security
Exception

Web Service call to
will throw a WS
Security exception
with authentication
failure message

be correct.

No DMs
Available
Exception

Exception message
DMs are available.

not able to
domain manager ( DM
).

running.
proper.
getManagedEle
ment returns a
SOAP Exception

A call to
getManagedElement
returns a Web
Services exception
stating that the
device is not in up-
state though it is
actually up.

The device name
specified in request is
incorrect

Cross check the device name in
getManagedElements response and
correct if device is not in up state

Delta Inventory:
Not receiving
delta inventory
change
notifications.
Notifications are not
received if there is an
inventory change.
If PN-IL is in standlone
mode and if the OSS
user is not subscribed
for the notifications.
Subscribe for the notifications on
MTOSI Notification Producer Web
Service.

Cisco Specific Interfaces

64 OL-30201-01
9 Cisco Specific Interfaces
This section describes the APIs that are provided as CISCO specific interfacaces. These do
not conform to either MTOSI or 3GPP standards.

Cisco Specific Vendor APIs are provided for the following functional areas:

Alarm Life Cycle Management
Alarm Retrieval

Developer Network.

9.1 Alarm Life Cycle Management
The alarm life cycle management support allows any OSS user to perform the following
operations on any Prime Network Ticket. All the following operations are synchronous in
nature
Acknowledge
De-Acknowledge
Clear
Retire
AddNote
The WSDL document describing the details of the Interface can be accessed from the Appendix
section.

The following table lists the Alarm Life Cycle actions supported by PrimeNetwork.

DM/Operation Ack DeAck Clear AddNote Retire
PN

9.1.1 AlarmMgmt::Acknowlege
Add compliance for all the APIs.

Description:
This API is used to acknowledge a Prime Network Ticket.

OL-30201-01 65
Input:
1 uniqueId String This parameter describes the Prime
Network Ticket ID.
This ID could be an integer or of
format {[NewAlarm(Id=X)]}
2 Hint String Optional value that can be used as
extra meta data in processing the
requests. For example, OSS application
or FM can use this as a
timestamp/version/state value that
can be used to correlate actions to
avoid issues with concurrent actions
performed on a Prime Network Ticket.
3 Note String Optional note to include while
performing the operation.
4 Username String Optional attribute. The user on behalf
of whom the operation is done.

Output:
1 uniqueId String The same value which is used in the
operation.
2 Hint String The same value which is used in the
operation.
3 Success Boolean Value denoting the result of the
operation - true in case of success.
Error:
1 Invalid ID provided for the
operation in StandAlone
Integration layer deployment.
When user provides improper ticketId (not in
expected format), the operation will return soap
fault with the detail containing the
alarmApiException. The alarmApiException code
will be API_ERROR and message will contain the
information:
Please enter the PN Ticket Number or OID(format:
[NewAlarm(Id=<Ticket Number>)]
2 Ticket does not exist on the
PrimeNetwork.
The operation will return soap fault with the detail
containing the alarmApiException.
The alarmApiException code will be API_ERROR
and message will contain the information:
DM[<comURI>]=>Message[API_ERROR:<Operation
Name> operation failed. Reason:
<DM_Error_Message>]
where:

66 OL-30201-01
<Operation Name>: the operation name, e.g.
Acknowledge
<comURI>: the comURI of the responding DM
<DM_Error_Message>: the error message returned
by DM.
9.1.2 AlarmMgmt::De-Acknowlege

Description:
This API is used to de-acknowledge a Prime Network Ticket.
Input:
Network Ticket ID.
of whom the de-acknowledge
operation is done.

Output:
operation.
operation.

Error:

OL-30201-01 67
Integration layer deployment. fault with the detail containing the
information:
PrimeNetwork.
<DM_Error_Message>]

where:
Acknowledge
by DM.

9.1.3 AlarmMgmt::Clear
Description:
This API is used to force clear a Prime Network Ticket.
Input:
Network Ticket ID.


68 OL-30201-01
Output:
operation.
operation.
3 Success boolean Value denoting the result of the
Error:
information:
PrimeNetwork.
<DM_Error_Message>]

where:
Acknowledge
by DM.

9.1.4 AlarmMgmt::Retire

Description:
This API is used to retire(archive) a Prime Network Ticket.
Input:
1 uniqueId String This parameter describes the prime
network ticket ID.

OL-30201-01 69
performed on an Prime Network
Ticket.

Output:
operation.
operation.
3 Success boolean Value denoting the result of the

Error:
information:
PrimeNetwork.
<DM_Error_Message>]

where:
Acknowledge
by DM.


70 OL-30201-01
9.1.5 AlarmMgmt::Add Note
Description:
This API is used to add a note to a Prime Network Ticket.
Input:
Network Ticket ID.
performed on an Prime Network
Ticket.
3 Note String The mandatory note which is to be
added to the Prime Network Ticket.

Output:
operation.
operation.

Error:
information:

OL-30201-01 71
PrimeNetwork.
<DM_Error_Message>]

where:
Acknowledge
by DM.

9.2 Alarm Retrieval
This is a vendor extension API provided to retrieve any alarms.

Appendix section.

9.2.1 AlarmRetrieval::getsubtendingEvents
This API allows the user to get all subtending events for an Alarm or a Ticket in PrimeNetwork.

Description:
This API is used to list all subtending events associated with an Alarm or a Ticket in
Prime Network .
Input :

Parameter Data Type Description
uniqueId String This parameter describes the Prime Network Ticket
ID.
This ID could be an integer or of format
{[NewAlarm(Id=X)]}

Output:

1 eventId String This gives the PN event id for the input
ticket provided by user.
2 correlationId String This refers to the alarmId to which the
event is associated with.

72 OL-30201-01
3 Description String This gives the description of the event.
4 Source String Identifier of the model object that is the
root cause of the event
5 duplicationCount String The duplication count as it is calculated
by the VNE. This count is meaningful for
flapping events and represents the total
number of non-cleared events that are
aggregated by this flapping event.
6 Severity String The severeness of the event in the
system. Severity enumeration
(Indeterminate, Information, Cleared,
Warning, Minor, Major , Critical)
7 Timestamp String This gives the origin timestamp of the
event.
8 Archived String Indicates whether this event is archived
in the database of Prime Network.
9 ElementTypeA String The brand name of the device this
network event is associated with.
10 ElementTypeZ String In case of a link, will return the Z size
element type.
11 DetectionType String Represents the way this event was
detected. Possible Values: service,
syslogs, trap v1/v2/v3
12 extendedName String This value can be used to distinct
between event types defined outside
Prime Network, In external OSS systems
such as PPM which forward events to
Prime Network.
13 State String The event state is a short, textual
description of Name field (defined in
send-alarm-msg-util.xml)
14 suppressionDisplay String Indicates whether this event should be
displayed in the GUI
15 Name String Event's type enumeration. For example:
Link down, Port up, Login etc.
16 reductionCount String The reduction count as it is calculated by
the VNE. This count is meaningful for
flapping events and represents the total
number of events that are aggregated by
this flapping event.
17 creationInDeviceTimezone String A human readable string representing
the event creation time in the device
timezone

Error:


OL-30201-01 73
1 Improper TicketID When user provides improper ticketId
(not in expected format), below error
will be shown.
Id provided is invalid. Please enter the
PN Ticket Number or OID(format:
2 TicketID does not exist If user provided ticketId does not exist in
PrimeNetwork, below errorwill be
shown,
GetSubtendingEvents operation failed.
Reason: ERROR (1200000006): OID
doesn't exist
3 Too many events to be processed If the ticketID provided by the user has
10,000 events associated with it, an
error will be thrown like,
GetSubtendingEvents operation failed.
Reason:Too many events to be
processed for the Ticket.

9.3 Trouble Shooting Cisco Specific Interfaces
The table below includes the issues that might be encountered while setting up OSS

Table 8-1: OSS Integration Problems and Troubleshooting Procedures for Cisco Specific Interfaces
Problem
Description
Web Services
Security
Exception

Web Service call to
will throw a WS
Security exception
with authentication
failure message

be correct.

No DMs
Available
Exception

Exception message
DMs are available.

not able to
domain manager ( DM
).

running.
proper.
Subtending
Alarms:
Exception message:
Reason:Too
There are too many
events associated with
The number of events
assoiated with the

74 OL-30201-01
Exception
indicating too
many events.
many events to
be processed for
the Ticket

the Alarm ID/Ticket ID
supplied.
Alarm/Ticket is more than
10K.

Appendix I References to WSDL Documents

OL-30201-01 75
10 Appendix I References to WSDL Documents

10.1 3GPP WSDL Documents

This section contains references to the following WSDL Documents:
3GPP Inventory WSDL
3GPP FT IRP WSDL
3GPP Notification IRP WSDL
3GPP Notification Consumer WSDL

10.1.1 3GPP Inventory WSDL

The WSDL for 3GPP Inventory Management IRP can be accessed from the following URL:

https://<server>:<tgppPort>/TGPPInventoryIRP_RPC?wsdl

Where:
server is the hostname or IP address of Prime Central or Prime Network Server
tgppPort is the port number where CXF service for TGPP is running. By default port number is
9220.

10.1.2 3GPP FT IRP WSDL

The WSDL for 3GPP File Transfer IRP can be accessed from the following URL:

https://<server>:<tgppPort>/TGPPFileTransferIRP_RPC?wsdl

Where:
9220.

10.1.3 3GPP Notification IRP WSDL


https://<server>:<tgppPort>/TGPPNotificationIRP_RPC?wsdl
Where:

76 OL-30201-01
9220.

10.1.4 3GPP Notification Consumer WSDL
This WSDL will be used by the Notification Consumer ( OSS ) to receive 3GPP Notifications.

This WSDL does not support any operation and is provided for the OSS client user to download
the WSDL.


https://<server>:<tgppPort>/TGPPNotificationIRP_Consumer?wsdl

Where:
9220.

10.2 MTOSI WSDL Documents

This section contains references to the following WSDL Documents:
Managed Element Retrieval WSDL
Managed Element Names Retrieval WSDL
Equipment Inventory Retrieval WSDL
Termination Point Retrieval WSDL
Resource Inventory Retrieval WSDL
Connection Retrieval WSDL
Ethernet Virtual Connection (EVC) Resource Retrieval WSDL

10.2.1 Managed Element Retrieval WSDL
The WSDL documents can be obtained by following URL

https://<server>:< mtosiPort>/ManagedElementRetrieval_RPC?wsdl
https://<server>:<mtosiport>/ManagedElementNamesRetrieval_RPC?wsdl

Where:
serveris the hostname or IP address of Prime Central or Prime Network Server
mtosiPort - is the port number where the mtosi service is running. By default port number is
9110.

OL-30201-01 77
10.2.2 Managed Element Names Retrieval WSDL
The WSDL document can be obtained from the following URL

https://<server>:<mtosiPort>/ManagedElementNamesRetrieval_RPC?wsdl

Where:
9110.

10.2.3 Equipment Inventory Retrieval WSDL
WSDL document can be obtained by following URL

https://<server>:<mtosiPort>/ EquipmentInventoryRetrieval_RPC?wsdl

Where:
9110.

10.2.4 Termination Point Retrieval WSDL
The WSDL document can be obtained by following URL

https://<server>:<mtosiPort>/ TerminationPointRetrieval_RPC?wsdl

Where:
9110.

10.2.5 Resource Inventory Retrieval WSDL

https://<server>:<mtosiPort>/ResourceInventoryRetrievalRPC?wsdl

Where:
mtosiPort is the port number where CXF service for MTOSI is running. By default port number
is 9110.


78 OL-30201-01
10.2.6 Connection Retrieval WSDL

https://<server>:<mtosiPort>/ConnectionRetrievalRPC?wsdl

Where:
is 9110

10.2.7 Ethernet Virtual Connection (EVC) Resource Retrieval WSDL


https://<server>:<mtosiPort>/FlowDomainFragmentRetrievalRPC?wsdl

Where:
serveris the hostname or IP address of Prime Central or Prime Network Server
is 9110

10.3 Cisco Specific Extensions WSDL Documents
This section has references to the following WSDL Documents:
Alarm Life Cycle Management WSDL
Alarm Retrieval Management WSDL

10.3.1 Alarm Life Cycle Management WSDL
The WSDL for Alarm Life Cycle management Interface can be accessed from the following URL:

https://<server>:<alarmMgmtPort>/AlarmManagementAPI ?wsdl

Where:

server - is the hostname or IP address of Prime Central or Prime Network Server where the
Web Service is running.
alarmMgmtPort is the port number where CXF service for Alarm Mgmt API is running. By
default port number is 9020.

OL-30201-01 79
10.3.2 Alarm Retrieval Management WSDL

The WSDL for Alarm Retrieval interface can be accessed from the following URL:

https://<server>:<alarmMgmtPort>/AlarmRetrievalAPI?wsdl

Where:

server - is the hostname or IP address of Prime Central or Prime Network Server where the
Web Service is running.
alarmMgmtPort is the port number where CXF service for Alarm Mgmt API is running. By
default port number is 9020.

11 Appendix II 3GPP-Miscellaneous

This section includes:
3GPP InventoryNrm Schema File
3GPP Inventory File
3GPP Detailed Inventory Information
3GPP Status File
3GPP FT-IRP Inventory Notifications
FTP Configuration
Useful Code Snippets for 3GPP

11.1 3GPP InventoryNrm Schema File

<?xml ver si on="1.0" encodi ng="UTF-8"?>

<! - -
3GPP TS 32. 696 I nvent or y Management NRM I RP
I nvent or y dat a f i l e NRM- speci f i c XML schema
i nvent or yNr m. xsd
- - >

<schema
t ar get Namespace=
"http://www.3gpp.org/ftp/specs/archive/32_series/32.696#inventoryNrm"
el ement For mDef aul t ="qualified"
xml ns="http://www.w3.org/2001/XMLSchema"
xml ns: xn=
"http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm"
xml ns: i n=
"http://www.3gpp.org/ftp/specs/archive/32_series/32.696#inventoryNrm"
>
Appendix II 3GPP-Miscellaneous

80 OL-30201-01



<! - - I nvent or y Management Al t er nat i ve 1 NRM I RP NRM cl ass associ at ed XML
el ement s - - >
<si mpl eType name="eightOctetsType">
<r est r i ct i on base="hexBinary">
<l engt h val ue="8"/ >
</ r est r i ct i on>
</ si mpl eType>
<si mpl eType name="fourOctetsType">
<r est r i ct i on base="hexBinary">
<l engt h val ue="4"/ >
</ si mpl eType>
<si mpl eType name="angleValueType">
<r est r i ct i on base="short">
<mi nI ncl usi ve val ue="0"/ >
<maxI ncl usi ve val ue="3600"/ >
</ si mpl eType>

<el ement
name="InventoryUnit"
subst i t ut i onGr oup="xn:ManagedElementOptionallyContainedNrmClass"
>
<compl exType>
<compl exCont ent >
<ext ensi on base="xn:NrmClass">
<sequence>
<el ement
name="attributes"
mi nOccur s="0">
<compl exType>
<al l >
<el ement
name="inventoryUnitType"
t ype="string"
/ >
<el ement
name="vendorUnitFamilyType"
t ype="string"
mi nOccur s="0"
/ >
<el ement
name="vendorUnitTypeNumber"
t ype="string"
mi nOccur s="0"
/ >
<el ement
name="vendorName"
t ype="string"/ >
<el ement
name="serialNumber"
t ype="string"
mi nOccur s="0"/ >

OL-30201-01 81
<el ement
name="dateOfManufacture"
t ype="date"
mi nOccur s="0"/ >
<el ement
name="dateOfLastService"
t ype="date"
mi nOccur s="0"/ >
<el ement
name="unitPosition"
t ype="string"
mi nOccur s="0"/ >
<el ement
name="manufacturerData"
t ype="string"
mi nOccur s="0"/ >
<el ement
name="versionNumber"
t ype="string"
mi nOccur s="0"/ >
<el ement name="relatedFunction" t ype="xn:dn" mi nOccur s="0"/ >
</ al l >
</ compl exType>
</ el ement >
<el ement r ef ="xn:ManagedFunction" mi nOccur s="0"/ >
<choi ce mi nOccur s="0" maxOccur s="unbounded">
<el ement r ef ="in:InventoryUnit"/ >
<el ement r ef ="xn:VsDataContainer"/ >
<el ement r ef ="in:TmaInventoryUnit"/ >
<el ement r ef ="in:AntennaInventoryUnit"/ >
</ choi ce>
</ sequence>
</ ext ensi on>
</ compl exCont ent >
</ compl exType>
</ el ement >
<el ement name="TmaInventoryUnit"
subst i t ut i onGr oup="xn:ManagedElementOptionallyContainedNrmClass">
<compl exType>
<compl exCont ent >
<sequence>
<el ement name="attributes" mi nOccur s="0">
<compl exType>
<al l >
<! - - I nher i t ed at t r i but es f r omI nvent or yUni t - - >
<el ement name="inventoryUnitType" t ype="string"/ >
<el ement name="vendorUnitFamilyType" t ype="string" mi nOccur s="0"/ >
<el ement name="vendorUnitTypeNumber" t ype="string" mi nOccur s="0"/ >
<el ement name="vendorName" t ype="string"/ >
<el ement name="serialNumber" t ype="string" mi nOccur s="0"/ >
<el ement name="dateOfManufacture" t ype="date" mi nOccur s="0"/ >
<el ement name="dateOfLastService" t ype="date" mi nOccur s="0"/ >
<el ement name="unitPosition" t ype="string" mi nOccur s="0"/ >
<el ement name="manufacturerData" t ype="string" mi nOccur s="0"/ >
<el ement name="versionNumber" t ype="string" mi nOccur s="0"/ >
<! - - End of i nher i t ed at t r i but es f r omI nvent or yUni t - - >
<el ement name="tmaNumberOfNonLinearGainValues" t ype="short"
mi nOccur s="0"/ >

82 OL-30201-01
<el ement name="tmaNonLinearGainValue" t ype="short" mi nOccur s="0"/ >
<el ement name="tmaAdditionalDataFieldNumber" t ype="short" mi nOccur s="0"/ >
<el ement name="tmaAntennaModelNumber" t ype="string" mi nOccur s="0"/ >
<el ement name="tmaAntennaOperatingBands" t ype="short" mi nOccur s="0"/ >
<el ement name="tmaBeamwidthForEachOpBandInBandOrder"
t ype="in:eightOctetsType" mi nOccur s="0"/ >
<el ement name="tmaGainForEachOpBandInBandOrder" t ype="in:fourOctetsType"
mi nOccur s="0"/ >
<el ement name="tmaInstallationDate" t ype="string" mi nOccur s="0"/ >
<el ement name="tmaInstallersId" t ype="string" mi nOccur s="0"/ >
<el ement name="tmaMaxSupportedGain" t ype="short" mi nOccur s="0"/ >
<el ement name="tmaMinSupportedGain" t ype="short" mi nOccur s="0"/ >
</ al l >
</ compl exType>
</ el ement >
</ choi ce>
</ sequence>
</ ext ensi on>
</ compl exType>
</ el ement >
<el ement name="AntennaInventoryUnit"
subst i t ut i onGr oup="xn:ManagedElementOptionallyContainedNrmClass">
<compl exType>
<compl exCont ent >
<sequence>
<el ement name="attributes" mi nOccur s="0">
<compl exType>
<al l >
<! - - I nher i t ed at t r i but es f r omI nvent or yUni t - - >
<el ement name="inventoryUnitType" t ype="string"/ >
<el ement name="vendorUnitFamilyType" t ype="string" mi nOccur s="0"/ >
<el ement name="vendorUnitTypeNumber" t ype="string" mi nOccur s="0"/ >
<el ement name="vendorName" t ype="string"/ >
<el ement name="serialNumber" t ype="string" mi nOccur s="0"/ >
<el ement name="dateOfManufacture" t ype="date" mi nOccur s="0"/ >
<el ement name="dateOfLastService" t ype="date" mi nOccur s="0"/ >
<el ement name="unitPosition" t ype="string" mi nOccur s="0"/ >
<el ement name="manufacturerData" t ype="string" mi nOccur s="0"/ >
<el ement name="versionNumber" t ype="string" mi nOccur s="0"/ >
<! - - End of i nher i t ed at t r i but es f r omI nvent or yUni t - - >
<el ement name="maxTiltValue" t ype="in:angleValueType" mi nOccur s="0"/ >
<el ement name="minTiltValue" t ype="in:angleValueType" mi nOccur s="0"/ >
<el ement name="mechanicalOffset" t ype="in:angleValueType" mi nOccur s="0"/ >
<el ement name="baseElevation" t ype="integer" mi nOccur s="0"/ >
<el ement name="latitude" t ype="decimal" mi nOccur s="0"/ >
<el ement name="longitude" t ype="decimal" mi nOccur s="0"/ >
<el ement name="patternLabel" t ype="string" mi nOccur s="0"/ >
</ al l >
</ compl exType>
</ el ement >
</ choi ce>
</ sequence>

OL-30201-01 83
</ ext ensi on>
</ compl exType>
</ el ement >
</ schema>
11.2 3GPP Inventory File

A Sample inventory file is given here

I M_20120808_1005+0300_32767_10. 86. 66. 35_10002. xml

Where :

IM Indicates the management type
20120808 Date of creation
32767File expiry time in hours
10.86.66.35 Name of the device
10002 Running serial number ( RC )

11.2.1 Inventory File Contents

The inventory file contains physical and logical inventory information. A sample inventory
file containing inventory data is given here:

<?xml ver si on=" 1. 0" encodi ng=" UTF- 8" st andal one=" yes" ?>
<?xml - st yl esheet t ype=" t ext / xsl " hr ef =" I nvent or yXSLT. xsl " ?>
<I nvent or yUni t
xml ns: ns2=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 626#gener i cN
r m"
xml ns=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 696#i nvent or yNr m
" xml ns: ns4=" Ci scoTgppI nvCommon" xml ns: ns3=" Ci scoSpeci f i cGGSNNameSpace"
xml ns: ns9=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 526#sonPol i c
yNr m"
xml ns: ns5=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 755#epcNr m"
xml ns: ns6=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 636#cor eNr m"
xml ns: ns10=" Ci scoSpeci f i cPGWNameSpace" xml ns: ns7=" apnpr of i l e"
xml ns: ns11=" Ci scoSpeci f i cSGWNameSpace" xml ns: ns8=" saegw" >
>
<at t r i but es>
Managed El ement Dat a
<vendor Uni t Fami l yType>CI SCO_ASR_5000</ vendor Uni t Fami l yType>
<vendor Uni t TypeNumber ></ vendor Uni t TypeNumber >
<vendor Name>Ci sco</ vendor Name>
<ser i al Number ></ ser i al Number >
<ver si onNumber >14. 0 ( 43929) </ ver si onNumber >
</ at t r i but es>

<at t r i but es>
Har dwar e Uni t Dat a
<vendor Uni t Fami l yType>ASR5000 Chassi s</ vendor Uni t Fami l yType>

84 OL-30201-01
<vendor Uni t TypeNumber ></ vendor Uni t TypeNumber >
<ser i al Number ></ ser i al Number >
<uni t Posi t i on>ManagedEl ement =10. 56. 22. 105, Chassi s=1</ uni t Posi t i on>
</ at t r i but es>

<at t r i but es>
Har dwar e Uni t Dat a
<vendor Uni t Fami l yType>Redundancy Cr ossbar Car d - 40</ vendor Uni t Fami l yType>
<vendor Uni t TypeNumber >Unknown Modul e</ vendor Uni t TypeNumber >
<ser i al Number >SAD154000TG</ ser i al Number >
<uni t Posi t i on>ManagedEl ement =10. 56. 22. 105, Chassi s=1,
Sl ot Num=40</ uni t Posi t i on>
<ver si onNumber >V03</ ver si onNumber >
</ at t r i but es>

:
:
:

<! - - Logi cal I nvent or y - - >


<at t r i but es>
Sof t war e Uni t Dat a
</ at t r i but es>
<ns2: ManagedFunct i on
<ns2: VsDat aCont ai ner i d=" bul u- VsDat a1" >
<ns2: at t r i but es>
<ns2: vsDat aType xsi : t ype=" xs: st r i ng"
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema"
xml ns: xsi =" ht t p: / / www. w3. or g/ 2001/ XMLSchema- i nst ance" >cl ass
com. ci sco. pr i me. esb. t gpp. model . common. Ser vi ngGWFunct i on</ ns2: vsDat aType>
<ns2: vsDat aFor mat Ver si on xsi : t ype=" xs: st r i ng"
xml ns: xsi =" ht t p: / / www. w3. or g/ 2001/ XMLSchema-
i nst ance" >ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 755#epcNr m-
9. 3. 0</ ns2: vsDat aFor mat Ver si on>
<ns2: vsDat a xsi : t ype=" ns4: vsDat aCi scoSpeci f i cMobi l eCont ai ner "
xml ns: xsi =" ht t p: / / www. w3. or g/ 2001/ XMLSchema- i nst ance" >
<ns5: Ser vi ngGWFunct i on
<ns5: user Label >bul u</ ns5: user Label >
<ns5: pLMNI dLi st / >
<ns5: t ACLi st / >
</ ns5: at t r i but es>
<ns2: VsDat aCont ai ner i d=" bul u- VsDat a1" >
<ns2: vsDat aType xsi : t ype=" xs: st r i ng" xml ns: xs=" ht t p: / / www


OL-30201-01 85
. w3. or g/ 2001/ XMLSchema" >Ser vi ngGWFunct i on</ ns2: vsDat aType>
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Ci scoSpeci f i cAt t r i but es. sgw. 1.
0</ ns2: vsDat aFor mat Ver si on>
<ns2: vsDat a xsi : t ype=" ns11: SGWSer vi ceType" >
<ns11: Account i ngCont ext >bi swa</ ns11: Account i ngCont ext >
<ns11: Account i ngMode>GTPP</ ns11: Account i ngMode>
<ns11: Egr essCont ext >bi swa</ ns11: Egr essCont ext >
<ns11: Egr essPr ot ocol >gt p- pmi p</ ns11: Egr essPr ot ocol >
<ns11: Ser vi ceSt at us>Down</ ns11: Ser vi ceSt at us>
</ ns2: vsDat a>
</ ns2: VsDat aCont ai ner >
</ ns5: Ser vi ngGWFunct i on>
</ ns2: vsDat a>
</ ns2: ManagedFunct i on>


<! - - ACS I nvent or y - - >

i d=" {[ ManagedEl ement ( Key=Si mul at edASR5K) ] [ Logi cal Root ] [ Cont ext ( Cont ext Name=l oc
al ) ] [ Mobi l e] [ Act i veChar gi ngCont ai ner ] [ Act i veChar gi ngSer vi ce( Ser vi ceName=demo) ]
}" >
<ns2: VsDat aCont ai ner i d=" demo- VsDat a1" >
com. ci sco. pr i me. esb. t gpp. model . common. AcsPr of i l e</ ns2: vsDat aType>
i nst ance" >Ci scoSpeci f i cAt t r i but es. acs. 1. 0</ ns2: vsDat aFor mat Ver si on>
<ns8: AcsPr of i l e
i d=" {[ ManagedEl ement ( Key=Si mul at edASR5K) ] [ Logi cal Root ] [ Cont ext ( Cont ext Name=l oc
al ) ] [ Mobi l e] [ Act i veChar gi ngCont ai ner ] [ Act i veChar gi ngSer vi ce( Ser vi ceName=demo) ]
}" >
<ns8: user Label >demo</ ns8: user Label >
<ns2: VsDat aCont ai ner i d=" demo- VsDat a1" >
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Act i veChar gi ngSer vi ce</ ns2: vsDat aT
ype>
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Ci scoSpeci f i cAt t r i but es. acs. 1. 0</ n
s2: vsDat aFor mat Ver si on>
<ns2: vsDat a xsi : t ype=" ns23: Act i veChar gi ngSer vi ceType"
xml ns: ns23=" Act i veChar gi ngSer vi ceType" >
<Act i veChar gi ngFai r Usage>
<CpuThr eshol dPer cent >100</ CpuThr eshol dPer cent >
</ Act i veChar gi ngFai r Usage>

86 OL-30201-01
<Al gMedi aI dl eTi meout >
120 sec
</ Al gMedi aI dl eTi meout >
<Bandwi dt hPol i cyCont ai ner >
<Bandwi dt hPol i cy>
<Bandwi dt hPol i cyName>hi ma</ Bandwi dt hPol i cyName>
<Tot al Bandwi dt hI DConf i gur ed>0</ Tot al Bandwi dt hI DConf i gur ed>
<Tot al Gr oupLi mi t Conf i gur ed>0</ Tot al Gr oupLi mi t Conf i gur ed>
</ Bandwi dt hPol i cy>
<Tot al Bandwi dt hPol i cyConf i gur ed>1</ Tot al Bandwi dt hPol i cyConf i gur ed>
</ Bandwi dt hPol i cyCont ai ner >
<Cdr Fl owCont r ol >Enabl ed</ Cdr Fl owCont r ol >
<Cdr Fl owCont r ol Unsent QueueSi ze>75</ Cdr Fl owCont r ol Unsent QueueSi ze>
<Cdr Fl owUnsent QueueHi gh>56</ Cdr Fl owUnsent QueueHi gh>
<Cdr Fl owUnsent QueueLow>18</ Cdr Fl owUnsent QueueLow>
<Char gi ngAct i onCont ai ner >
<Char gi ngAct i on>
<Char geVol ume>i p byt es</ Char geVol ume>
<Char gi ngAct i onAl l ocat i onRet ent i onPr i or i t y/ >
<Char gi ngAct i onBandwi dt h>
<BandWi dt hI D>0</ BandWi dt hI D>
<Downl i nk>Di sabl ed</ Downl i nk>
<Upl i nk>Di sabl ed</ Upl i nk>
</ Char gi ngAct i onBandwi dt h>
<Char gi ngAct i onBi l l i ngAct i on>
<Edr >Di sabl ed</ Edr >
<Egcdr >Di sabl ed</ Egcdr >
<Radi usAccount i ngRecor d>Di sabl ed</ Radi usAccount i ngRecor d>
<Rf Account i ng>Di sabl ed</ Rf Account i ng>
<Udr >Enabl ed</ Udr >
</ Char gi ngAct i onBi l l i ngAct i on>
<Char gi ngAct i onFl owAct i on>
<Cl ear Quot aRet r yTi mer >Di sabl ed</ Cl ear Quot aRet r yTi mer >
<Condi t i onal Redi r ect >4</ Condi t i onal Redi r ect >
<Di scar d>Di sabl ed</ Di scar d>
<OcsRedi r ect URL>Di sabl ed</ OcsRedi r ect URL>
<Redi r ect URL>Di sabl ed</ Redi r ect URL>
<Ter mi nat eFl ow>Di sabl ed</ Ter mi nat eFl ow>
<Ter mi nat eSessi on>Di sabl ed</ Ter mi nat eSessi on>
</ Char gi ngAct i onFl owAct i on>
<Char gi ngAct i onName>hi m</ Char gi ngAct i onName>
<Char gi ngAct i onQoS>
<Renegot i at eTr af f i cCl ass>Di sabl ed</ Renegot i at eTr af f i cCl ass>
</ Char gi ngAct i onQoS>
<Char gi ngAct i onVi deo>
<Readdr essi ngCAE>Di sabl ed</ Readdr essi ngCAE>
<Tr ansr at i ng>Di sabl ed</ Tr ansr at i ng>
</ Char gi ngAct i onVi deo>
<Char gi ngEDRName>Di sabl ed</ Char gi ngEDRName>
<Char gi ngEGCDRs>Di sabl ed</ Char gi ngEGCDRs>
<Char gi ngRf >Di sabl ed</ Char gi ngRf >
<Char gi ngUDRs>Enabl ed</ Char gi ngUDRs>
<Cont ent Fi l t er i ng>Enabl ed</ Cont ent Fi l t er i ng>
<Cont ent I d>0</ Cont ent I d>
<Cr edi t Conr ol >Di sabl ed</ Cr edi t Conr ol >
<Fl owI dl eTi meout >
</ Fl owI dl eTi meout >
<Fl owMappi ngI dl eTi meout >
</ Fl owMappi ngI dl eTi meout >

OL-30201-01 87
<Li mi t For Fl owTypeSt at e>Di sabl ed</ Li mi t For Fl owTypeSt at e>
<Ret r ansmi ssi onCount >Di sabl ed</ Ret r ansmi ssi onCount >
</ Char gi ngAct i on>
<Condi t i onal Redi r ect >Di sabl ed</ Condi t i onal Redi r ect >
<Ter mi nat eSessi on>Enabl ed</ Ter mi nat eSessi on>
<Char gi ngAct i onName>act i on1</ Char gi ngAct i onName>

88 OL-30201-01
<Condi t i onal Redi r ect >Di sabl ed</ Condi t i onal Redi r ect >
<Char gi ngAct i onName>deva- char gi ng</ Char gi ngAct i onName>
<Char gi ngAct i onAl l ocat i onRet ent i onPr i or i t y>
<Pr i or i t yCapabi l i t yI ndi cat or >1</ Pr i or i t yCapabi l i t yI ndi cat or >
<Pr i or i t yLevel >4</ Pr i or i t yLevel >
<Pr i or i t yVul ner abi l i t yI ndi cat or >0</ Pr i or i t yVul ner abi l i t yI ndi cat or >
</ Char gi ngAct i onAl l ocat i onRet ent i onPr i or i t y>
<Condi t i onal Redi r ect >kar t eekkar t eek</ Condi t i onal Redi r ect >

OL-30201-01 89
<Char gi ngAct i onName>hi ma</ Char gi ngAct i onName>
<Cr edi t Conr ol >Enabl ed</ Cr edi t Conr ol >
<Cr edi t Rat i ngGr oup>5000</ Cr edi t Rat i ngGr oup>
</ Char gi ngAct i onCont ai ner >
<Cont ent Fi l t er i ng>Di sabl ed</ Cont ent Fi l t er i ng>
<Cont ent Fi l t er i ngCat egor i esCont ai ner / >
<Cont ent Fi l t er i ngMat chMet hod>gener i c</ Cont ent Fi l t er i ngMat chMet hod>
<Cr edi t Cont r ol Cont ai ner >
<Cr edi t Cont r ol Gr oups>
<ApnType>gn</ ApnType>
<Cr edi t Cont r ol Di amet er >
<Di ct i onar y>dcca- cust om8</ Di ct i onar y>
<Pendi ngTi meout >
</ Pendi ngTi meout >
<Sessi onFai l over >Di sabl ed</ Sessi onFai l over >
</ Cr edi t Cont r ol Di amet er >
<Fai l ur eHandl i ng>
t er mi nat e
<Ter mi nat eRequest >r et r y- and- t er mi nat e</ Ter mi nat eRequest >
<Updat eRequest >r et r y- and- t er mi nat e</ Updat eRequest >
</ Fai l ur eHandl i ng>
<Gr oup>dcca- 1</ Gr oup>
<Mode>Radi us</ Mode>
<MsccFi nal Uni t Act i on>cat egor y</ MsccFi nal Uni t Act i on>
<Pendi ngTr af f i cTr eat ment >
<For cedReaut h>dr op</ For cedReaut h>
<NoQuot a>dr op</ NoQuot a>
<Quot aExhaust ed>dr op</ Quot aExhaust ed>
<Tr i gger >dr op</ Tr i gger >
<Val i di t yExpi r ed>dr op</ Val i di t yExpi r ed>
</ Pendi ngTr af f i cTr eat ment >

90 OL-30201-01
<Quot a>
<Hol di ngTi me>
N/ A
</ Hol di ngTi me>
<Request Tr i gger >i ncl ude packet </ Request Tr i gger >
<Ti meThr eshol d>N/ A</ Ti meThr eshol d>
<Uni t sThr eshol d>N/ A</ Uni t sThr eshol d>
<Val i di t yTi me>
</ Val i di t yTi me>
<Vol umeThr eshol d>N/ A</ Vol umeThr eshol d>
</ Quot a>
<Ser ver Unr eachabl eFai l ur eHandl i ng>
N/ A
<Updat eRequest >N/ A</ Updat eRequest >
</ Ser ver Unr eachabl eFai l ur eHandl i ng>
<Tr i gger Type>N/ A</ Tr i gger Type>
</ Cr edi t Cont r ol Gr oups>
<Pendi ngTi meout >
<Gr oup>deva- cr edi t - cont r ol </ Gr oup>
<Mode>Di amet er </ Mode>
<Quot a>
<Hol di ngTi me>
</ Hol di ngTi me>
<Val i di t yTi me>
</ Quot a>

OL-30201-01 91
<ApnType>vi r t ual </ ApnType>
<EndPoi nt Real m>N/ A</ EndPoi nt Real m>
<Endpoi nt Name>deva- or i gi n</ Endpoi nt Name>
<Pendi ngTi meout >
<Sessi onFai l over >Enabl ed</ Sessi onFai l over >
<Di amet er Peer Sel ect >
256
pr ef i x
234
<Peer >deva- peer </ Peer >
<Real m>N/ A</ Real m>
<Secondar yPeer >deva- secondar y</ Secondar yPeer >
<Secondar yReal m>N/ A</ Secondar yReal m>
</ Di amet er Peer Sel ect >
cont i nue go- of f l i ne- af t er - t x- expi r y
<Ter mi nat eRequest >cont i nue r et r y- af t er - t x- expi r y</ Ter mi nat eRequest >
<Updat eRequest >t er mi nat e</ Updat eRequest >
<Gr oup>deva- cr edi t </ Gr oup>
<MsccFi nal Uni t Act i on>sessi on onper - mscc- exhaust i on</ MsccFi nal Uni t Act i on>
<NoQuot a>buf f er </ NoQuot a>
<Quot aExhaust ed>buf f er </ Quot aExhaust ed>
<Quot a>
<Request Tr i gger >excl ude packet </ Request Tr i gger >
<Ti meThr eshol d>23 ( per cent ) </ Ti meThr eshol d>
<Uni t sThr eshol d>45 ( per cent ) </ Uni t sThr eshol d>
<Val i di t yTi me>
<Vol umeThr eshol d>85 ( per cent ) </ Vol umeThr eshol d>
</ Quot a>
cont i nue
<Updat eRequest >cont i nue</ Updat eRequest >
<Tr i gger Type>cel l i d</ Tr i gger Type>
<Pendi ngTi meout >

92 OL-30201-01
<Gr oup>deva- cr edi t - bug</ Gr oup>
<Quot a>
<Hol di ngTi me>
</ Hol di ngTi me>
<Val i di t yTi me>
</ Quot a>
<Pendi ngTi meout >
<Ter mi nat eRequest >cont i nue</ Ter mi nat eRequest >
<Gr oup>hi ma</ Gr oup>
<Mode>Di amet er </ Mode>
<For cedReaut h>pass</ For cedReaut h>
<NoQuot a>buf f er </ NoQuot a>
<Quot aExhaust ed>pass</ Quot aExhaust ed>
<Tr i gger >pass</ Tr i gger >
<Val i di t yExpi r ed>pass</ Val i di t yExpi r ed>
<Quot a>
<Hol di ngTi me>
</ Hol di ngTi me>

OL-30201-01 93
<Uni t sThr eshol d>100 ( per cent ) </ Uni t sThr eshol d>
<Val i di t yTi me>
<Vol umeThr eshol d>78763 ( byt es) </ Vol umeThr eshol d>
</ Quot a>
<Tr i gger Type>l ac</ Tr i gger Type>
</ Cr edi t Cont r ol Cont ai ner >
<DeepPacket I nspect i on>Enabl ed</ DeepPacket I nspect i on>
<Dymami cCont ent Fi l t er i ng>Di sabl ed</ Dymami cCont ent Fi l t er i ng>
<Gr oupof Rul edef Cont ai ner >
<Gr oupOf Rul edef >
<Appl i cat i onType>Char gi ng</ Appl i cat i onType>
<Name>Rul edef s1</ Name>
</ Gr oupOf Rul edef >
</ Gr oupof Rul edef Cont ai ner >


act i vechar gi nggr oupof -
r ul edef s
<Passi veMode>Di sabl ed</ Passi veMode>
<Rul ebaseCont ai ner >
<Rul ebase>
<Char gi ngRul eOpt i mi zat i on>Hi gh</ Char gi ngRul eOpt i mi zat i on>
<Del ayedChar gi ng>Di sabl ed</ Del ayedChar gi ng>
<Fai r UsageWai ver Per cent age>425</ Fai r UsageWai ver Per cent age>
Di sabl ed
<P2pDynami cRout i ng>Enabl ed</ P2pDynami cRout i ng>
<QosRenogot i at i onTi meout >
</ QosRenogot i at i onTi meout >
<Rt pDynami cRout i ng>Enabl ed</ Rt pDynami cRout i ng>
<Rul ebaseBi l l i ngAndChar gi ngRecor ds>
<Edr Supr essZer oByt eRecor ds>Di sabl ed</ Edr Supr essZer oByt eRecor ds>
</ Rul ebaseBi l l i ngAndChar gi ngRecor ds>
<Rul ebaseCCAFi el ds>
<Quot aRet r yTi me>
</ Quot aRet r yTi me>
<Rul ebaseCCAQuot aHol di ngTi meEnt r i es>
<Quot aHol di ngTi me>
</ Quot aHol di ngTi me>
</ Rul ebaseCCAQuot aHol di ngTi meEnt r i es>
<Rul ebaseCCATi meDur at i onAl gor i t hmEnt r i es>
<Al gor i t hmName>Par ki ng Met er </ Al gor i t hmName>
<Cont ent I d>any</ Cont ent I d>
<Ti me>4294967295 ( secs) </ Ti me>
</ Rul ebaseCCATi meDur at i onAl gor i t hmEnt r i es>
</ Rul ebaseCCAFi el ds>
<Rul ebaseCont ent Fi l t er i ng/ >
<Rul ebaseEGCDRFi el ds>
<Downl i nkOct et s>100003</ Downl i nkOct et s>

94 OL-30201-01
<Rul ebaseEGCDRTar i f f Ti meThr eshol dEnt r i es>
<Tar i f f Name>Ti me1</ Tar i f f Name>
<Tar r i f f Ti meVal ue>
<hr s>23</ hr s>
<mi ns>59</ mi ns>
</ Tar r i f f Ti meVal ue>
</ Rul ebaseEGCDRTar i f f Ti meThr eshol dEnt r i es>
<Thr eshol dI nt er val >40000000 ( secs) </ Thr eshol dI nt er val >
<Ti meBasedMet er i ng>Di sabl ed</ Ti meBasedMet er i ng>
<Tot al Oct et s>5604321</ Tot al Oct et s>
<Upl i nkOct et s>5000005</ Upl i nkOct et s>
</ Rul ebaseEGCDRFi el ds>
<Rul ebaseFl owEndCondi t i ons/ >
<Rul ebaseName>hi ma</ Rul ebaseName>
<Rul ebaseTCPPr oxyMode>
<Cont ent Fi l t er i ng>Di sabl ed</ Cont ent Fi l t er i ng>
<DccaEnabl ed>Di sabl ed</ DccaEnabl ed>
Enabl ed
<Next HopReaddr essi ng>Di sabl ed</ Next HopReaddr essi ng>
<Pr oxyMode>Dynami c</ Pr oxyMode>
<Xheader I nser t i on>Di sabl ed</ Xheader I nser t i on>
</ Rul ebaseTCPPr oxyMode>
<Rul ebaseTet her i ngDet ect i on>
<OsBasedDet ect i on>Di sabl ed</ OsBasedDet ect i on>
<Tet her i ngDet ect i on>Enabl ed</ Tet her i ngDet ect i on>
<UaBasedDet ect i on>Enabl ed</ UaBasedDet ect i on>
</ Rul ebaseTet her i ngDet ect i on>
<Rul ebaseUDRFi el ds>
<Thr eshol dI nt er val >
</ Thr eshol dI nt er val >
<Udr Tr i gger >Enabl ed</ Udr Tr i gger >
</ Rul ebaseUDRFi el ds>
<Ur l Bl ackLi st i ngAct i on>t er mi nat e- f l ow</ Ur l Bl ackLi st i ngAct i on>
<Ur l Bl ackl i st i ngCont ent I d>35</ Ur l Bl ackl i st i ngCont ent I d>
<XHeader ReEncr ypt i onPer i od>
0 mi n
</ XHeader ReEncr ypt i onPer i od>
</ Rul ebase>
<Rul ebase>
<P2pDynami cRout i ng>Di sabl ed</ P2pDynami cRout i ng>
<Rt pDynami cRout i ng>Di sabl ed</ Rt pDynami cRout i ng>

OL-30201-01 95
<Rul ebaseName>def aul t </ Rul ebaseName>
<Pr oxyMode>Di sabl ed</ Pr oxyMode>
<Tet her i ngDet ect i on>Di sabl ed</ Tet her i ngDet ect i on>
<Udr Tr i gger >Di sabl ed</ Udr Tr i gger >
<Ur l Bl ackLi st i ngAct i on>Not Conf i gur ed</ Ur l Bl ackLi st i ngAct i on>
</ Rul ebase>
<Rul ebase>
<P2pDynami cRout i ng>Di sabl ed</ P2pDynami cRout i ng>
<Rt pDynami cRout i ng>Di sabl ed</ Rt pDynami cRout i ng>
<Rul ebaseName>wi r el ess</ Rul ebaseName>
<Pr oxyMode>Di sabl ed</ Pr oxyMode>
<Tet her i ngDet ect i on>Di sabl ed</ Tet her i ngDet ect i on>

96 OL-30201-01
<Udr Tr i gger >Di sabl ed</ Udr Tr i gger >
<Ur l Bl ackLi st i ngAct i on>Not Conf i gur ed</ Ur l Bl ackLi st i ngAct i on>
</ Rul ebase>
</ Rul ebaseCont ai ner >
<Rul edef Cont ai ner >
<Rul edef >
<CopyPacket ToLog>Di sabl ed</ CopyPacket ToLog>
<Mul t i Li neOR>Di sabl ed</ Mul t i Li neOR>
<Rul eName>t est 1</ Rul eName>
<Tet her edFl owCheck>Di sabl ed</ Tet her edFl owCheck>
</ Rul edef >
<Rul edef >
<CopyPacket ToLog>Di sabl ed</ CopyPacket ToLog>
<Mul t i Li neOR>Di sabl ed</ Mul t i Li neOR>
<Rul eName>r ul e1</ Rul eName>
<Tet her edFl owCheck>Di sabl ed</ Tet her edFl owCheck>
</ Rul edef >
</ Rul edef Cont ai ner >
<Sel ect edChar gi ngRul ebaseFor AVP>Last </ Sel ect edChar gi ngRul ebaseFor AVP>
<TcpFl owI dl eTi meout >
</ TcpFl owI dl eTi meout >
<TcpFl owMappi ngI dl eTi meout >
</ TcpFl owMappi ngI dl eTi meout >
<UdpFl owI dl eTi meout >
</ UdpFl owI dl eTi meout >
<UdpFl owMappi ngTi meout >
</ UdpFl owMappi ngTi meout >
<Ur l Bl ackLi st i ng>Enabl ed</ Ur l Bl ackLi st i ng>
<Ur l Bl ackl i st i ngMat chMet hod>exact </ Ur l Bl ackl i st i ngMat chMet hod>
</ ns2: vsDat a>
</ ns8: AcsPr of i l e>
</ ns2: vsDat a>
</ ns15: I nvent or yUni t >
:
:
:

<! AAA Gr oup I nvent or y - - >

i d=" {[ ManagedEl ement ( Key=Si mul at edASR5K) ] [ Logi cal Root ] [ Cont ext ( Cont ext Name
=l ocal ) ] [ AAACont ai ner ] [ AAAGr oupCont ai ner ] [ AAAGr oup( Gr oupName=def aul t ) ] }" >

OL-30201-01 97
<ns2: VsDat aCont ai ner i d=" def aul t - VsDat a1" >
com. ci sco. pr i me. esb. t gpp. model . common. AAAGr oup</ ns2: vsDat aType>
i nst ance" >Ci scoSpeci f i cAt t r i but es. aaa. 1. 0</ ns2: vsDat aFor mat Ver si on>
<ns10: AAAGr oup
=l ocal ) ] [ AAACont ai ner ] [ AAAGr oupCont ai ner ] [ AAAGr oup( Gr oupName=def aul t ) ] }" >
<ns10: user Label >def aul t </ ns10: user Label >
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >AAAGr oup</ ns2: vsDat aType>
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Ci scoSpeci f i cAt t r i but es. aaa. 1.
<ns2: vsDat a xsi : t ype=" ns23: AAAGr oupType" xml ns: ns23=" AAAGr oupType" >
<AAADi amet er Conf i gur at i on>
<AAADi amet er Account i ngGener al Conf i gur at i on>
<Di ct i onar y>nasr eq</ Di ct i onar y>
<Request Ti meout >
</ Request Ti meout >
</ AAADi amet er Account i ngGener al Conf i gur at i on>
<AAADi amet er Account i ngSer ver sEnt r i es>
<Di amet er Ser ver Host Name>sdf g</ Di amet er Ser ver Host Name>
<Number Of I nst anceI nDownSt at e>21</ Number Of I nst anceI nDownSt at e>
<Number Of I nst anceI nUpSt at e>0</ Number Of I nst anceI nUpSt at e>
<Pr i or i t y>23</ Pr i or i t y>
</ AAADi amet er Account i ngSer ver sEnt r i es>
<AAADi amet er Account i ngSer ver sEnt r i es>
<Di amet er Ser ver Host Name>s123</ Di amet er Ser ver Host Name>
</ AAADi amet er Account i ngSer ver sEnt r i es>
<AAADi amet er Aut hent i cat i onGener al Conf i gur at i on>
<Di ct i onar y>aaa- cust om11</ Di ct i onar y>
<Request Ti meout >
</ Request Ti meout >
<Redi r ect Host AVP>Di sabl ed</ Redi r ect Host AVP>
</ AAADi amet er Aut hent i cat i onGener al Conf i gur at i on>
<AAADi amet er Aut hent i cat i onSer ver sEnt r i es>
<Di amet er Ser ver Host Name>abcder t </ Di amet er Ser ver Host Name>
</ AAADi amet er Aut hent i cat i onSer ver sEnt r i es>
<AAADi amet er Aut hent i cat i onSer ver sEnt r i es>
<Di amet er Ser ver Host Name>ab</ Di amet er Ser ver Host Name>

98 OL-30201-01
</ AAADi amet er Aut hent i cat i onSer ver sEnt r i es>
<Gr oupName>def aul t </ Gr oupName>
</ AAADi amet er Conf i gur at i on>
<AAARadi usConf i gur at i on>
<AAARadi usAccount i ngGener al Conf i gur at i on>
<Account i ngGTPt r i gger Pol i cy>st andar d</ Account i ngGTPt r i gger Pol i cy>
<Account i ngRequest MaxRet r i es>5</ Account i ngRequest MaxRet r i es>
<Account i ngResponseTi meout >
</ Account i ngResponseTi meout >
<ApnToBeI ncl uded>Gn</ ApnToBeI ncl uded>
<Ar chi ve>Enabl ed</ Ar chi ve>
<Fi r eAndFor get >Di sabl ed</ Fi r eAndFor get >
<MaxOut st andi ngAAAMessages>256</ MaxOut st andi ngAAAMessages>
<MaxPDUSi ze>2048</ MaxPDUSi ze>
<Remot eAddr ess>Di sabl ed</ Remot eAddr ess>
<Ser ver Bi l l i ngVer si on>0</ Ser ver Bi l l i ngVer si on>
<Ser ver DeadTi me>
</ Ser ver DeadTi me>
<Ser ver Sel ect i onAl gor i t hm>Fi r st - ser ver </ Ser ver Sel ect i onAl gor i t hm>
</ AAARadi usAccount i ngGener al Conf i gur at i on>
<AAARadi usAccount i ngKeepAl i veAndDeadSer ver Conf i gur at i on>
<Cal l i ngSt at i onI D>000000000000000</ Cal l i ngSt at i onI D>
<Det ect DeadSer ver Consecut i veFai l ur es>4</ Det ect DeadSer ver Consecut i veFai l ur e
s>
<Det ect DeadSer ver KeepAl i ve>Di sabl ed</ Det ect DeadSer ver KeepAl i ve>
<KeepAl i veConsecut i veResponse>1</ KeepAl i veConsecut i veResponse>
<KeepAl i veI nt er val >
</ KeepAl i veI nt er val >
<KeepAl i veMaxRet r i es>3</ KeepAl i veMaxRet r i es>
<KeepAl i veTi meout >
</ KeepAl i veTi meout >
<User Name>Test - User name</ User Name>
</ AAARadi usAccount i ngKeepAl i veAndDeadSer ver Conf i gur at i on>
<AAARadi usAut hent i cat i onGener al Conf i gur at i on>
<ApnToBeI ncl uded>Gn</ ApnToBeI ncl uded>
<Aut hent i cat eNul l User Name>Enabl ed</ Aut hent i cat eNul l User Name>
<Aut hent i cat i onRequest MaxRet r i es>5</ Aut hent i cat i onRequest MaxRet r i es>
<Aut hent i cat i onResponset i meout >
</ Aut hent i cat i onResponset i meout >
<MaxOut st andi ngAAAMessages>256</ MaxOut st andi ngAAAMessages>
<Modi f yNASI P>Di sabl ed</ Modi f yNASI P>
<Pr obeI nt er val >
</ Pr obeI nt er val >
<Pr obeMaxRet r i es>5</ Pr obeMaxRet r i es>
<Pr obeTi meout >
</ Pr obeTi meout >
<Ser ver DeadTi me>
<Ser ver Sel ect i onAl gor i t hm>Fi r st - ser ver </ Ser ver Sel ect i onAl gor i t hm>
</ AAARadi usAut hent i cat i onGener al Conf i gur at i on>

OL-30201-01 99
<AAARadi usAut hent i cat i onKeepAl i veAndDeadSer ver Conf i gur at i on>
<Cal l i ngSt at i onI D>000000000000000</ Cal l i ngSt at i onI D>
s>
<Det ect DeadSer ver KeepAl i ve>Di sabl ed</ Det ect DeadSer ver KeepAl i ve>
<KeepAl i veConsecut i veResponse>1</ KeepAl i veConsecut i veResponse>
<KeepAl i veI nt er val >
</ KeepAl i veI nt er val >
<KeepAl i veMaxRet r i es>3</ KeepAl i veMaxRet r i es>
<KeepAl i veTi meout >
</ KeepAl i veTi meout >
<User Name>Test - User name</ User Name>
<Al l owAccessRej ect >Di sabl ed</ Al l owAccessRej ect >
<Aut hent i cat i onPasswor d>Test - Passwor d</ Aut hent i cat i onPasswor d>
</ AAARadi usAut hent i cat i onKeepAl i veAndDeadSer ver Conf i gur at i on>
<AAARadi usChar gi ngGener al Conf i gur at i on>
<Account i ngSer ver Sel ect i onAl gor i t hm>Fi r st -
ser ver </ Account i ngSer ver Sel ect i onAl gor i t hm>
<Aut hent i cat i onSer ver Sel ect i onAl gor i t hm>Fi r st -
ser ver </ Aut hent i cat i onSer ver Sel ect i onAl gor i t hm>
<Char gi ngDet ect DeadSer ver Consecut i veFai l ur es>4</ Char gi ngDet ect DeadSer ver Co
nsecut i veFai l ur es>
<Maxi mumOut st andi ngAAAMessages>256</ Maxi mumOut st andi ngAAAMessages>
<Ser ver DeadTi me>
<Ser ver MaxRet r i es>5</ Ser ver MaxRet r i es>
<Ser ver ResponseTi meout >
</ Ser ver ResponseTi meout >
</ AAARadi usChar gi ngGener al Conf i gur at i on>
<AAARadi usChar gi ngTr i gger sConf i gur at i on>
<MsTi mezoneChangeTr i gger >Enabl ed</ MsTi mezoneChangeTr i gger >
<Qual i t yOf Ser vi ceChangeTr i gger >Enabl ed</ Qual i t yOf Ser vi ceChangeTr i gger >
<Radi oAccessTechnol ogyChangeTr i gger >Enabl ed</ Radi oAccessTechnol ogyChangeTr
i gger >
<Rout i ngAr eaI nf or mat i onChangeTr i gger >Enabl ed</ Rout i ngAr eaI nf or mat i onChange
Tr i gger >
<Ser vi ngNodeChangeTr i gger >Enabl ed</ Ser vi ngNodeChangeTr i gger >
<User Locat i onI nf or mat i onChangeTr i gger >Enabl ed</ User Locat i onI nf or mat i onChan
geTr i gger >
</ AAARadi usChar gi ngTr i gger sConf i gur at i on>
<Al l owAccount i ngDown>Enabl ed</ Al l owAccount i ngDown>
<Al l owAut hent i cat i onDown>Di sabl ed</ Al l owAut hent i cat i onDown>
<Aut hent i cat or Val i dat i on>Enabl ed</ Aut hent i cat or Val i dat i on>
<Di ct i onar y>st ar ent - vsa1</ Di ct i onar y>
</ AAARadi usConf i gur at i on>
</ ns2: vsDat a>
</ ns10: AAAGr oup>
</ ns2: vsDat a>
.

100 OL-30201-01
.
.
.

<! AAA Di amet er Endpoi nt I nvent or y - - >

=l ocal ) ] [ AAACont ai ner ] [ AAADi amet er Endpoi nt Cont ai ner ] [ AAADi amet er Endpoi nt ( E
ndpoi nt Name=endpoi nt 2) ] }" >
<ns2: VsDat aCont ai ner i d=" endpoi nt 2- VsDat a1" >
com. ci sco. pr i me. esb. t gpp. model . common. AAADi amet er Endpoi nt </ ns2: vsDat aType>
i nst ance" >Ci scoSpeci f i cAt t r i but es. aaa. 1. 0</ ns2: vsDat aFor mat Ver si on>
<ns11: AAADi amet er Endpoi nt
=l ocal ) ] [ AAACont ai ner ] [ AAADi amet er Endpoi nt Cont ai ner ] [ AAADi amet er Endpoi nt ( E
ndpoi nt Name=endpoi nt 2) ] }" >
<ns11: user Label >endpoi nt 2</ ns11: user Label >
<ns2: VsDat aCont ai ner i d=" endpoi nt 2- VsDat a1" >
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >AAADi amet er Endpoi nt </ ns2: vsDat
aType>
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Ci scoSpeci f i cAt t r i but es. aaa. 1.
<ns2: vsDat a xsi : t ype=" ns23: AAADi amet er Endpoi nt Type"
xml ns: ns23=" AAADi amet er Endpoi nt Type" >
<AAADi amet er Rout eEnt r i es>
<Appl i cat i on>CC Not Conf i gur ed</ Appl i cat i on>
<Or i gi n>*</ Or i gi n>
<Peer Host Name>*</ Peer Host Name>
<Peer Name>peer 2</ Peer Name>
<Peer Real m>st ar ent net wor ks. com</ Peer Real m>
<Rout eType>St at i c</ Rout eType>
<Rout eWei ght >10</ Rout eWei ght >
</ AAADi amet er Rout eEnt r i es>
<Peer Host Name>peer 2</ Peer Host Name>

OL-30201-01 101
<Peer Name>peer - 5</ Peer Name>
<Peer Host Name>peer - 5</ Peer Host Name>
<AAADi amet er Rout eHeal t hSt at usEnt r i es>
<Avai l abl eCount >21</ Avai l abl eCount >
<Fai l edCount >0</ Fai l edCount >
<Or i gi nCount >21</ Or i gi nCount >
<Peer Host Name></ Peer Host Name>
</ AAADi amet er Rout eHeal t hSt at usEnt r i es>

102 OL-30201-01
<Peer Host Name>peer - 5</ Peer Host Name>
</ ns2: vsDat a>
</ ns11: AAADi amet er Endpoi nt >
</ ns2: vsDat a>

.
.
.
.
<! GTPP I nvent or y - - >

=hai m) ] [ Mobi l e] [ GTPPGr oupCont ai ner ] [ GTPPGr oup( Gr oupName=def aul t ) ] }" >
com. ci sco. pr i me. esb. t gpp. model . common. Gt ppPr of i l e</ ns2: vsDat aType>
i nst ance" >Ci scoSpeci f i cAt t r i but es. gt pp. 1. 0</ ns2: vsDat aFor mat Ver si on>
<ns9: gt ppPr of i l e
=hai m) ] [ Mobi l e] [ GTPPGr oupCont ai ner ] [ GTPPGr oup( Gr oupName=def aul t ) ] }" >
<ns9: user Label >def aul t </ ns9: user Label >
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Gt ppPr of i l e</ ns2: vsDat aType>
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Ci scoSpeci f i cAt t r i but es. gt pp. 1
. 0</ ns2: vsDat aFor mat Ver si on>
<ns2: vsDat a xsi : t ype=" ns23: GTPPGr oupType" xml ns: ns23=" GTPPGr oupType" >
<Account i ngSer ver Fai l ur eDet ect i on>

OL-30201-01 103
<DeadSer ver Suppr essCDRs>Di sabl ed</ DeadSer ver Suppr essCDRs>
<DeadTi me>
</ DeadTi me>
s>
<Dupl i cat eHol dTi meMi nut es>
</ Dupl i cat eHol dTi meMi nut es>
<EchoMaxRet r i es>4</ EchoMaxRet r i es>
<EchoTi meout >
</ EchoTi meout >
<Redi r ect i onAl l owed>yes</ Redi r ect i onAl l owed>
</ Account i ngSer ver Fai l ur eDet ect i on>
<CDRAt t r i but esI ndi cat or >
<ApnPr esent >Enabl ed</ ApnPr esent >
<Camel I nf o>Di sabl ed</ Camel I nf o>
<Cel l PLMNI d>Enabl ed</ Cel l PLMNI d>
<Char gi ngChar act er i st i cSel ect i onModePr esent >Enabl ed</ Char gi ngChar act er i st i
cSel ect i onModePr esent >
<Dest i nat i onNumber >Enabl ed</ Dest i nat i onNumber >
<Di agnost i csPr esent >Di sabl ed</ Di agnost i csPr esent >
<Dur at i on>Di sabl ed</ Dur at i on>
<Dynami cFl agPr esent >Enabl ed</ Dynami cFl agPr esent >
Enabl ed
<Li st Of Ser vi ceDat aPr esent >Enabl ed</ Li st Of Ser vi ceDat aPr esent >
<Local RecSeqNumPr esent >Di sabl ed</ Local RecSeqNumPr esent >
<Msi sdn>Enabl ed</ Msi sdn>
<NodeI DPr esent >Enabl ed</ NodeI DPr esent >
<PdnConnect i onI DPr esent >Enabl ed</ PdnConnect i onI DPr esent >
<PdpAddr essPr esent >Enabl ed</ PdpAddr essPr esent >
<PdpTypePr esent >Enabl ed</ PdpTypePr esent >
<PgwPLMNI DPr esent >Enabl ed</ PgwPLMNI DPr esent >
<Pl mnI DPr esent >Enabl ed</ Pl mnI DPr esent >
<Rat >Di sabl ed</ Rat >
<Rat Pr esent >Enabl ed</ Rat Pr esent >
<Recor di ngEnt i t y>Enabl ed</ Recor di ngEnt i t y>
<Ser vedMNAI Pr esent >Enabl ed</ Ser vedMNAI Pr esent >
<Ser vedPDPPDNAddr essExt ensi onPr esent >Di sabl ed</ Ser vedPDPPDNAddr essExt ensi o
nPr esent >
<Ser vi ceCent r e>Enabl ed</ Ser vi ceCent r e>
<St ar t Ti mePr esent >Enabl ed</ St ar t Ti mePr esent >
<St opTi mePr esent >Enabl ed</ St opTi mePr esent >
<User Locat i onI nf or mat i onPr esent >Enabl ed</ User Locat i onI nf or mat i onPr esent >
</ CDRAt t r i but esI ndi cat or >
<CDRTr i gger s>
<Cel l Updat e>Di sabl ed</ Cel l Updat e>
<Di r ect Tunnel >Enabl ed</ Di r ect Tunnel >
<Egcdr MaxLosdvLi mi t >Di sabl ed</ Egcdr MaxLosdvLi mi t >
Enabl ed
Di sabl ed
<MsTi mezoneChange>Enabl ed</ MsTi mezoneChange>
<OnRATChangeGener at e>CDR</ OnRATChangeGener at e>
<Pl mnI DChange>Di sabl ed</ Pl mnI DChange>
<QosChange>Enabl ed</ QosChange>
<Rat Change>Enabl ed</ Rat Change>
<Rout i ngAr eaUpdat e>Enabl ed</ Rout i ngAr eaUpdat e>
<Ser vi ngNodeChangeLi mi t >Enabl ed</ Ser vi ngNodeChangeLi mi t >
<Tar i f f Ti meChange>Enabl ed</ Tar i f f Ti meChange>

104 OL-30201-01
<Ti meLi mi t >Enabl ed</ Ti meLi mi t >
<Vol umeLi mi t >Enabl ed</ Vol umeLi mi t >
</ CDRTr i gger s>
<Cdr MaxRet r i es>4</ Cdr MaxRet r i es>
<Cdr St or ageMode>r emot e</ Cdr St or ageMode>
<Cdr Ti meout >
</ Cdr Ti meout >
<Char gi ngAgent >
<Char gi ngAgent Addr ess>
0. 0. 0. 0
</ Char gi ngAgent Addr ess>
</ Char gi ngAgent >
<Dat aReqSt ar t SeqNum>0</ Dat aReqSt ar t SeqNum>
<Di ct i onar y>st andar d</ Di ct i onar y>
<EGCDRDat aGener at i onConf i gur at i on>
<Cl osi ngCauseUni que>no</ Cl osi ngCauseUni que>
<Del et eSer vi ceThr eshol ds>no</ Del et eSer vi ceThr eshol ds>
no
<LosdvMaxCont ai ner s>10</ LosdvMaxCont ai ner s>
<Lot dvMaxCont ai ner s>8</ Lot dvMaxCont ai ner s>
<Ser vi ceI dl eTi meout >
</ Ser vi ceI dl eTi meout >
<Ser vi ceI nt er val >
</ Ser vi ceI nt er val >
</ EGCDRDat aGener at i onConf i gur at i on>
<Local St or age>
<Fi l eCompr essi on>none</ Fi l eCompr essi on>
<Fi l eFor mat >cust om1</ Fi l eFor mat >
<Fi l eRot at i onCDRCount >10000</ Fi l eRot at i onCDRCount >
<Fi l eRot at i onTi meI nt er val >
</ Fi l eRot at i onTi meI nt er val >
<Fi l eRot at i onVol umeLi mi t >4</ Fi l eRot at i onVol umeLi mi t >
<For ceFi l eRot at i onByTi meI nt er val >Di sabl ed</ For ceFi l eRot at i onByTi meI nt er val
>
<Pur gePr ocessedFi l es>Di sabl ed</ Pur gePr ocessedFi l es>
</ Local St or age>
<MBMSCDRTr i gger s>
<Bucket s>4</ Bucket s>


</ MBMSCDRTr i gger s>
<MaxCDRSi nMsg>1</ MaxCDRSi nMsg>
<MaxCDRSi ze>65400</ MaxCDRSi ze>
<MaxCDRsWai t Ti me>
</ MaxCDRsWai t Ti me>
<Recover Fi l eSeqNum>No</ Recover Fi l eSeqNum>
<Sour cePor t Val i dat i on>Enabl ed</ Sour cePor t Val i dat i on>
<St ar t Fi l eSeqNum>1</ St ar t Fi l eSeqNum>
<St or ageSer ver >
<St or ageSer ver Addr ess>
6. 6. 6. 6
</ St or ageSer ver Addr ess>
<St or ageSer ver MaxRet r i es>2</ St or ageSer ver MaxRet r i es>
<St or ageSer ver Por t >44</ St or ageSer ver Por t >

OL-30201-01 105
<St or ageSer ver Ti meout >
</ St or ageSer ver Ti meout >
</ St or ageSer ver >
</ ns2: vsDat a>
</ ns9: gt ppPr of i l e>
</ ns2: vsDat a>

.
.
.
.
<! Oper at or Pol i cy I nvent or y - - >

=l ocal ) ] [ Mobi l e] [ Pol i cyCont ai ner ] [ Oper at or Pol i cyCont ai ner ] [ Oper at or Pol i cy(
Oper at or Pol i cyName=t 4demo) ] }" >
<ns2: VsDat aCont ai ner i d=" t 4demo- VsDat a1" >
com. ci sco. pr i me. esb. t gpp. model . common. Pol i cyPr of i l e</ ns2: vsDat aType>
i nst ance" >Ci scoSpeci f i cAt t r i but es. pol i cy. 1. 0</ ns2: vsDat aFor mat Ver si on>
<ns12: Pol i cyPr of i l e
=l ocal ) ] [ Mobi l e] [ Pol i cyCont ai ner ] [ Oper at or Pol i cyCont ai ner ] [ Oper at or Pol i cy(
Oper at or Pol i cyName=t 4demo) ] }" >
<ns12: user Label >t 4demo</ ns12: user Label >
<ns2: VsDat aCont ai ner i d=" t 4demo- VsDat a1" >
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Pol i cyPr of i l e</ ns2: vsDat aType>
xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" >Ci scoSpeci f i cAt t r i but es. pol i cy
. 1. 0</ ns2: vsDat aFor mat Ver si on>
<ns2: vsDat a xsi : t ype=" ns23: Oper at or Pol i cyType"
xml ns: ns23=" Oper at or Pol i cyType" >
<ApnRemapTabl eName>{[ ManagedEl ement ( Key=Si mul at edASR5K) ] [ Logi cal Root ] [ Cont
ext ( Cont ext Name=l ocal ) ] [ Mobi l e] [ Pr of i l esCont ai ner ] [ APNRemapCont ai ner ] [ APNR
emap( ApnRemapName=t 4demo) ] }</ ApnRemapTabl eName>
<Cal l Cont r ol Pr of i l eName>t 4demo</ Cal l Cont r ol Pr of i l eName>
<Def aul t APNPr of i l eName>{[ ManagedEl ement ( Key=Si mul at edASR5K) ] [ Logi cal Root ] [
Cont ext ( Cont ext Name=l ocal ) ] [ Mobi l e] [ Pr of i l esCont ai ner ] [ APNPr of i l eCont ai ner
] [ APNPr of i l e( ApnPr of i l eName=t 4demo) ] }</ Def aul t APNPr of i l eName>
<Oper at or Pol i cyAPNEnt r i es>

106 OL-30201-01
<Net wor kI dent i f i er >t 4demo</ Net wor kI dent i f i er >
<Net wor kI dent i f i er APNPr of i l eName>{[ ManagedEl ement ( Key=Si mul at edASR5K) ] [ Log
i cal Root ] [ Cont ext ( Cont ext Name=l ocal ) ] [ Mobi l e] [ Pr of i l esCont ai ner ] [ APNPr of i l
eCont ai ner ] [ APNPr of i l e( ApnPr of i l eName=t 4demo) ] }</ Net wor kI dent i f i er APNPr of i
l eName>
<Oper at or I dent i f i er > </ Oper at or I dent i f i er >
</ Oper at or Pol i cyAPNEnt r i es>
<Oper at or Pol i cyDescr i pt i on>" demo" </ Oper at or Pol i cyDescr i pt i on>
<Oper at or Pol i cyI MEI RangesEnt r i es>
<Pr of i l eName>t 4demo</ Pr of i l eName>
<St ar t Range>120</ St ar t Range>
<ToRange>125</ ToRange>
</ Oper at or Pol i cyI MEI RangesEnt r i es>
<Oper at or Pol i cyName>t 4demo</ Oper at or Pol i cyName>
</ ns2: vsDat a>
</ ns12: Pol i cyPr of i l e>
</ ns2: vsDat a>

.
.
.
.



OL-30201-01 107
11.3 3GPP Detailed Inventory Information

This section includes:
Physical Inventory attributes
Logical Inventory attributes

11.3.1 Physical Inventory attributes
This section lists the physical inventory attributes for:
Managed Element
Chassis
Card
Slot
Port
Sub-Port
Power
Fan

Table 9-1: Physical Inventory Attributes for Managed Element
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
inventoryUnitType M M -
vendorName M M -
vendorUnitFamilyType CM M -
vendorUnitTypeNumber CM M -
serialNumber CM M -
versionNumber O M -
dateOfManufacture O M -
dateOfLastService O M -
unitPosition O M -
manufacturerData O M -
relatedFunction O M -


108 OL-30201-01
Table 9-2: Physical Inventory Attribute for Chassis
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -

Table 9-3: Physical Inventory Attribute for Card
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -


OL-30201-01 109
Table 9-4: Physical Inventory Attribute for Slot
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -

Table 9-5: Physical Inventory Attribute for Port
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -


110 OL-30201-01
Table 9-6: Physical Inventory Attribute for Sub-port
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -

Table 9-7: Physical Inventory Attribute for Power
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -


OL-30201-01 111
Table 9-8: Physical Inventory Attribute for Fan
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -

11.3.2 Logical Inventory attributes
This section lists the logical inventory attributes for:
PGW
o Logical Inventory Attribute for PGW
o Vendor Extensions for PGW
SGW
o Logical Inventory Attribute for SGW
o Vendor Extensions for SGW
APN
o Logical Inventory Attribute for APN
o Vendor Extension for APN
SAEGW
o Logical Inventory Attribute for SAEGW
o Vendor Extensions for SAEGW
GGSN
o Logical Inventory Attribute for GGSN
o Vendor Extension for GGSN
ACS
o Logical Inventory Attribute for ACS
o Vendor Extension for ACS
AAA
o Logical Inventory Attribute for AAA
o Vendor Extension for AAAGroup
GTPP

112 OL-30201-01
o Logical Inventory Attribute for GTPP
o Vendor Extension for GTPP
Operator Policy
o Logical Inventory Attribute for Operator Policy
o Vendor Extension for Operator Policy

11.3.2.1 Logical Inventory Attribute for PGW

Table 9-9: Logical Attribute for PGW

11.3.2.1.1 Vendor Extensions for PGW
PgwStatus
NewcallPolicy
EgtpService
LmaService
GgsnService
QciQosMappingTable
SessionDeleteDelayTimeout
SaeGwService
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
PGWFunction
Id
userLabel
linkList

OL-30201-01 113
PgwStatus

11.3.2.2 Logical Inventory Attribute for SGW

Table 9-10: Logical Attribute for SGW
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
ServingGWFunction
userLabel
PLMNIdList
TACList
11.3.2.2.1 Vendor Extensions for SGW
AccountingContext
AccountingGtppGroup
AccountingMode
EgressProtocol
EgressContext
EgressMagService
ImsAuthorizationService
AccountingPolicy
ServiceStatus
SaeGwService
NewcallPolicy

114 OL-30201-01
11.3.2.3 Logical Inventory Attribute for APN

Table 9-11: Logical Attribute for APN
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write
Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
APN
Id
userLabel

11.3.2.3.1 Vendor Extension for APN
AccountingMode
SelectionMode
L3toL2AddressPolicy
AllocationType
DnsConfiguration
Id
PrimaryDnsAddress
Secondarty DnsAddress
IpHeaderCompression
PDP
Id
PdpType
PrimaryContexts
TotoalContexts
RadiusServerConfiguration
Id

OL-30201-01 115
RadiusGroup
RadiusSecondaryGroup
ReturnedFramedIpAddressPolicy
ReturnedUserNamePolicy
MediationDevice
o Id
o DelayGTPResponse
o NoEarlyPDU
o NoInterims
o Accounting
NetBIOS
o Id
o PrimaryNBNSAddress
o SecondaryNBNSAddress
ApnTunnel
o Id
o AddressPolicy
o PeerLoadBalancing
Timeout
o Id
o AbsoluteTimeout
o LongDurationTimeout
o BearerInactivityTimeout
o BearerInactivityVolumeThresholdTotal
o EmergencyInactivityTimeout
o IdleTimeout
o IdleTimeoutActivityIgnoreDownlink
o Ipv6InitRouterSolicitWaitTimeout
o LongDurationAction
o LongDurationInactivityTimeout
o MbmsBearerAbsoluteTimeout
o MbmsBearerIdleTimeout
o MbmsUeAbsoluteTimeout
Dhcp
o Id
o DhcpLeaseExpirationPolicy
o DhcpServiceName
PPPProfile
o Id
o AuthenticationMode
o DataCompressionMode
o DataCompressionProtocols
o Protocols
o KeepAlivePeriod
o MinCompressionSize
o Mtu

116 OL-30201-01
ApnlpParameters
o id
o Access Group
o Local Address
o NextHopGatewayAddress
o OutAccessGroup
o DiscardEnabled
ApnChargingCharacteristics
o Id
o AllBitBehavior
o HomeBitBehavior
o RoamingBitBehavior
o VisitingBitBehavior
o RadiusReturned
o AllProfile
o HomeProfile
o RoamingProfile
o VisitingProfile
o UseGgsn
GSMQoS
o Id
o ResidualBERCode
o SDUErrorRatioCode
NewcallPolicy
o MobileIP
Id
MnAAARemovalIndication
MnHaHashAlgorithm
MnHaSharedKey
MnHaSPI
AlternateHA
HA
APNIPv6
o Id
o AddressPrefixPoolName
o DNSPrimaryAddress
o DNSSecondaryAddress
o EgressAddressFiltering
o InboundAccessGroupName
o OutboundAccessGroupName
o InitialRouterAdvertisementInterval
o InitialRouterAdvertisementNumber

VirtualAPNs
o id
o RuleDefinition
o RuleType

OL-30201-01 117
o QciToDscp
o QciArpToDscp
Gtpp
o Id
o AccountingContext
o AccountingContextName
o Group
o GroupType
o GroupXid
APNQoSDownlinkTrafficPolicingEntries
o ID
o BurstSizeAutoReadjust
o BurstSizeAutoReadjustDuration
o CommittedDataRate
o ExceedAction
o GuaranteedBurstSize
o NegotiateLimit
o PeakBurstSize
o PeakDataRate
o QciName
o RateLimit
o ViolateAction
APNQoSUplinkTrafficPolicingEntries
o ID
o BurstSizeAutoReadjust
o BurstSizeAutoReadjustDuration
o CommittedDataRate
o ExceedAction
o GuaranteedBurstSize
o NegotiateLimit
o PeakBurstSize
o PeakDataRate
o QciName
o RateLimit
o ViolateAction
o ActiveChargingBandwidthPolicy
o ActiveChargingRulebase
o ContentFilteringCategoryPolicyId
o CreditControlGroup


118 OL-30201-01
11.3.2.4 Logical Inventory Attribute for SAEGW

Table 9-12: Logical Attribute for SAEGW
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
SAEGWFunction
Id
userLabel
11.3.2.4.1 Vendor Extensions for SAEGW
SgwService
PgwService

11.3.2.5 Logical Inventory Attribute for GGSN

Table 9-13: Logical Attribute for GGSN
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read
Qualifier
3GPP
Prescribed
Write
Qualifier
Id M M -
vendorName M M -

OL-30201-01 119
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
APN
ggsnFunctionId
userLabel
proceduralStatus
11.3.2.5.1 Vendor Extension for GGSN
PLMNPolicy
NewcallPolicy
AuthenticationServerTimeout
AccountingServerTimeout
Gtpu
AccountingContext
LocalIpAddress
PGW
Plmns
o Id
o Primary
TimersAndQoS
o Id
o RetransmissionTimeout
o MaxRetransmissions
o EchoInterval
o GuardInterval
o SetupTimeout
o QciToDscp
o QciArpToDscp
IQCIEntry
o Id
o QCI
o DSCP
IQCIARPEntry
o Id
o Arp
o Dscp
o QCI
ChargingCharacteristics

120 OL-30201-01
o Id
o CcBehaviorNoRecords
o Intervals
o Profiles
o Tariffs
IGGSNChargingCharacteristicsIntervalTableEntry
o Id
o ProfileId
o Interval
o DownLink
o UpLink
o Total
o Sgsns
IGGSNChargingCharacteristicsProfilesTableEntry
o Id
o Profile
o Buckets
o Prepaid
o DownLink
o UpLink
o Total
IGGSNChargingCharacteristicsTariffTableEntry
o Id
o ProfileId
o Time1
o Time2
o Time3
o Time4
o Time5
o Time6
Sgsns
o Id
o IPAddress
o SubnetMask
o PLMNId
o RejectForeignSubscriber
PLMNForeign
o RATType
o Description


OL-30201-01 121
11.3.2.6 Logical Inventory Attribute for ACS

Table 9-14: Logical Attribute for ACS

11.3.2.6.1 Vendor Extension for ACS
The vendor extension information is given here

ActiveChargingFairUsage
o CpuThresholdPercent
o DeactivateMarginPercent
o ThresholdPercent
ActiveChargingServiceRedirectUserAgentEntries
o userAgent
AlgMediaIdleTimeout
BandwidthPolicyContainer
o BandwidthPolicy
BandwidthPolicyFlowLimitEntries
o BandwidthID
o GroupID
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write
Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
AcsProfile
Id
userLabel

122 OL-30201-01
BandwidthPolicyRatesAndActionsEntries
o CommittedBurstRate
o CommittedDataRate
o Direction
o ExceedAction
o GroupID
o PeakBurstSize
o PeakDataRate
o ViolationAction
TotalBandwidthIDConfigured
TotalGroupLimitConfigured
BandwidthPolicyName

o TotalBandwidthPolicyConfigured
CdrFlowControl
CdrFlowControlUnsentQueueSize
CdrFlowUnsentQueueHigh
CdrFlowUnsentQueueLow
ChargingActionContainer
o ChargingAction
ChargeVolume
ChargingActionAllocationRetentionPriority
o PriorityCapabilityIndicator
o PriorityLevel
o PriorityVulnerabilityIndicator
ChargingActionBandwidth
o BandWidthID
o ChargingActionBandwidthDirectionEntries
o CommittedBurstRate
o CommittedDataRate
o Direction
o ExceedAction
o PeakBurstSize
o PeakDataRate
o ViolationAction
o Downlink
o Uplink
ChargingActionBillingAction
o Edr
o Egcdr
o RadiusAccountingRecord

OL-30201-01 123
o RfAccounting
o Udr
ChargingActionFlowAction
o ClearQuotaRetryTimer
o ConditionalRedirect
o Discard
o OcsRedirectURL
o RandomDrop
o Readdress
o RedirectURL
o TerminateFlow
o TerminateSession
ChargingActionPacketFilterEntries
o PacketFilterName
ChargingActionName
ChargingActionQoS
o ClassIdentifier
o RenegotiateTrafficClass
ChargingActionVideo
o BitRate
o ReaddressingCAE
o TargetRateReduction
o Transrating
ChargingEDRName
ChargingEGCDRs
ChargingRf
ChargingUDRs
ContentFiltering
ContentId
CreditControl
CreditRatingGroup
FlowIdleTimeout
FlowMappingIdleTimeout
IpTypeOfService
LimitForFlowTypeAction
LimitForFlowTypeState
LimitForFlowTypeValue
NextHopForwardingAddress
RedirectURL
RetransmissionCount
ServiceId
VlanId


124 OL-30201-01
ContentFiltering
ContentFilteringCategoriesContainer
o ContentFilteringCategory
CategoryPolicy
o ContentCategory
o ContentFailureAction
o ContentInsert
o ContentPriority
o ContentRedirect
o ContentReplyCode
o EdrFileFormat
ContentFilteringPolicyId
EdrFile
FailureAction
ContentFilteringMatchMethod
CreditControlContainer
o CreditControlGroups
ApnType
CreditControlDiameter
o Dictionary
o EndPointRealm
o EndpointName
o PendingTimeout
o SessionFailover
DiameterPeerSelect
o ImsiEndValue
o ImsiRangeMode
o ImsiStartValue
o Peer
o Realm
o SecondaryPeer
o SecondaryRealm
FailureHandling
o InitialRequest
o TerminateRequest
o UpdateRequest
Group
Mode
MsccFinalUnitAction
PendingTrafficTreatment
o ForcedReauth
o NoQuota
o QuotaExhausted

OL-30201-01 125
o Trigger
o ValidityExpired
Quota
o HoldingTime
o RequestTrigger
o TimeThreshold
o UnitsThreshold
o ValidityTime
o VolumeThreshold
ServerUnreachableFailureHandling
o InitialRequest
o UpdateRequest
TriggerType
DeepPacketInspection
DymamicContentFiltering
GroupofRuledefContainer
o GroupOfRuledef
ApplicationType
DynamicCommandContentFilteringPolicyId
GroupOfRuledefPriorityEntries
o Priority
o RuledefName
o RuledefValue
Name
IcmpFlowIdleTimeout
InterpretationOfChargingRulebaseName
PassiveMode
RulebaseContainer
o Rulebase
ChargeMidSessionPackets
ChargeSeparateFromApplication
ChargingRuleOptimization
DefaultBandwidthPolicyName
DelayedCharging
FairUsageWaiverPercentage
FlowErrorChargingAction
IgnorePortInapplicationHeader
LimitForTCPFlows
LimitForTotalFlows
LimitforNonTCPFlows
P2pDynamicRouting
PrefixedUrlForPreprocessingGroupName
QosRenogotiationTimeout

126 OL-30201-01
RtpDynamicRouting
RuleBaseRoutingActionPrioritiesEntries
o Analyzer
o Description
o Priority
o RoutingRuledef
RulebaseBillingAndChargingRecords
o BillingFormatEGCDRs
o BillingFormatRadius
o BillingFormatRf
o BillingFormatUDRs
o EdrSupressZeroByteRecords
o EdrTransactionCompleteProtocol
o FailureHandlingUDRs
o FailureHandlingUdrFormatName
o TransactionCompleteChargingEDRFormat
o TransactionCompleteReportingERFormat
o UDRFormatname
RulebaseCCAFields
o DiameterRequestedServiceSpecificUnits
o DiameterRequestedServiceUnitTime
o DiameterRequestedServiceVolumeInputOctets
o DiameterRequestedServiceVolumeOutputOctets
o DiameterRequestedServiceVolumeTotalOctets
o QuotaRetryTime
o RadiusChargingContext
o RadiusChargingGroup
o RadiusInterimInterval
o RulebaseCCAQuotaHoldingTimeEntries
o ContentId
o QuotaHoldingTime
o RulebaseCCATimeDurationAlgorithmEntries
o AlgorithmName
o ContentId
o Time
RulebaseChargingActionPrioritiesEntries
o ChargingActionName
o Description
o Priority
o Ruledef
o TimeDef
o Type
RulebaseContentFiltering
o ContentFilteringFlowAnyError

OL-30201-01 127
o ContentFilteringGroup
o ContentFilteringMode
o ContentFilteringPolicy
RulebaseEGCDRFields
o DownlinkOctets
o InactivityTime
o ParkingMeterTimeout
o RulebaseEGCDRTariffTimeThresholdEntries
o TariffName
o TarriffTimeValue
o ThresholdInterval
o TimeBasedMetering
o TimeBasedMeteringAlgorithm
o TimePeriod
o TotalOctets
o UplinkOctets
RulebaseFlowEndConditions
o ChargingEDR
o ContentFilteringEDR
o FlowOverflowEDR
o HagrEDR
o HandOffEDR
o NormalEndSignallingEDR
o ReportingEDR
o SessionEndEDR
o TimeoutEDR
o UrlBlacklistingEDR
RulebaseName
RulebasePostProcessingActionPrioritiesEntries
o ChargingAction
o Description
o Priority
o RuledefName
o RuledefValue
o Type
RulebaseTCPProxyMode
o ContentFiltering
o DccaEnabled
o IpReaddressing
o NextHopReaddressing
o ProxyMode
o XheaderInsertion
RulebaseTetheringDetection

128 OL-30201-01
o OsBasedDetection
o TetheringDetection
o UaBasedDetection
RulebaseUDRFields
o DownlinkOctets
o ThresholdInterval
o TotalOctets
o UdrTrigger
o UplinkOctets
UrlBlackListingAction
UrlBlacklistingContentId
XHeaderCertificateName
XHeaderReEncryptionPeriod
RuledefContainer
o Ruledef
ApplicationType
CopyPacketToLog
MultiLineOR
RuleName
RuledefProtocolConfigurationEntries
o Fields
o Operator
o Value
TetheredFlowCheck
SelectedChargingRulebaseForAVP
TcpFlowIdleTimeout
TcpFlowMappingIdleTimeout
UdpFlowIdleTimeout
UdpFlowMappingTimeout
UrlBlackListing
UrlBlacklistingMatchMethod

11.3.2.7 Logical Inventory Attribute for AAA
The Logical inventory Attributes for AAAGroup and AAADiameterEndpoint are given
below

A. AAAGroup

Table 11-25: Attribute for AAAGroup
The Logical inventory Attributes for AAAGroup is given below


OL-30201-01 129
Table 9-15: Attribute for AAA Group

11.3.2.7.1 Vendor Extension for AAAGroup
A. The vendor extension information of AAAGroup is given here

AAADiameterConfiguration
o AAADiameterAccountingGeneralConfiguration
Dictionary
EndPointName
MaxRetries
MaxTransmissions
RequestTimeout
o AAADiameterAccountingServersEntries
DiameterServerHostName
NumberOfInstanceInDownState
NumberOfInstanceInUpState
Priority
o AAADiameterAuthenticationGeneralConfiguration
Dictionary
EndPointName
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write
Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
AAAGroup
Id
userLabel

130 OL-30201-01
MaxRetries
MaxTransmissions
RequestTimeout
RedirectHostAVP
o AAADiameterAuthenticationServersEntries
DiameterServerHostName
NumberOfInstanceInDownState
NumberOfInstanceInUpState
Priority
o GroupName
AAARadiusConfiguration
o AAARadiusAccountingGeneralConfiguration
AccountingGTPtriggerPolicy
AccountingRequestMaxRetries
AccountingRequestMaxTransmissions
AccountingResponseTimeout
ApnToBeIncluded
Archive
FireAndForget
InterimAccountingDownlinkVolume
InterimAccountingInterval
InterimAccountingTotalVolume
InterimAccountingUplinkVolume
MaxOutstandingAAAMessages
MaxPDUSize
RemoteAddress
ServerBillingVersion
ServerDeadTime
ServerSelectionAlgorithm
o AAARadiusAccountingKeepAliveAndDeadServerConfiguration
CallingStationID
DetectDeadServerConsecutiveFailures
DetectDeadServerKeepAlive
DetectDeadServerResponseTimeout
KeepAliveConsecutiveResponse
KeepAliveInterval
KeepAliveMaxRetries
KeepAliveTimeout
UserName
FramedIPAddress
o AAARadiusAccountingServersEntries
AdministrativeStatus
KeepAliveRepresentativeGroup

OL-30201-01 131
OperationalState
Preference
RequestTimeout
RetainAdministrativeStatusAfterReboot
RetransmitCount
RetransmitEnabled
Role
ServerIP
ServerPort
o AAARadiusAuthenticationGeneralConfiguration
ApnToBeIncluded
AuthenticateNullUserName
AuthenticationRequestMaxRetries
AuthenticationRequestMaxTransmissions
AuthenticationResponsetimeout
MaxOutstandingAAAMessages
ModifyNASIP
ProbeInterval
ProbeMaxRetries
ProbeTimeout
ServerDeadTime
ServerSelectionAlgorithm
o AAARadiusAuthenticationKeepAliveAndDeadServerConfiguration
CallingStationID
DetectDeadServerConsecutiveFailures
DetectDeadServerKeepAlive
DetectDeadServerResponseTimeout
KeepAliveConsecutiveResponse
KeepAliveInterval
KeepAliveMaxRetries
KeepAliveTimeout
UserName
AllowAccessReject
AuthenticationPassword
o AAARadiusAuthenticationServersEntries
OperationalState
Preference
RequestTimeout
RetransmitCount
RetransmitEnabled

132 OL-30201-01
Role
ServerIP
ServerPort
o AAARadiusChargingAccountingServersEntries
OperationalState
Preference
RequestTimeout
RetransmitCount
RetransmitEnabled
Role
ServerIP
ServerPort
o AAARadiusChargingGeneralConfiguration
AccountingServerSelectionAlgorithm
AuthenticationRequestMaxTransmissions
AuthenticationServerSelectionAlgorithm
ChargingDetectDeadServerConsecutiveFailures
ChargingDetectDeadServerResponseTimeout
MaximumOutstandingAAAMessages
ServerDeadTime
ServerMaxRetries
ServerResponseTimeout
o AAARadiusChargingServersEntries
OperationalState
Preference
RequestTimeout
RetransmitCount
RetransmitEnabled
Role
ServerIP
ServerPort
o AAARadiusChargingTriggersConfiguration
MsTimezoneChangeTrigger
QualityOfServiceChangeTrigger
RadioAccessTechnologyChangeTrigger
RoutingAreaInformationChangeTrigger
ServingNodeChangeTrigger
UserLocationInformationChangeTrigger

OL-30201-01 133
o AllowAccountingDown
o AllowAuthenticationDown
o AuthenticatorValidation
o DeadCriteriaRetransmitCount
o DeadCriteriaTime
o DeadTime
o Dictionary
o GroupName
o IgnorePreferredServer
o LoadBalancingMethod
o RequestTimeout
o RetransmitCount
o RetransmitEnabled
o StripDomain
o VRF

B. AAADiameterEndpoint

The Logical inventory Attributes for AAADiameterEndpoint is given below

Table 9-16: Attribute for AAADiameterEndpoint

Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write
Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
AAADiameterEndpoint
Id
userLabel

134 OL-30201-01

B. The vendor extension information of AAADiameterEndpoint is given here

AAADiameterPeersEntries
o LocalHostName
o LocalIPAddress
o LocalPort
o LocalRealm
o PeerHostName
o PeerIPAddress
o PeerPort
o PeerRealm
o SecondaryLocalIPAddress
o SecondaryLocalPort
o State
o TaskName
AAADiameterRouteEntries
o Application
o Origin
o PeerHostName
o PeerName
o PeerRealm
o RouteExpiryTimeOut
o RouteType
o RouteWeight
AAADiameterRouteHealthStatusEntries
o AvailableCount
o FailedCount
o OriginCount
o PeerHostName
o PeerName
AAARealmTaskManagerEntries
o ApplicationName
o CardNumber
o CpuNumber
o TaskName
OriginRealmName


OL-30201-01 135
11.3.2.8 Logical Inventory Attribute for GTPP

The Logical inventory Attributes for GTPP is given below

Table 9-17: Attribute for GTPP

11.3.2.8.1 Vendor Extension for GTPP

AccountingServer
o ContextName
o Group
o Port
o PrimaryAccountingServerAddress
o Priority
o State
AccountingServerFailureDetection
o DeadServerSuppressCDRs
o DeadTime
o DetectDeadServerConsecutiveFailures
o DuplicateHoldTimeMinutes
Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write
Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
GTPPProfile
Id
userLabel

136 OL-30201-01
o EchoMaxRetries
o EchoTimeout
o RedirectionAllowed
CDRAttributesIndicator
o ApnPresent
o CamelInfo
o CellPLMNId
o ChargingCharacteristicSelectionModePresent
o DestinationNumber
o DiagnosticsPresent
o Duration
o DynamicFlagPresent
o ImeiPresent
o ListOfServiceDataPresent
o LocalRecSeqNumPresent
o Msisdn
o NodeIDPresent
o NodeIDSuffix
o PdnConnectionIDPresent
o PdpAddressPresent
o PdpTypePresent
o PgwPLMNIDPresent
o PlmnIDPresent
o PlmnIDUnknownUse
o Rat
o RatPresent
o RecordingEntity
o ServedMNAIPresent
o ServedPDPPDNAddressExtensionPresent
o ServiceCentre
o StartTimePresent
o StopTimePresent
o UserLocationInformationPresent
CDRTriggers
o CellUpdate
o DirectTunnel
o EgcdrMaxLosdvLimit
o InterPLMNSGSNChange
o IntraSGSNGroupChange
o MsTimezoneChange
o OnRATChangeGenerate
o PlmnIDChange
o PresvModeStateChange

OL-30201-01 137
o QosChange
o RatChange
o RoutingAreaUpdate
o ServingNodeChangeLimit
o TariffTimeChange
o TimeLimit
o VolumeLimit
CdrMaxRetries
CdrStorageMode
CdrTimeout
ChargingAgent
o ChargingAgentAddress
o ChargingAgentPort
DataReqStartSeqNum
Dictionary
EGCDRDataGenerationConfiguration
o ClosingCauseUnique
o DeleteServiceThresholds
o IncludeAllLosdvs
o LosdvMaxContainers
o LotdvMaxContainers
o ServiceDownlink
o ServiceIdleTimeout
o ServiceInterval
o ServiceTotal
o ServiceUplink
LocalStorage
FileCompression
FileFormat
FileRotationCDRCount
FileRotationTimeInterval
FileRotationVolumeLimit
ForceFileRotationByTimeInterval
PurgeProcessedFiles
MBMSCDRTriggers
o Buckets
o Interval
o Time1
o Time2
o Time3
o Time4
o Volume
MaxCDRSinMsg

138 OL-30201-01
MaxCDRSize
MaxCDRsWaitTime
RecoverFileSeqNum
SourcePortValidation
StartFileSeqNum
StorageServer
o StorageServerAddress
o StorageServerMaxRetries
o StorageServerPort
o StorageServerTimeout

11.3.2.9 Logical Inventory Attribute for Operator Policy

The Logical inventory Attributes for Operator Policy is given below

Table 9-18: Attribute for OperatorPolicy

Attribute name
3GPP
Prescribed
Support
Qualifier
3GPP
Prescribed
Read Qualifier
3GPP
Prescribed
Write
Qualifier
Id M M -
vendorName M M -
serialNumber CM M -
versionNumber O M -
unitPosition O M -
ManagedFunction
Id
PolicyProfile
Id
userLabel

OL-30201-01 139
11.3.2.9.1 Vendor Extension for Operator Policy
ApnRemapTableName
ApnRemapTableValidity
CallControlProfileName
CallControlValidity
DefaultAPNProfileName
DefaultAPNProfileValidity
OperatorPolicyAPNEntries
o NetworkIdentifier
o NetworkIdentifierAPNProfileName
o NetworkIdentifierAPNProfileValidity
o OperatorIdentifier
o OperatorIdentifierAPNProfileName
o OperatorIdentifierAPNProfileValidity
OperatorPolicyDescription
OperatorPolicyIMEIRangesEntries
o ImeiValidity
o ProfileName
o SoftwareVersion
o StartRange
o ToRange

11.4 3GPP Status File
A Status file will be generated to indicate the completion status of the web service calls
getAllInventory and getManagedElement. This file will be present under the
INSTALL_DIR/sil-data folder and on the respective FTP / SFTP servers under the
configured output directory.
The status file will be referred to get the status of the web service requests.

11.4.1 Status File Name
The status file name contains the request ID, the module and the status of the completion
of web service request.
<Request_ID>_<Module_Identifier>_<Status>.status

Where:
Request_ID: A running sequence number generated by the server to uniquely
identify a request. The request ID is returned to the web service user in the
response. The Web service user can use the request ID to query on the status of the
request.

140 OL-30201-01
Module_Identifier: Indicates the module on which the status file was generated in
response to an operation.
Status: Indicates if the call has completed successfully, failed or in-progress.
The status file will have the status strings as part of the name based on the following
conditions:
IN_PROGRESS Indicates that the file creation is started
SUCCESS - Indicates that the request is successfully executed
FAILURE Indicates if any failure was encountered while processing the request

A Sample status file will have the following name: 10008_IM_SUCCESS.status

11.4.2 Status File Contents
The status file will contain information about the management elements for which
inventory was collected, their name, the inventory file name and the location of storage.

Total Managed Element Count: 1
Success Count: 1
Skipped Count: 0
Failed Count: 0

ManagedElementName FamilyType Status InventoryFileName Location
Size(Bytes)
10.86.66.35 CISCO_ASR_5500 SUCCESS
IM_20120808_1005+0300_32767_10.86.66.35_10002.xml
localhost://tmp/IM_20120808_1005+0300_32767_10.86.66.35_10002.xml

Where
10.86.66.35 Indicates the managed element for which the inventory is collected.
CISCO_ASR_5500 Indicates the device family
SUCCESS Indicates the status of the request.
IM_20120808_1005+0300_32767_10.86.66.35_10002.xml Name of the inventory file.
10.10.56.55:/tmp Indicates the location where the inventory file is generated.
123456 Indicates IM file size in bytes.

11.5 3GPP FT-IRP Inventory Notifications
11.5.1 File Ready Notification

<soap: Envel ope xml ns: soap=" ht t p: / / schemas. xml soap. or g/ soap/ envel ope/ " >
<soap: Body>
<ns2: not i f y
xml ns: ns2=" ht t p: / / www. 3gpp. or g/ f t p/ Specs/ ar chi ve/ 32_ser i es/ 32. 307/ schema/
32307- 810/ not i f i cat i on/ Not i f i cat i onI RPNt f Dat a"

OL-30201-01 141
32317- 810/ Gener i cI RPDat a"
xml ns: ns4=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 305#not i f i c
at i on"
xml ns: ns5=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 345#f TI RPI O
Cs"
xml ns: ns6=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 345#f TI RPNo
t i f "
xml ns: ns7=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 526#sonPol i
cyNr m"
xml ns: ns8=" ht t p: / / www. 3gpp. or g/ f t p/ Specs/ ar chi ve/ 32_ser i es/ 32. 347#FTI RPDa
t a"
xml ns: ns9=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 626#gener i c
Nr m" >
<not i f i cat i onHeader AndBody>
<ns4: Not i f i cat i on
xml ns: xsi =" ht t p: / / www. w3. or g/ 2001/ XMLSchema- i nst ance"
xsi : t ype=" ns6: Not i f yFi l eReady" >
<ns4: header >
<ns4: obj ect I nst ance>FTI RP=1</ ns4: obj ect I nst ance>
<ns4: event Ti me>2013- 04-
16T12: 55: 13. 171+05: 30</ ns4: event Ti me>
<ns4: syst emDN>FTI RP=1</ ns4: syst emDN>
<ns4: not i f i cat i onType>FI LE-
READY</ ns4: not i f i cat i onType>
</ ns4: header >
<ns6: body>
<ns6: Fi l eI nf oLi st >
<ns5: f i l eI nf o>
<ns5: management Dat aType>I M</ ns5: managemen
t Dat aType>
<ns5: f i l eLocat i on>10. 106. 2. 220: / t mp/ I M_20
130416_1255+0530_32767_ASR- 5000_10005. xml </ ns5: f i l eLocat i on>
<ns5: f i l eSi ze>1117964</ ns5: f i l eSi ze>
<ns5: f i l eReadyTi me>2013- 04-
16T12: 55: 00. 000+05: 30</ ns5: f i l eReadyTi me>
<ns5: f i l eExpi r at i onTi me>2013- 05-
03T13: 35: 42. 086+05: 30</ ns5: f i l eExpi r at i onTi me>
<ns5: f i l eCompr essi on/ >
<ns5: f i l eFor mat >XML-
schema</ ns5: f i l eFor mat >
</ ns5: f i l eI nf o>
</ ns6: Fi l eI nf oLi st >
<ns6: Addi t i onal Text >10005</ ns6: Addi t i onal Text >
</ ns6: body>
</ ns4: Not i f i cat i on>
</ not i f i cat i onHeader AndBody>
</ ns2: not i f y>
</ soap: Body>
</ soap: Envel ope>

11.5.2 File Preparation Error Notification
<soap: Envel ope xml ns: soap=" ht t p: / / schemas. xml soap. or g/ soap/ envel ope/ " >
<soap: Body>
<ns2: not i f y
32307- 810/ not i f i cat i on/ Not i f i cat i onI RPNt f Dat a"
32317- 810/ Gener i cI RPDat a"

142 OL-30201-01
xml ns: ns4=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 305#not i f i c
at i on"
xml ns: ns5=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 345#f TI RPI O
Cs"
xml ns: ns6=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 345#f TI RPNo
t i f "
xml ns: ns7=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 526#sonPol i
cyNr m"
xml ns: ns8=" ht t p: / / www. 3gpp. or g/ f t p/ Specs/ ar chi ve/ 32_ser i es/ 32. 347#FTI RPDa
t a"
xml ns: ns9=" ht t p: / / www. 3gpp. or g/ f t p/ specs/ ar chi ve/ 32_ser i es/ 32. 626#gener i c
Nr m" >
<not i f i cat i onHeader AndBody>
<ns4: Not i f i cat i on
xml ns: xsi =" ht t p: / / www. w3. or g/ 2001/ XMLSchema- i nst ance"
xsi : t ype=" ns6: Not i f yFi l ePr epar at i onEr r or " >
<ns4: header >
<ns4: obj ect I nst ance>FTI RP=1</ ns4: obj ect I nst ance>
<ns4: event Ti me>2013- 04-
16T16: 39: 04. 464+05: 30</ ns4: event Ti me>
<ns4: syst emDN>FTI RP=1</ ns4: syst emDN>
<ns4: not i f i cat i onType>FI LE-
PREPARATI ON_ERROR</ ns4: not i f i cat i onType>
</ ns4: header >
<ns6: body>
<ns6: Fi l eI nf oLi st / >
<ns6: Reason>er r or I nPr epar at i on</ ns6: Reason>
<ns6: Addi t i onal Text >10012: Encount er ed Er r or whi l e
pr epar i ng I nvent or y Fi l es f or Some managed Devi ces</ ns6: Addi t i onal Text >
</ ns6: body>
</ ns4: Not i f i cat i on>
</ not i f i cat i onHeader AndBody>
</ ns2: not i f y>
</ soap: Body>
</ soap: Envel ope>

11.6 FTP Configuration
File Transfer is required to transfer inventory files to a remote file server as specified by
end user. User can configure the file server details using the script (ftpConfig.sh) available
in the SIL installation directory ($SIL_HOME/bin).

Each FTP server has a primary and a secondary ftp server setup with fail-over option or
replication option. In fail-over option, files are transferred to the secondary ftp server if the
primary is not reachable or copied on to the configured directory on local machine if the
secondary is not reachable as well. However, in replication option, files are transferred to
both the primary and the secondary ftp servers. In cases, where both primary and
secondary servers are not available, the files will be stored in the local storage directory.

For information on managing FTP for Standalone integration layer, see the Next Steps
chapter in Cisco Prime Network 3.10 Installation Guide.


OL-30201-01 143
11.7 Useful Code Snippets for 3GPP
This section has sample code snippets to retrieve the inventory using 3GPP interface.
11.7.1 Code Snippet for 3GPP Request Response

This section provides code snippets that can be used by a SOAP client to communicate with
the 3GPP Web Service to perform the required operation.

/ / J ava SOAP cl i ent I mpor t s

i mpor t j avax. xml . soap. SOAPBody;
i mpor t j avax. xml . soap. SOAPConnect i on;
i mpor t j avax. xml . soap. SOAPConnect i onFact or y;
i mpor t j avax. xml . soap. SOAPEl ement ;
i mpor t j avax. xml . soap. SOAPEnvel ope;
i mpor t j avax. xml . soap. SOAPExcept i on;
i mpor t j avax. xml . soap. SOAPFact or y;
i mpor t j avax. xml . soap. SOAPHeader ;
i mpor t j avax. xml . soap. SOAPMessage;
i mpor t j avax. xml . soap. SOAPPar t ;
i mpor t j avax. xml . t r ansf or m. Sour ce;

/ / Const r uct i ng t he SOAP Header

SOAPHeader header = message. get SOAPHeader ( ) ;
i f ( header == nul l )
header = envel ope. addHeader ( ) ;

/ / Const r uct i ng t he cont ent s f or per f or mi ng Aut hor i zat i on

St r i ng AUTH_NS = " ht t p: / / docs. oasi s- open. or g/ wss/ 2004/ 01/ oasi s-
200401- wss- wssecur i t y- secext - 1. 0. xsd" ;
St r i ng AUTH_PREFI X = " wsse" ;
SOAPFact or y soapFact or y = SOAPFact or y. newI nst ance( ) ;
SOAPEl ement wsSecHeader El m= soapFact or y. cr eat eEl ement ( " Secur i t y" ,
AUTH_PREFI X, AUTH_NS) ;
SOAPEl ement user NameTokenEl m= soapFact or y. cr eat eEl ement (
" User nameToken" , AUTH_PREFI X, AUTH_NS) ;
Name qname = envel ope
. cr eat eName(
" I d" ,
" wsu" ,
" ht t p: / / docs. oasi s-
open. or g/ wss/ 2004/ 01/ oasi s- 200401- wss- wssecur i t y- ut i l i t y- 1. 0. xsd" ) ;
user NameTokenEl m. addAt t r i but e( qname, " User nameToken- 27" ) ;
SOAPEl ement user NameEl m= soapFact or y. cr eat eEl ement ( " User name" ,
user NameEl m. addText Node( user name) ;

SOAPEl ement passwdEl m= soapFact or y. cr eat eEl ement ( " Passwor d" ,
passwdEl m. addText Node( passwor d) ;
Name passwor dType = envel ope. cr eat eName( " Type" ) ;
passwdEl m
. addAt t r i but e(
passwor dType,

144 OL-30201-01
" ht t p: / / docs. oasi s-
open. or g/ wss/ 2004/ 01/ oasi s- 200401- wss- user name- t oken- pr of i l e-
1. 0#Passwor dText " ) ;
user NameTokenEl m. addChi l dEl ement ( user NameEl m) ;
user NameTokenEl m. addChi l dEl ement ( passwdEl m) ;

/ / add chi l d el ement s t o t he r oot el ement
wsSecHeader El m. addChi l dEl ement ( user NameTokenEl m) ;

/ / add SOAP el ement f or header t o SOAP header obj ect
header . addChi l dEl ement ( wsSecHeader El m) ;
/ / end: set t i ng SOAP header s

/ / st ar t : set t i ng SOAP body
/ / Cr eat e and popul at e t he body
SOAPBody body = envel ope. get Body( ) ;

/ / Cr eat e t he mai n el ement and namespace
/ / Cr eat es mai n el ement f or get Al l I nvent or y Oper at i on.

SOAPEl ement bodyEl ement = body
. addChi l dEl ement ( envel ope
. cr eat eName(
" get Al l I nvent or y" ,
" i nv" ,

" ht t p: / / www. 3gpp. or g/ f t p/ Specs/ ar chi ve/ 32_ser i es/ ci scoTgppI nvent or y/ sche
ma/ I nvent or yI RPDat a" ) ) ;
/ / Add cont ent

bodyEl ement . addChi l dEl ement ( " i nvokeI dent i f i er I n" ) . addText Node( " 123" ) ;
bodyEl ement . addChi l dEl ement ( " quer yXpat hExp" ) . addText Node(
" / MD=CI SCO_PRI ME" ) ;

/ / Save t he message
message. saveChanges( ) ;
Mi meHeader s header s = message. get Mi meHeader s( ) ;
header s. addHeader ( " SOAPAct i on" , " get Al l I nvent or y" ) ;

/ / Set t he dest i nat i on
/ / Send t he message and get t he r epl y

SOAPMessage r epl y = connect i on. cal l ( message, wsdl name) ;

11.7.2 Code Snippet for 3GPP Notification Consumer
Devel opi ng a not i f i cat i on consumer i nvol ves i mpl ement i ng t he 3GPP
Not i f i cat i on I RP Webser vi ce i nt er f ace and publ i shi ng i t .
Sampl e I mpl ement at i on of t he Not i f i cat i on I RP Webser vi ce i nt er f ace:

i mpor t j ava. i o. St r i ngWr i t er ;

i mpor t j avax. j ws. Oneway;
i mpor t j avax. j ws. WebMet hod;
i mpor t j avax. j ws. WebPar am;
i mpor t j avax. xml . bi nd. J AXBCont ext ;
i mpor t j avax. xml . bi nd. J AXBEl ement ;
i mpor t j avax. xml . bi nd. J AXBExcept i on;
i mpor t j avax. xml . bi nd. Mar shal l er ;
i mpor t j avax. xml . namespace. QName;

OL-30201-01 145
i mpor t j avax. xml . ws. Request Wr apper ;

i mpor t
or g. _3gpp. f t p. specs. ar chi ve. _32_ser i es. _32_307. schema. _32307_810. not i f i cat
i on. not i f i cat i oni r pnt f dat a. AnySequenceType;
i mpor t
or g. _3gpp. f t p. specs. ar chi ve. _32_ser i es. _32_307. schema. _32307_810. not i f i cat
i on. not i f i cat i oni r pnt f syst em. Not i f i cat i onI RPNt f ;

@j avax. j ws. WebSer vi ce( ser vi ceName = " Not i f i cat i onI RPNt f " , por t Name =
" Not i f i cat i onI RPNt f " , t ar get Namespace =
" ht t p: / / www. 3gpp. or g/ f t p/ Specs/ ar chi ve/ 32_ser i es/ 32. 307/ schema/ 32307-
810/ not i f i cat i on/ Not i f i cat i onI RPNt f Syst em" , name = " Not i f i cat i onI RPNt f " ,
endpoi nt I nt er f ace =
" or g. _3gpp. f t p. specs. ar chi ve. _32_ser i es. _32_307. schema. _32307_810. not i f i ca
t i on. not i f i cat i oni r pnt f syst em. Not i f i cat i onI RPNt f " )
publ i c cl ass TGPPNot i f i cat i onConsumer I mpl i mpl ement s Not i f i cat i onI RPNt f {

@Oneway
@Request Wr apper ( l ocal Name = " not i f y" , t ar get Namespace =
810/ not i f i cat i on/ Not i f i cat i onI RPNt f Dat a" , cl assName =
" or g. _3gpp. f t p. specs. ar chi ve. _32_ser i es. _32_307. schema. _32307_810. not i f i ca
t i on. not i f i cat i oni r pnt f dat a. Not i f y" )
@WebMet hod( act i on =
810/ not i f i cat i on/ not i f y" )
publ i c voi d not i f y( @WebPar am( name = " not i f i cat i onHeader AndBody" ,
t ar get Namespace = " " ) AnySequenceType anySequence) {
/ / Do somet hi ng wi t h t he not i f i cat i on
/ / Thi s i mpl ement at i on j ust mar shal l s t he not i f i cat i on and pr i nt s
i t .
par seJ AXBEl ement ( anySequence) ;
}

@Suppr essWar ni ngs( { " unchecked" , " r awt ypes" })
publ i c voi d par seJ AXBEl ement ( AnySequenceType anySequence) {

t r y {
J AXBCont ext j axbCont ext =
J AXBCont ext . newI nst ance( anySequence. get Cl ass( ) ,

or g. _3gpp. f t p. specs. ar chi ve. _32_ser i es. _32. Obj ect Fact or y. cl ass) ;

Mar shal l er j axbMar shal l er = j axbCont ext . cr eat eMar shal l er ( ) ;

/ / out put pr et t y pr i nt ed
j axbMar shal l er . set Pr oper t y( Mar shal l er . J AXB_FORMATTED_OUTPUT,
t r ue) ;

St r i ngWr i t er st r i ngWr i t er = new St r i ngWr i t er ( ) ;
j axbMar shal l er . mar shal ( new J AXBEl ement (
new QName( " ur i " , " l ocal " ) ,
anySequence. get Cl ass( ) , anySequence ) , st r i ngWr i t er ) ;
Syst em. out . pr i nt l n( " Not i f i cat i on Recei ved. . . . " ) ;
Syst em. out . pr i nt l n( st r i ngWr i t er . get Buf f er ( ) . t oSt r i ng( ) ) ;
} cat ch ( J AXBExcept i on e) {
e. pr i nt St ackTr ace( ) ;
}


146 OL-30201-01
}
}

Publ i shi ng t he Webser vi ce:

Once you have i mpl ement ed Not i f i cat i on I RP I nt er f ace, you can publ i sh t he
webser vi ce usi ng t he Endpoi nt . publ i sh met hod as bel ow:

Endpoi nt . publ i sh( " ht t p: / / 10. 105. 39. 39: 9229/ Not i f i cat i onConsumer " , new
TGPPNot i f i cat i onConsumer I mpl ( ) ) ;

References

OL-30201-01 147
12 References

Refer the following document alongwith this guide.

Addendum: Prime Network OSS Integration Sample SOAP Request Response on
Cisco Developer Network. To view the information on the CDN website, you must
have a Cisco.com account with partner level access, or you must be a Prime
Network licensee.

References

148 OL-30201-01

Prime Network OSS Integration Guide-2-0

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Prime Network OSS Integration Guide-2-0

Загружено:

Авторское право:

Доступные форматы

Americas Headquarters

Cisco Systems, Inc.

Вам также может понравиться