Fix subprompts 'None' stringification in call to send_command

[bdowling]

send_command already performs the to_bytes safely on prompts (checking for None). Without this check the literal 'None' became a subprompt trigger!

SUMMARY

The call to send_command in ios edit_config was interning prompts=None to the literal string 'None' causing any output from the device to be scanned for a subprompt None and sending 'None' back as the answer was also 'None'.

Since send_command already does a safer to_bytes() on these parameters, I removed the unneccessary calls in cliconf/ios.py

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

cliconf/ios.py
network_cli

ANSIBLE VERSION

devel

ADDITIONAL INFORMATION

Example play that triggered this bug:

---

- hosts: onerouter
  gather_facts: no
  connection: network_cli

  tasks:
  - name: Set Interfaces Descriptions

    ios_config:
      parents: "interface GigabitEthernet1"
      lines:
        - description "Interface tag triggers a prompt response [None]"

[ansibot]

cc @Qalthos @ganeshrn @gundalow @kedarX @privateip @rcarrillocruz @trishnaguha
click here for bot help

[bdowling]

Debug of the error (with extra local debug turned on):

CLI-SUBPROMPT: Matched 'None', sent '<answer>\r'
CLI-PROMPT: looking for prompts in [63]| description "Interface tag triggers a prompt response [None]"\r\nbd-csr1000v-00(config-if)#
CLI-PROMPT: Matched Standard Prompt '[\r\n][\w\+\-\.:\/\[\]]+(?:\([^\)]+\)){0,3}(?:[>#]) ?$'
CLI-RECV:
CLI-SEND: end\r
cli command_timeout extended on new data
CLI-PROMPT: looking for prompts in [1]| N
cli command_timeout extended on new data
CLI-PROMPT: looking for prompts in [2]| No
cli command_timeout extended on new data
CLI-PROMPT: looking for prompts in [3]| Non
cli command_timeout extended on new data
CLI-PROMPT: looking for prompts in [4]| None
CLI-SUBPROMPT: Matched 'None', sent '<answer>\r'
cli command_timeout extended on new data
CLI-PROMPT: looking for prompts in [5]| None\r\n
cli command_timeout extended on new data
CLI-PROMPT: looking for prompts in [6]| None\r\n                            ^\r\n% Invalid input detected at '^' marker.\r\n\r\nbd-csr1000v-00(config-if)#
CLI-PROMPT: Matched Error Prompt 'invalid input'
CLI-PROMPT: Matched Standard Prompt (after error) '[\r\n][\w\+\-\.:\/\[\]]+(?:\([^\)]+\)){0,3}(?:[>#]) ?$'
done communicating
done with local.exec_command()
_low_level_execute_command() done: rc=1, stdout=, stderr=Traceback (most recent call last):
  File "/tmp/ansible_avtyI6/ansible_module_ios_config.py", line 551, in <module>    main()
  File "/tmp/ansible_avtyI6/ansible_module_ios_config.py", line 480, in main    load_config(module, commands)
  File "/tmp/ansible_avtyI6/ansible_modlib.zip/ansible/module_utils/network/ios/ios.py", line 162, in load_config
  File "/tmp/ansible_avtyI6/ansible_modlib.zip/ansible/module_utils/connection.py", line 146, in __rpc__
ansible.module_utils.connection.ConnectionError: None
                            ^
% Invalid input detected at '^' marker.

bd-csr1000v-00(config-if)#

[bdowling]

Note: I don't see other places where the caller uses to_bytes on the prompts, but there are a couple of occurrences of to_bytes on the command being sent. (Also redundant with what send_command already covers).

$ git grep 'send_command.*to_bytes'
lib/ansible/plugins/cliconf/dellos10.py:            self.send_command(to_bytes(cmd))
lib/ansible/plugins/cliconf/iosxr.py:        self.send_command(to_bytes(command))
lib/ansible/plugins/cliconf/vyos.py:            self.send_command(to_bytes(cmd))
lib/ansible/plugins/cliconf/vyos.py:        self.send_command(to_bytes(command))

[Qalthos]

That's what I get for forgetting how I've fixed it elsewhere. This is of course preferred, pushing the translation to the last point in common code.