Developer's GuideTable of ContentsTable of Contents31 Overview52 Managed Elements and Equipment Inventory52.1 WSDL Endpoints:53 Ethernet Virtual Connection Resource Inventory103.1 WSDL Endpoint:104 Data Center Resource Inventory114.1 WSDL Endpoint:115 MPLS VPN Resource Inventory145.1 SOAP Endpoints:146 Customer and Service Management166.1 WSDL Endpoints:167 Alarm Management187.1 AlarmMgmtAPI187.1.1 Operations187.2 AlarmRetrievalAPI197.2.1 Operations197.3 AlarmFmQueryAPI197.3.1 Operations198 Group Management208.1 GroupMgmtAPI208.1.1 Operations209 CAS SSO Client API219.1 PrimeCasClient219.1.1 com.cisco.prime.sso.client.PrimeCasClient219.2 PrimeClientService239.2.1 com.cisco.prime.sso.client.PrimeClientService239.3 SuiteInfo249.3.1 com.cisco.prime.sso.client.util Class SuiteInfojava.lang.Object249.4 SuiteSession259.4.1 com.cisco.prime.sso.client Class SuiteSessionjava.lang.Object2510 3GPP OSS Integration2511 Appendix2611.1 Managed Elements and Equipment Inventory - Request and Response Examples2611.1.1 ManagedElementRetrieval_RPC2611.1.1.1 getAllManagedElements2611.1.1.1.1 RequestResponse-getAllManagedElements2611.1.1.2 getManagedElementsIterator3111.1.1.2.1 RequestResponse-getManagedElementsIterator3111.1.1.3 getAllManagedElementsPassingFilter3511.1.1.3.1 RequestResponse-getAllManagedElementsPassingFilter3511.1.1.4 getManagedElement3811.1.1.4.1 RequestResponse-getManagedElement3811.1.2 getAllManagedElementNames_RPC4011.1.2.1 getAllManagedElementNames4011.1.2.1.1 RequestResponse-getAllManagedElementNames4011.1.2.2 getAllManagedElementNamesIterator4211.1.2.2.1 RequestResponse-getAllManagedElementNamesIterator4211.1.3 getAllManagedElementNamesTS_RPC4311.1.3.1 getAllManagedElementNamesTS4311.1.3.1.1 RequestResponse-getAllManagedElementNamesTS4311.1.4 EquipmentRetrieval_RPC4511.1.4.1 getAllEquipment4511.1.4.1.1 RequestResponse-getAllEquipment4511.1.4.2 getEquipment5511.1.4.2.1 RequestResponse-getEquipment5511.1.4.3 getContainedEquipment5811.1.4.3.1 RequestResponse-getContainedEquipment5811.1.4.4 getEquipmentIterator6011.1.4.4.1 RequestResponse-getEquipmentIterator6011.1.4.5 getAllRemoteEquipmentByPTP7211.1.4.5.1 RequestResponse-getAllRemoteEquipmentByPTP7211.1.5 TerminationPointRetrieval_RPC9911.1.5.1 getAllSupportedPhysicalTerminationPoints9911.1.5.1.1 RequestResponse-getAllSupportedPhysicalTerminationPoints9911.1.5.2 getTerminationPoint10211.1.5.2.1 RequestResponse-getTerminationPoint10211.1.6 NotificationProducer10511.1.6.1 Subscribe10511.1.6.1.1 RequestResponse-Subscribe10511.2 Ethernet Virtual Connection Resource Inventory - Request and Response Examples11311.2.1 FlowDomainRetrievalRPC11311.2.1.1 getAllFlowDomainFragmentNames11311.2.1.1.1 RequestResponse-getAllFlowDomainFragmentNames11311.2.1.2 getFlowDomainFragment12211.2.1.2.1 RequestResponse-getFlowDomainFragment12211.2.1.3 getFlowDomainFragmentRoute12511.2.1.3.1 RequestResponse-getFlowDomainFragmentRoute12511.3 Data Center Resource Inventory - Request and Response Examples12811.3.1 ResourceInventoryRetrieval_RPC12811.3.1.1 getInventoryDC12811.3.1.1.1 RequestResponse-getInventoryDC12811.3.2 ResourceInventoryRetrieval_RPC13211.3.2.1 getInventoryDataStore13211.3.2.1.1 RequestResponse-getInventoryDataStore13211.3.3 ResourceInventoryRetrieval_RPC13711.3.3.1 getInventoryHost13711.3.3.1.1 RequestResponse-getInventoryHost13711.3.4 ResourceInventoryRetrieval_RPC18211.3.4.1 getInventoryHostCluster18211.3.4.1.1 RequestResponse-getInventoryHostCluster18211.3.5 ResourceInventoryRetrieval_RPC18711.3.5.1 getInventoryHost18711.3.5.1.1 RequestResponse-getInventoryVM18711.4 MPLS VPN Resource Inventory - Request and Response Examples19511.4.1 ConnectionRetrievalRPC- Request and Response Examples19511.4.1.1 getInventorySncNames19511.4.1.1.1 RequestResponse-getInventorySNCNames19511.4.1.2 getSubnetworkConnection19611.4.1.2.1 RequestResponse-getSubnetworkConnection19611.4.1.3 getSubnetworkConnectionRoute20011.4.1.3.1 RequestResponse-getSubnetworkConnectionRoute20011.5 Customer and Service Management - Request and Response Examples20311.5.1 CiscoCustomerProvision_RPC - Request and Response Examples20311.5.1.1 createCustomer20311.5.1.1.1 Request-createCustomer20311.5.1.1.2 Response-createCustomer20411.5.1.2 getAllCustomerIDs20511.5.1.2.1 Request-getAllCustomerIDs20511.5.1.2.2 Response-getAllCustomerIDs20511.5.1.3 getAllCustomers20711.5.1.3.1 Request-getAllCustomers20711.5.1.3.2 Response-getAllCustomers20811.5.1.4 getCustomer21111.5.1.4.1 Request-getCustomer21111.5.1.4.2 Response-getCustomer21111.5.1.5 modifyCustomer21311.5.1.5.1 Request-modifyCustomer21311.5.1.5.2 Response-modifyCustomer21411.5.1.6 deleteCustomer21511.5.1.6.1 Request-deleteCustomer21511.5.1.6.2 Response-deleteCustomer21611.5.2 ServiceInventoryRetrieval_RPC - Request and Response Examples21611.5.2.1 getServiceInventory21611.5.2.1.1 Request-getServiceInventory21711.5.2.1.2 Response-getServiceInventory21711.5.3 ServiceActivationInterface - Request and Response Examples21911.5.3.1 Provision21911.5.3.1.1 Request-provision21911.5.3.1.2 Response-provision22111.5.3.2 Modify22211.5.3.2.1 Request-modify22211.5.3.2.2 Response-modify22311.5.3.3 Terminate22511.5.3.3.1 Request-terminate22511.5.3.3.2 Response-terminate22611.6 Alarm Management - Request and Response Examples22811.6.1 AlarmMgmtAPI - Request and Response Examples22811.6.1.1 acknowledgeAlarm22811.6.1.1.1 Request-acknowledgeAlarm22811.6.1.1.2 Response-acknowledgeAlarm22811.6.1.2 deAcknowledgeAlarm22811.6.1.2.1 Request-deAcknowledgeAlarm22811.6.1.2.2 Response-deAcknowledgeAlarm22911.6.1.3 clearAlarm22911.6.1.3.1 Request-clearAlarm22911.6.1.3.2 Response-clearAlarm22911.6.1.4 retireAlarm23011.6.1.4.1 Request-retireAlarm23011.6.1.4.2 Response-RetireAlarm23011.6.1.5 addNoteToAlarm23011.6.1.5.1 Request-addNoteToAlarm23011.6.1.5.2 Response-addNoteToAlarm23111.6.2 AlarmRetrievalAPI - Request and Response Examples23111.6.2.1 getSubtendingEvents23111.6.2.1.1 Request-getSubtendingEvents23111.6.2.1.2 Response-getSubtendingEvents23111.6.3 AlarmFmQueryAPI - Request and Response Examples23211.6.3.1 getActiveAlarmCounts23211.6.3.1.1 Request-getActiveAlarmCounts23211.6.3.1.2 Response-getActiveAlarmCounts23311.6.3.2 getActiveAlarmIds23411.6.3.2.1 Request-getActiveAlarmIds23411.6.3.2.2 Response-getActiveAlarmIds23411.6.3.3 getAlarmDetail23511.6.3.3.1 Request-getAlarmDetail23511.6.3.3.2 Response-getAlarmDetail23511.6.3.4 getAlarmDetails23611.6.3.4.1 Request-getAlarmDetails23611.6.3.4.2 Response-getAlarmDetails237Size: 2.01 MBPages: 253Language: EnglishOpen manual
Developer's GuideTable of ContentsList Of Tables7Preface8Conventions9Additional User Documentation10Obtaining Documentation, Obtaining Support, and Security Guidelines11Prime Network Integration Layer12Standalone Mode12Suite Mode13Technologies143GPP OSS Integration15Supported Devices for 3GPP Interface153GPPIntegration Reference Point (IRP)163GPP Interfaces and supported APIs16Overview of 3GPP Inventory Management17Physical Inventory17Logical Inventory173GPP Inventory IRP InterfaceDetails18InventoryIRP:: getAllInventory18InventoryIRP:: getAllManagedElementNames21InventoryIRP:: getManagedElement22InventoryIRP:: getStatus24InventoryIRP:: getActiveOperations25Overview of 3GPP File Transfer IRP263GPP File Transfer IRP Interface Details27File Transfer IRP::listAvailableFiles27Overview of 3GPP Alarm IRP313GPP Alarm IRP Interface Details31AlarmIRP::GetAlarmList31Alarm IRP::acknowledgeAlarms35AlarmIRP::unacknowledgeAlarms38AlarmIRP::SetComment41AlarmIRP::clearAlarms44AlarmIRP:: notifyNewAlarm47AlarmIRP:: notifyAckStateChanged48AlarmIRP:: notifyClearedAlarm49AlarmIRP:: notifyUpdateAlarm50Overview of 3GPP Notification IRP513GPP Notification IRP Details51Notification IRP::subscribe52Notification IRP::unsubscribe54Notification IRP::getSubscriptionIds56Notification IRP:: getNotificationCategories563GPP FT Notification Consumer57Overview of 3GPP Notifications573GPP File Ready Notification573GPP File Preparation Error Notification583GPP FT Notification Multi-DM Behavior58Overview of Communication Surveillance IRP (CS IRP)593GPP Communication Surveillance IRP Interface Details59CSIRP::getHeartbeatPeriod59CSIRP::setHeartbeatPeriod60CSIRP::notifyHeartbeat61Scheduling Web Services613GPP Standard Compliance62Trouble Shooting – 3GPP62MTOSI OSS Integration65Supported Devices for MTOSI Interface65MTOSI Interface and supported APIs65MTOSI API Summary66MTOSI Inventory Management70MTOSI Interface Details70Managed Element Retrieval Interface70Managed Element Names Retrieval Interface72Equipment Inventory Interface73Physical TerminationPoint Retrieval Interface76Resource Inventory Retrieval Interface77Connection Retrieval Interface78Flow Domain Retrieval Interface80Ethernet Virtual Circuit81Flow Domain Retrieval APIs82DataCenter83List of all available data center names83List of all available Host name from a particular Data center84Details of a particular host84List of available Host cluster Name from a particular Data Center86Detail information of a Host cluster86List of Data Store Name87Detailed information of a particular Data Store.87List of available Virtual machine ID88Detailed information of a particular data store89L3 MPLS VPN90Retrieving list of configured L3 MPLS-VPN names90Retrieving details of a VPN91Retrieving route details91Floating Termination Point92Retrieving details of all available port channels in a device92Gigabit Passive Optical Network93List of all available GPON remote unit(ONU) details94Physical Termination Point Retrieval Interface96List of all supportedPTP of a Remote Unit(ONU)96Inventory Notification100Delta Inventory Management115Managed Element Names Retrieval Interface details115MTOSI Standard Compliance117Trouble Shooting - MTOSI11710 Cisco Specific Interfaces118Cisco Specific Interfaces and supported APIs118Alarm Life Cycle Management119AlarmMgmt::Acknowlege119AlarmMgmt::De-Acknowlege120AlarmMgmt::Clear122AlarmMgmt::Retire123AlarmMgmt::Add Note124Alarm Retrieval125AlarmRetrieval::getsubtendingEvents126Trouble Shooting – Cisco Specific Interfaces12811 Appendix I – References to WSDL Documents1293GPP WSDL Documents1293GPP Inventory WSDL1293GPP FT IRP WSDL1293GPP Alarm IRP WSDL1293GPP Notification IRP WSDL1303GPP Notification Consumer WSDL1303GPP CS IRP WSDL130MTOSI WSDL Documents131Managed Element Retrieval WSDL131Managed Element Names Retrieval WSDL131Equipment Inventory Retrieval WSDL132Termination Point Retrieval WSDL132Resource Inventory Retrieval WSDL132Connection Retrieval WSDL132Ethernet Virtual Connection (EVC) Resource Retrieval WSDL132Cisco Specific Extensions WSDL Documents133Alarm Life Cycle Management WSDL133Alarm Retrieval Management WSDL13312 Appendix II – 3GPP-Miscellaneous1343GPP inventoryNrm Schema File1343GPP Inventory File1383GPP Inventory File Contents1383GPP Detailed Inventory Information167Physical Inventory attributes168Logical Inventory attributes1713GPP Status File209Status File Name209Status File Contents2093GPP Notifications211File Ready Notification211File Preparation Error Notification212New Alarm Notification212Ack State Changed Notification214Cleared Alarm Notification215Heartbeat Notification216FTP Configuration217Useful Code Snippets for 3GPP217Useful Code Snippets for 3GPP Request Response217Useful Code Snippets for 3GPP Notification Consumer21913 References221Table 6-1 Technologies to Facilitate the OSS Integration14Table 7-1: Supported Devices for 3GPP and MTOSI15Table 7-2: Functional Area Supported by 3GPP17Table 7-3: 3GPP Interfaces Names18Table 7-4: Input Parameters to Retreive Physical and Logical Inventory Information19Table 7-5: input Paramters to Retreive List of Managed Elements21Table 7-6: Input Parameters to Retreive Specific Managed Element23Table 7-7: Input Paramters to acknowledge a list of Alarms35Table 7-8: Input Paramters to unacknowledge a list of Alarms38Table 7-9: Input Paramters to add comment to a list of Alarms41Table 7-10: Input Paramters to clear a list of Alarms44Table 7-11 OSS Integration Problems and Troubleshooting Procedure62Table 8-1: Supported Devices for 3GPP and MTOSI65Table 8-2: Supported APIs for Managed Elements, Equipment Inventory67Table 8-3: APIs for Retreiving EVC82Table 8-4: OSS Integration Problems and Troubleshooting Procedure117Interfaces128Table 11-1: Physical Inventory Attributes for Managed Element168Table 11-2: Physical Inventory Attribute for Chassis168Table 11-3: Physical Inventory Attribute for Card169Table 11-4: Physical Inventory Attribute for Slot169Table 11-5: Physical Inventory Attribute for Port170Table 11-6: Physical Inventory Attribute for Sub-port170Table 11-7: Physical Inventory Attribute for Power170Table 11-8: Physical Inventory Attribute for Fan171Table 11-9: Logical Attribute for PGW175Table 11-10: Logical Attribute for SGW176Table 11-11: Logical Attribute for APN177Table 11-12: Logical Attribute for SAEGW180Table 11-13: Logical Attribute for GGSN182Table 11-14: Logical Attribute for ACS184Table 11-15: Attribute for AAA Group192Table 11-16: Attribute for AAADiameterEndpoint196Table 11-17: Attribute for GTPP198Table 11-18: Attribute for OperatorPolicy201Table 11-19: Logical Attribute for SGSN202Table 11-20: Logical Attribute for MME206Size: 10.7 MBPages: 221Language: EnglishOpen manual
Installation GuideTable of ContentsCisco Prime Central 1.5.1 Quick Start Guide1Cisco Prime Central 1.5.1 Quick Start Guide2Preface2Related Documentation2Obtaining Documentation and Submitting a Service Request2Installation Requirements3Prime Central Server Requirements3Additional Requirements6Installed Red Hat RPM Packages7Prime Central Protocols and Ports8Port Exposure Categories11Sample Remediation Policy Script12Embedded Database Requirements13Database Memory15Ports and Files15Dual-Server Installation16Security16Prime Central Client Browser Requirements17Supported Client JRE Versions17Component Version Requirements17Prime Central 1.5.1 Image (Electronic Copy) Signature Verification17Extracting the 1.5.1 Image18Installing Prime Central19Installing Prime Central in a Single-Server Setup19Preparing the Server for Installation20Installing Prime Central on the Server21Explanation of Fields in the Embedded DB Information Window22Installing Prime Central in a Dual-Server Setup23Preparing Both Servers for Installation23Installing the Prime Central Portal25Installing the Prime Central Integration Layer26Pathname, Group Name, Username, and Password Constraints27Verifying the Prime Central Installation29Checking the Prime Central Version30Installing Prime Central Silently30Sample install.properties Files31Example 1: Installing Prime Central in a Single-Server Setup with a Local Embedded Database31Example 2: Installing Prime Central in a Single-Server Setup with a Remote Embedded Database32Example 3: Installing Prime Central in a Single-Server Setup with an External Database33Example 4: Installing the Prime Central Portal in a Dual-Server Setup with a Local Embedded Database34Example 5: Installing the Prime Central Portal in a Dual-Server Setup with a Remote Embedded Database36Example 6: Installing the Prime Central Portal in a Dual-Server Setup with an External Database37Example 7: Installing the Prime Central Integration Layer in a Dual-Server Setup38Verifying the Silent Installation39Installing Prime Central Fault Management39Preparing the Server for Installation39Installing Prime Central Fault Management on the Server41Configuring Mail Service for Alarm Reports42Installing Prime Central Fault Management Silently43Sample PrimeFM_install.properties File44Manually Registering Fault Management to Retrieve Alarm Data45Installing the Gateways Used with Prime Central45Troubleshooting the Installation46Prime Central Log Files47Troubleshooting the Prime Central Installation48Configuring Prime Carrier Management Suite Scale Setup54Configuring Applications as Suite Components55Integration Process55Contents of the DMIntegrator.prop File56DMIntegrator.sh Script Usage57Integrating Cisco InTracer with Prime Central57Integrating Prime Network with Prime Central58Integrating the Prime Network Integration Layer with Prime Central59Integrating Prime Network in a High Availability Configuration with Prime Central60Integrating the Prime Network Integration Layer in a High Availability Configuration with Prime Central61Local Redundancy Configuration61Geographical Disaster Recovery Configuration62Configuring the Primary Server62Configuring the Geographical Disaster Recovery Server62Integrating Prime Optical and the Prime Optical Integration Layer with Prime Central63Integrating Prime Performance Manager with Prime Central64Integrating Prime Provisioning with Prime Central66Integrating Cisco ME 4600 Series Agora-NG with Prime Central67Integrating Cisco Broadband Access Center (BAC) with Prime Central67Integrating RAN Management System (RMS) with Prime Central67Integrating Cisco Prime Access Registrar (CPAR) with Prime Central68Configuring Prime Central as Trap Listener in CPAR to Receive Traps68Integrating Cisco Prime Network Registrar (CPNR) with Prime Central69Configuring Prime Central as Trap Listener in CPNR to Receive Traps69Integrating SpiderNet with Prime Central70Configuring Prime Central as Trap Listener in SpiderNet to Receive Traps70Upgrading Prime Central71Before You Begin71Upgrading to Prime Central 1.5.172Upgrading Prime Central Silently74Verifying the Upgrade75Rollback for Prime Central and Embedded Oracle Database75Rollback Procedure if Upgrade Fails with Error Code 776Rollback Procedure if Upgrade Fails with Error Code 877Rollback Procedure if Upgrade Fails with Error Code 977Rollback Procedure for Prime Central with External Oracle Database78Rollback Procedure for Prime Central on Distributed IL Server79Upgrading to Prime Central Fault Management 1.5.179Upgrading Prime Central Fault Management Silently81Reverting to Prime Central Fault Management 1.581Uninstalling Prime Central83Uninstalling Prime Central in an Embedded Database Configuration83Uninstalling Prime Central in an External Database Configuration84Uninstalling Prime Central Silently85Uninstalling Prime Central Fault Management85Uninstalling Prime Central Fault Management Silently86Unregistering an Application from Prime Central86Unregistering Cisco InTracer87Unregistering Prime Network88Unregistering the Prime Network Integration Layer89Unregistering Prime Optical90Unregistering the Prime Optical Integration Layer91Unregistering Prime Performance Manager91Unregistering Prime Provisioning92Unregistering Cisco ME 4600 Series Agora-NG92Unregistering Cisco BAC93Unregistering RMS from Prime Central93Disabling SNMP Traps Notification to Prime Central NMS Interface93Cleaning Up Files On Central Node94Unregistering RMS Data Manager from Prime Central94Unregistering Cisco Prime Access Registrar (CPAR) from Prime Central95Unregistering Cisco Prime Network Registrar (CPNR) from Prime Central95Unregistering SpiderNet from Prime Central96Next Steps96Starting and Stopping the Prime Central Components96Backing Up and Restoring the Embedded Database97Backing Up and Restoring the Fault Management Database98Backing Up the Fault Management Database Manually98Restoring the Fault Management Database Manually99Size: 2.16 MBPages: 101Language: EnglishOpen manual
