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 This parameter is always required.
28
29       -l, --username=<name>
30              Login Name This parameter is always required.
31
32       -p, --password=<password>
33              Login password or passphrase
34
35       -S, --password-script=<script>
36              Script to retrieve password
37
38       -z, --ssl
39              SSL connection
40
41       -4, --inet4-only
42              Forces agent to use IPv4 addresses only
43
44       -6, --inet6-only
45              Forces agent to use IPv6 addresses only
46
47       -u, --ipport=<port>
48              TCP port to use for connection with device
49
50       -n, --plug=<id>
51              Physical  plug  number or name of virtual machine This parameter
52              is always required.
53
54       --suborg=<path>
55              Additional path needed to access suborganization (Default Value:
56              )
57
58       -v, --verbose
59              Verbose mode
60
61       -D, --debug-file=<debugfile>
62              Write debug information to given file
63
64       -V, --version
65              Display version information and exit
66
67       -h, --help
68              Display help and exit
69
70       -C, --separator=<char>
71              Separator  for  CSV created by operation list (Default Value: ,)
72
73
74       --power-wait
75              Wait X seconds after issuing ON/OFF (Default Value: 0)
76
77       --power-timeout
78              Test X seconds for status change after  ON/OFF  (Default  Value:
79              20)
80
81       --shell-timeout
82              Wait  X  seconds  for  cmd prompt after issuing command (Default
83              Value: 3)
84
85       --delay
86              Wait X seconds before fencing  is  started  (Default  Value:  0)
87
88
89       --retry-on
90              Count of attempts to retry power on (Default Value: 1)
91
92

ACTIONS

94
95
96       on     Power on machine.
97
98       off    Power off machine.
99
100       reboot Reboot machine.
101
102       status This returns the status of the plug/virtual machine.
103
104       list   List  available  plugs with aliases/virtual machines if there is
105              support for more then one device. Returns N/A otherwise.
106
107       monitor
108              Check if fencing device is running. List available plugs/virtual
109              machines or get status of machine (if it does not support more).
110
111
112       metadata
113               The operational behavior of this is not known.
114
115

STDIN PARAMETERS

117
118
119       action Fencing Action (Default Value: reboot)
120
121       ipaddr IP Address or Hostname This parameter is always required.
122
123       login  Login Name This parameter is always required.
124
125       passwd Login password or passphrase
126
127       passwd_script
128              Script to retrieve password
129
130       ssl    SSL connection
131
132       inet4_only
133              Forces agent to use IPv4 addresses only
134
135       inet6_only
136              Forces agent to use IPv6 addresses only
137
138       ipport TCP port to use for connection with device
139
140       port   Physical plug number or name of virtual machine  This  parameter
141              is always required.
142
143       suborg Additional path needed to access suborganization (Default Value:
144              )
145
146       verbose
147              Verbose mode
148
149       debug  Write debug information to given file
150
151       version
152              Display version information and exit
153
154       help   Display help and exit
155
156       separator
157              Separator for CSV created by operation list (Default  Value:  ,)
158
159
160       power_wait
161              Wait X seconds after issuing ON/OFF (Default Value: 0)
162
163       power_timeout
164              Test  X  seconds  for status change after ON/OFF (Default Value:
165              20)
166
167       shell_timeout
168              Wait X seconds for cmd prompt  after  issuing  command  (Default
169              Value: 3)
170
171       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
172
173
174       retry_on
175              Count of attempts to retry power on (Default Value: 1)
176
177
178
179fence_cisco_ucs (Fence Agent)     2009-10-20                    FENCE_AGENT(8)
Impressum