Perl API Reference Guide for Cisco License Manager - Preface [Cisco License Manager]

Table Of Contents

Preface

Audience

Purpose

Organization

Conventions

Product Documentation

Obtaining Documentation, Obtaining Support, and Security Guidelines

Preface

This preface explains the audience, purpose, and organization of the Perl API Reference Guide for Cisco License Manager. It also defines the conventions that are used to present instructions and information.

Audience

The Perl API Reference Guide for Cisco License Manager is intended for system administrators who install and configure internetworking software and who are familiar with Cisco IOS software or for software developers who plan to create scripts to run Cisco License Manager functions.

Purpose

The Perl API Reference Guide for Cisco License Manager provides detailed information about the Perl application programming interface (API) functions used with Cisco License Manager Release 2.0. For additional information on related documentation, see the "Product Documentation" section.

Organization

The Perl API Reference Guide for Cisco License Manager is organized as follows:

•Chapter 1, "Getting Started," provides overview and installation information needed to use the Perl API with Cisco License Manager Release 2.0.

•Chapter 2, "AuditTrail Management Functions," provides information about the audit trail management functions.

•Chapter 3, "Device Group Management Functions," provides information about the device group management functions.

•Chapter 4, "Device Management Functions," provides information about the device management functions.

•Chapter 5, "Folder Management Functions," provides information about the folder management functions.

•Chapter 6, "License Inventory Management Functions," provides information about the license inventory management functions.

•Chapter 7, "License Line Management Functions," provides information about the license line management functions.

•Chapter 8, "License Manager Class Constructor," provides information about the Cisco License Manager class constructor.

•Chapter 9, "Notification Handling Functions," provides information about the notification handling functions.

•Chapter 10, "PAK Management Functions," provides information about the product authorization key (PAK) management functions.

•Chapter 11, "Policy Management Functions," provides information about the policy management functions.

•Chapter 12, "Report Management Functions," provides information about the report management functions.

•Chapter 13, "Scheduler Management Functions," provides information about the scheduler management functions.

•Chapter 14, "Troubleshooting Utility Functions," provides information about the troubleshooting utility functions.

•Chapter 15, "User Login and Logout Functions," provides information about the user login and logout functions.

•Chapter 16, "User Management Functions," provides information about the user management functions.

•Appendix A, "Helper Modules," provides information about the helper modules.

•Appendix B, "Sample Client Program in Perl," provides a sample client program in Perl.

•Appendix C, "Access Control," provides information about the levels of access control in Cisco License Manager, as well as the rules of control.

Conventions

This document uses the conventions listed in Table 1:

Table 1 Font Conventions

Item

Convention

Commands and keywords

boldface font

Variables for which you supply values

italic font

Displayed session and system information

screen font

Information you enter

boldface screen font

Menu items and button names

boldface font

Note Means reader take note. Notes contain helpful suggestions or references to material not contained in the publication.

Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Tip Means the following information will help you solve a problem.

Product Documentation

Note We sometimes update the printed and electronic documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates.

The following table lists the Cisco License Manager Release 2.0 documentation.

Table 2 Product Documentation

Document

Location

Home page for Cisco License Manager documentation (all releases)

On Cisco.com at http://www.cisco.com/en/US/
products/ps7138/tsd_products_support_
series_home.html

Release Notes for Cisco License Manager Release 2.0

On Cisco.com at http://www.cisco.com/en/US/
products/ps7138/prod_release_note
09186a00808f84de.html

Finding Documentation for Cisco License Manager Release 2.0

•Adobe Acrobat PDF on SDK CD

•On Cisco.com at http://www.cisco.com/en/US/products/
ps7138/products_documentation_roadmap
09186a00808f7c00.html (in HTML and PDF format)

User Guide for Cisco License Manager Release 2.0

On Cisco.com at http://www.cisco.com/application/pdf/en/
us/guest/products/ps8295/c1626/ccmigration_
09186a00808c04d8.pdf

Java API Reference Guide for Cisco License Manager Release 2.0

•Adobe Acrobat PDF on SDK CD

•On Cisco.com at http://www.cisco.com/en/US/
products/ps7138/products_programming_reference_guide
_book09186a00808e2dce.html (in HTML and PDF format)

Perl API Reference Guide for Cisco License Manager Release 2.0

•Adobe Acrobat PDF on SDK CD

•On Cisco.com at http://www.cisco.com/en/US/
products/ps7138/products_programming_reference_guide
_book09186a00808e2f0e.html (in HTML and PDF format)

Online Help

In the user interface, click Help to display help in a separate window.

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