Table of Contents

Scheduler and Task Manager Events

Subject Names

Subjects for Task-level Events
Subjects for Action-level Events

Event Data Structure

Event Data for Task-level Events
Event Data for Action-level Events

Repository Events

VPN Inventory Repository

Subjects for Events in the VPN Inventory Repository
Event Data for VPN Inventory Repository Events

Task Repository

Subjects for Events in the Task Repository
Event Data for Task Repository Events

Subject Specifications for Events

The TIB/Rendezvous software—for which access to third-party client application developers is given through the Event Gateway server and the CiscoEventGateway::EventGateway interface—divides event space according to hierarchical subjects in an a.b.c.d format. A client application can use a CiscoEventGateway::Callback object to subscribe to specific subjects of interest or groups of subjects. The events are implemented using a self-describing data structure consisting of name=value pairs where the name is textual and the value is a variant data type that is supported by the CORBA::any type.

In CORBA, there are two standard event services, CosEvent and its successor (and superset) CosNotification. These services divide the event space into a series of event channels, each identified by a CORBA interoperable object reference (IOR). These standard event services use the CORBA any data type to describe arbitrary data.

Events are described using the following structures.

struct MsgField {
  string name;
  any data;
};
 
struct Msg {
  sequence<MsgField> fields;
};
 
struct Event {
  string subject;
  Msg msg;
};
 
typedef sequence<Event> EventSeq;
 

These structures closely parallel the TIB/Rendezvous event structure and allow for self-describing messages. Each Event structure contains the subject to which it is published and the message that is published for it.

A message is a sequence of MsgField structures. A MsgField structure contains a name=data pair, where the data is represented as a CORBA any object. It is important to note that the names are not necessarily unique within the Msg structure. Also, the data value can be a nested instance of the Msg structure, allowing the construction of complex messages. For examples of complex Msg structures, see the "Event Data for Task Repository Events" section.

Using this self-describing data format, the gateway process is kept simple and does not require an interface change each time new Cisco VPN Solutions Center subjects and events are added. In addition, events can be extended to include additional information over time without requiring recompilation of existing client code to continue to receive the events.

Scheduler and Task Manager Events

Each run-time task notifies the Event Gateway server of events that signal the beginning and end of its execution. Similarly, it also notifies the Event Gateway server of events for each of the actions of which it is composed.

Subject Names

Because both task-level and action-level events are generated by the Scheduler and Task Manager, the subject names for these event fall into two categories:

• Task-level events

• Action-level events

The specific subjects for these categories are described, respectively, in the "Subjects for Task-level Events" and "Subjects for Action-level Events" sections.

Subjects for Task-level Events

The subjects for the task-level events composed of one of the following basic structures:

• cisco.vpnsc.sched.task.task_type.begin

• cisco.vpnsc.sched.task.task_type.end

• cisco.vpnsc.sched.task.task_type.abort

where task_type is a placeholder for one of the strings listed in the "Task Type" column of Table 11-1.

Table 11-1: Task Types for Task-level Events

Task Type	Description
deployServiceRequest	Deploy service requests.
getAcct	Collect VPN accounting data.
getConfig	Collect router configuration files.
getNetNReports	Collect configuration and run reports.
saAgent	Provision SLA definitions and collect SLA data.
vpnDef	Collect VPN routing information.
vpnBaseline	Generate service request audit reports.

Subjects for Action-level Events

The subjects for the task-level events composed of one of the following basic structures:

• cisco.vpnsc.sched.action.action_type.begin

• cisco.vpnsc.sched.action.action_type.end

• cisco.vpnsc.sched.action.action_type.abort

where action_type is a placeholder for one of the strings listed in the "Action Type" column of Table 11-2.

Table 11-2: Action Types for Action-level Events

Action Type	Description
DeployServiceRequest	Deploy service requests.
GenerateAuditReportsAndTopologies	Generate service request audit reports.
CollectConfig	Collect configuration data.
CollectVPNDef	Part of the vpnDef task.
CollectStats	Collect configuration and run reports.
CollectRT	Collect VPN routing information.
CollectSaa	Collect SA Agent data.
CreateSLA	Create a service-level agreement.
DeleteSLA	Delete a service-level agreement.
CollectSLAData	Collect SLA performance data.
EnableTraps	Registers SNMP traps for configuration changes.
DisableTraps	Deregisters SNMP traps for configuration changes.
GenerateVPNAuditReportsAndTopologies	Part of the vpnBaseline task.
RunReports	Collect configuration and run reports.

Event Data Structure

The event data structures, like the subjects for the Scheduler and Task Manager events, fall into two categories:

• Task-level events

• Action-level events

The specific event-data structures for these categories are described, respectively, in the "Event Data for Task-level Events" and "Event Data for Action-level Events" sections.

Event Data for Task-level Events

The event data for task-level events composed of the name=value pairs listed in Table 11-3.

Table 11-3: Event Data for Task-level Events

Name	Type	Value Description
vers	unsigned short	Message version number.
ts	unsigned long	Timestamp (ms)
taskType	string	See the task types listed in Table 11-1
taskName	string	User-defined task name
taskId	string	Persistent task Id
trtId	string	Runtime task Id
statusCode	unsigned short	0 - 8
statusDesc	string	System-derived, from task statusCode

Event Data for Action-level Events

The event data for action-level events composed of the name=value pairs listed in Table 11-4.

Table 11-4: Event Data for Task-level Events

Name	Type	Value Description
Vers	unsigned short	Message version number.
Ts	unsigned long	Timestamp (ms)
TaskType	string	See the task types listed in Table 11-1
TaskName	string	User-defined task name
TaskId	string	Persistent task Id
TrtId	string	Runtime task Id
StatusCode	unsigned short	0 - 8
StatusDesc	string	System-derived, from task StatusCode

Repository Events

Subject names for all repository events are structured in the following manner:

  cisco.vpnsc.rep.mediatorName.repositoryName.objectName.action

where:

• Cisco.vpnsc.rep is the common prefix for all repository events

• mediatorName is the name of the mediator that sent the event—currently hard-coded to m1.

• repositoryName is the name of the repository—dir, col, task, or vi—in which the event occurred

• objectType is the name—not a name field of a VPN Inventory repository object—of the repository object which related to this event.

• action indicates the type of repository change: create, modify, or remove

An example of subject name is:

  cisco.vpnsc.m1.repository.vi.customer.create

This subject indicates that a new CiscoVsmBrowser::VsmCustomer object was added to the VPN Inventory repository.

VPN Inventory Repository

Using the ESS you can subscribe CiscoEventGateway::Callback objects to the subjects for the VPN Inventory repository that are listed in the following sections.

Subjects for Events in the VPN Inventory Repository

For CiscoVsmBrowser::VsmProviderAdminDomain events, there are three subjects that are structured as:

  cisco.vpnsc.rep.m1.vi.vsmObjectType.action

where vsmObjectType loosely corresponds with the namespaces of the CiscoVsmBrowser interfaces. The action values are specific to each of the valid vsmObjectType values. Specific vsmObjectType values are listed in the sections that follow.

Subjects for CiscoVsmBrowser::VsmProviderAdminDomain Events

For CiscoVsmBrowser::VsmProviderAdminDomain events, there are three subjects that are structured as:

  cisco.vpnsc.rep.m1.vi.providerAdminDomain.action

where you can substitute any of the items in the "Action Value" column of Table 11-5 for the action field of the subject expression. Table 11-5 also shows the specific API operations that trigger these events upon execution.

Table 11-5: Action Values for CiscoVsmBrowser::VsmProviderAdminDomain Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmProviderAdminDomainCreator::addToRep()
modify	CiscoVsmFWModifier::VsmProviderAdminDomainModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeProviderAdminDomainFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-6 for the action field of the subject expression. Table 11-6 also shows the specific API operations that trigger these events upon execution.

Table 11-6: Action Values for CiscoVsmBrowser::VsmCosProfile Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep()
modify	CiscoVsmFWModifier::VsmCoSProfileModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeCoSProfileFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-7 for the action field of the subject expression. Table 11-7 also shows the specific API operations that trigger these events upon execution.

Table 11-7: Action Values for CiscoVsmBrowser::VsmRtSeed Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VpnInvMgr::addRTSeed()
remove	CiscoVpnServiceModel::VpnInvMgr::removeRTSeed()

where you can substitute any of the items in the "Action Value" column of Table 11-8 for the action field of the subject expression. Table 11-8 also shows the specific API operations that trigger these events upon execution.

Table 11-8: Action Values for CiscoVsmBrowser::VsmVPN Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmVPNCreator::addToRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeVPNFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-9 for the action field of the subject expression. Table 11-9 also shows the specific API operations that trigger these events upon execution.

Table 11-9: Action Values for CiscoVsmBrowser::VsmCERC Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmCERCCreator::addToRep()
modify	CiscoVsmFWModifier::VsmCERCModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeCERCFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-10 for the action field of the subject expression. Table 11-10 also shows the specific API operations that trigger these events upon execution.

Table 11-10: Action Values for CiscoVsmBrowser::VsmRegion Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmRegionCreator::addToRep()
modify	CiscoVsmFWModifier::VsmRegionModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeRegionFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-11 for the action field of the subject expression. Table 11-11 also shows the specific API operations that trigger these events upon execution.

Table 11-11: Action Values for CiscoVsmBrowser::VsmPE Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmPECreator::addToRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removePEFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-12 for the action field of the subject expression. Table 11-12 also shows the specific API operations that trigger these events upon execution.

Table 11-12: Action Values for CiscoVsmBrowser::VsmCustomer Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmCustomerCreator::addToRep()
modify	CiscoVsmFWModifier::VsmCustomerModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeCustomerFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-13 for the action field of the subject expression. Table 11-13 also shows the specific API operations that trigger these events upon execution.

Table 11-13: Action Values for CiscoVsmBrowser::VsmCustomerSite Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep()
modify	CiscoVsmFWModifier::VsmCustomerSiteModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeCustomerSiteFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-14 for the action field of the subject expression. Table 11-14 also shows the specific API operations that trigger these events upon execution.

Table 11-14: Action Values for CiscoVsmBrowser::VsmCE Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmCECreator::addToRep()
modify	CiscoVsmFWModifier::VsmCEModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeCEFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-15 for the action field of the subject expression. Table 11-15 also shows the specific API operations that trigger these events upon execution.

Table 11-15: Action Values for CiscoVsmBrowser::VsmConfiglet Subjects

Action Value	Corresponding API Operations
create	CiscoVsmFWCreator::VsmCECreator::addToRep()
modify	CiscoVsmFWModifier::VsmCEModifier::updateRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeCEFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-16 for the action field of the numberedAddressPool subject expression, and you can substitute any of the items in the "Action Value" column of Table 11-17 for the action field of the unnumberedAddressPool subject expression. Table 11-16 and Table 11-17 also show the specific API operations that trigger these events upon execution.

Table 11-16: Action Values for "Numbered" CiscoVsmBrowser::VsmIPAddressPool Subjects

Action Value	Corresponding API Operations
create	CiscoVpnServiceModel::VpnInvMgr::addIPAddressPool30()
remove	CiscoVpnServiceModel::VpnInvMgr::removeIPAddressPool30()
allocate	CiscoVsmBrowser::VsmRegion::getNext30Address()
deallocate	CiscoVsmBrowser::VsmRegion::freeIPAddress30()

where you can substitute any of the items in the "Action Value" column of Table 11-18 for the action field of the subject expression. Table 11-18 also shows the specific API operations that trigger these events upon execution.

Table 11-18: Action Values for CiscoVsmBrowser::VsmConfiglet Subjects

Action Value	Corresponding API Operations
requested	CiscoVsmSRCreator::VsmConnectivityCreator::addToRep()
pending	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
invalid	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
failed	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
deployed	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
functional	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
lost	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
broken	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
closed	CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep()
remove	CiscoVpnServiceModel::VpnInvMgr::removeSRVCFromRep

Event Data for VPN Inventory Repository Events

Event data is constructed based on the object type to which with the subject corresponds. The following sections describe the event data for each of the event generated by the VPN Inventory repository.

Event Data for CiscoVsmBrowser::VsmProviderAdminDomain Events

Event data for CiscoVsmBrowser::VsmProviderAdminDomain events is composed of the name=value pairs listed in Table 11-19.

Table 11-19: Event Data for CiscoVsmBrowser::VsmProviderAdminDomain Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
contactInfo	string	See API Programmer Reference.
asNumber	unsigned long	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmCosProfile events is composed of the name=value pairs listed in Table 11-20.

Table 11-20: Event Data for CiscoVsmBrowser::VsmCosProfile Events

Name	Type	Value Description
providerName	string	See API Programmer Reference for details.
profileId	unsigned long	See API Programmer Reference for details.
profileName	string	See API Programmer Reference for details.
isDefault	boolean	See API Programmer Reference for details.
configuration	unsigned long	See API Programmer Reference for details.
outOfContractMultiplier	float	See API Programmer Reference for details.
cosClasses	sequence<CoSClass>	See Table 11-21

Event Data for CiscoVsmBrowser::VsmRtSeed Events

Event data for CiscoVsmBrowser::VsmRtSeed events is composed of the name=value pairs listed in Table 11-22.

Table 11-22: Event Data for CiscoVsmBrowser::VsmRtSeed Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
rtSeed	string	See API Programmer Reference.
offset	unsigned long	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmVPN events is composed of the name=value pairs listed in Table 11-23.

Table 11-23: Event Data for CiscoVsmBrowser::VsmVPN Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
vpnName	string	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmCERC events is composed of the name=value pairs listed in Table 11-24.

Table 11-24: Event Data for CiscoVsmBrowser::VsmCERC Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
vpnName	string	See API Programmer Reference.
cercId	unsigned long	See API Programmer Reference.
hubRt	string	See API Programmer Reference.
spokeRt	string	See API Programmer Reference.
description	string	See API Programmer Reference.
autoPick	boolean	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmRegion events is composed of the name=value pairs listed in Table 11-25.

Table 11-25: Event Data for CiscoVsmBrowser::VsmRegion Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
regionId	unsigned long	See API Programmer Reference.
regionName	string	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmPE events is composed of the name=value pairs listed in Table 11-26.

Table 11-26: Event Data for CiscoVsmBrowser::VsmPE Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
vpnName	string	See API Programmer Reference.
targetId	unsigned long	See API Programmer Reference.
hostName	string	See API Programmer Reference.
networkName	string	See API Programmer Reference.
domainName	string	See API Programmer Reference.
routerPasswords	string	See API Programmer Reference.
routerInterfaces	string	See API Programmer Reference.
extString	string	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmCustomer events is composed of the name=value pairs listed in Table 11-27.

Table 11-27: Event Data for CiscoVsmBrowser::VsmCustomer Events

Name	Type	Value Description
customerName	string	See API Programmer Reference.
contactInfo	string	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmCustomerSite events is composed of the name=value pairs listed in Table 11-28.

Table 11-28: Event Data for CiscoVsmBrowser::VsmCustomerSite Events

Name	Type	Value Description
customerName	string	See API Programmer Reference.
siteId	unsigned long	See API Programmer Reference.
siteName	string	See API Programmer Reference.
locationInfo	string	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmCE events is composed of the name=value pairs listed in Table 11-29.

Table 11-29: Event Data for CiscoVsmBrowser::VsmCE Events

Name	Type	Value Description
customerName	string	See API Programmer Reference.
siteName	string	See API Programmer Reference.
targetId	unsigned long	See API Programmer Reference.
hostName	string	See API Programmer Reference.
networkName	string	See API Programmer Reference.
domainName	string	See API Programmer Reference.
routerPasswords	sequence<string>	See API Programmer Reference.
routerInterfaces	sequence<string>	See API Programmer Reference.
type	short	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmConfiglet events is composed of the name=value pairs listed in Table 11-30.

Table 11-30: Event Data for CiscoVsmBrowser::VsmConfiglet Events

Name	Type	Value Description
targetId	unsigned long	See API Programmer Reference.
srvcIds	sequence<unsigned long>	See API Programmer Reference.
configletId	unsigned long	See API Programmer Reference.
configletText	string	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmIPAddressPool events is composed of the name=value pairs listed in Table 11-30.

Table 11-31: Event Data for CiscoVsmBrowser::VsmIPAddressPool Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
regionId	unsigned long	See API Programmer Reference.
regionName	string	See API Programmer Reference.
address	string	See API Programmer Reference.

Event data for CiscoVsmBrowser::VsmSRVC events is composed of the name=value pairs listed in Table 11-29.

Table 11-32: Event Data for CiscoVsmBrowser::VsmSRVC Events

Name	Type	Value Description
providerName	string	See API Programmer Reference.
customerName	string	See API Programmer Reference.
cosProfileName	string	See API Programmer Reference.
peId	unsigned long	See API Programmer Reference.
ceId	unsigned long	See API Programmer Reference.
subsumedSrvcIds	sequence<unsigned long>	See API Programmer Reference.
id	unsigned long	See API Programmer Reference.
type	unsigned long	See API Programmer Reference.
createTime	unsigned long	See API Programmer Reference.
lastStateChangeTime	unsigned long	See API Programmer Reference.
user	string	See API Programmer Reference.
creator	string	See API Programmer Reference.
isAutoPickAddress	boolean	See API Programmer Reference.
isIpUnnumbered	boolean	See API Programmer Reference.
peCeLinkProtocol	short	See API Programmer Reference.
peInterface	string	See API Programmer Reference.
ceInterface	string	See API Programmer Reference.
peInterfaceAddress	string	See API Programmer Reference.
ceInterfaceAddress	string	See API Programmer Reference.
isPeInterfaceShutdown	boolean	See API Programmer Reference.
vrfName	string	See API Programmer Reference.
rd	string	See API Programmer Reference.
isVrfRdOverwrite	boolean	See API Programmer Reference.
cercMembers	sequence<CercMember>	See API Programmer Reference.
isGreyManagementSrvc	boolean	See API Programmer Reference.
extString	string	See API Programmer Reference.
isOnlyDefualtRouteToCe	boolean	See API Programmer Reference.
isMemberGreyManagementVPN	boolean	See API Programmer Reference.
ceAsNumber	unsigned long	See API Programmer Reference.
ceAdvertisedRoutes	string	See API Programmer Reference.
routesToAllSites	sequence<string>	See API Programmer Reference.
ceRedistributedProtocols	sequence<string>	See API Programmer Reference.
peInterfaceType	unsigned long	See API Programmer Reference.
ceInterfaceType	unsigned long	See API Programmer Reference.
peInterfaceEncapsulation	unsigned long	See API Programmer Reference.
ceInterfaceEncapsulation	unsigned long	See API Programmer Reference.
peCircuitId	CircuitId	See API Programmer Reference.
ceCircuitId	CircuitId	See API Programmer Reference.
peTemplate	string	See API Programmer Reference.
ceTemplate	string	See API Programmer Reference.
peInterfaceTemplate	string	See API Programmer Reference.
ceInterfaceTemplate	string	See API Programmer Reference.
exportMapName	string	See API Programmer Reference.
importMapName	string	See API Programmer Reference.
isNetflowAccountingOn	boolean	See API Programmer Reference.
maxRoutes	long	See API Programmer Reference.
isAsOverride	boolean	See API Programmer Reference.
maxAsOccurrenceInPath	short	See API Programmer Reference.
isCeLoopbackInterfaceRequired	boolean	See API Programmer Reference.
ceLoopbackInterfaceAddress	string	See API Programmer Reference.
stateHistory	sequence<StateHistory>	See API Programmer Reference.
auditText	string	See API Programmer Reference.

Table 11-33: Event Data for CercMember substructure from Table 11-31

Name	Type	Value Description
cercId	unsigned long	See API Programmer Reference.
useHubRt	boolean	See API Programmer Reference.

Table 11-34: Event Data for CircuitId substructure from Table 11-31

Name	Type	Value Description
id1	unsigned long	See API Programmer Reference.
id2	unsigned long	See API Programmer Reference.
id3	unsigned long	See API Programmer Reference.

Table 11-35: Event Data for StateHistory substructure from Table 11-31

Name	Type	Value Description
time	unsigned long	See API Programmer Reference.
comments	string	See API Programmer Reference.

Task Repository

Using the ESS you can subscribe CiscoEventGateway::Callback objects to the subjects for the Task repository that are listed in the following sections.

Subjects for Events in the Task Repository

For CiscoVsmBrowser::VsmProviderAdminDomain events, there are three subjects that are structured as:

  cisco.vpnsc.rep.m1.vi.vsmTaskType.action

where vsmTaskType loosely corresponds with the namespaces of the CiscoVsmBrowser interfaces. The action values are specific to each of the valid vsmObjectType values. Specific vsmTaskType values are listed in the sections that follow.

Subjects for CiscoTaskManagedObjects::TaskScheduledTask Events

For CiscoTaskManagedObjects::TaskScheduledTask events, there are three subjects that are structured as:

  cisco.vpnsc.rep.m1.task.ScheduledTask.action

where you can substitute any of the items in the "Action Value" column of Table 11-36 for the action field of the subject expression. Table 11-36 also shows the specific API operations that trigger these events upon execution.

Table 11-36: Action Values for CiscoTaskManagedObjects::TaskScheduledTask Subjects

Action Value	Corresponding API Operations
create	CiscoTaskManagedObjects::TaskScheduledTask::addToRep()
modify	CiscoTaskManagedObjects::TaskScheduledTask::updateRep()
remove	CiscoTaskManagedObjects::TaskScheduledTask::removeFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-37 for the action field of the subject expression. Table 11-37 also shows the specific API operations that trigger these events upon execution.

Table 11-37: Action Values for CiscoTaskManagedObjects::TaskPersistentTask Subjects

Action Value	Corresponding API Operations
create	CiscoTaskManagedObjects::TaskPersistentTask::addToRep()
remove	CiscoTaskManagedObjects::TaskPersistentTask::removeFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-38 for the action field of the subject expression. Table 11-38 also shows the specific API operations that trigger these events upon execution.

Table 11-38: Action Values for CiscoTaskManagedObjects::TaskRuntimeTask Subjects

Action Value	Corresponding API Operations
create	CiscoTaskManagedObjects::TaskRuntimeTask::addToRep()
modify	CiscoTaskManagedObjects::TaskRuntimeTask::updateRep()
remove	CiscoTaskManagedObjects::TaskRuntimeTask::removeFromRep()

where you can substitute any of the items in the "Action Value" column of Table 11-39 for the action field of the subject expression. Table 11-39 also shows the specific API operations that trigger these events upon execution.

Table 11-39: Action Values for CiscoTaskManagedObjects::RuntimeActionGlobalState Subjects

Action Value	Corresponding API Operations
create	CiscoTaskManagedObjects::RuntimeActionGlobalState::addToRep()
remove	CiscoTaskManagedObjects::RuntimeActionGlobalState::removeFromRep()

Event Data for Task Repository Events

Event data is constructed based on the object type to which with the subject corresponds. The following sections describe the event data for each of the event generated by the Task repository.

Event Data for CiscoTaskManagedObjects::TaskScheduledTask Events

Event data for cisco.vpnsc.rep.m1.task.ScheduledTask.create events is composed of the name=value pairs listed in Table 11-40.

Table 11-40: Event Data for cisco.vpnsc.rep.m1.task.ScheduledTask.create Events

Name	Type	Value Description
PersistentTaskID	string	See API Programmer Reference.
ScheduledTaskID	string	See API Programmer Reference.
CronSpec	string	See API Programmer Reference.
type	string	See API Programmer Reference.
TimeScheduled	string	See API Programmer Reference.
Desc	string	See API Programmer Reference.
SchedulerNsmId	long	See API Programmer Reference.
ScheduleAssertionList	sequence<Arguments>	See Table 11-41.

Event data for cisco.vpnsc.rep.m1.task.ScheduledTask.modify event is composed of the name=value pairs listed in Table 11-42.

Table 11-42: Event Data for cisco.vpnsc.rep.m1.task.ScheduledTask.modify Events

Name	Type	Value Description
PersistentTaskID	string	See API Programmer Reference.
ScheduledTaskID	string	See API Programmer Reference.
CronSpec	string	See API Programmer Reference.
type	string	See API Programmer Reference.
TimeScheduled	string	See API Programmer Reference.
Desc	string	See API Programmer Reference.
SchedulerNsmId	long	See API Programmer Reference.
ScheduleAssertionList	sequence<Arguments>	See Table 11-41.
OldCronSpec	string	See API Programmer Reference.
OldType	string	See API Programmer Reference.
OldTimeScheduled	string	See API Programmer Reference.
RuntimeActionList	sequence<RuntimeAction>	See Table 11-43.
RuntimeActionGlobalStateList	sequence<RuntimeActionGlobalState>	See API Programmer Reference.
MediatorList	sequence<long>	See API Programmer Reference.

Table 11-44: Event Data for ActionOutput substructure from Table 11-43 and Table 11-45

Name	Type	Value Description
Index	short	See API Programmer Reference.
Desc	string	See API Programmer Reference.
FilePath	string	See API Programmer Reference.

Table 11-45: Event Data for RuntimeActionGlobalState substructure from Table 11-42

Name	Type	Value Description
Index	string	See API Programmer Reference.
Status	short	See API Programmer Reference.
Rc	short	See API Programmer Reference.
RcDesc	string	See API Programmer Reference.
ActionOutputList	sequence<ActionOutput>	See Table 11-44.

Event data for cisco.vpnsc.rep.m1.task.ScheduledTask.remove event is composed of the name=value pairs listed in Table 11-46.

Table 11-46: Event Data for cisco.vpnsc.rep.m1.task.ScheduledTask.modify Events

Name	Type	Value Description
ScheduledTaskID	string	See API Programmer Reference.

Event data for cisco.vpnsc.rep.m1.task.PersistentTask.create events is composed of the name=value pairs listed in Table 11-47.

Table 11-47: Event Data for cisco.vpnsc.rep.m1.task.PersistentTask.create Events

Name	Type	Value Description
TaskID	string	See API Programmer Reference.
TaskDesc	string	See API Programmer Reference.
TaskCreatorNsmId	long	See API Programmer Reference.
TaskNetwork	string	See API Programmer Reference.
ClassName	string	See API Programmer Reference.
CreationStepList	sequence<string>	See API Programmer Reference.
ArgumentList	sequence<Argument>	See Table 11-41.
ActionList	sequence<Actions>	See Table 11-48.
OldDesc	string	See API Programmer Reference.
OldSchedulerNsmId	long	See API Programmer Reference.
OldScheduleAssertionList	sequence<Arguments>	See Table 11-41.

Event data for cisco.vpnsc.rep.m1.task.ScheduledTask.remove event is composed of the name=value pairs listed in Table 11-48.

Table 11-48: Event Data for ActionList substructure from Table 11-47

Name	Type	Value Description
Index	short	See API Programmer Reference.
CmdType	short	See API Programmer Reference.
CentralDistFlag	short	See API Programmer Reference.
Cmd	string	See API Programmer Reference.
Name	string	See API Programmer Reference.
Desc	string	See API Programmer Reference.
TargetTag	string	See API Programmer Reference.
Category	string	See API Programmer Reference.
ArgumentList	sequence<Arguments>	See Table 11-41.
DependencyList	sequence<short>	See API Programmer Reference.

Event data for cisco.vpnsc.rep.m1.task.PersistentTask.remove event is composed of the name=value pairs listed in Table 11-49.

Table 11-49: Event Data for cisco.vpnsc.rep.m1.task.ScheduledTask.modify Events

Name	Type	Value Description
PersistentTaskID	string	See API Programmer Reference.

Posted: Fri Sep 22 20:11:03 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.