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

ACTIONS

112
113
114       on     Power on machine.
115
116       off    Power off machine.
117
118       reboot Reboot machine.
119
120       status This returns the status of the plug/virtual machine.
121
122       list   List available plugs with aliases/virtual machines if  there  is
123              support for more then one device. Returns N/A otherwise.
124
125       list-status
126              List  available  plugs  with  aliases/virtual machines and their
127              power state if it can be obtained without  additional  commands.
128
129
130       monitor
131              Check the health of fence device
132
133       metadata
134              Display the XML metadata describing this resource.
135
136

STDIN PARAMETERS

138
139
140       action Fencing Action (Default Value: reboot)
141
142       inet4_only
143              Forces agent to use IPv4 addresses only
144
145       inet6_only
146              Forces agent to use IPv6 addresses only
147
148       ipaddr IP Address or Hostname This parameter is always required.
149
150       ipport TCP/UDP  port  to use for connection with device (Default Value:
151              80)
152
153       login  Login Name This parameter is always required.
154
155       notls  Disable TLS negotiation, force SSL 3.0 (Default Value: 1)
156
157       passwd Login password or passphrase
158
159       passwd_script
160              Script to retrieve password
161
162       port   Physical plug number, name  of  virtual  machine  or  UUID  This
163              parameter is always required.
164
165       ssl    SSL connection
166
167       ssl_insecure
168              SSL  connection  without  verifying  fence  device's certificate
169
170
171       ssl_secure
172              SSL connection with verifying fence device's certificate
173
174       suborg Additional path needed to access suborganization (Default Value:
175              )
176
177       verbose
178              Verbose mode
179
180       debug  Write debug information to given file
181
182       version
183              Display version information and exit
184
185       help   Display help and exit
186
187       separator
188              Separator  for  CSV created by operation list (Default Value: ,)
189
190
191       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
192
193
194       login_timeout
195              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
196
197
198       power_timeout
199              Test X seconds for status change after  ON/OFF  (Default  Value:
200              20)
201
202       power_wait
203              Wait X seconds after issuing ON/OFF (Default Value: 0)
204
205       shell_timeout
206              Wait  X  seconds  for  cmd prompt after issuing command (Default
207              Value: 3)
208
209       retry_on
210              Count of attempts to retry power on (Default Value: 1)
211
212       gnutlscli_path
213              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
214
215
216
217fence_cisco_ucs (Fence Agent)     2009-10-20                    FENCE_AGENT(8)