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
28              always 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
47              machine 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       --retry-on=[attempts]
119              Count of attempts to retry power on (Default Value: 1)
120
121       --gnutlscli-path=[path]
122              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
123
124

ACTIONS

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

STDIN PARAMETERS

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