CH A P T E R
15
Utility Functions
This chapter provides information about these troubleshooting utility functions:
•
checkCiscoPortalConnection, page 15-1
•
checkDeviceConnection, page 15-2
•
getServerProperties, page 15-2
•
getVersion, page 15-3
checkCiscoPortalConnection
Synopsis
public Status checkCiscoPortalConnection(UserToken token) throws RemoteException;
Description
This function checks the health of the Cisco Product License Registration Portal connection.
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.
Return
This function returns a Status object. If there is an operation error, the error number and the error
message are in the returned status object.
Error and Exception
If a system error prevents the operation from completing, a RemoteException is thrown.
Java API Reference Guide for Cisco License Manager
OL-13001-05
15-1
Chapter 15
Utility Functions
checkDeviceConnection
checkDeviceConnection
Synopsis
public Status checkDeviceConnection(UserToken token, String devID) throws RemoteException;
Description
This function checks the health of a device connection.
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.
devID
String,
mandatory
—
Device ID where the connection is to be
checked.
Return
This function returns a Status object. If there is an operation error, the error number and the error
message are in the returned status object.
Error and Exception
If a system error prevents the operation from completing, a RemoteException is thrown.
getServerProperties
Synopsis
public Properties getServerProperties(UserToken token) throws RemoteException;
Description
This function retrieves configuration properties from server. The REQUEST_LIMIT property key is
supported.
This property sets a limit on the number of items that an incoming request can contain. Bulk operations
that take an array of multiple items of Device, PAK, License, LicenseLine IDs or Objects are subject to
a limit check. The limit is configured at the server side.
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.
Java API Reference Guide for Cisco License Manager
15-2
OL-13001-05
Chapter 15
Utility Functions
getVersion
Return
This function returns the Properties object, which contains server configuration properties.
Error and Exception
If a system error prevents the operation from completing, a RemoteException is thrown.
getVersion
Synopsis
public Version getVersion(UserToken token) throws RemoteException;
Description
This function returns the Cisco License Manager version and build number.
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.
Return
This function returns the Version object, which includes Cisco License Manager version and build
number.
Error and Exception
If a system error prevents the operation from completing, a RemoteException is thrown.
Java API Reference Guide for Cisco License Manager
OL-13001-05
15-3
Chapter 15
Utility Functions
getVersion
Java API Reference Guide for Cisco License Manager
15-4
OL-13001-05