mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-14 04:39:33 +00:00
15c9ca130f
Introducing a new `podmand system` subcommand to prepare a Windows host to run Hyper-V based Podman machines: `hyperv-prep`. When executed it: - creates of the registry keys for VSocks - adds the current user to the Hyper-V administrators group This command requires an administrator terminal. Signed-off-by: Mario Loriedo <mario.loriedo@gmail.com>
71 lines
2.1 KiB
Markdown
71 lines
2.1 KiB
Markdown
% podman-system-hyperv-prep 1
|
|
|
|
## NAME
|
|
podman\-system\-hyperv\-prep - A Windows administrator command to prepare a host that is going to run Hyper-V based Podman machines
|
|
|
|
## SYNOPSIS
|
|
**podman system hyperv-prep** [*options*]
|
|
|
|
## DESCRIPTION
|
|
Prepare a Windows host to run Hyper-V based Podman machines by creating the
|
|
required registry entries in HKEY_LOCAL_MACHINE for Hyper-V VSock communication
|
|
and adding the current user to the Hyper-V Administrators group.
|
|
|
|
The registry entries are marked to persist even when all machines are removed,
|
|
and the group membership allows the user to manage Hyper-V virtual machines.
|
|
Together, these avoid the need for administrator privileges during normal machine
|
|
operations.
|
|
|
|
This command requires administrator privileges and is only available on Windows.
|
|
The **--status** option can be used without administrator privileges.
|
|
|
|
## OPTIONS
|
|
|
|
#### **--mounts**=*number*
|
|
|
|
Number of VSock entries for mount purpose. Every mounted host folder of a running machine needs a dedicated VSock. There should be enough VSock to satisfy the needs of running Podman machines on the host. The default is **2**.
|
|
|
|
#### **--force**, **-f**
|
|
|
|
Skip confirmation prompts during reset. Only valid with **--reset**.
|
|
|
|
#### **--reset**
|
|
|
|
Remove all Podman VSock registry entries and remove the current user from the
|
|
Hyper-V Administrators group. Prompts for confirmation before each action unless
|
|
**--force** is specified.
|
|
|
|
#### **--status**
|
|
|
|
Show the list of VSock registry entries and the current user's Hyper-V
|
|
Administrators group membership status.
|
|
|
|
## EXAMPLE
|
|
|
|
Create the required registry entries and add the current user to the Hyper-V
|
|
Administrators group:
|
|
```
|
|
podman system hyperv-prep
|
|
```
|
|
|
|
Show existing registry entries and group membership status:
|
|
```
|
|
podman system hyperv-prep --status
|
|
```
|
|
|
|
Remove all Podman VSock registry entries and the current user from the Hyper-V
|
|
Administrators group (with confirmation prompts):
|
|
```
|
|
podman system hyperv-prep --reset
|
|
```
|
|
|
|
Reset without confirmation prompts:
|
|
```
|
|
podman system hyperv-prep --reset --force
|
|
```
|
|
|
|
## SEE ALSO
|
|
**[podman(1)](podman.1.md)**, **[podman-system(1)](podman-system.1.md)**
|
|
|
|
## HISTORY
|
|
April 2026
|