[PR #9351/4b23e5ec backport][stable-9] s[o-y]*: normalize docs (#9368)

s[o-y]*: normalize docs (#9351)

* s[o-y]*: normalize docs

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/spectrum_model_attrs.py

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 4b23e5ecff)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-25 16:46:29 +01:00 committed by GitHub
parent e120c64a21
commit 595c105a29
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
20 changed files with 994 additions and 1174 deletions

View file

@ -11,18 +11,17 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
DOCUMENTATION = r"""
module: ssh_config
short_description: Manage SSH config for user
version_added: '2.0.0'
description:
- Configures SSH hosts with special C(IdentityFile)s and hostnames.
- Configures SSH hosts with special C(IdentityFile)s and hostnames.
author:
- Björn Andersson (@gaqzi)
- Abhijeet Kasurde (@Akasurde)
- Björn Andersson (@gaqzi)
- Abhijeet Kasurde (@Akasurde)
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes
attributes:
check_mode:
support: full
@ -33,7 +32,7 @@ options:
description:
- Whether a host entry should exist or not.
default: present
choices: [ 'present', 'absent' ]
choices: ['present', 'absent']
type: str
user:
description:
@ -50,8 +49,7 @@ options:
host:
description:
- The endpoint this configuration is valid for.
- Can be an actual address on the internet or an alias that will
connect to the value of O(hostname).
- Can be an actual address on the internet or an alias that will connect to the value of O(hostname).
required: true
type: str
hostname:
@ -68,17 +66,14 @@ options:
type: str
identity_file:
description:
- The path to an identity file (SSH private key) that will be used
when connecting to this host.
- The path to an identity file (SSH private key) that will be used when connecting to this host.
- File need to exist and have mode V(0600) to be valid.
type: path
identities_only:
description:
- Specifies that SSH should only use the configured authentication
identity and certificate files (either the default files, or
those explicitly configured in the C(ssh_config) files or passed on
the ssh command-line), even if ssh-agent or a PKCS11Provider or
SecurityKeyProvider offers more identities.
- Specifies that SSH should only use the configured authentication identity and certificate files (either the default files, or those explicitly
configured in the C(ssh_config) files or passed on the ssh command-line), even if ssh-agent or a PKCS11Provider or SecurityKeyProvider
offers more identities.
type: bool
version_added: 8.2.0
user_known_hosts_file:
@ -89,7 +84,7 @@ options:
description:
- Whether to strictly check the host key when doing connections to the remote host.
- The value V(accept-new) is supported since community.general 8.6.0.
choices: [ 'yes', 'no', 'ask', 'accept-new' ]
choices: ['yes', 'no', 'ask', 'accept-new']
type: str
proxycommand:
description:
@ -126,7 +121,7 @@ options:
controlmaster:
description:
- Sets the C(ControlMaster) option.
choices: [ 'yes', 'no', 'ask', 'auto', 'autoask' ]
choices: ['yes', 'no', 'ask', 'auto', 'autoask']
type: str
version_added: 8.1.0
controlpath:
@ -140,10 +135,10 @@ options:
type: str
version_added: 8.1.0
requirements:
- paramiko
'''
- paramiko
"""
EXAMPLES = r'''
EXAMPLES = r"""
- name: Add a host in the configuration
community.general.ssh_config:
user: akasurde
@ -158,9 +153,9 @@ EXAMPLES = r'''
ssh_config_file: "{{ ssh_config_test }}"
host: "example.com"
state: absent
'''
"""
RETURN = r'''
RETURN = r"""
hosts_added:
description: A list of host added.
returned: success
@ -196,7 +191,7 @@ hosts_change_diff:
}
}
]
'''
"""
import os