ocf_heartbeat_symlink(7)

1OCF_HEARTBEAT_SYMLIN(7)       OCF resource agents      OCF_HEARTBEAT_SYMLIN(7)
2
3
4

NAME

6       ocf_heartbeat_symlink - Manages a symbolic link
7

SYNOPSIS

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

DESCRIPTION

12       This resource agent that manages a symbolic link (symlink).
13
14       It is primarily intended to manage configuration files which should be
15       enabled or disabled based on where the resource is running, such as
16       cron job definitions and the like.
17

SUPPORTED PARAMETERS

19       link
20           Full path of the symbolic link to be managed. This must obviously
21           be in a filesystem that supports symbolic links.
22
23           (required, string, no default)
24
25       target
26           Full path to the link target (the file or directory which the
27           symlink points to).
28
29           (required, string, no default)
30
31       backup_suffix
32           A suffix to append to any files that the resource agent moves out
33           of the way because they clash with "link".
34
35           If this is unset (the default), then the resource agent will simply
36           refuse to create a symlink if it clashes with an existing file.
37
38           (optional, string, no default)
39

SUPPORTED ACTIONS

41       This resource agent supports the following actions (operations):
42
43       start
44           Starts the resource. Suggested minimum timeout: 15s.
45
46       stop
47           Stops the resource. Suggested minimum timeout: 15s.
48
49       monitor
50           Performs a detailed status check. Suggested minimum timeout: 15s.
51           Suggested interval: 60s.
52
53       meta-data
54           Retrieves resource agent metadata (internal use only). Suggested
55           minimum timeout: 5s.
56
57       validate-all
58           Performs a validation of the resource configuration. Suggested
59           minimum timeout: 10s.
60

EXAMPLE CRM SHELL

62       The following is an example configuration for a symlink resource using
63       the crm(8) shell:
64
65           primitive p_symlink ocf:heartbeat:symlink \
66             params \
67               link=string \
68               target=string \
69             op monitor depth="0" timeout="15s" interval="60s"
70

EXAMPLE PCS

72       The following is an example configuration for a symlink resource using
73       pcs(8)
74
75           pcs resource create p_symlink ocf:heartbeat:symlink \
76             link=string \
77             target=string \
78             op monitor OCF_CHECK_LEVEL="0" timeout="15s" interval="60s"
79

AUTHOR

84       ClusterLabs contributors (see the resource agent source for information
85       about individual authors)
86
87
88
89resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_SYMLIN(7)