java api reference guide for cisco license manager, … · iii java api reference guide for cisco...

Java API Reference Guide for Cisco License ManagerRelease 3.1 May 2011

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706 USAhttp://www.cisco.comTel: 408 526-4000

800 553-NETS (6387)Fax: 408 527-0883

Text Part Number: OL-13001-05

http://www.cisco.com

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCBs public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R)

.Java API Reference Guide for Cisco License Manager 2007-2011 Cisco Systems, Inc. All rights reserved.

http://www.cisco.com/go/trademarks

OL-13001-05

C O N T E N T S

License and Warranty Information ix

Supplemental License Agreement i-ix

Cisco Limited 90-Day Software Warranty Terms i-x

Preface xi

Audience i-xi

Purpose i-xi

Organization i-xi

Conventions i-xii

Product Documentation i-xiii

Obtaining Documentation and Submitting a Service Request i-xiv

C H A P T E R 1 Getting Started 1-1

Overview 1-1

Installation 1-1API Prerequisites 1-1

Installing the Cisco License Manager SDK 1-2

Using the SDK 1-2

New and Removed Cisco License Manager APIs 1-3New APIs 1-3Removed APIs 1-3

C H A P T E R 2 Access Control Functions 2-1

getAssociatedActions 2-1

getUserAccessListFromDevice 2-2

getUserAccessListFromGroup 2-2

getUserAccessListFromPAK 2-3

isGroupAccessAllowNone 2-4

removeAccessListFromDevice 2-4

removeAccessListFromGroup 2-5

setGroupAccessAllowNone 2-6

iiiJava API Reference Guide for Cisco License Manager

Contents

C H A P T E R 3 Audit Trail Management Functions 3-1

listAllAuditTrailRecords 3-1

purgeAuditTrailRecords 3-2

readAuditTrailRecords 3-3

C H A P T E R 4 Device Group Management Functions 4-1

addDevicesToGroup 4-1

createDeviceGroup 4-2

deleteDeviceGroup 4-3

listAllGroups 4-3

moveDevices 4-4

removeDevicesFromGroup 4-5

renameDeviceGroup 4-6

C H A P T E R 5 Device Management Functions 5-1

asyncDiscoverDevices 5-2

asyncPollDeviceLicenseInfo 5-4

changeDeviceHopInfo 5-4

createDeviceByIPAddr 5-5

createDevicesByUDI 5-6

deleteDevices 5-7

getActiveRMADevices 5-8

getAllowedOperationByDevicePlatform 5-8

getDeviceFeatureInfos 5-9

getDevicePIXASAFeatureInfos 5-10

getDeviceRMAJob 5-11

getDeviceSANOSDCOSFeatureInfos 5-11

getDiscoveryAuthInfo 5-12

getDiscoverySettings 5-13

getDiscoveryTransports 5-13

listAllDevices 5-14

listAllDevicesInGroup 5-15

listAllGroupsByDevice 5-16

listApplicableDevicesBySKU 5-16

listDeviceIdsByFilter 5-17

listRunningAsyncOperationJobRecords 5-18

ivJava API Reference Guide for Cisco License Manager

OL-13001-05

Contents

readDevices 5-19

readRMAJobs 5-19

writeDeviceDisplayName 5-20

writeDeviceHopInfo 5-20

C H A P T E R 6 Folder Management Functions 6-1

addPAKsToFolder 6-1

createFolder 6-2

deleteFolder 6-2

listAllFolders 6-3

removePAKsFromFolder 6-4

renameFolder 6-5

C H A P T E R 7 License Inventory Management Functions 7-1

asyncAnnotateLicenses 7-2

asyncDeployLicenses 7-3

asyncObtainLicense 7-4

deployLicenseByFile 7-5

getDeviceIdsWithUnDeployedLicenses 7-5

getPAKIdsWithUnDeployedLicenses 7-6

getRehostableSKUsByDevice 7-7

getRehostInfo 7-7

initRehostLicense 7-8

listAllLicenses 7-9

listAllLicenseLines 7-10

listAllLicensesInPAK 7-11

listAllPAKs 7-11

obtainLicenseForRehost 7-12

readLicenses 7-13

rehostLicense 7-14

reObtainLicense 7-14

resendLicense 7-15

revokeLicenseForRehost 7-16

transferRMADeviceLicenses 7-16

vJava API Reference Guide for Cisco License Manager

OL-13001-05

Contents

C H A P T E R 8 License Line Management Functions 8-1

asyncAnnotateLicenseLines 8-1

asyncDeployLicenseLines 8-2

getLicenseLinesByLicense 8-3

getLicenseLinesOnDevice 8-4

listExpiredLicenseLines 8-4

listExpiringLicenses 8-5

readLicenseLines 8-5

C H A P T E R 9 License Manager Class Constructors 9-1

LicenseManager (Default) 9-1

LicenseManager (Nondefault) 9-2

C H A P T E R 10 Notification Handling Functions 10-1

deregisterNotificationListener 10-1

disableNotificationByEmail 10-2

enableNotificationByEmail 10-2

registerNotificationListener 10-3

C H A P T E R 11 PAK Management Functions 11-1

asyncDownloadPAKInfo 11-2

createPAKs 11-3

deletePAKs 11-3

listAllFoldersByPAK 11-4

listAllPAKsInFolder 11-5

listPAKContainFeatures 11-6

readPAKs 11-6

writePAKs 11-7

C H A P T E R 12 Policy Management Functions 12-1

asyncExecutePolicy 12-1

createPolicy 12-2

deletePolicy 12-3

enumerateDeviceFilterAttribute 12-4

enumerateSKUFilterAttribute 12-5

listAllPolicies 12-5

viJava API Reference Guide for Cisco License Manager

OL-13001-05

Contents

listApplicableDevicesBySKUs 12-6

listFilteredDevices 12-7

listDeviceIdsByFilter 12-7

listFilteredSKUs 12-8

readPolicy 12-9

writePolicy 12-9

C H A P T E R 13 Report Management Functions 13-1

generateReport 13-1

readReport 13-2

C H A P T E R 14 Scheduler Management Functions 14-1

listScheduler 14-1

registerDiscoveryScheduler 14-2

registerScheduler 14-2

registerServerStatusListener 14-3

unregisterDiscoveryScheduler 14-4

unregisterScheduler 14-4

C H A P T E R 15 Utility Functions 15-1

checkCiscoPortalConnection 15-1

checkDeviceConnection 15-2

getServerProperties 15-2

getVersion 15-3

C H A P T E R 16 User Login and Logout Functions 16-1

checkUserEULAStatus 16-1

login 16-2

logout 16-3

C H A P T E R 17 User Management Functions 17-1

createUser 17-1

deleteUser 17-2

getDiscoveryAuthInfo 17-3

listAllUsers 17-3

readUserInfo 17-4

viiJava API Reference Guide for Cisco License Manager

OL-13001-05

Contents

writeUserInfo 17-4

C H A P T E R 18 Asynchronous Job Management Functions 18-1

addPersistentIDStatus 18-1

deleteAsyncOperationJobRecords 18-2

getAsyncOperationJobRecord 18-2

getAsyncOperationStatus 18-3

killAsyncOperation 18-4

listAllAsyncOperationJobRecords 18-5

listPersistentIDStatus 18-5

listPersistentIDStatusByGroup 18-6

readPersistentIDStatus 18-7

setAsyncOperationJobComment 18-8

A P P E N D I X A Sample Client Program in Java A-1

A P P E N D I X B Levels of Access Control B-1

User Control B-1

Device Control B-3

PAK Control B-3

Rules of Control B-3

viiiJava API Reference Guide for Cisco License Manager

OL-13001-05

License and Warranty Information

Supplemental License Agreement, page ix

Cisco Limited 90-Day Software Warranty Terms, page x

Supplemental License AgreementSUPPLEMENTAL LICENSE AGREEMENT FOR CISCO SYSTEMS LICENSE MANAGER SOFTWARE DEVELOPMENT KIT ("SDK")

IMPORTANTREAD CAREFULLY: This Supplemental License Agreement (SLA) contains additional limitations on the license to the Software provided to Customer under the Software License Agreement between Customer and Cisco. Capitalized terms used in this SLA and not otherwise defined herein shall have the meanings assigned to them in the Software License Agreement. To the extent that there is a conflict among any of these terms and conditions applicable to the Software, the terms and conditions in this SLA shall take precedence.

By installing, downloading, accessing or otherwise using the Software, Customer agrees to be bound by the terms of this SLA. If Customer does not agree to the terms of this SLA, Customer may not install, download, or otherwise use the Software. When used below, the term server refers to central processor unit.

1. ADDITIONAL LICENSE RESTRICTIONS.

Installation and Use. Customer may only install and use the SDK on a single development station or node for internal development of products which will utilize Cisco Systems License Manager software ("CLM Software").

Use of the SDK on multiple stations or nodes requires the purchase of an additional SDK for each of those units. Installation and use of CLM Software APIs that may be made available to Customer at Cisco's sole discretion are governed under separate terms and conditions.

Reproduction and Distribution. Customer may not reproduce nor distribute SDK software.

2. DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS.

Please refer to the Cisco Systems, Inc. Software License Agreement.

ixJava API Reference Guide for Cisco License Manager

OL-13001-05

License and Warranty Information Cisco Limited 90-Day Software Warranty Terms

Cisco Limited 90-Day Software Warranty TermsThere are special terms applicable to your software warranty and various services that you can use during the warranty period. Your formal Warranty Statement, including the warranties and license agreements applicable to Cisco software, is available on Cisco.com. Follow these steps to access and download the Cisco Information Packet and your warranty and license agreements from Cisco.com.

1. Launch your browser, and go to this URL:

http://www.cisco.com/en/US/products/prod_warranties_listing.html

The Product Warranties page appears.

2. Click the Cisco Limited 90-Day Software Warranty Terms link.

3. Read the Cisco Information Packet online or download the PDFs.

Note You must have Adobe Acrobat Reader to view and print PDF files. You can download the reader from the Adobe website: http://www.adobe.com

xJava API Reference Guide for Cisco License Manager

OL-13001-05

http://www.adobe.comhttp://www.cisco.com/en/US/products/prod_warranties_listing.html

Preface

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

AudienceThis guide is intended for system administrators who install and configure internetworking software and who are familiar with Cisco IOS software. This guide is also for software developers who plan to create scripts to run Cisco License Manager functions.

PurposeThis guide provides detailed information about the Java application programming interface (API) functions used with Cisco License Manager. The guide documents two Java packages:

com.cisco.nm.clm.sdk

Chapter 2, Access Control Functions, to Chapter 18, Asynchronous Job Management Functions, describe the API calls in com.cisco.nm.clm.sdk.LicenseManager. The API calls are grouped by function.

com.cisco.nm.clm.common

Appendix C, Data Object Definitions, defines all Java classes in com.cisco.nm.clm.common package, which is referred by com.cisco.nm.clm.sdk.LicenseManager.

For additional information about related documentation, see the Product Documentation section on page xiii.

OrganizationThis guide is organized as follows:

Chapter 1, Getting Started, provides overview and installation information needed to use the Java API with Cisco License Manager.

Chapter 2, Access Control Functions, provides information about the access control functions.

Chapter 3, Audit Trail Management Functions, provides information about the audit trail management functions.

xiJava API Reference Guide for Cisco License Manager

OL-13001-05

Preface Conventions

Chapter 4, Device Group Management Functions, provides information about the device group management functions.

Chapter 5, Device Management Functions, provides information about the device management functions.

Chapter 6, Folder Management Functions, provides information about the folder management functions.

Chapter 7, License Inventory Management Functions, provides information about the license inventory management functions.

Chapter 8, License Line Management Functions, provides information about the license line management functions.

Chapter 9, License Manager Class Constructors, provides information about the Cisco License Manager class constructors:

Chapter 10, Notification Handling Functions, provides information about the notification handling functions.

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

Chapter 12, Policy Management Functions, provides information about the policy management functions.

Chapter 13, Report Management Functions, provides information about the report management functions.

Chapter 14, Scheduler Management Functions, provides information about the scheduler management functions.

Chapter 15, Utility Functions, provides information about the troubleshooting utility functions.

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

Chapter 17, User Management Functions, provides information about the user management functions.

Chapter 18, Asynchronous Job Management Functions, provides information about the job management functions.

Appendix A, Sample Client Program in Java, provides a sample client program in Java.

Appendix B, Levels of Access Control, provides information about the levels of access control in Cisco License Manager and the rules of control.

Appendix C, Data Object Definitions, defines all the Java classes in the com.cisco.nm.clm.common package.

ConventionsThis 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

xiiJava API Reference Guide for Cisco License Manager

OL-13001-05

Preface Product Documentation

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.

Table 2 lists the Cisco License Manager documentation.

Displayed session and system information screen font

Information you enter boldface screen font

Menu items and button names boldface font

Table 1 Font Conventions

Item Convention

Table 2 Product Documentation

Document Location

Home page for Cisco License Manager documentation (all releases)

http://www.cisco.com/en/US/products/ps7138/tsd_products_support_series_home.html

Release Notes for Cisco License Manager http://www.cisco.com/en/US/products/ps7138/prod_release_notes_list.html

Finding Documentation for Cisco License Manager Adobe Acrobat PDF on SDK CD

http://www.cisco.com/en/US/products/ps7138/products_documentation_roadmaps_list.html

User Guide for Cisco License Manager http://www.cisco.com/en/US/products/ps7138/products_user_guide_list.html

Java API Reference Guide for Cisco License Manager Adobe Acrobat PDF on SDK CD

http://www.cisco.com/en/US/products/ps7138/products_installation_and_configuration_guides_list.html

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

xiiiJava API Reference Guide for Cisco License Manager

OL-13001-05

http://www.cisco.com/en/US/products/ps7138/tsd_products_support_series_home.htmlhttp://www.cisco.com/en/US/products/ps7138/prod_release_notes_list.htmlhttp://www.cisco.com/en/US/products/ps7138/products_documentation_roadmaps_list.htmlhttp://www.cisco.com/en/US/products/ps7138/products_documentation_roadmaps_list.htmlhttp://www.cisco.com/en/US/products/ps7138/products_user_guide_list.htmlhttp://www.cisco.com/en/US/products/ps7138/products_installation_and_configuration_guides_list.htmlhttp://www.cisco.com/en/US/products/ps7138/products_installation_and_configuration_guides_list.html

Preface Obtaining Documentation and Submitting a Service Request

Obtaining Documentation and Submitting a Service RequestFor information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly Whats 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

Subscribe to the Whats New in Cisco Product Documentation as an RSS feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service. Cisco currently supports RSS Version 2.0.

xivJava API Reference Guide for Cisco License Manager

OL-13001-05

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

JaOL-13001-05

C H A P T E R 1

Getting Started

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

Overview, page 1-1

Installation, page 1-1

Using the SDK, page 1-2

New and Removed Cisco License Manager APIs, page 1-3

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

The API is a set of Java class libraries in a single Java archive (JAR) file. The top-level class License Manager contains all functions that can be invoked by client programs. This is the same class library set used by the Cisco License Manager GUI. This guide provides the external Java API as seen by its client programs.

The Java API communicates with the Cisco License Manager Server by using Java.

Installation API Prerequisites, page 1-1

Installing the Cisco License Manager SDK, page 1-2

API PrerequisitesThe API requires Java Development Kit (JDK) Version 1.6.

For information about the Cisco License Manager server and client requirements, see the release notes:

http://www.cisco.com/en/US/products/ps7138/prod_release_notes_list.html

1-1va API Reference Guide for Cisco License Manager

http://www.cisco.com/en/US/products/ps7138/prod_release_notes_list.html

Chapter 1 Getting Started Installing the Cisco License Manager SDK

Installing the Cisco License Manager SDKWe recommend that you install the Cisco License Manager Software Developer Kit (SDK) on the same machine on which the server resides.

To install theCisco License Manager SDK, complete the following steps:

Step 1 Copy clm_java_sdk.zip from the CD to a local drive.

Step 2 Unzip the file.

The folder CiscoLicenseManager_JAVA_SDK is created on the local drive. It contains these files:

clm-sdk.jar

clm_ssl_rmi.cert

conf, a folder containing the file ClmErrorMessages.properties.

Using the SDKComplete the following steps to begin using the SDK:

Step 1 Add clm-sdk.jar to the Java classpath when compiling and running the client program.

javac -classpath /clm-sdk.jar:/conf MyProgram.java, where is the directory that holds the CLM SDK files

Note You must use Java 6.0 version when compiling and running Cisco License Manager Release 3.1 SDK client program.

Step 2 If the Cisco License Manager License Manager server is Secure Sockets Layer (SSL)-enabled:

Run the following command to import the Cisco License Manager certificate file, clm_ssl_rmi.cer, to the trust store on your client system:

%JAVA_HOME%\bin\keytool -import -keystore -alias ciscolicensemanagerca -file

where is the trust store of your client system (for example, C:\jdk1.5\jre\lib\security\cacerts) and is the full path of the clm_ssl_rmi.cer file (for example, C:\CLM3.1_SDK\clm_ssl_rmi.cer).

Step 3 Start the Cisco License Manager server. For details, see the User Guide for Cisco License Manager.

Step 4 Start the client program.

1-2Java API Reference Guide for Cisco License Manager

OL-13001-05

Chapter 1 Getting Started New and Removed Cisco License Manager APIs

New and Removed Cisco License Manager APIs New APIs, page 1-3

Removed APIs, page 1-3

New APIsThese APIs were introduced in Cisco License Manager Release 3.1:

public Status changeDeviceHopInfo(UserToken token, Device.TransportMethod transMethod, LicenseManagerInterface.IdType idtype, String id, String username, String password, String enablePwd) throws RemoteException;

public FeatureInfo[ ] getDeviceFeatureInfos(UserToken token, String devID) throws RemoteException;

public FeatureInfo[ ] getDeviceFeatureInfos(UserToken token, String devID, Device.DevicePlatform platform) throws RemoteException;

public SANOSDCOSFeatureInfo[ ] getDeviceSANOSDCOSFeatureInfos(UserToken token, String devID) throws RemoteException;

public PIXASAFeatureInfo getDevicePIXASAFeatureInfo(UserToken token, String devID) throws RemoteException;

public Status writeDeviceDisplayName(UserToken token, String devID, String displayName) throws RemoteException;

public ReportStatus readReport(UserToken token, ReportSubject subject, AuditTrailFilter filter) throws RemoteException;

public boolean isGroupAccessAllowNone(UserToken token, String groupName) throws RemoteException;

public Status setGroupAccessAllowNone(UserToken token, String groupName) throws RemoteException;

public AuditTrailPagingInfo listAuditTrailRecordsByFilter(UserToken token, Pagination pageinfo) throws RemoteException;

Removed APIsThese APIs were removed in Cisco License Manager Release 3.1:

public LicLineStatus createLicenseLines(UserToken token, String[ ] licline_ids) throws RemoteException;

public IDStatus writeLicenseLines(UserToken token, LicenseLine[ ] liclines) throws RemoteException;

public IDStatus deleteLicenseLines(UserToken token, String[ ] licline_ids) throws RemoteException;


OL-13001-05

Chapter 1 Getting Started New and Removed Cisco License Manager APIs


OL-13001-05

JaOL-13001-05

C H A P T E R 2

Access Control Functions

This chapter provides information about these access control functions:

getAssociatedActions, page 2-1

getUserAccessListFromDevice, page 2-2

getUserAccessListFromGroup, page 2-2

getUserAccessListFromPAK, page 2-3

isGroupAccessAllowNone, page 2-4

removeAccessListFromDevice, page 2-4

removeAccessListFromGroup, page 2-5

setGroupAccessAllowNone, page 2-6

getAssociatedActionsSynopsispublic String[] getAssociatedActions(UserToken token,String username) throws RemoteException;

Description

This function returns a list of strings representing the actions that can be performed.

The user who is logged in using the administrator role can obtain information for all users. Users without the administrator role can obtain information only for themselves.

Input Parameters

Parameter Type Value Description

token UserToken, mandatory

Token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.

username String, mandatory

Array of strings representing the actions a user can perform.


Chapter 2 Access Control Functions getUserAccessListFromDevice

Return

This function returns an array of usernames.

Error and Exception

If a system error prevents the operation from completing, a RemoteException is thrown.

getUserAccessListFromDeviceSynopsispublic String[] getUserAccessListFromDevice(UserToken token, String devID) throws RemoteException;

Description

This function returns the user access list for a given device ID as an array of string. Each string is a user ID.

Input Parameters

Return

This function returns an array of strings representing the access list.

Error and Exception


getUserAccessListFromGroupSynopsispublic String[] getUserAccessListFromGroup(UserToken token, String group) throws RemoteException;

Description

This function returns the user access list for a given group as an array of string. Each string is a user ID.




devID String, mandatory

Device ID.


OL-13001-05

Chapter 2 Access Control Functions getUserAccessListFromPAK

Input Parameters

Return

This function returns an array of string representing an access list.

Error and Exception


getUserAccessListFromPAKSynopsispublic String[]getUserAccessListFromPAK(UserToken token, String pakID) throws RemoteException;

Description

This function returns the user access list for a given PAK as an array of string. Each string is a user ID.

Input Parameters

Return

This function returns an array of strings representing an access list.




group String, mandatory

Group ID.




pakID String, mandatory

Array of PAK IDs.


OL-13001-05

Chapter 2 Access Control Functions isGroupAccessAllowNone

Error and Exception


isGroupAccessAllowNoneSynopsispublic boolean isGroupAccessAllowNone(UserToken token, String groupName) throws RemoteException;

Description

The function checks if the given group allows no user access.

Input Parameters

Return

This function is true if the given group allows no user access.

Error and Exception


removeAccessListFromDeviceSynopsispublic Status removeAccessListFromDevice(UserToken token, String devID) throws RemoteException;

Description

This function removes an access list for the specified device.




groupName String, mandatory

Group name.


OL-13001-05

Chapter 2 Access Control Functions removeAccessListFromGroup

Input Parameters

Return

This function returns a Status object that contains an error code and error message when an operation error occurs.

Error and Exception


removeAccessListFromGroupSynopsispublic Status removeAccessListFromGroup(UserToken token, String group) throws RemoteException;

Description

This function removes an access list for the specified group.

Input Parameters

Return

This function returns a Status object that contains an error code and error message when an operation error occurs.

Error and Exception






Device ID for which the access list is removed.





Group for which the access list has to be removed.


OL-13001-05

Chapter 2 Access Control Functions setGroupAccessAllowNone

setGroupAccessAllowNoneSynopsispublic Status setGroupAccessAllowNone(UserToken token, String groupName) throws RemoteException;

Description

The function sets the given group to allow no user access.

Input Parameters

Return

The function returns the Status object that contains an error code and an error message when an operation error occurs.

Error and Exception





groupName String, mandatory

Group name.


OL-13001-05

JaOL-13001-05

C H A P T E R 3

Audit Trail Management Functions

This chapter provides information about these audit trail management functions:

listAllAuditTrailRecords, page 3-1

purgeAuditTrailRecords, page 3-2

readAuditTrailRecords, page 3-3

listAllAuditTrailRecordsSynopsispublic AuditTrailPagingInfo listAllAuditTrailRecords(UserToken token, Pagination pageinfo) throws RemoteException;

Description

This function returns all audit trail records in the inventory. The output includes status, total count, and an array of AuditTrails. If no record is found, the returned array is of zero size.

If a valid offset and a max are entered, pagination is provided. For example, if the result set has 100 records, and you want 10 records at a time, you can request a page at a time by specifying the offset and the max in Pagination:

To get first page:

Pagination p = new Pagination(0, 10)

To get fifth page:


To get all records without paging:

Pagination p = new Pagination(0, -1)


Chapter 3 Audit Trail Management Functions purgeAuditTrailRecords

Input Parameters

Return

This function returns AuditTrailPagingInfo object that includes an array of AuditTrail Object. If the offset is greater than the number of records, it returns an array of zero size.

Error and Exception

If there is an operation error, the Status object contains an error code and an error message.If a system error prevents the operation from completing, a RemoteException is thrown.

purgeAuditTrailRecordsSynopsispublic Status purgeAuditTrailRecords(UserToken token, int numToKeep) throws RemoteException;

Description

This function purges the audit trail logs that contain records of user activities. It removes the older records that exceed the numToKeep parameter.

Input Parameters

Return

This function returns a Status object. If there is operation error, the error number and the error message are returned in the Status object.




pageinfo DataObject, mandatory

Pagination Object that includes an offset and a max. Offset specifies the offset relative to the first record set to return. Max specifies the maximum number of records to return. If max is set to -1, all records that have value -1 are returned.




numToKeep Integer, mandatory

Valid integer value Number (quantity) of log records to keep.


OL-13001-05

Chapter 3 Audit Trail Management Functions readAuditTrailRecords

Error and Exception


readAuditTrailRecordsSynopsispublic AuditTrail[] readAuditTrailRecords(UserToken token, String[] ids) throws RemoteException;

Description

This function returns AuditTrail Records with the given Cisco License Manager database object IDs in the inventory.

Input Parameters

Return

This function returns an array of AuditTrail objects.

Error and Exception





ids String, mandatory

Array of Cisco License Manager database object IDs for AuditTrail records.


OL-13001-05

Chapter 3 Audit Trail Management Functions readAuditTrailRecords


OL-13001-05

JaOL-13001-05

C H A P T E R 4

Device Group Management Functions

This chapter provides information about these device group management functions:

addDevicesToGroup, page 4-1

createDeviceGroup, page 4-2

deleteDeviceGroup, page 4-3

listAllGroups, page 4-3

moveDevices, page 4-4

removeDevicesFromGroup, page 4-5

renameDeviceGroup, page 4-6

addDevicesToGroupSynopsispublic IDStatus addDevicesToGroup(UserToken token, String[] devIDs, String group) throws RemoteException;

Description

This function adds devices to the specified device group. You can add devices for more than one group.

Note If you want to keep a device in a single group, you should remove the device from any other group by calling the removeDevicesFromGroup() function.

Input Parameters





Chapter 4 Device Group Management Functions createDeviceGroup

Return

This function returns an IDStatus object. If the operation is successful, the following are returned in the IDStatus:

ClmErrors.SUCCESS in error code.

IDStatusItem array containing IDs of the devices that are being added.

CLMError.SUCCESS in IDStatusItem error code for each item added successfully.

Error and Exception


createDeviceGroupSynopsispublic Status createDeviceGroup(UserToken token, String group) throws RemoteException;

Description

This function creates a new device group with the given name.

Input Parameters

Return

This function returns a Status object. If the operation is successful, ClmErrors.SUCCESS is returned in the error code.

devIDs Array of string, mandatory

Array of device IDs to be added to the group.


Name of the group.






Up to 64 ASCII characters in the range from x21 to x7A

Name of the group.


OL-13001-05

Chapter 4 Device Group Management Functions deleteDeviceGroup

Error and Exception


deleteDeviceGroupSynopsispublic Status deleteDeviceGroup(UserToken token, String group) throws RemoteException;

Description

This function deletes a device group from the system. Devices under this group are not deleted, but they are moved to the Default group if they are not in any other group.

Input Parameters

Return


Error and Exception


listAllGroupsSynopsispublic IDPagingInfo listAllGroups(UserToken token, Pagination pageinfo) throws RemoteException;

Description

This function returns the IDPagingInfo object, which includes status, total count, and an array of group names.

If a valid offset and a max are entered, pagination is provided. For example, if the result set has 100 records, and you want 10 records at a time, you can request one page at a time by specifying the offset and the max in Pagination:

To get first page:


To get fifth page:





Name of the device group to be deleted.


OL-13001-05

Chapter 4 Device Group Management Functions moveDevices




Input Parameters

Return

This function returns the IDPagingInfo object, which includes an array of group names. If the offset is larger than the number of records, it returns an array of zero size. If there is an operation error, the Status object returns an error code and message.

Error and Exception


moveDevicesSynopsispublic Status moveDevices(UserToken token, String[] devIDs, String fromGroup, String toGroup) throws RemoteException;

Description

This function moves devices from one group to another group.

Input Parameters





Pagination Object that includes an offset and a max. Offset specifies the offset relative to the first record set to return. Max specifies the maximum number of records to return. If the maximum is set to -1, all records that have value -1 are returned.




devIDs String, mandatory

Array of device IDs to be moved.


OL-13001-05

Chapter 4 Device Group Management Functions removeDevicesFromGroup

Return


Error and Exception


removeDevicesFromGroupSynopsispublic IDStatus removeDevicesFromGroup(UserToken token, String[] devIDs, String group) throws RemoteException;

Description

This function removes devices from the specified device group. The devices are not deleted. If this is the last group to which a device belongs, the device is moved to Default group. To delete the devices from inventory, use the deleteDevice() function.

Input Parameters

Return

This function returns an IDStatus object. If operation is successful, the IDStatus object contains IDStatusItem[], each IDStatusItem contains the ID of the device that is being removed to the group.

If the device is removed successfully from the group, the error code in IDStatusItem is e ClmErrors.SUCCESS. A device cannot be removed from the last group to which it belongs.

Error and Exception


fromGroup String, mandatory

Group from which to remove devices.

toGroup String, mandatory

Group to which devices are moved.






Array of device IDs to be removed to the group.


Name of the device group.


OL-13001-05

Chapter 4 Device Group Management Functions renameDeviceGroup

renameDeviceGroupSynopsispublic Status renameDeviceGroup(UserToken token, String oldName, String newname) throws RemoteException;

Description

This function renames a given device group. All devices contained in the group remain unchanged.

Input Parameters

Return


Error and Exception





oldName String, mandatory

Name of device group to be renamed.

newname String, mandatory


New name for the device group.


OL-13001-05

JaOL-13001-05

C H A P T E R 5

Device Management Functions

This chapter provides information about these device management functions:

asyncDiscoverDevices, page 5-2

asyncPollDeviceLicenseInfo, page 5-4

changeDeviceHopInfo, page 5-4

createDeviceByIPAddr, page 5-5

createDevicesByUDI, page 5-6

deleteDevices, page 5-7

getActiveRMADevices, page 5-8

getAllowedOperationByDevicePlatform, page 5-8

getDeviceFeatureInfos, page 5-9

getDevicePIXASAFeatureInfos, page 5-10

getDeviceRMAJob, page 5-11

getDeviceSANOSDCOSFeatureInfos, page 5-11

getDiscoveryAuthInfo, page 5-12

getDiscoverySettings, page 5-13

getDiscoveryTransports, page 5-13

listAllDevices, page 5-14

listAllDevicesInGroup, page 5-15

listAllGroupsByDevice, page 5-16

listApplicableDevicesBySKU, page 5-16

listDeviceIdsByFilter, page 5-17

listRunningAsyncOperationJobRecords, page 5-18

readDevices, page 5-19

readRMAJobs, page 5-19

writeDeviceDisplayName, page 5-20

writeDeviceHopInfo, page 5-20


Chapter 5 Device Management Functions asyncDiscoverDevices

asyncDiscoverDevicesSynopsispublic Sting asyncDiscoverDevices(UserToken token, String subnet, String subnetMask, String group,DiscoveryAuthInfo devAuthInfo, Device.TransportMethod[] transportMethods, String[] policyIDs,IDStatusListener listener) throws RemoteException;

Description

This function generates an inventory of devices that are discovered in the given subnet and adds the devices to the specified device group.

The Cisco License Manager currently supports Cisco IOS Telnet and secure shell (SSH) for non-agent-enabled device discovery, thus prolonging the discovery time. If the network devices are configured the same way, you can provide the transport method (such as HTTP, HTTPS, Telnet, or SSH), which speeds up the discovery and reduces the discovery process time. If a null or empty string array is passed in, Cisco License Manager uses all supported methods to discover the devices.

This function is nonblocking and returns a request ID to the caller immediately. While calling this function, the client program provides a listener object that implements the IDStatusListener interface. When the operation is complete, the onStatus() method in the listener object is invoked.

Input Parameters




subnet String, mandatory Network address Subnet to conduct the autodiscovery.

subnet_mask String, mandatory Subnet mask.

group String, mandatory Group to which the discovered devices should be added. If the group is null, all discovered devices are added to the default group. If the group does not exist, an error is returned.


OL-13001-05

Chapter 5 Device Management Functions asyncDiscoverDevices

Return

This function returns a request ID. When the operation is completed, the status is provided as the input parameter of the onStatus() method. The listener receives the IDStatus, which contains a list of IDStatusItems. Each IDStatusItem contains the device ID of the discovered devices.

Error and Exception


dev_auth_info DiscoveryAuthInfo, mandatory

A DiscoveryAuthInfo is used when communicating with discovered devices to retrieve license information. If no authentication is needed for the devices in the network, this parameter can be set to null.

DiscoveryAuthInfo contains an array of username and password pairs and an array of enable passwords. To enter the enable password, the username field is set to null, and the enable password is set in the password field.

When Cisco License Manager tries to communicate with the device, the instances of DiscoveryAuthInfo are tried one at a time until they can be authenticated by the device. If Telnet is used, there are only three tries.

transportMethods Device. TransportMethod array, optional

HTTP, HTTPS, TELNET, SSH

If the devices in a subnet are set up with the same device discovery method, the device discovery process is speeded up because Cisco License Manager uses only the specified method to quickly determine if the device license is supported. This parameter specifies which connection transport is used. Cisco License Manager uses the specified transports by entry order.

To enter the enable password, set the username field to null and set the enable password in the password field.

If null or zero length is entered, Cisco License Manager uses all available methods to discover the device.

policyIDs Array of string, mandatory

Array of policy IDs that run after the discovery is completed.

listener IDStatusListener object, mandatory

Object that implements the IDStatusListener interface.



OL-13001-05

Chapter 5 Device Management Functions asyncPollDeviceLicenseInfo

asyncPollDeviceLicenseInfoSynopsispublic String asyncPollDeviceLicenseInfo(UserToken token, String jobGroup, String[] devIDs, IDStatusListener listener) throws RemoteException;

Description

This function communicates with the given devices, retrieving license information from them and storing the information in the inventory.

This function is nonblocking and returns a request ID to the caller immediately. While calling this function, the client program provides a listener object that implements the IDStatusListener interface. When the operation is complete, the onStatus() method in the listener object is invoked.

Input Parameters

Return

This function returns a request ID to the caller. When the operation is complete, the status is provided as the input parameter of the onStatus() method. The listener will receive IDStatus when the operation is completed. The IDStatus contains the list of IDStatusItem, which includes the device ID, error code, and error message of the individual device poll operation.

Error and Exception


changeDeviceHopInfoSynopsispublic Status changeDeviceHopInfo(UserToken token, Device.TransportMethod transMethod, LicenseManagerInterface.IdType idtype, String id, String username, String password, String enablePwd) throws RemoteException;




jobGroup String,

mandatory

A group which the asynchronous job belongs to. If it is set to null, the returned job ID will be used as job group name.


Array of device IDs.

listener IDStatusListener object, mandatory

Object that implements IDStatusListener interface.


OL-13001-05

Chapter 5 Device Management Functions createDeviceByIPAddr

Description

This function changes the username, password, and enable password of a given device, of devices in a group, or of all devices with a specified transport method.

Input Parameters

Return

This function returns Status objects.

Error and Exception


createDeviceByIPAddrSynopsispublic DeviceStatus createDeviceByIPAddr(UserToken token, String ip, String group, DiscoveryAuthInfo devAuthInfo, TransportMethodInfo[] transinfos) throws RemoteException;

Description

This function creates device objects in the inventory with the following parameters.




transtype Device.TransportMethod, mandatory

Ttransport method. Possible values are HTTP, HTTPS, TELNET, SSH.

idtype IdType Specifies whether the following argument is a group ID or a device ID. Possible values are ALL, GROUP, DEVICE. If ALL is specified, the next argument ID is ignored

id String, mandatory Group or device ID.

username String, mandatory Username to be changed. If the value is null, the value of username will not be modified

password String, mandatory Password to be changed. If the value is null, the value of password will not be modified

enablePwd String, mandatory Enable password to be changed. If the value is null, the value of enable password will not be modified. If transMethod is HTTP or HTTPS, this value is ignored.


OL-13001-05

Chapter 5 Device Management Functions createDevicesByUDI

Input Parameters

Return

This function returns DeviceStatus objects. When an error occurs for an element in the input array, the information is contained in the returned status object.

Error and Exception


createDevicesByUDISynopsispublic DeviceStatus createDevicesByUDI(UserToken token, String[] deviceIDs, String group) throws RemoteException;




ip String, mandatory

IP address IP addresses. The address is used for creating a device object.



devAuthInfo Array of usernames and passwords, mandatory

DeviceAuthInfo is used when communicating with devices. It contains an array of username and password pairs.

When Cisco License Manager tries to communicate with the device, an instance of the DeviceAuthInfo in the array is tried one at a time until it can be authenticated by the device. If no authentication is needed for the device, this parameter can be set to null.

To enter the enable password, the username field is set to null, and the enable password is set in the password field.

transinfos Array of TransportMethodInfo, optional

HTTP, HTTPS, TELNET, SSH

Array of TransportMethodInfo used when communicating with devices. TransportMethodInfo consists of port/Device.TransportMethod pair.

If the port is set to -1, the default port for the Transport Method is used. If transinfos is set to null, all transport methods are tried.

When specifying a non-default port for a TransportMethod, you must choose the right port to avoid unpredictable behavior.


OL-13001-05

Chapter 5 Device Management Functions deleteDevices

Description

This function creates device objects in the inventory using a given unique device identifier (UDI). If the group is not specified, the device is added to the default group.

Input Parameters

Return

This function returns DeviceStatus objects. When an error occurs for an element in the input array, the information is contained in the returned status object.

Error and Exception


deleteDevicesSynopsispublic IDStatus deleteDevices(UserToken token, String[] devIDs) throws RemoteException;

Description

This function deletes device objects from the inventory by using the given device IDs.

Input Parameters




deviceIDs Array of string, mandatory


Array of UDIs. Each UDI is used for creating a device object.









OL-13001-05

Chapter 5 Device Management Functions getActiveRMADevices

Return

This function returns IDStatus objects. When there is an error for an element in the input array, the information is contained in the returned status object.

Error and Exception


getActiveRMADevicesSynopsispublic DeviceStatus getActiveRMADevices(UserToken token) throws RemoteException;

Description

This function returns a list of connected devices marked as RMA (meaning return material authorization) in the Cisco License Manager server storage.

Input Parameters

Return

This function returns DeviceStatus, in which the DeviceStatusItem[] contains the device objects.

If there is an operation error, the error code and the error message are in the returned status object.

Error and Exception


getAllowedOperationByDevicePlatformSynopsispublic Device.LicenseOperation[] getAllowedOperationByDevicePlatform(UserToken token, Device.DevicePlatform platform) throws RemoteException;

Description

This function returns an array of allowed operations for a specified platform.





OL-13001-05

Chapter 5 Device Management Functions getDeviceFeatureInfos

Input Parameters

Return

This function returns an array of LicenseOperation, which contains allowed operations for a given device platform.

Error and Exception


getDeviceFeatureInfosSynopsispublic FeatureInfo[] getDeviceFeatureInfos(UserToken token, String devID) throws RemoteException;

public FeatureInfo[] getDeviceFeatureInfos(UserToken token, String devID, Device.DevicePlatform platform) throws RemoteException;

Description

This function retrieves all FeatureInfo of a given device from inventory or retrieves all FeatureInfo of a given device and platform from inventory.

Input Parameters




platform DevicePlatform enum, mandatory

CSL, URLF, CISCO12K, IPS,SANOSDCOS, PIXASA,CSCSSM, MSE

Device platform, which can be any of the following: CSL, URLF, CISCO12K, IPS, SANOSDCOS, PIXASA, CSCSSM, MSE.





OL-13001-05

Chapter 5 Device Management Functions getDevicePIXASAFeatureInfos

Return

This function returns an array of FeatureInfo objects.

Error and Exception


getDevicePIXASAFeatureInfosSynopsispublic PIXASAFeatureInfo getDevicePIXASAFeatureInfos(UserToken token, String devID) throws RemoteException;

Description

This function retrieves PIXASA FeatureInfo of a given device from inventory.

Input Parameters

Return

This function returns the PIXASAFeatureInfo object.

Error and Exception



Unique device ID

platform DevicePlatform enum, mandatory

CSL, URLF, CISCO12K, IPS, SANOSDCOS, PIXASA, CSCSSM, MSE, ACE, UNKNOWN

Device platform.






Unique device ID


OL-13001-05

Chapter 5 Device Management Functions getDeviceRMAJob

getDeviceRMAJobSynopsispublic RMAJob getDeviceRMAJob(UserToken token, String devID) throws RemoteException;

Description

This function retrieves the RMAJob of a given device from inventory.

Input Parameters

Return

This function returns the RMAJob object.

Error and Exception


getDeviceSANOSDCOSFeatureInfosSynopsispublic SANOSDCOSFeatureInfo[] getDeviceSANOSDCOSFeatureInfos(UserToken token, String devID) throws RemoteException;

Description

This function retrieves all SANOSDCOSFeatureInfo of a given device from inventory.

Input Parameters

Return

This function returns an array of SANOSDCOSFeatureInfo objects.





Unique device ID





Unique device ID


OL-13001-05

Chapter 5 Device Management Functions getDiscoveryAuthInfo

Error and Exception


getDiscoveryAuthInfoSynopsispublic DiscoveryAuthInfo getDiscoveryAuthInfo (UserToken token) throws RemoteException;

Description

This function returns DiscoveryAuthInfo, which is a collection of usernames and passwords set by the administrator user during discovery. The user must log in using the administrator role to have permission to invoke this function.

Input Parameters

Return

This function returns a DiscoveryAuthInfo Object.

Error and Exception






OL-13001-05

Chapter 5 Device Management Functions getDiscoverySettings

getDiscoverySettingsSynopsispublic DiscoverySetting[] getDiscoverySettings (UserToken token) throws RemoteException;

Description

This function retrieves all the discovery information after Cisco License Manager is installed. DiscoverySetting is a data structure in data storage, which stores network IP, network mask, TransportMethods, and DiscoveryAuthInfo of each discovery operation. The user must log in using the administrator role to have permission to invoke this function.

Input Parameters

Return

This function returns the DiscoverySetting array, which is available only to a user in the administrator role. If the user is not an administrator user, the function returns a null value. The function returns an empty array if no discovery operation was invoked before this function call.

Error and Exception


getDiscoveryTransports Synopsispublic Device.TransportMethod[] getDiscoveryTransports (UserToken token) throws RemoteException;

Description

This function returns an array of transport methods set by the administrator user during discovery. The user must log in using the administrator role to have permission to invoke this function.

Input Parameters



Token that represents the users authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.





OL-13001-05

Chapter 5 Device Management Functions listAllDevices

Return

This function returns an array of TransportMethods.

Error and Exception


listAllDevicesSynopsispublic DevicePagingInfo listAllDevices(UserToken token,Pagination pageinfo) throws RemoteException;

Description

This function retrieves all devices from inventory.

If a valid offset and a max are entered, pagination is provided. For example, if the result set has 100 records, and you want 10 records at a time, you can request a page at a time by specifying the offset and the max in Pagination:

To get first page:


To get fifth page:




Input Parameters

Return

This function returns the DevicePagingInfo object that includes an array of devices. If the offset is greater than the number of records, it returns an array of zero size.

Error and Exception

If there is an operation error, the Status Object contains an error code and a message.







OL-13001-05

Chapter 5 Device Management Functions listAllDevicesInGroup


listAllDevicesInGroupSynopsispublic IDPagingInfo listAllDevicesInGroup(UserToken token, String group, Pagination pageinfo) throws RemoteException;

Description

This function returns the IDPagingInfo object, which includes status, total count, and an array of device IDs belonging to a given device group. If the group is null, the function returns device IDs in the Default group.

If a valid offset and a max are entered, pagination is provided. For example, if the result set has 100 records, and you want 10 records at a time, you r can request a page at a time by specifying the offset and the max in Pagination:

To get first page:


To get fifth page:




Input Parameters

Return

This function returns IDPagingInfo object, which includes an array of device IDs. If the offset is larger than the number of records, it returns an array of zero size. If there is an operation error, the Status Object contains an error code and a message.

Error and Exception






Name of the device group, or null if the function is looking for the Default group.




OL-13001-05

Chapter 5 Device Management Functions listAllGroupsByDevice

listAllGroupsByDevice Synopsispublic String[] listAllGroupsByDevice(UserToken token, String devID) throws RemoteException;

Description

This function returns an array of groups to which the given device belongs.

Input Parameters

Return

This function returns an array of groups if the device is valid. If the device is invalid, an array of zero size is returned.

Error and Exception


listApplicableDevicesBySKU Synopsispublic String[] listApplicableDevicesBySKUs(UserToken token, SKU[] skus, String group) throws RemoteException;

Description

This function returns an array of device IDs in the given group that have licensable features matching all features in the given SKUs. If group is null, it returns matching IDs in all groups.

Input Parameters





Device ID.





OL-13001-05

Chapter 5 Device Management Functions listDeviceIdsByFilter

Return

This function returns an array of device IDs in the given group that have licensable features matching all features in the given SKUs. If the input SKU array is null or empty, or if there are no features in any of the input SKUs, this function returns all devices. If no matching devices are found, this function returns an array of 0 length.

Error and Exception


Note SKU filtering is not applicable for non Cisco software licensing devices, as the licensable features obtained from the device are not the same as those obtained from SWIFT. This is applicable for PIX, ASA, FWSM, and URLF.

listDeviceIdsByFilterSynopsispublic String[] listDeviceIdsByFilter(UserToken token, String deviceType, String deviceModel, String[] features) throws RemoteException;

Description

This function returns a list of device IDs that contains the device type, device model, and the license feature.

Each filter can be set to null for no filtering. If all filters are set to null, the operation is treated as an error and null is returned.

Input Parameters

Return

This function returns a string array. Each string is a device ID that matches the filter.

sku SKU, mandatory

Valid SKU object Array of SKUs for matching.

group String Group name.





deviceType String, optional String that represents the device type.

deviceModel String, optional String that represents the device model.

features Array of string, optional

String array that represent the license feature names.


OL-13001-05

Chapter 5 Device Management Functions listRunningAsyncOperationJobRecords

Error and Exception


listRunningAsyncOperationJobRecordsSynopsispublic ClmJobStatus listRunningAsyncOperationJobRecords(UserToken token, boolean includeAllUsers) throws RemoteException;

Description

This function returns all of the Cisco License Manager jobs that contain information about the running asynchronous operations that you initiated.

Input Parameters

Return

This function returns a ClmJobStatus object, which includes a list of ClmJobs.

Error and Exception





includeAllUsers Boolean, mandatory

True, False If true, this parameter returns all records. If false, this parameter returns only records containing the username. This also applies to the users logging in with the Administrator role.


OL-13001-05

Chapter 5 Device Management Functions readDevices

readDevicesSynopsispublic DeviceStatus readDevices(UserToken token, String[] devIDs) throws RemoteException;

Description

This function uses the given device ID to retrieve an array of device objects from the inventory.

Input Parameters

Return

This function returns DeviceStatus objects. When an operation error occurs, a DeviceStatus object is returned with information about the error.

Error and Exception


readRMAJobsSynopsispublic RMAJob[] readRMAJobs(UserToken token, String[] ids) throws RemoteException;

Description

This function retrieves RMAJobs of the given Cisco License Manager database object IDs from inventory.

Input Parameters









ids String, mandatory

Cisco License Manager database object IDs for the RMAJob.


OL-13001-05

Chapter 5 Device Management Functions writeDeviceDisplayName

Return

This function returns an array of RMAJob objects.

Error and Exception


writeDeviceDisplayNameSynopsispublic Status writeDeviceDisplayName(UserToken token, String devID, String displayName) throws RemoteException;

Description

This function writes the display name of the given Device object into the inventory.

Input Parameters

Return

This function returns IDStatus objects.

Error and Exception


writeDeviceHopInfoSynopsispublic Status writeDeviceHopInfo(UserToken token, String devID, Device.DevicePlatform platform, DeviceHopInfo[][] infos) throws RemoteException;

Description

This function writes DeviceHopInfo of the given Device object and DevicePlatform into the inventory.





Unique device ID.

displayName String, mandatory

Device display name.


OL-13001-05

Chapter 5 Device Management Functions writeDeviceHopInfo

Input Parameters

Return

This function returns IDStatus objects.

Error and Exception





devID String, mandatory Unique device ID.

platform Device.DevicePlatform

Device platform.

infos Array of DeviceHopInfo

Array of DeviceHopInfo.


OL-13001-05

Chapter 5 Device Management Functions writeDeviceHopInfo


OL-13001-05

JaOL-13001-05

C H A P T E R 6

Folder Management Functions

This chapter provides information about these folder management functions:

addPAKsToFolder, page 6-1

createFolder, page 6-2

deleteFolder, page 6-2

listAllFolders, page 6-3

removePAKsFromFolder, page 6-4

renameFolder, page 6-5

addPAKsToFolderSynopsispublic IDStatus addPAKsToFolder(UserToken token, String[] pakIDs, String folder) throws RemoteException;

Description

This function adds product authorization keys (PAKs) to the specified folder. It is possible to add PAKs to multiple folders. If the client program wants to keep the PAK in a single folder, it should remove the PAK from a previous folder by calling removePAKsFromFolder().

Input Parameters




pakIDs String array, mandatory

Array of PAK IDs to be added to the folder.

folder String, mandatory

Name of the folder.


Chapter 6 Folder Management Functions createFolder

Return

This function returns an IDStatus object. The error number will be SUCCESS if the operation is successful. The IDStatus contains an array of IDStatusItem. The IDStatusItem consists of the PAK ID, error number, and the error message.

Error and Exception


createFolder Synopsispublic Status createFolder(UserToken token, String folder) throws RemoteException;

Description

This function creates a new PAK folder with the given name.

Input Parameters

Return

This function returns the Status object with a ClmErrors.SUCCESS error code.

Error and Exception


deleteFolderSynopsispublic Status deleteFolder(UserToken token, String folder) throws RemoteException;

Description

This function deletes a folder from the system. PAKs in this folder are not deleted. These PAKs are moved to the default folder if they do not already belong to another folder.






Name of the folder.


OL-13001-05

Chapter 6 Folder Management Functions listAllFolders

Input Parameters

Return

This function returns the Status object with theClmErrors.SUCCESS returned in the error code.

Error and Exception


listAllFoldersSynopsispublic IDPagingInfo listAllFolders(UserToken token, Pagination pageinfo) throws RemoteException;

Description

This function returns IDPagingInfo Object, which includes status, total count, and an array of folder names. If a valid offset and a max are entered, pagination is provided. For example, if the result set has 100 records, and you want 10 records at a time, you can request one page at a time by specifying the offset and the max in Pagination:

To get first page:


To get fifth page:








Name of the folder.


OL-13001-05

Chapter 6 Folder Management Functions removePAKsFromFolder

Input Parameters

Return

This function returns the IDPagingInfo object that includes an array of folder names. If the offset is greater than the number of records, it returns an array of zero size.

If there is operation error, the Status object contains the error code and the message.

Error and Exception


removePAKsFromFolder Synopsispublic IDStatus removePAKsFromFolder(UserToken token, String[] pakIDs, String folder) throws RemoteException;

Description

This function removes PAKs from the specified folder. A PAK cannot be removed from the last folder to which it belongs. The PAKs are not deleted. To delete the PAKs from inventory, use the deletePAKs() function.

Input Parameters









pakIDs String array, mandatory

Array of PAK IDs to be removed from the folder.


Name of the folder.


OL-13001-05

Chapter 6 Folder Management Functions renameFolder

Return

This function returns an IDStatus object with SUCCESS returned in the error if the operation is successful. The IDStatus contains an array of IDStatusItem. Each IDStatusItem contain the PAK ID, error number, and the error message.

Error and Exception


renameFolder Synopsispublic Status renameFolder(UserToken token, String oldName, String newName) throws RemoteException;

Description

This function renames a given PAK folder. All PAKs contained in the folder are unchanged.

Input Parameters

Return

This fun

java api reference guide for cisco license manager, … · iii java api reference guide for cisco...

Documents