MAC

Forwarding Data Base(FDB).

URLs Summary

URL	GET	POST	PATCH	PUT	DELETE
/rest/v1/running/fdb	Y	N	Y	N	N
/rest/v1/running/fdb/fdb-entry/{vlan-id}/{mac-address}	Y	Y	Y	N	Y
/rest/v1/rpc/show-mac-address	N	Y	N	N	N
/rest/v1/rpc/show-mac-limit	N	Y	N	N	N
/rest/v1/rpc/clear-mac-address	N	Y	N	N	N

Examples

Show mac address

POST HTTPS://{switch IP}/rest/v1/rpc/show-mac-address
{
    "interface-name": "Ethernet1"
}

response:

{
    "aging-time": 1800,
    "mac-address-info": [
        {
            "mac-address": "60:eb:5a:4c:30:db",
            "vlan-id": 10,
            "type": "dynamic",
            "port": "Ethernet1",
            "index": 1
        }
    ]
}

Show mac limit

POST HTTPS://{switch IP}/rest/v1/rpc/show-mac-limit

response:

{
    "port-mac-limit": [
        {
            "port": "Ethernet1",
            "mac-limit": 30
        }
    ],
    "vlanid-mac-limit": [
        {
            "vlanid": 10,
            "mac-limit": 100
        }
    ]
}

Clear mac address

POST HTTPS://{switch IP}/rest/v1/rpc/clear-mac-address
{
    "vlan-id": "1005"
}

Modify static fdb entry.

PATCH HTTPS://{switch IP}/rest/v1/running/fdb
{
    "fdb-entry": [
    {
        "mac-address": "cc:cc:cc:cc:cc:cc",
        "vlan-id": "1002",
        "type": "static",
        "port": "Lag2"
     }]
}

Create a fdb entry for a VLAN.

POST HTTPS://{switch IP}/rest/v1/running/fdb/fdb-entry
{
    "vlan-id": "1005",
    "mac-address": "00:01:02:03:04:05",
    "peer": "1.1.1.1",
    "vni": "1",
    "type": "static"
}

Delete a fdb entry from vlan.

DELETE HTTPS://{switch IP}/rest/v1/running/fdb/fdb-entry/1000/12:34:56:78:9a:bc

Properties Descriptions

FDB entry

Tree Diagrams

  +--rw fdb
     +--rw fdb-entry* [vlan-id mac-address]
     |  +--rw mac-address
     |  +--rw vlan-id
     |  +--ro type?
     |  +--rw (outer-if-type)
     |     +--:(port)
     |     |  +--rw port?
     |     +--:(blackhole)
     |     |  +--rw blackhole?
     |     +--:(vxlan-tunnel)
     |        +--rw vni?
     |        +--rw peer?

Table of Properties

Name	Required	Type/Range	Description
fdb	M		Path-only node, has no configurable value.
fdb-entry	M		(sub-property of fdb) Path-only node, has no configurable value.
mac-address	M	A:B:C:D:E:F	(sub-property of fdb-entry) MAC address for the fdb entry
vlan-id	M	1..4094	(sub-property of fdb-entry) VLAN ID for the fdb entry
type	RO	”static""dynamic”	(sub-property of fdb-entry) The type of fdb. Default value: “static”
port	O	Ethernet name.Lag1..9999	(sub-property of fdb-entry) Mutually exclusive with: - blackhole - vni - peer The name of the port
blackhole	O	”true""false”	(sub-property of fdb-entry) Mutually exclusive with: - port - vni - peer Configure blackhole mac address
vni	O	1..16777215	(sub-property of fdb-entry) Mutually exclusive with: - port - blackhole VXLAN Network Identifier
peer	O	A.B.C.D	(sub-property of fdb-entry) Mutually exclusive with: - port - blackhole Peer VTEP IP
aging-time	O	30..7200 “never”	(sub-property of fdb) Mac aging time, default is 1800 seconds. Default value: 1800

FDB aging

Tree Diagrams

  +--rw fdb
     +--rw aging-time?

Table of Properties

Name	Required	Type/Range	Description
fdb	M		Path-only node, has no configurable value.
aging-time	O	30..7200 “never”	(sub-property of fdb) Mac aging time, default is 1800 seconds.Default value: 1800

Show mac address

Tree Diagrams

    +---x show-mac-address
    |  +---w input
    |  |  +---w interface-name?
    |  +--ro output
    |     +--ro mac-address-info* []
    |     |  +--ro mac-address?
    |     |  +--ro vlan-id?
    |     |  +--ro type?
    |     |  +--ro port?
    |     |  +--ro index?
    |     +--ro aging-time?

Table of Properties

Name	Required	Type/Range	Description
show-mac-address	M		Path-only node, has no configurable value.
interface-type	O	”ethernet""link-aggregation""all”	(sub-property of input) The type of interface to show MAC address for, or “all” for all types. Default value: “all”
interface-name	O	Ethernet name. Lag1..9999	(sub-property of input)
mac-address-info	RO		(sub-property of output) Path-only node, has no configurable value. A table that show information of mac address
mac-address	RO	A:B:C:D:E:F	(sub-property of mac-address-info) MAC address for the fdb entry
vlan-id	RO	1..4094	(sub-property of mac-address-info) VLAN ID for the fdb entry
type	RO	”static""dynamic”	(sub-property of mac-address-info) The type of fdb
port	RO	Ethernet name. Lag1..9999 “blackhole”	(sub-property of mac-address-info) The name of the port
index	RO	0..4294967295	(sub-property of mac-address-info)
aging-time	RO	30..7200 “never”	(sub-property of output) Mac aging time, default is 1800 seconds. Default value: 1800

Clear mac address

Tree Diagrams

    +---x clear-mac-address
    |  +---w input
    |     +---w interface-name?
    |     +---w vlan-id?

Table of Properties

Name	Required	Type/Range	Description
clear-mac-address	M		Path-only node, has no configurable value. Clear MAC address table entries based on specified criteria.
interface-name	O	Ethernet name.Lag1..9999	(sub-property of input) Name of the Ethernet or link-aggregation interface.
vlan-id	O	1..4094	(sub-property of input)

Show mac limit

Tree Diagrams

    +---x show-mac-limit
       +--ro output
          +--ro port-mac-limit* []
          |  +--ro port?
          |  +--ro mac-limit?
          +--ro vlanid-mac-limit* []
             +--ro vlanid?
             +--ro mac-limit?

Table of Properties

Name	Required	Type/Range	Description
show-mac-limit	M		Path-only node, has no configurable value.
port-mac-limit	RO		(sub-property of output) Path-only node, has no configurable value. A table that show information of mac limit
port	RO	Ethernet name	(sub-property of port-mac-limit) The name of the port
mac-limit	RO	1..131072	(sub-property of port-mac-limit)
vlanid-mac-limit	RO		(sub-property of output) Path-only node, has no configurable value. A table that show information of mac limit
vlanid	RO	1..4094	(sub-property of vlanid-mac-limit) The name of the vlan
mac-limit	RO	1..131072	(sub-property of vlanid-mac-limit)