Debian Codegraph @

upstream/mageia-cauldron/man5/org.freedesktop.machine1.5

raw
1 '\" t
2 .TH "ORG\&.FREEDESKTOP\&.MACHINE1" "5" "" "systemd 258.7" "org.freedesktop.machine1"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 org.freedesktop.machine1 \- The D\-Bus interface of systemd\-machined
24 .SH "INTRODUCTION"
25 .PP
26 \fBsystemd-machined.service\fR(8)
27 is a system service that keeps track of locally running virtual machines and containers\&. This page describes the D\-Bus interface\&.
28 .SH "THE MANAGER OBJECT"
29 .PP
30 The service exposes the following interfaces on the Manager object on the bus:
31 .sp
32 .if n \{\
33 .RS 4
34 .\}
35 .nf
36 node /org/freedesktop/machine1 {
37 interface org\&.freedesktop\&.machine1\&.Manager {
38 methods:
39 GetMachine(in s name,
40 out o machine);
41 GetImage(in s name,
42 out o image);
43 GetMachineByPID(in u pid,
44 out o machine);
45 ListMachines(out a(ssso) machines);
46 ListImages(out a(ssbttto) images);
47 CreateMachine(in s name,
48 in ay id,
49 in s service,
50 in s class,
51 in u leader,
52 in s root_directory,
53 in a(sv) scope_properties,
54 out o path);
55 CreateMachineWithNetwork(in s name,
56 in ay id,
57 in s service,
58 in s class,
59 in u leader,
60 in s root_directory,
61 in ai ifindices,
62 in a(sv) scope_properties,
63 out o path);
64 RegisterMachine(in s name,
65 in ay id,
66 in s service,
67 in s class,
68 in u leader,
69 in s root_directory,
70 out o path);
71 RegisterMachineWithNetwork(in s name,
72 in ay id,
73 in s service,
74 in s class,
75 in u leader,
76 in s root_directory,
77 in ai ifindices,
78 out o path);
79 UnregisterMachine(in s name);
80 TerminateMachine(in s id);
81 KillMachine(in s name,
82 in s whom,
83 in i signal);
84 GetMachineAddresses(in s name,
85 out a(iay) addresses);
86 GetMachineSSHInfo(in s name,
87 out s ssh_address,
88 out s ssh_private_key_path);
89 GetMachineOSRelease(in s name,
90 out a{ss} fields);
91 OpenMachinePTY(in s name,
92 out h pty,
93 out s pty_path);
94 OpenMachineLogin(in s name,
95 out h pty,
96 out s pty_path);
97 OpenMachineShell(in s name,
98 in s user,
99 in s path,
100 in as args,
101 in as environment,
102 out h pty,
103 out s pty_path);
104 BindMountMachine(in s name,
105 in s source,
106 in s destination,
107 in b read_only,
108 in b mkdir);
109 CopyFromMachine(in s name,
110 in s source,
111 in s destination);
112 CopyToMachine(in s name,
113 in s source,
114 in s destination);
115 CopyFromMachineWithFlags(in s name,
116 in s source,
117 in s destination,
118 in t flags);
119 CopyToMachineWithFlags(in s name,
120 in s source,
121 in s destination,
122 in t flags);
123 OpenMachineRootDirectory(in s name,
124 out h fd);
125 GetMachineUIDShift(in s name,
126 out u shift);
127 RemoveImage(in s name);
128 RenameImage(in s name,
129 in s new_name);
130 CloneImage(in s name,
131 in s new_name,
132 in b read_only);
133 MarkImageReadOnly(in s name,
134 in b read_only);
135 GetImageHostname(in s name,
136 out s hostname);
137 GetImageMachineID(in s name,
138 out ay id);
139 GetImageMachineInfo(in s name,
140 out a{ss} machine_info);
141 GetImageOSRelease(in s name,
142 out a{ss} os_release);
143 SetPoolLimit(in t size);
144 SetImageLimit(in s name,
145 in t size);
146 CleanPool(in s mode,
147 out a(st) images);
148 MapFromMachineUser(in s name,
149 in u uid_inner,
150 out u uid_outer);
151 MapToMachineUser(in u uid_outer,
152 out s machine_name,
153 out o machine_path,
154 out u uid_inner);
155 MapFromMachineGroup(in s name,
156 in u gid_inner,
157 out u gid_outer);
158 MapToMachineGroup(in u gid_outer,
159 out s machine_name,
160 out o machine_path,
161 out u gid_inner);
162 signals:
163 MachineNew(s machine,
164 o path);
165 MachineRemoved(s machine,
166 o path);
167 properties:
168 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
169 readonly s PoolPath = \*(Aq\&.\&.\&.\*(Aq;
170 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
171 readonly t PoolUsage = \&.\&.\&.;
172 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
173 readonly t PoolLimit = \&.\&.\&.;
174 };
175 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
176 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
177 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
178 };
179 .fi
180 .if n \{\
181 .RE
182 .\}
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229 .SS "Methods"
230 .PP
231 \fBGetMachine()\fR
232 may be used to get the machine object path for the machine with the specified name\&. Similarly,
233 \fBGetMachineByPID()\fR
234 gets the machine object the specified PID belongs to if there is any\&.
235 .PP
236 \fBGetImage()\fR
237 may be used to get the image object path of the image with the specified name\&.
238 .PP
239 \fBListMachines()\fR
240 returns an array of all currently registered machines\&. The structures in the array consist of the following fields: machine name, machine class, an identifier for the service that registered the machine and the machine object path\&.
241 .PP
242 \fBListImages()\fR
243 returns an array of all currently known images\&. The structures in the array consist of the following fields: image name, type, read\-only flag, creation time, modification time, current disk space, and image object path\&.
244 .PP
245 \fBCreateMachine()\fR
246 may be used to register a new virtual machine or container with
247 \fBsystemd\-machined\fR, creating a scope unit for it\&. It accepts the following arguments: a machine name chosen by the registrar, an optional UUID as a 32 byte array, a string that identifies the service that registers the machine, a class string, the PID of the leader process of the machine, an optional root directory of the container, and an array of additional properties to use for the scope registration\&. The virtual machine name must be suitable as a hostname, and hence should follow the usual DNS hostname rules, as well as the Linux hostname restrictions\&. Specifically, only 7 bit ASCII is permitted, a maximum length of 64 characters is enforced, only characters from the set
248 "a\-zA\-Z0\-9\-_\&."
249 are allowed, the name may not begin with a dot, and it may not contain two dots immediately following each other\&. Container and VM managers should ideally use the hostname used internally in the machine for this parameter\&. This recommendation is made in order to make the machine name naturally resolvable using
250 \fBnss-mymachines\fR(8)\&. If a container manager needs to embed characters outside of the indicated range, escaping is required, possibly using
251 "_"
252 as the escape character\&. Another (somewhat natural) option would be to utilize Internet IDNA encoding\&. The UUID is passed as a 32 byte array or, if no suitable UUID is available, an empty array (zero length) or zeroed out array shall be passed\&. The UUID should identify the virtual machine/container uniquely and should ideally be the same UUID that
253 /etc/machine\-id
254 in the VM/container is initialized from\&. The service string can be free\-form, but it is recommended to pass a short lowercase identifier like
255 "systemd\-nspawn",
256 "libvirt\-lxc"
257 or similar\&. The class string should be either
258 "container"
259 or
260 "vm"
261 indicating whether the machine to register is of the respective class\&. The leader PID should be the host PID of the init process of the container or the encapsulating process of the VM\&. If the root directory of the container is known and available in the host\*(Aqs hierarchy, it should be passed (note that this is for informational purposes only, and will not be used otherwise)\&. Otherwise, pass the empty string instead\&. Finally, the scope properties are passed as array in the same way as to PID1\*(Aqs
262 \fBStartTransientUnit()\fR
263 method\&. Calling this method will internally register a transient scope unit for the calling client (utilizing the passed scope_properties) and move the leader PID into it\&. The method returns an object path for the registered machine object that implements the
264 org\&.freedesktop\&.machine1\&.Machine
265 interface (see below)\&. Also see the
266 \m[blue]\fBNew Control Group Interfaces\fR\m[]\&\s-2\u[1]\d\s+2
267 for details about scope units and how to alter resource control settings on the created machine at runtime\&.
268 .PP
269 \fBRegisterMachine()\fR
270 is similar to
271 \fBCreateMachine()\fR\&. However, it only registers a machine and does not create a scope unit for it\&. Instead, the caller\*(Aqs unit is registered\&. We recommend to only use this method for container or VM managers that are run multiple times, one instance for each container/VM they manage, and are invoked as system services\&.
272 .PP
273 \fBCreateMachineWithNetwork()\fR
274 and
275 \fBRegisterMachineWithNetwork()\fR
276 are similar to
277 \fBCreateMachine()\fR
278 and
279 \fBRegisterMachine()\fR
280 but take an extra argument: an array of network interface indices that point towards the virtual machine or container\&. The interface indices should reference one or more network interfaces on the host that can be used to communicate with the guest\&. Commonly, the passed interface index refers to the host side of a "veth" link (in case of containers), a "tun"/"tap" link (in case of VMs), or the host side of a bridge interface that bridges access to the VM/container interfaces\&. Specifying this information is useful to enable support for link\-local IPv6 communication to the machines since the scope field of sockaddr_in6 can be initialized by the specified ifindex\&.
281 \fBnss-mymachines\fR(8)
282 makes use of this information\&.
283 .PP
284 \fBKillMachine()\fR
285 sends a UNIX signal to the machine\*(Aqs processes\&. As its arguments, it takes a machine name (as originally passed to
286 \fBCreateMachine()\fR
287 or returned by
288 \fBListMachines()\fR), an identifier that specifies what precisely to send the signal to (either
289 "leader"
290 or
291 "all"), and a numeric UNIX signal integer\&.
292 .PP
293 \fBTerminateMachine()\fR
294 terminates a virtual machine, killing its processes\&. It takes a machine name as its only argument\&.
295 .PP
296 \fBGetMachineAddresses()\fR
297 retrieves the IP addresses of a container\&. This method returns an array of pairs consisting of an address family specifier (\fBAF_INET\fR
298 or
299 \fBAF_INET6\fR) and a byte array containing the addresses\&. This is only supported for containers that make use of network namespacing\&.
300 .PP
301 \fBGetMachineSSHInfo()\fR
302 retrieves the SSH information of a machine\&. This method returns two strings, the SSH address which can be used to tell SSH where to connect, and the path to the SSH private key required for the connection to succeed\&.
303 .PP
304 \fBGetMachineOSRelease()\fR
305 retrieves the OS release information of a container\&. This method returns an array of key value pairs read from the
306 \fBos-release\fR(5)
307 file in the container and is useful to identify the operating system used in a container\&.
308 .PP
309 \fBOpenMachinePTY()\fR
310 allocates a pseudo TTY in the container and returns a file descriptor and its path\&. This is equivalent to transitioning into the container and invoking
311 \fBposix_openpt\fR(3)\&.
312 .PP
313 \fBOpenMachineLogin()\fR
314 allocates a pseudo TTY in the container and ensures that a getty login prompt of the container is running on the other end\&. It returns the file descriptor of the PTY and the PTY path\&. This is useful for acquiring a pty with a login prompt from the container\&.
315 .PP
316 \fBOpenMachineShell()\fR
317 allocates a pseudo TTY in the container, as the specified user, and invokes the executable at the specified path with a list of arguments (starting from argv[0]) and an environment block\&. It then returns the file descriptor of the PTY and the PTY path\&.
318 .PP
319 \fBBindMountMachine()\fR
320 bind mounts a file or directory from the host into the container\&. Its arguments consist of a machine name, the source directory on the host, the destination directory in the container, and two booleans, one indicating whether the bind mount shall be read\-only, the other indicating whether the destination mount point shall be created first, if it is missing\&.
321 .PP
322 \fBCopyFromMachine()\fR
323 copies files or directories from a container into the host\&. It takes a container name, a source directory in the container and a destination directory on the host as arguments\&.
324 \fBCopyToMachine()\fR
325 does the opposite and copies files from a source directory on the host into a destination directory in the container\&.
326 \fBCopyFromMachineWithFlags()\fR
327 and
328 \fBCopyToMachineWithFlags()\fR
329 do the same but take an additional flags argument\&.
330 .PP
331 \fBRemoveImage()\fR
332 removes the image with the specified name\&.
333 .PP
334 \fBRenameImage()\fR
335 renames the specified image\&.
336 .PP
337 \fBCloneImage()\fR
338 clones the specified image under a new name\&. It also takes a boolean argument indicating whether the resulting image shall be read\-only or not\&.
339 .PP
340 \fBMarkImageReadOnly()\fR
341 toggles the read\-only flag of an image\&.
342 .PP
343 \fBSetPoolLimit()\fR
344 sets an overall quota limit on the pool of images\&.
345 .PP
346 \fBSetImageLimit()\fR
347 sets a per\-image quota limit\&.
348 .PP
349 \fBMapFromMachineUser()\fR,
350 \fBMapToMachineUser()\fR,
351 \fBMapFromMachineGroup()\fR, and
352 \fBMapToMachineGroup()\fR
353 may be used to map UIDs/GIDs from the host user namespace to a container user namespace or vice versa\&.
354 .SS "Signals"
355 .PP
356 \fBMachineNew()\fR
357 and
358 \fBMachineRemoved()\fR
359 are sent whenever a new machine is registered or removed\&. These signals carry the machine name and the object path to the corresponding
360 org\&.freedesktop\&.machine1\&.Machine
361 interface (see below)\&.
362 .SS "Properties"
363 .PP
364 \fIPoolPath\fR
365 specifies the file system path where images are written to\&.
366 .PP
367 \fIPoolUsage\fR
368 specifies the current usage size of the image pool in bytes\&.
369 .PP
370 \fIPoolLimit\fR
371 specifies the size limit of the image pool in bytes\&.
372 .SH "MACHINE OBJECTS"
373 .sp
374 .if n \{\
375 .RS 4
376 .\}
377 .nf
378 node /org/freedesktop/machine1/machine/rawhide {
379 interface org\&.freedesktop\&.machine1\&.Machine {
380 methods:
381 Terminate();
382 Kill(in s whom,
383 in i signal);
384 GetAddresses(out a(iay) addresses);
385 GetSSHInfo(out s ssh_address,
386 out s ssh_private_key_path);
387 GetOSRelease(out a{ss} fields);
388 GetUIDShift(out u shift);
389 OpenPTY(out h pty,
390 out s pty_path);
391 OpenLogin(out h pty,
392 out s pty_path);
393 OpenShell(in s user,
394 in s path,
395 in as args,
396 in as environment,
397 out h pty,
398 out s pty_path);
399 BindMount(in s source,
400 in s destination,
401 in b read_only,
402 in b mkdir);
403 CopyFrom(in s source,
404 in s destination);
405 CopyTo(in s source,
406 in s destination);
407 CopyFromWithFlags(in s source,
408 in s destination,
409 in t flags);
410 CopyToWithFlags(in s source,
411 in s destination,
412 in t flags);
413 OpenRootDirectory(out h fd);
414 properties:
415 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
416 readonly s Name = \*(Aq\&.\&.\&.\*(Aq;
417 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
418 readonly ay Id = [\&.\&.\&.];
419 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
420 readonly t Timestamp = \&.\&.\&.;
421 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
422 readonly t TimestampMonotonic = \&.\&.\&.;
423 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
424 readonly s Service = \*(Aq\&.\&.\&.\*(Aq;
425 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
426 readonly s Unit = \*(Aq\&.\&.\&.\*(Aq;
427 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
428 readonly s Subgroup = \*(Aq\&.\&.\&.\*(Aq;
429 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
430 readonly u Leader = \&.\&.\&.;
431 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
432 readonly t LeaderPIDFDId = \&.\&.\&.;
433 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
434 readonly u Supervisor = \&.\&.\&.;
435 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
436 readonly t SupervisorPIDFDId = \&.\&.\&.;
437 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
438 readonly s Class = \*(Aq\&.\&.\&.\*(Aq;
439 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
440 readonly s RootDirectory = \*(Aq\&.\&.\&.\*(Aq;
441 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
442 readonly ai NetworkInterfaces = [\&.\&.\&.];
443 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
444 readonly u VSockCID = \&.\&.\&.;
445 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
446 readonly s SSHAddress = \*(Aq\&.\&.\&.\*(Aq;
447 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
448 readonly s SSHPrivateKeyPath = \*(Aq\&.\&.\&.\*(Aq;
449 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
450 readonly s State = \*(Aq\&.\&.\&.\*(Aq;
451 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
452 readonly u UID = \&.\&.\&.;
453 };
454 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
455 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
456 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
457 };
458 .fi
459 .if n \{\
460 .RE
461 .\}
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497 .SS "Methods"
498 .PP
499 \fBTerminate()\fR
500 and
501 \fBKill()\fR
502 terminate/kill the machine\&. These methods take the same arguments as
503 \fBTerminateMachine()\fR
504 and
505 \fBKillMachine()\fR
506 on the Manager interface, respectively\&.
507 .PP
508 \fBGetAddresses()\fR,
509 \fBGetSSHInfo()\fR
510 and
511 \fBGetOSRelease()\fR
512 get the IP address, SSH connection and OS release information from the machine\&. These methods take the same arguments as
513 \fBGetMachineAddresses()\fR,
514 \fBGetMachineSSHInfo()\fR
515 and
516 \fBGetMachineOSRelease()\fR
517 of the Manager interface, respectively\&.
518 .SS "Properties"
519 .PP
520 \fIName\fR
521 is the machine name as it was passed in during registration with
522 \fBCreateMachine()\fR
523 on the manager object\&.
524 .PP
525 \fIId\fR
526 is the machine UUID\&.
527 .PP
528 \fITimestamp\fR
529 and
530 \fITimestampMonotonic\fR
531 are the realtime and monotonic timestamps when the virtual machines where created in microseconds since the epoch\&.
532 .PP
533 \fIService\fR
534 contains a short string identifying the registering service as passed in during registration of the machine\&.
535 .PP
536 \fIUnit\fR
537 is the systemd scope or service unit name for the machine\&.
538 .PP
539 \fILeader\fR
540 is the PID of the leader process of the machine\&. (The leader process is the top\-level process of the payload of the machine, i\&.e\&. for containers PID 1 inside the container, and for VMs the process encapsulating the VM\&. Its lifetime defines the lifetime of the machine\&.)
541 .PP
542 \fILeaderPIDFDId\fR
543 encodes the Linux pidfd inode ID of the leader process of the machine\&.
544 .PP
545 \fISupervisor\fR
546 is the PID of the supervisor process of the machine\&. (The supervisor process is the process that manages the machine, if there\*(Aqs a separate one for it\&. A supervisor process is not always defined, and does not define the machine\*(Aqs lifetime\&.)
547 .PP
548 \fISupervisorPIDFDId\fR
549 encodes the Linux pidfd inode ID of the supervisor process of the machine\&.
550 .PP
551 \fIClass\fR
552 is the class of the machine and is either the string "vm" (for real VMs based on virtualized hardware) or "container" (for lightweight userspace virtualization sharing the same kernel as the host)\&.
553 .PP
554 \fIRootDirectory\fR
555 is the root directory of the container if it is known and applicable or the empty string\&.
556 .PP
557 \fINetworkInterfaces\fR
558 contains an array of network interface indices that point towards the container, the VM or the host\&. For details about this information see the description of
559 \fBCreateMachineWithNetwork()\fR
560 above\&.
561 .PP
562 \fIVSockCID\fR
563 is the VSOCK CID of the VM if it is known, or
564 \fBVMADDR_CID_ANY\fR
565 otherwise\&.
566 .PP
567 \fISSHAddress\fR
568 is the address of the VM in a format
569 \fBssh\fR
570 can understand if it is known or the empty string\&.
571 .PP
572 \fISSHPrivateKeyPath\fR
573 is the path to the SSH private key of the VM if it is known or the empty string\&.
574 .PP
575 \fIState\fR
576 is the state of the machine and is one of
577 "opening",
578 "running", or
579 "closing"\&. Note that the state machine is not considered part of the API and states might be removed or added without this being considered API breakage\&.
580 .PP
581 \fISubgroup\fR
582 contains the sub\-control\-group path this machine\*(Aqs processes reside in, relative to the specified unit\*(Aqs control group\&.
583 .PP
584 \fIUID\fR
585 contains the numeric UNIX UID of the user who registered the machine\&.
586 .SH "EXAMPLES"
587 .PP
588 \fBExample\ \&1.\ \&Introspect org\&.freedesktop\&.machine1\&.Manager on the bus\fR
589 .sp
590 .if n \{\
591 .RS 4
592 .\}
593 .nf
594 $ gdbus introspect \-\-system \e
595 \-\-dest org\&.freedesktop\&.machine1 \e
596 \-\-object\-path /org/freedesktop/machine1
597 .fi
598 .if n \{\
599 .RE
600 .\}
601 .PP
602 \fBExample\ \&2.\ \&Introspect org\&.freedesktop\&.machine1\&.Machine on the bus\fR
603 .sp
604 .if n \{\
605 .RS 4
606 .\}
607 .nf
608 $ gdbus introspect \-\-system \e
609 \-\-dest org\&.freedesktop\&.machine1 \e
610 \-\-object\-path /org/freedesktop/machine1/machine/rawhide
611 .fi
612 .if n \{\
613 .RE
614 .\}
615 .SH "VERSIONING"
616 .PP
617 These D\-Bus interfaces follow
618 \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[2]\d\s+2\&.
619 .SH "HISTORY"
620 .SS "The Manager Object"
621 .PP
622 \fBCopyFromMachineWithFlags()\fR
623 and
624 \fBCopyToMachineWithFlags()\fR
625 were added in version 252\&.
626 .PP
627 \fBGetMachineSSHInfo()\fR
628 was added in version 256\&.
629 .SS "Machine Objects"
630 .PP
631 \fBCopyFromWithFlags()\fR
632 and
633 \fBCopyToWithFlags()\fR
634 were added in version 252\&.
635 .PP
636 \fBGetSSHInfo()\fR,
637 \fIVSockCID\fR,
638 \fISSHAddress\fR, and
639 \fISSHPrivateKeyPath\fR
640 were added in version 256\&.
641 .PP
642 \fILeaderPIDFDId\fR,
643 \fISupervisor\fR,
644 \fISupervisorPIDFDId\fR,
645 \fISubgroup\fR, and
646 \fIUID\fR
647 were added in version 258\&.
648 .SH "SEE ALSO"
649 .PP
650 \fBsystemd\fR(1), \fBsystemd-machined.service\fR(8), \fBmachinectl\fR(1)
651 .SH "NOTES"
652 .IP " 1." 4
653 New Control Group Interfaces
654 .RS 4
655 \%https://systemd.io/CONTROL_GROUP_INTERFACE
656 .RE
657 .IP " 2." 4
658 the usual interface versioning guidelines
659 .RS 4
660 \%https://0pointer.de/blog/projects/versioning-dbus.html
661 .RE