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

NAME

7       fence_lpar - Fence agent for IBM LPAR
8

DESCRIPTION

10       fence_lpar  accepts  options on the command line as well as from stdin.
11       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
12       fence_lpar  can  be  run  by itself with command line options.  This is
13       useful for testing and for turning outlets on or off from scripts.
14
15

PARAMETERS

17
18
19       -o, --action=<action>
20              Fencing Action (Default Value: reboot)
21
22       -a, --ip=<ip>
23              IP Address or Hostname This parameter is always required.
24
25       -l, --username=<name>
26              Login Name This parameter is always required.
27
28       -p, --password=<password>
29              Login password or passphrase
30
31       -S, --password-script=<script>
32              Script to retrieve password
33
34       -x, --ssh
35              SSH connection (Default Value: 1)
36
37       -k, --identity-file=<filename>
38              Identity file for ssh
39
40       -n <id> Name of the partition
41              Partition name
42
43       -s <id> Name of the managed system
44              Managed system name
45
46       -H, --hmc-version=<version>
47              Force HMC version to use (3 or 4) (Default Value: 4)
48
49       -c, --command-prompt=<prompt>
50              Force command prompt (Default  Value:  [':~>',  ']\$',  '\$  '])
51
52
53       -4, --inet4-only
54              Forces agent to use IPv4 addresses only
55
56       -6, --inet6-only
57              Forces agent to use IPv6 addresses only
58
59       -u, --ipport=<port>
60              TCP port to use for connection with device
61
62       -v, --verbose
63              Verbose mode
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       -C, --separator=<char>
75              Separator  for  CSV created by operation list (Default Value: ,)
76
77
78       --power-timeout
79              Test X seconds for status change after  ON/OFF  (Default  Value:
80              20)
81
82       --shell-timeout
83              Wait  X  seconds  for  cmd prompt after issuing command (Default
84              Value: 3)
85
86       --login-timeout
87              Wait X seconds for cmd prompt after login  (Default  Value:  15)
88
89
90       --power-wait
91              Wait X seconds after issuing ON/OFF (Default Value: 0)
92
93       --delay
94              Wait  X  seconds  before  fencing  is started (Default Value: 0)
95
96
97       --retry-on
98              Count of attempts to retry power on (Default Value: 1)
99
100

ACTIONS

102
103
104       on     Power on machine.
105
106       off    Power off machine.
107
108       reboot Reboot machine.
109
110       status This returns the status of the plug/virtual machine.
111
112       list   List available plugs with aliases/virtual machines if  there  is
113              support for more then one device. Returns N/A otherwise.
114
115       monitor
116              Check if fencing device is running. List available plugs/virtual
117              machines or get status of machine (if it does not support more).
118
119
120       metadata
121               The operational behavior of this is not known.
122
123

STDIN PARAMETERS

125
126
127       action Fencing Action (Default Value: reboot)
128
129       ipaddr IP Address or Hostname This parameter is always required.
130
131       login  Login Name This parameter is always required.
132
133       passwd Login password or passphrase
134
135       passwd_script
136              Script to retrieve password
137
138       secure SSH connection (Default Value: 1)
139
140       identity_file
141              Identity file for ssh
142
143       partition
144              Partition name
145
146       managed
147              Managed system name
148
149       hmc_version
150              Force HMC version to use (3 or 4) (Default Value: 4)
151
152       cmd_prompt
153              Force  command  prompt  (Default  Value:  [':~>', ']\$', '\$ '])
154
155
156       inet4_only
157              Forces agent to use IPv4 addresses only
158
159       inet6_only
160              Forces agent to use IPv6 addresses only
161
162       ipport TCP port to use for connection with device
163
164       verbose
165              Verbose mode
166
167       debug  Write debug information to given file
168
169       version
170              Display version information and exit
171
172       help   Display help and exit
173
174       separator
175              Separator for CSV created by operation list (Default  Value:  ,)
176
177
178       power_timeout
179              Test  X  seconds  for status change after ON/OFF (Default Value:
180              20)
181
182       shell_timeout
183              Wait X seconds for cmd prompt  after  issuing  command  (Default
184              Value: 3)
185
186       login_timeout
187              Wait  X  seconds  for cmd prompt after login (Default Value: 15)
188
189
190       power_wait
191              Wait X seconds after issuing ON/OFF (Default Value: 0)
192
193       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
194
195
196       retry_on
197              Count of attempts to retry power on (Default Value: 1)
198
199
200
201fence_lpar (Fence Agent)          2009-10-20                    FENCE_AGENT(8)