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
42
43       -D, --debug-file=[debugfile]
44              Write debug information to given file
45
46       -V, --version
47              Display version information and exit
48
49       -h, --help
50              Display help and exit
51
52       -C, --separator=[char]
53              Separator for CSV created by 'list' operation (Default Value: ,)
54
55
56       --delay=[seconds]
57              Wait X seconds before fencing  is  started  (Default  Value:  0)
58
59
60       --login-timeout=[seconds]
61              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
62
63
64       --power-timeout=[seconds]
65              Test X seconds for status change after  ON/OFF  (Default  Value:
66              20)
67
68       --power-wait=[seconds]
69              Wait X seconds after issuing ON/OFF (Default Value: 0)
70
71       --sbd-path=[path]
72              Path to SBD binary (Default Value: /sbin/sbd)
73
74       --shell-timeout=[seconds]
75              Wait  X  seconds  for  cmd prompt after issuing command (Default
76              Value: 3)
77
78       --retry-on=[attempts]
79              Count of attempts to retry power on (Default Value: 1)
80
81

ACTIONS

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

STDIN PARAMETERS

115
116
117       action Fencing action (Default Value: reboot)
118
119       devices
120              SBD Device This parameter is always required.
121
122       method Method to fence (onoff|cycle) (Default Value: cycle)
123
124       plug   Physical  plug  number  on  device,  UUID  or  identification of
125              machine This parameter is always required. Obsoletes: port
126
127
128       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
129              file or logging to syslog.
130
131       verbose
132              Verbose mode
133
134       debug_file
135              Write debug information to given file Obsoletes: debug
136
137       version
138              Display version information and exit
139
140       help   Display help and exit
141
142       separator
143              Separator for CSV created by 'list' operation (Default Value: ,)
144
145
146       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
147
148
149       login_timeout
150              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
151
152
153       power_timeout
154              Test  X  seconds  for status change after ON/OFF (Default Value:
155              20)
156
157       power_wait
158              Wait X seconds after issuing ON/OFF (Default Value: 0)
159
160       sbd_path
161              Path to SBD binary (Default Value: /sbin/sbd)
162
163       shell_timeout
164              Wait X seconds for cmd prompt  after  issuing  command  (Default
165              Value: 3)
166
167       retry_on
168              Count of attempts to retry power on (Default Value: 1)
169
170
171
172fence_sbd (Fence Agent)           2009-10-20                    FENCE_AGENT(8)