|
|
The file CiscoVsmBrowser.idl contains the following interfaces:
CiscoVsmBrowser::VsmCE CiscoVsmBrowser::VsmCERC CiscoVsmBrowser::VsmCERCMembership CiscoVsmBrowser::VsmConfiglet CiscoVsmBrowser::VsmCoSProfile CiscoVsmBrowser::VsmCustomer CiscoVsmBrowser::VsmCustomerSite CiscoVsmBrowser::VsmPE CiscoVsmBrowser::VsmPRG CiscoVsmBrowser::VsmProviderAdminDomain CiscoVsmBrowser::VsmRegion CiscoVsmBrowser::VsmSRVC CiscoVsmBrowser::VsmVPN CiscoVsmBrowser::VsmVRFDef
The CORBA VPN Service Model Browser module defines a set of CORBA interfaces with which to browse the service model objects in the VPN Inventory Repository. When instantiated, each of these objects corresponds with one of the key elements that collectively comprise the VPN service model.
See Also
CiscoVpnServiceModel, CiscoVsmFWCreator, CiscoVsmFWModifier, CiscoVsmSRCreator, CiscoVsmExceptions
Since
Cisco VPN Solutions Center, Release 1.0
List of all subnets a customer site to be advertised and accessible to the provider-edge router (PE) through the customer-edge router (CE).
Usage
typedef sequence<string> advertisedRouteSeq
Description
Advertised routes are required only when static routing is used for the PE-CE link---for example, if CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol(StaticRoutingType) is to execute---instead of a dynamic protocol, such as RIP or BGP.
Each advertised route is specified as ip_address/host_mask_length--- for example, 171.71.29.0/24.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEAdvertisedRoutes, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, routesToAllSitesSeq, VsmPECELinkProtocolType, redistributedProtocolSeq
Since
Cisco VPN Solutions Center, Release 1.0
Identifies a circuit as either Frame Relay, ISL, or ATM.
Usage
struct CircuitIdentifier
{
long id1
long id2
long id3
};
Members
id1---Frame Relay range is 16 through 1007 (DLCI value); ISL range is 1 through 1000 (VLAN ID value); ATM range is 1 through 4096 (VCD value).
id2---Unused for Frame Relay; unused for ISL; ATM range is 0 through 255 (VPI value).
id2---Unused for Frame Relay; unused for ISL; ATM range is 0 through 65535 (VCI value).
Description
How the CircuitIdentifier fields are used depends on the circuit type it is to represent. For Frame Relay circuits, use the following:
For ISL circuits, use the following:
For ATM circuits, use the following:
Set all unused CircuitIdentifier fields to -1.
See Also
VsmInterfaceType, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCECircuitIdentifier, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECircuitIdentifier
Since
Cisco VPN Solutions Center, Release 1.0
List of protocols that are redistributed from the customer-edge router (CE). This includes all protocols present on the CE, excluding the protocol used for communication over the PE-CE link.
Usage
typedef sequence<string> redistributedProtocolSeq
Description
This is required only if the routing protocol to be used for the PE-CE link is either RIP or BGP---for example, if CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol(RIPv2RoutingType) or CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol(BGPRoutingType) is to execute---and the given protocol is to get its routing information through redistribution.
Each item in the list should contain name of one protocol. For protocols that require an autonomous system, include the AS number in the the protocol designation---for example, bgp 69.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCERedistributedProtocols, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, advertisedRouteSeq, routesToAllSitesSeq, VsmPECELinkProtocolType
Since
Cisco VPN Solutions Center, Release 1.0
Summarized list of all subnets at other customer sites that can be reached from the customer-edge router (CE).
Usage
typedef sequence<string> routesToAllSitesSeq
Description
The routes to all customer sites are required only when static routing is used for the PE-CE link---for example, if CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol(StaticRoutingType) is to execute---instead of a dynamic protocol, such as RIP or BGP.
Each advertised route is specified as ip_address/host_mask_length---for example, 171.71.29.0/24.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setRoutesToAllSites, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, advertisedRouteSeq, VsmPECELinkProtocolType, redistributedProtocolSeq
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmCERCMembership objects.
Usage
typedef sequence<VsmCERCMembership> VsmCERCMembershipSeq
See Also
VsmCERCMembership, VsmVRFDef::getAllCERCMemberships, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCERCMemberships, CiscoVsmSRCreator::VsmVPNServiceModifier::modifyCERCMemberships
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmCERC objects.
Usage
typedef sequence<VsmCERC> VsmCERCSeq
See Also
VsmCERC, VsmVPN::getAllCERCs
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmCE objects.
Usage
typedef sequence<VsmCE> VsmCESeq
See Also
VsmCE, VsmCustomerSite::getAllCEs, VsmVPN::getAllCEs
Since
Cisco VPN Solutions Center, Release 1.0
Represents a type of customer-edge router (CE).
Usage
enum VsmCEType
{
CETypeUnmanaged,
CETypeManagedRegular,
CETypeManagedShadow,
CETypeManagedMgmtLan,
CETypeManagedRegularSAA,
CETypeManagedShadowSAA,
CETypeManagedMgmtLanSAA,
CETypeDirectConnectedRegular,
CETypeDirectConnectedMgmtHost
};
Enumerators
CETypeUnmanaged---Unmanaged CE.
CETypeManagedRegular---Regular managed CE.
CETypeManagedShadow---Shadow managed CE.
CETypeManagedMgmtLan---Management LAN CE.
CETypeManagedRegularSAA---Regular managed SAA.
CETypeManagedShadowSAA---Shadow managed SAA.
CETypeManagedMgmtLanSAA---Management LAN SAA.
CETypeManagedMgmtLanSAA---Direct connected host.
CETypeDirectConnectedMgmtHost---Direct connected management host.
See Also
VsmCE, VsmCE::getCEType, CiscoVsmFWCreator::VsmCECreator::setCEType
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmConfiglet objects.
Usage
typedef sequence<VsmConfiglet> VsmConfigletSeq
See Also
VsmConfiglet, VsmPE::getConfigletList, VsmCE::getConfiglets, VsmVPN::getConfiglets
Since
Cisco VPN Solutions Center, Release 1.0
The VsmCoSClass struct represents CoS class of service provided by this provider admin domain in a CoS profile.
Usage
struct VsmCoSClass
{
string className
short cosPrecedence
VsmInboundRateExceedAction exceedAction
unsigned long cePeRate
unsigned long peCeRate
unsigned long flag
};
Members
className---string that represents the the name of this CoS class. The string must has a length no longer than 64 characters.
cosPrecedence---short that represents the precedence number of this CoS Class. ?? Is this the same a the CoS precedence bits? ??
exceedAction---VsmInboundRateExceedAction that represents the action to take when the rate limit has exceeded the class specification. This value is reserved for future use. Current system uses the action specified in the CoSProfile object instead.
cePeRate---unsigned long that represents the rate limit from CE to PE.
peCeRate---unsigned long that represents the rate limit from PE to CE.
flag---unsigned long that is reserved for future use.
See Also
VsmCoSClassSeq, VsmInboundRateExceedAction
Since
Cisco VPN Solutions Center, Release 1.0
A sequence of VsmCoSClass objects.
Usage
typedef sequence<VsmCoSClass> VsmCoSClassSeq
See Also
VsmCoSClass, VsmCoSProfile::getAllCoSClasses, CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Represents the selected configuration actions for a CoS Profile.
Usage
enum VsmCoSProfileConfig
{
CoSNoConfig,
CoSApplyShaping,
CoSShapeOutOfContractOnly,
CoSApplyAdaptiveOnFR,
CoSApplyPolicing,
CoSDropExcessTraffic,
CoSUseGTSForCongMgmt,
CoSUseWREDForCongMgmt,
CoSUseFairQueueingForCongMgmt,
CoSUseCARForCongMgmt
};
Enumerators
CoSNoConfig---No configuration.
CoSApplyShaping---Apply shaping on the CE.
CoSShapeOutOfContractOnly---Shape only the out of contract traffic.
CoSApplyAdaptiveOnFR---Apply adaptive shaping for Frame Relay.
CoSApplyPolicing---Apply policing on the ingress PE.
CoSDropExcessTraffic---Drop the packet of excessive traffic.
CoSUseGTSForCongMgmt---Use GTS for congestion management on the egress PE.
CoSUseWREDForCongMgmt---Use WRED for congestion management.
CoSUseFairQueueingForCongMgmt---Use Fair Queueing for congestion management on the egress PE.
CoSUseCARForCongMgmt---Use Committed Access Rate (CAR) congestion management on the egress PE.
See Also
VsmCoSProfileConfigSeq
Since
Cisco VPN Solutions Center, Release 1.0
List of VsmCoSProfileConfig objects in the service model.
Usage
typedef sequence<VsmCoSProfileConfig> VsmCoSProfileConfigSeq
See Also
VsmCoSProfileConfig, VsmCoSProfile::getCoSProfileConfig, CiscoVsmFWCreator::VsmCoSProfileCreator::setCoSProfileConfig
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmCoSProfile objects.
Usage
typedef sequence<VsmCoSProfile> VsmCoSProfileSeq
See Also
VsmCoSProfile, VsmProviderAdminDomain::getCoSProfiles
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmCustomer objects.
Usage
typedef sequence<VsmCustomer> VsmCustomerSeq
See Also
VsmCustomer, CiscoVpnServiceModel::VpnInvMgr::getAllCustomers
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmCustomerSite objects.
Usage
typedef sequence<VsmCustomerSite> VsmCustomerSiteSeq
See Also
VsmCustomerSite, VsmCustomer::getAllCustomerSites
Since
Cisco VPN Solutions Center, Release 1.0
Represents the action to take when the rate limit has exceeded the specification in the CoSClass.
Usage
enum VsmInboundRateExceedAction
{
ActionDrop,
ActionRepaintTransmit
};
Enumerators
ActionDrop---Drop the packet.
ActionRepaintTransmit---Repaint the packet and transmit it.
See Also
VsmCoSClass
Since
Cisco VPN Solutions Center, Release 1.0
Interface encapsulation for a provider-edge router (PE) interface or a customer-edge router (CE) interface.
Usage
enum VsmInterfaceEncapsulation
{
Unknown_Encap,
FrameRelay_Encap,
HDLC_Encap,
PPP_Encap,
ATM_Encap,
ISL_Encap,
FrameRelay_IETF_Encap,
Default_Encap
};
Interface type for the link between a provider-edge router (PE) and the a customer-edge router (CE).
Usage
enum VsmInterfaceType
{
Unknown,
POS,
POS_PPP,
POS_HDLC,
POS_FrameRelay,
FastEthernet,
FastEthernet_ISL,
Ethernet,
Serial,
Serial_PPP,
Serial_FrameRelay,
Serial_HDLC,
ATM,
HSSI,
HSSI_HDLC,
HSSI_PPP,
HSSI_FrameRelay,
FDDI,
GigabitEthernet,
GigabitEthernet_ISL,
WAN_Switch
};
Enumerators
Unknown---Unknown interface type.
POS---Generic POS interface.
POS_PPP---POS interface for point-to-point protocol.
POS_HDLC---POS interface for HDLC.
POS_FrameRelay---POS interface for Frame Relay.
FastEthernet---Generic fast ethernet interface.
FastEthernet_ISL---Fast ethernet interface for ISL.
Ethernet---Generic ethernet interface.
Serial---Generic serial interface.
Serial_PPP---Serial interface for point-to-point protocol.
Serial_FrameRelay---Serial interface for Frame Relay.
Serial_HDLC---Serial interface for HDLC.
ATM---Asynchronous transfer mode (ATM) interface.
HSSI---Generic HSSI interface.
HSSI_HDLC---HSSI interface for HDLC.
HSSI_PPP---HSSI interface for point-to-point protocol.
HSSI_FrameRelay---HSSI interface for Frame Relay.
FDDI---FDDI interface.
GigabitEthernet---Generic gigabit ethernet interface.
GigabitEthernet_ISL---Gigabit ethernet interface for ISL.
WAN_Switch---WAN switch interface.
Description
The interface type also specifies specific encapsulation types, where applicable.
See Also
CircuitIdentifier, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterfaceType, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEInterfaceType
Since
Cisco VPN Solutions Center, Release 1.0
Indicates whether the PE and CE interfaces of the PE-CE link are both IP-numbered or both IP-unnumbered.
Usage
enum VsmInterfIPUnnumberType
{
InterfIPNumbered,
InterfPECEIPUnnumbered
};
Enumerators
InterfIPNumbered---The PE and CE interfaces are both IP-numbered.
InterfPECEIPUnnumbered---The PE and CE interfaces are both IP-unnumbered.
See Also
VsmSRVC::getIPUnnumbered, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setIPUnnumbered, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setAutoPickAddress, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterfaceAddress, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEInterfaceAddress
Since
Cisco VPN Solutions Center, Release 1.0
IP address.
Usage
typedef string VsmIPAddress
See Also
VsmIPAddressPool, VsmIPAddressSeq, VsmRegion::getNext30Address, VsmRegion::getNext32Address, VsmRegion::freeIPAddress30, VsmRegion::freeIPAddress32, VsmRegion::isAddressOverlappedWithPool30, VsmRegion::isAddressOverlappedWithPool32, VsmSRVC::getPEAddress, VsmSRVC::getCEAddress
Since
Cisco VPN Solutions Center, Release 1.0
Pool of unique IP addresses available for allocation by the VsmRegion object to which the pool is assigned.
Usage
typedef string VsmIPAddressPool
See Also
VsmIPAddress, VsmIPAddressPoolSeq, CiscoVpnServiceModel::VpnInvMgr::addIPAddressPool30, CiscoVpnServiceModel::VpnInvMgr::addIPAddressPool32
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmIPAddressPool types.
Usage
typedef sequence<VsmIPAddressPool> VsmIPAddressPoolSeq
See Also
VsmIPAddressPool, VsmRegion::getAllIPAddressPool30, VsmRegion::getAllIPAddressPool32
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmIPAddress types.
Usage
typedef sequence<VsmIPAddress> VsmIPAddressSeq
See Also
VsmIPAddress, VsmRegion::getAllFreeIPAddress30, VsmRegion::getAllFreeIPAddress32
Since
Cisco VPN Solutions Center, Release 1.0
Stores the router-login user ID and password, router-enable user ID and password, and the SNMP read-only and read-write community attributes.
Usage
struct VsmPassword
{
string loginUID
string enableUID
string loginPW
string enablePW
string snmpRoComm
string snmpRwComm
short level
};
Members
loginUID---string that represents the router login login-user ID.
enableUID---string that represents the router enable user id.
loginPW---string that represents the router login password.
enablePW---string that represents the router enable password.
snmpRoComm---string that represents the SNMP read-only community attribute.
snmpRwComm---string that represents the SNMP read-write community attribute.
level---short that represents the password level in the multi-level password scheme, such as the Popeye MGX switch.
See Also
VsmPasswordSeq, CiscoVpnServiceModel::VpnInvMgr::addRouterPasswordToPE, CiscoVpnServiceModel::VpnInvMgr::removeRouterPasswordFromPE, CiscoVpnServiceModel::VpnInvMgr::addRouterPasswordToCE, CiscoVpnServiceModel::VpnInvMgr::removeRouterPasswordFromPE
Since
Cisco VPN Solutions Center, Release 1.0
List of VsmPassword structures.
Usage
typedef sequence<VsmPassword> VsmPasswordSeq
See Also
VsmPassword, VsmPE::getRouterPasswordList, VsmCE::getRouterPasswordList, CiscoVsmFWCreator::VsmPECreator::setRouterPasswords, CiscoVsmFWCreator::VsmCECreator::setRouterPasswords
Since
Cisco VPN Solutions Center, Release 1.0
Represents if either end of the PE-CE link is IP unnumbered.
Usage
enum VsmPECELinkProtocolType
{
UnknownRoutingType,
StaticRoutingType,
RIPv2RoutingType,
BGPRoutingType
};
Enumerators
UnknownRoutingType---Unkown routing protocol.
StaticRoutingType---Static routing protocol.
RIPv2RoutingType---RIPv2 routing protocol.
BGPRoutingType---BGP routing protocol.
See Also
VsmSRVC::getPECELinkProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEAutonomousSystem, CiscoVsmSRCreator::VsmVPNServiceModifier::modifyPECERoutingProtocol
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmPE objects.
Usage
typedef sequence<VsmPE> VsmPESeq
See Also
VsmPE, VsmRegion::getAllPEs, VsmVPN::getAllPEs
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmPRG objects.
Usage
typedef sequence<VsmPRG> VsmPRGSeq
See Also
VsmPRG, VsmVPN::getAllPRGs
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmProviderAdminDomain objects.
Usage
typedef sequence<VsmProviderAdminDomain> VsmProviderAdminDomainSeq
See Also
VsmProviderAdminDomain, CiscoVpnServiceModel::VpnInvMgr::getAllProviders
Since
Cisco VPN Solutions Center, Release 1.0
Seed for allocating route-distinguisher (RD) values.
Usage
typedef string VsmRDSeed
See Also
VsmRDSeedSeq, VsmProviderAdminDomain::getNextRD, VsmProviderAdminDomain::freeRD
Since
Cisco VPN Solutions Center, Release 1.0
A sequence of VsmRDSeed types.
Usage
typedef sequence<VsmRDSeed> VsmRDSeedSeq
See Also
VsmRDSeed, VsmRTSeedSeq, VsmProviderAdminDomain::getAllFreeRDs, VsmProviderAdminDomain::getAllRDSeeds
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmRegion objects.
Usage
typedef sequence<VsmRegion> VsmRegionSeq
See Also
VsmRegion, VsmProviderAdminDomain::getAllRegions
Since
Cisco VPN Solutions Center, Release 1.0
Stores router interface information.
Usage
struct VsmRouterInterface
{
string interfName
string interfAddr
};
Members
interfName---string that represents the interface name---Serial0/1, for example.
interfAddr---string that represents the interface address---192.100.200.201, for example.
See Also
CiscoVpnServiceModel::VpnInvMgr::addRouterInterfaceToPE, CiscoVpnServiceModel::VpnInvMgr::removeRouterInterfaceFromPE, CiscoVpnServiceModel::VpnInvMgr::addRouterInterfaceToCE, CiscoVpnServiceModel::VpnInvMgr::removeRouterInterfaceFromCE
Since
Cisco VPN Solutions Center, Release 1.0
List of VsmRouterInterface objects in the service model.
Usage
typedef sequence<VsmRouterInterface> VsmRouterInterfaceSeq
See Also
VsmRouterInterface, VsmPE::getRouterInterfaceList, VsmCE::getRouterInterfaceList, CiscoVsmFWCreator::VsmPECreator::setRouterInterfaces, CiscoVsmFWCreator::VsmCECreator::setRouterInterfaces
Since
Cisco VPN Solutions Center, Release 1.0
Seed for allocating route-target (RT) values.
Usage
typedef string VsmRTSeed
See Also
VsmRTSeedSeq, VsmProviderAdminDomain::getNextRT, VsmProviderAdminDomain::freeRT
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmRTSeed types.
Usage
typedef sequence<VsmRTSeed> VsmRTSeedSeq
See Also
VsmRTSeed, VsmRDSeedSeq, VsmProviderAdminDomain::getAllFreeRTs, VsmProviderAdminDomain::getAllRTSeeds
Since
Cisco VPN Solutions Center, Release 1.0
Represents the state of a service request.
Usage
enum VsmSRState
{
Requested,
Pending,
Invalid,
FailedDeploy,
Deployed,
Broken,
Functional,
Lost,
Closed
};
Enumerators
Requested---A service is requested.
Pending---A service request is pending.
Invalid---A service request is invalid.
FailedDeploy---A service request failed to deploy.
Deployed---A service request was deployed.
Broken---A service request is broken.
Functional---A service request is functional.
Lost---A service request is lost.
Closed ---A service request is closed.
See Also
VsmSRStateSeq, VsmSRType, VsmSRVC::getState
Since
Cisco VPN Solutions Center, Release 1.0
VsmSRState status indicators that correspond to each service- request instance in the service model.
Usage
typedef sequence<VsmSRState> VsmSRStateSeq
See Also
VsmSRState, VsmPE::getConfigletList, VsmPE::getSRVCs, VsmCE::getConfiglets, VsmCE::getSRVCs, VsmVPN::getConfiglets, VsmCustomer::getSRVCs, VsmVRFDef::getSRVCs, VsmPRG::getSRVCs, VsmCoSProfile::getSRVCs, CiscoVpnServiceModel::VpnInvMgr::getAllSRVCs, CiscoVpnServiceModel::VpnInvMgr::findSRVCsByPECEPair
Since
Cisco VPN Solutions Center, Release 1.0
Represents a service-request type.
Usage
enum VsmSRType
{
SRTypeAdd,
SRTypeDelete
};
Enumerators
SRTypeAdd---Add an SRVC to the service model. SRTypeDelete---Delete an SRVC from the service model.
See Also
VsmSRState, VsmSRVC::getType
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmSRVC objects.
Usage
typedef sequence<VsmSRVC> VsmSRVCSeq
See Also
VsmSRVC, VsmSRState, VsmSRStateSeq, VsmPE::getSRVCs, VsmCE::getSRVCs, VsmCustomer::getSRVCs, VsmVRFDef::getSRVCs, VsmPRG::getSRVCs, VsmCoSProfile::getSRVCs, VsmConfiglet::getSRVCs
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmVPN objects.
Usage
typedef sequence<VsmVPN> VsmVPNSeq
See Also
VsmVPN, CiscoVpnServiceModel::VpnInvMgr::getAllVPNs
Since
Cisco VPN Solutions Center, Release 1.0
Sequence of VsmVRFDef objects.
Usage
typedef sequence<VsmVRFDef> VsmVRFDefSeq
See Also
VsmVRFDef, VsmProviderAdminDomain::getVRFDefs, VsmCERC::getAllVRFDefs
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmCE interface represents a customer-edge router (CE) in the VPN Inventory Repository. Each CE connects a customer site (VsmCustomerSite object) to a provider-edge router (VsmPE object) and obtains the VPN service for that customer site. Each CE belongs to exactly one customer site. Each CE may have multiple configlets (VsmConfiglet objects) and can be configured through one or more service requests (VsmSRVC objects).
See Also
CiscoVpnServiceModel::VpnInvMgr::newCECreator, CiscoVpnServiceModel::VpnInvMgr::releaseCECreator, CiscoVsmFWCreator::VsmCECreator, CiscoVsmFWCreator::VsmCECreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseCE, VsmPE, VsmCustomer, VsmCustomerSite, VsmConfiglet, VsmSRVC
Since
Cisco VPN Solutions Center, Release 1.0
Returns VsmCEType-enumerated constant that indicates the router type of this customer-edge router.
Usage
VsmCEType getCEType();
Returns
VsmCEType---Enumerated constant that respesents the router type of this customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmFWCreator::VsmCECreator::setCEType
Since
Cisco VPN Solutions Center, Release 1.0
Gets the configlets (VsmConfiglet objects) for this customer-edge router.
Usage
VsmConfigletSeq getConfiglets(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmConfiglet objects that are related to this customer-edge router.
Returns
VsmConfigletSeq---List of VsmConfiglet objects for this customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmConfiglet, VsmConfiglet::getCE, VsmConfiglet::getSRVCs, VsmPE::getConfigletList, VsmVPN::getConfiglets
Since
Cisco VPN Solutions Center, Release 1.0
Gets the customer site (VsmCustomerSite object) to which this customer-edge router belongs.
Usage
VsmCustomerSite getCustomerSite(); raises(RepException);
Returns
VsmCustomerSite---Customer site to which this customer-edge router belongs.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmCustomerSite, CiscoVsmFWCreator::VsmCECreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets the domain name of the customer-edge router.
Usage
string getDomainName(); raises(RepException, InvalidData);
Returns
string---Domain name of the customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
See Also
CiscoVsmFWCreator::VsmCECreator::setDomainName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the host name of the customer-edge router.
Usage
string getHostName(); raises(RepException, InvalidData);
Returns
string---Host name of the customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
See Also
CiscoVsmFWCreator::VsmCECreator::setHostName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the device ID value. An ID value is assigned to each CE object when it is added to the VPN Inventory Repository.
Usage
unsigned long getID(); raises(RepException, InvalidData);
Returns
unsigned long---ID value of the customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the name of the network to which this customer-edge router belongs.
Usage
string getNetworkName(); raises(RepException, InvalidData);
Returns
string---Name of the network to which this customer-edge router belongs.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
See Also
CiscoVsmFWCreator::VsmCECreator::setNetworkName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the list of router-interface objects for this customer-edge router.
Usage
VsmRouterInterfaceSeq getRouterInterfaceList(); raises(RepException);
Returns
VsmRouterInterfaceSeq---List of interface objects for this customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmFWCreator::VsmCECreator::setRouterInterfaces
Since
Cisco VPN Solutions Center, Release 1.0
Gets the list of passwords for this customer-edge router.
Usage
VsmPasswordSeq getRouterPasswordList(); raises(RepException);
Returns
VsmPasswordSeq---List of passwords for this customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmPassword, CiscoVsmFWCreator::VsmCECreator::setRouterPasswords
Since
Cisco VPN Solutions Center, Release 1.0
Gets all service requests (VsmSRVC objects) for this customer-edge router that match one of the VsmSRState values in the list of VsmSRState values supplied as an input parameter.
Usage
VsmSRVCSeq getSRVCs(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this customer-edge router.
Returns
VsmSRVCSeq---List of service requests (VsmSRVC objects) for this customer-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmSRVC, VsmSRVC::getCE , VsmSRVC::getCEConfiglet , VsmSRState, VsmSRStateSeq, VsmPE::getSRVCs, VsmCustomer::getSRVCs, VsmVRFDef::getSRVCs, VsmPRG::getSRVCs, VsmCoSProfile::getSRVCs
Since
Cisco VPN Solutions Center, Release 1.0
The VsmCERC object represents the CE Routing Community (CERC). CERC is used to define the relationship between sites. The relationship can be either full mesh or hub-and-spoke.
See Also
VsmCE, VsmCERCMembership, CiscoVpnServiceModel::VpnInvMgr::newCERCCreator, CiscoVsmFWCreator::VsmCERCCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseCERC, CiscoVpnServiceModel::VpnInvMgr::releaseCERCCreator
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the VRF Definitions that join this CERC.
Usage
VsmVRFDefSeq getAllVRFDefs(); raises(RepException);
Returns
VsmVRFDefSeq type, which lists the VRF Definitions objects.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the description string about this CERC.
Usage
string getDesc();
Returns
string type, which represents the description string.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the route target value of the hub.
Usage
string getHubRT();
Returns
string type, which represents the RT string.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the unique CERC id
Usage
unsigned long getID();
Returns
unsigned long type, which represents the id value.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the route target value of the spoke.
Usage
string getSpokeRT();
Returns
string type, which represents the RT string.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VPN object this CERC belongs to
Usage
VsmVPN getVPN(); raises(RepException);
Returns
VsmVPN type, which represents the VPN object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
This interface represents a relationship between a VRF Definition and CERC. It dictates which CERC a VRF Definition is joining and whether it is joining the CERC as a hub or a spoke.
See Also
VsmCE, VsmCERC, VsmVRFDef, CiscoVpnServiceModel::VpnInvMgr::newCERCMembership, CiscoVpnServiceModel::VpnInvMgr::releaseCERCMembership
Since
Cisco VPN Solutions Center, Release 1.0
Gets the CERC object regarding this CERC Membership.
Usage
VsmCERC getCERC();
Returns
VsmCERC type, which represents the CERC.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the underlying CERC hub RT value
Usage
string getCERCHubRT();
Returns
string type, which represents the CERC RT value
Since
Cisco VPN Solutions Center, Release 1.0
Gets the CERC ID for the underline CERC.
Usage
unsigned long getCERCID();
Returns
unsigned long type, which represents the CERC's ID value.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the underline CERC's spoke RT value
Usage
string getCERCSpokeRT();
Returns
string type, which represents the CERC's RT value
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VPN name which the underline CERC belongs to.
Usage
string getCERCVPNName();
Returns
string type, which represents the VPN name.
Since
Cisco VPN Solutions Center, Release 1.0
Returns TRUE if this VsmCERCMembership dictates a VRF Definition object allows a site to join a CERC as a hub site.
Usage
boolean isHubRTUsed();
Returns
TRUE or FALSE.
Since
Cisco VPN Solutions Center, Release 1.0
The configlet object represents a configlet file which stores a set of router configuration commands for a particular provisioning task.
See Also
VsmPE, VsmCE, VsmVPN, CiscoVsmSRCreator::VsmVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::releaseConfiglet
Since
Cisco VPN Solutions Center, Release 1.0
Gets the corresponding VsmCE object if this configlet is for a customer-edge router (PE).
Usage
VsmCE getCE(); raises(RepException);
Returns
VsmCE---CE object with which this VsmConfiglet object is associated.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Description
If the getCE() operation is executed by a VsmConfiglet object that does not correspond with a VsmCE object, this operation returns nothing.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the text content of the VsmConfiglet.
Usage
string getConfigletText(); raises(RepException);
Returns
string---Text content of the VsmConfigle object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the unique identifer of the VsmConfiglet object.
Usage
unsigned long getID();
Returns
unsigned long---Unique identifier value that is assigned to the VsmConfiglet object upon adding it the to the VPN Inventory Repository.
Description
Each VsmConfiglet object is assigned a unique identifier value upon saving it in the VPN Inventory Repository.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the corresponding VsmPE object if this configlet is for a provider-edge router (PE).
Usage
VsmPE getPE(); raises(RepException);
Returns
VsmPE---PE object with which this VsmConfiglet object is associated.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Description
If the getPE() operation is executed by a VsmConfiglet object that does not correspond with a VsmPE object, this operation returns nothing.
Since
Cisco VPN Solutions Center, Release 1.0
Gets all VsmSRVC associated with the generation of this VsmConfiglet object.
Usage
VsmSRVCSeq getSRVCs(); raises(RepException);
Returns
VsmSRVCSeq---List of VsmSRVC objects that are associate with the generation of this VsmConfiglet object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
The VsmCoSProfile object represents a profile of CoS provided by this provider admin domain.
See Also
CiscoVpnServiceModel::VpnInvMgr::newCoSProfileCreator, CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfileCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfile
Since
Cisco VPN Solutions Center, Release 1.0
Gets all CoS classes defined for this CoS profile.
Usage
VsmCoSClassSeq getAllCoSClasses(); raises(RepException);
Returns
VsmCoSClassSeq object, which is a collection of VsmCoSClass objects.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Returns the configured values of the VsmCoSProfileConfig.
Usage
VsmCoSProfileConfigSeq getCoSProfileConfig();
Returns
VsmCoSProfileConfig type, which lists the values of the profile configurations.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the name of the CoS Profile.
Usage
string getName();
Returns
string type, which lists the name of the CoS Profile.
See Also
CiscoVsmFWCreator::VsmCoSProfileCreator::setName, VsmProviderAdminDomain::getName, VsmRegion::getName, VsmCustomer::getName, VsmCustomerSite::getName, VsmVPN::getName, VsmVRFDef::getName
Since
Cisco VPN Solutions Center, Release 1.0
Returns the multiplier for setting the out of contract limit without dropping the packets.
Usage
float getOutOfContractMultiplier();
Returns
float type, which is the value of the multiplier.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the provider admin domain that owns this CoS Profile.
Usage
VsmProviderAdminDomain getProviderAdminDomain(); raises(RepException);
Returns
VsmProviderAdminDomain type, which represents the provider admin domain object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets all SRVC objects that use this CoS Profile. The state of each returned SRVC matches one of the states in requestStates.
Usage
VsmSRVCSeq getSRVCs(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq) that lists the valid states of an SRVC object.
Returns
VsmSRVCSeq object, which is a collection of SRVC objects that use this CoS Profile.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Returns TRUE if the current profile is part of the default set of profiles.
Usage
boolean isDefault();
Returns
TRUE or FALSE.
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmCustomer interface represents a customer that requests a VPN service of an internet-service provider (ISP). Each customer may have multiple sites---for example, CustomerSite_1, CustomerSite_2, ..., CustomerSite_n---and may have many service requests (VsmSRVC objects) associated with them.
See Also
CiscoVpnServiceModel::VpnInvMgr::newCustomerCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerCreator, CiscoVsmFWCreator::VsmCustomerCreator, CiscoVsmFWCreator::VsmCustomerCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseCustomer
Since
Cisco VPN Solutions Center, Release 1.0
Gets a VsmCustomerSite object based on its name string.
Usage
VsmCustomerSite findCustomerSiteByName(in string name)
raises(RepException);
Parameters
name---in string that represents the customer-site name.
Returns
VsmRegion---Specific VsmCustomerSite object that belongs to this customer and matches the specied name string.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmCustomerSite, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep, CiscoVsmFWCreator::VsmCustomerSiteCreator::setName, VsmCustomerSite::getName
Since
Cisco VPN Solutions Center, Release 1.0
Gets all VsmCustomerSite objects that belong to this customer.
Usage
VsmCustomerSiteSeq getAllCustomerSites(); raises(RepException);
Returns
VsmCustomerSiteSeq---List of VsmCustomerSite objects that belong to this customer.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmCustomerSite, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets the contact information for this customer.
Usage
string getContactInfo();
Returns
string---Customer-contact information.
See Also
CiscoVsmFWCreator::VsmCustomerCreator::setContactInfo, VsmProviderAdminDomain::getContactInfo
Since
Cisco VPN Solutions Center, Release 1.0
Gets the customer name.
Usage
string getName();
Returns
string---Customer name.
See Also
CiscoVsmFWCreator::VsmCustomerCreator::setName, VsmProviderAdminDomain::getName, VsmRegion::getName, VsmCustomerSite::getName, VsmVPN::getName, VsmVRFDef::getName, VsmCoSProfile::getName
Since
Cisco VPN Solutions Center, Release 1.0
Gets a list of all provider-edge routers (VsmPE objects) to which this customer is connected. A customer is said to be connected to a PE P if there is a service request between P and a CE of the customer and that the service request is in one of the states specified in requestStates.
Usage
VsmPESeq getPEs(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this provider-edge router.
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this provider-edge router.
Returns
VsmPESeq---List of VsmPE objects to which this customer is connected
Raises
RepException if a VPN Inventory Repository error occurs.
See Also
VsmPE
Since
Cisco VPN Solutions Center, Release 1.0
Gets a list of all VsmSRVC objects that match one of the states specified by requestStates and are not subsumed by another VsmSRVC object.
Usage
VsmSRVCSeq getSRVCs(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states that qualify the SRVCs to be retrieved.
Returns
VsmSRVCSeq---List of VsmSRVC objects that match the request states supplied as input criteria through requestStates.
Raises
RepException if a VPN Inventory Repository error occurs.
See Also
VsmSRVC, VsmSRVCSeq, VsmSRState, VsmSRStateSeq, VsmPE::getSRVCs, VsmCE::getSRVCs, VsmVRFDef::getSRVCs, VsmPRG::getSRVCs, VsmCoSProfile::getSRVCs, VsmConfiglet::getSRVCs
Since
Cisco VPN Solutions Center, Release 1.0
Gets a list of all VPNs (VsmVPN objects) to which this customer belongs. A customer is said to be in VPN V if there is a service request that belongs to V and that the service request is in one of the states specified in requestStates.
Usage
VsmVPNSeq getVPNs(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this provider-edge router.
Returns
VsmVPNSeq---List of VsmVPN objects that this customer belongs
Raises
RepException if a VPN Inventory Repository error occurs.
See Also
VsmVPN
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmCustomerSite interface represents a specific site that belongs to exactly one customer (VsmCustomer object) and can have one or more customer-edge (CE) routers (VsmCE objects). Each customer site consists of IP systems with mutual IP interconnectivity and communication between them without the use of a VPN.
See Also
CiscoVpnServiceModel::VpnInvMgr::newCustomerSiteCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerSiteCreator, CiscoVsmFWCreator::VsmCustomerSiteCreator, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseCustomerSite
Since
Cisco VPN Solutions Center, Release 1.0
Gets all customer-edge routers (CEs) that belong to this customer site.
Usage
VsmCESeq getAllCEs(); raises(RepException);
Returns
VsmCESeq---List of all CEs at this customer site.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmFWCreator::VsmCECreator::addToRep, VsmRegion::getAllPEs
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VsmCustomer object to which this customer site belongs.
Usage
VsmCustomer getCustomer(); raises(RepException);
Returns
VsmCustomer---Object that represents the customer to to which this customer site belongs.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmFWCreator::VsmCustomerSiteCreator, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets the location information for this customer site.
Usage
string getLocationInfo();
Returns
string---Location information for this customer site.
See Also
CiscoVsmFWCreator::VsmCustomerSiteCreator::setLocationInfo
Since
Cisco VPN Solutions Center, Release 1.0
Gets the name of this customer site.
Usage
string getName();
Returns
string---Customer-site name.
See Also
CiscoVsmFWCreator::VsmCustomerSiteCreator::setName, VsmProviderAdminDomain::getName, VsmRegion::getName, VsmCustomer::getName, VsmVPN::getName, VsmVRFDef::getName, VsmCoSProfile::getName
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmPE interface represents a provider-edge router (PE) in the VPN Inventory Repository. Each PE belongs to one and only one region (VsmRegion object) of the provider administrative domain (VsmProviderAdminDomain object). Each VsmPE object may have multiple VPN routing/forwarding tables (VsmVRFDef objects), configlets (VsmConfiglet objects), and may be configured by any of several service requests (VsmSRVC objects).
See Also
CiscoVpnServiceModel::VpnInvMgr::newPECreator, CiscoVpnServiceModel::VpnInvMgr::releasePECreator, CiscoVsmFWCreator::VsmPECreator, CiscoVsmFWCreator::VsmPECreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releasePE, VsmCE, VsmRegion, VsmProviderAdminDomain, VsmConfiglet, VsmSRVC, VsmVRFDef
Since
Cisco VPN Solutions Center, Release 1.0
Gets the configlets (VsmConfiglet objects) for this provider-edge router.
Usage
VsmConfigletSeq getConfigletList(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmConfiglet objects that are related to this provider-edge router.
Returns
VsmConfigletSeq---List of VsmConfiglet objects for this provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmConfiglet, VsmConfiglet::getPE, VsmConfiglet::getSRVCs, VsmCE::getConfiglets, VsmVPN::getConfiglets
Since
Cisco VPN Solutions Center, Release 1.0
Gets all customers (VsmCustomer objects) that are connected to this provider-edge router (PE). A PE is said to be connected to a customer X if there is a service request between a CE of X and the PE and that the service request is in one of the states specified in requestStates.
Usage
VsmCustomerSeq getCustomers(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this provider-edge router.
Returns
VsmCustomerSeq---List of customers (VsmCustomer objects) for this provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmCustomer
Since
Cisco VPN Solutions Center, Release 1.0
Gets the domain name of the provider-edge router.
Usage
string getDomainName(); raises(RepException, InvalidData);
Returns
string---Domain name of the provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
See Also
CiscoVsmFWCreator::VsmPECreator::setDomainName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the host name of the provider-edge router.
Usage
string getHostName(); raises(RepException, InvalidData);
Returns
string---Host name of the provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
See Also
CiscoVsmFWCreator::VsmPECreator::setHostName, getID, getDomainName, getNetworkName, VsmCE::getHostName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the device ID value. An ID value is assigned to each VsmPE object when it is saved in the VPN Inventory Repository.
Usage
unsigned long getID(); raises(RepException, InvalidData);
Returns
unsigned long---ID value of the provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
See Also
getID, getHostName, getDomainName, getNetworkName, VsmCE::getID
Since
Cisco VPN Solutions Center, Release 1.0
Gets the name of the network to which this provider-edge router belongs.
Usage
string getNetworkName(); raises(RepException, InvalidData);
Returns
string---Name of the network to which this provider-edge router belongs. string---Domain name of the provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.
See Also
CiscoVsmFWCreator::VsmPECreator::setNetworkName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VsmRegion object to which this provider-edge router belongs.
Usage
VsmRegion getRegion(); raises(RepException);
Returns
VsmRegion---Region object to which this provider-edge router belongs.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmRegion, CiscoVsmFWCreator::VsmPECreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets the list of router-interface objects for this provider-edge router.
Usage
VsmRouterInterfaceSeq getRouterInterfaceList(); raises(RepException);
Returns
VsmRouterInterfaceSeq---List of interface objects for this provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmFWCreator::VsmPECreator::setRouterInterfaces
Since
Cisco VPN Solutions Center, Release 1.0
Gets the list of passwords for this provider-edge router.
Usage
VsmPasswordSeq getRouterPasswordList(); raises(RepException);
Returns
VsmPasswordSeq---List of passwords for this provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmPassword, CiscoVsmFWCreator::VsmPECreator::setRouterPasswords
Since
Cisco VPN Solutions Center, Release 1.0
Gets all service requests (VsmSRVC objects) for this provider-edge router that match one of the VsmSRState values in the list of VsmSRState values supplied as an input parameter.
Usage
VsmSRVCSeq getSRVCs(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this provider-edge router.
Returns
VsmSRVCSeq---List of service requests (VsmSRVC objects) for this provider-edge router.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmSRVC, VsmSRVC::getPE , VsmSRVC::getPEConfiglet , VsmSRState, VsmSRStateSeq, VsmCE::getSRVCs, VsmCustomer::getSRVCs, VsmVRFDef::getSRVCs, VsmPRG::getSRVCs, VsmCoSProfile::getSRVCs
Since
Cisco VPN Solutions Center, Release 1.0
The VsmPRG object represents the Port Reservation Group. PRG is used to group a set of port reservation service request for a VPN.
See Also
VsmSRVC, CiscoVpnServiceModel::VpnInvMgr::newPRGCreator, CiscoVsmFWCreator::VsmPRGCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releasePRGCreator, CiscoVpnServiceModel::VpnInvMgr::releasePRG
Since
Cisco VPN Solutions Center, Release 1.0
Gets the description string about this PRG
Usage
string getDesc();
Returns
string type, which represents the policy description.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the unique PRG id
Usage
unsigned long getID();
Returns
unsigned long type, which represents the policy id value.
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the SRVCs for this PRG
Usage
VsmSRVCSeq getSRVCs(in VsmSRStateSeq requestStates)
raises(RepException);
Returns
VsmSRVCSeq type, which lists the SRVC objects.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VPN object this PRG belongs to
Usage
VsmVPN getVPN(); raises(RepException);
Returns
VsmVPN type, which represents the VPN object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmProviderAdminDomain interface represents the administrative domain of an ISP with one BGP autonomous system (AS) number. The network owned by the provider administrative domain is called, the backbone network. If an ISP has two AS numbers, for example, the ISP must be represented as two VsmProviderAdminDomain objects in the service model. Each VsmProviderAdminDomain object may manage one or more VsmRegion objects. Each VsmProviderAdminDomain object also maintains lists of RD and RT seeds and lists of free IP addresses (originally assigned from the region IP address pools) from which to get or generate obtain their respective values during the provisioning process.
See Also
CiscoVpnServiceModel::VpnInvMgr::newProviderAdminDomainCreator, CiscoVpnServiceModel::VpnInvMgr::releaseProviderAdminDomainCreator, CiscoVsmFWCreator::VsmProviderAdminDomainCreator, CiscoVsmFWCreator::VsmProviderAdminDomainCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseProviderAdminDomain
Since
Cisco VPN Solutions Center, Release 1.0
Gets a VsmRegion object based on its name string.
Usage
VsmRegion findRegionByName(in string name)
raises(RepException);
Parameters
name---in string that represents the region name.
Returns
VsmRegion---Specific VsmRegion object that is managed by this provider administrative domain and matches the specied name string.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getAllRegions, VsmPE::getRegion, CiscoVsmFWCreator::VsmRegionCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Free the given RD for this provider admin domain and puts it in the free RD list.
Usage
void freeRD(in VsmRDSeed rd)
raises(RepException);
Parameters
rd---in VsmRDSeed that represents the RD value to be freed.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmRDSeed, getNextRD, getAllFreeRDs, getAllRDSeeds, isRDOverlapped, freeRT
Since
Cisco VPN Solutions Center, Release 1.0
Frees the given route target (RT) for this provider admin domain and puts it in the free RT list.
Usage
void freeRT(in VsmRTSeed rt)
raises(RepException);
Parameters
rd---in VsmRTSeed that represents the RT value to be freed.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.
See Also
VsmRTSeed, getNextRT, getAllFreeRTs, getAllRTSeeds, isRTOverlapped, freeRD
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the free RDs in the free list for this provider admin domain.
Usage
VsmRDSeedSeq getAllFreeRDs(); raises(RepException);
Returns
VsmRDSeedSeq type, which lists all the free RDs for this provider admin domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmRDSeedSeq, getNextRD, freeRD, getAllRDSeeds, isRDOverlapped, getAllFreeRTs
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the free RTs in the free list for this provider admin domain.
Usage
VsmRTSeedSeq getAllFreeRTs(); raises(RepException);
Returns
VsmRTSeedSeq---Lists all the free RTs for this provider administrative domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmRTSeedSeq, getNextRT, freeRT, getAllRTSeeds, isRTOverlapped, getAllFreeRDs
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the RD seeds for this provider admin domain.
Usage
VsmRDSeedSeq getAllRDSeeds(); raises(RepException);
Returns
VsmRDSeedSeq---Lists all the RD seeds for this provider administrative domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmRDSeedSeq, getNextRD, freeRD, getAllFreeRDs, isRDOverlapped, getAllRTSeeds
Since
Cisco VPN Solutions Center, Release 1.0
Gets all VsmRegion objects managed by this VsmProviderAdminDomain object.
Usage
VsmRegionSeq getAllRegions(); raises(RepException);
Returns
VsmRegionSeq---List of all VsmRegion objects managed by this provider administrative domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
findRegionByName, VsmPE::getRegion, CiscoVsmFWCreator::VsmRegionCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the RT seeds for this provider admin domain.
Usage
VsmRTSeedSeq getAllRTSeeds(); raises(RepException);
Returns
VsmRTSeedSeq---Lists all the RT seeds for this provider administrative domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmRTSeedSeq, getNextRT, freeRT, getAllFreeRTs, isRTOverlapped, getAllRDSeeds
Since
Cisco VPN Solutions Center, Release 1.0
Gets the autonomous system (AS) number assigned to the provider.
Usage
unsigned long getASNumber();
Returns
unsigned long---AS number assigned to this provider administrative domain.
See Also
CiscoVsmFWCreator::VsmProviderAdminDomainCreator::setASNumber
Since
Cisco VPN Solutions Center, Release 1.0
Gets the contact information for this provider administrative domain.
Usage
string getContactInfo();
Returns
string---Contact information for this provider administrative domain.
See Also
CiscoVsmFWCreator::VsmProviderAdminDomainCreator::setContactInfo, VsmCustomer::getContactInfo
Since
Cisco VPN Solutions Center, Release 1.0
Gets a qualified list of the VsmCoSProfile objects that are defined for this provider administrative domain.
Usage
VsmCoSProfileSeq getCoSProfiles(in boolean defaultOnly)
raises(RepException);
Parameters
defaultOnly---in boolean that instructs this operation to return only the default CoS profiles when set to TRUE and to return all CoS profiles when set to FALSE.
Returns
VsmCoSProfileSeq---List of VsmCoSProfile objects that are defined for this provider administrative domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmCoSProfile, CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets the name of the provider administrative domain.
Usage
string getName();
Returns
string---Name of this provider administrative domain.
See Also
CiscoVsmFWCreator::VsmProviderAdminDomainCreator::setName, getName, VsmRegion::getName, VsmCustomer::getName, VsmCustomerSite::getName, VsmVPN::getName, VsmVRFDef::getName, VsmCoSProfile::getName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the next available route distringuisher (RD) from either the free RD list of the RD seed list for this provider administrative domain. RDs available from the free-RD list are used before RDs from the RD seed list,
Usage
VsmRDSeed getNextRD(); raises(RepException);
Returns
VsmRDSeed---Next available RD value.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmRDSeed, freeRD, getAllFreeRDs, getAllRDSeeds, isRDOverlapped, getNextRT
Since
Cisco VPN Solutions Center, Release 1.0
Gets the next available route target (RT) from either the free RT list of the RD seed list for this provider administrative domain. RTs available from the free-RT list are used before RTs from the RT seed list,
Usage
VsmRTSeed getNextRT(); raises(RepException);
Returns
VsmRDSeed---Next available RT value.
Raises
CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.
See Also
VsmRTSeed, freeRT, getAllFreeRTs, getAllRTSeeds, isRTOverlapped, getNextRD
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VPN routing/forwarding (VFR) table definitions (VRFDef objects) created for this provider administrative domain.
Usage
VsmVRFDefSeq getVRFDefs(); raises(RepException);
Returns
VsmVRFDefSeq---List of VsmVRFDef objects for this provider administrative domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmVRFDef
Since
Cisco VPN Solutions Center, Release 1.0
Checks if the given RD value is overlapped with the provider admin domain's RD seeds.
Usage
boolean isRDOverlapped(in VsmRDSeed rd)
raises(RepException);
Parameters
rd---in VsmRDSeed that represents the RD value to be checked.
Returns
boolean---TRUE when the given RD overlaps a provider RD seed.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNextRD, freeRD, getAllRDSeeds, getAllFreeRDs, isRTOverlapped
Since
Cisco VPN Solutions Center, Release 1.0
Checks if the given RT value is overlapped with the provider admin domain's RT seeds.
Usage
boolean isRTOverlapped(in VsmRTSeed rt)
raises(RepException);
Parameters
rt---in VsmRTSeed that represents the RT value to be checked.
Returns
boolean---TRUE when the given RT overlaps a provider RT seed.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNextRT, freeRT, getAllRTSeeds, getAllFreeRTs, isRDOverlapped
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmRegion interface represents a region of the provider administrative domain (VsmProviderAdminDomain object). A provider can partition its backbone network geographically into multiple regions. Each region is represented in the VPN Inventory Repository as a VsmRegion object, and each region has its own IP address allocation pools. Each region belongs to exactly one provider administrative domain and can manage many provider-edge (PE) routers (VsmPE objects).
See Also
CiscoVpnServiceModel::VpnInvMgr::newRegionCreator, CiscoVpnServiceModel::VpnInvMgr::releaseRegionCreator, CiscoVsmFWCreator::VsmRegionCreator, CiscoVsmFWCreator::VsmRegionCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseRegion, VsmPE::getRegion, VsmProviderAdminDomain::findRegionByName
Since
Cisco VPN Solutions Center, Release 1.0
Frees the specified /30 IP subnet address after verifying it is from an IP address pool that belongs to the region. If the IP address is from an IP address pool that belongs to the region, it is added to list of freed IP addresses for the region. If the specified IP address is not from a pool that belongs to the region, it is ignored.
Usage
void freeIPAddress30(in VsmIPAddress addr)
raises(RepException);
Parameters
addr---in VsmIPAddress that represents an IP address to be freed.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext30Address, getAllIPAddressPool30, getAllFreeIPAddress30, isAddressOverlappedWithPool30, freeIPAddress32
Frees the specified /32 IP subnet address after verifying it is from an IP address pool that belongs to the region. If the IP address is from an IP address pool that belongs to the region, it is added to list of freed IP addresses for the region. If the specified IP address is not from a pool that belongs to the region, it is ignored.
Usage
void freeIPAddress32(in VsmIPAddress addr)
raises(RepException);
Parameters
addr---in VsmIPAddress that represents an IP address to be freed.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext32Address, getAllIPAddressPool32, getAllFreeIPAddress32, isAddressOverlappedWithPool32, freeIPAddress30
Since
Cisco VPN Solutions Center, Release 1.0
Gets a list of all /30 IP addresses from the list of freed IP addresses for the region. Each address in the returned list is written as IP_address + time_since_freed. For example: 192.100.200.128/24 + 5/5/1999 01:22:30
Usage
VsmIPAddressSeq getAllFreeIPAddress30(); raises(RepException);
Returns
VsmIPAddressSeq---Lists the free /30 IP addresses for this region.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext30Address, freeIPAddress30, getAllIPAddressPool30, isAddressOverlappedWithPool30, getAllFreeIPAddress32
Since
Cisco VPN Solutions Center, Release 1.0
Gets a list of all /32 IP addresses from the list of freed IP addresses for the region. Each address in the returned list is written as IP_address + time_since_freed. For exmaple: 192.100.200.128/24 + 5/5/1999 01:22:30
Usage
VsmIPAddressSeq getAllFreeIPAddress32(); raises(RepException);
Returns
VsmIPAddressSeq---Lists the free /32 IP addresses for this region.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext32Address, freeIPAddress32, getAllIPAddressPool32, isAddressOverlappedWithPool32, getAllFreeIPAddress30
Since
Cisco VPN Solutions Center, Release 1.0
Gets a list of all IP address pools that are available for allocating /30 IP subnet addresses. Each pool in the returned list is written as last_allocated_address/mask. For example: 192.100.200.128/24 for the original pool 192.100.200.0/24.
Usage
VsmIPAddressPoolSeq getAllIPAddressPool30(); raises(RepException);
Returns
VsmIPAddressPoolSeq---Lists the IP address pools for this region.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext30Address, freeIPAddress30, getAllFreeIPAddress30, isAddressOverlappedWithPool30, getAllIPAddressPool32
Since
Cisco VPN Solutions Center, Release 1.0
Gets a list of all IP address pools that are available for allocating /32 IP subnet addresses. Each pool in the returned list is written as last_allocated_address/mask. For example: 192.100.200.128/24 for the original pool 192.100.200.0/24.
Usage
VsmIPAddressPoolSeq getAllIPAddressPool32(); raises(RepException);
Returns
VsmIPAddressPoolSeq---Lists the IP address pools for this region.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext32Address, freeIPAddress32, getAllFreeIPAddress32, isAddressOverlappedWithPool32, getAllIPAddressPool30
Since
Cisco VPN Solutions Center, Release 1.0
Gets all provider-edge routers (PEs) that belong to this region.
Usage
VsmPESeq getAllPEs(); raises(RepException);
Returns
VsmPESeq---List of all PEs in this region of the provider administrative domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmFWCreator::VsmPECreator::addToRep, VsmCustomerSite::getAllCEs
Since
Cisco VPN Solutions Center, Release 1.0
Gets the region name.
Usage
string getName();
Returns
string---Region name.
See Also
CiscoVsmFWCreator::VsmRegionCreator::setName, VsmProviderAdminDomain::getName, VsmCustomer::getName, VsmCustomerSite::getName, VsmVPN::getName, VsmVRFDef::getName, VsmCoSProfile::getName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the next available /30 subnet address from either the list of freed IP addresses or the IP address pools that belong to this region. Those IP addresses from the list of freed IP addresses that have been available for more than 24 hours are issued first.
Usage
VsmIPAddress getNext30Address(); raises(RepException);
Returns
VsmIPAddress---The next available /30 subnet address.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
freeIPAddress30, getAllIPAddressPool30, getAllFreeIPAddress30, isAddressOverlappedWithPool30, getNext32Address
Since
Cisco VPN Solutions Center, Release 1.0
Gets the next available /32 subnet address from either the list of freed IP addresses or the IP address pools that belong to this region. Those IP addresses from the list of freed IP addresses that have been available for more than 24 hours are issued first.
Usage
VsmIPAddress getNext32Address(); raises(RepException);
Returns
VsmIPAddress---The next available /32 subnet address.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
freeIPAddress32, getAllIPAddressPool32, getAllFreeIPAddress32, isAddressOverlappedWithPool32, getNext30Address
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VsmProviderAdminDomain object to which this region belongs.
Usage
VsmProviderAdminDomain getProviderAdminDomain(); raises(RepException);
Returns
VsmProviderAdminDomain---Object that represents the provider administrator domain to which this region belongs.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmFWCreator::VsmRegionCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Checks to see if the specified IP address overlaps with a /30 IP address pools that belongs to the region.
Usage
boolean isAddressOverlappedWithPool30(in VsmIPAddress addr)
raises(RepException);
Parameters
addr---in VsmIPAddress that represents the /30 IP address to be checked.
Returns
boolean type---TRUE when the specified address overlaps a subnet from a /30 IP address pool that belongs to the region.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext30Address, freeIPAddress30, getAllIPAddressPool30, getAllFreeIPAddress30, isAddressOverlappedWithPool32
Since
Cisco VPN Solutions Center, Release 1.0
Checks to see if the specified IP address overlaps with a /32 IP address pools that belongs to the region.
Usage
boolean isAddressOverlappedWithPool32(in VsmIPAddress addr)
raises(RepException);
Parameters
addr---in VsmIPAddress) that represents the /32 IP address to be checked.
Returns
boolean type---TRUE when the specified address overlaps a subnet from a /32 IP address pool that belongs to the region.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
getNext32Address, freeIPAddress32, getAllIPAddressPool32, getAllFreeIPAddress32, isAddressOverlappedWithPool30
Since
Cisco VPN Solutions Center, Release 1.0
This object represents a service request that configures VPN connectivity for a PE-CE link.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseSRVC
Since
Cisco VPN Solutions Center, Release 1.0
Gets the CE object configured by this SRVC.
Usage
VsmCE getCE(); raises(RepException);
Returns
VsmCE type, which represents the CE object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCE
Since
Cisco VPN Solutions Center, Release 1.0
Gets the IP address of the CE interface that is configured by this service request.
Usage
VsmIPAddress getCEAddress();
Returns
VsmIPAddress type, which represents the CE address.
Since
Cisco VPN Solutions Center, Release 1.0
Gets CE advertised routes
Usage
advertisedRouteSeq getCEAdvertisedRoutes();
Returns
advertisedRouteSeq type, which represents CE advertised routes
Since
Cisco VPN Solutions Center, Release 1.0
Gets CE BGP autonomous number.
Usage
unsigned long getCEAutonomousSystem();
Returns
unsigned long type, which represents the CE autonomus number
Since
Cisco VPN Solutions Center, Release 1.0
Gets CE circuit identifier
Usage
CircuitIdentifier getCeCircuitId();
Returns
CircuitIdentifier type, which represents the CE circuit id.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the CE configlet for this service request
Usage
VsmConfiglet getCEConfiglet(); raises(RepException);
Returns
VsmConfiglet type, which lists the configlet object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the interface name of the CE interface that is configured by this service request
Usage
string getCEInterface();
Returns
string type, which represents the CE interface name.
Since
Cisco VPN Solutions Center, Release 1.0
Gets CE interface encapsulation
Usage
VsmInterfaceEncapsulation getCeInterfaceEncapsulation();
Returns
VsmInterfaceEncapsulation type, which represents the CE interface encapsulation
Gets CE interface template
Usage
string getCEInterfaceTemplate();
Returns
string type, which represents the CE interface template
Since
Cisco VPN Solutions Center, Release 1.0
Gets CE interface type
Usage
VsmInterfaceType getCeInterfaceType();
Returns
VsmInterfaceType type, which represents the CE interface type
Since
Cisco VPN Solutions Center, Release 1.0
Get CE loopback IP address
Usage
string getCELoopbackInterfaceAddress();
Get CE loopback interface number.
Usage
short getCELoopbackInterfaceNumber();
Gets CE redistributed protocols
Usage
redistributedProtocolSeq getCERedistributedProtocols();
Returns
redistributedProtocolSeq type, which represents CE redistributed protocols
Since
Cisco VPN Solutions Center, Release 1.0
Gets CE template
Usage
string getCeTemplate();
Returns
string type, which represents the CE template
Since
Cisco VPN Solutions Center, Release 1.0
Gets the CoS Profile this SRVC uses.
Usage
VsmCoSProfile getCoSProfile(); raises(RepException);
Returns
VsmCoSProfile type, which represents the CoS Profile object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCoSProfile
Since
Cisco VPN Solutions Center, Release 1.0
Gets the service creation time of the service.
Usage
string getCreateTime();
Returns
string type, which represents the service request creation time.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the type of creator who created this service request. For example: Observed, Provisioned, etc.
Usage
string getCreatorType();
Returns
string type, which represents the creator type.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the customer who requested this service.
Usage
VsmCustomer getCustomer(); raises(RepException);
Returns
VsmCustomer type, which represents the customer object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Get export map name.
Usage
string getExportMapName();
Gets the service request id for this SRVC service request. The service request id is unique across the whole system.
Usage
unsigned long getID();
Returns
unsigned long type, which represents the ID value.
Since
Cisco VPN Solutions Center, Release 1.0
Get import map name.
Usage
string getImportMapName();
Gets the IP address of the PE interface that is configured by this service request.
Usage
VsmInterfIPUnnumberType getIPUnnumbered();
Returns
VsmInterfIPUnnumberType---Enumerated type that indicates how the PE and CE interfaces are numbered.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the time at which this service was changed
Usage
string getLastStateChngTime();
Returns
string type, which represents the service request last state change time.
Since
Cisco VPN Solutions Center, Release 1.0
Get allow AS in
Usage
short getMaxASOccurrenceInPath();
Get maximum number of routes.
Usage
long getMaxRoutes();
Gets the PE object configured by this SRVC.
Usage
VsmPE getPE(); raises(RepException);
Returns
VsmPE type, which represents the PE object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPE
Since
Cisco VPN Solutions Center, Release 1.0
Gets the IP address of the PE interface that is configured by this service request.
Usage
VsmIPAddress getPEAddress();
Returns
VsmIPAddress type, which represents the PE address.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the routing protocol between the PE-CE link.
Usage
VsmPECELinkProtocolType getPECELinkProtocol();
Returns
VsmPECELinkProtocolType type, which represents the routing protocol.
Since
Cisco VPN Solutions Center, Release 1.0
Gets PE circuit identifier
Usage
CircuitIdentifier getPeCircuitId();
Returns
CircuitIdentifier type, which represents the PE circuit id.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the PE configlet for this service request
Usage
VsmConfiglet getPEConfiglet(); raises(RepException);
Returns
VsmConfiglet type, which lists the configlet object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the PE interface name.
Usage
string getPEInterface();
Returns
string type, which represents the PE interface name.
Since
Cisco VPN Solutions Center, Release 1.0
Gets PE interface encapsulation
Usage
VsmInterfaceEncapsulation getPeInterfaceEncapsulation();
Returns
VsmInterfaceEncapsulation type, which represents the PE interface encapsulation
Gets PE interface template
Usage
string getPEInterfaceTemplate();
Returns
string type, which represents the PE interface template
Since
Cisco VPN Solutions Center, Release 1.0
Gets PE interface type
Usage
VsmInterfaceType getPeInterfaceType();
Returns
VsmInterfaceType type, which represents the PE interface type
Since
Cisco VPN Solutions Center, Release 1.0
Gets PE template
Usage
string getPeTemplate();
Returns
string type, which represents the PE template
Since
Cisco VPN Solutions Center, Release 1.0
Gets the PRG this SRRG belongs to
Usage
VsmPRG getPRG(); raises(RepException);
Returns
VsmPRG type, which represents the PRG object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPRG
Since
Cisco VPN Solutions Center, Release 1.0
Gets routes to all sites that are reachable from the CE.
Usage
routesToAllSitesSeq getRoutesToAllSites();
Returns
routesToAllSitesSeq type, which represents routes to all sites.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the service BLOB for this service request.
Usage
string getSrvcDefText(); raises(RepException);
Returns
string type, which represents the service definition blob.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the state of this service request.
Usage
VsmSRState getState();
Returns
VsmSRState type, which represents the service request state value.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the state description for this service request.
Usage
string getStateDesc();
Returns
string type, which represents the state description.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the service request that is subsumed by this service request.
Usage
VsmSRVC getSubsumedSRVC(); raises(RepException);
Returns
VsmSRVC---Represents the subsumed VsmSRVC object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the service type for this service request.
Usage
VsmSRType getType();
Returns
VsmSRType type, which represents the service request type value.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the user name who created this service request
Usage
string getUser();
Returns
string type, which represents the user name.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VRF definition with which the PE interface configured by this service request is associated.
Usage
VsmVRFDef getVRFDef(); raises(RepException);
Returns
VsmVRFDef type, which represents the VRF object.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCoSProfile
Since
Cisco VPN Solutions Center, Release 1.0
Get AS override
Usage
boolean isASOverride();
Usage
boolean isCELoopbackInterfaceRequired();
Returns TRUE if CE router will be added to grey management VPN.
Usage
boolean isMemberGreyManagementVPN();
Returns
boolean---TRUE indicates CE router will be added to grey management VPN; FALSE indicates CE router will not be added to grey management VPN.
Get netflow accounting
Usage
boolean isNetflowAccountingOn();
Returns TRUE if only the default route is sent to the CE.
Usage
boolean isOnlyDefRouteSentToCE();
Returns
TRUE or FALSE.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setOnlyDefaultRouteSentToCE
Since
Cisco VPN Solutions Center, Release 1.0
Returns TRUE if the PE interface is to be shutdown down after provisioning.
Usage
boolean isPEInterfaceShutdown();
Returns
TRUE or FALSE.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterfaceShutdown
Since
Cisco VPN Solutions Center, Release 1.0
Returns TRUE if this service request is for a port reservation only.
Usage
boolean isPEPortReservationOnly();
Returns
boolean---TRUE indicates the service request is for a port reservation only; FALSE indicates the service request is to add VPN service to a CE.
See Also
CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEPortReservationOnly
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmVPN interface represents a virtual private network (VPN) that is implemented by a one or more provider administrative domains (VsmProviderAdminDomain object). A VPN can span multiple provider administrative domains, but it must have a default provider administrative domain to manage the allocation of route-distinguishers (RDs) and route-targets (RTs). Each VPN consists of a set of provisioning templates and policies. CE routing communities (CERCs) in a VPN simpify complex topology into multiple subgroups.
Description
Eric Rosen and Yakov Rekhter, in the IETF draft of RFC 2547, describe a virtual private network using the following characterization:
Consider a set of sites that are attached to a common network, which we may call the backbone. Apply a policy to create a number of subsets of the set of sites and impose the following rule: two sites may have IP interconnectivity over the backbone only if at least one of the subsets contains both sites. Such a subset is a virtual private network (VPN).
See Also
CiscoVpnServiceModel::VpnInvMgr::newVPNCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVPNCreator, CiscoVsmFWCreator::VsmVpnCreator, CiscoVsmFWCreator::VsmVpnCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseVPN
Since
Cisco VPN Solutions Center, Release 1.0
Gets all CE routing communities (CERCs) that belong to this VPN.
Usage
VsmCERCSeq getAllCERCs(); raises(RepException);
Returns
VsmCERCSeq---List of VsmCERC objects that belong to this VPN.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmCERC, CiscoVsmFWCreator::VsmCERCCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets all customer-edge routers (CEs) that are related to this VPN through provisioning-service requests.
Usage
VsmCESeq getAllCEs(); raises(RepException);
Returns
VsmPESeq---List of VsmCE objects that are used by this VPN.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmCE, CiscoVsmFWCreator::VsmCECreator::addToRep, VsmCustomerSite::getAllCEs
Since
Cisco VPN Solutions Center, Release 1.0
Gets all provider-edge routers (PEs) that are related to this VPN through provisioning-service requests.
Usage
VsmPESeq getAllPEs(); raises(RepException);
Returns
VsmPESeq---List of VsmPE objects that are used by this VPN.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmPE, CiscoVsmFWCreator::VsmPECreator::addToRep, VsmRegion::getAllPEs
Since
Cisco VPN Solutions Center, Release 1.0
Gets all port-reservation groups (PRGs) that belong to this VPN.
Usage
VsmPRGSeq getAllPRGs(); raises(RepException);
Returns
VsmCERCSeq---List of VsmPRG objects that belong to this VPN.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmPRG, CiscoVsmFWCreator::VsmPRGCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets all configlets (VsmConfiglet objects) that are related to this VPN through provisioning-service requests that match one of the service-request states supplied through the requestStates input argument.
Usage
VsmConfigletSeq getConfiglets(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmConfiglet objects that are related to this VPN.
Returns
VsmConfigletSeq---List of VsmConfiglet objects whose service-request matches one of the service-request states supplied through the requestStates input argument.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmConfiglet, VsmConfiglet::getSRVCs, VsmCE::getConfiglets, VsmPE::getConfigletList
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VPN name.
Usage
string getName();
Returns
string---VPN name.
See Also
CiscoVsmFWCreator::VsmVpnCreator::setName, VsmProviderAdminDomain::getName, VsmRegion::getName, VsmCustomer::getName, VsmCustomerSite::getName, VsmVRFDef::getName, VsmCoSProfile::getName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the default VsmProviderAdminDomain for this VPN. Based on the information for the default provider administrative domain, you can create service objects for the VPN, such as allocating route-distinguisher (RD) and route-target (RT) seeds, and so on.
Usage
VsmProviderAdminDomain getProviderAdminDomain(); raises(RepException);
Returns
VsmProviderAdminDomain type, which represents the provider admin domain.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmProviderAdminDomain, CiscoVsmFWCreator::VsmProviderAdminDomainCreator::addToRep
Since
Cisco VPN Solutions Center, Release 1.0
Gets all service requests (VsmSRVC objects) that are related to this VPN and that the service requests are in one of the states specified in requestStates.
Usage
VsmSRVCSeq getSRVCs(in VsmSRStateSeq requestStates)
raises(RepException);
Parameters
requestStates---in VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this provider-edge router.
Returns
VsmSRVCSeq---List of VsmSRVC objects that belongs to this VPN.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
See Also
VsmSRVC
Since
Cisco VPN Solutions Center, Release 1.0
An instance of the VsmVRFDef interface represents the configuration information for a VPN routing/forwarding (VRF) table for PEs that share a common route-distinguisher (RD). A VRF is an IOS route table that defines the connection of a set of sites with a VPN service. In the VPN Inventory Repository, a VRF definition is a template that helps define a VRF table in a provider-edge router (PE). A VsmVRFDef object is created automatically when a request to add VPN service to a CE is created. Each VRF definition belongs to one provider administrative domain and has a specific set of CE routing community (CERC) memberships. All VsmSRVC objects with the same VPN connectivity become part of a common VRF definition.
See Also
CiscoVpnServiceModel::VpnInvMgr::newVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVPNConnectivityCreator, CiscoVsmSRCreator::VsmVPNConnectivityCreator, CiscoVpnServiceModel::VpnInvMgr::releaseVRFDef, VsmProviderAdminDomain, VsmCERCMembership
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the CERC Memberships which associate with this VRFDef
Usage
VsmCERCMembershipSeq getAllCERCMemberships(); raises(RepException);
Returns
VsmCERCMembershipSeq type, which lists the CERC memberships.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the ID of the VRF definition.
Usage
unsigned long getID();
Returns
unsigned long---Represents the unique identifier for the VsmVRFDef object.
Since
Cisco VPN Solutions Center, Release 1.0
Gets the VRF name.
Usage
string getName();
Returns
string---Represents the name assigned to the VsmVRFDef object.
See Also
CiscoVsmFWCreator::VsmVRFDefCreator::setName, VsmProviderAdminDomain::getName, VsmRegion::getName, VsmCustomer::getName, VsmCustomerSite::getName, VsmVPN::getName, VsmCoSProfile::getName
Since
Cisco VPN Solutions Center, Release 1.0
Gets the default route distinguisher configured for this VRF
Usage
string getRD();
Returns
string type, which represents the default RD.
Since
Cisco VPN Solutions Center, Release 1.0
Gets all the SRVCs which associate with this VRFDef
Usage
VsmSRVCSeq getSRVCs(in VsmSRStateSeq requestStates)
raises(RepException);
Returns
VsmSRVCSeq type, which lists the SRVC objects.
Raises
CiscoVsmExceptions::RepException if a VPN InventoryRepository error occurs.
Since
Cisco VPN Solutions Center, Release 1.0
Posted: Wed May 17 17:47:04 PDT 2000
Copyright 1989 - 2000©Cisco Systems Inc.