Cisco Prime OSS Integration Guide for MTOSI and 3GPP November, 2012 Rev 1.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-28496-01 1 Abstract The Cisco Prime OSS Integration Guide for MTOSI and 3GPP gives information on OSS Integration using 3GPP and MTOSI 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 NONINFRINGEMENT 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. Thirdparty 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 © 1999–2012 Cisco Systems, Inc. All rights reserved. Contents Table of Contents List Of Tables ......................................................................................................... iv 1 Preface.............................................................................................................. v 1.1 Conventions ................................................................................................... v 1.2 Additional User Documentation ................................................................... vi 1.3 Obtaining Documentation, Obtaining Support, and Security Guidelines..... vi 2 Overview...........................................................................................................7 2.1 3GPP OSS Integration.....................................................................................7 2.2 MTOSI OSS Integration ..................................................................................7 3 3GPP Integration Reference Point (IRP) ...........................................................8 3.1 3GPP Integration Layer ..................................................................................8 3.2 3GPP Inventory Management .......................................................................8 3.3 3GPP Interface Details ...................................................................................9 4 MTOSI Inventory Management ......................................................................14 4.1 MTOSI Interface Details ...............................................................................14 5 Supported Devices..........................................................................................21 6 Technologies...................................................................................................21 7 3GPP Inventory File ........................................................................................22 8 3GPP Standard Compliance ............................................................................24 9 MTOSI Standard Compliance .........................................................................24 10 Trouble Shooting ..........................................................................................25 11 Appendix.......................................................................................................27 11.1 3GPP Inventory WSDL File ...........................................................................27 11.2 3GPP inventoryNrm Schema File .................................................................33 11.3 3GPP Detailed Inventory Information .........................................................38 11.4 Useful Code Snippets for 3GPP ....................................................................51 11.5 3GPP Sample Inventory File .........................................................................53 11.6 3GPP Status File ...........................................................................................56 11.7 FTP Configuration.........................................................................................57 11.8 3GPP Web Service Sample Request Response ............................................57 11.9 MTOSI Web Service Sample Request and Response ...................................59 Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 iii Preface List Of Tables Table 3- 1: Functional Area Supported By 3GPP............................................................................. 8 Table 3- 2: 3GPP Interfaces Names ............................................................................................... 9 Table 3- 3: Input Parameters to Retreive Physical and Logical Inventory Information ............... 10 Table 3- 4: Input Parameters to Retreive List of Managed Elements.......................................... 11 Table 3- 5: Input Parameters to Retreive Specific Managed Element......................................... 12 Table 4- 6: Supported APIs for Managed Elements, Equipment Inventory................................. 15 Table 4- 7: APIs for Retreiveing EVC............................................................................................ 18 Table 5- 8: Supported Devices for 3GPP and MTOSI ................................................................... 21 Table 6- 9: Technologies to Facilitate the OSS Integratin ........................................................... 21 Table 10- 10: OSS Integration Problems and Troubleshooting Procedure .................................. 25 Table 11- 11: Physical Inventory Attributes for Managed Element ............................................. 38 Table 11- 12: Physical Inventory Attribute for Chassis ................................................................. 39 Table 11- 13: Physical Inventory Attribute for Card ..................................................................... 39 Table 11- 14: Physical Inventory Attribute for Slot ...................................................................... 40 Table 11- 15: Physical Inventory Attribute for Port ...................................................................... 40 Table 11- 16: Physical Inventory Attribute for Sub-Port............................................................... 41 Table 11- 17: Physical Inventory Attribute for Power .................................................................. 41 Table 11- 18: Physical Inventory Attribute for Fan ....................................................................... 42 Table 11- 19: Attribute for PGW ................................................................................................... 43 Table 11- 20: Attribute for SGW ................................................................................................... 44 Table 11- 21: Attribute for APN .................................................................................................... 45 Table 11- 22: Attribute for SAEGW ............................................................................................... 49 Table 11- 23: Logical Inventory Attribute for GGSN ..................................................................... 49 Cisco Prime OSS Integration Guide for MTOSI and 3GPP iv OL-28496-01 Preface 1 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.1.0.2 and Prime Network release 3.10. This preface contains the following sections: • • • Conventions Additional User Documentation Obtaining Documentation, Obtaining Support, and Security Guidelines 1.1 Conventions This document uses the following conventions: Convention bold font Indication Commands and keywords and user-entered text appear in bold font. italic font Document titles, new or emphasized terms, and arguments for which you supply values are in italic font. [ ] Elements in square brackets are optional. {x | y | z } Required alternative keywords are grouped in braces and separated by vertical bars. [x|y|z] Optional alternative keywords are grouped in brackets and separated by vertical bars. String A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. courier font For code snippets and XML < > Nonprinting characters such as passwords are in angle brackets. [ ] Default responses to system prompts are in square brackets. !, # An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line. Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication. Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 v Preface 1.2 Additional User Documentation We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates. Other related documents are: • ASR 5000 Product page • 3GPP Telecom Management 1.3 Obtaining Documentation, Obtaining Support, and Security Guidelines For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What’s 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 What’s 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. Cisco Prime OSS Integration Guide for MTOSI and 3GPP vi OL-28496-01 Overview 2 Overview This section introduces the 3GPP and MTOSI OSS Integration: • 3GPP OSS Integration • MTOSI OSS Integration 2.1 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 for retrieving inventory data for specific types of devices via. SOAP interface. As part of Mobility 1.0 and Prime Network 3.10, 3GPP interface will be provided to support ASR5000 and ASR5500 devices. 2.2 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 Prime Suite release. Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 7 3GPP Integration Reference Point (IRP) 3 3GPP Integration 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 Inventory IRP. The Inventory IRP is a complete Cisco extension. This section includes the details on: • 3GPP Integration Layer • Overview of 3GPP Inventory Management • 3GPP Interface Details 3.1 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. 3.2 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 Interface Details. Table 3- 1 gives a list of functional areas supported along with the management data type. Table 3- 1: Functional Area Supported By 3GPP Sl.No Functional Area 1 Inventory Management Management Data Type IM Cisco Prime OSS Integration Guide for MTOSI and 3GPP 8 Description 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 ) OL-28496-01 3GPP Integration Reference Point (IRP) 3.2.1 Physical Inventory Inventory Management includes information on following physical inventory data. • Managed element • Chassis • Card • Slot • Port • Sub-port • Power unit • Fan The attributes of the physical inventory units can be found in Appendix section. 3.2.2 Logical Inventory Inventory Management also captures information on following logical entities: • PGW • SGW • SAEGW • APN • GGSN Logical entities have both 3GPP prescribed data and Cisco specific vendor extensions. The attributes details are available in Appendix section. 3.3 3GPP Interface Details 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. Table 3- 2: 3GPP Interfaces Names Sl.No Interface Name 2 getAllManagedElementNames 3 getManagedElement 1 getAllInventory Description This API is used to retrieve Inventory data for all supported devices under the management domain This API is used to retrieve the managed element name and types for all managed elements present in the management domain. This API is used to retrieve the inventory data for a specific Managed Element. Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 9 3GPP Integration Reference Point (IRP) 3.3.1 Interface: 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. Table 3- 3 gives the list of parameters that should be used as input to retrieve physical and logical inventory information. Table 3- 3: Input Parameters to Retreive Physical and Logical Inventory Information Sl.No Parameter Data Type 2 queryXpathExp String 1 InvokeIdentifierIn String Description 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. An XPath query string containing the 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. NOTE: There will be one Inventory XML file per supported managed element. Cisco Prime OSS Integration Guide for MTOSI and 3GPP 10 OL-28496-01 3GPP Integration Reference Point (IRP) 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 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 machines 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. 3.3.2 Interface: 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. Table 3- 4 gives the list of parameters that should be used as input to retrieve physical and logical inventory information. Table 3- 4: Input Parameters to Retreive List of Managed Elements Sl.No 1 1 Parameter InvokeIdentifierIn Data Type String Description 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 In Prime Network 3.10, this interface will only return the name of devices that are managed by Prime Network. Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 11 3GPP Integration Reference Point (IRP) 2 queryXpathExp String for correlation purpose. The value passed to this is not validated and is returned to the user as is. An XPath query string containing the 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. 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. 3.3.3 Interface: 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. Table 3- 5 gives the list of parameters that should be used as input to retrieve physical and logical inventory information. Table 3- 5: Input Parameters to Retreive Specific Managed Element Sl.No 1 Parameter InvokeIdentifier Data Type String Cisco Prime OSS Integration Guide for MTOSI and 3GPP 12 Description 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 OL-28496-01 3GPP Integration Reference Point (IRP) 2 queryXpathExp String purpose. The value passed to this is not validated and is returned to the user as is. An XPath query string containing the 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. 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. 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. 2 The Managed Element name should be identical with that of Prime Network Administration GUI Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 13 MTOSI Inventory Management 4 MTOSI Inventory Management Cisco Prime Central and 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. 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. 4.1 MTOSI Interface Details 4.1.1 Managed Element Retrieval Interface Managed Element retrieval is supported by these APIs: • getAllManagedElementNames • getManagedElement WSDL document can be obtained by following URL https://<server>:<mtosiport>/ ManagedElementNamesRetrieval_RPC?wsdl https://<server>:<mtosiport>/ManagedElementRetrieval_RPC?wsdl Where: server - is 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. 4.1.2 Equipment Retrieval Interface Equipment entity retrieval is supported by these APIs: • getAllEquipment • getEquipment • getContainedEquipment WSDL document can be obtained by following URL https://<server>:<mtosiport>/ EquipmentInventoryRetrieval_RPC?wsdl Where: Cisco Prime OSS Integration Guide for MTOSI and 3GPP 14 OL-28496-01 MTOSI Inventory Management server – is 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. 4.1.3 Physical Termination Point Retrieval Interface Physical termination point retrieval is supported by following API: • getAllSupportedPhysicalTermiminationPoints WSDL document can be obtained from the following URL https://<server>:<mtosiport>/ TerminationPointRetrieval_RPC?wsdl Where : server – is the hostname or IP address of Prime Central or Prime Network Server mtosiport – is the port number where CXF service for mtosi is running. By default port number is 9110. Table 4- 6 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. Table 4- 6: Supported APIs for Managed Elements, Equipment Inventory API Response Request Description getAllManagedElementNam getAllManagedElement getAllManaged es( ... ) NamesResponse - a list ElementNames Managed Element Request Names Returns all Managed Element Names. This is a proprietory API to facilitate getManagedElement API for a specific managed element retrieval. getManagedElement(...) 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 getManagedElementRe sponse - a specific Management Element instance getManagedEle mentRequest a list of RDN consisting of MD/ME name value pairs Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 15 MTOSI Inventory Management 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 corresponding wsdl/xsd files for more details. • ManageResourceInvento ry/IIS/wsdl/EquipmentInv entoryRetrieval/Equipme ntInventoryRetrievalHttp. wsdl • ManageResourceInvento ry/IIS/xsd/EquipmentInve ntoryRetrievalMessages.x sd Equipment Attribute Extension as per requirement are defined in – • NetworkResourceFulfillm ent/IIS/xsd/Cisco_ME_EQ _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 corresponding wsdl/xsd files for 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 getAllSupportedPhysica getAllSupporte Returns a list PTPs. See the minationPoints( ... ) lTerminationPointsRes dPhysicalTermi corresponding wsdl/xsd files for ponse - a list of physical nationPointsRe more details. termination endpoints quest - a list of • ManageResourceInvento RDNs that (PTP) of the specified ry/IIS/wsdl/TerminationP equipment specify the ointRetrieval/Terminatio Cisco Prime OSS Integration Guide for MTOSI and 3GPP 16 OL-28496-01 MTOSI Inventory Management containing equipment: MD/ME/EH[/E H/EH]/EQ • nPointRetrievalMessages. wsdl ManageResourceInvento ry/IIS/xsd/TerminationPo intRetrievalMessages.xsd PTP Attribute Extensions per requirements are defined in – • NetworkResourceFulfillm ent/IIS/xsd/Cisco_ME_EQ _Inventory.xsd subscribe(...) unsubscribe(...) 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 elements: consumerEPR, topic, and selector. subscribeRequ est - This operation allows the Client to subscribe for notifications 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 subscribe operation used to receive subscriptions 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 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 Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 17 MTOSI Inventory Management 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. 4.1.4 Ethernet Virtual Connection (EVC) Resource Inventory APIs EVC resource retrieval is supported by these APIs: • getFlowDomainFragment • getFlowDomainFragmentRoute • getAllFlowDomainFragmentNames WSDL document can be obtained by following URL • https://<server>:<mtosiport>/FlowDomainFragmentRetrievalRPC?wsdl Where: server – is the hostname or IP address of Prime Central or Prime Network Server mtosiport – is the port number where CXF service for MTOSI is running. By default port number is 9110 More details of the interfaces and data type are described in these files below. • ManagedResourceInventory/FlowDomainFragmentRetrieval wsdl file • ManagedResourceInventory/FlowDomainFragmentRetrieval xsd file Table 4- 7 lists the APIs for the retrieval of Ethernet Virtual Connections (EVC). MTOSI Extension Points and Extensions are described below. Service topologies supported include point to point, multipoint to mulitpoint and point to multipoint (E-Tree). Table 4- 7: APIs for Retreiveing EVC API Function getFlowDomainFragme Retrieval of Flow Domain Extension Point and Extension Extension Points - Cisco Prime OSS Integration Guide for MTOSI and 3GPP 18 OL-28496-01 MTOSI Inventory Management nt(…) 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 getFlowDomainFragme Retrieval of Matrix Flow ntRoute(…) Domain Fragment. Upon success of this operation, EoMPLS Forwarding Entities including Ethernet PW edge instances/crossconnects and VFI when applicable will be returned. • FlowDomainFragmentType>LayeredParametersType->LayerRateType • FlowDomainFragmentType>LayeredParametersType>vendorExtensions • FlowDomainFragmentType>TerminationPointDataListType>TerminationPointDataType>LayeredParametersType>vendorExtensions Extensions are defined in • NetworkResourcesBasic/IIS/xsd/LayerRates .xsd • NetworkResourcesBasic/IIS/xsd/Cisco_CE_ LayeredParam.xsd Extension Points • FlowDomainFragmentRouteType -> MatrixFlowDomainFragmentType >LayeredParameterType>vendorExtensions • FlowDomainFragmentRouteType -> MatrixFlowDomainFragmentType>vendorExtensions Extensions are defined in NetworkResourcesBasic/IIS/xsd/Cisco_CE_Layered Param.xsd getAllFlowDomainFrag Retrieval of names This is a proprietory API introduced to facilitate the mentNames(…) of all the managed Flow client to performance subsequent retrieval of a Domain Fragments . Upon named Ethernet connection. success of this operation, all Ethernet connection names will be returned. 4.1.5 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 Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 19 MTOSI Inventory Management 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. 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 Cisco Prime OSS Integration Guide for MTOSI and 3GPP 20 OL-28496-01 Supported Devices 5 Supported Devices Table 5- 8 list of supported devices for 3GPP and MTOSI. Table 5- 8: Supported Devices for 3GPP and MTOSI 3GPP MTOSI 6 Supported DM Versions PN 3.10, PC 1.1.0.2 PN 3.10, PC 1.1.0.2 Supported Devices ASR5500, ASR5000 Device support is based on PN 3.10 Technologies The NMS / EMS (IRP Agent) uses SOAP / WSDL to implement the Web Services. This requires the OSS clients (IRP Managers) to use SOAP understandable clients to communicate and access the interfaces supported by the IRP Agents. Table 6- 9 list the technologies used to facilitate the OSS integration. Table 6- 9: Technologies to Facilitate the OSS Integratin Technology ESB OSGi JMS SOAP Web Service Explanation Enterprise Service Bus. The apache Service Mix, Fuse environment Open Software Gateway Interface, The Karaf environment. Java Messaging Service, Queues and topics for communicating across integration layer and prime networks. Simple Object Access Protocol, Used for communicating with the Web Service end point Technology that exposes a SOAP / WSDL for accessing the 3GPP interfaces. Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 21 3GPP Inventory File 7 3GPP Inventory File This section covers the naming convention for the 3GPP inventory. The inventory file name will have the following format as defined by the 3GPP Specification. <managementData_type><file_ready_date>< file_ready_time><file_expiration_delta_time>[<specificIRP_extension>][<separator><RC >] Where: • The managementData_type field is the type of the management data contained in the file, the value of managementData_type field including o PM - performance data files o CM - configuration files (except inventory) o IM - inventory files o TE - test files o CT - call trace files o NL - notification log files o CG - charging files o OT - other files • The file_ready_date field is of the form YYYYMMDD, where: o YYYY is the year in four-digit notation; o MM is the month in two digit notation (01 - 12); o DD is the day in two digit notation (01 - 31). The file_ready_date is the date when the file was last closed and made available for upload and the file content will not be changed. • The file_ready_time is the time when the file was last closed and made available for upload and the file content will not be changed. o The file_ready_time field is of the form HHMMshhmm, where: HH is the two digit hour of the day (local time), based on 24 hour clock (00 - 23); MM is the two digit minute of the hour (local time, 00 - 59); s is the sign of the local time differential from UTC (+ or -), in case the time differential to UTC is 0 then the sign may be arbitrarily set to "+" or "-"; hh is the two digit number of hours of the local time differential from UTC (00 -23); mm is the two digit number of minutes of the local time differential from UTC (00 - 59). • To reduce length of the file name, the file_expiration_delta_time field could be a delta time interval from file ready time. The unit is hour. • The specificIRP_extension field is used for other IRPs to extend the extra file naming convention which is not covered by the basic file naming convention defined in FileTransferIRP. Cisco Prime OSS Integration Guide for MTOSI and 3GPP 22 OL-28496-01 3GPP Inventory File • • The RC parameter is a running count, starting with the value of "1", and shall be appended only if the filename is not unique, i.e. more than one file is generated and all other parameters of the file name are identical. The separator field is "_-_", which is an underscore character (_), followed by a minus character (-), followed by an underscore character (_). Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 23 3GPP Standard Compliance 8 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. 9 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 3GPP and MTOSI standards in th following links: • http://www.3gpp.org/specifications • http://www.tmforum.org/MultiTechnologyOperations/2319/home.html Cisco Prime OSS Integration Guide for MTOSI and 3GPP 24 OL-28496-01 Trouble Shooting 10 Trouble Shooting Table 10- 10 includes the issues that might be encountered while setting up OSS integration layer and steps to troubleshoot the problem. Table 10- 10: 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 ). • 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 • Exception indicating No Managed Element in Network • • • • • 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 that the Prime Networks application is running. Network Connectivity to the Prime Networks machine is proper. 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 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. Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 25 Trouble Shooting getManagedEle ment returns a SOAP Exception A call to getManagedElement returns a Web Services exception stating that the device is not in upstate though it is actually up. The device name specified in request is incorrect Cisco Prime OSS Integration Guide for MTOSI and 3GPP 26 Note: The password will be encrypted in the configuration file. Cross check the device name in getManagedElements response and correct if device is not in up state OL-28496-01 Appendix 11 Appendix This section includes: • 3GPP Inventory WSDL File • 3GPP inventoryNrm Schema File • 3GPP Detailed Inventory Information • Useful Code Snippets for 3GPP • 3GPP Sample Inventory File • 3GPP Status File • FTP Configuration • 3GPP Web Service Sample Request Response • MTOSI Web Service Sample Request and Response 11.1 3GPP Inventory WSDL File <?xml version="1.0" encoding="UTF-8"?> <definitions xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:inventoryIRPSystem="http://www.3gpp.org/ftp/Specs/archive/32_series/ ciscoTgppInventory/schema/InventoryIRPSystem" xmlns:inventoryIRPData="http://www.3gpp.org/ftp/Specs/archive/32_series/ci scoTgppInventory/schema/InventoryIRPData" xmlns:genericIRPSystem="http://www.3gpp.org/ftp/Specs/archive/32_series/32 317/schema/32317-800/GenericIRPSystem" targetNamespace="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgpp Inventory/schema/InventoryIRPSystem"> <import namespace="http://www.3gpp.org/ftp/Specs/archive/32_series/32317/schema/32 317-800/GenericIRPSystem" location="../../../genericIRP/SolutionSet/wsdl/32317-800.wsdl"/> <types> <schema targetNamespace="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgpp Inventory/schema/InventoryIRPData" xmlns="http://www.w3.org/2001/XMLSchema"> <complexType name="AnyMENameType"> <sequence> <!--MO instance location in XPath expression--> <element name="meName" type="string"/> <element name="meType" type="string"/> <!--each MO--> <any/> </sequence> </complexType> <complexType name="AnyMOType"> <sequence> <!--MO instance location in XPath expression--> <element name="moiLocation" type="string"/> <!--each MO--> <any/> </sequence> </complexType> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 27 Appendix <complexType name="MENameSequenceType"> <sequence> <element name="meType" type="inventoryIRPData:AnyMENameType" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> <complexType name="MOSequenceType"> <sequence> <element name="mo" type="inventoryIRPData:AnyMOType" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> <!-- getAllManagedElementNames Request --> <!-- This operation is a Vendor extension by Cisco --> <element name="getAllManagedElementNames"> <complexType> <sequence> <element name="invokeIdentifierIn" type="string"/> <element name="queryXpathExp" type="string"/> </sequence> </complexType> </element> <!-- getAllManagedElementNames Response --> <complexType name="GetAllManagedElementNamesResponseType"> <sequence> <element name="invokeIdentifierOut" type="string"/> <element name="meNameListOut" type="inventoryIRPData:MENameSequenceType"/> </sequence> </complexType> <!-- getAllInventory Response --> <element name="getAllManagedElementNamesResponse"> <xs:complexType> <xs:sequence><xs:element name="getAllMENamesResponse" type="inventoryIRPData:GetAllManagedElementNamesResponseType"></xs:element ></xs:sequence> </xs:complexType> </element> <!-- getAllManagedElementNames Fault --> <element name="getAllManagedElementNamesFault"> <complexType> <choice> <element name="getAllManagedElementNamesFault" type="string"/> <element name="resourceLimitationFault" type="string"/> <element name="operationCancelledFault" type="string"/> <element name="complexityLimitationFault" type="string"/> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 28 OL-28496-01 Appendix <element ref="inventoryIRPData:InvalidParameterFault"/> </choice> </complexType> </element> <!-- getManagedElement Request --> <!-- This operation is a Vendor extension by Cisco --> <element name="getManagedElement"> <complexType> <sequence> <element name="invokeIdentifierIn" type="string"/> <element name="queryXpathExp" type="string"/> </sequence> </complexType> </element> <!-- getManagedElement Response --> <complexType name="GetManagedElementResponseType"> <sequence> <element name="invokeIdentifierOut" type="string"/> <element name="responseMessage" type="string"/> </sequence> </complexType> <!-- getAllInventory Response --> <element name="getManagedElementResponse"> <xs:complexType> <xs:sequence><xs:element name="getMEResp" type="inventoryIRPData:GetManagedElementResponseType"></xs:element></xs:se quence> </xs:complexType> </element> <!-- getManagedElement Fault --> <element name="getManagedElementFault"> <complexType> <choice> <element name="getManagedElementFault" type="string"/> <element name="resourceLimitationFault" type="string"/> <element name="operationCancelledFault" type="string"/> <element name="complexityLimitationFault" type="string"/> <element ref="inventoryIRPData:InvalidParameterFault"/> </choice> </complexType> </element> <complexType name="GetAllInventoryResponseTypeNew"> <sequence> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 29 Appendix <element maxOccurs="1" name="invokeIdentifierOut" type="string" /> <element maxOccurs="1" name="responseMessage" type="string" /> </sequence> </complexType> <!-- getAllInventory Request --> <!-- This operation is a Vendor extension by Cisco --> <element name="getAllInventory"> <complexType> <sequence> <element name="invokeIdentifierIn" type="string"/> <element name="queryXpathExp" type="string"/> </sequence> </complexType> </element> <!-- getAllInventory Response --> <element name="getAllInventoryResponse"> <xs:complexType> <xs:sequence><xs:element name="getAllRequestResponse" type="inventoryIRPData:GetAllInventoryResponseTypeNew"></xs:element></xs:s equence> </xs:complexType> </element> <!-- getAllInventory Fault --> <element name="getAllInventoryFault"> <complexType> <choice> <element name="getAllInventoryFault" type="string"/> <element name="resourceLimitationFault" type="string"/> <element name="operationCancelledFault" type="string"/> <element name="complexityLimitationFault" type="string"/> <element ref="inventoryIRPData:InvalidParameterFault"/> </choice> </complexType> </element> <element name="OperationNotSupportedFault" type="string"/> <element name="InvalidParameterFault" type="string"/> <simpleType name="VersionNumberType"> <restriction base="string"/> </simpleType> <complexType name="VersionNumberSetType"> <sequence> <element name="versionNumber" type="inventoryIRPData:VersionNumberType" maxOccurs="unbounded"/> </sequence> </complexType> <complexType name="ParameterSetType"> <sequence> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 30 OL-28496-01 Appendix <element name="parameterName" type="string" maxOccurs="unbounded"/> </sequence> </complexType> <complexType name="OperationType"> <sequence> <element name="operationName" type="string"/> <element name="parameterSet" type="inventoryIRPData:ParameterSetType"/> </sequence> </complexType> <complexType name="OperationSetType"> <sequence> <element name="operation" type="inventoryIRPData:OperationType" maxOccurs="unbounded"/> </sequence> </complexType> <complexType name="NotificationType"> <sequence> <element name="notificationName" type="string"/> <element name="parameterSet" type="inventoryIRPData:ParameterSetType"/> </sequence> </complexType> <complexType name="NotificationSetType"> <sequence> <element name="notification" type="inventoryIRPData:NotificationType" maxOccurs="unbounded"/> </sequence> </complexType> </schema> </types> <message name="getAllManagedElementNamesRequest"> <part name="parameter" element="inventoryIRPData:getAllManagedElementNames"/> </message> <message name="getAllManagedElementNamesResponse"> <part name="parameter" element="inventoryIRPData:getAllManagedElementNamesResponse"/> </message> <message name="getAllManagedElementNamesFault"> <part name="parameter" element="inventoryIRPData:getAllManagedElementNamesFault"/> </message> <message name="getManagedElementRequest"> <part name="parameter" element="inventoryIRPData:getManagedElement"/> </message> <message name="getManagedElementResponse"> <part name="parameter" element="inventoryIRPData:getManagedElementResponse"/> </message> <message name="getManagedElementFault"> <part name="parameter" element="inventoryIRPData:getManagedElementFault"/> </message> <message name="getAllInventoryRequest"> <part name="parameter" element="inventoryIRPData:getAllInventory"/> </message> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 31 Appendix <message name="getAllInventoryResponse"> <part name="parameter" element="inventoryIRPData:getAllInventoryResponse"/> </message> <message name="getAllInventoryFault"> <part name="parameter" element="inventoryIRPData:getAllInventoryFault"/> </message> <portType name="InventoryIRP_RPC"> <operation name="getManagedElement"> <input message="inventoryIRPSystem:getManagedElementRequest"/> <output message="inventoryIRPSystem:getManagedElementResponse"/> <fault name="getManagedElementFault" message="inventoryIRPSystem:getManagedElementFault"/> </operation> <operation name="getAllManagedElementNames"> <input message="inventoryIRPSystem:getAllManagedElementNamesRequest"/> <output message="inventoryIRPSystem:getAllManagedElementNamesResponse"/> <fault name="getAllManagedElementNamesFault" message="inventoryIRPSystem:getAllManagedElementNamesFault"/> </operation> <operation name="getAllInventory"> <input message="inventoryIRPSystem:getAllInventoryRequest"/> <output message="inventoryIRPSystem:getAllInventoryResponse"/> <fault name="getAllInventoryFault" message="inventoryIRPSystem:getAllInventoryFault"/> </operation> </portType> <binding name="InventoryIRPSoapHttpBinding" type="inventoryIRPSystem:InventoryIRP_RPC"> <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> <operation name="getManagedElement"> <soap:operation soapAction="getManagedElement" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="getManagedElementFault"> <soap:fault name="getManagedElementFault" use="literal"/> </fault> </operation> <operation name="getAllManagedElementNames"> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 32 OL-28496-01 Appendix <soap:operation soapAction="getAllManagedElementNames" stype="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="getAllManagedElementNamesFault"> <soap:fault name="getAllManagedElementNamesFault" use="literal"/> </fault> </operation> <operation name="getAllInventory"> <soap:operation soapAction="getAllInventory" style="document"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> <fault name="getAllInventoryFault"> <soap:fault name="getAllInventoryFault" use="literal"/> </fault> </operation> </binding> <service name="InventoryIRPRetrievalHttp"> <port name="InventoryIRPSoapHttp" binding="inventoryIRPSystem:InventoryIRPSoapHttpBinding"> <soap:address location="To be defined."/> </port> </service> </definitions> 11.2 3GPP inventoryNrm Schema File <?xml version="1.0" encoding="UTF-8"?> <!-3GPP TS 32.696 Inventory Management NRM IRP Inventory data file NRM-specific XML schema inventoryNrm.xsd --> <schema targetNamespace= "http://www.3gpp.org/ftp/specs/archive/32_series/32.696#inventoryNrm" elementFormDefault="qualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xn= "http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm" xmlns:in= "http://www.3gpp.org/ftp/specs/archive/32_series/32.696#inventoryNrm" > Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 33 Appendix <import schemaLocation="../../../ConfigurationManagement/GenericNetworkResourcesIR P/SolutionSet/xsd/genericNrm.xsd" namespace= "http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm" /> <!-- Inventory Management Alternative 1 NRM IRP NRM class associated XML elements --> <simpleType name="eightOctetsType"> <restriction base="hexBinary"> <length value="8"/> </restriction> </simpleType> <simpleType name="fourOctetsType"> <restriction base="hexBinary"> <length value="4"/> </restriction> </simpleType> <simpleType name="angleValueType"> <restriction base="short"> <minInclusive value="0"/> <maxInclusive value="3600"/> </restriction> </simpleType> <element name="InventoryUnit" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass" > <complexType> <complexContent> <extension base="xn:NrmClass"> <sequence> <element name="attributes" minOccurs="0"> <complexType> <all> <element name="inventoryUnitType" type="string" /> <element name="vendorUnitFamilyType" type="string" minOccurs="0" /> <element name="vendorUnitTypeNumber" type="string" minOccurs="0" /> <element name="vendorName" type="string"/> <element name="serialNumber" type="string" minOccurs="0"/> <element Cisco Prime OSS Integration Guide for MTOSI and 3GPP 34 OL-28496-01 Appendix name="dateOfManufacture" type="date" minOccurs="0"/> <element name="dateOfLastService" type="date" minOccurs="0"/> <element name="unitPosition" type="string" minOccurs="0"/> <element name="manufacturerData" type="string" minOccurs="0"/> <element name="versionNumber" type="string" minOccurs="0"/> <element name="relatedFunction" type="xn:dn" minOccurs="0"/> </all> </complexType> </element> <element ref="xn:ManagedFunction" minOccurs="0"/> <choice minOccurs="0" maxOccurs="unbounded"> <element ref="in:InventoryUnit"/> <element ref="xn:VsDataContainer"/> <element ref="in:TmaInventoryUnit"/> <element ref="in:AntennaInventoryUnit"/> </choice> </sequence> </extension> </complexContent> </complexType> </element> <element name="TmaInventoryUnit" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> <complexType> <complexContent> <extension base="xn:NrmClass"> <sequence> <element name="attributes" minOccurs="0"> <complexType> <all> <!-- Inherited attributes from InventoryUnit--> <element name="inventoryUnitType" type="string"/> <element name="vendorUnitFamilyType" type="string" minOccurs="0"/> <element name="vendorUnitTypeNumber" type="string" minOccurs="0"/> <element name="vendorName" type="string"/> <element name="serialNumber" type="string" minOccurs="0"/> <element name="dateOfManufacture" type="date" minOccurs="0"/> <element name="dateOfLastService" type="date" minOccurs="0"/> <element name="unitPosition" type="string" minOccurs="0"/> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 35 Appendix <element name="manufacturerData" type="string" minOccurs="0"/> <element name="versionNumber" type="string" minOccurs="0"/> <element name="relatedFunction" type="xn:dn" minOccurs="0"/> <!-- End of inherited attributes from InventoryUnit --> <element name="tmaNumberOfNonLinearGainValues" type="short" minOccurs="0"/> <element name="tmaNonLinearGainValue" type="short" minOccurs="0"/> <element name="tmaAdditionalDataFieldNumber" type="short" minOccurs="0"/> <element name="tmaAntennaModelNumber" type="string" minOccurs="0"/> <element name="tmaAntennaOperatingBands" type="short" minOccurs="0"/> <element name="tmaBeamwidthForEachOpBandInBandOrder" type="in:eightOctetsType" minOccurs="0"/> <element name="tmaGainForEachOpBandInBandOrder" type="in:fourOctetsType" minOccurs="0"/> <element name="tmaInstallationDate" type="string" minOccurs="0"/> <element name="tmaInstallersId" type="string" minOccurs="0"/> <element name="tmaMaxSupportedGain" type="short" minOccurs="0"/> <element name="tmaMinSupportedGain" type="short" minOccurs="0"/> </all> </complexType> </element> <choice minOccurs="0" maxOccurs="unbounded"> <element ref="in:InventoryUnit"/> <element ref="xn:VsDataContainer"/> </choice> </sequence> </extension> </complexContent> </complexType> </element> <element name="AntennaInventoryUnit" substitutionGroup="xn:ManagedElementOptionallyContainedNrmClass"> <complexType> <complexContent> <extension base="xn:NrmClass"> <sequence> <element name="attributes" minOccurs="0"> <complexType> <all> <!-- Inherited attributes from InventoryUnit--> <element name="inventoryUnitType" type="string"/> <element name="vendorUnitFamilyType" type="string" minOccurs="0"/> <element name="vendorUnitTypeNumber" type="string" minOccurs="0"/> <element name="vendorName" type="string"/> <element name="serialNumber" type="string" minOccurs="0"/> <element name="dateOfManufacture" type="date" minOccurs="0"/> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 36 OL-28496-01 Appendix <element name="dateOfLastService" type="date" minOccurs="0"/> <element name="unitPosition" type="string" minOccurs="0"/> <element name="manufacturerData" type="string" minOccurs="0"/> <element name="versionNumber" type="string" minOccurs="0"/> <element name="relatedFunction" type="xn:dn" minOccurs="0"/> <!-- End of inherited attributes from InventoryUnit--> <element name="maxTiltValue" type="in:angleValueType" minOccurs="0"/> <element name="minTiltValue" type="in:angleValueType" minOccurs="0"/> <element name="mechanicalOffset" type="in:angleValueType" minOccurs="0"/> <element name="baseElevation" type="integer" minOccurs="0"/> <element name="latitude" type="decimal" minOccurs="0"/> <element name="longitude" type="decimal" minOccurs="0"/> <element name="patternLabel" type="string" minOccurs="0"/> </all> </complexType> </element> <choice minOccurs="0" maxOccurs="unbounded"> <element ref="in:InventoryUnit"/> <element ref="xn:VsDataContainer"/> </choice> </sequence> </extension> </complexContent> </complexType> </element> </schema> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 37 Appendix 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 11- 11: Physical Inventory Attributes for Managed Element Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M Cisco Prime OSS Integration Guide for MTOSI and 3GPP 38 3GPP Prescribed Write Qualifier - OL-28496-01 Appendix Table 11- 12: Physical Inventory Attribute for Chassis Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Table 11- 13: Physical Inventory Attribute for Card Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 39 Appendix Table 11- 14: Physical Inventory Attribute for Slot Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Table 11- 15: Physical Inventory Attribute for Port Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M Cisco Prime OSS Integration Guide for MTOSI and 3GPP 40 3GPP Prescribed Write Qualifier - OL-28496-01 Appendix Table 11- 16: Physical Inventory Attribute for Sub-Port Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Table 11- 17: Physical Inventory Attribute for Power Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 41 Appendix Table 11- 18: Physical Inventory Attribute for Fan Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier Id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - 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 Extensions 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 Cisco Prime OSS Integration Guide for MTOSI and 3GPP 42 OL-28496-01 Appendix 11.3.2.1 Logical Inventory Attribute for PGW Table 11- 19: Attribute for PGW Attribute name id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction ManagedFunction Id PGWFunction Id userLabel linkList 11.3.2.1.1 • • • • • • • • • 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Vendor Extensions for PGW PgwStatus NewcallPolicy EgtpService LmaService GgsnService QciQosMappingTable SessionDeleteDelayTimeout SaeGwService PgwStatus Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 43 Appendix 11.3.2.2 Logical Inventory Attribute for SGW Table 11- 20: Attribute for SGW Attribute name id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction ManagedFunction Id ServingGWFunction userLabel PLMNIdList TACList 11.3.2.2.1 • • • • • • • • • • • 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Vendor Extensions for SGW AccountingContext AccountingGtppGroup AccountingMode EgressProtocol EgressContext EgressMagService ImsAuthorizationService AccountingPolicy ServiceStatus SaeGwService NewcallPolicy Cisco Prime OSS Integration Guide for MTOSI and 3GPP 44 OL-28496-01 Appendix 11.3.2.3 Logical Inventory Attribute for APN Table 11- 21: Attribute for APN Attribute name id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction ManagedFunction Id APN Id userLabel 11.3.2.3.1 • • • • • • • • • • • • • • • 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Vendor Extension for APN AccountingMode SelectionMode L3toL2AddressPolicy AllocationType DnsConfiguration Id PrimaryDnsAddress Secondarty DnsAddress IpHeaderCompression PDP Id PdpType PrimaryContexts TotoalContexts RadiusServerConfiguration Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 45 Appendix • • • • • • • • • • • Id 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 Cisco Prime OSS Integration Guide for MTOSI and 3GPP 46 OL-28496-01 Appendix • • • • • • o Mtu 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 Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 47 Appendix RuleType 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 o o • • • Cisco Prime OSS Integration Guide for MTOSI and 3GPP 48 OL-28496-01 Appendix 11.3.2.4 Logical Inventory Attribute for SAEGW Table 11- 22: Attribute for SAEGW Attribute name id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction ManagedFunction Id SAEGWFunction Id userLabel 11.3.2.4.1 • • 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier M M M CM CM CM O O O O O O M M M M M M M M M M M M 3GPP Prescribed Write Qualifier - Vendor Extensions for SAEGW SgwService PgwService 11.3.2.5 Logical Inventory Attribute for GGSN Table 11- 23: Logical Inventory Attribute for GGSN Attribute name 3GPP Prescribed Support Qualifier 3GPP Prescribed Read Qualifier id inventoryUnitType vendorName vendorUnitFamilyType vendorUnitTypeNumber serialNumber M M M CM CM CM M M M M M M 3GPP Prescribed Write Qualifier - Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 49 Appendix versionNumber dateOfManufacture dateOfLastService unitPosition manufacturerData relatedFunction ManagedFunction Id APN O O O O O O M M M M M M - 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 o Id Cisco Prime OSS Integration Guide for MTOSI and 3GPP 50 OL-28496-01 Appendix • • • • • 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 11.4 Useful Code Snippets for 3GPP 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. // Java SOAP client Imports import javax.xml.soap.SOAPBody; import javax.xml.soap.SOAPConnection; import javax.xml.soap.SOAPConnectionFactory; Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 51 Appendix import import import import import import import import javax.xml.soap.SOAPElement; javax.xml.soap.SOAPEnvelope; javax.xml.soap.SOAPException; javax.xml.soap.SOAPFactory; javax.xml.soap.SOAPHeader; javax.xml.soap.SOAPMessage; javax.xml.soap.SOAPPart; javax.xml.transform.Source; // Constructing the SOAP Header SOAPHeader header = message.getSOAPHeader(); if (header == null) header = envelope.addHeader(); // Constructing the contents for performing Authorization String AUTH_NS = "http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd"; String AUTH_PREFIX = "wsse"; SOAPFactory soapFactory = SOAPFactory.newInstance(); SOAPElement wsSecHeaderElm = soapFactory.createElement("Security", AUTH_PREFIX, AUTH_NS); SOAPElement userNameTokenElm = soapFactory.createElement( "UsernameToken", AUTH_PREFIX, AUTH_NS); Name qname = envelope .createName( "Id", "wsu", "http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"); userNameTokenElm.addAttribute(qname, "UsernameToken-27"); SOAPElement userNameElm = soapFactory.createElement("Username", AUTH_PREFIX, AUTH_NS); userNameElm.addTextNode(username); SOAPElement passwdElm = soapFactory.createElement("Password", AUTH_PREFIX, AUTH_NS); passwdElm.addTextNode(password); Name passwordType = envelope.createName("Type"); passwdElm .addAttribute( passwordType, "http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-username-token-profile1.0#PasswordText"); userNameTokenElm.addChildElement(userNameElm); userNameTokenElm.addChildElement(passwdElm); // add child elements to the root element wsSecHeaderElm.addChildElement(userNameTokenElm); // add SOAP element for header to SOAP header object header.addChildElement(wsSecHeaderElm); // end: setting SOAP headers // start: setting SOAP body // Create and populate the body SOAPBody body = envelope.getBody(); Cisco Prime OSS Integration Guide for MTOSI and 3GPP 52 OL-28496-01 Appendix // Create the main element and namespace // Creates main element for “getAllInventory” Operation. SOAPElement bodyElement = body .addChildElement(envelope .createName( "getAllInventory", "inv", "http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgppInventory/sche ma/InventoryIRPData")); // Add content bodyElement.addChildElement("invokeIdentifierIn").addTextNode("123"); bodyElement.addChildElement("queryXpathExp").addTextNode( "/MD=CISCO_PRIME"); // Save the message message.saveChanges(); MimeHeaders headers = message.getMimeHeaders(); headers.addHeader("SOAPAction", "getAllInventory"); // Set the destination // Send the message and get the reply SOAPMessage reply = connection.call(message, wsdlname); 11.5 3GPP Sample Inventory File A Sample inventory file is given here IM_20120808_1005+0300_32767_10.86.66.35_10002.xml Where : IM – Indicates the management type 20120808 – Date of creation 32767 – File expiry time in hours 10.86.66.35 – Name of the device 10002 – Running serial number ( RC ) 11.5.1 3GPP Inventory File Contents The inventory file contains physical and logical inventory information. A sample inventory file containing inventory data is given here: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?xml-stylesheet type="text/xsl" href="InventoryXSLT.xsl"?> <InventoryUnit xmlns:ns2="http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericN rm" xmlns="http://www.3gpp.org/ftp/specs/archive/32_series/32.696#inventoryNrm " xmlns:ns4="CiscoTgppInvCommon" xmlns:ns3="CiscoSpecificGGSNNameSpace" xmlns:ns9="http://www.3gpp.org/ftp/specs/archive/32_series/32.526#sonPolic yNrm" Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 53 Appendix xmlns:ns5="http://www.3gpp.org/ftp/specs/archive/32_series/32.755#epcNrm" xmlns:ns6="http://www.3gpp.org/ftp/specs/archive/32_series/32.636#coreNrm" xmlns:ns10="CiscoSpecificPGWNameSpace" xmlns:ns7="apnprofile" xmlns:ns11="CiscoSpecificSGWNameSpace" xmlns:ns8="saegw"> > <attributes> <inventoryUnitType>Managed Element Data</inventoryUnitType> <vendorUnitFamilyType>CISCO_ASR_5000</vendorUnitFamilyType> <vendorUnitTypeNumber></vendorUnitTypeNumber> <vendorName>Cisco</vendorName> <serialNumber></serialNumber> <versionNumber>14.0 (43929)</versionNumber> </attributes> <InventoryUnit id="{[ManagedElement(Key=10.56.22.105)][PhysicalRoot][Chassis]}"> <attributes> <inventoryUnitType>Hardware Unit Data</inventoryUnitType> <vendorUnitFamilyType>ASR5000 Chassis</vendorUnitFamilyType> <vendorUnitTypeNumber></vendorUnitTypeNumber> <vendorName>Cisco</vendorName> <serialNumber></serialNumber> <unitPosition>ManagedElement=10.56.22.105, Chassis=1</unitPosition> </attributes> <InventoryUnit id="{[ManagedElement(Key=10.56.22.105)][PhysicalRoot][Chassis][Slot(SlotNu m=40)][Module]}"> <attributes> <inventoryUnitType>Hardware Unit Data</inventoryUnitType> <vendorUnitFamilyType>Redundancy Crossbar Card 40</vendorUnitFamilyType> <vendorUnitTypeNumber>Unknown Module</vendorUnitTypeNumber> <vendorName>Cisco</vendorName> <serialNumber>SAD154000TG</serialNumber> <unitPosition>ManagedElement=10.56.22.105, Chassis=1, SlotNum=40</unitPosition> <versionNumber>V03</versionNumber> </attributes> </InventoryUnit> : : : <!--Logical Inventory --> <InventoryUnit id="{[ManagedElement(Key=10.56.22.105)][LogicalRoot][Context(ContextName=b iswa)][Mobile][SGWContainer][SGWService(ServiceName=bulu)]}"> <attributes> <inventoryUnitType>Software Unit Data</inventoryUnitType> <vendorName>Cisco</vendorName> </attributes> <ns2:ManagedFunction id="{[ManagedElement(Key=10.56.22.105)][LogicalRoot][Context(ContextName=b iswa)][Mobile][SGWContainer][SGWService(ServiceName=bulu)]}"> <ns2:VsDataContainer id="bulu-VsData1"> <ns2:attributes> <ns2:vsDataType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" Cisco Prime OSS Integration Guide for MTOSI and 3GPP 54 OL-28496-01 Appendix xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">class com.cisco.prime.esb.tgpp.model.common.ServingGWFunction</ns2:vsDataType> <ns2:vsDataFormatVersion xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">http://www.3gpp.org/ftp/specs/archive/32_series/32.755#epcNrm9.3.0</ns2:vsDataFormatVersion> <ns2:vsData xsi:type="ns4:vsDataCiscoSpecificMobileContainer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ns5:ServingGWFunction id="{[ManagedElement(Key=10.56.22.105)][LogicalRoot][Context(ContextName=b iswa)][Mobile][SGWContainer][SGWService(ServiceName=bulu)]}"> <ns5:attributes> <ns5:userLabel>bulu</ns5:userLabel> <ns5:pLMNIdList/> <ns5:tACList/> </ns5:attributes> <ns2:VsDataContainer id="bulu-VsData1"> <ns2:attributes> <ns2:vsDataType xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">ServingGWFunction</ns2:vsDataT ype> <ns2:vsDataFormatVersion xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">CiscoSpecificAttributes.sgw.1. 0</ns2:vsDataFormatVersion> <ns2:vsData xsi:type="ns11:SGWServiceType"> <ns11:AccountingContext>biswa</ns11:AccountingContext> <ns11:AccountingMode>GTPP</ns11:AccountingMode> <ns11:EgressContext>biswa</ns11:EgressContext> <ns11:EgressProtocol>gtppmip</ns11:EgressProtocol> <ns11:ServiceStatus>Down</ns11:ServiceStatus> </ns2:vsData> </ns2:attributes> </ns2:VsDataContainer> </ns5:ServingGWFunction> </ns2:vsData> </ns2:attributes> </ns2:VsDataContainer> </ns2:ManagedFunction> </InventoryUnit> : : : <InventoryUnit> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 55 Appendix 11.6 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.6.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. • 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.6.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 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 Cisco Prime OSS Integration Guide for MTOSI and 3GPP 56 OL-28496-01 Appendix 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. localhost://tmp/IM_20120808_1005+0300_32767_10.86.66.35_10002.xml – Indicates the location where the inventory file is generated. 11.7 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. 11.8 3GPP Web Service Sample Request Response This section contains the sample Request and Response for the Web Service operations supported: 11.8.1 InventoryIRP::getAllManagedElementNames OperationName: getAllManagedElementNames SOAP Request: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgppInvent ory/schema/InventoryIRPData"> <soapenv:Header/> <soapenv:Body> <inv:getAllManagedElementNames> <invokeIdentifierIn>1234</invokeIdentifierIn> <queryXpathExp>/MD=CISCO_PRIME</queryXpathExp> </inv:getAllManagedElementNames> </soapenv:Body> </soapenv:Envelope> SOAP Response: Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 57 Appendix <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getAllManagedElementNamesResponse xmlns:ns2="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgppInvent ory/schema/InventoryIRPData" xmlns:ns3="http://www.3gpp.org/ftp/Specs/archive/32_series/32317/schema/32 317-800/GenericIRPData"> <getAllMENamesResponse> <invokeIdentifierOut>1234</invokeIdentifierOut> <meNameListOut> <meType> <meName>ASR5500-35</meName> <meType>CISCO_ASR_5500</meType> </meType> <meType> <meName>ASR5500-105</meName> <meType>CISCO_ASR_5000</meType> </meType> </meNameListOut> </getAllMENamesResponse> </ns2:getAllManagedElementNamesResponse> </soap:Body> </soap:Envelope> 11.8.2 InventoryIRP::getAllInventory Operation: getAllInventory SOAP Request: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgppInvent ory/schema/InventoryIRPData"> <soapenv:Header/> <soapenv:Body> <inv:getAllInventory> <invokeIdentifierIn>1</invokeIdentifierIn> <queryXpathExp>/MD=CISCO_PRIME</queryXpathExp> </inv:getAllInventory> </soapenv:Body> </soapenv:Envelope> SOAP Response: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getAllInventoryResponse xmlns:ns2="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgppInvent ory/schema/InventoryIRPData" xmlns:ns3="http://www.3gpp.org/ftp/Specs/archive/32_series/32317/schema/32 317-800/GenericIRPData"> <getAllRequestResponse> <invokeIdentifierOut>1</invokeIdentifierOut> <responseMessage>Inventory Request Initiated with Request ID: 10017</responseMessage> </getAllRequestResponse> </ns2:getAllInventoryResponse> </soap:Body> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 58 OL-28496-01 Appendix </soap:Envelope> 11.8.3 InventoryIRP::getManagedElement Operation: getManagedElement SOAP Request: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgppInvent ory/schema/InventoryIRPData"> <soapenv:Header/> <soapenv:Body> <inv:getManagedElement> <invokeIdentifierIn>1234</invokeIdentifierIn> <queryXpathExp>/MD=CISCO_PRIME/ME=ASR5500-35</queryXpathExp> </inv:getManagedElement> </soapenv:Body> </soapenv:Envelope> SOAP Response: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getManagedElementResponse xmlns:ns2="http://www.3gpp.org/ftp/Specs/archive/32_series/ciscoTgppInvent ory/schema/InventoryIRPData" xmlns:ns3="http://www.3gpp.org/ftp/Specs/archive/32_series/32317/schema/32 317-800/GenericIRPData"> <getMEResp> <invokeIdentifierOut>1234</invokeIdentifierOut> <responseMessage>Inventory Request Initiated for {[ManagedElement(Key=ASR5500-35)]} with request ID 10018</responseMessage> </getMEResp> </ns2:getManagedElementResponse> </soap:Body> </soap:Envelope> 11.9 MTOSI Web Service Sample Request and Response 11.9.1 getME SOAP Request <?xml version="1.0" encoding="UTF-8" ?> - <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:v11="http://www.tmforum.org/mtop/mri/xsd/mer/v1" xmlns:v12="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> - <soapenv:Header> <v1:header /> </soapenv:Header> - <soapenv:Body> - <v11:getManagedElementRequest> - <!-Optional: --> - <v11:meRef> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 59 Appendix - <!-1 or more repetitions: --> - <v12:rdn> <v12:type>MD</v12:type> <v12:value>CISCO_PRIME</v12:value> </v12:rdn> - <v12:rdn> <v12:type>ME</v12:type> <v12:value>15454-ansi-65-101</v12:value> </v12:rdn> </v11:meRef> </v11:getManagedElementRequest> </soapenv:Body> </soapenv:Envelope> SOAP Response <?xml version="1.0" encoding="UTF-8" ?> - <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> - <soap:Header> - <header xmlns:ns14="http://www.tmforum.org/mtop/nrb/xsd/crmd/v1" xmlns:ns13="http://www.tmforum.org/mtop/fmw/xsd/cosd/v1" xmlns:ns12="http://www.tmforum.org/mtop/rp/xsd/crp/v1" xmlns:ns11="http://www.tmforum.org/mtop/fmw/xsd/msg/v1" xmlns:ns10="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:ns9="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1" xmlns:ns8="http://www.tmforum.org/mtop/nrb/xsd/lay/v1" xmlns:ns7="http://www.tmforum.org/mtop/nrf/xsd/me/v1" xmlns:ns6="http://www.tmforum.org/mtop/nrb/xsd/cri/v1" xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/coi/v1" xmlns:ns4="http://www.tmforum.org/mtop/mri/xsd/mer/v1" xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>getManagedElement</activityName> <msgName>getManagedElementResponse</msgName> <msgType>RESPONSE</msgType> <activityStatus>SUCCESS</activityStatus> <priority>HIGH - modified in NormalizeSoapMsg.processResponse</priority> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2012-07-10T06:18:03.124+02:00</timestamp> </header> </soap:Header> - <soap:Body> - <ns4:getManagedElementResponse xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:ns4="http://www.tmforum.org/mtop/mri/xsd/mer/v1" xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/coi/v1" xmlns:ns6="http://www.tmforum.org/mtop/nrb/xsd/cri/v1" xmlns:ns7="http://www.tmforum.org/mtop/nrf/xsd/me/v1" xmlns:ns8="http://www.tmforum.org/mtop/nrb/xsd/lay/v1" xmlns:ns9="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1" xmlns:ns10="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:ns11="http://www.tmforum.org/mtop/fmw/xsd/msg/v1" xmlns:ns12="http://www.tmforum.org/mtop/rp/xsd/crp/v1" Cisco Prime OSS Integration Guide for MTOSI and 3GPP 60 OL-28496-01 Appendix xmlns:ns13="http://www.tmforum.org/mtop/fmw/xsd/cosd/v1" xmlns:ns14="http://www.tmforum.org/mtop/nrb/xsd/crmd/v1"> - <ns4:me> - <ns5:name> - <ns3:rdn> <ns3:type>HINTS</ns3:type> <ns3:value>TIME:1341893883161;DMLIST:opt://opt:13</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>MD</ns3:type> <ns3:value>CISCO_PRIME</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>ME</ns3:type> <ns3:value>15454-ansi-65-101</ns3:value> </ns3:rdn> </ns5:name> <ns5:discoveredName>15454-ansi-65-101</ns5:discoveredName> - <ns5:vendorExtensions> <ns15:Cisco_ManagementIPAddress xmlns:ns15="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_Invent ory/v1">10.58.65.101</ns15:Cisco_ManagementIPAddress> <ns15:Cisco_ME_Operation_Mode xmlns:ns15="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_Invent ory/v1">UNKNOWN</ns15:Cisco_ME_Operation_Mode> <ns15:Cisco_ME_Hardware_Type xmlns:ns15="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_Invent ory/v1">Optical</ns15:Cisco_ME_Hardware_Type> <ns15:Cisco_ME_Description xmlns:ns15="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_Invent ory/v1">Optical</ns15:Cisco_ME_Description> <ns15:Cisco_ME_Serial_Number xmlns:ns15="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_Invent ory/v1">UNKNOWN</ns15:Cisco_ME_Serial_Number> </ns5:vendorExtensions> <ns6:resourceState>WORKING</ns6:resourceState> <ns7:location /> <ns7:manufacturer>Cisco Systems</ns7:manufacturer> <ns7:productName>Cisco ONS 15454</ns7:productName> <ns7:softwareVersion>09.20-010E-05.18</ns7:softwareVersion> <ns7:isInSyncState>true</ns7:isInSyncState> <ns7:communicationState>CS_AVAILABLE</ns7:communicationState> </ns4:me> </ns4:getManagedElementResponse> </soap:Body> </soap:Envelope> 11.9.2 getAllSupportedPhysicalTerminationPoints SOAP Request <?xml version="1.0" encoding="UTF-8" ?> - <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:v11="http://www.tmforum.org/mtop/mri/xsd/tpr/v1" xmlns:v12="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> - <soapenv:Header> <v1:header /> </soapenv:Header> - <soapenv:Body> - <v11:getAllSupportedPhysicalTerminationPointsRequest> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 61 Appendix - <!-Optional:--> - <v11:equipmentRef> - <!-1 or more repetitions: --> - <v12:rdn> <v12:type>MD</v12:type> <v12:value>CISCO_PRIME</v12:value> </v12:rdn> - <v12:rdn> <v12:type>ME</v12:type> <v12:value>15454-ansi-65-102</v12:value> </v12:rdn> - <v12:rdn> <v12:type>EH</v12:type> <v12:value>rack=1</v12:value> </v12:rdn> - <v12:rdn> <v12:type>EH</v12:type> <v12:value>shelf=1</v12:value> </v12:rdn> - <v12:rdn> <v12:type>EH</v12:type> <v12:value>slot=2</v12:value> </v12:rdn> - <v12:rdn> <v12:type>EQ</v12:type> <v12:value>OC12_4</v12:value> </v12:rdn> </v11:equipmentRef> </v11:getAllSupportedPhysicalTerminationPointsRequest> </soapenv:Body> </soapenv:Envelope> SOAP Response <?xml version="1.0" encoding="UTF-8" ?> - <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> - <soap:Header> - <header xmlns:ns21="http://www.tmforum.org/mtop/nrb/xsd/crmd/v1" xmlns:ns20="http://www.tmforum.org/mtop/fmw/xsd/cosd/v1" xmlns:ns19="http://www.tmforum.org/mtop/nrf/xsd/com/v1" xmlns:ns18="http://www.tmforum.org/mtop/nrf/xsd/fd/v1" xmlns:ns17="http://www.tmforum.org/mtop/nrf/xsd/gtp/v1" xmlns:ns16="http://www.tmforum.org/mtop/nrf/xsd/tppool/v1" xmlns:ns15="http://www.tmforum.org/mtop/nrb/xsd/lay/v1" xmlns:ns14="http://www.tmforum.org/mtop/rp/xsd/crp/v1" xmlns:ns13="http://www.tmforum.org/mtop/fmw/xsd/msg/v1" xmlns:ns12="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1" xmlns:ns11="http://www.tmforum.org/mtop/nrf/xsd/tp/v1" xmlns:ns10="http://www.tmforum.org/mtop/nrf/xsd/ctp/v1" xmlns:ns9="http://www.tmforum.org/mtop/nrf/xsd/ftp/v1" xmlns:ns8="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:ns7="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:ns6="http://www.tmforum.org/mtop/nrb/xsd/cri/v1" xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/coi/v1" xmlns:ns4="http://www.tmforum.org/mtop/mri/xsd/tpr/v1" xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 62 OL-28496-01 Appendix <activityName>getAllSupportedPhysicalTerminationPoints</activityName> <msgName>getAllSupportedPhysicalTerminationPointsResponse</msgName> <msgType>RESPONSE</msgType> <activityStatus>SUCCESS</activityStatus> <priority>HIGH - modified in NormalizeSoapMsg.processResponse</priority> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2012-07-10T06:46:39.211+02:00</timestamp> </header> </soap:Header> - <soap:Body> - <ns4:getAllSupportedPhysicalTerminationPointsResponse xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:ns4="http://www.tmforum.org/mtop/mri/xsd/tpr/v1" xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/coi/v1" xmlns:ns6="http://www.tmforum.org/mtop/nrb/xsd/cri/v1" xmlns:ns7="http://www.tmforum.org/mtop/nrf/xsd/ptp/v1" xmlns:ns8="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:ns9="http://www.tmforum.org/mtop/nrf/xsd/ftp/v1" xmlns:ns10="http://www.tmforum.org/mtop/nrf/xsd/ctp/v1" xmlns:ns11="http://www.tmforum.org/mtop/nrf/xsd/tp/v1" xmlns:ns12="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1" xmlns:ns13="http://www.tmforum.org/mtop/fmw/xsd/msg/v1" xmlns:ns14="http://www.tmforum.org/mtop/rp/xsd/crp/v1" xmlns:ns15="http://www.tmforum.org/mtop/nrb/xsd/lay/v1" xmlns:ns16="http://www.tmforum.org/mtop/nrf/xsd/tppool/v1" xmlns:ns17="http://www.tmforum.org/mtop/nrf/xsd/gtp/v1" xmlns:ns18="http://www.tmforum.org/mtop/nrf/xsd/fd/v1" xmlns:ns19="http://www.tmforum.org/mtop/nrf/xsd/com/v1" xmlns:ns20="http://www.tmforum.org/mtop/fmw/xsd/cosd/v1" xmlns:ns21="http://www.tmforum.org/mtop/nrb/xsd/crmd/v1"> - <ns4:tpList> - <ns11:tp> - <ns7:ptp> - <ns5:name> - <ns3:rdn> <ns3:type>HINTS</ns3:type> <ns3:value>TIME:1341895599296;DMLIST:opt://opt:13</ns3:value > </ns3:rdn> - <ns3:rdn> <ns3:type>MD</ns3:type> <ns3:value>CISCO_PRIME</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>ME</ns3:type> <ns3:value>15454-ansi-65-102</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>PTP</ns3:type> <ns3:value>/rack=1/shelf=1/slot=2/port=1</ns3:value> </ns3:rdn> </ns5:name> <ns5:userLabel /> - <ns5:vendorExtensions> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 63 Appendix <ns22:Cisco_PTP_Line_Rate xmlns:ns22="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_In ventory/v1">LR_Not_Applicable</ns22:Cisco_PTP_Line_Rate> </ns5:vendorExtensions> <ns6:resourceState>UNKNOWN</ns6:resourceState> <ns7:direction>D_BIDIRECTIONAL</ns7:direction> <ns7:isEdgePoint>true</ns7:isEdgePoint> - <ns8:transmissionParametersList> - <ns8:transmissionParameters> <ns8:layerRate>LR_DSR_OC12_STM4</ns8:layerRate> <ns8:parameterList /> </ns8:transmissionParameters> - <ns8:transmissionParameters> <ns8:layerRate>LR_PHYSICAL_OPTICAL</ns8:layerRate> - <ns8:parameterList> - <ns2:nvs> <ns2:name>AdminState</ns2:name> <ns2:value>IN_SERVICE</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>OperationalState</ns2:name> <ns2:value>IS-NR</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>AlarmReporting</ns2:name> <ns2:value>On</ns2:value> </ns2:nvs> </ns8:parameterList> </ns8:transmissionParameters> </ns8:transmissionParametersList> </ns7:ptp> </ns11:tp> - <ns11:tp> - <ns7:ptp> - <ns5:name> - <ns3:rdn> <ns3:type>HINTS</ns3:type> <ns3:value>TIME:1341895599296;DMLIST:opt://opt:13</ns3:value > </ns3:rdn> - <ns3:rdn> <ns3:type>MD</ns3:type> <ns3:value>CISCO_PRIME</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>ME</ns3:type> <ns3:value>15454-ansi-65-102</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>PTP</ns3:type> <ns3:value>/rack=1/shelf=1/slot=2/port=2</ns3:value> </ns3:rdn> </ns5:name> <ns5:userLabel /> - <ns5:vendorExtensions> <ns22:Cisco_PTP_Line_Rate xmlns:ns22="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_In ventory/v1">LR_Not_Applicable</ns22:Cisco_PTP_Line_Rate> </ns5:vendorExtensions> <ns6:resourceState>UNKNOWN</ns6:resourceState> <ns7:direction>D_BIDIRECTIONAL</ns7:direction> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 64 OL-28496-01 Appendix <ns7:isEdgePoint>true</ns7:isEdgePoint> - <ns8:transmissionParametersList> - <ns8:transmissionParameters> <ns8:layerRate>LR_DSR_OC12_STM4</ns8:layerRate> <ns8:parameterList /> </ns8:transmissionParameters> - <ns8:transmissionParameters> <ns8:layerRate>LR_PHYSICAL_OPTICAL</ns8:layerRate> - <ns8:parameterList> - <ns2:nvs> <ns2:name>AdminState</ns2:name> <ns2:value>IN_SERVICE</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>OperationalState</ns2:name> <ns2:value>IS-NR</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>AlarmReporting</ns2:name> <ns2:value>On</ns2:value> </ns2:nvs> </ns8:parameterList> </ns8:transmissionParameters> </ns8:transmissionParametersList> </ns7:ptp> </ns11:tp> - <ns11:tp> - <ns7:ptp> - <ns5:name> - <ns3:rdn> <ns3:type>HINTS</ns3:type> <ns3:value>TIME:1341895599296;DMLIST:opt://opt:13</ns3:value > </ns3:rdn> - <ns3:rdn> <ns3:type>MD</ns3:type> <ns3:value>CISCO_PRIME</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>ME</ns3:type> <ns3:value>15454-ansi-65-102</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>PTP</ns3:type> <ns3:value>/rack=1/shelf=1/slot=2/port=3</ns3:value> </ns3:rdn> </ns5:name> <ns5:userLabel /> - <ns5:vendorExtensions> <ns22:Cisco_PTP_Line_Rate xmlns:ns22="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_In ventory/v1">LR_Not_Applicable</ns22:Cisco_PTP_Line_Rate> </ns5:vendorExtensions> <ns6:resourceState>UNKNOWN</ns6:resourceState> <ns7:direction>D_BIDIRECTIONAL</ns7:direction> <ns7:isEdgePoint>true</ns7:isEdgePoint> - <ns8:transmissionParametersList> - <ns8:transmissionParameters> <ns8:layerRate>LR_DSR_OC12_STM4</ns8:layerRate> <ns8:parameterList /> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 65 Appendix </ns8:transmissionParameters> - <ns8:transmissionParameters> <ns8:layerRate>LR_PHYSICAL_OPTICAL</ns8:layerRate> - <ns8:parameterList> - <ns2:nvs> <ns2:name>AdminState</ns2:name> <ns2:value>AUTO_IN_SERVICE</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>OperationalState</ns2:name> <ns2:value>OOS-AU, FLT & AINS</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>AlarmReporting</ns2:name> <ns2:value>On</ns2:value> </ns2:nvs> </ns8:parameterList> </ns8:transmissionParameters> </ns8:transmissionParametersList> </ns7:ptp> </ns11:tp> - <ns11:tp> - <ns7:ptp> - <ns5:name> - <ns3:rdn> <ns3:type>HINTS</ns3:type> <ns3:value>TIME:1341895599297;DMLIST:opt://opt:13</ns3:value > </ns3:rdn> - <ns3:rdn> <ns3:type>MD</ns3:type> <ns3:value>CISCO_PRIME</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>ME</ns3:type> <ns3:value>15454-ansi-65-102</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>PTP</ns3:type> <ns3:value>/rack=1/shelf=1/slot=2/port=4</ns3:value> </ns3:rdn> </ns5:name> <ns5:userLabel /> - <ns5:vendorExtensions> <ns22:Cisco_PTP_Line_Rate xmlns:ns22="http://www.cisco.com/mtop/nrf/xsd/Cisco_ME_EQ_In ventory/v1">LR_Not_Applicable</ns22:Cisco_PTP_Line_Rate> </ns5:vendorExtensions> <ns6:resourceState>UNKNOWN</ns6:resourceState> <ns7:direction>D_BIDIRECTIONAL</ns7:direction> <ns7:isEdgePoint>true</ns7:isEdgePoint> - <ns8:transmissionParametersList> - <ns8:transmissionParameters> <ns8:layerRate>LR_DSR_OC12_STM4</ns8:layerRate> <ns8:parameterList /> </ns8:transmissionParameters> - <ns8:transmissionParameters> <ns8:layerRate>LR_PHYSICAL_OPTICAL</ns8:layerRate> - <ns8:parameterList> - <ns2:nvs> <ns2:name>AdminState</ns2:name> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 66 OL-28496-01 Appendix <ns2:value>AUTO_IN_SERVICE</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>OperationalState</ns2:name> <ns2:value>OOS-AU, FLT & AINS</ns2:value> </ns2:nvs> - <ns2:nvs> <ns2:name>AlarmReporting</ns2:name> <ns2:value>On</ns2:value> </ns2:nvs> </ns8:parameterList> </ns8:transmissionParameters> </ns8:transmissionParametersList> </ns7:ptp> </ns11:tp> </ns4:tpList> </ns4:getAllSupportedPhysicalTerminationPointsResponse> </soap:Body> </soap:Envelope> 11.9.3 getFlowDomainFragment SOAP Request - <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:v11="http://www.tmforum.org/mtop/mri/xsd/fdr/v1" xmlns:v12="http://www.tmforum.org/mtop/fmw/xsd/nam/v1"> - <soapenv:Header> <v1:header /> </soapenv:Header> - <soapenv:Body> - <v11:getFlowDomainFragmentRequest> - <!-- Optional: --> - <v11:fdfrRef> - <!-- 1 or more repetitions:--> - <v12:rdn> <v12:type>MD</v12:type> <v12:value>CISCO_PRIME</v12:value> </v12:rdn> - <v12:rdn> <v12:type>FDFR</v12:type> <v12:value>10002@ASR9K-AGG2 -- 10002@ASR9K-DIST2</v12:value> </v12:rdn> </v11:fdfrRef> </v11:getFlowDomainFragmentRequest> </soapenv:Body> </soapenv:Envelope> SOAP Response <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> - <soap:Header> - <header xmlns:ns21="http://www.tmforum.org/mtop/nrf/xsd/fdfrroute/v1" xmlns:ns20="http://www.cisco.com/mtop/nrb/xsd/Cisco_CE_LP/v1" xmlns:ns19="http://www.tmforum.org/mtop/nrf/xsd/cc/v1" xmlns:ns18="http://www.tmforum.org/mtop/nrf/xsd/com/v1" xmlns:ns17="http://www.tmforum.org/mtop/nrf/xsd/fd/v1" Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 67 Appendix xmlns:ns16="http://www.tmforum.org/mtop/nrb/xsd/itu/v1" xmlns:ns15="http://www.tmforum.org/mtop/nrf/xsd/mfd/v1" xmlns:ns14="http://www.tmforum.org/mtop/nrf/xsd/mfdfr/v1" xmlns:ns13="http://www.tmforum.org/mtop/nrb/xsd/lay/v1" xmlns:ns12="http://www.tmforum.org/mtop/rp/xsd/crp/v1" xmlns:ns11="http://www.tmforum.org/mtop/fmw/xsd/msg/v1" xmlns:ns10="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1" xmlns:ns9="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:ns8="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:ns7="http://www.tmforum.org/mtop/nrf/xsd/fdfr/v1" xmlns:ns6="http://www.tmforum.org/mtop/nrb/xsd/cri/v1" xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/coi/v1" xmlns:ns4="http://www.tmforum.org/mtop/mri/xsd/fdr/v1" xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1"> <activityName>getFlowDomainFragment</activityName> <msgName>getFlowDomainFragmentResponse</msgName> <msgType>RESPONSE</msgType> <activityStatus>SUCCESS</activityStatus> <priority>HIGH - modified in NormalizeSoapMsg.processResponse</priority> <communicationPattern>SimpleResponse</communicationPattern> <communicationStyle>RPC</communicationStyle> <timestamp>2012-03-21T15:24:56.190-07:00</timestamp> </header> </soap:Header> - <soap:Body> - <ns4:getFlowDomainFragmentResponse xmlns="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:ns2="http://www.tmforum.org/mtop/fmw/xsd/gen/v1" xmlns:ns3="http://www.tmforum.org/mtop/fmw/xsd/nam/v1" xmlns:ns4="http://www.tmforum.org/mtop/mri/xsd/fdr/v1" xmlns:ns5="http://www.tmforum.org/mtop/fmw/xsd/coi/v1" xmlns:ns6="http://www.tmforum.org/mtop/nrb/xsd/cri/v1" xmlns:ns7="http://www.tmforum.org/mtop/nrf/xsd/fdfr/v1" xmlns:ns8="http://www.tmforum.org/mtop/nrb/xsd/lp/v1" xmlns:ns9="http://www.tmforum.org/mtop/nrf/xsd/tpdata/v1" xmlns:ns10="http://www.tmforum.org/mtop/nrf/xsd/tcp/v1" xmlns:ns11="http://www.tmforum.org/mtop/fmw/xsd/msg/v1" xmlns:ns12="http://www.tmforum.org/mtop/rp/xsd/crp/v1" xmlns:ns13="http://www.tmforum.org/mtop/nrb/xsd/lay/v1" xmlns:ns14="http://www.tmforum.org/mtop/nrf/xsd/mfdfr/v1" xmlns:ns15="http://www.tmforum.org/mtop/nrf/xsd/mfd/v1" xmlns:ns16="http://www.tmforum.org/mtop/nrb/xsd/itu/v1" xmlns:ns17="http://www.tmforum.org/mtop/nrf/xsd/fd/v1" xmlns:ns18="http://www.tmforum.org/mtop/nrf/xsd/com/v1" xmlns:ns19="http://www.tmforum.org/mtop/nrf/xsd/cc/v1" xmlns:ns20="http://www.cisco.com/mtop/nrb/xsd/Cisco_CE_LP/v1" xmlns:ns21="http://www.tmforum.org/mtop/nrf/xsd/fdfrroute/v1"> - <ns4:fdfr> - <ns5:name> - <ns3:rdn> <ns3:type>HINTS</ns3:type> <ns3:value>TIME:1332368697115;DMLIST:net://net:6</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>MD</ns3:type> <ns3:value>CISCO_PRIME</ns3:value> </ns3:rdn> - <ns3:rdn> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 68 OL-28496-01 Appendix <ns3:type>FDFR</ns3:type> <ns3:value>10002@ASR9K-AGG2 -- 10002@ASR9K-DIST2</ns3:value> </ns3:rdn> </ns5:name> <ns5:discoveredName>10002@ASR9K-AGG2 -- 10002@ASR9KDIST2</ns5:discoveredName> <ns7:direction>CD_BI</ns7:direction> - <ns8:transmissionParameters> <ns8:layerRate>Cisco_LR_EVC</ns8:layerRate> - <ns8:vendorExtensions> <ns20:Cisco_EVC_PWEdge_Name>10002@ASR9K-AGG2 -- 10002@ASR9KDIST2</ns20:Cisco_EVC_PWEdge_Name> </ns8:vendorExtensions> </ns8:transmissionParameters> - <ns7:aEndTpDataList> - <ns9:tpData> - <ns9:tpRef> - <ns3:rdn> <ns3:type>HINTS</ns3:type> <ns3:value>TIME:1332368697116;DMLIST:net://net:6</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>MD</ns3:type> <ns3:value>CISCO_PRIME</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>ME</ns3:type> <ns3:value>ASR9K-DIST2</ns3:value> </ns3:rdn> - <ns3:rdn> <ns3:type>CTP</ns3:type> <ns3:value>TenGigE0/0/0/0 EFP: 21</ns3:value> </ns3:rdn> </ns9:tpRef> <ns9:tpMappingMode>TM_NA</ns9:tpMappingMode> - <ns8:transmissionParametersList> - <ns8:transmissionParameters> <ns8:layerRate>Cisco_LR_EVC</ns8:layerRate> - <ns8:vendorExtensions> <ns20:Cisco_EFP_Administration_State>UNLOCKED</ns20:Cisco_ EFP_Administration_State> <ns20:Cisco_EFP_Operational_State>WORKING</ns20:Cisco_EFP_ Operational_State> <ns20:Cisco_EFP_isExactTag>false</ns20:Cisco_EFP_isExactTa g> <ns20:Cisco_EFP_outerVlanTpId>IEEE802.1Q</ns20:Cisco_EFP_o uterVlanTpId> <ns20:Cisco_EFP_SVID>21</ns20:Cisco_EFP_SVID> <ns20:Cisco_EFP_innerVlanTpId /> <ns20:Cisco_EFP_CVID /> <ns20:Cisco_EFP_Description /> </ns8:vendorExtensions> </ns8:transmissionParameters> </ns8:transmissionParametersList> </ns9:tpData> </ns7:aEndTpDataList> <ns7:zEndTpDataList /> <ns7:isFlexible>true</ns7:isFlexible> <ns7:administrativeState>LOCKED</ns7:administrativeState> <ns7:fdfrState>SNCS_NONEXISTENT</ns7:fdfrState> Cisco Prime OSS Integration Guide for MTOSI and 3GPP OL-28496-01 69 Appendix <ns7:fdfrType>FDFRT_POINT_TO_POINT</ns7:fdfrType> </ns4:fdfr> </ns4:getFlowDomainFragmentResponse> </soap:Body> </soap:Envelope> Cisco Prime OSS Integration Guide for MTOSI and 3GPP 70 OL-28496-01