Operation

get /esmBrowser/svcTemplate/get15MinPMReportProfiles
15MinPMReportProfiles (get15MinPMReportProfiles : /esmBrowser/svcTemplate/get15MinPMReportProfiles)
This method fetches all the PM report profiles


Return type
  • PMServReportProfileObj
  • Responses

    Response Messages

    Schema

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

    /oms1350/esmBrowser/svcTemplate/get15MinPMReportProfiles

    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
    [ { "repId": 1, "format": 0, "userlabel": "24_REPORT", "repository": 0, "window": 2, "destType": 0, "destName": "/usr/Systems/OTNE_2-14/CPM/outputfiles/", "secLabel": 1, "reSol": 0, "domainId": 1 }, { "repId": 2, "format": 0, "userlabel": "2h_REPORT", "repository": 0, "window": 6, "destType": 0, "destName": "/usr/Systems/OTNE_2-14/CPM/outputfiles/", "secLabel": 1, "reSol": 0, "domainId": 1 }, { "repId": 3, "format": 0, "userlabel": "test_1", "repository": 0, "window": 0, "destType": 0, "destName": "/tmp/", "secLabel": 0, "reSol": 0, "domainId": 1 } ]

    External Docs
    See Also :

    Operation

    get /esmBrowser/svcTemplate/getServiceTemplate/{context}
    ServiceTemplates (getServiceTemplate : /esmBrowser/svcTemplate/getServiceTemplate/{context})
    This method fetches particular Service Template details including cli details and oam details based on given Template Name.Exception is thrown if no cli details are retrived for given Mdid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    context required Types of service templates [EPTREE, EPL, EVPL, EPLAN, EVPLAN, EVPTREE]

    Return type
  • ServiceTemplate
  • Responses

    Response Messages

    Schema

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

    oms1350/esmBrowser/svcTemplate/getServiceTemplate/My%20Templates+Service%20Templates+EPTREE?dojo.preventCache=146823348

    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
    <ServiceTemplate> <aggMeterBurst>Default</aggMeterBurst> <aggMeterRate>0</aggMeterRate> <allMeters2R3C2>false</allMeters2R3C2> <author>alcatel</author> <cacEnabled>0</cacEnabled> <className>SvcTemplateHolder</className> <createTime>0</createTime> <customer>''</customer> <demarcOamMaNAme>OAMSvc</demarcOamMaNAme> <demarcOamMdFormat>NONE</demarcOamMdFormat> <demarcOamMdId>2</demarcOamMdId> <demarcOamMdLevel>0</demarcOamMdLevel> <demarcOamTemplateName>OAM_FOR_Demarcation_Device</demarcOamTemplateName> <demarcOamTemplatePath>Best Practices/OAM Template</demarcOamTemplatePath> <descr>Best Practices for Provider-Bridge Service</descr> <egressEnabled>0</egressEnabled> <egressMaxBurst>None</egressMaxBurst> <egressRate>Default</egressRate> <epActiveHoldDelay>0</epActiveHoldDelay> <epRevertTimer>0</epRevertTimer> <epStandbySignallingSlave>N</epStandbySignallingSlave> <eplOp2TunnelEnabled>0</eplOp2TunnelEnabled> <id>21</id> <ingressEnabled>0</ingressEnabled> <key>SvcTemplateHolder/21</key> <l2ptEnabled>0</l2ptEnabled> <lacpEnabled>0</lacpEnabled> <llfEnabled>0</llfEnabled> <modifyTime>0</modifyTime> <mplstp_handle>0</mplstp_handle> <numberOfMeterForPolicy>0</numberOfMeterForPolicy> <oamMaNAme>OAMSvc</oamMaNAme> <oamMdFormat>NONE</oamMdFormat> <oamMdId>2</oamMdId> <oamMdLevel>3</oamMdLevel> <oamTemplateName>OAM_FOR_Service</oamTemplateName> <oamTemplatePath>Best Practices/OAM Template</oamTemplatePath> <pmState>-1</pmState> <policyNameForMPLS>Best Practices/QoS Templates/ACCESSINGRESSQOS_IP</policyNameForMPLS> <postProvCliCmd/> <preProvCliCmd/> <pwRefreshTimer>0</pwRefreshTimer> <pwRequestTimer>0</pwRequestTimer> <pwRetryTimer>0</pwRetryTimer> <pwTimeoutMultiplier>0</pwTimeoutMultiplier> <repProf15m>null</repProf15m> <repProf24h>null</repProf24h> <serviceType>EPL</serviceType> <tcaProfName>null</tcaProfName> <templateId>21</templateId> <templateName>Service_EPL_AccessIngressQoS_IP</templateName> <templatePath>Best Practices/Service Templates/Provider-Bridge/EPL/</templatePath> <templateState>PUBLISHED</templateState> <templateType>0</templateType> <eTreeType>NA</eTreeType> </ServiceTemplate>

    External Docs
    See Also :

    Operation

    get /esmBrowser/svcTemplate/getServiceTemplateDetails/{id}
    ServiceTemplates (getServiceTemplateDetails : /esmBrowser/svcTemplate/getServiceTemplateDetails/{id})
    This method fetches particular Service Template details including cli details and oam details based on given Template Name.Exception is thrown if no cli details are retrived for given Mdid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required DB record id of the template ---

    Return type
  • ServiceTemplate
  • Responses

    Response Messages

    Schema

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

    /oms1350/esmBrowser/svcTemplate/getServiceTemplateDetails/1

    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
    { "templateId": 1, "templateName": "Service_EPL_AccessIngressQoS_IP", "templatePath": "Best Practices/Service Templates/MPLS-TP/EPL/", "customer": "''", "author": "alcatel", "descr": "Best Practices for MPLS-TP Service", "serviceType": "EPL", "policyPortList": [], "templateState": "PUBLISHED", "createTime": 0, "modifyTime": 0, "preProvCliCmd": "", "postProvCliCmd": "", "oamTemplateName": "OAM_FOR_Service", "oamMaNAme": "OAMSvc", "oamTemplatePath": "Best Practices/OAM Template", "oamMdId": 2, "oamMdLevel": 3, "oamMdFormat": "NONE", "pmState": -1, "egressRate": "Default", "egressMaxBurst": "None", "aggMeterRate": "0", "aggMeterBurst": "Default", "ingressEnabled": 0, "egressEnabled": 0, "llfEnabled": 0, "l2ptEnabled": 0, "lacpEnabled": 0, "eplOp2TunnelEnabled": 0, "numberOfMeterForPolicy": 0, "repProf15m": "null", "repProf24h": "null", "tcaProfName": "null", "templateType": 1, "policyNameForMPLS": "Best Practices/QoS Templates/ACCESSINGRESSQOS_IP", "pwStatusSignalEnabled": "Y", "pwControlChannelEnabled": "Y", "pwAcknowledgementEnabled": "N", "epStandbySignallingMaster": "N", "epStandbySignallingSlave": "N", "pwRefreshTimer": 0, "pwRequestTimer": 0, "pwRetryTimer": 0, "pwTimeoutMultiplier": 0, "epRevertTimer": 0, "epActiveHoldDelay": 0, "mplstp_handle": 0, "allMeters2R3C2": false, "oamtemplateMAHolders": [ { "templateName": "Best Practices/OAM Template/OAM_FOR_Service", "maName": "OAMSvc", "author": "alcatel", "description": "Best practice OAM for Service", "oamSupported": "1", "maFormat": "ITU-ICC", "ccmInterval": "1s", "mhfCreation": "0", "direction": "UP", "interfaceType": "SAP", "active": "true", "controlMep": "false", "lowestPriorityDefect": "MAC, Remote, Error, Xcon", "ccmEnable": "true", "ccmPriority": 7, "aisEnable": "false", "aisPriority": 7, "aisInterval": 60, "aisLevel": null, "aisLevel1": false, "aisLevel2": false, "aisLevel3": false, "aisLevel4": false, "aisLevel5": false, "aisLevel6": false, "aisLevel7": false, "id": 2, "mdId": 2 } ] }

    External Docs
    See Also :

    Operation

    get /esmBrowser/svcTemplate/getServiceTemplateJson/{context}
    ServiceTemplates (getServiceTemplateJson : /esmBrowser/svcTemplate/getServiceTemplateJson/{context})
    This method fetches particular Service Template details including cli details and oam details based on given Template Name.Exception is thrown if no cli details are retrived for given Mdid

    Path parameters

    Name

    IsRequired

    Description

    Enum

    context required template name [Stringvalue]

    Return type
  • ServiceTemplate
  • Responses

    Response Messages

    Schema

    200success ServiceTemplate
    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 :

    MAHolder

    Name

    Type

    Description

    Enum

    templateName String string TemplateName ---
    maName String string MA name ---
    author String string Author for the OAM template ---
    description String string Description for the OAM Template ---
    oamSupported String string isOamSupported [Enable, disable]
    maFormat String string MA format [ITU-ICC]
    ccmInterval String string CCM interval for the MA ---
    mhfCreation String string MHF Creation to be supported ---
    direction String string MEP direction [true, false]
    interfaceType String string MEP Interface type [SAP, PATH]
    active String string MEP Active [true, false]
    controlMep String string Control MEP enabled [true, false]
    lowestPriorityDefect String string Lowest priority defect on the MEP ['All Defects', 'MAC, Remote, Error, Xcon', 'Remote, Error, Xcon', 'Error, Xcon', 'Xcon only', 'No defects Xcon or lower']
    ccmEnable String string CCM Enabled [true, false]
    ccmPriority Integer integer CCM Priority [0, 1, 2, 3, 4, 5, 6, 7]
    aisEnable String string AIS Enabled [true, false]
    aisPriority Integer integer AIS priority [0, 1, 2, 3, 4, 5, 6, 7]
    aisInterval Integer integer AIS Interval [1, 60]
    aisLevel array[Boolean] boolean AIS levels list ---
    aisLevel1 Boolean boolean isAisLevel1 ---
    aisLevel2 Boolean boolean isAisLevel2 ---
    aisLevel3 Boolean boolean isAisLevel3 ---
    aisLevel4 Boolean boolean isAisLevel4 ---
    aisLevel5 Boolean boolean isAisLevel5 ---
    aisLevel6 Boolean boolean isAisLevel6 ---
    aisLevel7 Boolean boolean isAisLevel7 ---
    id Long long Id ---
    mdId Long long MdId ---

    nPolicyName

    Name

    Type

    Description

    Enum

    policyName String string --- ---
    portMode String string --- ---

    PMServReportProfileObj

    Name

    Type

    Description

    Enum

    repId Long long returns report id ---
    format Long long format ---
    userlabel String string userlabel ---
    repository Long long return repository ---
    window Long long report window ---
    destType Long long destType ---
    destName String string Specifies the path where the file is getting stored ---
    secLabel Long long return secLabel ---
    reSol Long long reSol ---
    domainId Long long return domainId ---

    ServiceTemplate

    Name

    Type

    Description

    Enum

    templateId Long long templateId ---
    templateName String string templateName ---
    templatePath String string templatePath ---
    customer String string customer ---
    author String string author ---
    descr String string descr ---
    serviceType String string serviceType [EPL, EVPLAN, EVPL, EPLAN, EPTREE, EVPTREE]
    eTreeType String string eTreeType [Asymmetric VLAN, SHG]
    policyPortList array[nPolicyName] nPolicyName policyPortList ---
    templateState String string templateState [PUBLISHED, UNPUBLISHED]
    createTime Long long createTime ---
    modifyTime Long long modifyTime ---
    preProvCliCmd String string preProvCliCmd ---
    postProvCliCmd String string preProvCliCmd ---
    oamTemplateName String string oamTemplateName ---
    oamMaNAme String string oamMaNAme ---
    oamTemplatePath String string oamTemplatePath ---
    oamMdId Integer integer oamMdId ---
    oamMdLevel Integer integer oamMdLevel ---
    oamMdFormat String string oamMdFormat ---
    demarcOamTemplateName String string --- ---
    demarcOamMaNAme String string --- ---
    demarcOamTemplatePath String string --- ---
    demarcOamMdId Integer integer --- ---
    demarcOamMdLevel Integer integer --- ---
    demarcOamMdFormat String string --- ---
    pmState Integer integer pmState ---
    egressRate String string egressRate ---
    egressMaxBurst String string egressMaxBurst [none, 32 to 16384]
    aggMeterRate String string aggMeterRate ---
    aggMeterBurst String string aggMeterBurst ---
    egressRateOper String string egressRateOper ---
    ingressEnabled Integer integer ingressEnabled ---
    egressEnabled Integer integer egressEnabled ---
    llfEnabled Integer integer llfEnabled ---
    l2ptEnabled Integer integer l2ptEnabled ---
    lacpEnabled Integer integer lacpEnabled ---
    eplOp2TunnelEnabled Integer integer --- ---
    cacEnabled Integer integer --- ---
    numberOfMeterForPolicy Integer integer numberOfMeterForPolicy ---
    repProf15m String string repProf15m ---
    repProf24h String string repProf24h ---
    tcaProfName String string tcaProfName ---
    templateType Integer integer --- ---
    policyNameForMPLS String string Policy instance name ---
    pwStatusSignalEnabled String string Status Signal Enable/Disable ---
    pwControlChannelEnabled String string Control Channel Enable/Disable ---
    pwAcknowledgementEnabled String string PW Acknowledgement Enable/Disable ---
    epStandbySignallingMaster String string Stand By Signalling Master ---
    epStandbySignallingSlave String string Stand By Signalling Slave ---
    pwRefreshTimer Long long Refresh Timer in Seconds ---
    pwRequestTimer Long long Request Timer in Seconds ---
    pwRetryTimer Long long Retry Timer in Seconds ---
    pwTimeoutMultiplier Long long Timeout Multiplier in Seconds ---
    epRevertTimer Long long Revert Timer in Seconds ---
    epActiveHoldDelay Long long Active Hold Delay in deciSeconds ---
    mplstp_handle Long long --- ---
    demarcOAMTemplateMAHolders array[MAHolder] MAHolder --- ---
    policyName String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    allMeters2R3C2 Boolean boolean isAllMeters2R3C2 ---

    ServiceTemplateHolder

    Name

    Type

    Description

    Enum

    svcTemplateHolders array[ServiceTemplate] ServiceTemplate List ---
    items array[ServiceTemplate] ServiceTemplate --- ---