HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/org.freedesktop.systemd1.xml
Git blob: 20ed6f31bcbe879e8e6830a4afab186debae7998
Lines 2001–3000 of 13,333
not provide LUO support.</para>
<para><varname>ReloadCount</varname> encodes the number of successfully completed configuration
reloads of the manager. The counter is reset to <literal>0</literal> on
<command>daemon-reexec</command> and on the initial boot.</para>
<para><varname>Virtualization</varname> contains a short ID string describing the virtualization
technology the system runs in. On bare-metal hardware this is the empty string. Otherwise, it contains
an identifier such as <literal>kvm</literal>, <literal>vmware</literal> and so on. For a full list of
IDs see
<citerefentry><refentrytitle>systemd-detect-virt</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
Note that only the "innermost" virtualization technology is exported here. This detects both
full-machine virtualizations (VMs) and shared-kernel virtualization (containers).</para>
<para><varname>ConfidentialVirtualization</varname> contains a short ID string describing the confidential
virtualization technology the system runs in. On bare-metal hardware this is the empty string. Otherwise,
it contains an identifier such as <literal>sev</literal>, <literal>sev-es</literal>, <literal>sev-snp</literal>,
<literal>tdx</literal> and so on. For a full list of IDs see
<citerefentry><refentrytitle>systemd-detect-virt</refentrytitle><manvolnum>1</manvolnum></citerefentry></para>.
<para><varname>Architecture</varname> contains a short ID string describing the architecture the
systemd instance is running on. This follows the same vocabulary as
<varname>ConditionArchitectures=</varname>.</para>
<para><varname>ControlGroup</varname> contains the root control group path of this system manager. Note
that the root path is encoded as the empty string here (not as <literal>/</literal>!), so that it can be
appended to <filename>/sys/fs/cgroup/systemd</filename> easily. This value will be set to the empty
string for the host instance and some other string for container instances.</para>
<para><varname>AccessSELinuxContext</varname> contains the SELinux context that is used to control
access to the unit. It's read from the unit file when it is loaded and cached until the service manager
is reloaded. This property contains an empty string if SELinux is not used or if no label could be read
(for example because the unit is not backed by a file on disk).</para>
<para><varname>SystemState</varname> contains the current state of the system manager. The possible
values are:</para>
<variablelist>
<varlistentry>
<term><literal>initializing</literal></term>
<listitem><para>The system is booting, and <filename>basic.target</filename> has not been reached
yet.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>starting</literal></term>
<listitem><para>The system is booting, and <filename>basic.target</filename> has been reached.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>running</literal></term>
<listitem><para>The system has finished booting, and no units are in the failed state.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>degraded</literal></term>
<listitem><para>The system has finished booting, but some units are in the failed state.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>maintenance</literal></term>
<listitem><para>The system has finished booting, but it has been put in rescue or maintenance
mode.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>stopping</literal></term>
<listitem><para>The system is shutting down.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Security</title>
<para>Read access is generally granted to all clients. Additionally, for unprivileged clients, some
operations are allowed through the polkit privilege system. Operations which modify unit state
(<function>StartUnit()</function>, <function>StopUnit()</function>, <function>KillUnit()</function>,
<function>KillUnitSubgroup()</function>, <function>QueueSignalUnit()</function>,
<function>RestartUnit()</function> and similar, <function>SetUnitProperties()</function>) require
<interfacename>org.freedesktop.systemd1.manage-units</interfacename>. Operations which modify unit file
enablement state (<function>EnableUnitFiles()</function>, <function>DisableUnitFiles()</function>,
<function>EnableUnitFilesWithFlags()</function>, <function>DisableUnitFilesWithFlags()</function>,
<function>ReenableUnitFiles()</function>, <function>LinkUnitFiles()</function>,
<function>PresetUnitFiles()</function>, <function>MaskUnitFiles()</function>, and similar) require
<interfacename>org.freedesktop.systemd1.manage-unit-files</interfacename>. Operations which modify the
exported environment (<function>SetEnvironment()</function>, <function>UnsetEnvironment()</function>,
<function>UnsetAndSetEnvironment()</function>) require
<interfacename>org.freedesktop.systemd1.set-environment</interfacename>. <function>Reload()</function>
and <function>Reexecute()</function> require
<interfacename>org.freedesktop.systemd1.reload-daemon</interfacename>. Operations which dump internal
state require <interfacename>org.freedesktop.systemd1.bypass-dump-ratelimit</interfacename> to avoid
rate limits.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Unit Objects</title>
<programlisting executable="systemd" node="/org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice" interface="org.freedesktop.systemd1.Unit">
node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice {
interface org.freedesktop.systemd1.Unit {
methods:
Start(in s mode,
out o job);
Stop(in s mode,
out o job);
Reload(in s mode,
out o job);
Restart(in s mode,
out o job);
TryRestart(in s mode,
out o job);
ReloadOrRestart(in s mode,
out o job);
ReloadOrTryRestart(in s mode,
out o job);
EnqueueJob(in s job_type,
in s job_mode,
out u job_id,
out o job_path,
out s unit_id,
out o unit_path,
out s job_type,
out a(uosos) affected_jobs);
Kill(in s whom,
in i signal);
KillSubgroup(in s subgroup,
in i signal);
QueueSignal(in s whom,
in i signal,
in i value);
ResetFailed();
SetProperties(in b runtime,
in a(sv) properties);
Ref();
Unref();
Clean(in as mask);
Freeze();
Thaw();
properties:
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s Id = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Names = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly s Following = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Requires = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Requisite = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Wants = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as BindsTo = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as PartOf = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Upholds = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as RequiredBy = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as RequisiteOf = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as WantedBy = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as BoundBy = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as UpheldBy = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as ConsistsOf = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Conflicts = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as ConflictedBy = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Before = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as After = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as OnSuccess = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as OnSuccessOf = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as OnFailure = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as OnFailureOf = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Triggers = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as TriggeredBy = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as PropagatesReloadTo = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as ReloadPropagatedFrom = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as PropagatesStopTo = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as StopPropagatedFrom = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as JoinsNamespaceOf = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as SliceOf = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as RequiresMountsFor = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as WantsMountsFor = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as Documentation = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s Description = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s AccessSELinuxContext = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s LoadState = '...';
readonly s ActiveState = '...';
readonly s FreezerState = '...';
readonly s SubState = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s FragmentPath = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s SourcePath = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as DropInPaths = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly s UnitFileState = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly s UnitFilePreset = '...';
readonly t StateChangeTimestamp = ...;
readonly t StateChangeTimestampMonotonic = ...;
readonly t InactiveExitTimestamp = ...;
readonly t InactiveExitTimestampMonotonic = ...;
readonly t ActiveEnterTimestamp = ...;
readonly t ActiveEnterTimestampMonotonic = ...;
readonly t ActiveExitTimestamp = ...;
readonly t ActiveExitTimestampMonotonic = ...;
readonly t InactiveEnterTimestamp = ...;
readonly t InactiveEnterTimestampMonotonic = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b CanStart = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b CanStop = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b CanReload = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b CanIsolate = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly as CanClean = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b CanFreeze = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b CanLiveMount = ...;
readonly (uo) Job = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b StopWhenUnneeded = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b RefuseManualStart = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b RefuseManualStop = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b AllowIsolate = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b DefaultDependencies = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b SurviveFinalKillSignal = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s OnSuccessJobMode = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s OnFailureJobMode = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b IgnoreOnIsolate = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b NeedDaemonReload = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly as Markers = ['...', ...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t JobTimeoutUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t JobRunningTimeoutUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s JobTimeoutAction = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s JobTimeoutRebootArgument = '...';
readonly b ConditionResult = ...;
readonly b AssertResult = ...;
readonly t ConditionTimestamp = ...;
readonly t ConditionTimestampMonotonic = ...;
readonly t AssertTimestamp = ...;
readonly t AssertTimestampMonotonic = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("invalidates")
readonly a(sbbsi) Conditions = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("invalidates")
readonly a(sbbsi) Asserts = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly (ss) LoadError = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b Transient = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b Perpetual = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t StartLimitIntervalUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly u StartLimitBurst = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s StartLimitAction = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s FailureAction = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly i FailureActionExitStatus = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s SuccessAction = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly i SuccessActionExitStatus = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s RebootArgument = '...';
readonly ay InvocationID = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s CollectMode = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly as Refs = ['...', ...];
readonly a(ss) ActivationDetails = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b DebugInvocation = ...;
};
interface org.freedesktop.DBus.Peer { ... };
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
<!--method EnqueueJob is not documented!-->
<!--method Ref is not documented!-->
<!--method Unref is not documented!-->
<!--method Clean is not documented!-->
<!--method Freeze is not documented!-->
<!--method Thaw is not documented!-->
<!--property PartOf is not documented!-->
<!--property Upholds is not documented!-->
<!--property RequisiteOf is not documented!-->
<!--property UpheldBy is not documented!-->
<!--property ConsistsOf is not documented!-->
<!--property OnSuccess is not documented!-->
<!--property OnSuccessOf is not documented!-->
<!--property OnFailureOf is not documented!-->
<!--property ReloadPropagatedFrom is not documented!-->
<!--property PropagatesStopTo is not documented!-->
<!--property StopPropagatedFrom is not documented!-->
<!--property JoinsNamespaceOf is not documented!-->
<!--property SliceOf is not documented!-->
<!--property WantsMountsFor is not documented!-->
<!--property FreezerState is not documented!-->
<!--property DropInPaths is not documented!-->
<!--property UnitFilePreset is not documented!-->
<!--property StateChangeTimestamp is not documented!-->
<!--property StateChangeTimestampMonotonic is not documented!-->
<!--property CanClean is not documented!-->
<!--property CanFreeze is not documented!-->
<!--property CanLiveMount is not documented!-->
<!--property SurviveFinalKillSignal is not documented!-->
<!--property OnSuccessJobMode is not documented!-->
<!--property OnFailureJobMode is not documented!-->
<!--property JobRunningTimeoutUSec is not documented!-->
<!--property JobTimeoutAction is not documented!-->
<!--property JobTimeoutRebootArgument is not documented!-->
<!--property AssertResult is not documented!-->
<!--property AssertTimestamp is not documented!-->
<!--property AssertTimestampMonotonic is not documented!-->
<!--property Asserts is not documented!-->
<!--property Perpetual is not documented!-->
<!--property StartLimitIntervalUSec is not documented!-->
<!--property StartLimitAction is not documented!-->
<!--property FailureAction is not documented!-->
<!--property FailureActionExitStatus is not documented!-->
<!--property SuccessAction is not documented!-->
<!--property SuccessActionExitStatus is not documented!-->
<!--property RebootArgument is not documented!-->
<!--property InvocationID is not documented!-->
<!--property CollectMode is not documented!-->
<!--property Refs is not documented!-->
<!--Autogenerated cross-references for systemd.directives, do not edit-->
<variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.systemd1.Unit"/>
<variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.systemd1.Unit"/>
<variablelist class="dbus-method" generated="True" extra-ref="Start()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Stop()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Reload()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Restart()"/>
<variablelist class="dbus-method" generated="True" extra-ref="TryRestart()"/>
<variablelist class="dbus-method" generated="True" extra-ref="ReloadOrRestart()"/>
<variablelist class="dbus-method" generated="True" extra-ref="ReloadOrTryRestart()"/>
<variablelist class="dbus-method" generated="True" extra-ref="EnqueueJob()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Kill()"/>
<variablelist class="dbus-method" generated="True" extra-ref="KillSubgroup()"/>
<variablelist class="dbus-method" generated="True" extra-ref="QueueSignal()"/>
<variablelist class="dbus-method" generated="True" extra-ref="ResetFailed()"/>
<variablelist class="dbus-method" generated="True" extra-ref="SetProperties()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Ref()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Unref()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Clean()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Freeze()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Thaw()"/>
<variablelist class="dbus-property" generated="True" extra-ref="Id"/>
<variablelist class="dbus-property" generated="True" extra-ref="Names"/>
<variablelist class="dbus-property" generated="True" extra-ref="Following"/>
<variablelist class="dbus-property" generated="True" extra-ref="Requires"/>
<variablelist class="dbus-property" generated="True" extra-ref="Requisite"/>
<variablelist class="dbus-property" generated="True" extra-ref="Wants"/>
<variablelist class="dbus-property" generated="True" extra-ref="BindsTo"/>
<variablelist class="dbus-property" generated="True" extra-ref="PartOf"/>
<variablelist class="dbus-property" generated="True" extra-ref="Upholds"/>
<variablelist class="dbus-property" generated="True" extra-ref="RequiredBy"/>
<variablelist class="dbus-property" generated="True" extra-ref="RequisiteOf"/>
<variablelist class="dbus-property" generated="True" extra-ref="WantedBy"/>
<variablelist class="dbus-property" generated="True" extra-ref="BoundBy"/>
<variablelist class="dbus-property" generated="True" extra-ref="UpheldBy"/>
<variablelist class="dbus-property" generated="True" extra-ref="ConsistsOf"/>
<variablelist class="dbus-property" generated="True" extra-ref="Conflicts"/>
<variablelist class="dbus-property" generated="True" extra-ref="ConflictedBy"/>
<variablelist class="dbus-property" generated="True" extra-ref="Before"/>
<variablelist class="dbus-property" generated="True" extra-ref="After"/>
<variablelist class="dbus-property" generated="True" extra-ref="OnSuccess"/>
<variablelist class="dbus-property" generated="True" extra-ref="OnSuccessOf"/>
<variablelist class="dbus-property" generated="True" extra-ref="OnFailure"/>
<variablelist class="dbus-property" generated="True" extra-ref="OnFailureOf"/>
<variablelist class="dbus-property" generated="True" extra-ref="Triggers"/>
<variablelist class="dbus-property" generated="True" extra-ref="TriggeredBy"/>
<variablelist class="dbus-property" generated="True" extra-ref="PropagatesReloadTo"/>
<variablelist class="dbus-property" generated="True" extra-ref="ReloadPropagatedFrom"/>
<variablelist class="dbus-property" generated="True" extra-ref="PropagatesStopTo"/>
<variablelist class="dbus-property" generated="True" extra-ref="StopPropagatedFrom"/>
<variablelist class="dbus-property" generated="True" extra-ref="JoinsNamespaceOf"/>
<variablelist class="dbus-property" generated="True" extra-ref="SliceOf"/>
<variablelist class="dbus-property" generated="True" extra-ref="RequiresMountsFor"/>
<variablelist class="dbus-property" generated="True" extra-ref="WantsMountsFor"/>
<variablelist class="dbus-property" generated="True" extra-ref="Documentation"/>
<variablelist class="dbus-property" generated="True" extra-ref="Description"/>
<variablelist class="dbus-property" generated="True" extra-ref="AccessSELinuxContext"/>
<variablelist class="dbus-property" generated="True" extra-ref="LoadState"/>
<variablelist class="dbus-property" generated="True" extra-ref="ActiveState"/>
<variablelist class="dbus-property" generated="True" extra-ref="FreezerState"/>
<variablelist class="dbus-property" generated="True" extra-ref="SubState"/>
<variablelist class="dbus-property" generated="True" extra-ref="FragmentPath"/>
<variablelist class="dbus-property" generated="True" extra-ref="SourcePath"/>
<variablelist class="dbus-property" generated="True" extra-ref="DropInPaths"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitFileState"/>
<variablelist class="dbus-property" generated="True" extra-ref="UnitFilePreset"/>
<variablelist class="dbus-property" generated="True" extra-ref="StateChangeTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="StateChangeTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InactiveExitTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InactiveExitTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="ActiveEnterTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="ActiveEnterTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="ActiveExitTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="ActiveExitTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="InactiveEnterTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="InactiveEnterTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="CanStart"/>
<variablelist class="dbus-property" generated="True" extra-ref="CanStop"/>
<variablelist class="dbus-property" generated="True" extra-ref="CanReload"/>
<variablelist class="dbus-property" generated="True" extra-ref="CanIsolate"/>
<variablelist class="dbus-property" generated="True" extra-ref="CanClean"/>
<variablelist class="dbus-property" generated="True" extra-ref="CanFreeze"/>
<variablelist class="dbus-property" generated="True" extra-ref="CanLiveMount"/>
<variablelist class="dbus-property" generated="True" extra-ref="Job"/>
<variablelist class="dbus-property" generated="True" extra-ref="StopWhenUnneeded"/>
<variablelist class="dbus-property" generated="True" extra-ref="RefuseManualStart"/>
<variablelist class="dbus-property" generated="True" extra-ref="RefuseManualStop"/>
<variablelist class="dbus-property" generated="True" extra-ref="AllowIsolate"/>
<variablelist class="dbus-property" generated="True" extra-ref="DefaultDependencies"/>
<variablelist class="dbus-property" generated="True" extra-ref="SurviveFinalKillSignal"/>
<variablelist class="dbus-property" generated="True" extra-ref="OnSuccessJobMode"/>
<variablelist class="dbus-property" generated="True" extra-ref="OnFailureJobMode"/>
<variablelist class="dbus-property" generated="True" extra-ref="IgnoreOnIsolate"/>
<variablelist class="dbus-property" generated="True" extra-ref="NeedDaemonReload"/>
<variablelist class="dbus-property" generated="True" extra-ref="Markers"/>
<variablelist class="dbus-property" generated="True" extra-ref="JobTimeoutUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="JobRunningTimeoutUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="JobTimeoutAction"/>
<variablelist class="dbus-property" generated="True" extra-ref="JobTimeoutRebootArgument"/>
<variablelist class="dbus-property" generated="True" extra-ref="ConditionResult"/>
<variablelist class="dbus-property" generated="True" extra-ref="AssertResult"/>
<variablelist class="dbus-property" generated="True" extra-ref="ConditionTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="ConditionTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="AssertTimestamp"/>
<variablelist class="dbus-property" generated="True" extra-ref="AssertTimestampMonotonic"/>
<variablelist class="dbus-property" generated="True" extra-ref="Conditions"/>
<variablelist class="dbus-property" generated="True" extra-ref="Asserts"/>
<variablelist class="dbus-property" generated="True" extra-ref="LoadError"/>
<variablelist class="dbus-property" generated="True" extra-ref="Transient"/>
<variablelist class="dbus-property" generated="True" extra-ref="Perpetual"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartLimitIntervalUSec"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartLimitBurst"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartLimitAction"/>
<variablelist class="dbus-property" generated="True" extra-ref="FailureAction"/>
<variablelist class="dbus-property" generated="True" extra-ref="FailureActionExitStatus"/>
<variablelist class="dbus-property" generated="True" extra-ref="SuccessAction"/>
<variablelist class="dbus-property" generated="True" extra-ref="SuccessActionExitStatus"/>
<variablelist class="dbus-property" generated="True" extra-ref="RebootArgument"/>
<variablelist class="dbus-property" generated="True" extra-ref="InvocationID"/>
<variablelist class="dbus-property" generated="True" extra-ref="CollectMode"/>
<variablelist class="dbus-property" generated="True" extra-ref="Refs"/>
<variablelist class="dbus-property" generated="True" extra-ref="ActivationDetails"/>
<variablelist class="dbus-property" generated="True" extra-ref="DebugInvocation"/>
<!--End of Autogenerated section-->
<refsect2>
<title>Methods</title>
<para><function>Start()</function>, <function>Stop()</function>, <function>Reload()</function>,
<function>Restart()</function>, <function>TryRestart()</function>,
<function>ReloadOrRestart()</function>, <function>ReloadOrTryRestart()</function>,
<function>Kill()</function>, <function>KillSubgroup()</function>, <function>QueueSignal()</function>,
<function>ResetFailed()</function>, and <function>SetProperties()</function> implement the same
operation as the respective methods on the <interfacename>Manager</interfacename> object (see
above). However, these methods operate on the unit object and hence do not take a unit name
parameter. Invoking the methods directly on the Manager object has the advantage of not requiring a
<function>GetUnit()</function> call to get the unit object for a specific unit name. Calling the
methods on the Manager object is hence a round trip optimization.</para>
</refsect2>
<refsect2>
<title>Properties</title>
<para><varname>Id</varname> contains the primary name of the unit.</para>
<para><varname>Names</varname> contains all names of the unit, including the primary name that is also
exposed in <varname>Id</varname>.</para>
<para><varname>Following</varname> either contains the empty string or contains the name of another
unit that this unit follows in state. This is used for some device units which reflect the unit state
machine of another unit, and which other unit this is might possibly change.</para>
<para><varname>Requires</varname>, <varname>RequiresOverridable</varname>,
<varname>Requisite</varname>, <varname>RequisiteOverridable</varname>, <varname>Wants</varname>,
<varname>BindsTo</varname>, <varname>RequiredBy</varname>, <varname>RequiredByOverridable</varname>,
<varname>WantedBy</varname>, <varname>BoundBy</varname>, <varname>Conflicts</varname>,
<varname>ConflictedBy</varname>, <varname>Before</varname>, <varname>After</varname>,
<varname>OnFailure</varname>, <varname>Triggers</varname>, <varname>TriggeredBy</varname>,
<varname>PropagatesReloadTo</varname>, and <varname>RequiresMountsFor</varname> contain arrays which encode
the dependencies and their inverse dependencies (where this applies) as configured in the unit file or
determined automatically.</para>
<para><varname>Description</varname> contains the human-readable description string for the
unit.</para>
<para><varname>SourcePath</varname> contains the path to a configuration file this unit is
automatically generated from in case it is not a native unit (in which case it contains the empty
string). For example, all mount units generated from <filename>/etc/fstab</filename> have this field
set to <filename>/etc/fstab</filename>.</para>
<para><varname>Documentation</varname> contains a string array with URLs of documentation for this
unit.</para>
<para><varname>LoadState</varname> contains a state value that reflects whether the configuration file
of this unit has been loaded. The following states are currently defined: <literal>loaded</literal>,
<literal>error</literal>, and <literal>masked</literal>. <literal>loaded</literal> indicates that the
configuration was successfully loaded. <literal>error</literal> indicates that the configuration failed
to load. The <varname>LoadError</varname> field (see below) contains information about the cause of
this failure. <literal>masked</literal> indicates that the unit is currently masked out (i.e. symlinked
to <filename>/dev/null</filename> or empty). Note that the <varname>LoadState</varname> is fully
orthogonal to the <varname>ActiveState</varname> (see below) as units without valid loaded
configuration might be active (because configuration might have been reloaded at a time where a unit
was already active).</para>
<para><varname>ActiveState</varname> contains a state value that reflects whether the unit is currently
active or not. The following states are currently defined:</para>
<xi:include href="unit-states.xml" xpointer="table"/>
<para><varname>SubState</varname> encodes states of the same state machine that
<varname>ActiveState</varname> covers, but knows more fine-grained states that are
unit-type-specific. Where <varname>ActiveState</varname> only covers eight high-level states,
<varname>SubState</varname> covers possibly many more low-level unit-type-specific states that are
mapped to the eight high-level states. Note that multiple low-level states might map to the same
high-level state, but not vice versa. Not all high-level states have low-level counterparts on all unit
types. At this point the low-level states are not documented here, and are more likely to be extended
later on than the common high-level states explained above.</para>
<para><varname>FragmentPath</varname> contains the unit file path this unit was read from, if there is
one (if not, it contains the empty string).</para>
<para><varname>UnitFileState</varname> encodes the install state of the unit file of
<varname>FragmentPath</varname>. It currently knows the following states: <literal>enabled</literal>,
<literal>enabled-runtime</literal>, <literal>linked</literal>, <literal>linked-runtime</literal>,
<literal>masked</literal>, <literal>masked-runtime</literal>, <literal>static</literal>,
<literal>disabled</literal>, and <literal>invalid</literal>. <literal>enabled</literal> indicates that a
unit file is permanently enabled. <literal>enable-runtime</literal> indicates the unit file is only
temporarily enabled and will no longer be enabled after a reboot (that means, it is enabled via
<filename>/run/</filename> symlinks, rather than <filename>/etc/</filename>). <literal>linked</literal>
indicates that a unit is linked into <filename>/etc/</filename> permanently. <literal>linked-runtime</literal>
indicates that a unit is linked into <filename>/run/</filename> temporarily (until the next
reboot). <literal>masked</literal> indicates that the unit file is masked permanently.
<literal>masked-runtime</literal> indicates that it is masked in <filename>/run/</filename> temporarily
(until the next reboot). <literal>static</literal> indicates that the unit is statically enabled, i.e.
always enabled and does not need to be enabled explicitly. <literal>invalid</literal> indicates that it
could not be determined whether the unit file is enabled.</para>
<para><varname>InactiveExitTimestamp</varname>, <varname>InactiveExitTimestampMonotonic</varname>,
<varname>ActiveEnterTimestamp</varname>, <varname>ActiveEnterTimestampMonotonic</varname>,
<varname>ActiveExitTimestamp</varname>, <varname>ActiveExitTimestampMonotonic</varname>,
<varname>InactiveEnterTimestamp</varname>, and <varname>InactiveEnterTimestampMonotonic</varname>
contain <constant>CLOCK_REALTIME</constant> and <constant>CLOCK_MONOTONIC</constant> 64-bit microsecond
timestamps of the last time a unit left the inactive state, entered the active state, exited the active
state, or entered an inactive state. These are the points in time where the unit transitioned
<literal>inactive</literal>/<literal>failed</literal> → <literal>activating</literal>,
<literal>activating</literal> → <literal>active</literal>, <literal>active</literal> →
<literal>deactivating</literal>, and finally <literal>deactivating</literal> →
<literal>inactive</literal>/<literal>failed</literal>. The fields are 0 in case such a transition has
not yet been recorded on this boot.</para>
<para><varname>CanStart</varname>, <varname>CanStop</varname>, and <varname>CanReload</varname> encode
as booleans whether the unit supports the start, stop or reload operations. Even if a unit supports
such an operation, the client might not necessary have the necessary privileges to execute them.</para>
<para><varname>CanIsolate</varname> encodes as a boolean whether the unit may be started in isolation
mode.</para>
<para><varname>Job</varname> encodes the job ID and job object path of the job currently scheduled or
executed for this unit, if there is any. If no job is scheduled or executed, the job id field will be
0.</para>
<para><varname>StopWhenUnneeded</varname>, <varname>RefuseManualStart</varname>,
<varname>RefuseManualStop</varname>, <varname>AllowIsolate</varname>,
<varname>DefaultDependencies</varname>, <varname>OnFailureIsolate</varname>,
<varname>IgnoreOnIsolate</varname>, <varname>IgnoreOnSnapshot</varname> map directly to the
corresponding configuration booleans in the unit file.</para>
<para><varname>NeedDaemonReload</varname> is a boolean that indicates whether the configuration file
this unit is loaded from (i.e. <varname>FragmentPath</varname> or <varname>SourcePath</varname>) has
changed since the configuration was read and hence whether a configuration reload is recommended.
</para>
<para><varname>Markers</varname> is an array of string flags that can be set using
<function>SetUnitProperties()</function> to indicate that the service should be reloaded or restarted.
Currently known values are <literal>needs-restart</literal>, <literal>needs-stop</literal>,
<literal>needs-start</literal> and <literal>needs-reload</literal>. Package scripts may use the first
three to mark units for later restart or start or stop when a new version of the package is installed
or removed. Configuration management scripts may use the fourth to mark units for a later reload when
the configuration is adjusted. Those flags are not set by the manager, except to unset as appropriate
when the unit is stopped, restarted, or reloaded. When markers are set, they are normalized according
to the following precedence rules, modeled after the job type merging logic. When new markers are
applied incrementally (using the <literal>+</literal> prefix), conflicting existing markers are
cleared before the new markers are merged in:
<itemizedlist>
<listitem><para><literal>needs-reload</literal> loses against all other markers. If any of
<literal>needs-restart</literal>, <literal>needs-start</literal>, or <literal>needs-stop</literal>
is set, <literal>needs-reload</literal> is cleared.</para></listitem>
<listitem><para><literal>needs-stop</literal> wins against <literal>needs-restart</literal> and
<literal>needs-reload</literal>, clearing both.</para></listitem>
<listitem><para><literal>needs-start</literal> wins against <literal>needs-stop</literal>, clearing
it.</para></listitem>
<listitem><para><literal>needs-restart</literal> wins against <literal>needs-start</literal>. If
both are set, <literal>needs-start</literal> is cleared.</para></listitem>
</itemizedlist>
For example, if a unit currently has <literal>needs-stop</literal> set and a new
<literal>+needs-start</literal> marker is applied, the existing <literal>needs-stop</literal> is
cleared and only <literal>needs-start</literal> remains. Conversely, applying
<literal>+needs-stop</literal> to any existing marker will clear all other markers, as
<literal>needs-stop</literal> takes precedence over <literal>needs-restart</literal> and
<literal>needs-reload</literal>, and the new marker clears conflicting existing ones.</para>
<para><varname>JobTimeoutUSec</varname> maps directly to the corresponding configuration setting in the
unit file.</para>
<para><varname>ConditionTimestamp</varname> and <varname>ConditionTimestampMonotonic</varname> contain
the <constant>CLOCK_REALTIME</constant>/<constant>CLOCK_MONOTONIC</constant> microsecond timestamps of
the last time the configured conditions of the unit have been checked or 0 if they have never been
checked. Conditions are checked when a unit is requested to start.</para>
<para><varname>ConditionResult</varname> contains the condition result of the last time the configured
conditions of this unit were checked. </para>
<para><varname>Conditions</varname> contains all configured conditions of the unit. For each condition,
five fields are given: condition type (e.g. <varname>ConditionPathExists</varname>), whether the
condition is a trigger condition, whether the condition is reversed, the right hand side of the
condition (e.g. the path in case of <varname>ConditionPathExists</varname>), and the status. The status
can be 0, in which case the condition has not been checked yet, a positive value, in which case the
condition passed, or a negative value, in which case the condition is not met. Currently only 0, +1, and -1
are used, but additional values may be used in the future, retaining the meaning of
zero/positive/negative values.</para>
<para><varname>LoadError</varname> contains a pair of strings. If the unit failed to load (as encoded
in <varname>LoadState</varname>, see above), then this will include a D-Bus error pair consisting of
the error ID and an explanatory human-readable string of what happened. If it loaded successfully, this
will be a pair of empty strings.</para>
<para><varname>Transient</varname> contains a boolean that indicates whether the unit was created as a
transient unit (i.e. via <function>StartTransientUnit()</function> on the manager object).</para>
<para><varname>ActivationDetails</varname> contains a list of string pairs, key and value, that
describe the event that caused the unit to be activated, if any. The key describes the information
(e.g.: <varname>trigger_unit</varname>, with value <varname>foo.service</varname>). This is only filled
in if the unit was triggered by a <varname>Path</varname> or <varname>Timer</varname> unit, and it is
only provided in a best effort fashion: it is not guaranteed to be set, and it is not guaranteed to be
the only trigger. It is only guaranteed to be a valid trigger that caused the activation job to be
enqueued and complete successfully. The key value pairs correspond (in lowercase) to the environment
variables described in the <literal>Environment Variables Set or Propagated by the Service
Manager</literal> section in
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note
that new key value pair may be added at any time in future versions. Existing entries will not be
removed.</para>
<para><varname>DebugInvocation</varname> contains a boolean that will change to
<constant>true</constant> when the unit is restarted with log level set to debug due to an earlier
failure, and will change back to <constant>false</constant> when either the unit successfully starts
or the restart rate limit is reached. See the <literal>RestartMode=</literal> section in
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more details.</para>
<para><varname>OOMKills</varname> contains a different value depending on whether
<varname>OOMPolicy=kill</varname> is enabled for the unit or not. If enabled, the property contains the
number of times the kernel OOM killer killed all the processes in the unit's cgroup and its
descendant cgroups. If disabled, the property contains the number of processes the kernel OOM killer
has killed in the unit's cgroup and its descendant cgroups. When the corresponding cgroups have not
been realized, it reports <constant>18446744073709551615</constant> (<constant>2^64 - 1</constant>).</para>
<para><varname>ManagedOOMKills</varname> contains the number of times <command>systemd-oomd</command>
killed all the processes in the unit's cgroup and its descendant cgroups. When the corresponding
cgroups have not been realized yet, it reports <constant>18446744073709551615</constant>
(<constant>2^64 - 1</constant>).</para>
</refsect2>
<refsect2>
<title>Security</title>
<para>Similarly to methods on the <interfacename>Manager</interfacename> object, read-only access is
allowed for everyone. All operations are allowed for clients when the
<interfacename>org.freedesktop.systemd1.manage-units</interfacename> privilege is granted by
polkit.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Service Unit Objects</title>
<para>All service unit objects implement the
<interfacename>org.freedesktop.systemd1.Service</interfacename> interface (described here) in addition to
the generic <interfacename>org.freedesktop.systemd1.Unit</interfacename> interface (see above).</para>
<programlisting executable="systemd" node="/org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice" interface="org.freedesktop.systemd1.Service">
node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice {
interface org.freedesktop.systemd1.Service {
methods:
BindMount(in s source,
in s destination,
in b read_only,
in b mkdir);
MountImage(in s source,
in s destination,
in b read_only,
in b mkdir,
in a(ss) options);
DumpFileDescriptorStore(out a(suuutuusu) entries);
GetProcesses(out a(sus) processes);
AttachProcesses(in s subcgroup,
in au pids);
RemoveSubgroup(in s subcgroup,
in t flags);
properties:
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s Type = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s ExitType = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s Restart = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s RestartMode = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s PIDFile = '...';
readonly s NotifyAccess = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t RestartUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly u RestartSteps = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t RestartMaxDelayUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t RestartRandomizedDelayUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t RestartUSecNext = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t TimeoutStartUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t TimeoutStopUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t TimeoutAbortUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s TimeoutStartFailureMode = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s TimeoutStopFailureMode = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t RuntimeMaxUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly t RuntimeRandomizedExtraUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t WatchdogUSec = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t WatchdogTimestamp = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t WatchdogTimestampMonotonic = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b RootDirectoryStartOnly = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b RemainAfterExit = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly b GuessMainPID = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly (aiai) RestartPreventExitStatus = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly (aiai) RestartForceExitStatus = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly (aiai) SuccessExitStatus = ...;
readonly u MainPID = ...;
readonly u ControlPID = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s BusName = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly u FileDescriptorStoreMax = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")