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

NAME

7       fence_rhevm - Fence agent for RHEV-M REST API
8

DESCRIPTION

10       fence_rhevm  is an I/O Fencing agent which can be used with RHEV-M REST
11       API to fence virtual machines.
12
13       fence_rhevm accepts options on the command line as well as from  stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_rhevm 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: http://www.redhat.com
19

PARAMETERS

21
22
23       -o, --action=<action>
24              Fencing Action (Default Value: reboot)
25
26       -a, --ip=<ip>
27              IP Address or Hostname This parameter is always required.
28
29       -l, --username=<name>
30              Login Name This parameter is always required.
31
32       -p, --password=<password>
33              Login password or passphrase
34
35       -S, --password-script=<script>
36              Script to retrieve password
37
38       -z, --ssl
39              SSL connection
40
41       -4, --inet4-only
42              Forces agent to use IPv4 addresses only
43
44       -6, --inet6-only
45              Forces agent to use IPv6 addresses only
46
47       -u, --ipport=<port>
48              TCP port to use for connection with device
49
50       -n, --plug=<id>
51              Physical  plug  number or name of virtual machine This parameter
52              is always required.
53
54       -v, --verbose
55              Verbose mode
56
57       -D, --debug-file=<debugfile>
58              Write debug information to given file
59
60       -V, --version
61              Display version information and exit
62
63       -h, --help
64              Display help and exit
65
66       -C, --separator=<char>
67              Separator for CSV created by operation list (Default  Value:  ,)
68
69
70       --power-wait
71              Wait X seconds after issuing ON/OFF (Default Value: 1)
72
73       --power-timeout
74              Test  X  seconds  for status change after ON/OFF (Default Value:
75              20)
76
77       --shell-timeout
78              Wait X seconds for cmd prompt  after  issuing  command  (Default
79              Value: 3)
80
81       --delay
82              Wait  X  seconds  before  fencing  is started (Default Value: 0)
83
84
85       --retry-on
86              Count of attempts to retry power on (Default Value: 1)
87
88

ACTIONS

90
91
92       on     Power on machine.
93
94       off    Power off machine.
95
96       reboot Reboot machine.
97
98       status This returns the status of the plug/virtual machine.
99
100       list   List available plugs with aliases/virtual machines if  there  is
101              support for more then one device. Returns N/A otherwise.
102
103       monitor
104              Check if fencing device is running. List available plugs/virtual
105              machines or get status of machine (if it does not support more).
106
107
108       metadata
109               The operational behavior of this is not known.
110
111

STDIN PARAMETERS

113
114
115       action Fencing Action (Default Value: reboot)
116
117       ipaddr IP Address or Hostname This parameter is always required.
118
119       login  Login Name This parameter is always required.
120
121       passwd Login password or passphrase
122
123       passwd_script
124              Script to retrieve password
125
126       ssl    SSL connection
127
128       inet4_only
129              Forces agent to use IPv4 addresses only
130
131       inet6_only
132              Forces agent to use IPv6 addresses only
133
134       ipport TCP port to use for connection with device
135
136       port   Physical  plug  number or name of virtual machine This parameter
137              is always required.
138
139       verbose
140              Verbose mode
141
142       debug  Write debug information to given file
143
144       version
145              Display version information and exit
146
147       help   Display help and exit
148
149       separator
150              Separator for CSV created by operation list (Default  Value:  ,)
151
152
153       power_wait
154              Wait X seconds after issuing ON/OFF (Default Value: 1)
155
156       power_timeout
157              Test  X  seconds  for status change after ON/OFF (Default Value:
158              20)
159
160       shell_timeout
161              Wait X seconds for cmd prompt  after  issuing  command  (Default
162              Value: 3)
163
164       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
165
166
167       retry_on
168              Count of attempts to retry power on (Default Value: 1)
169
170
171
172fence_rhevm (Fence Agent)         2009-10-20                    FENCE_AGENT(8)
Impressum