Modifying service configuration

Overview

The following are the requirements for an XML request to modify a VPLS, site, access interface, and SDP binding separately. This method can be used for other types of services. The find method can be used to retrieve the FDN of the object. See Chapter 13, Inventory management for more information about the find method.

Service modification parameters

• method - generic.GenericObject.configureInstance

• distinguishedName - determined by the Parent Hierarchy of the class to be created in the XML API Reference

  • for a service - svc-mgr:service-${*id}

  • for a site - svc-mgr:service-${*id}:${siteId}

  • for an access interface - svc-mgr:service-${*id}:${siteId}:interface-${portPointer}-inner-tag-${innerEncapValue}-outer-tag-${outerEncapValue}

  • for an SDP binding- svc-mgr:service-${*id}:${siteId}:circuit-${pathId}-${vcId}

• configInfo - creates and configures the following service parameters:

  • Service object:

        •  For a service - vpls.Vpls

        •  For a site - vpls.Site

        •  For an access interface- vpls.L2AccessInterface

        •  For an SDP binding- svt.MeshSdpBinding or svt.SpokeSdpBinding

  • actionMask - specifies the modify operation

  • properties that are modifiable

The following request modifies properties in a VPLS. For other service objects, replace the value in the <distinguishedName> and use the appropriate service object. For example, to modify a site, use the following:

<distinguishedName>svc-mgr:service-123:198.51.100.55</distinguishedName>

• where <vpls.Site> and </vpls.Site> are in the positions of the <vpls.Vpls> and </vpls.Vpls> respectively.

Figure 19-11: VPLS modification request example

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

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

   <distinguishedName>svc-mgr:service-123</distinguishedName>

   <configInfo>

      <vpls.Vpls>

         <actionMask>

            <bit>modify</bit>

         </actionMask>

          Properties to modify

          ..

      </vpls.Vpls>

   </configInfo>

</generic.GenericObject.configureInstance>

The following example outlines what is required for an XML request to modify a VPLS service, site, access interface, and SDP binding in one request. This method can be used for other types of services.

Service modification parameters

• method - generic.GenericObject.configureInstance

• distinguishedName - svc-mgr:service-${*id}. The FDN is determined by the Parent Hierarchy of the class to be created in the XML API Reference

• configInfo - creates and configures the following service parameters:

  • Service object - vpls.Vpls

  • actionMask - specifies the modify operation

  • Properties that are modifiable

  • <children-Set> - tag to enclose children objects

        •   Site object - vpls.Site

        •   actionMask - specifies the modify operation

        •   <objectFullName>- svc-mgr:service-${*id}:${siteId}

        •   Properties that are modifiable

        •   <children-Set> - tag to enclose children objects

                 •   SDP binding object- svt.MeshSdpBinding

                 •   <objectFullName>- svc-mgr:service-${*id}:${siteId}:circuit-${pathId}-${vcId}

                 •   Properties that are modifiable

                 •   Access interface - vpls.L2AccessInterface

                 •   <objectFullName>- svc-mgr:service-${*id}:${siteId}:interface-${portPointer}-inner-tag-${innerEncapValue}-outer-tag-${outerEncapValue}

                •   Properties that are modifiable

Figure 19-12: Multiple service object modification request example

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

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

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

   <configInfo>

      <vpls.Vpls>

         <actionMask>

            <bit>modify</bit>

         </actionMask>

          Properties to modify

          ..           

         <children-Set>

            <vpls.Site>

               <actionMask>

                  <bit>modify</bit>

               </actionMask>

               <objectFullName>svc-mgr:service-620:198.51.100.198</object

FullName>

                Properties to modify

                ..

               <children-Set>

                  <svt.MeshSdpBinding>

                     <actionMask>

                        <bit>modify</bit>

                     </actionMask>

                     <objectFullName>svc-mgr:service-620:198.51.100.198:circuit-1-10</objectFullName>

                    Properties to modify

                    ..               

                  </svt.MeshSdpBinding>

                  <vpls.L2AccessInterface>

                     <actionMask>

                        <bit>modify</bit>

                     </actionMask>                                                    

                     <objectFullName>svc-mgr:service-620: 198.51.100.198: interface-1/1/4-inner-tag-0-outer-tag-95</objectFullName>

                    Properties to modify

                    ..                                                        

                  </vpls.L2AccessInterface>

               </children-Set>

            </vpls.Site>

         </children-Set>

      </vpls.Vpls>

   </configInfo>

</generic.GenericObject.configureInstance>