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

[PR #5965/0ef80569 backport][stable-6] Add attributes to more modules (1/4) (#6022)

Add attributes to more modules (1/4) (#5965)

* Add attributes to more modules.

* Apply suggestions from code review.

Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com>

---------

Co-authored-by: Kristian Heljas <11139388+kristianheljas@users.noreply.github.com>
(cherry picked from commit 0ef805699d)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2023-02-20 17:47:01 +01:00 committed by GitHub
parent 611e024550
commit ef09ea519c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
35 changed files with 296 additions and 58 deletions

View file

@ -29,8 +29,7 @@ options:
required: true
requirements:
- hpe3par_sdk >= 1.0.2. Install using 'pip install hpe3par_sdk'
- hpe3par_sdk >= 1.0.2. Install using C(pip install hpe3par_sdk).
- WSAPI service should be enabled on the 3PAR storage array.
notes:
- check_mode not supported
'''

View file

@ -31,6 +31,11 @@ short_description: Create, Start, Stop, Restart or Terminate an Instance in ECS;
description:
- Create, start, stop, restart, modify or terminate ecs instances.
- Add or remove ecs instances to/from security group.
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
state:
description:
@ -252,6 +257,7 @@ requirements:
- "footmark >= 1.19.0"
extends_documentation_fragment:
- community.general.alicloud
- community.general.attributes
'''
EXAMPLES = '''

View file

@ -31,6 +31,12 @@ description:
C(new_release), either the 'release' parameter or a generated timestamp,
C(new_release_path), the path to the new release folder (not created by the module)."
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
path:
type: path
@ -111,7 +117,9 @@ notes:
- Because of the default behaviour of generating the I(new_release) fact, this module will not be idempotent
unless you pass your own release name with I(release). Due to the nature of deploying software, this should not
be much of a problem.
extends_documentation_fragment: files
extends_documentation_fragment:
- ansible.builtin.files
- community.general.attributes
'''
EXAMPLES = '''

View file

@ -21,6 +21,13 @@ author:
- Marcel Arns (@marns93)
requirements:
- heroku3
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
api_key:
type: str

View file

@ -14,7 +14,14 @@ module: honeybadger_deployment
author: "Benjamin Curtis (@stympy)"
short_description: Notify Honeybadger.io about app deployments
description:
- Notify Honeybadger.io about app deployments (see http://docs.honeybadger.io/article/188-deployment-tracking)
- Notify Honeybadger.io about app deployments (see U(http://docs.honeybadger.io/article/188-deployment-tracking)).
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
token:
type: str

View file

@ -15,7 +15,14 @@ module: hponcfg
author: Dag Wieers (@dagwieers)
short_description: Configure HP iLO interface using hponcfg
description:
- This modules configures the HP iLO interface using hponcfg.
- This modules configures the HP iLO interface using hponcfg.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
path:
description:

View file

@ -13,15 +13,22 @@ DOCUMENTATION = r'''
module: imc_rest
short_description: Manage Cisco IMC hardware through its REST API
description:
- Provides direct access to the Cisco IMC REST API.
- Perform any configuration changes and actions that the Cisco IMC supports.
- More information about the IMC REST API is available from
U(http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html)
- Provides direct access to the Cisco IMC REST API.
- Perform any configuration changes and actions that the Cisco IMC supports.
- More information about the IMC REST API is available from
U(http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html).
author:
- Dag Wieers (@dagwieers)
- Dag Wieers (@dagwieers)
requirements:
- lxml
- xmljson >= 0.1.8
- lxml
- xmljson >= 0.1.8
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
hostname:
description:

View file

@ -16,6 +16,13 @@ short_description: Manage SmartOS images
description:
- Manage SmartOS virtual machine images through imgadm(1M)
author: Jasper Lievisse Adriaanse (@jasperla)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
force:
required: false

View file

@ -15,6 +15,13 @@ description:
- Manage Infinity IPAM using REST API.
author:
- Meirong Liu (@MeganLiu)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
server_ip:
description:

View file

@ -15,6 +15,13 @@ short_description: Manage network namespaces
requirements: [ ip ]
description:
- Create or delete network namespaces using the ip command.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
required: false

View file

@ -25,6 +25,15 @@ requirements:
notes:
- To make the DNS record changes effective, you need to run C(update dnsserver) on the ipwcli.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
dnsname:
description:

View file

@ -13,7 +13,14 @@ DOCUMENTATION = '''
module: linode
short_description: Manage instances on the Linode Public Cloud
description:
- Manage Linode Public Cloud instances and optionally wait for it to be 'running'.
- Manage Linode Public Cloud instances and optionally wait for it to be 'running'.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
state:
description:

View file

@ -22,6 +22,13 @@ notes:
- No Linode resizing is currently implemented. This module will, in time,
replace the current Linode module which uses deprecated API bindings on the
Linode side.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
region:
description:

View file

@ -16,6 +16,13 @@ short_description: Manage LXC Containers
description:
- Management of LXC containers.
author: "Kevin Carter (@cloudnull)"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
name:
description:

View file

@ -16,6 +16,13 @@ notes: []
short_description: Manage Netcup DNS records
description:
- "Manages DNS records via the Netcup API, see the docs U(https://ccp.netcup.net/run/webservice/servers/endpoint.php)."
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
api_key:
description:

View file

@ -14,16 +14,23 @@ DOCUMENTATION = '''
module: ohai
short_description: Returns inventory data from I(Ohai)
description:
- Similar to the M(community.general.facter) module, this runs the I(Ohai) discovery program
(U(https://docs.chef.io/ohai.html)) on the remote host and
returns JSON inventory data.
I(Ohai) data is a bit more verbose and nested than I(facter).
- Similar to the M(community.general.facter) module, this runs the I(Ohai) discovery program
(U(https://docs.chef.io/ohai.html)) on the remote host and
returns JSON inventory data.
I(Ohai) data is a bit more verbose and nested than I(facter).
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options: {}
notes: []
requirements: [ "ohai" ]
author:
- "Ansible Core Team"
- "Michael DeHaan (@mpdehaan)"
- "Ansible Core Team"
- "Michael DeHaan (@mpdehaan)"
'''
EXAMPLES = '''

View file

@ -18,7 +18,14 @@ description: Manage OMAPI hosts into compatible DHCPd servers
requirements:
- pypureomapi
author:
- Loic Blot (@nerzhul)
- Loic Blot (@nerzhul)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
state:
description:

View file

@ -12,13 +12,20 @@ DOCUMENTATION = r'''
---
module: open_iscsi
author:
- Serge van Ginderachter (@srvg)
- Serge van Ginderachter (@srvg)
short_description: Manage iSCSI targets with Open-iSCSI
description:
- Discover targets on given portal, (dis)connect targets, mark targets to
manually or auto start, return device nodes of connected targets.
requirements:
- open_iscsi library and tools (iscsiadm)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
portal:
description:

View file

@ -13,10 +13,17 @@ DOCUMENTATION = '''
module: opendj_backendprop
short_description: Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command
description:
- This module will update settings for OpenDJ with the command set-backend-prop.
- It will check first via de get-backend-prop if configuration needs to be applied.
- This module will update settings for OpenDJ with the command set-backend-prop.
- It will check first via de get-backend-prop if configuration needs to be applied.
author:
- Werner Dijkerman (@dj-wasabi)
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
opendj_bindir:
description:

View file

@ -15,6 +15,13 @@ author:
short_description: Manage services on OpenWrt
description:
- Controls OpenWrt services on remote hosts.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
type: str

View file

@ -13,10 +13,17 @@ DOCUMENTATION = '''
module: pacemaker_cluster
short_description: Manage pacemaker clusters
author:
- Mathieu Bultel (@matbu)
- Mathieu Bultel (@matbu)
description:
- This module can manage a pacemaker cluster and nodes from Ansible using
the pacemaker cli.
- This module can manage a pacemaker cluster and nodes from Ansible using
the pacemaker cli.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
state:
description:

View file

@ -20,6 +20,13 @@ description:
requirements:
- ipmctl and ndctl command line tools
- xmltodict
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
appdirect:
description:

View file

@ -20,21 +20,28 @@ module: pubnub_blocks
short_description: PubNub blocks management module
description:
- "This module allows Ansible to interface with the PubNub BLOCKS
infrastructure by providing the following operations: create / remove,
start / stop and rename for blocks and create / modify / remove for event
handlers"
infrastructure by providing the following operations: create / remove,
start / stop and rename for blocks and create / modify / remove for event
handlers."
author:
- PubNub <support@pubnub.com> (@pubnub)
- Sergey Mamontov <sergey@pubnub.com> (@parfeon)
requirements:
- "python >= 2.7"
- "pubnub_blocks_client >= 1.0"
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
email:
description:
- Email from account for which new session should be started.
- "Not required if C(cache) contains result of previous module call (in
same play)."
same play)."
required: false
type: str
default: ''
@ -42,7 +49,7 @@ options:
description:
- Password which match to account to which specified C(email) belong.
- "Not required if C(cache) contains result of previous module call (in
same play)."
same play)."
required: false
type: str
default: ''
@ -57,14 +64,14 @@ options:
account:
description:
- "Name of PubNub account for from which C(application) will be used to
manage blocks."
manage blocks."
- "User's account will be used if value not set or empty."
type: str
default: ''
application:
description:
- "Name of target PubNub application for which blocks configuration on
specific C(keyset) will be done."
specific C(keyset) will be done."
type: str
required: true
keyset:
@ -75,7 +82,7 @@ options:
state:
description:
- "Intended block state after event handlers creation / update process
will be completed."
will be completed."
required: false
default: 'present'
choices: ['started', 'stopped', 'present', 'absent']
@ -95,23 +102,23 @@ options:
event_handlers:
description:
- "List of event handlers which should be updated for specified block
C(name)."
C(name)."
- "Each entry for new event handler should contain: C(name), C(src),
C(channels), C(event). C(name) used as event handler name which can be
used later to make changes to it."
C(channels), C(event). C(name) used as event handler name which can be
used later to make changes to it."
- C(src) is full path to file with event handler code.
- "C(channels) is name of channel from which event handler is waiting
for events."
for events."
- "C(event) is type of event which is able to trigger event handler:
I(js-before-publish), I(js-after-publish), I(js-after-presence)."
I(js-before-publish), I(js-after-publish), I(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
C(event)) can be added if changes required for them."
handler can be identified). Rest parameters (C(src), 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 key
C(name), where new name should be passed."
event handler payload and pass dictionary, which 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."
it to C(absent) and it will be removed."
required: false
default: []
type: list
@ -119,7 +126,7 @@ options:
changes:
description:
- "List of fields which should be changed by block itself (doesn't
affect any event handlers)."
affect any event handlers)."
- "Possible options for change is: C(name)."
required: false
default: {}
@ -127,8 +134,8 @@ options:
validate_certs:
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
will cause problems to call PubNub REST API."
calls. Sometimes host may have issues with certificates on it and this
will cause problems to call PubNub REST API."
- If check should be ignored C(False) should be passed to this parameter.
required: false
default: true
@ -224,9 +231,10 @@ EXAMPLES = '''
RETURN = '''
module_cache:
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
up process."
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
up process.
type: dict
returned: always
'''

View file

@ -18,6 +18,11 @@ short_description: Add or remove Pulp repos from a remote host
description:
- Add or remove Pulp repos from a remote host.
- Note, this is for Pulp 2 only.
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
add_export_distributor:
description:
@ -165,7 +170,8 @@ notes:
- This module can currently only create distributors and importers on rpm
repositories. Contributions to support other repo types are welcome.
extends_documentation_fragment:
- url
- ansible.builtin.url
- community.general.attributes
'''
EXAMPLES = '''

View file

@ -14,6 +14,13 @@ module: puppet
short_description: Runs puppet
description:
- Runs I(puppet) agent or apply in a reliable manner.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
timeout:
description:

View file

@ -16,7 +16,14 @@ requirements: [ pushbullet.py ]
module: pushbullet
short_description: Sends notifications to Pushbullet
description:
- This module sends push notifications via Pushbullet to channels or devices.
- This module sends push notifications via Pushbullet to channels or devices.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
api_key:
type: str

View file

@ -14,11 +14,18 @@ DOCUMENTATION = '''
module: pushover
short_description: Send notifications via U(https://pushover.net)
description:
- Send notifications via pushover, to subscriber list of devices, and email
addresses. Requires pushover app on devices.
- Send notifications via pushover, to subscriber list of devices, and email
addresses. Requires pushover app on devices.
notes:
- You will require a pushover.net account to use this module. But no account
is required to receive messages.
- You will require a pushover.net account to use this module. But no account
is required to receive messages.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
msg:
type: str

View file

@ -13,7 +13,14 @@ DOCUMENTATION = r'''
module: serverless
short_description: Manages a Serverless Framework project
description:
- Provides support for managing Serverless Framework (https://serverless.com/) project deployments and stacks.
- Provides support for managing Serverless Framework (U(https://serverless.com/)) project deployments and stacks.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
state:
description:

View file

@ -15,6 +15,13 @@ short_description: Create or cancel a virtual instance in SoftLayer
description:
- Creates or cancels SoftLayer instances.
- When created, optionally waits for it to be 'running'.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
instance_id:
description:

View file

@ -18,6 +18,11 @@ author:
description:
- Create and delete CPG on HPE 3PAR.
module: ss_3par_cpg
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
cpg_name:
description:
@ -88,6 +93,7 @@ options:
default: false
extends_documentation_fragment:
- community.general.hpe3par
- community.general.attributes
'''

View file

@ -24,6 +24,15 @@ description:
provides inline block-level deduplication, compression, and
thin provisioning capabilities to primary storage.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
options:
name:
description:

View file

@ -20,6 +20,11 @@ description:
through specific array ports.
author:
- Sandeep Kasargod (@vexata)
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
description:
@ -46,6 +51,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.vexata.vx100
- community.general.attributes
'''

View file

@ -17,6 +17,11 @@ description:
- Create, deletes or extend volumes on a Vexata VX100 array.
author:
- Sandeep Kasargod (@vexata)
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
name:
description:
@ -35,6 +40,7 @@ options:
type: str
extends_documentation_fragment:
- community.general.vexata.vx100
- community.general.attributes
'''

View file

@ -14,7 +14,14 @@ DOCUMENTATION = r'''
module: wakeonlan
short_description: Send a magic Wake-on-LAN (WoL) broadcast packet
description:
- The C(wakeonlan) module sends magic Wake-on-LAN (WoL) broadcast packets.
- The C(wakeonlan) module sends magic Wake-on-LAN (WoL) broadcast packets.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
mac:
description:

View file

@ -14,6 +14,13 @@ module: znode
short_description: Create, delete, retrieve, and update znodes using ZooKeeper
description:
- Create, delete, retrieve, and update znodes using ZooKeeper.
attributes:
check_mode:
support: none
diff_mode:
support: none
extends_documentation_fragment:
- community.general.attributes
options:
hosts:
description: