fence_ibm_powervs(8)

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       -m, --method=[method]
45              Method to fence (onoff|cycle) (Default Value: onoff)
46
47       -n, --plug=[id]
48              Physical  plug  number  on device, UUID or identification of ma‐
49              chine This parameter is always required.
50
51       -q, --quiet
52              Disable logging to stderr. Does not affect --verbose or --debug-
53              file or logging to syslog.
54
55       -v, --verbose
56              Verbose  mode.  Multiple  -v flags can be stacked on the command
57              line (e.g., -vvv) to increase verbosity.
58
59       --verbose-level
60              Level of debugging detail in output. Defaults to the  number  of
61              --verbose  flags  specified on the command line, or to 1 if ver‐
62              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
63
64
65       -D, --debug-file=[debugfile]
66              Write debug information to given file
67
68       -V, --version
69              Display version information and exit
70
71       -h, --help
72              Display help and exit
73
74       --plug-separator=[char]
75              Separator  for  plug  parameter when specifying more than 1 plug
76              (Default Value: ,)
77
78       -C, --separator=[char]
79              Separator for CSV created by 'list' operation (Default Value: ,)
80
81
82       --delay=[seconds]
83              Wait  X  seconds  before  fencing  is started (Default Value: 0)
84
85
86       --disable-timeout=[true/false]
87              Disable timeout (true/false) (default: true when run from  Pace‐
88              maker 2.0+)
89
90       --login-timeout=[seconds]
91              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
92
93
94       --power-timeout=[seconds]
95              Test X seconds for status change after  ON/OFF  (Default  Value:
96              30)
97
98       --power-wait=[seconds]
99              Wait X seconds after issuing ON/OFF (Default Value: 1)
100
101       --shell-timeout=[seconds]
102              Wait  X  seconds  for  cmd prompt after issuing command (Default
103              Value: 500)
104
105       --stonith-status-sleep=[seconds]
106              Sleep X seconds between status calls  during  a  STONITH  action
107              (Default Value: 2)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112

ACTIONS

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

STDIN PARAMETERS

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