path: root/changelogs/changelog.yaml

ancestor: null
releases:
  1.0.0:
    modules:
    - description: Manage multiline banners on VyOS devices
      name: vyos_banner
      namespace: ''
    - description: Run one or more commands on VyOS devices
      name: vyos_command
      namespace: ''
    - description: Manage VyOS configuration on remote device
      name: vyos_config
      namespace: ''
    - description: Get facts about vyos devices.
      name: vyos_facts
      namespace: ''
    - description: FIREWALL global resource module
      name: vyos_firewall_global
      namespace: ''
    - description: FIREWALL interfaces resource module
      name: vyos_firewall_interfaces
      namespace: ''
    - description: FIREWALL rules resource module
      name: vyos_firewall_rules
      namespace: ''
    - description: (deprecated, removed after 2022-06-01) Manage Interface on VyOS
        network devices
      name: vyos_interface
      namespace: ''
    - description: Interfaces resource module
      name: vyos_interfaces
      namespace: ''
    - description: (deprecated, removed after 2022-06-01) Manage L3 interfaces on
        VyOS network devices
      name: vyos_l3_interface
      namespace: ''
    - description: L3 interfaces resource module
      name: vyos_l3_interfaces
      namespace: ''
    - description: LAG interfaces resource module
      name: vyos_lag_interfaces
      namespace: ''
    - description: (deprecated, removed after 2022-06-01) Manage link aggregation
        groups on VyOS network devices
      name: vyos_linkagg
      namespace: ''
    - description: (deprecated, removed after 2022-06-01) Manage LLDP configuration
        on VyOS network devices
      name: vyos_lldp
      namespace: ''
    - description: LLDP global resource module
      name: vyos_lldp_global
      namespace: ''
    - description: (deprecated, removed after 2022-06-01) Manage LLDP interfaces configuration
        on VyOS network devices
      name: vyos_lldp_interface
      namespace: ''
    - description: LLDP interfaces resource module
      name: vyos_lldp_interfaces
      namespace: ''
    - description: Manage logging on network devices
      name: vyos_logging
      namespace: ''
    - description: OSPFv2 resource module
      name: vyos_ospfv2
      namespace: ''
    - description: OSPFV3 resource module
      name: vyos_ospfv3
      namespace: ''
    - description: Tests reachability using ping from VyOS network devices
      name: vyos_ping
      namespace: ''
    - description: (deprecated, removed after 2022-06-01) Manage static IP routes
        on Vyatta VyOS network devices
      name: vyos_static_route
      namespace: ''
    - description: Static routes resource module
      name: vyos_static_routes
      namespace: ''
    - description: Run `set system` commands on VyOS devices
      name: vyos_system
      namespace: ''
    - description: Manage the collection of local users on VyOS device
      name: vyos_user
      namespace: ''
    - description: Manage VLANs on VyOS network devices
      name: vyos_vlan
      namespace: ''
    plugins:
      cliconf:
      - description: Use vyos cliconf to run command on VyOS platform
        name: vyos
        namespace: null
    release_date: '2020-06-23'
  1.0.1:
    changes:
      minor_changes:
      - Add doc plugin fixes (https://github.com/ansible-collections/vyos.vyos/pull/51)
    fragments:
    - 51-doc-plugin-fixes.yaml
    release_date: '2020-06-23'
  1.0.2:
    changes:
      bugfixes:
      - Added workaround to avoid set_fact dynamically assigning value. This behavior
        seems to have been broken after ansible2.9.
      - Make `src`, `backup` and `backup_options` in vyos_config work when module
        alias is used (https://github.com/ansible-collections/vyos.vyos/pull/67).
      - vyos_config - fixed issue where config could be saved while in check mode
        (https://github.com/ansible-collections/vyos.vyos/pull/53)
      minor_changes:
      - Fixed the typo in the modulename of ospfv2 and ospfv3 unit tests.
      - Updated docs.
      - terminal plugin - Added additional escape sequence to be removed from terminal
        output.
    fragments:
    - 65-remove-unwanted-terminal-chars.yaml
    - 70-workaround-set_fact.yaml
    - 72-modulename-typofix.yaml
    - 73-update-docs.yaml
    - fix_src_backup_with_module_alias.yaml
    - prevent-vyos_config-saving-in-check-mode.yaml
    release_date: '2020-07-31'
  1.0.3:
    fragments:
    - 1.0.3.yaml
    release_date: '2020-08-06'
  1.0.4:
    changes:
      minor_changes:
      - Moved intent testcases from integration suite to unit tests.
      - Reformatted files with latest version of Black (20.8b1).
    fragments:
    - 71-refactor-interface-test.yaml
    - 80-reformat-files.yaml
    release_date: '2020-08-27'
  1.0.5:
    changes:
      bugfixes:
      - Added openvpn vtu interface support.
      - Update network integration auth timeout for connection local.
      - terminal plugin - Overhaul ansi_re to remove more escape sequences
    fragments:
    - 86-openvpn_vtu_interface.yaml
    - local_auth_timeout.yaml
    - terminal-escape-codes.yaml
    release_date: '2020-10-08'
  1.1.0:
    changes:
      minor_changes:
      - Added ospf_interfaces resource module.
    fragments:
    - vyos_ospf_interfaces_rm.yaml
    modules:
    - description: OSPF Interfaces resource module
      name: vyos_ospf_interfaces
      namespace: ''
    release_date: '2020-10-30'
  1.1.1:
    changes:
      bugfixes:
      - Add version key to galaxy.yaml to work around ansible-galaxy bug
      - Enable configuring an interface which is not present in the running config.
      - vyos_config - Only process src files as commands when they actually contain
        commands. This fixes an issue were the whitespace preceding a configuration
        key named 'set' was stripped, tripping up the parser.
    fragments:
    - 91-new-interface.yaml
    - config-processed-as-command.yaml
    - galaxy-version.yaml
    release_date: '2021-01-27'
  2.0.0:
    changes:
      bugfixes:
      - Update docs to clarify the idemptonecy related caveat and add it in the output
        warnings (https://github.com/ansible-collections/ansible.netcommon/pull/189)
      - cliconf plugin - Prevent `get_capabilities()` from getting larger every time
        it is called
      major_changes:
      - Please refer to ansible.netcommon `changelog <https://github.com/ansible-collections/ansible.netcommon/blob/main/changelogs/CHANGELOG.rst#ansible-netcommon-collection-release-notes>`_
        for more details.
      - Requires ansible.netcommon v2.0.0+ to support `ansible_network_single_user_mode`
        and `ansible_network_import_modules`
      - ipaddress is no longer in ansible.netcommon. For Python versions without ipaddress
        (< 3.0), the ipaddress package is now required.
      minor_changes:
      - Add support for configuration caching (single_user_mode).
      - Add vyos BGP global resource module.(https://github.com/ansible-collections/vyos.vyos/pull/125).
      - Re-use device_info dictionary in cliconf.
    fragments:
    - 120-remove-ipaddress.yaml
    - 122-rpc-unbloat.yaml
    - bgp_global_resource_module.yaml
    - fix_docker_sanity_test_failures.yaml
    - major_release_2.0.0.yaml
    - modify_resource_module_class_import.yaml
    - single_user_mode.yaml
    - vyos_config_diff_doc_update.yaml
    modules:
    - description: BGP Global Resource Module.
      name: vyos_bgp_global
      namespace: ''
    release_date: '2021-02-24'
  2.1.0:
    changes:
      minor_changes:
      - Add regex for delete failures to terminal_stderr_re
      - Add vyos BGP address_family resource module (https://github.com/ansible-collections/vyos.vyos/pull/132).
      - Enabled addition and parsing of wireguard interface.
    fragments:
    - 128-remove_tests_sanity_requirements.yml
    - 132-add-vyos-bgp-address-family.yml
    - parse_wireguard_interface.yml
    - replace-check_required.yaml
    - skip_no_log_sanity_error.yaml
    - terminal_stderr_delete.yml
    modules:
    - description: BGP Address Family Resource Module.
      name: vyos_bgp_address_family
      namespace: ''
    release_date: '2021-03-30'
  2.2.0:
    changes:
      minor_changes:
      - Add support for available_network_resources key, which allows to fetch the
        available resources for a platform (https://github.com/ansible-collections/vyos.vyos/issues/138).
      security_fixes:
      - Mask values of sensitive keys in module result.
    fragments:
    - 147-add_ignore_txt.yml
    - 160_available_network_resources.yaml
    - no_log_mask.yaml
    - remove-old-test-deps.yml
    release_date: '2021-04-27'
  2.3.0:
    changes:
      bugfixes:
      - change admin_distance to distance while generating static_routes nexthop command.
      - firewall_global - port-groups were not added (https://github.com/ansible-collections/vyos.vyos/issues/107)
      minor_changes:
      - Add vyos_route_maps resource module (https://github.com/ansible-collections/vyos.vyos/pull/156.).
    fragments:
    - changelog_doc_path_update.yaml
    - fix_delete_route_maps.yaml
    - fix_port_groups.yaml
    - fix_static_routes_distance.yaml
    - vyos-route-maps.yaml
    modules:
    - description: Route Map Resource Module.
      name: vyos_route_maps
      namespace: ''
    release_date: '2021-05-18'
  2.3.1:
    changes:
      bugfixes:
      - Fix KeyError 'source' - vyos_firewall_rules
      - Updated docs resolving spelling typos
      - change interface to next-hop-interface while generating static_routes nexthop
        command.
    fragments:
    - 172-fix-source-keyerror-firewallrules.yml
    - docs_common_error_correction.yaml
    - fix_static_routes_next_hop_interface.yaml
    - update_readme_freenode_to_liberachat.yml
    release_date: '2021-06-22'
  2.4.0:
    changes:
      minor_changes:
      - Add vyos_prefix_lists Resource Module.
    fragments:
    - vyos_prefix_lists.yml
    modules:
    - description: Prefix-Lists resource module for VyOS
      name: vyos_prefix_lists
      namespace: ''
    release_date: '2021-07-06'
  2.5.0:
    changes:
      bugfixes:
      - fix issue in route-maps facts code when route-maps facts are empty.
      deprecated_features:
      - The vyos_logging module has been deprecated in favor of the new vyos_logging_global
        resource module and will be removed in a release after "2023-08-01".
      minor_changes:
      - vyos_logging_global logging resource module.
    fragments:
    - fix_issue_vyos_facts.yaml
    - vyos_logging_global_module.yaml
    release_date: '2021-07-26'
  2.5.1:
    changes:
      bugfixes:
      - fix issue in firewall rules facts code when IPV6 ICMP type name in vyos.vyos.vyos_firewall_rules
        is not idempotent
    fragments:
    - doc_updated_correct_platform.yaml
    - fix_issue170_vyos_firewall_rules.yaml
    - fix_pylint_issues.yaml
    - tests_become.yaml
    release_date: '2021-08-27'
  2.6.0:
    changes:
      bugfixes:
      - Fix vyos_firewall_rules with state replaced to only replace the specified
        rules.
      minor_changes:
      - Add vyos_ntp Resource Module
      - Adds support for specifying an `afi` for an `address_group` for `vyos.vyos.firewall_global`.  As
        a result, `address_group` now supports IPv6.
      - Adds support for specifying an `afi` for an `network_group` for `vyos.vyos.firewall_global`.  As
        a result, `network_group` now supports IPv6.
    fragments:
    - 0-copy_ignore_txt.yml
    - fix-firewall_rules-state-replaced.yaml
    - set_allow_duplicates.yaml
    - support_ipv6_address_and_network_groups.yaml
    - vyos_ntp.yml
    release_date: '2021-10-02'