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

NAME

7       fence_kubevirt - Fence agent for KubeVirt
8

DESCRIPTION

10       fence_kubevirt is an I/O Fencing agent for KubeVirt.
11
12       fence_kubevirt  accepts  options  on  the  command line as well as from
13       stdin. Fenced sends parameters through stdin when it execs  the  agent.
14       fence_kubevirt can be run by itself with command line options.  This is
15       useful for testing and for turning outlets on or off from scripts.
16
17       Vendor URL: https://kubevirt.io/
18

PARAMETERS

20
21
22       -o, --action=[action]
23              Fencing action (Default Value: reboot)
24
25       -n, --plug=[id]
26              Physical plug number on device, UUID or  identification  of  ma‐
27              chine This parameter is always required.
28
29       --ssl-insecure
30              Use SSL connection without verifying certificate
31
32       --namespace=[namespace]
33              Namespace  of the KubeVirt machine. This parameter is always re‐
34              quired.
35
36       --kubeconfig=[kubeconfig]
37              Kubeconfig file path
38
39       --apiversion=[apiversion]
40              Version of the KubeVirt  API.  (Default  Value:  kubevirt.io/v1)
41
42
43       -q, --quiet
44              Disable logging to stderr. Does not affect --verbose or --debug-
45              file or logging to syslog.
46
47       -v, --verbose
48              Verbose mode. Multiple -v flags can be stacked  on  the  command
49              line (e.g., -vvv) to increase verbosity.
50
51       --verbose-level
52              Level  of  debugging detail in output. Defaults to the number of
53              --verbose flags specified on the command line, or to 1  if  ver‐
54              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
55
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 'list' operation (Default Value: ,)
68
69
70       --delay=[seconds]
71              Wait  X  seconds  before  fencing  is started (Default Value: 0)
72
73
74       --disable-timeout=[true/false]
75              Disable timeout (true/false) (default: true when run from  Pace‐
76              maker 2.0+)
77
78       --login-timeout=[seconds]
79              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
80
81
82       --power-timeout=[seconds]
83              Test X seconds for status change after  ON/OFF  (Default  Value:
84              40)
85
86       --power-wait=[seconds]
87              Wait X seconds after issuing ON/OFF (Default Value: 0)
88
89       --shell-timeout=[seconds]
90              Wait  X  seconds  for  cmd prompt after issuing command (Default
91              Value: 3)
92
93       --stonith-status-sleep=[seconds]
94              Sleep X seconds between status calls  during  a  STONITH  action
95              (Default Value: 1)
96
97       --retry-on=[attempts]
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       list-status
116              List available plugs with  aliases/virtual  machines  and  their
117              power  state  if it can be obtained without additional commands.
118
119
120       monitor
121              Check the health of fence device
122
123       metadata
124              Display the XML metadata describing this resource.
125
126       manpage
127               The operational behavior of this is not known.
128
129       validate-all
130              Validate if all required parameters are entered.
131
132

STDIN PARAMETERS

134
135
136       action Fencing action (Default Value: reboot)
137
138       plug   Physical plug number on device, UUID or  identification  of  ma‐
139              chine  This  parameter is always required. Obsoletes: port
140
141
142       ssl_insecure
143              Use SSL connection without verifying certificate
144
145       namespace
146              Namespace of the KubeVirt machine. This parameter is always  re‐
147              quired.
148
149       kubeconfig
150              Kubeconfig file path
151
152       apiversion
153              Version  of  the  KubeVirt  API. (Default Value: kubevirt.io/v1)
154
155
156       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
157              file or logging to syslog.
158
159       verbose
160              Verbose  mode.  Multiple  -v flags can be stacked on the command
161              line (e.g., -vvv) to increase verbosity.
162
163       verbose_level
164              Level of debugging detail in output. Defaults to the  number  of
165              --verbose  flags  specified on the command line, or to 1 if ver‐
166              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
167
168
169       debug_file
170              Write debug information to given file Obsoletes: debug
171
172       version
173              Display version information and exit
174
175       help   Display help and exit
176
177       separator
178              Separator for CSV created by 'list' operation (Default Value: ,)
179
180
181       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
182
183
184       disable_timeout
185              Disable  timeout (true/false) (default: true when run from Pace‐
186              maker 2.0+)
187
188       login_timeout
189              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
190
191
192       power_timeout
193              Test  X  seconds  for status change after ON/OFF (Default Value:
194              40)
195
196       power_wait
197              Wait X seconds after issuing ON/OFF (Default Value: 0)
198
199       shell_timeout
200              Wait X seconds for cmd prompt  after  issuing  command  (Default
201              Value: 3)
202
203       stonith_status_sleep
204              Sleep  X  seconds  between  status calls during a STONITH action
205              (Default Value: 1)
206
207       retry_on
208              Count of attempts to retry power on (Default Value: 1)
209
210
211
212fence_kubevirt (Fence Agent)      2009-10-20                    FENCE_AGENT(8)