Composite service configuration

Workflow

The XML API uses the service.CompositeServiceManager (comp-svc-mgr) class to manage composite services. The following workflow describes how to create a composite service.


1	Create a composite service.
2	Add service components (such as an Epipe and a VPLS) to the composite service.
3	Create connectors to link the service components.

Examples

The following example outlines what is required for an XML request to create a composite service. One type of composite service is a VLL such as an Epipe spoke into a VPLS service.

The generic.GenericObject.configureInstance method is used to create the composite service. The service.CompositeService class contains methods to add or create service components to the composite service, and methods to create connectors for the service components in the composite service. See the XML API Reference for information about these methods and the required input parameters.

Composite service creation parameters

method - generic.GenericObject.configureInstance
distinguishedName - comp-svc-mgr. The FDN can be determined by looking at the Parent Hierarchy of the class to be created in the XML API Reference
configInfo - creates and configures the following service parameters:
- Service object - service.CompositeService
- actionMask - specifies the create operation
- <compositeSvcId> - assigns a unique composite service ID.

Figure 19-21: Composite service creation request example

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

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

   <distinguishedName>comp-svc-mgr</distinguishedName>

   <configInfo>

      <service.CompositeService>

         <actionMask>

            <bit>create</bit>

         </actionMask>

         <compositeSvcId/>

      </service.CompositeService>

   </configInfo>

</generic.GenericObject.configureInstance>

Composite service add service parameters

method - service.CompositeService.addServices
instanceFullName - comp-svc-mgr:cmp-service-${*id}. The FDN can be determined by looking at the Parent Hierarchy of the class to be created in the XML API Reference
alnFdns - pointers to the services to be added
- <pointer> - svc-mgr:service-${*id} - add one for each service

Figure 19-22: Composite service addition request example

<service.CompositeService.addServices xmlns="xmlapi_1.0">

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

   <instanceFullName>comp-svc-mgr:cmp-service-1002</instanceFullName>

   <aInFdns>

      <pointer>svc-mgr:service-84</pointer>

      <pointer>svc-mgr:service-87</pointer>

   </aInFdns>

</service.CompositeService.addServices>

Composite service connector parameters

method - see Table 19-8, Composite service connector methods and objects
instanceFullName - comp-svc-mgr:cmp-service-${*id}. The FDN can be determined by looking at the Parent Hierarchy of the class to be created in the XML API Reference
Configuration input parameter - see Table 19-8, Composite service connector methods and objects
- Connector object - see Table 19-8, Composite service connector methods and objects
- Other properties to be configured depend on the connector type. The sample in Figure 19-23, Composite service SCP connector creation request example is for a SCP connector.

Table 19-8: Composite service connector methods and objects

Connector type	Method (service.CompositeService.method)	Configuration parameter	Connector object
SCP	createScpConnector	configInfoConnector	service.ScpConnector
Spoke	createSpokeConnector	cfgSpokeConnector	service.SpokeConnector
Cross-connect	createCrossConnect	cfgCrossConnect	service.CrossConnect
Routed VPLS	createRoutedVplsConnector	cfgRoutedVplsConnector	service.RoutedVplsConnector

Figure 19-23: Composite service SCP connector creation request example

<service.CompositeService.createScpConnector xmlns="xmlapi_1.0">

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

   <instanceFullName>comp-svc-mgr:cmp-service-1002</instanceFullName>

   <configInfoConnector>

      <actionMask>

         <bit>create</bit>

      </actionMask>

      <displayedName>abcdef</displayedName>

      <firstSvcPointer>svc-mgr:service-serviceIdA</firstSvcPointer>

      <secondSvcPointer>svc-mgr:service-serviceIdB</secondSvcPointer>

      <firstSitePointer>svc-mgr:service-serviceIdA:siteIdA</firstSitePointer>

      <secondSitePointer>svc-mgr:service-serviceIdB:siteIdB</secondSitePointer>

      <firstScpPointer>svc-mgr:service-serviceIdA:siteIdA:interface-portAandEncapValues</firstScpPointer>

      <secondScpPointer>svc-mgr:service-serviceIdB:siteIdB:interface-portBandEncapValues</secondScpPointer>

   </configInfoConnector>

</service.CompositeService.createScpConnector>