VLAN service configuration

Workflow

The following workflow describes how to create a VLAN service.


1	Create a VLAN service.
2	Choose VLAN type and VLAN group.
3	Create a VLAN site.
4	Add an access interface.
5	For an OmniSwitch, and depending on the type of VLAN, create Ethernet service, service access multipoint, SAP, and customer VLANs. For separate requests, see Service configuration in General service configuration . Replace the service object with vlan.Vlan, replace the site object with vlan.Site, and replace the access interface object with vlan.L2AccessInterface. Use the proper distinguishedName for the object you are creating.

Examples

The following example outlines what is required for an XML request to create a VLAN service, site, and access interface in one request.

VLAN service creation parameters

method - generic.GenericObject.configureChildInstance
distinguishedName - svc-mgr. The FDN can be determined by looking at the Parent Hierarchy of the class to be created in the XML API Reference
childConfigInfo - creates and configures the following service parameters:
- Service object - vlan.Vlan
- actionMask - specifies the create operation
- <subscriberPointer> - assigns a subscriber. See the Parent Hierarchy of the class subscr.Subscriber for the FDN.
- <displayedName> - assign a service name
- <serviceId> - (optional) assigns a unique service ID. If the service ID is not specified, the NFM-P automatically assigns the ID.
- <groupPointer> - assigns a VLAN group. See the Parent Hierarchy of the class netw.VlanGroup for the FDN.
- <vlanSubType> - choose a VLAN type
- <children-Set> - tag to enclose children objects
  
       •   Site object - vlan.Site
  
       •   actionMask- specifies the create operation
  
       •   <siteId> - IP address of the NE
  
       •   <children-Set> - tag to enclose children objects
  
                    •   Access interface object - vlan.L2AccessInterface
  
                    •   <portPointer> - assign a port. See the Parent Hierarchy of the port or                         channel object such as equipment.PhysicalPort for the FDN.
  
                    •   If applicable, depending on the VLAN type, configure an Ethernet                        service instead of an access interface: Ethernet service object -                        vlan.EthernetService.
  
                    •   actionMask - specifies the create operation
  
                    •   <ethernetServiceName> - assigns an Ethernet service name
  
                    •   <children-Set> - tag to enclose children objects
  
                               •   Service access multipoint object -                                    vlan.ServiceAccessMultipoint
  
                               •   <children-Set> - tag to enclose children objects
  
                                            •   Customer VLAN object - vlan.CustomerVlan
  
                                            •   Service access point object -                                                  vlan.ServiceAccessPoint
  
                                            •   <portPointer> - assigns a port. See the Parent                                                 Hierarchy of the port or channel object such as                                                 equipment.PhysicalPort for the FDN.

Figure 19-19: VLAN service creation request example

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

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

   <distinguishedName>svc-mgr</distinguishedName>

   <childConfigInfo>

      <vlan.Vlan>

         <actionMask>

            <bit>create</bit>

         </actionMask>

         <vlanSubType>tlsVlan</vlanSubType>

         <serviceId/>

         <subscriberPointer/>

         <groupPointer>group:tree:name</groupPointer>

         <children-Set>

            <vlan.Site>

               <actionMask>

                  <bit>create</bit>

               </actionMask>

               <siteId/>

               <children-Set>

                  <vlan.EthernetService>

                     <actionMask>

                        <bit>create</bit>

                     </actionMask>

                     <ethernetServiceName/>

                     <children-Set>

                        <vlan.ServiceAccessMultiPoint>

                           <actionMask>

                              <bit>create</bit>

                           </actionMask>

                           <sapProfilePointer>Ethernet Service SAP Policy:default-sap-profile</sapProfilePointer>

                           <children-Set>

                              <vlan.ServiceAccessPoint>

                                 <actionMask>

                                    <bit>create</bit>

                                 </actionMask>

                                 <portPointer/>

                              </vlan.ServiceAccessPoint>

                              <vlan.CustomerVlan>

                                 <actionMask>

                                    <bit>create</bit>

                                 </actionMask>

                              </vlan.CustomerVlan>

                           </children-Set>

                        </vlan.ServiceAccessMultiPoint>

                     </children-Set>

                  </vlan.EthernetService>

               </children-Set>

            </vlan.Site>

         </children-Set>

      </vlan.Vlan>

   </childConfigInfo>

</generic.GenericObject.configureChildInstance>