|
|
The file CiscoVsmSRCreator.idl contains the following interfaces:
CiscoVsmSRCreator::VsmVPNConnectivityCreator CiscoVsmSRCreator::VsmVPNServiceModifier
The CORBA VPN Service Request Creator module defines a set of interfaces to create a new service request to:
You can then execute either the VsmVPNConnectivityCreator::addToRep() operation or the VsmVPNServiceModifier::addToRep() operation, respectively, to add the service request—a CiscoVsmBrowser::VsmSRVC object—to the VPN Inventory Repository.
See Also
CiscoVpnServiceModel, CiscoVsmBrowser, CiscoVsmExceptions
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmVPNConnectivityCreator interface represents a creator object with which to define a service request that either adds VPN service to a customer-edge router or adds a port reservation to an existing port-reservation group (PRG).
Description
For requests to add VPN service to a CE, you must supply information about the CE and the provider-edge router (PE) with which it is to be linked.
The following CE information is required:
The following PE information is required:
You can optionally set templates to add IOS commands to:
In addition to the basic edge-router information, you can:
In addition to the information for the edge routers, you must also supply the following:
For requests that are only to reserve a port reservation on a PE, you can:
After setting information for either the VsmVPNConnectivityCreator or VsmVPNServiceModifier object, you can add a new CiscoVsmBrowser::VsmSRVC object to the VPN Inventory Repository using the VsmVPNConnectivityCreator::addToRep() and VsmVPNServiceModifier::addToRep() operations, respectively,
See Also
CiscoVpnServiceModel::VpnInvMgr::newVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVPNConnectivityCreator, CiscoVsmBrowser::VsmSRVC, CiscoVpnServiceModel::VpnInvMgr::findSRVCByID, CiscoVpnServiceModel::VpnInvMgr::findSRVCsByPECEPair, CiscoVpnServiceModel::VpnInvMgr::getAllSRVCs, CiscoVpnServiceModel::VpnInvMgr::releaseSRVC, VsmVPNServiceModifier, CiscoVpnServiceModel::VpnInvMgr::newVPNServiceModifier, CiscoVpnServiceModel::VpnInvMgr::releaseVPNServiceModifier
Since
Cisco VPN Solutions Center, Release 1.0
Adds a service request, with the information specified through the execution of other operations in the VsmVPNConnectivityCreator interface, to the VPN Inventory Repository.
Usage
CiscoVsmBrowser::VsmSRVC addToRep(); raises(InvalidData, RepException);
Returns
CiscoVsmBrowser::VsmSRVC—The service request SRVC just created.
Raises
CiscoVsmExceptions::InvalidData if any of the data supplied is invalid. CiscoVsmExceptions::RepException if errors occur when accessing the VPN Inventory Repository.
See Also
VsmVPNServiceModifier, CiscoVsmFWCreator::VsmPECreator::addToRep, CiscoVsmFWCreator::VsmCECreator::addToRep, CiscoVsmFWCreator::VsmProviderAdminDomainCreator::addToRep, CiscoVsmFWCreator::VsmCustomerCreator::addToRep, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep, CiscoVsmFWCreator::VsmVpnCreator::addToRep, CiscoVsmFWCreator::VsmRegionCreator::addToRep, CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep, CiscoVsmFWCreator::VsmCERCCreator::addToRep, CiscoVsmFWCreator::VsmPRGCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
When TRUE, allows the overriding of the autonomous system (AS) number.
Usage
void setASOverride(in boolean asOverrideState);
Parameters
asOverrideState—in boolean that, when TRUE, allows you to override the AS number. The default state is FALSE, which disallows overriding of the AS number.
Description
Execution of this operation is optional. It is not required to define a valid service request.
See Also
CiscoVsmBrowser::VsmSRVC::isASOverride
Since
Cisco VPN Solutions Center, Release 1.1
When TRUE, sets this service request to automatically assign IP addresses for any IP-numbered interfaces of the PE-CE link using the available IP addresses in the address pool for the PE region.
Usage
void setAutoPickAddress(in boolean autoPickAddressState);
Parameters
autoPickAddressState—in boolean that, when TRUE, indicates that IP addresses are to be automatically assigned to the IP-numbered interfaces of the PE-CE link using the available IP addresses in the address pool for the PE region. The default state is TRUE. If FALSE, automatic assignment of IP addresses is disabled.
Description
When TRUE (default), two IP addresses are supplied for PE and CE interfaces of the PE-CE link. Because these addresses are automatically chosen, you need not execute the setPEInterfaceAddress() and setCEInterfaceAddress() operations; executing either of them without executing setAutoPickAddress(FALSE) creates a condition that causes an exception to be raised.
When setAutoPickAddress(FALSE) executes, both the PE and CE interface addresses must be set by the setPEInterfaceAddress() and setCEInterfaceAddress() operations, respectively. The addresses set by these two operations must not overlap the IP address pool of the CiscoVsmBrowser::VsmRegion to which the PE belongs.
See Also
CiscoVsmBrowser::VsmInterfIPUnnumberType, setPEInterfaceAddress, setCEInterfaceAddress, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets a cable helper address to configure a PE interface through which to supply VPN connectivity to a cable modem.
Usage
void setCableModemHelperAddress(in CiscoVsmBrowser::VsmIPAddress cableModemHelperAddress)
raises(InvalidData);
Parameters
cableModemHelperAddress—in CiscoVsmBrowser::VsmIPAddress that represents...
Raises
CiscoVsmExceptions::InvalidData if an invalid IP address is supplied.
Description
For VPN connectivity to a cable modem, the Cisco VPN Solutions Center software does not support cable-modem configuration. Do not supply a managed CE as input to the setCE() operation.
See Also
CiscoVsmBrowser::VsmSRVC::getCableModemHelperAddress, setCableModemHostHelperAddress, setCableModemSecondaryIpAddressList, setCableModemMaintenanceInterface, setCableModemMaintenanceInterfaceHelperAddress
Since
Cisco VPN Solutions Center, Release 1.2
Sets a host helper address to configure a PE interface through which to supply VPN connectivity to a cable modem.
Usage
void setCableModemHostHelperAddress(in CiscoVsmBrowser::VsmIPAddress cableModemHostHelperAddress)
raises(InvalidData);
Parameters
cableModemHostHelperAddress—in CiscoVsmBrowser::VsmIPAddress that represents...
Raises
CiscoVsmExceptions::InvalidData if an invalid IP address is supplied.
See Also
CiscoVsmBrowser::VsmSRVC::getCableModemHostHelperAddress, setCableModemHelperAddress, setCableModemSecondaryIpAddressList, setCableModemMaintenanceInterface, setCableModemMaintenanceInterfaceHelperAddress
Since
Cisco VPN Solutions Center, Release 1.2
When TRUE, indicates that a maintenance subinterface is to be provisioned.
Usage
void setCableModemMaintenanceInterface(in boolean cableModemMaintenanceInterfaceState)
raises(InvalidData);
Parameters
cableModemMaintenanceInterfaceState—in boolean that, when TRUE, indicates that a maintenance subinterface is to be provisioned. The default state is FALSE, which indicates no maintenance subinterface is to be provisioned.
Raises
CiscoVsmExceptions::InvalidData
Description
The default for this operation is FALSE. Execution of this operation is necessary only if a service request involving a maintenance subinterface is to be provisioned. A maintenance subinterface is always assigned subinterface number 1.
See Also
CiscoVsmBrowser::VsmSRVC::isCableModemMaintenanceInterface, setCableModemHelperAddress, setCableModemHostHelperAddress, setCableModemSecondaryIpAddressList, setCableModemMaintenanceInterfaceHelperAddress
Since
Cisco VPN Solutions Center, Release 1.2
Sets a maintenance-interface helper address when a maintenance subinterface is to be provisioned.
Usage
void setCableModemMaintenanceInterfaceHelperAddress(in CiscoVsmBrowser::VsmIPAddress cableModemMaintenanceInterfaceHelperAddress)
raises(InvalidData);
Parameters
cableModemMaintenanceInterfaceHelperAddress—in CiscoVsmBrowser::VsmIPAddress that represents...
Raises
CiscoVsmExceptions::InvalidData if an invalid IP address is supplied.
Description
This operation must execute only if the setCableModemMaintenanceInterface() operation executes with the cableModemMaintenanceInterfaceState set to TRUE.
See Also
CiscoVsmBrowser::VsmSRVC::getCableModemMaintenanceInterfaceHelperAddress, setCableModemHelperAddress, setCableModemHostHelperAddress, setCableModemSecondaryIpAddressList, setCableModemMaintenanceInterface
Since
Cisco VPN Solutions Center, Release 1.2
Sets a list of secondary IP addresses for use by a PE interface that is to supply VPN connectivity to a cable modem.
Usage
void setCableModemSecondaryIpAddressList(in CiscoVsmBrowser::VsmIPAddressSeq cableModemSecondaryIPAddressList)
raises(InvalidData);
Parameters
cableModemSecondaryIPAddressList—in CiscoVsmBrowser::VsmIPAddressSeq that represents a list of secondary IP addresses for use by a PE interface that is to supply VPN connectivity to a cable modem.
Raises
CiscoVsmExceptions::InvalidData if cableModemSecondaryIPAddressList is either an empty list or contains an invalid IP address.
See Also
CiscoVsmBrowser::VsmSRVC::getCableModemSecondaryIpAddressList, setCableModemHelperAddress, setCableModemHostHelperAddress, setCableModemMaintenanceInterface, setCableModemMaintenanceInterfaceHelperAddress
Since
Cisco VPN Solutions Center, Release 1.2
Sets the VsmCE object to which VPN service is to be added.
Usage
void setCE(in CiscoVsmBrowser::VsmCE ce)
raises(InvalidData);
Parameters
ce—in CiscoVsmBrowser::VsmCE object that represents the customer-edge router (CE) of the PE-CE link to which the VPN service is to be added.
Raises
CiscoVsmExceptions::InvalidData if the data contained by the VsmCE object is invalid.
See Also
CiscoVpnServiceModel::VpnInvMgr::newCECreator, CiscoVsmFWCreator::VsmCECreator::addToRep, CiscoVsmBrowser::VsmCustomer::getAllCustomerSites, CiscoVsmBrowser::VsmCustomerSite::getAllCEs
Since
Cisco VPN Solutions Center, Release 1.0
Sets the routes to be advertised by the customer-edge router (CE) to which VPN service is to be added.
Usage
void setCEAdvertisedRoutes(in CiscoVsmBrowser::advertisedRouteSeq routes)
raises(InvalidData);
Parameters
routes—in CiscoVsmBrowser::advertisedRouteSeq that represents the list of routes to be advertised by the customer-edge router (CE).
Raises
CiscoVsmExceptions::InvalidData if any of the routes in the in CiscoVsmBrowser::advertisedRouteSeq parameter has a syntax error.
Description
This is required only if static routing is used for the PE-CE link—for example, if setPECERoutingProtocol(StaticRoutingType) is to execute—instead of a dynamic protocol, such as RIP or BGP.
You need not set the advertised routes if this service request only specifies a PE port reservation.
See Also
CiscoVsmBrowser::VsmSRVC::getCEAdvertisedRoutes, setPECERoutingProtocol, CiscoVsmBrowser::VsmPECELinkProtocolType, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the BGP autonomous system (AS) number associated with the customer-edge router (CE) to which VPN service is to be added.
Usage
void setCEAutonomousSystem(in unsigned long asNumber)
raises(InvalidData);
Parameters
asNumber—in unsigned long that represents the BGP autonomous system number for the customer-edge router (CE) to which VPN service is to be added. Valid values are in the range [1 - 65535]
Raises
CiscoVsmExceptions::InvalidData if asNumber has an invalid value.
Description
This is required only if the routing protocol used for the PE-CE link is set as BGP—for example, setPECERoutingProtocol(BGPRoutingType) is to execute.
You need not set the AS number if this service request only specifies a PE port reservation.
See Also
CiscoVsmBrowser::VsmSRVC::getCEAutonomousSystem, setPECERoutingProtocol, CiscoVsmBrowser::VsmPECELinkProtocolType, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the relevant circuit-identifier data for the customer-edge router (CE) to which VPN service is to be added.
Usage
void setCECircuitIdentifier(in CiscoVsmBrowser::CircuitIdentifier circuitID)
raises(InvalidData);
Parameters
circuitID—in CiscoVsmBrowser::CircuitIdentifier represents the circuit-identifier data that corresponds to the CE interface.
Raises
CiscoVsmExceptions::InvalidData if the circuit-identifier data does not coincide with a known interface type or if one or more of the circuit-identifier data is out of range.
Description
This is required for Frame Relay, ISL, and ATM interfaces. The circuit-identifier data must coincide with interface type—for example, DLCI for Frame Relay and VCD, VPI and VCI for ATM. If the interface type is already set, when this operation executes, the circuitID input is compared with the known interface type to validate or invalidate the input.
See Also
CiscoVsmBrowser::VsmSRVC::getCeCircuitId, setPECircuitIdentifier, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the interface name for the customer-edge router (CE) of the PE-CE link.
Usage
void setCEInterface(in string routerInterfaceName)
raises(InvalidData);
Parameters
routerInterfaceName—in string that contains the interface name, the unit number, and the subinterface number of the customer-edge router (CE) of the PE-CE link.
Raises
CiscoVsmExceptions::InvalidData if data is invalid.
Description
In the routerInterfaceName string, include the interface type, the unit number, and the subinterface number—Serial1.100 or Serial0/0/0.100, for example.
See Also
CiscoVsmBrowser::VsmSRVC::getCEInterface, setPEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the interface address for the customer-edge router (CE) of the PE-CE link.
Usage
void setCEInterfaceAddress(in string routerInterfaceAddress)
raises(InvalidData);
Parameters
routerInterfaceAddress—in string that represents the interface address for the customer-edge router (CE)—for example, i.j.k.l/n, where n represents the subnet mask. If the interface is IP-unnumbered, the subnet mask, n, must be /32. The PE and CE interfaces are both IP-unnumbered if setIPUnumbered(CiscoVsmBrowser::VsmInterfIPUnnumberType::InterfPECEIPUnnumbered) executes.
Raises
CiscoVsmExceptions::InvalidData if the format of the address is invalid.
Description
Execution of this operation is required and applicable only if setAutoPickAddress(FALSE) also executes. If setAutoPickAddress(FALSE) does not execute before executing the setCEInterfaceAddress() operation, this operation raises an exception when executed.
By using this operation, you are choosing to override the automatic address-allocation feature, which verifies that a chosen IP address is unique before assigning it. You must, therefore, ensure that the address being set does not overlap with the address pools of the CiscoVsmBrowser::VsmRegion object to which the PE member of the PE-CE link, belongs.
See Also
CiscoVsmBrowser::VsmSRVC::getCEAddress, setIPUnnumbered, CiscoVsmBrowser::VsmSRVC::getIPUnnumbered, setAutoPickAddress, setCEInterface, setPEInterfaceAddress, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets an interface template with which to augment the IOS configuration for the interface of the customer-edge router (CE) of the PE-CE link.
Usage
void setCEInterfaceTemplate(in string routerInterfaceTemplate);
Parameters
routerInterfaceTemplate—in string that contains one or more IOS command strings to augment the configuration of the CE of the PE-CE link.
Description
The CE interface template is optional and contains a string of additional IOS commands that are to be appended verbatim to the CE interface. No syntax or semantic checking is performed.
See Also
setPEInterfaceTemplate, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the interface type for the customer-edge router (CE) to which VPN service is to be added.
Usage
void setCEInterfaceType(in CiscoVsmBrowser::VsmInterfaceType routerInterfaceType)
raises(InvalidData);
Parameters
routerInterfaceType—in CiscoVsmBrowser::VsmInterfaceType that represents the interface type of the CE to which VPN service is to be added.
Raises
CiscoVsmExceptions::InvalidData if the specified interface type is not listed in the in CiscoVsmBrowser::VsmInterfaceType definition.
See Also
setPEInterfaceType, setCEInterface, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the loopback interface address for the customer-edge router (CE).
Usage
void setCELoopbackInterfaceAddress(in string ceLoopbackInterfaceAddress)
raises(InvalidData);
Parameters
ceLoopbackInterfaceAddress—in string that specifies the IP address for the CE loopback interface.
Raises
CiscoVsmExceptions::InvalidData if the specified address is invalid.
Description
This operation must specify an IP address for the CE loopback interface if both setCELoopbackInterfaceRequired(TRUE) and setAutoPickAddress(FALSE) execute. These two operations indicate, respectively, that a CE loopback interface is required and that the IP address for the loopback interface is not automatically assigned.
If setAutoPickAddress(FALSE) does not execute and setCELoopbackInterfaceRequired(TRUE) does execute, execution of the setCELoopbackInterfaceAddress() is optional and overrides the IP address that is automatically assigned.
If the setCELoopbackInterfaceRequired() operation does not execute, or if setCELoopbackInterfaceRequired(FALSE) does execute, execution of the setCELoopbackInterfaceAddress() operation is ignored.
See Also
setCELoopbackInterfaceRequired, CiscoVsmBrowser::VsmSRVC::getCELoopbackInterfaceAddress
Since
Cisco VPN Solutions Center, Release 1.1
When TRUE, specifies a requirement for a loopback interface on the customer-edge router (CE).
Usage
void setCELoopbackInterfaceRequired(in boolean ceLoopbackInterfaceRequiredState);
Parameters
ceLoopbackInterfaceRequiredState—in boolean that, when TRUE, specifies that a loopback interface is required on the CE. The default state is FALSE, which indicates that a CE loopback interface is not required.
Description
Execution of this operation is optional. It is not required to define a valid service request.
See Also
setCELoopbackInterfaceAddress, CiscoVsmBrowser::VsmSRVC::isCELoopbackInterfaceRequired
Since
Cisco VPN Solutions Center, Release 1.1
Sets the OSPF area number for the VsmCE object specified by the setCE() operation if the PE-CE routing protocol is OSPF.
Usage
void setCeOSPFArea(in unsigned long ceOSPFArea)
raises(InvalidData);
Parameters
ceOSPFArea—in unsigned long that represents the OSPF area number for the VsmCE object specified by the setCE() operation if the PE-CE routing protocol is OSPF.
Raises
CiscoVsmExceptions::InvalidData if OSPF is not used or if ceOSPFArea is a negative value.
See Also
CiscoVsmBrowser::VsmSRVC::getCeOSPFArea, CiscoVsmBrowser::VsmSRVC::isCeOSPFAreaSetAsIpAddress, setCE, setCeOSPFProcessId, setCeOSPFAreaAsIpAddress, setPECERoutingProtocol
Since
Cisco VPN Solutions Center, Release 1.2
Sets the OSPF area as an IP address for the VsmCE object specified by the setCE() operation if the PE-CE routing protocol is OSPF.
Usage
void setCeOSPFAreaAsIpAddress(in string ceOSPFArea)
raises(InvalidData);
Parameters
ceOSPFArea—in string that represents the OSPF area as an IP address for the VsmCE object specified by the setCE() operation if the PE-CE routing protocol is OSPF.
Raises
CiscoVsmExceptions::InvalidData if OSPF is not used or if ceOSPFArea does not represent a valid IP address.
See Also
CiscoVsmBrowser::VsmSRVC::isCeOSPFAreaSetAsIpAddress, CiscoVsmBrowser::VsmSRVC::getCeOSPFAreaAsIpAddress, setCE, setCeOSPFProcessId, setCeOSPFArea, setPECERoutingProtocol
Since
Cisco VPN Solutions Center, Release 1.2
Sets the OSPF process ID on the VsmCE object specified by the setCE() operation if the PE-CE routing protocol is OSPF.
Usage
void setCeOSPFProcessId(in long ceOSPFProcessID)
raises(InvalidData);
Parameters
ceOSPFProcessID—in long that represents the OSPF process identifier of the VsmCE specified by the setCE() operation. Valid values range from 1 to 65535, inclusive.
Raises
CiscoVsmExceptions::InvalidData if OSPF is not used or if ceOSPFProcessID is a negative value.
See Also
CiscoVsmBrowser::VsmSRVC::getCeOSPFProcessId, setCE, setCeOSPFArea, setCeOSPFAreaAsIpAddress, setPECERoutingProtocol
Since
Cisco VPN Solutions Center, Release 1.2
Sets the list of CERC memberships for the customer-edge router (CE) to which VPN service is to be added.
Usage
void setCERCMemberships(in CiscoVsmBrowser::VsmCERCMembershipSeq cercMemberships)
raises(InvalidData);
Parameters
cercMemberships—in CiscoVsmBrowser::VsmCERCMembershipSeq that represents the list of CERC memberships for the customer-edge router (CE) to which VPN service is to be added.
Raises
CiscoVsmExceptions::InvalidData if the CiscoVsmBrowser::VsmCERCMembershipSeq input argument contains a VsmCERCMembership object that has invalid data.
Description
You need not set the CERC memberships if this service request only specifies a PE port reservation.
See Also
CiscoVpnServiceModel::VpnInvMgr::newCERCMembership, CiscoVsmFWCreator::VsmCERCCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::getAllVPNs, CiscoVsmBrowser::VsmCustomerSite::getAllCEs, VsmVPNServiceModifier::modifyCERCMemberships
Since
Cisco VPN Solutions Center, Release 1.0
Sets the list of protocols to be redistributed from the customer-edge router (CE).
Usage
void setCERedistributedProtocols(in CiscoVsmBrowser::redistributedProtocolSeq protocols);
Parameters
protocols—in CiscoVsmBrowser::redistributedProtocolSeq that represents the list of protocols to be redistributed by the customer-edge router (CE) to which VPN service is to be added.
Description
This list includes all protocols present on the CE, excluding the protocol used for communication over the PE-CE link. A protocol list is required only if the routing protocol to be used for the PE-CE link is either RIP or BGP—for example, if setPECERoutingProtocol(RIPv2RoutingType) or setPECERoutingProtocol(BGPRoutingType) is to execute—and the given protocol is to get its routing information through redistribution.
You need not specify a list protocols to redistribute if this service request only specifies a PE port reservation.
See Also
CiscoVsmBrowser::VsmSRVC::getCERedistributedProtocols, setPECERoutingProtocol, CiscoVsmBrowser::VsmPECELinkProtocolType, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets a template with which to augment the IOS configuration defined by configlets that are generated by the provisioning systems for the for the customer-edge router (CE) of the PE-CE link.
Usage
void setCETemplate(in string routerTemplate);
Parameters
routerTemplate—in string that contains a string of one or more IOS commands to augment the configuration of the CE of the PE-CE link as defined by the configlets generated by the provisioning system.
Description
The CE template is optional and contains a string of additional IOS commands that are to be appended verbatim to the CE. No syntax or semantic checking is performed.
CE templates are ignored for service requests that only specify a PE port reservation.
See Also
CiscoVsmBrowser::VsmSRVC::getCeTemplate, setCEInterfaceTemplate, setPETemplate, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the class-of-service (CoS) profile for this PE-CE link.
Usage
void setCoSProfile(in CiscoVsmBrowser::VsmCoSProfile cosProfile)
raises(InvalidData);
Parameters
cosProfile—in CiscoVsmBrowser::VsmCoSProfile that represents the CoS profile for this PE-CE link.
Raises
CiscoVsmExceptions::InvalidData if the specified CiscoVsmBrowser::VsmCoSProfile object is invalid.
See Also
CiscoVsmBrowser::VsmSRVC::getCoSProfile
Since
Cisco VPN Solutions Center, Release 1.0
Sets the VsmCustomer object to be used for the VPN service to be created.
Usage
void setCustomer(in CiscoVsmBrowser::VsmCustomer customer)
raises(InvalidData);
Parameters
customer—in CiscoVsmBrowser::VsmCustomer object that represents the customer for which the VPN service is to be created.
Raises
CiscoVsmExceptions::InvalidData if the data contained by the VsmCustomer object is invalid.
See Also
CiscoVpnServiceModel::VpnInvMgr::newCustomerCreator, CiscoVsmFWCreator::VsmCustomerCreator::addToRep, CiscoVsmBrowser::VsmCE::getCustomerSite, CiscoVsmBrowser::VsmCustomerSite::getCustomer
Since
Cisco VPN Solutions Center, Release 1.0
Sets the export map name.
Usage
void setExportMapName(in string exportMapName)
raises(InvalidData);
Parameters
exportMapName—in string that specifies the name of the export map.
Raises
CiscoVsmExceptions::InvalidData if exportMapName is a NULL or empty string.
Description
Execution of this operation is optional. It is not required to define a valid service request.
See Also
CiscoVsmBrowser::VsmSRVC::getExportMapName
Since
Cisco VPN Solutions Center, Release 1.1
Sets the import map name.
Usage
void setImportMapName(in string importMapName)
raises(InvalidData);
Parameters
importMapName—in string that specifies the name of the import map.
Raises
CiscoVsmExceptions::InvalidData if importMapName is a NULL or empty string.
Description
Execution of this operation is optional. It is not required to define a valid service request.
See Also
CiscoVsmBrowser::VsmSRVC::getImportMapName
Since
Cisco VPN Solutions Center, Release 1.1
Sets the service request to configure none (default), one, or both of the edge routers (PE and CE) of the PE-CE link to use IP-unnumbered interfaces.
Usage
void setIPUnnumbered(in CiscoVsmBrowser::VsmInterfIPUnnumberType ipUnnumberedState);
Parameters
ipUnnumberedState—in CiscoVsmBrowser::VsmInterfIPUnnumberType that specifies whether none (default), one, or both edge routers (PE and CE) of the PE-CE link are to use IP-unnumbered interfaces. The default states is VsmInterfIPUnnumberType::InterfIPNumbered, which specifies the use of IP-numbered interfaces for both the PE and CE.
See Also
CiscoVsmBrowser::VsmSRVC::getIPUnnumbered
Since
Cisco VPN Solutions Center, Release 1.0
Sets the maximum number of times a specific autonomous system (AS) number can appear in the routing path before rerouting a data packet.
Usage
void setMaxASOccurrenceInPath(in short maxASOccurrenceInPath)
raises(InvalidData);
Parameters
maxASOccurrenceInPath—in short that accepts values from 1 to 10, inclusive, to specify the maximum number of times a specific AS number can appear in the routing path before rerouting a data packet.
Raises
CiscoVsmExceptions::InvalidData if maxASOccurrenceInPath is out of range.
Description
Execution of this operation is optional. It is not required to define a valid service request.
Sets the maximum number of routes for the VRF table to accept.
Usage
void setMaxRoutes(in long maxRoutes)
raises(InvalidData);
Parameters
maxRoutes—in long that specifies the maximum number of routes for the VRF table to accept. As a default, the VFR table accepts a number of routes that is limited only by your system resources.
Raises
CiscoVsmExceptions::InvalidData if maxRoutes is less than zero.
Description
Execution of this operation is optional. It is not required to define a valid service request.
See Also
CiscoVsmBrowser::VsmSRVC::getMaxRoutes
Since
Cisco VPN Solutions Center, Release 1.1
When TRUE, the CE router is added as a member of a grey management VPN.
Usage
void setMemberGreyManagementVPN(in boolean memberGreyManagementVPN)
raises(InvalidData);
Parameters
memberGreyManagementVPN—in boolean that, when TRUE, indicates that the CE is to be added as a member of the grey management VPN. The default state is FALSE, which excludes the CE from the grey management VPN.
If memberGreyManagementVPN is being set to TRUE and the grey management VPN has not been created yet, the InvalidData exception will be thrown. This check is performed only if the PE has been set—that is, setPE() has executed. Otherwise, it is checked when addToRep() executes.
A grey management VPN is created when a service request that involves a management CE is created.
Raises
CiscoVsmExceptions::InvalidData if the grey management VPN has not been created yet.
See Also
CiscoVsmBrowser::VsmSRVC::isMemberGreyManagementVPN
Since
Cisco VPN Solutions Center, Release 1.1
When TRUE, enables netflow accounting.
Usage
void setNetflowAccountingOn(in boolean netflowAccountingOnState);
Parameters
netflowAccountingOnState—in boolean that, when TRUE, enables netflow accounting. The default state is FALSE, which disables netflow accounting.
Description
Execution of this operation is optional. It is not required to define a valid service request.
See Also
CiscoVsmBrowser::VsmSRVC::isNetflowAccountingOn
Since
Cisco VPN Solutions Center, Release 1.1
When TRUE, sets this service request to instruct the PE to send only the default route to the CE.
Usage
void setOnlyDefaultRouteSentToCE(in boolean onlyDefaultRouteSentToCEState);
Parameters
onlyDefaultRouteSentToCEState—in boolean that, when TRUE, instructs the PE to send only the default route to the CE. The default state is FALSE, which instructs the PE to send all routes to the CE to support internet feeds into customer sites.
See Also
CiscoVsmBrowser::VsmSRVC::isOnlyDefRouteSentToCE
Since
Cisco VPN Solutions Center, Release 1.0
Sets the VsmPE object for the VPN service to be created.
Usage
void setPE(in CiscoVsmBrowser::VsmPE pe)
raises(InvalidData);
Parameters
pe—in CiscoVsmBrowser::VsmPE object that represents the provider-edge router (PE) of the PE-CE link for which the VPN service is to be created.
Raises
CiscoVsmExceptions::InvalidData if the data contained by the VsmPE object is invalid.
See Also
CiscoVpnServiceModel::VpnInvMgr::newPECreator, CiscoVsmFWCreator::VsmPECreator::addToRep, CiscoVsmBrowser::VsmProviderAdminDomain::getAllRegions, CiscoVsmBrowser::VsmRegion::getAllPEs
Since
Cisco VPN Solutions Center, Release 1.0
Sets the routing protocol for the PE-CE link—the connection between the provider-edge router (PE) and the customer-edge router (CE)—for exchanging advertised routes.
Usage
void setPECERoutingProtocol(in CiscoVsmBrowser::VsmPECELinkProtocolType routingProtocol)
raises(InvalidData);
Parameters
routingProtocol—in CiscoVsmBrowser::VsmPECELinkProtocolType the represents the routing protocol for the PE-CE link.
Raises
CiscoVsmExceptions::InvalidData if the specified protocol is not defined by CiscoVsmBrowser::VsmPECELinkProtocolType.
Description
You need not set the routing protocol if this service request only specifies a PE port reservation.
See Also
CiscoVsmBrowser::VsmSRVC::getPECELinkProtocol, setCEInterfaceAddress, setPEInterface, setPEInterfaceType, setPEInterfaceAddress, setPECircuitIdentifier, setPEInterfaceShutdown, setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
Sets the relevant circuit-identifier data for the provider-edge router (PE) of the PE-CE link.
Usage
void setPECircuitIdentifier(in CiscoVsmBrowser::CircuitIdentifier circuitID)
raises(InvalidData);
Parameters
circuitID—in CiscoVsmBrowser::CircuitIdentifier represents the circuit-identifier data that corresponds to the PE interface.
Raises
CiscoVsmExceptions::InvalidData if the circuit-identifier data does not coincide with a known interface type or if one or more of the circuit-identifier data is out of range.
Description
This is required for Frame Relay, ISL, and ATM interfaces. The circuit-identifier data must coincide with interface type—for example, DLCI for Frame Relay and VCD, VPI and VCI for ATM. If the interface type is already set, when this operation executes, the circuitID input is compared with the known interface type to validate or invalidate the input.
See Also
CiscoVsmBrowser::VsmSRVC::getPeCircuitId, setCECircuitIdentifier, setPEInterface, setPEInterfaceType, setPEInterfaceAddress, setPEInterfaceShutdown, setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
Sets the interface name for the provider-edge router (PE) of the PE-CE link.
Usage
void setPEInterface(in string routerInterfaceName)
raises(InvalidData);
Parameters
routerInterfaceName—in string that contains the interface name, the unit number, and the subinterface number of the provider-edge router (PE) of the PE-CE link.
Raises
CiscoVsmExceptions::InvalidData if data is invalid.
Description
In the routerInterfaceName string, include the interface type, the unit number, and the subinterface number—Serial1.100 or Serial0/0/0.100, for example.
See Also
CiscoVsmBrowser::VsmSRVC::getPEInterface, setCEInterface, setPEInterfaceType, setPEInterfaceAddress, setPECircuitIdentifier, setPEInterfaceShutdown, setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
Sets the interface address for the provider-edge router (PE) of the PE-CE link.
Usage
void setPEInterfaceAddress(in string routerInterfaceAddress)
raises(InvalidData);
Parameters
routerInterfaceAddress—in string that represents the interface address for the provider-edge router (PE)—for example, a.b.c.d/m, where m represents the subnet mask. If the interface is IP-unnumbered, the subnet mask, m, must be /32. The PE and CE interfaces are both IP-unnumbered if setIPUnumbered(CiscoVsmBrowser::VsmInterfIPUnnumberType::InterfPECEIPUnnumbered) executes.
Raises
CiscoVsmExceptions::InvalidData if the format of the address is invalid.
Description
Execution of this operation is required and applicable only if setAutoPickAddress(FALSE) also executes. If setAutoPickAddress(FALSE) does not execute before executing the setPEInterfaceAddress() operation, this operation raise an exception when executed.
By using this operation, you are choosing to override the automatic address-allocation feature, which verifies that a chosen IP address is unique before assigning it. You must, therefore, ensure that the address being set does not overlap with the address pools of the CiscoVsmBrowser::VsmRegion object to which the PE belongs.
See Also
CiscoVsmBrowser::VsmSRVC::getPEAddress, setIPUnnumbered, CiscoVsmBrowser::VsmSRVC::getIPUnnumbered, setIPUnnumbered, setAutoPickAddress, setCEInterfaceAddress, setPEInterface, setPEInterfaceType, setPEInterfaceAddress, setPECircuitIdentifier, setPEInterfaceShutdown, setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
When TRUE, sets this service request to instruct the provisioning system to issue a shutdown command for the PE interface.
Usage
void setPEInterfaceShutdown(in boolean peInterfaceShutdownState);
Parameters
peInterfaceShutdownState—in boolean that, when TRUE, instructs the provisioning system to issue a shutdown command for the PE interface. The default state is FALSE.
See Also
CiscoVsmBrowser::VsmSRVC::isPEInterfaceShutdown
Since
Cisco VPN Solutions Center, Release 1.0
Sets an interface template with which to augment the IOS configuration for the interface of the provider-edge router (PE) of the PE-CE link.
Usage
void setPEInterfaceTemplate(in string routerInterfaceTemplate);
Parameters
routerInterfaceTemplate—in string that contains one or more IOS command strings to augment the configuration of the PE of the PE-CE link.
Description
The PE interface template is optional and contains a string of additional IOS commands that are to be appended verbatim to the PE interface. No syntax or semantic checking is performed.
See Also
setPETemplate, setCEInterfaceTemplate, setPEInterface, setPEInterfaceType, setPEInterfaceAddress, setPEInterfaceShutdown, setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
Sets the interface type for the provider-edge router (PE) of the PE-CE link.
Usage
void setPEInterfaceType(in CiscoVsmBrowser::VsmInterfaceType routerInterfaceType)
raises(InvalidData);
Parameters
routerInterfaceType—in CiscoVsmBrowser::VsmInterfaceType that represents the interface type of the PE of the PE-CE link.
Raises
CiscoVsmExceptions::InvalidData if the specified interface type is not listed in the in CiscoVsmBrowser::VsmInterfaceType definition.
See Also
setCEInterfaceType, setPEInterface, setPEInterfaceAddress, setPECircuitIdentifier, setPEInterfaceShutdown, setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
Sets the OSPF area number for the VsmPE object specified by the setPE() operation if the PE-CE routing protocol is OSPF.
Usage
void setPeOSPFArea(in unsigned long peOSPFArea)
raises(InvalidData);
Parameters
ceOSPFArea—in unsigned long that represents the OSPF area number for the VsmPE object specified by the setPE() operation if the PE-CE routing protocol is OSPF.
Raises
CiscoVsmExceptions::InvalidData if OSPF is not used or if ceOSPFArea is a negative value.
See Also
CiscoVsmBrowser::VsmSRVC::getPeOSPFArea, CiscoVsmBrowser::VsmSRVC::isPeOSPFAreaSetAsIpAddress, setPE, setPeOSPFProcessId, setPeOSPFAreaAsIpAddress, setPECERoutingProtocol
Since
Cisco VPN Solutions Center, Release 1.2
Sets the OSPF area as an IP address for the VsmPE object specified by the setPE() operation if the PE-CE routing protocol is OSPF.
Usage
void setPeOSPFAreaAsIpAddress(in string peOSPFArea)
raises(InvalidData);
Parameters
peOSPFArea—in string that represents the OSPF area as an IP address for the VsmPE object specified by the setPE() operation if the PE-CE routing protocol is OSPF.
Raises
CiscoVsmExceptions::InvalidData if OSPF is not used or if peOSPFArea does not represent a valid IP address.
See Also
CiscoVsmBrowser::VsmSRVC::isPeOSPFAreaSetAsIpAddress, CiscoVsmBrowser::VsmSRVC::getPeOSPFAreaAsIpAddress, setPE, setPeOSPFProcessId, setPeOSPFArea, setPECERoutingProtocol
Since
Cisco VPN Solutions Center, Release 1.2
Sets the OSPF process ID on the VsmPE object specified by the setPE() operation if the PE-CE routing protocol is OSPF.
Usage
void setPeOSPFProcessId(in long peOSPFProcessID)
raises(InvalidData);
Parameters
ceOSPFProcessID—in long that represents the OSPF process identifier of the VsmPE specified by the setPE() operation. Valid values range from 1 to 65535, inclusive.
Raises
CiscoVsmExceptions::InvalidData if OSPF is not used or if peOSPFProcessID is a negative value.
See Also
CiscoVsmBrowser::VsmSRVC::getPeOSPFProcessId, setPE, setPeOSPFArea, setPeOSPFAreaAsIpAddress, setPECERoutingProtocol
Since
Cisco VPN Solutions Center, Release 1.2
When TRUE, sets this service request to create only a PE port reservation.
Usage
void setPEPortReservationOnly(in boolean pePortReservationOnlyState);
Parameters
pePortReservationOnlyState—in boolean that, when TRUE, indicates that this service request is for a port reservation only. The default state is FALSE.
See Also
CiscoVsmBrowser::VsmSRVC::isPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
Sets a template with which to augment the IOS configuration defined by configlets that are generated by the provisioning systems for the for the provider-edge router (PE) of the PE-CE link.
Usage
void setPETemplate(in string routerTemplate);
Parameters
routerTemplate—in string that contains a string of one or more IOS commands to augment the configuration of the PE of the PE-CE link as defined by the configlets generated by the provisioning system.
Description
The PE template is optional and contains a string of additional IOS commands that are to be appended verbatim to the PE. No syntax or semantic checking is performed.
See Also
CiscoVsmBrowser::VsmSRVC::getPeTemplate, setPEInterfaceTemplate, setCETemplate, setPEInterface, setPEInterfaceType, setPEInterfaceAddress, setPEInterfaceShutdown, setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
Sets a port-reservation group (PRG) object to assign the port reservation generated by a service request that generates only a port reservation.
Usage
void setPRG(in CiscoVsmBrowser::VsmPRG portReservationGroup)
raises(InvalidData);
Parameters
portReservationGroup—in CiscoVsmBrowser::VsmPRG that represents the group of port reservations to use for this PE-CE link.
Raises
CiscoVsmExceptions::InvalidData if the specified CiscoVsmBrowser::VsmPRG object is invalid.
Description
This operation is only used when generating service requests for port reservations only.
See Also
CiscoVsmBrowser::VsmSRVC::getPRG, setPEPortReservationOnly, CiscoVsmBrowser::VsmSRVC::isPEPortReservationOnly, setPE, setPEInterfaceType, setPEInterfaceTemplate, setPEInterfaceAddress, setPECircuitIdentifier
Since
Cisco VPN Solutions Center, Release 1.0
When TRUE, indicates that connected routes for the related VsmPE object are to be redistributed.
Usage
void setRedistributeConnectedRoutes(in boolean redistributeConnectedRoutesState);
Parameters
redistributeStaticRoutesState—in boolean that, when TRUE, enables redistribution of connected routes for the related VsmPE object. The default state is FALSE, which disables redistribution of connected routes for the related VsmPE object.
Description
The default for this operation is FALSE. Execution of this operation is necessary only if connected routes on the related VsmPE object are to be redistributed.
See Also
CiscoVsmBrowser::VsmSRVC::areConnectedRoutesRedistributed, setRedistributeStaticRoutes
Since
Cisco VPN Solutions Center, Release 1.2
When TRUE, indicates that static routes for the related VsmPE object are to be redistributed.
Usage
void setRedistributeStaticRoutes(in boolean redistributeStaticRoutesState);
Parameters
redistributeStaticRoutesState—in boolean that, when TRUE, enables redistribution of static routes for the related VsmPE object. The default state is FALSE, which disables redistribution of static routes for the related VsmPE object.
Description
The default for this operation is FALSE. Execution of this operation is necessary only if static routes on the related VsmPE object are to be redistributed.
See Also
CiscoVsmBrowser::VsmSRVC::areStaticRoutesRedistributed, setRedistributeConnectedRoutes
Since
Cisco VPN Solutions Center, Release 1.2
Sets the routes to other customer sites that can be reached from the customer-edge router (CE) to which VPN service is to be added.
Usage
void setRoutesToAllSites(in CiscoVsmBrowser::routesToAllSitesSeq routes)
raises(InvalidData);
Parameters
routes—in CiscoVsmBrowser::routesToAllSitesSeq that represents the list of routes to other customer sites from the customer-edge router (CE) to which VPN service is to be added.
Raises
CiscoVsmExceptions::InvalidData if any of the routes in the in CiscoVsmBrowser::advertisedRouteSeq parameter has a syntax error.
Description
This is a summarized list of all subnets at other customer sites that can be reached from the CE to which VPN service is to be added. Executing this operation is required only if static routing is used for the PE-CE link—for example, if setPECERoutingProtocol(StaticRoutingType) is to execute—instead of a dynamic protocol, such as RIP or BGP.
You need not set the advertised routes if this service request only specifies a PE port reservation.
See Also
CiscoVsmBrowser::VsmSRVC::getRoutesToAllSites, setPECERoutingProtocol, CiscoVsmBrowser::VsmPECELinkProtocolType, setCEInterface, setCEInterfaceType, setCEInterfaceAddress, setCECircuitIdentifier, setCEAutonomousSystem, setCEAdvertisedRoutes, setCERedistributedProtocols, setRoutesToAllSites
Since
Cisco VPN Solutions Center, Release 1.0
Sets the initial state of the service request after creation.
Usage
void setState(in CiscoVsmBrowser::VsmSRState srState);
Parameters
srState—in CiscoVsmBrowser::VsmSRState that represents the state of the service request upon adding it to the VPN Inventory Repository.
Description
If the setState() operation does not execute, the default srState value is Requested.
See Also
CiscoVsmBrowser::VsmSRState, CiscoVsmBrowser::VsmSRVC::getState
Since
Cisco VPN Solutions Center, Release 1.0.1
Sets name of the VPN routing/forwarding (VRF) table and the route-distinguisher (RD) value.
Usage
void setVRFNameAndRD(in string vrfName, in string rdValue)
raises(InvalidData);
Parameters
vrfName—in string that represents the name of the CiscoVsmBrowser::VsmVRFDef object that defines the connectivity between a set of customer sites and a VPN to which they belong.
rdValue—in string that represents the route-distinguisher (RD) value.
Raises
CiscoVsmExceptions::InvalidData if either the VRF name or the RD value is invalid.
Description
If setVRFNameAndRD() operation does not execute, the VRF name and RD value are autogenerated. If this operation executes and set a VRF name, it must also set and RD value. Likewise, if this operation executes and sets and RD value, it must also set the VRF name.
If the service request to be created involves a management CE, a grey-management VPN is also created when the service request is added to the VPN Inventory Repository. A grey-management VPN has a special autogenerated VRF name and RD value, which you cannot overwrite. If this operation executes and a grey-management VPN is involved, the specified vrfName and rdValue strings are ignored and an exception is raised.
See Also
CiscoVsmBrowser::VsmVRFDef::getName, CiscoVsmBrowser::VsmVRFDef::getRD
Since
Cisco VPN Solutions Center, Release 1.0.1
An instance of the VsmVPNServiceModifier interface represents a an object with which to define a service request that modifies or deletes a VPN service that currently exists in the VPN Inventory Repository.
Description
The VsmVPNServiceModifier interface is derived from the VsmVPNConnectivityCreator interface. Each instance of the VsmVPNServiceModifier interface, with the exception of the setPE and setCE operations, inherits the full functionality of the VsmVPNConnectivityCreator interface in addition to its local convenience operations.
Inherited operations are not overloaded in this interface, because the CORBA IDL does not support overloaded namespaces. However, the underlying implementation code does overload namespaces, as required, to supply appropriate rules checking for the addToRep() operation and to prevent execution of the setPE and setCE operations, which do not apply to the VsmVPNServiceModifier interface.
There are two basic ways to modify a VPN service:
You may opt to delete the VPN service with this interface and create a new VPN service using the VsmVPNConnectivityCreator interface. However, if you want to track modifications to specific VPN service, you must use the modification operations in this interface.
With the convenience operations of the VsmVPNServiceModifier interface, you can perform the VPN-service modifications:
After setting information for the VsmVPNServiceModifier object, you can add a new CiscoVsmBrowser::VsmSRVC object to the VPN Inventory Repository using the VsmVPNServiceModifier::addToRep() operation, which is supplied through the VsmVPNConnectivityCreator inheritance path. The addToRep() operation supplies the rules checking required to ensure your service request is acceptable.
See Also
CiscoVpnServiceModel::VpnInvMgr::newVPNServiceModifier, CiscoVpnServiceModel::VpnInvMgr::releaseVPNServiceModifier, CiscoVsmBrowser::VsmSRVC, CiscoVpnServiceModel::VpnInvMgr::findSRVCByID, CiscoVpnServiceModel::VpnInvMgr::findSRVCsByPECEPair, CiscoVpnServiceModel::VpnInvMgr::getAllSRVCs, CiscoVpnServiceModel::VpnInvMgr::releaseSRVC, VsmVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::newVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVPNConnectivityCreator
Since
Cisco VPN Solutions Center, Release 1.0
readonly attribute unsigned long serviceRequestID
Unique identifier of the service request to be modified or deleted.
Since
Cisco VPN Solutions Center, Release 1.0
Deletes this VPN service from the VPN Inventory Repository.
Usage
void deleteVPNService(); raises(RepException);
Raises
CiscoVsmExceptions::RepException if errors occur when accessing the VPN Inventory Repository.
See Also
VsmVPNConnectivityCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Modifies the list of CERCs in the CERC membership list.
Usage
void modifyCERCMemberships(in boolean cleanFirst, in CiscoVsmBrowser::VsmCERCMembershipSeq addList, in CiscoVsmBrowser::VsmCERCMembershipSeq removeList)
raises(InvalidData, RepException);
Parameters
cleanFirst—in boolean that, when TRUE, indicates that you all items in the current CERC membership list are to be removed before applying the addList and deleteList items.
addList—in CiscoVsmBrowser::VsmCERCMembershipSeq that represents the CERC members to be added to the membership list.
removeList—in CiscoVsmBrowser::VsmCERCMembershipSeq that represents the CERC members to be removed from the membership list.
Raises
CiscoVsmExceptions::InvalidData if any of the data supplied is invalid. CiscoVsmExceptions::RepException if errors occur when accessing the VPN Inventory Repository.
See Also
VsmVPNConnectivityCreator::setCERCMemberships, CiscoVpnServiceModel::VpnInvMgr::newCERCMembership, CiscoVsmFWCreator::VsmCERCCreator, CiscoVsmBrowser::VsmCustomerSite::getAllCEs, VsmVPNConnectivityCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Modifies an interface for either the provider-edge router (PE) or customer-edge router (CE) of a PE-CE link.
Usage
void modifyPECEMajorInterface(in boolean peInterfaceState, in boolean ipUnnumberedState, in boolean autoPickAddressState, in string routerInterface, in string routerInterfaceAddress, in string routerInterfaceTemplate, in CiscoVsmBrowser::VsmInterfaceType routerInterfaceType, in CiscoVsmBrowser::CircuitIdentifier circuitID)
raises(InvalidData, RepException);
Parameters
peInterfaceState—in boolean that, when TRUE, indicates the provider-edge router of the PE-CE link is to be modified. When set to FALSE, this parameter indicates the CE interface is to be modified.
ipUnnumberedState—in boolean that, when TRUE, indicates the modified interface is to be IP-unnumbered. When set to FALSE, this parameter indicates the modified interface is to be IP-numbered. These two boolean settings are roughly equivalent to executing the setIPUnnumbered(CiscoVsmBrowser::VsmInterfIPUnnumberType::InterfPECEIPUnnumbered) and setIPUnnumbered(CiscoVsmBrowser::VsmInterfIPUnnumberType::InterfIPNumbered) operations, respectively.
Use the value returned by the CiscoVsmBrowser::VsmSRVC::getIPUnnumbered() to determine programmatically whether the ipUnnumberedState parameter changes the original setting of the CiscoVsmBrowser::VsmInterfIPUnnumberType value for the PE-CE link. If so, the modifyPECEMajorInterface() operation must execute twice—once for the PE and once for the CE—prior to executing the addToRep() operation to modify the original service request.
autoPickAddressState—in boolean that, when TRUE, indicates that an IP address is to be assigned automatically to an IP-numbered interface from the address pools that belong to the PE region. If autoPickAddressState is TRUE, the routerInterfaceAddress parameter is ignored. These two boolean settings are equivalent to executing setAutoPickAddress(TRUE) and setAutoPickAddress(FALSE), respectively.
However, no exception is raised if an IP address is supplied through the routerInterfaceAddress parameter with the autoPickAddressState set to TRUE, which may cause problems when executing the modifyPECEMajorInterface() operation twice to change the original setting of the CiscoVsmBrowser::VsmInterfIPUnnumberType value for the PE-CE link.
routerInterfaceAddress—in string that represents the new interface address for the router indicated by the peInterfaceState value—for example, i.j.k.l/n, where n represents the subnet mask. If the interface is IP-unnumbered, the subnet mask, n, must be /32. The PE and CE interfaces are both IP-unnumbered if setIPUnumbered(CiscoVsmBrowser::VsmInterfIPUnnumberType::InterfPECEIPUnnumbered) executes.
This parameter is required and applicable only if autoPickAddressState is set to FALSE. In this case, the automatic address-allocation feature, which verifies that a chosen IP address is unique, is disabled. You must, therefore, ensure that the address that is supplied through this parameter does not overlap with the address pools of the CiscoVsmBrowser::VsmRegion object to which the PE member of the PE-CE link belongs.
routerInterfaceTemplate—in string that contains one or more IOS command strings to augment the configuration of the CE of the PE-CE link. Additional IOS command strings are optional, and no syntax or semantic checking is performed.
routerInterfaceType—in CiscoVsmBrowser::VsmInterfaceType that represents the interface type of the interface of the PE-CE link to be modified.
circuitID—in CiscoVsmBrowser::CircuitIdentifier represents the circuit-identifier data that corresponds to the interface of the PE-CE link to be modified. This is required for Frame Relay, ISL, and ATM interfaces. The circuit-identifier data must coincide with interface type—for, example, DLCI for Frame Relay and VCD, VPI and VCI for ATM. If the interface type is already set, when this operation executes, the circuitID input is compared with the known interface type to validate or invalidate the input.
Raises
CiscoVsmExceptions::InvalidData if any of the data supplied is invalid. CiscoVsmExceptions::RepException if errors occur when accessing the VPN Inventory Repository.
Description
While this operation does supply a means by which to modify the PE-CE link parameters of an existing service request, it is not recommended. its behavior is somewhat different than that of the collective operations that it inherits from the VsmVPNConnectivityCreator interface. For this reason, the recommended process for modifying a service request involves execution of one or more of the following operations as needed:
After executing the needed operations from the preceding list, execute the VsmVPNServiceModifier::addToRep() operation to add the modified service request to the VPN Inventory Repository. Using the inherited operations ensures that the same data-checking algorithms are used when modifying an existing service request as were used when creating the original service request.
See Also
VsmVPNConnectivityCreator::setIPUnnumbered, VsmVPNConnectivityCreator::setAutoPickAddress, VsmVPNConnectivityCreator::setCEInterface, VsmVPNConnectivityCreator::setPEInterface, VsmVPNConnectivityCreator::setCEInterfaceAddress, VsmVPNConnectivityCreator::setPEInterfaceAddress, VsmVPNConnectivityCreator::setCEInterfaceTemplate, VsmVPNConnectivityCreator::setPEInterfaceTemplate, VsmVPNConnectivityCreator::setCEInterfaceType, VsmVPNConnectivityCreator::setPEInterfaceType, VsmVPNConnectivityCreator::setCECircuitIdentifier, VsmVPNConnectivityCreator::setPECircuitIdentifier, VsmVPNConnectivityCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Modifies the routing protocol of the PE-CE link.
Usage
void modifyPECERoutingProtocol(in CiscoVsmBrowser::VsmPECELinkProtocolType routingProtocol, in CiscoVsmBrowser::advertisedRouteSeq advertisedRoutes, in CiscoVsmBrowser::redistributedProtocolSeq redistributedProtocols)
raises(InvalidData, RepException);
Parameters
routingProtocol—in CiscoVsmBrowser::VsmPECELinkProtocolType that represents the routing protocol for the PE-CE link—the connection between the provider-edge router (PE) and the customer-edge router (CE)— for exchanging advertised routes.
advertisedRoutes—in CiscoVsmBrowser::advertisedRouteSeq that represents the list of routes to be advertised by the customer-edge router (CE). A list of advertised routes is required only when changing the routingProtocol to a static protocol.
redistributedProtocols—in CiscoVsmBrowser::redistributedProtocolSeq that represents the list of all protocols present on the customer-edge router (CE), excluding the protocol used for communication over the PE-CE link. This protocol list is required only if the routing protocol to be used for the PE-CE link is either RIP or BGP—for example, if setPECERoutingProtocol(RIPv2RoutingType) or setPECERoutingProtocol(BGPRoutingType) is to execute—and the given protocol is to get its routing information through redistribution.
Raises
CiscoVsmExceptions::InvalidData if any of the data supplied is invalid. CiscoVsmExceptions::RepException if errors occur when accessing the VPN Inventory Repository.
Description
You can also use this operation to change the list of advertised routes or to change the list of redistributed protocols, even no change is required to the routing protocol.
See Also
CiscoVsmBrowser::VsmPECELinkProtocolType, CiscoVsmBrowser::advertisedRouteSeq
Since
Cisco VPN Solutions Center, Release 1.0
Posted: Tue Sep 26 16:56:31 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.