Defining Service Requests

VPN Connectivity

Configuration Options

Auto-pick Address and IP-Unnumbered States

Edge-router and Edge-router Interface Templates

Map Names

Maximum Occurrences of an AS Number in a Routing Path

Maximum Number of Routes for a VRF Table to Accept

Netflow Accounting On State

PE Port-reservation Group Only

Configuration Requirements

Routing Protocol

Customer

CERC Memberships

Class-of-Service Profile

VPN Routing and Forwarding Table

State

PE Port Reservation

Defining Service Requests

After the necessary VSM elements are added to the VPN Inventory repository, you can create a service request VPN configuration (SRVC) to define one of the following:

For both of the these CiscoVsmBrowser::VsmSRVC object variations, you can create the VsmSRVC object using the CiscoVsmSRCreator::VsmVPNConnectivityCreator interface. However, you cannot modify the VsmSRVC object.

Figure 5-1: Adding VPN Connectivity to a CE

The setServiceRequestSetting() operations in Figure 5-1 and Figure 5-2 serve as placeholders for the configurations setting described in "VPN Connectivity" section.

While the CiscoVsmSRCreator::VsmVPNServiceModifier interface suggests that you can modify a VsmSRVC objects, you cannot actually modify them. You can, however, modify the supported VPN service by subsuming the original VsmSRVC object and adding a new VsmSRVC object—with updated service information—to the VPN Inventory repository to supersede the original.

The VsmVPNServiceModifier interface is derived from the VsmVPNConnectivityCreator interface, so all features are API features of the VsmVPNConnectivityCreator interface are available to the VsmVPNServiceModifier through its inheritance. There are some features, however, that cannot be modified—even using the subsumption approach—for a VPN service. For more information regarding those service-request features that cannot be modified, see the Cisco VPN Solutions Center: MPLS Solution Provisioning and Operations Guide.

Figure 5-2: Modifying a VPN Service

Note The CiscoVsmSRCreator::VsmVPNServiceModifier interface inherits its addToRep() operation from the CiscoVsmSRCreator::VsmVPNConnectivityCreator interface from which it is derived. This operation, however, implements separate rules-checking algorithms for the VsmVPNConnectivityCreator and VsmVPNServiceModifier interfaces.

For information about port-reservation groups, see "PE Port Reservation" section.

VPN Connectivity

When using the APIs to either define or modify VPN connectivity to a CE, the usage of the API operations vary depending on the specifications of the service you want to create. The information in this section discusses the API usage as:

There are also contingent requirements for some of the required information for each of the service-request elements is supplied in the "Configuration Requirements" section.

Configuration Options

When using the APIs to either define or modify VPN connectivity to a CE, the following API features are optional for use at your discretion:

Auto-pick Address and IP-Unnumbered States

The setAutoPickAddress() operation accepts a boolean parameter called, autoPickAddressState. The default parameter value is TRUE. The setIPUnnumbered() operation accepts a CiscoVsmBrowser::VsmInterfIPUnnumberType called, ipUnnumberedState. The default value is CiscoVsmBrowser::VsmInterfIPUnnumberType::InterfIPNumbered.

This settings of these two states affect the IP-address requirements of the PE and CE for the service request. If ipUnnumberedState is InterfIPNumbered and autoPickAddressState is TRUE—the default configurations—the Cisco VPN Solutions Center software automatically picks two addresses from the pool of /30 subnet address allocated for the CiscoVsmBrowser::VsmRegion object to which the PE belongs. If ipUnnumberedState is InterfIPNumbered and autoPickAddressState is FALSE, execute the CiscoVsmBrowser::VsmRegion::getNext30Address() operation twice two manually get the next two /30 subnet addresses from the CiscoVsmBrowser::VsmRegion object.

If ipUnnumberedState is InterfPECEIPUnnumbered and autoPickAddressState is TRUE, the Cisco VPN Solutions Center software automatically picks two addresses from the pool of /32 subnet address allocated for the CiscoVsmBrowser::VsmRegion object for loopback addresses. If ipUnnumberedState is InterfPECEIPUnnumbered and autoPickAddressState is FALSE, execute the CiscoVsmBrowser::VsmRegion::getNext32Address() operation twice two manually get the next two /32 subnet addresses from the CiscoVsmBrowser::VsmRegion object.

Edge-router and Edge-router Interface Templates

The setCETemplate() and setPETemplate() operations each accept supplementary IOS commands for the CE and PE, respectively, as a string parameter called, routerTemplate. These commands augment the other configuration data—for the SRVC to be added to the VPN Inventory repository—to collectively determine the configuration data for the respective CE and PE configlets. There are no default templates for either of these operations.

The setCEInterfaceTemplate() and setPEInterfaceTemplate() operations each accept supplementary IOS commands for the CE and PE physical interfaces, respectively, as a string parameter called, routerInterfaceTemplate. These commands augment the other configuration data—for the SRVC to be added to the VPN Inventory repository—to collectively determine the configuration data for the respective CE and PE configlets. There are no default templates for either of these operations.

Map Names

Supply the names of import and export maps, respectively, using the setExportMapName() and setImportMapName() operations.

Maximum Occurrences of an AS Number in a Routing Path

The setMaxASOccurrenceInPath() operation accepts a short parameter—1 to 10, inclusive—called, maxASOccurrenceInPath. There is no default.

Maximum Number of Routes for a VRF Table to Accept

The setMaxRoutes() operation accepts a long parameter called, maxRoutes. As a default, the number of routes accepted by a VFR table is limited only by your system resources.

Netflow Accounting On State

The setNetflowAccountingOn() operation accepts a boolean parameter called, netflowAccountingOnState. The default is FALSE.

PE Port-reservation Group Only

The setPEPortReservationOnly() operation accepts a boolean parameter called, portReservationOnlyState. The default is FALSE.

Configuration Requirements

When using the APIs to either define or modify VPN connectivity to a CE, the following API features must be addressed for all VPN connections:

Required information for each of these service-request elements is supplied in the following subsections.

CE

Execute the setCE() operation to supply the CiscoVsmBrowser::VsmCE object that represents the CE to which VPN connectivity is to be supplied. The following pieces of information must also be supplied for the CE:

CE Interface—Execute the setCEInterface() operation to set the interface name of the CE to use for the PE-CE link.
CE Interface Type—Execute the setCEInterfaceType() operation to set the interface type—defined by the CiscoVsmBrowser::VsmInterfaceType enumerated type—for the CE.

In addition to these required settings, you can optionally set a:

CE Loopback Interface Requirement—Execute the setCELoopbackInterfaceRequired() operation to specify a requirement for a loopback interface on the CE.
CE as a Grey-management VPN Member—Execute setMemberGreyManagementVPN(TRUE) to specify that the CE router is to be added as a member of a grey-management VPN.
CE Routes to Other Customer Sites—Execute setRoutesToAllSites() to specify a list of routes to other customer sites that are to be reachable from the CE.
CE Template—Execute the setCETemplate() operation to specify a string of supplementary IOS commands with which to augment the basic configlet data for the CE.
CE Interface Template—Execute the setCEInterfaceTemplate() operation to specify a string of supplementary IOS commands with which to augment the basic configlet data for the physical interface on the CE.

There are also contingent requirements of the CE settings based on the configuration options you specify for the PE-CE link as described in the "Configuration Options" section. The following configuration settings apply to the CE as described:

CE Circuit Identifier—Execute the setCECircuitIdentifier() operation for Frame Relay, ISL, and ATM circuits to set the relevant circuit-identifier data for the CE.
CE Autonomous System Number—If BGP is to be used as the routing protocol—that is, the setPECERoutingProtocol(BGPRoutingType) operation is to execute—execute the setCEAutonomousSystem() operation to set the AS number associated with the CE.
CE Interface Address—If the setAutoPickAddress(FALSE) is to execute, execute the setCEInterfaceAddress() operation to set the interface address of the CE.
CE Loopback Interface Address—If both setCELoopbackInterfaceRequired(TRUE) and setAutoPickAddress(FALSE), execute the setCELoopbackInterfaceAddress() operation to set the loopback interface address for the CE.
CE Advertised Routes—If Static routing is specified as the routing protocol—that is, the setPECERoutingProtocol() operation is to execute with StaticRoutingType specified as input—execute the setCEAdvertisedRoutes() operation to set the routes to be advertised by the CE.
CE Redistributed Protocols—If either BGP or RIPv2 is to be used as the routing protocol—that is, the setPECERoutingProtocol() operation is to execute with either BGPRoutingType or RIPv2RoutingType specified as input—execute the setCERedistributedProtocols() operation to set the list of protocols to be redistributed from the CE.
CE OSPF Area—If OSPF is to be used as the routing protocol—that is, the setPECERoutingProtocol(OSPFRoutingType) operation is to execute—execute either the setCeOSPFArea() or setCeOSPFAreaAsIpAddress() operation to set the OSPF area as an IP address for the CE.
CE OSPF Process Identifier—If OSPF is to be used as the routing protocol—that is, the setPECERoutingProtocol(OSPFRoutingType) operation is to execute—execute the setCeOSPFProcessId() operation to set the OSPF process identifier on the CE.
Cable Modem Helper Address—If a cable modem is used as a CE is used, execute the setCableModemHelperAddress() operation to set a cable helper address to configure the PE interface through which to supply VPN connectivity to the cable modem.
Cable Modem Host Helper Address—If a cable modem is used as a CE is used, execute the setCableModemHostHelperAddress() operation to set a host helper address to configure the PE interface through which to supply VPN connectivity to the cable modem.
Cable Modem Secondary IP Address List—If a cable modem is used as a CE is used, execute the setCableModemSecondaryIpAddressList() operation to set a list of secondary IP addresses for use by the PE interface that is to supply VPN connectivity to the cable modem.
Cable Modem Maintenance Interface Requirement—If a cable modem is used as a CE is used and if a maintenance interface is required, execute the setCableModemMaintenanceInterface(TRUE) operation to specify that a maintenance subinterface is to be provisioned.
Cable Modem Maintenance Interface Helper Address—If a cable modem is used and a maintenance interface is required, execute the setCableModemMaintenanceInterfaceHelperAddress() operation to specify that a maintenance subinterface is to be provisioned.

PE

Execute the setPE() operation to supply the CiscoVsmBrowser::VsmPE object that represents the PE to which VPN connectivity is to be supplied. The following pieces of information must also be supplied for the PE:

PE Interface—Execute the setPEInterface() operation to set the interface name of the PE.
PE Interface Type—Execute the setPEInterfaceType() operation to set the interface type—defined by the CiscoVsmBrowser::VsmInterfaceType enumerated type—for the PE.

In addition to these required settings, you can optionally set a:

PE Interface Shutdown Requirement—Execute the setPEInterfaceShutdown() operation to instruct the provisioning system to issue a shutdown command for the PE interface.
Send Only Default Routes to CE—Execute setOnlyDefaultRouteSentToCE(TRUE) to instruct the PE to send only the default route to the CE.
PE Route Redistribution—Execute the setRedistributeConnectedRoutes(TRUE) and setRedistributeConnectedRoutes(TRUE) operation to indicate that connected and static routes, respectively, are to be redistributed for the PE.
PE Template—Execute the setPETemplate() operation to specify a string of supplementary IOS commands with which to augment the basic configlet data for the PE.
PE Interface Template—Execute the setPEInterfaceTemplate() operation to specify a string of supplementary IOS commands with which to augment the basic configlet data for the physical interface on the PE.

There are also contingent requirements of the PE settings based on the configuration options you specify for the PE-CE link as described in the "Configuration Options" section. The following configuration settings apply to the PE as described:

PE Circuit Identifier—Execute the setCECircuitIdentifier() operation for Frame Relay, ISL, and ATM circuits to set the relevant circuit-identifier data for the PE.
PE Interface Address—If the setAutoPickAddress(FALSE) is to execute, execute the setPEInterfaceAddress() operation to set the interface address of the PE.
PE OSPF Area—If OSPF is to be used as the routing protocol—that is, the setPECERoutingProtocol(OSPFRoutingType) operation is to execute—execute either the setPeOSPFArea() or setPeOSPFAreaAsIpAddress() operation to set the OSPF area as an IP address for the PE.
PE OSPF Process Identifier—If OSPF is to be used as the routing protocol—that is, the setPECERoutingProtocol(OSPFRoutingType) operation is to execute—execute the setPeOSPFProcessId() operation to set the OSPF process identifier on the PE.
PE Port Reservation—If this service request is for a PE port reservation only, execute the setPEPortReservationOnly(TRUE) operation. See the "PE Port Reservation" section.

Routing Protocol

For all service requests that add VPN connectivity to a CE, you must set a routing protocol for use by the PE-CE link to be configured by the SRVC. The chosen routing protocol conditionally affects the information required for the CE and PE. For example, if BGP is used for the PE-CE routing protocol, an autonomous system (AS) number is required for the CE. Use the setPECERoutingProtocol() operation to set the appropriate CiscoVsmBrowser::VsmPECELinkProtocolType constant.

Customer

Execute the setCustomer() operation to specify the customer for whom the VPN service is to be created. For more information about CERC memberships, see the "VPN Customer" section and the "CiscoVsmBrowser::VsmCustomer" section.

CERC Memberships

Execute the setCERCMemberships() operation to specify the CE routing communities to which the CE of the PE-CE pair is to be added. For more information about CERC memberships, see the "CERC Membership" section and the "CiscoVsmBrowser::VsmCERCMembership" section.

Class-of-Service Profile

Execute the setCosProfile() operation to specify the class-of-service (CoS) profile to use for policing and shaping traffic over the PE-CE link defined by the service request. For more information about CoS profiles, see the "Class-of-Service Profile" section and the "CiscoVsmBrowser::VsmCoSProfile" section.

VPN Routing and Forwarding Table

Execute the setVRFNameAndRD() operation to specify the name of the VRF table and the route-distinguisher (RD) value for the PE-CE link defined by the service request. For more information about CoS profiles, see the "VPN Routing/Forwarding Table Definition" section and the "CiscoVsmBrowser::VsmVRFDef" section.

State

Execute the setState() operation to set the initial state of the CiscoVsmBrowser::VsmSRVC object to be returned upon executing the addToRep() operation. For information regarding state progressions of service requests, see the Cisco VPN Solutions Center: MPLS Solution Provisioning and Operations Guide.

PE Port Reservation

This feature is not yet available.

Table of Contents

Defining Service Requests