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

NAME

7       fence_ovh - Fence agent for OVH
8

DESCRIPTION

10       fence_ovh  is an Power Fencing agent which can be used within OVH date‐
11       centre. Poweroff is simulated with a reboot into rescue-pro mode.
12
13       fence_ovh accepts options on the command line as well  as  from  stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_ovh can be run by itself with command line options.  This is use‐
16       ful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: http://www.ovh.net
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       -Z, --email=[email]
27              Reboot  email  This  parameter  is always required.
28
29
30       -p, --password=[password]
31              Login password or passphrase
32
33       -S, --password-script=[script]
34              Script to run to retrieve password
35
36       -n, --plug=[id]
37              Physical plug number on device, UUID or  identification  of  ma‐
38              chine This parameter is always required.
39
40       -l, --username=[name]
41              Login name This parameter is always required.
42
43       -q, --quiet
44              Disable logging to stderr. Does not affect --verbose or --debug-
45              file or logging to syslog.
46
47       -v, --verbose
48              Verbose mode. Multiple -v flags can be stacked  on  the  command
49              line (e.g., -vvv) to increase verbosity.
50
51       --verbose-level
52              Level  of  debugging detail in output. Defaults to the number of
53              --verbose flags specified on the command line, or to 1  if  ver‐
54              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
55
56
57       -D, --debug-file=[debugfile]
58              Write debug information to given file
59
60       -V, --version
61              Display version information and exit
62
63       -h, --help
64              Display help and exit
65
66       --plug-separator=[char]
67              Separator for plug parameter when specifying more  than  1  plug
68              (Default Value: ,)
69
70       -C, --separator=[char]
71              Separator for CSV created by 'list' operation (Default Value: ,)
72
73
74       --delay=[seconds]
75              Wait X seconds before fencing  is  started  (Default  Value:  0)
76
77
78       --disable-timeout=[true/false]
79              Disable  timeout (true/false) (default: true when run from Pace‐
80              maker 2.0+)
81
82       --login-timeout=[seconds]
83              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
84
85
86       --power-timeout=[seconds]
87              Test  X  seconds  for status change after ON/OFF (Default Value:
88              20)
89
90       --power-wait=[seconds]
91              Wait X seconds after issuing ON/OFF (Default Value: 0)
92
93       --shell-timeout=[seconds]
94              Wait X seconds for cmd prompt  after  issuing  command  (Default
95              Value: 3)
96
97       --stonith-status-sleep=[seconds]
98              Sleep  X  seconds  between  status calls during a STONITH action
99              (Default Value: 1)
100
101       --retry-on=[attempts]
102              Count of attempts to retry power on (Default Value: 1)
103
104

ACTIONS

106
107
108       on     Power on machine.
109
110       off    Power off machine.
111
112       reboot Reboot machine.
113
114       list   List available plugs with aliases/virtual machines if  there  is
115              support for more then one device. Returns N/A otherwise.
116
117       list-status
118              List  available  plugs  with  aliases/virtual machines and their
119              power state if it can be obtained without  additional  commands.
120
121
122       monitor
123              Check the health of fence device
124
125       metadata
126              Display the XML metadata describing this resource.
127
128       manpage
129               The operational behavior of this is not known.
130
131       validate-all
132              Validate if all required parameters are entered.
133
134

STDIN PARAMETERS

136
137
138       action Fencing action (Default Value: reboot)
139
140       email  Reboot  email  This  parameter  is always required.
141
142
143       password
144              Login password or passphrase Obsoletes: passwd
145
146       password_script
147              Script to run  to  retrieve  password  Obsoletes:  passwd_script
148
149
150       plug   Physical  plug  number  on device, UUID or identification of ma‐
151              chine This parameter is always required. Obsoletes:  port
152
153
154       username
155              Login  name  This parameter is always required. Obsoletes: login
156
157
158       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
159              file or logging to syslog.
160
161       verbose
162              Verbose  mode.  Multiple  -v flags can be stacked on the command
163              line (e.g., -vvv) to increase verbosity.
164
165       verbose_level
166              Level of debugging detail in output. Defaults to the  number  of
167              --verbose  flags  specified on the command line, or to 1 if ver‐
168              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
169
170
171       debug_file
172              Write debug information to given file Obsoletes: debug
173
174       version
175              Display version information and exit
176
177       help   Display help and exit
178
179       plug_separator
180              Separator  for  plug  parameter when specifying more than 1 plug
181              (Default Value: ,)
182
183       separator
184              Separator for CSV created by 'list' operation (Default Value: ,)
185
186
187       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
188
189
190       disable_timeout
191              Disable timeout (true/false) (default: true when run from  Pace‐
192              maker 2.0+)
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       stonith_status_sleep
210              Sleep X seconds between status calls  during  a  STONITH  action
211              (Default Value: 1)
212
213       retry_on
214              Count of attempts to retry power on (Default Value: 1)
215
216
217
218fence_ovh (Fence Agent)           2009-10-20                    FENCE_AGENT(8)