fence_ibm_vpc(8)

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

NAME

7       fence_ibm_vpc - Fence agent for IBM Cloud VPC
8

DESCRIPTION

10       fence_ibm_vpc  is an I/O Fencing agent which can be used with IBM Cloud
11       VPC to fence virtual machines.
12
13       fence_ibm_vpc 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_vpc can be run by itself with command line options.  This  is
16       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       --apikey=[key]
24              API Key This parameter is always required.
25
26       --limit=[number]
27              Number of nodes returned by API (Default Value: 50)
28
29       --proxy=[http://<URL>:<PORT>]
30              Network proxy (Default Value: )
31
32       --region=[region]
33              Region This parameter is always required.
34
35       --token-file=[path]
36              Path  to  the  token  cache  file  (Default  Value:  /run/fence-
37              agents/fence_ibm_vpc/[hash].token)
38
39       -o, --action=[action]
40              Fencing action (Default Value: reboot)
41
42       -n, --plug=[id]
43              Physical plug number on device, UUID or  identification  of  ma‐
44              chine This parameter is always required.
45
46       -q, --quiet
47              Disable logging to stderr. Does not affect --verbose or --debug-
48              file or logging to syslog.
49
50       -v, --verbose
51              Verbose mode. Multiple -v flags can be stacked  on  the  command
52              line (e.g., -vvv) to increase verbosity.
53
54       --verbose-level
55              Level  of  debugging detail in output. Defaults to the number of
56              --verbose flags specified on the command line, or to 1  if  ver‐
57              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
58
59
60       -D, --debug-file=[debugfile]
61              Write debug information to given file
62
63       -V, --version
64              Display version information and exit
65
66       -h, --help
67              Display help and exit
68
69       --plug-separator=[char]
70              Separator for plug parameter when specifying more  than  1  plug
71              (Default Value: ,)
72
73       -C, --separator=[char]
74              Separator for CSV created by 'list' operation (Default Value: ,)
75
76
77       --delay=[seconds]
78              Wait X seconds before fencing  is  started  (Default  Value:  0)
79
80
81       --disable-timeout=[true/false]
82              Disable  timeout (true/false) (default: true when run from Pace‐
83              maker 2.0+)
84
85       --login-timeout=[seconds]
86              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
87
88
89       --power-timeout=[seconds]
90              Test  X  seconds  for status change after ON/OFF (Default Value:
91              30)
92
93       --power-wait=[seconds]
94              Wait X seconds after issuing ON/OFF (Default Value: 1)
95
96       --shell-timeout=[seconds]
97              Wait X seconds for cmd prompt  after  issuing  command  (Default
98              Value: 15)
99
100       --stonith-status-sleep=[seconds]
101              Sleep  X  seconds  between  status calls during a STONITH action
102              (Default Value: 1)
103
104       --retry-on=[attempts]
105              Count of attempts to retry power on (Default Value: 1)
106
107

ACTIONS

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

STDIN PARAMETERS

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