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       -4, --inet4-only
27              Forces agent to use IPv4 addresses only
28
29       -6, --inet6-only
30              Forces agent to use IPv6 addresses only
31
32       -a, --ip=[ip]
33              IP  address  or  hostname  of  fencing  device This parameter is
34              always required.
35
36       -u, --ipport=[port]
37              TCP/UDP port to use for connection with device  (Default  Value:
38              80)
39
40       -t, --notls
41              Disable  TLS  negotiation  and force SSL3.0. This should only be
42              used for devices that do not support TLS1.0 and up.
43
44
45       -p, --password=[password]
46              Login password or passphrase
47
48       -S, --password-script=[script]
49              Script to run to retrieve password
50
51       -n, --plug=[id]
52              Physical  plug  number  on  device,  UUID  or  identification of
53              machine This parameter is always required.
54
55       -z, --ssl
56              Use SSL connection with verifying certificate
57
58       --ssl-insecure
59              Use SSL connection without verifying certificate
60
61       --ssl-secure
62              Use SSL connection with verifying certificate
63
64       --suborg=[path]
65              Additional path needed to access suborganization (Default Value:
66              )
67
68       -l, --username=[name]
69              Login name This parameter is always required.
70
71       -q, --quiet
72              Disable logging to stderr. Does not affect --verbose or --debug-
73              file or logging to syslog.
74
75       -v, --verbose
76              Verbose mode
77
78       -D, --debug-file=[debugfile]
79              Write debug information to given file
80
81       -V, --version
82              Display version information and exit
83
84       -h, --help
85              Display help and exit
86
87       -C, --separator=[char]
88              Separator for CSV created by 'list' operation (Default Value: ,)
89
90
91       --delay=[seconds]
92              Wait  X  seconds  before  fencing  is started (Default Value: 0)
93
94
95       --login-timeout=[seconds]
96              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
97
98
99       --missing-as-off
100              Missing port returns OFF instead of failure
101
102       --power-timeout=[seconds]
103              Test  X  seconds  for status change after ON/OFF (Default Value:
104              20)
105
106       --power-wait=[seconds]
107              Wait X seconds after issuing ON/OFF (Default Value: 0)
108
109       --shell-timeout=[seconds]
110              Wait X seconds for cmd prompt  after  issuing  command  (Default
111              Value: 3)
112
113       --retry-on=[attempts]
114              Count of attempts to retry power on (Default Value: 1)
115
116       --gnutlscli-path=[path]
117              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
118
119

ACTIONS

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

STDIN PARAMETERS

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