cc/td/doc/product/rtrmgmt/vpnsc/mpls/1_2
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

CiscoVsmBrowser.idl

CiscoVsmBrowser.idl

Interface List

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

Module CiscoVsmBrowser

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

Data Structures and Types

advertisedRouteSeq User Defined Type

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

CircuitIdentifier Structure

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

redistributedProtocolSeq User Defined Type

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

routesToAllSitesSeq User Defined Type

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

VsmCERCMembershipSeq User Defined Type

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

VsmCERCSeq User Defined Type

Sequence of VsmCERC objects.

Usage

typedef sequence<VsmCERC> VsmCERCSeq

See Also

VsmCERC, VsmVPN::getAllCERCs

Since

Cisco VPN Solutions Center, Release 1.0

VsmCESeq User Defined Type

Sequence of VsmCE objects.

Usage

typedef sequence<VsmCE> VsmCESeq

See Also

VsmCE, VsmCustomerSite::getAllCEs, VsmVPN::getAllCEs

Since

Cisco VPN Solutions Center, Release 1.0

VsmCEType Enumerated Type

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

VsmConfigletSeq User Defined Type

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

VsmCoSClass Structure

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

classNamestring that represents the the name of this CoS class. The string must has a length no longer than 64 characters.

cosPrecedenceshort that represents the precedence number of this CoS Class. ?? Is this the same a the CoS precedence bits? ??

exceedActionVsmInboundRateExceedAction 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.

cePeRateunsigned long that represents the rate limit from CE to PE.

peCeRateunsigned long that represents the rate limit from PE to CE.

flagunsigned long that is reserved for future use.

See Also

VsmCoSClassSeq, VsmInboundRateExceedAction

Since

Cisco VPN Solutions Center, Release 1.0

VsmCoSClassSeq User Defined Type

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

VsmCoSProfileConfig Enumerated Type

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

VsmCoSProfileConfigSeq User Defined Type

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

VsmCoSProfileSeq User Defined Type

Sequence of VsmCoSProfile objects.

Usage

typedef sequence<VsmCoSProfile> VsmCoSProfileSeq

See Also

VsmCoSProfile, VsmProviderAdminDomain::getCoSProfiles

Since

Cisco VPN Solutions Center, Release 1.0

VsmCustomerSeq User Defined Type

Sequence of VsmCustomer objects.

Usage

typedef sequence<VsmCustomer> VsmCustomerSeq

See Also

VsmCustomer, CiscoVpnServiceModel::VpnInvMgr::getAllCustomers

Since

Cisco VPN Solutions Center, Release 1.0

VsmCustomerSiteSeq User Defined Type

Sequence of VsmCustomerSite objects.

Usage

typedef sequence<VsmCustomerSite> VsmCustomerSiteSeq

See Also

VsmCustomerSite, VsmCustomer::getAllCustomerSites

Since

Cisco VPN Solutions Center, Release 1.0

VsmInboundRateExceedAction Enumerated Type

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

VsmInterfaceEncapsulation Enumerated Type

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
};

VsmInterfaceRole Enumerated Type

Represents a router interface role.

Usage

enum VsmInterfaceRole
{
    Primary, Secondary
};

Enumerators

Primary—The interface is a primary interface Secondary—The interface is a secondary interface

See Also

VsmRouterInterface

Since

Cisco VPN Solutions Center, Release 1.2

VsmInterfaceType Enumerated Type

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, POS_FrameRelay_IETF, Serial_FrameRelay_IETF, HSSI_FrameRelay_IETF, Cable
};

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.

ATMAsynchronous 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.

Cable—Cable modem 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

VsmInterfIPUnnumberType Enumerated Type

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

VsmIPAddress User Defined Type

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

VsmIPAddressPool User Defined Type

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

VsmIPAddressPoolSeq User Defined Type

Sequence of VsmIPAddressPool types.

Usage

typedef sequence<VsmIPAddressPool> VsmIPAddressPoolSeq

See Also

VsmIPAddressPool, VsmRegion::getAllIPAddressPool30, VsmRegion::getAllIPAddressPool32

Since

Cisco VPN Solutions Center, Release 1.0

VsmIPAddressSeq User Defined Type

Sequence of VsmIPAddress types.

Usage

typedef sequence<VsmIPAddress> VsmIPAddressSeq

See Also

VsmIPAddress, VsmRegion::getAllFreeIPAddress30, VsmRegion::getAllFreeIPAddress32

Since

Cisco VPN Solutions Center, Release 1.0

VsmPassword Structure

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

loginUIDstring that represents the router login login-user ID.

enableUIDstring that represents the router enable user id.

loginPWstring that represents the router login password.

enablePWstring that represents the router enable password.

snmpRoCommstring that represents the SNMP read-only community attribute.

snmpRwCommstring that represents the SNMP read-write community attribute.

levelshort 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

VsmPasswordSeq User Defined Type

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

VsmPECELinkProtocolType Enumerated Type

Represents if either end of the PE-CE link is IP unnumbered.

Usage

enum VsmPECELinkProtocolType
{
    UnknownRoutingType, StaticRoutingType, RIPv2RoutingType, BGPRoutingType, OSPFRoutingType, NoRoutingRequiredType
};

Enumerators

UnknownRoutingType—Unkown routing protocol.

StaticRoutingType—Static routing protocol.

RIPv2RoutingType—RIPv2 routing protocol.

BGPRoutingType—BGP routing protocol.

OSPFRoutingType—OSPF routing protocol.

NoRoutingRequiredType—No routing is required.

See Also

VsmSRVC::getPECELinkProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEAutonomousSystem, CiscoVsmSRCreator::VsmVPNServiceModifier::modifyPECERoutingProtocol

Since

Cisco VPN Solutions Center, Release 1.0

VsmPESeq User Defined Type

Sequence of VsmPE objects.

Usage

typedef sequence<VsmPE> VsmPESeq

See Also

VsmPE, VsmRegion::getAllPEs, VsmVPN::getAllPEs

Since

Cisco VPN Solutions Center, Release 1.0

VsmPRGSeq User Defined Type

Sequence of VsmPRG objects.

Usage

typedef sequence<VsmPRG> VsmPRGSeq

See Also

VsmPRG, VsmVPN::getAllPRGs

Since

Cisco VPN Solutions Center, Release 1.0

VsmProviderAdminDomainSeq User Defined Type

Sequence of VsmProviderAdminDomain objects.

Usage

typedef sequence<VsmProviderAdminDomain> VsmProviderAdminDomainSeq

See Also

VsmProviderAdminDomain, CiscoVpnServiceModel::VpnInvMgr::getAllProviders

Since

Cisco VPN Solutions Center, Release 1.0

VsmRDSeed User Defined Type

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

VsmRDSeedSeq User Defined Type

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

VsmRegionSeq User Defined Type

Sequence of VsmRegion objects.

Usage

typedef sequence<VsmRegion> VsmRegionSeq

See Also

VsmRegion, VsmProviderAdminDomain::getAllRegions

Since

Cisco VPN Solutions Center, Release 1.0

VsmRouterInterface Structure

Stores router interface information.

Usage

struct VsmRouterInterface
{
    string interfName; string interfAddr; VsmInterfaceRole interfRole;
};

Members

interfNamestring that represents the interface name—Serial0/1, for example.

interfAddrstring that represents the interface address—192.100.200.201, for example.

interfRoleVsmInterfaceRole that represents the interface role, either a primary interface or secondary interface.

See Also

CiscoVpnServiceModel::VpnInvMgr::addRouterInterfaceToPE, CiscoVpnServiceModel::VpnInvMgr::removeRouterInterfaceFromPE, CiscoVpnServiceModel::VpnInvMgr::addRouterInterfaceToCE, CiscoVpnServiceModel::VpnInvMgr::removeRouterInterfaceFromCE

Since

Cisco VPN Solutions Center, Release 1.0

VsmRouterInterfaceSeq User Defined Type

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

VsmRTSeed User Defined Type

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

VsmRTSeedSeq User Defined Type

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

VsmSRState Enumerated Type

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

VsmSRStateSeq User Defined Type

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

VsmSRType Enumerated Type

Represents a service-request type.

Usage

enum VsmSRType
{
    SRTypeAdd, SRTypeDelete
};

Enumerators

SRTypeAdd—Add VPN connectivity for a PE-CE pair to the VPN service model.

SRTypeDelete—Delete VPN connectivity for a PE-CE pair from the VPN service model.

See Also

VsmSRState, VsmSRVC::getType

Since

Cisco VPN Solutions Center, Release 1.0

VsmSRVCSeq User Defined Type

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

VsmVPNSeq User Defined Type

Sequence of VsmVPN objects.

Usage

typedef sequence<VsmVPN> VsmVPNSeq

See Also

VsmVPN, CiscoVpnServiceModel::VpnInvMgr::getAllVPNs

Since

Cisco VPN Solutions Center, Release 1.0

VsmVRFDefSeq User Defined Type

Sequence of VsmVRFDef objects.

Usage

typedef sequence<VsmVRFDef> VsmVRFDefSeq

See Also

VsmVRFDef, VsmProviderAdminDomain::getVRFDefs, VsmCERC::getAllVRFDefs

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmCE

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

Operations

getCEType()

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 Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCECreator::setCEType

Since

Cisco VPN Solutions Center, Release 1.0

getConfiglets()

Gets the configlets (VsmConfiglet objects) for this customer-edge router.

Usage

VsmConfigletSeq getConfiglets(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin 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 Inventory Repository error occurs.

See Also

VsmConfiglet, VsmConfiglet::getCE, VsmConfiglet::getSRVCs, VsmPE::getConfigletList, VsmVPN::getConfiglets

Since

Cisco VPN Solutions Center, Release 1.0

getCustomerSite()

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 Inventory Repository error occurs.

See Also

VsmCustomerSite, CiscoVsmFWCreator::VsmCECreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getDomainName()

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

getHostName()

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

getID()

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 Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.

Since

Cisco VPN Solutions Center, Release 1.0

getNetworkName()

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

getRouterInterfaceList()

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 Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCECreator::setRouterInterfaces

Since

Cisco VPN Solutions Center, Release 1.0

getRouterPasswordList()

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 Inventory Repository error occurs.

See Also

VsmPassword, CiscoVsmFWCreator::VsmCECreator::setRouterPasswords

Since

Cisco VPN Solutions Center, Release 1.0

getSRVCs()

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 srStates)
raises(
    RepException);

Parameters

srStatesin 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 Inventory Repository 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

getTelnetRetries()

Gets the number of times to attempt a telnet connection for this VsmPE object.

Usage

unsigned short getTelnetRetries();
raises(
    RepException);

Returns

short—The number of times to attempt a telnet connection for this VsmPE object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPECreator::setTelnetRetries, CiscoVsmFWModifier::VsmPEModifier::setTelnetRetries, getTelnetTimeOut

Since

Cisco VPN Solutions Center, Release 1.2

getTelnetTimeOut()

Gets the telnet timeout value for this VsmPE object.

Usage

unsigned long getTelnetTimeOut();
raises(
    RepException);

Returns

long—The telnet timeout value (seconds) for this VsmPE object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPECreator::setTelnetTimeOut, CiscoVsmFWModifier::VsmPEModifier::setTelnetTimeOut, getTelnetRetries

Since

Cisco VPN Solutions Center, Release 1.2

Interface VsmCERC

An instance of the VsmCERC interface defines the relationship between VsmCE objects. VsmCE object can form either a full-mesh or hub-and-spoke CE routing community (CERC).

See Also

CiscoVpnServiceModel::VpnInvMgr::newCERCCreator, CiscoVsmFWCreator::VsmCERCCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseCERC, CiscoVpnServiceModel::VpnInvMgr::releaseCERCCreator, CiscoVpnServiceModel::VpnInvMgr::newCERCModifier, CiscoVsmFWModifier::VsmCERCModifier::updateRep, CiscoVpnServiceModel::VpnInvMgr::releaseCERC, CiscoVpnServiceModel::VpnInvMgr::releaseCERCModifier

Since

Cisco VPN Solutions Center, Release 1.0

Operations

getAllVRFDefs()

Gets all VsmVRFDef objects that join this VsmCERC object.

Usage

VsmVRFDefSeq getAllVRFDefs();
raises(
    RepException);

Returns

VsmVRFDefSeq—List of all VsmVRFDef objects that join this VsmCERC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setVRFNameAndRD

Since

Cisco VPN Solutions Center, Release 1.0

getDesc()

Gets the descriptive text for this VsmCERC object.

Usage

string getDesc();

Returns

string—Descriptive text for this VsmCERC object.

See Also

CiscoVsmFWCreator::VsmCERCCreator::setDesc, CiscoVsmFWModifier::VsmCERCModifier::setDesc

Since

Cisco VPN Solutions Center, Release 1.0

getHubRT()

Gets the hub route-target (RT) value, assuming a hub-and-spoke configuration is used, for this VsmCERC object.

Usage

string getHubRT();

Returns

string—Represents hub RT value, assuming a hub-and-spoke configuration is used, for this VsmCERC object. RT values are expressed as rtSeed:offset.

Description

In addition, a convenience operation is supplied by the VsmCERCMembership interface to conveniently access this value.

See Also

CiscoVsmFWCreator::VsmCERCCreator::setHubRT, VsmCERCMembership::getCERCHubRT

Since

Cisco VPN Solutions Center, Release 1.0

getID()

Gets the unique identifier for this VsmCERC object.

Usage

unsigned long getID();

Returns

unsigned long—Unique identifier for this VsmCERC object.

See Also

CiscoVsmFWCreator::VsmCERCCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getSpokeRT()

Gets the spoke route-target (RT) value, assuming a spoke-and-spoke configuration is used, for this VsmCERC object.

Usage

string getSpokeRT();

Returns

string—Represents spoke RT value, assuming a spoke-and-spoke configuration is used, for this VsmCERC object. RT values are expressed as rtSeed:offset.

Description

In addition, a convenience operation is supplied by the VsmCERCMembership interface to conveniently access this value.

See Also

CiscoVsmFWCreator::VsmCERCCreator::setSpokeRT, VsmCERCMembership::getCERCSpokeRT

Since

Cisco VPN Solutions Center, Release 1.0

getVPN()

Gets the VsmVPN object to which this VsmCERC object belongs.

Usage

VsmVPN getVPN();
raises(
    RepException);

Returns

VsmVPN—The VsmVPN object to which this VsmCERC object belongs.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCERCCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmCERCMembership

An instance of the VsmCERCMembership interface defines the relationship between a VsmVRFDef object and a VsmCERC object. It dictates with which CERC a VRF definition is joining and whether the CE end of the PE-CE link 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

Operations

getCERC()

Gets the VsmCERC object associated with this VsmCERCMembership object.

Usage

VsmCERC getCERC();

Returns

VsmCERC—The VsmCERC object associated with this VsmCERCMembership object.

Description

This state is set upon creating the VsmCERCMembership object using the cerc parameter of the CiscoVpnServiceModel::VpnInvMgr::newCERCMembership() operation.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCERCMembership

Since

Cisco VPN Solutions Center, Release 1.0

getCERCHubRT()

Gets the hub route-target (RT) value, assuming a hub-and-spoke configuration is used, of the VsmCERC object associated with this VsmCERCMembership object.

Usage

string getCERCHubRT();

Returns

string—Represents hub RT value, assuming a hub-and-spoke configuration is used, of the VsmCERC object associated with this VsmCERCMembership object. RT values are expressed as rtSeed:offset.

Description

This is a convenience operatation. The equivalent longhand version is VsmCERCMembership.getCERC().getHubRT() using pseudocode notation.

See Also

CiscoVsmFWCreator::VsmCERCCreator::setHubRT, VsmCERC::getHubRT

Since

Cisco VPN Solutions Center, Release 1.0

getCERCID()

Gets the unique identifier of the VsmCERC object associated with this VsmCERCMembership object.

Usage

unsigned long getCERCID();

Returns

unsigned long—Represents unique identifier of the the VsmCERC object associated with this VsmCERCMembership object.

Description

This is a convenience operatation. The equivalent longhand version is VsmCERCMembership.getCERC().getID() using pseudocode notation.

See Also

CiscoVsmFWCreator::VsmCERCCreator::addToRep, VsmCERC::getID

Since

Cisco VPN Solutions Center, Release 1.0

getCERCSpokeRT()

Gets the spoke route-target (RT) value, assuming a hub-and-spoke configuration is used, of the VsmCERC object associated with this VsmCERCMembership object.

Usage

string getCERCSpokeRT();

Returns

string—Represents spoke RT value, assuming a hub-and-spoke configuration is used, of the VsmCERC object associated with this VsmCERCMembership object. RT values are expressed as rtSeed:offset.

Description

This is a convenience operatation. The equivalent longhand version is VsmCERCMembership.getCERC().getSpokeRT() using pseudocode notation.

See Also

CiscoVsmFWCreator::VsmCERCCreator::setSpokeRT, VsmCERC::getSpokeRT

Since

Cisco VPN Solutions Center, Release 1.0

getCERCVPNName()

Gets the name of VsmVPN object to which the VsmCERC object, associated with this VsmCERCMembership object, belongs.

Usage

string getCERCVPNName();

Returns

string—Represents the name of the VsmVPN object to which the VsmCERC object, associated with this VsmCERCMembership object, belongs.

Description

This is a convenience operatation. The equivalent longhand version is VsmCERCMembership.getCERC().getVPN().getName() using pseudocode notation.

See Also

CiscoVsmFWCreator::VsmCERCCreator::addToRep, VsmVPN::getName

Since

Cisco VPN Solutions Center, Release 1.0

isHubRTUsed()

Returns TRUE if this VsmCERCMembership object requires a VsmVRFDef object that allows a VsmCustomerSite object to join a VsmCERC object as a hub site.

Usage

boolean isHubRTUsed();

Returns

booleanTRUE if this VsmCERCMembership object requires a VsmVRFDef object that allows a VsmCustomerSite object to join a VsmCERC object as a hub site; FALSE if joining the VsmCERC object in a full-mesh configuration.

Description

This state is set upon creating the VsmCERCMembership object using the useHubRTState parameter of the CiscoVpnServiceModel::VpnInvMgr::newCERCMembership() operation.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCERCMembership

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmConfiglet

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

Operations

getCE()

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 Inventory Repository 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

getConfigletText()

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 Inventory Repository error occurs.

Since

Cisco VPN Solutions Center, Release 1.0

getID()

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

getPE()

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 Inventory Repository 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

getSRVCs()

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 Inventory Repository error occurs.

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmCoSProfile

An instance of the VsmCoSProfile interface defines a class-of-service (CoS) profile for a specified VsmProviderAdminDomain object. Each VsmCoSProfile object represents the set of CoS configurations— CoS classes that record information on how traffic shaping and policing is configured—that is offered by a service provider to its customer. Each VsmProviderAdminDomain object can have multiple VsmCoSProfile objects defined for it.

See Also

CiscoVpnServiceModel::VpnInvMgr::newCoSProfileCreator, CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfileCreator, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfile, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCoSProfile, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::newCoSProfileModifier, CiscoVsmFWModifier::VsmCoSProfileModifier::updateRep, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfile, CiscoVpnServiceModel::VpnInvMgr::releaseCoSProfileModifier

Since

Cisco VPN Solutions Center, Release 1.0

Operations

getAllCoSClasses()

Gets all CoSClass values assined to this VsmCoSProfile object.

Usage

VsmCoSClassSeq getAllCoSClasses();
raises(
    RepException);

Returns

VsmCoSClassSeq—List of all CoSClass values assined to this VsmCoSProfile object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getCoSProfileConfig()

Gets the list of VsmCoSProfileConfig values specified for this VsmCoSProfile object.

Usage

VsmCoSProfileConfigSeq getCoSProfileConfig();

Returns

VsmCoSProfileConfig—List of VsmCoSProfileConfig values specified for this VsmCoSProfile object.

See Also

CiscoVsmFWCreator::VsmCoSProfileCreator::setCoSProfileConfig

Since

Cisco VPN Solutions Center, Release 1.0

getName()

Gets the name assigned to this VsmCoSProfile object.

Usage

string getName();

Returns

string—The name assigned to this VsmCoSProfile object.

See Also

CiscoVsmFWCreator::VsmCoSProfileCreator::setName, CiscoVsmFWModifier::VsmCoSProfileModifier::setName, VsmProviderAdminDomain::getName, VsmRegion::getName, VsmCustomer::getName, VsmCustomerSite::getName, VsmVPN::getName, VsmVRFDef::getName

Since

Cisco VPN Solutions Center, Release 1.0

getOutOfContractMultiplier()

Gets the scalar value used determining the limit that must be exceeded before out-of-contract penalties—dropped packets or decreased priority— are imposed.

Usage

float getOutOfContractMultiplier();

Returns

float—Scalar value used determining the limit that must be exceeded before out-of-contract penalties are imposed.

See Also

CiscoVsmFWCreator::VsmCoSProfileCreator::setOutOfContractMultiplier

Since

Cisco VPN Solutions Center, Release 1.0

getProviderAdminDomain()

Gets the VsmProviderAdminDomain object associated with this VsmCoSProfile object.

Usage

VsmProviderAdminDomain getProviderAdminDomain();
raises(
    RepException);

Returns

VsmProviderAdminDomain—The VsmProviderAdminDomain object associated with this VsmCoSProfile object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getSRVCs()

Gets all VsmSRVC objects for this VsmCoSProfile object that match one of the VsmSRState values supplied by the srStates input parameter.

Usage

VsmSRVCSeq getSRVCs(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this CoS profile.

Returns

VsmSRVCSeq—List of all VsmSRVC objects for this VsmCoSProfile object that match one of the VsmSRState values supplied by the srStates input parameter.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCoSProfile, CiscoVsmSRCreator::VsmVPNServiceModifier::setCoSProfile, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

isDefault()

Returns TRUE if this VsmCoSProfile object is the default VsmCoSProfile object for the VsmProviderAdminDomain object for which it is added to the VPN Inventory repository.

Usage

boolean isDefault();

Returns

booleanTRUE if this VsmCoSProfile object is the default VsmCoSProfile object for the VsmProviderAdminDomain object for which it is added to the VPN Inventory repository. FALSE indicates that this VsmCoSProfile object is not the default.

See Also

CiscoVsmFWCreator::VsmCoSProfileCreator::setDefault, CiscoVsmFWModifier::VsmCoSProfileModifier::setDefault

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmCustomer

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

Operations

findCustomerSiteByName()

Gets a VsmCustomerSite object based on its name string.

Usage

VsmCustomerSite findCustomerSiteByName(
    in string name)
raises(
    RepException);

Parameters

namein 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 Inventory Repository error occurs.

See Also

VsmCustomerSite, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep, CiscoVsmFWCreator::VsmCustomerSiteCreator::setName, VsmCustomerSite::getName

Since

Cisco VPN Solutions Center, Release 1.0

getAllCustomerSites()

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 Inventory Repository error occurs.

See Also

VsmCustomerSite, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getContactInfo()

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

getName()

Gets the name assigned to this VsmCustomer object.

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

getPEs()

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 srStates.

Usage

VsmPESeq getPEs(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this provider-edge router.

srStatesin 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

getSRVCs()

Gets a list of all VsmSRVC objects that match one of the states specified by srStates and are not subsumed by another VsmSRVC object.

Usage

VsmSRVCSeq getSRVCs(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin 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 srStates.

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

getVPNs()

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 srStates.

Usage

VsmVPNSeq getVPNs(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin 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

Interface VsmCustomerSite

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

Operations

getAllCEs()

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 Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCECreator::addToRep, VsmRegion::getAllPEs

Since

Cisco VPN Solutions Center, Release 1.0

getCustomer()

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 Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmCustomerSiteCreator, CiscoVsmFWCreator::VsmCustomerSiteCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getLocationInfo()

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

getName()

Gets the name assigned to this VsmCustomerSite object.

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

Interface VsmPE

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

Operations

getConfigletList()

Gets the configlets (VsmConfiglet objects) for this provider-edge router.

Usage

VsmConfigletSeq getConfigletList(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin 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 Inventory Repository error occurs.

See Also

VsmConfiglet, VsmConfiglet::getPE, VsmConfiglet::getSRVCs, VsmCE::getConfiglets, VsmVPN::getConfiglets

Since

Cisco VPN Solutions Center, Release 1.0

getCustomers()

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 srStates.

Usage

VsmCustomerSeq getCustomers(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin 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 Inventory Repository error occurs.

See Also

VsmCustomer

Since

Cisco VPN Solutions Center, Release 1.0

getDomainName()

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

getHostName()

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

getID()

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 Inventory Repository error occurs. CiscoVsmExceptions::InvalidData when other error occurs.

See Also

getID, getHostName, getDomainName, getNetworkName, VsmCE::getID

Since

Cisco VPN Solutions Center, Release 1.0

getNetworkName()

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

getRegion()

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 Inventory Repository error occurs.

See Also

VsmRegion, CiscoVsmFWCreator::VsmPECreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getRouterInterfaceList()

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 Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPECreator::setRouterInterfaces

Since

Cisco VPN Solutions Center, Release 1.0

getRouterPasswordList()

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 Inventory Repository error occurs.

See Also

VsmPassword, CiscoVsmFWCreator::VsmPECreator::setRouterPasswords

Since

Cisco VPN Solutions Center, Release 1.0

getSRVCs()

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 srStates)
raises(
    RepException);

Parameters

srStatesin 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 Inventory Repository 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

getTelnetRetries()

Gets the number of times to attempt a telnet connection for this VsmPE object.

Usage

unsigned short getTelnetRetries();
raises(
    RepException);

Returns

short—The number of times to attempt a telnet connection for this VsmPE object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPECreator::setTelnetRetries, CiscoVsmFWModifier::VsmPEModifier::setTelnetRetries, getTelnetTimeOut

Since

Cisco VPN Solutions Center, Release 1.2

getTelnetTimeOut()

Gets the telnet timeout value for this VsmPE object.

Usage

unsigned long getTelnetTimeOut();
raises(
    RepException);

Returns

long—The telnet timeout value (seconds) for this VsmPE object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPECreator::setTelnetTimeOut, CiscoVsmFWModifier::VsmPEModifier::setTelnetTimeOut, getTelnetRetries

Since

Cisco VPN Solutions Center, Release 1.2

Interface VsmPRG

An instance of the VsmPRG interface reserves a group of ports for a specified VsmPE object. Collectectively, these PE ports are maintained as a port-reservation group (PRG) and are available for use by the specified VPN.

See Also

CiscoVpnServiceModel::VpnInvMgr::newPRGCreator, CiscoVsmFWCreator::VsmPRGCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::releasePRG, CiscoVpnServiceModel::VpnInvMgr::releasePRGCreator, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPRG, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVpnServiceModel::VpnInvMgr::newPRGModifier, CiscoVsmFWModifier::VsmPRGModifier::updateRep, CiscoVpnServiceModel::VpnInvMgr::releasePRG, CiscoVpnServiceModel::VpnInvMgr::releasePRGModifier

Since

Cisco VPN Solutions Center, Release 1.0

Operations

getDesc()

Gets the descriptive text for this VsmPRG object.

Usage

string getDesc();

Returns

string—Descriptive text for this VsmPRG object.

See Also

CiscoVsmFWCreator::VsmPRGCreator::setDesc, CiscoVsmFWModifier::VsmPRGModifier::setDesc

Since

Cisco VPN Solutions Center, Release 1.0

getID()

Gets the unique identifier for this VsmPRG object.

Usage

unsigned long getID();

Returns

unsigned long—Unique identifier for this VsmPRG object.

See Also

CiscoVsmFWCreator::VsmPRGCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getSRVCs()

Gets all VsmSRVC objects for this VsmPRG object that match one of the VsmSRState values supplied by the srStates input parameter.

Usage

VsmSRVCSeq getSRVCs(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin VsmSRStateSeq that lists the service-request states on which to base the retrieval of VsmSRVC objects that are related to this PRG.

Returns

VsmSRVCSeq—List of all VsmSRVC objects for this VsmPRG object that match one of the VsmSRState values supplied by the srStates input parameter.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPRG, CiscoVsmSRCreator::VsmVPNServiceModifier::setPRG, CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getVPN()

Gets the VsmVPN object to which this VsmPRG belongs.

Usage

VsmVPN getVPN();
raises(
    RepException);

Returns

VsmVPN—The VsmVPN object to which this VsmPRG belongs.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPRGCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmProviderAdminDomain

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

Operations

findRegionByName()

Gets a VsmRegion object based on its name string.

Usage

VsmRegion findRegionByName(
    in string name)
raises(
    RepException);

Parameters

namein 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 Inventory Repository error occurs.

See Also

getAllRegions, VsmPE::getRegion, CiscoVsmFWCreator::VsmRegionCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

freeRD()

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

rdin VsmRDSeed that represents the RD value to be freed.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

VsmRDSeed, getNextRD, getAllFreeRDs, getAllRDSeeds, isRDOverlapped, freeRT

Since

Cisco VPN Solutions Center, Release 1.0

freeRT()

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

rdin 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

getAllFreeRDs()

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 Inventory Repository error occurs.

See Also

VsmRDSeedSeq, getNextRD, freeRD, getAllRDSeeds, isRDOverlapped, getAllFreeRTs

Since

Cisco VPN Solutions Center, Release 1.0

getAllFreeRTs()

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 Inventory Repository error occurs.

See Also

VsmRTSeedSeq, getNextRT, freeRT, getAllRTSeeds, isRTOverlapped, getAllFreeRDs

Since

Cisco VPN Solutions Center, Release 1.0

getAllRDSeeds()

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 Inventory Repository error occurs.

See Also

VsmRDSeedSeq, getNextRD, freeRD, getAllFreeRDs, isRDOverlapped, getAllRTSeeds

Since

Cisco VPN Solutions Center, Release 1.0

getAllRegions()

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 Inventory Repository error occurs.

See Also

findRegionByName, VsmPE::getRegion, CiscoVsmFWCreator::VsmRegionCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getAllRTSeeds()

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 Inventory Repository error occurs.

See Also

VsmRTSeedSeq, getNextRT, freeRT, getAllFreeRTs, isRTOverlapped, getAllRDSeeds

Since

Cisco VPN Solutions Center, Release 1.0

getASNumber()

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

getContactInfo()

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

getCoSProfiles()

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

defaultOnlyin 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 Inventory Repository error occurs.

See Also

VsmCoSProfile, CiscoVsmFWCreator::VsmCoSProfileCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getName()

Gets the name assigned to this VsmProviderAdminDomain object.

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

getNextRD()

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 Inventory Repository error occurs.

See Also

VsmRDSeed, freeRD, getAllFreeRDs, getAllRDSeeds, isRDOverlapped, getNextRT

Since

Cisco VPN Solutions Center, Release 1.0

getNextRT()

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

getVRFDefs()

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 Inventory Repository error occurs.

See Also

VsmVRFDef

Since

Cisco VPN Solutions Center, Release 1.0

isRDOverlapped()

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

rdin VsmRDSeed that represents the RD value to be checked.

Returns

booleanTRUE when the given RD overlaps a provider RD seed.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

getNextRD, freeRD, getAllRDSeeds, getAllFreeRDs, isRTOverlapped

Since

Cisco VPN Solutions Center, Release 1.0

isRTOverlapped()

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

rtin VsmRTSeed that represents the RT value to be checked.

Returns

booleanTRUE when the given RT overlaps a provider RT seed.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

getNextRT, freeRT, getAllRTSeeds, getAllFreeRTs, isRDOverlapped

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmRegion

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

Operations

freeIPAddress30()

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

addrin VsmIPAddress that represents an IP address to be freed.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

getNext30Address, getAllIPAddressPool30, getAllFreeIPAddress30, isAddressOverlappedWithPool30, freeIPAddress32

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

addrin VsmIPAddress that represents an IP address to be freed.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

getNext32Address, getAllIPAddressPool32, getAllFreeIPAddress32, isAddressOverlappedWithPool32, freeIPAddress30

Since

Cisco VPN Solutions Center, Release 1.0

getAllFreeIPAddress30()

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/30 + 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 Inventory Repository error occurs.

See Also

getNext30Address, freeIPAddress30, getAllIPAddressPool30, isAddressOverlappedWithPool30, getAllFreeIPAddress32

Since

Cisco VPN Solutions Center, Release 1.0

getAllFreeIPAddress32()

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 Inventory Repository error occurs.

See Also

getNext32Address, freeIPAddress32, getAllIPAddressPool32, isAddressOverlappedWithPool32, getAllFreeIPAddress30

Since

Cisco VPN Solutions Center, Release 1.0

getAllIPAddressPool30()

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/30 for the original pool 192.100.200.0/30.

Usage

VsmIPAddressPoolSeq getAllIPAddressPool30();
raises(
    RepException);

Returns

VsmIPAddressPoolSeq—Lists the IP address pools for this region.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

getNext30Address, freeIPAddress30, getAllFreeIPAddress30, isAddressOverlappedWithPool30, getAllIPAddressPool32

Since

Cisco VPN Solutions Center, Release 1.0

getAllIPAddressPool32()

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 Inventory Repository error occurs.

See Also

getNext32Address, freeIPAddress32, getAllFreeIPAddress32, isAddressOverlappedWithPool32, getAllIPAddressPool30

Since

Cisco VPN Solutions Center, Release 1.0

getAllPEs()

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 Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmPECreator::addToRep, VsmCustomerSite::getAllCEs

Since

Cisco VPN Solutions Center, Release 1.0

getName()

Gets the name assigned to this VsmRegion object.

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

getNext30Address()

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 Inventory Repository error occurs.

See Also

freeIPAddress30, getAllIPAddressPool30, getAllFreeIPAddress30, isAddressOverlappedWithPool30, getNext32Address

Since

Cisco VPN Solutions Center, Release 1.0

getNext32Address()

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 Inventory Repository error occurs.

See Also

freeIPAddress32, getAllIPAddressPool32, getAllFreeIPAddress32, isAddressOverlappedWithPool32, getNext30Address

Since

Cisco VPN Solutions Center, Release 1.0

getProviderAdminDomain()

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 Inventory Repository error occurs.

See Also

CiscoVsmFWCreator::VsmRegionCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

isAddressOverlappedWithPool30()

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

addrin 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 Inventory Repository error occurs.

See Also

getNext30Address, freeIPAddress30, getAllIPAddressPool30, getAllFreeIPAddress30, isAddressOverlappedWithPool32

Since

Cisco VPN Solutions Center, Release 1.0

isAddressOverlappedWithPool32()

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

addrin 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 Inventory Repository error occurs.

See Also

getNext32Address, freeIPAddress32, getAllIPAddressPool32, getAllFreeIPAddress32, isAddressOverlappedWithPool30

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmSRVC

An instance of the VsmSRVC interface represents a service request that either configures VPN connectivity for a PE-CE link or reserves a PE port for use by a port-reservation group (VsmPRG object).

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep, CiscoVpnServiceModel::VpnInvMgr::releaseSRVC

Since

Cisco VPN Solutions Center, Release 1.0

Operations

areConnectedRoutesRedistributed()

When TRUE, indicates that connected routes for the related VsmPE object are to be redistributed.

Usage

boolean areConnectedRoutesRedistributed();

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

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setRedistributeConnectedRoutes, areStaticRoutesRedistributed

Since

Cisco VPN Solutions Center, Release 1.2

areStaticRoutesRedistributed()

When TRUE, indicates that static routes for the related VsmPE object are to be redistributed.

Usage

boolean areStaticRoutesRedistributed();

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

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setRedistributeStaticRoutes, areConnectedRoutesRedistributed

Since

Cisco VPN Solutions Center, Release 1.2

getCableModemHelperAddress()

Gets the a cable helper address to configure the PE interface for the VsmPE object associated with this VsmSRVC object.

Usage

VsmIPAddress getCableModemHelperAddress();

Returns

VsmIPAddress—Cable helper address to configure the PE interface for the VsmPE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCableModemHelperAddress, getCableModemHostHelperAddress, getCableModemSecondaryIpAddressList, isCableModemMaintenanceInterface, getCableModemMaintenanceInterfaceHelperAddress

Since

Cisco VPN Solutions Center, Release 1.2

getCableModemHostHelperAddress()

Gets the a host helper address to configure the PE interface for the VsmPE object associated with this VsmSRVC object.

Usage

VsmIPAddress getCableModemHostHelperAddress();

Returns

VsmIPAddress—Host helper address to configure the PE interface for the VsmPE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCableModemHostHelperAddress, getCableModemHelperAddress, getCableModemSecondaryIpAddressList, isCableModemMaintenanceInterface, getCableModemMaintenanceInterfaceHelperAddress

Since

Cisco VPN Solutions Center, Release 1.2

getCableModemMaintenanceInterfaceHelperAddress()

Gets the maintenance-interface helper address for the VsmPE object associated with this VsmSRVC object when a maintenance subinterface is to be provisioned.

Usage

VsmIPAddress getCableModemMaintenanceInterfaceHelperAddress();

Returns

VsmIPAddress—Maintenance-interface helper address for the VsmPE object associated with this VsmSRVC object when a maintenance subinterface is to be provisioned.

Description

This operation only applies if the isCableModemMaintenanceInterface() operation returns TRUE.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCableModemMaintenanceInterfaceHelperAddress, getCableModemHelperAddress, getCableModemHostHelperAddress, getCableModemSecondaryIpAddressList, isCableModemMaintenanceInterface

Since

Cisco VPN Solutions Center, Release 1.2

getCableModemSecondaryIpAddressList()

Gets the list of secondary IP addresses for use by the PE associated with this VsmSRVC object.

Usage

VsmIPAddressSeq getCableModemSecondaryIpAddressList();

Returns

VsmIPAddressSeq—List of secondary IP addresses for use by the PE associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCableModemSecondaryIpAddressList, getCableModemHelperAddress, getCableModemHostHelperAddress, isCableModemMaintenanceInterface, getCableModemMaintenanceInterfaceHelperAddress

Since

Cisco VPN Solutions Center, Release 1.2

getCE()

Gets the VsmCE object associated with this VsmSRVC object.

Usage

VsmCE getCE();
raises(
    RepException);

Returns

VsmCE—Object that represents the CE associated with this VsmSRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCE

Since

Cisco VPN Solutions Center, Release 1.0

getCEAddress()

Gets the IP address of the VsmCE object associated with this VsmSRVC object.

Usage

VsmIPAddress getCEAddress();

Returns

VsmIPAddress—IP address of the VsmCE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEAddress, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setAutoPickAddress

Since

Cisco VPN Solutions Center, Release 1.0

getCEAdvertisedRoutes()

Gets a list of all subnets of a customer site to be advertised by the VsmCE object and accessible to the VsmPE object that are associated with this VsmSRVC object.

Usage

advertisedRouteSeq getCEAdvertisedRoutes();

Returns

redistributedProtocolSeq—List of all subnets of a customer site to be advertised by the VsmCE object and accessible to the VsmPE object that are associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEAdvertisedRoutes

Since

Cisco VPN Solutions Center, Release 1.0

getCEAutonomousSystem()

Gets the autonomous system (AS) number.for the VsmCE object associated with this VsmSRVC object.

Usage

unsigned long getCEAutonomousSystem();

Returns

unsigned long—Autonomous system (AS) number.for the VsmCE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEAutonomousSystem

Since

Cisco VPN Solutions Center, Release 1.0

getCeCircuitId()

Gets circuit-identifier data for the CE interface associated with this VsmSRVC object.

Usage

CircuitIdentifier getCeCircuitId();

Returns

CircuitIdentifier—Circuit-identifier data for the CE interface associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCECircuitIdentifier

Since

Cisco VPN Solutions Center, Release 1.0

getCEConfiglet()

Gets the CE configlet for this VsmSRVC object.

Usage

VsmConfiglet getCEConfiglet();
raises(
    RepException);

Returns

VsmConfiglet—CE configlet, which is based on information given to the CiscoVsmSRCreator::VsmVPNConnectivityCreator object that generated this VsmSRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEInterfaceTemplate, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCETemplate, getPEConfiglet

Since

Cisco VPN Solutions Center, Release 1.0

getCEInterface()

Gets the interface name for the VsmCE object associated with this VsmSRVC object.

Usage

string getCEInterface();

Returns

string—Interface name for the VsmCE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEInterface

Since

Cisco VPN Solutions Center, Release 1.0

getCeInterfaceEncapsulation()

Not used.

Usage

VsmInterfaceEncapsulation getCeInterfaceEncapsulation();

getCEInterfaceTemplate()

Gets the template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the CE interface associated with this VsmSRVC object.

Usage

string getCEInterfaceTemplate();

Returns

string—Template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the CE interface associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEInterfaceTemplate

Since

Cisco VPN Solutions Center, Release 1.0

getCeInterfaceType()

Gets the interface type for the CE interface associated with this VsmSRVC object.

Usage

VsmInterfaceType getCeInterfaceType();

Returns

VsmInterfaceType—Interface type for the CE interface associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCEInterfaceType

Since

Cisco VPN Solutions Center, Release 1.0

getCELoopbackInterfaceAddress()

Gets the loopback interface address for the VsmCE object associated with this VsmSRVC object.

Usage

string getCELoopbackInterfaceAddress();

Returns

string—If the getCELoopbackInterfaceRequired() operation returns TRUE, this operation returns the loopback interface address for the VsmCE object associated with this VsmSRVC object; getCELoopbackInterfaceRequired() returns FALSE, this operation returns an empty string.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCELoopbackInterfaceAddress

Since

Cisco VPN Solutions Center, Release 1.1

getCELoopbackInterfaceNumber()

Not used.

Usage

short getCELoopbackInterfaceNumber();

getCeOSPFArea()

Gets the OSPF area number, if the routing protocol is OSPF, for the VsmCE object associated with this VsmSRVC object.

Usage

unsigned long getCeOSPFArea();

Returns

unsigned long—If OSPFRoutingType is specified by the CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol() operation, represents the OSPF area number for the VsmCE object associated with this VsmSRVC object; returns 0 otherwise.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCeOSPFArea, getPeOSPFArea

Since

Cisco VPN Solutions Center, Release 1.2

getCeOSPFAreaAsIpAddress()

Gets the OSPF area in IP-address notation, if the routing protocol is OSPF, for the VsmCE object associated with this VsmSRVC object.

Usage

string getCeOSPFAreaAsIpAddress();

Returns

string—If OSPFRoutingType is specified by the CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol() operation, the IP-address representation of the OSPF area for the VsmCE object associated with this VsmSRVC object; returns an empty string otherwise.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCeOSPFAreaAsIpAddress

Since

Cisco VPN Solutions Center, Release 1.2

getCeOSPFProcessId()

Gets the OSPF process ID of the VsmCE object associated with this VsmSRVC object if the routing protocol is OSPF.

Usage

long getCeOSPFProcessId();

Returns

long—Represents the process ID of the VsmCE object associated with this VsmSRVC object if the routing protocol is OSPF; returns value is undefined otherwise.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCeOSPFProcessId, getPeOSPFProcessId

Since

Cisco VPN Solutions Center, Release 1.2

getCERedistributedProtocols()

Gets a list of all protocols that are redistributed from the VsmCE object associated with this VsmSRVC object.

Usage

redistributedProtocolSeq getCERedistributedProtocols();

Returns

redistributedProtocolSeq—List of all protocols that are redistributed from the VsmCE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCERedistributedProtocols

Since

Cisco VPN Solutions Center, Release 1.0

getCeTemplate()

Gets the template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the VsmCE object associated with this VsmSRVC object.

Usage

string getCeTemplate();

Returns

string—Template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the VsmCE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCETemplate

Since

Cisco VPN Solutions Center, Release 1.0

getCoSProfile()

Gets VsmCoSProfile object associated with this VsmSRVC object.

Usage

VsmCoSProfile getCoSProfile();
raises(
    RepException);

Returns

VsmCoSProfileVsmCoSProfile object associated with this VsmSRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCoSProfile

Since

Cisco VPN Solutions Center, Release 1.0

getCreateTime()

Gets the time that this VsmSRVC object was created.

Usage

string getCreateTime();

Returns

string—Time that this VsmSRVC object was created.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getCreatorType()

Gets the type of creator that created this VsmSRVC object.

Usage

string getCreatorType();

Returns

string—Type of creator that created this VsmSRVC object; for example, third-party client applications, the Cisco VPN Solutions Center client application, or CLI-based applications.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getCustomer()

Gets the VsmCustomer object associated with this VsmSRVC object.

Usage

VsmCustomer getCustomer();
raises(
    RepException);

Returns

VsmCustomer—Customer for whom this VsmSRVC object was generated.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCustomer

Since

Cisco VPN Solutions Center, Release 1.0

getExportMapName()

Gets the export map name.

Usage

string getExportMapName();

Returns

string—Export map name.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setExportMapName

Since

Cisco VPN Solutions Center, Release 1.1

getID()

Gets the unique identifier for this VsmSRVC object.

Usage

unsigned long getID();

Returns

unsigned long—Unique identifier for this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getImportMapName()

Gets the import map name.

Usage

string getImportMapName();

Returns

string—Import map name.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setImportMapName

Since

Cisco VPN Solutions Center, Release 1.1

getIPUnnumbered()

Gets the VsmInterfIPUnnumberType enumeration that indicates whether none, one, or both of the edge routers associated with this VsmSRVC object use IP-unnumbered interfaces.

Usage

VsmInterfIPUnnumberType getIPUnnumbered();

Returns

VsmInterfIPUnnumberType—Enumerated type that indicates whether none, one, or both of the edge routers associated with this VsmSRVC object use IP-unnumbered interfaces.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setIPUnnumbered

Since

Cisco VPN Solutions Center, Release 1.0

getLastStateChngTime()

Gets the time that this VsmSRVC object was last modified changed.

Usage

string getLastStateChngTime();

Returns

string—Time that this VsmSRVC object was last modified changed.

Since

Cisco VPN Solutions Center, Release 1.0

getMaxASOccurrenceInPath()

Gets the maximum number of times a specific autonomous system (AS) number can appear in the routing path before rerouting a data packet.

Usage

short getMaxASOccurrenceInPath();

Returns

short—Maximum number of times a specific autonomous system (AS) number can appear in the routing path before rerouting a data packet.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setMaxASOccurrenceInPath

Since

Cisco VPN Solutions Center, Release 1.1

getMaxRoutes()

Gets the maximum number of routes for the VRF table to accept.

Usage

long getMaxRoutes();

Returns

long—Maximum number of routes for the VRF table to accept.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setMaxRoutes

Since

Cisco VPN Solutions Center, Release 1.1

getPE()

Gets the VsmPE object associated with this VsmSRVC object.

Usage

VsmPE getPE();
raises(
    RepException);

Returns

VsmPE—Object that represents the PE associated with this VsmSRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPE

Since

Cisco VPN Solutions Center, Release 1.0

getPEAddress()

Gets the IP address of the VsmPE object associated with this VsmSRVC object.

Usage

VsmIPAddress getPEAddress();

Returns

VsmIPAddress—IP address of the VsmPE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEAddress, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setAutoPickAddress

Since

Cisco VPN Solutions Center, Release 1.0

getPECELinkProtocol()

Gets the routing protocol used to establish cumminication over the PE-CE link associated with this VsmSRVC object.

Usage

VsmPECELinkProtocolType getPECELinkProtocol();

Returns

VsmPECELinkProtocolType—Routing protocol used to establish cumminication over the PE-CE link associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol

Since

Cisco VPN Solutions Center, Release 1.0

getPeCircuitId()

Gets circuit-identifier data for the PE interface associated with this VsmSRVC object.

Usage

CircuitIdentifier getPeCircuitId();

Returns

CircuitIdentifier—Circuit-identifier data for the PE interface associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECircuitIdentifier

Since

Cisco VPN Solutions Center, Release 1.0

getPEConfiglet()

Gets the PE configlet for this VsmSRVC object.

Usage

VsmConfiglet getPEConfiglet();
raises(
    RepException);

Returns

VsmConfiglet—PE configlet, which is based on information given to the CiscoVsmSRCreator::VsmVPNConnectivityCreator object that generated this VsmSRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterfaceTemplate, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPETemplate, getCEConfiglet

Since

Cisco VPN Solutions Center, Release 1.0

getPEInterface()

Gets the interface name for the VsmPE object associated with this VsmSRVC object.

Usage

string getPEInterface();

Returns

string—Interface name for the VsmPE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterface

Since

Cisco VPN Solutions Center, Release 1.0

getPeInterfaceEncapsulation()

Not used.

Usage

VsmInterfaceEncapsulation getPeInterfaceEncapsulation();

getPEInterfaceTemplate()

Gets the template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the PE interface associated with this VsmSRVC object.

Usage

string getPEInterfaceTemplate();

Returns

string—Template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the PE interface associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterfaceTemplate

Since

Cisco VPN Solutions Center, Release 1.0

getPeInterfaceType()

Gets the interface type for the PE interface associated with this VsmSRVC object.

Usage

VsmInterfaceType getPeInterfaceType();

Returns

VsmInterfaceType—Interface type for the PE interface associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterfaceType

Since

Cisco VPN Solutions Center, Release 1.0

getPeOSPFArea()

Gets the OSPF area number, if the routing protocol is OSPF, for the VsmPE object associated with this VsmSRVC object.

Usage

unsigned long getPeOSPFArea();

Returns

unsigned long—If OSPFRoutingType is specified by the CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol() operation, represents the OSPF area number for the VsmPE object associated with this VsmSRVC object; returns 0 otherwise.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPeOSPFArea

Since

Cisco VPN Solutions Center, Release 1.2

getPeOSPFAreaAsIpAddress()

Gets the OSPF area in IP-address notation, if the routing protocol is OSPF, for the VsmPE object associated with this VsmSRVC object.

Usage

string getPeOSPFAreaAsIpAddress();

Returns

string—If OSPFRoutingType is specified by the CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol() operation, the IP-address representation of the OSPF area for the VsmPE object associated with this VsmSRVC object; returns an empty string otherwise.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPeOSPFAreaAsIpAddress

Since

Cisco VPN Solutions Center, Release 1.2

getPeOSPFProcessId()

Gets the OSPF process ID of the VsmPE object associated with this VsmSRVC object if the routing protocol is OSPF.

Usage

long getPeOSPFProcessId();

Returns

long—Represents the process ID of the VsmPE object associated with this VsmSRVC object if the routing protocol is OSPF; returns value is undefined otherwise.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPeOSPFProcessId, getCeOSPFProcessId

Since

Cisco VPN Solutions Center, Release 1.2

getPeTemplate()

Gets the template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the VsmPE object associated with this VsmSRVC object.

Usage

string getPeTemplate();

Returns

string—Template text with which to augment the IOS configuration to be defined by the configlets that are generated by the provisioning system for the VsmPE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPETemplate

Since

Cisco VPN Solutions Center, Release 1.0

getPRG()

Gets the VsmPRG for which this VsmSRVC reserves a PE port.

Usage

VsmPRG getPRG();
raises(
    RepException);

Returns

VsmPRG—Object for which this VsmSRVC reserves a PE port.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPRG

Since

Cisco VPN Solutions Center, Release 1.0

getRoutesToAllSites()

Gets a list of routes to all customer sites that are accessible by the VsmCE object associated with this VsmSRVC object.

Usage

routesToAllSitesSeq getRoutesToAllSites();

Returns

routesToAllSitesSeq—List of routes to all customer sites that are accessible by the VsmCE object associated with this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setRoutesToAllSites

Since

Cisco VPN Solutions Center, Release 1.0

getSrvcDefText()

Gets an ASCII definition of this VsmSRVC object.

Usage

string getSrvcDefText();
raises(
    RepException);

Returns

string—ASCII definition of this VsmSRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

Since

Cisco VPN Solutions Center, Release 1.0

getState()

Gets the current state of this VsmSRVC object.

Usage

VsmSRState getState();

Returns

VsmSRState—Current state of this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setState, getStateDesc

Since

Cisco VPN Solutions Center, Release 1.0

getStateDesc()

Gets the state history for this VsmSRVC object.

Usage

string getStateDesc();

Returns

string—State history for this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setState, getState

Since

Cisco VPN Solutions Center, Release 1.0

getSubsumedSRVC()

Gets the VsmSRVC object that was subsumed by this VsmSRVC object upon modification.

Usage

VsmSRVC getSubsumedSRVC();
raises(
    RepException);

Returns

VsmSRVC—Subsumed VsmSRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNServiceModifier::addToRep, CiscoVsmSRCreator::VsmVPNServiceModifier::serviceRequestID

Since

Cisco VPN Solutions Center, Release 1.0

getType()

Gets the type of service request this VsmSRVC object represents.

Usage

VsmSRType getType();

Returns

VsmSRType—Type of service request—addition or deletion service for a PE-CE pair—that this VsmSRVC object represents.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, CiscoVsmSRCreator::VsmServiceModifier::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getUser()

Gets the name of the operating-system user that executed the client from which this VsmSRVC object was created.

Usage

string getUser();

Returns

string—Name of the user who created this VsmSRVC object.

Description

A VsmSRVC object may be created by either the VPN Solutions Center client application or by a third-party API-based client application. The user name returned by this operation is the name of the operating-system user that executed the client application that created this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::addToRep, getCreatorType,

Since

Cisco VPN Solutions Center, Release 1.0

getVRFDef()

Gets the VsmVRFDef object that configures the PE interface associated with this VsmCRVC object.

Usage

VsmVRFDef getVRFDef();
raises(
    RepException);

Returns

VsmVRFDef—Object that configures the PE interface associated with this VsmCRVC object.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCERCMemberships

Since

Cisco VPN Solutions Center, Release 1.0

isASOverride()

When TRUE, indicates that the client application can override of the autonomus system (AS) number.

Usage

boolean isASOverride();

Returns

boolean—When TRUE, indicates that the client application can override of the autonomus system (AS) number. The default is FALSE, which disallows overriding of the AS number.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setASOverride

Since

Cisco VPN Solutions Center, Release 1.1

isCableModemMaintenanceInterface()

When TRUE, indicates that a maintenance subinterface is to be provisioned for the VsmPE object associated with this VsmSRVC.

Usage

boolean isCableModemMaintenanceInterface();

Returns

booleanTRUE when a maintenance subinterface is to be provisioned for the VsmPE object associated with this VsmSRVC; FALSE otherwise.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCableModemMaintenanceInterface, getCableModemHelperAddress, getCableModemHostHelperAddress, getCableModemSecondaryIpAddressList, getCableModemMaintenanceInterfaceHelperAddress

Since

Cisco VPN Solutions Center, Release 1.2

isCELoopbackInterfaceRequired()

When TRUE, indicates that a loopback interface is required for the VsmCE object associated with this VsmSRVC object.

Usage

boolean isCELoopbackInterfaceRequired();

Returns

boolean—When TRUE, indicates that a loopback interface is required for the VsmCE object associated with this VsmSRVC object. The default is FALSE, which indicates that a loopback interface is not required for the VsmCE object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCELoopbackInterfaceRequired

Since

Cisco VPN Solutions Center, Release 1.1

isCeOSPFAreaSetAsIpAddress()

When TRUE, indicates that the OSPF area, if the routing protocol is OSPF, is exressed in IP-address notation for the VsmCE object associated with this VsmSRVC object.

Usage

boolean isCeOSPFAreaSetAsIpAddress();

Returns

boolean—When TRUE, indicates that the OSPF area is exressed numerically for the VsmCE object associated with this VsmSRVC object; when, FALSE, indicates the OSPF area is expressed numerically for the VsmCE object associated with this VsmSRVC object; if OSPFRoutingType is not specified by the CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol() operation, the return value is undefined.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::getCeOSPFArea, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setCeOSPFAreaAsIpAddress

Since

Cisco VPN Solutions Center, Release 1.2

isMemberGreyManagementVPN()

When TRUE, indicates that the CE for this VsmSRVC object is to be added to a grey-management VPN.

Usage

boolean isMemberGreyManagementVPN();

Returns

boolean—When TRUE, indicates that the CE is to be added to a grey-management VPN; when FALSE, indicates that the CE is not to be added to grey management VPN.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setMemberGreyManagementVPN

Since

Cisco VPN Solutions Center, Release 1.1

isNetflowAccountingOn()

When b

Usage

boolean isNetflowAccountingOn();

Returns

boolean—When TRUE, indicates that netflow accounting is enabled by this VsmSRVC object. The default is FALSE, which indicates that netflow accounting is enabled by this VsmSRVC object.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setASOverride

Since

Cisco VPN Solutions Center, Release 1.1

isOnlyDefRouteSentToCE()

When TRUE, only the default route is sent to the CE associated with this VsmSRVC object.

Usage

boolean isOnlyDefRouteSentToCE();

Returns

booleanTRUE if only the default route is sent to the CE associated with this VsmSRVC object; FALSE if all routes are sent to the CE.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setOnlyDefaultRouteSentToCE

Since

Cisco VPN Solutions Center, Release 1.0

isPEInterfaceShutdown()

When TRUE, indicates the PE interface is to be shutdown after provisioning.

Usage

boolean isPEInterfaceShutdown();

Returns

boolean—TRUE if the PE interface is to be shutdown after provisioning; FALSE otherwise.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEInterfaceShutdown

Since

Cisco VPN Solutions Center, Release 1.0

isPeOSPFAreaSetAsIpAddress()

When TRUE, indicates that the OSPF area, if the routing protocol is OSPF, is exressed in IP-address notation for the VsmPE object associated with this VsmSRVC object.

Usage

boolean isPeOSPFAreaSetAsIpAddress();

Returns

boolean—When TRUE, indicates that the OSPF area is exressed numerically for the VsmPE object associated with this VsmSRVC object; when, FALSE, indicates the OSPF area is expressed numerically for the VsmPE object associated with this VsmSRVC object; if OSPFRoutingType is not specified by the CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol() operation, the return value is undefined.

Description

This operation applies only when the getPECELinkProtocol() operation returns OSPFRoutingType.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPECERoutingProtocol, CiscoVsmSRCreator::VsmVPNConnectivityCreator::getPeOSPFArea, CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPeOSPFAreaAsIpAddress

Since

Cisco VPN Solutions Center, Release 1.2

isPEPortReservationOnly()

When TRUE, indicates this VsmSRVC defines only a port reservation for the associated VsmPE object.

Usage

boolean isPEPortReservationOnly();

Returns

booleanTRUE if this VsmSRVC defines only a port reservation for the associated VsmPE object; FALSE if this this VsmSRVC establishes VPN service to a CE.

See Also

CiscoVsmSRCreator::VsmVPNConnectivityCreator::setPEPortReservationOnly

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmVPN

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

Operations

getAllCERCs()

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 Inventory Repository error occurs.

See Also

VsmCERC, CiscoVsmFWCreator::VsmCERCCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getAllCEs()

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 Inventory Repository error occurs.

See Also

VsmCE, CiscoVsmFWCreator::VsmCECreator::addToRep, VsmCustomerSite::getAllCEs

Since

Cisco VPN Solutions Center, Release 1.0

getAllPEs()

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 Inventory Repository error occurs.

See Also

VsmPE, CiscoVsmFWCreator::VsmPECreator::addToRep, VsmRegion::getAllPEs

Since

Cisco VPN Solutions Center, Release 1.0

getAllPRGs()

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 Inventory Repository error occurs.

See Also

VsmPRG, CiscoVsmFWCreator::VsmPRGCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getConfiglets()

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 srStates input argument.

Usage

VsmConfigletSeq getConfiglets(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin 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 srStates input argument.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

See Also

VsmConfiglet, VsmConfiglet::getSRVCs, VsmCE::getConfiglets, VsmPE::getConfigletList

Since

Cisco VPN Solutions Center, Release 1.0

getName()

Gets the name assigned to this VsmVPN object.

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

getProviderAdminDomain()

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 Inventory Repository error occurs.

See Also

VsmProviderAdminDomain, CiscoVsmFWCreator::VsmProviderAdminDomainCreator::addToRep

Since

Cisco VPN Solutions Center, Release 1.0

getSRVCs()

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 srStates.

Usage

VsmSRVCSeq getSRVCs(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Parameters

srStatesin 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 Inventory Repository error occurs.

See Also

VsmSRVC

Since

Cisco VPN Solutions Center, Release 1.0

Interface VsmVRFDef

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

Operations

getAllCERCMemberships()

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 Inventory Repository error occurs.

Since

Cisco VPN Solutions Center, Release 1.0

getID()

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

getName()

Gets the name assigned to this VsmVRFDef object.

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

getRD()

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

getSRVCs()

Gets all the SRVCs which associate with this VRFDef

Usage

VsmSRVCSeq getSRVCs(
    in VsmSRStateSeq srStates)
raises(
    RepException);

Returns

VsmSRVCSeq type, which lists the SRVC objects.

Raises

CiscoVsmExceptions::RepException if a VPN Inventory Repository error occurs.

Since

Cisco VPN Solutions Center, Release 1.0


hometocprevnextglossaryfeedbacksearchhelp
Posted: Tue Sep 26 16:57:48 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.