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

NAME

7       fence_ibm_powervs - Fence agent for IBM PowerVS
8

DESCRIPTION

10       fence_ibm_powervs  is  an  I/O Fencing agent which can be used with IBM
11       PowerVS to fence virtual machines.
12
13       fence_ibm_powervs accepts options on the command line as well  as  from
14       stdin.  Fenced  sends parameters through stdin when it execs the agent.
15       fence_ibm_powervs can be run by itself with command line options.  This
16       is useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: https://www.ibm.com
19

PARAMETERS

21
22
23       --api-type=[public|private]
24              API-type (public|private) (Default Value: private)
25
26       --crn=[crn]
27              CRN This parameter is always required.
28
29       --instance=[instance]
30              PowerVS Instance This parameter is always required.
31
32       --proxy=[http://<URL>:<PORT>]
33              Network proxy (Default Value: )
34
35       --region=[region]
36              Region This parameter is always required.
37
38       --token=[token]
39              API Token This parameter is always required.
40
41       -o, --action=[action]
42              Fencing action (Default Value: reboot)
43
44       -n, --plug=[id]
45              Physical  plug  number  on device, UUID or identification of ma‐
46              chine This parameter is always required.
47
48       -q, --quiet
49              Disable logging to stderr. Does not affect --verbose or --debug-
50              file or logging to syslog.
51
52       -v, --verbose
53              Verbose  mode.  Multiple  -v flags can be stacked on the command
54              line (e.g., -vvv) to increase verbosity.
55
56       --verbose-level
57              Level of debugging detail in output. Defaults to the  number  of
58              --verbose  flags  specified on the command line, or to 1 if ver‐
59              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
60
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       --plug-separator=[char]
72              Separator  for  plug  parameter when specifying more than 1 plug
73              (Default Value: ,)
74
75       -C, --separator=[char]
76              Separator for CSV created by 'list' operation (Default Value: ,)
77
78
79       --delay=[seconds]
80              Wait  X  seconds  before  fencing  is started (Default Value: 0)
81
82
83       --disable-timeout=[true/false]
84              Disable timeout (true/false) (default: true when run from  Pace‐
85              maker 2.0+)
86
87       --login-timeout=[seconds]
88              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
89
90
91       --power-timeout=[seconds]
92              Test X seconds for status change after  ON/OFF  (Default  Value:
93              30)
94
95       --power-wait=[seconds]
96              Wait X seconds after issuing ON/OFF (Default Value: 1)
97
98       --shell-timeout=[seconds]
99              Wait  X  seconds  for  cmd prompt after issuing command (Default
100              Value: 500)
101
102       --stonith-status-sleep=[seconds]
103              Sleep X seconds between status calls  during  a  STONITH  action
104              (Default Value: 2)
105
106       --retry-on=[attempts]
107              Count of attempts to retry power on (Default Value: 1)
108
109

ACTIONS

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

STDIN PARAMETERS

143
144
145       api_type
146              API-type (public|private) (Default  Value:  private)  Obsoletes:
147              api-type
148
149       crn    CRN This parameter is always required.
150
151       instance
152              PowerVS Instance This parameter is always required.
153
154       proxy  Network proxy (Default Value: )
155
156       region Region This parameter is always required.
157
158       token  API Token This parameter is always required.
159
160       action Fencing action (Default Value: reboot)
161
162       plug   Physical  plug  number  on device, UUID or identification of ma‐
163              chine This parameter is always required. Obsoletes:  port
164
165
166       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
167              file or logging to syslog.
168
169       verbose
170              Verbose mode. Multiple -v flags can be stacked  on  the  command
171              line (e.g., -vvv) to increase verbosity.
172
173       verbose_level
174              Level  of  debugging detail in output. Defaults to the number of
175              --verbose flags specified on the command line, or to 1  if  ver‐
176              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
177
178
179       debug_file
180              Write debug information to given file Obsoletes: debug
181
182       version
183              Display version information and exit
184
185       help   Display help and exit
186
187       plug_separator
188              Separator for plug parameter when specifying more  than  1  plug
189              (Default Value: ,)
190
191       separator
192              Separator for CSV created by 'list' operation (Default Value: ,)
193
194
195       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
196
197
198       disable_timeout
199              Disable  timeout (true/false) (default: true when run from Pace‐
200              maker 2.0+)
201
202       login_timeout
203              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
204
205
206       power_timeout
207              Test  X  seconds  for status change after ON/OFF (Default Value:
208              30)
209
210       power_wait
211              Wait X seconds after issuing ON/OFF (Default Value: 1)
212
213       shell_timeout
214              Wait X seconds for cmd prompt  after  issuing  command  (Default
215              Value: 500)
216
217       stonith_status_sleep
218              Sleep  X  seconds  between  status calls during a STONITH action
219              (Default Value: 2)
220
221       retry_on
222              Count of attempts to retry power on (Default Value: 1)
223
224
225
226fence_ibm_powervs (Fence Agent)   2009-10-20                    FENCE_AGENT(8)