diff options
| author | Abhijeet Kasurde <akasurde@redhat.com> | 2023-09-28 21:20:15 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-28 21:20:15 +0200 |
| commit | 55f27a579ea36d8257398fec9ea1a9110816974d (patch) | |
| tree | 024f78591fb25baff7e639e6d76c7fc894dd6350 | |
| parent | Update ansible-test containers (diff) | |
| download | ansible-55f27a579ea36d8257398fec9ea1a9110816974d.tar.xz ansible-55f27a579ea36d8257398fec9ea1a9110816974d.zip | |
systemd_service: add a note about module rename (#81803)
* The module systemd is renamed to systemd_service to maintain
the scope of the module. Mention this in the module description.
* Misc typo fixes.
Fixes: #80917
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
| -rw-r--r-- | lib/ansible/modules/systemd_service.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/lib/ansible/modules/systemd_service.py b/lib/ansible/modules/systemd_service.py index 7dec044656..8b3b430677 100644 --- a/lib/ansible/modules/systemd_service.py +++ b/lib/ansible/modules/systemd_service.py @@ -15,6 +15,8 @@ version_added: "2.2" short_description: Manage systemd units description: - Controls systemd units (services, timers, and so on) on remote hosts. + - M(ansible.builtin.systemd) is renamed to M(ansible.builtin.systemd_service) to better reflect the scope of the module. + M(ansible.builtin.systemd) is kept as an alias for backward compatibility. options: name: description: @@ -32,7 +34,7 @@ options: choices: [ reloaded, restarted, started, stopped ] enabled: description: - - Whether the unit should start on boot. B(At least one of state and enabled are required.) + - Whether the unit should start on boot. B(At least one of the states and enabled are required.) type: bool force: description: @@ -64,7 +66,7 @@ options: - "For systemd to work with 'user', the executing user must have its own instance of dbus started and accessible (systemd requirement)." - "The user dbus process is normally started during normal login, but not during the run of Ansible tasks. Otherwise you will probably get a 'Failed to connect to bus: no such file or directory' error." - - The user must have access, normally given via setting the C(XDG_RUNTIME_DIR) variable, see example below. + - The user must have access, normally given via setting the C(XDG_RUNTIME_DIR) variable, see the example below. type: str choices: [ system, user, global ] @@ -89,9 +91,9 @@ notes: - Since 2.4, one of the following options is required O(state), O(enabled), O(masked), O(daemon_reload), (O(daemon_reexec) since 2.8), and all except O(daemon_reload) and (O(daemon_reexec) since 2.8) also require O(name). - Before 2.4 you always required O(name). - - Globs are not supported in name, i.e C(postgres*.service). + - Globs are not supported in name, in other words, C(postgres*.service). - The service names might vary by specific OS/distribution - - The order of execution when having multiple properties is to first enable/disable, then mask/unmask and then deal with service state. + - The order of execution when having multiple properties is to first enable/disable, then mask/unmask and then deal with the service state. It has been reported that systemctl can behave differently depending on the order of operations if you do the same manually. requirements: - A system managed by systemd. |