The Cisco Prime Provisioning API Programmer Guide describes APIs that are available to third party Operations Support System (OSS) products. The Prime Provisioning API provides a mechanism for inserting, retrieving, updating, and removing data from the Prime Provisioning servers using an eXtensible Markup Language (XML) interface.
This preface contains the following sections:
Note Prime Provisioning can be used as a standalone product or as part of the Prime Carrier Management Suite. When installed as part of the suite, you can launch Prime Provisioning from the Prime Central portal. For more information about Prime Central, see the documentation for Cisco Prime Central.
Who Should Use This Book
This guide is intended to be a technical resource for application developers who want to use the Prime Provisioning APIs to provision network services.
You should have an advanced level of understanding of Internet network design, operation, and terminology, be familiar with Cisco Internetwork Operating System (IOS) software and its commands, and have a basic understanding of the Cisco Prime Provisioning product.
Service provider developers that use the API should also have an understanding of a high-level programming language such as Java, or an equivalent language. Additionally, we recommend that you have knowledge of the following:
- Hypertext Transport Protocol (HTTP/HTTPS)
- Socket programming
- XML and XML Schema
You should be familiar with the Prime Provisioning GUI and how to use it to provision your network. In most cases, API operations correlate to GUI operations. See Appendix A, “GUI to API Mapping,” for more information.
How This Book Is Organized
This programmer guide is organized as follows:
- These chapters describe the Prime Provisioning API fundamentals.
– “Introduction to the Prime Provisioning API,” describes the fundamental concepts for using the API XML, and includes the API model, components, and operations.
– “Getting Started,” describes the steps required to log into the API, and the basic steps for creating inventory, service requests, and service policies.
– “Common APIs,” describes the APIs for operations that are common to all Prime Provisioning services.
– “Using Templates,” describes Prime Provisioning templates and how to use them to download configurations and use them in a service request.
– “Monitoring APIs,” describes how to use the API to monitor services and create reports.
- These chapters describe the concepts for each service and provide a provisioning example, which includes the steps required to provision the services using the Prime Provisioning APIs.
– Chapter 6, “MPLS Provisioning”
– Chapter 7, “L2VPN Provisioning”
– Chapter 8, “VPLS Provisioning”
– Chapter 9, “EVC Provisioning”
– Chapter10, “Traffic Engineering Management Provisioning”
– Chapter 11, “RAN Backhaul Provisioning”
– Chapter 12, “MPLS Transport Profile Provisioning”
– Appendix A, “GUI to API Mapping,” maps the GUI operations to the corresponding APIs.
– Appendix B, “Implementing a Notification Server,” provides an example for implementing a servlet to receive notification events from Prime Provisioning, and lists all events that can be collected for notification.
– Appendix C, “Scripts,” provides the list of scripts available with the Prime Provisioning software application.
– Appendix D, “Prime Provisioning XDE SDK,” Gives an overview of the XDE SDK, how to install it, and how to use it to extend the functionality of Prime Provisioning.
See the Cisco Prime Provisioning Documentation Overview for a list of all Prime Provisioning guides.
We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates. Other Cisco Prime Product Documentation
If you are deploying Prime Provisioning as part of the Prime Carrier Management suite, then see also the documentation for the other suite components:
- For events and notifications through the CIM event model
- For CIM Objects over HTTP, DMTF