VLAN

28 min

virtual lan \urls summary\ url get post patch put delete /rest/v1/rpc/clear counters vlan n y n n n /rest/v1/running/interfaces/{name}/vlan config/{vlan id} y y y n y /rest/v1/rpc/show vlan n y n n n /rest/v1/rpc/show vlan summary n y n n n /rest/v1/running/vlans/{vlanid} y y y n y /rest/v1/rpc/batch create vlan n y n n n /rest/v1/rpc/batch create vlan member n y n n n /rest/v1/rpc/batch delete vlan n y n n n /rest/v1/rpc/batch delete vlan member n y n n n \examples\ \create vlans 300 305 and 307 \ post https //{switch ip}/rest/v1/rpc/batch create vlan { "vlan ranges" "300 305,307" } \create members for vlans 300 305 and 307 \ post https //{switch ip}/rest/v1/rpc/batch create vlan member { "interface name" "ethernet1", "vlan ranges" "300 305,307" } \ delete vlans 300,305 307\ post https //{switch ip}/rest/v1/rpc/batch delete vlan { "vlan ranges" "300,305 307" } \delete members from vlans \ post https //{switch ip}/rest/v1/rpc/batch delete vlan member { "interface name" "ethernet1", "vlan ranges" "300 305,307" } \show vlan summary\ post https //{switch ip}/rest/v1/rpc/show vlan summary response { "vlan" \[ { "vlan id" 10, "ip address" \[], "proxy arp" "disable", "description" "", "dhcp helper address" \[], "member" \[ { "port" "ethernet53 1", "tagging mode" "untagged" } ] }, { "vlan id" 200, "ip address" \[], "proxy arp" "disable", "description" "", "dhcp helper address" \[], "member" \[] } ] } \get all vlans \ get https //{switch ip}/rest/v1/running/vlans response { "result" \[ { "vlanid" 10, "name" "vlan10", "mac limit" 100 }, { "vlanid" 200, "name" "vlan200" } ] } \create a vlan \ post https //{switch ip}/rest/v1/running/vlans/300 {"description" "vlan 300"} \modify a vlan \ patch https //{switch ip}/rest/v1/running/vlans/300 {"mac limit" 12345} \delete a vlan \ delete https //{switch ip}/rest/v1/running/vlans/100 \add a member into a vlan \ post https //{switch ip}/rest/v1/running/interfaces/ethernet2/vlan config { "vlan id" "101", "tagging mode" "tagged" } \delete a member from a vlan \ delete https //{switch ip}/rest/v1/running/interfaces/ethernet1/vlan config/100 \properties descriptions\ \vlan configuration\ tree diagrams + rw vlans + rw vlan \[vlanid] + rw vlanid + ro name? + rw mac limit? + rw mac learning? + rw description? + rw unknown unicast action? + rw unknown multicast action? + rw broadcast action? table of properties name required type/range description vlans m path only node, has no configurable value vlanid m 1 4094 (sub property of vlans) vlan identity name ro vlan1 4094 (sub property of vlans) mac limit o 1 131072 (sub property of vlans) limit the number of dynamic mac addresses to be learned when the mac number reaches the threshold, dynamic mac addresses are no longer learned mac learning o "true" "false" (sub property of vlans) set mac learning mode for vlan, if disable, vlan will not learn mac default value "true" description o string (sub property of vlans) set textual description of the vlan unknown unicast action o "flood" "drop" (sub property of vlans) set the unknown unicast packets forwarding action unknown multicast action o "flood" "drop" (sub property of vlans) set the unknown multicast packets forwarding action broadcast action o "flood" "drop" (sub property of vlans) set the broadcast packets forwarding action \vlan member configuration\ tree diagrams + rw interfaces + rw interface \[name] + rw name + rw vlan config + rw vlan \[vlan id] + rw vlan id + rw tagging mode? table of properties name required type/range description interfaces m path only node, has no configurable value interface parameters name m ethernet name lag name (sub property of interfaces) the name of the interface vlan config cm (sub property of interfaces) path only node, has no configurable value only applicable when {interface} is a ethernet or portchannel name vlan related configuration that is part of the physical ethernet interface vlan m (sub property of vlan config) path only node, has no configurable value vlan id m 1 4094 (sub property of vlan) vlan identity tagging mode o "tagged" "untagged" (sub property of vlan) specifies the type of interface as a vlan member default value "tagged" \batch create vlan\ tree diagrams + x batch create vlan \| + w input \| + w vlan ranges? table of properties name required type/range description batch create vlan m path only node, has no configurable value vlan ranges o a comma separated list of vlans (1 4094), optionally in ranges (e g , 10 50,52) (sub property of input) ranges of vlan ids, e g 100 200,300 400 \batch delete vlan\ tree diagrams + x batch delete vlan \| + w input \| + w vlan ranges? table of properties name required type/range description batch delete vlan m path only node, has no configurable value vlan ranges o a comma separated list of vlans (1 4094), optionally in ranges (e g , 10 50,52) (sub property of input) ranges of vlan ids, e g 100 200,300 400 \batch create vlan member\ tree diagrams + x batch create vlan member \| + w input \| + w interface name? \| + w vlan ranges? table of properties name required type/range description batch create vlan member m path only node, has no configurable value interface name o ethernet name lag name (sub property of input) the name of the interface vlan ranges o a comma separated list of vlans (1 4094), optionally in ranges (e g , 10 50,52) (sub property of input) ranges of vlan ids, e g 100 200,300 400 \batch delete vlan member\ tree diagrams + x batch delete vlan member \| + w input \| + w interface name? \| + w vlan ranges? \| + ro output \| + ro result? table of properties name required type/range description batch delete vlan member m path only node, has no configurable value interface name o ethernet name lag name (sub property of input) the name of the interface vlan ranges o a comma separated list of vlans (1 4094), optionally in ranges (e g , 10 50,52) (sub property of input) ranges of vlan ids, e g 100 200,300 400 \show vlan summary\ tree diagrams + x show vlan summary \| + w input \| | + w vlan id? \| + ro output \| + ro vlan \[vlan id] \| + ro vlan id \| + ro ip address \| + ro member \[port] \| | + ro port \| | + ro tagging mode? \| + ro proxy arp? \| + ro description? \| + ro dhcp helper address table of properties name required type/range description show vlan summary m path only node, has no configurable value vlan id o 1 4094 (sub property of input) the specified vlan id to show vlan ro (sub property of output) path only node, has no configurable value vlan id ro 1 4094 (sub property of vlan) ip address ro string (sub property of vlan) member ro (sub property of vlan) path only node, has no configurable value port ro string (sub property of member) tagging mode ro string (sub property of member) proxy arp ro string (sub property of vlan) description ro string (sub property of vlan) dhcp helper address ro string (sub property of vlan) \show vlan\ tree diagrams + x show vlan \| + w input \| | + w vlan id \| + ro output \| + ro result? table of properties name required type/range description show vlan m path only node, has no configurable value vlan id m 1 4094 "all" (sub property of input) the vlan id to show result ro string (sub property of output) a table that shows information of the specified vlan \clear counters vlan\ tree diagrams + x clear counters vlan + ro output + ro data? table of properties name required type/range description clear counters vlan m path only node, has no configurable value rpc for clearing vlan counters data ro string (sub property of output) the result of clear counters vlan