Operation

get /esmService/policyBrowser/getAllPortAccessPolicies
getAllPortAccessPolicies (getAllAccessBestPractices : /esmService/policyBrowser/getAllPortAccessPolicies)
read QOS Access Best Practices Policy List


Return type
  • PolicyInstRespHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/getAllPortAccessPolicies

    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
    [{"createtime":0,"author":"null","bestpractice":true,"state":"PUBLISHED","policytype":"Access","policyid":80016,"policyname":"ACCESSEGRESSQOS_Dot1P","lastupdatedtime":0,"policydescription":null,"policyrecordtype":0,"policykeyname":null,"policykeyvalue":null,"path":"Best Practices/QoS Templates/Access Egress Templates/","templatetype":1},{"createtime":0,"author":"null","bestpractice":true,"state":"PUBLISHED","policytype":"Access","policyid":80018,"policyname":"ACCESSEGRESSQOS_Dot1PandLSP-EXP","lastupdatedtime":0,"policydescription":null,"policyrecordtype":0,"policykeyname":null,"policykeyvalue":null,"path":"Best Practices/QoS Templates/Access Egress Templates/","templatetype":1}]

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/getAllInterfaceNetworkPolicies
    getAllInterfaceNetworkPolicies (getAllInterfaceNetworkPolicies : /esmService/policyBrowser/getAllInterfaceNetworkPolicies)
    read QOS Network Best Practices List


    Return type
  • PolicyInstRespHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/getAllInterfaceNetworkPolicies

    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
    [{"createtime":0,"author":"null","bestpractice":true,"state":"PUBLISHED","policytype":"Network","policyid":80020,"policyname":"MPLSTP_NWTPOLICY_Dot1PandLSP-EXP","lastupdatedtime":0,"policydescription":null,"policyrecordtype":0,"policykeyname":null,"policykeyvalue":null,"path":"Best Practices/QoS Templates/Network Templates/","templatetype":1}]

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/getAllPortNetworkPolicies
    getAllPortNetworkPolicies (getAllPortNetworkPolicies : /esmService/policyBrowser/getAllPortNetworkPolicies)
    read QOS Network Best Practices List


    Return type
  • PolicyInstRespHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/getAllPortNetworkPolicies

    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
    [{"createtime":0,"author":"null","bestpractice":true,"state":"PUBLISHED","policytype":"Network","policyid":80019,"policyname":"MPLSTP_PORT_NWTPOLICY","lastupdatedtime":0,"policydescription":null,"policyrecordtype":0,"policykeyname":null,"policykeyvalue":null,"path":"Best Practices/QoS Templates/Network Templates/","templatetype":1}]

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/getAuthorDescrForSavePolicy/{policyName}
    getAuthorDescrForSavePolicy (getAuthorDescrForSavePolicy : /esmService/policyBrowser/getAuthorDescrForSavePolicy/{policyName})
    Qives all the details of QOS template along with Author and Descr for saved policy

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ,can be retrived as policyName attribute from /esmService/policyBrowser/readAccessPolicyList ---

    Return type
  • ServiceTemplate
  • Responses

    Response Messages

    Schema

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

    /oms1350/esmService/policyBrowser/getAuthorDescrForSavePolicy/Best%20Practices+QoS%20Templates+ACCESSINGRESSQOS_MAC

    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> <allMeters2R3C2>false</allMeters2R3C2> <author>null</author> <className>SvcTemplateHolder</className> <createTime>0</createTime> <descr>ACCESSQOS_MatchMAC</descr> <epActiveHoldDelay>0</epActiveHoldDelay> <epRevertTimer>0</epRevertTimer> <epStandbySignallingSlave>N</epStandbySignallingSlave> <id>0</id> <key>SvcTemplateHolder/0</key> <modifyTime>0</modifyTime> <mplstp_handle>0</mplstp_handle> <numberOfMeterForPolicy>0</numberOfMeterForPolicy> <oamMdId>0</oamMdId> <oamMdLevel>0</oamMdLevel> <pwRefreshTimer>0</pwRefreshTimer> <pwRequestTimer>0</pwRequestTimer> <pwRetryTimer>0</pwRetryTimer> <pwTimeoutMultiplier>0</pwTimeoutMultiplier> <templateId>0</templateId> <templateType>0</templateType> </ServiceTemplate>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/getCirPirAggregateValuesFromPolicyName/{policyName}
    getCirPirAggregateValuesFromPolicyName (getCirPirValuesFromPolicyId : /esmService/policyBrowser/getCirPirAggregateValuesFromPolicyName/{policyName})
    return QOS CIR PIR Aggregate For Save Policy

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---

    Return type
  • CirPirAggregateDataHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/getCirPirAggregateValuesFromPolicyName/My%20Templates+QoS%20Templates+Access+POLICY_INSTANCE_80325

    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
    { cir: 0, pir: 60000032, cirUnit: "kbps", pirUnit: "kbps" }

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/getPolicyDetailsByName/{policyName}
    getPolicyDetailsByName (getPolicyDetailsByName : /esmService/policyBrowser/getPolicyDetailsByName/{policyName})
    read QOS Network Policy List

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---

    Return type
  • PolicyInstRespHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/getPolicyDetailsByName/My%20Templates+QoS%20Templates+DiscoveredQoS_Access1468171644754

    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
    {"policyID":80027,"policyName":"My Templates/QoS Templates/DiscoveredQoS_Access1468171644754","policyPath":null,"policyDescription":null,"bestPractice":false,"policyType":"Access","state":null,"author":null,"policyScope":2,"servicePolicyType":0,"policyRecordType":0,"tpid":0,"oldPolicyId":0,"interfaceId":0,"handle":0,"policyList":null,"additionalInfo":null,"changedParams":null,"policyChanged":false}

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessEgressProfile/{policyName}/{neName}
    readAccessEgressProfile (readAccessEgressProfileDetails : /esmService/policyBrowser/readAccessEgressProfile/{policyName}/{neName})
    return QOS Access Egress Profile

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessEgressProfile/Best%20Practices+QoS%20Templates+ACCESSINGRESSQOS_IP/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80027</policyID> <bestPractice>false</bestPractice> <accessEgressPolicy> <accessEgressQueueList/> <accessEgressFCList> <accessEgressFC> <profileId>1</profileId> <accessOutProfile>2</accessOutProfile> <accessInProfile>2</accessInProfile> <cosName>AF</cosName> <changedParameters/> </accessEgressFC> <accessEgressFC> <profileId>2</profileId> <accessInProfile>0</accessInProfile> <accessOutProfile>0</accessOutProfile> <cosName>Best-Effort</cosName> <changedParameters/> </accessEgressFC> <accessEgressFC> <profileId>3</profileId> <accessInProfile>5</accessInProfile> <accessOutProfile>5</accessOutProfile> <cosName>EF</cosName> <changedParameters/> </accessEgressFC> <accessEgressFC> <profileId>4</profileId> <accessOutProfile>6</accessOutProfile> <accessInProfile>6</accessInProfile> <cosName>High-1</cosName> <changedParameters/> </accessEgressFC> <accessEgressFC> <profileId>5</profileId> <accessOutProfile>4</accessOutProfile> <accessInProfile>4</accessInProfile> <cosName>High-2</cosName> <changedParameters/> </accessEgressFC> <accessEgressFC> <profileId>6</profileId> <accessOutProfile>3</accessOutProfile> <accessInProfile>3</accessInProfile> <cosName>Low-1</cosName> <changedParameters/> </accessEgressFC> <accessEgressFC> <profileId>7</profileId> <accessInProfile>1</accessInProfile> <accessOutProfile>1</accessOutProfile> <cosName>Low-2</cosName> <changedParameters/> </accessEgressFC> <accessEgressFC> <profileId>8</profileId> <accessInProfile>7</accessInProfile> <accessOutProfile>7</accessOutProfile> <cosName>NC</cosName> <changedParameters/> </accessEgressFC> </accessEgressFCList> </accessEgressPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessEgressQos/{policyName}/{neName}
    readAccessEgressQos (readAccessEgressQosDetails : /esmService/policyBrowser/readAccessEgressQos/{policyName}/{neName})
    return QOS Access Egress details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessEgressQos/Best%20Practices+QoS%20Templates+Access%20Egress%20Templates+BP_PB_ACCESSEGRESSQoS/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80023</policyID> <bestPractice>true</bestPractice> <accessEgressPolicy> <remarking>Disabled</remarking> <accessEgressQueueList/> <accessEgressFCList/> </accessEgressPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessEgressQueue/{policyName}/{neName}
    readAccessEgressQueue (readAccessEgressQueueDetails : /esmService/policyBrowser/readAccessEgressQueue/{policyName}/{neName})
    return QOS Access Egress Queue

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName, NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessEgressQueue/Best%20Practices+QoS%20Templates+Access%20Egress%20Templates+BP_PB_ACCESSEGRESSQoS/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80023</policyID> <bestPractice>true</bestPractice> <accessEgressPolicy> <accessEgressQueueList> <accessEgressQueue> <queueId>1</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>Best-Effort</cosName> <changedParameters/> </accessEgressQueue> <accessEgressQueue> <queueId>2</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>Low-2</cosName> <changedParameters/> </accessEgressQueue> <accessEgressQueue> <queueId>3</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>AF</cosName> <changedParameters/> </accessEgressQueue> <accessEgressQueue> <queueId>4</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>Low-1</cosName> <changedParameters/> </accessEgressQueue> <accessEgressQueue> <queueId>5</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>High-2</cosName> <changedParameters/> </accessEgressQueue> <accessEgressQueue> <queueId>6</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>EF</cosName> <changedParameters/> </accessEgressQueue> <accessEgressQueue> <queueId>7</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>High-1</cosName> <changedParameters/> </accessEgressQueue> <accessEgressQueue> <queueId>8</queueId> <accEgrPIRAdminunit>kbps</accEgrPIRAdminunit> <accEgrPIRAdmin>Max</accEgrPIRAdmin> <accEgrCIRAdminunit>kbps</accEgrCIRAdminunit> <accEgrPIRrule>Closest</accEgrPIRrule> <accEgrCIRrule>Closest</accEgrCIRrule> <accEgrCIRAdmin>0</accEgrCIRAdmin> <cosName>NC</cosName> <changedParameters/> </accessEgressQueue> </accessEgressQueueList> <accessEgressFCList/> </accessEgressPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessIngressCos/{policyName}/{neName}/{tpNativeName}/{serviceName}
    readAccessIngressCos (readAccessIngressCosDetails : /esmService/policyBrowser/readAccessIngressCos/{policyName}/{neName}/{tpNativeName}/{serviceName})
    return QOS Access Ingress Cos

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName , NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---
    tpNativeName required tpNativeName ---
    serviceName required serviceName ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessIngressCos/My%20Templates+QoS%20Templates+DiscoveredQoS_Access1468171644754/PSS32-BA-01/11QPE24-1-4-C21/PB-MCLAG-Incon

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80001</policyID> <bestPractice>false</bestPractice> <accessIngressPolicy> <accessIngressMatchCriterionList> <accessIngressMatchCriterion> <trafficMatchId>1</trafficMatchId> <dscpValue>AF11</dscpValue> <trafficMatchCriterionType>TRAFFICMATCH_IPDSCP</trafficMatchCriterionType> <cosName>Low-2</cosName> <changedParameters/> </accessIngressMatchCriterion> <accessIngressMatchCriterion> <trafficMatchId>2</trafficMatchId> <dscpValue>AF12</dscpValue> <trafficMatchCriterionType>TRAFFICMATCH_IPDSCP</trafficMatchCriterionType> <cosName>AF</cosName> <changedParameters/> </accessIngressMatchCriterion> <accessIngressMatchCriterion> <trafficMatchId>3</trafficMatchId> <dscpValue>AF13</dscpValue> <trafficMatchCriterionType>TRAFFICMATCH_IPDSCP</trafficMatchCriterionType> <cosName>NC</cosName> <changedParameters/> </accessIngressMatchCriterion> </accessIngressMatchCriterionList> <accessIngressMeterList/> <accessCosMeterList/> </accessIngressPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessIngressMatch/{policyName}/{neName}/{tpNativeName}/{serviceName}
    readAccessIngressMatch (readAccessIngressMatchDetails : /esmService/policyBrowser/readAccessIngressMatch/{policyName}/{neName}/{tpNativeName}/{serviceName})
    return QOS Access Ingress Match

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---
    tpNativeName required tpNativeName ---
    serviceName required serviceName ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessIngressMatch/Best%20Practices+QoS%20Templates+ACCESSINGRESSQOS_IP/SETUP-4V1-K/0/0

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80001</policyID> <bestPractice>false</bestPractice> <accessIngressPolicy> <accessIngressMatchCriterionList> <accessIngressMatchCriterion> <trafficMatchId>1</trafficMatchId> <dscpValue>AF11</dscpValue> <trafficMatchCriterionType>TRAFFICMATCH_IPDSCP</trafficMatchCriterionType> <cosName>Low-2</cosName> <changedParameters/> </accessIngressMatchCriterion> <accessIngressMatchCriterion> <trafficMatchId>2</trafficMatchId> <dscpValue>AF12</dscpValue> <trafficMatchCriterionType>TRAFFICMATCH_IPDSCP</trafficMatchCriterionType> <cosName>AF</cosName> <changedParameters/> </accessIngressMatchCriterion> <accessIngressMatchCriterion> <trafficMatchId>3</trafficMatchId> <dscpValue>AF13</dscpValue> <trafficMatchCriterionType>TRAFFICMATCH_IPDSCP</trafficMatchCriterionType> <cosName>NC</cosName> <changedParameters/> </accessIngressMatchCriterion> </accessIngressMatchCriterionList> <accessIngressMeterList/> <accessCosMeterList/> </accessIngressPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessIngressMeter/{policyName}/{neName}/{tpNativeName}/{serviceName}
    readAccessIngressMeter (readAccessIngressMeterDetails : /esmService/policyBrowser/readAccessIngressMeter/{policyName}/{neName}/{tpNativeName}/{serviceName})
    return QOS Access Ingress Meter

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---
    tpNativeName required tpNativeName ---
    serviceName required serviceName ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessIngressMeter/Best%20Practices+QoS%20Templates+ACCESSINGRESSQOS_IP/SETUP-4V1-K/0/0

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80001</policyID> <bestPractice>false</bestPractice> <accessIngressPolicy> <accessIngressMatchCriterionList/> <accessIngressMeterList> <accessIngressMeter> <meterId>1</meterId> <accessIngrCIRAdmin>0</accessIngrCIRAdmin> <accessIngrPbsAdmin>512</accessIngrPbsAdmin> <meterType>UniCast</meterType> <accessIngrCbsAdmin>32</accessIngrCbsAdmin> <accIngrPIRrule>Closest</accIngrPIRrule> <accessIngrPIRAdmin>20000000</accessIngrPIRAdmin> <meterMode>2R3C-1</meterMode> <accIngrCIRrule>Closest</accIngrCIRrule> <changedParameters/> </accessIngressMeter> <accessIngressMeter> <meterId>2</meterId> <accessIngrCIRAdmin>0</accessIngrCIRAdmin> <accessIngrPbsAdmin>512</accessIngrPbsAdmin> <meterType>UniCast</meterType> <accessIngrCbsAdmin>32</accessIngrCbsAdmin> <accIngrPIRrule>Minimum</accIngrPIRrule> <accessIngrPIRAdmin>20000000</accessIngrPIRAdmin> <meterMode>2R3C-1</meterMode> <accIngrCIRrule>Minimum</accIngrCIRrule> <changedParameters/> </accessIngressMeter> <accessIngressMeter> <meterId>11</meterId> <accessIngrCIRAdmin>0</accessIngrCIRAdmin> <accessIngrPbsAdmin>512</accessIngrPbsAdmin> <meterType>Multipoint</meterType> <accessIngrCbsAdmin>32</accessIngrCbsAdmin> <accIngrPIRrule>Closest</accIngrPIRrule> <accessIngrPIRAdmin>20000000</accessIngrPIRAdmin> <meterMode>2R3C-2</meterMode> <accIngrCIRrule>Closest</accIngrCIRrule> <changedParameters/> </accessIngressMeter> </accessIngressMeterList> <accessCosMeterList/> </accessIngressPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessIngressPolicy/{policyName}/{neName}/{tpNativeName}/{serviceName}
    readAccessIngressPolicy (readAccessIngressPolicyDetails : /esmService/policyBrowser/readAccessIngressPolicy/{policyName}/{neName}/{tpNativeName}/{serviceName})
    return QOS Access Ingress Policy

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName, NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---
    tpNativeName required tpNativeName ---
    serviceName required serviceName ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessIngressPolicy/Best%20Practices+QoS%20Templates+ACCESSINGRESSQOS_IP/SETUP-4V1-K/0/0

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80001</policyID> <bestPractice>false</bestPractice> <accessIngressPolicy> <defaultCOS>Low-2</defaultCOS> <trafficMatchCriterionType>Trust IP</trafficMatchCriterionType> <numberOfMeters>32</numberOfMeters> <accessIngressMatchCriterionList/> <accessIngressMeterList/> <accessCosMeterList/> <changedParameters/> </accessIngressPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readAccessPolicyList
    readAccessPolicyList (readAccessPolicyList : /esmService/policyBrowser/readAccessPolicyList)
    return QOS Access Policy List


    Return type
  • PolicyInstRespHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readAccessPolicyList

    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
    <PolicyInstRespHolderList> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <responseList> <response> <policyID>80001</policyID> <policyName>Best Practices/QoS Templates/ACCESSINGRESSQOS_IP</policyName> <policyDescription>ACCESSQOS_MatchIP</policyDescription> <bestPractice>true</bestPractice> <policyType>Access</policyType> <policyScope>2</policyScope> <servicePolicyType>0</servicePolicyType> <policyRecordType>0</policyRecordType> <tpid>0</tpid> <oldPolicyId>0</oldPolicyId> <interfaceId>0</interfaceId> <isPolicyChanged>false</isPolicyChanged> <handle>0</handle> </response> </responseList> </PolicyInstRespHolderList>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readEgressPortSchedulingPolicy/{policyName}/{neName}
    readEgressPortSchedulingPolicy (readEgressPortSchedulingPolicy : /esmService/policyBrowser/readEgressPortSchedulingPolicy/{policyName}/{neName})
    return QOS Egress Port Scheduling Policy

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readEgressPortSchedulingPolicy/My%20Templates+QoS%20Templates+DiscoveredQoS_Access1468171644754/PSS32-BA-01?dojo.preventCache=1468496300600

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80027</policyID> <bestPractice>false</bestPractice> <egressPortSchedulerPolicy> <egressPortData> <schedulerMode>Strict</schedulerMode> <queueWeight7>Strict</queueWeight7> <queueWeight8>Strict</queueWeight8> <queueWeight5>Strict</queueWeight5> <queueWeight6>Strict</queueWeight6> <useDefault>Yes</useDefault> <queueWeight3>Strict</queueWeight3> <queueWeight4>Strict</queueWeight4> <queueWeight1>Strict</queueWeight1> <queueWeight2>Strict</queueWeight2> <changedParameters/> </egressPortData> </egressPortSchedulerPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readEgressQueueSlopingPolicy/{policyName}/{neName}
    readEgressQueueSlopingPolicy (readEgressQueueSlopingPolicy : /esmService/policyBrowser/readEgressQueueSlopingPolicy/{policyName}/{neName})
    get QOS Egress Queue Sloping Policy

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readEgressQueueSlopingPolicy/Best%20Practices+QoS%20Templates+Sloping%20Templates+BP_Sloping_Policy/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80022</policyID> <bestPractice>true</bestPractice> <policyType>Sloping</policyType> <egressQoSSlopingPolicy> <EgressQueueSlopingList> <EgressQueueSloping> <queueId>1</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>2</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>3</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>4</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>5</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>6</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>7</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>8</queueId> <slopeType>High</slopeType> <startAverage>70</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>90</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>1</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>2</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>3</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>4</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>5</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>6</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>7</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>8</queueId> <slopeType>Low</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>1</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>2</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>3</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>4</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>5</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>6</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>7</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> <EgressQueueSloping> <queueId>8</queueId> <slopeType>Non-TCP</slopeType> <startAverage>50</startAverage> <maxProbability>75</maxProbability> <redSlopeEnabled>No</redSlopeEnabled> <timeAverageFactor>7</timeAverageFactor> <useDefault>Yes</useDefault> <maxAverage>75</maxAverage> <changedParameters/> </EgressQueueSloping> </EgressQueueSlopingList> </egressQoSSlopingPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkEgressProfile/{policyName}/{neName}
    readNetworkEgressProfile (readNetworkEgressProfileDetails : /esmService/policyBrowser/readNetworkEgressProfile/{policyName}/{neName})
    return QOS Network Egress Profile

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkEgressProfile/Best%20Practices+QoS%20Templates+Network%20QoS%20Templates+BP_PB_NETWORKPOLICYQoS2/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80026</policyID> <bestPractice>true</bestPractice> <networkQoSPolicy> <networkEgressParams> <NetworkEgressFCDataList> <NetworkEgressFCData> <profileId>1</profileId> <outProfileValue>0</outProfileValue> <inProfileValue>0</inProfileValue> <cosName>Best-Effort</cosName> <changedParameters/> </NetworkEgressFCData> <NetworkEgressFCData> <profileId>2</profileId> <outProfileValue>1</outProfileValue> <inProfileValue>1</inProfileValue> <cosName>Low-2</cosName> <changedParameters/> </NetworkEgressFCData> <NetworkEgressFCData> <profileId>3</profileId> <outProfileValue>2</outProfileValue> <inProfileValue>2</inProfileValue> <cosName>AF</cosName> <changedParameters/> </NetworkEgressFCData> <NetworkEgressFCData> <profileId>4</profileId> <outProfileValue>3</outProfileValue> <inProfileValue>3</inProfileValue> <cosName>Low-1</cosName> <changedParameters/> </NetworkEgressFCData> <NetworkEgressFCData> <profileId>5</profileId> <outProfileValue>6</outProfileValue> <inProfileValue>6</inProfileValue> <cosName>High-1</cosName> <changedParameters/> </NetworkEgressFCData> <NetworkEgressFCData> <profileId>6</profileId> <outProfileValue>5</outProfileValue> <inProfileValue>5</inProfileValue> <cosName>EF</cosName> <changedParameters/> </NetworkEgressFCData> <NetworkEgressFCData> <profileId>7</profileId> <outProfileValue>4</outProfileValue> <inProfileValue>4</inProfileValue> <cosName>High-2</cosName> <changedParameters/> </NetworkEgressFCData> <NetworkEgressFCData> <profileId>8</profileId> <outProfileValue>7</outProfileValue> <inProfileValue>7</inProfileValue> <cosName>NC</cosName> <changedParameters/> </NetworkEgressFCData> </NetworkEgressFCDataList> </networkEgressParams> </networkQoSPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkEgressQos/{policyName}/{neName}
    readNetworkEgressQos (readNetworkEgressQosDetails : /esmService/policyBrowser/readNetworkEgressQos/{policyName}/{neName})
    return QOS Network Egress details

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkEgressQos/Best%20Practices+QoS%20Templates+Network%20QoS%20Templates+BP_PB_NETWORKPOLICYQoS2/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80026</policyID> <bestPractice>true</bestPractice> <networkQoSPolicy> <networkEgressParams> <remarking>Disabled</remarking> <NetworkEgressFCDataList/> </networkEgressParams> </networkQoSPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkEgressQueue/{policyName}/{neName}
    readNetworkEgressQueue (readNetworkEgressQueueDetails : /esmService/policyBrowser/readNetworkEgressQueue/{policyName}/{neName})
    return QOS Network Egress Queue

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkEgressQueue/Best%20Practices+QoS%20Templates+NETWORKPOLICY2/SETUP-4V1-K

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80005</policyID> <bestPractice>false</bestPractice> <networkQueuePolicy> <NetworkEgressQueueList> <NetworkEgressQueue> <queueId>1</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>Best-Effort</cosName> <changedParameters/> </NetworkEgressQueue> <NetworkEgressQueue> <queueId>2</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>Low-2</cosName> <changedParameters/> </NetworkEgressQueue> <NetworkEgressQueue> <queueId>3</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>AF</cosName> <changedParameters/> </NetworkEgressQueue> <NetworkEgressQueue> <queueId>4</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>Low-1</cosName> <changedParameters/> </NetworkEgressQueue> <NetworkEgressQueue> <queueId>5</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>High-2</cosName> <changedParameters/> </NetworkEgressQueue> <NetworkEgressQueue> <queueId>6</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>EF</cosName> <changedParameters/> </NetworkEgressQueue> <NetworkEgressQueue> <queueId>7</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>High-1</cosName> <changedParameters/> </NetworkEgressQueue> <NetworkEgressQueue> <queueId>8</queueId> <ntwPIRratio>100</ntwPIRratio> <ntwCIRratio>0</ntwCIRratio> <ntwEgrPIRrule>Closest</ntwEgrPIRrule> <ntwEgrCIRrule>Closest</ntwEgrCIRrule> <cosName>NC</cosName> <changedParameters/> </NetworkEgressQueue> </NetworkEgressQueueList> </networkQueuePolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkIngressCos/{policyName}/{neName}
    readNetworkIngressCos (readNetworkIngressCosDetails : /esmService/policyBrowser/readNetworkIngressCos/{policyName}/{neName})
    return QOS Network Ingress Cos

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkIngressCos/Best%20Practices+QoS%20Templates+Network%20QoS%20Templates+BP_PB_NETWORKPOLICYQoS2/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80026</policyID> <bestPractice>true</bestPractice> <networkQoSPolicy> <networkIngressParams> <NetworkIngressFCDataList/> <NetworkIngressMeterList/> <NetworkCosMeterList> <NetworkCosMeter> <cosId>1</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>Best-Effort</cosName> </NetworkCosMeter> <NetworkCosMeter> <cosId>2</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>Low-2</cosName> </NetworkCosMeter> <NetworkCosMeter> <cosId>3</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>AF</cosName> </NetworkCosMeter> <NetworkCosMeter> <cosId>4</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>Low-1</cosName> </NetworkCosMeter> <NetworkCosMeter> <cosId>5</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>High-2</cosName> </NetworkCosMeter> <NetworkCosMeter> <cosId>6</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>EF</cosName> </NetworkCosMeter> <NetworkCosMeter> <cosId>7</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>High-1</cosName> </NetworkCosMeter> <NetworkCosMeter> <cosId>8</cosId> <changedParameters/> <networkUniMeterId>1</networkUniMeterId> <networkMCMeterId>9</networkMCMeterId> <cosName>NC</cosName> </NetworkCosMeter> </NetworkCosMeterList> <changedParameters/> </networkIngressParams> </networkQoSPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkIngressMeter/{policyName}/{neName}
    readNetworkIngressMeter (readNetworkIngressMeterDetails : /esmService/policyBrowser/readNetworkIngressMeter/{policyName}/{neName})
    return QOS Network Ingress Meter

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkIngressMeter/Best%20Practices+QoS%20Templates+Network%20QoS%20Templates+BP_PB_NETWORKPOLICYQoS2/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80026</policyID> <bestPractice>true</bestPractice> <networkQoSPolicy> <networkIngressParams> <NetworkIngressFCDataList/> <NetworkIngressMeterList> <NetworkIngressMeter> <meterId>1</meterId> <networkIngrCbsAdmin>Default</networkIngrCbsAdmin> <networkIngrCIRrule>Closest</networkIngrCIRrule> <networkIngrCIRAdminunit>kbps</networkIngrCIRAdminunit> <meterType>UniCast</meterType> <networkIngrPIRrule>Closest</networkIngrPIRrule> <networkIngrPIRAdmin>Max</networkIngrPIRAdmin> <networkIngrMbsAdmin>Default</networkIngrMbsAdmin> <networkIngrPIRAdminunit>kbps</networkIngrPIRAdminunit> <networkIngrCIRAdmin>0</networkIngrCIRAdmin> <changedParameters/> </NetworkIngressMeter> <NetworkIngressMeter> <meterId>9</meterId> <networkIngrCbsAdmin>Default</networkIngrCbsAdmin> <networkIngrCIRrule>Closest</networkIngrCIRrule> <networkIngrCIRAdminunit>kbps</networkIngrCIRAdminunit> <meterType>Multipoint</meterType> <networkIngrPIRrule>Closest</networkIngrPIRrule> <networkIngrPIRAdmin>Max</networkIngrPIRAdmin> <networkIngrMbsAdmin>Default</networkIngrMbsAdmin> <networkIngrPIRAdminunit>kbps</networkIngrPIRAdminunit> <networkIngrCIRAdmin>0</networkIngrCIRAdmin> <changedParameters/> </NetworkIngressMeter> </NetworkIngressMeterList> <NetworkCosMeterList/> <changedParameters/> </networkIngressParams> </networkQoSPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkIngressProfile/{policyName}/{neName}
    readNetworkIngressProfile (readNetworkIngressProfileDetails : /esmService/policyBrowser/readNetworkIngressProfile/{policyName}/{neName})
    return QOS Network Ingress Profile

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkIngressProfile/Best%20Practices+QoS%20Templates+Network%20QoS%20Templates+BP_PB_NETWORKPOLICYQoS2/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80026</policyID> <bestPractice>true</bestPractice> <networkQoSPolicy> <networkIngressParams> <NetworkIngressFCDataList> <NetworkIngressFCData> <profileId>1</profileId> <profile>In</profile> <dot1Priority>0</dot1Priority> <cosName>Best-Effort</cosName> <changedParameters/> </NetworkIngressFCData> <NetworkIngressFCData> <profileId>2</profileId> <profile>In</profile> <dot1Priority>1</dot1Priority> <cosName>Low-2</cosName> <changedParameters/> </NetworkIngressFCData> <NetworkIngressFCData> <profileId>3</profileId> <profile>In</profile> <dot1Priority>2</dot1Priority> <cosName>AF</cosName> <changedParameters/> </NetworkIngressFCData> <NetworkIngressFCData> <profileId>4</profileId> <profile>In</profile> <dot1Priority>3</dot1Priority> <cosName>Low-1</cosName> <changedParameters/> </NetworkIngressFCData> <NetworkIngressFCData> <profileId>5</profileId> <profile>In</profile> <dot1Priority>4</dot1Priority> <cosName>High-2</cosName> <changedParameters/> </NetworkIngressFCData> <NetworkIngressFCData> <profileId>6</profileId> <profile>In</profile> <dot1Priority>5</dot1Priority> <cosName>EF</cosName> <changedParameters/> </NetworkIngressFCData> <NetworkIngressFCData> <profileId>7</profileId> <profile>In</profile> <dot1Priority>6</dot1Priority> <cosName>High-1</cosName> <changedParameters/> </NetworkIngressFCData> <NetworkIngressFCData> <profileId>8</profileId> <profile>In</profile> <dot1Priority>7</dot1Priority> <cosName>NC</cosName> <changedParameters/> </NetworkIngressFCData> </NetworkIngressFCDataList> <NetworkIngressMeterList/> <NetworkCosMeterList/> <changedParameters/> </networkIngressParams> </networkQoSPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkIngressQos/{policyName}/{neName}
    readNetworkIngressQos (readNetworkIngressQosDetails : /esmService/policyBrowser/readNetworkIngressQos/{policyName}/{neName})
    return Network Ingress Qos

    Path parameters

    Name

    IsRequired

    Description

    Enum

    policyName required policyName ---
    neName required neName,NE Name, The value for NE Name can be got using GetAllL2CardsList/{localTimeZoneOffset}. If the NE Name has #OCS it has to replaced with %23OCS ---

    Return type
  • PolicyInstHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkIngressQos/Best%20Practices+QoS%20Templates+Network%20QoS%20Templates+BP_PB_NETWORKPOLICYQoS2/PSS32-BA-01

    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
    <PolicyInstHolder> <resId> <cmdStatus>Success</cmdStatus> <jobName/> <objectId>0</objectId> <objectType>0</objectType> <opMsg/> <paramCount>0</paramCount> </resId> <cmdStatus>Success</cmdStatus> <req> <policyID>80026</policyID> <bestPractice>true</bestPractice> <networkQoSPolicy> <networkIngressParams> <defaultCOS>Low-2</defaultCOS> <defaultProfile>Out</defaultProfile> <NetworkIngressFCDataList/> <NetworkIngressMeterList/> <NetworkCosMeterList/> <changedParameters/> </networkIngressParams> </networkQoSPolicy> </req> </PolicyInstHolder>

    External Docs
    See Also :

    Operation

    get /esmService/policyBrowser/readNetworkPolicyList
    readNetworkPolicyList (readNetworkPolicyList : /esmService/policyBrowser/readNetworkPolicyList)
    read QOS Network Policy List


    Return type
  • PolicyInstRespHolder
  • Responses

    Response Messages

    Schema

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

    /esmService/policyBrowser/readNetworkPolicyList

    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
    <PolicyInstRespHolderList> <resId> <cmdStatus>Success</cmdStatus> <opMsg/> <paramCount>0</paramCount> </resId> <responseList> <response> <policyID>80004</policyID> <policyName>Best Practices/QoS Templates/NETWORKPOLICY1</policyName> <policyDescription>NETWORKPOLICY1</policyDescription> <bestPractice>true</bestPractice> <policyType>Network</policyType> <policyScope>2</policyScope> <servicePolicyType>0</servicePolicyType> <policyRecordType>0</policyRecordType> <tpid>0</tpid> <oldPolicyId>0</oldPolicyId> <interfaceId>0</interfaceId> <isPolicyChanged>false</isPolicyChanged> <handle>0</handle> </response> </responseList> </PolicyInstRespHolderList>

    External Docs
    See Also :

    AbstractPolicy

    Name

    Type

    Description

    Enum

    policyType String string policyType [ ]
    additionalInfo Object object --- ---

    CirPirAggregateDataHolder

    Name

    Type

    Description

    Enum

    cir String string Cir Value [ ]
    usedCir String string --- ---
    pir String string Pir Value [ ]
    usedPir String string --- ---
    cirUnit String string Cir Unit [ ]
    pirUnit String string Pir Unit [ ]
    availableCir String string --- ---
    availableCirUnit String string --- ---
    availablePir String string --- ---
    availablePirUnit String string --- ---
    neName String string --- ---
    tpNativeName String string --- ---
    id String string --- ---
    portRate String string --- ---
    stdPortRate String string --- ---
    bandwidthCheck String string --- ---
    tpType String string --- ---
    key String string --- ---
    className String string --- ---

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

    N_AccessEgressPolicyMapper

    Name

    Type

    Description

    Enum

    accessEgresData Object object --- ---
    accessEgressQueue array[N_QueueDataMapper] N_QueueDataMapper --- ---
    accessEgressFC array[N_FCDataMapper] N_FCDataMapper --- ---
    changedParam array[String] string --- ---
    additionalInfo Object object --- ---

    N_AccessIngressPolicyMapper

    Name

    Type

    Description

    Enum

    accessIngresData Object object --- ---
    accessIngressMatchCriterion array[N_TrafficMatchDataMapper] N_TrafficMatchDataMapper --- ---
    accessIngressMeter array[N_MeteringDataMapper] N_MeteringDataMapper --- ---
    accessCosMeter array[N_CosMeterDataMapper] N_CosMeterDataMapper --- ---
    changedParam array[String] string --- ---
    additionalInfo Object object --- ---

    N_CosMeterDataMapper

    Name

    Type

    Description

    Enum

    cosId Long long --- ---
    changedParam array[String] string --- ---
    accessIngressCos Object object --- ---

    N_EgressPortSchedulerPolicyMapper

    Name

    Type

    Description

    Enum

    egressPortSchedulerData Object object --- ---
    portSchedulerData N_PortSchedulerDataMapper N_PortSchedulerDataMapper --- ---
    changedParam array[String] string --- ---
    additionalInfo Object object --- ---

    N_EgressQoSSlopingPolicyMapper

    Name

    Type

    Description

    Enum

    egressSlopingQueue array[N_SlopingQueueDataMapper] N_SlopingQueueDataMapper --- ---
    additionalInfo Object object --- ---

    N_FCDataMapper

    Name

    Type

    Description

    Enum

    profileId Long long --- ---
    profileData Object object --- ---
    changedParam array[String] string --- ---

    N_MeteringDataMapper

    Name

    Type

    Description

    Enum

    meterId Long long --- ---
    changedParam array[String] string --- ---
    accessIngressMeter Object object --- ---

    N_MPLSLSPEXPDataMapper

    Name

    Type

    Description

    Enum

    mplsLspExpFCData array[N_FCDataMapper] N_FCDataMapper --- ---

    N_NetworkEgressDataMapper

    Name

    Type

    Description

    Enum

    networkEgresData Object object --- ---
    networkEgressFCData array[N_FCDataMapper] N_FCDataMapper --- ---

    N_NetworkIngressDataMapper

    Name

    Type

    Description

    Enum

    networkIngressData Object object --- ---
    networkCosMeter array[N_CosMeterDataMapper] N_CosMeterDataMapper --- ---
    changedParam array[String] string --- ---
    networkIngressFCData array[N_FCDataMapper] N_FCDataMapper --- ---
    networkIngressMeter array[N_MeteringDataMapper] N_MeteringDataMapper --- ---

    N_NetworkQoSPolicyMapper

    Name

    Type

    Description

    Enum

    additionalInfo Object object --- ---
    networkIngressParams N_NetworkIngressDataMapper N_NetworkIngressDataMapper --- ---
    networkEgressParams N_NetworkEgressDataMapper N_NetworkEgressDataMapper --- ---

    N_NetworkQueuePolicyMapper

    Name

    Type

    Description

    Enum

    additionalInfo Object object --- ---
    networkEgressQueue array[N_QueueDataMapper] N_QueueDataMapper --- ---

    N_PolicyInstMapper

    Name

    Type

    Description

    Enum

    policyID Long long --- ---
    policyName String string --- ---
    policyDescription String string --- ---
    bestPractice Boolean boolean --- ---
    policyType String string --- ---
    accessIngressPolicy N_AccessIngressPolicyMapper N_AccessIngressPolicyMapper --- ---
    accessEgressPolicy N_AccessEgressPolicyMapper N_AccessEgressPolicyMapper --- ---
    networkQoSPolicy N_NetworkQoSPolicyMapper N_NetworkQoSPolicyMapper --- ---
    networkQueuePolicy N_NetworkQueuePolicyMapper N_NetworkQueuePolicyMapper --- ---
    egressPortSchedulerPolicy N_EgressPortSchedulerPolicyMapper N_EgressPortSchedulerPolicyMapper --- ---
    egressQoSSlopingPolicy N_EgressQoSSlopingPolicyMapper N_EgressQoSSlopingPolicyMapper --- ---
    remarkingPolicy N_RemarkingDataMapper N_RemarkingDataMapper --- ---
    mplsLspExpPolicy N_MPLSLSPEXPDataMapper N_MPLSLSPEXPDataMapper --- ---
    additionalInfo Object object --- ---

    N_PortData

    Name

    Type

    Description

    Enum

    tpid Integer integer --- ---
    tpName String string --- ---
    portState String string --- ---
    portActualState String string --- ---

    N_PortSchedulerDataMapper

    Name

    Type

    Description

    Enum

    portSchedulerData Object object --- ---
    changedParam array[String] string --- ---

    N_QueueDataMapper

    Name

    Type

    Description

    Enum

    queueId Long long --- ---
    queueData Object object --- ---
    changedParam array[String] string --- ---

    N_RemarkingDataMapper

    Name

    Type

    Description

    Enum

    remarkingData Object object --- ---
    remarkingFCData array[N_FCDataMapper] N_FCDataMapper --- ---

    N_SlopingQueueDataMapper

    Name

    Type

    Description

    Enum

    queueId Long long --- ---
    slopeType String string --- ---
    queueData Object object --- ---
    changedParam array[String] string --- ---

    N_SupportedNEData

    Name

    Type

    Description

    Enum

    neId Integer integer --- ---
    neName String string --- ---
    neReachability String string NeReachability [Yes, No]

    N_TrafficMatchDataMapper

    Name

    Type

    Description

    Enum

    trafficMatchId Long long --- ---
    changedParam array[String] string --- ---
    accessIngressMatchCriterion Object object --- ---

    nPolicyName

    Name

    Type

    Description

    Enum

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

    OAMTestSuiteTemplateHolder

    Name

    Type

    Description

    Enum

    PolicyInst1

    Name

    Type

    Description

    Enum

    policyID Long long policyID ---
    policyName String string policyName [ ]
    policyPath String string policyPath [ ]
    policyDescription String string policyDescription [ ]
    bestPractice Boolean boolean --- ---
    policyType String string policyType [ ]
    state String string state [ ]
    author String string author [ ]
    policyScope Integer integer --- ---
    servicePolicyType Integer integer --- ---
    policyRecordType Integer integer --- ---
    tpid Integer integer --- ---
    oldPolicyId Integer integer --- ---
    interfaceId Integer integer --- ---
    handle Integer integer --- ---
    policyList array[AbstractPolicy ] AbstractPolicy List ---
    additionalInfo Object object --- ---
    changedParams array[String] string List ---
    internalPolicy Boolean boolean is Internal Policy ---
    policyModified Boolean boolean is current policy modified ---
    cirPirAdminUnitReqd Boolean boolean --- ---
    policyChanged Boolean boolean --- ---

    PolicyInstHolder

    Name

    Type

    Description

    Enum

    reqId Request Header Request Header reqId ---
    resId Response Header Model Response Header Model --- ---
    cmdStatus String string cmdStatus [ ]
    message String string message [ ]
    req N_PolicyInstMapper N_PolicyInstMapper req ---

    PolicyInstRespHolder

    Name

    Type

    Description

    Enum

    resId Response Header Model Response Header Model --- ---
    response array[PolicyInst1] PolicyInst1 response ---

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

    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 --- ---
    asymmetric 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 --- ---
    oamTsTemplateHolder OAMTestSuiteTemplateHolder OAMTestSuiteTemplateHolder --- ---
    policyName String string --- ---
    mapping_type String string --- ---
    port_role String string --- ---
    mapper_payload Long long --- ---
    demapper_payload Long long --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    allMeters2R3C2 Boolean boolean isAllMeters2R3C2 ---

    UIMapperRMD

    Name

    Type

    Description

    Enum

    supportedNe array[N_SupportedNEData] N_SupportedNEData getSupportedNe ---
    portData array[N_PortData] N_PortData getPortData ---