System Administration Commands vrrpadm(1M) NAME vrrpadm - VRRP administration tool SYNOPSIS vrrpadm create-router -V -l -A {inet | inet6} [-a ] [-P ] [-p ] [-i ] [-o ] [-f] vrrpadm delete-router vrrpadm enable-router vrrpadm disable-router vrrpadm modify-router [-p priority] [-i adv_interval] [-o flags] vrrpadm show-router [-P | -x] [-p] [-o field[,...]] [] DESCRIPTION The vrrpadm command is used to administer the VRRP service in the system. Each vrrpadm subcommand operates on a VRRP router, which is identified by a name given by the administrator. VRRP routers with the same VRID and address family within a LAN comprise a virtual router, which protects a set of virtual IP addresses. A system can have multiple VRRP routers, each belongs to a different virtual router. SUBCOMMANDS The following subcommands are supported. Note, most subcommands (create-router, delete-router, enable-router, disable-router, modify-router) require the solaris.network.vrrp authorization to operate; the show-router subcommand doesn't require extra authorizations. vrrpadm create-router Create a VRRP router with the given configuration. -V , --VRID= The virtual router identifier (VRID). Together with address family, it identifies a corresponding virtual Router within a LAN. -A [inet | inet6], --address_family=[inet | inet6] Address family. Either IPv4 or IPv6. -l , --link= The data-link on which the VRRP router is configured. This determines the LAN this VRRP router is running in. The data-link can be a physical link, a VLAN or an aggregation. -p , --priority= The priority of this VRRP router used in Master selection for this virtual router. The default value is 255, which indicates this VRRP router is the IP Address Owner, and owns all the virtual IP addresses. A IP Address Owner will respond to the packets addressed to one of the virtual IP addresses for ICMP pings, TCP connections, etc. The range 1-254 is available for VRRP routers backing up a virtual router. Master selection prefers the VRRP router with the higher priority. -i , --adv_interval= The advertisement interval in milliseconds. Default is 1000 (1 second). -o , --flags= The preempt and accept modes, delimited by a comma. Values can be: preempt, no_preempt, accept, no_accept. By default both are set to true. Example: -o preempt,no_accept. -f, --force In order to function properly, each VRRP router requires a special VRRP VNIC with the well-known virtual router MAC address exists, and all the virtual IP addresses associated with this VRRP router reside on this VNIC. This special VNIC can be created with the dladm create-vnic subcommand using the "-m vrrp" option. In the global zone, one can force the VNIC to be created and plumbed by specifying the '-f' option, and the system will create/plumb the VRRP VNIC automatically as part of the "vrrpadm create-router" operation. Note that the name of the automatically created VNIC wil be in the form of v__[v4|v6]. The command may fail if the name has already been taken. -a , --assoc_ips= The associated virtual IP addresses protected by the VRRP router, each in the form of
. If there are more than one virtual IP addresses, they are separated by commas. This option may be combined with the '-f' option, so that VNIC can be created and plumbed automatically. -P , --Prim_ip= The IP addresses configured over the interface which can be potentially selected as the primary IP address used to send the VRRP advertisement. router_name The name of this VRRP router. This name is used to identify this VRRP router in other vrrpadm subcommands. vrrpadm delete-router Delete the VRRP router identified by . vrrpadm enable-router Send a STARTUP event to the VRRP router identified by . On receiving this event, the VRRP router, if in the INITIALIZE state, will leave the INITIALIZE state and eventually enter either BACKUP or MASTER state. vrrpadm disable-router Send a SHUTDOWN event to the VRRP router identified by . On receiving this event, the VRRP router, if in BACKUP or MASTER state, will enter the INITIALIZE state, which is actually a "paused" state. vrrpadm modify-router Modify the configuration of the VRRP router identified by . Only the priority, the advertisement interval, the preempt mode and the accept mode can be modified. -p , --priority= The new priority of this VRRP router. -i , --adv_interval= The new advertisement interval. -o , --flags= The new preempt and/or accept modes. Either one or both can be specified. If both are specified, they are delimited by a comma. Example: -o preempt,no_accept vrrpadm show-router Display the information of the VRRP router identified by . If no is specified, display all the VRRP routers on the system. By default (with no options), the following fields are displayed: NAME The name of the VRRP router VRID The VRID of the VRRP router LINK The data-link on which the VRRP router is created on. Note that the name of the link can change over time unless the router is enabled. AF The address family of the VRRP router. Either IPv4 or IPv6 PRIO The priority of this VRRP router used in Master selection ADV_INTV The advertisement interval in milliseconds STATE The current state of the VRRP router, can be INIT (Initialize), BACK (Backup) or MAST (Master). MODE A set of flags associated with the VRRP router. Possible values are: e The router has been enabled p Preempt mode is true a Accept mode is true o Virtual address owner VNIC The VRRP VNIC created for this VRRP router Note that the name of the VNIC can change over time unless the router is enabled. -x, --extended Display additional information of the given VRRP router PRIMARY_IP The primary IP address selected by the VRRP router' VIRTUAL_IPS The virtual IP addresses configured on the VRRP router PRV_STAT The previous state of the VRRP router STAT_LAST Time since the last state transition -P, --peer Display the information of the backup VRRP router. This option is only meaningful when the VRRP router is in the backup state. The following fields are displayed: NAME The name of the VRRP router PEER The primary IP address of the peer VRRP router P_PRIO The priority of the peer VRRP router contained in the advertisement received from the peer. P_INTV The advertisement interval (in milliseconds) contained in advertisements received from the peer P_ADV_LAST Time since last received advertisement from the peer MASTER_DOWN_INT Time interval (in milliseconds) to declare Master down -p, --parsable Display the VRRP router information in the machine parsable format. -o field[,...], --output=field[,...] A case-insensitive, comma-separated list of output fields to display. The field name must be one of the fields listed above, or the special value all to display all fields. By default (without -o), vrrpadm show displays all fields. SEE ALSO vrrpd(1M), dladm(1M)