fence_kubevirt(8)

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.
34
35       --kubeconfig=[kubeconfig]
36              Kubeconfig file path
37
38       --apiversion=[apiversion]
39              Version  of  the  KubeVirt  API. (Default Value: kubevirt.io/v1)
40
41
42       -q, --quiet
43              Disable logging to stderr. Does not affect --verbose or --debug-
44              file or logging to syslog.
45
46       -v, --verbose
47              Verbose  mode.  Multiple  -v flags can be stacked on the command
48              line (e.g., -vvv) to increase verbosity.
49
50       --verbose-level
51              Level of debugging detail in output. Defaults to the  number  of
52              --verbose  flags  specified on the command line, or to 1 if ver‐
53              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
54
55
56       -D, --debug-file=[debugfile]
57              Write debug information to given file
58
59       -V, --version
60              Display version information and exit
61
62       -h, --help
63              Display help and exit
64
65       --plug-separator=[char]
66              Separator  for  plug  parameter when specifying more than 1 plug
67              (Default Value: ,)
68
69       -C, --separator=[char]
70              Separator for CSV created by 'list' operation (Default Value: ,)
71
72
73       --delay=[seconds]
74              Wait  X  seconds  before  fencing  is started (Default Value: 0)
75
76
77       --disable-timeout=[true/false]
78              Disable timeout (true/false) (default: true when run from  Pace‐
79              maker 2.0+)
80
81       --login-timeout=[seconds]
82              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
83
84
85       --power-timeout=[seconds]
86              Test X seconds for status change after  ON/OFF  (Default  Value:
87              40)
88
89       --power-wait=[seconds]
90              Wait X seconds after issuing ON/OFF (Default Value: 0)
91
92       --shell-timeout=[seconds]
93              Wait  X  seconds  for  cmd prompt after issuing command (Default
94              Value: 3)
95
96       --stonith-status-sleep=[seconds]
97              Sleep X seconds between status calls  during  a  STONITH  action
98              (Default Value: 1)
99
100       --retry-on=[attempts]
101              Count of attempts to retry power on (Default Value: 1)
102
103

ACTIONS

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

STDIN PARAMETERS

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