REFERENCE.md

Reference

Table of Contents

Classes

• dbus: Installs and manages D-Bus.
• dbus::config
• dbus::install
• dbus::reload
• dbus::service

Defined types

• dbus::session: Manage per-application session bus configuration.
• dbus::system: Manage per-application system bus configuration.

Classes

dbus

Installs and manages D-Bus.

• See also
  • puppet_defined_types::dbus::session
    • dbus::session
  • puppet_defined_types::dbus::system
    • dbus::system

Examples

Declaring the class

include dbus

Parameters

The following parameters are available in the dbus class:

• conf_dir
• local_session_conf
• local_system_conf
• package_name
• purge_session_dir
• purge_system_dir
• service_name
• service_restart
• session_conf
• session_dir
• system_conf
• system_dir
• validate

conf_dir

Data type: Stdlib::Absolutepath

Top-level configuration directory, usually /etc/dbus-1.

local_session_conf

Data type: Stdlib::Absolutepath

The configuration file used to override the default session bus configuration, usually /etc/dbus-1/session-local.conf.

local_system_conf

Data type: Stdlib::Absolutepath

The configuration file used to override the default system bus configuration, usually /etc/dbus-1/system-local.conf.

package_name

Data type: String

The name of the package.

purge_session_dir

Data type: Boolean

Whether to purge any unmanaged session bus configuration files.

purge_system_dir

Data type: Boolean

Whether to purge any unmanaged system bus configuration files.

service_name

Data type: String

The name of the service.

service_restart

Data type: String

The command used to get dbus-daemon to reload its configuration, which is usually dbus-send --system --type=method_call --dest=org.freedesktop.DBus / org.freedesktop.DBus.ReloadConfig. On platforms that use systemd, this is what the unit does anyway and so will rely on that where possible.

session_conf

Data type: Stdlib::Absolutepath

The configuration file containing the default session bus configuration, usually /etc/dbus-1/session.conf.

session_dir

Data type: Stdlib::Absolutepath

The directory used by applications to add additional session bus configuration, usually /etc/dbus-1/session.d.

system_conf

Data type: Stdlib::Absolutepath

The configuration file containing the default system bus configuration, usually /etc/dbus-1/system.conf.

system_dir

Data type: Stdlib::Absolutepath

The directory used by applications to add additional system bus configuration, usually /etc/dbus-1/system.d.

validate

Data type: Boolean

Whether to validate the XML configuration files prior to installing them.

dbus::config

The dbus::config class.

dbus::install

The dbus::install class.

dbus::reload

The dbus::reload class.

dbus::service

The dbus::service class.

Defined types

dbus::session

Manage per-application session bus configuration.

• See also
  • puppet_classes::dbus
    • dbus

Examples

include dbus
dbus::session { 'example':
  content => file('example/example.conf'),
}

Parameters

The following parameters are available in the dbus::session defined type:

• content
• application

content

Data type: String

The contents of the file.

application

Data type: String

Used to construct the filename.

Default value: $title

dbus::system

Manage per-application system bus configuration.

• See also
  • puppet_classes::dbus
    • dbus

Examples

include dbus
dbus::system { 'example':
  content => file('example/example.conf'),
}

Parameters

The following parameters are available in the dbus::system defined type:

• content
• application

content

Data type: String

The contents of the file.

application

Data type: String

Used to construct the filename.

Default value: $title