2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" >
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
6 <refentry id=
"org.freedesktop.machine1" conditional='ENABLE_MACHINED'
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
9 <title>org.freedesktop.machine1
</title>
10 <productname>systemd
</productname>
14 <refentrytitle>org.freedesktop.machine1
</refentrytitle>
15 <manvolnum>5</manvolnum>
19 <refname>org.freedesktop.machine1
</refname>
20 <refpurpose>The D-Bus interface of systemd-machined
</refpurpose>
24 <title>Introduction
</title>
27 <citerefentry><refentrytitle>systemd-machined.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
28 is a system service that keeps track of locally running virtual machines and containers.
29 This page describes the D-Bus interface.
</para>
33 <title>The Manager Object
</title>
35 <para>The service exposes the following interfaces on the Manager object on the bus:
</para>
37 <programlisting executable=
"systemd-machined" node=
"/org/freedesktop/machine1" interface=
"org.freedesktop.machine1.Manager">
38 node /org/freedesktop/machine1 {
39 interface org.freedesktop.machine1.Manager {
45 GetMachineByPID(in u pid,
47 ListMachines(out a(ssso) machines);
48 ListImages(out a(ssbttto) images);
49 @org.freedesktop.systemd1.Privileged(
"true")
50 CreateMachine(in s name,
56 in a(sv) scope_properties,
58 @org.freedesktop.systemd1.Privileged(
"true")
59 CreateMachineWithNetwork(in s name,
66 in a(sv) scope_properties,
68 @org.freedesktop.systemd1.Privileged(
"true")
69 RegisterMachine(in s name,
76 @org.freedesktop.systemd1.Privileged(
"true")
77 RegisterMachineWithNetwork(in s name,
85 UnregisterMachine(in s name);
86 TerminateMachine(in s id);
87 KillMachine(in s name,
90 GetMachineAddresses(in s name,
91 out a(iay) addresses);
92 GetMachineOSRelease(in s name,
94 @org.freedesktop.systemd1.Privileged(
"true")
95 OpenMachinePTY(in s name,
98 OpenMachineLogin(in s name,
101 OpenMachineShell(in s name,
108 BindMountMachine(in s name,
113 CopyFromMachine(in s name,
116 CopyToMachine(in s name,
119 OpenMachineRootDirectory(in s name,
121 GetMachineUIDShift(in s name,
123 RemoveImage(in s name);
124 RenameImage(in s name,
126 CloneImage(in s name,
129 MarkImageReadOnly(in s name,
131 GetImageHostname(in s name,
133 GetImageMachineID(in s name,
135 GetImageMachineInfo(in s name,
136 out a{ss} machine_info);
137 GetImageOSRelease(in s name,
138 out a{ss} os_release);
139 SetPoolLimit(in t size);
140 SetImageLimit(in s name,
144 MapFromMachineUser(in s name,
147 MapToMachineUser(in u uid_outer,
151 MapFromMachineGroup(in s name,
154 MapToMachineGroup(in u gid_outer,
159 MachineNew(s machine,
161 MachineRemoved(s machine,
164 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"false")
165 readonly s PoolPath = '...';
166 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"false")
167 readonly t PoolUsage = ...;
168 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"false")
169 readonly t PoolLimit = ...;
171 interface org.freedesktop.DBus.Peer { ... };
172 interface org.freedesktop.DBus.Introspectable { ... };
173 interface org.freedesktop.DBus.Properties { ... };
177 <!--method UnregisterMachine is not documented!-->
179 <!--method OpenMachineRootDirectory is not documented!-->
181 <!--method GetMachineUIDShift is not documented!-->
183 <!--method GetImageHostname is not documented!-->
185 <!--method GetImageMachineID is not documented!-->
187 <!--method GetImageMachineInfo is not documented!-->
189 <!--method GetImageOSRelease is not documented!-->
191 <!--method CleanPool is not documented!-->
193 <!--Autogenerated cross-references for systemd.directives, do not edit-->
195 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.machine1.Manager"/>
197 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.machine1.Manager"/>
199 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetMachine()"/>
201 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetImage()"/>
203 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetMachineByPID()"/>
205 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"ListMachines()"/>
207 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"ListImages()"/>
209 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CreateMachine()"/>
211 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CreateMachineWithNetwork()"/>
213 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RegisterMachine()"/>
215 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RegisterMachineWithNetwork()"/>
217 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"UnregisterMachine()"/>
219 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"TerminateMachine()"/>
221 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"KillMachine()"/>
223 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetMachineAddresses()"/>
225 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetMachineOSRelease()"/>
227 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenMachinePTY()"/>
229 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenMachineLogin()"/>
231 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenMachineShell()"/>
233 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"BindMountMachine()"/>
235 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CopyFromMachine()"/>
237 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CopyToMachine()"/>
239 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenMachineRootDirectory()"/>
241 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetMachineUIDShift()"/>
243 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RemoveImage()"/>
245 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RenameImage()"/>
247 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CloneImage()"/>
249 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"MarkImageReadOnly()"/>
251 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetImageHostname()"/>
253 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetImageMachineID()"/>
255 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetImageMachineInfo()"/>
257 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetImageOSRelease()"/>
259 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetPoolLimit()"/>
261 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetImageLimit()"/>
263 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CleanPool()"/>
265 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"MapFromMachineUser()"/>
267 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"MapToMachineUser()"/>
269 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"MapFromMachineGroup()"/>
271 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"MapToMachineGroup()"/>
273 <variablelist class=
"dbus-signal" generated=
"True" extra-ref=
"MachineNew"/>
275 <variablelist class=
"dbus-signal" generated=
"True" extra-ref=
"MachineRemoved"/>
277 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"PoolPath"/>
279 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"PoolUsage"/>
281 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"PoolLimit"/>
283 <!--End of Autogenerated section-->
286 <title>Methods
</title>
288 <para><function>GetMachine()
</function> may be used to get the machine object path for the machine with
289 the specified name. Similarly,
<function>GetMachineByPID()
</function> gets the machine object the
290 specified PID belongs to if there is any.
</para>
292 <para><function>GetImage()
</function> may be used to get the image object path of the image with the
293 specified name.
</para>
295 <para><function>ListMachines()
</function> returns an array of all currently registered machines. The
296 structures in the array consist of the following fields: machine name, machine class, an identifier for
297 the service that registered the machine and the machine object path.
</para>
299 <para><function>ListImages()
</function> returns an array of all currently known images. The
300 structures in the array consist of the following fields: image name, type, read-only flag, creation
301 time, modification time, current disk space, and image object path.
</para>
303 <para><function>CreateMachine()
</function> may be used to register a new virtual machine or container
304 with
<command>systemd-machined
</command>, creating a scope unit for it. It accepts the following arguments: a
305 machine name chosen by the registrar, an optional UUID as a
32 byte array, a string that identifies the
306 service that registers the machine, a class string, the PID of the leader process of the machine, an
307 optional root directory of the container, and an array of additional properties to use for the scope
308 registration. The virtual machine name must be suitable as a hostname, and hence should follow the usual
309 DNS hostname rules, as well as the Linux hostname restrictions. Specifically, only
7 bit ASCII is
310 permitted, a maximum length of
64 characters is enforced, only characters from the set
311 <literal>a-zA-Z0-
9-_.
</literal> are allowed, the name may not begin with a dot, and it may not contain
312 two dots immediately following each other. Container and VM managers should ideally use the hostname
313 used internally in the machine for this parameter. This recommendation is made in order to make the
314 machine name naturally resolvable using
315 <citerefentry><refentrytitle>nss-mymachines
</refentrytitle><manvolnum>8</manvolnum></citerefentry>. If
316 a container manager needs to embed characters outside of the indicated range, escaping is required,
317 possibly using
<literal>_
</literal> as the escape character. Another (somewhat natural) option would be
318 to utilize Internet IDNA encoding. The UUID is passed as a
32 byte array or, if no suitable UUID is
319 available, an empty array (zero length) or zeroed out array shall be passed. The UUID should identify
320 the virtual machine/container uniquely and should ideally be the same UUID that
321 <filename>/etc/machine-id
</filename> in the VM/container is initialized from. The service string can be
322 free-form, but it is recommended to pass a short lowercase identifier like
323 <literal>systemd-nspawn
</literal>,
<literal>libvirt-lxc
</literal> or similar. The class string should
324 be either
<literal>container
</literal> or
<literal>vm
</literal> indicating whether the machine to
325 register is of the respective class. The leader PID should be the host PID of the init process of the
326 container or the encapsulating process of the VM. If the root directory of the container is known and
327 available in the host's hierarchy, it should be passed. Otherwise, pass the empty string instead. Finally, the
328 scope properties are passed as array in the same way as to PID1's
329 <function>StartTransientUnit()
</function> method. Calling this method will internally register a transient scope
330 unit for the calling client (utilizing the passed scope_properties) and move the leader PID into
331 it. The method returns an object path for the registered machine object that implements the
332 <interfacename>org.freedesktop.machine1.Machine
</interfacename> interface (see below). Also see the
333 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface/">New Control Group
334 Interfaces
</ulink> for details about scope units and how to alter resource control settings on the
335 created machine at runtime.
</para>
337 <para><function>RegisterMachine()
</function> is similar to
<function>CreateMachine()
</function>.
338 However, it only registers a machine and does not create a scope unit for it. Instead, the caller's unit is
339 registered. We recommend to only use this method for container or VM managers that are run
340 multiple times, one instance for each container/VM they manage, and are invoked as system
343 <para><function>CreateMachineWithNetwork()
</function> and
344 <function>RegisterMachineWithNetwork()
</function> are similar to
<function>CreateMachine()
</function>
345 and
<function>RegisterMachine()
</function> but take an extra argument: an array of network interface
346 indices that point towards the virtual machine or container. The interface indices should reference one
347 or more network interfaces on the host that can be used to communicate with the guest. Commonly, the
348 passed interface index refers to the host side of a
"veth" link (in case of containers), a
349 "tun"/
"tap" link (in case of VMs), or the host side of a bridge interface that bridges access to the
350 VM/container interfaces. Specifying this information is useful to enable support for link-local IPv6
351 communication to the machines since the scope field of sockaddr_in6 can be initialized by the
353 <citerefentry><refentrytitle>nss-mymachines
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
354 makes use of this information.
</para>
356 <para><function>KillMachine()
</function> sends a UNIX signal to the machine's processes. As its arguments, it takes a
357 machine name (as originally passed to
<function>CreateMachine()
</function> or returned by
358 <function>ListMachines()
</function>), an identifier that specifies what precisely to send the signal to (either
359 <literal>leader
</literal> or
<literal>all
</literal>), and a numeric UNIX signal integer.
</para>
361 <para><function>TerminateMachine()
</function> terminates a virtual machine, killing its processes. It
362 takes a machine name as its only argument.
</para>
364 <para><function>GetMachineAddresses()
</function> retrieves the IP addresses of a container. This method
365 returns an array of pairs consisting of an address family specifier (
<constant>AF_INET
</constant> or
366 <constant>AF_INET6
</constant>) and a byte array containing the addresses. This is only supported for
367 containers that make use of network namespacing.
</para>
369 <para><function>GetMachineOSRelease()
</function> retrieves the OS release information of a
370 container. This method returns an array of key value pairs read from the
371 <citerefentry><refentrytitle>os-release
</refentrytitle><manvolnum>5</manvolnum></citerefentry> file in
372 the container and is useful to identify the operating system used in a container.
</para>
374 <para><function>OpenMachinePTY()
</function> allocates a pseudo TTY in the container and returns a file
375 descriptor and its path. This is equivalent to transitioning into the container and invoking
376 <citerefentry project=
"man-pages"><refentrytitle>posix_openpt
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
379 <para><function>OpenMachineLogin()
</function> allocates a pseudo TTY in the container and ensures that
380 a getty login prompt of the container is running on the other end. It returns the file descriptor of
381 the PTY and the PTY path. This is useful for acquiring a pty with a login prompt from the
384 <para><function>OpenMachineShell()
</function> allocates a pseudo TTY in the container, as the specified
385 user, and invokes the executable at the specified path with a list of arguments (starting from
386 argv[
0]) and an environment block. It then returns the file descriptor of the PTY and the PTY
389 <para><function>BindMountMachine()
</function> bind mounts a file or directory from the host into the
390 container. Its arguments consist of a machine name, the source directory on the host, the destination directory in the
391 container, and two booleans, one indicating whether the bind mount shall be
392 read-only, the other indicating whether the destination mount point shall be created first, if it is
395 <para><function>CopyFromMachine()
</function> copies files or directories from a container into the
396 host. It takes a container name, a source directory in the container and a destination directory on the
397 host as arguments.
<function>CopyToMachine()
</function> does the opposite and copies files from a source
398 directory on the host into a destination directory in the container.
</para>
400 <para><function>RemoveImage()
</function> removes the image with the specified name.
</para>
402 <para><function>RenameImage()
</function> renames the specified image.
</para>
404 <para><function>CloneImage()
</function> clones the specified image under a new name. It also takes a
405 boolean argument indicating whether the resulting image shall be read-only or not.
</para>
407 <para><function>MarkImageReadOnly()
</function> toggles the read-only flag of an image.
</para>
409 <para><function>SetPoolLimit()
</function> sets an overall quota limit on the pool of images.
</para>
411 <para><function>SetImageLimit()
</function> sets a per-image quota limit.
</para>
413 <para><function>MapFromMachineUser()
</function>,
<function>MapToMachineUser()
</function>,
414 <function>MapFromMachineGroup()
</function>, and
<function>MapToMachineGroup()
</function> may be used to map
415 UIDs/GIDs from the host user namespace to a container user namespace or vice versa.
</para>
419 <title>Signals
</title>
421 <para><function>MachineNew
</function> and
<function>MachineRemoved
</function> are sent whenever a new
422 machine is registered or removed. These signals carry the machine name and the object path to the corresponding
423 <interfacename>org.freedesktop.machine1.Machine
</interfacename> interface (see below).
</para>
427 <title>Properties
</title>
429 <para><varname>PoolPath
</varname> specifies the file system path where images are written to.
</para>
431 <para><varname>PoolUsage
</varname> specifies the current usage size of the image pool in bytes.
</para>
433 <para><varname>PoolLimit
</varname> specifies the size limit of the image pool in bytes.
</para>
438 <title>Machine Objects
</title>
440 <programlisting executable=
"systemd-machined" node=
"/org/freedesktop/machine1/machine/rawhide" interface=
"org.freedesktop.machine1.Machine">
441 node /org/freedesktop/machine1/machine/rawhide {
442 interface org.freedesktop.machine1.Machine {
447 GetAddresses(out a(iay) addresses);
448 GetOSRelease(out a{ss} fields);
449 GetUIDShift(out u shift);
460 BindMount(in s source,
464 CopyFrom(in s source,
468 OpenRootDirectory(out h fd);
470 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
471 readonly s Name = '...';
472 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
473 readonly ay Id = [...];
474 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
475 readonly t Timestamp = ...;
476 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
477 readonly t TimestampMonotonic = ...;
478 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
479 readonly s Service = '...';
480 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
481 readonly s Unit = '...';
482 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
483 readonly u Leader = ...;
484 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
485 readonly s Class = '...';
486 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
487 readonly s RootDirectory = '...';
488 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
489 readonly ai NetworkInterfaces = [...];
490 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"false")
491 readonly s State = '...';
493 interface org.freedesktop.DBus.Peer { ... };
494 interface org.freedesktop.DBus.Introspectable { ... };
495 interface org.freedesktop.DBus.Properties { ... };
499 <!--method GetUIDShift is not documented!-->
501 <!--method OpenPTY is not documented!-->
503 <!--method OpenLogin is not documented!-->
505 <!--method OpenShell is not documented!-->
507 <!--method BindMount is not documented!-->
509 <!--method CopyFrom is not documented!-->
511 <!--method CopyTo is not documented!-->
513 <!--method OpenRootDirectory is not documented!-->
515 <!--Autogenerated cross-references for systemd.directives, do not edit-->
517 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.machine1.Machine"/>
519 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.machine1.Machine"/>
521 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"Terminate()"/>
523 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"Kill()"/>
525 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetAddresses()"/>
527 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetOSRelease()"/>
529 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetUIDShift()"/>
531 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenPTY()"/>
533 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenLogin()"/>
535 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenShell()"/>
537 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"BindMount()"/>
539 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CopyFrom()"/>
541 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"CopyTo()"/>
543 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"OpenRootDirectory()"/>
545 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Name"/>
547 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Id"/>
549 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Timestamp"/>
551 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"TimestampMonotonic"/>
553 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Service"/>
555 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Unit"/>
557 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Leader"/>
559 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Class"/>
561 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"RootDirectory"/>
563 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"NetworkInterfaces"/>
565 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"State"/>
567 <!--End of Autogenerated section-->
570 <title>Methods
</title>
572 <para><function>Terminate()
</function> and
<function>Kill()
</function> terminate/kill the machine. These methods
573 take the same arguments as
<function>TerminateMachine()
</function> and
574 <function>KillMachine()
</function> on the Manager interface, respectively.
</para>
576 <para><function>GetAddresses()
</function> and
<function>GetOSRelease()
</function> get the IP address and OS
577 release information from the machine. These methods take the same arguments as
578 <function>GetMachineAddresses()
</function> and
<function>GetMachineOSRelease()
</function> of the
579 Manager interface, respectively.
</para>
583 <title>Properties
</title>
585 <para><varname>Name
</varname> is the machine name as it was passed in during registration with
586 <function>CreateMachine()
</function> on the manager object.
</para>
588 <para><varname>Id
</varname> is the machine UUID.
</para>
590 <para><varname>Timestamp
</varname> and
<varname>TimestampMonotonic
</varname> are the realtime and
591 monotonic timestamps when the virtual machines where created in microseconds since the epoch.
</para>
593 <para><varname>Service
</varname> contains a short string identifying the registering service as passed
594 in during registration of the machine.
</para>
596 <para><varname>Unit
</varname> is the systemd scope or service unit name for the machine.
</para>
598 <para><varname>Leader
</varname> is the PID of the leader process of the machine.
</para>
600 <para><varname>Class
</varname> is the class of the machine and is either the string
"vm" (for real VMs
601 based on virtualized hardware) or
"container" (for light-weight userspace virtualization sharing the
602 same kernel as the host).
</para>
604 <para><varname>RootDirectory
</varname> is the root directory of the container if it is known and
605 applicable or the empty string.
</para>
607 <para><varname>NetworkInterfaces
</varname> contains an array of network interface indices that point
608 towards the container, the VM or the host. For details about this information see the description of
609 <function>CreateMachineWithNetwork()
</function> above.
</para>
611 <para><varname>State
</varname> is the state of the machine and is one of
<literal>opening
</literal>,
612 <literal>running
</literal>, or
<literal>closing
</literal>. Note that the state machine is not considered
613 part of the API and states might be removed or added without this being considered API breakage.
619 <title>Examples
</title>
622 <title>Introspect
<interfacename>org.freedesktop.machine1.Manager
</interfacename> on the bus
</title>
625 $ gdbus introspect --system \
626 --dest org.freedesktop.machine1 \
627 --object-path /org/freedesktop/machine1
632 <title>Introspect
<interfacename>org.freedesktop.machine1.Machine
</interfacename> on the bus
</title>
635 $ gdbus introspect --system \
636 --dest org.freedesktop.machine1 \
637 --object-path /org/freedesktop/machine1/machine/rawhide
642 <xi:include href=
"org.freedesktop.locale1.xml" xpointer=
"versioning"/>