Use attributes to document module capabilities; warn about command module's check_mode support (#118)

* Improve formatting.

* Add 'api' action group attribute.

* Document attributes.

* Known issue: command module declares to support check mode.

* Compatibility with older ansible-core releases.

* Fix typo.

* Improve docs.

* Add shortcuts for common combinations.

* Update changelogs/fragments/command-check_mode.yml

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>

Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
This commit is contained in:
Felix Fontein 2022-11-06 20:58:06 +01:00 committed by GitHub
parent 29b604464a
commit 835cec5e24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 179 additions and 13 deletions

View file

@ -17,7 +17,7 @@ No special setup is needed; the module needs to be run on a host that can connec
---
- name: RouterOS test with API
hosts: localhost
gather_facts: no
gather_facts: false
vars:
hostname: 192.168.1.1
username: admin
@ -71,7 +71,7 @@ To avoid having to specify common parameters for all the API based modules in ev
---
- name: RouterOS test with API
hosts: localhost
gather_facts: no
gather_facts: false
module_defaults:
group/community.routeros.api
hostname: 192.168.1.1