Return to freevrrpd.8 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / freevrrpd

Annotation of embedaddon/freevrrpd/freevrrpd.8, revision 1.1.1.1

1.1       misho       1: .Dd 30 January, 2015
                      2: .Dt FREEVRRPD 8
                      3: .Sh NAME
                      4: .Nm freevrrpd
                      5: .Nd Virtual Redundancy Router Protocol Daemon
                      6: .Sh SYNOPSIS
                      7: .Nm freevrrpd
                      8: .Bk -words
                      9: .Op Fl F
                     10: .Op Fl f Ar config_file
                     11: .Op Fl c Ar chroot_directory
                     12: .Sh DESCRIPTION
                     13: .Nm freevrrpd
                     14: is a RFC2338/5798 compliant daemon. VRRP can be used with multiple
                     15: interfaces as well as multiple VRIDs. For each VRID defined in the
                     16: configuration file,
                     17: .Nm freevrrpd
                     18: creates a thread for managing a poll of one or multiple virtual IP
                     19: addresses. The daemon currently only supports IPv4 but IPv6 is being
                     20: developed.
                     21: .Pp
                     22: When
                     23: .Nm freevrrpd 
                     24: start, it reads /usr/local/etc/freevrrpd.conf file and then daemonizes
                     25: itself.  All of the options are defined in the config file. 
                     26: .Pp
                     27: .Nm freevrrpd is compatible with FreeBSD.
                     28: .Pp
                     29: Functionality includes :
                     30: .Bl -bullet -compact
                     31: .It
                     32: Support of multiple VRIDs
                     33: .It
                     34: State announcements are multicast using the
                     35: .Xr bpf 4
                     36: device.
                     37: .It
                     38: Changing routes and IP in 3 seconds
                     39: .It
                     40: Sending gratuitous ARP requests to clean the ARP cache of all hosts listening hosts.
                     41: .It
                     42: Election between different backup and master servers with differing priorities
                     43: .It
                     44: THe same host can be both a SLAVE and MASTER at the same time for different VRIDs.
                     45: .It
                     46: Automatic downgrade to BACKUP state if the MASTER returns to service.
                     47: .It
                     48: Support of netmasks for virtual IP addresses.
                     49: .El
                     50: .Sh CONFIGURATION
                     51: .Pp
                     52: .Nm freevrrpd
                     53: reads its configuration data from /usr/local/etc/freevrrpd.conf, or
                     54: the file specified with -f on the command line. The config file
                     55: contains keyword-argument pairs, one per line. Each VRID definition is
                     56: define by the [VRID] keyword. Lines statring with '#' and empty lines
                     57: are interpreted as comments.
                     58: .Pp
                     59: The possible keywords and their meanings are as follows (note that keywords and arguments are cas-sensitive):
                     60: .Bl -tag -width Ds
                     61: .It Cm serverid
                     62: This keyword is followed by a decimal number between 1 and 255 and represent the group identifier (Virtual Router Identifier).
                     63: .It Cm interface
                     64: This keyword is followed by an interface name where multicast VRRP annonce on the specified serverid group will be sent.
                     65: .It Cm useVMAC
                     66: Specifies wheter Virtual MAC adress (like 00:5E:00:...) is permitted.
                     67: The default is
                     68: .Dq yes .
                     69: Note that disabling useVMAC is a RFC infragment but must be necessary for some specific cases. If disabled,
                     70: .Dq sendgratuitousarp
                     71: must be enabled.
                     72: .It Cm priority
                     73: This keyword can be followed by a decimal number between 0 to 255. a priority of 255 mean a MASTER server. a priority between 0 to 254 is a BACKUP priority.
                     74: Note that 0 is the minimal BACKUP priority and 254 is the higher. If the VRID MASTER fail, tha higher BACKUP priority will become MASTER.
                     75: .It Cm addr
                     76: Specifies all Virtual IP adresses separated by commas of the corresponded VRID. a VIP syntax will be: 
                     77: .Dq xxx.xxx.xxx.xxx/yy 
                     78: or 
                     79: .Dq device:xxx.xxx.xxx.xxx/yy. 
                     80: .Dq xxx.xxx.xxx.xxx 
                     81: represent the IP adress and 
                     82: .Dq yy 
                     83: is a netmask in CIDR format. device is an optional device where VIP will be setted.
                     84: .It Cm monitoredcirctuis
                     85: Specifies whether NIC monitoring is enabled. This option use a special ioctl for getting carrier, duplex and health of the network card.
                     86: The default is 
                     87: .Dq yes .
                     88: Note that your NIC driver must support mii bus functionnality. Some old drivers cannot use this option and must be disabled.
                     89: .It Cm MCClearErrorsCount
                     90: This keyword can be followed by a decimal number that represent the number of concurrent valid checks (monitored circuits) before nberrors flag will be resetted at 0.
                     91: The default is
                     92: .Dq 3600 .
                     93: Note that the default value mean that 30 concurrent checks ok on a NIC by monitored circuits will reset the error counter for this NIC.
                     94: If a value of 
                     95: .It Cm masterscript
                     96: This keyword can be followed by a script name with an absolute path and will be executed during MASTER transition state.
                     97: .It Cm backupscript
                     98: This keyword take same argument as 
                     99: .Dq masterscript 
                    100: except that this script is executed during BACKUP transition state.
                    101: .It Cm vridsdep
                    102: This keyword can be followed by a list of VRID in decimal format separated by commas and depends from this one. If this VRID become BACKUP, all VRIDs specified will become BACKUP too.
                    103: .It Cm password
                    104: This keyword can be followed by a password for authenticate VRRP packets on a specific VRID.
                    105: Note that the password will be transmitted in clear with this method.
                    106: .It Cm AHencryption
                    107: Not implemented yet
                    108: .It Cm useIKE
                    109: Not implemented yet
                    110: .It Cm presharedkey
                    111: Not implemented yet
                    112: .Sh IMPLEMENTATION NOTES
                    113: This utility doesn't quit properly if you use the -KILL signal. If you want to stop freevrrpd, you can use kill [PID] and not kill -9 [PID], then it can delete virtual IP addresses and routes properly on shutdown.
                    114: .Sh BUGS
                    115: .Nm freevrrpd
                    116: is in active developpement, please send me bugs report and suggestions.
                    117: .Sh AUTHORS
                    118: .An Sebastien Petit Aq spe@bsdfr.org
                    119: .Sh HISTORY
                    120: first appeared in FreeBSD-4.3