|
|
The file CiscoTaskFactory.idl contains the following interface:
CiscoTaskFactory::TaskFactory
The CiscoTaskFactory module supplies API support for the provisioning and data-collection tasks that are accessible through the graphic user interface (GUI) of the Cisco VPN Solutions Center product.
See Also
CiscoTaskServiceModel, CiscoTaskManagedObjects, CiscoTaskExceptions
Since
Cisco VPN Solutions Center, Release 1.1
An instance of the TaskFactory interface supplies high-level operations for those frequently-used tasks that are implemented in the GUI portion of the Cisco VPN Solutions Center product.
See Also
CiscoTaskServiceModel, CiscoTaskManagedObjects, CiscoTaskExceptions
Since
Cisco VPN Solutions Center, Release 1.1
Creates a persistent task to collect VPN accounting data from the Netflow Collector software.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createCollectVPNAccountingDataTask(in string taskName, in CiscoTaskManagedObjects::TaskActionTargetSeq targetList)
raises(RepException, InvalidData);
Parameters
taskName—in string that represents the name of the task.
targetList—in CiscoTaskManagedObjects::TaskActionTargetSeq that lists Netflow data collectors from which to retrieve data.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—Represents the task created.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters are invalid or contains invalid data.
Since
Cisco VPN Solutions Center, Release 1.1
Creates a persistent task to deploy service requests to a CE.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createDeployServiceRequestTask(in string taskName, in boolean allRequests, in CiscoTaskManagedObjects::TaskActionTargetSeq targetList, in boolean audit)
raises(RepException, InvalidData);
Parameters
taskName—in string represents the name of the task.
allRequests—in boolean that, when TRUE, indicates that the targetList parameters are to be ignored, and all new service requests are to be deployed.
targetList—in CiscoTaskManagedObjects::TaskActionTargetSeq that lists the service requests to be deployed on a CE. The target ID should be the service request ID. You can get the service request IDs using the CiscoVpnServiceModel::VpnInvMgr::getAllSRVCs() operation.
audit—a boolean that, when TRUE, generates audit reports for the service requests.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—represents the task created.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters are invalid or contains invalid data.
See Also
VsmBrowser::VsmSRVC, createAuditingTask, CiscoTaskManagedObjects::TaskActionTargetSeq, CiscoTaskManagedObjects::TaskPersistentTask
Since
Cisco VPN Solution Center, Release 1.1
Creates a persistent task that generates web-based VPN audit reports.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createGenAuditReportsTask(in string taskName, in boolean auditNew, in boolean auditExisting, in boolean vpnRouting)
raises(RepException, InvalidData);
Parameters
taskName—in string represents the name of the task.
auditNew—in boolean that, when TRUE, generates audit reports for new service requests.
auditExisting—in boolean that, when TRUE, generates audit reports for existing service requests.
vpnRouting—in boolean that, when TRUE, uses VPN routing information during audits.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—The newly created auditing task.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters are invalid or contain invalid data.
Description
Options for more extensive audits are available, including audits of all service requests and use of VPN routing information during audits.
See Also
CiscoTaskManagedObjects::TaskPersistentTask.
Since
Cisco VPN Solution Center, Release 1.1
Creates a persistent task to get router configurations and adds it to the Task repository.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createGetRouterConfigTask(in string taskName, in CiscoTaskManagedObjects::TaskActionTargetSeq targetList, in boolean mask)
raises(RepException, InvalidData);
Parameters
taskName—a string which represents the name of the newly created persistent task.
targetList—a list of CiscoTaskManagedObjects::TaskActionTarget objects which represents the list of routers whose configuration will be collected.
mask—a boolean variable, when it is set to true, the password field in each router's cofiguration will be masked.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—the GetConfig persistent task.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters are invalid or contains invalid data.
Description
The task collects router configurations data from active routers.
See Also
CiscoTaskManagedObjects::TaskPersistentTask.
Since
Cisco VPN Solution Center, Release 1.1
Creates a persistant task that collects SA Agent data from routers on which SA Agent is enabled.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createGetSlaDataTask(in string taskName, in string inputFile)
raises(RepException, InvalidData);
Parameters
taskName—in string that represents the name of the task.
inputFile—in string that represents the file that contains SA Agent operational commands. See the API Programmer Guide for information about how to construct the input file.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—Represents the task created.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters areinvalid or contains invalid data.
Description
The collected SA Agent data is used when generating SLA reports.
See Also
CiscoTaskManagedObjects::TaskPersistentTask
Since
Cisco VPN Solution Center, Release 1.1
Creates a persistant task which collects routing information from routers.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createGetVPNRoutingInfoTask(in string taskName, in CiscoTaskManagedObjects::TaskActionTargetSeq targetList)
raises(RepException, InvalidData);
Parameters
taskName—in string that represents the name of the task.
targetList—in CiscoTaskManagedObjects::TaskActionTargetSeq that lists the routers whose routing information is to be collected.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—Represents the task created.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters areinvalid or contains invalid data.
See Also
CiscoTaskManagedObjects::TaskPersistentTask
Since
Cisco VPN Solution Center, Release 1.1
Creates a persistent task to get router configurations and add the task to the Task repository.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createImportRouterConfigTask(in string taskName, in string dirpath, in string network)
raises(RepException, InvalidData);
Parameters
taskName—a string represents the name of the newly created persistent task.
dirpath—a string represents the directory name in which the configuration file exists.
network—a string represents the network name in which the import action will take place.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—the GetConfig persistent task.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters are invalid or contains invalid data.
Description
The task imports router configrations from a file.
See Also
CiscoTaskManagedObjects::TaskPersistentTask.
Since
Cisco VPN Solution Center, Release 1.1
Creates a persistant task which polls a router CAR MIB.
Usage
CiscoTaskManagedObjects::TaskPersistentTask createPollCARMIBTask(in string taskName, in CiscoTaskManagedObjects::TaskActionTargetSeq targetList)
raises(RepException, InvalidData);
Parameters
taskName—in string that represents the name of the task.
targetList—in CiscoTaskManagedObjects::TaskActionTargetSeq that lists the routers whose CAR MIB information is to be collected.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—Represents the task created.
Raises
CiscoTaskExceptions::RepException if a Task Repository error occurs. CiscoTaskExceptions::InvalidData if the parameters are invalid or contains invalid data.
See Also
CiscoTaskManagedObjects::TaskPersistentTask
Since
Cisco VPN Solution Center, Release 1.1
Posted: Tue Sep 26 16:49:02 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.