ocf_heartbeat_symlink - Man Page

Manages a symbolic link


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


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


Full path of the symbolic link to be managed. This must obviously be in a filesystem that supports symbolic links.

(required, string, no default)


Full path to the link target (the file or directory which the symlink points to).

(required, string, no default)


A suffix to append to any files that the resource agent moves out of the way because they clash with "link".

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):


Starts the resource. Suggested minimum timeout: 15s.


Stops the resource. Suggested minimum timeout: 15s.


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


Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.


Performs a validation of the resource configuration. Suggested minimum timeout: 10s.

Example CRM Shell

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="15s" interval="60s"

Example PCS

The following is an example configuration for a symlink resource using pcs(8)

pcs resource create p_symlink ocf:heartbeat:symlink \
  link=string \
  target=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="15s" interval="60s"

See Also



ClusterLabs contributors (see the resource agent source for information about individual authors)


01/30/2024 resource-agents UNKNOWN OCF resource agents