1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_sbd - Fence agent for sbd
8

DESCRIPTION

10       fence_sbd  is I/O Fencing agent which can be used in environments where
11       sbd can be used (shared storage).
12
13       fence_sbd accepts options on the command line as well  as  from  stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_sbd can be run by itself with command line options.  This is use‐
16       ful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL:
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       --devices=[device_a,device_b]
27              SBD Device This parameter is always required.
28
29       -m, --method=[method]
30              Method to fence (onoff|cycle) (Default Value: cycle)
31
32       -n, --plug=[id]
33              Physical  plug  number  on  device,  UUID  or  identification of
34              machine This parameter is always required.
35
36       -q, --quiet
37              Disable logging to stderr. Does not affect --verbose or --debug-
38              file or logging to syslog.
39
40       -v, --verbose
41              Verbose  mode.  Multiple  -v flags can be stacked on the command
42              line (e.g., -vvv) to increase verbosity.
43
44       --verbose-level
45              Level of debugging detail in output. Defaults to the  number  of
46              --verbose  flags  specified on the command line, or to 1 if ver‐
47              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
48
49
50       -D, --debug-file=[debugfile]
51              Write debug information to given file
52
53       -V, --version
54              Display version information and exit
55
56       -h, --help
57              Display help and exit
58
59       -C, --separator=[char]
60              Separator for CSV created by 'list' operation (Default Value: ,)
61
62
63       --delay=[seconds]
64              Wait X seconds before fencing  is  started  (Default  Value:  0)
65
66
67       --disable-timeout=[true/false]
68              Disable  timeout (true/false) (default: true when run from Pace‐
69              maker 2.0+)
70
71       --login-timeout=[seconds]
72              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
73
74
75       --power-timeout=[seconds]
76              Test  X  seconds  for status change after ON/OFF (Default Value:
77              20)
78
79       --power-wait=[seconds]
80              Wait X seconds after issuing ON/OFF (Default Value: 0)
81
82       --sbd-path=[path]
83              Path to SBD binary (Default Value: /sbin/sbd)
84
85       --shell-timeout=[seconds]
86              Wait X seconds for cmd prompt  after  issuing  command  (Default
87              Value: 3)
88
89       --retry-on=[attempts]
90              Count of attempts to retry power on (Default Value: 1)
91
92

ACTIONS

94
95
96       on     Power on machine.
97
98       off    Power off machine.
99
100       reboot Reboot machine.
101
102       status This returns the status of the plug/virtual machine.
103
104       list   List  available  plugs with aliases/virtual machines if there is
105              support for more then one device. Returns N/A otherwise.
106
107       list-status
108              List available plugs with  aliases/virtual  machines  and  their
109              power  state  if it can be obtained without additional commands.
110
111
112       monitor
113              Check the health of fence device
114
115       metadata
116              Display the XML metadata describing this resource.
117
118       manpage
119               The operational behavior of this is not known.
120
121       validate-all
122              Validate if all required parameters are entered.
123
124

STDIN PARAMETERS

126
127
128       action Fencing action (Default Value: reboot)
129
130       devices
131              SBD Device This parameter is always required.
132
133       method Method to fence (onoff|cycle) (Default Value: cycle)
134
135       plug   Physical plug  number  on  device,  UUID  or  identification  of
136              machine This parameter is always required. Obsoletes: port
137
138
139       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
140              file or logging to syslog.
141
142       verbose
143              Verbose  mode.  Multiple  -v flags can be stacked on the command
144              line (e.g., -vvv) to increase verbosity.
145
146       verbose_level
147              Level of debugging detail in output. Defaults to the  number  of
148              --verbose  flags  specified on the command line, or to 1 if ver‐
149              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
150
151
152       debug_file
153              Write debug information to given file Obsoletes: debug
154
155       version
156              Display version information and exit
157
158       help   Display help and exit
159
160       separator
161              Separator for CSV created by 'list' operation (Default Value: ,)
162
163
164       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
165
166
167       disable_timeout
168              Disable  timeout (true/false) (default: true when run from Pace‐
169              maker 2.0+)
170
171       login_timeout
172              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
173
174
175       power_timeout
176              Test  X  seconds  for status change after ON/OFF (Default Value:
177              20)
178
179       power_wait
180              Wait X seconds after issuing ON/OFF (Default Value: 0)
181
182       sbd_path
183              Path to SBD binary (Default Value: /sbin/sbd)
184
185       shell_timeout
186              Wait X seconds for cmd prompt  after  issuing  command  (Default
187              Value: 3)
188
189       retry_on
190              Count of attempts to retry power on (Default Value: 1)
191
192
193
194fence_sbd (Fence Agent)           2009-10-20                    FENCE_AGENT(8)