2020-09-11 15:15:17 -04:00
============
virt-manager
============
---------------------------------------
Graphical tool for managing libvirt VMs
---------------------------------------
:Manual section: 1
:Manual group: Virtualization Support
SYNOPSIS
========
`` virt-manager `` [OPTIONS]
DESCRIPTION
===========
`` virt-manager `` is a desktop tool for managing virtual machines. It
provides the ability to control the lifecycle of existing machines
(bootup/shutdown,pause/resume,suspend/restore), provision new virtual
machines and various types of store, manage virtual networks,
access the graphical console of virtual machines, and view performance
statistics, all done locally or remotely.
OPTIONS
=======
Standard GTK options like `` --g-fatal-warnings `` are accepted.
The following options are accepted when running `` virt-manager ``
`` -h `` , `` --help ``
Display command line help summary
`` --version ``
Show virt-manager's version number and exit
`` -c `` , `` --connect ``
Specify the hypervisor connection **URI**
`` --debug ``
List debugging output to the console (normally this is only logged in
~/.cache/virt-manager/virt-manager.log). This function implies --no-fork.
`` --no-fork ``
2024-10-10 10:46:40 -04:00
Don't fork `` virt-manager `` off into the background.
See `` VIRT-MANAGER, SSH, AND FORKING `` section for more info.
2020-09-11 15:15:17 -04:00
2024-10-10 10:28:45 -04:00
`` --fork ``
Force forking `` virt-manager `` off into the background.
This is the default behavior.
2024-10-10 10:46:40 -04:00
See `` VIRT-MANAGER, SSH, AND FORKING `` section for more info.
2024-10-10 10:28:45 -04:00
2020-09-11 15:15:17 -04:00
DIALOG WINDOW OPTIONS
=====================
2021-10-02 14:10:40 +00:00
For these options, only the requested window will be shown, the manager
2020-09-11 15:15:17 -04:00
window will not be run in this case. Connection autostart will also
be disabled. All these options require specifying a manual `` --connect ``
URI.
`` --show-domain-creator ``
Display the wizard for creating new virtual machines
`` --show-domain-editor `` NAME|ID|UUID
Display the dialog for editing properties of the virtual machine with
unique ID matching either the domain name, ID, or UUID
`` --show-domain-performance `` NAME|ID|UUID
Display the dialog for monitoring performance of the virtual machine with
unique ID matching either the domain name, ID, or UUID
`` --show-domain-console `` NAME|ID|UUID
Display the virtual console of the virtual machine with
unique ID matching either the domain name, ID, or UUID
`` --show-host-summary ``
Display the host/connection details window.
2024-03-03 11:54:37 -05:00
2021-11-04 00:57:16 -03:00
SYSTEM TRAY OPTION
==================
Connection autostart will not be disabled and thus don't require specifying a
manual `` --connect `` URI. But it supports `` --connect `` URI as well:
`` --show-systray ``
2024-03-03 11:54:37 -05:00
Launch virt-manager only in system tray
2020-09-11 15:15:17 -04:00
2024-10-10 10:46:40 -04:00
VIRT-MANAGER, SSH, AND FORKING
==============================
virt-manager: Switch to `--no-fork` by default
The reason we fork by default, is to force ssh to invoke
ssh-askpass when a password is required, rather than prompt on
a terminal no one is looking at. There's a more thorough
explanation here:
https://github.com/virt-manager/virt-manager/issues/731
With SSH_ASKPASS_REQUIRE=force, we now have a way to force ssh
to use askpass in the above scenario, when ssh and libvirt are new
enough.
The default forking behavior has caused maintenance pain in the
past, and is currently causing issues on macos:
https://github.com/virt-manager/virt-manager/issues/620
Let's flip the default to `--no-fork`. The VIRT_MANAGER_DEFAULT_FORK
env variable is there as an escape hatch incase I really miscalculated.
I don't expect many people are depending on use of askpass either
way, or if they are, they are launching virt-manager from their
desktop and not a terminal, which already gives us the correct
behavior AFAICT>
My suspicion is barely anyone will notice, which is why
I'm ok with changing this now, despite the libvirt support being
brand new.
If this doesn't raise any issues, then we can eventually drop
the forking behavior all together.
Signed-off-by: Cole Robinson <crobinso@redhat.com>
2024-10-10 10:52:20 -04:00
Historically, on startup virt-manager would detach from the running
terminal and fork into the background. This was to force any usage of
ssh to call ssh-askpass when it needed a password, rather than silently
2024-10-10 10:46:40 -04:00
asking on a terminal the user probably isn't watching.
openssh 8.4p1 released in Sep 2020 added the SSH_ASKPASS_REQUIRE
environment variable that saves us from having to do the fork dance.
https://man.openbsd.org/ssh.1#SSH_ASKPASS_REQUIRE
virt-manager now sets SSH_ASKPASS_REQUIRE=force.
However to get this to work with libvirt ssh connections, you'll need
libvirt 10.8.0 released in October 1st 2024.
virt-manager: Switch to `--no-fork` by default
The reason we fork by default, is to force ssh to invoke
ssh-askpass when a password is required, rather than prompt on
a terminal no one is looking at. There's a more thorough
explanation here:
https://github.com/virt-manager/virt-manager/issues/731
With SSH_ASKPASS_REQUIRE=force, we now have a way to force ssh
to use askpass in the above scenario, when ssh and libvirt are new
enough.
The default forking behavior has caused maintenance pain in the
past, and is currently causing issues on macos:
https://github.com/virt-manager/virt-manager/issues/620
Let's flip the default to `--no-fork`. The VIRT_MANAGER_DEFAULT_FORK
env variable is there as an escape hatch incase I really miscalculated.
I don't expect many people are depending on use of askpass either
way, or if they are, they are launching virt-manager from their
desktop and not a terminal, which already gives us the correct
behavior AFAICT>
My suspicion is barely anyone will notice, which is why
I'm ok with changing this now, despite the libvirt support being
brand new.
If this doesn't raise any issues, then we can eventually drop
the forking behavior all together.
Signed-off-by: Cole Robinson <crobinso@redhat.com>
2024-10-10 10:52:20 -04:00
virt-manager no longer forks by defaults.
You can get the old forking behavior with the `` --fork `` option,
or by setting the `` VIRT_MANAGER_DEFAULT_FORK=yes `` environment variable.
2024-10-10 10:46:40 -04:00
However if you find you need forking for a usecase other than temporarily
working around libvirt version issues, please let the virt-manager developers
know by filing a bug report.
2020-09-11 15:15:17 -04:00
BUGS
====
Please see https://virt-manager.org/bugs/
COPYRIGHT
=========
Copyright (C) Red Hat, Inc, and various contributors.
This is free software. You may redistribute copies of it under the terms of the GNU General
Public License https://www.gnu.org/licenses/gpl.html. There is NO WARRANTY, to the extent
permitted by law.
SEE ALSO
========
`` virsh(1) `` , `` virt-viewer(1) `` , the project website https://virt-manager.org
