CiscoTaskManagedObjects.idl

CiscoTaskManagedObjects::TaskAction
CiscoTaskManagedObjects::TaskPersistentTask
CiscoTaskManagedObjects::TaskRuntimeAction
CiscoTaskManagedObjects::TaskRuntimeActionGlobalState
CiscoTaskManagedObjects::TaskRuntimeTask
CiscoTaskManagedObjects::TaskScheduledTask

Module CiscoTaskManagedObjects

The CiscoTaskManagedObjects module defines all the managed objects in the Task Server. You can program your client to browse objects in the Task Repository. You can also program your client to execute any of the following:

Get an attribute value for an object in the Task Server Repository.
Get an object that is contained by another object in the Task Server Repository.
Add an object to the Task Server Repository.
Delete an object from the Task Server Repository.

See Also

CiscoTaskServiceModel, CiscoTaskFactory, CiscoTaskExceptions

Since

Cisco VPN Solutions Center, Release 1.1

Data Structures and Types

ActionErrorCode Enumerated Type

Enumerated error codes

Usage

enum ActionErrorCode
{
Success,
Invalid_Object,
String_Too_Long,
Invalid_Index,
Invalid_List

};

See Also

TaskRuntimeAction, TaskRuntimeActionGlobalState Cisco VPN Solutions Center, Release 1.1

DevTarget Structure

A DevTarget represents a network target(router, netflow collector) in directory repository

Usage

struct DevTarget
{
unsigned long targetID;
string name;
string domain;
string network;
string role;

};

Members

targetID—the ID of the target in directory repository. name—the name of the target. domain—the domain of the target network—the network of the target role—the role of the target

Since

Cisco VPN Solutions Center, Release 1.1

DevTargetSeq User Defined Type

Sequence of DevTarget objects

Usage

typedef sequence<DevTarget> DevTargetSeq

See Also

DevTarget, TaskMgr::getAllTargets

Since

Cisco VPN Solutions Center, Release 1.1

RunStatus Enumerated Type

An enumeration for RuntimeTask and RuntimeAction run status

Usage

enum RunStatus
{
WaitingToRun,
Running,
Exited,
Aborted,
Unknown

};

See Also

TaskRuntimeTask, TaskRuntimeAction Cisco VPN Solutions Center, Release 1.1

TaskActionDependency Structure

A TaskActionDependency object represents a dependency relationship between actions within a persistent task.

Usage

struct TaskActionDependency
{
short dependedActionIndex;
short minActionStatusCode;
short localGlobalFlag;
string statusDesc;

};

Members

dependedActionIndex—short that represents the index of the action upon which the task depends.

minActionStatusCode—short that represents the minimum return code needed for that action.

localGlobalFlag—short that indicates whether the the action is centralized or distributed.

statusDesc—string that indicates the status of the action dependency.

See Also

TaskAction

Since

Cisco VPN Solutions Center, Release 1.1

TaskActionDependencySeq User Defined Type

Sequence of DevTarget objects

Usage

typedef sequence<TaskActionDependency> TaskActionDependencySeq

See Also

DevTarget, TaskMgr::getAllTargets

Since

Cisco VPN Solutions Center, Release 1.1

TaskActionOutput Structure

A TaskActionOutpur represents a summary of output from a runtime task. To get the content of the output, a client program need to get a FileInputStream reference.

Usage

struct TaskActionOutput
{
short index;
string desc;

};

Members

index—the index of the object. desc—a short description about this output.

See Also

TaskRuntimeAction, TaskRuntimeActionGlobalState

Since

Cisco VPN Solutions Center, Release 1.1

TaskActionOutputSeq User Defined Type

Sequence of TaskActionOutput objects

Usage

typedef sequence<TaskActionOutput> TaskActionOutputSeq

See Also

TaskActionOutput, TaskRuntimeAction::getActionOutputList, TaskRuntimeActionGlobalState::getActionOutputList

Since

Cisco VPN Solutions Center, Release 1.1

TaskActionSeq User Defined Type

Sequence of TaskAction objects.

Usage

typedef sequence<TaskAction> TaskActionSeq

See Also

TaskAction, TaskPersistentTask::getActionList

Since

Cisco VPN Solutions Center, Release 1.1

TaskActionTarget Structure

A TaskActionTarget represents a network target(router, netflow collector) on which an action will performs.

Usage

struct TaskActionTarget
{
unsigned long targetID;
short targetType;

};

Members

targetID—the ID of the target in directory repository. targetType—the type of the target.

See Also

TaskAction

Since

Cisco VPN Solutions Center, Release 1.1

TaskActionTargetSeq User Defined Type

Sequence of TaskActionTarget objects

Usage

typedef sequence<TaskActionTarget> TaskActionTargetSeq

See Also

TaskActionTarget, TaskAction::getActionTargetList

Since

Cisco VPN Solutions Center, Release 1.1

TaskArgument Structure

A TaskArgument represents an argument entry. It is a name value pair which will be used to schedule and run the task.

Usage

struct TaskArgument
{
short index;
string tag;
string value;

};

Members

index—the ID of an argument. tag—the tag name of the argument. value—the value of the argument

See Also

TaskAction

Since

Cisco VPN Solutions Center, Release 1.1

TaskArgumentSeq User Defined Type

Sequence of DevTarget objects

Usage

typedef sequence<TaskArgument> TaskArgumentSeq

See Also

DevTarget, TaskMgr::getAllTargets

Since

Cisco VPN Solutions Center, Release 1.1

TaskPersistentTaskSeq User Defined Type

Sequence of TaskPersistentTask objects.

Usage

typedef sequence<TaskPersistentTask> TaskPersistentTaskSeq

See Also

TaskPersistentTask, TaskMgr::getAllPersistentTasks

Since

Cisco VPN Solutions Center, Release 1.1

TaskRuntimeActionGlobalStateSeq User Defined Type

Sequence of TaskRuntimeActionGlobalStateSeq objects

Usage

typedef sequence<TaskRuntimeActionGlobalState> TaskRuntimeActionGlobalStateSeq

See Also

TaskRuntimeActionGlobalStateSeq, TaskRuntimeTask::getRuntimeActionGlobalStateList

Since

Cisco VPN Solutions Center, Release 1.1

TaskRuntimeActionSeq User Defined Type

Sequence of TaskRuntimeAction objects

Usage

typedef sequence<TaskRuntimeAction> TaskRuntimeActionSeq

See Also

TaskRuntimeAction, TaskRuntimeTask::getRuntimeActionList

Since

Cisco VPN Solutions Center, Release 1.1

TaskRuntimeTaskSeq User Defined Type

Sequence of TaskRuntimeTask objects

Usage

typedef sequence<TaskRuntimeTask> TaskRuntimeTaskSeq

See Also

TaskRuntimeTask, TaskMgr::getAllRuntimeTasks, TaskMgr::getRuntimeTasks, TaskMgr::getAllActiveRuntimeTasks

Since

Cisco VPN Solutions Center, Release 1.1

TaskScheduledTaskSeq User Defined Type

Sequence of TaskScheduledTask objects

Usage

typedef sequence<TaskScheduledTask> TaskScheduledTaskSeq

See Also

TaskScheduledTask, TaskMgr::getAllScheduledTasks, TaskMgr::getScheduledTasks

Since

Cisco VPN Solutions Center, Release 1.1

TaskTime User Defined Type

Time—either end time or start time—of a task execution.

Cisco VPN Solutions Center, Release 1.1

Usage

typedef CiscoTime::Time TaskTime

Interface TaskAction

An instance of the TaskAction intrface represents an action within a persistent task object. Some actions may depends on the successful return of some other actions within the task. This dependency relationship is represented by a TaskActionDependency object. To create a correct TaskAction object could become complex. Every attributes needs to be set correctly. Please follow the documentation carefully.

Since

Cisco VPN Solutions Center, Release 1.1

Operations

addActionDependencyListItem()

Appends a TaskActionDependency object to the end of a dependency list.

Usage

long addActionDependencyListItem(
in TaskActionDependency dependency)

raises(
InvalidData);

Parameters

dependency—the TaskActionDependency to be added in.

Returns

a long number which represents the size of the list.

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

TaskActionDependency

Since

Cisco VPN Solutions Center, Release 1.1

addActionTargetListItem()

Appends a TaskActionTarget object to the end of an action target list.

Usage

long addActionTargetListItem(
in TaskActionTarget target)

raises(
InvalidData);

Parameters

target—the TaskActionTarget to be added in.

Returns

a long number which represents the size of the list.

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

TaskActionDependency

Since

Cisco VPN Solutions Center, Release 1.1

addArgumentListItem()

Appends a TaskArgument object to the end of an argument list.

Usage

long addArgumentListItem(
in TaskArgument argument)

raises(
InvalidData);

Parameters

argument—the TaskArgument to be added in.

Returns

a long number which represents the size of the list.

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

TaskArgument

Since

Cisco VPN Solutions Center, Release 1.1

getActionDependencyList()

Gets a TaskActionDependencySeq object which represents the action dependency list contained in this TaskAction object.

Usage

TaskActionDependencySeq getActionDependencyList();
raises(
InvalidData);

Returns

TaskActionDependencySeq—a list of TaskActionDependency objects.

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getActionTargetList()

Gets a TaskActionTargetSeq object which represents the action target list contained in this TaskAction object.

Usage

TaskActionTargetSeq getActionTargetList();
raises(
InvalidData);

Returns

TaskActionTargetSeq—a list of TaskActionTarget objects.

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getArgumentList()

Gets a TaskArgumentSeq object which represents the argument list contained in this TaskAction object.

Usage

TaskArgumentSeq getArgumentList();
raises(
InvalidData);

Returns

TaskArgumentSeq—a list of TaskArgument objects.

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getCategory()

Gets the category of a TaskAction object.

Usage

string getCategory();
raises(
RepException,
InvalidData);

Returns

a string that represents the category of the action. Please refer to API documentation for all the available action categories.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs.

Since

Cisco VPN Solutions Center, Release 1.1

getCentralDistFlag()

Gets the central or distribution flag of a TaskAction object.

Usage

short getCentralDistFlag();
raises(
RepException,
InvalidData);

Returns

a short number that represents the central or distribution flag of the action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getCmd()

Gets the command string of a TaskAction object.

Usage

string getCmd();
raises(
RepException,
InvalidData);

Returns

a string that represents the command of the action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getCmdType()

Gets the command type of a TaskAction object.

Usage

short getCmdType();
raises(
RepException,
InvalidData);

Returns

a short number that represents the command type of the action. Please refer to API documentation for all the pre-defined command types.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getDesc()

Gets the description string of a TaskAction object.

Usage

string getDesc();
raises(
RepException,
InvalidData);

Returns

a string that represents the description of the action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getIndex()

Gets the index of a TaskAction object.

Usage

short getIndex();
raises(
RepException,
InvalidData);

Returns

a short number that represents the index of the action. The index is a unique number among all the actions contained in the same persistent task object.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getName()

Gets the name of a TaskAction object.

Usage

string getName();
raises(
RepException,
InvalidData);

Returns

a string that represents the name of the action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getTargetTag()

Gets the target of a TaskAction object.

Usage

string getTargetTag();
raises(
RepException,
InvalidData);

Returns

a string that represents the target tag of the action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setCategory()

Sets the category of a TaskAction object.

Usage

void setCategory(
in string category)

raises(
RepException,
InvalidData);

Parameters

category—a string that represents the category to be set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setCentralDistFlag()

Sets the central to distribute flag of a TaskAction object.

Usage

void setCentralDistFlag(
in short flag)

raises(
RepException,
InvalidData);

Parameters

flag—a short number that represents the central or distribution flag.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setCmd()

Sets the command of a TaskAction object.

Usage

void setCmd(
in string cmd)

raises(
RepException,
InvalidData);

Parameters

cmd—a string that represents the command to be set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setCmdType()

Sets the command type of a TaskAction object.

Usage

void setCmdType(
in short cmdType)

raises(
RepException,
InvalidData);

Parameters

cmdType—a short number that represents the command type to be set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setDesc()

Sets the description of a TaskAction object.

Usage

void setDesc(
in string desc)

raises(
RepException,
InvalidData);

Parameters

desc—a string that represents the description to be set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setName()

Sets the name of a TaskAction object.

Usage

void setName(
in string name)

raises(
RepException,
InvalidData);

Parameters

name—a string that represents the name to be set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setTargetTag()

Sets the target tag of a TaskAction object.

Usage

void setTargetTag(
in string tag)

raises(
RepException,
InvalidData);

Parameters

tag—a string that represents the target tag to be set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

Interface TaskPersistentTask

An instance of the TaskPersistentTask interface represents a persistent task in the Task Repository. You can program your client to set and get information for a persistent task. You can also add persistent tasks to and remove them from from the Task Repository.

Since

Cisco VPN Solutions Center, Release 1.1

Operations

addToRep()

Adds this persistent task object into repository.

Usage

void addToRep(
in TaskActionSeq actions)

raises(
RepException,
InvalidData);

Parameters

actions—TaskActionSeq object represents a list of actions which are contained in this persistent task

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the input parameter isinvalid or if the persistent task is invalid.

Description

This operation copies all actions and arguments, link the copy with a task object, and adds all of them to the Task Repository

See Also

TaskAction, TaskArgument

Since

Cisco VPN Solutions Center, Release 1.1

getActionList()

Gets the TaskAction objects which are contained in this persistent task.

Usage

TaskActionSeq getActionList();
raises(
RepException,
InvalidData);

Returns

TaskActionSeq—List of TaskAction objects

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the input parameter isinvalid or if the persistent task is invalid.

See Also

TaskAction

Since

Cisco VPN Solutions Center, Release 1.1

getClassName()

Gets the class name of this task

Usage

string getClassName();
raises(
RepException,
InvalidData);

Returns

a string that represents the class name of this persistent task

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getCreationTime()

Gets the creation time of this task

Usage

TaskTime getCreationTime();
raises(
RepException,
InvalidData);

Returns

a TaskTime that represents the creation time of this persistent task

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

CiscoTime::Time

Since

Cisco VPN Solutions Center, Release 1.1

getLastUpdateTime()

Gets the last update time of this task

Usage

TaskTime getLastUpdateTime();
raises(
RepException,
InvalidData);

Returns

a TaskTime that represents the last update time of this persistent task

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

CiscoTime::Time

Since

Cisco VPN Solutions Center, Release 1.1

getTaskDesc()

Gets the description of the task

Usage

string getTaskDesc();
raises(
RepException,
InvalidData);

Returns

a string that represents the description of the task

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getTaskName()

Gets the name of the task

Usage

string getTaskName();
raises(
RepException,
InvalidData);

Returns

a string that represents the name of the task

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

removeFromRep()

Remove this persistent task object from repository. This operation will delete all the contained actions and arguments.

Usage

void removeFromRep();
raises(
RepException,
InvalidData);

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the input parameter isinvalid or if the persistent task is invalid.

Since

Cisco VPN Solutions Center, Release 1.1

setClassName()

Set the class name of this task

Usage

void setClassName(
in string aClassName)

raises(
RepException,
InvalidData);

Parameters

aClassName—a string represents the class name we want's to set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the input parameter isinvalid or if the persistent task is invalid.

Since

Cisco VPN Solutions Center, Release 1.1

setTaskDesc()

Set the description of this task

Usage

void setTaskDesc(
in string desc)

raises(
RepException,
InvalidData);

Parameters

desc—in string that describes the task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the input parameter isinvalid or if the persistent task is invalid.

Since

Cisco VPN Solutions Center, Release 1.1

Interface TaskRuntimeAction

An instance of the TaskRuntimeAction interface represents a runtime action that is contained by a TaskPersistentTask object. Each runtime action tracks the status of the corresponding action.

Operations

getActionOutputFileContent()

Gets a CiscoFileInputStream refernce for one of the log files generated by this TaskRuntimeAction. Through this interface, user can get detail message about how the action performs.

Usage

CiscoStream::CiscoFileInputStream getActionOutputFileContent(
in short index);

Parameters

index—in short that represents the index of the file to be retrieved.

Returns

CiscoStream::CiscoFileInputStream object.

See Also

CiscoStream::CiscoFileInputStream

Since

Cisco VPN Solutions Center, Release 1.1

getActionOutputList()

Gets the action output list of a TaskRuntimeAction object.

Usage

TaskActionOutputSeq getActionOutputList();
raises(
RepException,
InvalidData);

Returns

a TaskActionOutputSeq value that represents the action output list of the runtime action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

TaskActionOutput

Since

Cisco VPN Solutions Center, Release 1.1

getEndTime()

Gets the end time of a TaskRuntimeAction object.

Usage

TaskTime getEndTime();
raises(
RepException,
InvalidData);

Returns

a TaskTime value that represents the end time of the runtime action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getIndex()

Gets the index of a TaskRuntimeAction object.

Usage

short getIndex();
raises(
RepException,
InvalidData);

Returns

a short value that represents the index of the runtime action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getName()

Gets the name of a TaskRuntimeAction object.

Usage

string getName();
raises(
RepException,
InvalidData);

Returns

a string value that represents the name of the runtime action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getRc()

Gets the return code of the TaskRuntimeAction object.

Usage

short getRc();
raises(
RepException,
InvalidData);

Returns

short—Value that represents result status of the runtime task. Here are the possible return-code values:

0—Status unknown.
1—Setup error.
2—Input error.
3—Device connection error.
4—Collection error.
5—Parsing error.
6—Warning.
7—Complete.
8—Success.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getRcDesc()

Gets the return code description of a TaskRuntimeAction object.

Usage

string getRcDesc();
raises(
RepException,
InvalidData);

Returns

string—Description string that corresponds with the return code supplied by the Rc() operation. Here are the descriptions for each Rc() return code:

0—Status unknown.
1—An error occurred during the initialization process. The ECSP_HOME environment variable was not defined, the action was unable to source a necessary file, or the action was otherwise unable to begin.
2—An error occurred while processing the input parameters. Either bad syntax was used, or an invalid filename was supplied. The action cannot continue to execute.
3—The system is unable to connect to a specifed device. A device is either unavailable or a password error occurred. The action skips the inaccessible device and continues to execute.
4—An error occurred during a data-collection process. Either a command did not respond to the action, or the action was otherwise unable to collect the data. The action proceeds for other devices.
5—An error occurred while parsing collected data. This differentiates between an error encountered during a collection process and the actual collected data. The action continues with data collected from other devices.
6—A nonfatal exception occurred when executing the action. This is informational and reports the discrepancy, it is not considered an execution failure.
7—The action completed without errors. For some actions, you may want to distinguish between Complete and Success. For example, when collecting Netflow data, empty data sets may indicate that a Complete but was not truly a Success.
8—The action executed with no exceptional behavior.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getRuntimeActionDesc()

Gets the description of a TaskRuntimeAction object.

Usage

string getRuntimeActionDesc();
raises(
RepException,
InvalidData);

Returns

a string value that represents the description of the runtime action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getStartTime()

Gets the start time of a TaskRuntimeAction object.

Usage

TaskTime getStartTime();
raises(
RepException,
InvalidData);

Returns

a TaskTime value that represents the start time of the runtime action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getStatus()

Gets the run status of a TaskRuntimeAction object.

Usage

RunStatus getStatus();
raises(
RepException,
InvalidData);

Returns

a RunStatus value that represents the run status of the runtime action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

Interface TaskRuntimeActionGlobalState

A TaskRuntimeActionGlobalState instance represents the global state for a TaskRuntimeAction object, which may be executing on a central host (NSM) or on many distributed hosts (mediator).

Description

For future use.

Since

Cisco VPN Solutions Center, Release 1.1,

Operations

getActionOutputFileContent()

Gets a CiscoFileInputStream reference for one of the log files generated by this TaskRuntimeAction.

Usage

CiscoStream::CiscoFileInputStream getActionOutputFileContent(
in short index)

raises(
RepException,
InvalidData);

Parameters

index—the index of the file which the user want to retrieve.

Returns

CiscoStream::CiscoFileInputStream—Text that gives a detailed description of the performance of this action.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Description

Through this interface, you can get detailed messages describing the performance of this action.

See Also

CiscoStream::CiscoFileInputStream

Since

Cisco VPN Solutions Center, Release 1.1

getActionOutputList()

Gets the action output list of a TaskRuntimeActionGlobalState object.

Usage

TaskActionOutputSeq getActionOutputList();
raises(
RepException,
InvalidData);

Returns

a TaskActionOutputSeq value that represents the action output list of the runtime action global state.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

TaskActionOutput

Since

Cisco VPN Solutions Center, Release 1.1

getIndex()

Gets the index of a TaskRuntimeActionGlobalState object.

Usage

short getIndex();
raises(
RepException,
InvalidData);

Returns

a short value that represents the index of the runtime action global state.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getRc()

Gets the return code of a TaskRuntimeActionGlobalState object.

Usage

short getRc();
raises(
RepException,
InvalidData);

Returns

a short value that represents the return code of the runtime action global state.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

RcDesc

Since

Cisco VPN Solutions Center, Release 1.1

getRcDesc()

Gets the return code description of a TaskRuntimeActionGlobalState object.

Usage

string getRcDesc();
raises(
RepException,
InvalidData);

Returns

a short value that represents the return code description of the runtime action global state.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

Since

Cisco VPN Solutions Center, Release 1.1

Interface TaskRuntimeTask

An instance of the TaskRuntimeTask interface represents the runtime object that corresponds with each execution of a TaskScheduledTask object. The scheduler creates a TaskRuntimeTask object each time it executes the tasks that correspond with a TaskScheduledTask object. Each TaskRuntimeTask object monitors all the runtime-action status and return codes for the scheduled tasks. You can program your clients to check the status of each action.

Since

Cisco VPN Solutions Center, Release 1.1

Operations

getClassName()

Gets the class name of the TaskRuntimeTask object.

Usage

string getClassName();
raises(
RepException,
InvalidData);

Returns

a string that represents the class name of the runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getEndTime()

Gets the end time of the TaskRuntimeTask object.

Usage

TaskTime getEndTime();
raises(
RepException,
InvalidData);

Returns

a TaskTime that represents the end time of the runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getID()

Gets the ID of a TaskRuntimeTask object.

Usage

string getID();
raises(
RepException,
InvalidData);

Returns

a string that represents the ID of the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getName()

Gets the name of a TaskRuntimeTask object.

Usage

string getName();
raises(
RepException,
InvalidData);

Returns

a string that represents the name of the runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getRc()

Gets the return code of the TaskRuntimeTask object.

Usage

short getRc();
raises(
RepException,
InvalidData);

Returns

short—Value that represents result status of the runtime task. Here are the possible return-code values:

0—Status unknown.
1—Setup error.
2—Input error.
3—Device connection error.
4—Collection error.
5—Parsing error.
6—Warning.
7—Complete.
8—Success.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getRcDesc()

Gets the return code description of the TaskRuntimeTask object.

Usage

string getRcDesc();
raises(
RepException,
InvalidData);

Returns

string—Description string that corresponds with the return code supplied by the Rc() operation. Here are the descriptions for each Rc() return code:

0—Status unknown.
1—An error occurred during the initialization process. The ECSP_HOME environment variable was not defined, the action was unable to source a necessary file, or the action was otherwise unable to begin.
2—An error occurred while processing the input parameters. Either bad syntax was used, or an invalid filename was supplied. The action cannot continue to execute.
3—The system is unable to connect to a specifed device. A device is either unavailable or a password error occurred. The action skips the inaccessible device and continues to execute.
4—An error occurred during a data-collection process. Either a command did not respond to the action, or the action was otherwise unable to collect the data. The action proceeds for other devices.
5—An error occurred while parsing collected data. This differentiates between an error encountered during a collection process and the actual collected data. The action continues with data collected from other devices.
6—A nonfatal exception occurred when executing the action. This is informational and reports the discrepancy, it is not considered an execution failure.
7—The action completed without errors. For some actions, you may want to distinguish between Complete and Success. For example, when collecting Netflow data, empty data sets may indicate that a Complete but was not truly a Success.
8—The action executed with no exceptional behavior.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getRuntimeActionGlobalStateList()

Gets the list of TaskRuntimeActionGlobalState objects that are contained by this TaskRuntimeTask object.

Usage

TaskRuntimeActionGlobalStateSeq getRuntimeActionGlobalStateList();
raises(
RepException,
InvalidData);

Returns

TaskRuntimeActionGlobalStateSeq—List of TaskRuntimeActionGlobalState objects that is contained by this TaskRuntimeTask object.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

TaskRuntimeActionGlobalState

Since

Cisco VPN Solutions Center, Release 1.1

getRuntimeActionList()

Gets the runtime action list which contains in this runtime task.

Usage

TaskRuntimeActionSeq getRuntimeActionList();
raises(
RepException,
InvalidData);

Returns

a TaskRuntimeActionSeq that represent a list of TaskRuntimeAction objects which is contained in this runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

TaskRuntimeAction

Since

Cisco VPN Solutions Center, Release 1.1

getRuntimeTaskDesc()

Gets the return code description of the TaskRuntimeTask object.

Usage

string getRuntimeTaskDesc();
raises(
RepException,
InvalidData);

Returns

a string that represents the return code description of the runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getScheduledTask()

Gets the TaskScheduledTask object that this TaskRuntimeTask object is executing.

Usage

TaskScheduledTask getScheduledTask();
raises(
RepException,
InvalidData);

Returns

a TaskScheduledTask that represents the scheduled task the runtime task runs.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getScheduledTime()

Gets the schedule time of the TaskRuntimeTask object.

Usage

TaskTime getScheduledTime();
raises(
RepException,
InvalidData);

Returns

a TaskTime that represents the schedule time of the runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getStartTime()

Gets the start time of the TaskRuntimeTask object.

Usage

TaskTime getStartTime();
raises(
RepException,
InvalidData);

Returns

a TaskTime that represents the start time of the runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getStatus()

Gets the run status of the TaskRuntimeTask object.

Usage

RunStatus getStatus();
raises(
RepException,
InvalidData);

Returns

a RunStatus that represents the run status of the runtime task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

removeFromRep()

Remove the runtime task from repository.

Usage

void removeFromRep();
raises(
RepException,
InvalidData);

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

Interface TaskScheduledTask

An instance of the TaskScheduledTask interface represents a scheduled task. A scheduled task is defines how and when a scheduler is to execute a given task. A TaskPersistentTask object may have multiple TaskScheduledTask objects, which means the persistent task may have multiple schedules.

See Also

TaskPersistentTask

Since

Cisco VPN Solutions Center, Release 1.1

Operations

addToRep()

Add the TaskScheduledTask object into repository.

Usage

void addToRep(
in TaskPersistentTask persistentTask)

raises(
RepException,
InvalidData);

Parameters

persistentTask—in TaskPersistentTask that represents the persistent task to be scheduled.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs.

Since

Cisco VPN Solutions Center, Release 1.1

getAssertionList()

get the assertion list for the TaskScheduledTask object.

Usage

TaskArgumentSeq getAssertionList();
raises(
RepException,
InvalidData);

Returns

TaskArgumentSeq—represents the assertion list for the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getCronSpec()

Gets the cron spec of a TaskScheduledTask object. It is a Unix-like cron string which specifies when and how often the task will run.

Usage

string getCronSpec();
raises(
RepException,
InvalidData);

Returns

a string that represents the cron spec of the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getDesc()

Gets the description of the TaskScheduledTask object.

Usage

string getDesc();
raises(
RepException,
InvalidData);

Returns

a string that represents the description of the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getName()

Gets the name of a TaskScheduledTask object.

Usage

string getName();
raises(
RepException,
InvalidData);

Returns

a string that represents the name of the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getPersistentTask()

Gets the TaskPersistentTask object that is scheduled by this TaskScheduledTask object.

Usage

TaskPersistentTask getPersistentTask();
raises(
RepException,
InvalidData);

Returns

TaskPersistentTask—Represents the persistent task that this task is scheduling.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getTimeScheduled()

Gets the creation time of the TaskScheduledTask object.

Usage

TaskTime getTimeScheduled();
raises(
RepException,
InvalidData);

Returns

a TaskTime that represents the creation time of the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

See Also

CiscoTime::Time

Since

Cisco VPN Solutions Center, Release 1.1

getType()

Gets the type of a TaskScheduledTask object.

Usage

string getType();
raises(
RepException,
InvalidData);

Returns

a string that represents the type of the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

getUser()

Gets the user of a TaskScheduledTask object. Usually, it is the id of the user who creates the scheduled task.

Usage

string getUser();
raises(
RepException,
InvalidData);

Returns

a string that represents the user of the scheduled task.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

removeFromRep()

Remove the TaskScheduledTask object from repository.

Usage

void removeFromRep();
raises(
RepException,
InvalidData);

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the schedule task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setActive()

Sets the active Assertion for the TaskScheduledTask object.

Usage

void setActive(
in boolean active)

raises(
InvalidData);

Parameters

active—a boolean that represents the active asserion of the task

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setCronSpec()

Sets the cron spec of the TaskScheduledTask object.

Usage

void setCronSpec(
in string scheduleCronSpec)

raises(
RepException,
InvalidData);

Parameters

scheduleCronSpec—a string that represents the cron spec to be set. The format of the string is defined as: (minutes hours dayOfMonth monthOfYear dayOfWeek) - each is a string

NOTES 1. the second num of range must be greater than or equal to first num 2. the third num of range must be greater than or equal to 1 and indicates an interval 3. all nums must be less than the size of the given vector 4. If there are any errors, nothing is set 5. this uses the funny thing with cron for specifying day. In parentheses is how cron treats the two specifications

day of month day of week interpretation * * every day 1,15 (AND) * only the first and fifteenth (AND) 0 only on sundays 1,15 (OR) 0 on first and fifteenth and sundays

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setDesc()

Sets the description of the TaskScheduledTask object.

Usage

void setDesc(
in string desc)

raises(
RepException,
InvalidData);

Parameters

desc—a string that represents the description of the task

Raises

CiscoTaskExceptions::RepException if repository error happens CiscoTaskExceptions::InvalidData if the persistent task objectis not valid.

Since

Cisco VPN Solutions Center, Release 1.1

setEarliestStart()

Sets the earliest start time of the TaskScheduledTask object.

Usage

void setEarliestStart(
in TaskTime time)

raises(
InvalidData);

Parameters

time—a TaskTime that represents the earliest start time of the scheduled task

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setExpired()

Sets the expired Assertion for the TaskScheduledTask object.

Usage

void setExpired(
in boolean expired)

raises(
InvalidData);

Parameters

expired—a boolean that represents the expired asserion of the task

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setInternal()

Sets the internal Assertion for the TaskScheduledTask object.

Usage

void setInternal(
in boolean internal)

raises(
InvalidData);

Parameters

internal—a boolean that represents the internal asserion of the task

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setLatestStart()

Sets the latest start time of the TaskScheduledTask object.

Usage

void setLatestStart(
in TaskTime time)

raises(
InvalidData);

Parameters

time—a TaskTime that represents the latest start time of the task

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setNumberOfTimes()

Sets the NumberOfTimes Assertion for the TaskScheduledTask object.

Usage

void setNumberOfTimes(
in long n)

raises(
InvalidData);

Parameters

n—a long that represents the NumberOfTimes asserion of the task

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setStartNow()

Sets the start_now Assertion for the TaskScheduledTask object.

Usage

void setStartNow(
in boolean now)

raises(
InvalidData);

Parameters

now—a boolean that represents the start_now asserion of the task

Raises

CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setType()

Sets the type of the TaskScheduledTask object.

Usage

void setType(
in string scheduleType)

raises(
RepException,
InvalidData);

Parameters

scheduleType—a string that represents the schedule type to be set.

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

setUser()

Sets the user of the TaskScheduledTask object.

Usage

void setUser(
in string scheduleUser)

raises(
RepException,
InvalidData);

Parameters

scheduleUser—a string that represents the user of the task

Raises

CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the persistent task is invalid or contains invalid data.

Since

Cisco VPN Solutions Center, Release 1.1

Table of Contents

CiscoTaskManagedObjects.idl