OCF_HEARTBEAT_SYMLIN(7) OCF resource agents OCF_HEARTBEAT_SYMLIN(7) 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 en- abled 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". 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: 15s. stop Stops the resource. Suggested minimum timeout: 15s. monitor Performs a detailed status check. Suggested minimum timeout: 15s. Sug- gested interval: 60s. meta-data Retrieves resource agent metadata (internal use only). Suggested mini- mum timeout: 5s. validate-all 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 http://clusterlabs.org/ AUTHOR ClusterLabs contributors (see the resource agent source for information about individual authors) resource-agents 4.13.0 08/27/2026 OCF_HEARTBEAT_SYMLIN(7)
NAME | SYNOPSIS | DESCRIPTION | SUPPORTED PARAMETERS | SUPPORTED ACTIONS | EXAMPLE CRM SHELL | EXAMPLE PCS | SEE ALSO | AUTHOR
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_symlink&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>