From bcaae4c4350511ea93de5c2b17238873f2a27c5a Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Tue, 2 Apr 2024 08:06:40 -0700 Subject: [PATCH] systemd_service: Update docs regarding required_* (#82917) * Update the documentation regarding required_one_of and required_by in systemd_service Fixes: #82914 Signed-off-by: Abhijeet Kasurde --- changelogs/fragments/systemd_service_note.yml | 3 +++ lib/ansible/modules/systemd_service.py | 12 +++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 changelogs/fragments/systemd_service_note.yml diff --git a/changelogs/fragments/systemd_service_note.yml b/changelogs/fragments/systemd_service_note.yml new file mode 100644 index 00000000000..ccd55873e43 --- /dev/null +++ b/changelogs/fragments/systemd_service_note.yml @@ -0,0 +1,3 @@ +--- +bugfixes: + - systemd_services - update documentation regarding required_one_of and required_by parameters (https://github.com/ansible/ansible/issues/82914). diff --git a/lib/ansible/modules/systemd_service.py b/lib/ansible/modules/systemd_service.py index 7ab30bc98fa..8340de36ea7 100644 --- a/lib/ansible/modules/systemd_service.py +++ b/lib/ansible/modules/systemd_service.py @@ -29,11 +29,13 @@ options: - V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the unit. V(reloaded) will always reload and if the service is not running at the moment of the reload, it is started. + - If set, requires O(name). type: str choices: [ reloaded, restarted, started, stopped ] enabled: description: - - Whether the unit should start on boot. B(At least one of the states and enabled are required.) + - Whether the unit should start on boot. B(At least one of state and enabled are required.) + - If set, requires O(name). type: bool force: description: @@ -42,7 +44,8 @@ options: version_added: 2.6 masked: description: - - Whether the unit should be masked or not, a masked unit is impossible to start. + - Whether the unit should be masked or not. A masked unit is impossible to start. + - If set, requires O(name). type: bool daemon_reload: description: @@ -87,11 +90,10 @@ attributes: platform: platforms: posix 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). + - O(state), O(enabled), O(masked) requires O(name). - Before 2.4 you always required O(name). - Globs are not supported in name, in other words, C(postgres*.service). - - The service names might vary by specific OS/distribution + - 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 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: