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 This parameter is always required.
42
43       -u, --ipport=[port]
44              TCP/UDP port to use for connection with device  (Default  Value:
45              23)
46
47       -l, --username=[name]
48              Login Name This parameter is always required.
49
50       -p, --password=[password]
51              Login password or passphrase
52
53       -S, --password-script=[script]
54              Script to retrieve password
55
56       -n, --plug=[id]
57              Physical  plug  number,  name  of  virtual  machine or UUID This
58              parameter is always required.
59
60       -v, --verbose
61              Verbose mode
62
63       -D, --debug-file=[debugfile]
64              Write debug information to given file
65
66       -V, --version
67              Display version information and exit
68
69       -h, --help
70              Display help and exit
71
72       -C, --separator=[char]
73              Separator for CSV created by operation list (Default  Value:  ,)
74
75
76       --delay=[seconds]
77              Wait  X  seconds  before  fencing  is started (Default Value: 0)
78
79
80       --login-timeout=[seconds]
81              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
82
83
84       --power-timeout=[seconds]
85              Test  X  seconds  for status change after ON/OFF (Default Value:
86              20)
87
88       --power-wait=[seconds]
89              Wait X seconds after issuing ON/OFF (Default Value: 0)
90
91       --shell-timeout=[seconds]
92              Wait X seconds for cmd prompt  after  issuing  command  (Default
93              Value: 3)
94
95       --retry-on=[attempts]
96              Count of attempts to retry power on (Default Value: 1)
97
98       --telnet-path=[path]
99              Path to telnet binary (Default Value: /usr/bin/telnet)
100
101

ACTIONS

103
104
105       on     Power on machine.
106
107       off    Power off machine.
108
109       status This returns the status of the plug/virtual machine.
110
111       list   List  available  plugs with aliases/virtual machines if there is
112              support for more then one device. Returns N/A otherwise.
113
114       list-status
115              List available plugs with  aliases/virtual  machines  and  their
116              power  state  if it can be obtained without additional commands.
117
118
119       monitor
120              Check the health of fence device
121
122       metadata
123              Display the XML metadata describing this resource.
124
125

STDIN PARAMETERS

127
128
129       action Fencing Action (Default Value: off)
130
131       cmd_prompt
132              Force Python regex for command prompt (Default Value: [' #>  '])
133
134
135       inet4_only
136              Forces agent to use IPv4 addresses only
137
138       inet6_only
139              Forces agent to use IPv6 addresses only
140
141       ipaddr IP Address or Hostname This parameter is always required.
142
143       ipport TCP/UDP  port  to use for connection with device (Default Value:
144              23)
145
146       login  Login Name This parameter is always required.
147
148       passwd Login password or passphrase
149
150       passwd_script
151              Script to retrieve password
152
153       port   Physical plug number, name  of  virtual  machine  or  UUID  This
154              parameter is always required.
155
156       verbose
157              Verbose mode
158
159       debug  Write debug information to given file
160
161       version
162              Display version information and exit
163
164       help   Display help and exit
165
166       separator
167              Separator  for  CSV created by operation list (Default Value: ,)
168
169
170       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
171
172
173       login_timeout
174              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
175
176
177       power_timeout
178              Test X seconds for status change after  ON/OFF  (Default  Value:
179              20)
180
181       power_wait
182              Wait X seconds after issuing ON/OFF (Default Value: 0)
183
184       shell_timeout
185              Wait  X  seconds  for  cmd prompt after issuing command (Default
186              Value: 3)
187
188       retry_on
189              Count of attempts to retry power on (Default Value: 1)
190
191       telnet_path
192              Path to telnet binary (Default Value: /usr/bin/telnet)
193
194
195
196fence_sanbox2 (Fence Agent)       2009-10-20                    FENCE_AGENT(8)