Table Of Contents

Getting Started

Overview

Installation

API Prerequisites

System Requirements

Installing the Cisco License Manager Perl SDK

Uninstalling Cisco License Manager Perl SDK

Getting Started

---

This chapter provides overview and installation information needed to use the Perl application programming interface (API) with Cisco License Manager Release 2.0 and contains the following sections:

•Overview

•Installation

•Uninstalling Cisco License Manager Perl SDK

Overview

Cisco License Manager provides an object-oriented PERL API for client programs to invoke functions implemented in the Cisco License Manager back-end server.

Cisco::CLM::SDK::LicenseManager

The API is provided as a set of Perl modules. The module CISCO::CLM::SDK::LicenseManager contains the core API that can be invoked by client programs to access the functions supported by the back-end server. This guide provides the external Perl API as seen by its client programs and includes the following functions:

•add_devices_to_group, page 3-1

•add_paks_to_folder, page 5-1

•add_user_to_device_access_list, page 16-1

•add_user_to_group_access_list, page 16-2

•add_user_to_pak_access_list, page 16-3

•annotate_license_lines, page 7-1

•annotate_licenses, page 6-1

•check_cisco_portal_connection, page 14-1

•check_device_connection, page 14-1

•check_user_eula_status, page 15-1

•create_device_group, page 3-2

•create_devices_by_ip_addr, page 4-1

•create_devices_by_udi, page 4-2

•create_folder, page 5-2

•create_paks, page 10-1

•create_policy, page 11-1

•create_user, page 16-4

•delete_device_group, page 3-3

•delete_devices, page 4-3

•delete_folder, page 5-3

•delete_paks, page 10-2

•delete_policy, page 11-2

•delete_user, page 16-5

•deploy_license_lines, page 7-2

•deploy_licenses, page 6-2

•deregister_notification_listener, page 9-1

•disable_notification_by_email, page 9-2

•discover_devices, page 4-4

•download_pak_info, page 10-3

•enable_notification_by_email, page 9-2

•enumerate_device_filter_attribute, page 11-3

•enumerate_sku_filter_attribute, page 11-3

•execute_policy, page 11-4

•generate_report, page 12-1

•get_associated_actions, page 16-5

•get_license_lines_by_license, page 7-3

•get_license_lines_on_device, page 7-3

•get_licenses_on_device, page 6-3

•get_rehost_info, page 6-4

•get_user_access_list_from_device, page 16-6

•get_user_access_list_from_group, page 16-6

•get_user_access_list_from_pak, page 16-7

•init_rehost_license, page 6-4

•list_all_devices_in_group, page 4-5

•list_all_folders, page 5-3

•list_all_folders_by_pak, page 10-4

•list_all_groups, page 3-4

•list_all_groups_by_device, page 4-6

•list_all_licenses_in_pak, page 6-5

•list_all_paks_in_folder, page 10-4

•list_all_policies, page 11-4

•list_all_users, page 16-8

•list_device_ids_by_filter, page 4-7

•list_expired_license_lines, page 7-4

•list_filtered_devices, page 11-5

•list_filtered_skus, page 11-5

•list_pak_contain_features, page 10-5

•list_scheduler, page 13-1

•login, page 15-2

•logout, page 15-3

•new, page 8-1

•obtain_license, page 6-6

•obtain_license_for_rehost, page 6-6

•poll_device_license_info, page 4-7

•purge_audit_trail_records, page 2-1

•re_create_devices, page 4-8

•re_obtain_license, page 6-7

•read_audit_trail_records, page 2-2

•read_devices, page 4-9

•read_license_lines, page 7-4

•read_licenses, page 6-8

•read_paks, page 10-6

•read_policy, page 11-6

•read_report, page 12-2

•read_user_info, page 16-8

•register_notification_listener, page 9-3

•register_scheduler, page 13-2

•rehost_license, page 6-9

•remove_access_list_from_device, page 16-9

•remove_access_list_from_group, page 16-9

•remove_devices_from_group, page 3-4

•remove_paks_from_folder, page 5-4

•remove_user_from_device_access_list, page 16-10

•remove_user_from_group_access_list, page 16-11

•remove_user_from_pak_access_list, page 16-12

•rename_device_group, page 3-5

•rename_folder, page 5-5

•resend_license, page 6-9

•revoke_license_for_rehost, page 6-10

•unregister_scheduler, page 13-2

•write_devices, page 4-10

•write_license_lines, page 7-5

•write_licenses, page 6-11

•write_paks, page 10-6

•write_policy, page 11-7

•write_user_info, page 16-12

Installation

The Perl API communicates with the Cisco License Manager Server using Perl.

This section provides the following installation information:

•API Prerequisites

•System Requirements

•Installing the Cisco License Manager Perl SDK

API Prerequisites

The following prerequisites have been tested and certified for Perl API:

•ActivePerl Version 5.8

•Inline-Java-0.52 module installed

Inline-Java-0.52 can be downloaded and installed from the Comprehensive Perl Archive Network (CPAN) website (http://www.cpan.org).

---

Note Please make sure that the default J2SDK version 1.5 is used while installing Inline-Java-0.52.

---

System Requirements

The following table provides details of the recommended software and hardware requirements for the Cisco License Manager server. These recommended requirements support the maximum data capacity (30,000 Cisco devices in the network). Also use these requirements if you are installing the server and client on the same host.

Table 1-1 Server Recommended Software and Hardware Requirements

Requirement Type	Recommended Requirement
Processor	Intel Pentium 4 3.2 GHz or equivalent CPU-based machine Sun UltraSPARC IIIi or equivalent CPU-based machine
Software	Operating system •Windows Server 2003 R2 Standard Edition •Windows XP Professional •Solaris 10 (SPARC system only)
RAM	2 GB
Disk	10 GB

The following table provides details of the recommended software and hardware requirements for the Cisco License Manager client workstation.

Table 1-2 Client Workstation Recommended Software and Hardware Requirements

Requirement Type	Recommended Requirement
Processor	Intel Pentium 4 3.2 GHz or equivalent CPU-based machine Sun UltraSPARC IIIi or equivalent CPU-based machine
Software	Operating system •Windows Server 2003 R2 Standard Edition •Windows XP Professional •Solaris 10 (SPARC system only)
RAM	1 GB
Disk	10 GB
Network connectivity	Server must be reachable from the client software.
Java requirements	Version 1.5

Installing the Cisco License Manager Perl SDK

To install the Cisco::CLM module, unzip the module and run the following commands:

    cd Cisco-CLM-2.00

    perl Makefile.PL

    make

    make test

    make install

Alternatively, to install with Module::Build, use the following commands:

    perl Build.PL

    ./Build

    ./Build test

    ./Build install

On Windows XP, use the following commands:

perl Build.PL

Build

Build test

Build install

If you do not have root permission or you want to install the module in a non-standard place, please give the directory location during perl Makefile.PL as

•(For Windows) perl Makefile.PL PREFIX = C:\my\install\directory

•(For Solaris) perl Makefile.PL PREFIX = /home/clm/install/directory

Uninstalling Cisco License Manager Perl SDK

To uninstall the Cisco License Manager Perl SDK, navigate to the folder where you unzipped the module and run:

perl uninstall.pl Cisco::CLM

If you have installed the module in a non-standard location, please provide the full directory path in this form:

•(For Windows) perl uninstall.pl Cisco::CLM C:\my\install\directory

•(For Solaris) perl uninstall.pl Cisco::CLM /home/user/clm_directory