Document prompt ability for network/*_command modules

[IPvSean]

ISSUE TYPE

• Documentation Report

COMPONENT NAME

ios_command
vyos_command
nxos_command
iosxr_command
junos_command
eos_command

ANSIBLE VERSION

N/A

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A

SUMMARY

Referring to this thread: #32989

There seems to be an ability to use prompt->

  aireos_command:
        provider: "{{ creds }}"
        commands:
             - transfer download start
         prompt: "Are you sure you want to start\? \(y\/N\)"
         response: y
         wait_for: response[0] contains "File transfer is successful"

This looks like there is a command level parameter prompt. In the latest dev... I think this is actually documented on ios_command but not the others. We need to show some more examples in the module documentation, and possibly add something to the ansible networking guide as well, as this is a common ask.

STEPS TO REPRODUCE

N/A

EXPECTED RESULTS

N/A

ACTUAL RESULTS

N/A

[ansibot]

Files identified in the description:

• lib/ansible/modules/network/eos/eos_command.py
• lib/ansible/modules/network/ios/ios_command.py
• lib/ansible/modules/network/iosxr/iosxr_command.py
• lib/ansible/modules/network/junos/junos_command.py
• lib/ansible/modules/network/nxos/nxos_command.py
• lib/ansible/modules/network/vyos/vyos_command.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 @Qalthos @ganeshrn @gdpak @mikewiebe @privateip @Qalthos @rahushen @rcarrillocruz @samdoran @trishnaguha
click here for bot help

[gundalow]

In addition:

• Document that multiple prompts can be used
• Document how to escape (for regex matching), see iosxr_command module - Commands that prompt are not sending an answer #39856 for an example

[sweenig]

Yes please, would like to see documentation on how multiple prompts can be used.

[gateszeng]

I think I have a potential workaround.
Although not completely the same, I believe if you know the exact responses that you'd have to give to the prompts then you can insert those responses after your command, separated by new line characters and double quotes surrounding the entire command.
I tried this on the enos_command module and it worked, although I'd imagine the same thing applies to the other command modules as well.

 - name: CHANGE PASSWORDS
   enos_command:
     provider: "{{ provider }}"
     commands:
       - enable
       - configure terminal
       - "access user 4 password\nADMIN_PASS\nNEW_PASS\nNEW_PASS"

[ansibot]

cc @tstoner
click here for bot help

[sweenig]

I tried this with ios_command a few minutes before you posted and it didn't work initially. Then i realized that everyone who had suggested this had put it in quotes and I hadn't. Make sure you try it with quotes.

[ansibot]

cc @NilashishC
click here for bot help

[ansibot]

cc @chrisvanheuveln
click here for bot help

[ansibot]

cc @justjais
click here for bot help

[robdawg925]

Hey all,

Re-opening this thread, looking for some help.

Running Ansible 2.9.1

root@node-0:~# ansible --version
ansible 2.9.1
config file = /etc/ansible/ansible.cfg
configured module search path = ['/home/student/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
ansible python module location = /usr/local/lib/python3.6/dist-packages/ansible
executable location = /usr/local/bin/ansible
python version = 3.6.8 (default, Oct 7 2019, 12:59:55) [GCC 8.3.0]

I am trying to remove ‘feature npv’ on a Nexus switch. When running the command ‘no feature npv’ on the switch manually you get the following prompt:
Verify that boot variables are set and the changes are saved. Disabling npv mode erases the current configuration and reboots the switch in non-npv mode. Do you want to continue? (y/n):

Because I am not able to respond this prompt, when I run the ‘no feature npv’ command it times out. Below is my playbook:

• name: Play 1
  hosts: ucs_5ks
  connection: local
  gather_facts: no
  tasks:

  • name: interface
    nxos_command:
    commands:
    - config t
    - no feature npv

Looking at this thread I also tried the following, but it still fails.

name: Play 1
hosts: ucs_5ks
connection: local
gather_facts: no
tasks:

• name: interface
  nxos_command:
  commands:
  - config t
  - "no feature npv/ny"

I also tried using the nxos_feature module. My yaml file works for other features but does not work when I try enable/disable npv due to the prompt issues.

It also looks like I can't use 'prompt' when working with nxos_command.

Any ideas?

[chrisvanheuveln]

This might work for avoiding the user prompt:

name: interface
nxos_config:
  lines: |
    term dont-ask
    no feature npv/ny
    no term dont-ask

Ref:
https://www.cisco.com/c/en/us/td/docs/switches/datacenter/nexus9000/sw/6-x/command_reference/config_612I22/b_n9k_command_ref/b_n9k_command_ref_chapter_010110.html#wp3962612674

[robdawg925]

Thanks @chrisvanheuveln. Unfortunately looks like I still get the prompt.

PoD1-N5K-1(config)# term dont-ask
PoD1-N5K-1(config)# no feature npv
Verify that boot variables are set and the changes are saved. Disabling npv mode erases the current configuration and reboots the switch in non-npv mode. Do you want to continue? (y/n):

[ganeshrn]

@sweenig You can use cli_command module that handles single as well as multiple prompts.

@robdawg925
The format for nxos_command module to handle prompt in this case is

  - name: run commands that require answering a prompt
    nxos_command:
      commands:
        - configure terminal
        - command: 'no feature npv'
          prompt: 'Do you want to continue'
          answer: 'y'

Note: The value of the prompt option is a Python regex hence special characters like ? should be handled with escape charterers if required.

[ganeshrn]

needs_info

[robdawg925]

@ganeshrn thanks. That worked! The command get executed on the switch. The only thing is the task in playbook gets a timeout error because the switch reboots write after the command.

[ansibot]

@IPvSean This issue is waiting for your response. Please respond or the issue will be closed.

click here for bot help

[IPvSean]

@robdawg925 does this help? https://www.ansible.com/blog/rebooting-network-devices-with-ansible

use the reset

- name: reset the connection
  meta: reset_connection

[IPvSean]

this is a documentation bug, @samccann could we get examples from the blog post into module docs to help close this out?