RESTAPI Manual
High Availability
VRRP & VRRP6
20 min
virtual router redundancy protocol urls summary urls summary url get post patch put delete /rest/v1/running/interfaces/{name}/ipv4/vrrps/{vrid} y y y n y /rest/v1/running/interfaces/{name}/ipv4/vrrps/{vrid}/track interface/{interface} y y y n y /rest/v1/running/interfaces/{name}/ipv6/vrrps/{vrid} y y y n y /rest/v1/running/interfaces/{name}/ipv6/vrrps/{vrid}/track interface/{interface} y y y n y /rest/v1/rpc/show vrrp n y n n n /rest/v1/rpc/show vrrp6 n y n n n /rest/v1/rpc/show vrrp summary n y n n n /rest/v1/rpc/show vrrp6 summary n y n n n examples examples create a vrrp instance for ipv4 create a vrrp instance for ipv4 post https //{switch ip}/rest/v1/running/interfaces/ethernet1/ipv4/vrrps/10 { "version" "v2", "priority" 101, "preempt" "false", "advertisement interval" 1000, "admin status" "false", "checksum with ipv4 pseudoheader" "false", "virtual address" \["10 0 0 1/24"], "track interface" \[ { "interface" "ethernet2", "priority decrement" 10 }, { "interface" "ethernet3" }], "bfd monitoring" { "dest addr" "10 0 0 2", "profile" "test" } } create a track interface for vrrp instance for ipv4 create a track interface for vrrp instance for ipv4 post https //{switch ip}/rest/v1/running/interfaces/ethernet1/ipv4/vrrps/10/track interface { "interface" "ethernet2", "priority decrement" 10 } create a vrrp6 instance for ipv6 create a vrrp6 instance for ipv6 post https //{switch ip}/rest/v1/running/interfaces/ethernet1/ipv6/vrrps/10 { "priority" 101, "preempt" "true", "advertisement interval" 100, "admin status" "false", "virtual address" \["2002 1/64", "2003 1/63"], "track interface" \[ { "interface" "ethernet2", "priority decrement" 10 }, { "interface" "ethernet3" }], "bfd monitoring" { "dest addr" "2002 2", "profile" "test" } } create a track interface for vrrp6 instance for ipv6 create a track interface for vrrp6 instance for ipv6 post https //{switch ip}/rest/v1/running/interfaces/ethernet1/ipv6/vrrps/10/track interface { "interface" "ethernet2", "priority decrement" 10 } delete a track interface from vrrp6 instance for ipv6 delete a track interface from vrrp6 instance for ipv6 delete https //{switch ip}/rest/v1/running/interfaces/ethernet1/ipv6/vrrps/10/track interface/ethernet0 s s how vrrp instance how vrrp instance post https //{switch ip}/rest/v1/rpc/show vrrp/ { "interface" "ethernet1", "vrid" 10 } show vrrp6 instance show vrrp6 instance post https //{switch ip}/rest/v1/rpc/show vrrp6/ { "interface" "ethernet1", "vrid" 10 } show vrrp summary show vrrp summary post https //{switch ip}/rest/v1/rpc/show vrrp summary/ show vrrp6 summary show vrrp6 summary post https //{switch ip}/rest/v1/rpc/show vrrp6 summary/ properties descriptions properties descriptions vrrp instances for ipv4 vrrp instances for ipv4 tree diagrams + rw interfaces + rw interface \[name] + rw name + rw ipv4 + rw vrrps + rw vrrp \[vrid] + rw vrid + rw priority? + rw track interface \[interface] \| + rw interface \| + rw priority decrement? + rw preempt? + rw advertisement interval? + rw admin status? + rw version? + rw checksum with ipv4 pseudoheader? + rw bfd monitoring \| + rw dest addr \| + rw profile? + rw virtual address 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 vrrps m (sub property of ipv4) path only node, has no configurable value enclosing container for vrrp groups handled by this ip interface vrid m 0 255 (sub property of vrrps) set the virtual router id for use by the vrrp group this usually also determines the virtual mac address that is generated for the vrrp group virtual address m a b c d/m (sub property of vrrps) configure one or more ipv4 virtual addresses for the vrrp group priority o 1 254 (sub property of vrrps) specifies the sending vrrp interface's priority for the virtual router higher values equal higher priority default value 100 track interface m (sub property of vrrps) path only node, has no configurable value tracking interface interface m interface name (sub property of track interface) configure one or more tracking interfaces for the vrrp group priority decrement o 10 50 (sub property of track interface) specifies how much to decrement the priority of the vrrp instance if the tracking interface goes down default value 20 preempt o "true" "false" (sub property of vrrps) when set to true, enables preemption by a higher priority backup router of a lower priority master router default value "true" advertisement interval o 10 40950 (sub property of vrrps) sets the interval between successive vrrp advertisements; for version 3 the value must be multiple of 10; for version 2 the value must be multiple of 1000; default value 1000 admin status o "true" "false" (sub property of vrrps) administrative status for this vrrp group default value "true" version o "v2" "v3" (sub property of vrrps) default value "v3" checksum with ipv4 pseudoheader co "true" "false" (sub property of vrrps) only applicable when version = "v3" enabled if vrrpv3 checksum for ipv4 involves pseudoheader default value "true" bfd monitoring o (sub property of vrrps) path only node, has no configurable value dest addr o a b c d (sub property of bfd monitoring) configure bfd destination ipv4 addresses for the vrrp group profile o string (sub property of bfd monitoring) let bfd use a pre configured profile vrrp6 instances for ipv6 vrrp6 instances for ipv6 tree diagrams + rw interfaces + rw interface \[name] + rw name + rw ipv6 + rw vrrps + rw vrrp \[vrid] + rw vrid + rw priority? + rw track interface \[interface] \| + rw interface \| + rw priority decrement? + rw preempt? + rw advertisement interval? + rw admin status? + rw bfd monitoring \| + rw dest addr \| + rw profile? + rw virtual address 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 ipv6 m (sub property of interfaces) path only node, has no configurable value parameters for the ipv6 address family vrrps m (sub property of ipv6) path only node, has no configurable value vrid m 0 255 (sub property of vrrps) set the virtual router id for use by the vrrp group this usually also determines the virtual mac address that is generated for the vrrp group virtual address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx/m (sub property of vrrps) configure one or more ipv6 virtual addresses for the vrrp group priority o 1 254 (sub property of vrrps) specifies the sending vrrp interface's priority for the virtual router higher values equal higher priority default value 100 track interface m (sub property of vrrps) path only node, has no configurable value tracking interface interface m interface name (sub property of track interface) configure one or more tracking interfaces for the vrrp group priority decrement o 10 50 (sub property of track interface) specifies how much to decrement the priority of the vrrp instance if the tracking interface goes down default value 20 preempt o "true" "false" (sub property of vrrps) when set to true, enables preemption by a higher priority backup router of a lower priority master router default value "true" advertisement interval o 10 40950 (sub property of vrrps) sets the interval between successive vrrp advertisements; for version 3 the value must be multiple of 10; for version 2 the value must be multiple of 1000; default value 1000 admin status o "true" "false" (sub property of vrrps) administrative status for this vrrp group default value "true" bfd monitoring o (sub property of vrrps) path only node, has no configurable value dest addr m xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of bfd monitoring) configure bfd destination ipv6 addresses for the vrrp group profile o string (sub property of bfd monitoring) let bfd use a pre configured profile show vrrp instance show vrrp instance tree diagrams + x show vrrp \| + ro input \| + w interface? string \| + w vrid? uint8 \| + ro output \| + ro result? string table of properties name required type/range description show vrrp m path only node, has no configurable value show vrrp instance information interface m ethernet name ethernet sub interface name portchannel0000 9999 portchannel sub interface name vlan1 4094 (sub property of input) the name of the interface vrid m 0 255 (sub property of input) vrrp instance id result ro string (sub property of output) show vrrp6 instance show vrrp6 instance tree diagrams + x show vrrp6 \| + ro input \| + w interface? string \| + w vrid? uint8 \| + ro output \| + ro result? string table of properties name required type/range description show vrrp m path only node, has no configurable value show vrrp6 instance information interface m ethernet name ethernet sub interface name portchannel0000 9999 portchannel sub interface name vlan1 4094 (sub property of input) the name of the interface vrid m 0 255 (sub property of input) vrrp instance id result ro string (sub property of output) show vrrp s show vrrp s ummary tree diagrams + x show vrrp summary \| + ro output \| + ro result? string table of properties name required type/range description show vrrp summary m path only node, has no configurable value show vrrp summary information result ro string (sub property of output) show vrrp6 summary show vrrp6 summary tree diagrams + x show vrrp6 summary \| + ro output \| + ro result? string table of properties name required type/range description show vrrp6 summary m path only node, has no configurable value show vrrp6 summary information result ro string (sub property of output)
