cli: --graphics: use predictable cli subarg names

To match the XML schema, rename these subarguments and add aliases
to preserve compatibility:

* clipboard_copypaste -> clipboard.copypaste
* filetransfer_enable -> filetransfer.enable
* gl -> gl.enable
* rendernode -> gl.rendernode
* image_compression -> image.compression
* mouse_mode -> mouse.mode
* passwd -> password
* passwdValidTo -> passwordValidTo
* streaming_mode -> streaming.mode
* tlsport -> tlsPort
This commit is contained in:
Cole Robinson 2019-05-12 08:50:32 -04:00
parent 83e15a3bce
commit ea63141fca
2 changed files with 67 additions and 57 deletions

View File

@ -929,7 +929,7 @@ For example:
--graphics vnc,password=foobar
The supported options are:
Some supported options are:
=over 4
@ -968,7 +968,7 @@ command 'virsh console NAME' can be used to connect to the serial device.
Request a permanent, statically assigned port number for the guest
console. This is used by 'vnc' and 'spice'
=item B<tlsport>
=item B<tlsPort>
Specify the spice tlsport.
@ -988,27 +988,18 @@ path on the host filesystem.
This is used by 'vnc' and 'spice'
=item B<keymap>
Request that the virtual console be configured to run with a specific
keyboard layout. If the special value 'local' is specified, virt-install
will attempt to configure to use the same keymap as the local system. A value
of 'none' specifically defers to the hypervisor. Default behavior is
hypervisor specific, but typically is the same as 'local'. This is used
by 'vnc' and 'spice'.
=item B<password>
Request a console password, required at connection time. Beware, this info may
end up in virt-install log files, so don't use an important password. This
is used by 'vnc' and 'spice'
=item B<gl>
=item B<gl.enable>
Whether to use OpenGl accelerated rendering. Value is 'yes' or 'no'. This is
Whether to use OpenGL accelerated rendering. Value is 'yes' or 'no'. This is
used by 'spice'.
=item B<rendernode>
=item B<gl.rendernode>
DRM render node path to use. This is used when 'gl' is enabled.

View File

@ -648,10 +648,9 @@ def add_gfx_option(devg):
ParserGraphics.register()
devg.add_argument("--graphics", action="append",
help=_("Configure guest display settings. Ex:\n"
"--graphics vnc\n"
"--graphics spice,port=5901,tlsport=5902\n"
"--graphics none\n"
"--graphics vnc,password=foobar,port=5910,keymap=ja"))
"--graphics spice\n"
"--graphics vnc,port=5901,listen=0.0.0.0\n"
"--graphics none\n"))
def add_net_option(devg):
@ -2670,6 +2669,45 @@ class ParserGraphics(VirtCLIParser):
guest_propname = "devices.graphics"
remove_first = "type"
stub_none = False
aliases = {
"tlsPort": "tlsport",
"password": "passwd",
"passwordValidTo": "passwdValidTo",
"image.compression": "image_compression",
"streaming.mode": "streaming_mode",
"clipboard.copypaste": "clipboard_copypaste",
"filetransfer.enable": "filetransfer_enable",
"mouse.mode": "mouse_mode",
"gl.enable": "gl",
"gl.rendernode": "rendernode",
}
def _parse(self, inst):
if self.optstr == "none":
self.guest.skip_default_graphics = True
return
ret = super()._parse(inst)
if inst.conn.is_qemu() and inst.gl:
if inst.type != "spice":
logging.warning("graphics type=%s does not support GL", inst.type)
elif not inst.conn.check_support(
inst.conn.SUPPORT_CONN_SPICE_GL):
logging.warning("qemu/libvirt version may not support spice GL")
if inst.conn.is_qemu() and inst.rendernode:
if inst.type != "spice":
logging.warning("graphics type=%s does not support rendernode", inst.type)
elif not inst.conn.check_support(
inst.conn.SUPPORT_CONN_SPICE_RENDERNODE):
logging.warning("qemu/libvirt version may not support rendernode")
return ret
###################
# Option handling #
###################
def set_keymap_cb(self, inst, val, virtarg):
from . import hostkeymap
@ -2699,36 +2737,21 @@ class ParserGraphics(VirtCLIParser):
cb = self._make_find_inst_cb(cliarg, list_propname)
return cb(*args, **kwargs)
def _parse(self, inst):
if self.optstr == "none":
self.guest.skip_default_graphics = True
return
ret = super()._parse(inst)
if inst.conn.is_qemu() and inst.gl:
if inst.type != "spice":
logging.warning("graphics type=%s does not support GL", inst.type)
elif not inst.conn.check_support(
inst.conn.SUPPORT_CONN_SPICE_GL):
logging.warning("qemu/libvirt version may not support spice GL")
if inst.conn.is_qemu() and inst.rendernode:
if inst.type != "spice":
logging.warning("graphics type=%s does not support rendernode", inst.type)
elif not inst.conn.check_support(
inst.conn.SUPPORT_CONN_SPICE_RENDERNODE):
logging.warning("qemu/libvirt version may not support rendernode")
return ret
@classmethod
def _init_class(cls, **kwargs):
VirtCLIParser._init_class(**kwargs)
_add_device_address_args(cls)
cls.add_arg("type", "type", cb=cls.set_type_cb)
cls.add_arg("port", "port")
cls.add_arg("tlsport", "tlsPort")
cls.add_arg("tlsPort", "tlsPort")
cls.add_arg("listen", "listen")
cls.add_arg("keymap", "keymap", cb=cls.set_keymap_cb)
cls.add_arg("password", "passwd")
cls.add_arg("passwordValidTo", "passwdValidTo")
cls.add_arg("connected", "connected")
cls.add_arg("defaultMode", "defaultMode")
cls.add_arg("listens[0-9]*.type", "type",
find_inst_cb=cls.listens_find_inst_cb)
cls.add_arg("listens[0-9]*.address", "address",
@ -2737,21 +2760,17 @@ class ParserGraphics(VirtCLIParser):
find_inst_cb=cls.listens_find_inst_cb)
cls.add_arg("listens[0-9]*.socket", "socket",
find_inst_cb=cls.listens_find_inst_cb)
cls.add_arg("keymap", "keymap", cb=cls.set_keymap_cb)
cls.add_arg("password", "passwd")
cls.add_arg("passwordvalidto", "passwdValidTo")
cls.add_arg("connected", "connected")
cls.add_arg("defaultMode", "defaultMode")
cls.add_arg("image_compression", "image_compression")
cls.add_arg("streaming_mode", "streaming_mode")
cls.add_arg("clipboard_copypaste", "clipboard_copypaste",
cls.add_arg("image.compression", "image_compression")
cls.add_arg("streaming.mode", "streaming_mode")
cls.add_arg("clipboard.copypaste", "clipboard_copypaste",
is_onoff=True)
cls.add_arg("mouse_mode", "mouse_mode")
cls.add_arg("filetransfer_enable", "filetransfer_enable",
cls.add_arg("mouse.mode", "mouse_mode")
cls.add_arg("filetransfer.enable", "filetransfer_enable",
is_onoff=True)
cls.add_arg("gl", "gl", is_onoff=True)
cls.add_arg("rendernode", "rendernode")
cls.add_arg("gl.enable", "gl", is_onoff=True)
cls.add_arg("gl.rendernode", "rendernode")
########################