github.com/containers/podman/v5@v5.1.0-rc1/docs/source/markdown/podman-machine-list.1.md.in (about)

     1  % podman-machine-list 1
     2  
     3  ## NAME
     4  podman\-machine\-list - List virtual machines
     5  
     6  ## SYNOPSIS
     7  **podman machine list** [*options*]
     8  
     9  **podman machine ls** [*options*]
    10  
    11  ## DESCRIPTION
    12  
    13  List Podman managed virtual machines.
    14  
    15  Podman on MacOS and Windows requires a virtual machine. This is because containers are Linux -
    16  containers do not run on any other OS because containers' core functionality are
    17  tied to the Linux kernel. Podman machine must be used to manage MacOS and Windows machines,
    18  but can be optionally used on Linux.
    19  
    20  Rootless only.
    21  
    22  NOTE: The podman-machine configuration file is managed under the
    23  `$XDG_CONFIG_HOME/containers/podman/machine/` directory. Changing the `$XDG_CONFIG_HOME`
    24  environment variable while the machines are running can lead to unexpected behavior.
    25  (see [podman(1)](podman.1.md))
    26  
    27  ## OPTIONS
    28  
    29  #### **--format**=*format*
    30  
    31  Change the default output format.  This can be of a supported type like 'json'
    32  or a Go template.
    33  Valid placeholders for the Go template are listed below:
    34  
    35  | **Placeholder**     | **Description**                           |
    36  | ------------------- | ----------------------------------------- |
    37  | .CPUs               | Number of CPUs                            |
    38  | .Created            | Time since VM creation                    |
    39  | .Default            | Is default machine                        |
    40  | .DiskSize           | Disk size of machine                      |
    41  | .IdentityPath       | Path to ssh identity file                 |
    42  | .LastUp             | Time since the VM was last run            |
    43  | .Memory             | Allocated memory for machine              |
    44  | .Name               | VM name                                   |
    45  | .Port               | SSH Port to use to connect to VM          |
    46  | .RemoteUsername     | VM Username for rootless Podman           |
    47  | .Running            | Is machine running                        |
    48  | .Stream             | Stream name                               |
    49  | .UserModeNetworking | Whether machine uses user-mode networking |
    50  | .VMType             | VM type                                   |
    51  
    52  #### **--help**
    53  
    54  Print usage statement.
    55  
    56  @@option noheading
    57  
    58  #### **--quiet**, **-q**
    59  
    60  Only print the name of the machine. This also implies no table heading
    61  is printed.
    62  
    63  ## EXAMPLES
    64  
    65  List all Podman machines.
    66  ```
    67  $ podman machine list
    68  NAME                    VM TYPE     CREATED      LAST UP      CPUS        MEMORY      DISK SIZE
    69  podman-machine-default  qemu        2 weeks ago  2 weeks ago  1           2.147GB     10.74GB
    70  ```
    71  
    72  List all Podman machines using the specified table format.
    73  ```
    74  $ podman machine ls --format "table {{.Name}}\t{{.VMType}}\t{{.Created}}\t{{.LastUp}}"
    75  NAME                    VM TYPE     CREATED      LAST UP
    76  podman-machine-default  qemu        2 weeks ago  2 weeks ago
    77  ```
    78  
    79  List all Podman machines in json format.
    80  ```
    81  $ podman machine ls --format json
    82  [
    83      {
    84          "Name": "podman-machine-default",
    85          "Default": false,
    86          "Created": "2021-12-27T10:36:14.373347492-05:00",
    87          "Running": false,
    88          "LastUp": "2021-12-27T11:22:50.17333371-05:00",
    89          "Stream": "default",
    90          "VMType": "qemu",
    91          "CPUs": 1,
    92          "Memory": "2147483648",
    93          "DiskSize": "10737418240"
    94      }
    95  ]
    96  ```
    97  
    98  ## SEE ALSO
    99  **[podman(1)](podman.1.md)**, **[podman-machine(1)](podman-machine.1.md)**
   100  
   101  ## HISTORY
   102  March 2021, Originally compiled by Ashley Cui <acui@redhat.com>