fence_raritan(8)

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

NAME

7       fence_raritan - I/O Fencing agent for Raritan Dominion PX
8

DESCRIPTION

10       fence_raritan  is an I/O Fencing agent which can be used with the Rari‐
11       tan DPXS12-20 Power Distribution Unit. It logs into device  via  telnet
12       and  reboots  a  specified outlet. Lengthy telnet connections should be
13       avoided while a GFS cluster is  running  because  the  connection  will
14       block any necessary fencing actions.
15
16       fence_raritan  accepts  options  on  the  command  line as well as from
17       stdin. Fenced sends parameters through stdin when it execs  the  agent.
18       fence_raritan  can be run by itself with command line options.  This is
19       useful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: http://www.raritan.com/
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -4, --inet4-only
30              Forces agent to use IPv4 addresses only
31
32       -6, --inet6-only
33              Forces agent to use IPv6 addresses only
34
35       -a, --ip=[ip]
36              IP address or hostname  of  fencing  device  This  parameter  is
37              always required.
38
39       -u, --ipport=[port]
40              TCP/UDP  port  to use for connection with device (Default Value:
41              23)
42
43       -p, --password=[password]
44              Login password or passphrase
45
46       -S, --password-script=[script]
47              Script to run to retrieve password
48
49       -n, --plug=[id]
50              Physical plug  number  on  device,  UUID  or  identification  of
51              machine This parameter is always required.
52
53       -l, --username=[name]
54              Login name This parameter is always required.
55
56       -q, --quiet
57              Disable logging to stderr. Does not affect --verbose or --debug-
58              file or logging to syslog.
59
60       -v, --verbose
61              Verbose mode
62
63       -D, --debug-file=[debugfile]
64              Write debug information to given file
65
66       -V, --version
67              Display version information and exit
68
69       -h, --help
70              Display help and exit
71
72       -C, --separator=[char]
73              Separator for CSV created by 'list' operation (Default Value: ,)
74
75
76       --delay=[seconds]
77              Wait  X  seconds  before  fencing  is started (Default Value: 0)
78
79
80       --login-timeout=[seconds]
81              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
82
83
84       --power-timeout=[seconds]
85              Test  X  seconds  for status change after ON/OFF (Default Value:
86              20)
87
88       --power-wait=[seconds]
89              Wait X seconds after issuing ON/OFF (Default Value: 0)
90
91       --shell-timeout=[seconds]
92              Wait X seconds for cmd prompt  after  issuing  command  (Default
93              Value: 3)
94
95       --retry-on=[attempts]
96              Count of attempts to retry power on (Default Value: 1)
97
98       --telnet-path=[path]
99              Path to telnet binary (Default Value: /usr/bin/telnet)
100
101

ACTIONS

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

STDIN PARAMETERS

135
136
137       action Fencing action (Default Value: reboot)
138
139       inet4_only
140              Forces agent to use IPv4 addresses only
141
142       inet6_only
143              Forces agent to use IPv6 addresses only
144
145       ip     IP address or hostname  of  fencing  device  This  parameter  is
146              always required. Obsoletes: ipaddr
147
148       ipport TCP/UDP  port  to use for connection with device (Default Value:
149              23)
150
151       password
152              Login password or passphrase Obsoletes: passwd
153
154       password_script
155              Script to run  to  retrieve  password  Obsoletes:  passwd_script
156
157
158       plug   Physical  plug  number  on  device,  UUID  or  identification of
159              machine This parameter is always required. Obsoletes: port
160
161
162       username
163              Login  name  This parameter is always required. Obsoletes: login
164
165
166       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
167              file or logging to syslog.
168
169       verbose
170              Verbose mode
171
172       debug_file
173              Write debug information to given file Obsoletes: debug
174
175       version
176              Display version information and exit
177
178       help   Display help and exit
179
180       separator
181              Separator for CSV created by 'list' operation (Default Value: ,)
182
183
184       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
185
186
187       login_timeout
188              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
189
190
191       power_timeout
192              Test X seconds for status change after  ON/OFF  (Default  Value:
193              20)
194
195       power_wait
196              Wait X seconds after issuing ON/OFF (Default Value: 0)
197
198       shell_timeout
199              Wait  X  seconds  for  cmd prompt after issuing command (Default
200              Value: 3)
201
202       retry_on
203              Count of attempts to retry power on (Default Value: 1)
204
205       telnet_path
206              Path to telnet binary (Default Value: /usr/bin/telnet)
207
208
209
210fence_raritan (Fence Agent)       2009-10-20                    FENCE_AGENT(8)