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
38              machine 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       --retry-on=[attempts]
94              Count of attempts to retry power on (Default Value: 1)
95
96

ACTIONS

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

STDIN PARAMETERS

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