Skip to content

Client API

AsyncSystemdClient

systemd_client.client.AsyncSystemdClient

Async-first systemd client for user or system services.

Source code in src/systemd_client/client.py 
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
class AsyncSystemdClient:
    """Async-first systemd client for user or system services."""

    def __init__(
        self,
        backend: BackendType = BackendType.AUTO,
        scope: SystemdScope = SystemdScope.USER,
    ) -> None:
        self._scope = scope
        self._backend_type = backend
        self._backend: AbstractBackend = get_backend(backend, scope=scope)
        self._journal = AsyncJournalReader(scope=scope)

    async def __aenter__(self) -> AsyncSystemdClient:
        return self

    async def __aexit__(
        self,
        exc_type: type[BaseException] | None,
        exc_val: BaseException | None,
        exc_tb: TracebackType | None,
    ) -> None:
        await self.close()

    async def close(self) -> None:
        """Release backend resources."""
        await self._backend.close()

    def __repr__(self) -> str:
        return (
            f"{self.__class__.__name__}("
            f"backend={self._backend_type!r}, scope={self._scope!r})"
        )

    async def list_units(
        self,
        unit_type: str | None = None,
        state: str | None = None,
    ) -> list[UnitInfo]:
        """List systemd units."""
        return await self._backend.list_units(unit_type=unit_type, state=state)

    async def list_unit_files(
        self,
        unit_type: str | None = None,
        state: str | None = None,
    ) -> list[UnitFileInfo]:
        """List installed unit files."""
        return await self._backend.list_unit_files(unit_type=unit_type, state=state)

    async def status(self, unit_name: str) -> UnitStatus:
        """Get detailed status of a unit."""
        return await self._backend.get_unit_status(unit_name)

    async def cat(self, unit_name: str) -> str:
        """Show the content of a unit file."""
        return await self._backend.cat(unit_name)

    async def start(self, unit_name: str, no_block: bool = False) -> None:
        """Start a unit."""
        await self._backend.start_unit(unit_name, no_block=no_block)

    async def stop(self, unit_name: str, no_block: bool = False) -> None:
        """Stop a unit."""
        await self._backend.stop_unit(unit_name, no_block=no_block)

    async def restart(self, unit_name: str, no_block: bool = False) -> None:
        """Restart a unit."""
        await self._backend.restart_unit(unit_name, no_block=no_block)

    async def reload(self, unit_name: str, no_block: bool = False) -> None:
        """Reload a unit."""
        await self._backend.reload_unit(unit_name, no_block=no_block)

    async def try_restart(self, unit_name: str, no_block: bool = False) -> None:
        """Restart a unit if it is active, otherwise do nothing."""
        await self._backend.try_restart_unit(unit_name, no_block=no_block)

    async def reload_or_restart(self, unit_name: str, no_block: bool = False) -> None:
        """Reload a unit if it supports it, otherwise restart."""
        await self._backend.reload_or_restart_unit(unit_name, no_block=no_block)

    async def start_units(self, unit_names: list[str], no_block: bool = False) -> None:
        """Start multiple units in a single operation."""
        await self._backend.start_units(unit_names, no_block=no_block)

    async def stop_units(self, unit_names: list[str], no_block: bool = False) -> None:
        """Stop multiple units in a single operation."""
        await self._backend.stop_units(unit_names, no_block=no_block)

    async def restart_units(self, unit_names: list[str], no_block: bool = False) -> None:
        """Restart multiple units in a single operation."""
        await self._backend.restart_units(unit_names, no_block=no_block)

    async def enable(self, unit_name: str) -> EnableResult:
        """Enable a unit."""
        return await self._backend.enable_unit(unit_name)

    async def disable(self, unit_name: str) -> EnableResult:
        """Disable a unit."""
        return await self._backend.disable_unit(unit_name)

    async def mask(self, unit_name: str) -> EnableResult:
        """Mask a unit."""
        return await self._backend.mask_unit(unit_name)

    async def unmask(self, unit_name: str) -> EnableResult:
        """Unmask a unit."""
        return await self._backend.unmask_unit(unit_name)

    async def is_active(self, unit_name: str) -> bool:
        """Check if a unit is active."""
        return await self._backend.is_active(unit_name)

    async def is_enabled(self, unit_name: str) -> bool:
        """Check if a unit is enabled."""
        return await self._backend.is_enabled(unit_name)

    async def is_failed(self, unit_name: str) -> bool:
        """Check if a unit is in failed state."""
        return await self._backend.is_failed(unit_name)

    async def daemon_reload(self) -> None:
        """Reload the systemd daemon configuration."""
        await self._backend.daemon_reload()

    async def reset_failed(self, unit_name: str | None = None) -> None:
        """Reset the failed state of a unit, or all units if no name given."""
        await self._backend.reset_failed(unit_name)

    async def set_property(self, unit_name: str, properties: dict[str, str]) -> None:
        """Set runtime properties on a unit (cgroup limits, etc.)."""
        await self._backend.set_property(unit_name, properties)

    async def get_resource_usage(self, unit_name: str) -> ResourceUsage:
        """Get resource usage statistics for a unit."""
        return await self._backend.get_resource_usage(unit_name)

    async def list_timers(self) -> list[TimerInfo]:
        """List active timers."""
        return await self._backend.list_timers()

    async def list_sockets(self) -> list[SocketInfo]:
        """List active sockets."""
        return await self._backend.list_sockets()

    async def list_dependencies(self, unit_name: str) -> list[str]:
        """List dependency tree of a unit."""
        return await self._backend.list_dependencies(unit_name)

    async def kill(self, unit_name: str, signal: str = "SIGTERM") -> None:
        """Send a signal to a unit's processes."""
        await self._backend.kill_unit(unit_name, signal)

    async def run(
        self,
        command: str | list[str],
        *,
        name: str | None = None,
        wait: bool = False,
        properties: dict[str, str] | None = None,
        remain_after_exit: bool = False,
    ) -> TransientResult:
        """Run a command as a transient systemd service (systemd-run)."""
        cmd = [command] if isinstance(command, str) else command
        return await self._backend.run_transient(
            cmd, name=name, wait=wait, properties=properties,
            remain_after_exit=remain_after_exit,
        )

    async def run_on_calendar(
        self,
        on_calendar: str,
        command: str | list[str],
        *,
        name: str | None = None,
    ) -> TransientResult:
        """Schedule a command as a transient timer (systemd-run --on-calendar)."""
        cmd = [command] if isinstance(command, str) else command
        return await self._backend.run_transient_timer(
            cmd, on_calendar=on_calendar, name=name,
        )

    async def install(self, unit_file: UnitFile) -> str:
        """Install a unit file. Returns the path where it was written."""
        return await self._backend.install_unit_file(unit_file)

    async def uninstall(self, unit_name: str) -> None:
        """Remove an installed unit file and daemon-reload."""
        await self._backend.uninstall_unit_file(unit_name)

    async def edit(self, unit_name: str, overrides: dict[str, dict[str, str]]) -> str:
        """Create a drop-in override for a unit. Returns the override path."""
        return await self._backend.edit_unit_file(unit_name, overrides)

    async def show_environment(self) -> dict[str, str]:
        """Show the manager's environment variables."""
        return await self._backend.show_environment()

    async def set_environment(self, variables: dict[str, str]) -> None:
        """Set environment variables for the manager."""
        await self._backend.set_environment(variables)

    async def unset_environment(self, names: list[str]) -> None:
        """Unset environment variables from the manager."""
        await self._backend.unset_environment(names)

    async def list_sessions(self) -> list[SessionInfo]:
        """List active login sessions."""
        return await self._backend.list_sessions()

    async def list_users(self) -> list[UserInfo]:
        """List logged-in users."""
        return await self._backend.list_users()

    async def terminate_session(self, session_id: str) -> None:
        """Terminate a login session."""
        await self._backend.terminate_session(session_id)

    async def lock_session(self, session_id: str) -> None:
        """Lock a login session."""
        await self._backend.lock_session(session_id)

    async def poweroff(self) -> None:
        """Power off the system."""
        await self._backend._run_systemctl("poweroff")

    async def reboot(self) -> None:
        """Reboot the system."""
        await self._backend._run_systemctl("reboot")

    async def suspend(self) -> None:
        """Suspend the system."""
        await self._backend._run_systemctl("suspend")

    async def hibernate(self) -> None:
        """Hibernate the system."""
        await self._backend._run_systemctl("hibernate")

    async def analyze_blame(self) -> list[BlameEntry]:
        """List units ordered by initialization time (slowest first)."""
        from systemd_client._analyze import analyze_blame
        return await analyze_blame(self._scope)

    async def analyze_critical_chain(self, unit: str | None = None) -> str:
        """Show the critical chain of unit startup."""
        from systemd_client._analyze import analyze_critical_chain
        return await analyze_critical_chain(self._scope, unit)

    async def analyze_security(self, unit: str) -> SecurityAnalysis:
        """Analyze security hardening of a unit (exposure score 0-10)."""
        from systemd_client._analyze import analyze_security
        return await analyze_security(self._scope, unit)

    async def analyze_verify(self, unit: str) -> list[str]:
        """Verify unit file syntax and return diagnostic messages."""
        from systemd_client._analyze import analyze_verify
        return await analyze_verify(self._scope, unit)

    async def journal(
        self,
        unit: str | None = None,
        lines: int | None = None,
        since: str | None = None,
        until: str | None = None,
        priority: JournalPriority | None = None,
        grep: str | None = None,
    ) -> list[JournalEntry]:
        """Query journal entries."""
        q = JournalQuery(
            unit=unit, lines=lines, since=since, until=until,
            priority=priority, grep=grep,
        )
        return await self._journal.query(q)

    async def journal_follow(
        self,
        unit: str | None = None,
        lines: int | None = None,
        priority: JournalPriority | None = None,
    ) -> AsyncIterator[JournalEntry]:
        """Follow journal output as an async generator."""
        q = JournalQuery(unit=unit, lines=lines, priority=priority)
        async for entry in self._journal.follow(q):
            yield entry

__init__(backend=BackendType.AUTO, scope=SystemdScope.USER)

Source code in src/systemd_client/client.py 
38
39
40
41
42
43
44
45
46
def __init__(
    self,
    backend: BackendType = BackendType.AUTO,
    scope: SystemdScope = SystemdScope.USER,
) -> None:
    self._scope = scope
    self._backend_type = backend
    self._backend: AbstractBackend = get_backend(backend, scope=scope)
    self._journal = AsyncJournalReader(scope=scope)

list_units(unit_type=None, state=None) async

List systemd units.

Source code in src/systemd_client/client.py 
69
70
71
72
73
74
75
async def list_units(
    self,
    unit_type: str | None = None,
    state: str | None = None,
) -> list[UnitInfo]:
    """List systemd units."""
    return await self._backend.list_units(unit_type=unit_type, state=state)

status(unit_name) async

Get detailed status of a unit.

Source code in src/systemd_client/client.py 
85
86
87
async def status(self, unit_name: str) -> UnitStatus:
    """Get detailed status of a unit."""
    return await self._backend.get_unit_status(unit_name)

start(unit_name, no_block=False) async

Start a unit.

Source code in src/systemd_client/client.py 
93
94
95
async def start(self, unit_name: str, no_block: bool = False) -> None:
    """Start a unit."""
    await self._backend.start_unit(unit_name, no_block=no_block)

stop(unit_name, no_block=False) async

Stop a unit.

Source code in src/systemd_client/client.py 
97
98
99
async def stop(self, unit_name: str, no_block: bool = False) -> None:
    """Stop a unit."""
    await self._backend.stop_unit(unit_name, no_block=no_block)

restart(unit_name, no_block=False) async

Restart a unit.

Source code in src/systemd_client/client.py 
101
102
103
async def restart(self, unit_name: str, no_block: bool = False) -> None:
    """Restart a unit."""
    await self._backend.restart_unit(unit_name, no_block=no_block)

reload(unit_name, no_block=False) async

Reload a unit.

Source code in src/systemd_client/client.py 
105
106
107
async def reload(self, unit_name: str, no_block: bool = False) -> None:
    """Reload a unit."""
    await self._backend.reload_unit(unit_name, no_block=no_block)

enable(unit_name) async

Enable a unit.

Source code in src/systemd_client/client.py 
129
130
131
async def enable(self, unit_name: str) -> EnableResult:
    """Enable a unit."""
    return await self._backend.enable_unit(unit_name)

disable(unit_name) async

Disable a unit.

Source code in src/systemd_client/client.py 
133
134
135
async def disable(self, unit_name: str) -> EnableResult:
    """Disable a unit."""
    return await self._backend.disable_unit(unit_name)

mask(unit_name) async

Mask a unit.

Source code in src/systemd_client/client.py 
137
138
139
async def mask(self, unit_name: str) -> EnableResult:
    """Mask a unit."""
    return await self._backend.mask_unit(unit_name)

unmask(unit_name) async

Unmask a unit.

Source code in src/systemd_client/client.py 
141
142
143
async def unmask(self, unit_name: str) -> EnableResult:
    """Unmask a unit."""
    return await self._backend.unmask_unit(unit_name)

is_active(unit_name) async

Check if a unit is active.

Source code in src/systemd_client/client.py 
145
146
147
async def is_active(self, unit_name: str) -> bool:
    """Check if a unit is active."""
    return await self._backend.is_active(unit_name)

is_enabled(unit_name) async

Check if a unit is enabled.

Source code in src/systemd_client/client.py 
149
150
151
async def is_enabled(self, unit_name: str) -> bool:
    """Check if a unit is enabled."""
    return await self._backend.is_enabled(unit_name)

is_failed(unit_name) async

Check if a unit is in failed state.

Source code in src/systemd_client/client.py 
153
154
155
async def is_failed(self, unit_name: str) -> bool:
    """Check if a unit is in failed state."""
    return await self._backend.is_failed(unit_name)

daemon_reload() async

Reload the systemd daemon configuration.

Source code in src/systemd_client/client.py 
157
158
159
async def daemon_reload(self) -> None:
    """Reload the systemd daemon configuration."""
    await self._backend.daemon_reload()

journal(unit=None, lines=None, since=None, until=None, priority=None, grep=None) async

Query journal entries.

Source code in src/systemd_client/client.py 
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
async def journal(
    self,
    unit: str | None = None,
    lines: int | None = None,
    since: str | None = None,
    until: str | None = None,
    priority: JournalPriority | None = None,
    grep: str | None = None,
) -> list[JournalEntry]:
    """Query journal entries."""
    q = JournalQuery(
        unit=unit, lines=lines, since=since, until=until,
        priority=priority, grep=grep,
    )
    return await self._journal.query(q)

journal_follow(unit=None, lines=None, priority=None) async

Follow journal output as an async generator.

Source code in src/systemd_client/client.py 
310
311
312
313
314
315
316
317
318
319
async def journal_follow(
    self,
    unit: str | None = None,
    lines: int | None = None,
    priority: JournalPriority | None = None,
) -> AsyncIterator[JournalEntry]:
    """Follow journal output as an async generator."""
    q = JournalQuery(unit=unit, lines=lines, priority=priority)
    async for entry in self._journal.follow(q):
        yield entry

SystemdClient

systemd_client.client.SystemdClient

Synchronous systemd client wrapping AsyncSystemdClient.

Source code in src/systemd_client/client.py 
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
class SystemdClient:
    """Synchronous systemd client wrapping AsyncSystemdClient."""

    def __init__(
        self,
        backend: BackendType = BackendType.AUTO,
        scope: SystemdScope = SystemdScope.USER,
    ) -> None:
        self._async_client = AsyncSystemdClient(backend=backend, scope=scope)
        self._journal = JournalReader(scope=scope)

    def __enter__(self) -> SystemdClient:
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_val: BaseException | None,
        exc_tb: TracebackType | None,
    ) -> None:
        self.close()

    def close(self) -> None:
        """Release backend resources."""
        run_sync(self._async_client.close())

    def __repr__(self) -> str:
        return repr(self._async_client).replace("AsyncSystemdClient", "SystemdClient")

    def list_units(
        self,
        unit_type: str | None = None,
        state: str | None = None,
    ) -> list[UnitInfo]:
        """List systemd units."""
        return run_sync(self._async_client.list_units(unit_type=unit_type, state=state))

    def list_unit_files(
        self,
        unit_type: str | None = None,
        state: str | None = None,
    ) -> list[UnitFileInfo]:
        """List installed unit files."""
        return run_sync(self._async_client.list_unit_files(unit_type=unit_type, state=state))

    def status(self, unit_name: str) -> UnitStatus:
        """Get detailed status of a unit."""
        return run_sync(self._async_client.status(unit_name))

    def cat(self, unit_name: str) -> str:
        """Show the content of a unit file."""
        return run_sync(self._async_client.cat(unit_name))

    def start(self, unit_name: str, no_block: bool = False) -> None:
        """Start a unit."""
        run_sync(self._async_client.start(unit_name, no_block=no_block))

    def stop(self, unit_name: str, no_block: bool = False) -> None:
        """Stop a unit."""
        run_sync(self._async_client.stop(unit_name, no_block=no_block))

    def restart(self, unit_name: str, no_block: bool = False) -> None:
        """Restart a unit."""
        run_sync(self._async_client.restart(unit_name, no_block=no_block))

    def reload(self, unit_name: str, no_block: bool = False) -> None:
        """Reload a unit."""
        run_sync(self._async_client.reload(unit_name, no_block=no_block))

    def try_restart(self, unit_name: str, no_block: bool = False) -> None:
        """Restart a unit if it is active, otherwise do nothing."""
        run_sync(self._async_client.try_restart(unit_name, no_block=no_block))

    def reload_or_restart(self, unit_name: str, no_block: bool = False) -> None:
        """Reload a unit if it supports it, otherwise restart."""
        run_sync(self._async_client.reload_or_restart(unit_name, no_block=no_block))

    def start_units(self, unit_names: list[str], no_block: bool = False) -> None:
        """Start multiple units in a single operation."""
        run_sync(self._async_client.start_units(unit_names, no_block=no_block))

    def stop_units(self, unit_names: list[str], no_block: bool = False) -> None:
        """Stop multiple units in a single operation."""
        run_sync(self._async_client.stop_units(unit_names, no_block=no_block))

    def restart_units(self, unit_names: list[str], no_block: bool = False) -> None:
        """Restart multiple units in a single operation."""
        run_sync(self._async_client.restart_units(unit_names, no_block=no_block))

    def enable(self, unit_name: str) -> EnableResult:
        """Enable a unit."""
        return run_sync(self._async_client.enable(unit_name))

    def disable(self, unit_name: str) -> EnableResult:
        """Disable a unit."""
        return run_sync(self._async_client.disable(unit_name))

    def mask(self, unit_name: str) -> EnableResult:
        """Mask a unit."""
        return run_sync(self._async_client.mask(unit_name))

    def unmask(self, unit_name: str) -> EnableResult:
        """Unmask a unit."""
        return run_sync(self._async_client.unmask(unit_name))

    def is_active(self, unit_name: str) -> bool:
        """Check if a unit is active."""
        return run_sync(self._async_client.is_active(unit_name))

    def is_enabled(self, unit_name: str) -> bool:
        """Check if a unit is enabled."""
        return run_sync(self._async_client.is_enabled(unit_name))

    def is_failed(self, unit_name: str) -> bool:
        """Check if a unit is in failed state."""
        return run_sync(self._async_client.is_failed(unit_name))

    def daemon_reload(self) -> None:
        """Reload the systemd daemon configuration."""
        run_sync(self._async_client.daemon_reload())

    def reset_failed(self, unit_name: str | None = None) -> None:
        """Reset the failed state of a unit, or all units if no name given."""
        run_sync(self._async_client.reset_failed(unit_name))

    def set_property(self, unit_name: str, properties: dict[str, str]) -> None:
        """Set runtime properties on a unit (cgroup limits, etc.)."""
        run_sync(self._async_client.set_property(unit_name, properties))

    def get_resource_usage(self, unit_name: str) -> ResourceUsage:
        """Get resource usage statistics for a unit."""
        return run_sync(self._async_client.get_resource_usage(unit_name))

    def list_timers(self) -> list[TimerInfo]:
        """List active timers."""
        return run_sync(self._async_client.list_timers())

    def list_sockets(self) -> list[SocketInfo]:
        """List active sockets."""
        return run_sync(self._async_client.list_sockets())

    def list_dependencies(self, unit_name: str) -> list[str]:
        """List dependency tree of a unit."""
        return run_sync(self._async_client.list_dependencies(unit_name))

    def kill(self, unit_name: str, signal: str = "SIGTERM") -> None:
        """Send a signal to a unit's processes."""
        run_sync(self._async_client.kill(unit_name, signal))

    def run(
        self,
        command: str | list[str],
        *,
        name: str | None = None,
        wait: bool = False,
        properties: dict[str, str] | None = None,
        remain_after_exit: bool = False,
    ) -> TransientResult:
        """Run a command as a transient systemd service (systemd-run)."""
        return run_sync(self._async_client.run(
            command, name=name, wait=wait, properties=properties,
            remain_after_exit=remain_after_exit,
        ))

    def run_on_calendar(
        self,
        on_calendar: str,
        command: str | list[str],
        *,
        name: str | None = None,
    ) -> TransientResult:
        """Schedule a command as a transient timer (systemd-run --on-calendar)."""
        return run_sync(self._async_client.run_on_calendar(
            on_calendar, command, name=name,
        ))

    def install(self, unit_file: UnitFile) -> str:
        """Install a unit file. Returns the path where it was written."""
        return run_sync(self._async_client.install(unit_file))

    def uninstall(self, unit_name: str) -> None:
        """Remove an installed unit file and daemon-reload."""
        run_sync(self._async_client.uninstall(unit_name))

    def edit(self, unit_name: str, overrides: dict[str, dict[str, str]]) -> str:
        """Create a drop-in override for a unit. Returns the override path."""
        return run_sync(self._async_client.edit(unit_name, overrides))

    def show_environment(self) -> dict[str, str]:
        """Show the manager's environment variables."""
        return run_sync(self._async_client.show_environment())

    def set_environment(self, variables: dict[str, str]) -> None:
        """Set environment variables for the manager."""
        run_sync(self._async_client.set_environment(variables))

    def unset_environment(self, names: list[str]) -> None:
        """Unset environment variables from the manager."""
        run_sync(self._async_client.unset_environment(names))

    def list_sessions(self) -> list[SessionInfo]:
        """List active login sessions."""
        return run_sync(self._async_client.list_sessions())

    def list_users(self) -> list[UserInfo]:
        """List logged-in users."""
        return run_sync(self._async_client.list_users())

    def terminate_session(self, session_id: str) -> None:
        """Terminate a login session."""
        run_sync(self._async_client.terminate_session(session_id))

    def lock_session(self, session_id: str) -> None:
        """Lock a login session."""
        run_sync(self._async_client.lock_session(session_id))

    def poweroff(self) -> None:
        """Power off the system."""
        run_sync(self._async_client.poweroff())

    def reboot(self) -> None:
        """Reboot the system."""
        run_sync(self._async_client.reboot())

    def suspend(self) -> None:
        """Suspend the system."""
        run_sync(self._async_client.suspend())

    def hibernate(self) -> None:
        """Hibernate the system."""
        run_sync(self._async_client.hibernate())

    def analyze_blame(self) -> list[BlameEntry]:
        """List units ordered by initialization time (slowest first)."""
        return run_sync(self._async_client.analyze_blame())

    def analyze_critical_chain(self, unit: str | None = None) -> str:
        """Show the critical chain of unit startup."""
        return run_sync(self._async_client.analyze_critical_chain(unit))

    def analyze_security(self, unit: str) -> SecurityAnalysis:
        """Analyze security hardening of a unit (exposure score 0-10)."""
        return run_sync(self._async_client.analyze_security(unit))

    def analyze_verify(self, unit: str) -> list[str]:
        """Verify unit file syntax and return diagnostic messages."""
        return run_sync(self._async_client.analyze_verify(unit))

    def journal(
        self,
        unit: str | None = None,
        lines: int | None = None,
        since: str | None = None,
        until: str | None = None,
        priority: JournalPriority | None = None,
        grep: str | None = None,
    ) -> list[JournalEntry]:
        """Query journal entries."""
        q = JournalQuery(
            unit=unit, lines=lines, since=since, until=until,
            priority=priority, grep=grep,
        )
        return self._journal.query(q)

    def journal_follow(
        self,
        unit: str | None = None,
        lines: int | None = None,
        priority: JournalPriority | None = None,
    ) -> Iterator[JournalEntry]:
        """Follow journal output as a synchronous iterator."""
        q = JournalQuery(unit=unit, lines=lines, priority=priority)
        return self._journal.follow(q)

__init__(backend=BackendType.AUTO, scope=SystemdScope.USER)

Source code in src/systemd_client/client.py 
325
326
327
328
329
330
331
def __init__(
    self,
    backend: BackendType = BackendType.AUTO,
    scope: SystemdScope = SystemdScope.USER,
) -> None:
    self._async_client = AsyncSystemdClient(backend=backend, scope=scope)
    self._journal = JournalReader(scope=scope)

list_units(unit_type=None, state=None)

List systemd units.

Source code in src/systemd_client/client.py 
351
352
353
354
355
356
357
def list_units(
    self,
    unit_type: str | None = None,
    state: str | None = None,
) -> list[UnitInfo]:
    """List systemd units."""
    return run_sync(self._async_client.list_units(unit_type=unit_type, state=state))

status(unit_name)

Get detailed status of a unit.

Source code in src/systemd_client/client.py 
367
368
369
def status(self, unit_name: str) -> UnitStatus:
    """Get detailed status of a unit."""
    return run_sync(self._async_client.status(unit_name))

start(unit_name, no_block=False)

Start a unit.

Source code in src/systemd_client/client.py 
375
376
377
def start(self, unit_name: str, no_block: bool = False) -> None:
    """Start a unit."""
    run_sync(self._async_client.start(unit_name, no_block=no_block))

stop(unit_name, no_block=False)

Stop a unit.

Source code in src/systemd_client/client.py 
379
380
381
def stop(self, unit_name: str, no_block: bool = False) -> None:
    """Stop a unit."""
    run_sync(self._async_client.stop(unit_name, no_block=no_block))

restart(unit_name, no_block=False)

Restart a unit.

Source code in src/systemd_client/client.py 
383
384
385
def restart(self, unit_name: str, no_block: bool = False) -> None:
    """Restart a unit."""
    run_sync(self._async_client.restart(unit_name, no_block=no_block))

reload(unit_name, no_block=False)

Reload a unit.

Source code in src/systemd_client/client.py 
387
388
389
def reload(self, unit_name: str, no_block: bool = False) -> None:
    """Reload a unit."""
    run_sync(self._async_client.reload(unit_name, no_block=no_block))

enable(unit_name)

Enable a unit.

Source code in src/systemd_client/client.py 
411
412
413
def enable(self, unit_name: str) -> EnableResult:
    """Enable a unit."""
    return run_sync(self._async_client.enable(unit_name))

disable(unit_name)

Disable a unit.

Source code in src/systemd_client/client.py 
415
416
417
def disable(self, unit_name: str) -> EnableResult:
    """Disable a unit."""
    return run_sync(self._async_client.disable(unit_name))

mask(unit_name)

Mask a unit.

Source code in src/systemd_client/client.py 
419
420
421
def mask(self, unit_name: str) -> EnableResult:
    """Mask a unit."""
    return run_sync(self._async_client.mask(unit_name))

unmask(unit_name)

Unmask a unit.

Source code in src/systemd_client/client.py 
423
424
425
def unmask(self, unit_name: str) -> EnableResult:
    """Unmask a unit."""
    return run_sync(self._async_client.unmask(unit_name))

is_active(unit_name)

Check if a unit is active.

Source code in src/systemd_client/client.py 
427
428
429
def is_active(self, unit_name: str) -> bool:
    """Check if a unit is active."""
    return run_sync(self._async_client.is_active(unit_name))

is_enabled(unit_name)

Check if a unit is enabled.

Source code in src/systemd_client/client.py 
431
432
433
def is_enabled(self, unit_name: str) -> bool:
    """Check if a unit is enabled."""
    return run_sync(self._async_client.is_enabled(unit_name))

is_failed(unit_name)

Check if a unit is in failed state.

Source code in src/systemd_client/client.py 
435
436
437
def is_failed(self, unit_name: str) -> bool:
    """Check if a unit is in failed state."""
    return run_sync(self._async_client.is_failed(unit_name))

daemon_reload()

Reload the systemd daemon configuration.

Source code in src/systemd_client/client.py 
439
440
441
def daemon_reload(self) -> None:
    """Reload the systemd daemon configuration."""
    run_sync(self._async_client.daemon_reload())

journal(unit=None, lines=None, since=None, until=None, priority=None, grep=None)

Query journal entries.

Source code in src/systemd_client/client.py 
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
def journal(
    self,
    unit: str | None = None,
    lines: int | None = None,
    since: str | None = None,
    until: str | None = None,
    priority: JournalPriority | None = None,
    grep: str | None = None,
) -> list[JournalEntry]:
    """Query journal entries."""
    q = JournalQuery(
        unit=unit, lines=lines, since=since, until=until,
        priority=priority, grep=grep,
    )
    return self._journal.query(q)

journal_follow(unit=None, lines=None, priority=None)

Follow journal output as a synchronous iterator.

Source code in src/systemd_client/client.py 
586
587
588
589
590
591
592
593
594
def journal_follow(
    self,
    unit: str | None = None,
    lines: int | None = None,
    priority: JournalPriority | None = None,
) -> Iterator[JournalEntry]:
    """Follow journal output as a synchronous iterator."""
    q = JournalQuery(unit=unit, lines=lines, priority=priority)
    return self._journal.follow(q)