RESTAPI Manual
Layer 2
MAC
16 min
forwarding data base(fdb) urls summary 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 examples show mac address show mac address post https //{switch ip}/rest/v1/rpc/show mac address { "interface type" "ethernet" } show mac limit show mac limit post https //{switch ip}/rest/v1/rpc/show mac limit clear mac address clear mac address post https //{switch ip}/rest/v1/rpc/clear mac address { "vlan id" "1005" } modify static fdb entry 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" "portchannel0002" }] } create a fdb entry for a vlan 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 a fdb entry from vlan delete https //{switch ip}/rest/v1/running/fdb/fdb entry/1000/12 34 56 78 9a\ bc properties descriptions properties descriptions fdb entry 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 portchannel0000 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 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 show mac address tree diagrams + x show mac address \| + w input \| | + w interface type? \| | + 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 portchannel0000 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 portchannel0000 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 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 portchannel0000 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 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)
