Cisco IP Solution Center API Programmer Guide, 5.1 - About This Guide [Cisco IP Solution Center]

Table Of Contents

About This Guide

Who Should Use This Book

How This Book Is Organized

Related Documentation

Additional Information

Obtaining Documentation, Obtaining Support, and Security Guidelines

About This Guide

The Cisco IP Solution Center API Programmer Guide describes APIs that are available to third party Operations Support System (OSS) products. The ISC API provides a mechanism for inserting, retrieving, updating, and removing data from the ISC servers using an eXtensible Markup Language (XML) interface.

This preface contains the following sections:

•Who Should Use This Book

•How This Book Is Organized

•Related Documentation

•Additional Information

•Obtaining Documentation, Obtaining Support, and Security Guidelines

Who Should Use This Book

This guide is intended to be a technical resource for application developers who want to use the ISC API 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 IP Solution Center (ISC) 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 ISC 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 ISC API fundamentals.

–Chapter 1, "Introduction to the ISC API," describes the fundamental concepts for using the XML API, and includes the API model, components, and operations.

–Chapter 2, "Getting Started," describes the steps required to log into the API, and the basic steps for creating inventory, service requests, and service policies.

–Chapter 3, "Common APIs," describes the APIs for operations that are common to all ISC services.

–Chapter 4, "Using Templates," describes ISC templates and how to use them to download configurations and use them in a service request.

–Chapter 5, "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 ISC API.

–Chapter 6, "MPLS Provisioning."

–Chapter 7, "L2VPN Provisioning."

–Chapter 8, "VPLS Provisioning."

–Chapter 9, "FlexUNI/EVC 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 ISC, and lists all events that can be collected for notification.

–Appendix C, "Scripts," provides the list of scripts available with the ISC software application.

Related Documentation

The entire documentation set for Cisco IP Solution Center, 5.1 can be accessed at:

http://www.cisco.com/en/US/products/sw/netmgtsw/ps4748/
tsd_products_support_series_home.html

Tip To cut and paste a two-line URL into the address field of your browser, you must cut and paste each line separately to get the entire URL without a break.

The following documents comprise the ISC 5.1 documentation set.

General documentation (in suggested reading order)

•Cisco IP Solution Center Getting Started and Documentation Guide, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/roadmap/docguide.html

•Release Notes for Cisco IP Solution Center, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/release/notes/relnotes.html

•Cisco IP Solution Center Installation Guide, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/installation/guide/
installation.html

•Cisco IP Solution Center Infrastructure Reference, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/infrastructure/reference/
guide/infrastructure.html

•Cisco IP Solution Center System Error Messages, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/system/messages/
messages.html

Application and technology documentation (listed alphabetically)

•Cisco IP Solution Center Carrier Ethernet and L2VPN User Guide, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/carrier_ethernet/user/guide/
l2vpn51book.html

•Cisco IP Solution Center MPLS VPN User Guide, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/mpls_vpn/user/guide/
mpls51book.html

•Cisco IP Solution Center Traffic Engineering Management User Guide, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/traffic_management/user/
guide/tem.html

•Cisco MPLS Diagnostics Expert 2.1 Failure Scenarios Guide on ISC 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/mpls_failure_scenarios/user/
guide/mdefs.html

•Cisco MPLS Diagnostics Expert 2.1.3 User Guide on ISC 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/mpls_diagnostics/user/guide/
mdeuser.html

API Documentation

•Cisco IP Solution Center API Programmer Guide, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/developer/guide/
api-gd.html

•Cisco IP Solution Center API Programmer Reference, 5.1.

http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/developer/reference/
xmlapi.zip

Note All documentation might be upgraded over time. All upgraded documentation will be available at the same URLs specified in this document.

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, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, 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

	Cisco IP Solution Center API Programmer Guide, 5.1
	About This Guide
Cisco IP Solution Center API Programmer Guide, 5.1 Index About This Guide Introduction to the ISC API Getting Started Common APIs Using Templates Monitoring APIs MPLS Provisioning L2VPN Provisioning VPLS Provisioning FlexUNI/EVC Provisioning GUI to API Mapping Implementing a Notification Server Scripts	Download this chapter About This Guide Download the complete book Cisco IP Solution Center API Programmer Guide, 5.1 - Full-length PDF (PDF - 4 MB) Table Of Contents About This Guide Who Should Use This Book How This Book Is Organized Related Documentation Additional Information Obtaining Documentation, Obtaining Support, and Security Guidelines About This Guide The Cisco IP Solution Center API Programmer Guide describes APIs that are available to third party Operations Support System (OSS) products. The ISC API provides a mechanism for inserting, retrieving, updating, and removing data from the ISC servers using an eXtensible Markup Language (XML) interface. This preface contains the following sections: •Who Should Use This Book •How This Book Is Organized •Related Documentation •Additional Information •Obtaining Documentation, Obtaining Support, and Security Guidelines Who Should Use This Book This guide is intended to be a technical resource for application developers who want to use the ISC API 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 IP Solution Center (ISC) 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 ISC 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 ISC API fundamentals. –Chapter 1, "Introduction to the ISC API," describes the fundamental concepts for using the XML API, and includes the API model, components, and operations. –Chapter 2, "Getting Started," describes the steps required to log into the API, and the basic steps for creating inventory, service requests, and service policies. –Chapter 3, "Common APIs," describes the APIs for operations that are common to all ISC services. –Chapter 4, "Using Templates," describes ISC templates and how to use them to download configurations and use them in a service request. –Chapter 5, "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 ISC API. –Chapter 6, "MPLS Provisioning." –Chapter 7, "L2VPN Provisioning." –Chapter 8, "VPLS Provisioning." –Chapter 9, "FlexUNI/EVC 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 ISC, and lists all events that can be collected for notification. –Appendix C, "Scripts," provides the list of scripts available with the ISC software application. Related Documentation The entire documentation set for Cisco IP Solution Center, 5.1 can be accessed at: http://www.cisco.com/en/US/products/sw/netmgtsw/ps4748/ tsd_products_support_series_home.html Tip To cut and paste a two-line URL into the address field of your browser, you must cut and paste each line separately to get the entire URL without a break. The following documents comprise the ISC 5.1 documentation set. General documentation (in suggested reading order) •Cisco IP Solution Center Getting Started and Documentation Guide, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/roadmap/docguide.html •Release Notes for Cisco IP Solution Center, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/release/notes/relnotes.html •Cisco IP Solution Center Installation Guide, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/installation/guide/ installation.html •Cisco IP Solution Center Infrastructure Reference, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/infrastructure/reference/ guide/infrastructure.html •Cisco IP Solution Center System Error Messages, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/system/messages/ messages.html Application and technology documentation (listed alphabetically) •Cisco IP Solution Center Carrier Ethernet and L2VPN User Guide, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/carrier_ethernet/user/guide/ l2vpn51book.html •Cisco IP Solution Center MPLS VPN User Guide, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/mpls_vpn/user/guide/ mpls51book.html •Cisco IP Solution Center Traffic Engineering Management User Guide, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/traffic_management/user/ guide/tem.html •Cisco MPLS Diagnostics Expert 2.1 Failure Scenarios Guide on ISC 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/mpls_failure_scenarios/user/ guide/mdefs.html •Cisco MPLS Diagnostics Expert 2.1.3 User Guide on ISC 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/mpls_diagnostics/user/guide/ mdeuser.html API Documentation •Cisco IP Solution Center API Programmer Guide, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/developer/guide/ api-gd.html •Cisco IP Solution Center API Programmer Reference, 5.1. http://www.cisco.com/en/US/docs/net_mgmt/ip_solution_center/5.1/developer/reference/ xmlapi.zip Note All documentation might be upgraded over time. All upgraded documentation will be available at the same URLs specified in this document. 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, Obtaining Support, and Security Guidelines For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, 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
	© 1992-2009 Cisco Systems, Inc. All rights reserved. Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks of Cisco Systems, Inc.