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       -C, --separator=[char]
89              Separator for CSV created by 'list' operation (Default Value: ,)
90
91
92       --delay=[seconds]
93              Wait  X  seconds  before  fencing  is started (Default Value: 0)
94
95
96       --disable-timeout=[true/false]
97              Disable timeout (true/false) (default: true when run from  Pace‐
98              maker 2.0+)
99
100       --login-timeout=[seconds]
101              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
102
103
104       --missing-as-off
105              Missing port returns OFF instead of failure
106
107       --power-timeout=[seconds]
108              Test X seconds for status change after  ON/OFF  (Default  Value:
109              20)
110
111       --power-wait=[seconds]
112              Wait X seconds after issuing ON/OFF (Default Value: 0)
113
114       --shell-timeout=[seconds]
115              Wait  X  seconds  for  cmd prompt after issuing command (Default
116              Value: 3)
117
118       --stonith-status-sleep=[seconds]
119              Sleep X seconds between status calls  during  a  STONITH  action
120              (Default Value: 1)
121
122       --retry-on=[attempts]
123              Count of attempts to retry power on (Default Value: 1)
124
125       --gnutlscli-path=[path]
126              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
127
128

ACTIONS

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

STDIN PARAMETERS

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