|
|
The Cisco VPN Solutions Center: MPLS Solution API Programmer Guide describes the programmatic concepts that are supported by the accompanying CORBA IDL-based application programming interfaces (APIs) supplied with the Cisco VPN Solutions Center: MPLS Solution software. With these APIs, you can add MPLS Solution features to third-party network-management software.
 |
Note This book supplies a generic—that is, not language-specific—description of how to use the API features to address the API-related concepts when implementing MPLS VPN Solution features in third-party source code. |
For API reference information, see the Cisco VPN Solutions Center: MPLS Solution API Programmer Reference. For information about installation and general use of the software, see the Cisco VPN Solutions Center: MPLS Solution User Guide and User Reference.
The Cisco VPN Solutions Center: MPLS Solution API Programmer Guide is a technical resource for programmers. Use of the APIs that this book supports requires familiarity with the Common Object Request Broker Architecture (CORBA) and the Interface Definition Language (IDL) as defined by the OMG (Object Management Group). CORBA and the IDL information is available from the OMG web site at www.omg.org .
This book does not supply the prerequisite information to assist you in building the necessary comprehension of the MPLS technology and how the VPN Solutions Center software uses it. A thorough basic understanding of this technology is necessary before beginning client-application development using the APIs. For information to help you build this foundation, see the Cisco VPN Solutions Center: MPLS Solution Provisioning and Operations Guide.
This API Programmer Guide is organized as follows:
"Getting Started using the CORBA APIs,"describes the basic CORBA requirements and details about how to connect to the VPN Solutions Center servers.
"Quick Start: VPN Service Model," describes for previous API users the basic flow for using the VPN Service Model (VSM) to define VSM objects and construct services requests to implement a VPN service.
"Overview: VPN Service Model,"describes the VPN Service Model and describes the object relationships that comprise it.
"VSM Object Management,"describes the object-management process for each of the VSM objects.
"Defining Service Requests,"describes how to define service requests for creation or modification of VPN services.
"Quick Start: VPN Provisioning and Inventory Manager," describes for previous API users the basic flow for using the VPIM server to transfer configuration data to and from VPN routers.
"VPIM: Transferring Configuration Data,"describes how to use the VPIM server to download configuration data to edge routers and how to upload current configurations.
"Quick Start: Event Subscription Service," describes for previous API users the basic flow for using the Account Monitor and SLA Monitor APIs to,. respectively, collect VPN-usage data and VPN performance.
"Overview: Event Subscription Service," describes how the VPN Solutions Center software and third-party client applications communicate with the TIB/Rendezvous software the supports the Event Subscription Service.
"Using the Event Subscription Service," describes how to connect to the Event Gateway server and subscribe client callback objects to receive notification of events of a specified subject.
"Subject Specifications for Events," describes how to specify a subject when subscribing a callback object to receive events from the Event Gateway server. It also supplies message structures for each subject to be handled by the client application source code.
Companion documents to the Cisco VPN Solutions Center: MPLS Solution Guide include the following:
The Cisco VPN Solutions Center: MPLS Solution API Programmer Reference describes the accompanying CORBA IDL-based APIs. Programmers can use these APIs to incorporate Cisco VPN Solutions Center features in source code of third-party network-management software. This adds network-management support for MPLS-based VPN services.
The Cisco VPN Solutions Center: MPLS Solution Installation Guide gives an overview of the Cisco VPN Solutions Center software, lists the system requirements and prerequisite tasks prior to installation, and describes how to install the product and troubleshoot installation problems.
The Cisco VPN Solutions Center: MPLS Solution Provisioning and Operations Guide provides a conceptual overview of the MPLS technology, and describes the steps for setting up and provisioning a VPN, downloading configlets, creating a management VPN, and monitoring VPN performance and generating the pertinent reports.
This guide discusses service requests, including how to define, deploy, and troubleshoot them. This guide supplies recommendations for administering customer edge routers (CEs) in a service provider environment, discussing the advantages and disadvantages of using both provider-managed and unmanaged CEs.
|
Note This book includes prerequisite information to assist you in building your comprehension of the MPLS technology and the MPLS support supplied by the VPN Solutions Center software. A thorough basic understanding of this technology is necessary before beginning client-application development using the APIs. |
The Cisco VPN Solutions Center: MPLS Solution User Reference provides details on the features of the Cisco VPN Solutions Center GUI-based client software. This reference also provides an overview and a description of WatchDog and the VPN Console. The menus in the VPN Console task bar are described item by item. In addition, this reference has appendices that describe command-line interface (CLI) commands and a table properties you can set in the csm.properties file.
The Release Notes for the Cisco VPN Solutions Center: MPLS Solution provide last-minute updates that could not be included in the formal product documentation set. In addition, these notes provide an overview of the feature set, limitations, and known issues.
Cisco Connection Online (CCO) is the primary real-time support channel for Cisco Systems customers. Maintenance customers and partners can self-register on CCO to obtain additional information and services.
Available 24 hours a day, 7 days a week, CCO provides a wealth of standard and value-added services to Cisco's customers and business partners. CCO services include product information, product documentation, software updates, release notes, technical tips, the Bug Navigator, configuration notes, brochures, descriptions of service offerings, and download access to public and authorized files.
CCO serves a wide variety of users through two interfaces that are updated and enhanced simultaneously: a character-based version and a multimedia version that resides on the World Wide Web (WWW). The character-based CCO supports Zmodem, Kermit, Xmodem, FTP, and Internet e-mail, and it is excellent for quick access to information over lower bandwidths. The WWW version of CCO provides richly formatted documents with photographs, figures, graphics, and video, as well as hyperlinks to related information.
You can access CCO in the following ways:
For a copy of the CCO Frequently Asked Questions (FAQ), contact cco-help@cisco.com. For additional information, contact cco-team@cisco.com.
|
Note If you are a network administrator and need personal technical assistance with a Cisco product that is under warranty or covered by a maintenance contract, contact Cisco's Technical Assistance Center (TAC) at 800 553-2447, 408 526-7209, or tac@cisco.com. To obtain general information about Cisco Systems, Cisco products, or upgrades, contact 800 553-6387, 408 526-7208, or cs-rep@cisco.com. |
Cisco documentation and additional literature are available in a CD-ROM package, which ships with your product. The Documentation CD-ROM, a member of the Cisco Connection Family, is updated monthly. Therefore, it might be more current than printed documentation. To order additional copies of the Documentation CD-ROM, contact your local sales representative or call customer service. The CD-ROM package is available as a single package or as an annual subscription. You can also access Cisco documentation on the World Wide Web at http://www.cisco.com, http://www-china.cisco.com, or http://www-europe.cisco.com.
If you are reading Cisco product documentation on the World Wide Web, you can submit comments electronically. Click Feedback in the toolbar and select Documentation. After you complete the form, click Submit to send it to Cisco. We appreciate your comments.
This book uses the following conventions:
Names of on-screen elements that you click or select (such as menu names and commands; buttons and checkboxes; and items in list boxes and drop-down lists) are printed in bold type. Also printed in bold are keywords, names of commands, and names of keys on the keyboard.
When they appear within a passage of normal text, words that you enter from the keyboard are printed in a bold face type. If the word is enclosed in angle brackets ("<" and ">"), the word shown is a placeholder which tells you the type of word or character to enter (such as a password or user name).
When they are set off from the main text, words and characters that you enter are printed in the Courier typeface in a bold font.
Words that appear on screen from a source other than the keyboard are printed in the Courier face but not bold when set off from the main text.
For example, if you see this:
login: root
you should enter the string root at the login prompt. But if you see this:
password: <root password>
you should enter your own password instead of the words root password.
The italic style of type is used to emphasize words, to introduce new terms, and for filenames and titles of printed publications.
Though it is possible to reconfigure your mouse to use buttons differently, this book will refer to mouse operations for a standard, right-hand, three-button mouse.
To select something, place the on-screen pointer or cursor on the item and click the left mouse button.
To view an Options menu, place the on-screen pointer or cursor on an item and click the right mouse button. If a menu is available, it will open. (Clicking the right mouse button is sometimes referred to as a right click.)
To drag something, click the mouse on it and drag the pointer to a different location before releasing the mouse button.
When selecting items from a list using the mouse, you can sometimes select more than one item by holding down the Shift or Control key while clicking the mouse.
To select a contiguous block of items, click on one item, hold the Shift key down, and click on a second item. All items between the two will be selected when multiple selection is enabled.
To select items from different locations when multiple selection is enabled, hold the Control key down. Each selected item will remain selected until you complete the action or click the mouse without holding the Control key down.
Posted: Fri Sep 22 20:20:59 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.