Expand description
Crate to manage and monitor services through systemctl
Homepage: https://github.com/gwbres/systemctl
§systemctl
Small rust crate to interact with systemd units through systemctl
.
At the time I needed those features, I was not aware of zbus-systemd
, which is now available and should be prefered.
This crate uses systemctl
interaction directly, which is far from ideal for applications.
zbus-systemd
should therefore be prefered.
§Features
- serde: Enable to make structs in this crate De-/Serializable
§Limitations
Currently, systemd Version <245 are not supported as unit-file-list changed from two column to three column setup. See: systemd Changelog
§Unit / service operation
Nominal service operations:
let systemctl = systemctl::SystemCtl::default();
systemctl.stop("systemd-journald.service")
.unwrap();
systemctl.restart("systemd-journald.service")
.unwrap();
if let Ok(true) = systemctl.exists("ntpd") {
let is_active = systemctl.is_active("ntpd")
.unwrap();
}
§Service enumeration
let systemctl = systemctl::SystemCtl::default();
// list all units
systemctl.list_units(None, None, None);
// list all services
// by adding a --type filter
systemctl.list_units(Some("service"), None, None);
// list all services currently `enabled`
// by adding a --state filter
systemctl.list_units(Some("service"), Some("enabled"), None);
// list all services starting with cron
systemctl.list_units(Some("service"), None, Some("cron*"));
// Check if a unit is active
systemctl.get_active_state("service");
// list dependencies of a service or target
systemctl.list_dependencies("some.target");
§Unit structure
Use the unit structure for more information
let systemctl = systemctl::SystemCtl::default();
let unit = systemctl.create_unit("ssh.service")
.unwrap();
systemctl.restart(&unit.name).unwrap();
println!("active: {}", unit.active);
println!("preset: {}", unit.preset);
if let Some(docs) = unit.docs { // doc pages available
for doc in docs {
if let Some(page) = doc.as_man() {
// `man` page exists
}
if let Some(url) = doc.as_url() {
// `url` is indicated
}
}
}
println!("auto_start (enabled): {:?}", unit.auto_start);
println!("config script : {}", unit.script);
println!("pid: {:?}", unit.pid);
println!("Running task(s): {:?}", unit.tasks);
println!("Memory consumption: {:?}", unit.memory);
§TODO
-
parse all known attributes in
from_systemctl
Structs§
- System
Ctl - Struct with API calls to systemctl.
- System
CtlBuilder - Use builder syntax to set the required parameters and finish by calling the method
Self::build()
. - Unit
- Structure to describe a systemd
unit
- Unit
List - Implementation of list generated with
systemctl list-unit-files
- Unit
Service - Implementation of list generated with
systemctl list-units
Enums§
- Active
State ActiveState
describes a Unit’s current active state- Auto
Start Status AutoStartStatus
describes the Unit current state- Doc
- Doc describes types of documentation possibly
available for a systemd
unit
- Loaded
State LoadedState
describes a Unit’s current loaded state- Service
Property - Type
Type
describes a Unit declaration Type in systemd