|
|
The Cisco VPN Solutions Center: MPLS Solution API Programmer Reference supplies reference information for application programming interfaces (APIs) that are provided with the Cisco VPN Solutions Center: MPLS Solution. With these APIs, you can add MPLS VPN Solution features to the source code for third-party network-management software.
For API reference information, see the Cisco VPN Solutions Center: MPLS Solution API Programmer Guide . 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 Reference 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 .
Following a comprehensive API Summary, this Reference is organized as follows:
"Overview," describes the services that are accessible through the APIs to their related CORBA servers. This chapter also discusses how to connect to individual servers using the Orbix Naming Service.
"CiscoVpnServiceModel.idl," describes the CiscoVpnServciceModel.idl file through which you can plan and engineer networks, manage (create and release) creator objects for service-model elements, and query the top-level of the VPN Inventory Repository.
"CiscoVsmFWCreator.idl," describes the CiscoVsmFWCreator.idl file through which you can create service-model objects and add them to and retrieve them from the VPN Inventory Repository.
"CiscoVsmFWModifier.idl," describes the CiscoVsmFWModifier.idl file through which you can modify service-model objects that already exist in the VPN Inventory Repository.
"CiscoVsmSRCreator.idl," describes the CiscoVsmSRCreator.idl file through which you can define service requests.
"CiscoVsmBrowser.idl," describes the CiscoVsmBrowser.idl file through which you can browse the contents of the VPN Inventory Repository.
"CiscoVsmExceptions.idl," describes the CiscoVsmExceptions.idl file, which defines the exception-handling scheme for the service-model APIs.
"CiscoVPIM.idl," describes the CiscoVPIM.idl (VPN Provisioning and Inventory Manager) file that supplies a high-level management facility to manage service requests and provisioning operations.
"CiscoVPIMDL.idl," describes the CiscoVPIMDL.idl file through which you can download configlets to provider and customer edge routers.
"CiscoVpnServiceRequest.idl," describes the CiscoVpnServiceRequests.idl file through which you can retrieve service-request information from the VPN Inventory Repository.
"CiscoVPIMExceptions.idl," describes the CiscoVPIMExceptions.idl file, which defines the exception-handling scheme for the provisioning APIs.
"CiscoTaskServiceModel.idl," describes the CiscoTaskServiceModel.idl file, which defines a set of CORBA interface with which to manage specific tasks and supplies the entry point to the Task Server in the form of the TaskServer interface.
"CiscoTaskManagedObjects.idl," describes the CiscoTaskManagedObjects.idl file, which defines all the managed objects in the Task Server.
"CiscoTaskFactory.idl," describes the CiscoTaskFactory.idl file, which supplies high-level operations that programmatically replicate the tasks that are available through the graphic user interface.
"CiscoTaskExceptions.idl," describes the CiscoTaskExceptions.idl file, which defines the exception-handling scheme for the Task Manager APIs.
"CiscoStream.idl," describes the CiscoStream.idl file, which defines the input-output stream for the Task Manager APIs.
"CiscoTime.idl," describes the CiscoTime.idl file, which defines the time format to use when scheduling tasks with the Task Manager APIs.
"CiscoAcctMonitor.idl," describes the CiscoAcctMonitor.idl file through which you can collect Netflow data to monitor account performance and generate accounting and billing data.
"CiscoSlaMonitor.idl," describes the CiscoSlaMonitor.idl file through you can define service-level agreements (SLAs) that describe the quality-of-service expectations for ISP services to be rendered to the customer.
"CiscoEventGateway.idl," describes the CiscoEventGateway.idl file through which you can define an event-notification scheme to monitor client-specified repository and other events generated by the VPN Solutions Center software.
The following chapters describe the "helper" APIs that are used by the SLA and Account Monitor APIs:
Companion documents to the Cisco VPN Solutions Center: MPLS Solution Reference include the following:
The Cisco VPN Solutions Center: MPLS Solution API Programmer Guide describes the programmatic concepts that are supported by the accompanying CORBA IDL-based APIs. 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.
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 coneptual overview of the MPLS techology, 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 Cisco 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: Tue Sep 26 20:26:43 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.