DRBDLINKS(8)						      System Manager's Manual						      DRBDLINKS(8)

NAME

       drbdlinks - manages links into a shared DRBD partition

SYNOPSIS

       drbdlinks [OPTION]... [start|stop|auto|status|monitor]

DESCRIPTION

       drbdlinks  is  a  program which manages links into a DRBD partition which is shared among several machines.  It is meant to be used in con-
       junction with the heartbeat system for simplifying management of high availability  clusters.   A  simple  configuration  file,	"/etc/drb-
       dlinks.conf", specifies the links.  This can be used to manage links for "/etc/apache", "/var/lib/pgsql", and other system files and direc-
       tories that need to appear as if they are local to the system when running applications after a DRBD shared partition has been mounted.

       A sample configuration file with annotations is included in the drbdlinks distribution.

       When run with "start" as the mode, drbdlinks will rename the existing files/directories, and then make symbolic links into the DRBD  parti-
       tion.  "stop" does the reverse.

       The "monitor" and "status" modes will check the file-system against the configuration file and will report "running" (monitor mode) or "OK"
       (status mode) if all links appear to be up.  Otherwise they report "down" or "stopped" (respectively).

       By default, the rename appends .drbdlinks to the name, but this can be overridden in the configuration file.

       The "list" mode just show the list of links, with each line showing the link, destination, and a 0/1 flag for bindMount status.	 This  may
       be useful for user scripts without having to parse the configuration.

       An  init  script is included which runs "stop" before heartbeat starts, and after heartbeat stops.  This is done to try to ensure that when
       the shared partition isn't mounted, the links are in their normal state.

OPTIONS

       drbdlinks has several options, using either short or long variants.

       -h, --help
	      Print a short help message describing the available options and exit.

       -c, --config-file=CONFIGFILE
	      Specify an alternate config file.  The default config file is /etc/drbdlinks.conf.  Alternate  config  files  should  have  a  "drb-
	      dlinks-" prefix, e.g. "drbdlinks-httpd.conf".

       -s, --suffix=SUFFIX
	      Name to append to the local file-system name when the link is in place.  The default is "drbdlinks", which would result in a renamed
	      file like "/etc/httpd.drbdlinks".

       -v, --verbose
	      Increase verbosity level by 1 for every occurrence of this option.

EXAMPLES

       Here are a few examples of how drbdlinks can be used.

       The most straight-forward, and default, method for starting drbdlinks:

	      drbdlinks start

       To use a suffix different from the default when linking to a file or directory, the -s option can be used, specifying the desired string:

	      drbdlinks -s orig start

       would rename the file-system name to "name.orig".

       Increase the verbosity to assist in debugging:

	      drbdlinks -v -v start

       Use an alternate configuration file, possibly from with a DRBD mounted file-system:

	      drbdlinks -c /shared1/drbdlinks-httpd.conf start

       This would use the specified configuration file, found on our DRBD device mounted on /shared1.  This would allow us  to	easily	keep  drb-
       dlinks configurations tied to a specific set of data on a DRBD disk in an active/active sort of HA configuration.

SEE ALSO

       DRBD(8), drbdadm(8), drbdsetup(8), heartbeat(8).

AUTHOR

       drbdlinks was written by Sean Reifschneider <jafo@tummy.com>.

       This  manual page was written by Cyril Bouthors <cyril@bouthors.org>, for the Debian project (but may be used by others).  Sean Reifschnei-
       der modified it for status and monitor arguments, and included it in the base drbdlinks release.  Mike Loseke  <mike@tummy.com>	added  the
       sections on options and examples.

								September  3, 2008						      DRBDLINKS(8)