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

doc style adjustments: modules [no]* (#10443)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
Details
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
Details
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
Details
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
Details
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
Details
nox / Run extra sanity tests (push) Waiting to run
Details

Browse source 
* doc style adjustments: modules n*

* doc style adjustments: modules o*

* Apply suggestions from code review

* Apply suggestions from code review

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

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2025-07-25 18:52:01 +12:00 • committed by GitHub
commit 6d67546902
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 252 additions and 229 deletions
Download patch file Download diff file Expand all files Collapse all files

15
plugins/modules/nagios.py
View file

@ -22,11 +22,6 @@ description:
- The C(nagios) module is not idempotent.
- All actions require the O(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}})
variable to refer to the host the playbook is currently running on.
- You can specify multiple services at once by separating them with commas, for example O(services=httpd,nfs,puppet).
- When specifying what service to handle there is a special service value, O(host), which will handle alerts/downtime/acknowledge
for the I(host itself), for example O(services=host). This keyword may not be given with other services at the same time.
B(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running
on it.) To schedule downtime for all services on particular host use keyword "all", for example O(services=all).
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -88,6 +83,12 @@ options:
description:
- What to manage downtime/alerts for. Separate multiple services with commas.
- 'B(Required) option when O(action) is one of: V(downtime), V(acknowledge), V(forced_check), V(enable_alerts), V(disable_alerts).'
- You can specify multiple services at once by separating them with commas, for example O(services=httpd,nfs,puppet).
- When specifying what O(services) to handle there is a special service value, V(host), which handles alerts/downtime/acknowledge
for the I(host itself), for example O(services=host). This keyword may not be given with other services at the same
time. B(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the
services running on it.) To schedule downtime for all O(services) on particular host use keyword V(all), for example
O(services=all).
aliases: ["service"]
type: str
servicegroup:
@ -97,8 +98,8 @@ options:
type: str
command:
description:
- The raw command to send to nagios, which should not include the submitted time header or the line-feed.
- B(Required) option when using the V(command) O(action).
- The raw command to send to Nagios, which should not include the submitted time header or the line-feed.
- B(Required) option when O(action=command).
type: str
author: "Tim Bielawa (@tbielawa)"

2
plugins/modules/netcup_dns.py
View file

@ -68,7 +68,7 @@ options:
default: false
description:
- Whether the record should be the only one for that record type and record name. Only use with O(state=present).
- This will delete all other records with the same record name and type.
- This deletes all other records with the same record name and type.
priority:
description:
- Record priority. Required for O(type=MX).

4
plugins/modules/newrelic_deployment.py
View file

@ -62,8 +62,8 @@ options:
required: false
validate_certs:
description:
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
required: false
default: true
type: bool

6
plugins/modules/nexmo.py
View file

@ -45,12 +45,12 @@ options:
msg:
type: str
description:
- Message to text to send. Messages longer than 160 characters will be split into multiple messages.
- Message text to send. Messages longer than 160 characters are split into multiple messages.
required: true
validate_certs:
description:
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
type: bool
default: true
extends_documentation_fragment:

8
plugins/modules/nictagadm.py
View file

@ -35,7 +35,7 @@ options:
type: str
etherstub:
description:
- Specifies that the nic tag will be attached to a created O(etherstub).
- Specifies that the nic tag is attached to a created O(etherstub).
- Parameter O(etherstub) is mutually exclusive with both O(mtu), and O(mac).
type: bool
default: false
@ -46,7 +46,7 @@ options:
type: int
force:
description:
- When O(state=absent) this switch will use the C(-f) parameter and delete the nic tag regardless of existing VMs.
- When O(state=absent) this switch uses the C(-f) parameter and delete the nic tag regardless of existing VMs.
type: bool
default: false
state:
@ -83,7 +83,7 @@ mac:
type: str
sample: 00:1b:21:a3:f5:4d
etherstub:
description: Specifies if the nic tag will create and attach to an etherstub.
description: Specifies if the nic tag was created and attached to an etherstub.
returned: always
type: bool
sample: false
@ -93,7 +93,7 @@ mtu:
type: int
sample: 1500
force:
description: Shows if -f was used during the deletion of a nic tag.
description: Shows if C(-f) was used during the deletion of a nic tag.
returned: always
type: bool
sample: false

93
plugins/modules/nmcli.py
View file

@ -21,10 +21,10 @@ extends_documentation_fragment:
description:
- Manage the network devices. Create, modify and manage various connection and device type, for example V(ethernet), V(team),
V(bond), V(vlan) and so on.
- 'On CentOS 8 and Fedora >=29 like systems, the requirements can be met by installing the following packages: NetworkManager.'
- 'On CentOS 7 and Fedora <=28 like systems, the requirements can be met by installing the following packages: NetworkManager-tui.'
- 'On Ubuntu and Debian like systems, the requirements can be met by installing the following packages: network-manager.'
- 'On openSUSE, the requirements can be met by installing the following packages: NetworkManager.'
- 'On CentOS 8 and Fedora >=29 like systems, the requirements can be met by installing the following packages: C(NetworkManager).'
- 'On CentOS 7 and Fedora <=28 like systems, the requirements can be met by installing the following packages: C(NetworkManager-tui).'
- 'On Ubuntu and Debian like systems, the requirements can be met by installing the following packages: C(network-manager).'
- 'On openSUSE, the requirements can be met by installing the following packages: C(NetworkManager).'
attributes:
check_mode:
support: full
@ -34,8 +34,8 @@ options:
state:
description:
- Whether the device should exist or not, taking action if the state is different from what is stated.
- Using O(state=present) to create connection will automatically bring connection up.
- Using O(state=up) and O(state=down) will not modify connection with other parameters. These states have been added
- Using O(state=present) creates connection set to be brought up automatically.
- Using O(state=up) and O(state=down) does not modify connection with other parameters. These states have been added
in community.general 9.5.0.
type: str
required: true
@ -48,7 +48,7 @@ options:
default: true
autoconnect_priority:
description:
- The priority of the connection profile for autoconnect. If set, connection profiles with higher priority will be preferred.
- The priority of the connection profile for autoconnect. If set, connection profiles with higher priority are preferred.
type: int
version_added: 11.0.0
autoconnect_retries:
@ -71,9 +71,9 @@ options:
ifname:
description:
- The interface to bind the connection to.
- The connection will only be applicable to this interface name.
- The connection is only applicable to this interface name.
- A special value of V(*) can be used for interface-independent connections.
- The ifname argument is mandatory for all connection types except bond, team, bridge, vlan and vpn.
- The O(ifname) argument is mandatory for all connection types except bond, team, bridge, vlan and vpn.
- This parameter defaults to O(conn_name) when left unset for all connection types except vpn that removes it.
type: str
type:
@ -501,7 +501,7 @@ options:
runner_fast_rate:
description:
- Option specifies the rate at which our link partner is asked to transmit LACPDU packets. If this is V(true) then packets
will be sent once per second. Otherwise they will be sent every 30 seconds.
are sent once per second. Otherwise they are sent every 30 seconds.
- Only allowed for O(runner=lacp).
type: bool
version_added: 6.5.0
@ -595,7 +595,7 @@ options:
- Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection.
- One of V(0) (use global default value), V(1) (disable FILS), V(2) (enable FILS if the supplicant and the access
point support it) or V(3) (enable FILS and fail if not supported).
- When set to V(0) and no global default is set, FILS will be optionally enabled.
- When set to V(0) and no global default is set, FILS is optionally enabled.
type: int
choices: [0, 1, 2, 3]
default: 0
@ -639,7 +639,7 @@ options:
- Indicates whether Protected Management Frames (802.11w) must be enabled for the connection.
- One of V(0) (use global default value), V(1) (disable PMF), V(2) (enable PMF if the supplicant and the access
point support it) or V(3) (enable PMF and fail if not supported).
- When set to V(0) and no global default is set, PMF will be optionally enabled.
- When set to V(0) and no global default is set, PMF is optionally enabled.
type: int
choices: [0, 1, 2, 3]
default: 0
@ -672,8 +672,8 @@ options:
description:
- Controls the interpretation of WEP keys.
- Allowed values are V(1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or
13-character ASCII password; or V(2), in which case the passphrase is provided as a string and will be hashed
using the de-facto MD5 method to derive the actual WEP key.
13-character ASCII password; or V(2), in which case the passphrase is provided as a string and it is hashed using
the de-facto MD5 method to derive the actual WEP key.
type: int
choices: [1, 2]
wep-key0:
@ -708,8 +708,8 @@ options:
wps-method:
description:
- Flags indicating which mode of WPS is to be used if any.
- There is little point in changing the default setting as NetworkManager will automatically determine whether it
is feasible to start WPS enrollment from the Access Point capabilities.
- There is little point in changing the default setting as NetworkManager automatically determines whether it is
feasible to start WPS enrollment from the Access Point capabilities.
- WPS can be disabled by setting this property to a value of V(1).
type: int
default: 0
@ -753,8 +753,8 @@ options:
description:
- 802.11 frequency band of the network.
- One of V(a) for 5GHz 802.11a or V(bg) for 2.4GHz 802.11.
- This will lock associations to the Wi-Fi network to the specific band, so for example, if V(a) is specified, the
device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible.
- This locks associations to the Wi-Fi network to the specific band, so for example, if V(a) is specified, the device
does not associate with the same network in the 2.4GHz band even if the network's settings are compatible.
- This setting depends on specific driver capability and may not work with all drivers.
type: str
choices: [a, bg]
@ -767,7 +767,7 @@ options:
channel:
description:
- Wireless channel to use for the Wi-Fi connection.
- The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel.
- The device only joins (or creates for Ad-Hoc networks) a Wi-Fi network on the specified channel.
- Because channel numbers overlap between bands, this property also requires the O(wifi.band) property to be set.
type: int
default: 0
@ -782,7 +782,7 @@ options:
- With O(wifi.cloned-mac-address) setting V(random) or V(stable), by default all bits of the MAC address are scrambled
and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits
are fixed.
- Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.
- Note that the least significant bit of the first MAC address is always unset to create a unicast MAC address.
- If the property is V(null), it is eligible to be overwritten by a default connection setting.
- If the value is still V(null) or an empty string, the default is to create a locally-administered, unicast MAC
address.
@ -792,12 +792,12 @@ options:
3 bytes using the V(random) or V(stable) algorithm.
- If the value contains one additional MAC address after the mask, this address is used instead of the current MAC
address to fill the bits that shall not be randomized.
- For example, a value of V(FE:FF:FF:00:00:00 68:F7:28:00:00:00) will set the OUI of the MAC address to 68:F7:28,
while the lower bits are randomized.
- A value of V(02:00:00:00:00:00 00:00:00:00:00:00) will create a fully scrambled globally-administered, burned-in
MAC address.
- For example, a value of V(FE:FF:FF:00:00:00 68:F7:28:00:00:00) sets the OUI of the MAC address to 68:F7:28, while
the lower bits are randomized.
- A value of V(02:00:00:00:00:00 00:00:00:00:00:00) creates a fully scrambled globally-administered, burned-in MAC
address.
- If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, V(02:00:00:00:00:00
00:00:00:00:00:00 02:00:00:00:00:00) will create a fully scrambled MAC address, randomly locally or globally administered.
00:00:00:00:00:00 02:00:00:00:00:00) creates a fully scrambled MAC address, randomly locally or globally administered.
type: str
hidden:
description:
@ -827,7 +827,7 @@ options:
choices: [0, 1, 2]
mac-address:
description:
- If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches.
- If specified, this connection only applies to the Wi-Fi device whose permanent MAC address matches.
- This property does not change the MAC address of the device (for example for MAC spoofing).
type: str
mode:
@ -896,25 +896,25 @@ options:
apn:
description:
- The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network.
- The APN often determines how the user will be billed for their network usage and whether the user has access to
the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's
mobile broadband plan.
- The APN often determines how the user is billed for their network usage and whether the user has access to the
Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile
broadband plan.
- The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
type: str
auto-config:
description: When V(true), the settings such as O(gsm.apn), O(gsm.username), or O(gsm.password) will default to values
that match the network the modem will register to in the Mobile Broadband Provider database.
description: When V(true), the settings such as O(gsm.apn), O(gsm.username), or O(gsm.password) default to values
that match the network the modem registers to in the Mobile Broadband Provider database.
type: bool
default: false
device-id:
description:
- The device unique identifier (as given by the V(WWAN) management service) which this connection applies to.
- If given, the connection will only apply to the specified device.
- If given, the connection only applies to the specified device.
type: str
home-only:
description:
- When V(true), only connections to the home network will be allowed.
- Connections to roaming networks will not be made.
- When V(true), only connections to the home network are allowed.
- Connections to roaming networks are not made.
type: bool
default: false
mtu:
@ -925,7 +925,7 @@ options:
network-id:
description:
- The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration.
- If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified
- If the Network ID is specified, NetworkManager attempts to force the device to register only on the specified
network.
- This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise
possible.
@ -944,7 +944,7 @@ options:
- NMSettingSecretFlags indicating how to handle the O(gsm.password) property.
- 'Following choices are allowed: V(0) B(NONE): The system is responsible for providing and storing this secret
(default), V(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when
it is required agents will be asked to retrieve it V(2) B(NOT_SAVED): This secret should not be saved, but should
it is required agents are asked to retrieve it V(2) B(NOT_SAVED): This secret should not be saved, but should
be requested from the user each time it is needed V(4) B(NOT_REQUIRED): In situations where it cannot be automatically
determined that the secret is required (some VPNs and PPP providers do not require all secrets) this flag indicates
that the specific secret is not required.'
@ -966,14 +966,14 @@ options:
sim-id:
description:
- The SIM card unique identifier (as given by the C(WWAN) management service) which this connection applies to.
- If given, the connection will apply to any device also allowed by O(gsm.device-id) which contains a SIM card matching
- If given, the connection applies to any device also allowed by O(gsm.device-id) which contains a SIM card matching
the given identifier.
type: str
sim-operator-id:
description:
- A MCC/MNC string like V(310260) or V(21601I) identifying the specific mobile network operator which this connection
applies to.
- If given, the connection will apply to any device also allowed by O(gsm.device-id) and O(gsm.sim-id) which contains
- If given, the connection applies to any device also allowed by O(gsm.device-id) and O(gsm.sim-id) which contains
a SIM card provisioned by the given operator.
type: str
username:
@ -1032,8 +1032,8 @@ options:
ip4-auto-default-route:
description:
- Whether to enable special handling of the IPv4 default route.
- If enabled, the IPv4 default route from O(wireguard.peer-routes) will be placed to a dedicated routing-table and
two policy routing rules will be added.
- If enabled, the IPv4 default route from O(wireguard.peer-routes) is placed to a dedicated routing-table and two
policy routing rules are added.
- The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table
is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved
Rule-based Routing".
@ -1043,7 +1043,7 @@ options:
- Like O(wireguard.ip4-auto-default-route), but for the IPv6 default route.
type: bool
listen-port:
description: The WireGuard connection listen-port. If not specified, the port will be chosen randomly when the interface
description: The WireGuard connection listen-port. If not specified, the port is chosen randomly when the interface
comes up.
type: int
mtu:
@ -1056,12 +1056,12 @@ options:
peer-routes:
description:
- Whether to automatically add routes for the AllowedIPs ranges of the peers.
- If V(true) (the default), NetworkManager will automatically add routes in the routing tables according to C(ipv4.route-table)
- If V(true) (the default), NetworkManager automatically adds routes in the routing tables according to C(ipv4.route-table)
and C(ipv6.route-table). Usually you want this automatism enabled.
- If V(false), no such routes are added automatically. In this case, the user may want to configure static routes
in C(ipv4.routes) and C(ipv6.routes), respectively.
- Note that if the peer's AllowedIPs is V(0.0.0.0/0) or V(::/0) and the profile's C(ipv4.never-default) or C(ipv6.never-default)
setting is enabled, the peer route for this peer will not be added automatically.
setting is enabled, the peer route for this peer is not added automatically.
type: bool
private-key:
description: The 256 bit private-key in base64 encoding.
@ -1079,7 +1079,7 @@ options:
version_added: 5.1.0
suboptions:
permissions:
description: User that will have permission to use the connection.
description: User that has permission to use the connection.
type: str
required: true
service-type:
@ -1096,7 +1096,7 @@ options:
- NMSettingSecretFlags indicating how to handle the C(vpn.password) property.
- 'Following choices are allowed: V(0) B(NONE): The system is responsible for providing and storing this secret
(default); V(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when
it is required agents will be asked to retrieve it; V(2) B(NOT_SAVED): This secret should not be saved, but should
it is required agents are asked to retrieve it; V(2) B(NOT_SAVED): This secret should not be saved, but should
be requested from the user each time it is needed; V(4) B(NOT_REQUIRED): In situations where it cannot be automatically
determined that the secret is required (some VPNs and PPP providers do not require all secrets) this flag indicates
that the specific secret is not required.'
@ -1115,7 +1115,8 @@ options:
ipsec-psk:
description:
- The pre-shared key in base64 encoding.
- "You can encode using this Ansible jinja2 expression: V(\"0s{{ '[YOUR PRE-SHARED KEY]' | ansible.builtin.b64encode }}\")."
- >
You can encode using this Ansible Jinja2 expression: V("0s{{ '[YOUR PRE-SHARED KEY]' | ansible.builtin.b64encode }}").
- This is only used when O(vpn.ipsec-enabled=true).
type: str
sriov:

12
plugins/modules/nosh.py
View file

@ -35,22 +35,22 @@ options:
required: false
choices: [started, stopped, reset, restarted, reloaded]
description:
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary.
- V(restarted) will always bounce the service.
- V(reloaded) will send a SIGHUP or start the service.
- V(reset) will start or stop the service according to whether it is enabled or not.
- V(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
- V(restarted) always bounces the service.
- V(reloaded) sends a SIGHUP or starts the service.
- V(reset) starts or stops the service according to whether it is enabled or not.
enabled:
required: false
type: bool
description:
- Enable or disable the service, independently of C(*.preset) file preference or running state. Mutually exclusive with
O(preset). Will take effect prior to O(state=reset).
O(preset). It takes effect prior to O(state=reset).
preset:
required: false
type: bool
description:
- Enable or disable the service according to local preferences in C(*.preset) files. Mutually exclusive with O(enabled).
Only has an effect if set to true. Will take effect prior to O(state=reset).
Only has an effect if set to true. It takes effect prior to O(state=reset).
user:
required: false
default: false

4
plugins/modules/nsupdate.py
View file

@ -63,8 +63,8 @@ options:
type: str
zone:
description:
- DNS record will be modified on this O(zone).
- When omitted DNS will be queried to attempt finding the correct zone.
- DNS record is modified on this O(zone).
- When omitted, DNS is queried to attempt finding the correct zone.
type: str
record:
description:

8
plugins/modules/office_365_connector_card.py
View file

@ -17,7 +17,7 @@ description:
U(https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#connector-card-for-microsoft-365-groups).
author: "Marc Sensenich (@marc-sensenich)"
notes:
- This module is not idempotent, therefore if the same task is run twice there will be two Connector Cards created.
- This module is not idempotent, therefore if you run the same task twice then you create two Connector Cards.
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -35,7 +35,7 @@ options:
type: str
description:
- A string used for summarizing card content.
- This will be shown as the message subject.
- This is the message subject.
- This is required if the text parameter is not populated.
color:
type: str
@ -49,13 +49,13 @@ options:
type: str
description:
- The main text of the card.
- This will be rendered below the sender information and optional title,
- This is rendered below the sender information and optional title,
- And above any sections or actions present.
actions:
type: list
elements: dict
description:
- This array of objects will power the action links found at the bottom of the card.
- This array of objects is used to power the action links found at the bottom of the card.
sections:
type: list
elements: dict

4
plugins/modules/one_host.py
View file

@ -36,8 +36,8 @@ options:
state:
description:
- Takes the host to the desired lifecycle state.
- If V(absent) the host will be deleted from the cluster.
- If V(present) the host will be created in the cluster (includes V(enabled), V(disabled) and V(offline) states).
- If V(absent) the host is deleted from the cluster.
- If V(present) the host is created in the cluster (includes V(enabled), V(disabled) and V(offline) states).
- If V(enabled) the host is fully operational.
- V(disabled), for example to perform maintenance operations.
- V(offline), host is totally offline.

6
plugins/modules/one_image.py
View file

@ -48,8 +48,8 @@ options:
type: bool
new_name:
description:
- A name that will be assigned to the existing or new image.
- In the case of cloning, by default O(new_name) will take the name of the origin image with the prefix 'Copy of'.
- A name that is assigned to the existing or new image.
- In the case of cloning, by default O(new_name) is set to the name of the origin image with the prefix 'Copy of'.
type: str
persistent:
description:
@ -325,7 +325,7 @@ datastore:
returned: when O(state=present), O(state=cloned), or O(state=renamed)
version_added: 9.5.0
vms:
description: The image's list of vm ID's.
description: The image's list of VM ID's.
type: list
elements: int
returned: when O(state=present), O(state=cloned), or O(state=renamed)

10
plugins/modules/one_image_info.py
View file

@ -29,10 +29,10 @@ options:
elements: str
name:
description:
- A O(name) of the image whose facts will be gathered.
- If the O(name) begins with V(~) the O(name) will be used as regex pattern, which restricts the list of images (whose
facts will be returned) whose names match specified regex.
- Also, if the O(name) begins with V(~*) case-insensitive matching will be performed.
- A O(name) of the image whose facts is gathered.
- If the O(name) begins with V(~) the O(name) is used as regex pattern, which restricts the list of images (whose facts
is returned) whose names match specified regex.
- Also, if the O(name) begins with V(~*) case-insensitive matching is performed.
- See examples for more details.
type: str
author:
@ -231,7 +231,7 @@ images:
sample: image_datastore
version_added: 9.5.0
vms:
description: The image's list of vm ID's.
description: The image's list of VM ID's.
type: list
elements: int
version_added: 9.5.0

8
plugins/modules/one_service.py
View file

@ -55,7 +55,7 @@ options:
type: str
unique:
description:
- Setting O(unique=true) will make sure that there is only one service instance running with a name set with O(service_name)
- Setting O(unique=true) ensures that there is only one service instance running with a name set with O(service_name)
when instantiating a service from a template specified with O(template_id) or O(template_name). Check examples below.
type: bool
default: false
@ -73,11 +73,11 @@ options:
type: str
owner_id:
description:
- ID of the user which will be set as the owner of the service.
- ID of the user which is set as the owner of the service.
type: int
group_id:
description:
- ID of the group which will be set as the group of the service.
- ID of the group which is set as the group of the service.
type: int
wait:
description:
@ -91,7 +91,7 @@ options:
type: int
custom_attrs:
description:
- Dictionary of key/value custom attributes which will be used when instantiating a new service.
- Dictionary of key/value custom attributes which is used when instantiating a new service.
default: {}
type: dict
role:

6
plugins/modules/one_template.py
View file

@ -33,12 +33,12 @@ attributes:
options:
id:
description:
- A O(id) of the template you would like to manage. If not set then a new template will be created with the given O(name).
- A O(id) of the template you would like to manage. If not set then a new template is created with the given O(name).
type: int
name:
description:
- A O(name) of the template you would like to manage. If a template with the given name does not exist it will be created,
otherwise it will be managed by this module.
- A O(name) of the template you would like to manage. If a template with the given name does not exist it is created,
otherwise it is managed by this module.
type: str
template:
description:

171
plugins/modules/one_vm.py
View file

@ -39,7 +39,7 @@ options:
api_password:
description:
- Password of the user to login into OpenNebula RPC server. If not set then the value of the E(ONE_PASSWORD) environment
variable is used. if both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth
variable is used. 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.
type: str
@ -53,7 +53,7 @@ options:
type: int
vm_start_on_hold:
description:
- Set to true to put vm on hold while creating.
- Set to true to put VM on hold while creating.
default: false
type: bool
instance_ids:
@ -80,7 +80,7 @@ options:
wait:
description:
- Wait for the instance to reach its desired state before returning. Keep in mind if you are waiting for instance to
be in running state it does not mean that you will be able to SSH on that machine only that boot process have started
be in running state it does not mean that you are able to SSH on that machine only that boot process have started
on that instance. See the example using the M(ansible.builtin.wait_for) module for details.
default: true
type: bool
@ -94,9 +94,9 @@ options:
- A dictionary of key/value attributes to add to new instances, or for setting C(state) of instances with these attributes.
- Keys are case insensitive and OpenNebula automatically converts them to upper case.
- Be aware V(NAME) is a special attribute which sets the name of the VM when it is deployed.
- C(#) character(s) can be appended to the C(NAME) and the module will automatically add indexes to the names of VMs.
- C(#) character(s) can be appended to the C(NAME) and the module automatically adds indexes to the names of VMs.
- 'For example: V(NAME: foo-###) would create VMs with names V(foo-000), V(foo-001),...'
- When used with O(count_attributes) and O(exact_count) the module will match the base name without the index part.
- When used with O(count_attributes) and O(exact_count) the module matches the base name without the index part.
default: {}
type: dict
labels:
@ -126,7 +126,7 @@ options:
description:
- Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances
are either created or terminated based on this value.
- B(NOTE:) Instances with the least IDs will be terminated first.
- B(NOTE:) Instances with the least IDs are terminated first.
type: int
mode:
description:
@ -135,11 +135,11 @@ options:
type: str
owner_id:
description:
- ID of the user which will be set as the owner of the instance.
- ID of the user which is set as the owner of the instance.
type: int
group_id:
description:
- ID of the group which will be set as the group of the instance.
- ID of the group which is set as the group of the instance.
type: int
memory:
description:
@ -157,7 +157,7 @@ options:
type: float
vcpu:
description:
- Number of CPUs (cores) new VM will have.
- Number of CPUs (cores) the new VM uses.
type: int
networks:
description:
@ -170,9 +170,9 @@ options:
- Creates an image from a VM disk.
- It is a dictionary where you have to specify C(name) of the new image.
- Optionally you can specify C(disk_id) of the disk you want to save. By default C(disk_id) is 0.
- B(NOTE:) This operation will only be performed on the first VM (if more than one VM ID is passed) and the VM has to
be in the C(poweredoff) state.
- Also this operation will fail if an image with specified C(name) already exists.
- B(NOTE:) This operation is only performed on the first VM (if more than one VM ID is passed) and the VM has to be
in the C(poweredoff) state.
- Also this operation fails if an image with specified C(name) already exists.
type: dict
persistent:
description:
@ -195,14 +195,16 @@ options:
- When O(instance_ids) is provided, updates running VMs with the C(updateconf) API call.
- When new VMs are being created, emulates the C(updateconf) API call using direct template merge.
- Allows for complete modifications of the C(CONTEXT) attribute.
- "Supported attributes include:"
- 'Supported attributes include:'
- B(BACKUP_CONFIG:) V(BACKUP_VOLATILE), V(FS_FREEZE), V(INCREMENT_MODE), V(KEEP_LAST), V(MODE);
- B(CONTEXT:) (Any value, except V(ETH*). Variable substitution will be made);
- B(CONTEXT:) (Any value, except V(ETH*). Variable substitutions are made);
- B(CPU_MODEL:) V(FEATURES), V(MODEL);
- B(FEATURES:) V(ACPI), V(APIC), V(GUEST_AGENT), V(HYPERV), V(IOTHREADS), V(LOCALTIME), V(PAE), V(VIRTIO_BLK_QUEUES), V(VIRTIO_SCSI_QUEUES);
- B(FEATURES:) V(ACPI), V(APIC), V(GUEST_AGENT), V(HYPERV), V(IOTHREADS), V(LOCALTIME), V(PAE), V(VIRTIO_BLK_QUEUES),
V(VIRTIO_SCSI_QUEUES);
- B(GRAPHICS:) V(COMMAND), V(KEYMAP), V(LISTEN), V(PASSWD), V(PORT), V(TYPE);
- B(INPUT:) V(BUS), V(TYPE);
- B(OS:) V(ARCH), V(BOOT), V(BOOTLOADER), V(FIRMWARE), V(INITRD), V(KERNEL), V(KERNEL_CMD), V(MACHINE), V(ROOT), V(SD_DISK_BUS), V(UUID);
- B(OS:) V(ARCH), V(BOOT), V(BOOTLOADER), V(FIRMWARE), V(INITRD), V(KERNEL), V(KERNEL_CMD), V(MACHINE), V(ROOT), V(SD_DISK_BUS),
V(UUID);
- B(RAW:) V(DATA), V(DATA_VMX), V(TYPE), V(VALIDATE);
- B(VIDEO:) V(ATS), V(IOMMU), V(RESOLUTION), V(TYPE), V(VRAM).
type: dict
@ -453,35 +455,35 @@ instances:
returned: success
contains:
vm_id:
description: Vm ID.
description: VM ID.
type: int
sample: 153
vm_name:
description: Vm name.
description: VM name.
type: str
sample: foo
template_id:
description: Vm's template ID.
description: VM's template ID.
type: int
sample: 153
group_id:
description: Vm's group ID.
description: VM's group ID.
type: int
sample: 1
group_name:
description: Vm's group name.
description: VM's group name.
type: str
sample: one-users
owner_id:
description: Vm's owner ID.
description: VM's owner ID.
type: int
sample: 143
owner_name:
description: Vm's owner name.
description: VM's owner name.
type: str
sample: app-user
mode:
description: Vm's mode.
description: VM's mode.
type: str
returned: success
sample: 660
@ -512,20 +514,21 @@ instances:
networks:
description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC.
type: list
sample: [
{
"ip": "10.120.5.33",
"mac": "02:00:0a:78:05:21",
"name": "default-test-private",
"security_groups": "0,10"
},
{
"ip": "10.120.5.34",
"mac": "02:00:0a:78:05:22",
"name": "default-test-private",
"security_groups": "0"
}
]
sample:
[
{
"ip": "10.120.5.33",
"mac": "02:00:0a:78:05:21",
"name": "default-test-private",
"security_groups": "0,10"
},
{
"ip": "10.120.5.34",
"mac": "02:00:0a:78:05:22",
"name": "default-test-private",
"security_groups": "0"
}
]
uptime_h:
description: Uptime of the instance in hours.
type: int
@ -537,23 +540,27 @@ instances:
attributes:
description: A dictionary of key/values attributes that are associated with the instance.
type: dict
sample: {
"HYPERVISOR": "kvm",
"LOGO": "images/logos/centos.png",
"TE_GALAXY": "bar",
"USER_INPUTS": null
}
sample:
{
"HYPERVISOR": "kvm",
"LOGO": "images/logos/centos.png",
"TE_GALAXY": "bar",
"USER_INPUTS": null
}
updateconf:
description: A dictionary of key/values attributes that are set with the updateconf API call.
type: dict
version_added: 6.3.0
sample: {
"OS": { "ARCH": "x86_64" },
"CONTEXT": {
"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0",
"SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..."
sample:
{
"OS": {
"ARCH": "x86_64"
},
"CONTEXT": {
"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0",
"SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..."
}
}
}
tagged_instances:
description:
- A list of instances info based on a specific attributes and/or labels that are specified with O(count_attributes) and
@ -562,35 +569,35 @@ tagged_instances:
returned: success
contains:
vm_id:
description: Vm ID.
description: VM ID.
type: int
sample: 153
vm_name:
description: Vm name.
description: VM name.
type: str
sample: foo
template_id:
description: Vm's template ID.
description: VM's template ID.
type: int
sample: 153
group_id:
description: Vm's group ID.
description: VM's group ID.
type: int
sample: 1
group_name:
description: Vm's group name.
description: VM's group name.
type: str
sample: one-users
owner_id:
description: Vm's user ID.
description: VM's user ID.
type: int
sample: 143
owner_name:
description: Vm's user name.
description: VM's user name.
type: str
sample: app-user
mode:
description: Vm's mode.
description: VM's mode.
type: str
returned: success
sample: 660
@ -621,20 +628,21 @@ tagged_instances:
networks:
description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC.
type: list
sample: [
{
"ip": "10.120.5.33",
"mac": "02:00:0a:78:05:21",
"name": "default-test-private",
"security_groups": "0,10"
},
{
"ip": "10.120.5.34",
"mac": "02:00:0a:78:05:22",
"name": "default-test-private",
"security_groups": "0"
}
]
sample:
[
{
"ip": "10.120.5.33",
"mac": "02:00:0a:78:05:21",
"name": "default-test-private",
"security_groups": "0,10"
},
{
"ip": "10.120.5.34",
"mac": "02:00:0a:78:05:22",
"name": "default-test-private",
"security_groups": "0"
}
]
uptime_h:
description: Uptime of the instance in hours.
type: int
@ -646,12 +654,27 @@ tagged_instances:
attributes:
description: A dictionary of key/values attributes that are associated with the instance.
type: dict
sample: {"HYPERVISOR": "kvm", "LOGO": "images/logos/centos.png", "TE_GALAXY": "bar", "USER_INPUTS": null}
sample:
{
"HYPERVISOR": "kvm",
"LOGO": "images/logos/centos.png",
"TE_GALAXY": "bar",
"USER_INPUTS": null
}
updateconf:
description: A dictionary of key/values attributes that are set with the updateconf API call.
type: dict
version_added: 6.3.0
sample: {"OS": {"ARCH": "x86_64"}, "CONTEXT": {"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0", "SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..."}}
sample:
{
"OS": {
"ARCH": "x86_64"
},
"CONTEXT": {
"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0",
"SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..."
}
}
"""
try:

6
plugins/modules/one_vnet.py
View file

@ -30,12 +30,12 @@ options:
id:
description:
- A O(id) of the network you would like to manage.
- If not set then a new network will be created with the given O(name).
- If not set then a new network is created with the given O(name).
type: int
name:
description:
- A O(name) of the network you would like to manage. If a network with the given name does not exist it will be created,
otherwise it will be managed by this module.
- A O(name) of the network you would like to manage. If a network with the given name does not exist it, then is created,
otherwise it is managed by this module.
type: str
template:
description:

14
plugins/modules/oneandone_firewall_policy.py
View file

@ -46,14 +46,14 @@ options:
type: str
rules:
description:
- A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to
three optional parameters (port_from, port_to, and source).
- List of rules that are set for the firewall policy. Each rule must contain protocol parameter, in addition to three
optional parameters (port_from, port_to, and source).
type: list
elements: dict
default: []
add_server_ips:
description:
- A list of server identifiers (id or name) to be assigned to a firewall policy. Used in combination with update state.
- A list of server identifiers (ID or name) to be assigned to a firewall policy. Used in combination with update state.
type: list
elements: str
required: false
@ -67,15 +67,15 @@ options:
default: []
add_rules:
description:
- A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules
parameter. Used in combination with update state.
- List of rules that are added to an existing firewall policy. It is syntax is the same as the one used for rules parameter.
Used in combination with update state.
type: list
elements: dict
required: false
default: []
remove_rules:
description:
- A list of rule IDs that will be removed from an existing firewall policy. Used in combination with update state.
- List of rule IDs that are removed from an existing firewall policy. Used in combination with update state.
type: list
elements: str
required: false
@ -194,7 +194,7 @@ RETURN = r"""
firewall_policy:
description: Information about the firewall policy that was processed.
type: dict
sample: '{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}'
sample: {"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}
returned: always
"""

14
plugins/modules/oneandone_load_balancer.py
View file

@ -78,15 +78,15 @@ options:
choices: ["ROUND_ROBIN", "LEAST_CONNECTIONS"]
datacenter:
description:
- ID or country code of the datacenter where the load balancer will be created.
- ID or country code of the datacenter where the load balancer is created.
- If not specified, it defaults to V(US).
type: str
choices: ["US", "ES", "DE", "GB"]
required: false
rules:
description:
- A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and
port_server parameters, in addition to source parameter, which is optional.
- A list of rule objects that are set for the load balancer. Each rule must contain protocol, port_balancer, and port_server
parameters, in addition to source parameter, which is optional.
type: list
elements: dict
default: []
@ -111,15 +111,15 @@ options:
default: []
add_rules:
description:
- A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules
parameter. Used in combination with O(state=update).
- A list of rules that are added to an existing load balancer. It is syntax is the same as the one used for rules parameter.
Used in combination with O(state=update).
type: list
elements: dict
required: false
default: []
remove_rules:
description:
- A list of rule IDs that will be removed from an existing load balancer. Used in combination with O(state=update).
- A list of rule IDs that are removed from an existing load balancer. Used in combination with O(state=update).
type: list
elements: str
required: false
@ -245,7 +245,7 @@ RETURN = r"""
load_balancer:
description: Information about the load balancer that was processed.
type: dict
sample: '{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Balancer"}'
sample: {"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Balancer"}
returned: always
"""

6
plugins/modules/oneandone_monitoring_policy.py
View file

@ -89,7 +89,7 @@ options:
required: true
ports:
description:
- Array of ports that will be monitoring.
- Array of ports that are to be monitored.
type: list
elements: dict
default: []
@ -114,7 +114,7 @@ options:
required: true
processes:
description:
- Array of processes that will be monitoring.
- Array of processes that are to be monitored.
type: list
elements: dict
default: []
@ -413,7 +413,7 @@ RETURN = r"""
monitoring_policy:
description: Information about the monitoring policy that was processed.
type: dict
sample: '{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}'
sample: {"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}
returned: always
"""

4
plugins/modules/oneandone_private_network.py
View file

@ -50,7 +50,7 @@ options:
type: str
datacenter:
description:
- The identifier of the datacenter where the private network will be created.
- The identifier of the datacenter where the private network is created.
type: str
choices: [US, ES, DE, GB]
network_address:
@ -143,7 +143,7 @@ RETURN = r"""
private_network:
description: Information about the private network.
type: dict
sample: '{"name": "backup_network", "id": "55726DEDA20C99CF6F2AF8F18CAC9963"}'
sample: {"name": "backup_network", "id": "55726DEDA20C99CF6F2AF8F18CAC9963"}
returned: always
"""

4
plugins/modules/oneandone_public_ip.py
View file

@ -43,7 +43,7 @@ options:
required: false
datacenter:
description:
- ID of the datacenter where the IP will be created (only for unassigned IPs).
- ID of the datacenter where the IP is created (only for unassigned IPs).
type: str
choices: [US, ES, DE, GB]
default: US
@ -110,7 +110,7 @@ RETURN = r"""
public_ip:
description: Information about the public IP that was processed.
type: dict
sample: '{"id": "F77CC589EBC120905B4F4719217BFF6D", "ip": "10.5.132.106"}'
sample: {"id": "F77CC589EBC120905B4F4719217BFF6D", "ip": "10.5.132.106"}
returned: always
"""

4
plugins/modules/oneandone_server.py
View file

@ -73,8 +73,8 @@ options:
type: float
hdds:
description:
- A list of hard disks with nested O(ignore:hdds[].size) and O(ignore:hdds[].is_main) properties. It must be provided with O(vcore),
O(cores_per_processor), and O(ram) parameters.
- A list of hard disks with nested O(ignore:hdds[].size) and O(ignore:hdds[].is_main) properties. It must be provided
with O(vcore), O(cores_per_processor), and O(ram) parameters.
type: list
elements: dict
private_network:

7
plugins/modules/onepassword_info.py
View file

@ -51,7 +51,7 @@ options:
section:
type: str
description:
- The name of a section within this item containing the specified field (optional, will search all sections if not
- The name of a section within this item containing the specified field (optional, it searches all sections if not
specified).
vault:
type: str
@ -62,8 +62,7 @@ options:
auto_login:
type: dict
description:
- A dictionary containing authentication details. If this is set, M(community.general.onepassword_info) will attempt
to sign in to 1Password automatically.
- A dictionary containing authentication details. If this is set, the module attempts to sign in to 1Password automatically.
- Without this option, you must have already logged in using the 1Password CLI before running Ansible.
- It is B(highly) recommended to store 1Password credentials in an Ansible Vault. Ensure that the key used to encrypt
the Ansible Vault is equal to or greater in strength than the 1Password master password.
@ -72,7 +71,7 @@ options:
type: str
description:
- 1Password subdomain name (V(subdomain).1password.com).
- If this is not specified, the most recent subdomain will be used.
- If this is not specified, the most recent subdomain is used.
username:
type: str
description:

6
plugins/modules/oneview_ethernet_network.py
View file

@ -27,9 +27,9 @@ options:
state:
description:
- Indicates the desired state for the Ethernet Network resource.
- V(present) will ensure data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists.
- V(default_bandwidth_reset) will reset the network connection template to the default.
- V(present) ensures data properties are compliant with OneView.
- V(absent) removes the resource from OneView, if it exists.
- V(default_bandwidth_reset) resets the network connection template to the default.
type: str
default: present
choices: [present, absent, default_bandwidth_reset]

4
plugins/modules/oneview_fc_network.py
View file

@ -24,8 +24,8 @@ options:
state:
description:
- Indicates the desired state for the Fibre Channel Network resource.
- V(present) will ensure data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists.
- V(present) ensures data properties are compliant with OneView.
- V(absent) removes the resource from OneView, if it exists.
type: str
choices: ['present', 'absent']
required: true

4
plugins/modules/oneview_fcoe_network.py
View file

@ -25,8 +25,8 @@ options:
state:
description:
- Indicates the desired state for the FCoE Network resource.
- V(present) will ensure data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists.
- V(present) ensures data properties are compliant with OneView.
- V(absent) removes the resource from OneView, if it exists.
type: str
default: present
choices: ['present', 'absent']

4
plugins/modules/oneview_logical_interconnect_group.py
View file

@ -28,8 +28,8 @@ options:
state:
description:
- Indicates the desired state for the Logical Interconnect Group resource.
- V(absent) will remove the resource from OneView, if it exists.
- V(present) will ensure data properties are compliant with OneView.
- V(absent) removes the resource from OneView, if it exists.
- V(present) ensures data properties are compliant with OneView.
type: str
choices: [absent, present]
default: present

4
plugins/modules/oneview_network_set.py
View file

@ -27,8 +27,8 @@ options:
state:
description:
- Indicates the desired state for the Network Set resource.
- V(present) will ensure data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists.
- V(present) ensures data properties are compliant with OneView.
- V(absent) removes the resource from OneView, if it exists.
type: str
default: present
choices: ['present', 'absent']

2
plugins/modules/online_server_info.py
View file

@ -41,7 +41,7 @@ online_server_info:
type: list
elements: dict
sample:
"online_server_info": [
[
{
"abuse": "abuse@example.com",
"anti_ddos": false,

2
plugins/modules/online_user_info.py
View file

@ -37,7 +37,7 @@ online_user_info:
returned: success
type: dict
sample:
"online_user_info": {
{
"company": "foobar LLC",
"email": "foobar@example.com",
"first_name": "foo",

6
plugins/modules/open_iscsi.py
View file

@ -44,7 +44,7 @@ options:
login:
description:
- Whether the target node should be connected.
- When O(target) is omitted, will login to all available.
- When O(target) is omitted, it logins to all available.
type: bool
aliases: [state]
node_auth:
@ -84,7 +84,7 @@ options:
description:
- Whether the list of target nodes on the portal should be (re)discovered and added to the persistent iSCSI database.
- Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) to manual, hence combined with
O(auto_node_startup=true) will always return a changed state.
O(auto_node_startup=true) always returns a changed state.
type: bool
default: false
show_nodes:
@ -95,7 +95,7 @@ options:
rescan:
description:
- Rescan an established session for discovering new targets.
- When O(target) is omitted, will rescan all sessions.
- When O(target) is omitted, it rescans all sessions.
type: bool
default: false
version_added: 4.1.0

8
plugins/modules/openbsd_pkg.py
View file

@ -36,9 +36,9 @@ options:
elements: str
state:
description:
- V(present) will make sure the package is installed.
- V(latest) will make sure the latest version of the package is installed.
- V(absent) will make sure the specified package is not installed.
- V(present) ensures the package is installed.
- V(latest) ensures the latest version of the package is installed.
- V(absent) ensures the specified package is not installed.
choices: [absent, latest, present, installed, removed]
default: present
type: str
@ -73,7 +73,7 @@ options:
type: bool
default: false
notes:
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
- When used with a C(loop:) each package is processed individually, it is much more efficient to pass the list directly
to the O(name) option.
"""

6
plugins/modules/opendj_backendprop.py
View file

@ -10,10 +10,10 @@ __metaclass__ = type
DOCUMENTATION = r"""
module: opendj_backendprop
short_description: Will update the backend configuration of OpenDJ using the dsconfig set-backend-prop command
short_description: Update the backend configuration of OpenDJ using the dsconfig set-backend-prop command
description:
- This module will update settings for OpenDJ with the command set-backend-prop.
- It will check first using de get-backend-prop if configuration needs to be applied.
- This module updates settings for OpenDJ with the command C(set-backend-prop).
- It checks first using C(get-backend-prop) if configuration needs to be applied.
author:
- Werner Dijkerman (@dj-wasabi)
extends_documentation_fragment:

13
plugins/modules/openwrt_init.py
View file

@ -32,20 +32,19 @@ options:
state:
type: str
description:
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary.
- V(restarted) will always bounce the service.
- V(reloaded) will always reload.
- V(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
- V(restarted) always bounces the service.
- V(reloaded) always reloads.
choices: ['started', 'stopped', 'restarted', 'reloaded']
enabled:
description:
- Whether the service should start on boot. B(At least one of state and enabled are required).
- Whether the service should start on boot. B(At least one) of O(state) and O(enabled) are required.
type: bool
pattern:
type: str
description:
- If the service does not respond to the 'running' command, name a substring to look for as would be found in the output
of the C(ps) command as a stand-in for a 'running' result. If the string is found, the service will be assumed to
be running.
- If the service does not respond to the C(running) command, name a substring to look for as would be found in the output
of the C(ps) command as a stand-in for a C(running) result. If the string is found, the service is assumed to be running.
notes:
- One option other than O(name) is required.
requirements:

2
plugins/modules/osx_defaults.py
View file

@ -69,7 +69,7 @@ options:
state:
description:
- The state of the user defaults.
- If set to V(list) will query the given parameter specified by O(key). Returns V(null) is nothing found or mis-spelled.
- If set to V(list) it queries the given parameter specified by O(key). Returns V(null) is nothing found or misspelled.
type: str
choices: [absent, list, present]
default: present

4
plugins/modules/ovh_ip_failover.py
View file

@ -49,13 +49,13 @@ options:
default: true
type: bool
description:
- If true, the module will wait for the IP address to be moved. If false, exit without waiting. The taskId will be returned
- If V(true), the module waits for the IP address to be moved. If false, exit without waiting. The C(taskId) is returned
in module output.
wait_task_completion:
required: false
default: 0
description:
- If not 0, the module will wait for this task ID to be completed. Use O(wait_task_completion) if you want to wait for
- If not V(0), the module waits for this task ID to be completed. Use O(wait_task_completion) if you want to wait for
completion of a previously executed task with O(wait_completion=false). You can execute this module repeatedly on
a list of failover IPs using O(wait_completion=false) (see examples).
type: int