VRRP & VRRP6
Virtual Router Redundancy Protocol.
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
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
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
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
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 HTTPS://{switch IP}/rest/v1/running/interfaces/Ethernet1/ipv6/vrrps/10/track-interface/Ethernet1Show vrrp instance
POST HTTPS://{switch IP}/rest/v1/rpc/show-vrrp/
{
"interface": "Ethernet1",
"vrid": 10
}Show vrrp6 instance
POST HTTPS://{switch IP}/rest/v1/rpc/show-vrrp6/
{
"interface": "Ethernet1",
"vrid": 10
}Show vrrp summary
POST HTTPS://{switch IP}/rest/v1/rpc/show-vrrp-summary/Show vrrp6 summary
POST HTTPS://{switch IP}/rest/v1/rpc/show-vrrp6-summary/Properties Descriptions
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 Lag1..9999 Link-aggregation 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
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 Lag1..9999 Link-aggregation 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
Tree Diagrams
+---x show-vrrp
| +--ro input
| +--w interface? string
| +--w vrid? uint8
| +--ro output
| +--ro result? stringTable 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 Lag1..9999 Link-aggregation 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
Tree Diagrams
+---x show-vrrp6
| +--ro input
| +--w interface? string
| +--w vrid? uint8
| +--ro output
| +--ro result? stringTable 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 Lag1..9999 Link-aggregation 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 summary
Tree Diagrams
+---x show-vrrp-summary
| +--ro output
| +--ro result? stringTable 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
Tree Diagrams
+---x show-vrrp6-summary
| +--ro output
| +--ro result? stringTable 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) |