Commit graph

12 commits

Author SHA1 Message Date
Felix Fontein
56ce47aef5
Update docs (#248)
* Add reference to module defaults groups docs.

* Fix bad quote.
2024-01-06 09:38:12 +01:00
Felix Fontein
9c75b9c5cd Fix module default group example. 2024-01-06 08:47:41 +01:00
Felix Fontein
a823d66b33
Fix typos, improve markup (#231)
* Fix typos.

* Improve markup.
2023-10-29 08:28:00 +01:00
Felix Fontein
2e78a207e9
Use semantic markup (#185)
* Enable semantic markup.

* Use semantic markup.

* Break long lines.

* Add ignore entries.

* Ignore docs build error.
2023-06-22 13:18:08 +02:00
PhiBo
9567bbf292
Add new api option force_no_cert (#124)
* Add new option force_no_cert

Connect to a router without a certificate by using ADH ciphers.
This can be useful when setting up a device.

* Changelog

* Update plugins/doc_fragments/api.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update changelogs/fragments/124-api.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
2022-11-12 09:47:52 +01:00
Felix Fontein
835cec5e24
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>
2022-11-06 20:58:06 +01:00
Felix Fontein
2911710f1b
Add api_info and api_modify modules (#91)
* Add api_info and api_modify modules.

* Add documentation, and cross-references for the modules.

* Bump version added for new modules.

* Ignore dynamic entries. Allow _info module to return them.

* Document behavior for dynamic entries.

* Update license headers.

* Add disclaimer.

* Improve formulation.

* Auto-generate path list in DOCUMENTATION.

* Add test to make sure lists have been generated automatically.
2022-07-31 22:06:19 +02:00
Felix Fontein
7973f58661
Move licenses to LICENSES/, use SPDX-License-Identifier, mention all licenses in galaxy.yml, add missing license file (#101)
* Add SPDX license identifiers, mention all licenses in galaxy.yml.

* Add default copyright headers.

* Adjust remaining/missing entries.

* Fix/add more copyright statements.

* Add sanity test.

* Add changelog.

* Add missing license file.

* Remove colon after 'Copyright'.

* Avoid colon after 'Copyright' in lint script.
2022-07-18 23:16:54 +02:00
Felix Fontein
6e104c962b
Extend documentation. (#96) 2022-05-24 22:51:27 +02:00
Felix Fontein
ea782c1cf2
Add module defaults group community.routeros.api. (#90) 2022-05-13 13:18:28 +02:00
Felix Fontein
75b4b966a6
Add options to control certificate validation for api module (#37)
* Add options to control certificate validation for api module.

* Linting.

* Extend documentation.

* Fix validate_cert_hostname=true.

* Add documentation on setting up certificates on a RouterOS device.
2021-06-28 20:33:37 +02:00
Felix Fontein
39dcf4ac5b
Add basic scenario guides (#36)
* Add extra docs.

* Mention more quirks.

* Work around RST quirks.
2021-06-23 21:18:00 +02:00