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       -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       --stonith-status-sleep=[seconds]
90              Sleep  X  seconds  between  status calls during a STONITH action
91              (Default Value: 1)
92
93       --retry-on=[attempts]
94              Count of attempts to retry power on (Default Value: 1)
95
96

ACTIONS

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

STDIN PARAMETERS

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