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.
This commit is contained in:
Felix Fontein 2022-07-31 22:06:19 +02:00 committed by GitHub
parent 1abaa8e7ca
commit 2911710f1b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 3277 additions and 6 deletions

View file

@ -17,6 +17,8 @@ short_description: Find and modify information using the API
version_added: 2.1.0
description:
- Allows to find entries for a path by conditions and modify the values of these entries.
- Use the M(community.routeros.api_find_and_modify) module to set all entries of a path to specific values,
or change multiple entries in different ways in one step.
notes:
- "If you want to change values based on their old values (like change all comments 'foo' to 'bar') and make sure that
there are at least N such values, you can use I(require_matches_min=N) together with I(allow_no_matches=true).
@ -65,6 +67,9 @@ options:
type: bool
seealso:
- module: community.routeros.api
- module: community.routeros.api_facts
- module: community.routeros.api_modify
- module: community.routeros.api_info
'''
EXAMPLES = '''