fence_cisco_ucs(8)

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

NAME

7       fence_cisco_ucs - Fence agent for Cisco UCS
8

DESCRIPTION

10       fence_cisco_ucs  is  an  I/O Fencing agent which can be used with Cisco
11       UCS to fence machines.
12
13       fence_cisco_ucs accepts options on the command line  as  well  as  from
14       stdin.  Fenced  sends parameters through stdin when it execs the agent.
15       fence_cisco_ucs can be run by itself with command line  options.   This
16       is useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: http://www.cisco.com
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       -a, --ip=[ip]
27              IP  address  or hostname of fencing device This parameter is al‐
28              ways required.
29
30       -u, --ipport=[port]
31              TCP/UDP port to use for connection with device  (Default  Value:
32              80)
33
34       -t, --notls
35              Disable  TLS  negotiation  and force SSL3.0. This should only be
36              used for devices that do not support TLS1.0 and up.
37
38
39       -p, --password=[password]
40              Login password or passphrase
41
42       -S, --password-script=[script]
43              Script to run to retrieve password
44
45       -n, --plug=[id]
46              Physical  plug  number  on device, UUID or identification of ma‐
47              chine This parameter is always required.
48
49       -z, --ssl
50              Use SSL connection with verifying certificate
51
52       --ssl-insecure
53              Use SSL connection without verifying certificate
54
55       --ssl-secure
56              Use SSL connection with verifying certificate
57
58       --suborg=[path]
59              Additional path needed to access suborganization (Default Value:
60              )
61
62       -l, --username=[name]
63              Login name This parameter is always required.
64
65       -q, --quiet
66              Disable logging to stderr. Does not affect --verbose or --debug-
67              file or logging to syslog.
68
69       -v, --verbose
70              Verbose mode. Multiple -v flags can be stacked  on  the  command
71              line (e.g., -vvv) to increase verbosity.
72
73       --verbose-level
74              Level  of  debugging detail in output. Defaults to the number of
75              --verbose flags specified on the command line, or to 1  if  ver‐
76              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
77
78
79       -D, --debug-file=[debugfile]
80              Write debug information to given file
81
82       -V, --version
83              Display version information and exit
84
85       -h, --help
86              Display help and exit
87
88       --plug-separator=[char]
89              Separator for plug parameter when specifying more  than  1  plug
90              (Default Value: ,)
91
92       -C, --separator=[char]
93              Separator for CSV created by 'list' operation (Default Value: ,)
94
95
96       --delay=[seconds]
97              Wait X seconds before fencing  is  started  (Default  Value:  0)
98
99
100       --disable-timeout=[true/false]
101              Disable  timeout (true/false) (default: true when run from Pace‐
102              maker 2.0+)
103
104       --login-timeout=[seconds]
105              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
106
107
108       --missing-as-off
109              Missing port returns OFF instead of failure
110
111       --power-timeout=[seconds]
112              Test  X  seconds  for status change after ON/OFF (Default Value:
113              20)
114
115       --power-wait=[seconds]
116              Wait X seconds after issuing ON/OFF (Default Value: 0)
117
118       --shell-timeout=[seconds]
119              Wait X seconds for cmd prompt  after  issuing  command  (Default
120              Value: 3)
121
122       --stonith-status-sleep=[seconds]
123              Sleep  X  seconds  between  status calls during a STONITH action
124              (Default Value: 1)
125
126       --retry-on=[attempts]
127              Count of attempts to retry power on (Default Value: 1)
128
129       --gnutlscli-path=[path]
130              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
131
132

ACTIONS

134
135
136       on     Power on machine.
137
138       off    Power off machine.
139
140       reboot Reboot machine.
141
142       status This returns the status of the plug/virtual machine.
143
144       list   List available plugs with aliases/virtual machines if  there  is
145              support for more then one device. Returns N/A otherwise.
146
147       list-status
148              List  available  plugs  with  aliases/virtual machines and their
149              power state if it can be obtained without  additional  commands.
150
151
152       monitor
153              Check the health of fence device
154
155       metadata
156              Display the XML metadata describing this resource.
157
158       manpage
159               The operational behavior of this is not known.
160
161       validate-all
162              Validate if all required parameters are entered.
163
164

STDIN PARAMETERS

166
167
168       action Fencing action (Default Value: reboot)
169
170       ip     IP  address  or hostname of fencing device This parameter is al‐
171              ways required. Obsoletes: ipaddr
172
173       ipport TCP/UDP port to use for connection with device  (Default  Value:
174              80)
175
176       notls  Disable  TLS  negotiation  and force SSL3.0. This should only be
177              used for devices that do not support TLS1.0 and up.
178
179
180       password
181              Login password or passphrase Obsoletes: passwd
182
183       password_script
184              Script  to  run  to  retrieve  password Obsoletes: passwd_script
185
186
187       plug   Physical plug number on device, UUID or  identification  of  ma‐
188              chine  This  parameter is always required. Obsoletes: port
189
190
191       ssl    Use SSL connection with verifying certificate
192
193       ssl_insecure
194              Use SSL connection without verifying certificate
195
196       ssl_secure
197              Use SSL connection with verifying certificate
198
199       suborg Additional path needed to access suborganization (Default Value:
200              )
201
202       username
203              Login  name  This parameter is always required. Obsoletes: login
204
205
206       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
207              file or logging to syslog.
208
209       verbose
210              Verbose  mode.  Multiple  -v flags can be stacked on the command
211              line (e.g., -vvv) to increase verbosity.
212
213       verbose_level
214              Level of debugging detail in output. Defaults to the  number  of
215              --verbose  flags  specified on the command line, or to 1 if ver‐
216              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
217
218
219       debug_file
220              Write debug information to given file Obsoletes: debug
221
222       version
223              Display version information and exit
224
225       help   Display help and exit
226
227       plug_separator
228              Separator  for  plug  parameter when specifying more than 1 plug
229              (Default Value: ,)
230
231       separator
232              Separator for CSV created by 'list' operation (Default Value: ,)
233
234
235       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
236
237
238       disable_timeout
239              Disable timeout (true/false) (default: true when run from  Pace‐
240              maker 2.0+)
241
242       login_timeout
243              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
244
245
246       missing_as_off
247              Missing port returns OFF instead of failure
248
249       power_timeout
250              Test X seconds for status change after  ON/OFF  (Default  Value:
251              20)
252
253       power_wait
254              Wait X seconds after issuing ON/OFF (Default Value: 0)
255
256       shell_timeout
257              Wait  X  seconds  for  cmd prompt after issuing command (Default
258              Value: 3)
259
260       stonith_status_sleep
261              Sleep X seconds between status calls  during  a  STONITH  action
262              (Default Value: 1)
263
264       retry_on
265              Count of attempts to retry power on (Default Value: 1)
266
267       gnutlscli_path
268              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
269
270
271
272fence_cisco_ucs (Fence Agent)     2009-10-20                    FENCE_AGENT(8)