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       -C, --separator=[char]
67              Separator for CSV created by 'list' operation (Default Value: ,)
68
69
70       --delay=[seconds]
71              Wait  X  seconds  before  fencing  is started (Default Value: 0)
72
73
74       --disable-timeout=[true/false]
75              Disable timeout (true/false) (default: true when run from  Pace‐
76              maker 2.0+)
77
78       --login-timeout=[seconds]
79              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
80
81
82       --power-timeout=[seconds]
83              Test X seconds for status change after  ON/OFF  (Default  Value:
84              20)
85
86       --power-wait=[seconds]
87              Wait X seconds after issuing ON/OFF (Default Value: 0)
88
89       --shell-timeout=[seconds]
90              Wait  X  seconds  for  cmd prompt after issuing command (Default
91              Value: 3)
92
93       --stonith-status-sleep=[seconds]
94              Sleep X seconds between status calls  during  a  STONITH  action
95              (Default Value: 1)
96
97       --retry-on=[attempts]
98              Count of attempts to retry power on (Default Value: 1)
99
100

ACTIONS

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

STDIN PARAMETERS

132
133
134       action Fencing action (Default Value: reboot)
135
136       email  Reboot email This parameter is  always  required.
137
138
139       password
140              Login password or passphrase Obsoletes: passwd
141
142       password_script
143              Script  to  run  to  retrieve  password Obsoletes: passwd_script
144
145
146       plug   Physical plug number on device, UUID or  identification  of  ma‐
147              chine  This  parameter is always required. Obsoletes: port
148
149
150       username
151              Login name This parameter is always required.  Obsoletes:  login
152
153
154       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
155              file or logging to syslog.
156
157       verbose
158              Verbose mode. Multiple -v flags can be stacked  on  the  command
159              line (e.g., -vvv) to increase verbosity.
160
161       verbose_level
162              Level  of  debugging detail in output. Defaults to the number of
163              --verbose flags specified on the command line, or to 1  if  ver‐
164              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
165
166
167       debug_file
168              Write debug information to given file Obsoletes: debug
169
170       version
171              Display version information and exit
172
173       help   Display help and exit
174
175       separator
176              Separator for CSV created by 'list' operation (Default Value: ,)
177
178
179       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
180
181
182       disable_timeout
183              Disable timeout (true/false) (default: true when run from  Pace‐
184              maker 2.0+)
185
186       login_timeout
187              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
188
189
190       power_timeout
191              Test X seconds for status change after  ON/OFF  (Default  Value:
192              20)
193
194       power_wait
195              Wait X seconds after issuing ON/OFF (Default Value: 0)
196
197       shell_timeout
198              Wait  X  seconds  for  cmd prompt after issuing command (Default
199              Value: 3)
200
201       stonith_status_sleep
202              Sleep X seconds between status calls  during  a  STONITH  action
203              (Default Value: 1)
204
205       retry_on
206              Count of attempts to retry power on (Default Value: 1)
207
208
209
210fence_ovh (Fence Agent)           2009-10-20                    FENCE_AGENT(8)
Impressum