Crash with KeyError on nxos_config module

[call-tomorrow]

SUMMARY

Playbooks with the presence of nxos_config module parameter 'backup' crashes with KeyError.

ISSUE TYPE

• Bug Report

COMPONENT NAME

nxos_config

ANSIBLE VERSION

ansible 2.8.0
  config file = /home/testuser/ansible/ansible.cfg
  configured module search path = [u'/home/testuser/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.5 (default, Apr  9 2019, 14:30:50) [GCC 4.8.5 20150623 (Red Hat 4.8.5-36)]

CONFIGURATION

ANSIBLE_SSH_ARGS(/home/testuser/ansible/ansible.cfg) = -q
DEFAULT_ASK_PASS(/home/testuser/ansible/ansible.cfg) = True
DEFAULT_FORKS(/home/testuser/ansible/ansible.cfg) = 10
DEFAULT_GATHERING(/home/testuser/ansible/ansible.cfg) = explicit
DEFAULT_HOST_LIST(/home/testuser/ansible/ansible.cfg) = [u'/home/testuser/ansible/inventory/hosts']
DEFAULT_ROLES_PATH(env: ANSIBLE_ROLES_PATH) = [u'/home/testuser/ansible/roles']
HOST_KEY_CHECKING(/home/testuser/ansible/ansible.cfg) = False

OS / ENVIRONMENT

Ansible: CentOS Linux release 7.6.1810
Remote: Cisco Nexus9000

STEPS TO REPRODUCE

- name: Add VLAN to port-profile O1
  nxos_config:
        parents:
                - port-profile type ethernet O1
        lines:
                - switchport trunk allowed vlan add {{ item.vlan_id }}
        backup: yes
        provider: "{{ cli }}"
  register: profile_hm
  with_items: "{{ vlans }}"

EXPECTED RESULTS

Clean execution without errors.

ACTUAL RESULTS

The full traceback is:
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 110, in run
    item_results = self._run_loop(items)
  File "/usr/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 370, in _run_loop
    res = self._execute(variables=task_vars)
  File "/usr/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 648, in _execute
    result = self._handler.run(task_vars=variables)
  File "/usr/lib/python2.7/site-packages/ansible/plugins/action/nxos.py", line 141, in run
    result = super(ActionModule, self).run(task_vars=task_vars)
  File "/usr/lib/python2.7/site-packages/ansible/plugins/action/network.py", line 51, in run
    self._handle_backup_option(result, task_vars)
  File "/usr/lib/python2.7/site-packages/ansible/plugins/action/network.py", line 106, in _handle_backup_option
    result['backup_path'] = copy_result['dest']
KeyError: 'dest'

fatal: [10.99.10.94]: FAILED! => {
    "msg": "Unexpected failure during module execution.", 
    "stdout": ""
}

[ansibot]

Files identified in the description:

• lib/ansible/modules/network/nxos/nxos_config.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

cc @chrisvanheuveln @mikewiebe @privateip @rahushen @rcarrillocruz @trishnaguha
click here for bot help

[ansibot]

@call-tomorrow, just so you are aware we have a dedicated Working Group for network.
You can find other people interested in this in #ansible-network on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

[r1k0]

same exact issue for ios_config using 2.8.0 on RH (upgraded last weekend) no issues with 2.7.5

The full traceback is:
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 144, in run
    res = self._execute()
  File "/usr/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 648, in _execute
    result = self._handler.run(task_vars=variables)
  File "/usr/lib/python2.7/site-packages/ansible/plugins/action/ios.py", line 95, in run
    result = super(ActionModule, self).run(task_vars=task_vars)
  File "/usr/lib/python2.7/site-packages/ansible/plugins/action/network.py", line 51, in run
    self._handle_backup_option(result, task_vars)
  File "/usr/lib/python2.7/site-packages/ansible/plugins/action/network.py", line 106, in _handle_backup_option
    result['backup_path'] = copy_result['dest']
KeyError: 'dest'

edit: turns out I had a library module for ios_config.py that was obsolete in addition to having --check alias on ansible-playbook. Adding backup_options to the role and all is good, no more bugs.

[saurav955]

Had the same issue with ironware_config as well. Removing the check_mode solved it for me.
Thanks r1k0.

[marcosgeorgopoulos]

We are having the same issue with the iOS_config module, we cannot use check mode with it. looks like 2.8 broke something. regression testing.....?

[james-powis]

This is affecting all of the "network" modules... It is a quick and easy fix and I will get a PR submitted by end of the day to fix.

[Yannis100]

I don't know how to proceed to have this fix backported to stable-2.8 branch the same as #63283 for stable-2.9
@ganeshrn I added a comment in your merge request for stable-2.9

I have different issues in 2.7 and 2.8 that prevents me from doing exactly what I want, and as 2.9 is not an option yet, I'm stuck :(