Files
podman/docs/source/markdown/podman-machine-list.1.md.in
Lewis Roy 7b1055a5fb feat: Add support for configuring swap in Podman machine
Add `--swap` argument to `podman machine init` command.

Passing an int64 value to this flag will trigger the Podman machine
ignition file to be generated with a zram-generator.conf file containing
the --swap value as the zram-size argument.

This file is read by the zram-generator systemd service on boot
resulting in a zram swap device being created.

Fixes: https://github.com/containers/podman/issues/15980

Signed-off-by: Lewis Roy <lewis@redhat.com>
2025-04-29 12:20:24 +10:00

108 lines
3.5 KiB
Markdown

% podman-machine-list 1
## NAME
podman\-machine\-list - List virtual machines
## SYNOPSIS
**podman machine list** [*options*]
**podman machine ls** [*options*]
## DESCRIPTION
List Podman managed virtual machines.
Podman on MacOS and Windows requires a virtual machine. This is because containers are Linux -
containers do not run on any other OS because containers' core functionality are
tied to the Linux kernel. Podman machine must be used to manage MacOS and Windows machines,
but can be optionally used on Linux.
Rootless only.
NOTE: The podman-machine configuration file is managed under the
`$XDG_CONFIG_HOME/containers/podman/machine/` directory. Changing the `$XDG_CONFIG_HOME`
environment variable while the machines are running can lead to unexpected behavior.
(see [podman(1)](podman.1.md))
## OPTIONS
#### **--all-providers**
Show machines from all providers
#### **--format**=*format*
Change the default output format. This can be of a supported type like 'json'
or a Go template.
Valid placeholders for the Go template are listed below:
| **Placeholder** | **Description** |
| ------------------- | ----------------------------------------- |
| .CPUs | Number of CPUs |
| .Created | Time since VM creation |
| .Default | Is default machine |
| .DiskSize | Disk size of machine |
| .IdentityPath | Path to ssh identity file |
| .LastUp | Time since the VM was last run |
| .Memory | Allocated memory for machine |
| .Name | VM name |
| .Port | SSH Port to use to connect to VM |
| .RemoteUsername | VM Username for rootless Podman |
| .Running | Is machine running |
| .Stream | Stream name |
| .Swap | Allocated swap for machine |
| .UserModeNetworking | Whether machine uses user-mode networking |
| .VMType | VM type |
#### **--help**
Print usage statement.
@@option noheading
#### **--quiet**, **-q**
Only print the name of the machine. This also implies no table heading
is printed.
## EXAMPLES
List all Podman machines.
```
$ podman machine list
NAME VM TYPE CREATED LAST UP CPUS MEMORY DISK SIZE
podman-machine-default qemu 2 weeks ago 2 weeks ago 1 2.147GB 10.74GB
```
List all Podman machines using the specified table format.
```
$ podman machine ls --format "table {{.Name}}\t{{.VMType}}\t{{.Created}}\t{{.LastUp}}"
NAME VM TYPE CREATED LAST UP
podman-machine-default qemu 2 weeks ago 2 weeks ago
```
List all Podman machines in json format.
```
$ podman machine ls --format json
[
{
"Name": "podman-machine-default",
"Default": false,
"Created": "2021-12-27T10:36:14.373347492-05:00",
"Running": false,
"LastUp": "2021-12-27T11:22:50.17333371-05:00",
"Stream": "default",
"VMType": "qemu",
"CPUs": 1,
"Memory": "2147483648",
"DiskSize": "10737418240"
}
]
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-machine(1)](podman-machine.1.md)**
## HISTORY
March 2021, Originally compiled by Ashley Cui <acui@redhat.com>