ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-30 08:31:28 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

fix style in plugins (#10303)

Browse source
This commit is contained in:
Alexei Znamensky 2025-07-02 01:15:01 +12:00 • committed by GitHub
commit 329c2222fc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
35 changed files with 98 additions and 97 deletions
Download patch file Download diff file Expand all files Collapse all files

20
plugins/inventory/cobbler.py
View file

@ -12,14 +12,17 @@ short_description: Cobbler inventory source
version_added: 1.0.0
description:
- Get inventory hosts from the cobbler service.
- "Uses a configuration file as an inventory source, it must end in C(.cobbler.yml) or C(.cobbler.yaml) and have a C(plugin: cobbler) entry."
- Adds the primary IP addresses to C(cobbler_ipv4_address) and C(cobbler_ipv6_address) host variables if defined in Cobbler. The primary IP address is
defined as the management interface if defined, or the interface who's DNS name matches the hostname of the system, or else the first interface found.
- 'Uses a configuration file as an inventory source, it must end in C(.cobbler.yml) or C(.cobbler.yaml) and have a C(plugin:
cobbler) entry.'
- Adds the primary IP addresses to C(cobbler_ipv4_address) and C(cobbler_ipv6_address) host variables if defined in Cobbler.
The primary IP address is defined as the management interface if defined, or the interface who's DNS name matches the
hostname of the system, or else the first interface found.
extends_documentation_fragment:
- inventory_cache
options:
plugin:
description: The name of this plugin, it should always be set to V(community.general.cobbler) for this plugin to recognize it as its own.
description: The name of this plugin, it should always be set to V(community.general.cobbler) for this plugin to recognize
it as its own.
type: string
required: true
choices: ['cobbler', 'community.general.cobbler']
@ -72,7 +75,7 @@ options:
include_profiles:
description:
- Profiles to include from inventory.
- If specified, all other profiles will be excluded.
- If specified, all other profiles are excluded.
- O(exclude_profiles) is ignored if O(include_profiles) is specified.
type: list
default: []
@ -81,7 +84,8 @@ options:
inventory_hostname:
description:
- What to use for the ansible inventory hostname.
- By default the networking hostname is used if defined, otherwise the DNS name of the management or first non-static interface.
- By default the networking hostname is used if defined, otherwise the DNS name of the management or first non-static
interface.
- If set to V(system), the cobbler system name is used.
type: str
choices: ['hostname', 'system']
@ -99,12 +103,12 @@ options:
description: Prefix to apply to cobbler groups.
default: cobbler_
want_facts:
description: Toggle, if V(true) the plugin will retrieve all host facts from the server.
description: Toggle, if V(true) the plugin retrieves all host facts from the server.
type: boolean
default: true
want_ip_addresses:
description:
- Toggle, if V(true) the plugin will add a C(cobbler_ipv4_addresses) and C(cobbler_ipv6_addresses) dictionary to the
- Toggle, if V(true) the plugin adds a C(cobbler_ipv4_addresses) and C(cobbler_ipv6_addresses) dictionary to the
defined O(group) mapping interface DNS names to IP addresses.
type: boolean
default: true

2
plugins/inventory/gitlab_runners.py
View file

@ -21,7 +21,7 @@ description:
- Uses a YAML configuration file gitlab_runners.[yml|yaml].
options:
plugin:
description: The name of this plugin, it should always be set to 'gitlab_runners' for this plugin to recognize it as its own.
description: The name of this plugin, it should always be set to V(gitlab_runners) for this plugin to recognize it as its own.
type: str
required: true
choices:

20
plugins/inventory/lxd.py
View file

@ -48,20 +48,19 @@ options:
version_added: 8.0.0
server_check_hostname:
description:
- This option controls if the server's hostname is checked as part of the HTTPS connection verification.
This can be useful to disable, if for example, the server certificate provided (see O(server_cert) option)
does not cover a name matching the one used to communicate with the server. Such mismatch is common as LXD
generates self-signed server certificates by default.
- This option controls if the server's hostname is checked as part of the HTTPS connection verification. This can be
useful to disable, if for example, the server certificate provided (see O(server_cert) option) does not cover a name
matching the one used to communicate with the server. Such mismatch is common as LXD generates self-signed server
certificates by default.
type: bool
default: true
version_added: 8.0.0
trust_password:
description:
- The client trusted password.
- You need to set this password on the lxd server before
running this module using the following command
C(lxc config set core.trust_password <some random password>)
See U(https://documentation.ubuntu.com/lxd/en/latest/authentication/#adding-client-certificates-using-a-trust-password).
- You need to set this password on the lxd server before running this module using the following command C(lxc config
set core.trust_password <some random password>) See
U(https://documentation.ubuntu.com/lxd/en/latest/authentication/#adding-client-certificates-using-a-trust-password).
- If O(trust_password) is set, this module send a request for authentication before sending any requests.
type: str
state:
@ -85,7 +84,7 @@ options:
prefered_instance_network_interface:
description:
- If an instance has multiple network interfaces, select which one is the preferred as pattern.
- Combined with the first number that can be found e.g. 'eth' + 0.
- Combined with the first number that can be found, for example C(eth) + C(0).
- The option has been renamed from O(prefered_container_network_interface) to O(prefered_instance_network_interface)
in community.general 3.8.0. The old name still works as an alias.
type: str
@ -101,7 +100,8 @@ options:
choices: ['inet', 'inet6']
groupby:
description:
- Create groups by the following keywords C(location), C(network_range), C(os), C(pattern), C(profile), C(release), C(type), C(vlanid).
- Create groups by the following keywords C(location), C(network_range), C(os), C(pattern), C(profile), C(release),
C(type), C(vlanid).
- See example for syntax.
type: dict
"""

4
plugins/inventory/nmap.py
View file

@ -64,14 +64,14 @@ options:
default: true
udp_scan:
description:
- Scan via UDP.
- Scan using UDP.
- Depending on your system you might need O(sudo=true) for this to work.
type: boolean
default: false
version_added: 6.1.0
icmp_timestamp:
description:
- Scan via ICMP Timestamp (C(-PP)).
- Scan using ICMP Timestamp (C(-PP)).
- Depending on your system you might need O(sudo=true) for this to work.
type: boolean
default: false

2
plugins/inventory/opennebula.py
View file

@ -50,7 +50,7 @@ options:
type: string
api_authfile:
description:
- If both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth file. Default
- If both O(api_username) or O(api_password) are not set, then it tries to authenticate with ONE auth file. Default
path is C(~/.one/one_auth).
- Set environment variable E(ONE_AUTH) to override this path.
env:

2
plugins/inventory/scaleway.py
View file

@ -44,7 +44,7 @@ options:
oauth_token:
description:
- Scaleway OAuth token.
- If not explicitly defined or in environment variables, it will try to lookup in the scaleway-cli configuration file
- If not explicitly defined or in environment variables, it tries to lookup in the C(scaleway-cli) configuration file
(C($SCW_CONFIG_PATH), C($XDG_CONFIG_HOME/scw/config.yaml), or C(~/.config/scw/config.yaml)).
- More details on L(how to generate token, https://www.scaleway.com/en/docs/generate-api-keys/).
type: string

2
plugins/inventory/virtualbox.py
View file

@ -48,7 +48,7 @@ options:
according to U(https://www.virtualbox.org/manual/UserManual.html#gui-vmgroups). Groups are now split using the V(,)
character, and the V(/) character indicates nested groups.
- When enabled, a VM that's been configured using V(VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2,/TestGroup3")
will result in the group C(TestGroup2) being a child group of C(TestGroup); and the VM being a part of C(TestGroup2)
results in the group C(TestGroup2) being a child group of C(TestGroup); and the VM being a part of C(TestGroup2)
and C(TestGroup3).
default: false
type: bool

6
plugins/inventory/xen_orchestra.py
View file

@ -31,7 +31,7 @@ options:
description:
- API host to XOA API.
- If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_HOST)
will be used instead.
is used instead.
type: str
env:
- name: ANSIBLE_XO_HOST
@ -39,7 +39,7 @@ options:
description:
- Xen Orchestra user.
- If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_USER)
will be used instead.
is used instead.
required: true
type: str
env:
@ -48,7 +48,7 @@ options:
description:
- Xen Orchestra password.
- If the value is not specified in the inventory configuration, the value of environment variable E(ANSIBLE_XO_PASSWORD)
will be used instead.
is used instead.
required: true
type: str
env: