dbus

func (*Conn) Close ¶

func (c *Conn) Close()

Close closes an established connection.

func (*Conn) Connected ¶ added in v22.4.0

func (c *Conn) Connected() bool

Connected returns whether conn is connected

func (*Conn) DisableUnitFilesContext ¶ added in v22.2.0

func (c *Conn) DisableUnitFilesContext(ctx context.Context, files []string, runtime bool) ([]DisableUnitFileChange, error)

DisableUnitFilesContext may be used to disable one or more units in the system (by removing symlinks to them from /etc or /run).

It takes a list of unit files to disable (either just file names or full absolute paths if the unit files are residing outside the usual unit search paths), and one boolean: whether the unit was enabled for runtime only (true, /run), or persistently (false, /etc).

This call returns an array with the changes made. The changes list consists of structures with three strings: the type of the change (one of symlink or unlink), the file name of the symlink and the destination of the symlink.

func (*Conn) EnableUnitFilesContext ¶ added in v22.2.0

func (c *Conn) EnableUnitFilesContext(ctx context.Context, files []string, runtime bool, force bool) (bool, []EnableUnitFileChange, error)

EnableUnitFilesContext may be used to enable one or more units in the system (by creating symlinks to them in /etc or /run).

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, /run), or persistently (false, /etc). The second one controls whether symlinks pointing to other units shall be replaced if necessary.

This call returns one boolean and an array with the changes made. The boolean signals whether the unit files contained any enablement information (i.e. an [Install]) section. The changes list consists of structures with three strings: the type of the change (one of symlink or unlink), the file name of the symlink and the destination of the symlink.

func (*Conn) FreezeUnit ¶ added in v22.4.0

func (c *Conn) FreezeUnit(ctx context.Context, unit string) error

Freeze the cgroup associated with the unit. Note that FreezeUnit and ThawUnit are only supported on systems running with cgroup v2.

func (*Conn) GetAllPropertiesContext ¶ added in v22.2.0

func (c *Conn) GetAllPropertiesContext(ctx context.Context, unit string) (map[string]interface{}, error)

GetAllPropertiesContext takes the (unescaped) unit name and returns all of its dbus object properties.

func (*Conn) GetManagerProperty ¶

func (c *Conn) GetManagerProperty(prop string) (string, error)

GetManagerProperty returns the value of a property on the org.freedesktop.systemd1.Manager interface. The value is returned in its string representation, as defined at https://developer.gnome.org/glib/unstable/gvariant-text.html.

func (*Conn) GetServicePropertyContext ¶ added in v22.2.0

func (c *Conn) GetServicePropertyContext(ctx context.Context, service string, propertyName string) (*Property, error)

GetServiceProperty returns property for given service name and property name.

func (*Conn) GetUnitByPID ¶ added in v22.4.0

func (c *Conn) GetUnitByPID(ctx context.Context, pid uint32) (dbus.ObjectPath, error)

GetUnitByPID returns 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

func (*Conn) GetUnitNameByPID ¶ added in v22.4.0

func (c *Conn) GetUnitNameByPID(ctx context.Context, pid uint32) (string, error)

GetUnitNameByPID returns the name 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

func (*Conn) GetUnitPathPropertiesContext ¶ added in v22.2.0

func (c *Conn) GetUnitPathPropertiesContext(ctx context.Context, path dbus.ObjectPath) (map[string]interface{}, error)

GetUnitPathPropertiesContext takes the (escaped) unit path and returns all of its dbus object properties.

func (*Conn) GetUnitPropertiesContext ¶ added in v22.2.0

func (c *Conn) GetUnitPropertiesContext(ctx context.Context, unit string) (map[string]interface{}, error)

GetUnitPropertiesContext takes the (unescaped) unit name and returns all of its dbus object properties.

func (*Conn) GetUnitPropertyContext ¶ added in v22.2.0

func (c *Conn) GetUnitPropertyContext(ctx context.Context, unit string, propertyName string) (*Property, error)

GetUnitPropertyContext takes an (unescaped) unit name, and a property name, and returns the property value.

func (*Conn) GetUnitTypePropertiesContext ¶ added in v22.2.0

func (c *Conn) GetUnitTypePropertiesContext(ctx context.Context, unit string, unitType string) (map[string]interface{}, error)

GetUnitTypePropertiesContext returns the extra properties for a unit, specific to the unit type. Valid values for unitType: Service, Socket, Target, Device, Mount, Automount, Snapshot, Timer, Swap, Path, Slice, Scope. Returns "dbus.Error: Unknown interface" error if the unitType is not the correct type of the unit.

func (*Conn) GetUnitTypePropertyContext ¶ added in v22.2.0

func (c *Conn) GetUnitTypePropertyContext(ctx context.Context, unit string, unitType string, propertyName string) (*Property, error)

GetUnitTypePropertyContext takes a property name, a unit name, and a unit type, and returns a property value. For valid values of unitType, see GetUnitTypePropertiesContext.

func (*Conn) KillUnitContext ¶ added in v22.2.0

func (c *Conn) KillUnitContext(ctx context.Context, name string, signal int32)

KillUnitContext takes the unit name and a UNIX signal number to send. All of the unit's processes are killed.

func (*Conn) KillUnitWithTarget ¶ added in v22.3.0

func (c *Conn) KillUnitWithTarget(ctx context.Context, name string, target Who, signal int32) error

KillUnitWithTarget is like KillUnitContext, but allows you to specify which process in the unit to send the signal to.

func (*Conn) LinkUnitFilesContext ¶ added in v22.2.0

func (c *Conn) LinkUnitFilesContext(ctx context.Context, files []string, runtime bool, force bool) ([]LinkUnitFileChange, error)

LinkUnitFilesContext links unit files (that are located outside of the usual unit search paths) into the unit search path.

It takes a list of absolute paths to unit files to link and two booleans.

The first boolean controls whether the unit shall be enabled for runtime only (true, /run), or persistently (false, /etc).

The second controls whether symlinks pointing to other units shall be replaced if necessary.

This call returns a list of the changes made. The list consists of structures with three strings: the type of the change (one of symlink or unlink), the file name of the symlink and the destination of the symlink.

func (*Conn) ListJobsContext ¶ added in v22.2.0

func (c *Conn) ListJobsContext(ctx context.Context) ([]JobStatus, error)

ListJobsContext returns an array with all currently queued jobs.

func (*Conn) ListUnitFilesByPatternsContext ¶ added in v22.2.0

func (c *Conn) ListUnitFilesByPatternsContext(ctx context.Context, states []string, patterns []string) ([]UnitFile, error)

ListUnitFilesByPatternsContext returns an array of all available units on disk matched the patterns.

func (*Conn) ListUnitFilesContext ¶ added in v22.2.0

func (c *Conn) ListUnitFilesContext(ctx context.Context) ([]UnitFile, error)

ListUnitFiles returns an array of all available units on disk.

func (*Conn) ListUnitsByNamesContext ¶ added in v22.2.0

func (c *Conn) ListUnitsByNamesContext(ctx context.Context, units []string) ([]UnitStatus, error)

ListUnitsByNamesContext returns an array with units. It takes a list of units' names and returns an UnitStatus array. Comparing to ListUnitsByPatternsContext method, this method returns statuses even for inactive or non-existing units. Input array should contain exact unit names, but not patterns.

Requires systemd v230 or higher.

func (*Conn) ListUnitsByPatternsContext ¶ added in v22.2.0

func (c *Conn) ListUnitsByPatternsContext(ctx context.Context, states []string, patterns []string) ([]UnitStatus, error)

ListUnitsByPatternsContext returns an array with units. It takes a list of units' statuses and names to filter. 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.

func (*Conn) ListUnitsContext ¶ added in v22.2.0

func (c *Conn) ListUnitsContext(ctx context.Context) ([]UnitStatus, error)

ListUnitsContext returns an array with 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. Also note that a unit is only loaded if it is active and/or enabled. Units that are both disabled and inactive will thus not be returned.

func (*Conn) ListUnitsFilteredContext ¶ added in v22.2.0

func (c *Conn) ListUnitsFilteredContext(ctx context.Context, states []string) ([]UnitStatus, error)

ListUnitsFilteredContext returns an array with units filtered by state. It takes a list of units' statuses to filter.

func (*Conn) MaskUnitFilesContext ¶ added in v22.2.0

func (c *Conn) MaskUnitFilesContext(ctx context.Context, files []string, runtime bool, force bool) ([]MaskUnitFileChange, error)

MaskUnitFilesContext masks one or more units in the system.

The files argument contains a list of units to mask (either just file names or full absolute paths if the unit files are residing outside the usual unit search paths).

The runtime argument is used to specify whether the unit was enabled for runtime only (true, /run/systemd/..), or persistently (false, /etc/systemd/..).

func (*Conn) NewSubscriptionSet ¶

func (conn *Conn) NewSubscriptionSet() *SubscriptionSet

NewSubscriptionSet returns a new subscription set.

func (*Conn) ReloadContext ¶ added in v22.2.0

func (c *Conn) ReloadContext(ctx context.Context) error

ReloadContext instructs systemd to scan for and reload unit files. This is an equivalent to systemctl daemon-reload.

func (*Conn) ReloadOrRestartUnitContext ¶ added in v22.2.0

func (c *Conn) ReloadOrRestartUnitContext(ctx context.Context, name string, mode string, ch chan<- string) (int, error)

ReloadOrRestartUnitContext attempts a reload if the unit supports it and use a restart otherwise.

func (*Conn) ReloadOrTryRestartUnitContext ¶ added in v22.2.0

func (c *Conn) ReloadOrTryRestartUnitContext(ctx context.Context, name string, mode string, ch chan<- string) (int, error)

ReloadOrTryRestartUnitContext attempts a reload if the unit supports it, and use a "Try" flavored restart otherwise.

func (*Conn) ReloadUnitContext ¶ added in v22.2.0

func (c *Conn) ReloadUnitContext(ctx context.Context, name string, mode string, ch chan<- string) (int, error)

ReloadUnitContext reloads a unit. Reloading is done only if the unit is already running, and fails otherwise.

func (*Conn) ResetFailedUnitContext ¶ added in v22.2.0

func (c *Conn) ResetFailedUnitContext(ctx context.Context, name string) error

ResetFailedUnitContext resets the "failed" state of a specific unit.

func (*Conn) RestartUnitContext ¶ added in v22.2.0

func (c *Conn) RestartUnitContext(ctx context.Context, name string, mode string, ch chan<- string) (int, error)

RestartUnitContext restarts a service. If a service is restarted that isn't running it will be started.

func (*Conn) SetPropertiesSubscriber ¶

func (c *Conn) SetPropertiesSubscriber(updateCh chan<- *PropertiesUpdate, errCh chan<- error)

SetPropertiesSubscriber writes to updateCh when any unit's properties change. Every property change reported by systemd will be sent; that is, no transitions will be "missed" (as they might be with SetSubStateSubscriber). However, state changes will only be written to the channel with non-blocking writes. If updateCh is full, it attempts to write an error to errCh; if errCh is full, the error passes silently.

func (*Conn) SetSubStateSubscriber ¶

func (c *Conn) SetSubStateSubscriber(updateCh chan<- *SubStateUpdate, errCh chan<- error)

SetSubStateSubscriber writes to updateCh when any unit's substate changes. Although this writes to updateCh on every state change, the reported state may be more recent than the change that generated it (due to an unavoidable race in the systemd dbus interface). That is, this method provides a good way to keep a current view of all units' states, but is not guaranteed to show every state transition they go through. Furthermore, state changes will only be written to the channel with non-blocking writes. If updateCh is full, it attempts to write an error to errCh; if errCh is full, the error passes silently.

func (*Conn) SetUnitPropertiesContext ¶ added in v22.2.0

func (c *Conn) SetUnitPropertiesContext(ctx context.Context, name string, runtime bool, properties ...Property) error

SetUnitPropertiesContext 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 in systemd.cgroup(5)) may. The changes are applied instantly, and stored on disk for future boots, unless runtime is true, in which case the settings only apply until the next reboot. name is the name of the unit to modify. properties are the settings to set, encoded as an array of property name and value pairs.

func (*Conn) StartTransientUnitContext ¶ added in v22.2.0

func (c *Conn) StartTransientUnitContext(ctx context.Context, name string, mode string, properties []Property, ch chan<- string) (int, error)

StartTransientUnitContext 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. name is the unit name including suffix, and must be unique. mode is the same as in StartUnitContext, properties contains properties of the unit.

func (*Conn) StartUnitContext ¶ added in v22.2.0

func (c *Conn) StartUnitContext(ctx context.Context, name string, mode string, ch chan<- string) (int, error)

StartUnitContext enqueues a start job and depending jobs, if any (unless otherwise specified by the mode string).

Takes the unit to activate, plus a mode string. The mode needs to be one of replace, fail, isolate, ignore-dependencies, ignore-requirements. If "replace" the call will start the unit and its dependencies, possibly replacing already queued jobs that conflict with this. If "fail" the call will start the unit and its dependencies, but will fail if this would change an already queued job. If "isolate" the call will start the unit in question and terminate all units that aren't dependencies of it. If "ignore-dependencies" it will start a unit but ignore all its dependencies. If "ignore-requirements" it will start a unit but only ignore the requirement dependencies. It is not recommended to make use of the latter two options.

If the provided channel is non-nil, a result string will be sent to it upon job completion: one of done, canceled, timeout, failed, dependency, skipped. done indicates successful execution of a job. canceled indicates that a job has been canceled before it finished execution. timeout indicates that the job timeout was reached. failed indicates that the job failed. dependency indicates that a job this job has been depending on failed and the job hence has been removed too. skipped indicates that a job was skipped because it didn't apply to the units current state.

If no error occurs, the ID of the underlying systemd job will be returned. There does exist the possibility for no error to be returned, but for the returned job ID to be 0. In this case, the actual underlying ID is not 0 and this datapoint should not be considered authoritative.

If an error does occur, it will be returned to the user alongside a job ID of 0.

func (*Conn) StopUnitContext ¶ added in v22.2.0

func (c *Conn) StopUnitContext(ctx context.Context, name string, mode string, ch chan<- string) (int, error)

StopUnitContext is similar to StartUnitContext, but stops the specified unit rather than starting it.

func (*Conn) Subscribe ¶

func (c *Conn) Subscribe() error

Subscribe sets up this connection to subscribe to all systemd dbus events. This is required before calling SubscribeUnits. When the connection closes systemd will automatically stop sending signals so there is no need to explicitly call Unsubscribe().

func (*Conn) SubscribeUnits ¶

func (c *Conn) SubscribeUnits(interval time.Duration) (<-chan map[string]*UnitStatus, <-chan error)

SubscribeUnits returns two unbuffered channels which will receive all changed units every interval. Deleted units are sent as nil.

func (*Conn) SubscribeUnitsCustom ¶

func (c *Conn) SubscribeUnitsCustom(interval time.Duration, buffer int, isChanged func(*UnitStatus, *UnitStatus) bool, filterUnit func(string) bool) (<-chan map[string]*UnitStatus, <-chan error)

SubscribeUnitsCustom is like SubscribeUnits but lets you specify the buffer size of the channels, the comparison function for detecting changes and a filter function for cutting down on the noise that your channel receives.

func (*Conn) SystemStateContext ¶ added in v22.2.0

func (c *Conn) SystemStateContext(ctx context.Context) (*Property, error)

SystemStateContext returns the systemd state. Equivalent to systemctl is-system-running.

func (*Conn) ThawUnit ¶ added in v22.4.0

func (c *Conn) ThawUnit(ctx context.Context, unit string) error

Unfreeze the cgroup associated with the unit.

func (*Conn) TryRestartUnitContext ¶ added in v22.2.0

func (c *Conn) TryRestartUnitContext(ctx context.Context, name string, mode string, ch chan<- string) (int, error)

TryRestartUnitContext is like RestartUnitContext, except that a service that isn't running is not affected by the restart.

func (*Conn) UnmaskUnitFilesContext ¶ added in v22.2.0

func (c *Conn) UnmaskUnitFilesContext(ctx context.Context, files []string, runtime bool) ([]UnmaskUnitFileChange, error)

UnmaskUnitFilesContext unmasks one or more units in the system.

It takes the list of unit files to mask (either just file names or full absolute paths if the unit files are residing outside the usual unit search paths), and a boolean runtime flag to specify whether the unit was enabled for runtime only (true, /run/systemd/..), or persistently (false, /etc/systemd/..).

func (*Conn) Unsubscribe ¶

func (c *Conn) Unsubscribe() error

Unsubscribe this connection from systemd dbus events.

func (SubscriptionSet) Add ¶

func (s SubscriptionSet) Add(value string)

func (SubscriptionSet) Contains ¶

func (s SubscriptionSet) Contains(value string) (exists bool)

func (SubscriptionSet) Length ¶

func (s SubscriptionSet) Length() int

func (SubscriptionSet) Remove ¶

func (s SubscriptionSet) Remove(value string)

func (*SubscriptionSet) Subscribe ¶

func (s *SubscriptionSet) Subscribe() (<-chan map[string]*UnitStatus, <-chan error)

Subscribe starts listening for dbus events for all of the units in the set. Returns channels identical to conn.SubscribeUnits.

func (SubscriptionSet) Values ¶

func (s SubscriptionSet) Values() (values []string)