RESTAPI Manual
Layer 3
ARP
17 min
urls summary urls summary url get post patch put delete /rest/v1/running/arp global y y y n y /rest/v1/running/arp global/arp dynamic learning y y y n y /rest/v1/running/interfaces/{name}/arp dynamic learning y n y n n /rest/v1/running/interfaces/{name}/ipv4/neighbor/\[{ip}] y y y n y /rest/v1/rpc/clear neighbor n y n n n /rest/v1/rpc/show ipv4 neighbor summary n y n n n examples examples show ipv4 neighbor summary show ipv4 neighbor summary post https //{switch ip}/rest/v1/rpc/show ipv4 neighbor summary get global arp configuration get global arp configuration get https //{switch ip}/rest/v1/running/arp global create global arp dynamic learning create global arp dynamic learning post https //{switch ip}/rest/v1/running/arp global/arp dynamic learning { "interval" 10, "times" 16 } modify arp dynamic learning for an interface modify arp dynamic learning for an interface patch https //{switch ip}/rest/v1/running/interfaces/vlan100/arp dynamic learning { "mode" "evpn" } create an ipv4 neighbor for interface create an ipv4 neighbor for interface post https //{switch ip}/rest/v1/running/interfaces/portchannel0012/ipv4/neighbor { "ip" "100 0 0 2", "mac address" "00 11 22\ a3 44 5f" } clear neighbors clear neighbors post https //{switch ip}/rest/v1/rpc/clear neighbor { "interface" "ethernet1" } properties descriptions properties descriptions arp flood global arp flood global tree diagrams + rw arp global + rw flood enable? table of properties name required type/range description arp global m path only node, has no configurable value flood enable o "true" "false" (sub property of arp global) enable to flood packet default value "true" arp arp dynamic learning global global tree diagrams + rw arp global + rw arp dynamic learning + rw interval? + rw times? + rw expire time? table of properties name required type/range description arp global m path only node, has no configurable value arp dynamic learning m (sub property of arp global) path only node, has no configurable value global arp dynamic learning configuration interval o 1 65535 (sub property of arp dynamic learning) arp probe interval for learned neighbors, units seconds default value 6 times o 1 65535 (sub property of arp dynamic learning) arp probe times for learned neighbors default value 5 expire time o 60 86400 (sub property of arp dynamic learning) arp aging timer, units seconds default value 300 interface arp dynamic learning interface arp dynamic learning tree diagrams + rw interfaces + rw interface \[name] + rw name + rw arp dynamic learning + rw mode? + rw arp accept? + rw arp active detect? + rw interval? + rw times? + rw expire time? table of properties name required type/range description interfaces m path only node, has no configurable value interface parameters name m ethernet name portchannel name (sub property of interfaces) the name of the interface arp dynamic learning m (sub property of interfaces) path only node, has no configurable value arp dynamic learning on interfaces mode o "disable" "default" "evpn" (sub property of arp dynamic learning) arp proxy mode default value "disable" arp accept o "true" "false" (sub property of arp dynamic learning) define behavior for gratuitous arp frames who's ip is not already present in the arp table "false" don't create new entries in the arp table "true" create new entries in the arp table both replies and requests type gratuitous arp will trigger the arp table to be updated, if this setting is on if the arp table already contains the ip address of the gratuitous arp frame, the arp table will be updated regardless if this setting is on or off default value "false" arp active detect o "true" "false" (sub property of arp dynamic learning) define behavior for receiving arp request who's target ip is not already present in the arp table, but the ip is the same as the ip segment of the interface "true" actively sending arp request to detect the unknown target ip "false" do nothing this is useful when some hosts are set to be silent which means they would't send gratuitous arp actively default value "false" interval o 1 65535 (sub property of arp dynamic learning) arp probe interval for learned neighbors, units seconds default value 6 times o 1 65535 (sub property of arp dynamic learning) arp probe times for learned neighbors default value 5 expire time o 60 86400 (sub property of arp dynamic learning) arp aging timer, units seconds default value 300 static static arp entry arp entry tree diagrams + rw interfaces + rw interface \[name] + rw name + rw ipv4 \| + rw neighbor \[ip] \| | + rw ip \| | + rw mac address \| | + ro origin? table of properties name required type/range description interfaces m path only node, has no configurable value interface parameters name m ethernet name ethernet sub interface name portchannel0000 9999 portchannel sub interface name vlan1 4094 (sub property of interfaces) the name of the interface ipv4 m (sub property of interfaces) path only node, has no configurable value parameters for the ipv4 address family neighbor m (sub property of ipv4) path only node, has no configurable value a list of mappings from ipv4 addresses to link layer addresses entries in this list in the intended configuration are used as static entries in the arp cache in the operational state, this list represents the arp cache ip m a b c d (sub property of neighbor) the ipv4 address of the neighbor node mac address m a\ b c\ d e\ f (sub property of neighbor) the link layer address of the neighbor node origin ro "other" "static" "dynamic" (sub property of neighbor) the origin of this neighbor entry show arp summary show arp summary tree diagrams + x show ipv4 neighbor summary \| + w input \| | + w ip? \| | + w interface? \| + ro output \| + ro result? table of properties name required type/range description show ipv4 neighbor summary m path only node, has no configurable value ip o a b c d (sub property of input) the ipv4 address of the neighbor node interface o interface name (sub property of input) the name of the interface needs to show ipv6 neighbors result ro string (sub property of output) a table that shows information of all ipv4 neighbors clear neighborss clear neighborss tree diagrams + x clear neighbor + w input \| + w interface + ro output + ro text? table of properties name required type/range description clear neighbor m path only node, has no configurable value interface m "all" interface name (sub property of input) all to flush neighbors on all the interface interface name remove neighbors on a specific interface text ro string (sub property of output) flush neighbor on interface
