mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
[PR #5967/d03ae532 backport][stable-6] Add attributes to more modules (3/4) (#6025)
Add attributes to more modules (3/4) (#5967)
Add attributes to more modules.
(cherry picked from commit d03ae532ed
)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
e92908b66e
commit
91095240f4
23 changed files with 172 additions and 20 deletions
|
@ -19,6 +19,13 @@ version_added: '0.2.0'
|
||||||
author:
|
author:
|
||||||
- Michael Heap (@mheap)
|
- Michael Heap (@mheap)
|
||||||
- Lukas Bestle (@lukasbestle)
|
- Lukas Bestle (@lukasbestle)
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
id:
|
id:
|
||||||
description:
|
description:
|
||||||
|
@ -46,8 +53,6 @@ requirements:
|
||||||
- macOS 10.11+
|
- macOS 10.11+
|
||||||
- "mas-cli (U(https://github.com/mas-cli/mas)) 1.5.0+ available as C(mas) in the bin path"
|
- "mas-cli (U(https://github.com/mas-cli/mas)) 1.5.0+ available as C(mas) in the bin path"
|
||||||
- The Apple ID to use already needs to be signed in to the Mac App Store (check with C(mas account)).
|
- The Apple ID to use already needs to be signed in to the Mac App Store (check with C(mas account)).
|
||||||
notes:
|
|
||||||
- This module supports C(check_mode).
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -23,6 +23,11 @@ author: "Chris Schmidt (@chrisisbeef)"
|
||||||
requirements:
|
requirements:
|
||||||
- lxml
|
- lxml
|
||||||
- boto if using a S3 repository (s3://...)
|
- boto if using a S3 repository (s3://...)
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
group_id:
|
group_id:
|
||||||
type: str
|
type: str
|
||||||
|
@ -166,7 +171,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- Filesystem permission mode applied recursively to I(dest) when it is a directory.
|
- Filesystem permission mode applied recursively to I(dest) when it is a directory.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- files
|
- ansible.builtin.files
|
||||||
|
- community.general.attributes
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -15,6 +15,13 @@ module: monit
|
||||||
short_description: Manage the state of a program monitored via Monit
|
short_description: Manage the state of a program monitored via Monit
|
||||||
description:
|
description:
|
||||||
- Manage the state of a program monitored via I(Monit).
|
- Manage the state of a program monitored via I(Monit).
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -15,6 +15,13 @@ module: mqtt
|
||||||
short_description: Publish a message on an MQTT topic for the IoT
|
short_description: Publish a message on an MQTT topic for the IoT
|
||||||
description:
|
description:
|
||||||
- Publish a message on an MQTT topic.
|
- Publish a message on an MQTT topic.
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
server:
|
server:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -28,6 +28,13 @@ description:
|
||||||
e.g., I(service=host). This keyword may not be given with other services at the same time.
|
e.g., I(service=host). This keyword may not be given with other services at the same time.
|
||||||
I(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running on it.)
|
I(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running on it.)
|
||||||
To schedule downtime for all services on particular host use keyword "all", e.g., I(service=all).
|
To schedule downtime for all services on particular host use keyword "all", e.g., I(service=all).
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
action:
|
action:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -16,6 +16,13 @@ author: "Matt Coddington (@mcodd)"
|
||||||
short_description: Notify New Relic about app deployments
|
short_description: Notify New Relic about app deployments
|
||||||
description:
|
description:
|
||||||
- Notify New Relic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/record-monitor-deployments/)
|
- Notify New Relic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/record-monitor-deployments/)
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
token:
|
token:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -15,6 +15,11 @@ short_description: Send a SMS via nexmo
|
||||||
description:
|
description:
|
||||||
- Send a SMS message via nexmo
|
- Send a SMS message via nexmo
|
||||||
author: "Matt Martz (@sivel)"
|
author: "Matt Martz (@sivel)"
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
api_key:
|
api_key:
|
||||||
type: str
|
type: str
|
||||||
|
@ -50,7 +55,8 @@ options:
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- url
|
- ansible.builtin.url
|
||||||
|
- community.general.attributes
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = """
|
EXAMPLES = """
|
||||||
|
|
|
@ -15,7 +15,14 @@ short_description: Manage nic tags on SmartOS systems
|
||||||
description:
|
description:
|
||||||
- Create or delete nic tags on SmartOS systems.
|
- Create or delete nic tags on SmartOS systems.
|
||||||
author:
|
author:
|
||||||
- Bruce Smith (@SmithX10)
|
- Bruce Smith (@SmithX10)
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -22,6 +22,12 @@ requirements:
|
||||||
- python-nomad
|
- python-nomad
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.nomad
|
- community.general.nomad
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
|
@ -51,8 +57,6 @@ options:
|
||||||
choices: ["hcl", "json"]
|
choices: ["hcl", "json"]
|
||||||
default: hcl
|
default: hcl
|
||||||
type: str
|
type: str
|
||||||
notes:
|
|
||||||
- C(check_mode) is supported.
|
|
||||||
seealso:
|
seealso:
|
||||||
- name: Nomad jobs documentation
|
- name: Nomad jobs documentation
|
||||||
description: Complete documentation for Nomad API jobs.
|
description: Complete documentation for Nomad API jobs.
|
||||||
|
|
|
@ -18,6 +18,13 @@ short_description: Manage services with nosh
|
||||||
description:
|
description:
|
||||||
- Control running and enabled state for system-wide or user services.
|
- Control running and enabled state for system-wide or user services.
|
||||||
- BSD and Linux systems are supported.
|
- BSD and Linux systems are supported.
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -24,6 +24,13 @@ description:
|
||||||
requirements:
|
requirements:
|
||||||
- dnspython
|
- dnspython
|
||||||
author: "Loic Blot (@nerzhul)"
|
author: "Loic Blot (@nerzhul)"
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -16,6 +16,11 @@ description:
|
||||||
- This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI.
|
- This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI.
|
||||||
The complete Oracle Cloud Infrastructure Ansible Modules can be downloaded from
|
The complete Oracle Cloud Infrastructure Ansible Modules can be downloaded from
|
||||||
U(https://github.com/oracle/oci-ansible-modules/releases).
|
U(https://github.com/oracle/oci-ansible-modules/releases).
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
cidr_block:
|
cidr_block:
|
||||||
description: The CIDR IP address block of the VCN. Required when creating a VCN with I(state=present).
|
description: The CIDR IP address block of the VCN. Required when creating a VCN with I(state=present).
|
||||||
|
@ -48,10 +53,11 @@ options:
|
||||||
aliases: [ 'id' ]
|
aliases: [ 'id' ]
|
||||||
author: "Rohit Chaware (@rohitChaware)"
|
author: "Rohit Chaware (@rohitChaware)"
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.oracle
|
- community.general.oracle
|
||||||
- community.general.oracle_creatable_resource
|
- community.general.oracle_creatable_resource
|
||||||
- community.general.oracle_wait_options
|
- community.general.oracle_wait_options
|
||||||
- community.general.oracle_tags
|
- community.general.oracle_tags
|
||||||
|
- community.general.attributes
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -18,6 +18,13 @@ author: "Marc Sensenich (@marc-sensenich)"
|
||||||
notes:
|
notes:
|
||||||
- This module is not idempotent, therefore if the same task is run twice
|
- This module is not idempotent, therefore if the same task is run twice
|
||||||
there will be two Connector Cards created
|
there will be two Connector Cards created
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
webhook:
|
webhook:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -15,6 +15,13 @@ author:
|
||||||
- Saranya Sridharan (@saranyasridharan)
|
- Saranya Sridharan (@saranyasridharan)
|
||||||
requirements:
|
requirements:
|
||||||
- psutil(python module)
|
- psutil(python module)
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description: The name of the process(es) you want to get PID(s) for.
|
description: The name of the process(es) you want to get PID(s) for.
|
||||||
|
|
|
@ -19,6 +19,13 @@ author:
|
||||||
- "Justin Johns (!UNKNOWN)"
|
- "Justin Johns (!UNKNOWN)"
|
||||||
requirements:
|
requirements:
|
||||||
- "This pingdom python library: https://github.com/mbabineau/pingdom-python"
|
- "This pingdom python library: https://github.com/mbabineau/pingdom-python"
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -25,6 +25,13 @@ notes:
|
||||||
config file and default to None.
|
config file and default to None.
|
||||||
requirements:
|
requirements:
|
||||||
- subscription-manager
|
- subscription-manager
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -19,7 +19,14 @@ description:
|
||||||
requirements:
|
requirements:
|
||||||
- ovirtsdk
|
- ovirtsdk
|
||||||
author:
|
author:
|
||||||
- Timothy Vandenbrande (@TimothyVandenbrande)
|
- Timothy Vandenbrande (@TimothyVandenbrande)
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
user:
|
user:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -15,10 +15,16 @@ short_description: Adds or removes Red Hat software channels
|
||||||
description:
|
description:
|
||||||
- Adds or removes Red Hat software channels.
|
- Adds or removes Red Hat software channels.
|
||||||
author:
|
author:
|
||||||
- Vincent Van der Kussen (@vincentvdk)
|
- Vincent Van der Kussen (@vincentvdk)
|
||||||
notes:
|
notes:
|
||||||
- This module fetches the system id from RHN.
|
- This module fetches the system id from RHN.
|
||||||
- This module doesn't support I(check_mode).
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -15,13 +15,20 @@ short_description: Manage Red Hat Network registration using the C(rhnreg_ks) co
|
||||||
description:
|
description:
|
||||||
- Manage registration to the Red Hat Network.
|
- Manage registration to the Red Hat Network.
|
||||||
author:
|
author:
|
||||||
- James Laska (@jlaska)
|
- James Laska (@jlaska)
|
||||||
notes:
|
notes:
|
||||||
- This is for older Red Hat products. You probably want the M(community.general.redhat_subscription) module instead.
|
- This is for older Red Hat products. You probably want the M(community.general.redhat_subscription) module instead.
|
||||||
- In order to register a system, C(rhnreg_ks) requires either a username and password, or an activationkey.
|
- In order to register a system, C(rhnreg_ks) requires either a username and password, or an activationkey.
|
||||||
requirements:
|
requirements:
|
||||||
- rhnreg_ks
|
- rhnreg_ks
|
||||||
- either libxml2 or lxml
|
- either libxml2 or lxml
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: none
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -20,6 +20,13 @@ notes:
|
||||||
prior to setting the RHSM release.
|
prior to setting the RHSM release.
|
||||||
requirements:
|
requirements:
|
||||||
- Red Hat Enterprise Linux 6+ with subscription-manager installed
|
- Red Hat Enterprise Linux 6+ with subscription-manager installed
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
release:
|
release:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -22,6 +22,13 @@ notes:
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- subscription-manager
|
- subscription-manager
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: full
|
||||||
options:
|
options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -17,6 +17,13 @@ short_description: Notify Rollbar about app deployments
|
||||||
description:
|
description:
|
||||||
- Notify Rollbar about app deployments
|
- Notify Rollbar about app deployments
|
||||||
(see https://rollbar.com/docs/deploys_other/)
|
(see https://rollbar.com/docs/deploys_other/)
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
token:
|
token:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -12,10 +12,17 @@ DOCUMENTATION = r'''
|
||||||
---
|
---
|
||||||
module: runit
|
module: runit
|
||||||
author:
|
author:
|
||||||
- James Sumners (@jsumners)
|
- James Sumners (@jsumners)
|
||||||
short_description: Manage runit services
|
short_description: Manage runit services
|
||||||
description:
|
description:
|
||||||
- Controls runit services on remote hosts using the sv utility.
|
- Controls runit services on remote hosts using the sv utility.
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.general.attributes
|
||||||
|
attributes:
|
||||||
|
check_mode:
|
||||||
|
support: full
|
||||||
|
diff_mode:
|
||||||
|
support: none
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
|
|
Loading…
Reference in a new issue