Config::Model::Systemd - Editor and validator for systemd configuration files
version 0.254.1
# run on one service: $ sudo cme <cmd> systemd-service <name> # run command on name.service $ sudo cme <cmd> systemd-socket <name> # run command on name.socket $ sudo cme <cmd> systemd-timer <name> # run command on name.timer # run on several user units: # Run on several units: $ sudo cme <cmd> systemd * # run command on all units $ sudo cme <cmd> systemd <pattern> # run command on all units matching pattern $ sudo cme <cmd> systemd <pattern> # run command on all units matching pattern $ cme <cmd> systemd-user <pattern> # run command on all user units matching pattern # run on one service file (for unit development): $ sudo cme <cmd> systemd-service-file <file-name> $ sudo cme <cmd> systemd-socket-file <file-name> $ sudo cme <cmd> systemd-timer-file <file-name>
This module provides (with cme) a configuration editor for the configuration files of systemd, i.e. all files in ~/.config/systemd/user/ or all files in /etc/systemd/system/
~/.config/systemd/user/
/etc/systemd/system/
Ok. I simplified. In more details, this module provides the configuration models of Systemd configuration file that cme, Config::Model and Config::Model::TkUI use to provide a configuration editor (cme edit) and checker (cme check).
cme edit
cme check
The following command loads user systemd files (from ~/.config/systemd/user/ and launch a graphical editor:
cme edit systemd-user foo
Likewise, the following command loads system systemd configuration files and launch a graphical editor to updated an override file (like systemctl edit command):
systemctl edit
sudo cme edit systemd foo
A developer can also edit a systemd file shipped with a software:
cme edit systemd-service-file software-thing.service
You can also use cme to run sanity checks on systemd configuration files:
cme check systemd-user '*' cme check systemd '*' # may take time cme check systemd-service foo cme check systemd-service-file software-thing.service
As of Config::Model 2.086, a "cme(...)" in cme function is exported to modify configuration in a Perl program. For instance:
use Config::Model qw/cme/; # also import cme function # call cme for systemd-user, modify ans save my-imap-tunnel.socket file. cme( application => 'systemd-user', backend_arg => 'my-imap-tunnel' )->modify('socket:my-imap-tunnel Socket Accept=yes') ;
Similarly, system Systemd files can be modified using systemd application:
systemd
use Config::Model qw/cme/; cme( application => 'systemd', backend_arg => 'foo' )->modify(...) ;
For more details and parameters, please see cme, modify, load and save documentation.
The examples below require App::Cme
Dump override content of a specific service:
$ cme dump systemd-service transmission-daemon Reading unit 'service' 'transmission-daemon' from '/lib/systemd/system/transmission-daemon.service'. --- Unit: After: - network-online.target - remote-fs.target Before: - umount.target Conflicts: - umount.target
Dump the whole service (like systemctl cat):
systemctl cat
$ cme dump systemd-service transmission-daemon --dumptype full Reading unit 'service' 'transmission-daemon' from '/lib/systemd/system/transmission-daemon.service'. --- Install: WantedBy: - multi-user.target Service: CPUShares: 1024 CPUWeight: 100 ExecReload: - /bin/kill -s HUP $MAINPID ExecStart: - /usr/bin/transmission-daemon -f --log-error [etc...]
Edit the service override with a GUI:
$ cme edit systemd-service transmission-daemon.service
Edit the service override with a Shell UI:
$ cme shell systemd-service transmission-daemon.service >:$ ls Service Unit Install >:$ cd Unit >: Unit $ ll -nz name │ type │ value ──────────┼──────┼─────────────────────────────────────── Conflicts │ list │ umount.target Before │ list │ umount.target After │ list │ network-online.target,remote-fs.target >: Unit $ set After:.push(foo.target) >: Unit $ ll -nz name │ type │ value ──────────┼──────┼────────────────────────────────────────────────── Conflicts │ list │ umount.target Before │ list │ umount.target After │ list │ network-online.target,remote-fs.target,foo.target
Run command all user units:
$ cme edit systemd-user '*' $ cme check systemd-user '*'
Run command all user units that match 'foo':
$ cme edit systemd-user foo $ cme check systemd-user foo
Check all root units (can be quite long on small systems):
# cme check systemd '*'
Check all root units that match 'foo':
# cme check systemd foo
Edit override file of foo.service:
foo.service
# cme edit systemd foo.service
Run command on a service file:
$ cme check systemd-service path/to/file.service $ cme edit systemd-service path/to/file.service
Timer and socket units are also supported:
$ cme check systemd-socket path/to/file.socket $ cme check systemd-timer path/to/file.timer
use Config::Model qw/cme/; cme(application => 'systemd-user' backend_arg => 'free-imap-tunnel') ->modify('socket:free-imap-tunnel Socket Accept=yes') ; cme(application => 'systemd-service', config_file => 'foo.service') ->modify('Unit Description="a service that does foo things"')
The list of supported parameters is extracted from the xml documentation provided by systemd project. This list is expected to be rather complete.
The properties of these parameters are inferred from the description of the parameters and are probably less accurate. In case of errors, please log a bug.
For now, only unit, socket and service files are supported. Please log a wishlist bug if you need other unit types to be supported.
unit
socket
service
In case of issue, please log a bug on https://github.com/dod38fr/config-model-systemd/issues.
Mohammad S Anwar
Thanks for your contributions
cme
Config::Model
http://github.com/dod38fr/config-model/wiki/Using-config-model
Dominique Dumont
This software is Copyright (c) 2008-2022 by Dominique Dumont.
This is free software, licensed under:
The GNU Lesser General Public License, Version 2.1, February 1999
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
http://cpants.cpanauthors.org/dist/Config-Model-Systemd
CPAN Testers
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.
http://www.cpantesters.org/distro/C/Config-Model-Systemd
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
http://matrix.cpantesters.org/?dist=Config-Model-Systemd
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
http://deps.cpantesters.org/?module=Config::Model::Systemd
Please report any bugs or feature requests by email to ddumont at cpan.org, or through the web interface at https://github.com/dod38fr/config-model-systemd/issues. You will be automatically notified of any progress on the request by the system.
ddumont at cpan.org
The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)
http://github.com/dod38fr/config-model-systemd
git clone git://github.com/dod38fr/config-model-systemd.git
To install Config::Model::Systemd, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Config::Model::Systemd
CPAN shell
perl -MCPAN -e shell install Config::Model::Systemd
For more information on module installation, please visit the detailed CPAN module installation guide.