fence_sanbox2(8)

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

NAME

7       fence_sanbox2 - Fence agent for QLogic SANBox2 FC switches
8

DESCRIPTION

10       fence_sanbox2  is  an  I/O  Fencing agent which can be used with QLogic
11       SANBox2 FC switches.  It logs into a SANBox2 switch via telnet and dis‐
12       ables  a  specified  port.  Disabling  the port which a machine is con‐
13       nected to effectively fences that machine. Lengthy  telnet  connections
14       to  the switch should be avoided while a GFS cluster is running because
15       the connection will block any necessary fencing actions.
16
17       fence_sanbox2 accepts options on the  command  line  as  well  as  from
18       stdin.  Fenced  sends parameters through stdin when it execs the agent.
19       fence_sanbox2 can be run by itself with command line options.  This  is
20       useful for testing and for turning outlets on or off from scripts.
21
22       Vendor URL: http://www.qlogic.com
23

PARAMETERS

25
26
27       -o, --action=[action]
28              Fencing action (Default Value: off)
29
30       -c, --command-prompt=[prompt]
31              Force  Python regex for command prompt (Default Value: [' #> '])
32
33
34       -4, --inet4-only
35              Forces agent to use IPv4 addresses only
36
37       -6, --inet6-only
38              Forces agent to use IPv6 addresses only
39
40       -a, --ip=[ip]
41              IP address or hostname  of  fencing  device  This  parameter  is
42              always required.
43
44       -u, --ipport=[port]
45              TCP/UDP  port  to use for connection with device (Default Value:
46              23)
47
48       -p, --password=[password]
49              Login password or passphrase
50
51       -S, --password-script=[script]
52              Script to run to retrieve password
53
54       -n, --plug=[id]
55              Physical plug  number  on  device,  UUID  or  identification  of
56              machine This parameter is always required.
57
58       -l, --username=[name]
59              Login name This parameter is always required.
60
61       -q, --quiet
62              Disable logging to stderr. Does not affect --verbose or --debug-
63              file or logging to syslog.
64
65       -v, --verbose
66              Verbose mode
67
68       -D, --debug-file=[debugfile]
69              Write debug information to given file
70
71       -V, --version
72              Display version information and exit
73
74       -h, --help
75              Display help and exit
76
77       -C, --separator=[char]
78              Separator for CSV created by 'list' operation (Default Value: ,)
79
80
81       --delay=[seconds]
82              Wait  X  seconds  before  fencing  is started (Default Value: 0)
83
84
85       --login-timeout=[seconds]
86              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
87
88
89       --power-timeout=[seconds]
90              Test  X  seconds  for status change after ON/OFF (Default Value:
91              20)
92
93       --power-wait=[seconds]
94              Wait X seconds after issuing ON/OFF (Default Value: 0)
95
96       --shell-timeout=[seconds]
97              Wait X seconds for cmd prompt  after  issuing  command  (Default
98              Value: 3)
99
100       --retry-on=[attempts]
101              Count of attempts to retry power on (Default Value: 1)
102
103       --telnet-path=[path]
104              Path to telnet binary (Default Value: /usr/bin/telnet)
105
106

ACTIONS

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

STDIN PARAMETERS

138
139
140       action Fencing action (Default Value: off)
141
142       command_prompt
143              Force Python regex for command prompt (Default Value: [' #>  '])
144              Obsoletes: cmd_prompt
145
146       inet4_only
147              Forces agent to use IPv4 addresses only
148
149       inet6_only
150              Forces agent to use IPv6 addresses only
151
152       ip     IP  address  or  hostname  of  fencing  device This parameter is
153              always required. Obsoletes: ipaddr
154
155       ipport TCP/UDP port to use for connection with device  (Default  Value:
156              23)
157
158       password
159              Login password or passphrase Obsoletes: passwd
160
161       password_script
162              Script  to  run  to  retrieve  password Obsoletes: passwd_script
163
164
165       plug   Physical plug  number  on  device,  UUID  or  identification  of
166              machine This parameter is always required. Obsoletes: port
167
168
169       username
170              Login name This parameter is always required.  Obsoletes:  login
171
172
173       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
174              file or logging to syslog.
175
176       verbose
177              Verbose mode
178
179       debug_file
180              Write debug information to given file Obsoletes: debug
181
182       version
183              Display version information and exit
184
185       help   Display help and exit
186
187       separator
188              Separator for CSV created by 'list' operation (Default Value: ,)
189
190
191       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
192
193
194       login_timeout
195              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
196
197
198       power_timeout
199              Test  X  seconds  for status change after ON/OFF (Default Value:
200              20)
201
202       power_wait
203              Wait X seconds after issuing ON/OFF (Default Value: 0)
204
205       shell_timeout
206              Wait X seconds for cmd prompt  after  issuing  command  (Default
207              Value: 3)
208
209       retry_on
210              Count of attempts to retry power on (Default Value: 1)
211
212       telnet_path
213              Path to telnet binary (Default Value: /usr/bin/telnet)
214
215
216
217fence_sanbox2 (Fence Agent)       2009-10-20                    FENCE_AGENT(8)