mirror.MikroTik/ansible-collections.community.routeros
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.routeros.git synced 2025-06-21 01:25:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Improve formulations.

Browse source
This commit is contained in:
Felix Fontein 2024-12-28 16:52:27 +01:00
parent 539119c57d
commit 1e0c582b98
3 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
plugins/cliconf/routeros.py
View file

@ -10,7 +10,7 @@ author: "Egor Zaitsev (@heuels)"
name: routeros name: routeros
short_description: Use routeros cliconf to run command on MikroTik RouterOS platform short_description: Use routeros cliconf to run command on MikroTik RouterOS platform
description: description:
- This routeros plugin provides low level abstraction apis for sending and receiving CLI commands from MikroTik RouterOS - This routeros plugin provides low level abstraction APIs for sending and receiving CLI commands from MikroTik RouterOS
network devices. network devices.
""" """

2
plugins/doc_fragments/api.py
View file

@ -43,7 +43,7 @@ options:
- ssl - ssl
port: port:
description: description:
- RouterOS api port. If O(tls) is set, port will apply to TLS/SSL connection. - RouterOS API port. If O(tls) is set, port will apply to TLS/SSL connection.
- Defaults are V(8728) for the HTTP API, and V(8729) for the HTTPS API. - Defaults are V(8728) for the HTTP API, and V(8729) for the HTTPS API.
type: int type: int
force_no_cert: force_no_cert:

8
plugins/modules/api.py
View file

@ -14,7 +14,7 @@ author: "Nikolay Dachev (@NikolayDachev)"
short_description: Ansible module for RouterOS API short_description: Ansible module for RouterOS API
description: description:
- Ansible module for RouterOS API with the Python C(librouteros) library. - Ansible module for RouterOS API with the Python C(librouteros) library.
- This module can add, remove, update, query and execute arbitrary command in RouterOS via API. - This module can add, remove, update, query, and execute arbitrary command in RouterOS through the API.
notes: notes:
- O(add), O(remove), O(update), O(cmd), and O(query) are mutually exclusive. - O(add), O(remove), O(update), O(cmd), and O(query) are mutually exclusive.
- Use the M(community.routeros.api_modify) and M(community.routeros.api_find_and_modify) modules for more specific modifications, - Use the M(community.routeros.api_modify) and M(community.routeros.api_find_and_modify) modules for more specific modifications,
@ -37,7 +37,7 @@ options:
path: path:
description: description:
- Main path for all other arguments. - Main path for all other arguments.
- If other arguments are not set, api will return all items in selected path. - If other arguments are not set, the module will return all items in selected path.
- Example V(ip address). Equivalent of RouterOS CLI C(/ip address print). - Example V(ip address). Equivalent of RouterOS CLI C(/ip address print).
required: true required: true
type: str type: str
@ -57,7 +57,7 @@ options:
update: update:
description: description:
- Update config/value in RouterOS by '.id' in selected path. - Update config/value in RouterOS by '.id' in selected path.
- Example V(.id=*03 address=1.1.1.3/32) and path V(ip address) will replace existing ip address with C(.id=*03). - Example V(.id=*03 address=1.1.1.3/32) and path V(ip address) will replace the existing IP address with C(.id=*03).
- Equivalent in RouterOS CLI C(/ip address set address=1.1.1.3/32 numbers=1). - Equivalent in RouterOS CLI C(/ip address set address=1.1.1.3/32 numbers=1).
- Note C(number) in RouterOS CLI is different from C(.id). - Note C(number) in RouterOS CLI is different from C(.id).
type: str type: str
@ -261,7 +261,7 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
message: message:
description: All outputs are in list with dictionary elements returned from RouterOS api. description: All outputs are in list with dictionary elements returned from RouterOS API.
sample: sample:
- address: 1.2.3.4 - address: 1.2.3.4
- address: 2.3.4.5 - address: 2.3.4.5