/system/interfaces/{Interface.name}/virtual_ip4_routers/{VRRP.group-id}

put

https://switch-ip/rest/v10.16/system/interfaces/{Interface.name}/virtual_ip4_routers/{VRRP.group-id}

Path Params

Interface.name

string

required

Reference Resource: Port
The port name. For non-bonded ports, the port name is the same as the associated interface name. The name must otherwise be unique across all ports and interfaces of the system.

VRRP.group-id

string

required

Reference Resource: VRRP
The port's VRRP groups (or VR instances) for IPv4 address family. A maximum of 32 VRRP groups can be assigned to a port.

Body Params

accept_mode_disable

boolean

Set this value to true, to disable the accept mode. If accept mode is enabled, routes for vritual IP addresses will be installed and VR will accept the packets destined to virtual IP addresses. If accept mode is disabled, routes for virtual IP addresses will not be installed hence VR will not accept any packet destined to virtual IP addresses.

admin_enable

boolean

Set this value to true, to activate the VR instance.

auth_key

string

length ≥ 1

Authentication key to be used with VRRPv2 advertisements. This does not take effect if the VRRP version is VRRPv3. If not set, VRRP authentication is not operational on that VR.

auth_mode

string

enum

Specifies the authentication mode to be used when exchanging VRRP packets. This is only applicable when VRRP version is VRRPv2. text: a clear-text password is included in VRRP advertisements. md5 : an Authentication Header(AH) is added to the IPv4 headers of the VRRP advertisement packets. none : VRRP advertisement packets are not authenticated. This does not take effect if the VRRP version is VRRPv3.

Allowed:

bfd_peer_addresses

array of strings

length ≤ 9223372036854776000

Specifies all potential BFD peers. Active will establish BFD sessions to all peers. Standby will establish BFD session to the active only.

bfd_peer_addresses

group-id

integer

required

Reference Resource: VRRP
The port's VRRP groups (or VR instances) for IPv6 address family. A maximum of 32 VRRP groups can be assigned to a port.

ip_address

object

Specifies a virtual IPv4 or IPv6 address for the VR instance. For an owner, the virtual IP must be one of the IP addresses configured on the interface for that VR. For a standby, the virtual IP must match the virtual IP of the owner. The owner and the standbys using a given virtual IP must all belong to the same network or subnet. For IPv6, VR's first address should be link local address. After the primary link local IPv6 address is configured on the VR, user can add the global IPv6 addresses. This column, also specifies the interface's IP address to designate as the source for VRRP advertisements from the VR. By default primary IP address of real interface is used as source for VRRP advertisements. Source IP configuration parameter is for IPv4 only. IPv6 doesn't have a source IP address configuration parameter. For IPv6, the source IP address is the link-local address of the real interface over which the packet is transmitted.

ip_address_secondary

array of strings

length ≤ 9223372036854776000

Specifies secondary IPv4 or IPv6 addresses for the VRRP group. You must configure a primary address before you are able to configure secondary addresses.

ip_address_secondary

preempt_disable

boolean

Set this value to true, to disable preempt mode. When mode is enabled, a Standby router coming up with a higher priority than another Standby that is currently operating as Active will take over the Active function. When the mode is disabled, the protocol prevents higher-priority Standby from taking over the Active operation from a lower-priority Standby. This mode does not prevent an Owner router from resuming the Active function after recovering from being unavailable. Also, the VR instance must be disabled (that is, set "admin_enable" to false) when setting this field.

priority

integer

0 to 255

The priority value of the VR.

timers

object

track_entities

array of strings

length ≤ 256

Reference Resource: Track_Entity
Set of track entities.

track_entities

version

integer

2 to 3

VRRP protocol version. VRRPv3 supports usage of IPv4 and IPv6 addresses while VRRPv2 only supports IPv4 addresses.

Responses

200

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!