added a playbook template for CML console connections and accompanying inventory

Author: splitnines

ansible.cfg

@@ -1,14 +1,15 @@
 [defaults]
 root = ~/projects/netdevops/
 inventory = ./inventory
-stdout_callback = json
+stdout_callback = default
+callback_result_format = yaml
 result_format = yaml
 forks = 10
 timeout = 30
 gathering = explicit
 retry_files_enabled = False
 host_key_checking = False
-deprecation_warnings = True
+deprecation_warnings = False
 log_path = ./logs/ansible.log
 
 [persistent_connection]

inventory/consoles.yml

@@ -0,0 +1,21 @@
+all:
+  children:
+    consoles:
+      vars:
+        ansible_connection: local
+        ansible_host: localhost
+        telnet_user: "{{ lookup('env', 'CISCO_USER') }}"
+        telnet_password: "{{ lookup('env', 'CISCO_PASS') }}"
+      hosts:
+        r1:
+          telnet_port: 9001
+        r2:
+          telnet_port: 9002
+        r3:
+          telnet_port: 9003
+        r4:
+          telnet_port: 9004
+        r5:
+          telnet_port: 9005
+        r6:
+          telnet_port: 9006

inventory/group_vars/consoles.yml

@@ -0,0 +1,8 @@
+ansible_connection: ansible.netcommon.network_cli
+ansible_network_os: cisco.ios.ios
+
+ansible_user: "{{ lookup('env', 'CISCO_USER') }}"
+ansible_password: "{{ lookup('env', 'CISCO_PASS') }}"
+
+ansible_command_timeout: 60
+ansible_connect_timeout: 60

inventory/lab.yml

@@ -30,3 +30,22 @@ all:
       hosts:
         sp1:
           ansible_host: 10.0.0.248
+    consoles:
+      vars:
+        ansible_connection: local
+        ansible_host: localhost
+        telnet_user: "{{ lookup('env', 'CISCO_USER') }}"
+        telnet_password: "{{ lookup('env', 'CISCO_PASS') }}"
+      hosts:
+        r1:
+          telnet_port: 9001
+        r2:
+          telnet_port: 9002
+        r3:
+          telnet_port: 9003
+        r4:
+          telnet_port: 9004
+        r5:
+          telnet_port: 9005
+        r6:
+          telnet_port: 9006

playbooks/consoles_pb.yml

@@ -0,0 +1,39 @@
+- name: CML console playbook
+  hosts: consoles
+  gather_facts: false
+
+  tasks:
+    - name: Run commands through an existing or new console session
+      ansible.builtin.expect:
+        command: "telnet {{ ansible_host }} {{ telnet_port }}"
+        timeout: 10
+        echo: false
+        responses:
+          "(?i)Escape character is \\'\\^\\]\\'\\.\\s*$": "\r"
+
+          '(?i)Username:\s*$': "{{ telnet_user }}"
+          '(?i)Password:\s*$': "{{ telnet_password }}"
+
+          # Exit the local Telnet client cleanly.
+          '(?i)telnet>\s*$': "quit"
+
+          "(?i)Press RETURN to get started\\.": "\u001d"
+
+          # Each successive IOS prompt sends the next response.
+          '(?m)^(?!telnet>)[^\r\n]*[>#]\s*$':
+            - "terminal length 0"
+            - "show clock"
+            - "show version | include uptime"
+            - "show ip interface brief"
+            # - "exit\r\n\u001dquit\r"
+            - "exit"
+            - "\u001d"
+      register: out
+      changed_when: false
+      delegate_to: localhost
+      vars:
+        ansible_python_interpreter: "{{ ansible_playbook_python }}"
+
+    - name: Results
+      ansible.builtin.debug:
+        msg: "{{ out.stdout | replace('\\'', '') }}"

playbooks/test.yml

@@ -1,5 +1,5 @@
 ---
-- hosts: default 
+- hosts: consoles 
   gather_facts: no
 
   tasks:

pyproject.toml

@@ -8,6 +8,7 @@ dependencies = [
     "ansible>=11.9.0",
     "ansible-pylibssh>=1.2.2",
     "paramiko>=4.0.0",
+    "pexpect>=4.9.0",
     "pyats[full]>=25.7",
     "python-dotenv>=1.1.1",
 ]