1FENCE_AGENT(8) System Manager's Manual FENCE_AGENT(8)
3
7 fence_evacuate - Fence agent for the automatic resurrection of Open‐
8 Stack compute instances
9
11 Used to reschedule flagged instances
12 fence_evacuate accepts options on the command line as well as from
14 stdin. Fenced sends parameters through stdin when it execs the agent.
15 fence_evacuate can be run by itself with command line options. This is
16 useful for testing and for turning outlets on or off from scripts.
17 Vendor URL:
19
21 -o, --action=[action]
24 Fencing action (Default Value: reboot)
25 -k, --auth-url=[url]
27 Keystone Admin Auth URL (Default Value: )
28 -e, --endpoint-type=[endpoint]
30 Nova Endpoint type (Default Value: internalURL)
31 -p, --password=[password]
34 Login password or passphrase
35 -S, --password-script=[script]
37 Script to run to retrieve password
38 -n, --plug=[id]
40 Physical plug number on device, UUID or identification of
41 machine This parameter is always required.
42 --region-name=[region]
44 Region Name (Default Value: )
45 -t, --tenant-name=[name]
47 Keystone Admin Tenant or v3 Project (Default Value: )
48 -l, --username=[name]
50 Login name
51 --insecure
53 Allow Insecure TLS Requests (Default Value: False)
54 -d, --project-domain=[name]
56 Keystone v3 Project Domain (Default Value: Default)
57 -u, --user-domain=[name]
59 Keystone v3 User Domain (Default Value: Default)
60 -d, --domain=[string]
62 DNS domain in which hosts live
63 --instance-filtering
65 Allow instances to be evacuated (Default Value: True)
66 --no-shared-storage
68 Disable functionality for dealing with shared storage (Default
69 Value: False)
70 --compute-domain=[string]
72 Replaced by domain
73 -q, --quiet
75 Disable logging to stderr. Does not affect --verbose or --debug-
76 file or logging to syslog.
77 -v, --verbose
79 Verbose mode
80 -D, --debug-file=[debugfile]
82 Write debug information to given file
83 -V, --version
85 Display version information and exit
86 -h, --help
88 Display help and exit
89 -C, --separator=[char]
91 Separator for CSV created by 'list' operation (Default Value: ,)
92 --delay=[seconds]
95 Wait X seconds before fencing is started (Default Value: 0)
96 --login-timeout=[seconds]
99 Wait X seconds for cmd prompt after login (Default Value: 5)
100 --power-timeout=[seconds]
103 Test X seconds for status change after ON/OFF (Default Value:
104 20)
105 --power-wait=[seconds]
107 Wait X seconds after issuing ON/OFF (Default Value: 0)
108 --shell-timeout=[seconds]
110 Wait X seconds for cmd prompt after issuing command (Default
111 Value: 180)
112 --retry-on=[attempts]
114 Count of attempts to retry power on (Default Value: 1)
115
118 on Power on machine.
121 off Power off machine.
123 reboot Reboot machine.
125 status This returns the status of the plug/virtual machine.
127 list List available plugs with aliases/virtual machines if there is
129 support for more then one device. Returns N/A otherwise.
130 list-status
132 List available plugs with aliases/virtual machines and their
133 power state if it can be obtained without additional commands.
134 monitor
137 Check the health of fence device
138 metadata
140 Display the XML metadata describing this resource.
141 manpage
143 The operational behavior of this is not known.
144 validate-all
146 Validate if all required parameters are entered.
147
150 action Fencing action (Default Value: reboot)
153 auth_url
155 Keystone Admin Auth URL (Default Value: )
156 endpoint_type
158 Nova Endpoint type (Default Value: internalURL)
159 password
162 Login password or passphrase Obsoletes: passwd
163 password_script
165 Script to run to retrieve password Obsoletes: passwd_script
166 plug Physical plug number on device, UUID or identification of
169 machine This parameter is always required. Obsoletes: port
170 region_name
173 Region Name (Default Value: )
174 tenant_name
176 Keystone Admin Tenant or v3 Project (Default Value: )
177 username
179 Login name Obsoletes: login
180 insecure
182 Allow Insecure TLS Requests (Default Value: False)
183 project_domain
185 Keystone v3 Project Domain (Default Value: Default) Obsoletes:
186 project-domain
187 user_domain
189 Keystone v3 User Domain (Default Value: Default) Obsoletes:
190 user-domain
191 domain DNS domain in which hosts live
193 instance_filtering
195 Allow instances to be evacuated (Default Value: True)
196 no_shared_storage
198 Disable functionality for dealing with shared storage (Default
199 Value: False)
200 compute_domain
202 Replaced by domain Obsoletes: compute-domain
203 quiet Disable logging to stderr. Does not affect --verbose or --debug-
205 file or logging to syslog.
206 verbose
208 Verbose mode
209 debug_file
211 Write debug information to given file Obsoletes: debug
212 version
214 Display version information and exit
215 help Display help and exit
217 separator
219 Separator for CSV created by 'list' operation (Default Value: ,)
220 delay Wait X seconds before fencing is started (Default Value: 0)
223 login_timeout
226 Wait X seconds for cmd prompt after login (Default Value: 5)
227 power_timeout
230 Test X seconds for status change after ON/OFF (Default Value:
231 20)
232 power_wait
234 Wait X seconds after issuing ON/OFF (Default Value: 0)
235 shell_timeout
237 Wait X seconds for cmd prompt after issuing command (Default
238 Value: 180)
239 retry_on
241 Count of attempts to retry power on (Default Value: 1)
242fence_evacuate (Fence Agent) 2009-10-20 FENCE_AGENT(8)