HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/org.freedesktop.systemd1.xml
Git blob: 20ed6f31bcbe879e8e6830a4afab186debae7998
Lines 1001–2000 of 13,333
<variablelist class="dbus-method" generated="True" extra-ref="EnqueueMarkedJobs()"/>
<variablelist class="dbus-method" generated="True" extra-ref="ListUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="ListUnitFilesByPatterns()"/>
<variablelist class="dbus-method" generated="True" extra-ref="GetUnitFileState()"/>
<variablelist class="dbus-method" generated="True" extra-ref="EnableUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DisableUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="EnableUnitFilesWithFlags()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DisableUnitFilesWithFlags()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DisableUnitFilesWithFlagsAndInstallInfo()"/>
<variablelist class="dbus-method" generated="True" extra-ref="ReenableUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="LinkUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="PresetUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="PresetUnitFilesWithMode()"/>
<variablelist class="dbus-method" generated="True" extra-ref="MaskUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="UnmaskUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="RevertUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="SetDefaultTarget()"/>
<variablelist class="dbus-method" generated="True" extra-ref="GetDefaultTarget()"/>
<variablelist class="dbus-method" generated="True" extra-ref="PresetAllUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="AddDependencyUnitFiles()"/>
<variablelist class="dbus-method" generated="True" extra-ref="GetUnitFileLinks()"/>
<variablelist class="dbus-method" generated="True" extra-ref="SetExitCode()"/>
<variablelist class="dbus-method" generated="True" extra-ref="LookupDynamicUserByName()"/>
<variablelist class="dbus-method" generated="True" extra-ref="LookupDynamicUserByUID()"/>
<variablelist class="dbus-method" generated="True" extra-ref="GetDynamicUsers()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DumpUnitFileDescriptorStore()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UnitNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UnitRemoved()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="JobNew()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="JobRemoved()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="StartupFinished()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="UnitFilesChanged()"/>
<variablelist class="dbus-signal" generated="True" extra-ref="Reloading()"/>
<variablelist class="dbus-property" generated="True" extra-ref="Version"/>
<variablelist class="dbus-property" generated="True" extra-ref="Features"/>
<variablelist class="dbus-property" generated="True" extra-ref="Virtualization"/>
<variablelist class="dbus-property" generated="True" extra-ref="ConfidentialVirtualization"/>
<variablelist class="dbus-property" generated="True" extra-ref="Architecture"/>
<variablelist class="dbus-property" generated="True" extra-ref="Tainted"/>
<variablelist class="dbus-property" generated="True" extra-ref="FirmwareTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="FirmwareTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="LoaderTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="LoaderTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="KernelTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="KernelTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="UserspaceTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="UserspaceTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="FinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="FinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="ShutdownStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="ShutdownStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="ShutdownFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="ShutdownFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownLateStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownLateStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownLateFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="PreviousShutdownLateFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="SecurityStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="SecurityStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="SecurityFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="SecurityFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="GeneratorsStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="GeneratorsStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="GeneratorsFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="GeneratorsFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitsLoadStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitsLoadStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitsLoadFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitsLoadFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitsLoadTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitsLoadTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDSecurityStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDSecurityStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDSecurityFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDSecurityFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDGeneratorsStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDGeneratorsStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDGeneratorsFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDGeneratorsFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDUnitsLoadStartTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDUnitsLoadStartTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDUnitsLoadFinishTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InitRDUnitsLoadFinishTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="LogLevel"/>
<variablelist class="dbus-property" generated="True" extra-ref="LogTarget"/>
<variablelist class="dbus-property" generated="True" extra-ref="NNames"/>
<variablelist class="dbus-property" generated="True" extra-ref="NFailedUnits"/>
<variablelist class="dbus-property" generated="True" extra-ref="NJobs"/>
<variablelist class="dbus-property" generated="True" extra-ref="NInstalledJobs"/>
<variablelist class="dbus-property" generated="True" extra-ref="NFailedJobs"/>
<variablelist class="dbus-property" generated="True" extra-ref="TransactionsWithOrderingCycle"/>
<variablelist class="dbus-property" generated="True" extra-ref="Progress"/>
<variablelist class="dbus-property" generated="True" extra-ref="Environment"/>
<variablelist class="dbus-property" generated="True" extra-ref="ConfirmSpawn"/>
<variablelist class="dbus-property" generated="True" extra-ref="ShowStatus"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitPath"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultStandardOutput"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultStandardError"/>
<variablelist class="dbus-property" generated="True" extra-ref="WatchdogDevice"/>
<variablelist class="dbus-property" generated="True" extra-ref="WatchdogLastPingTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="WatchdogLastPingTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="RuntimeWatchdogUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="RuntimeWatchdogPreUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="RuntimeWatchdogPreGovernor"/>
<variablelist class="dbus-property" generated="True" extra-ref="RebootWatchdogUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="KExecWatchdogUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="ServiceWatchdogs"/>
<variablelist class="dbus-property" generated="True" extra-ref="ControlGroup"/>
<variablelist class="dbus-property" generated="True" extra-ref="SystemState"/>
<variablelist class="dbus-property" generated="True" extra-ref="ExitCode"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultTimerAccuracyUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultTimeoutStartUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultTimeoutStopUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultTimeoutAbortUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultDeviceTimeoutUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultRestartUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultStartLimitIntervalUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultStartLimitBurst"/>
<variablelist class="dbus-property" generated="True" extra-ref="EventLoopRateLimitIntervalUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="EventLoopRateLimitBurst"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultIOAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultIPAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultMemoryAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultTasksAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitCPU"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitCPUSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitFSIZE"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitFSIZESoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitDATA"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitDATASoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitSTACK"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitSTACKSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitCORE"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitCORESoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitRSS"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitRSSSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitNOFILE"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitNOFILESoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitAS"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitASSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitNPROC"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitNPROCSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitMEMLOCK"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitMEMLOCKSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitLOCKS"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitLOCKSSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitSIGPENDING"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitSIGPENDINGSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitMSGQUEUE"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitMSGQUEUESoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitNICE"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitNICESoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitRTPRIO"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitRTPRIOSoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitRTTIME"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultLimitRTTIMESoft"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultTasksMax"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultMemoryPressureThresholdUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultMemoryPressureWatch"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultCPUPressureThresholdUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultCPUPressureWatch"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultIOPressureThresholdUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultIOPressureWatch"/>
<variablelist class="dbus-property" generated="True" extra-ref="TimerSlackNSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultOOMPolicy"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultOOMScoreAdjust"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultRestrictSUIDSGID"/>
<variablelist class="dbus-property" generated="True" extra-ref="CtrlAltDelBurstAction"/>
<variablelist class="dbus-property" generated="True" extra-ref="SoftRebootsCount"/>
<variablelist class="dbus-property" generated="True" extra-ref="KExecCount"/>
<variablelist class="dbus-property" generated="True" extra-ref="ReloadCount"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultMemoryZSwapWriteback"/>
<!--End of Autogenerated section-->
<refsect2>
<title>Methods</title>
<para>Note that many of the methods exist twice: once on the <interfacename>Manager</interfacename>
object and once on the respective unit objects. This is to optimize access times so that methods that
belong to unit objects do not have to be called with a resolved unit path, but can be called with only
the unit id, too.</para>
<para><function>GetUnit()</function> may be used to get the unit object path for a unit name. It takes
the unit name and returns the object path. If a unit has not been loaded yet by this name this method
will fail.</para>
<para><function>GetUnitByPID()</function> may be used to get the unit object path of the unit a process
ID belongs to. It takes a UNIX PID and returns the object path. The PID must refer to an existing system process.
<function>GetUnitByPIDFD()</function> may be used to query with a Linux PIDFD (see:
<citerefentry><refentrytitle>pidfd_open</refentrytitle><manvolnum>2</manvolnum></citerefentry>) instead
of a PID, which is safer as UNIX PIDs can be recycled. The latter method returns the unit id and the
invocation id together with the unit object path.</para>
<para><function>LoadUnit()</function> is similar to <function>GetUnit()</function> but will load the
unit from disk if possible.</para>
<para><function>StartUnit()</function> enqueues a start job and possibly depending jobs. It takes the unit
to activate and a mode string as arguments. The mode needs to be one of <literal>replace</literal>,
<literal>fail</literal>, <literal>isolate</literal>, <literal>ignore-dependencies</literal>, or
<literal>ignore-requirements</literal>. If <literal>replace</literal>, the method will start the unit and
its dependencies, possibly replacing already queued jobs that conflict with it. If
<literal>fail</literal>, the method will start the unit and its dependencies, but will fail if this would
change an already queued job. If <literal>isolate</literal>, the method will start the unit in question
and terminate all units that are not dependencies of it. If <literal>ignore-dependencies</literal>, it
will start a unit but ignore all its dependencies. If <literal>ignore-requirements</literal>, it will
start a unit but only ignore the requirement dependencies. It is not recommended to make use of the
latter two options. On reply, if successful, this method returns the newly created job object
which has been enqueued for asynchronous activation. Callers that want to track the outcome of the
actual start operation need to monitor the result of this job. This can be achieved in a race-free
manner by first subscribing to the <function>JobRemoved()</function> signal, then calling
<function>StartUnit()</function> and using the returned job object to filter out unrelated
<function>JobRemoved()</function> signals, until the desired one is received, which will then carry
the result of the start operation.</para>
<para><function>StartUnitReplace()</function> is similar to <function>StartUnit()</function> but
replaces a job that is queued for one unit by a job for another unit.</para>
<para><function>StartUnitWithFlags()</function> is similar to <function>StartUnit()</function> but
allows the caller to pass an extra <varname>flags</varname> parameter, which does not support any
flags for now, and is reserved for future extensions.</para>
<para><function>StopUnit()</function> is similar to <function>StartUnit()</function> but stops the
specified unit rather than starting it. Note that the <literal>isolate</literal> mode is invalid for this
method.</para>
<para><function>ReloadUnit()</function>, <function>RestartUnit()</function>,
<function>TryRestartUnit()</function>, <function>ReloadOrRestartUnit()</function>, or
<function>ReloadOrTryRestartUnit()</function> may be used to restart and/or reload a unit. These methods take
similar arguments as <function>StartUnit()</function>. Reloading is done only if the unit is already
running and fails otherwise. If a service is restarted that is not running, it will be started unless
the "Try" flavor is used in which case a service that is not running is not affected by the restart. The
"ReloadOrRestart" flavors attempt a reload if the unit supports it and use a restart otherwise.</para>
<para><function>EnqueueUnitJob()</function> is similar to the various
<function>StartUnit()</function>/<function>StopUnit()</function>/<function>RestartUnit()</function>
methods above, but provides a unified interface that operates on a single unit. The
<varname>job_type</varname> argument selects the job type and is one of
<literal>start</literal>, <literal>stop</literal>, <literal>reload</literal>,
<literal>restart</literal>, <literal>try-restart</literal>,
<literal>reload-or-restart</literal> or <literal>reload-or-try-restart</literal>. The
<varname>job_mode</varname> argument matches the <varname>mode</varname> argument of
<function>StartUnit()</function>. On reply the method returns the enqueued anchor job's
numeric id and object path, the affected unit's id and object path, the job type
actually queued (after type collapsing, e.g. <literal>reload-or-restart</literal> turns
into <literal>restart</literal> or <literal>reload</literal>), and an array of
additional jobs that were enqueued as part of the same transaction in order to satisfy
dependencies.</para>
<para><function>EnqueueUnitJobMany()</function> is similar to
<function>EnqueueUnitJob()</function>, but operates on multiple units at once. All
requested units are enqueued in a single transaction, which is necessary in order to
properly honour <varname>After=</varname>/<varname>Before=</varname> ordering between
units passed in the same call regardless of their order in the array. The
<varname>job_type</varname> argument is applied to each of the listed units, including
the magic values <literal>reload-or-restart</literal> and
<literal>reload-or-try-restart</literal> which are resolved per unit (units that
support reloading get a reload job, others get a restart). The <varname>flags</varname>
argument does not support any flags for now and must be passed as <literal>0</literal>;
it is reserved for future extensions. On reply the method returns an array of tuples
describing the anchor job that was enqueued for each requested unit: the numeric job
id, the job object path, the unit id, the unit object path, and the job type that was
actually queued. Note that the order of tuples in the reply is unspecified and may not
correspond to the order of the input array.</para>
<para><function>EnqueueMarkedJobs()</function> creates reload/restart jobs for units which have been
appropriately marked, see <varname>Markers</varname> property above. This is equivalent to calling
<function>TryRestartUnit()</function> or <function>ReloadOrTryRestartUnit()</function> for the marked
units.</para>
<para><function>BindMountUnit()</function> can be used to bind mount new files or directories into a
running service mount namespace. If supported by the kernel, any prior mount on the selected target
will be replaced by the new mount. If not supported, any prior mount will be over-mounted, but remain
pinned and inaccessible.
</para>
<para><function>MountImageUnit()</function> can be used to mount new images into a running service
mount namespace. If supported by the kernel, any prior mount on the selected target will be replaced
by the new mount. If not supported, any prior mount will be over-mounted, but remain pinned and
inaccessible.</para>
<para><function>KillUnit()</function> may be used to kill (i.e. send a signal to) all processes of a
unit. It takes the unit <varname>name</varname>, an enum <varname>who</varname> and a UNIX
<varname>signal</varname> number to send. The <varname>who</varname> enum is one of
<literal>main</literal>, <literal>control</literal>, <literal>cgroup</literal> or
<literal>all</literal>. If <literal>main</literal>, only the main process of the unit is killed. If
<literal>control</literal>, only the control process of the unit is killed. If
<literal>cgroup</literal> is specified only the processes in the control group of the unit are killed,
which might or might not include the main and control processes too. If <literal>all</literal>, all
processes are killed, i.e. the main process, the control process and those in the control group. A
<literal>control</literal> process is for example a process that is configured via
<varname>ExecStop=</varname> and is spawned in parallel to the main daemon process in order to shut it
down. The value may be suffixed by <literal>-fail</literal> in which case the operation will fail of no
matching process was found (otherwise it will return successfully, executing no operation).</para>
<para><function>KillUnitSubgroup()</function> is just like <function>KillUnit()</function> but takes an
additional path argument that selects a sub-control group of the unit's control group. Only processes
in that subgroup are killed. The path my be specified with our without leading <literal>/</literal>, in
both cases it is taken relatively to the unit's control group. If the subgroup path is specified as an
empty string or as <literal>/</literal> it has the same effect as <function>KillUnit()</function>. If
it is specified as anything else the <literal>whom</literal> parameter must be set to either
<literal>cgroup</literal> or <literal>cgroup-fail</literal>.</para>
<para><function>QueueSignalUnit()</function> is similar to <function>KillUnit()</function> but may be
used to enqueue a POSIX Realtime Signal (i.e. <constant>SIGRTMIN+…</constant> and
<constant>SIGRTMAX-…</constant>) to the selected process(es). Takes the same parameters as
<function>KillUnit()</function> with one additional argument: an integer that is passed in the
<varname>sival_int</varname> value accompanying the queued signal. See
<citerefentry project="man-pages"><refentrytitle>sigqueue</refentrytitle><manvolnum>3</manvolnum></citerefentry>
for details.</para>
<para><function>GetJob()</function> returns the job object path for a specific job, identified by its
id.</para>
<para><function>CancelJob()</function> cancels a specific job identified by its numeric ID. This
operation is also available in the <function>Cancel()</function> method of Job objects (see below) and
exists primarily to reduce the necessary round trips to execute this operation. Note that this will not
have any effect on jobs whose execution has already begun.</para>
<para><function>ClearJobs()</function> flushes the job queue, removing all jobs that are still
queued. Note that this does not have any effect on jobs whose execution has already begun. It only
flushes jobs that are queued and have not yet begun execution.</para>
<para><function>ResetFailedUnit()</function> resets the "failed" state of a specific unit.</para>
<para><function>SetShowStatus()</function> configures the display of status messages during bootup and
shutdown. The <varname>mode</varname> parameter can be set to any value that's valid for the
<varname>systemd.show_status</varname> kernel parameter. For more information about
<varname>systemd.show_status</varname>, see
<citerefentry project="man-pages"><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
The <varname>mode</varname> parameter can also be set to an empty string. When <varname>mode</varname>
is set to an empty string, <function>SetShowStatus()</function> will reset
<varname>ShowStatus</varname> back to its original value. You can use
<function>SetShowStatus()</function> create a service that does something like this:
<orderedlist>
<listitem><para>Send a D-Bus message that will turn off status messages.</para></listitem>
<listitem><para>Block until a reply to that message is received.</para></listitem>
<listitem><para>Print multiple lines without being interrupted by status messages.</para></listitem>
<listitem><para>Send a D-Bus message that will reset <varname>ShowStatus</varname> back to its
original value.</para></listitem>
</orderedlist>
</para>
<para><function>ResetFailed()</function> resets the "failed" state of all units.</para>
<para><function>ListUnits()</function> returns an array of all currently loaded units. Note that
units may be known by multiple names at the same time, and hence there might be more unit names loaded
than actual units behind them. The array consists of structures with the following elements:
<itemizedlist>
<listitem><para>The primary unit name as string</para></listitem>
<listitem><para>The human-readable description string</para></listitem>
<listitem><para>The load state (i.e. whether the unit file has been loaded
successfully)</para></listitem>
<listitem><para>The active state (i.e. whether the unit is currently started or
not)</para></listitem>
<listitem><para>The sub state (a more fine-grained version of the active state that is specific to
the unit type, which the active state is not)</para></listitem>
<listitem><para>A unit that is being followed in its state by this unit, if there is any, otherwise
the empty string.</para></listitem>
<listitem><para>The unit object path</para></listitem>
<listitem><para>If there is a job queued for the job unit, the numeric job id, 0
otherwise</para></listitem>
<listitem><para>The job type as string</para></listitem>
<listitem><para>The job object path</para></listitem>
</itemizedlist></para>
<para><function>ListJobs()</function> returns an array with all currently queued jobs. Returns an array
consisting of structures with the following elements:
<itemizedlist>
<listitem><para>The numeric job id</para></listitem>
<listitem><para>The primary unit name for this job</para></listitem>
<listitem><para>The job type as string</para></listitem>
<listitem><para>The job state as string</para></listitem>
<listitem><para>The job object path</para></listitem>
<listitem><para>The unit object path</para></listitem>
</itemizedlist></para>
<para><function>Subscribe()</function> enables most bus signals to be sent out. Clients which are
interested in signals need to call this method. Signals are only sent out if at least one client
invoked this method. Note that this behavior is applied to all the signals that the object
in <constant>/org/freedesktop/systemd1</constant> may emit, including the
D-Bus standard <constant>org.freedesktop.DBus.Properties.PropertiesChanged</constant>
signal and others that do not belong to the <constant>org.freedesktop.systemd1</constant> interface.</para>
<para><function>Unsubscribe()</function> reverts the signal subscription that
<function>Subscribe()</function> implements. It is not necessary to invoke
<function>Unsubscribe()</function> as clients are tracked. Signals are no longer sent out as soon as
all clients which previously asked for <function>Subscribe()</function> either closed their connection
to the bus or invoked <function>Unsubscribe()</function>.</para>
<para><function>Dump()</function> returns a text dump of the internal service manager state. This is a
privileged, low-level debugging interface only. The returned string is supposed to be readable
exclusively by developers, and not programmatically. There's no interface stability on the returned
string guaranteed, and new fields may be added any time, and old fields removed. The general structure
may be rearranged drastically between releases. This is exposed by
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>dump</command> command. Similarly, <function>DumpUnitsMatchingPatterns()</function> returns
the internal state of units whose names match the glob expressions specified in the
<varname>patterns</varname> argument. The
<function>DumpByFileDescriptor()</function>/<function>DumpUnitsMatchingPatternsByFileDescriptor()</function>
methods are identical to <function>Dump()</function>/<function>DumpUnitsMatchingPatterns()</function>,
but return data serialized into a file descriptor (the client should read the text data from it until
hitting EOF). Given the size limits on D-Bus messages and the possibly large size of the returned
strings,
<function>DumpByFileDescriptor()</function>/<function>DumpUnitsMatchingPatternsByFileDescriptor()</function>
are usually the preferred interface, since it ensures the data can be passed reliably from the service
manager to the client. Note though that they cannot work when communicating with the service manager
remotely, as file descriptors are strictly local to a system. All the <function>Dump*()</function>
methods are rate limited for unprivileged users.</para>
<para><function>Reload()</function> may be invoked to reload all unit files.</para>
<para><function>Reexecute()</function> may be invoked to reexecute the main manager process. It will
serialize its state, reexecute, and deserizalize the state again. This is useful for upgrades and is a
more comprehensive version of <function>Reload()</function>.</para>
<para><function>Exit()</function> may be invoked to ask the manager to exit. This is not available for
the system manager and is useful only for user session managers.</para>
<para><function>Reboot()</function>, <function>PowerOff()</function>, <function>Halt()</function>,
<function>KExec()</function> and <function>SoftReboot()</function> may be used to ask for immediate
reboot, powering down, halt, kexec based reboot, or soft reboot of the system. Note that this does not
shut down any services and immediately transitions into the later shutdown operation. These functions
are normally only called as the last step of shutdown and should not be called directly. To shut down
the machine, it is generally a better idea to invoke <function>Reboot()</function>,
<function>RebootWithFlags()</function> or <function>PowerOff()</function> on the
<filename>systemd-logind</filename> manager object; see
<citerefentry><refentrytitle>org.freedesktop.login1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information. <function>SoftReboot()</function> accepts an argument indicating the path for the
root file system to activate for the next boot cycle. If an empty string is specified the
<filename>/run/nextroot/</filename> path is used if it exists.</para>
<para><function>SwitchRoot()</function> may be used to transition to a new root directory. This is
intended to be used in the initrd, and also to transition from the host system into a shutdown initrd.
The method takes two arguments: the new root directory (which needs to be specified) and an init binary
path (which may be left empty, in which case it is automatically searched for). The state of the system
manager will be serialized before the transition. After the transition, the manager binary on the main
system is invoked and replaces the old PID 1. All state will then be deserialized.</para>
<para><function>SetEnvironment()</function> may be used to alter the environment block that is passed
to all spawned processes. It takes a string array of environment variable assignments. Any previously set
environment variables will be overridden.</para>
<para><function>UnsetEnvironment()</function> may be used to unset environment variables. It takes a
string array of environment variable names. All variables specified will be unset (if they have been
set previously) and no longer be passed to all spawned processes. This method has no effect for variables
that were previously not set, but will not fail in that case.</para>
<para><function>UnsetAndSetEnvironment()</function> is a combination of
<function>UnsetEnvironment()</function> and <function>SetEnvironment()</function>. It takes two
lists. The first list contains variables to unset, the second one contains assignments to set. If a
variable is listed in both, the variable is set after this method returns, i.e. the set list overrides the
unset list.</para>
<para><function>ListUnitFiles()</function> returns an array of unit names and their enablement
status. Note that <function>ListUnit()</function> returns a list of units currently loaded into memory,
while <function>ListUnitFiles()</function> returns a list of unit <emphasis>files</emphasis> that were
found on disk. Note that while most units are read directly from a unit file with the same name, some
units are not backed by files and some files (templates) cannot directly be loaded as units but need
to be instantiated instead.</para>
<para><function>GetUnitFileState()</function> returns the current enablement status of a specific unit
file.</para>
<para><function>EnableUnitFiles()</function> may be used to enable one or more units in the system (by
creating symlinks to them in <filename>/etc/</filename> or <filename>/run/</filename>). It takes a list
of unit files to enable (either just file names or full absolute paths if the unit files are residing
outside the usual unit search paths) and two booleans: the first controls whether the unit shall be
enabled for runtime only (true, <filename>/run/</filename>), or persistently (false,
<filename>/etc/</filename>). The second one controls whether symlinks pointing to other units shall be
replaced if necessary. This method returns one boolean and an array of the changes made. The boolean
signals whether the unit files contained any enablement information (i.e. an [Install] section). The
changes array consists of structures with three strings: the type of the change (one of
<literal>symlink</literal> or <literal>unlink</literal>), the file name of the symlink and the
destination of the symlink. Note that most of the following calls return a changes list in the same
format.</para>
<para>Similarly, <function>DisableUnitFiles()</function> disables one or more units in the system,
i.e. removes all symlinks to them in <filename>/etc/</filename> and <filename>/run/</filename>.</para>
<para>The <function>EnableUnitFilesWithFlags()</function> and <function>DisableUnitFilesWithFlags()</function>
take in options as flags instead of booleans to allow for extendability, defined as follows:</para>
<programlisting>
#define SD_SYSTEMD_UNIT_RUNTIME (UINT64_C(1) << 0)
#define SD_SYSTEMD_UNIT_FORCE (UINT64_C(1) << 1)
#define SD_SYSTEMD_UNIT_PORTABLE (UINT64_C(1) << 2)
</programlisting>
<para><varname>SD_SYSTEMD_UNIT_RUNTIME</varname> will enable or disable the unit for runtime only,
<varname>SD_SYSTEMD_UNIT_FORCE</varname> controls whether symlinks pointing to other units shall be
replaced if necessary. <varname>SD_SYSTEMD_UNIT_PORTABLE</varname> will add or remove the symlinks in
<filename>/etc/systemd/system.attached</filename> and <filename>/run/systemd/system.attached</filename>.</para>
<para><function>DisableUnitFilesWithFlagsAndInstallInfo()</function> is similar to
<function>DisableUnitFilesWithFlags()</function> and takes the same arguments, but returns
a boolean to indicate whether the unit files contain any enablement information, like
<function>EnableUnitFiles()</function>. The changes made are still returned in an array.</para>
<para>Similarly, <function>ReenableUnitFiles()</function> applies the changes to one or more units that
would result from disabling and enabling the unit quickly one after the other in an atomic
fashion. This is useful to apply updated [Install] information contained in unit files.</para>
<para>Similarly, <function>LinkUnitFiles()</function> links unit files (that are located outside of the
usual unit search paths) into the unit search path.</para>
<para>Similarly, <function>PresetUnitFiles()</function> enables/disables one or more unit files
according to the preset policy. See
<citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
information.</para>
<para>Similarly, <function>MaskUnitFiles()</function> masks unit files and
<function>UnmaskUnitFiles()</function> unmasks them again.</para>
<para><function>SetDefaultTarget()</function> changes the <filename>default.target</filename> link. See
<citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry> for more
information.</para>
<para><function>GetDefaultTarget()</function> retrieves the name of the unit to which
<filename>default.target</filename> is aliased.</para>
<para><function>SetUnitProperties()</function> may be used to modify certain unit properties at
runtime. Not all properties may be changed at runtime, but many resource management settings (primarily
those listed in
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
may. The changes are applied instantly and stored on disk for future boots, unless
<varname>runtime</varname> is true, in which case the settings only apply until the next
reboot. <varname>name</varname> is the name of the unit to modify. <varname>properties</varname> are
the settings to set, encoded as an array of property name and value pairs. Note that this is not a
dictionary! Also note that when setting array properties with this method usually results in appending to
the pre-configured array. To reset the configured arrays, set the property to an empty array first and
then append to it.</para>
<para><function>StartTransientUnit()</function> may be used to create and start a transient unit which
will be released as soon as it is not running or referenced anymore or the system is
rebooted. <varname>name</varname> is the unit name including its suffix and must be
unique. <varname>mode</varname> is the same as in <function>StartUnit()</function>,
<varname>properties</varname> contains properties of the unit, specified like in
<function>SetUnitProperties()</function>. <varname>aux</varname> is currently unused and should be
passed as an empty array. See the
<ulink url="https://systemd.io/CONTROL_GROUP_INTERFACE">New Control Group
Interface</ulink> for more information how to make use of this functionality for resource control
purposes.</para>
<para><function>DumpUnitFileDescriptorStore()</function> returns an array with information about the
file descriptors currently in the file descriptor store of the specified unit. This call is equivalent
to <function>DumpFileDescriptorStore()</function> on the
<interfacename>org.freedesktop.systemd1.Service</interfacename>. For further details, see below.</para>
<para><function>CleanUnit()</function> deletes the configuration, state, logs, cache and runtime data
directories and clear out the file descriptors store for the unit, as specified in the mask
parameters. The possible values are <literal>configuration</literal>, <literal>state</literal>,
<literal>logs</literal>, <literal>cache</literal>, <literal>runtime</literal>,
<literal>fdstore</literal>, and <literal>all</literal>.</para>
<para><function>RemoveSubgroupFromUnit()</function> removes a subcgroup belonging to a unit's
cgroup. Takes three arguments: the unit name (if empty defaults to the caller's unit), a cgroup path
(which must start start with a slash <literal>/</literal>), which is taken relative to the unit's
cgroup, and a flags argument (which must be zero for now). This is primarily useful for unprivileged
service managers to ask the system service manager for removal of subcgroups it manages, in case one
was delegated to other UIDs.</para>
</refsect2>
<refsect2>
<title>Signals</title>
<para>Note that most signals are sent out only after <function>Subscribe()</function> has been invoked
by at least one client. Make sure to invoke this method when subscribing to these signals!</para>
<para><function>UnitNew()</function> and <function>UnitRemoved()</function> are sent out each time a
new unit is loaded or unloaded. Note that this has little to do with whether a unit is available on
disk or not, and simply reflects the units that are currently loaded into memory. The signals take two
parameters: the primary unit name and the object path.</para>
<para><function>JobNew()</function> and <function>JobRemoved()</function> are sent out each time a new
job is queued or dequeued. Both signals take the numeric job ID, the bus path and the primary unit name
for this job as arguments. <function>JobRemoved()</function> also includes a result string which is one
of <literal>done</literal>, <literal>canceled</literal>, <literal>timeout</literal>,
<literal>failed</literal>, <literal>dependency</literal>, or
<literal>skipped</literal>. <literal>done</literal> indicates successful execution of a
job. <literal>canceled</literal> indicates that a job has been canceled (via
<function>CancelJob()</function> above) before it finished execution (this does not necessarily mean
though that the job operation is actually cancelled too, see above). <literal>timeout</literal>
indicates that the job timeout was reached. <literal>failed</literal> indicates that the job
failed. <literal>dependency</literal> indicates that a job this job depended on failed and the job hence
was removed as well. <literal>skipped</literal> indicates that a job was skipped because
it did not apply to the unit's current state.</para>
<para><function>StartupFinished()</function> is sent out when startup finishes. It carries six
microsecond timespan values, each indicating how much boot time has been spent in the firmware (if
known), in the boot loader (if known), in the kernel initialization phase, in the initrd (if known), in
userspace and in total. These values may also be calculated from the
<varname>FirmwareTimestampMonotonic</varname>, <varname>LoaderTimestampMonotonic</varname>,
<varname>InitRDTimestampMonotonic</varname>, <varname>UserspaceTimestampMonotonic</varname>, and
<varname>FinishTimestampMonotonic</varname> properties (see below).</para>
<para><function>UnitFilesChanged()</function> is sent out each time the list of enabled or masked unit
files on disk have changed.</para>
<para><function>Reloading()</function> is sent out immediately before a daemon reload is done (with the
boolean parameter set to True) and after a daemon reload is completed (with the boolean parameter set
to False). This may be used by UIs to optimize UI updates.</para>
</refsect2>
<refsect2>
<title>Properties</title>
<para>Most properties simply reflect the respective options in
<filename>/etc/systemd/system.conf</filename> and the kernel command line.</para>
<para>The others:</para>
<para><varname>Version</varname> encodes the version string of the running systemd instance. Note that
the version string is purely informational. It should not be parsed and one may not assume the version to
be formatted in any particular way. We take the liberty to change the versioning scheme at any time and
it is not part of the public API.</para>
<para><varname>Features</varname> encodes the features that have been enabled and disabled for this
build. Enabled options are prefixed with <literal>+</literal>, disabled options with
<literal>-</literal>.</para>
<para><varname>Tainted</varname> encodes taint flags as a colon-separated list. When systemd detects it
is running on a system with a certain problem, it will set an appropriate taint flag. Taints may be
used to lower the chance of bogus bug reports. The following taints are currently known:</para>
<variablelist>
<varlistentry>
<term><literal>unmerged-usr</literal></term>
<listitem><para><filename>/bin</filename>, <filename>/sbin</filename> and
<filename>/lib*</filename> are not symlinks to their counterparts under <filename>/usr/</filename>.
For more information on this issue consult
<ulink url="https://systemd.io/THE_CASE_FOR_THE_USR_MERGE">The Case for the /usr Merge</ulink>.
</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>unmerged-bin</literal></term>
<listitem><para><filename>/usr/sbin</filename> is not a symlink to <filename>/usr/bin/</filename>.
</para>
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>var-run-bad</literal></term>
<listitem><para><filename>/run/</filename> does not exist or <filename>/var/run</filename> is not a
symlink to <filename>/run/</filename>.</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>cgroupsv1</literal></term>
<listitem><para>The system is using the deprecated cgroup v1 hierarchy.</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>local-hwclock</literal></term>
<listitem><para>The local hardware clock (RTC) is configured to be in local time rather than
UTC.</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>support-ended</literal></term>
<listitem><para>The system is running past the end of support declared by the vendor. See the
description of <varname>SUPPORT_END=</varname> in
<citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>old-kernel</literal></term>
<listitem><para>The system is running a kernel version that is older than the minimum supported by
this version of systemd.</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>overflowuid-not-65534</literal></term>
<term><literal>overflowgid-not-65534</literal></term>
<listitem><para>The kernel overflow UID or GID have a value other than 65534.</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><literal>short-uid-range</literal></term>
<term><literal>short-gid-range</literal></term>
<listitem><para>The UID or GID range assigned to the running systemd instance covers less than
0…65534.</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
</variablelist>
<para><varname>FirmwareTimestamp</varname>, <varname>FirmwareTimestampMonotonic</varname>,
<varname>LoaderTimestamp</varname>, <varname>LoaderTimestampMonotonic</varname>,
<varname>KernelTimestamp</varname>, <varname>KernelTimestampMonotonic</varname>,
<varname>InitRDTimestamp</varname>, <varname>InitRDTimestampMonotonic</varname>,
<varname>UserspaceTimestamp</varname>, <varname>UserspaceTimestampMonotonic</varname>,
<varname>FinishTimestamp</varname>, <varname>FinishTimestampMonotonic</varname>,
<varname>ShutdownStartTimestamp</varname> and <varname>ShutdownStartTimestampMonotonic</varname>
encode <constant>CLOCK_REALTIME</constant> and <constant>CLOCK_MONOTONIC</constant> microsecond
timestamps taken when the firmware first began execution, when the boot loader first began execution,
when the kernel first began execution, when the initrd first began execution, when the main systemd
instance began execution, when all queued startup jobs finished execution and finally, when a shutdown
operation first began execution. These values are useful for determining boot-time performance. Note
that as monotonic time begins with the kernel startup, the <varname>KernelTimestampMonotonic</varname>
timestamp will always be 0 and <varname>FirmwareTimestampMonotonic</varname> and
<varname>LoaderTimestampMonotonic</varname> are to be read as negative values. Also, not all fields
are always available, depending on the used firmware, boot loader or initrd implementation. In these
cases the respective pairs of timestamps are both 0, indicating that no data is available.</para>
<para><varname>ShutdownFinishTimestamp</varname> and
<varname>ShutdownFinishTimestampMonotonic</varname> encode <constant>CLOCK_REALTIME</constant> and
<constant>CLOCK_MONOTONIC</constant> microsecond timestamps taken when all units have finished stopping
during shutdown, i.e. when <filename>shutdown.target</filename> is reached. Together with
<varname>ShutdownStartTimestamp</varname> (which is taken when unit stopping begins) they bracket the
time spent stopping units.</para>
<para><varname>PreviousShutdownStartTimestamp</varname>,
<varname>PreviousShutdownFinishTimestamp</varname>,
<varname>PreviousShutdownLateStartTimestamp</varname>,
<varname>PreviousShutdownLateFinishTimestamp</varname> and their
<constant>Monotonic</constant> counterparts encode <constant>CLOCK_REALTIME</constant> and
<constant>CLOCK_MONOTONIC</constant> microsecond timestamps describing the shutdown of the
<emphasis>previous</emphasis> boot, restored from the Live Update Orchestrator (LUO) payload after a
kexec-based live update. <varname>PreviousShutdownStartTimestamp</varname> and
<varname>PreviousShutdownFinishTimestamp</varname> bracket the unit-stopping phase of that previous
boot, while <varname>PreviousShutdownLateStartTimestamp</varname> and
<varname>PreviousShutdownLateFinishTimestamp</varname> are taken by <command>systemd-shutdown</command>
itself when it began execution and when it was about to <function>kexec()</function> into the current
kernel, respectively. Unlike the current cycle's <varname>ShutdownStartTimestamp</varname> and
<varname>ShutdownFinishTimestamp</varname> (which describe an in-progress shutdown of the running
system), these always refer to a previous, already-completed boot, similar to the firmware, boot loader
and kernel timestamps. They are populated only after a kexec-based live update and are useful for
determining shutdown and live-update performance; otherwise they are all 0.</para>
<para><varname>UnitsLoadTimestamp</varname> and <varname>UnitsLoadTimestampMonotonic</varname> encode
<constant>CLOCK_REALTIME</constant> and <constant>CLOCK_MONOTONIC</constant> microseconds timestamps
(as described above). The timestamps are taken every time when the manager starts loading unit files.
</para>
<para>Similarly, the <varname>SecurityStartTimestamp</varname>,
<varname>GeneratorsStartTimestamp</varname> and <varname>LoadUnitTimestamp</varname> (as well as their
monotonic and stop counterparts) expose performance data for uploading the security policies to the
kernel (such as the SELinux, IMA, or SMACK policies), for running the generator tools and for loading
the unit files.</para>
<para><varname>NNames</varname> encodes how many unit names are currently known. This only includes
names of units that are currently loaded and can be more than the amount of actually loaded units since
units may have more than one name.</para>
<para><varname>NJobs</varname> encodes how many jobs are currently queued.</para>
<para><varname>NInstalledJobs</varname> encodes how many jobs have ever been queued in total.</para>
<para><varname>NFailedJobs</varname> encodes how many jobs have ever failed in total.</para>
<para><varname>TransactionsWithOrderingCycle</varname> encodes IDs of transactions that encountered
ordering cycle.</para>
<para><varname>Progress</varname> encodes boot progress as a floating point value between 0.0 and
1.0. This value begins at 0.0 at early-boot and ends at 1.0 when boot is finished and is based on the
number of executed and queued jobs. After startup, this field is always 1.0 indicating a finished
boot.</para>
<para><varname>Environment</varname> encodes the environment block passed to all executed services. It
may be altered with bus calls such as <function>SetEnvironment()</function> (see above).</para>
<para><varname>ShowStatus</varname> encodes systemd's current policy for displaying status messages
during bootup and shutdown. Its value can be any valid value for the
<varname>systemd.show_status</varname> kernel parameter (see
<citerefentry project="man-pages"><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
It may be altered using <function>SetShowStatus()</function> (see above).</para>
<para><varname>UnitPath</varname> encodes the currently active unit file search path. It is an array of
file system paths encoded as strings.</para>
<para><varname>SoftRebootsCount</varname> encodes how many soft-reboots were successfully completed
since the last full boot. Starts at <literal>0</literal>.</para>
<para><varname>KExecCount</varname> encodes how many kexec-based live updates were successfully
completed since the last full boot. Starts at <literal>0</literal>. The counter is preserved across the
kexec through the Live Update Orchestrator (LUO), and is hence <literal>0</literal> when the kernel does