pr*: style adjustments (#9524)
* pr*: style adjustments * revert removal of "null" * Update plugins/modules/redfish_command.py * Update plugins/modules/redhat_subscription.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>pull/9563/head
parent
3f7ea60766
commit
568fcea15e
|
@ -30,7 +30,8 @@ options:
|
||||||
type: str
|
type: str
|
||||||
node:
|
node:
|
||||||
description:
|
description:
|
||||||
- Specify which node of the cluster you want to manage. V(null) == the cluster status itself, V(all) == check the status of all nodes.
|
- Specify which node of the cluster you want to manage. V(null) == the cluster status itself, V(all) == check the status
|
||||||
|
of all nodes.
|
||||||
type: str
|
type: str
|
||||||
timeout:
|
timeout:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -111,8 +111,10 @@ options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Desired state of the device.
|
- Desired state of the device.
|
||||||
- If set to V(present) (the default), the module call will return immediately after the device-creating HTTP request successfully returns.
|
- If set to V(present) (the default), the module call will return immediately after the device-creating HTTP request
|
||||||
- If set to V(active), the module call will block until all the specified devices are in state active due to the Packet API, or until O(wait_timeout).
|
successfully returns.
|
||||||
|
- If set to V(active), the module call will block until all the specified devices are in state active due to the Packet
|
||||||
|
API, or until O(wait_timeout).
|
||||||
choices: [present, absent, active, inactive, rebooted]
|
choices: [present, absent, active, inactive, rebooted]
|
||||||
default: present
|
default: present
|
||||||
type: str
|
type: str
|
||||||
|
@ -133,7 +135,8 @@ options:
|
||||||
wait_timeout:
|
wait_timeout:
|
||||||
description:
|
description:
|
||||||
- How long (seconds) to wait either for automatic IP address assignment, or for the device to reach the V(active) state.
|
- How long (seconds) to wait either for automatic IP address assignment, or for the device to reach the V(active) state.
|
||||||
- If O(wait_for_public_IPv) is set and O(state=active), the module will wait for both events consequently, applying the timeout twice.
|
- If O(wait_for_public_IPv) is set and O(state=active), the module will wait for both events consequently, applying
|
||||||
|
the timeout twice.
|
||||||
default: 900
|
default: 900
|
||||||
type: int
|
type: int
|
||||||
|
|
||||||
|
@ -262,7 +265,7 @@ changed:
|
||||||
returned: success
|
returned: success
|
||||||
|
|
||||||
devices:
|
devices:
|
||||||
description: Information about each device that was processed
|
description: Information about each device that was processed.
|
||||||
type: list
|
type: list
|
||||||
sample:
|
sample:
|
||||||
- {
|
- {
|
||||||
|
|
|
@ -75,9 +75,10 @@ options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Desired state of the IP subnet on the specified device.
|
- Desired state of the IP subnet on the specified device.
|
||||||
- With O(state=present), you must specify either O(hostname) or O(device_id). Subnet with given CIDR will then be assigned to the specified
|
- With O(state=present), you must specify either O(hostname) or O(device_id). Subnet with given CIDR will then be assigned
|
||||||
device.
|
to the specified device.
|
||||||
- With O(state=absent), you can specify either O(hostname) or O(device_id). The subnet will be removed from specified devices.
|
- With O(state=absent), you can specify either O(hostname) or O(device_id). The subnet will be removed from specified
|
||||||
|
devices.
|
||||||
- If you leave both O(hostname) and O(device_id) empty, the subnet will be removed from any device it is assigned to.
|
- If you leave both O(hostname) and O(device_id) empty, the subnet will be removed from any device it is assigned to.
|
||||||
choices: ['present', 'absent']
|
choices: ['present', 'absent']
|
||||||
default: 'present'
|
default: 'present'
|
||||||
|
|
|
@ -18,8 +18,8 @@ short_description: Attach/detach a volume to a device in the Packet host
|
||||||
description:
|
description:
|
||||||
- Attach/detach a volume to a device in the Packet host.
|
- Attach/detach a volume to a device in the Packet host.
|
||||||
- API is documented at U(https://www.packet.com/developers/api/volumes/).
|
- API is documented at U(https://www.packet.com/developers/api/volumes/).
|
||||||
- This module creates the attachment route in the Packet API. In order to discover the block devices on the server, you have to run the Attach
|
- This module creates the attachment route in the Packet API. In order to discover the block devices on the server, you
|
||||||
Scripts, as documented at U(https://help.packet.net/technical/storage/packet-block-storage-linux).
|
have to run the Attach Scripts, as documented at U(https://help.packet.net/technical/storage/packet-block-storage-linux).
|
||||||
version_added: '0.2.0'
|
version_added: '0.2.0'
|
||||||
|
|
||||||
author:
|
author:
|
||||||
|
|
|
@ -32,7 +32,8 @@ attributes:
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name or list of names of the package(s) or file(s) to install, upgrade, or remove. Cannot be used in combination with O(upgrade).
|
- Name or list of names of the package(s) or file(s) to install, upgrade, or remove. Cannot be used in combination with
|
||||||
|
O(upgrade).
|
||||||
aliases: [package, pkg]
|
aliases: [package, pkg]
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
|
@ -50,7 +51,8 @@ options:
|
||||||
force:
|
force:
|
||||||
description:
|
description:
|
||||||
- When removing packages, forcefully remove them, without any checks. Same as O(extra_args="--nodeps --nodeps").
|
- When removing packages, forcefully remove them, without any checks. Same as O(extra_args="--nodeps --nodeps").
|
||||||
- When combined with O(update_cache), force a refresh of all package databases. Same as O(update_cache_extra_args="--refresh --refresh").
|
- When combined with O(update_cache), force a refresh of all package databases. Same as O(update_cache_extra_args="--refresh
|
||||||
|
--refresh").
|
||||||
default: false
|
default: false
|
||||||
type: bool
|
type: bool
|
||||||
|
|
||||||
|
@ -64,8 +66,8 @@ options:
|
||||||
executable:
|
executable:
|
||||||
description:
|
description:
|
||||||
- Path of the binary to use. This can either be C(pacman) or a pacman compatible AUR helper.
|
- Path of the binary to use. This can either be C(pacman) or a pacman compatible AUR helper.
|
||||||
- Pacman compatibility is unfortunately ill defined, in particular, this modules makes extensive use of the C(--print-format) directive
|
- Pacman compatibility is unfortunately ill defined, in particular, this modules makes extensive use of the C(--print-format)
|
||||||
which is known not to be implemented by some AUR helpers (notably, C(yay)).
|
directive which is known not to be implemented by some AUR helpers (notably, C(yay)).
|
||||||
- Beware that AUR helpers might behave unexpectedly and are therefore not recommended.
|
- Beware that AUR helpers might behave unexpectedly and are therefore not recommended.
|
||||||
default: pacman
|
default: pacman
|
||||||
type: str
|
type: str
|
||||||
|
@ -82,8 +84,8 @@ options:
|
||||||
- Whether or not to refresh the master package lists.
|
- Whether or not to refresh the master package lists.
|
||||||
- This can be run as part of a package installation or as a separate step.
|
- This can be run as part of a package installation or as a separate step.
|
||||||
- If not specified, it defaults to V(false).
|
- If not specified, it defaults to V(false).
|
||||||
- Please note that this option only had an influence on the module's C(changed) state if O(name) and O(upgrade) are not specified before
|
- Please note that this option only had an influence on the module's C(changed) state if O(name) and O(upgrade) are
|
||||||
community.general 5.0.0. See the examples for how to keep the old behavior.
|
not specified before community.general 5.0.0. See the examples for how to keep the old behavior.
|
||||||
type: bool
|
type: bool
|
||||||
|
|
||||||
update_cache_extra_args:
|
update_cache_extra_args:
|
||||||
|
@ -114,27 +116,29 @@ options:
|
||||||
reason_for:
|
reason_for:
|
||||||
description:
|
description:
|
||||||
- Set the install reason for V(all) packages or only for V(new) packages.
|
- Set the install reason for V(all) packages or only for V(new) packages.
|
||||||
- In case of O(state=latest) already installed packages which will be updated to a newer version are not counted as V(new).
|
- In case of O(state=latest) already installed packages which will be updated to a newer version are not counted as
|
||||||
|
V(new).
|
||||||
default: new
|
default: new
|
||||||
choices: [all, new]
|
choices: [all, new]
|
||||||
type: str
|
type: str
|
||||||
version_added: 5.4.0
|
version_added: 5.4.0
|
||||||
|
|
||||||
notes:
|
notes:
|
||||||
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name)
|
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
|
||||||
option.
|
to the O(name) option.
|
||||||
- To use an AUR helper (O(executable) option), a few extra setup steps might be required beforehand. For example, a dedicated build user with
|
- To use an AUR helper (O(executable) option), a few extra setup steps might be required beforehand. For example, a dedicated
|
||||||
permissions to install packages could be necessary.
|
build user with permissions to install packages could be necessary.
|
||||||
- 'In the tests, while using C(yay) as the O(executable) option, the module failed to install AUR packages with the error: C(error: target not
|
- 'In the tests, while using C(yay) as the O(executable) option, the module failed to install AUR packages with the error:
|
||||||
found: <pkg>).'
|
C(error: target not found: <pkg>).'
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = r"""
|
RETURN = r"""
|
||||||
packages:
|
packages:
|
||||||
description:
|
description:
|
||||||
- A list of packages that have been changed.
|
- A list of packages that have been changed.
|
||||||
- Before community.general 4.5.0 this was only returned when O(upgrade=true). In community.general 4.5.0, it was sometimes omitted when the
|
- Before community.general 4.5.0 this was only returned when O(upgrade=true). In community.general 4.5.0, it was sometimes
|
||||||
package list is empty, but since community.general 4.6.0 it is always returned when O(name) is specified or O(upgrade=true).
|
omitted when the package list is empty, but since community.general 4.6.0 it is always returned when O(name) is specified
|
||||||
|
or O(upgrade=true).
|
||||||
returned: success and O(name) is specified or O(upgrade=true)
|
returned: success and O(name) is specified or O(upgrade=true)
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
|
|
|
@ -79,7 +79,8 @@ options:
|
||||||
default: Created by Ansible
|
default: Created by Ansible
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
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 will not be validated. This should only be used on personally controlled sites using
|
||||||
|
self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -95,10 +95,11 @@ options:
|
||||||
desc:
|
desc:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- For O(state=triggered) - Required. Short description of the problem that led to this trigger. This field (or a truncated version) will
|
- For O(state=triggered) - Required. Short description of the problem that led to this trigger. This field (or a truncated
|
||||||
be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents tables in the PagerDuty UI. The
|
version) will be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents
|
||||||
maximum length is 1024 characters.
|
tables in the PagerDuty UI. The maximum length is 1024 characters.
|
||||||
- For O(state=acknowledged) or O(state=resolved) - Text that will appear in the incident's log associated with this event.
|
- For O(state=acknowledged) or O(state=resolved) - Text that will appear in the incident's log associated with this
|
||||||
|
event.
|
||||||
required: false
|
required: false
|
||||||
default: Created via Ansible
|
default: Created via Ansible
|
||||||
incident_class:
|
incident_class:
|
||||||
|
@ -111,11 +112,12 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Identifies the incident to which this O(state) should be applied.
|
- Identifies the incident to which this O(state) should be applied.
|
||||||
- For O(state=triggered) - If there is no open (in other words unresolved) incident with this key, a new one will be created. If there is already an
|
- For O(state=triggered) - If there is no open (in other words unresolved) incident with this key, a new one will be
|
||||||
open incident with a matching key, this event will be appended to that incident's log. The event key provides an easy way to 'de-dup'
|
created. If there is already an open incident with a matching key, this event will be appended to that incident's
|
||||||
problem reports. If no O(incident_key) is provided, then it will be generated by PagerDuty.
|
log. The event key provides an easy way to 'de-dup' problem reports. If no O(incident_key) is provided, then it will
|
||||||
- For O(state=acknowledged) or O(state=resolved) - This should be the incident_key you received back when the incident was first opened
|
be generated by PagerDuty.
|
||||||
by a trigger event. Acknowledge events referencing resolved or nonexistent incidents will be discarded.
|
- For O(state=acknowledged) or O(state=resolved) - This should be the incident_key you received back when the incident
|
||||||
|
was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents will be discarded.
|
||||||
required: false
|
required: false
|
||||||
link_url:
|
link_url:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -31,7 +31,8 @@ attributes:
|
||||||
options:
|
options:
|
||||||
integration_key:
|
integration_key:
|
||||||
description:
|
description:
|
||||||
- The integration key that identifies the service the change was made to. This can be found by adding an integration to a service in PagerDuty.
|
- The integration key that identifies the service the change was made to. This can be found by adding an integration
|
||||||
|
to a service in PagerDuty.
|
||||||
required: true
|
required: true
|
||||||
type: str
|
type: str
|
||||||
summary:
|
summary:
|
||||||
|
@ -81,8 +82,8 @@ options:
|
||||||
type: str
|
type: str
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled sites using
|
- If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled
|
||||||
self-signed certificates.
|
sites using self-signed certificates.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
|
|
|
@ -73,21 +73,24 @@ options:
|
||||||
required: true
|
required: true
|
||||||
backup:
|
backup:
|
||||||
description:
|
description:
|
||||||
- Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
|
- Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered
|
||||||
|
it incorrectly.
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
use_min:
|
use_min:
|
||||||
description:
|
description:
|
||||||
- If set to V(true), the minimal value will be used or conserved.
|
- If set to V(true), the minimal value will be used or conserved.
|
||||||
- If the specified value is inferior to the value in the file, file content is replaced with the new value, else content is not modified.
|
- If the specified value is inferior to the value in the file, file content is replaced with the new value, else content
|
||||||
|
is not modified.
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
use_max:
|
use_max:
|
||||||
description:
|
description:
|
||||||
- If set to V(true), the maximal value will be used or conserved.
|
- If set to V(true), the maximal value will be used or conserved.
|
||||||
- If the specified value is superior to the value in the file, file content is replaced with the new value, else content is not modified.
|
- If the specified value is superior to the value in the file, file content is replaced with the new value, else content
|
||||||
|
is not modified.
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
|
|
|
@ -16,7 +16,8 @@ author:
|
||||||
short_description: Manage PAM Modules
|
short_description: Manage PAM Modules
|
||||||
description:
|
description:
|
||||||
- Edit PAM service's type, control, module path and module arguments.
|
- Edit PAM service's type, control, module path and module arguments.
|
||||||
- In order for a PAM rule to be modified, the type, control and module_path must match an existing rule. See man(5) pam.d for details.
|
- In order for a PAM rule to be modified, the type, control and module_path must match an existing rule. See man(5) pam.d
|
||||||
|
for details.
|
||||||
notes:
|
notes:
|
||||||
- This module does not handle authselect profiles.
|
- This module does not handle authselect profiles.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
@ -70,7 +71,8 @@ options:
|
||||||
- When O(state=updated), the O(module_arguments) will replace existing module_arguments.
|
- When O(state=updated), the O(module_arguments) will replace existing module_arguments.
|
||||||
- When O(state=args_absent) args matching those listed in O(module_arguments) will be removed.
|
- When O(state=args_absent) args matching those listed in O(module_arguments) will be removed.
|
||||||
- When O(state=args_present) any args listed in O(module_arguments) are added if missing from the existing rule.
|
- When O(state=args_present) any args listed in O(module_arguments) are added if missing from the existing rule.
|
||||||
- Furthermore, if the module argument takes a value denoted by C(=), the value will be changed to that specified in module_arguments.
|
- Furthermore, if the module argument takes a value denoted by C(=), the value will be changed to that specified in
|
||||||
|
module_arguments.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
state:
|
state:
|
||||||
|
@ -91,7 +93,8 @@ options:
|
||||||
default: /etc/pam.d
|
default: /etc/pam.d
|
||||||
backup:
|
backup:
|
||||||
description:
|
description:
|
||||||
- Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
|
- Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered
|
||||||
|
it incorrectly.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
"""
|
"""
|
||||||
|
@ -151,11 +154,7 @@ EXAMPLES = r"""
|
||||||
type: auth
|
type: auth
|
||||||
control: required
|
control: required
|
||||||
module_path: pam_faillock.so
|
module_path: pam_faillock.so
|
||||||
module_arguments: 'preauth
|
module_arguments: 'preauth silent deny=3 unlock_time=604800 fail_interval=900'
|
||||||
silent
|
|
||||||
deny=3
|
|
||||||
unlock_time=604800
|
|
||||||
fail_interval=900'
|
|
||||||
state: updated
|
state: updated
|
||||||
|
|
||||||
- name: Remove specific arguments from a rule
|
- name: Remove specific arguments from a rule
|
||||||
|
|
|
@ -15,8 +15,8 @@ author:
|
||||||
module: parted
|
module: parted
|
||||||
short_description: Configure block device partitions
|
short_description: Configure block device partitions
|
||||||
description:
|
description:
|
||||||
- This module allows configuring block device partition using the C(parted) command line tool. For a full description of the fields and the
|
- This module allows configuring block device partition using the C(parted) command line tool. For a full description of
|
||||||
options check the GNU parted manual.
|
the fields and the options check the GNU parted manual.
|
||||||
requirements:
|
requirements:
|
||||||
- This module requires C(parted) version 1.8.3 and above.
|
- This module requires C(parted) version 1.8.3 and above.
|
||||||
- Option O(align) (except V(undefined)) requires C(parted) 2.1 or above.
|
- Option O(align) (except V(undefined)) requires C(parted) 2.1 or above.
|
||||||
|
@ -33,7 +33,8 @@ options:
|
||||||
device:
|
device:
|
||||||
description:
|
description:
|
||||||
- The block device (disk) where to operate.
|
- The block device (disk) where to operate.
|
||||||
- Regular files can also be partitioned, but it is recommended to create a loopback device using C(losetup) to easily access its partitions.
|
- Regular files can also be partitioned, but it is recommended to create a loopback device using C(losetup) to easily
|
||||||
|
access its partitions.
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
align:
|
align:
|
||||||
|
@ -49,8 +50,8 @@ options:
|
||||||
type: int
|
type: int
|
||||||
unit:
|
unit:
|
||||||
description:
|
description:
|
||||||
- Selects the current default unit that Parted will use to display locations and capacities on the disk and to interpret those given by
|
- Selects the current default unit that Parted will use to display locations and capacities on the disk and to interpret
|
||||||
the user if they are not suffixed by an unit.
|
those given by the user if they are not suffixed by an unit.
|
||||||
- When fetching information about a disk, it is recommended to always specify a unit.
|
- When fetching information about a disk, it is recommended to always specify a unit.
|
||||||
type: str
|
type: str
|
||||||
choices: [s, B, KB, KiB, MB, MiB, GB, GiB, TB, TiB, '%', cyl, chs, compact]
|
choices: [s, B, KB, KiB, MB, MiB, GB, GiB, TB, TiB, '%', cyl, chs, compact]
|
||||||
|
@ -58,7 +59,8 @@ options:
|
||||||
label:
|
label:
|
||||||
description:
|
description:
|
||||||
- Disk label type or partition table to use.
|
- Disk label type or partition table to use.
|
||||||
- If O(device) already contains a different label, it will be changed to O(label) and any previous partitions will be lost.
|
- If O(device) already contains a different label, it will be changed to O(label) and any previous partitions will be
|
||||||
|
lost.
|
||||||
- A O(name) must be specified for a V(gpt) partition table.
|
- A O(name) must be specified for a V(gpt) partition table.
|
||||||
type: str
|
type: str
|
||||||
choices: [aix, amiga, bsd, dvh, gpt, loop, mac, msdos, pc98, sun]
|
choices: [aix, amiga, bsd, dvh, gpt, loop, mac, msdos, pc98, sun]
|
||||||
|
@ -72,17 +74,19 @@ options:
|
||||||
default: primary
|
default: primary
|
||||||
part_start:
|
part_start:
|
||||||
description:
|
description:
|
||||||
- Where the partition will start as offset from the beginning of the disk, that is, the "distance" from the start of the disk. Negative
|
- Where the partition will start as offset from the beginning of the disk, that is, the "distance" from the start of
|
||||||
numbers specify distance from the end of the disk.
|
the disk. Negative numbers specify distance from the end of the disk.
|
||||||
- The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, for example V(10GiB), V(15%).
|
- The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, for
|
||||||
|
example V(10GiB), V(15%).
|
||||||
- Using negative values may require setting of O(fs_type) (see notes).
|
- Using negative values may require setting of O(fs_type) (see notes).
|
||||||
type: str
|
type: str
|
||||||
default: 0%
|
default: 0%
|
||||||
part_end:
|
part_end:
|
||||||
description:
|
description:
|
||||||
- Where the partition will end as offset from the beginning of the disk, that is, the "distance" from the start of the disk. Negative numbers
|
- Where the partition will end as offset from the beginning of the disk, that is, the "distance" from the start of the
|
||||||
specify distance from the end of the disk.
|
disk. Negative numbers specify distance from the end of the disk.
|
||||||
- The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, for example V(10GiB), V(15%).
|
- The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, for
|
||||||
|
example V(10GiB), V(15%).
|
||||||
type: str
|
type: str
|
||||||
default: 100%
|
default: 100%
|
||||||
name:
|
name:
|
||||||
|
@ -114,10 +118,11 @@ options:
|
||||||
version_added: '1.3.0'
|
version_added: '1.3.0'
|
||||||
|
|
||||||
notes:
|
notes:
|
||||||
- When fetching information about a new disk and when the version of parted installed on the system is before version 3.1, the module queries
|
- When fetching information about a new disk and when the version of parted installed on the system is before version 3.1,
|
||||||
the kernel through C(/sys/) to obtain disk information. In this case the units CHS and CYL are not supported.
|
the module queries the kernel through C(/sys/) to obtain disk information. In this case the units CHS and CYL are not
|
||||||
- Negative O(part_start) start values were rejected if O(fs_type) was not given. This bug was fixed in parted 3.2.153. If you want to use negative
|
supported.
|
||||||
O(part_start), specify O(fs_type) as well or make sure your system contains newer parted.
|
- Negative O(part_start) start values were rejected if O(fs_type) was not given. This bug was fixed in parted 3.2.153. If
|
||||||
|
you want to use negative O(part_start), specify O(fs_type) as well or make sure your system contains newer parted.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = r"""
|
RETURN = r"""
|
||||||
|
|
|
@ -45,11 +45,13 @@ options:
|
||||||
- Path to the pear executable.
|
- Path to the pear executable.
|
||||||
prompts:
|
prompts:
|
||||||
description:
|
description:
|
||||||
- List of regular expressions that can be used to detect prompts during pear package installation to answer the expected question.
|
- List of regular expressions that can be used to detect prompts during pear package installation to answer the expected
|
||||||
|
question.
|
||||||
- Prompts will be processed in the same order as the packages list.
|
- Prompts will be processed in the same order as the packages list.
|
||||||
- You can optionally specify an answer to any question in the list.
|
- You can optionally specify an answer to any question in the list.
|
||||||
- If no answer is provided, the list item will only contain the regular expression.
|
- If no answer is provided, the list item will only contain the regular expression.
|
||||||
- "To specify an answer, the item will be a dict with the regular expression as key and the answer as value C(my_regular_expression: 'an_answer')."
|
- "To specify an answer, the item will be a dict with the regular expression as key and the answer as value C(my_regular_expression:
|
||||||
|
'an_answer')."
|
||||||
- You can provide a list containing items with or without answer.
|
- You can provide a list containing items with or without answer.
|
||||||
- A prompt list can be shorter or longer than the packages list but will issue a warning.
|
- A prompt list can be shorter or longer than the packages list but will issue a warning.
|
||||||
- If you want to specify that a package will not need prompts in the middle of a list, V(null).
|
- If you want to specify that a package will not need prompts in the middle of a list, V(null).
|
||||||
|
@ -83,9 +85,9 @@ EXAMPLES = r"""
|
||||||
prompts:
|
prompts:
|
||||||
- (.*)Enable internal debugging in APCu \[no\]: "yes"
|
- (.*)Enable internal debugging in APCu \[no\]: "yes"
|
||||||
|
|
||||||
- name: Install multiple pear/pecl packages at once with prompts. Prompts will be processed on the same order as the packages order. If there
|
- name: Install multiple pear/pecl packages at once with prompts. Prompts will be processed on the same order as the packages
|
||||||
is more prompts than packages, packages without prompts will be installed without any prompt expected. If there is more packages than prompts,
|
order. If there is more prompts than packages, packages without prompts will be installed without any prompt expected.
|
||||||
additional prompts will be ignored.
|
If there is more packages than prompts, additional prompts will be ignored.
|
||||||
community.general.pear:
|
community.general.pear:
|
||||||
name: pecl/gnupg, pecl/apcu
|
name: pecl/gnupg, pecl/apcu
|
||||||
state: present
|
state: present
|
||||||
|
@ -93,9 +95,9 @@ EXAMPLES = r"""
|
||||||
- I am a test prompt because gnupg doesnt asks anything
|
- I am a test prompt because gnupg doesnt asks anything
|
||||||
- (.*)Enable internal debugging in APCu \[no\]: "yes"
|
- (.*)Enable internal debugging in APCu \[no\]: "yes"
|
||||||
|
|
||||||
- name: Install multiple pear/pecl packages at once skipping the first prompt. Prompts will be processed on the same order as the packages order.
|
- name: Install multiple pear/pecl packages at once skipping the first prompt. Prompts will be processed on the same order
|
||||||
If there is more prompts than packages, packages without prompts will be installed without any prompt expected. If there is more packages
|
as the packages order. If there is more prompts than packages, packages without prompts will be installed without any
|
||||||
than prompts, additional prompts will be ignored.
|
prompt expected. If there is more packages than prompts, additional prompts will be ignored.
|
||||||
community.general.pear:
|
community.general.pear:
|
||||||
name: pecl/gnupg, pecl/apcu
|
name: pecl/gnupg, pecl/apcu
|
||||||
state: present
|
state: present
|
||||||
|
|
|
@ -9,8 +9,8 @@ __metaclass__ = type
|
||||||
|
|
||||||
DOCUMENTATION = r"""
|
DOCUMENTATION = r"""
|
||||||
module: pids
|
module: pids
|
||||||
description: "Retrieves a list of PIDs of given process name in Ansible controller/controlled machines.Returns an empty list if no process in
|
description: "Retrieves a list of PIDs of given process name in Ansible controller/controlled machines. Returns an empty list
|
||||||
that name exists."
|
if no process in that name exists."
|
||||||
short_description: Retrieves process IDs list if the process is running otherwise return empty list
|
short_description: Retrieves process IDs list if the process is running otherwise return empty list
|
||||||
author:
|
author:
|
||||||
- Saranya Sridharan (@saranyasridharan)
|
- Saranya Sridharan (@saranyasridharan)
|
||||||
|
|
|
@ -20,8 +20,8 @@ extends_documentation_fragment:
|
||||||
options:
|
options:
|
||||||
clients:
|
clients:
|
||||||
description:
|
description:
|
||||||
- A list of the pip executables that will be used to get the packages. They can be supplied with the full path or just the executable name,
|
- A list of the pip executables that will be used to get the packages. They can be supplied with the full path or just
|
||||||
for example V(pip3.7).
|
the executable name, for example V(pip3.7).
|
||||||
default: ['pip']
|
default: ['pip']
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
|
|
@ -47,24 +47,28 @@ options:
|
||||||
description:
|
description:
|
||||||
- Desired state for the application.
|
- Desired state for the application.
|
||||||
- The states V(present) and V(absent) are aliases to V(install) and V(uninstall), respectively.
|
- The states V(present) and V(absent) are aliases to V(install) and V(uninstall), respectively.
|
||||||
- The state V(latest) is equivalent to executing the task twice, with state V(install) and then V(upgrade). It was added in community.general
|
- The state V(latest) is equivalent to executing the task twice, with state V(install) and then V(upgrade). It was added
|
||||||
5.5.0.
|
in community.general 5.5.0.
|
||||||
- The states V(install_all), V(uninject), V(upgrade_shared), V(pin) and V(unpin) are only available in C(pipx>=1.6.0), make sure to have
|
- The states V(install_all), V(uninject), V(upgrade_shared), V(pin) and V(unpin) are only available in C(pipx>=1.6.0),
|
||||||
a compatible version when using this option. These states have been added in community.general 9.4.0.
|
make sure to have a compatible version when using this option. These states have been added in community.general 9.4.0.
|
||||||
name:
|
name:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The name of the application. In C(pipx) documentation it is also referred to as the name of the virtual environment where the application
|
- The name of the application. In C(pipx) documentation it is also referred to as the name of the virtual environment
|
||||||
will be installed.
|
where the application will be installed.
|
||||||
- If O(name) is a simple package name without version specifiers, then that name is used as the Python package name to be installed.
|
- If O(name) is a simple package name without version specifiers, then that name is used as the Python package name
|
||||||
|
to be installed.
|
||||||
- Use O(source) for passing package specifications or installing from URLs or directories.
|
- Use O(source) for passing package specifications or installing from URLs or directories.
|
||||||
source:
|
source:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Source for the package. This option is used when O(state=install) or O(state=latest), and it is ignored with other states.
|
- Source for the package. This option is used when O(state=install) or O(state=latest), and it is ignored with other
|
||||||
- Use O(source) when installing a Python package with version specifier, or from a local path, from a VCS URL or compressed file.
|
states.
|
||||||
|
- Use O(source) when installing a Python package with version specifier, or from a local path, from a VCS URL or compressed
|
||||||
|
file.
|
||||||
- The value of this option is passed as-is to C(pipx).
|
- The value of this option is passed as-is to C(pipx).
|
||||||
- O(name) is still required when using O(source) to establish the application name without fetching the package from a remote source.
|
- O(name) is still required when using O(source) to establish the application name without fetching the package from
|
||||||
|
a remote source.
|
||||||
install_apps:
|
install_apps:
|
||||||
description:
|
description:
|
||||||
- Add apps from the injected packages.
|
- Add apps from the injected packages.
|
||||||
|
@ -136,14 +140,14 @@ options:
|
||||||
spec_metadata:
|
spec_metadata:
|
||||||
description:
|
description:
|
||||||
- Spec metadata file for O(state=install_all).
|
- Spec metadata file for O(state=install_all).
|
||||||
- This content of the file is usually generated with C(pipx list --json), and it can be obtained with M(community.general.pipx_info) with
|
- This content of the file is usually generated with C(pipx list --json), and it can be obtained with M(community.general.pipx_info)
|
||||||
O(community.general.pipx_info#module:include_raw=true) and obtaining the content from the RV(community.general.pipx_info#module:raw_output).
|
with O(community.general.pipx_info#module:include_raw=true) and obtaining the content from the RV(community.general.pipx_info#module:raw_output).
|
||||||
type: path
|
type: path
|
||||||
version_added: 9.4.0
|
version_added: 9.4.0
|
||||||
notes:
|
notes:
|
||||||
- This first implementation does not verify whether a specified version constraint has been installed or not. Hence, when using version operators,
|
- This first implementation does not verify whether a specified version constraint has been installed or not. Hence, when
|
||||||
C(pipx) module will always try to execute the operation, even when the application was previously installed. This feature will be added in
|
using version operators, C(pipx) module will always try to execute the operation, even when the application was previously
|
||||||
the future.
|
installed. This feature will be added in the future.
|
||||||
author:
|
author:
|
||||||
- "Alexei Znamensky (@russoz)"
|
- "Alexei Znamensky (@russoz)"
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -26,7 +26,8 @@ author:
|
||||||
- "Shaun Zinck (@szinck)"
|
- "Shaun Zinck (@szinck)"
|
||||||
- "Jasper Lievisse Adriaanse (@jasperla)"
|
- "Jasper Lievisse Adriaanse (@jasperla)"
|
||||||
notes:
|
notes:
|
||||||
- 'Known bug with pkgin < 0.8.0: if a package is removed and another package depends on it, the other package will be silently removed as well.'
|
- 'Known bug with pkgin < 0.8.0: if a package is removed and another package depends on it, the other package will be silently
|
||||||
|
removed as well.'
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
attributes:
|
attributes:
|
||||||
|
|
|
@ -50,15 +50,16 @@ options:
|
||||||
default: false
|
default: false
|
||||||
annotation:
|
annotation:
|
||||||
description:
|
description:
|
||||||
- A list of keyvalue-pairs of the form C(<+/-/:><key>[=<value>]). A V(+) denotes adding an annotation, a V(-) denotes removing an annotation,
|
- A list of keyvalue-pairs of the form C(<+/-/:><key>[=<value>]). A V(+) denotes adding an annotation, a V(-) denotes
|
||||||
and V(:) denotes modifying an annotation. If setting or modifying annotations, a value must be provided.
|
removing an annotation, and V(:) denotes modifying an annotation. If setting or modifying annotations, a value must
|
||||||
|
be provided.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
pkgsite:
|
pkgsite:
|
||||||
description:
|
description:
|
||||||
- For C(pkgng) versions before 1.1.4, specify C(packagesite) to use for downloading packages.
|
- For C(pkgng) versions before 1.1.4, specify C(packagesite) to use for downloading packages. If not specified, use
|
||||||
If not specified, use settings from C(/usr/local/etc/pkg.conf).
|
settings from C(/usr/local/etc/pkg.conf).
|
||||||
- For newer C(pkgng) versions, specify a the name of a repository configured in C(/usr/local/etc/pkg/repos).
|
- For newer C(pkgng) versions, specify a the name of a repository configured in C(/usr/local/etc/pkg/repos).
|
||||||
required: false
|
required: false
|
||||||
type: str
|
type: str
|
||||||
|
@ -76,7 +77,7 @@ options:
|
||||||
type: path
|
type: path
|
||||||
jail:
|
jail:
|
||||||
description:
|
description:
|
||||||
- Pkg will execute in the given jail name or id.
|
- Pkg will execute in the given jail name or ID.
|
||||||
- Can not be used together with O(chroot) or O(rootdir) options.
|
- Can not be used together with O(chroot) or O(rootdir) options.
|
||||||
type: str
|
type: str
|
||||||
autoremove:
|
autoremove:
|
||||||
|
@ -103,8 +104,8 @@ options:
|
||||||
author: "bleader (@bleader)"
|
author: "bleader (@bleader)"
|
||||||
notes:
|
notes:
|
||||||
- When using pkgsite, be careful that already in cache packages will not be downloaded again.
|
- When using pkgsite, be careful that already in cache packages will not be downloaded again.
|
||||||
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name)
|
- When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
|
||||||
option.
|
to the O(name) option.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
|
|
|
@ -28,7 +28,8 @@ attributes:
|
||||||
check_mode:
|
check_mode:
|
||||||
support: full
|
support: full
|
||||||
details:
|
details:
|
||||||
- In order to check the availability of packages, the catalog cache under C(/var/opt/csw/pkgutil) may be refreshed even in check mode.
|
- In order to check the availability of packages, the catalog cache under C(/var/opt/csw/pkgutil) may be refreshed even
|
||||||
|
in check mode.
|
||||||
diff_mode:
|
diff_mode:
|
||||||
support: none
|
support: none
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -14,7 +14,8 @@ module: pmem
|
||||||
short_description: Configure Intel Optane Persistent Memory modules
|
short_description: Configure Intel Optane Persistent Memory modules
|
||||||
version_added: 4.5.0
|
version_added: 4.5.0
|
||||||
description:
|
description:
|
||||||
- This module allows Configuring Intel Optane Persistent Memory modules (PMem) using C(ipmctl) and C(ndctl) command line tools.
|
- This module allows Configuring Intel Optane Persistent Memory modules (PMem) using C(ipmctl) and C(ndctl) command line
|
||||||
|
tools.
|
||||||
requirements:
|
requirements:
|
||||||
- C(ipmctl) and C(ndctl) command line tools
|
- C(ipmctl) and C(ndctl) command line tools
|
||||||
- xmltodict
|
- xmltodict
|
||||||
|
@ -29,7 +30,8 @@ options:
|
||||||
appdirect:
|
appdirect:
|
||||||
description:
|
description:
|
||||||
- Percentage of the total capacity to use in AppDirect Mode (V(0)-V(100)).
|
- Percentage of the total capacity to use in AppDirect Mode (V(0)-V(100)).
|
||||||
- Create AppDirect capacity utilizing hardware interleaving across the requested PMem modules if applicable given the specified target.
|
- Create AppDirect capacity utilizing hardware interleaving across the requested PMem modules if applicable given the
|
||||||
|
specified target.
|
||||||
- Total of O(appdirect), O(memorymode) and O(reserved) must be V(100).
|
- Total of O(appdirect), O(memorymode) and O(reserved) must be V(100).
|
||||||
type: int
|
type: int
|
||||||
appdirect_interleaved:
|
appdirect_interleaved:
|
||||||
|
@ -44,8 +46,8 @@ options:
|
||||||
type: int
|
type: int
|
||||||
reserved:
|
reserved:
|
||||||
description:
|
description:
|
||||||
- Percentage of the capacity to reserve (V(0)-V(100)). O(reserved) will not be mapped into the system physical address space and will be
|
- Percentage of the capacity to reserve (V(0)-V(100)). O(reserved) will not be mapped into the system physical address
|
||||||
presented as reserved capacity with Show Device and Show Memory Resources Commands.
|
space and will be presented as reserved capacity with Show Device and Show Memory Resources Commands.
|
||||||
- O(reserved) will be set automatically if this is not configured.
|
- O(reserved) will be set automatically if this is not configured.
|
||||||
type: int
|
type: int
|
||||||
required: false
|
required: false
|
||||||
|
@ -100,8 +102,8 @@ options:
|
||||||
choices: ['pmem', 'blk']
|
choices: ['pmem', 'blk']
|
||||||
size:
|
size:
|
||||||
description:
|
description:
|
||||||
- The size of namespace. This option supports the suffixes V(k) or V(K) or V(KB) for KiB, V(m) or V(M) or V(MB) for MiB, V(g) or V(G)
|
- The size of namespace. This option supports the suffixes V(k) or V(K) or V(KB) for KiB, V(m) or V(M) or V(MB)
|
||||||
or V(GB) for GiB and V(t) or V(T) or V(TB) for TiB.
|
for MiB, V(g) or V(G) or V(GB) for GiB and V(t) or V(T) or V(TB) for TiB.
|
||||||
- This option is required if multiple namespaces are configured.
|
- This option is required if multiple namespaces are configured.
|
||||||
- If this option is not set, all of the available space of a region is configured.
|
- If this option is not set, all of the available space of a region is configured.
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -173,7 +173,8 @@ options:
|
||||||
|
|
||||||
loadavg:
|
loadavg:
|
||||||
description:
|
description:
|
||||||
- Specifies that no new builds should be started if there are other builds running and the load average is at least LOAD.
|
- Specifies that no new builds should be started if there are other builds running and the load average is at least
|
||||||
|
LOAD.
|
||||||
- 'Since version 2.6: Value of 0 or False resets any previously added C(--load-average) setting values.'
|
- 'Since version 2.6: Value of 0 or False resets any previously added C(--load-average) setting values.'
|
||||||
type: float
|
type: float
|
||||||
|
|
||||||
|
|
|
@ -35,8 +35,9 @@ options:
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
description:
|
description:
|
||||||
- If O(force) is V(true) and O(state) is V(absent), the module will delete the organization, no matter if it contains users or not. By default
|
- If O(force) is V(true) and O(state) is V(absent), the module will delete the organization, no matter if it contains
|
||||||
O(force) is V(false), which will cause the module to fail the deletion of the organization when it contains users.
|
users or not. By default O(force) is V(false), which will cause the module to fail the deletion of the organization
|
||||||
|
when it contains users.
|
||||||
state:
|
state:
|
||||||
type: str
|
type: str
|
||||||
default: 'present'
|
default: 'present'
|
||||||
|
@ -44,8 +45,8 @@ options:
|
||||||
- present
|
- present
|
||||||
- absent
|
- absent
|
||||||
description:
|
description:
|
||||||
- If V(present), the module adds organization O(name) to Pritunl. If V(absent), attempt to delete the organization from Pritunl (please
|
- If V(present), the module adds organization O(name) to Pritunl. If V(absent), attempt to delete the organization from
|
||||||
read about O(force) usage).
|
Pritunl (please read about O(force) usage).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
|
|
|
@ -38,8 +38,8 @@ options:
|
||||||
- present
|
- present
|
||||||
- absent
|
- absent
|
||||||
description:
|
description:
|
||||||
- If V(present), the module adds user O(user_name) to the Pritunl O(organization). If V(absent), removes the user O(user_name) from the
|
- If V(present), the module adds user O(user_name) to the Pritunl O(organization). If V(absent), removes the user O(user_name)
|
||||||
Pritunl O(organization).
|
from the Pritunl O(organization).
|
||||||
user_name:
|
user_name:
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
|
|
|
@ -12,8 +12,8 @@ DOCUMENTATION = r"""
|
||||||
module: profitbricks
|
module: profitbricks
|
||||||
short_description: Create, destroy, start, stop, and reboot a ProfitBricks virtual machine
|
short_description: Create, destroy, start, stop, and reboot a ProfitBricks virtual machine
|
||||||
description:
|
description:
|
||||||
- Create, destroy, update, start, stop, and reboot a ProfitBricks virtual machine. When the virtual machine is created it can optionally wait
|
- Create, destroy, update, start, stop, and reboot a ProfitBricks virtual machine. When the virtual machine is created it
|
||||||
for it to be 'running' before returning. This module has a dependency on profitbricks >= 1.0.0.
|
can optionally wait for it to be 'running' before returning. This module has a dependency on profitbricks >= 1.0.0.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -78,7 +78,7 @@ options:
|
||||||
choices: ["IDE", "VIRTIO"]
|
choices: ["IDE", "VIRTIO"]
|
||||||
instance_ids:
|
instance_ids:
|
||||||
description:
|
description:
|
||||||
- List of instance ids, currently only used when state='absent' to remove instances.
|
- List of instance IDs, currently only used when state='absent' to remove instances.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
default: []
|
default: []
|
||||||
|
|
|
@ -12,8 +12,8 @@ DOCUMENTATION = r"""
|
||||||
module: profitbricks_datacenter
|
module: profitbricks_datacenter
|
||||||
short_description: Create or destroy a ProfitBricks Virtual Datacenter
|
short_description: Create or destroy a ProfitBricks Virtual Datacenter
|
||||||
description:
|
description:
|
||||||
- This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. This module has a dependency
|
- This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. This
|
||||||
on profitbricks >= 1.0.0.
|
module has a dependency on profitbricks >= 1.0.0.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
attributes:
|
attributes:
|
||||||
|
|
|
@ -12,7 +12,8 @@ DOCUMENTATION = r"""
|
||||||
module: profitbricks_volume
|
module: profitbricks_volume
|
||||||
short_description: Create or destroy a volume
|
short_description: Create or destroy a volume
|
||||||
description:
|
description:
|
||||||
- Allows you to create or remove a volume from a ProfitBricks datacenter. This module has a dependency on profitbricks >= 1.0.0.
|
- Allows you to create or remove a volume from a ProfitBricks datacenter. This module has a dependency on profitbricks >=
|
||||||
|
1.0.0.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -44,7 +45,8 @@ options:
|
||||||
choices: ["IDE", "VIRTIO"]
|
choices: ["IDE", "VIRTIO"]
|
||||||
image:
|
image:
|
||||||
description:
|
description:
|
||||||
- The system image ID for the volume, for example V(a3eae284-a2fe-11e4-b187-5f1f641608c8). This can also be a snapshot image ID.
|
- The system image ID for the volume, for example V(a3eae284-a2fe-11e4-b187-5f1f641608c8). This can also be a snapshot
|
||||||
|
image ID.
|
||||||
type: str
|
type: str
|
||||||
image_password:
|
image_password:
|
||||||
description:
|
description:
|
||||||
|
@ -84,7 +86,7 @@ options:
|
||||||
type: bool
|
type: bool
|
||||||
instance_ids:
|
instance_ids:
|
||||||
description:
|
description:
|
||||||
- List of instance ids, currently only used when state='absent' to remove instances.
|
- List of instance IDs, currently only used when O(state=absent) to remove instances.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
default: []
|
default: []
|
||||||
|
|
|
@ -40,11 +40,13 @@ options:
|
||||||
type: str
|
type: str
|
||||||
disk:
|
disk:
|
||||||
description:
|
description:
|
||||||
- This option was previously described as "hard disk size in GB for instance" however several formats describing a lxc mount are permitted.
|
- This option was previously described as "hard disk size in GB for instance" however several formats describing a lxc
|
||||||
- Older versions of Proxmox will accept a numeric value for size using the O(storage) parameter to automatically choose which storage to
|
mount are permitted.
|
||||||
allocate from, however new versions enforce the C(<STORAGE>:<SIZE>) syntax.
|
- Older versions of Proxmox will accept a numeric value for size using the O(storage) parameter to automatically choose
|
||||||
- Additional options are available by using some combination of the following key-value pairs as a comma-delimited list C([volume=]<volume>
|
which storage to allocate from, however new versions enforce the C(<STORAGE>:<SIZE>) syntax.
|
||||||
[,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]).
|
- Additional options are available by using some combination of the following key-value pairs as a comma-delimited list
|
||||||
|
C([volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>]
|
||||||
|
[,size=<DiskSize>]).
|
||||||
- See U(https://pve.proxmox.com/wiki/Linux_Container) for a full description.
|
- See U(https://pve.proxmox.com/wiki/Linux_Container) for a full description.
|
||||||
- This option is mutually exclusive with O(storage) and O(disk_volume).
|
- This option is mutually exclusive with O(storage) and O(disk_volume).
|
||||||
type: str
|
type: str
|
||||||
|
@ -114,7 +116,8 @@ options:
|
||||||
startup:
|
startup:
|
||||||
description:
|
description:
|
||||||
- Specifies the startup order of the container.
|
- Specifies the startup order of the container.
|
||||||
- Use C(order=#) where C(#) is a non-negative number to define the general startup order. Shutdown in done with reverse ordering.
|
- Use C(order=#) where C(#) is a non-negative number to define the general startup order. Shutdown in done with reverse
|
||||||
|
ordering.
|
||||||
- Use C(up=#) where C(#) is in seconds, to specify a delay to wait before the next VM is started.
|
- Use C(up=#) where C(#) is in seconds, to specify a delay to wait before the next VM is started.
|
||||||
- Use C(down=#) where C(#) is in seconds, to specify a delay to wait before the next VM is stopped.
|
- Use C(down=#) where C(#) is in seconds, to specify a delay to wait before the next VM is stopped.
|
||||||
type: list
|
type: list
|
||||||
|
@ -190,7 +193,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specifies the C(ostype) of the LXC container.
|
- Specifies the C(ostype) of the LXC container.
|
||||||
- If set to V(auto), no C(ostype) will be provided on instance creation.
|
- If set to V(auto), no C(ostype) will be provided on instance creation.
|
||||||
choices: ['auto', 'debian', 'devuan', 'ubuntu', 'centos', 'fedora', 'opensuse', 'archlinux', 'alpine', 'gentoo', 'nixos', 'unmanaged']
|
choices: ['auto', 'debian', 'devuan', 'ubuntu', 'centos', 'fedora', 'opensuse', 'archlinux', 'alpine', 'gentoo', 'nixos',
|
||||||
|
'unmanaged']
|
||||||
type: str
|
type: str
|
||||||
default: 'auto'
|
default: 'auto'
|
||||||
version_added: 8.1.0
|
version_added: 8.1.0
|
||||||
|
@ -289,8 +293,8 @@ options:
|
||||||
- Type of the clone created.
|
- Type of the clone created.
|
||||||
- V(full) creates a full clone, and O(storage) must be specified.
|
- V(full) creates a full clone, and O(storage) must be specified.
|
||||||
- V(linked) creates a linked clone, and the cloned container must be a template container.
|
- V(linked) creates a linked clone, and the cloned container must be a template container.
|
||||||
- V(opportunistic) creates a linked clone if the cloned container is a template container, and a full clone if not. O(storage) may be specified,
|
- V(opportunistic) creates a linked clone if the cloned container is a template container, and a full clone if not.
|
||||||
if not it will fall back to the default.
|
O(storage) may be specified, if not it will fall back to the default.
|
||||||
type: str
|
type: str
|
||||||
choices: ['full', 'linked', 'opportunistic']
|
choices: ['full', 'linked', 'opportunistic']
|
||||||
default: opportunistic
|
default: opportunistic
|
||||||
|
|
|
@ -17,8 +17,10 @@ short_description: Start a VM backup in Proxmox VE cluster
|
||||||
version_added: 10.1.0
|
version_added: 10.1.0
|
||||||
description:
|
description:
|
||||||
- Allows you to create backups of KVM and LXC guests in Proxmox VE cluster.
|
- Allows you to create backups of KVM and LXC guests in Proxmox VE cluster.
|
||||||
- Offers the GUI functionality of creating a single backup as well as using the run-now functionality from the cluster backup schedule.
|
- Offers the GUI functionality of creating a single backup as well as using the run-now functionality from the cluster backup
|
||||||
- The mininum required privileges to use this module are C(VM.Backup) and C(Datastore.AllocateSpace) for the respective VMs and storage.
|
schedule.
|
||||||
|
- The mininum required privileges to use this module are C(VM.Backup) and C(Datastore.AllocateSpace) for the respective
|
||||||
|
VMs and storage.
|
||||||
- Most options are optional and if unspecified will be chosen by the Cluster and its default values.
|
- Most options are optional and if unspecified will be chosen by the Cluster and its default values.
|
||||||
- Note that this module B(is not idempotent). It always starts a new backup (when not in check mode).
|
- Note that this module B(is not idempotent). It always starts a new backup (when not in check mode).
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -60,9 +62,10 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specify the description of the backup.
|
- Specify the description of the backup.
|
||||||
- Needs to be a single line, newline and backslash need to be escaped as V(\\n) and V(\\\\) respectively.
|
- Needs to be a single line, newline and backslash need to be escaped as V(\\n) and V(\\\\) respectively.
|
||||||
- If you need variable interpolation, you can set the content as usual through ansible jinja templating and/or let Proxmox substitute templates.
|
- If you need variable interpolation, you can set the content as usual through ansible jinja templating and/or let Proxmox
|
||||||
- Proxmox currently supports V({{cluster}}), V({{guestname}}), V({{node}}), and V({{vmid}}) as templating variables. Since this is also
|
substitute templates.
|
||||||
a jinja delimiter, you need to set these values as raw jinja.
|
- Proxmox currently supports V({{cluster}}), V({{guestname}}), V({{node}}), and V({{vmid}}) as templating variables.
|
||||||
|
Since this is also a jinja delimiter, you need to set these values as raw jinja.
|
||||||
default: "{{guestname}}"
|
default: "{{guestname}}"
|
||||||
type: str
|
type: str
|
||||||
fleecing:
|
fleecing:
|
||||||
|
@ -109,8 +112,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- Use custom retention options instead of those from the default cluster configuration (which is usually V("keep-all=1")).
|
- Use custom retention options instead of those from the default cluster configuration (which is usually V("keep-all=1")).
|
||||||
- Always requires Datastore.Allocate permission at the storage endpoint.
|
- Always requires Datastore.Allocate permission at the storage endpoint.
|
||||||
- Specifying a retention time other than V(keep-all=1) might trigger pruning on the datastore, if an existing backup should be deleted
|
- Specifying a retention time other than V(keep-all=1) might trigger pruning on the datastore, if an existing backup
|
||||||
due to your specified timeframe.
|
should be deleted due to your specified timeframe.
|
||||||
- Deleting requires C(Datastore.Modify) or C(Datastore.Prune) permissions on the backup storage.
|
- Deleting requires C(Datastore.Modify) or C(Datastore.Prune) permissions on the backup storage.
|
||||||
type: str
|
type: str
|
||||||
storage:
|
storage:
|
||||||
|
@ -120,7 +123,7 @@ options:
|
||||||
required: true
|
required: true
|
||||||
vmids:
|
vmids:
|
||||||
description:
|
description:
|
||||||
- The instance ids to be backed up.
|
- The instance IDs to be backed up.
|
||||||
- Only valid, if O(mode=include).
|
- Only valid, if O(mode=include).
|
||||||
type: list
|
type: list
|
||||||
elements: int
|
elements: int
|
||||||
|
@ -212,8 +215,8 @@ backups:
|
||||||
choices: ["unknown", "success", "failed"]
|
choices: ["unknown", "success", "failed"]
|
||||||
upid:
|
upid:
|
||||||
description: >-
|
description: >-
|
||||||
Proxmox cluster UPID, which is needed to lookup task info. Returns OK, when a cluster node did not create a task after being called, for
|
Proxmox cluster UPID, which is needed to lookup task info. Returns OK, when a cluster node did not create a task after
|
||||||
example due to no matching targets.
|
being called, for example due to no matching targets.
|
||||||
returned: on success
|
returned: on success
|
||||||
type: str
|
type: str
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -43,15 +43,16 @@ options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Indicates desired state of the disk.
|
- Indicates desired state of the disk.
|
||||||
- O(state=present) can be used to create, replace disk or update options in existing disk. It will create missing disk or update options
|
- O(state=present) can be used to create, replace disk or update options in existing disk. It will create missing disk
|
||||||
in existing one by default. See the O(create) parameter description to control behavior of this option.
|
or update options in existing one by default. See the O(create) parameter description to control behavior of this
|
||||||
|
option.
|
||||||
- Some updates on options (like O(cache)) are not being applied instantly and require VM restart.
|
- Some updates on options (like O(cache)) are not being applied instantly and require VM restart.
|
||||||
- Use O(state=detached) to detach existing disk from VM but do not remove it entirely. When O(state=detached) and disk is V(unused[n]) it
|
- Use O(state=detached) to detach existing disk from VM but do not remove it entirely. When O(state=detached) and disk
|
||||||
will be left in same state (not removed).
|
is V(unused[n]) it will be left in same state (not removed).
|
||||||
- O(state=moved) may be used to change backing storage for the disk in bounds of the same VM or to send the disk to another VM (using the
|
- O(state=moved) may be used to change backing storage for the disk in bounds of the same VM or to send the disk to
|
||||||
same backing storage).
|
another VM (using the same backing storage).
|
||||||
- O(state=resized) intended to change the disk size. As of Proxmox 7.2 you can only increase the disk size because shrinking disks is not
|
- O(state=resized) intended to change the disk size. As of Proxmox 7.2 you can only increase the disk size because shrinking
|
||||||
supported by the PVE API and has to be done manually.
|
disks is not supported by the PVE API and has to be done manually.
|
||||||
- To entirely remove the disk from backing storage use O(state=absent).
|
- To entirely remove the disk from backing storage use O(state=absent).
|
||||||
type: str
|
type: str
|
||||||
choices: ['present', 'resized', 'detached', 'moved', 'absent']
|
choices: ['present', 'resized', 'detached', 'moved', 'absent']
|
||||||
|
@ -73,8 +74,8 @@ options:
|
||||||
size:
|
size:
|
||||||
description:
|
description:
|
||||||
- Desired volume size in GB to allocate when O(state=present) (specify O(size) without suffix).
|
- Desired volume size in GB to allocate when O(state=present) (specify O(size) without suffix).
|
||||||
- New (or additional) size of volume when O(state=resized). With the V(+) sign the value is added to the actual size of the volume and without
|
- New (or additional) size of volume when O(state=resized). With the V(+) sign the value is added to the actual size
|
||||||
it, the value is taken as an absolute one.
|
of the volume and without it, the value is taken as an absolute one.
|
||||||
type: str
|
type: str
|
||||||
bwlimit:
|
bwlimit:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -35,8 +35,8 @@ options:
|
||||||
agent:
|
agent:
|
||||||
description:
|
description:
|
||||||
- Specify if the QEMU Guest Agent should be enabled/disabled.
|
- Specify if the QEMU Guest Agent should be enabled/disabled.
|
||||||
- Since community.general 5.5.0, this can also be a string instead of a boolean.
|
- Since community.general 5.5.0, this can also be a string instead of a boolean. This allows to specify values such
|
||||||
This allows to specify values such as V(enabled=1,fstrim_cloned_disks=1).
|
as V(enabled=1,fstrim_cloned_disks=1).
|
||||||
type: str
|
type: str
|
||||||
args:
|
args:
|
||||||
description:
|
description:
|
||||||
|
@ -97,7 +97,8 @@ options:
|
||||||
version_added: 1.3.0
|
version_added: 1.3.0
|
||||||
clone:
|
clone:
|
||||||
description:
|
description:
|
||||||
- Name of VM to be cloned. If O(vmid) is set, O(clone) can take an arbitrary value but is required for initiating the clone.
|
- Name of VM to be cloned. If O(vmid) is set, O(clone) can take an arbitrary value but is required for initiating the
|
||||||
|
clone.
|
||||||
type: str
|
type: str
|
||||||
cores:
|
cores:
|
||||||
description:
|
description:
|
||||||
|
@ -143,22 +144,24 @@ options:
|
||||||
type: str
|
type: str
|
||||||
format:
|
format:
|
||||||
description:
|
description:
|
||||||
- V(format) is the drive's backing file's data format. Please refer to the Proxmox VE Administrator Guide, section Proxmox VE Storage
|
- V(format) is the drive's backing file's data format. Please refer to the Proxmox VE Administrator Guide, section
|
||||||
(see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format supported by
|
Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables
|
||||||
the provided storage backend.
|
3 to 14) to find out format supported by the provided storage backend.
|
||||||
type: str
|
type: str
|
||||||
efitype:
|
efitype:
|
||||||
description:
|
description:
|
||||||
- V(efitype) indicates the size of the EFI disk.
|
- V(efitype) indicates the size of the EFI disk.
|
||||||
- V(2m) will allow for a 2MB EFI disk, which will be enough to persist boot order and new boot entries.
|
- V(2m) will allow for a 2MB EFI disk, which will be enough to persist boot order and new boot entries.
|
||||||
- V(4m) will allow for a 4MB EFI disk, which will additionally allow to store EFI keys in order to enable Secure Boot.
|
- V(4m) will allow for a 4MB EFI disk, which will additionally allow to store EFI keys in order to enable Secure
|
||||||
|
Boot.
|
||||||
type: str
|
type: str
|
||||||
choices:
|
choices:
|
||||||
- 2m
|
- 2m
|
||||||
- 4m
|
- 4m
|
||||||
pre_enrolled_keys:
|
pre_enrolled_keys:
|
||||||
description:
|
description:
|
||||||
- V(pre_enrolled_keys) indicates whether EFI keys for Secure Boot should be enrolled V(1) in the VM firmware upon creation or not (0).
|
- V(pre_enrolled_keys) indicates whether EFI keys for Secure Boot should be enrolled V(1) in the VM firmware upon
|
||||||
|
creation or not (0).
|
||||||
- If set to V(1), Secure Boot will also be enabled by default when the VM is created.
|
- If set to V(1), Secure Boot will also be enabled by default when the VM is created.
|
||||||
type: bool
|
type: bool
|
||||||
version_added: 4.5.0
|
version_added: 4.5.0
|
||||||
|
@ -203,7 +206,8 @@ options:
|
||||||
- V(pcie=boolean) V(default=0) Choose the PCI-express bus (needs the q35 machine model).
|
- V(pcie=boolean) V(default=0) Choose the PCI-express bus (needs the q35 machine model).
|
||||||
- V(rombar=boolean) V(default=1) Specify whether or not the device's ROM will be visible in the guest's memory map.
|
- V(rombar=boolean) V(default=1) Specify whether or not the device's ROM will be visible in the guest's memory map.
|
||||||
- V(x-vga=boolean) V(default=0) Enable vfio-vga device support.
|
- V(x-vga=boolean) V(default=0) Enable vfio-vga device support.
|
||||||
- /!\ This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
|
- /!\ This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use
|
||||||
|
with special care.
|
||||||
type: dict
|
type: dict
|
||||||
hotplug:
|
hotplug:
|
||||||
description:
|
description:
|
||||||
|
@ -223,9 +227,9 @@ options:
|
||||||
- Values allowed are - V("storage:size,format=value").
|
- Values allowed are - V("storage:size,format=value").
|
||||||
- V(storage) is the storage identifier where to create the disk.
|
- V(storage) is the storage identifier where to create the disk.
|
||||||
- V(size) is the size of the disk in GB.
|
- V(size) is the size of the disk in GB.
|
||||||
- V(format) is the drive's backing file's data format. V(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section
|
- V(format) is the drive's backing file's data format. V(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator
|
||||||
Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format
|
Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version,
|
||||||
supported by the provided storage backend.
|
tables 3 to 14) to find out format supported by the provided storage backend.
|
||||||
type: dict
|
type: dict
|
||||||
ipconfig:
|
ipconfig:
|
||||||
description:
|
description:
|
||||||
|
@ -300,11 +304,13 @@ options:
|
||||||
- A hash/dictionary of network interfaces for the VM. O(net='{"key":"value", "key":"value"}').
|
- A hash/dictionary of network interfaces for the VM. O(net='{"key":"value", "key":"value"}').
|
||||||
- Keys allowed are - C(net[n]) where 0 ≤ n ≤ N.
|
- Keys allowed are - C(net[n]) where 0 ≤ n ≤ N.
|
||||||
- Values allowed are - C("model="XX:XX:XX:XX:XX:XX",bridge="value",rate="value",tag="value",firewall="1|0",trunks="vlanid"").
|
- Values allowed are - C("model="XX:XX:XX:XX:XX:XX",bridge="value",rate="value",tag="value",firewall="1|0",trunks="vlanid"").
|
||||||
- Model is one of C(e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3).
|
- Model is one of C(e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet
|
||||||
|
rtl8139 virtio vmxnet3).
|
||||||
- C(XX:XX:XX:XX:XX:XX) should be an unique MAC address. This is automatically generated if not specified.
|
- C(XX:XX:XX:XX:XX:XX) should be an unique MAC address. This is automatically generated if not specified.
|
||||||
- The C(bridge) parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
|
- The C(bridge) parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard
|
||||||
- Option C(rate) is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes
|
bridge is called 'vmbr0'.
|
||||||
per second'.
|
- Option C(rate) is used to limit traffic bandwidth from and to this interface. It is specified as floating point number,
|
||||||
|
unit is 'Megabytes per second'.
|
||||||
- If you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services.
|
- If you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services.
|
||||||
type: dict
|
type: dict
|
||||||
newid:
|
newid:
|
||||||
|
@ -361,9 +367,9 @@ options:
|
||||||
- Values allowed are - C("storage:size,format=value").
|
- Values allowed are - C("storage:size,format=value").
|
||||||
- C(storage) is the storage identifier where to create the disk.
|
- C(storage) is the storage identifier where to create the disk.
|
||||||
- C(size) is the size of the disk in GB.
|
- C(size) is the size of the disk in GB.
|
||||||
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section
|
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator
|
||||||
Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format
|
Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version,
|
||||||
supported by the provided storage backend.
|
tables 3 to 14) to find out format supported by the provided storage backend.
|
||||||
type: dict
|
type: dict
|
||||||
scsi:
|
scsi:
|
||||||
description:
|
description:
|
||||||
|
@ -372,9 +378,9 @@ options:
|
||||||
- Values allowed are - C("storage:size,format=value").
|
- Values allowed are - C("storage:size,format=value").
|
||||||
- C(storage) is the storage identifier where to create the disk.
|
- C(storage) is the storage identifier where to create the disk.
|
||||||
- C(size) is the size of the disk in GB.
|
- C(size) is the size of the disk in GB.
|
||||||
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section
|
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator
|
||||||
Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format
|
Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version,
|
||||||
supported by the provided storage backend.
|
tables 3 to 14) to find out format supported by the provided storage backend.
|
||||||
type: dict
|
type: dict
|
||||||
scsihw:
|
scsihw:
|
||||||
description:
|
description:
|
||||||
|
@ -393,7 +399,8 @@ options:
|
||||||
- A hash/dictionary of serial device to create inside the VM. V('{"key":"value", "key":"value"}').
|
- A hash/dictionary of serial device to create inside the VM. V('{"key":"value", "key":"value"}').
|
||||||
- Keys allowed are - serial[n](str; required) where 0 ≤ n ≤ 3.
|
- Keys allowed are - serial[n](str; required) where 0 ≤ n ≤ 3.
|
||||||
- Values allowed are - V((/dev/.+|socket\)).
|
- Values allowed are - V((/dev/.+|socket\)).
|
||||||
- /!\ If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
|
- /!\ If you pass through a host serial device, it is no longer possible to migrate such machines - use with special
|
||||||
|
care.
|
||||||
type: dict
|
type: dict
|
||||||
shares:
|
shares:
|
||||||
description:
|
description:
|
||||||
|
@ -483,7 +490,8 @@ options:
|
||||||
timeout:
|
timeout:
|
||||||
description:
|
description:
|
||||||
- Timeout for operations.
|
- Timeout for operations.
|
||||||
- When used with O(state=stopped) the option sets a graceful timeout for VM stop after which a VM will be forcefully stopped.
|
- When used with O(state=stopped) the option sets a graceful timeout for VM stop after which a VM will be forcefully
|
||||||
|
stopped.
|
||||||
type: int
|
type: int
|
||||||
default: 30
|
default: 30
|
||||||
tpmstate0:
|
tpmstate0:
|
||||||
|
@ -517,16 +525,17 @@ options:
|
||||||
update:
|
update:
|
||||||
description:
|
description:
|
||||||
- If V(true), the VM will be updated with new value.
|
- If V(true), the VM will be updated with new value.
|
||||||
- Because of the operations of the API and security reasons, I have disabled the update of the following parameters O(net), O(virtio), O(ide),
|
- Because of the operations of the API and security reasons, I have disabled the update of the following parameters
|
||||||
O(sata), O(scsi). Per example updating O(net) update the MAC address and O(virtio) create always new disk... This security feature can
|
O(net), O(virtio), O(ide), O(sata), O(scsi). Per example updating O(net) update the MAC address and O(virtio) create
|
||||||
be disabled by setting the O(update_unsafe) to V(true).
|
always new disk... This security feature can be disabled by setting the O(update_unsafe) to V(true).
|
||||||
- Update of O(pool) is disabled. It needs an additional API endpoint not covered by this module.
|
- Update of O(pool) is disabled. It needs an additional API endpoint not covered by this module.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
update_unsafe:
|
update_unsafe:
|
||||||
description:
|
description:
|
||||||
- If V(true), do not enforce limitations on parameters O(net), O(virtio), O(ide), O(sata), O(scsi), O(efidisk0), and O(tpmstate0). Use this
|
- If V(true), do not enforce limitations on parameters O(net), O(virtio), O(ide), O(sata), O(scsi), O(efidisk0), and
|
||||||
option with caution because an improper configuration might result in a permanent loss of data (for example disk recreated).
|
O(tpmstate0). Use this option with caution because an improper configuration might result in a permanent loss of data
|
||||||
|
(for example disk recreated).
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
version_added: 8.4.0
|
version_added: 8.4.0
|
||||||
|
@ -546,9 +555,9 @@ options:
|
||||||
- Values allowed are - V(storage:size,format=value).
|
- Values allowed are - V(storage:size,format=value).
|
||||||
- V(storage) is the storage identifier where to create the disk.
|
- V(storage) is the storage identifier where to create the disk.
|
||||||
- V(size) is the size of the disk in GB.
|
- V(size) is the size of the disk in GB.
|
||||||
- V(format) is the drive's backing file's data format. V(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section
|
- V(format) is the drive's backing file's data format. V(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator
|
||||||
Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format
|
Guide, section Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version,
|
||||||
supported by the provided storage backend.
|
tables 3 to 14) to find out format supported by the provided storage backend.
|
||||||
type: dict
|
type: dict
|
||||||
watchdog:
|
watchdog:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -51,8 +51,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- The NIC emulator model.
|
- The NIC emulator model.
|
||||||
type: str
|
type: str
|
||||||
choices: ['e1000', 'e1000-82540em', 'e1000-82544gc', 'e1000-82545em', 'i82551', 'i82557b', 'i82559er', 'ne2k_isa', 'ne2k_pci', 'pcnet', 'rtl8139',
|
choices: ['e1000', 'e1000-82540em', 'e1000-82544gc', 'e1000-82545em', 'i82551', 'i82557b', 'i82559er', 'ne2k_isa', 'ne2k_pci',
|
||||||
'virtio', 'vmxnet3']
|
'pcnet', 'rtl8139', 'virtio', 'vmxnet3']
|
||||||
default: virtio
|
default: virtio
|
||||||
mtu:
|
mtu:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -29,7 +29,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
vmid:
|
vmid:
|
||||||
description:
|
description:
|
||||||
- The instance id.
|
- The instance ID.
|
||||||
- If not set, will be fetched from PromoxAPI based on the hostname.
|
- If not set, will be fetched from PromoxAPI based on the hostname.
|
||||||
type: str
|
type: str
|
||||||
state:
|
state:
|
||||||
|
@ -50,8 +50,8 @@ options:
|
||||||
- Allows to snapshot a container even if it has configured mountpoints.
|
- Allows to snapshot a container even if it has configured mountpoints.
|
||||||
- Temporarily disables all configured mountpoints, takes snapshot, and finally restores original configuration.
|
- Temporarily disables all configured mountpoints, takes snapshot, and finally restores original configuration.
|
||||||
- If running, the container will be stopped and restarted to apply config changes.
|
- If running, the container will be stopped and restarted to apply config changes.
|
||||||
- Due to restrictions in the Proxmox API this option can only be used authenticating as V(root@pam) with O(api_password), API tokens do
|
- Due to restrictions in the Proxmox API this option can only be used authenticating as V(root@pam) with O(api_password),
|
||||||
not work either.
|
API tokens do not work either.
|
||||||
- See U(https://pve.proxmox.com/pve-docs/api-viewer/#/nodes/{node}/lxc/{vmid}/config) (PUT tab) for more details.
|
- See U(https://pve.proxmox.com/pve-docs/api-viewer/#/nodes/{node}/lxc/{vmid}/config) (PUT tab) for more details.
|
||||||
default: false
|
default: false
|
||||||
type: bool
|
type: bool
|
||||||
|
@ -80,8 +80,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- Remove old snapshots if there are more than O(retention) snapshots.
|
- Remove old snapshots if there are more than O(retention) snapshots.
|
||||||
- If O(retention) is set to V(0), all snapshots will be kept.
|
- If O(retention) is set to V(0), all snapshots will be kept.
|
||||||
- This is only used when O(state=present) and when an actual snapshot is created. If no snapshot is created, all existing snapshots will
|
- This is only used when O(state=present) and when an actual snapshot is created. If no snapshot is created, all existing
|
||||||
be kept.
|
snapshots will be kept.
|
||||||
default: 0
|
default: 0
|
||||||
type: int
|
type: int
|
||||||
version_added: 7.1.0
|
version_added: 7.1.0
|
||||||
|
|
|
@ -18,8 +18,8 @@ DOCUMENTATION = r"""
|
||||||
module: pubnub_blocks
|
module: pubnub_blocks
|
||||||
short_description: PubNub blocks management module
|
short_description: PubNub blocks management module
|
||||||
description:
|
description:
|
||||||
- 'This module allows Ansible to interface with the PubNub BLOCKS infrastructure by providing the following operations: create / remove, start
|
- 'This module allows Ansible to interface with the PubNub BLOCKS infrastructure by providing the following operations:
|
||||||
/ stop and rename for blocks and create / modify / remove for event handlers.'
|
create / remove, start / stop and rename for blocks and create / modify / remove for event handlers.'
|
||||||
author:
|
author:
|
||||||
- PubNub <support@pubnub.com> (@pubnub)
|
- PubNub <support@pubnub.com> (@pubnub)
|
||||||
- Sergey Mamontov <sergey@pubnub.com> (@parfeon)
|
- Sergey Mamontov <sergey@pubnub.com> (@parfeon)
|
||||||
|
@ -49,8 +49,8 @@ options:
|
||||||
default: ''
|
default: ''
|
||||||
cache:
|
cache:
|
||||||
description: >-
|
description: >-
|
||||||
In case if single play use blocks management module few times it is preferred to enabled 'caching' by making previous module to share gathered
|
In case if single play use blocks management module few times it is preferred to enabled 'caching' by making previous
|
||||||
artifacts and pass them to this parameter.
|
module to share gathered artifacts and pass them to this parameter.
|
||||||
required: false
|
required: false
|
||||||
type: dict
|
type: dict
|
||||||
default: {}
|
default: {}
|
||||||
|
@ -84,22 +84,22 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- Short block description which will be later visible on admin.pubnub.com. Used only if block doesn't exists and won't change description
|
- Short block description which will be later visible on U(https://admin.pubnub.com).
|
||||||
for existing block.
|
- Used only if block does not exists and does not change description for existing block.
|
||||||
required: false
|
required: false
|
||||||
type: str
|
type: str
|
||||||
event_handlers:
|
event_handlers:
|
||||||
description:
|
description:
|
||||||
- List of event handlers which should be updated for specified block O(name).
|
- List of event handlers which should be updated for specified block O(name).
|
||||||
- 'Each entry for new event handler should contain: V(name), V(src), V(channels), V(event). V(name) used as event handler name which can
|
- 'Each entry for new event handler should contain: V(name), V(src), V(channels), V(event). V(name) used as event handler
|
||||||
be used later to make changes to it.'
|
name which can be used later to make changes to it.'
|
||||||
- C(src) is full path to file with event handler code.
|
- C(src) is full path to file with event handler code.
|
||||||
- V(channels) is name of channel from which event handler is waiting for events.
|
- V(channels) is name of channel from which event handler is waiting for events.
|
||||||
- 'V(event) is type of event which is able to trigger event handler: V(js-before-publish), V(js-after-publish), V(js-after-presence).'
|
- 'V(event) is type of event which is able to trigger event handler: V(js-before-publish), V(js-after-publish), V(js-after-presence).'
|
||||||
- Each entry for existing handlers should contain C(name) (so target handler can be identified). Rest parameters (C(src), C(channels) and
|
- Each entry for existing handlers should contain C(name) (so target handler can be identified). Rest parameters (C(src),
|
||||||
C(event)) can be added if changes required for them.
|
C(channels) and C(event)) can be added if changes required for them.
|
||||||
- It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which will contain single
|
- It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which
|
||||||
key C(name), where new name should be passed.
|
will contain single key C(name), where new name should be passed.
|
||||||
- To remove particular event handler it is possible to set C(state) for it to C(absent) and it will be removed.
|
- To remove particular event handler it is possible to set C(state) for it to C(absent) and it will be removed.
|
||||||
required: false
|
required: false
|
||||||
default: []
|
default: []
|
||||||
|
@ -114,8 +114,8 @@ options:
|
||||||
type: dict
|
type: dict
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with certificates on it and
|
- This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with
|
||||||
this will cause problems to call PubNub REST API.
|
certificates on it and this will cause problems to call PubNub REST API.
|
||||||
- If check should be ignored V(false) should be passed to this parameter.
|
- If check should be ignored V(false) should be passed to this parameter.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: true
|
||||||
|
@ -208,8 +208,8 @@ EXAMPLES = r"""
|
||||||
RETURN = r"""
|
RETURN = r"""
|
||||||
module_cache:
|
module_cache:
|
||||||
description:
|
description:
|
||||||
- Cached account information. In case if with single play module used few times it is better to pass cached data to next module calls to speed
|
- Cached account information. In case if with single play module used few times it is better to pass cached data to next
|
||||||
up process.
|
module calls to speed up process.
|
||||||
type: dict
|
type: dict
|
||||||
returned: always
|
returned: always
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -34,9 +34,9 @@ options:
|
||||||
type: str
|
type: str
|
||||||
force_basic_auth:
|
force_basic_auth:
|
||||||
description:
|
description:
|
||||||
- C(httplib2), the library used by the M(ansible.builtin.uri) module only sends authentication information when a webservice responds to an
|
- C(httplib2), the library used by the M(ansible.builtin.uri) module only sends authentication information when a webservice
|
||||||
initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. This option forces the
|
responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins
|
||||||
sending of the Basic authentication header upon initial request.
|
will fail. This option forces the sending of the Basic authentication header upon initial request.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
generate_sqlite:
|
generate_sqlite:
|
||||||
|
@ -47,20 +47,22 @@ options:
|
||||||
default: false
|
default: false
|
||||||
feed_ca_cert:
|
feed_ca_cert:
|
||||||
description:
|
description:
|
||||||
- CA certificate string used to validate the feed source SSL certificate. This can be the file content or the path to the file.
|
- CA certificate string used to validate the feed source SSL certificate. This can be the file content or the path to
|
||||||
|
the file.
|
||||||
type: str
|
type: str
|
||||||
aliases: [importer_ssl_ca_cert]
|
aliases: [importer_ssl_ca_cert]
|
||||||
feed_client_cert:
|
feed_client_cert:
|
||||||
description:
|
description:
|
||||||
- Certificate used as the client certificate when synchronizing the repository. This is used to communicate authentication information to
|
- Certificate used as the client certificate when synchronizing the repository. This is used to communicate authentication
|
||||||
the feed source. The value to this option must be the full path to the certificate. The specified file may be the certificate itself or
|
information to the feed source. The value to this option must be the full path to the certificate. The specified file
|
||||||
a single file containing both the certificate and private key. This can be the file content or the path to the file.
|
may be the certificate itself or a single file containing both the certificate and private key. This can be the file
|
||||||
|
content or the path to the file.
|
||||||
type: str
|
type: str
|
||||||
aliases: [importer_ssl_client_cert]
|
aliases: [importer_ssl_client_cert]
|
||||||
feed_client_key:
|
feed_client_key:
|
||||||
description:
|
description:
|
||||||
- Private key to the certificate specified in O(feed_client_cert), assuming it is not included in the certificate file itself. This can
|
- Private key to the certificate specified in O(feed_client_cert), assuming it is not included in the certificate file
|
||||||
be the file content or the path to the file.
|
itself. This can be the file content or the path to the file.
|
||||||
type: str
|
type: str
|
||||||
aliases: [importer_ssl_client_key]
|
aliases: [importer_ssl_client_key]
|
||||||
name:
|
name:
|
||||||
|
@ -71,7 +73,7 @@ options:
|
||||||
aliases: [repo]
|
aliases: [repo]
|
||||||
proxy_host:
|
proxy_host:
|
||||||
description:
|
description:
|
||||||
- Proxy url setting for the pulp repository importer. This is in the format scheme://host.
|
- Proxy URL setting for the pulp repository importer. This is in the format V(scheme://host).
|
||||||
required: false
|
required: false
|
||||||
default:
|
default:
|
||||||
type: str
|
type: str
|
||||||
|
@ -129,21 +131,22 @@ options:
|
||||||
default: true
|
default: true
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- The repo state. A state of V(sync) will queue a sync of the repo. This is asynchronous but not delayed like a scheduled sync. A state
|
- The repo state. A state of V(sync) will queue a sync of the repo. This is asynchronous but not delayed like a scheduled
|
||||||
of V(publish) will use the repository's distributor to publish the content.
|
sync. A state of V(publish) will use the repository's distributor to publish the content.
|
||||||
default: present
|
default: present
|
||||||
choices: ["present", "absent", "sync", "publish"]
|
choices: ["present", "absent", "sync", "publish"]
|
||||||
type: str
|
type: str
|
||||||
url_password:
|
url_password:
|
||||||
description:
|
description:
|
||||||
- The password for use in HTTP basic authentication to the pulp API. If the O(url_username) parameter is not specified, the O(url_password)
|
- The password for use in HTTP basic authentication to the pulp API. If the O(url_username) parameter is not specified,
|
||||||
parameter will not be used.
|
the O(url_password) parameter will not be used.
|
||||||
url_username:
|
url_username:
|
||||||
description:
|
description:
|
||||||
- The username for use in HTTP basic authentication to the pulp API.
|
- The username for use in HTTP basic authentication to the pulp API.
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
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 will not be validated. This should only be used on personally controlled sites using
|
||||||
|
self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
wait_for_completion:
|
wait_for_completion:
|
||||||
|
@ -152,7 +155,8 @@ options:
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
notes:
|
notes:
|
||||||
- This module can currently only create distributors and importers on rpm repositories. Contributions to support other repo types are welcome.
|
- This module can currently only create distributors and importers on rpm repositories. Contributions to support other repo
|
||||||
|
types are welcome.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- ansible.builtin.url
|
- ansible.builtin.url
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
|
|
|
@ -103,7 +103,8 @@ options:
|
||||||
waitforlock:
|
waitforlock:
|
||||||
description:
|
description:
|
||||||
- The maximum amount of time C(puppet) should wait for an already running C(puppet) agent to finish before starting.
|
- The maximum amount of time C(puppet) should wait for an already running C(puppet) agent to finish before starting.
|
||||||
- If a number without unit is provided, it is assumed to be a number of seconds. Allowed units are V(m) for minutes and V(h) for hours.
|
- If a number without unit is provided, it is assumed to be a number of seconds. Allowed units are V(m) for minutes
|
||||||
|
and V(h) for hours.
|
||||||
type: str
|
type: str
|
||||||
version_added: 9.0.0
|
version_added: 9.0.0
|
||||||
verbose:
|
verbose:
|
||||||
|
@ -125,10 +126,10 @@ options:
|
||||||
description:
|
description:
|
||||||
- The lang environment to use when running the puppet agent.
|
- The lang environment to use when running the puppet agent.
|
||||||
- The default value, V(C), is supported on every system, but can lead to encoding errors if UTF-8 is used in the output.
|
- The default value, V(C), is supported on every system, but can lead to encoding errors if UTF-8 is used in the output.
|
||||||
- Use V(C.UTF-8) or V(en_US.UTF-8) or similar UTF-8 supporting locales in case of problems. You need to make sure the selected locale is
|
- Use V(C.UTF-8) or V(en_US.UTF-8) or similar UTF-8 supporting locales in case of problems. You need to make sure the
|
||||||
supported on the system the puppet agent runs on.
|
selected locale is supported on the system the puppet agent runs on.
|
||||||
- Starting with community.general 9.1.0, you can use the value V(auto) and the module will try and determine the best parseable locale to
|
- Starting with community.general 9.1.0, you can use the value V(auto) and the module will try and determine the best
|
||||||
use.
|
parseable locale to use.
|
||||||
type: str
|
type: str
|
||||||
default: C
|
default: C
|
||||||
version_added: 8.6.0
|
version_added: 8.6.0
|
||||||
|
|
|
@ -32,7 +32,8 @@ options:
|
||||||
channel:
|
channel:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The channel TAG you wish to broadcast a push notification, as seen on the "My Channels" > "Edit your channel" at Pushbullet page.
|
- The channel TAG you wish to broadcast a push notification, as seen on the "My Channels" > "Edit your channel" at Pushbullet
|
||||||
|
page.
|
||||||
device:
|
device:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -20,9 +20,10 @@ options:
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
description:
|
description:
|
||||||
- 'A list of version-likes or module names to check for installation. Supported operators: C(<), C(>), C(<=), C(>=), or C(==).'
|
- 'A list of version-likes or module names to check for installation. Supported operators: C(<), C(>), C(<=), C(>=),
|
||||||
- The bare module name like V(ansible), the module with a specific version like V(boto3==1.6.1),
|
or C(==).'
|
||||||
or a partial version like V(requests>2) are all valid specifications.
|
- The bare module name like V(ansible), the module with a specific version like V(boto3==1.6.1), or a partial version
|
||||||
|
like V(requests>2) are all valid specifications.
|
||||||
default: []
|
default: []
|
||||||
author:
|
author:
|
||||||
- Will Thames (@willthames)
|
- Will Thames (@willthames)
|
||||||
|
@ -90,8 +91,8 @@ python_system_path:
|
||||||
- /usr/local/opt/python@2/site-packages/
|
- /usr/local/opt/python@2/site-packages/
|
||||||
- /usr/lib/python/site-packages/
|
- /usr/lib/python/site-packages/
|
||||||
valid:
|
valid:
|
||||||
description: A dictionary of dependencies that matched their desired versions. If no version was specified, then RV(ignore:desired) will be
|
description: A dictionary of dependencies that matched their desired versions. If no version was specified, then RV(ignore:desired)
|
||||||
null.
|
will be V(null).
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
sample:
|
sample:
|
||||||
|
|
|
@ -63,7 +63,8 @@ options:
|
||||||
aliases: [account_id]
|
aliases: [account_id]
|
||||||
description:
|
description:
|
||||||
- ID of account to delete/modify.
|
- ID of account to delete/modify.
|
||||||
- Can also be used in account creation to work around vendor issues where the ID of the new user is required in the POST request.
|
- Can also be used in account creation to work around vendor issues where the ID of the new user is required in the
|
||||||
|
POST request.
|
||||||
type: str
|
type: str
|
||||||
new_username:
|
new_username:
|
||||||
required: false
|
required: false
|
||||||
|
@ -227,9 +228,9 @@ options:
|
||||||
description:
|
description:
|
||||||
- Custom OEM properties for HTTP Multipart Push updates.
|
- Custom OEM properties for HTTP Multipart Push updates.
|
||||||
- If set, then O(update_custom_oem_header) is required too.
|
- If set, then O(update_custom_oem_header) is required too.
|
||||||
- The properties will be passed raw without any validation or conversion by Ansible. This means the content can be a file, a string, or
|
- The properties will be passed raw without any validation or conversion by Ansible. This means the content can be a
|
||||||
any other data. If the content is a dict that should be converted to JSON, then the content must be converted to JSON before passing it
|
file, a string, or any other data. If the content is a dict that should be converted to JSON, then the content must
|
||||||
to this module using the P(ansible.builtin.to_json#filter) filter.
|
be converted to JSON before passing it to this module using the P(ansible.builtin.to_json#filter) filter.
|
||||||
type: raw
|
type: raw
|
||||||
version_added: '10.1.0'
|
version_added: '10.1.0'
|
||||||
update_custom_oem_mime_type:
|
update_custom_oem_mime_type:
|
||||||
|
@ -327,7 +328,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- SSL/TLS Ciphers to use for the request.
|
- SSL/TLS Ciphers to use for the request.
|
||||||
- When a list is provided, all ciphers are joined in order with V(:).
|
- When a list is provided, all ciphers are joined in order with V(:).
|
||||||
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT) for more details.
|
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT)
|
||||||
|
for more details.
|
||||||
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
|
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
|
|
|
@ -136,7 +136,7 @@ options:
|
||||||
storage_subsystem_id:
|
storage_subsystem_id:
|
||||||
required: false
|
required: false
|
||||||
description:
|
description:
|
||||||
- Id of the Storage Subsystem on which the volume is to be created.
|
- ID of the Storage Subsystem on which the volume is to be created.
|
||||||
type: str
|
type: str
|
||||||
default: ''
|
default: ''
|
||||||
version_added: '7.3.0'
|
version_added: '7.3.0'
|
||||||
|
@ -166,8 +166,8 @@ options:
|
||||||
required: false
|
required: false
|
||||||
description:
|
description:
|
||||||
- Setting dict of volume to be created.
|
- Setting dict of volume to be created.
|
||||||
- If C(CapacityBytes) key is not specified in this dictionary, the size of the volume will be determined by the Redfish service. It is possible
|
- If C(CapacityBytes) key is not specified in this dictionary, the size of the volume will be determined by the Redfish
|
||||||
the size will not be the maximum available size.
|
service. It is possible the size will not be the maximum available size.
|
||||||
type: dict
|
type: dict
|
||||||
default: {}
|
default: {}
|
||||||
version_added: '7.5.0'
|
version_added: '7.5.0'
|
||||||
|
@ -176,7 +176,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- SSL/TLS Ciphers to use for the request.
|
- SSL/TLS Ciphers to use for the request.
|
||||||
- When a list is provided, all ciphers are joined in order with V(:).
|
- When a list is provided, all ciphers are joined in order with V(:).
|
||||||
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT) for more details.
|
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT)
|
||||||
|
for more details.
|
||||||
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
|
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
|
|
|
@ -75,7 +75,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- SSL/TLS Ciphers to use for the request.
|
- SSL/TLS Ciphers to use for the request.
|
||||||
- When a list is provided, all ciphers are joined in order with V(:).
|
- When a list is provided, all ciphers are joined in order with V(:).
|
||||||
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT) for more details.
|
- See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT)
|
||||||
|
for more details.
|
||||||
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
|
- The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
|
|
|
@ -14,32 +14,27 @@ DOCUMENTATION = r"""
|
||||||
module: redhat_subscription
|
module: redhat_subscription
|
||||||
short_description: Manage registration and subscriptions to RHSM using C(subscription-manager)
|
short_description: Manage registration and subscriptions to RHSM using C(subscription-manager)
|
||||||
description:
|
description:
|
||||||
- Manage registration and subscription to the Red Hat Subscription Management entitlement platform using the C(subscription-manager) command,
|
- Manage registration and subscription to the Red Hat Subscription Management entitlement platform using the C(subscription-manager)
|
||||||
registering using D-Bus if possible.
|
command, registering using D-Bus if possible.
|
||||||
author: "Barnaby Court (@barnabycourt)"
|
author: "Barnaby Court (@barnabycourt)"
|
||||||
notes:
|
notes:
|
||||||
- >-
|
- 'The module tries to use the D-Bus C(rhsm) service (part of C(subscription-manager)) to register, starting from community.general
|
||||||
The module tries to use the D-Bus C(rhsm) service (part of C(subscription-manager))
|
6.5.0: this is done so credentials (username, password, activation keys) can be passed to C(rhsm) in a secure way. C(subscription-manager)
|
||||||
to register, starting from community.general 6.5.0: this is done so credentials
|
itself gets credentials only as arguments of command line parameters, which is I(not) secure, as they can be easily stolen
|
||||||
(username, password, activation keys) can be passed to C(rhsm) in a secure way.
|
by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module will I(not)
|
||||||
C(subscription-manager) itself gets credentials only as arguments of command line
|
use D-Bus for registration when trying either to register using O(token), or when specifying O(environment), or when the
|
||||||
parameters, which is I(not) secure, as they can be easily stolen by checking the
|
system is old (typically RHEL 7 older than 7.4, RHEL 6, and older).'
|
||||||
process listing on the system. Due to limitations of the D-Bus interface of C(rhsm),
|
- In order to register a system, subscription-manager requires either a username and password, or an activationkey and an
|
||||||
the module will I(not) use D-Bus for registration when trying either to register
|
Organization ID.
|
||||||
using O(token), or when specifying O(environment), or when the system is old
|
- Since 2.5 values for O(server_hostname), O(server_insecure), O(rhsm_baseurl), O(server_proxy_hostname), O(server_proxy_port),
|
||||||
(typically RHEL 7 older than 7.4, RHEL 6, and older).
|
O(server_proxy_user) and O(server_proxy_password) are no longer taken from the C(/etc/rhsm/rhsm.conf) config file and
|
||||||
- In order to register a system, subscription-manager requires either a username and password, or an activationkey and an Organization ID.
|
default to V(null).
|
||||||
- Since 2.5 values for O(server_hostname), O(server_insecure), O(rhsm_baseurl),
|
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully
|
||||||
O(server_proxy_hostname), O(server_proxy_port), O(server_proxy_user) and
|
run this module.
|
||||||
O(server_proxy_password) are no longer taken from the C(/etc/rhsm/rhsm.conf)
|
- Since community.general 6.5.0, credentials (that is, O(username) and O(password), O(activationkey), or O(token)) are needed
|
||||||
config file and default to V(null).
|
only in case the the system is not registered, or O(force_register) is specified; this makes it possible to use the module
|
||||||
- It is possible to interact with C(subscription-manager) only as root,
|
to tweak an already registered system, for example attaching pools to it (using O(pool_ids)), and modifying the C(syspurpose)
|
||||||
so root permissions are required to successfully run this module.
|
attributes (using O(syspurpose)).
|
||||||
- Since community.general 6.5.0, credentials (that is, O(username) and O(password),
|
|
||||||
O(activationkey), or O(token)) are needed only in case the the system is not registered,
|
|
||||||
or O(force_register) is specified; this makes it possible to use the module to tweak an
|
|
||||||
already registered system, for example attaching pools to it (using O(pool_ids)),
|
|
||||||
and modifying the C(syspurpose) attributes (using O(syspurpose)).
|
|
||||||
requirements:
|
requirements:
|
||||||
- subscription-manager
|
- subscription-manager
|
||||||
- Optionally the C(dbus) Python library; this is usually included in the OS as it is used by C(subscription-manager).
|
- Optionally the C(dbus) Python library; this is usually included in the OS as it is used by C(subscription-manager).
|
||||||
|
@ -120,7 +115,7 @@ options:
|
||||||
auto_attach:
|
auto_attach:
|
||||||
description:
|
description:
|
||||||
- Upon successful registration, auto-consume available subscriptions.
|
- Upon successful registration, auto-consume available subscriptions.
|
||||||
- "Please note that the alias O(ignore:autosubscribe) was removed in community.general 9.0.0."
|
- Please note that the alias O(ignore:autosubscribe) was removed in community.general 9.0.0.
|
||||||
type: bool
|
type: bool
|
||||||
activationkey:
|
activationkey:
|
||||||
description:
|
description:
|
||||||
|
@ -136,10 +131,11 @@ options:
|
||||||
type: str
|
type: str
|
||||||
pool_ids:
|
pool_ids:
|
||||||
description:
|
description:
|
||||||
- "Specify subscription pool IDs to consume.
|
- Specify subscription pool IDs to consume.
|
||||||
- A pool ID may be specified as a C(string) - just the pool ID (for example V(0123456789abcdef0123456789abcdef)),
|
- 'A pool ID may be specified as a C(string) - just the pool ID (for example
|
||||||
or as a C(dict) with the pool ID as the key, and a quantity as the value (for example V(0123456789abcdef0123456789abcdef: 2). If the
|
V(0123456789abcdef0123456789abcdef)), or as a C(dict) with the pool ID as the key, and a quantity as the value (for
|
||||||
quantity is provided, it is used to consume multiple entitlements from a pool (the pool must support this)."
|
example V(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiple entitlements
|
||||||
|
from a pool (the pool must support this).'
|
||||||
default: []
|
default: []
|
||||||
type: list
|
type: list
|
||||||
elements: raw
|
elements: raw
|
||||||
|
@ -153,9 +149,9 @@ options:
|
||||||
type: str
|
type: str
|
||||||
consumer_id:
|
consumer_id:
|
||||||
description:
|
description:
|
||||||
- "References an existing consumer ID to resume using a previous registration for this system. If the system's identity certificate is
|
- References an existing consumer ID to resume using a previous registration for this system. If the system's identity
|
||||||
lost or corrupted, this option allows it to resume using its previous identity and subscriptions. The default is to not specify a consumer
|
certificate is lost or corrupted, this option allows it to resume using its previous identity and subscriptions. The
|
||||||
ID so a new ID is created."
|
default is to not specify a consumer ID so a new ID is created.
|
||||||
type: str
|
type: str
|
||||||
force_register:
|
force_register:
|
||||||
description:
|
description:
|
||||||
|
@ -168,10 +164,11 @@ options:
|
||||||
type: str
|
type: str
|
||||||
syspurpose:
|
syspurpose:
|
||||||
description:
|
description:
|
||||||
- Set syspurpose attributes in file C(/etc/rhsm/syspurpose/syspurpose.json) and synchronize these attributes with RHSM server. Syspurpose
|
- Set syspurpose attributes in file C(/etc/rhsm/syspurpose/syspurpose.json) and synchronize these attributes with RHSM
|
||||||
attributes help attach the most appropriate subscriptions to the system automatically. When C(syspurpose.json) file already contains some
|
server. Syspurpose attributes help attach the most appropriate subscriptions to the system automatically. When C(syspurpose.json)
|
||||||
attributes, then new attributes overwrite existing attributes. When some attribute is not listed in the new list of attributes, the existing
|
file already contains some attributes, then new attributes overwrite existing attributes. When some attribute is not
|
||||||
attribute will be removed from C(syspurpose.json) file. Unknown attributes are ignored.
|
listed in the new list of attributes, the existing attribute will be removed from C(syspurpose.json) file. Unknown
|
||||||
|
attributes are ignored.
|
||||||
type: dict
|
type: dict
|
||||||
suboptions:
|
suboptions:
|
||||||
usage:
|
usage:
|
||||||
|
@ -189,8 +186,8 @@ options:
|
||||||
elements: str
|
elements: str
|
||||||
sync:
|
sync:
|
||||||
description:
|
description:
|
||||||
- When this option is V(true), then syspurpose attributes are synchronized with RHSM server immediately. When this option is V(false),
|
- When this option is V(true), then syspurpose attributes are synchronized with RHSM server immediately. When this
|
||||||
then syspurpose attributes will be synchronized with RHSM server by rhsmcertd daemon.
|
option is V(false), then syspurpose attributes will be synchronized with RHSM server by rhsmcertd daemon.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -72,14 +72,15 @@ options:
|
||||||
type: str
|
type: str
|
||||||
value:
|
value:
|
||||||
description:
|
description:
|
||||||
- A redis config value. When memory size is needed, it is possible to specify it in the usual form of 1KB, 2M, 400MB where the base is 1024.
|
- A redis config value. When memory size is needed, it is possible to specify it in the usual form of 1KB, 2M, 400MB
|
||||||
Units are case insensitive, in other words 1m = 1mb = 1M = 1MB.
|
where the base is 1024. Units are case insensitive, in other words 1m = 1mb = 1M = 1MB.
|
||||||
type: str
|
type: str
|
||||||
|
|
||||||
notes:
|
notes:
|
||||||
- Requires the C(redis-py) Python package on the remote host. You can install it with pip
|
- Requires the C(redis-py) Python package on the remote host. You can install it with pip (C(pip install redis)) or with
|
||||||
(C(pip install redis)) or with a package manager. U(https://github.com/andymccurdy/redis-py).
|
a package manager. U(https://github.com/andymccurdy/redis-py).
|
||||||
- If the redis master instance you are making replica of is password protected this needs to be in the C(redis.conf) in the C(masterauth) variable.
|
- If the redis master instance you are making replica of is password protected this needs to be in the C(redis.conf) in
|
||||||
|
the C(masterauth) variable.
|
||||||
seealso:
|
seealso:
|
||||||
- module: community.general.redis_info
|
- module: community.general.redis_info
|
||||||
requirements: [redis]
|
requirements: [redis]
|
||||||
|
|
|
@ -20,10 +20,10 @@ attributes:
|
||||||
check_mode:
|
check_mode:
|
||||||
support: partial
|
support: partial
|
||||||
details:
|
details:
|
||||||
- For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise the module will
|
- For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise
|
||||||
fail.
|
the module will fail.
|
||||||
- When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present, V(0.0) is used as
|
- When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present,
|
||||||
value.
|
V(0.0) is used as value.
|
||||||
diff_mode:
|
diff_mode:
|
||||||
support: none
|
support: none
|
||||||
options:
|
options:
|
||||||
|
|
|
@ -14,9 +14,10 @@ short_description: Set or Unset RHSM Release version
|
||||||
description:
|
description:
|
||||||
- Sets or unsets the release version used by RHSM repositories.
|
- Sets or unsets the release version used by RHSM repositories.
|
||||||
notes:
|
notes:
|
||||||
- This module will fail on an unregistered system. Use the M(community.general.redhat_subscription) module to register a system prior to setting
|
- This module will fail on an unregistered system. Use the M(community.general.redhat_subscription) module to register a
|
||||||
the RHSM release.
|
system prior to setting the RHSM release.
|
||||||
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully run this module.
|
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully
|
||||||
|
run this module.
|
||||||
requirements:
|
requirements:
|
||||||
- Red Hat Enterprise Linux 6+ with subscription-manager installed
|
- Red Hat Enterprise Linux 6+ with subscription-manager installed
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
|
|
@ -12,12 +12,14 @@ DOCUMENTATION = r"""
|
||||||
module: rhsm_repository
|
module: rhsm_repository
|
||||||
short_description: Manage RHSM repositories using the subscription-manager command
|
short_description: Manage RHSM repositories using the subscription-manager command
|
||||||
description:
|
description:
|
||||||
- Manage (Enable/Disable) RHSM repositories to the Red Hat Subscription Management entitlement platform using the C(subscription-manager) command.
|
- Manage (Enable/Disable) RHSM repositories to the Red Hat Subscription Management entitlement platform using the C(subscription-manager)
|
||||||
|
command.
|
||||||
author: Giovanni Sciortino (@giovannisciortino)
|
author: Giovanni Sciortino (@giovannisciortino)
|
||||||
notes:
|
notes:
|
||||||
- In order to manage RHSM repositories the system must be already registered to RHSM manually or using the Ansible M(community.general.redhat_subscription)
|
- In order to manage RHSM repositories the system must be already registered to RHSM manually or using the Ansible M(community.general.redhat_subscription)
|
||||||
module.
|
module.
|
||||||
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully run this module.
|
- It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully
|
||||||
|
run this module.
|
||||||
requirements:
|
requirements:
|
||||||
- subscription-manager
|
- subscription-manager
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
@ -31,7 +33,8 @@ options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- If state is equal to present or disabled, indicates the desired repository state.
|
- If state is equal to present or disabled, indicates the desired repository state.
|
||||||
- In community.general 10.0.0 the states V(present) and V(absent) have been removed. Please use V(enabled) and V(disabled) instead.
|
- In community.general 10.0.0 the states V(present) and V(absent) have been removed. Please use V(enabled) and V(disabled)
|
||||||
|
instead.
|
||||||
choices: [enabled, disabled]
|
choices: [enabled, disabled]
|
||||||
default: "enabled"
|
default: "enabled"
|
||||||
type: str
|
type: str
|
||||||
|
@ -44,8 +47,8 @@ options:
|
||||||
elements: str
|
elements: str
|
||||||
purge:
|
purge:
|
||||||
description:
|
description:
|
||||||
- Disable all currently enabled repositories that are not not specified in O(name). Only set this to V(true) if passing in a list of repositories
|
- Disable all currently enabled repositories that are not not specified in O(name). Only set this to V(true) if passing
|
||||||
to the O(name) field. Using this with C(loop) will most likely not have the desired result.
|
in a list of repositories to the O(name) field. Using this with C(loop) will most likely not have the desired result.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -62,7 +62,8 @@ options:
|
||||||
type: str
|
type: str
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
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 will not be validated. This should only be used on personally controlled sites using
|
||||||
|
self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -34,7 +34,8 @@ options:
|
||||||
token:
|
token:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Rocket Chat Incoming Webhook integration token. This provides authentication to Rocket Chat's Incoming webhook for posting messages.
|
- Rocket Chat Incoming Webhook integration token. This provides authentication to Rocket Chat's Incoming webhook for
|
||||||
|
posting messages.
|
||||||
required: true
|
required: true
|
||||||
protocol:
|
protocol:
|
||||||
type: str
|
type: str
|
||||||
|
@ -51,8 +52,8 @@ options:
|
||||||
channel:
|
channel:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Channel to send the message to. If absent, the message goes to the channel selected for the O(token) specified during the creation of
|
- Channel to send the message to. If absent, the message goes to the channel selected for the O(token) specified during
|
||||||
webhook.
|
the creation of webhook.
|
||||||
username:
|
username:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
@ -79,13 +80,15 @@ options:
|
||||||
- 0
|
- 0
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
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 will not be validated. This should only be used on personally controlled sites using
|
||||||
|
self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
color:
|
color:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Allow text to use default colors - use the default of V(normal) to not send a custom color bar at the start of the message.
|
- Allow text to use default colors - use the default of V(normal) to not send a custom color bar at the start of the
|
||||||
|
message.
|
||||||
default: 'normal'
|
default: 'normal'
|
||||||
choices:
|
choices:
|
||||||
- 'normal'
|
- 'normal'
|
||||||
|
@ -118,7 +121,8 @@ EXAMPLES = r"""
|
||||||
link_names: 0
|
link_names: 0
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
|
|
||||||
- name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in rocketchat
|
- name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured
|
||||||
|
in rocketchat
|
||||||
community.general.rocketchat:
|
community.general.rocketchat:
|
||||||
token: thetoken/generatedby/rocketchat
|
token: thetoken/generatedby/rocketchat
|
||||||
domain: chat.example.com
|
domain: chat.example.com
|
||||||
|
|
|
@ -61,8 +61,8 @@ options:
|
||||||
default: 'https://api.rollbar.com/api/1/deploy/'
|
default: 'https://api.rollbar.com/api/1/deploy/'
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If V(false), SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using
|
- If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled
|
||||||
self-signed certificates.
|
sites using self-signed certificates.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
|
|
|
@ -30,9 +30,9 @@ options:
|
||||||
required: true
|
required: true
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always bounce the service
|
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. V(restarted) will always
|
||||||
(sv restart) and V(killed) will always bounce the service (sv force-stop). V(reloaded) will send a HUP (sv reload). V(once) will run a
|
bounce the service (sv restart) and V(killed) will always bounce the service (sv force-stop). V(reloaded) will send
|
||||||
normally downed sv once (sv once), not really an idempotent operation.
|
a HUP (sv reload). V(once) will run a normally downed sv once (sv once), not really an idempotent operation.
|
||||||
type: str
|
type: str
|
||||||
choices: [killed, once, reloaded, restarted, started, stopped]
|
choices: [killed, once, reloaded, restarted, started, stopped]
|
||||||
enabled:
|
enabled:
|
||||||
|
|
Loading…
Reference in New Issue