Skip to content

Commit

Permalink
Update default values in module argspec and docs
Browse files Browse the repository at this point in the history
This reverts commit bfe00bf.

Revert "Revert "Change short desction (ansible-collections#123)""

This reverts commit 90c7d21.

eos_interfaces: Fix issue with 'forced' speed configuration. (ansible-collections#120)

eos_interfaces: Fix issue with 'forced' speed configuration.

Reviewed-by: https://github.com/apps/ansible-zuul

Add documentation to use the l2_interfaces module for L2 configs, in l3_interfaces module. (ansible-collections#102)

Add documentation to use the l2_interfaces module for L2 configs, in l3_interfaces module.

Reviewed-by: https://github.com/apps/ansible-zuul

Remove local connection testing for integration jobs (ansible-collections#127)

Remove local connection testing for integration jobs

Reviewed-by: https://github.com/apps/ansible-zuul

Drop ansible from requirement.txt (ansible-collections#128)

Drop ansible from requirement.txt

Reviewed-by: https://github.com/apps/ansible-zuul

Add eos_ospf_interfaces resource module (ansible-collections#125)

Add eos_ospf_interfaces resource module

Reviewed-by: https://github.com/apps/ansible-zuul

Release prep version 1.2.0 (ansible-collections#129)

Release prep version 1.2.0

Reviewed-by: https://github.com/apps/ansible-zuul

Add version key to galaxy.yaml (ansible-collections#132)

Add version key to galaxy.yaml

Reviewed-by: https://github.com/apps/ansible-zuul

To fix the bug where description was being parsed incorrectly as Interface in of eos_*_interfaces (ansible-collections#140)

To fix the bug where description was being parsed incorrectly as Interface in of eos_*_interfaces

Reviewed-by: https://github.com/apps/ansible-zuul

Fix list.copy()  and idempotent issues (replaced and overridden) (ansible-collections#142)

Fix list.copy()  and idempotent issues (replaced and overridden)

Reviewed-by: https://github.com/apps/ansible-zuul

Update default values in module argspec and docs

Signed-off-by: GomathiselviS <[email protected]>

linters fix
  • Loading branch information
GomathiselviS committed Jan 21, 2021
1 parent 3b5eb15 commit d51b3ae
Show file tree
Hide file tree
Showing 92 changed files with 6,369 additions and 136 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ Name | Description
--- | ---
[arista.eos.eos](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_httpapi.rst)|Use eAPI to run command on eos platform

### Inventory plugins
Name | Description
--- | ---

### Modules
Name | Description
--- | ---
Expand All @@ -62,6 +66,7 @@ Name | Description
[arista.eos.eos_lldp_global](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_lldp_global_module.rst)|LLDP resource module
[arista.eos.eos_lldp_interfaces](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_lldp_interfaces_module.rst)|LLDP interfaces resource module
[arista.eos.eos_logging](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_logging_module.rst)|Manage logging on network devices
[arista.eos.eos_ospf_interfaces](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_ospf_interfaces_module.rst)|OSPF Interfaces Resource Module.
[arista.eos.eos_ospfv2](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_ospfv2_module.rst)|OSPFv2 resource module
[arista.eos.eos_ospfv3](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_ospfv3_module.rst)|OSPFv3 resource module
[arista.eos.eos_static_route](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_static_route_module.rst)|(deprecated, removed after 2022-06-01) Manage static IP routes on Arista EOS network devices
Expand All @@ -72,10 +77,6 @@ Name | Description
[arista.eos.eos_vlans](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_vlans_module.rst)|VLANs resource module
[arista.eos.eos_vrf](https://github.com/ansible-collections/arista.eos/blob/main/docs/arista.eos.eos_vrf_module.rst)|Manage VRFs on Arista EOS network devices

### Inventory plugins
Name | Description
--- | ---

<!--end collection content-->

Click the ``Content`` button to see the list of content included in this collection.
Expand Down
23 changes: 22 additions & 1 deletion changelogs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,27 @@ Arista Eos Collection Release Notes
.. contents:: Topics


v1.2.0
======

Minor Changes
-------------

- Added ospf_interfaces resource module. (https://github.com/ansible-collections/arista.eos/pull/125)
- Documented the necessity to use eos_interfaces and eos_l2_interfaces (for l2 configs) in eos_l3_interfaces module.
- modify short description in ospfv3 resource module.
- stop integration testing of local connection as it is deprecated.

Bugfixes
--------

- updated config dict, with duplex key when speed changes from 'x' to 'forced x' (https://github.com/ansible-collections/arista.eos/pull/120).

New Modules
-----------

- eos_ospf_interfaces - OSPF Interfaces resource module

v1.1.0
======

Expand All @@ -26,7 +47,7 @@ Bugfixes
New Modules
-----------

- eos_ospfv3 - OSPFv3 resource module
- eos_ospfv3 - OSPFV3 resource module

v1.0.3
======
Expand Down
24 changes: 23 additions & 1 deletion changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -170,5 +170,27 @@ releases:
modules:
- description: OSPFv3 resource module
name: eos_ospfv3
namespace: .ansible.collections.ansible_collections.arista.eos.plugins.modules
namespace: ''
release_date: '2020-09-30'
1.2.0:
changes:
bugfixes:
- updated config dict, with duplex key when speed changes from 'x' to 'forced
x' (https://github.com/ansible-collections/arista.eos/pull/120).
minor_changes:
- Added ospf_interfaces resource module. (https://github.com/ansible-collections/arista.eos/pull/125)
- Documented the necessity to use eos_interfaces and eos_l2_interfaces (for
l2 configs) in eos_l3_interfaces module.
- modify short description in ospfv3 resource module.
- stop integration testing of local connection as it is deprecated.
fragments:
- 101-l3_interfaces_documentation.yaml
- 120-forcedspeed-interfaces-config.yaml
- 123-ospfv3-description.yaml
- 125-ospf_interfaces_resource_module.yaml
- 127-drop-local-connection-testing.yaml
modules:
- description: ospf_interfaces resource module
name: eos_ospf_interfaces
namespace: ''
release_date: '2020-10-30'
3 changes: 0 additions & 3 deletions changelogs/fragments/123-ospfv3-description.yaml

This file was deleted.

4 changes: 4 additions & 0 deletions changelogs/fragments/acls_idempotent_issue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
bugfixes:
- replace list.copy() with list[:] to support python 2.7 and fix idempotent issue with
replaced and overridden (https://github.com/ansible-collections/arista.eos/pull/142).
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
bugfixes:
- fixes eos interfaces rm where interface in description resulted in failure (https://github.com/ansible-collections/arista.eos/issues/86).
3 changes: 3 additions & 0 deletions changelogs/fragments/galaxy-version.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
bugfixes:
- Add version key to galaxy.yaml to work around ansible-galaxy bug
3 changes: 3 additions & 0 deletions changelogs/fragments/update_docs_default_value.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
bugfixes:
- update/remove default values in module docs.(https://github.com/ansible-collections/arista.eos/pull/152)
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_acl_interfaces_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ Parameters
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using Merged
Expand Down
4 changes: 2 additions & 2 deletions docs/arista.eos.eos_acls_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2752,7 +2752,7 @@ Parameters
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>no</li>
<li>yes</li>
</ul>
</td>
Expand Down Expand Up @@ -2839,7 +2839,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_banner_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: configure the login banner
arista.eos.eos_banner:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_bgp_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -853,7 +853,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: configure global bgp as 64496
arista.eos.eos_bgp:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_command_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: run show version on remote devices
arista.eos.eos_command:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_config_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: configure top level settings
arista.eos.eos_config:
Expand Down
8 changes: 4 additions & 4 deletions docs/arista.eos.eos_eapi_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Parameters
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>no</li>
<li>yes</li>
</ul>
</td>
Expand Down Expand Up @@ -137,7 +137,7 @@ Parameters
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>no</li>
<li>yes</li>
</ul>
</td>
Expand Down Expand Up @@ -409,7 +409,7 @@ Parameters
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>no</li>
<li>yes</li>
</ul>
</td>
Expand Down Expand Up @@ -486,7 +486,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Enable eAPI access with default configuration
arista.eos.eos_eapi:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_facts_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Gather all legacy facts
- arista.eos.eos_facts:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_interface_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: configure interface
arista.eos.eos_interface:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_interfaces_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_l2_interface_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Ensure Ethernet1 does not have any switchport
arista.eos.eos_l2_interface:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_l2_interfaces_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_l3_interface_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Remove ethernet1 IPv4 and IPv6 address
arista.eos.eos_l3_interface:
Expand Down
6 changes: 3 additions & 3 deletions docs/arista.eos.eos_l3_interfaces_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Parameters
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>no</li>
<li>yes</li>
</ul>
</td>
Expand Down Expand Up @@ -208,14 +208,14 @@ Notes

.. note::
- Tested against Arista EOS 4.20.10M
- This module works with connection ``network_cli``. See the `EOS Platform Options <../network/user_guide/platform_eos.html>`_.
- This module works with connection ``network_cli``. See the `EOS Platform Options <../network/user_guide/platform_eos.html>`_. 'eos_l2_interfaces/eos_interfaces' should be used for preparing the interfaces , before applying L3 configurations using this module (eos_l3_interfaces).



Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using deleted
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_lacp_interfaces_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
#
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_lacp_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_lag_interfaces_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_linkagg_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: create link aggregation group
arista.eos.eos_linkagg:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_lldp_global_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
#
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_lldp_interfaces_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
# Using merged
#
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_lldp_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: Enable LLDP service
arista.eos.eos_lldp:
Expand Down
2 changes: 1 addition & 1 deletion docs/arista.eos.eos_logging_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ Notes
Examples
--------

.. code-block:: yaml+jinja
.. code-block:: yaml
- name: configure host logging
arista.eos.eos_logging:
Expand Down
Loading

0 comments on commit d51b3ae

Please sign in to comment.