From b24d755f5a45e9a6305c9705411d1a64a12b812e Mon Sep 17 00:00:00 2001 From: Nathaniel Case Date: Mon, 22 Feb 2021 15:29:16 -0500 Subject: Subsequent calls to get_capabilities are duplicating entries in `rpc`. (#122) Subsequent calls to get_capabilities are duplicating entries in `rpc`. Reviewed-by: https://github.com/apps/ansible-zuul --- README.md | 8 ++++---- changelogs/fragments/.keep | 0 changelogs/fragments/122-rpc-unbloat.yaml | 3 +++ docs/vyos.vyos.vyos_banner_module.rst | 2 +- docs/vyos.vyos.vyos_command_module.rst | 2 +- docs/vyos.vyos.vyos_config_module.rst | 2 +- docs/vyos.vyos.vyos_facts_module.rst | 2 +- docs/vyos.vyos.vyos_firewall_global_module.rst | 2 +- docs/vyos.vyos.vyos_firewall_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_firewall_rules_module.rst | 2 +- docs/vyos.vyos.vyos_interface_module.rst | 2 +- docs/vyos.vyos.vyos_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_l3_interface_module.rst | 2 +- docs/vyos.vyos.vyos_l3_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_lag_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_linkagg_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_global_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_interface_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_lldp_module.rst | 2 +- docs/vyos.vyos.vyos_logging_module.rst | 2 +- docs/vyos.vyos.vyos_ospf_interfaces_module.rst | 2 +- docs/vyos.vyos.vyos_ospfv2_module.rst | 2 +- docs/vyos.vyos.vyos_ospfv3_module.rst | 2 +- docs/vyos.vyos.vyos_ping_module.rst | 4 ++-- docs/vyos.vyos.vyos_static_route_module.rst | 2 +- docs/vyos.vyos.vyos_static_routes_module.rst | 2 +- docs/vyos.vyos.vyos_system_module.rst | 2 +- docs/vyos.vyos.vyos_user_module.rst | 2 +- docs/vyos.vyos.vyos_vlan_module.rst | 2 +- plugins/cliconf/vyos.py | 13 +++++++------ 31 files changed, 42 insertions(+), 38 deletions(-) create mode 100644 changelogs/fragments/.keep create mode 100644 changelogs/fragments/122-rpc-unbloat.yaml diff --git a/README.md b/README.md index 2a63d7d1..2bd45657 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,10 @@ Name | Description Name | Description --- | --- +### Inventory plugins +Name | Description +--- | --- + ### Modules Name | Description --- | --- @@ -64,10 +68,6 @@ Name | Description [vyos.vyos.vyos_user](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_user_module.rst)|Manage the collection of local users on VyOS device [vyos.vyos.vyos_vlan](https://github.com/ansible-collections/vyos.vyos/blob/main/docs/vyos.vyos.vyos_vlan_module.rst)|Manage VLANs on VyOS network devices -### Inventory plugins -Name | Description ---- | --- - Click the ``Content`` button to see the list of content included in this collection. diff --git a/changelogs/fragments/.keep b/changelogs/fragments/.keep new file mode 100644 index 00000000..e69de29b diff --git a/changelogs/fragments/122-rpc-unbloat.yaml b/changelogs/fragments/122-rpc-unbloat.yaml new file mode 100644 index 00000000..0bee3e8e --- /dev/null +++ b/changelogs/fragments/122-rpc-unbloat.yaml @@ -0,0 +1,3 @@ +--- +bugfixes: + - cliconf plugin - Prevent `get_capabilities()` from getting larger every time it is called diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index 8e14ce3c..d046cc4d 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -220,7 +220,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure the pre-login banner vyos.vyos.vyos_banner: diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index 41041bc1..36ae7643 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -255,7 +255,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: show configuration on ethernet devices eth0 and eth1 vyos.vyos.vyos_command: diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index 0914d8ec..d6f2f6bb 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -333,7 +333,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure the remote device vyos.vyos.vyos_config: diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index d2858640..3177888b 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -199,7 +199,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Gather all facts - vyos.vyos.vyos_facts: diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index 30f7ecf1..b37cf020 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -783,7 +783,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst index 7c55b045..8a18fc61 100644 --- a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst @@ -216,7 +216,7 @@ Parameters Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_firewall_rules_module.rst b/docs/vyos.vyos.vyos_firewall_rules_module.rst index 15073b1e..cebe64cc 100644 --- a/docs/vyos.vyos.vyos_firewall_rules_module.rst +++ b/docs/vyos.vyos.vyos_firewall_rules_module.rst @@ -1327,7 +1327,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using deleted to delete firewall rules based on rule-set name # diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index 111ff311..46af72db 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -572,7 +572,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure interface vyos.vyos.vyos_interface: diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 5bf5d231..52ae1ccc 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -319,7 +319,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst index a8fe6040..8c76dcb8 100644 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ b/docs/vyos.vyos.vyos_l3_interface_module.rst @@ -322,7 +322,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Set eth0 IPv4 address vyos.vyos.vyos_l3_interface: diff --git a/docs/vyos.vyos.vyos_l3_interfaces_module.rst b/docs/vyos.vyos.vyos_l3_interfaces_module.rst index 38dd3e91..94b3d585 100644 --- a/docs/vyos.vyos.vyos_l3_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_l3_interfaces_module.rst @@ -303,7 +303,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index 153e20e2..52da8678 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -273,7 +273,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst index ae7eea7b..f7586d65 100644 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ b/docs/vyos.vyos.vyos_linkagg_module.rst @@ -348,7 +348,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure link aggregation group vyos.vyos.vyos_linkagg: diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index 92244211..851ed202 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -180,7 +180,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index 1c860e7d..01036649 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -264,7 +264,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Enable LLDP on eth1 net_lldp_interface: diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index c5ea47bc..030cd734 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -370,7 +370,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst index 92aa732e..88d0211c 100644 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ b/docs/vyos.vyos.vyos_lldp_module.rst @@ -209,7 +209,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Enable LLDP service vyos.vyos.vyos_lldp: diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index f651b7a5..9cb024d0 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -360,7 +360,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure console logging vyos.vyos.vyos_logging: diff --git a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst index 141c0cf3..0417088c 100644 --- a/docs/vyos.vyos.vyos_ospf_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_ospf_interfaces_module.rst @@ -461,7 +461,7 @@ Parameters Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 50ed5d34..9433538e 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -1649,7 +1649,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_ospfv3_module.rst b/docs/vyos.vyos.vyos_ospfv3_module.rst index d1ee1b18..568dbabe 100644 --- a/docs/vyos.vyos.vyos_ospfv3_module.rst +++ b/docs/vyos.vyos.vyos_ospfv3_module.rst @@ -348,7 +348,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index e3377fc5..f9c4a681 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -284,7 +284,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Test reachability to 10.10.10.10 vyos.vyos.vyos_ping: @@ -405,7 +405,7 @@ Common return values are documented `here The round trip time (RTT) stats.
Sample:
-
AnsibleMapping([('avg', 2), ('max', 8), ('min', 1), ('mdev', 24)])
+
{'avg': 2, 'max': 8, 'min': 1, 'mdev': 24}
diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 74f296d4..69afb568 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -354,7 +354,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure static route vyos.vyos.vyos_static_route: diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst index 53942a5c..5a6884b1 100644 --- a/docs/vyos.vyos.vyos_static_routes_module.rst +++ b/docs/vyos.vyos.vyos_static_routes_module.rst @@ -343,7 +343,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # Using merged # diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index a71303c4..bc521f07 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -248,7 +248,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: configure hostname and domain-name vyos.vyos.vyos_system: diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index 04a7a6e2..f47ab015 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -408,7 +408,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: create a new user vyos.vyos.vyos_user: diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index d00260ec..b6e3ccf5 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -434,7 +434,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create vlan vyos.vyos.vyos_vlan: diff --git a/plugins/cliconf/vyos.py b/plugins/cliconf/vyos.py index c8aaff9f..d63c677e 100644 --- a/plugins/cliconf/vyos.py +++ b/plugins/cliconf/vyos.py @@ -58,6 +58,13 @@ from ansible.plugins.cliconf import CliconfBase class Cliconf(CliconfBase): + __rpc__ = CliconfBase.__rpc__ + [ + "commit", + "discard_changes", + "get_diff", + "run_commands", + ] + def __init__(self, *args, **kwargs): super(Cliconf, self).__init__(*args, **kwargs) self._device_info = {} @@ -339,12 +346,6 @@ class Cliconf(CliconfBase): def get_capabilities(self): result = super(Cliconf, self).get_capabilities() - result["rpc"] += [ - "commit", - "discard_changes", - "get_diff", - "run_commands", - ] result["device_operations"] = self.get_device_operations() result.update(self.get_option_values()) return json.dumps(result) -- cgit v1.2.3