SAP configuration

Overview

Each customer service is configured with at least one SAP. The access interface identifies the point of customer interface for a service on the managed device.

The XML API allows you to create and manage service access interfaces by using the classes specified in the following table.

Table 19-5: SAP objects

Service type	Package and class
Apipe	vll.L2AccessInterface, mpr.AL2AccessInterface (for Wavence only)
Epipe	vll.L2AccessInterface, mpr.EL2AccessInterface (for Wavence only)
Fpipe	vll.L2AccessInterface
Ipipe	ipipe.L2AccessInterface
Cpipe	vll.L2AccessInterface, mpr.L2AccessInterface (for Wavence only)
Hpipe	vll.L2AccessInterface
VPLS, MVPLS, PBB	vpls.L2AccessInterface, vpls.BL2AccessInterface, vpls.IL2AccessInterface, mvpls.L2AccessInterface, mvpls.BL2AccessInterface, mvpls.IL2AccessInterface
IES	ies.L3AccessInterface
VPRN	vprn.L3AccessInterface

The following example shows the minimum XML parameter tags required to develop an XML request to create a basic service access interface.

The genericObject.configureChildInstance method is used in the XML request to create a SAP. The XML response returns the <objectFullName> parameter that can be used to identify the new SAP.

Service access interface creation parameters

method - generic.GenericObject.configureChildInstance
distinguishedName - svc-mgr:service-${*id}:${siteId}
childConfigInfo - creates and configures the following SAP interface parameters:
- Service object - see Table 19-5, SAP objects
- actionMask - specifies the create operation
- <portPointer> - assigns an access port
- <innerEncapValue>/<outerEncapValue> - assigns encapsulation values
  
  • To configure an IP address for an IES or VPRN service, the rtr.VirtualRouterIpAddress class properties must be configured. This class is the child class of the ies.L3AccessInterface or vprn.L3AccessInterface and must be enclosed using the <children-Set> tags.
  
  • <ipAddress> - assigns an IP address

Figure 19-7: SAP creation request example

<generic.GenericObject.configureChildInstance xmlns="xmlapi_1.0">

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

   <distinguishedName>svc-mgr:service-620: 198.51.100.198</distinguishedName>

   <childConfigInfo>

      <vll.L2AccessInterface>

         <actionMask>

            <bit>create</bit>

         </actionMask>

         <portPointer>network:198.51.100.234:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-7</portPointer>

         <innerEncapValue>0</innerEncapValue>

         <outerEncapValue>3001</outerEncapValue>

..

      </vll.L2AccessInterface>

   </childConfigInfo>

</generic.GenericObject.configureChildInstance>

See the XML API Reference and Schema Reference for more information about classes, properties, and methods to create the desired service access interfaces.

Use subject to agreed restrictions on disclosure and use.