Operation

post /esmService/LAG/abortLag
abortLag (abortLag : /esmService/LAG/abortLag)
This operation is used to create a LAG in ESM in Allocated state.

State transition :
Deploying -> Aborted

When a LAG instance is stuck in Deploying management state and the user wants to abort it this API is used.

Once the LAG is in aborted state in ESM, it can be seen/operated on from the Operate -> LAG. In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' has to be 'Deploying', 'targetManagementState' has to be 'Aborted', the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData Lag ID Data Holder ---

Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    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

    <LagIdHolder> <reqId> <reqId>9</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>2</lagId> <vsId>11</vsId> <packName>11QCE12X-2-7</packName> <neName>REST-K</neName> <managementState>Deploying</managementState> <targetManagementState>Allocated</targetManagementState> </req> </LagIdHolder>

    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
    <LagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_ABORT_SUCCESS_001</msgCode> <opMsg/> <paramCount>3</paramCount> <parameters>3</parameters> <parameters>REST-N</parameters> <parameters>11QPE24-1-10</parameters> <req> <clientName>testUser</clientName> <reqId>1</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <rsp> <jobTaskId>0</jobTaskId> <lagId>3</lagId> <neName>REST-N</neName> <packName>11QPE24-1-10</packName> <vsId>12</vsId> </rsp> </LagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/activateLag
    activateLag (activateLag : /esmService/LAG/activateLag)

    When a LAG instance is in de activated mode this api can be used to activate it.
    Activation simply means bringing the admin state and operational state UP on NE.

    Once the LAG is activated it can be seen as operational state up in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' has to be'Commissioned', 'targetManagementState' has to be the same as management state, the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <LagIdHolder> <reqId> <reqId>7</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>2</lagId> <vsId>14</vsId> <packName>11QPE24-1-12</packName> <neName>REST-N</neName> <adminState>Down</adminState> <managementState>Commissioned</managementState> <targetManagementState>Commissioned</targetManagementState> </req> <scheduler> <jobName>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LagIdHolder>

    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
    <LAGDataRespHolder> <lagId>2</lagId> <lagSequence>4673</lagSequence> <response> <neName>REST-N</neName> <packName>11QPE24-1-12</packName> <reserveResource>false</reserveResource> <lagId>0</lagId> <vsId>0</vsId> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_ACTIVATE_SUCCESS_001</msgCode> <opMsg/> <paramCount>4</paramCount> <parameters>REST-N</parameters> <parameters>11QPE24-1-12</parameters> <parameters>2</parameters> <parameters>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 IST</parameters> </responseId> <vsId>14</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/clearActiveStandbyLAG
    Clear Active Standby LAG (clearActiveStandbyLAG : /esmService/LAG/clearActiveStandbyLAG)
    This operation is used for clearing active and standby for a LAG on NE and can be triggered only on commissioned LAGs.

    The operations supported through this rest api are :

    1) Clear Active : It sets the selected LAG as active

    2) Clear Standby : It sets the selected LAG as standby

    3) Clear Active/standby : This operation will be allowed only when one more more "set active/set standby' operation are performed on the LAG.It clears the active and standby state on lags.


    In all the operations, after performing set or clear the peer - lag details (active/standby) are retried from NE. 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 LAG will be marked Commissioned.
    If any of the commands deployed to NE are failed LAG will be marked as Moify-Failed and the remarks will not be cleared. In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values. subGroupId can be obtained from /esmBrowser/LAG/getLagSubGroupData/{lagId}/{vsId}, forceOperation can take values SET_ACTIVE, SET_STANDBY,

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag Sub group ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <N_LagSubgroupIdHolder> <reqId> <reqId>7</reqId> <clientName>testUser</clientName> </reqId> <activate>true</activate> <req> <lagId>2</lagId> <vsId>14</vsId> <packName>11QPE24-1-12</packName> <neName>REST-N</neName> <subGroupId>1</subGroupId> <managementState>Commissioned</managementState> <currentActiveStandby>ForceClear_NA</currentActiveStandby> <originalActiveStandby>ForceClear_NA</originalActiveStandby> <operation>CLEAR</operation> <forceOperation>SET_ACTIVE</forceOperation> <jobTaskId/> </req> <scheduler> <jobName>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </N_LagSubgroupIdHolder>

    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
    <LAGDataRespHolder> <lagId>2</lagId> <lagSequence>4673</lagSequence> <response> <neName>REST-N</neName> <packName>11QPE24-1-12</packName> <reserveResource>false</reserveResource> <lagId>0</lagId> <vsId>0</vsId> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_ACTIVATE_SUCCESS_001</msgCode> <opMsg/> <paramCount>4</paramCount> <parameters>REST-N</parameters> <parameters>11QPE24-1-12</parameters> <parameters>2</parameters> <parameters>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 IST</parameters> </responseId> <vsId>14</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/createLAGInstance
    createLAGInstance (createLAGInstance : /esmService/LAG/createLAGInstance)
    This operation is used to create a LAG in ESM in Allocated state.
    Once the LAG is created it can be seen in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    The fields {neName} has to be given a valid node name, {packName} has to be a valid pack on the previously given NE name, {usage} can take values Standard, ERP, MCLAG, MPLS-TP, {mode} can take values ACCESS or UPLINK, portThreshold an takes values 1,2,3,4 reserveResource can take either 0 or 1. The field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <LAGInstHolder> <req> <neName>SETUP-4V1-P</neName> <packName>11QPE24-1-4</packName> <author>g</author> <description/> <usage>MCLAG</usage> <serviceState>DOWN</serviceState> <mode>ACCESS</mode> <encapType>DOT1-Q</encapType> <holdDownTime>0.0</holdDownTime> <portThreshold>0</portThreshold> <managementState>Allocated</managementState> <reserveResource>true</reserveResource> <selectionCriteria>Highest_Count</selectionCriteria> <slaveToPartner>false</slaveToPartner> <lagPortList> <LagPort> <portRate>1GbE</portRate> <portName>11QPE24-1-4-C5</portName> <priority>1</priority> <subgroupId>1</subgroupId> <duplexMode>FULL</duplexMode> <autoNegotiationEnabled>limited</autoNegotiationEnabled> </LagPort> </lagPortList> <lacpEnabled>Yes</lacpEnabled> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lacpEnabledOnStandby>Yes</lacpEnabledOnStandby> <macAddress/> <preProvCliCmd/> <postProvCliCmd/> </req> <scheduler> <jobName>LAG_SETUP-4V1-P_11QPE24-1-4_Fri Jul 08 2016 17:45:43 UTC+5:30</jobName> <jobDescription/> <username/> <trigger> <name>LAG_SETUP-4V1-P_11QPE24-1-4_Fri Jul 08 2016 17:45:43 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LAGInstHolder>

    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
    <LAGDataRespHolder> <lagId>1</lagId> <lagSequence>5659</lagSequence> <responseId> <cmdStatus>Success</cmdStatus> <message>Success</message> <msgCode>LAG_CRETION_SUCCESS_004</msgCode> <opMsg/> <paramCount>2</paramCount> <parameters>SETUP-4V1-P</parameters> <parameters>11QPE24-1-4 , LagId - LAG1</parameters> </responseId> <vsId>3</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/dbDeleteLag
    dbDeleteLag (dbDeleteLag : /esmService/LAG/dbDeleteLag)
    This operation can be used to clean up a LAG in allocated state.

    State transition :
    Allocated -> Deleted

    This can be triggered only on Commissioned or Deploy Failed LAG and will delete the LAG instance,all its associations from ESM alone and not NE In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' can be 'Commissioned' or 'Deploy Failed', 'targetManagementState' has to be 'Deleted', the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    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

    <LagIdHolder> <reqId> <reqId>7</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>2</lagId> <vsId>11</vsId> <packName>11QCE12X-2-7</packName> <neName>REST-K</neName> </req> </LagIdHolder>

    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
    <LAGDataRespHolder> <lagId>3</lagId> <lagSequence>4681</lagSequence> <responseId> <cmdStatus>Success</cmdStatus> <message>Success</message> <msgCode>LAG_CRETION_SUCCESS_004</msgCode> <opMsg/> <paramCount>2</paramCount> <parameters>REST-N</parameters> <parameters>11QPE24-1-10 , LagId - LAG3</parameters> </responseId> <vsId>12</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/deactivateLag
    deactivateLag (deactivateLag : /esmService/LAG/deactivateLag)

    When a LAG instance is in de activated mode this api can be used to activate it.
    Dectivation simply means bringing the admin state and operational state DOWN on NE.

    Once the LAG is activated it can be seen as operational state down in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' has to be 'Commissioned', 'targetManagementState' has to be 'Commissioned', the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <LagIdHolder> <reqId> <reqId>7</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>2</lagId> <vsId>10</vsId> <packName>11OPE8-1-10</packName> <neName>REST-M</neName> <adminState>Up</adminState> <managementState>Commissioned</managementState> <targetManagementState>Commissioned</targetManagementState> </req> <scheduler> <jobName>LAG_REST-M_11OPE8-1-10_LAG2_Fri Jan 15 2016 13:48:03 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-M_11OPE8-1-10_LAG2_Fri Jan 15 2016 13:48:03 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LagIdHolder>

    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
    <LAGDataRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_CRETION_SUCCESS_004</msgCode> <opMsg/> <paramCount>2</paramCount> <parameters>REST-K</parameters> <parameters>11QCE12X-2-7 , LagId - LAG2</parameters> </responseId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/deleteLag
    Deletes a Lag (deleteLagFromVs : /esmService/LAG/deleteLag)
    This operation can be used to clean up a LAG in allocated state.

    State transition :
    Allocated -> Deleted

    This can be triggered only on Allocated LAG and will delete the LAG instance,all its associations from ESM. In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' can be 'Allocated','Commissioned' or 'Deploy Failed', 'targetManagementState' has to be 'Deleted', the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    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

    <LagIdHolder> <reqId> <reqId>1</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>3</lagId> <vsId>12</vsId> <packName>11QPE24-1-10</packName> <neName>REST-N</neName> </req> </LagIdHolder>

    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
    <LagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_DEL_SUCCESS_001</msgCode> <opMsg/> <paramCount>3</paramCount> <parameters>3</parameters> <parameters>REST-N</parameters> <parameters>11QPE24-1-10</parameters> <req> <clientName>testUser</clientName> <reqId>1</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <rsp> <jobTaskId>0</jobTaskId> <lagId>3</lagId> <neName>REST-N</neName> <packName>11QPE24-1-10</packName> <vsId>12</vsId> </rsp> </LagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/forceActiveStandbyLAG
    forceActiveStandbyLAG (forceActiveStandbyLAG : /esmService/LAG/forceActiveStandbyLAG)
    This operation is used for setting active and standby for a LAG on NE and can be triggered only on commissioned LAGs.

    The operations supported through this rest api are :

    1) Force Active : It sets the selected LAG as active

    2) Force Standby : It sets the selected LAG as standby

    In all the operations, after performing set or clear the peer - lag details (active/standby) are retried from NE. 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 LAG will be marked Commissioned.
    If any of the commands deployed to NE are failed LAG will be marked as Moify-Failed and the remarks will not be cleared. In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values. subGroupId can be obtained from /esmBrowser/LAG/getLagSubGroupData/{lagId}/{vsId}, forceOperation can take values SET_ACTIVE, SET_STANDBY,

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag Sub group ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <N_LagSubgroupIdHolder> <reqId> <reqId>7</reqId> <clientName>testUser</clientName> </reqId> <activate>true</activate> <req> <lagId>2</lagId> <vsId>14</vsId> <packName>11QPE24-1-12</packName> <neName>REST-N</neName> <subGroupId>1</subGroupId> <managementState>Commissioned</managementState> <currentActiveStandby>ForceClear_NA</currentActiveStandby> <originalActiveStandby>ForceClear_NA</originalActiveStandby> <operation>CLEAR</operation> <forceOperation>SET_ACTIVE</forceOperation> <jobTaskId/> </req> <scheduler> <jobName>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </N_LagSubgroupIdHolder>

    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
    <LAGDataRespHolder> <lagId>2</lagId> <lagSequence>4673</lagSequence> <response> <neName>REST-N</neName> <packName>11QPE24-1-12</packName> <reserveResource>false</reserveResource> <lagId>0</lagId> <vsId>0</vsId> </response> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_ACTIVATE_SUCCESS_001</msgCode> <opMsg/> <paramCount>4</paramCount> <parameters>REST-N</parameters> <parameters>11QPE24-1-12</parameters> <parameters>2</parameters> <parameters>LAG_REST-N_11QPE24-1-12_LAG2_Fri Jan 15 2016 13:45:35 IST</parameters> </responseId> <vsId>14</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    get /esmBrowser/LAG/getAllElemLAGsJson/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    All Lags (getAllElemLAGsJson : /esmBrowser/LAG/getAllElemLAGsJson/{localTimeZoneOffset}/{pageContext}/{selectedLagName})
    This retreives all the LAGS that are present on ESM(local and even on NE) in JSON format {localTimeZoneOffset} can be the offset of your loccation from UTC, {pageContext} has to be 'LAG', {selectedLagName} has to be ALL

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required client time Zone offset to be updated ---
    pageContext required LAG ---
    selectedLagName required Lag Name ---

    Return type
  • LagUIDataList
  • Responses

    Response Messages

    Schema

    200success LagUIDataList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/LAG/getAllElemLAGs/+5:30/LAG/All

    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/json

    External Docs
    See Also :

    Operation

    get /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    All Lags (getAllLags : /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName})
    This retreives all the LAGS that are peesent on ESM(local and even on NE) {localTimeZoneOffset} can be the offset of your loccation from UTC, {pageContext} has to be 'LAG', {selectedLagName} has to be ALL

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required client time Zone offset to be updated ---
    pageContext required LAG ---
    selectedLagName required Lag Name ---

    Return type
  • LagUIDataList
  • Responses

    Response Messages

    Schema

    200success LagUIDataList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/LAG/getAllElemLAGs/+5:30/LAG/All

    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
    <LAGDataList> <lagUIDataList> <lagSequence>6341</lagSequence> <neName>NODE-N</neName> <packName>11QPE24-1-12</packName> <lagId>LAG3</lagId> <Author>alcatel</Author> <portThreshold>0</portThreshold> <adminState>Up</adminState> <operationalState>--</operationalState> <alarmState>--</alarmState> <lacpEnabled>Yes</lacpEnabled> <managementState>Commissioned</managementState> <availability>USED</availability> <lagUsage>MCLAG</lagUsage> <selectionCriteria>Highest Count</selectionCriteria> <creationTime>2016-01-29 16:32:17</creationTime> <lastUpdateTime>2016-01-29 16:32:19</lastUpdateTime> <scheduleTime>--</scheduleTime> <lagMode>Access</lagMode> <lagEncapType>Null</lagEncapType> <lagHoldDownTime>0.0</lagHoldDownTime> <lagMacAddress>00:00:00:00:00:00</lagMacAddress> <splitHorizonGroup>None</splitHorizonGroup> <slaveToPartner>No</slaveToPartner> <thresholdExceededCount>0</thresholdExceededCount> <portThresholdAction>Down</portThresholdAction> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lacpEnabledOnStandby>Yes</lacpEnabledOnStandby> <actorSystemId>00:00:00:00:00:00</actorSystemId> <actorSystemPriority>32768</actorSystemPriority> <actorAdminKey>61946</actorAdminKey> <actorOperationalKey>0</actorOperationalKey> <partnerSystemId>00:00:00:00:00:00</partnerSystemId> <partnerSystemPriority>0</partnerSystemPriority> <partnerOperationalKey>0</partnerOperationalKey> <vsId>10</vsId> <objectScope>active</objectScope> <lagUsedByService>false</lagUsedByService> <lagUsedByERP>false</lagUsedByERP> <lagUsedByMCLAG>false</lagUsedByMCLAG> <subGroupCount>1</subGroupCount> <preProvCLICommand/> <postProvCLICommand/> </lagUIDataList> </LAGDataList>

    External Docs
    See Also :

    Operation

    get /esmBrowser/LAG/getLagDetailsJSON/{lagId}/{vsId}/{localTimeZoneOffset}
    Lag Details (getLagDetailsJSON : /esmBrowser/LAG/getLagDetailsJSON/{lagId}/{vsId}/{localTimeZoneOffset})
    Wrapper for Lag data details which gets all LAG details for a particular lag. , the field {lagId} can be obtained from /esmBrowser/LAG/getLagDetailsJSON/{lagId}/{vsId}/{localTimeZoneOffset}

    Path parameters

    Name

    IsRequired

    Description

    Enum

    lagId required Lag identifier ---
    vsId required Vitual Switch identifier ---
    localTimeZoneOffset required client time Zone offset to be updated ---

    Return type
  • LAGUIData
  • Responses

    Response Messages

    Schema

    200success LAGUIData
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /esmBrowser/LAG/getLagDetailsJSON/3/10/+5:30

    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/json
    Example Response Data
    { "lagSequence": "4460", "neName": "PSS32-100-65-149", "neId": "8", "packName": "11QCE12X-1-11", "lagId": "LAG4", "portThreshold": "0", "adminState": "Down", "operationalState": "--", "alarmState": "--", "lacpEnabled": "No", "managementState": "Commissioned", "remark": null, "availability": "USED", "lagUsage": "ERP", "selectionCriteria": "Highest Count", "creationTime": "2017-06-27 09:56:44", "lastUpdateTime": "2017-06-27 09:56:46", "scheduleTime": null, "lagDescr": null, "lagAuthor": "alcatel", "lagMode": "Uplink", "lagEncapType": "QinQ", "lagHoldDownTime": "0.0", "lagMacAddress": null, "splitHorizonGroup": "NONE", "slaveToPartner": "No", "thresholdExceededCount": "0", "portThresholdAction": "Down", "lacpMode": "Passive", "lacpTransmitInterval": "Fast", "lacpEnabledOnStandby": "Yes", "actorSystemId": "00:00:00:00:00:00", "actorSystemPriority": "32768", "actorAdminKey": "0", "actorOperationalKey": "0", "partnerSystemId": "00:00:00:00:00:00", "partnerSystemPriority": "0", "partnerOperationalKey": "0", "vsId": "9", "objectScope": "active", "preCliText": null, "postCliText": null, "portRate": "1GbE", "lagUsedByService": false, "lagUsedByERP": false, "lagUsedByMCLAG": false, "subGroupCount": null, "preProvCLICommand": null, "postProvCLICommand": null, "preCLICmdBool": false, "postCLICmdBool": false, "serviceState": "Out of Service", "originalActiveStandby": null, "lacpEnabledBoolean": false, "lacpEnabledOnStandbyBoolean": true, "slaveToPartnerBoolean": false, "notificationTime": 1498537748062, "id": "4460", "key": "LAGUIData/4460", "className": "LAGUIData", "lagUserLabel": "PB_Lag_Name", "author": null }

    External Docs
    See Also :

    Operation

    get /esmBrowser/LAG/getLagIndex/{neName}/{portName}
    Retrieve ID of the lag created using the port passed as filter (getLagIndex : /esmBrowser/LAG/getLagIndex/{neName}/{portName})
    Find and retrieve the LAG ID of the LAG using the port listed in the input on the NE neName

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required Node Name ---
    portName required Port Name ---

    Return type
  • LAGId
  • Responses

    Response Messages

    Schema

    200success LAGId
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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/json

    External Docs
    See Also :

    Operation

    get /esmBrowser/LAG/getLagMemberPortListJson/{lagId}/{vsId}/{Status}/{DiffEnabled}
    Lag UI Member Port Data (getLagMemberPortListJson : /esmBrowser/LAG/getLagMemberPortListJson/{lagId}/{vsId}/{Status}/{DiffEnabled})
    Wrapper for Lag UI Member Port Data It gets all port members involved in a lag , the field {lagId} can be obtained from /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName} under the column lag ID {Status} has to be CURRENT and {DiffEnabled} has to be false

    Path parameters

    Name

    IsRequired

    Description

    Enum

    lagId required Lag identifier ---
    vsId required Vitual Switch identifier ---
    status required Lag Status [Current, Original]
    diffEnabled required DiffEnabled , when commisioned Lag has being modified [false, true]

    Return type
  • LagUIMemberPortDataList
  • Responses

    Response Messages

    Schema

    200success LagUIMemberPortDataList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    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

    External Docs
    See Also :

    Operation

    post /esmService/LAG/modifySaveLAGInstance
    modifySaveLAGInstance (modifySaveLAGInstance : /esmService/LAG/modifySaveLAGInstance)
    This operation is used to modify a LAG in ESM which is in Allocated state .
    Once the LAG is modified it can be seen in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    The fields {neName} has to be given a valid node name, {packName} has to be a valid pack on the previously given NE name, {usage} can take values Standard, ERP, MCLAG, MPLS-TP, {mode} can take values ACCESS or UPLINK, portThreshold an takes values 1,2,3,4 reserveResource can take either 0 or 1. The field 'scheduler' can be filled with any appropriate user desired values however this is not a scheduled operation

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <LAGInstHolder> <req> <neName>PSS32-100-65-149</neName> <packName>11QCE12X-1-11</packName> <userLabel>PB_Lag_Name1</userLabel> <author>alcatel</author> <description/> <usage>ERP</usage> <serviceState>DOWN</serviceState> <mode>UPLINK</mode> <encapType>QinQ</encapType> <holdDownTime>0.0</holdDownTime> <portThreshold>0</portThreshold> <managementState>COMMISSIONED</managementState> <lagId>4</lagId> <vsId>9</vsId> <reserveResource>true</reserveResource> <selectionCriteria>Highest_Count</selectionCriteria> <slaveToPartner>false</slaveToPartner> <lagPortList> <LagPort> <portRate>1GbE</portRate> <portName>11QCE12X-1-11-C12</portName> <priority>1</priority> <subgroupId>1</subgroupId> <duplexMode>FULL</duplexMode> <autoNegotiationEnabled>no</autoNegotiationEnabled> </LagPort> </lagPortList> <lacpEnabled>No</lacpEnabled> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lacpEnabledOnStandby>Yes</lacpEnabledOnStandby> <macAddress/> <preProvCliCmd/> <postProvCliCmd/> </req> </LAGInstHolder>

    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
    <LAGDataRespHolder> <lagId>1</lagId> <lagSequence>4034</lagSequence> <responseId> <cmdStatus>Success</cmdStatus> <message>Success</message> <msgCode>LAG_MODIFY_SUCCESS_003</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-M, 11QCE12X-1-10-LAG1</parameters> </responseId> <vsId>6</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/moveToAllocatedLAGInstance
    moveToAllocatedLAGInstance (moveToAllocatedLAGInstance : /esmService/LAG/moveToAllocatedLAGInstance)
    This operation is used to create a LAG in ESM in Allocated state.

    State transition :
    New -> Allocated

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

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

    While creating the LAG instance in ESM, the details of the following entities will also be saved in ESM database:
    1.generated LAG ID, and the ID of the pack on which the lag is created
    2.lagSequence which is port id of the port on which lag is created
    3.objectScope - Whether it is active on NE or not, description, admin state,operational state,port mode and threshold details.
    Creating a CLAG in allocated state is not a scheduled operation.
    Once the LAG is created in allocated state in ESM, it can be seen/operated on from the Operate -> LAG. In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' has to be 'New', 'targetManagementState' has to be 'Allocated', the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    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

    <LagIdHolder> <reqId> <reqId>5</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>2</lagId> <vsId>11</vsId> <packName>11QCE12X-2-7</packName> <neName>REST-K</neName> <adminState>Down</adminState> <managementState>Commissioned</managementState> <targetManagementState>Allocated</targetManagementState> </req> <scheduler> <jobName>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 13:54:00 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 13:54:00 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LagIdHolder>

    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
    <LAGDataRespHolder> <lagId>2</lagId> <lagSequence>4680</lagSequence> <responseId> <cmdStatus>Success</cmdStatus> <message>Success</message> <msgCode>LAG_SCHED_MODIFY_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>NE: REST-K,11QCE12X-2-7-LAG2</parameters> </responseId> <vsId>11</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/scheduleAllocateToDeployLAG
    scheduleAllocateToDeployLAG (scheduleAllocateToDeployLAG : /esmService/LAG/scheduleAllocateToDeployLAG)
    This operation is used to move a LAG in ESM from Allocated state to Commissioned State.
    Once the LAG is created it can be seen in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    The fields {neName} has to be given a valid node name, {packName} has to be a valid pack on the previously given NE name, {usage} can take values Standard, ERP, MCLAG, MPLS-TP, {mode} can take values ACCESS or UPLINK, portThreshold an takes values 1,2,3,4 reserveResource can take either 0 or 1. The field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <LAGInstHolder> <req> <lagId>2</lagId> <vsId>11</vsId> <packName>11QCE12X-2-7</packName> <neName>REST-K</neName> </req> <scheduler> <jobName>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 13:51:17 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 13:51:17 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LAGInstHolder>

    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
    <LAGDataRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_CRETION_SUCCESS_004</msgCode> <opMsg/> <paramCount>2</paramCount> <parameters>REST-K</parameters> <parameters>11QCE12X-2-7 , LagId - LAG2</parameters> </responseId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/scheduleDeployLAG
    scheduleDeployLAG (scheduleDeployLAG : /esmService/LAG/scheduleDeployLAG)
    This operation is used to create a LAG in ESM and deploy it on NE.
    Once the LAG is deployed it can be seen in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    The fields {neName} has to be given a valid node name, {packName} has to be a valid pack on the previously given NE name, {usage} can take values Standard, ERP, MCLAG, MPLS-TP, {mode} can take values ACCESS or UPLINK, portThreshold an takes values 1,2,3,4 reserveResource can take either 0 or 1. The field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <LAGInstHolder> <req> <neName>PSS32-100-65-149</neName> <packName>11QCE12X-1-11</packName> <userLabel>PB_Lag_Name</userLabel> <author>alcatel</author> <description/> <usage>ERP</usage> <serviceState>DOWN</serviceState> <mode>UPLINK</mode> <encapType>QinQ</encapType> <holdDownTime>0.0</holdDownTime> <portThreshold>0</portThreshold> <managementState>Allocated</managementState> <reserveResource>true</reserveResource> <selectionCriteria>Highest_Count</selectionCriteria> <slaveToPartner>false</slaveToPartner> <lagPortList> <LagPort> <portRate>1GbE</portRate> <portName>11QCE12X-1-11-C12</portName> <priority>1</priority> <subgroupId>1</subgroupId> <duplexMode>FULL</duplexMode> <autoNegotiationEnabled>no</autoNegotiationEnabled> </LagPort> </lagPortList> <lacpEnabled>No</lacpEnabled> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lacpEnabledOnStandby>Yes</lacpEnabledOnStandby> <macAddress/> <preProvCliCmd/> <postProvCliCmd/> </req> <scheduler> <jobName>LAG_PSS32-100-65-149_11QCE12X-1-11_Tue Jun 27 2017 09:54:09 UTC+5:30</jobName> <jobDescription/> <username>alcatel</username> <trigger> <name>LAG_PSS32-100-65-149_11QCE12X-1-11_Tue Jun 27 2017 09:54:09 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LAGInstHolder>

    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
    <LAGDataRespHolder> <lagId>3</lagId> <lagSequence>4681</lagSequence> <responseId> <cmdStatus>Success</cmdStatus> <message>Success</message> <msgCode>LAG_CRETION_SUCCESS_004</msgCode> <opMsg/> <paramCount>2</paramCount> <parameters>REST-N</parameters> <parameters>11QPE24-1-10 , LagId - LAG3</parameters> </responseId> <vsId>12</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/scheduleForceComplete
    scheduleForceComplete (scheduleForceCompleteLAGInstance : /esmService/LAG/scheduleForceComplete)
    This is a Best-Effort operation, which retries the modification operation and can be triggered only on a Modify-Failed LAG. 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 LAG 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 LAG is in Modify failed state, move back to Allocate or delete operations will not be enabled. In order to cleanup the LAG entities, the LAG should be in Modify-Failed. This operation can be used to mark it as Commissioned even though modification is failure, so that user can cleanup the LAG from Commissioned state.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml In the request data 'reqId' can be any number
    • 'clientName' can be any name the user desires
    • 'managementState' has to be 'Deploy Failed' or 'Commissioned'
    • 'targetManagementState' has to be 'Allocated'
    • the fields 'lagId'
    • 'neName'
    • 'packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.
    Example Request Data

    <LagIdHolder> <reqId> <reqId>1</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>2</lagId> <vsId>11</vsId> <packName>11QCE12X-2-7</packName> <neName>REST-K</neName> <adminState>Up</adminState> <managementState>Modify Failed</managementState> <targetManagementState>Commissioned</targetManagementState> </req> <scheduler> <jobName>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 14:12:19 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 14:12:19 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LagIdHolder>

    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
    <LagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_SCHED_FORCE_COMPLETE_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-K:11QCE12X-2-7-LAG2</parameters> <req> <clientName>testUser</clientName> <reqId>1</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <rsp> <adminState>Up</adminState> <jobTaskId>0</jobTaskId> <lagId>2</lagId> <managementState>Modify Failed</managementState> <neName>REST-K</neName> <packName>11QCE12X-2-7</packName> <targetManagementState>Commissioned</targetManagementState> <vsId>11</vsId> </rsp> </LagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/scheduleModifyLAGInstance
    scheduleModifyLAGInstance (scheduleModifyLAGInstance : /esmService/LAG/scheduleModifyLAGInstance)
    This operation is used to create a LAG in ESM in Commissioned or Deploy Failed state.
    Once the LAG is created it can be seen in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    The fields {neName} has to be given a valid node name, {packName} has to be a valid pack on the previously given NE name, {usage} can take values Standard, ERP, MCLAG, MPLS-TP, {mode} can take values ACCESS or UPLINK, portThreshold an takes values 1,2,3,4 reserveResource can take either 0 or 1. The field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • LAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success LAGDataRespHolder
    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

    <LAGInstHolder> <req> <neName>PSS32-100-65-149</neName> <packName>11QCE12X-1-11</packName> <userLabel>PB_Lag_Name</userLabel> <author>alcatel</author> <description/> <usage>ERP</usage> <serviceState>DOWN</serviceState> <mode>UPLINK</mode> <encapType>QinQ</encapType> <holdDownTime>0.0</holdDownTime> <portThreshold>0</portThreshold> <managementState>COMMISSIONED</managementState> <lagId>4</lagId> <vsId>9</vsId> <reserveResource>true</reserveResource> <selectionCriteria>Highest_Count</selectionCriteria> <slaveToPartner>false</slaveToPartner> <lagPortList> <LagPort> <portRate>1GbE</portRate> <portName>11QCE12X-1-11-C12</portName> <priority>1</priority> <subgroupId>1</subgroupId> <duplexMode>FULL</duplexMode> <autoNegotiationEnabled>no</autoNegotiationEnabled> </LagPort> </lagPortList> <lacpEnabled>No</lacpEnabled> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lacpEnabledOnStandby>Yes</lacpEnabledOnStandby> <macAddress/> <preProvCliCmd/> <postProvCliCmd/> </req> <scheduler> <jobName>LAG_PSS32-100-65-149_11QCE12X-1-11_Tue Jun 27 2017 09:58:48 UTC+5:30</jobName> <jobDescription/> <username>alcatel</username> <trigger> <name>LAG_PSS32-100-65-149_11QCE12X-1-11_Tue Jun 27 2017 09:58:48 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LAGInstHolder>

    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
    <LAGDataRespHolder> <lagId>2</lagId> <lagSequence>4680</lagSequence> <responseId> <cmdStatus>Success</cmdStatus> <message>Success</message> <msgCode>LAG_SCHED_MODIFY_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>NE: REST-K,11QCE12X-2-7-LAG2</parameters> </responseId> <vsId>11</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/scheduledDelete
    scheduledDelete (scheduledDeleteLAGInstance : /esmService/LAG/scheduledDelete)
    This operation can be used to clean up a LAG in allocated state.

    State transition :
    Deploy Failed -> Deleted

    This can be triggered only on Deploy Failed LAG and will delete the LAG instance,all its associations from ESM as well on NE(if any). In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' has to be Deploy Failed', 'targetManagementState' has to be 'Deleted', the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    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

    <LagIdHolder> <reqId> <reqId>1</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>3</lagId> <vsId>12</vsId> <packName>11QPE24-1-10</packName> <neName>REST-N</neName> </req> </LagIdHolder>

    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
    <LagIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>LAG_DEL_SUCCESS_001</msgCode> <opMsg/> <paramCount>3</paramCount> <parameters>3</parameters> <parameters>REST-N</parameters> <parameters>11QPE24-1-10</parameters> <req> <clientName>testUser</clientName> <reqId>1</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <rsp> <jobTaskId>0</jobTaskId> <lagId>3</lagId> <neName>REST-N</neName> <packName>11QPE24-1-10</packName> <vsId>12</vsId> </rsp> </LagIdRespHolder>

    External Docs
    See Also :

    Operation

    post /esmService/LAG/moveBackToAllocatedScheduled
    moveBackToAllocatedScheduled (scheduledMoveBackToAllcotedLAGInstance : /esmService/LAG/moveBackToAllocatedScheduled)
    This operation is used to create a LAG in ESM in Allocated state.

    This operation is to fully or partially remove the entity on NE and make it local to ESM
    Management State Transition: Commissiones --> Allocated or Deploy Failed ---> Allocated.

    Once the LAG is moved back to allocate it can be seen as Management state Allocated in /esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}
    In the request data 'reqId' can be any number, 'clientName' can be any name the user desires, 'managementState' has to be 'Deploy Failed' or 'Commissioned', 'targetManagementState' has to be 'Allocated', the fields 'lagId', 'neName','packName' can be obtained from '/esmBrowser/LAG/getAllElemLAGs/{localTimeZoneOffset}/{pageContext}/{selectedLagName}' the field 'scheduler' can be filled with any appropriate user desired values.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData Lag ID Data Holder ---

    Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    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

    <LagIdHolder> <reqId> <reqId>5</reqId> <clientName>testUser</clientName> </reqId> <req> <lagId>2</lagId> <vsId>11</vsId> <packName>11QCE12X-2-7</packName> <neName>REST-K</neName> <adminState>Down</adminState> <managementState>Commissioned</managementState> <targetManagementState>Allocated</targetManagementState> </req> <scheduler> <jobName>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 13:54:00 IST</jobName> <jobDescription/> <username/> <trigger> <name>LAG_REST-K_11QCE12X-2-7_LAG2_Fri Jan 15 2016 13:54:00 ISTTrigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </LagIdHolder>

    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
    <LAGDataRespHolder> <lagId>2</lagId> <lagSequence>4680</lagSequence> <responseId> <cmdStatus>Success</cmdStatus> <message>Success</message> <msgCode>LAG_SCHED_MODIFY_SUCCESS_002</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>NE: REST-K,11QCE12X-2-7-LAG2</parameters> </responseId> <vsId>11</vsId> </LAGDataRespHolder>

    External Docs
    See Also :

    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 ---

    Lag ID Data Holder

    Name

    Type

    Description

    Enum

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

    LAG Instance Data Holder

    Name

    Type

    Description

    Enum

    userLabel String string userLabel ---
    encapType String string encapType [ ]
    usage String string usage [ ]
    preProvCliCmd String string preProvCliCmd [ ]
    description String string description [ ]
    neName String string neName [ ]
    vsId Integer integer vsId ---
    serviceState String string serviceState [ ]
    mode String string mode [ ]
    lagId Integer integer lagId ---
    selectionCriteria String string selectionCriteria [ ]
    holdDownTime String string holdDownTime [ ]
    slaveToPartner String string slaveToPartner [ ]
    lacpMode String string lacpMode [ ]
    author String string author [ ]
    portThreshold String string portThreshold [ ]
    lagPortList array[LAG Member Data Holder] LAG Member Data Holder List ---
    lacpEnabled String string lacpEnabled [ ]
    postProvCliCmd String string destMepDetails [ ]
    macAddress String string macAddress [ ]
    reserveResource Boolean boolean It signifies whether to deloy lag on NE(1) or create it on ESM alone(0) ---
    lacpTransmitInterval String string lacpTransmitInterval [ ]
    lacpEnabledOnStandby String string lacpEnabledOnStandby [ ]
    packName String string packName [ ]
    managementState String string managementState [ ]

    LAG Member Data Holder

    Name

    Type

    Description

    Enum

    duplexMode String string duplexMode [ ]
    portRate String string portRate [ ]
    autoNegotiationEnabled String string autoNegotiationEnabled [ ]
    portName String string portName [ ]
    priority String string priority [ ]
    subgroupId String string subgroupId [ ]

    Lag Response Data Holder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model responseId ---
    rsp N_LagId N_LagId response ---

    Lag Sub group ID Data Holder

    Name

    Type

    Description

    Enum

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

    LAG UI Member port Data wrapper model list

    Name

    Type

    Description

    Enum

    tpId String string TPId ---
    activeOrStandBy String string Lag member ActiveOrStandBy [NotApplicable, Active, Standby, ForceClear]
    originalActiveStandby String string Lag member ActiveOrStandBy [NotApplicable, Active, Standby, ForceClear]
    adminState String string Lag admin State [NotApplicable, Up , Down , Diagnose , Inconsistent]
    operationalState String string Operational state [up, down, unknown, transition, --]
    primary String string PrimaryPortCheck [true, false]
    scope String string scope of Lag Ports [Local, active, unknown]
    effectiveRate String string Port effective Rate [multiple of 1 GBE or 10 GBE]
    duplexMode String string DuplexMode [Full]
    autoNeg String string Auto-negotiation value [No, Limited]
    primaryState String string PortPrimaryState [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance]
    memberPortRate String string Member Port effective Rate ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    portNameForOTNList String string --- ---
    portChanged Boolean boolean isPortChanged ---
    portName String string PortName ---
    subGroupId String string SubGroupId ---
    priority String string Lag's Port priority [1 to 65535]

    LAG UI Sub Group Data wrapper model list

    Name

    Type

    Description

    Enum

    lagId String string LagId ---
    vsId String string VSId ---
    subGroupId String string SubGroupId ---
    currentActiveOrStandby String string Lag member ActiveOrStandBy [NotApplicable, Active, Standby, ForceClear]
    beforeForceSetActiveOrStandby String string Lag member ActiveOrStandBy [NotApplicable, Active, Standby, ForceClear]

    LAGDataRespHolder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model responseId ---
    response LAG Instance Data Holder LAG Instance Data Holder response ---
    lagId Integer integer lagId ---
    vsId Integer integer vsId ---
    lagSequence Integer integer lagSequence ---

    LAGId

    Name

    Type

    Description

    Enum

    lagId Integer integer --- ---

    LAGUIData

    Name

    Type

    Description

    Enum

    lagSequence String string LagSequence ---
    neName String string Ne Name ---
    neId String string NeId ---
    packName String string PackName ---
    lagId String string LagId ---
    portThreshold String string PortThreshold [0 to 3]
    adminState String string Lag admin State [NotApplicable, Up , Down , Diagnose , Inconsistent]
    operationalState String string Operational state [up, down, unknown, transition, --]
    alarmState String string Alarm State ---
    lacpEnabled String string LacpEnabled [enable, disable]
    managementState String string Current management state of the service ---
    remark String string Lag Remark ---
    availability String string Lag Availability [used, available, unknown]
    lagUsage String string Lag usage [Standard, erp, mc-lag]
    selectionCriteria String string SelectionCriteria [Highest Count, Highest Value]
    creationTime String string creation time ---
    lastUpdateTime String string modification time ---
    scheduleTime String string Lag Schedule time ---
    lagDescr String string Lag Description ---
    lagAuthor String string Author for the Lag ---
    lagMode String string Lag Mode ---
    lagEncapType String string Lag Encapsulation Type [Null, Dot1Q, QinQ]
    lagHoldDownTime String string Lag Hold Down Time [0s to 200s]
    lagMacAddress String string Lag Mac Address ---
    splitHorizonGroup String string Split Horizon Group Name ---
    slaveToPartner String string SlaveToPartner [enable, diable]
    thresholdExceededCount String string ThresholdExceededCount ---
    portThresholdAction String string PortThresholdAction [down, dynamic cost]
    lacpMode String string Lacp Mode [Active, passive]
    lacpTransmitInterval String string LacpTransmitInterval [Fast, Slow]
    lacpEnabledOnStandby String string LacpEnabledOnStandby [enable, disable]
    actorSystemId String string --- ---
    actorSystemPriority String string --- ---
    actorAdminKey String string --- ---
    actorOperationalKey String string --- ---
    partnerSystemId String string --- ---
    partnerSystemPriority String string --- ---
    partnerOperationalKey String string --- ---
    vsId String string VSId ---
    objectScope String string scope of Lag Ports [Local, active, unknown]
    preCliText String string Pre CLI commands ---
    postCliText String string Post CLI commands ---
    portRate String string Port Rate [1 GBE or 10 GBE]
    effectiveRate String string --- ---
    lagUsedByService Boolean boolean isLagUsedByService ---
    lagUsedByERP Boolean boolean isLagUsedByERP ---
    lagUsedByMCLAG Boolean boolean IsLagUsedByMCLAG ---
    subGroupCount Integer integer SubGroupCount ---
    preProvCLICommand String string Pre CLI commands ---
    postProvCLICommand String string Post CLI commands ---
    preCLICmdBool Boolean boolean --- ---
    postCLICmdBool Boolean boolean --- ---
    serviceState String string --- ---
    originalActiveStandby String string --- ---
    lacpEnabledBoolean Boolean boolean --- ---
    lacpEnabledOnStandbyBoolean Boolean boolean --- ---
    slaveToPartnerBoolean Boolean boolean --- ---
    notificationTime Long long --- ---
    psId Integer integer --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    lagUserLabel String string --- ---
    author String string Author for the Lag ---

    LagUIDataList

    Name

    Type

    Description

    Enum

    lagUIDataList array[LAGUIData] LAGUIData LAG UI Data wrapper model list ---
    items array[LAGUIData] LAGUIData --- ---

    LagUIMemberPortDataList

    Name

    Type

    Description

    Enum

    lagUiMemberPortDataList array[LAG UI Member port Data wrapper model list] LAG UI Member port Data wrapper model list LAG UI Member port Data wrapper model list ---
    items array[LAG UI Member port Data wrapper model list] LAG UI Member port Data wrapper model list --- ---

    LagUISubGroupDataList

    Name

    Type

    Description

    Enum

    lagUiSubGroupData array[LAG UI Sub Group Data wrapper model list] LAG UI Sub Group Data wrapper model list LAG UI Sub Group Data wrapper model ---

    N_LagId

    Name

    Type

    Description

    Enum

    lagSequence Long long --- ---
    lagId String string Unique ID used to identify a LAG. ---
    jobTaskId Long long --- ---
    adminState String string Used to denote whether the LAG is active on NE or not. ---
    neName String string NE name on which LAG is created. ---
    packName String string Pack name on the NE on which LAG is created. ---
    targetManagementState String string --- ---
    managementState String string LAG management state ---
    vsId String string --- ---

    N_LagSubgroupId

    Name

    Type

    Description

    Enum

    lagId String string LAG ID ---
    vsId String string VS ID on which the lag is created ---
    neName String string NE name on which LAG is created. ---
    packName String string Pack name on the NE on which LAG is created. ---
    subGroupId String string Sub Group ID ---
    currentActiveStandby String string --- ---
    originalActiveStandby String string --- ---
    operation String string FORCE or CLEAR ---
    forceOperation String string To perform a force operation, values can be SET_ACTIVE, SET_STANDBY ---
    managementState String string --- ---
    jobTaskId Long long --- ---

    NEData

    Name

    Type

    Description

    Enum

    neid Integer integer NEID ---
    nprneid Integer integer NPRNEID ---
    name String string NEName ---
    displayname String string DisplayName ---
    nelabel String string NELABEL ---
    commstate Integer integer Nodes Communication State ---
    sasKNe Boolean boolean --- ---

    NEDataList

    Name

    Type

    Description

    Enum

    neData array[NEData] NEData NE Data wrapper model list ---

    PackDetails

    Name

    Type

    Description

    Enum

    cardName String string --- ---
    vsId Integer integer --- ---
    ehName String string --- ---
    packName String string --- ---
    neId Integer integer --- ---

    PackDetailsList

    Name

    Type

    Description

    Enum

    packDetails array[PackDetails] PackDetails --- ---

    PortDetails

    Name

    Type

    Description

    Enum

    portName String string PortName ---
    tpId Integer integer TpId ---
    autoNeg String string Auto-negotiation value [No, Limited]
    duplexMode String string DuplexMode [Full]
    neId Integer integer NEId ---
    portRate String string Port Rate [1 GBE or 10 GBE]
    neVersion String string NeVersion ---
    portState String string Port State ---
    portMacAddress String string PortMacAddress ---
    id String string --- ---
    portPrimaryState String string Port Primary State ---
    priority Integer integer --- ---

    PortDetailsList

    Name

    Type

    Description

    Enum

    portDetails array[PortDetails] PortDetails NE port Data wrapper model list ---
    items array[PortDetails] PortDetails --- ---

    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 ---