1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Add attributes to more modules (3/4) (#5967)

Add attributes to more modules.
This commit is contained in:
Felix Fontein 2023-02-20 17:30:26 +01:00 committed by GitHub
parent b4a500103a
commit d03ae532ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 172 additions and 20 deletions

View file

@ -19,6 +19,13 @@ version_added: '0.2.0'
author:
- Michael Heap (@mheap)
- Lukas Bestle (@lukasbestle)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
id:
description:
@ -46,8 +53,6 @@ requirements:
- macOS 10.11+
- "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)).
notes:
- This module supports C(check_mode).
'''
EXAMPLES = '''

View file

@ -23,6 +23,11 @@ author: "Chris Schmidt (@chrisisbeef)"
requirements:
- lxml
- boto if using a S3 repository (s3://...)
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
group_id:
type: str
@ -166,7 +171,8 @@ options:
description:
- Filesystem permission mode applied recursively to I(dest) when it is a directory.
extends_documentation_fragment:
- files
- ansible.builtin.files
- community.general.attributes
'''
EXAMPLES = '''

View file

@ -15,6 +15,13 @@ module: monit
short_description: Manage the state of a program monitored via Monit
description:
- 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:
name:
description:

View file

@ -14,7 +14,14 @@ DOCUMENTATION = '''
module: mqtt
short_description: Publish a message on an MQTT topic for the IoT
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:
server:
type: str

View file

@ -28,6 +28,13 @@ description:
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.)
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:
action:
description:

View file

@ -16,6 +16,13 @@ author: "Matt Coddington (@mcodd)"
short_description: Notify New Relic about app deployments
description:
- 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:
token:
type: str

View file

@ -15,6 +15,11 @@ short_description: Send a SMS via nexmo
description:
- Send a SMS message via nexmo
author: "Matt Martz (@sivel)"
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
api_key:
type: str
@ -50,7 +55,8 @@ options:
type: bool
default: true
extends_documentation_fragment:
- url
- ansible.builtin.url
- community.general.attributes
'''
EXAMPLES = """

View file

@ -15,7 +15,14 @@ short_description: Manage nic tags on SmartOS systems
description:
- Create or delete nic tags on SmartOS systems.
author:
- Bruce Smith (@SmithX10)
- Bruce Smith (@SmithX10)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
description:

View file

@ -15,13 +15,19 @@ author: FERREIRA Christophe (@chris93111)
version_added: "1.3.0"
short_description: Launch a Nomad Job
description:
- Launch a Nomad job.
- Stop a Nomad job.
- Force start a Nomad job
- Launch a Nomad job.
- Stop a Nomad job.
- Force start a Nomad job
requirements:
- python-nomad
extends_documentation_fragment:
- community.general.nomad
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
description:
@ -51,8 +57,6 @@ options:
choices: ["hcl", "json"]
default: hcl
type: str
notes:
- C(check_mode) is supported.
seealso:
- name: Nomad jobs documentation
description: Complete documentation for Nomad API jobs.

View file

@ -18,6 +18,13 @@ short_description: Manage services with nosh
description:
- Control running and enabled state for system-wide or user services.
- BSD and Linux systems are supported.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
type: str

View file

@ -24,6 +24,13 @@ description:
requirements:
- dnspython
author: "Loic Blot (@nerzhul)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
state:
description:

View file

@ -16,6 +16,11 @@ description:
- 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
U(https://github.com/oracle/oci-ansible-modules/releases).
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
cidr_block:
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' ]
author: "Rohit Chaware (@rohitChaware)"
extends_documentation_fragment:
- community.general.oracle
- community.general.oracle_creatable_resource
- community.general.oracle_wait_options
- community.general.oracle_tags
- community.general.oracle
- community.general.oracle_creatable_resource
- community.general.oracle_wait_options
- community.general.oracle_tags
- community.general.attributes
'''

View file

@ -18,6 +18,13 @@ author: "Marc Sensenich (@marc-sensenich)"
notes:
- This module is not idempotent, therefore if the same task is run twice
there will be two Connector Cards created
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
webhook:
type: str

View file

@ -15,6 +15,13 @@ author:
- Saranya Sridharan (@saranyasridharan)
requirements:
- psutil(python module)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
description: The name of the process(es) you want to get PID(s) for.

View file

@ -19,6 +19,13 @@ author:
- "Justin Johns (!UNKNOWN)"
requirements:
- "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:
state:
type: str

View file

@ -25,6 +25,13 @@ notes:
config file and default to None.
requirements:
- subscription-manager
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
state:
description:

View file

@ -19,7 +19,14 @@ description:
requirements:
- ovirtsdk
author:
- Timothy Vandenbrande (@TimothyVandenbrande)
- Timothy Vandenbrande (@TimothyVandenbrande)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
user:
description:

View file

@ -15,10 +15,16 @@ short_description: Adds or removes Red Hat software channels
description:
- Adds or removes Red Hat software channels.
author:
- Vincent Van der Kussen (@vincentvdk)
- Vincent Van der Kussen (@vincentvdk)
notes:
- 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:
name:
description:

View file

@ -15,13 +15,20 @@ short_description: Manage Red Hat Network registration using the C(rhnreg_ks) co
description:
- Manage registration to the Red Hat Network.
author:
- James Laska (@jlaska)
- James Laska (@jlaska)
notes:
- 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.
requirements:
- rhnreg_ks
- either libxml2 or lxml
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
state:
description:

View file

@ -20,6 +20,13 @@ notes:
prior to setting the RHSM release.
requirements:
- 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:
release:
description:

View file

@ -22,6 +22,13 @@ notes:
requirements:
- subscription-manager
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: full
options:
state:
description:

View file

@ -17,6 +17,13 @@ short_description: Notify Rollbar about app deployments
description:
- Notify Rollbar about app deployments
(see https://rollbar.com/docs/deploys_other/)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
token:
type: str

View file

@ -12,10 +12,17 @@ DOCUMENTATION = r'''
---
module: runit
author:
- James Sumners (@jsumners)
- James Sumners (@jsumners)
short_description: Manage runit services
description:
- 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:
name:
description: