Gns3 iosv telnet #580

Domoninic · 2023-08-05T15:57:50Z

SUMMARY

Add "send_carriage_return" option to send "\r" upon connection similar to existing send-newline.
This add ability to connect to IOSv devices in GNS3 which need get the "/r" as the first character in the telnet connection otherwise the prompt is never found. It seem that a carriage return is required to display the NAG banner after which the prompt is output.
Issue #542 describes similar issue with nag banner on Procurve switches

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

ansible.netcommon.telnet

ADDITIONAL INFORMATION

Using GNS3 a new project is created with a single IOSv router con0 is made available on 198.18.1.200:500.
The last output on the console is "%PLATFORM-5-SIGNATURE_VERIFIED: Image 'flash0:/vios-adventerprisek9-m' passed code signing verification" and the IOSv then waits for a "\r" before display in the NAG and prompt:

IOSv is strictly limited to use for evaluation, demonstration and IOS *
education. IOSv is provided as-is and is not supported by Cisco's *
Technical Advisory Center. Any use or disclosure, in whole or in part, *
of the IOSv Software or Documentation to any third party for any *
purposes is expressly prohibited except as otherwise authorized by *
Cisco in writing. *

Router#

SO using the inventory :-
all:
hosts:
R1:
ansible_host: 198.18.1.200
port: 5000
device_type: "cisco_ios_telnet"
and playbook :-

name: Configure hostname using Telnet connection
gather_facts: false
hosts: all
tasks:
- name: Configure hostname
  telnetX:
  port: '{{ hostvars[inventory_hostname].port }}'
  timeout: 5
  prompts:
  - '[>#]'
  command:
  - configure terminal
  - hostname {{ inventory_hostname }}

results in output :
(.venv) local@ansible:$ansible-playbook -i ./ansible/inventory/telnetX_hosts.yml ./ansible/telnetX.yml

PLAY [Configure hostname using Telnet connection] ********************************************************************

TASK [Configure hostname] ********************************************************************************************
fatal: [R1]: FAILED! => {"changed": true, "msg": "Telnet timed out trying to find prompt(s): '['[>#]']'", "stdout": "", "stdout_lines": []}

PLAY RECAP ***********************************************************************************************************
R1 : ok=0 changed=0 unreachable=0 failed=1 skipped=0 rescued=0 ignored=0

(.venv) local@ansible:$

This is the second run as the first output all the startup output from the device but results in the same behaviour.

With support for sending carriage return and adding send_carriage_return: true send_carriage_return: true to the task :-

name: Configure hostname using Telnet connection
gather_facts: false
hosts: all
tasks:
- name: Configure hostname
  telnetX:
  port: '{{ hostvars[inventory_hostname].port }}'
  timeout: 5
  send_carriage_return: true
  prompts:
  - '[>#]'
  command:
  - configure terminal
  - hostname {{ inventory_hostname }}

(.venv) adm-local@ansible:$ansible-playbook -i ./ansible/inventory/telnetX_hosts.yml ./ansible/telnetX.yml

PLAY [Configure hostname using Telnet connection] ********************************************************************

TASK [Configure hostname] ********************************************************************************************
changed: [R1]

PLAY RECAP ***********************************************************************************************************
R1 : ok=1 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0

(.venv) adm-local@ansible:$

add sending of "\r" if send_carriage_return flag is true, allows connection to IOSv devices console under GNS3

…wline It makes more sense to send to do send_carriage_return before send_newline. Not only is this the expected order "\r\n" but in case of cisco iosV on GNS3 the send_carriage_return needs be the first thing send to get any response.

for more information, see https://pre-commit.ci

softwarefactory-project-zuul · 2023-08-05T17:30:27Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/1c57d572d2884f7cb4cddf9cd7bacc58

Qalthos · 2023-09-05T13:47:30Z

I think this is a functional duplicate of #440, do you agree? I feel like an option to change whether explicit carriage returns are used globally is a little clearer, but I'm not sure if there is some reason to only need a carriage return on that first interaction

Domoninic · 2023-09-11T20:29:17Z

I think this is a functional duplicate of #440, do you agree? I feel like an option to change whether explicit carriage returns are used globally is a little clearer, but I'm not sure if there is some reason to only need a carriage return on that first interaction

I have tested with ansible.netcommon 5.2.0 and while it does function the terminal output now consists of blank line between every command:
R1(config)#line con 0
R1(config-line)#
R1(config-line)#transport preferred none
R1(config-line)#
R1(config-line)#exec-timeout 0 0
R1(config-line)#
R1(config-line)#privilege level 15
R1(config-line)#
R1(config-line)#logging synchronous
R1(config-line)#
R1(config-line)#length 60
R1(config-line)#
R1(config-line)#width 200
R1(config-line)#
R1(config-line)#exit

With the plain send_carriage_return option output is :
R1(config)#line con 0
R1(config-line)#transport preferred none
R1(config-line)#exec-timeout 0 0
R1(config-line)#privilege level 15
R1(config-line)#logging synchronous
R1(config-line)#length 60
R1(config-line)#width 200
R1(config-line)#exit

If I register this output I get reasonably clean output:
ok: [R1] => {
"con0": {
"changed": true,
"failed": false,
"stdout": "exit\r\nR1#\r\nR1#configure terminal\r\nEnter configuration commands, one per line. End with CNTL/Z.\r\nR1(config)#service password-encryption\r\nR1(config)#\r\n*Sep 11 19:28:52.412: %SYS-5-CONFIG_I: Configured from console by console\r\nR1(config)#line con 0\r\nR1(config-line)#transport preferred none\r\nR1(config-line)#exec-timeout 0 0\r\nR1(config-line)#privilege level 15\r\nR1(config-line)#logging synchronous\r\nR1(config-line)#",
"stdout_lines": [
"exit\r\n",
"R1#\r\n",
"R1#configure terminal\r\n",
"Enter configuration commands, one per line. End with CNTL/Z.\r\n",
"R1(config)#service password-encryption\r\n",
"R1(config)#\r\n",
"*Sep 11 19:28:52.412: %SYS-5-CONFIG_I: Configured from console by console\r\n",
"R1(config)#line con 0\r\n",
"R1(config-line)#transport preferred none\r\n",
"R1(config-line)#exec-timeout 0 0\r\n",
"R1(config-line)#privilege level 15\r\n",
"R1(config-line)#logging synchronous\r\n",
"R1(config-line)#"
]
}
}

But using the crlf method it is a mess and small changes in plays seem to drastically effect what get registered.

I would need test this further but so far the crlf creates more issues for me that it solves.

On a more general theme #440 changes the line ending used throughout the play including changing behavior of the send_newline flag. It seem to me this is doing double duty for two functions that could/should be considered separate. It would be better to have these so in play line ending can be change independent of the send_newline flag which really should just sent "\n". Perhaps a better approach would to have a line_ending option to set the preferred line ending and a separate generic send_on_start where an arbitrary character can be specified upon successful connection to start the terminal session. That way you can have "\r", "\r\n", "\n" or any other characters as the first thing sent.

Domoninic and others added 6 commits July 9, 2023 19:13

add send_carriage_return to telnet.py action plugin

4fe719f

add sending of "\r" if send_carriage_return flag is true, allows connection to IOSv devices console under GNS3

add send_carriage_return documentation to telnet.py module

6ab60a3

Merge branch 'ansible-collections:main' into GNS3-IOSv-Telent

e3238d2

[pre-commit.ci] auto fixes from pre-commit.com hooks

79400c8

for more information, see https://pre-commit.ci

Domoninic changed the title ~~Gns3 io sv telent~~ Gns3 iosv telent Aug 5, 2023

Qalthos added the needs_info This issue requires further information. Please answer any outstanding questions. label Sep 5, 2023

Ruchip16 changed the title ~~Gns3 iosv telent~~ Gns3 iosv telnet Jul 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gns3 iosv telnet #580

Gns3 iosv telnet #580

Domoninic commented Aug 5, 2023 •

edited

Loading

softwarefactory-project-zuul bot commented Aug 5, 2023

Qalthos commented Sep 5, 2023

Domoninic commented Sep 11, 2023 •

edited

Loading

Gns3 iosv telnet #580

Are you sure you want to change the base?

Gns3 iosv telnet #580

Conversation

Domoninic commented Aug 5, 2023 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

softwarefactory-project-zuul bot commented Aug 5, 2023

Qalthos commented Sep 5, 2023

Domoninic commented Sep 11, 2023 • edited Loading

Domoninic commented Aug 5, 2023 •

edited

Loading

Domoninic commented Sep 11, 2023 •

edited

Loading