Table Of Contents

Scheduler Management Functions

listScheduler

registerScheduler

unregisterScheduler

Scheduler Management Functions

---

This chapter provides information about the following scheduler management functions:

•listScheduler

•registerScheduler

•unregisterScheduler

listScheduler

Synopsis

Schedule[] listScheduler(UserToken token) throws RemoteException;

Description

This is a simple scheduling function that allows you to list a scheduled task from the scheduler.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A 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 an array of schedule objects if a schedule has been set. It returns null if a schedule has not been set.

Error and Exception

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

registerScheduler

Synopsis

Status registerScheduler(UserToken token, Schedule.ClmTask task, Schedule execute_time) 
throws RemoteException

Description

This is a simple scheduling function that allows you to schedule the time, frequency, and specific Cisco License Manager action to be performed.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.
task	Schedule.ClmTask, mandatory	—	Schedule.ClmTask object containing a Cisco License Manager-supported task string to be executed through the scheduler.
Execute_time	Schedule, mandatory	—	Schedule object that contains when to execute and frequency of execution.

Return

This function returns a Status object.

Error and Exception

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

When an error occurs, the Status object returns none SUCCESS error code and error message.

unregisterScheduler

Synopsis

Status unregisterScheduler(UserToken token, Schedule.ClmTask taskName) throws 
RemoteException;

Description

This is a simple scheduling function that allows you to remove a scheduled task from the scheduler.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.
taskName	Schedule.ClmTask, mandatory	—	Schedule.ClmTask object containing a Cisco License Manager-supported task string to be executed through the scheduler.

Return

This function returns a Status object.

Error and Exception

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

When an error occurs, the Status object returns none SUCCESS error code and error message.