1podman-remote(1)()                                          podman-remote(1)()
2
3
4

NAME

6       podman-remote  -  A remote CLI for Podman: A Simple management tool for
7       pods, containers and images.
8
9

SYNOPSIS

11       podman-remote [options] command
12
13

DESCRIPTION

15       Podman (Pod Manager) is a fully featured container  engine  that  is  a
16       simple  daemonless  tool.  Podman provides a Docker-CLI comparable com‐
17       mand line that eases the transition from other  container  engines  and
18       allows  the  management  of  pods,  containers and images.  Simply put:
19       alias docker=podman.  Most Podman commands can  be  run  as  a  regular
20       user, without requiring additional privileges.
21
22
23       Podman  uses  Buildah(1)  internally  to  create container images. Both
24       tools share image (not container) storage, hence each can use or manip‐
25       ulate images (but not containers) created by the other.
26
27
28       Podman-remote provides a local client interacting with a Podman backend
29       node through a varlink ssh connection. In this context, a  Podman  node
30       is  a  Linux system with Podman installed on it and the varlink service
31       activated. Credentials for this session can be passed in  using  flags,
32       environment variables, or in podman-remote.conf
33
34
35       podman [GLOBAL OPTIONS]
36
37

GLOBAL OPTIONS

39       --connection=name
40
41
42       Remote connection name
43
44
45       --help, -h
46
47
48       Print usage statement
49
50
51       --log-level=level
52
53
54       Log messages above specified level: debug, info, warn, error (default),
55       fatal or panic
56
57
58       --port=integer
59
60
61       Use an alternative port for the ssh connections.  The default  port  is
62       22
63
64
65       --remote-config-path=path
66
67
68       Alternate path for configuration file
69
70
71       --remote-host=ip
72
73
74       Remote host IP
75
76
77       --syslog
78
79
80       Output logging information to syslog as well as the console
81
82
83       --username=string
84
85
86       Username on the remote host (defaults to current username)
87
88
89       --version
90
91
92       Print the version
93
94

Exit Status

96       The  exit  code  from  podman gives information about why the container
97       failed to run or why it exited.   When  podman  commands  exit  with  a
98       non-zero code, the exit codes follow the chroot standard, see below:
99
100
101       125 The error is with podman itself
102
103
104              $ podman run --foo busybox; echo $?
105              Error: unknown flag: --foo
106              125
107
108
109
110       126 Executing a contained command and the command cannot be invoked
111
112
113              $ podman run busybox /etc; echo $?
114              Error: container_linux.go:346: starting container process caused "exec: \"/etc\": permission denied": OCI runtime error
115              126
116
117
118
119       127 Executing a contained command and the command cannot be found
120           $ podman run busybox foo; echo $?
121           Error:  container_linux.go:346:  starting  container process caused
122       "exec: \"foo\": executable file not found in $PATH": OCI runtime error
123           127
124
125
126       Exit code contained command exit code
127
128
129              $ podman run busybox /bin/sh -c 'exit 3'; echo $?
130              3
131
132
133

COMMANDS

135       ┌──────────────────────┬────────────────────────────────┐
136Command               Description                    
137       ├──────────────────────┼────────────────────────────────┤
138podman-attach(1)      │ Attach to a running container. │
139       ├──────────────────────┼────────────────────────────────┤
140podman-build(1)       │ Build a container image  using │
141       │                      │ a Dockerfile.                  │
142       ├──────────────────────┼────────────────────────────────┤
143podman-commit(1)      │ Create  new image based on the │
144       │                      │ changed container.             │
145       ├──────────────────────┼────────────────────────────────┤
146podman-container(1)   │ Manage containers.             │
147       ├──────────────────────┼────────────────────────────────┤
148podman-cp(1)          │ Copy files/folders  between  a │
149       │                      │ container    and   the   local │
150       │                      │ filesystem.                    │
151       ├──────────────────────┼────────────────────────────────┤
152podman-create(1)      │ Create a new container.        │
153       ├──────────────────────┼────────────────────────────────┤
154podman-diff(1)        │ Inspect changes on a container │
155       │                      │ or image's filesystem.         │
156       ├──────────────────────┼────────────────────────────────┤
157podman-events(1)      │ Monitor Podman events          │
158       ├──────────────────────┼────────────────────────────────┤
159podman-export(1)      │ Export  a container's filesys‐ │
160       │                      │ tem contents as a tar archive. │
161       ├──────────────────────┼────────────────────────────────┤
162podman-generate(1)    │ Generate structured data based │
163       │                      │ for a containers and pods.     │
164       ├──────────────────────┼────────────────────────────────┤
165podman-healthcheck(1) │ Manage  healthchecks  for con‐ │
166       │                      │ tainers                        │
167       ├──────────────────────┼────────────────────────────────┤
168podman-history(1)     │ Show the history of an image.  │
169       ├──────────────────────┼────────────────────────────────┤
170podman-image(1)       │ Manage images.                 │
171       ├──────────────────────┼────────────────────────────────┤
172podman-images(1)      │ List images in local storage.  │
173       ├──────────────────────┼────────────────────────────────┤
174podman-import(1)      │ Import a tarball and  save  it │
175       │                      │ as a filesystem image.         │
176       ├──────────────────────┼────────────────────────────────┤
177podman-info(1)        │ Displays Podman related system │
178       │                      │ information.                   │
179       ├──────────────────────┼────────────────────────────────┤
180podman-init(1)        │ Initialize a container         │
181       ├──────────────────────┼────────────────────────────────┤
182podman-inspect(1)     │ Display a container or image's │
183       │                      │ configuration.                 │
184       ├──────────────────────┼────────────────────────────────┤
185podman-kill(1)        │ Kill  the  main process in one │
186       │                      │ or more containers.            │
187       ├──────────────────────┼────────────────────────────────┤
188podman-load(1)        │ Load an image from a container │
189       │                      │ image  archive  into container │
190       │                      │ storage.                       │
191       ├──────────────────────┼────────────────────────────────┤
192podman-logs(1)        │ Display the  logs  of  a  con‐ │
193       │                      │ tainer.                        │
194       ├──────────────────────┼────────────────────────────────┤
195podman-pause(1)       │ Pause one or more containers.  │
196       ├──────────────────────┼────────────────────────────────┤
197podman-pod(1)         │ Management  tool for groups of │
198       │                      │ containers, called pods.       │
199       ├──────────────────────┼────────────────────────────────┤
200podman-port(1)        │ List port mappings for a  con‐ │
201       │                      │ tainer.                        │
202       ├──────────────────────┼────────────────────────────────┤
203podman-ps(1)          │ Prints  out  information about │
204       │                      │ containers.                    │
205       ├──────────────────────┼────────────────────────────────┤
206podman-pull(1)        │ Pull an image from a registry. │
207       ├──────────────────────┼────────────────────────────────┤
208podman-push(1)        │ Push an image from local stor‐ │
209       │                      │ age to elsewhere.              │
210       ├──────────────────────┼────────────────────────────────┤
211podman-restart(1)     │ Restart  one  or more contain‐ │
212       │                      │ ers.                           │
213       ├──────────────────────┼────────────────────────────────┤
214podman-rm(1)          │ Remove one or more containers. │
215       ├──────────────────────┼────────────────────────────────┤
216podman-rmi(1)         │ Removes one  or  more  locally │
217       │                      │ stored images.                 │
218       ├──────────────────────┼────────────────────────────────┤
219podman-run(1)         │ Run  a  command  in a new con‐ │
220       │                      │ tainer.                        │
221       ├──────────────────────┼────────────────────────────────┤
222podman-save(1)        │ Save an image to  a  container │
223       │                      │ archive.                       │
224       ├──────────────────────┼────────────────────────────────┤
225podman-start(1)       │ Start one or more containers.  │
226       ├──────────────────────┼────────────────────────────────┤
227podman-stop(1)        │ Stop  one or more running con‐ │
228       │                      │ tainers.                       │
229       ├──────────────────────┼────────────────────────────────┤
230podman-system(1)      │ Manage podman.                 │
231       ├──────────────────────┼────────────────────────────────┤
232podman-tag(1)         │ Add an additional  name  to  a │
233       │                      │ local image.                   │
234       ├──────────────────────┼────────────────────────────────┤
235podman-top(1)         │ Display  the running processes │
236       │                      │ of a container.                │
237       ├──────────────────────┼────────────────────────────────┤
238podman-unpause(1)     │ Unpause one or  more  contain‐ │
239       │                      │ ers.                           │
240       ├──────────────────────┼────────────────────────────────┤
241podman-version(1)     │ Display   the  Podman  version │
242       │                      │ information.                   │
243       ├──────────────────────┼────────────────────────────────┤
244podman-volume(1)      │ Manage Volumes.                │
245       └──────────────────────┴────────────────────────────────┘
246

FILES

248       podman-remote.conf ($HOME/.config/containers/podman-remote.conf)
249
250
251              The podman-remote.conf file is the default configuration file for the podman
252              remote client.  It is in the TOML format.  It is primarily used to keep track
253              of the user's remote connections.
254
255
256

SEE ALSO

258       podman-remote.conf(5)
259
260
261
262                                                            podman-remote(1)()
Impressum