1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_openstack - Fence agent for OpenStack's Nova service
8

DESCRIPTION

10       fence_openstack is a Fencing agent which can be used with machines con‐
11       trolled by the Openstack's Nova service. This agent calls  the  python-
12       novaclient and it is mandatory to be installed
13
14       fence_openstack  accepts  options  on  the command line as well as from
15       stdin. Fenced sends parameters through stdin when it execs  the  agent.
16       fence_openstack  can  be run by itself with command line options.  This
17       is useful for testing and for turning outlets on or off from scripts.
18
19       Vendor URL: https://wiki.openstack.org/wiki/Nova
20

PARAMETERS

22
23
24       -o, --action=[action]
25              Fencing action (Default Value: reboot)
26
27       --auth-url=[authurl]
28              Keystone Auth URL This  parameter  is  always  required.
29
30
31       -p, --password=[password]
32              Login password or passphrase
33
34       -S, --password-script=[script]
35              Script to run to retrieve password
36
37       -n, --plug=[UUID]
38              UUID of the node to be fenced.
39
40       --project-domain-name=[domain]
41              Keystone Project Domain Name (Default Value: Default)
42
43       --project-name=[project]
44              Keystone Project (Default Value: admin)
45
46       --user-domain-name=[domain]
47              Keystone User Domain Name (Default Value: Default)
48
49       -l, --username=[name]
50              Login name This parameter is always required.
51
52       --uuid=[uuid]
53              Replaced by port/-n/--plug
54
55       -q, --quiet
56              Disable logging to stderr. Does not affect --verbose or --debug-
57              file or logging to syslog.
58
59       -v, --verbose
60              Verbose mode
61
62       -D, --debug-file=[debugfile]
63              Write debug information to given file
64
65       -V, --version
66              Display version information and exit
67
68       -h, --help
69              Display help and exit
70
71       --delay=[seconds]
72              Wait X seconds before fencing  is  started  (Default  Value:  0)
73
74
75       --login-timeout=[seconds]
76              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
77
78
79       --power-timeout=[seconds]
80              Test X seconds for status change after  ON/OFF  (Default  Value:
81              20)
82
83       --power-wait=[seconds]
84              Wait X seconds after issuing ON/OFF (Default Value: 0)
85
86       --shell-timeout=[seconds]
87              Wait  X  seconds  for  cmd prompt after issuing command (Default
88              Value: 3)
89
90       --retry-on=[attempts]
91              Count of attempts to retry power on (Default Value: 1)
92
93

ACTIONS

95
96
97       on     Power on machine.
98
99       off    Power off machine.
100
101       reboot Reboot machine.
102
103       status This returns the status of the plug/virtual machine.
104
105       monitor
106              Check the health of fence device
107
108       metadata
109              Display the XML metadata describing this resource.
110
111       manpage
112               The operational behavior of this is not known.
113
114       validate-all
115              Validate if all required parameters are entered.
116
117

STDIN PARAMETERS

119
120
121       action Fencing action (Default Value: reboot)
122
123       auth_url
124              Keystone Auth URL This parameter is always required.  Obsoletes:
125              auth-url
126
127       password
128              Login password or passphrase Obsoletes: passwd
129
130       password_script
131              Script  to  run  to  retrieve  password Obsoletes: passwd_script
132
133
134       plug   UUID of the node to be fenced. Obsoletes: port
135
136
137       project_domain_name
138              Keystone Project Domain Name (Default Value: Default) Obsoletes:
139              project-domain-name
140
141       project_name
142              Keystone Project (Default Value: admin) Obsoletes:  project-name
143
144
145       user_domain_name
146              Keystone  User  Domain  Name (Default Value: Default) Obsoletes:
147              user-domain-name
148
149       username
150              Login name This parameter is always required.  Obsoletes:  login
151
152
153       uuid   Replaced by port/-n/--plug
154
155       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
156              file or logging to syslog.
157
158       verbose
159              Verbose mode
160
161       debug_file
162              Write debug information to given file Obsoletes: debug
163
164       version
165              Display version information and exit
166
167       help   Display help and exit
168
169       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
170
171
172       login_timeout
173              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
174
175
176       power_timeout
177              Test X seconds for status change after  ON/OFF  (Default  Value:
178              20)
179
180       power_wait
181              Wait X seconds after issuing ON/OFF (Default Value: 0)
182
183       shell_timeout
184              Wait  X  seconds  for  cmd prompt after issuing command (Default
185              Value: 3)
186
187       retry_on
188              Count of attempts to retry power on (Default Value: 1)
189
190
191
192fence_openstack (Fence Agent)     2009-10-20                    FENCE_AGENT(8)
Impressum