mirror of
https://github.com/containers/podman.git
synced 2025-08-26 11:33:07 +08:00
dbe0e67897
Initial impetus was #20958 (ps --format .Label abc). This is a complicated solution to a simple-seeming problem. The problem: .Label is a cobra *function*, something I did not know about nor handle. Solution: recognize cobra functions. Switch to __complete, not __completeNoDesc, so we can see the number of arguments required. Invent new man-page format for documenting functions. And, finally, start enforcing how functions (and cobra structs) are documented. This discovered a never-used completion function, .Recycle(), in podman-events. Remove it. [NO NEW TESTS NEEDED] - the .go change is an excision of dead code. Signed-off-by: Ed Santiago <santiago@redhat.com>
55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
% podman-machine-inspect 1
|
|
|
|
## NAME
|
|
podman\-machine\-inspect - Inspect one or more virtual machines
|
|
|
|
## SYNOPSIS
|
|
**podman machine inspect** [*options*] [*name*] ...
|
|
|
|
## DESCRIPTION
|
|
|
|
Inspect one or more virtual machines
|
|
|
|
Obtain greater detail about Podman virtual machines. More than one virtual machine can be
|
|
inspected at once.
|
|
|
|
The default machine name is `podman-machine-default`. If a machine name is not specified as an argument,
|
|
then `podman-machine-default` will be inspected.
|
|
|
|
Rootless only.
|
|
|
|
## OPTIONS
|
|
#### **--format**
|
|
|
|
Print results with a Go template.
|
|
|
|
| **Placeholder** | **Description** |
|
|
| ------------------- | --------------------------------------------------------------------- |
|
|
| .ConfigPath ... | Machine configuration file location |
|
|
| .ConnectionInfo ... | Machine connection information |
|
|
| .Created ... | Machine creation time (string, ISO3601) |
|
|
| .Image ... | Machine image config |
|
|
| .LastUp ... | Time when machine was last booted |
|
|
| .Name | Name of the machine |
|
|
| .Resources ... | Resources used by the machine |
|
|
| .Rootful | Whether the machine prefers rootful or rootless container execution |
|
|
| .SSHConfig ... | SSH configuration info for communicating with machine |
|
|
| .State | Machine state |
|
|
| .UserModeNetworking | Whether this machine uses user-mode networking |
|
|
|
|
#### **--help**
|
|
|
|
Print usage statement.
|
|
|
|
## EXAMPLES
|
|
|
|
```
|
|
$ podman machine inspect podman-machine-default
|
|
```
|
|
|
|
## SEE ALSO
|
|
**[podman(1)](podman.1.md)**, **[podman-machine(1)](podman-machine.1.md)**
|
|
|
|
## HISTORY
|
|
April 2022, Originally compiled by Brent Baude <bbaude@redhat.com>
|