Fix nxos action plugin for nxos_install_os #53768

mikewiebe · 2019-03-13T20:24:13Z

SUMMARY

Fix checks the connection type before attempting to determine the current values for PERSISTENT_COMMAND_TIMEOUT and PERSISTENT_CONNECT_TIMEOUT
Adds additional debug information to display the TIMEOUT values on failure.
Adds current timer values to the verbose -vvvv output.

NOTE: For connection: local (cli) or (nxapi) setting vars in the playbook task or passing via the -e argument have no effect. Setting environment variables or setting ansible.cfg however, do work.

I am open to suggestions about how we get playbook task vars to take effect for connection: local (cli) or (nxapi).

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

nxos_install_os

ADDITIONAL INFORMATION

The following tests were run to validate this fix.

CONNECTION: network_cli

TESTCASE: Timers NOT set

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin network_cli
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/bcc36897f8
<n9k> PERSISTENT_COMMAND_TIMEOUT is 30
<n9k> PERSISTENT_CONNECT_TIMEOUT is 30

TESTCASE: Timers set using ENV vars

(py2-ansible) $env | grep ANSIBLE_PERS
ANSIBLE_PERSISTENT_COMMAND_TIMEOUT=600
ANSIBLE_PERSISTENT_CONNECT_TIMEOUT=600

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin network_cli
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/4ac6359588
<n9k> PERSISTENT_COMMAND_TIMEOUT is 600
<n9k> PERSISTENT_CONNECT_TIMEOUT is 600

TESTCASE: Timers set using ansible.cfg

$cat /etc/ansible/ansible.cfg 
[persistent_connection]
connect_timeout=800
command_timeout=800

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin network_cli
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/c700b6b398
<n9k> PERSISTENT_COMMAND_TIMEOUT is 800
<n9k> PERSISTENT_CONNECT_TIMEOUT is 800

TESTCASE: Timers set using vars in playbook task

- name: "Install OS image {{ si }}"
  check_mode: "{{ checkmode }}"
  nxos_install_os:
    system_image_file: "{{ si }}"
    issu: "{{ issu }}"
    provider: "{{ connection }}"
  vars:
    ansible_command_timeout: 700
    ansible_connect_timeout: 700

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin network_cli
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/e8335c6594
<n9k> PERSISTENT_COMMAND_TIMEOUT is 700
<n9k> PERSISTENT_CONNECT_TIMEOUT is 700

TESTCASE: Timers set by passing them in to ansible-playbook using -e option

ansible-playbook nxos.yaml -e "ansible_command_timeout=1000 ansible_connect_timeout=900"

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin network_cli
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/01ee8deb61
<n9k> PERSISTENT_COMMAND_TIMEOUT is 1000
<n9k> PERSISTENT_CONNECT_TIMEOUT is 900

CONNECTION: httpapi

TESTCASE: Timers NOT set

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin httpapi
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/11c4d12331
<n9k> PERSISTENT_COMMAND_TIMEOUT is 30
<n9k> PERSISTENT_CONNECT_TIMEOUT is 30

TESTCASE: Timers set using ENV vars

(py2-ansible) $env | grep ANSIBLE_PERS
ANSIBLE_PERSISTENT_COMMAND_TIMEOUT=600
ANSIBLE_PERSISTENT_CONNECT_TIMEOUT=600

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin httpapi
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/0606e69189
<n9k> PERSISTENT_COMMAND_TIMEOUT is 600
<n9k> PERSISTENT_CONNECT_TIMEOUT is 600

TESTCASE: Timers set using ansible.cfg

$cat /etc/ansible/ansible.cfg 
[persistent_connection]
connect_timeout=800
command_timeout=800

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin httpapi
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/9012e40de0
<n9k> PERSISTENT_COMMAND_TIMEOUT is 800
<n9k> PERSISTENT_CONNECT_TIMEOUT is 800

TESTCASE: Timers set using vars in playbook task

- name: "Install OS image {{ si }}"
  check_mode: "{{ checkmode }}"
  nxos_install_os:
    system_image_file: "{{ si }}"
    issu: "{{ issu }}"
    provider: "{{ connection }}"
  vars:
    ansible_command_timeout: 700
    ansible_connect_timeout: 700

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin httpapi
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/b9d0d42858
<n9k> PERSISTENT_COMMAND_TIMEOUT is 700
<n9k> PERSISTENT_CONNECT_TIMEOUT is 700

TESTCASE: Timers set by passing them in to ansible-playbook using -e option

ansible-playbook nxos.yaml -e "ansible_command_timeout=1000 ansible_connect_timeout=900"

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> attempting to start connection
<n9k> using connection plugin httpapi
<n9k> found existing local domain socket, using it!
<n9k> updating play_context for connection
<n9k> 
<n9k> local domain socket path is /Users/mwiebe/.ansible/pc/8bf7088d5a
<n9k> PERSISTENT_COMMAND_TIMEOUT is 1000
<n9k> PERSISTENT_CONNECT_TIMEOUT is 900

CONNECTION: local (cli)

TESTCASE: Timers NOT set

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> PERSISTENT_COMMAND_TIMEOUT is 30
<n9k> PERSISTENT_CONNECT_TIMEOUT is 30

TESTCASE: Timers set using ENV vars

(py2-ansible) $env | grep ANSIBLE_PERS
ANSIBLE_PERSISTENT_COMMAND_TIMEOUT=600
ANSIBLE_PERSISTENT_CONNECT_TIMEOUT=600

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> PERSISTENT_COMMAND_TIMEOUT is 600
<n9k> PERSISTENT_CONNECT_TIMEOUT is 600

TESTCASE: Timers set using ansible.cfg

$cat /etc/ansible/ansible.cfg 
[persistent_connection]
connect_timeout=800
command_timeout=800

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> PERSISTENT_COMMAND_TIMEOUT is 800
<n9k> PERSISTENT_CONNECT_TIMEOUT is 800

TESTCASE: Timers set using vars in playbook task - FAILED

- name: "Install OS image {{ si }}"
  check_mode: "{{ checkmode }}"
  nxos_install_os:
    system_image_file: "{{ si }}"
    issu: "{{ issu }}"
    provider: "{{ connection }}"
  vars:
    ansible_command_timeout: 700
    ansible_connect_timeout: 700

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> PERSISTENT_COMMAND_TIMEOUT is 30
<n9k> PERSISTENT_CONNECT_TIMEOUT is 30

TESTCASE: Timers set by passing them in to ansible-playbook using -e option - FAILED

ansible-playbook nxos.yaml -e "ansible_command_timeout=1000 ansible_connect_timeout=900"

TASK [nxos_install_os : Install OS image nxos.7.0.3.I7.4.bin] ***************************************************************************************************************************************************************
task path: /Users/mwiebe/Projects/nxos_ansible/fix_ansible/test/integration/targets/nxos_install_os/tasks/upgrade/install_system.yaml:2
<n9k> PERSISTENT_COMMAND_TIMEOUT is 30
<n9k> PERSISTENT_CONNECT_TIMEOUT is 30

CONNECTION: local (nxapi)

Same results as CONNECTION: local (cli)

ansibot · 2019-03-13T22:47:52Z

cc @NilashishC @Qalthos @ganeshrn @gdpak @justjais @rcarrillocruz @trishnaguha
click here for bot help

trishnaguha · 2019-03-14T07:44:19Z

lib/ansible/plugins/action/nxos.py

            connection = self._connection
-            if connection.get_option('persistent_command_timeout') < 600 or connection.get_option('persistent_connect_timeout') < 600:
+            if connection.transport == 'local':


@mikewiebe Can you update the module docs which states, if someone wants to set the timeouts as config task variable network_cli/httpapi connection plugin is required. local only supports these timeout values with ansible.cfg or env var.

Yes, I can do that.

ansibot · 2019-03-14T14:46:21Z

cc @GGabriele @chrisvanheuveln @jedelman8 @rahushen
click here for bot help

mikewiebe · 2019-03-15T19:11:34Z

@trishnaguha Can we go ahead and merge this?

trishnaguha

Thanks @mikewiebe

* Fix nxos action plugin for nxos_install_os * Update module docs (cherry picked from commit 4c2a3bf)

fcam-naveen · 2019-04-04T23:06:42Z

Which version of Ansible this fix is available?

fcam-naveen · 2019-04-05T00:03:53Z

I just copied this file alone, it fails like this

TASK [Install OS on N6k] ***************************************************************************************************************************************************
task path: /Users/nsekhar/Work/virtual-env/myansible/cisco/nxos_upgrade.yaml:321
The full traceback is:
Traceback (most recent call last):
File "/Users/nsekhar/Work/virtual-env/myansible/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 106, in run
item_results = self._run_loop(items)
File "/Users/nsekhar/Work/virtual-env/myansible/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 343, in _run_loop
res = self._execute(variables=task_vars)
File "/Users/nsekhar/Work/virtual-env/myansible/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 563, in _execute
self._handler = self._get_action_handler(connection=self._connection, templar=templar)
File "/Users/nsekhar/Work/virtual-env/myansible/lib/python2.7/site-packages/ansible/executor/task_executor.py", line 929, in _get_action_handler
shared_loader_obj=self._shared_loader_obj,
File "/Users/nsekhar/Work/virtual-env/myansible/lib/python2.7/site-packages/ansible/plugins/loader.py", line 378, in get
self._module_cache[path] = self._load_module_source(name, path)
File "/Users/nsekhar/Work/virtual-env/myansible/lib/python2.7/site-packages/ansible/plugins/loader.py", line 357, in _load_module_source
module = imp.load_source(full_name, path, module_file)
File "/Users/nsekhar/Work/virtual-env/myansible/lib/python2.7/site-packages/ansible/plugins/action/nxos.py", line 29, in
from ansible.plugins.action.network import ActionModule as ActionNetworkModule
ImportError: No module named network

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

trishnaguha · 2019-04-08T10:53:31Z

@fcam-naveen It will be available in 2.7.11 version, not released yet.
If you want to test, please check stable-2.7 branch.
To test stable-2.7, follow these steps:

git clone https://github.com/ansible/ansible.git --single-branch --branch stable-2.7
cd ansible
source hacking/env-setup

Sulemanaaa · 2019-04-16T02:57:23Z

@trishnaguha so there is no way to get this working on 2.7.10? i have to upgrade 60 + switches and would love to automate this. I am getting the same error as in this post and looking for a fix :)

trishnaguha · 2019-04-16T04:51:34Z

@Sulemanaaa We don't backport fixes to the version that is already released. For a stable release you will have to wait for 2.7.11 to release. Your patience will be much appreciated :-).

However you can still pull stable-2.7 branch from github locally and use it until 2.7.11 is released to get this fix working.

git clone -b stable-2.7 https://github.com/ansible/ansible.git
cd ansible
source hacking/env-setup

ansible --version will now point to ansible 2.7.10.post0

This will enable stable-2.7 version of ansible on your local environment for that specific terminal session.
To disable it, just exit that terminal session.

Hope this helps!

Sulemanaaa · 2019-04-16T05:27:19Z

Thank you @trishnaguha tried the steps and getting:

self.local_index = Environment(self.shadow_path + sys.path)
error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: Setup script exited with error: [Errno 63] File name too long: '/var/folders/ch/bvvgyn4d41b5psz7vrm24dp40000gn/T/easy_install-orJxko/pip-19.0.3/temp/easy_install-ufCnMK/pip-19.0.3/temp/easy_install-RKPkCi/pip-19.0.3/temp/easy_install-L5X2JN/pip-19.0.3/temp/easy_install-bOrH0j/pip-19.0.3/temp/easy_install-c8S4u9/pip-19.0.3/temp/easy_install-SiXEPb/pip-19.0.3/temp/easy_install-vAUktn/pip-19.0.3/temp/easy_install-YA4lpp/pip-19.0.3/temp/easy_install-XyfSO8/pip-19.0.3/temp/easy_install-OT0C5e/pip-19.0.3/temp/easy_install-2jmdk4/pip-19.0.3/temp/easy_install-mjOsQ4/pip-19.0.3/temp/easy_install-hMpUM_/pip-19.0.3/temp/easy_install-v84ciV/pip-19.0.3/temp/easy_install-bKy5of/pip-19.0.3/temp/easy_install-O7ktai/pip-19.0.3/temp/easy_install-U0lwNa/pip-19.0.3/temp/easy_install-0nd1kW/pip-19.0.3/temp/easy_install-DevX3P/pip-19.0.3/temp/easy_install-XH3XaW/pip-19.0.3/temp/easy_install-Ggiqe8/pip-19.0.3/temp/easy_install-aZ0xIn/pip-19.0.3/temp/easy_install-HY0xTP/pip-19.0.3/temp/easy_install-th9_4d/pip-19.0.3/temp/easy_install-aVvGoL/pip-19.0.3/docs/html/development/configuration.rst'

Setting up Ansible to run out of checkout...

PATH=/Users/sushahid/ansible/bin:/Library/Frameworks/Python.framework/Versions/3.7/bin:/Library/Frameworks/Python.framework/Versions/3.7/bin:/Library/Frameworks/Python.framework/Versions/3.6/bin:/Library/Frameworks/Python.framework/Versions/2.7/bin:/Users/sushahid/anaconda3/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/X11/bin:/usr/local/bin/jamf:/usr/local/git/bin
PYTHONPATH=/Users/sushahid/ansible/lib
MANPATH=/Users/sushahid/ansible/docs/man

Remember, you may wish to specify your host file with -i

Done!

You have mail in /var/mail/sushahid
SUSHAHID-M-91WP:ansible sushahid$
SUSHAHID-M-91WP:ansible sushahid$
SUSHAHID-M-91WP:ansible sushahid$ ansible --version
Traceback (most recent call last):
File "/Users/sushahid/ansible/bin/ansible", line 67, in
import ansible.constants as C
File "/Users/sushahid/ansible/lib/ansible/constants.py", line 11, in
from jinja2 import Template
ImportError: No module named jinja2
SUSHAHID-M-91WP:ansible sushahid$

mikewiebe mentioned this pull request Mar 13, 2019

nxos_install_os ignoring PERSISTENT_COMMAND_TIMEOUT and PERSISTENT_CONNECT_TIMEOUT passed as extra_vars #50626

Closed

trishnaguha self-assigned this Mar 14, 2019

trishnaguha removed the needs_triage Needs a first human triage before being processed. label Mar 14, 2019

trishnaguha mentioned this pull request Mar 14, 2019

[WIP]nxos_install_os connection local fix for persistent timeout values #53793

Closed

trishnaguha reviewed Mar 14, 2019

View reviewed changes

ansibot added the module This issue/PR relates to a module. label Mar 14, 2019

mikewiebe added 2 commits March 15, 2019 10:36

Fix nxos action plugin for nxos_install_os

540aeb4

Update module docs

ffa85c1

mikewiebe force-pushed the rel280/fix_nxos_install_os branch from 7e1bd7c to ffa85c1 Compare March 15, 2019 14:36

trishnaguha approved these changes Mar 18, 2019

View reviewed changes

trishnaguha merged commit 4c2a3bf into ansible:devel Mar 18, 2019

trishnaguha added this to Needs Triage in Networking via automation Mar 18, 2019

trishnaguha pushed a commit to trishnaguha/ansible that referenced this pull request Apr 1, 2019

Fix nxos action plugin for nxos_install_os (ansible#53768)

81c113d

* Fix nxos action plugin for nxos_install_os * Update module docs (cherry picked from commit 4c2a3bf)

abadger pushed a commit that referenced this pull request Apr 4, 2019

Fix nxos action plugin for nxos_install_os (#53768)

0376402

* Fix nxos action plugin for nxos_install_os * Update module docs (cherry picked from commit 4c2a3bf)

ansible locked and limited conversation to collaborators Jul 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix nxos action plugin for nxos_install_os #53768

Fix nxos action plugin for nxos_install_os #53768

mikewiebe commented Mar 13, 2019 •

edited

ansibot commented Mar 13, 2019

trishnaguha Mar 14, 2019 •

edited

mikewiebe Mar 14, 2019

ansibot commented Mar 14, 2019

mikewiebe commented Mar 15, 2019

trishnaguha left a comment

fcam-naveen commented Apr 4, 2019

fcam-naveen commented Apr 5, 2019

trishnaguha commented Apr 8, 2019

Sulemanaaa commented Apr 16, 2019

trishnaguha commented Apr 16, 2019 •

edited

Sulemanaaa commented Apr 16, 2019

Fix nxos action plugin for nxos_install_os #53768

Fix nxos action plugin for nxos_install_os #53768

Conversation

mikewiebe commented Mar 13, 2019 • edited

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

CONNECTION: network_cli

CONNECTION: httpapi

CONNECTION: local (cli)

CONNECTION: local (nxapi)

ansibot commented Mar 13, 2019

trishnaguha Mar 14, 2019 • edited

Choose a reason for hiding this comment

mikewiebe Mar 14, 2019

Choose a reason for hiding this comment

ansibot commented Mar 14, 2019

mikewiebe commented Mar 15, 2019

trishnaguha left a comment

Choose a reason for hiding this comment

fcam-naveen commented Apr 4, 2019

fcam-naveen commented Apr 5, 2019

trishnaguha commented Apr 8, 2019

Sulemanaaa commented Apr 16, 2019

trishnaguha commented Apr 16, 2019 • edited

Sulemanaaa commented Apr 16, 2019

mikewiebe commented Mar 13, 2019 •

edited

trishnaguha Mar 14, 2019 •

edited

trishnaguha commented Apr 16, 2019 •

edited