Provided by: resource-agents_3.9.2-5ubuntu4_i386 bug

NAME

       ocf_heartbeat_symlink - Manages a symbolic link

SYNOPSIS

       symlink [start | stop | monitor | meta-data | validate-all]

DESCRIPTION

       This resource agent that manages a symbolic link (symlink).

       It is primarily intended to manage configuration files which should be
       enabled or disabled based on where the resource is running, such as
       cron job definitions and the like.

SUPPORTED PARAMETERS

       link
           Full path of the symbolic link to be managed. This must obviously
           be in a filesystem that supports symbolic links.  (required,
           string, no default)

       target
           Full path to the link target (the file or directory which the
           symlink points to).  (required, string, no default)

       backup_suffix
           A suffix to append to any files that the resource agent moves out
           of the way because they clash with "link". .sp If this is unset
           (the default), then the resource agent will simply refuse to create
           a symlink if it clashes with an existing file.  (optional, string,
           no default)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 15.

       stop
           Stops the resource. Suggested minimum timeout: 15.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 15.
           Suggested interval: 60.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested
           minimum timeout: 5.

       validate-all
           Performs a validation of the resource configuration. Suggested
           minimum timeout: 10.

EXAMPLE

       The following is an example configuration for a symlink resource using
       the crm(8) shell:

           primitive p_symlink ocf:heartbeat:symlink \
             params \
               link=string \
               target=string \
             op monitor depth="0" timeout="15" interval="60"

SEE ALSO

       http://www.linux-ha.org/wiki/symlink_(resource_agent)

AUTHOR

       Linux-HA contributors (see the resource agent source for information
       about individual authors)