VLAN Related REST

Retrieve VLANs for an OLT

Definition

URL	https://<emsserver>:8081/oam/oam-bin
prefix	ifc vlan
action	show
tid	The name of the OLT (TID).
aid	"" (Empty string)
filter	NA
attributes	NA

Example Request

JSON

{
    "prefix": "ifc vlan",
    "action": "show",
    "tid": "BigD",
    "aid": ""
}

Example Response

JSON

{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "key": {
                "vlanId": 201,
                "domain": 1
            },
            "bridgeType": 0,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "willis",
            "enableDAI": false
        },
        {
            "key": {
                "vlanId": 3999,
                "domain": 1
            },
            "bridgeType": 2,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "willis",
            "enableDAI": false
        },
        {
            "key": {
                "vlanId": 501,
                "domain": 1
            },
            "bridgeType": 2,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "",
            "enableDAI": false
        },
        {
            "key": {
                "vlanId": 128,
                "domain": 1
            },
            "bridgeType": 2,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "MGMT",
            "enableDAI": false
        },
        {
            "key": {
                "vlanId": 820,
                "domain": 1
            },
            "bridgeType": 2,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "",
            "enableDAI": false
        },
        {
            "key": {
                "vlanId": 830,
                "domain": 1
            },
            "bridgeType": 2,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "",
            "enableDAI": false
        },
        {
            "key": {
                "vlanId": 840,
                "domain": 1
            },
            "bridgeType": 2,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "",
            "enableDAI": false
        },
        {
            "key": {
                "vlanId": 810,
                "domain": 1
            },
            "bridgeType": 2,
            "aclMode": 0,
            "mvrpVlanType": 1,
            "stpId": 0,
            "description": "",
            "enableDAI": false
        }
    ]
}

Retrieve VLAN Assignments for an OLT

Definition

URL	https://<emsserver>:8081/oam/oam-bin
prefix	ifc vlanassign
action	show
tid	The name of the OLT (TID).
aid	"" (Empty string)
filter	NA
attributes	NA

Example Request

JSON

{
    "prefix": "ifc vlanAssign",
    "action": "show",
    "tid": "BigD",
    "aid": ""
}

Example Response

JSON

{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "key": {
                "interfaceAID": "NET1",
                "vlanId": 810
            },
            "domain": 1,
            "tagStyle": 1,
            "svid": 810,
            "mrpRegistrarAdminControl": 3,
            "isIPMCSource": false,
            "enableIGMPProxy": false,
            "isForceForward": false,
            "priorityProfile": "default",
            "description": ""
        },
        {
            "key": {
                "interfaceAID": "NET1",
                "vlanId": 820
            },
            "domain": 1,
            "tagStyle": 1,
            "svid": 820,
            "mrpRegistrarAdminControl": 3,
            "isIPMCSource": false,
            "enableIGMPProxy": false,
            "isForceForward": false,
            "priorityProfile": "default",
            "description": ""
        },
        {
            "key": {
                "interfaceAID": "NET1",
                "vlanId": 830
            },
            "domain": 1,
            "tagStyle": 1,
            "svid": 830,
            "mrpRegistrarAdminControl": 3,
            "isIPMCSource": false,
            "enableIGMPProxy": false,
            "isForceForward": false,
            "priorityProfile": "default",
            "description": ""
        },
        {
            "key": {
                "interfaceAID": "NET1",
                "vlanId": 840
            },
            "domain": 1,
            "tagStyle": 1,
            "svid": 840,
            "mrpRegistrarAdminControl": 3,
            "isIPMCSource": false,
            "enableIGMPProxy": false,
            "isForceForward": false,
            "priorityProfile": "default",
            "description": ""
        },
        {
            "key": {
                "interfaceAID": "NET1",
                "vlanId": 501
            },
            "domain": 1,
            "tagStyle": 1,
            "svid": 501,
            "mrpRegistrarAdminControl": 3,
            "isIPMCSource": false,
            "enableIGMPProxy": false,
            "isForceForward": false,
            "priorityProfile": "default",
            "description": ""
        },
        {
            "key": {
                "interfaceAID": "NET3",
                "vlanId": 128
            },
            "domain": 1,
            "tagStyle": 5,
            "svid": 128,
            "mrpRegistrarAdminControl": 3,
            "isIPMCSource": false,
            "enableIGMPProxy": false,
            "isForceForward": false,
            "priorityProfile": "Static-P6",
            "description": "MGMT"
        },
        {
            "key": {
                "interfaceAID": "NET3",
                "vlanId": 3999
            },
            "domain": 1,
            "tagStyle": 1,
            "svid": 3999,
            "mrpRegistrarAdminControl": 3,
            "isIPMCSource": false,
            "enableIGMPProxy": false,
            "isForceForward": false,
            "priorityProfile": "default",
            "description": "willis"
        }
    ],
    "interfacedata": [
        {
            "id": "NET1",
            "label": "NET1 (Uplink)"
        },
        {
            "id": "LPE",
            "label": "LPE"
        },
        {
            "id": "NET3",
            "label": "NET3 (Uplink)"
        }
    ]
}