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 ma‐
34              chine 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       --plug-separator=[char]
60              Separator  for  plug  parameter when specifying more than 1 plug
61              (Default Value: ,)
62
63       -C, --separator=[char]
64              Separator for CSV created by 'list' operation (Default Value: ,)
65
66
67       --delay=[seconds]
68              Wait  X  seconds  before  fencing  is started (Default Value: 0)
69
70
71       --disable-timeout=[true/false]
72              Disable timeout (true/false) (default: true when run from  Pace‐
73              maker 2.0+)
74
75       --login-timeout=[seconds]
76              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
77
78
79       --power-timeout=[seconds]
80              Test X seconds for status change after  ON/OFF  (Default  Value:
81              30)
82
83       --power-wait=[seconds]
84              Wait X seconds after issuing ON/OFF (Default Value: 0)
85
86       --sbd-path=[path]
87              Path to SBD binary (Default Value: /sbin/sbd)
88
89       --shell-timeout=[seconds]
90              Wait  X  seconds  for  cmd prompt after issuing command (Default
91              Value: 3)
92
93       --stonith-status-sleep=[seconds]
94              Sleep X seconds between status calls  during  a  STONITH  action
95              (Default Value: 1)
96
97       --retry-on=[attempts]
98              Count of attempts to retry power on (Default Value: 1)
99
100

ACTIONS

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

STDIN PARAMETERS

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