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

ACTIONS

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

STDIN PARAMETERS

133
134
135       apikey API Key This parameter is always required.
136
137       instance
138              Cloud Instance This parameter is always required.
139
140       limit  Number of nodes returned by API (Default Value: 50)
141
142       region Region This parameter is always required.
143
144       action Fencing action (Default Value: reboot)
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       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              30)
189
190       power_wait
191              Wait X seconds after issuing ON/OFF (Default Value: 1)
192
193       shell_timeout
194              Wait  X  seconds  for  cmd prompt after issuing command (Default
195              Value: 15)
196
197       stonith_status_sleep
198              Sleep X seconds between status calls  during  a  STONITH  action
199              (Default Value: 1)
200
201       retry_on
202              Count of attempts to retry power on (Default Value: 1)
203
204
205
206fence_ibm_vpc (Fence Agent)       2009-10-20                    FENCE_AGENT(8)