Releases: ansible-collections/dellemc.enterprise_sonic
Dell Enterprise SONiC Release 3.0.0
v3.0.0
Release Summary
Release Date: 2024-1121
This release provides enhanced Dell Enterprise SONiC Ansible Collection support for SONiC 4.4.0
and later images. It provides a new resource module for support of the SONiC SSH client configuration
options introduced with the SONiC 4.4.1 release. It provides the "breaking" changes needed for
full support of SONiC 4.4.0 features that were not fully supported by the 2.5.0 and 2.5.1
minor and bugfix releases of this collection. It also provides the "breaking" changes needed for
full support of the SONiC "aaa" server configuration options and the revised SONiC "vlan mapping"
(QinQ) configuration options provided in SONiC release 4.4.0. Other "breaking" changes include
enhanced support in the sonic_bgp_communities resource module for existing BGP communities
configuration options and expansion of support for the route map "set ip/ipv6 next hop" configuration
options.
This release also provides new support for several features released in SONiC releases 4.1, 4.2,
4.4.0, and 4.4.1 as well as bug fixes and enhancements for support of features that were initially
introduced in previous Enterprise SONiC Ansible releases. The changelog describes changes made to
the modules included in this collection since release 2.5.0.
Minor Changes
sonic_image_management - Add support for image GPG Key installation and verification feature in sonic_image_management module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/380).
sonic_interfaces - Add new unreliable-los option to interface resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/453).
sonic_ldap - Add ldap security profile support for sonic_ldap module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/414).
sonic_logging - Add "severity" option to the logging module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/478).
sonic_logging - Add TLS protocol in sonic_logging module(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/423).
sonic_logging - Add audit message-type in sonic_logging module(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/424).
sonic_logging - Add new 'auditd_system' choice to the 'message_type' choices for the logging resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/459).
sonic_mgmt_servers - Add REST server cipher suite support for sonic_mgmt_servers module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/464).
sonic_qos_buffer - Add 'buffer_init' attribute (https://github.com/ansible-collection/dellemc.enterprise_sonic/pull/444).
sonic_route_maps - Add the set ip/ipv6 next_hop 'native' option (https://github.com/ansible-collection/dellemc.enterprise_sonic/pull/421).
sonic_vxlan - Add 'suppress_vlan_neigh' vlan list option (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/448).
Breaking Changes / Porting Guide
sonic_aaa - Update AAA module to align with SONiC functionality (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/382).
sonic_bgp_communities - Change 'aann' option as a suboption of 'members' and update its type from string to list of strings (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/440).
sonic_route_maps - Change the 'set ip_next_hop' option from a single-line option to a dictionary (https://github.com/ansible-collection/dellemc.enterprise_sonic/pull/421).
sonic_vlan_mapping - New vlan_mapping resource module. The users of the vlan_mapping resource module with playbooks written for the SONiC 4.1 will need to revise their playbooks based on the new argspec to use those playbooks for SONiC 4.2 and later versions. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/296).
ConnectionError - Add the needed import of the Ansible ConnectionError exception class for all files where it was previously missing. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/445).
Update 'update_url' method to handle multiple interface names (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/455).
Update regex search expression for 'not found' error message in httpapi/sonic.py 'edit_config' method (https://github.com/ansible-collection/dellemc.enterprise_sonic/pull/443).
sonic_bgp_communities - Fix issues in merged state for standard community-lists (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/440).
sonic_copp - Update reserved CoPP names list (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/481).
sonic_interfaces - Remove the restriction preventing configuration of interface speed for port channel member interfaces (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/470).
sonic_l3_interfaces - Eliminate unconditional sending of the new autoconf REST API option during replaced and overridden state handling (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/474).
sonic_mclag - Delete any remaining PortChannel members for an mclag domain before attempting to delete the mclag domain (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/463).
sonic_ospf_area - Fix OSPF area bug (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/466).
sonic_qos_interfaces - Fix command deletion bug (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/473).
sonic_qos_wred - Update QoS WRED regression test case based on SONiC code changes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/465).
sonic_stp - Change the criteria for converting vlans and vlan ranges to handle vlan IDs with more than one digit (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/460).
sonic_stp - Fix functionality to allow a value of 0 to be configured for the appropriate integer attributes and refactor module code(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/477).
sonic_system - Catch the ConnectionError exception caused by unconditional fetching of auditd and ip loadshare hash algorithm configuration, and return empty configuration instead of allowing the uncaught exception to abort all "system" operations on SONiC images older than version 4.4.0 (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/441).
sonic_vrrp - Update delete handling to fix regression failure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/455).
sonic_vxlan - Fix failing regression tests for sonic_vxlan (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/471).
dellemc.enterprise_sonic.sonic_ssh - Manage SSH configurations on SONiC.
Dell Enterprise SONiC Release 2.5.1
Release Summary
Release Date: 2024-0917
This release provides bug fixes for problems present in the 2.5.0 release of the Dell
Enterprise SONiC Ansible Collection. The most critical of the fixes included in this
release is a fix to enable downward compatibility of the "sonic_system" resource module
for SONiC releases earlier than SONiC release 4.4.0. Also included are fixes to enable
correct handling for "Connection Error" exceptions and updating of documentation links
for the README file in accordance with a new location for the module documentation files.
The changelog describes changes made to the modules included in this collection since
release 2.5.0.
Bugfixes
ConnectionError - Add the needed import of the Ansible ConnectionError exception class for all files where it was
previously missing. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/445).
Update regex search expression for 'not found' error message in httpapi/sonic.py 'edit_config'
method (https://github.com/ansible-collection/dellemc.enterprise_sonic/pull/443).
sonic_system - Catch the ConnectionError exception caused by unconditional fetching of auditd and
ip loadshare hash algorithm configuration, and return empty configuration instead of allowing the
uncaught exception to abort all "system" operations on SONiC images older than
version 4.4.0 (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/441).
Dell Enterprise SONiC Release 2.5.0
This release provides enhanced Dell Enterprise SONiC Ansible Collection support for SONiC 4.x images.
In addition to new resource modules to support previously existing functionality, it provides
support for several new features released in SONiC releases 4.1, 4.2, and 4.4.
It also provides bug fixes and enhancements for support of features that were initially introduced
in previous Enterprise SONiC Ansible releases. The changelog describes changes made to the modules
included in this collection since release 2.0.0.
Additional details are described below.
- Update the "requires_ansible" version in the meta/runtime.yml file for this collection
to the oldest supported version of ansible-core. (This was recently changed by Redhat/Ansible
to version "2.15.0".) - Update the list of resource modules in the README file to include all currently available
resource modules for this collection.
Release Summary
Release Date: 2024-0812
This release provides enhanced Dell Enterprise SONiC Ansible Collection support for SONiC 4.x images.
In addition to new resource modules to support previously existing functionality, it provides
support for several new features released in SONiC releases 4.1, 4.2, and 4.4.
It also provides bug fixes and enhancements for support of features that were initially introduced
in previous Enterprise SONiC Ansible releases. The changelog describes changes made to the modules
included in this collection since release 2.0.0.
Additional details are described below.
- Update the "requires_ansible" version in the meta/runtime.yml file for this collection
to the oldest supported version of ansible-core. (This was recently changed by Redhat/Ansible
to version "2.15.0".) - Update the list of resource modules in the README file to include all currently available
resource modules for this collection.
bgp_af - Add support for 'import vrf' commands (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/351).
sonic_bfd - Add playbook check and diff modes support for bfd module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/346).
sonic_bgp - Add playbook check and diff modes support for bgp module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/350).
sonic_bgp - Add support BGP Asn Notation (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/417).
sonic_bgp - Fix GitHub issue# 416 (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/418).
sonic_bgp_af - Add playbook check and diff modes support for bgp_af module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/350).
sonic_bgp_af - Add support for BGP Asn Notation (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/417).
sonic_bgp_af - Add support for aggregate address configuration(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/398).
sonic_bgp_af - Update replaced state handling (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/400)
sonic_bgp_as_paths - Add playbook check and diff modes support for bgp_as_paths module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/350).
sonic_bgp_communities - Add playbook check and diff modes support for bgp_communities module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/350).
sonic_bgp_ext_communities - Add playbook check and diff modes support for bgp_ext_communities module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/350).
sonic_bgp_neighbors - Add playbook check and diff modes support for bgp_neighbors module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/360).
sonic_bgp_neighbors - Add support for BGP Asn Notation (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/417).
sonic_bgp_neighbors - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/335).
sonic_bgp_neighbors - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/336).
sonic_bgp_neighbors - Add support for the "fabric_external" option (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/336).
sonic_bgp_neighbors_af - Add playbook check and diff modes support for bgp_neighbors_af module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/360).
sonic_bgp_neighbors_af - Add support for BGP Asn Notation (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/417).
sonic_copp - Add playbook check and diff modes support for copp module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/346).
sonic_dhcp_relay - Add playbook check and diff modes support for dhcp_relay module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/346).
sonic_dhcp_snooping - Add playbook check and diff modes support for dhcp_snooping module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/346).
sonic_interfaces - Add description, enabled option support for Loopback interfaces (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/364).
sonic_interfaces - Fix GitHub issue 357 - set proper default value when deleted (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/366).
sonic_interfaces - Update replaced state handling (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/364).
sonic_l3_interfaces - Add playbook check and diff modes support for l3_interfaces module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/328).
sonic_l3_interfaces - Add support for USGv6R1 related features (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/374).
sonic_l3_interfaces - Fix IPv6 default dad configuration handling (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/428).
sonic_lag_interfaces - Add evpn ethernet-segment support for LAG interfaces (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/403).
sonic_lldp_global - Add playbook check and diff modes support for lldp_global module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/338).
sonic_logging - Add support for protocol option in logging module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/317).
sonic_mac - Add playbook check and diff modes support for mac module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/338).
sonic_mclag - Add playbook check and diff modes support for mclag module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/337).
sonic_mclag - Enable session-vrf command support in mclag(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/299).
sonic_port_breakout - Add playbook check and diff modes support for port_breakout module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/337).
sonic_port_group - Make error message for port group facts gathering more descriptive (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/396).
sonic_prefix_lists - Add playbook check and diff modes support for prefix_lists module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/331).
sonic_qos_maps - Comment out PFC priority group map tests cases (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/395).
sonic_qos_scheduler - Update states implementation (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/373).
sonic_route_maps - Add UT for route maps module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/384).
sonic_route_maps - Add playbook check and diff modes support for route_maps module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/331).
sonic_route_maps - Add support for BGP Asn Notation (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/417).
sonic_route_maps - Add support for the 'set tag' option and synchronize module documentation with argspec and model (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/413).
sonic_stp - Add playbook check and diff modes support for stp module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/338).
sonic_system - Add support for 'standard_extended' interface-naming mode (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/352).
sonic_system - Add support for configuring auto-breakout feature (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/342).
sonic_system - Adding Versatile Hash feature.(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/401).
sonic_system - Enable auditd command support(https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/405).
sonic_system - Update replaced state handling (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/388).
sonic_vxlan - Fix GitHub issue 376 - Change vxlan module get_fact function (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/393).
sonic_vxlans - Add playbook check and diff modes support for vxlans module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/337).
sonic_vxlans - Add support for the "external_ip" vxlan option (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/330).
[Bugfixes](https://github.com/ansible-collections/dellemc.enterprise_sonic/blob/main/CHANGELOG.rs...
Dell Enterprise SONiC Release 2.4.0
Release Summary:
Release Date: 2024-0108
This release provides an Ansible compliance change required on top of the changes included in
the 2.3.0 release of the enterprise_sonic Ansible network resource module collection.
It addresses an issue raised by the Ansible core team with the content of the 2.3.0 release,
and provides accompanying documentation changes in the README file. Additional details are
described below.
- Update the "requires_ansible" version in the meta/runtime.yml file for this collection
to the oldest supported version of ansible-core. (This was recently changed by Redhat/Ansible
to version "2.14.0".) - Update the README file "Recommended version" values for Ansible and Python in accordance
with the previous change item to modify the oldest supported version of ansible-core which,
in turn, requires a Python version >= "3.9". - Update the list of resource modules in the README file to include all currently available
resource modules for this collection.
Dell Enterprise SONiC Release 2.3.0
======================================
Dellemc.Enterprise_Sonic Release Notes
v2.3.0
Release Summary
Release Date: 2024-0103
This release provides the functionality enhancements listed below, along with fixes for
problems found in regression testing or reported by users. The main functionality enhancements
provided are the following items.
- Complete the support for "replaced" and "overridden" state handling for all resource modules except for the bgp_neighbors and bgp_neighbors_af modules.
With this release, the required support has been added for any resource modules that were not
provided with this support for the 2.1.0 release with the two exceptions noted above. - Provide initial support for the "--check" and "--diff" mode options for playbook execution. This
release provides the common utility support for these options for use by all resource modules.
It also provides the specific resource module changes required for implementation of the
functionality in many of the existing resource modules. (The "--check" and "--diff" mode support
for the remaining resource modules is planned for inclusion in the next release.) - New resource modules for "Public Key Infrastructure", STP, and DHCP Snooping.
- Support for "ranges" of vlans (e.g '2-100') in tasks for the mclag resource module.
Please refer to the "CHANGELOG.rst" file at the top directory level of this repo for additional
details on the contents of this release.
Minor Changes
- sonic_aaa - Add support for playbook check and diff modes (#304).
- sonic_aaa - Enhance config diff generation function (#318).
- sonic_acl_interfaces - Add support for playbook check and diff modes (#306).
- sonic_acl_interfaces - Enhance config diff generation function (#318).
- sonic_bgp_as_paths - Add support for replaced and overridden states (#290).
- sonic_bgp_communities - Add support for replaced and overridden states (#251).
- sonic_bgp_ext_communities - Add support for replaced and overridden states (#252).
- sonic_interfaces - Add support for playbook check and diff modes (#301).
- sonic_interfaces - Add support for replaced and overridden states (#314).
- sonic_interfaces - Change deleted design for interfaces module (#310).
- sonic_interfaces - Enhance config diff generation function (#318).
- sonic_ip_neighbor - Add support for playbook check and diff modes (#285).
- sonic_ip_neighbor - Enhance config diff generation function (#318).
- sonic_l2_acls - Add support for playbook check and diff modes (#306).
- sonic_l2_acls - Enhance config diff generation function (#318).
- sonic_l2_interfaces - Add support for playbook check and diff modes (#303).
- sonic_l2_interfaces - Enhance config diff generation function (#318).
- sonic_l3_acls - Add support for playbook check and diff modes (#306).
- sonic_l3_acls - Enhance config diff generation function (#318).
- sonic_l3_interfaces - Add support for replaced and overridden states (#241).
- sonic_lag_interfaces - Add support for playbook check and diff modes (#303).
- sonic_lag_interfaces - Enhance config diff generation function (#318).
- sonic_logging - Add support for playbook check and diff modes (#285).
- sonic_logging - Enhance config diff generation function (#318).
- sonic_mclag - Add VLAN range support for 'unique_ip' and 'peer_gateway' options (#288).
- sonic_mclag - Add support for replaced and overridden states (#288).
- sonic_ntp - Add support for playbook check and diff modes (#281).
- sonic_ntp - Enhance config diff generation function (#318).
- sonic_port_breakout - Add Ansible support for all port breakout modes now allowed in Enterprise SONiC (#276).
- sonic_port_breakout - Add support for replaced and overridden states (#291).
- sonic_port_group - Add support for playbook check and diff modes (#284).
- sonic_port_group - Enhance config diff generation function (#318).
- sonic_radius_server - Add support for playbook check and diff modes (#279).
- sonic_radius_server - Enhance config diff generation function (#318).
- sonic_static_routes - Add playbook check and diff modes support for static routes resource module (#313).
- sonic_static_routes - Enhance config diff generation function (#318).
- sonic_system - Add support for playbook check and diff modes (#284).
- sonic_system - Enhance config diff generation function (#318).
- sonic_tacacs_server - Add support for playbook check and diff modes (#281).
- sonic_tacacs_server - Enhance config diff generation function (#318).
- sonic_users - Add support for playbook check and diff modes (#304).
- sonic_users - Enhance config diff generation function (#318).
- sonic_vlans - Add support for playbook check and diff modes (#301).
- sonic_vlans - Enhance config diff generation function (#318).
- sonic_vrfs - Add mgmt VRF replaced state handling to sonic_vrfs module (#298).
- sonic_vrfs - Add mgmt VRF support to sonic_vrfs module (#293).
- sonic_vrfs - Add support for playbook check and diff modes (#285).
- sonic_vrfs - Enhance config diff generation function (#318).
- tests - Add UTs for BFD, COPP, and MAC modules (#287).
- tests - Enable contiguous execution of all regression integration tests on an S5296f (#277).
- tests - Fix the bgp CLI test base_cfg_path derivation of the bgp role_path by avoiding relative pathing from the possibly external playbook_dir (#283).
Bugfixes
- sonic_bgp_communities - Fix incorrect "facts" handling for parsing of a BGP community list configured with an empty "members" list (#319).
- sonic_bgp_neighbors - Fix prefix-limit issue (#289).
- sonic_interfaces - Add warnings when speed and auto_negotiate is configured at same time (#314).
- sonic_interfaces - Fix support for standard naming interfaces (#314).
- sonic_interfaces - Prevent configuring speed in port group interfaces (#314).
- sonic_stp - Correct the commands list for STP delete state (#302).
New Modules
- dellemc.enterprise_sonic.sonic_dhcp_snooping - M...
Dell Enterprise SONiC Release 2.2.0
v2.2.0
Release Summary
Release Date: 2023-06-01
This release provides Ansible compliance changes required on top of the changes included in
the 2.1.0 release of the enterprise_sonic Ansible network resource module collection.
It addresses two issues raised by the Ansible core team with the content of the 2.1.0 release.
- Back out the "breaking_change" made in the sonic_aaa resource module to fix a functional
shortcoming in the enterprise_sonic Ansible collection. Although the change is still needed,
it will be deferred to a "major" release. - Re-enable installation of new Ansible Netcommon repo instances when installing the
enterprise_sonic Ansible collection. The 2.1.0 enterprise_sonic Ansible release included a
workaround for a bug introduced in the 5.0.0 version of the Ansible Netcommon repo. This
workaround was implemented in the "galaxy.yml" file for the enterprise_sonic
2.1.0 release. New versions of Ansible Netcommon were published after the problematic 5.0.0
version and the revised "galaxy.yml" file for this release enables installation of these
newer versions.
Minor Changes
Dell Enterprise SONiC Release 2.1.0
Release Summary
Release Date: 2023-0515
This release provides enhanced Dell Enterprise SONiC Ansible Collection support for SONiC 4.x images.
In addition to new resource modules to support previously existing functionality, it provides
support for the "QinQ" (Vlan Mapping) function introduced with SONiC release 4.1. It also provides
bug fixes and enhancements for support of features that were initially introduced in previous
Enterprise SONiC Ansible releases. The changelog describes changes made to the modules and plugins
included in this collection since release 2.0.0.
Minor Changes
sonic_aaa - Add unit tests for AAA resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/198).
sonic_aaa - Add replaced and overridden states support for AAA resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/237).
sonic_api - Add unit tests for api resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/218).
sonic_bfd, sonic_copp - Update replaced methods (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/254).
sonic_bgp - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/240).
sonic_bgp - Add unit tests for BGP resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/182).
sonic_bgp - Add rt_delay attribute to module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/244).
sonic_bgp_af - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/246).
sonic_bgp_af - Add unit tests for BGP AF resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/183).
sonic_bgp_af - Modify BGP AF resource module unit tests to adjust for changes in the resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/191).
sonic_bgp_af - Add several attributes to support configuration of route distinguisher and route target (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/141).
sonic_bgp_as_paths - Add unit tests for BGP AS paths resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/184).
sonic_bgp_communities - Add unit tests for BGP communities resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/185).
sonic_bgp_ext_communities - Add unit tests for BGP ext communities resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/186).
sonic_bgp_neighbors - Add unit tests for BGP neighbors resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/187).
sonic_bgp_neighbors - Enhance unit tests for BGP Neighbors resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/245).
sonic_bgp_neighbors_af - Add unit tests for BGP neighbors AF resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/188).
sonic_command - Add unit tests for command resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/219).
sonic_config - Add unit tests for config resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/220).
sonic_dhcp_relay - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/249).
sonic_dhcp_relay - Add a common unit tests module and unit tests for dhcp relay module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/148).
sonic_facts - Add unit tests for facts resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/222).
sonic_interfaces - Add unit tests for interfaces resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/197).
sonic_interfaces - Add speed, auto-negotiate, advertised-speed and FEC to interface resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/128).
sonic_ip_neighbor - Add unit tests for IP neighbor resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/225).
sonic_ip_neighbor - Change the replaced function in ip_neighbor resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/253).
sonic_l2_interfaces - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/221).
sonic_l2_interfaces - Add unit tests for l2_interfaces resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/200).
sonic_l3_interfaces - Add unit tests for l3_interfaces resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/202).
sonic_lag_interface - Add replaced and overridden states support for LAG interface resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/196).
sonic_lag_interfaces - Add unit tests for lag_interfaces resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/203).
sonic_logging - Add replaced and overridden states support for logging resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/150).
sonic_logging - Add unit tests for logging resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/226).
sonic_logging - Change logging get facts for source_interface naming (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/258).
sonic_mclag - Add delay_restore, gateway_mac, and peer_gateway attributes to module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/145).
sonic_ntp - Add unit tests for NTP resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/207).
sonic_ntp - Add prefer attribute to NTP resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/118).
sonic_ntp - Add replaced and overridden states support for NTP resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/151).
sonic_ntp - Change NTP get facts to get default parameters (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/106).
sonic_ntp - Change NTP key values in NTP regression test script (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/107).
sonic_ntp - Change NTP module name (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/113).
sonic_ntp - Change NTP module names in NTP regression test script (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/114).
sonic_ntp - Change NTP resource module to make minpoll and maxpoll be configured together (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/129).
sonic_port_breakout - Add unit tests for port breakout resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/229).
sonic_port_group - Add unit tests for port group resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/228).
sonic_port_group - Add replaced and overridden states support for port group resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/227).
sonic_prefix_lists - Add unit tests for prefix lists resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/209).
sonic_prefix_lists - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/255).
sonic_radius_server - Add unit tests for RADIUS server resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/210).
sonic_radius_server - Add replaced and overridden states support for RADIUS server resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/239).
sonic_static_routes - Add unit tests for static routes resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/212).
sonic_static_routes - Add support for replaced and overridden states (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/236).
sonic_system - Add unit tests for system resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/223).
sonic_system - Add replaced and overridden states support for system resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/159).
sonic_tacacs_server - Add replaced and overridden states support for TACACS server resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/235).
sonic_tacacs_server - Add unit tests for TACACS server resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/208).
sonic_users - Add replaced and overridden states support for users resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/242).
sonic_users - Add unit tests for users resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/213).
sonic_vlans - Add unit tests for Vlans resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/214).
sonic_vlans - Add replaced and overridden states support for VLAN resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/217).
sonic_vrfs - Add unit tests for VRFS resource module (https://github.com/ansible-collections/dellemc.e...
Dell SONiC Enterprise Collection v1.1.2 for Dell Enterprise SONiC 3.x: bug fixes
Release Summary
This is a bugfix release for the dellemc.enterprise_sonic
collection on 2020-06-02.
The changelog describes changes made to the modules and plugins included in this collection since release 1.1.1.
Bugfixes
- utils - Fixed regex expression in sonic.py to handle standard interface naming in port breakout mode (#110).
Dell Enterprise SONiC Ansible Collection v2.0.0 support for SONiC 4.x images
Release Summary
This release provides Dell Enterprise SONiC Ansible Collection support for SONiC 4.x images. It is the first release for the 2.x branch of the collection. Subsequent enhancements for support of SONiC 4.x images will also be provided as needed on the 2.x branch. This release also contains bugfixes and enhancements to supplement the Ansible functionality provided previously for SONiC 3.x images. The changelog describes changes made to the modules and plugins included in this collection since release 1.1.0.
Major Changes
- Added 'static_routes' module to collection (#82).
- Added a resource module for NTP support (#99).
- Added a resource module for support of prefix lists (#100).
- Updated backend REST API request formats in all applicable modules for compatibility with SONiC 4.x openconfig YANG compliant REST APIs. (#53)
Minor Changes
- Added an execution-environment.yml file to the "meta" directory to enable use of Ansible execution environment infrastructure (#88).
- bgp_af - Added support for BGP options to configure usage and advertisement of vxlan primary IP address related attributes (#62).
- bgp_as_paths - updated module examples with 'permit' attribute (#102)
- bgp_neighbors - Add BGP peer group support for multiple attributes. The added attributes correspond to the same set of attributes added for BGP neighbors with PR 72 (#81).
- bgp_neighbors - Add support for multiple attributes (#72).
- bgp_neighbors - add an auth_pwd dictionary and nbr_description attribute to the argspec (#67).
- bgp_neighbors - added prefix-list related peer-group attributes (#101).
- bgp_neighbors_af - added prefix-list related neighbor attributes (#101).
- playbook - updated examples to reflect module changes (#102)
- sonic_vxlans - Add configuration capability for the primary IP address of a vxlan vtep to facilitate vxlan path redundundancy (#58).
- vlans - Added support for the vlan "description" attribute (#98).
- workflow - Added stable-2.13 to the sanity test matrix (#90).
Breaking Changes / Porting Guide
- bgp_af - Add the route_advertise_list dictionary to the argspec to replace the deleted, obsolete advertise_prefix attribute used for SONiC 3.x images on the 1.x branch of this collection. This change corresponds to a SONiC 4.0 OC YANG REST compliance change for the BGP AF REST API. It enables specification of a route map in conjunction with each route advertisement prefix (#63).
- bgp_af - remove the obsolete 'advertise_prefix' attribute from argspec and config code. This and subsequent co-req replacement with the new route advertise list argument structure require corresponding changes in playbooks previoulsly used for configuring route advertise prefixes for SONiC 3.x images. (#60)
- bgp_neighbors - Replace the previously defined standalone "bfd" attribute with a bfd dictionary containing multiple attributes. This change corresponds to the revised SONiC 4.x implementation of OC YANG compatible REST APIs. Playbooks previously using the bfd attributes for SONiC 3.x images must be modified for useon SONiC 4.0 images to use the new definition for the bfd attribute argspec structure (#72).
- bgp_neighbors - Replace, for BGP peer groups, the previously defined standalone "bfd" attribute with a bfd dictionary containing multiple attributes. This change corresponds to the revised SONiC 4.x implementation of OC YANG compatible REST APIs. Playbooks previously using the bfd attributes for SONiC 3.x images must be modified for useon SONiC 4.0 images to use the new definition for the bfd attribute argspec structure (#81).
Bugfixes
- Fixed regression test bugs in multiple modules (#103).
- Fixed regression test sequencing and other regression test bugs in multiple modules (#85).
- aaa - Fixed a bug in facts gathering by providing required conditional branching (#90)
- aaa - Modify regression test sequencing to enable correct testing of the functionality for this module (#78).
- bgp_neighbors - remove string conversion of timer attributes (#60)
- port_breakout - Fixed a bug in formulation of port breakout REST APIs (#88).
- sonic - Fix a bug in handling of interface names in standard interface naming mode (#103).
- sonic_command - Fix bugs in handling of CLI commands involving a prompt and answer sequence (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/76/files).
- users - Fixed a bug in facts gathering (#90).
- vxlan - update Vxlan test cases to comply with SONiC behavior (#105).
New Modules
- dellemc.enterprise_sonic.sonic_ntp - Manage NTP configuration on SONiC.
- dellemc.enterprise_sonic.sonic_prefix_lists - prefix list configuration handling for SONiC
- dellemc.enterprise_sonic.sonic_static_routes - Manage static routes configuration on SONiC
Dell SONiC Enterprise Collection v1.1.1 for Dell Enterprise SONiC 3.x: bug fixes and minor enhancements
Release Summary
This is a minor enhancement and bugfix release for the dellemc.enterprise_sonic
collection on 2020-06-02.
The list below provides a detailed description of changes made to the modules and plugins included in this
collection since release v1.1.0.
Minor Changes
- README - describe branch naming conventions for the "main" and "1.x" branches (#54).
- README - describe the mapping of SONiC release versions to the corresponding branch and release names in the Dell SONiC Enterprise Ansible collection. (#84).
- bgp_as_paths - Add a 'permit/deny' attribute (#52).
- bgp_neighbors - add 'password' and 'description' attributes (#69).
- meta - add the newly required execution_environment.yml file to the 'meta' directory (#89).
- port_breakout - modify port numbers to match commonly available breakout ports (#89).
- workflows - add stable-2.12 to the CI test matrix (#51).
- workflows - add stable-2.13 to the CI test matrix (#91).
Bugfixes
- Fixes incorrect grouping of parameters to be used for invocation of the "send_command" API for sending commands to a device. (#71).
- aaa - fix a logic mistake in validating authentication data (#52).
- aaa - modify a 'delete' test case to eliminate a subsequent idempotency failure for a 'merge' test case restoring the deleted attribute. The attribute that was being used for the test case had a non-idempotent effect in the SONiC switch functional code. This did not allow verification of the correct idempotency logic in the Ansible handling of the attribute 'delete' and 'restore' functionality. (#80).
- bgp - removed unnecessary brackets in a configuration handling instruction (#52).
- bgp_neighbors - add a 'maxsplit' value in facts handling (#52).
- bgp_neighbors - removed unnecessary brackets in configuration handling instructions (#52).
- radius_server - add a missing 'get' in configuration handling (#52).
- system - delete an initial test case requiring 'changed' state for deletion of final configuration attributes assuming 'leftover' configuration from previous execution. Replace this initial test case with cleanup of any residual state with no assumption of leftover residual state. Do the final deletion of configuration at the end of the test instead of at the beginning to retain verification that the deletion works correctly (#87).
- tacacs_server - correct an argument spelling error in facts handling (#52).