|
|
The file CiscoVPIMDL.idl contains the following interface:
CiscoVPIMDL::VPIMConfigletDownLoadManager
The CiscoVPIMDL module defines a CORBA interface (VPIMConfigletDownLoadManager) to the VPN Provisioning and Inventory Manager (VPIM). With this interface, you to generate configlets and download them to:
See Also
CiscoVPNServiceRequest, CiscoVPIM, CiscoVPIMExceptions
Sequence of unique service-request identifiers.
Usage
typedef sequence<unsigned long> ServiceRequestIds
See Also
downloadAll, downloadList
Since
Cisco VPN Solutions Center, Release 1.0
Result from processing a service request—for example, generating configlets and downloading them to routers.
Usage
struct ServiceRequestResult
{
unsigned long serviceRequestId;
unsigned long configletId;
string description;
Status status;
};
Members
serviceRequestId—unsigned long that represents the service-request identifier.
configletId—unsigned long that represents the configlet ID. This field is set to 0 if no configlet is generated due to an error condition.
description—string that represents a short description of the service request.
status—Status that represents the status of the service request.
See Also
downloadAll, downloadList
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of ServiceRequestResult structures.
Usage
typedef sequence<ServiceRequestResult> ServiceRequestResults
Status of a service request.
Usage
enum Status
{
Success,
SystemError,
ProvisioningError,
CommunicationError,
DownloadServerError,
DatasetManagerError,
BadServiceRequestData
};
Enumerators
Success—Service request was successfully processed.
SystemError—A Cisco VPN Solutions Center system error occured. For example, the file system may be full or an operating system error may have occurred.
ProvisioningError—Configlets could not be generated due to invalid data in a CiscoVsmBrowser::VsmSRVC object. For example, a duplicate (nonunique) interface+subinterface string concatenation is one source of this Status enumeration. Validate the offending data in the CiscoVsmBrowser::VsmSRVC object before attempting to download the configlet again.
CommunicationError—The Cisco VPN Solutions Center software could not communicate with the download/upload server when attempting to either download or upload configlet data. Try the download or upload operation again.
DownloadServerError—Errors were returned by the download server.
DatasetManagerError—Errors returned by the dataset manager (DM) server.
BadServiceRequestData—Service request contains invalid data.
See Also
ServiceRequestResult
Since
Cisco VPN Solutions Center, Release 1.0
With an instance of the VPIMConfigletDownLoadManager interface, you can generate configlets and download them to:
See Also
CiscoVsmSRCeator::VsmVPNConnectivityCreator, CiscoVsmSRCeator::VsmVPNServiceModifier, CiscoVPIM
Since
Cisco VPN Solutions Center, Release 1.0
Generates router configlets and downloads them for all routers with service requests with VsmSRState set to Requested.
Usage
void downloadAll(in string databasePath, in string logFilePath, in boolean writeToNVRAM, out ServiceRequestResults srResults)
raises(FileAccessException, NoSuchServiceRequest, VPNServiceRequestDBError);
Parameters
databasePath—in string that represents the full path to the database where service requests are stored. In this release of the Cisco VPN Solutions Center software, the downloadAll() operation ignores this parameters; this parameter is reserved for future use.
logFilePath—in string that represents full path to the log file. If no file exists at that location, a new log file is created there; if the file already exists, its contents are emptied. Log information is added to this file in HTML format.
writeToNVRAM—in boolean that, when TRUE, indicates the running configlet is to be written to the nonvolatile memory (NVRAM) of the router if the configlet download is successful. In this release of the Cisco VPN Solutions Center software, the downloadAll() operation ignores this parameters; this parameter is reserved for future use.
srResults—out ServiceRequestResults that represents status of each service request. This sequence contains either one or two ServiceRequestResult structures for each service request; two ServiceRequestResult structures if all configlets are successfully downloaded, and one ServiceRequestResult structure is returned if one or more configlets are not successfully downloaded for the given service request.
Raises
CiscoVPIMExceptions::FileAccessException if the log file cannot be created, written, or read. CiscoVPIMExceptions::VPNServiceRequestDBError if the database where service requests are stored can not be accessed. CiscoVPIMExceptions::NoSuchServiceRequest if no service requests with Requested state are found in the VPN Inventory Repository.
Description
In this release of the Cisco VPN Solutions Center software, the downloadAll() operation ignores both the databasePath and writeToNVRAM parameters. To instruct the Cisco VPN Solutions Center software to write the running configlet to nonvolatile RAM, set the DIPMServer.CIPMCopyRunningToStartup property in the csm.properties file to TRUE.
See Also
downloadList
Since
Cisco VPN Solutions Center, Release 1.0
Downloads the generated router configlets for all service requests in the list, regardless of the VsmSRState setting.
Usage
void downloadList(in ServiceRequestIds srIDList, in string databasePath, in string logFilePath, in boolean writeToNVRAM, out ServiceRequestResults srResults)
raises(FileAccessException, NoSuchServiceRequest, VPNServiceRequestDBError);
Parameters
srIDList—in ServiceRequestIds that list the service requests to be processed.
databasePath—in string that represents the full path to the database where service requests are stored. In this release of the Cisco VPN Solutions Center software, the downloadList() operation ignores this parameters; this parameter is reserved for future use.
logFilePath—in string that represents full path to the log file. If no file exists at that location, a new log file is created there; if the file already exists, its contents are emptied. Log information is added to this file in HTML format.
writeToNVRAM—in boolean that, when TRUE, indicates the running configlet is to be written to the nonvolatile memory (NVRAM) of the router if the configlet download is successful. In this release of the Cisco VPN Solutions Center software, the downloadList() operation ignores this parameters; this parameter is reserved for future use.
srResults—out ServiceRequestResults that represents status of each service request. This sequence contains either one or two ServiceRequestResult structures for each service request; two ServiceRequestResult structures if all configlets are successfully downloaded, and one ServiceRequestResult structure is returned if one or more configlets are not successfully downloaded for the given service request.
Raises
CiscoVPIMExceptions::FileAccessException if the log file cannot be created, written, or read. CiscoVPIMExceptions::VPNServiceRequestDBError if the database where service requests are stored can not be accessed. CiscoVPIMExceptions::NoSuchServiceRequest if no service requests from the list are found in the VPN Inventory Repository.
Description
In this release of the Cisco VPN Solutions Center software, the downloadList() operation ignores both the databasePath and writeToNVRAM parameters. To instruct the Cisco VPN Solutions Center software to write the running configlet to nonvolatile RAM, set the DIPMServer.CIPMCopyRunningToStartup property in the csm.properties file to TRUE.
See Also
downloadAll
Since
Cisco VPN Solutions Center, Release 1.0
Posted: Tue Sep 26 16:54:13 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.