Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nxos_config does not allow block replace when providing src rather than lines #89

Closed
mjhorndotnet opened this issue Jun 11, 2020 · 1 comment · Fixed by #768
Closed
Assignees
Labels
has_pr This issue has an associated PR.
Milestone

Comments

@mjhorndotnet
Copy link

mjhorndotnet commented Jun 11, 2020

SUMMARY

When using the nxos_config module and providing the desired config via a template passed to the src argument, any differences are replaced line by line. Trying to set replace=block throws the following error:

msg: 'replace is block but all of the following are missing: lines'

This can cause issues such as in my use case of managing route-maps. The template generates a route-map configuration. If existing config does not match, I need to first remove the existing configuration, before attempting to apply the new config. Otherwise the net result can be unpredictable as the route-map configs are not atomic.

ISSUE TYPE
  • Bug Report
COMPONENT NAME

nxos_config module

ANSIBLE VERSION
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/mhorn/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/dist-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.15rc1 (default, Apr 15 2018, 21:51:34) [GCC 7.3.0]

CONFIGURATION

OS / ENVIRONMENT

Behavior appears independent of nxos version, have tested against 6.x 7.x and 9.x

STEPS TO REPRODUCE

route-map.j2

route-map test permit 10
  description "First Sequence"
route-map test permit 20
  description "second sequence"

test.yml

---
- hosts: lab1-n-excsw01
  gather_facts: no
  tasks:
    - name: Apply route-map
      nxos_config:
        src: route-map.j2
        before: "no route-map test"
        replace: block
        save_when: changed
        diff_against: running
EXPECTED RESULTS

If the running config matches, no changes are made. If it does not match, the 'before' parameter of 'no route-map test' is run, and then all lines of the the src template are configured

ACTUAL RESULTS

Run as above, the following error is thrown:
msg: 'replace is block but all of the following are missing: lines'

Run without 'replace=block', results are not consistent. For example, running the above when only the first sequence exists first removes the route-map, but then only applies the missing second sequence. Repeated runs will oscillate between one section of the config or the other being applied, but never the desired config in it's entirety.

root@localhost:/etc/ansible$ ansible-playbook -i inventory/lab test.yml --diff

PLAY [lab1-n-excsw01] ****************************************************************************************************************************************

TASK [Apply route-map] ***************************************************************************************************************************************
--- before
+++ after
@@ -80,8 +80,8 @@
-route-map test permit 10
-  description "First Sequence"
+route-map test permit 20
+  description "second sequence"

changed: [lab1-n-excsw01]

PLAY RECAP ***************************************************************************************************************************************************
lab1-n-excsw01             : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

root@localhost:/etc/ansible$ ansible-playbook -i inventory/lab test.yml --diff

PLAY [lab1-n-excsw01] ****************************************************************************************************************************************

TASK [Apply route-map] ***************************************************************************************************************************************
--- before
+++ after
@@ -80,8 +80,8 @@
-route-map test permit 20
-  description "second sequence"
+route-map test permit 10
+  description "First Sequence"

changed: [lab1-n-excsw01]

PLAY RECAP ***************************************************************************************************************************************************
lab1-n-excsw01             : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

root@localhost:/etc/ansible$ ansible-playbook -i inventory/lab test.yml --diff

PLAY [lab1-n-excsw01] ****************************************************************************************************************************************

TASK [Apply route-map] ***************************************************************************************************************************************
--- before
+++ after
@@ -80,8 +80,8 @@
-route-map test permit 10
-  description "First Sequence"
+route-map test permit 20
+  description "second sequence"

changed: [lab1-n-excsw01]

PLAY RECAP ***************************************************************************************************************************************************
lab1-n-excsw01             : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

@Qalthos Qalthos self-assigned this Jun 17, 2020
@GomathiselviS GomathiselviS added this to the March'21 milestone Jan 27, 2021
@Qalthos Qalthos added this to To do in Networking Project Board via automation Jul 27, 2021
@Qalthos Qalthos moved this from To do to In progress in Networking Project Board Jul 27, 2021
@NilashishC NilashishC added the has_pr This issue has an associated PR. label Aug 9, 2021
@i-m-d
Copy link

i-m-d commented Sep 22, 2022

Hello,

Is this problem resolved ?
if yes, in which version ?
if not, when will be avaible ?

Thank you.

Networking Project Board automation moved this from In progress to Done Oct 25, 2023
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Jan 18, 2024
v9.1.0

ansible.utils
~~~~~~~~~~~~~

- Fact_diff filter plugin - Add fact_diff filter plugin. (ansible-collections/ansible.utils#78).

ansible.windows
~~~~~~~~~~~~~~~

- Set minimum supported Ansible version to 2.14 to align with the versions still supported by Ansible.
- win_share - Added a new param called ``scope_name`` that allows file shares to be scoped for Windows Server failover cluster roles.

cisco.ios
~~~~~~~~~

- Added ios_evpn_evi resource module.
- Added ios_evpn_global resource module.
- Added ios_vxlan_vtep resource module.
- Fixed ios_evpn_evi resource module integration test failure - code to remove VLAN config.
- ios_bgp_address_family - Fixed an issue with inherit peer-policy CLI
- ios_bgp_address_family - added 'advertise' key
- ios_vlans - added vlan config CLI feature.
- ios_vrf - added MDT related keys

cisco.ise
~~~~~~~~~

- Services included configuration, edda, dataconnect_services, subscriber.

cisco.nxos
~~~~~~~~~~

- nxos_config - Relax restrictions on I(src) parameter so it can be used more like I(lines). (ansible-collections/cisco.nxos#89).

community.general
~~~~~~~~~~~~~~~~~

- bitwarden lookup plugin - when looking for items using an item ID, the item is now accessed directly with ``bw get item`` instead of searching through all items. This doubles the lookup speed (ansible-collections/community.general#7468).
- elastic callback plugin - close elastic client to not leak resources (ansible-collections/community.general#7517).
- git_config - allow multiple git configs for the same name with the new ``add_mode`` option (ansible-collections/community.general#7260).
- git_config - the ``after`` and ``before`` fields in the ``diff`` of the return value can be a list instead of a string in case more configs with the same key are affected (ansible-collections/community.general#7260).
- git_config - when a value is unset, all configs with the same key are unset (ansible-collections/community.general#7260).
- gitlab modules - add ``ca_path`` option (ansible-collections/community.general#7472).
- gitlab modules - remove duplicate ``gitlab`` package check (ansible-collections/community.general#7486).
- gitlab_runner - add support for new runner creation workflow (ansible-collections/community.general#7199).
- ipa_config - adds ``passkey`` choice to ``ipauserauthtype`` parameter's choices (ansible-collections/community.general#7588).
- ipa_sudorule - adds options to include denied commands or command groups (ansible-collections/community.general#7415).
- ipa_user - adds ``idp`` and ``passkey`` choice to ``ipauserauthtype`` parameter's choices (ansible-collections/community.general#7589).
- irc - add ``validate_certs`` option, and rename ``use_ssl`` to ``use_tls``, while keeping ``use_ssl`` as an alias. The default value for ``validate_certs`` is ``false`` for backwards compatibility. We recommend to every user of this module to explicitly set ``use_tls=true`` and `validate_certs=true`` whenever possible, especially when communicating to IRC servers over the internet (ansible-collections/community.general#7550).
- keycloak module utils - expose error message from Keycloak server for HTTP errors in some specific situations (ansible-collections/community.general#7645).
- keycloak_user_federation - add option for ``krbPrincipalAttribute`` (ansible-collections/community.general#7538).
- lvol - change ``pvs`` argument type to list of strings (ansible-collections/community.general#7676, ansible-collections/community.general#7504).
- lxd connection plugin - tighten the detection logic for lxd ``Instance not found`` errors, to avoid false detection on unrelated errors such as ``/usr/bin/python3: not found`` (ansible-collections/community.general#7521).
- netcup_dns - adds support for record types ``OPENPGPKEY``, ``SMIMEA``, and ``SSHFP`` (ansible-collections/community.general#7489).
- nmcli - add support for new connection type ``loopback`` (ansible-collections/community.general#6572).
- nmcli - allow for ``infiniband`` slaves of ``bond`` interface types (ansible-collections/community.general#7569).
- nmcli - allow for the setting of ``MTU`` for ``infiniband`` and ``bond`` interface types (ansible-collections/community.general#7499).
- onepassword lookup plugin - support 1Password Connect with the opv2 client by setting the connect_host and connect_token parameters (ansible-collections/community.general#7116).
- onepassword_raw lookup plugin - support 1Password Connect with the opv2 client by setting the connect_host and connect_token parameters (ansible-collections/community.general#7116)
- passwordstore - adds ``timestamp`` and ``preserve`` parameters to modify the stored password format (ansible-collections/community.general#7426).
- proxmox - adds ``template`` value to the ``state`` parameter, allowing conversion of container to a template (ansible-collections/community.general#7143).
- proxmox - adds ``update`` parameter, allowing update of an already existing containers configuration (ansible-collections/community.general#7540).
- proxmox inventory plugin - adds an option to exclude nodes from the dynamic inventory generation. The new setting is optional, not using this option will behave as usual (ansible-collections/community.general#6714, ansible-collections/community.general#7461).
- proxmox_disk - add ability to manipulate CD-ROM drive (ansible-collections/community.general#7495).
- proxmox_kvm - adds ``template`` value to the ``state`` parameter, allowing conversion of a VM to a template (ansible-collections/community.general#7143).
- proxmox_kvm - support the ``hookscript`` parameter (ansible-collections/community.general#7600).
- proxmox_ostype - it is now possible to specify the ``ostype`` when creating an LXC container (ansible-collections/community.general#7462).
- proxmox_vm_info - add ability to retrieve configuration info (ansible-collections/community.general#7485).
- redfish_info - adding the ``BootProgress`` property when getting ``Systems`` info (ansible-collections/community.general#7626).
- ssh_config - adds ``controlmaster``, ``controlpath`` and ``controlpersist`` parameters (ansible-collections/community.general#7456).

community.routeros
~~~~~~~~~~~~~~~~~~

- api_info, api_modify - add missing DoH parameters ``doh-max-concurrent-queries``, ``doh-max-server-connections``, and ``doh-timeout`` to the ``ip dns`` path (ansible-collections/community.routeros#230, ansible-collections/community.routeros#235)
- api_info, api_modify - add missing parameters ``address-list``, ``address-list-timeout``, ``randomise-ports``, and ``realm`` to subpaths of the ``ip firewall`` path (ansible-collections/community.routeros#236, ansible-collections/community.routeros#237).
- api_info, api_modify - mark the ``interface wireless`` parameter ``running`` as read-only (ansible-collections/community.routeros#233).
- api_info, api_modify - set the default value to ``false`` for the  ``disabled`` parameter in some more paths where it can be seen in the documentation (ansible-collections/community.routeros#237).
- api_modify - add missing ``comment`` attribute to ``/routing id`` (ansible-collections/community.routeros#234).
- api_modify - add missing attributes to the ``routing bgp connection`` path (ansible-collections/community.routeros#234).
- api_modify - add versioning to the ``/tool e-mail`` path (RouterOS 7.12 release) (ansible-collections/community.routeros#234).
- api_modify - make ``/ip traffic-flow target`` a multiple value attribute (ansible-collections/community.routeros#234).

community.windows
~~~~~~~~~~~~~~~~~

- Set minimum supported Ansible version to 2.14 to align with the versions still supported by Ansible.

community.zabbix
~~~~~~~~~~~~~~~~

- Added zabbix_group_events_info module
- action module - Added notify_if_canceled property
- agent and proxy roles - Set default `zabbix_api_server_port` to 80 or 443 based on `zabbix_api_use_ssl`
- agent role - Removed duplicative Windows agent task
- agent role - Standardized default yum priority to 99
- all roles - Re-added ability to override Debian repo source
- all roles - Updated Debian repository format to 822 standard
- various - updated testing modules
- various - updated to fully qualified module names
- zabbix agent - Added capability to add additional configuration includes
- zabbix_api_info module added
- zabbix_user module - add current_passwd optional parameter to enable password updating of the currently logged in user (https://www.zabbix.com/documentation/6.4/en/manual/api/reference/user/update)

dellemc.powerflex
~~~~~~~~~~~~~~~~~

- Added support for PowerFlex Denver version(4.5.x) to TB and Config role.

f5networks.f5_modules
~~~~~~~~~~~~~~~~~~~~~

- bigiq_device_discovery - Changes in documentation related to Provider block

google.cloud
~~~~~~~~~~~~

- anisble-test - integration tests are now run against 2.14.0 and 2.15.0
- ansible - 2.14.0 is now the minimum version supported
- ansible-lint - fixed over a thousand reported errors
- ansible-lint - upgraded to 6.22
- ansible-test - add support for GCP application default credentials (ansible-collections/google.cloud#359).
- gcp_serviceusage_service - added backoff when checking for operation completion.
- gcp_serviceusage_service - use alloyb API for the integration test as spanner conflicts with other tests
- gcp_sql_ssl_cert - made sha1_fingerprint optional, which enables resource creation
- gcp_storage_default_object_acl - removed non-existent fields; the resource is not usable.

hetzner.hcloud
~~~~~~~~~~~~~~

- Add the `hetzner.hcloud.all` group to configure all the modules using `module_defaults`.
- Allow to set the `api_endpoint` module argument using the `HCLOUD_ENDPOINT` environment variable.
- Removed the `hcloud_` prefix from all modules names, e.g. `hetzner.hcloud.hcloud_firewall` was renamed to `hetzner.hcloud.firewall`. Old module names will continue working.
- Renamed the `endpoint` module argument to `api_endpoint`, backward compatibility is maintained using an alias.
- hcloud inventory - Add the `api_endpoint` option.
- hcloud inventory - Deprecate the `api_token_env` option, suggest using a lookup plugin (`{{ lookup('ansible.builtin.env', 'YOUR_ENV_VAR') }}`) or use the well-known `HCLOUD_TOKEN` environment variable name.
- hcloud inventory - Rename the `token_env` option to `api_token_env`, use aliases for backward compatibility.
- hcloud inventory - Rename the `token` option to `api_token`, use aliases for backward compatibility.

inspur.ispim
~~~~~~~~~~~~

- Modify edit_smtp_com and add description information.

microsoft.ad
~~~~~~~~~~~~

- Make ``name`` an optional parameter for the AD modules. Either ``name`` or ``identity`` needs to be set with their respective behaviours. If creating a new AD user and only ``identity`` is set, that will be the value used for the name of the object.
- Set minimum supported Ansible version to 2.14 to align with the versions still supported by Ansible.
- object_info - Add ActiveDirectory module import

purestorage.flasharray
~~~~~~~~~~~~~~~~~~~~~~

- purefa_dns - Added facility to add a CA certifcate to management DNS and check peer.
- purefa_info - Add NSID value for NVMe namespace in `hosts` response
- purefa_info - Subset `pgroups` now also provides a new dict called `deleted_pgroups`
- purefa_offload - Remove `nfs` as an option when Purity//FA 6.6.0 or higher is detected
- purefa_snap - Add support for suffix on remote offload snapshots

telekom_mms.icinga_director
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Extended docs and examples for multiple assign_filter conditions (telekom-mms/ansible-collection-icinga-director#227)

theforeman.foreman
~~~~~~~~~~~~~~~~~~

- content_view_publish role - allow passing ``async`` and ``poll`` to the module (theforeman/foreman-ansible-modules#1676)
- convert2rhel role - install ``convert2rhel`` from ``cdn-public.redhat.com``, dropping the requirement of a custom CA cert
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has_pr This issue has an associated PR.
Projects
Development

Successfully merging a pull request may close this issue.

5 participants