Operation

post /esmService/MCLAG/abortMclag
Aborts MC-Lag Operation (abortMclag : /esmService/MCLAG/abortMclag)
This operation can be used when a MCLAG is stuck in Deploying or Modifying state.

State transition :
Deploying -> Deploy Failed
OR
Modifying -> Modify Failed

ie., Used to bring the MCLAG back to a non-transient state when its stuck in a transient state. This will mark all the In-progress commands and tasks as Aborted. After marking the commands as Aborted if SNA sends a response, such a response will be dropped by ESM.
It will also mark the management state of the MCLAG as Modify-Failed, if it were stuck in Modifying, will mark it as Deploy-Failed if it were stuck in Deploying. This is not a scheduled operation.

Request body

Name

IsRequired

Description

Data Type

Enum

body required MC-Lag data N_MCLagIdHolder ---

Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>3</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>51</mclagConfigHandle> <mclagConfigName>Vlan-MCLAG</mclagConfigName> <managementState>Deploying</managementState> </req> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <errorCode/> <errorReason/> <message/> <msgCode>MCLAG_ABORT_SUCCESS_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>Vlan-MCLAG</parameters> </responseId> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/allocateMclag
    Allocates a MC-Lag (allocateMCLAG : /esmService/MCLAG/allocateMclag)
    This operation is used to create a MCLAG in ESM in Allocated state.

    State transition :
    New -> Allocated

    When a MCLAG instance is in Allocated management state, its existence will be only in ESM.It Will create a new MCLAG instance in ESM with the unique name given by user.

    Validation:
    1. MCLAG name should be unique. If not, validation error will be thrown.
    2. System attributes i.e. system id, system priority and lacp key should be unique. If not, validation error will be thrown.

    In case of any validation error, MCLAG entities will not be saved in ESM DB.

    While creating the MCLAG instance in ESM, the details of the following entities will also be saved in ESM database:
    1.MCLAG instance ( MCLAG config)
    2.MCLAG Source
    3.MCLAG Peer
    4.MCLAG Peer-LAG association

    Creating a MCLAG in allocated state is not a scheduled operation.
    Once the MCLAG is created in allocated state in ESM, it can be seen/operated on from the Operate -> MCLAG.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolderModel
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolderModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLAGInstHolder> <req> <reqId> <clientName/> <reqId>9</reqId> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </req> <scheduler> <jobName>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </MCLAGInstHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLAGDataRespHolder> <response> <reqId> <reqId>9</reqId> <clientName/> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_CREATE_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclag1</parameters> </responseId> </MCLAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/dbDeleteMclag
    DB deletes a MC-Lag (dbDeleteMclag : /esmService/MCLAG/dbDeleteMclag)
    This operation can be used to clean up a MCLAG and its associated entities from ESM database. However,the entities that are already deployed on the NE will remain as it is on the NE.

    State transition :
    Commissioned/Deploy-Failed/Modify-Failed -> DB Deleted

    Once the DB deleted operation is performed user is expected to trigger network discovery operation or ethernet sycn operation on all the involved NEs.
    This will make sure all the entities present in NE are synced up in ESM and there is no ID conflict during subsequent deployment operations.

    If user has done DB delete of a Consistent MCLAG, Network discovery will discover this MCLAG back.If the service is not discovered after network discovery, user can refer to Network discovery job list to know about the entities that are missing/mismatch.
    This is not a scheduled operation.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>9</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>51</mclagConfigHandle> <mclagConfigName>Vlan-MCLAG</mclagConfigName> <managementState>Commissioned</managementState> </req> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <errorCode/> <errorReason/> <message/> <msgCode>MCLAG_DB_DELETE_SUCCESS_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>Vlan-MCLAG</parameters> </responseId> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/deleteMclag
    Deletes a MC-lag (deleteMclag : /esmService/MCLAG/deleteMclag)
    This operation can be used to clean up a MCLAG in allocated state.

    State transition :
    Allocated -> Deleted

    This can be triggered only on Allocated MCLAG and will delete the MCLAG instance,all its associations from ESM.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>5</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>100</mclagConfigHandle> <mclagConfigName>mclagDeployTest</mclagConfigName> <managementState>Allocated</managementState> </req> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <errorCode/> <errorReason/> <message/> <msgCode>MCLAG_DELETE_SUCCESS_PLANNEDALLOCATE_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclagDeployTest</parameters> </responseId> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/modifySaveMclagInstance
    modifySaveMclagInstance (modifySaveMCLAG : /esmService/MCLAG/modifySaveMclagInstance)
    This operation is used to modify a MCLAG instance in Allocated and Commissioned management states.

    State transition :
    Allocated -> Allocated
    Commissioned -> Commissioned( remark will be updated)

    The MCLAG attributes, its Peer, Source and other details can be modified and saved in the Allocated / Commissioned states using this rest-API. For commissioned MCLAGs, the remark will get updated. Command will not be sent to NE in this operation and will only update the entities present in ESM DB with it's new values. (scheduledModifyMCLAG will be used for deploying the new values on NE).

    The validation done for allocateMCLAG will be done again for allocated MCLAGS during this operation.

    Important parameters that can be modified on a MCLAG in Allocated state are :
    1.MCLAG description
    2.Author
    3.Hold On Neighbour Failure Multiplier
    4.Keep Alive Interval
    5.ERP
    6.CVLAN
    7.SVLAN
    8.Customer
    9.LAGs and
    10.system attributes(system priority, system key and LACP key)
    11.CLI
    12. OAM Configured

    Important parameters that can be modified on a MCLAG in Commissioned state are :
    1.Description
    2.Author
    3.Lags
    4.CLI
    5.OAM Configured

    All this updated values will be saved in ESM.


    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolderModel
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolderModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLAGInstHolder> <req> <reqId> <clientName/> <reqId>9</reqId> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </req> <scheduler> <jobName>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </MCLAGInstHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLAGDataRespHolder> <response> <reqId> <reqId>9</reqId> <clientName/> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_MODIFY_SUCCESS_003</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclag1</parameters> </responseId> </MCLAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/allocateToDeployMCLAG
    allocateToDeployMCLAG (scheduleAllocateToDeployMCLAG : /esmService/MCLAG/allocateToDeployMCLAG)
    This operation is used to deploy a MCLAG on the involved NEs.

    State transition :
    Allocated -> Commissioned/Deploy-Failed

    It is almost same as scheduledDeployMCLAG operation (refer to scheduledDeployMCLAG API). The only difference is the management state from which the operation is started is Allocated

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolderModel
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolderModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLAGInstHolder> <req> <reqId> <clientName/> <reqId>9</reqId> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </req> <scheduler> <jobName>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </MCLAGInstHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLAGDataRespHolder> <response> <reqId> <reqId>9</reqId> <clientName/> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_CREATE_SUCCESS_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclag1</parameters> </responseId> </MCLAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/schedForceCompleteMCLAG
    Force complete a modify failed MC-Lag (scheduleForceCompleteMCLAGInstance : /esmService/MCLAG/schedForceCompleteMCLAG)
    This is a Best-Effort operation, which retries the modification operation and can be triggered only on a Modify-Failed MCLAG. Force complete will mark MCLAG as commissioned even on modification failure on NE or in ESM.

    State transition :
    Modify-Failed -> Commissioned

    This is a scheduled operation in ESM. The user can choose to force complete a MCLAG for a future time or do it right away. Even if the modification operation is failed, this operation will mark the MCLAG as Commissioned, but with a remark "Best effort: force complete".

    When a MCLAG is in Modify failed state, move back to Allocate or delete operations will not be enabled. In order to cleanup the MCLAG entities, the MCLAG should be in Commissioned or Deploy-Failed state. This operation can be used to mark it as Commissioned even though modification is failure, so that user can cleanup the MCLAG from Commissioned state.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>9</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>51</mclagConfigHandle> <mclagConfigName>Vlan-MCLAG</mclagConfigName> <managementState>Commissioned</managementState> </req> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <errorCode/> <errorReason/> <message/> <msgCode>LAG_SCHED_FORCE_COMPLETE_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>Vlan-MCLAG</parameters> </responseId> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledActivateMCLag
    Activate a MC-Lag (scheduledActivateMCLag : /esmService/MCLAG/scheduledActivateMCLag)
    This operation is used to bring up the admin states of all the involved entities, and thus marking the MCLAG service state and peer admin state of the MCLAG instance as In-Service.

    This can be performed on Commissioned MCLAG with Service state "Out of service" only and is an operation which impacts traffic flow.

    State transition :
    Commissioned (Service state : Out of Service, Peer Service state : Out of Service) -> Commissioned(Service state : In Service, Peer Service state : In Service)

    This is a scheduled operation in ESM. User can choose to activate a MCLAG for a future time or activate it right away and it creates the commands and sends the commands to NE(SNA) to mark the admin state of the entities as Up.

    The commands will be send for the following entities to bring up the admin state in the following order :
    Peer Service state
    MCLAG Service state

    If all the commands are successful, the mclag service-state and peer service state of the corresponding MCLAG instance will be marked as In Service, and the MCLAG will remain in Commissioned management state.
    If there is any failure, user can refer to the corresponding job details, for the failure reason and the entity on which there is failure.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>5</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>100</mclagConfigHandle> <mclagConfigName>mclagDeployTest</mclagConfigName> <managementState>Commissioned</managementState> </req> <scheduler> <jobName>MC-LAG_mclagDeployTest_Fri Jan 15 2016 17:46:39 IST</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_mclagDeployTest_Fri Jan 15 2016 17:46:39 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_ACTIVATE_SUCCESS_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclagDeployTest</parameters> </responseId> <rsp> <jobTaskId>0</jobTaskId> <managementState>Commissioned</managementState> <mclagConfigHandle>100</mclagConfigHandle> <mclagConfigName>mclagDeployTest</mclagConfigName> </rsp> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledBackToAllocateMCLag
    Move MC-Lag back to allocated state (scheduledBackToAllocateMCLag : /esmService/MCLAG/scheduledBackToAllocateMCLag)
    This operation is used to cleanup/delete all the entities created on the NEs for a given MCLAG and can be performed on both Commissioned and Deploy Failed MCLAGs.

    State transition :
    Commissioned -> Allocated
    OR
    Deploy Failed -> Allocated

    This operation will refer to ESM database to find all the entities created on the NE for the MCLAG instance on which operation is being invoked. This is a scheduled operation in ESM. User can choose to move back to allocate a MCLAG for a future time or move back to allocate it right away.

    Creates the commands and sends the commands to NE(SNA) to delete these entities. First MCLAG deactivation commands will be send for all the involved entities.

    The commands will be send in the following order :
    MCLAG Deactivation ( peer service state and mclag service state will be brought down)
    MCLAG Peer LAG Disassociation ( Lag will be disassociated to MCLAG)
    MCLAG Peer deletion
    MCLAG Source deletion
    SAP Deactivation and Deletion
    VPLS Deactivation and Deletion

    All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
    If all the commands executed are successful, ESM will delete elementary records from its database and the MCLAG will be marked as Allocated.
    If any of the commands have failed, the MCLAG will be marked Deploy-Failed(only the elementary database records for successful commands will be removed from ESM database).

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>9</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>100</mclagConfigHandle> <mclagConfigName>mclagDeployTest</mclagConfigName> <managementState>Commissioned</managementState> </req> <scheduler> <jobName>MC-LAG_mclagDeployTest_Fri Jan 15 2016 17:51:18 IST</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_mclagDeployTest_Fri Jan 15 2016 17:51:18 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_BACKTOALLOCATE_SUCCESS_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclagDeployTest</parameters> </responseId> <rsp> <jobTaskId>0</jobTaskId> <managementState>Commissioned</managementState> <mclagConfigHandle>100</mclagConfigHandle> <mclagConfigName>mclagDeployTest</mclagConfigName> <targetManagementState>Allocated</targetManagementState> </rsp> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledDeactivateMCLag
    De-Activate a MC-Lag (scheduledDeactivateMCLag : /esmService/MCLAG/scheduledDeactivateMCLag)
    This operation is used to deactivate MCLAG in ESM and on the involved NEs and to bring down the admin states of all the involved entities,thus marking the service state and peer admin state of the MCLAG instance as out of service.

    It can be performed on Commissioned MCLAGs with Service state "In Service" only and is an operation which impacts traffic flow.

    State transition :
    Commissioned (Service state : In Service, Peer Service state : In Service) -> Commissioned(Service state : Out of Service, Peer Service state : Out of Service)

    This is a scheduled operation in ESM. User can choose to deactivate a MCLAG for a future time or deactivate it right away. Creates the commands and sends the commands to NE(SNA) to mark the admin state of the entities as Down.

    The commands will be sent for the following entities to bring down the admin state in the order :
    Peer Service state
    MCLAG Service state

    If all the commands are successful, the mclag service-state and peer service state of the corresponding MCLAG instance will be marked as Out Of Service, and the MCLAG will remain in Commissioned management state.
    If there is any failure, user can refer to the corresponding job details, for the failure reason and the entity on which there is failure.


    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>3</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>100</mclagConfigHandle> <mclagConfigName>mclagDeployTest</mclagConfigName> <managementState>Commissioned</managementState> </req> <scheduler> <jobName>MC-LAG_mclagDeployTest_Fri Jan 15 2016 17:43:46 IST</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_mclagDeployTest_Fri Jan 15 2016 17:43:46 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_DEACTIVATE_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclagDeployTest</parameters> </responseId> <rsp> <jobTaskId>0</jobTaskId> <managementState>Commissioned</managementState> <mclagConfigHandle>100</mclagConfigHandle> <mclagConfigName>mclagDeployTest</mclagConfigName> </rsp> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledDeleteMCLag
    Delete a Deploy Failed MC-Lag (scheduledDeleteMCLag : /esmService/MCLAG/scheduledDeleteMCLag)
    This operation is used to cleanup/delete all the entities created on the NEs for a given MCLAG first and then delete the MCLAG instance from ESM as well. Applicable only to Deploy Failed management state. Internally does deactivate and delete for the involved entities.

    State transition :
    Deploy Failed -> Deleted

    The operation is almost same as move back to allocate operation(refer to scheduledBackToAllocateMCLag), except that it also deletes the MCLAG instance from ESM and is a scheduled operation in ESM. User can choose to delete a MCLAG for a future time or delete it right away.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLagIdHolder> <reqId> <reqId>9</reqId> <clientName>testUser</clientName> </reqId> <req> <mclagConfigHandle>51</mclagConfigHandle> <mclagConfigName>Vlan-MCLAG</mclagConfigName> <managementState>Commissioned</managementState> </req> </MCLagIdHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <errorCode/> <errorReason/> <message/> <msgCode>MCLAG_DELETE_SUCCESS_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>Vlan-MCLAG</parameters> </responseId> </MCLagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/deployMclag
    deployMclag (scheduledDeployMCLAG : /esmService/MCLAG/deployMclag)
    This operation is used to deploy a MCLAG in ESM and on the involved NEs.

    State transition :
    New -> Allocate
    Allocated -> Commissioned/Deploy-Failed

    It will first save the MCLAG instance in allocated state in ESM and is a scheduled operation in ESM. User can choose to deploy a MCLAG for a future time or deploy it right away. The MCLAG will be deployed from Allocated state at the scheduled time.

    It Persists all the elementary entities required (direct mapping with entities on the NE) in ESM database. When the commands are being created and deployed, MCLAG will be moved to a transient management state Deploying. It Generates the commands to be deployed on the NE (will be logged in ESM job list).

    The entities that will be created/updated on the NE during a MCLAG deployment are (in order):
    PRE CLI commands(if provided)
    VPLS, customer creation and association(Enabling MCLAG binding on the created VPLS)
    VPLS activation
    MCLAG Source creation
    MCLAG Peer creation
    MCLAG Peer Lag Association
    POST CLI commands(if provided)
    OAM MD MA and MEP creation (if Oam is configured)

    All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
    If all the commands created are successful(all entities are successfully created on the NE), ESM will mark the MCLAG in Commissioned management state.
    If any of the commands are failed(except POST CLI which are best effort commands), ESM will mark the MCLAG in Deploy-Failed management state.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolderModel
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolderModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLAGInstHolder> <req> <reqId> <clientName/> <reqId>4</reqId> </reqId> <mcLagName>UnProtectedMclag</mcLagName> <description/> <author>alcatel</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-5</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>UnProtectedMclag</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>false</isControlServiceProtected> <erpName>SETUP-4V1-N/11QCE12X-1-4-M1/11QCE12X-1-5-M1/OS</erpName> <cvLan>2011</cvLan> <svLan>2011</svLan> <customer>Customer1</customer> <vsOperationalMode>Provider Bridge</vsOperationalMode> <vplsName>UnProtectedMclag</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-5</packName> </neNamePackName> <peerList> <description/> <peerName>A</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description/> <peerName>B</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:00:00:01</systemId> <systemPriority>1</systemPriority> <adminKey>1</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG4</lag1Name> <lag2Name>LAG2</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-5</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>A</peer1Name> <peer2Name>B</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </req> <scheduler> <jobName>MC-LAG_UnProtectedMcla_Tue Dec 27 2016 14:25:25 UTC+5:30</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_UnProtectedMcla_Tue Dec 27 2016 14:25:25 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> <oam> <templateName/> <mdLevel>4</mdLevel> <mdFormat>NONE</mdFormat> <maInst> <maName>OAMmcl1130</maName> <maFormat>ITU-ICC</maFormat> <ccmInterval>1s</ccmInterval> <mhfCreation>0</mhfCreation> <mep> <upDirectionally>false</upDirectionally> <interfaceType>SAP</interfaceType> <active>true</active> <controlMepEnabled>false</controlMepEnabled> <lowestPriorityDeffect>MAC, Remote, Error, Xcon</lowestPriorityDeffect> <ccm> <ccmEnabled>true</ccmEnabled> <priority>7</priority> </ccm> <ais> <aisEnabled>false</aisEnabled> <interval>60</interval> <priority>7</priority> <aisLevels/> </ais> </mep> <remoteMepInstList/> </maInst> </oam> <oamConfigured>true</oamConfigured> </MCLAGInstHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLAGDataRespHolder> <response> <reqId> <reqId>9</reqId> <clientName/> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_CREATE_SUCCESS_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclag1</parameters> </responseId> </MCLAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/schedModifyMCLAG
    schedModifyMCLAG (scheduledModifyMCLAG : /esmService/MCLAG/schedModifyMCLAG)
    This operation is used to modify the MCLAG in Commissioned and Modify-Failed management states.

    State transition :
    Commissioned -> Commissioned
    OR
    Modify Failed -> Commissioned

    Some validations will be performed by ESM for this request. This operation will first update the ESM database with the changes done on the MCLAG by user, updates the servcie remarks and then it deploys the changes to the NE, and clears the remarks when the operation is successful. When the commands are being created and deployed, MCLAG will be moved to a transient management state Modifying.

    The modification is allowed for the following entities using this operation :
    1.Author(not propagated to NE)
    2.PRE and post CLI commands

    All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
    If all the commands executed are successful, the MCLAG will be marked Commissioned.
    If any of the commands deployed to NE are failed MCLAG will be marked as Modify-Failed and remarks will not be cleared.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required MC-Lag Data MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolderModel
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolderModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    <MCLAGInstHolder> <req> <reqId> <clientName/> <reqId>9</reqId> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </req> <scheduler> <jobName>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30</jobName> <jobDescription/> <username/> <trigger> <name>MC-LAG_mclag1_Thu Jul 07 2016 12:39:36 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </MCLAGInstHolder>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <MCLAGDataRespHolder> <response> <reqId> <reqId>9</reqId> <clientName/> </reqId> <mcLagName>mclag1</mcLagName> <description/> <author>test</author> <configurationType>VConfig</configurationType> <neNamePackNames> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackNames> <neNamePackNames> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackNames> <controlServiceName>mclag1</controlServiceName> <isBindingEnabled>true</isBindingEnabled> <isControlServiceProtected>true</isControlServiceProtected> <erpName>ring4</erpName> <cvLan>112</cvLan> <svLan>112</svLan> <customer>DiscoveredCustomer2</customer> <vplsName>mclag1</vplsName> <peers> <keepAliveInterval>10</keepAliveInterval> <neighborFailureMultiplier>3</neighborFailureMultiplier> <peerData> <neNamePackName> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </neNamePackName> <peerList> <description>d1</description> <peerName>p1</peerName> </peerList> </peerData> <peerData> <neNamePackName> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </neNamePackName> <peerList> <description>d2</description> <peerName>p2</peerName> </peerList> </peerData> </peers> <systemId>00:00:00:11:21:12</systemId> <systemPriority>112</systemPriority> <adminKey>112</adminKey> <flushEthernetRingEnabled>false</flushEthernetRingEnabled> <peerLagData> <lag1Name>LAG1</lag1Name> <lag2Name>LAG1</lag2Name> <lagEncapType>NULL</lagEncapType> <lagRate>1x1GbE</lagRate> <nePack1> <neName>SETUP-4V1-K</neName> <packName>11QPE24-2-7</packName> </nePack1> <nePack2> <neName>SETUP-4V1-N</neName> <packName>11QCE12X-1-4</packName> </nePack2> <peer1Name>p1</peer1Name> <peer2Name>p2</peer2Name> </peerLagData> <preCliCommand/> <postCliCommand/> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>MCLAG_SCHED_MODIFY_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>mclag1</parameters> </responseId> </MCLAGDataRespHolder>

    External Docs
    See Also :

    ElementaryMep

    Name

    Type

    Description

    Enum

    mepId Integer integer --- ---
    maId Integer integer --- ---
    mdId Integer integer --- ---
    vsId Integer integer --- ---
    macAddress String string --- ---
    neName String string --- ---

    eOAMRemoteMepInst

    Name

    Type

    Description

    Enum

    vsId Integer integer --- ---
    eMaId Integer integer --- ---
    eMdId Integer integer --- ---
    remoteMep array[Integer] integer --- ---

    EsmOAMDataModel

    Name

    Type

    Description

    Enum

    templateName String string OAM template name ---
    mdLevel Integer integer OAM maintenance domain level [0, 1, 2, 3, 4, 5, 6, 7]
    mdFormat String string OAM maintenance domain format [NONE]
    mdName String string OAM maintenance domain name [NONE]
    maInst EsmOamMADataModel EsmOamMADataModel OAM maintenance association wrapper ---
    slmTsData nTestSuiteTempData nTestSuiteTempData --- ---
    dmTsData nTestSuiteTempData nTestSuiteTempData --- ---
    elementaryMepList array[ElementaryMep] ElementaryMep OAM maintenance end point wrapper ---

    EsmOamMADataModel

    Name

    Type

    Description

    Enum

    remoteMepInstList array[eOAMRemoteMepInst] eOAMRemoteMepInst --- ---
    maName String string MA name ---
    maFormat String string MA format [ITU-ICC]
    ccmInterval String string CCM interval for the MA ---
    mhfCreation String string MHF Creation to be supported ---
    mep EsmOamMEPDataModel EsmOamMEPDataModel OAM maintenance end point wrapper ---
    remteMepList array[eOAMRemoteMepInst] eOAMRemoteMepInst --- ---

    EsmOamMEPAISDataModel

    Name

    Type

    Description

    Enum

    aisEnabled Boolean boolean AIS Enabled ---
    interval Integer integer AIS Interval [1, 60]
    priority Integer integer AIS priority [0, 1, 2, 3, 4, 5, 6, 7]
    levels array[Integer] integer AIS levels list ---

    EsmOamMEPCCMDataModel

    Name

    Type

    Description

    Enum

    ccmEnabled Boolean boolean CCM Enabled ---
    priority Integer integer CCM Priority [0, 1, 2, 3, 4, 5, 6, 7]

    EsmOamMEPDataModel

    Name

    Type

    Description

    Enum

    upDirectionally Boolean boolean MEP direction ---
    interfaceType String string MEP Interface type [SAP, PATH]
    active Boolean boolean MEP Active ---
    controlMepEnabled Boolean boolean Control MEP enabled ---
    lowestPriorityDeffect String string Lowest priority deffect on the MEP ['All Defects', 'MAC, Remote, Error, Xcon', 'Remote, Error, Xcon', 'Error, Xcon', 'Xcon only', 'No defects Xcon or lower']
    propagateHoldTime Integer integer ESM OAM MEP propagate hold down time ---
    standbyMepShutdownEnabled Boolean boolean ESM OAM MEP Standby MEP enabled ---
    ccm EsmOamMEPCCMDataModel EsmOamMEPCCMDataModel ESM OAM model wrapper for CCM attributes on MEP ---
    ais EsmOamMEPAISDataModel EsmOamMEPAISDataModel ESM OAM model wrapper for AIS attributes on MEP ---

    EsmRequestHeaderMapper

    Name

    Type

    Description

    Enum

    reqId String string Request ID ---
    clientName String string Client name ---

    ESMSchedulerDataModel

    Name

    Type

    Description

    Enum

    jobName String string Job Name ---
    jobDescription String string Job description ---
    username String string User name ---
    trigger ESMSchedulerTriggerDataModel ESMSchedulerTriggerDataModel Job Trigger data model ---

    ESMSchedulerTriggerDataModel

    Name

    Type

    Description

    Enum

    name String string Trigger Name ---
    deployNow String string Deploy Now [Yes]
    type String string Job Type ---
    expression String string Job trigger expression ---
    timeOffset String string User PC time zone offset ---

    MC-LagPeerLagUIDataModel

    Name

    Type

    Description

    Enum

    lagEncapType String string LagEncapType [NULL, Dot1-Q, QinQ]
    nePack1 NeNamePackName NeNamePackName Pack Name ---
    peer1Name String string MC-LagPeerName ---
    lag1Name String string LagName ---
    lagRate String string LagRate ---
    nePack2 NeNamePackName NeNamePackName Pack Name ---
    peer2Name String string MC-LagPeerName ---
    lag2Name String string Displays all the available Commissioned LAGs that are created in theselected NE and pack that matches the Encapsulation Type selected. ---

    MCLAGDataRespHolderModel

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model responseId ---
    response MCLAGInstMapper MCLAGInstMapper MClagInstanceMapper ---
    mcLagId Integer integer McLagId ---

    MCLAGInstHolderMapper

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    req MCLAGInstMapper MCLAGInstMapper --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    oam EsmOAMDataModel EsmOAMDataModel ESM OAM model wrapper ---
    oamConfigured Boolean boolean Is OAM to be configured ---
    activate Boolean boolean --- ---

    MCLAGInstMapper

    Name

    Type

    Description

    Enum

    reqId EsmRequestHeaderMapper EsmRequestHeaderMapper RequestHeaderMapper ---
    mcLagName String string Name for the MC-Lag ---
    description String string Description for the MC-Lag ---
    author String string Author for the MC-Lag ---
    configurationType String string MC-Lag Configuration type ---
    neNamePackNames array[NeNamePackName] NeNamePackName NeNamePackName ---
    controlServiceName String string ControlServiceName ---
    erpName String string Ring name ---
    cvLan String string Customer VLAN ID ---
    svLan String string Subscriber VLAN ID ---
    customer String string Customer name ---
    vsOperationalMode String string --- ---
    vplsName String string VPLS name ---
    peers MCLAGPeersUIModel MCLAGPeersUIModel MC-LagPeers ---
    systemId String string SystemId ---
    systemPriority Integer integer System Priority ---
    adminKey Integer integer adminKey ---
    flushEthernetRingEnabled Boolean boolean isFlushEthernetRingEnabled ---
    peerLagData array[MC-LagPeerLagUIDataModel] MC-LagPeerLagUIDataModel MC-LagPeerLagUIDataModel ---
    preCliCommand String string Pre CLI commands ---
    postCliCommand String string Post CLI commands ---
    managementState String string Current management state of the service ---
    bindingEnabled Boolean boolean isBindingEnabled ---
    controlServiceProtected Boolean boolean isControlServiceProtected ---

    MCLAGPeerDetails

    Name

    Type

    Description

    Enum

    peerName String string PeerName ---
    description String string Peer's Description ---

    MCLAGPeersUIModel

    Name

    Type

    Description

    Enum

    peerData array[MCLAGPeerUIData] MCLAGPeerUIData MC-Lag Peer UI data ---
    neighborFailureMultiplier Integer integer Hold On Neighbor Failure Multiplier [3, 4, 5]
    keepAliveInterval Integer integer Keep Alive Interval ---

    MCLAGPeerUIData

    Name

    Type

    Description

    Enum

    neNamePackName NeNamePackName NeNamePackName NeNamePackName ---
    peerList array[MCLAGPeerDetails] MCLAGPeerDetails MCLAGPeerDetails ---

    N_MCLagId

    Name

    Type

    Description

    Enum

    mclagConfigName String string --- ---
    jobTaskId Long long --- ---
    author String string --- ---
    description String string --- ---
    mclagConfigHandle Long long --- ---
    configType String string --- ---
    targetManagementState String string --- ---
    customerName String string --- ---
    managementState String string --- ---

    N_MCLagIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId EsmRequestHeaderMapper EsmRequestHeaderMapper --- ---
    req N_MCLagId N_MCLagId --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    activate Boolean boolean --- ---

    N_MCLagIdRespHolder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model --- ---
    rsp N_MCLagId N_MCLagId --- ---

    N_MCLagPeerId

    Name

    Type

    Description

    Enum

    mclagConfigHandle Long long --- ---
    mclagConfigName String string --- ---
    configType String string --- ---
    targetNeName String string --- ---
    targetPackName String string --- ---
    targetSourceId Long long --- ---
    targetPeerId Long long --- ---
    prevToPrevOper Integer integer --- ---
    operation String string --- ---
    forceCurrentOperation String string --- ---
    forcePrevOperation String string --- ---
    jobTaskId Long long --- ---

    N_MCLagPeerIdUIHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId EsmRequestHeaderMapper EsmRequestHeaderMapper --- ---
    req N_MCLagPeerId N_MCLagPeerId --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    activate Boolean boolean --- ---

    NeNamePackName

    Name

    Type

    Description

    Enum

    neName String string NeName ---
    packName String string PackName ---

    nTestSuiteTempData

    Name

    Type

    Description

    Enum

    testSuiteName String string --- ---
    testSuiteType String string --- [TWO_WAY_DM, TWO_WAY_SLM, LINK_PATH_TRACE, LOOPBACK, TWO_WAY_SLM_PRO, TWO_WAY_DM_PRO, LSP_PING, LSP_TRACE, VCCV_PING, VCCV_TRACE, TWO_WAY_LM]
    author String string --- ---
    forwardClass String string --- ---
    dataSize String string --- ---
    forwardingClass String string --- ---
    interval String string --- ---
    managementState String string --- ---
    timeOut String string --- ---
    flrInterval_15min String string --- ---
    flrInterval_1day String string --- ---
    flrIntervals String string --- ---
    flrThreshold String string --- ---
    priority String string --- ---
    sendCount String string --- ---
    timeToLive String string --- ---
    vlanPriority String string --- ---

    Request Header

    Name

    Type

    Description

    Enum

    reqId String string ReqId ---
    respBeanRef String string --- ---
    clientName String string ClientName ---
    selectiveSyncViaPolling Boolean boolean --- ---

    Response Header Model

    Name

    Type

    Description

    Enum

    req Request Header Request Header req ---
    errorReason String string errorReason [Error reason]
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string cmdStatus [Success, Failure, Timed-Out, Unknown]
    opMsg String string Operation message ---
    msgCode String string msgCode [Message code]
    parameters array[String] string --- ---
    paramCount Integer integer parameter count returned in the response ---
    objectId Integer integer Object Id ---
    jobName String string Job Name ---
    objectType Integer integer Job Object TYpe ---