mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 10:51:24 -07:00
[PR #9352/9fc3092b backport][stable-9] s[e-n]*: normalize docs (#9398)
s[e-n]*: normalize docs (#9352)
* s[e-n]*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* quote line with : and remove extraneous notes
* Update plugins/modules/slack.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/seport.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 9fc3092bb3
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
c64705474d
commit
7506742c38
20 changed files with 627 additions and 689 deletions
|
@ -8,14 +8,14 @@ from __future__ import (absolute_import, division, print_function)
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
DOCUMENTATION = r"""
|
||||
module: shutdown
|
||||
short_description: Shut down a machine
|
||||
notes:
|
||||
- E(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths)
|
||||
to specify locations to search if the default paths do not work.
|
||||
- The O(msg) and O(delay) options are not supported when a shutdown command is not found in O(search_paths), instead
|
||||
the module will attempt to shutdown the system by calling C(systemctl shutdown).
|
||||
- E(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths) to specify locations to search if the
|
||||
default paths do not work.
|
||||
- The O(msg) and O(delay) options are not supported when a shutdown command is not found in O(search_paths), instead the module will attempt
|
||||
to shutdown the system by calling C(systemctl shutdown).
|
||||
description:
|
||||
- Shut downs a machine.
|
||||
version_added: "1.1.0"
|
||||
|
@ -47,20 +47,21 @@ options:
|
|||
search_paths:
|
||||
description:
|
||||
- Paths to search on the remote machine for the C(shutdown) command.
|
||||
- I(Only) these paths will be searched for the C(shutdown) command. E(PATH) is ignored in the remote node when searching for the C(shutdown) command.
|
||||
- I(Only) these paths will be searched for the C(shutdown) command. E(PATH) is ignored in the remote node when searching for the C(shutdown)
|
||||
command.
|
||||
type: list
|
||||
elements: path
|
||||
default: ['/sbin', '/usr/sbin', '/usr/local/sbin']
|
||||
|
||||
seealso:
|
||||
- module: ansible.builtin.reboot
|
||||
- module: ansible.builtin.reboot
|
||||
author:
|
||||
- Matt Davis (@nitzmahone)
|
||||
- Sam Doran (@samdoran)
|
||||
- Amin Vakil (@aminvakil)
|
||||
'''
|
||||
- Matt Davis (@nitzmahone)
|
||||
- Sam Doran (@samdoran)
|
||||
- Amin Vakil (@aminvakil)
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Unconditionally shut down the machine with all defaults
|
||||
community.general.shutdown:
|
||||
|
||||
|
@ -71,13 +72,13 @@ EXAMPLES = r'''
|
|||
- name: Shut down a machine with shutdown command in unusual place
|
||||
community.general.shutdown:
|
||||
search_paths:
|
||||
- '/lib/molly-guard'
|
||||
'''
|
||||
- '/lib/molly-guard'
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
shutdown:
|
||||
description: V(true) if the machine has been shut down.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
'''
|
||||
"""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue