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

NAME

7       fence_zvmip - Fence agent for use with z/VM Virtual Machines
8

DESCRIPTION

10       The fence_zvm agent is intended to be used with with z/VM SMAPI service
11       via TCP/IP
12
13       To  use this agent the z/VM SMAPI service needs  to  be  configured  to
14       allow the virtual machine running this agent to connect to it and issue
15       the image_recycle operation.  This involves updating the VSMWORK1 AUTH‐
16       LIST  VMSYS:VSMWORK1.  file. The entry should look something similar to
17       this:
18
19       Column 1                   Column 66                Column 131
20
21          |                          |                        |
22          V                          V                        V
23
24       XXXXXXXX                      ALL                      IMAGE_CHARACTER‐
25       ISTICS
26
27       Where  XXXXXXX  is the name of the virtual machine used in the authuser
28       field of the request. This virtual machine also has to be authorized to
29       access the system's directory manager.
30
31
32       fence_zvmip  accepts options on the command line as well as from stdin.
33       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
34       fence_zvmip  can  be  run by itself with command line options.  This is
35       useful for testing and for turning outlets on or off from scripts.
36
37       Vendor URL: http://www.ibm.com
38

PARAMETERS

40
41
42       -o, --action=[action]
43              Fencing action (Default Value: reboot)
44
45       -4, --inet4-only
46              Forces agent to use IPv4 addresses only
47
48       -6, --inet6-only
49              Forces agent to use IPv6 addresses only
50
51       -a, --ip=[ip]
52              IP address or hostname  of  fencing  device  This  parameter  is
53              always required.
54
55       -u, --ipport=[port]
56              TCP/UDP  port  to use for connection with device (Default Value:
57              44444)
58
59       -m, --method=[method]
60              Method to fence (onoff|cycle) (Default Value: onoff)
61
62
63       -p, --password=[password]
64              Login password or passphrase
65
66       -S, --password-script=[script]
67              Script to run to retrieve password
68
69       -n, --plug=[id]
70              Physical  plug  number  on  device,  UUID  or  identification of
71              machine This parameter is always required.
72
73       -l, --username=[name]
74              Login name This parameter is always required.
75
76       -q, --quiet
77              Disable logging to stderr. Does not affect --verbose or --debug-
78              file or logging to syslog.
79
80       -v, --verbose
81              Verbose mode
82
83       -D, --debug-file=[debugfile]
84              Write debug information to given file
85
86       -V, --version
87              Display version information and exit
88
89       -h, --help
90              Display help and exit
91
92       -C, --separator=[char]
93              Separator for CSV created by 'list' operation (Default Value: ,)
94
95
96       --delay=[seconds]
97              Wait X seconds before fencing  is  started  (Default  Value:  0)
98
99
100       --login-timeout=[seconds]
101              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
102
103
104       --missing-as-off
105              Missing port returns OFF instead of failure (Default  Value:  1)
106
107
108       --power-timeout=[seconds]
109              Test  X  seconds  for status change after ON/OFF (Default Value:
110              20)
111
112       --power-wait=[seconds]
113              Wait X seconds after issuing ON/OFF (Default Value: 0)
114
115       --shell-timeout=[seconds]
116              Wait X seconds for cmd prompt  after  issuing  command  (Default
117              Value: 5)
118
119       --retry-on=[attempts]
120              Count of attempts to retry power on (Default Value: 1)
121
122

ACTIONS

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

STDIN PARAMETERS

156
157
158       action Fencing action (Default Value: reboot)
159
160       inet4_only
161              Forces agent to use IPv4 addresses only
162
163       inet6_only
164              Forces agent to use IPv6 addresses only
165
166       ip     IP address or hostname  of  fencing  device  This  parameter  is
167              always required. Obsoletes: ipaddr
168
169       ipport TCP/UDP  port  to use for connection with device (Default Value:
170              44444)
171
172       method Method to fence (onoff|cycle) (Default Value: onoff)
173
174
175       password
176              Login password or passphrase Obsoletes: passwd
177
178       password_script
179              Script  to  run  to  retrieve  password Obsoletes: passwd_script
180
181
182       plug   Physical plug  number  on  device,  UUID  or  identification  of
183              machine This parameter is always required. Obsoletes: port
184
185
186       username
187              Login name This parameter is always required.  Obsoletes:  login
188
189
190       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
191              file or logging to syslog.
192
193       verbose
194              Verbose mode
195
196       debug_file
197              Write debug information to given file Obsoletes: debug
198
199       version
200              Display version information and exit
201
202       help   Display help and exit
203
204       separator
205              Separator for CSV created by 'list' operation (Default Value: ,)
206
207
208       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
209
210
211       login_timeout
212              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
213
214
215       missing_as_off
216              Missing  port  returns OFF instead of failure (Default Value: 1)
217
218
219       power_timeout
220              Test X seconds for status change after  ON/OFF  (Default  Value:
221              20)
222
223       power_wait
224              Wait X seconds after issuing ON/OFF (Default Value: 0)
225
226       shell_timeout
227              Wait  X  seconds  for  cmd prompt after issuing command (Default
228              Value: 5)
229
230       retry_on
231              Count of attempts to retry power on (Default Value: 1)
232
233
234
235fence_zvmip (Fence Agent)         2009-10-20                    FENCE_AGENT(8)