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”

• Additional information:

– 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.

Related Documentation

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:

• Cisco Prime Central 2.0
• Cisco Prime Network 5.0
• Cisco Prime Optical 10.7
• Cisco Prime Performance Manager 1.7

Additional Information

• For Tomcat web server:

http://jakarta.apache.org/tomcat/index.html

• For SOAP plug-in:

– http://xml.apache.org/soap/

• For XML and XML Schema

– http://www.w3.org/XML

– http://www.w3.org/TR/xmlschema-0/

• For events and notifications through the CIM event model

http://www.dmtf.org/standards/documents/CIM/DSP0107.pdf

• For CIM Objects over HTTP, DMTF

http://www.dmtf.org/standards/documents/WBEM/DSP200.html

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation.

To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the  What’s New in Cisco Product Documentation RSS feed. The RSS feeds are a free service.