Loader

Retrieve ONT UNIs

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl
action show
tid The name of the OLT (TID) to wich the ONT is attached.
aid AID of the ONT:
  • Format: MDS1-<slot>-<pon>-<ont>
  • Example: MDS1-1-1-3
filter [ { aid:"" } ]
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl",
    "action": "show",
    "tid": "VOIPWORLD-1134",
    "aid": "MDS1-2-2-1",
    "filter": [
        {
            "aid": ""
        }
    ]
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "tid": "VOIPWORLD-1134",
            "aid": "ETH1-1-2-2-1",
            "userLabel": "Cisco7960"
        },
        {
            "tid": "VOIPWORLD-1134",
            "aid": "ETH1-1-2-2-2",
            "userLabel": "AP225"
        },
        {
            "tid": "VOIPWORLD-1134",
            "aid": "ETH1-1-2-2-3"
        },
        {
            "tid": "VOIPWORLD-1134",
            "aid": "ETH1-1-2-2-4"
        }
    ]
}

Retrieve UNI Configuration

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl
action show
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl",
    "action": "show",    "tid": "VOIPWORLD-1134",

    "aid": "ETH1-1-2-3-4"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "ETH1-1-2-3-4",
            "adminState": {
                "value": 1
            },
            "userLabel": "PC",
            "authConfig": [],
            "poePortType": "tellabs",
            "profileName": "EL-Loopback-Detection",
            "bridgeProfileName": "",
            "lldpProfileName": "enabled",
            "nacProfileName": "NAC-VLAN-2995-UT-IPTV",
            "paeProfileName": "default",
            "poeProfileName": "PoE_Disabled",
            "rstpProfileName": "default",
            "lldpMedLocation": "default",
            "dot1PortNumber": 395
        }
    ]
}

Edit UNI Configuration

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl
action edit
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes A JSON formatted array of attribute-value pairs, specifying the data to edit.
  • Format: [ { "attr1" : "attr1-str-value" } , { "attr2" : attr2-num-value } , ... ]
  • Example: [ { "adminStatue.value" : 1 } , { "userLabel" : "Room 314 Data-Voice Port" } , {"profileName" : "Loopback-Detection"} ]

Example Request

 

JSON
{
    "prefix": "esl",
    "action": "edit",
    "tid": "VOIPWORLD-1134",
    "aid": "ETH1-1-2-3-4",
    "attributes": [
        {
            "adminState.value": 1
        },
        {
            "userLabel": "PC Smith"
        },
        {
            "profileName": "EL-Loopback-Detection"
        }
    ]
}

Example Response

 

JSON
{
    "response": {
        "code": 1,
        "description": ""
    },
    "result": [
        {
            "aid": "ETH1-1-2-3-4",
            "adminState": {
                "value": 1
            },
            "userLabel": "PC Smith",
            "authConfig": [],
            "poePortType": "tellabs",
            "profileName": "EL-Loopback-Detection",
            "bridgeProfileName": "",
            "lldpProfileName": "enabled",
            "nacProfileName": "NAC-VLAN-2995-UT-IPTV",
            "paeProfileName": "default",
            "poeProfileName": "PoE_Disabled",
            "rstpProfileName": "default",
            "lldpMedLocation": "default",
            "dot1PortNumber": 395
        }
    ]
}

Retrieve UNI Status

URL https://<emsserver>:8081/oam/oam-bin
prefix esl
action status
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl",
    "action": "status",
    "tid": "VOIPWORLD-1134",
    "aid": "ETH1-1-2-3-4"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "ETH1-1-2-3-4",
            "eslState": {
                "value": 4
            },
            "opState": {
                "value": 0
            },
            "availState": [],
            "opLineSpeed": 100,
            "physAddress": "1-1-2-3-1-4",
            "actualDuplexMode": {
                "value": 0
            },
            "mtuSize": 1500,
            "authStatus": [],
            "poePortStatus": [
                {
                    "poePortPowerPairsControlAbility": false,
                    "poePortDetectionStatus": 1,
                    "poePortMPSAbsentCounter": 0,
                    "poePortPowerClassifications": 0,
                    "poeAllocatedPower": 0,
                    "poeConsumptionPower": 0,
                    "poePortInvalidSignatureCounter": 0,
                    "poePortPowerDeniedCounter": 0,
                    "poePortOverLoadCounter": 0,
                    "poePortShortCounter": 1
                }
            ]
        }
    ]
}

Retrieve UNI Statistics

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl
action statistics
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl",
    "action": "statistics",
    "tid": "VOIPWORLD-1134",
    "aid": "ETH1-1-2-3-4"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "ETH1-1-2-3-4",
            "rmonStats": {
                "inPkts": 94914,
                "outPkts": 10559950,
                "inOctets": 8908176,
                "outOctets": 649554092,
                "inBroadcastPkts": 952,
                "outBroadcastPkts": 3204481,
                "inMulticastPkts": 25137,
                "outMulticastPkts": 1980398,
                "inRateExceededPkts": -1,
                "inRateExceededBurstPkts": -1,
                "outRateExceededPkts": -1,
                "outRateExceededBurstPkts": -1,
                "inUnicastPkts": 68824,
                "outUnicastPkts": 5375071,
                "txUtilization": 0,
                "rxUtilization": 0,
                "inMeteringDiscards": 0,
                "outMeteringDiscards": 0,
                "allOctets": {
                    "inOctets": {
                        "ethOctets": {
                            "pkts64Octets": -1,
                            "pkts65to127Octets": -1,
                            "pkts128to255Octets": -1,
                            "pkts256to511Octets": -1,
                            "pkts512to1023Octets": -1,
                            "pkts1024to1518Octets": -1
                        },
                        "pkts1519to1920Octets": -1
                    },
                    "outOctets": {
                        "ethOctets": {
                            "pkts64Octets": -1,
                            "pkts65to127Octets": -1,
                            "pkts128to255Octets": -1,
                            "pkts256to511Octets": -1,
                            "pkts512to1023Octets": -1,
                            "pkts1024to1518Octets": -1
                        },
                        "pkts1519to1920Octets": -1
                    }
                }
            },
            "phyStats": {
                "ethStats": {
                    "rxRunts": 0,
                    "rxOversizePkts": 0,
                    "rxFragments": 0,
                    "rxJabbers": 0,
                    "carrierSenseErrors": 0,
                    "alignmentErrors": 0,
                    "fcsErrors": 0,
                    "symbolErrors": 0,
                    "inPauseFrames": -1,
                    "outPauseFrames": -1,
                    "deferredTransmissions": 0
                }
            },
            "authStatistics": []
        }
    ]
}

Retrieve UNI PM Data

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl pm
action statistics
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{

    "prefix": "esl pm",

    "action": "statistics",

    "tid": "VOIPWORLD-1134",

    "aid": "ETH1-1-2-3-4"

}

Example Response

 

JSON
{

    "response": {

        "code": 0,

        "description": ""

    },

    "result": [

        {

            "aid": "ETH1-1-2-3-4",

            "perfPeriod": 1,

            "flag": 1,

            "intervalId": "",

            "entityType": 2,

            "specificStatistics": {

                "ethStats": {

                    "statsFCS": 0,

                    "statsFrameTooLong": 0,

                    "statsSingleCollisionFrame": 0,

                    "statsCarrierSenseError": 0,

                    "statsAlignmentError": 0,

                    "statsLateCollision": 0,

                    "statsExcessiveCollision": 0,

                    "statsBufferOverflowRx": 0,

                    "statsBufferOverflowTx": 0,

                    "statsMultipleCollisionFrame": 0,

                    "statsSQE": 0,

                    "statsDeferredTransmission": 0,

                    "statsInternalMACTx": 0,

                    "statsInternalMACRx": 0

                },

                "rmonStats": {

                    "statsDroppedEvents": 0,

                    "statsOctets": 11648,

                    "statsPkts": 114,

                    "statsBroadcastPkts": 1,

                    "statsMulticastPkts": 8,

                    "statsUndersizePkts": 0,

                    "statsFragments": 0,

                    "statsJabbers": 0,

                    "pkts64OctetsRx": 90,

                    "pkts65to127OctetsRx": 0,

                    "pkts128to255OctetsRx": 16,

                    "pkts256to511OctetsRx": 8,

                    "pkts512to1023OctetsRx": 0,

                    "pkts1024to1518OctetsRx": 0

                }

            }

        },

        {

            "aid": "ETH1-1-2-3-4",

            "perfPeriod": 2,

            "flag": 1,

            "intervalId": "",

            "entityType": 2,

            "specificStatistics": {

                "ethStats": {

                    "statsFCS": -1,

                    "statsFrameTooLong": -1,

                    "statsSingleCollisionFrame": -1,

                    "statsCarrierSenseError": -1,

                    "statsAlignmentError": -1,

                    "statsLateCollision": -1,

                    "statsExcessiveCollision": -1,

                    "statsBufferOverflowRx": -1,

                    "statsBufferOverflowTx": -1,

                    "statsMultipleCollisionFrame": -1,

                    "statsSQE": -1,

                    "statsDeferredTransmission": -1,

                    "statsInternalMACTx": -1,

                    "statsInternalMACRx": -1

                },

                "rmonStats": {

                    "statsDroppedEvents": -1,

                    "statsOctets": -1,

                    "statsPkts": -1,

                    "statsBroadcastPkts": -1,

                    "statsMulticastPkts": -1,

                    "statsUndersizePkts": -1,

                    "statsFragments": -1,

                    "statsJabbers": -1,

                    "pkts64OctetsRx": -1,

                    "pkts65to127OctetsRx": -1,

                    "pkts128to255OctetsRx": -1,

                    "pkts256to511OctetsRx": -1,

                    "pkts512to1023OctetsRx": -1,

                    "pkts1024to1518OctetsRx": -1

                }

            }

        }

    ]

}

Retrieve UNI STP Status

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl stp
action status
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl stp",
    "action": "status",
    "tid": "BigD",
    "aid": "ETH1-7-5-1-1"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "ETH1-7-5-1-1",
            "id": 0,
            "specificValue": {
                "portId": "80:01",
                "uptimeSecs": 1282626,
                "portHelloTime": 2,
                "macOpState": {
                    "value": 0
                },
                "stpState": 3,
                "portRole": 3,
                "designatedRoot": "60:00:f4:8c:eb:5c:a6:40",
                "designatedBridge": "d0:00:02:c0:9b:02:0b:24",
                "designatedPort": "80:01",
                "designatedCostIntegral": 320000,
                "tcnAck": false,
                "edgePort": true,
                "pointToPoint": true,
                "disputed": false,
                "cistRegionalRoot": "d0:00:02:c0:9b:02:0b:24",
                "cistPathCost": 0,
                "roleCount": 1,
                "timeInRole": 1282568,
                "rrCount": 0,
                "timeSinceRr": 1282626
            }
        }
    ]
}

Retrieve UNI STP Statistics

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl stp
action statistics
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl stp",
    "action": "statistics",
    "tid": "BigD",
    "aid": "ETH1-7-5-1-1"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "ETH1-7-5-1-1",
            "specificValue": {
                "ifIndex": 134422528,
                "forwardTransitions": 2,
                "stpConfigurationBPduTx": 0,
                "stpConfigurationBPduRx": 0,
                "rstBPduTx": 0,
                "rstBPduRx": 0,
                "mstBPduTx": 670794,
                "mstBPduRx": 0,
                "tcnBPduTx": 0,
                "tcnBPduRx": 0,
                "maxAgeExpiryCnt": 0,
                "mstiRegions": 0,
                "mstiRegionsMax": 0,
                "violationsCount": -1
            }
        }
    ]
}}

Retrieve UNI LLDP Status

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl lldp
action status
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl lldp",
    "action": "status",
    "tid": "DMW-1134-125.146",
    "aid": "ETH1-1-1-1-1"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": {
        "port": "ETH1-1-1-1-1",
        "peerList": [
            {
                "1227531": [
                    ""
                ],
                "1227530": [
                    "CP-7961G"
                ],
                "1227529": [
                    "Cisco Systems, Inc."
                ],
                "1227528": [
                    "FCH11059DCC"
                ],
                "1183489": [
                    "Auto-Negotiation Status       : 3",
                    "    Supported                 : Enabled",
                    "    Status                    : Enabled",
                    "Capability                    : ",
                    "                                Symetric Pause",
                    "                                Asymetric and Symetric Pause",
                    "                                1000 BaseX FD",
                    "                                1000 BaseT",
                    "MAU Type                      : 100BASE-TX full duplex mode"
                ],
                "1227527": [
                    "SCCP41.9-4-2-1S"
                ],
                "1227526": [
                   "7961G_64-02070631Amd64megRel.bin"
                ],
                "1227525": [
                    "1"
                ],
                "1227524": [
                    "",
                    "Type                          : PD Device",
                    "Source                        : Unknown",
                    "Priority                      : Unknown",
                    "Value                         : 6.3 (W)"
                ],
                "1227522": [
                    "Defined",
                    "Voice vlanId=3123(tagged), Pri=5, DSCP=46",
                    "Defined",
                    "Voice Signaling vlanId=3123(tagged), Pri=4, DSCP=32"
                ],
                "1227521": [
                    "Class                         : Endpoint Class III",
                    "Capabilities                  : enabled",
                    "Network Policy                : enabled",
                    "Ext Pwr-Via-MDI PD            : enabled",
                    "Inventory                     : enabled"
                ],
                "8": [
                    "172.28.123.244",
                    "Interface                     : unknown"
                ],
                "7": [
                    "Telephone                     : enabled",
                    "Bridge                        : enabled"
                ],
                "6": [
                    "Cisco IP Phone 7961G,V1, SCCP41.9-4-2-1S"
                ],
                "5": [
                    "SEP001B0CDB1E44.tellabs.network"
                ],
                "4": [
                    "SW PORT"
                ],
                "3": [
                    "180"
                ],
                "2": [
                    "001B0CDB1E44:P1"
                ],
                "1": [
                    "172.28.123.244"
                ]
            }
        ]
    }
}

Retrieve UNI LLDP Statistics

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix esl lldp
action statistics
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "esl lldp",
    "action": "statistics",
    "tid": "DMW-1134-125.146",
    "aid": "ETH1-1-1-1-1"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "port": "ETH1-1-1-1-1",
            "RxAgeoutsTotal": 11,
            "RxFramesDiscardedTotal": 0,
            "RxFramesErrors": 0,
            "RxFramesTotal": 106577,
            "TxFramesTotal": 213234,
            "RxTLVsDiscardedTotal": 0,
            "RxTLVsUnrecognizedTotal": 0
        }
    ]
}}

Retrieve UNI Dynamic Services

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix xconn dynamic
action show
tid The name of the OLT (TID).
aid AID of the UNI port:
  • Format: ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: ETH1-1-2-3-4
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "xconn dynamic",
    "action": "show",
    "tid": "DMW-1134-125.146",
    "aid": "ETH1-1-1-1-1"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "P00-NV3123-SV3123-ETH1-1-1-1-1",
            "networkVlan": 3123,
            "subscriberVlan": 3123,
            "serviceProfileName": "VOICE-NV3123-SV3123",
            "aclProfileName": "TELLABS-PERMIT-ALL"
        }
    ]
}

Retrieve Subscriber MACs on a UNI Dynamic Service

Definition

URL https://<emsserver>:8081/oam/oam-bin
prefix xconn
action status
tid The name of the OLT (TID).
aid AID of the UNI Dynamic Service:
  • Format: P<priority>-NV<network_vlan>-SV<subscriber_vlan->-ETH1-<slot>-<pon>-<ont>-<uni>
  • Example: P00-NV76-SV76-ETH1-3-1-2-1
filter N/A
attributes N/A

Example Request

 

JSON
{
    "prefix": "xconn",
    "action": "status",
    "tid": "DMW-1134-125.146",
    "aid": "P00-NV3123-SV3123-ETH1-1-1-1-1"
}

Example Response

 

JSON
{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "P00-NV3123-SV3123-ETH1-1-1-1-1",
            "opState": {
                "value": 0
            },
            "availState": [],
            "subscriberMACTable": [
                {
                    "macAddress": "00:1B:0C:DB:1E:44",
                    "associatedIPAddress": "172.28.123.244",
                    "remainingLeaseTime": 75060,
                    "hardwareEntry": false
                }
            ]
        }
    ]
}
FEEDBACK: Are you happy with this material?