fixed readability / adjusted for login.yaml

scripts/breakout-to-secureCRT-session/readme.md

@@ -14,15 +14,65 @@ Tested on:
 - secureCRT 9.0.2
 
 Variables to edit:
-on main.py edit server, username, password, and lab number. 
+in login.yaml edit the server name, username, password, and lab number. 
 
 This python app will create a new folder and all the telnet sessions for the lab. 
 Port numbers are listed in front of the devices name so you can quickly bounce it off the breakout tool if something doesnt seem right...
 
 ![alt text](https://github.com/M35a2/CML-Breakout-SecureCRT-Session/blob/main/Capture.PNG?raw=true)
 
+to run the script:
+- edit the variables in login.yaml (note: you can find the lab number in the url when opening the lab on the cml server webpage)
+- run main.py file to start the program 
+
+Example:
+```
+C:\Users\Admin\Documents\CML-Breakout-SecureCRT-Session> python .\main.py
+creating: internet Node Definition: iosv
+creating: csr-sdwan-3-1 Node Definition: csr1000v
+creating: csr-sdwan-4-1 Node Definition: csr1000v
+creating: wan-em-2 Node Definition: wan_emulator
+...omitted...
+Node n98 does not exist, will check all nodes from n0 to n99.
+Node n99 does not exist, will check all nodes from n0 to n99.
+Nodes 0-99 checked. if you need more, increase the number checked in the while loop
+example: while n_id < 150:
+exiting...
+C:\Users\Admin\Documents\CML-Breakout-SecureCRT-Session>
+```
+
 easist way to update a lab after adding/deleting devices is to just delete the lab folder in secureCRT, rerun the script, and restart secureCRT
 
 Known issues:
-only tested on wan emulators, routers, switches... 
+This has not been tested on every node type.
-i haven't tested on anything that requires VNC or breakout might handle differently than adding by two port numbers. 
+Some nodes only add by 1 port number in the breakout tool, some add by 2.
+if you devices got out of order, check the breakout tool and see if it only added by one port after the device where it became out of order. 
+if so, you can add that node definition to the "if" statement starting on line 71 of main.py
+```
+        # if any custom nodes are added, and they dont add by 2 ports in the breakout tool
+        # add the node definition to the if statement below to only add by 1 port. 
+        if (response.get("node_definition") == "wan_emulator" or 
+                response.get("node_definition") == "asav" or 
+                response.get("node_definition") == "ftdv" or
+                response.get("node_definition") == "server" or
+                response.get("node_definition") == "alpine" or
+                response.get("node_definition") == "coreos" or
+                response.get("node_definition") == "desktop" or
+                response.get("node_definition") == "ubuntu" or
+           ---> response.get("node_definition") == "CustomNode1" or
+           ---> response.get("node_definition") == "CustomNode2"):
+            # only add 1 to port number for the next device
+            port = port + 1
+```
+the node definition is printed out with each item created so you know what the name is to add.
+Likewise, if there is a node that cannot be consoled into, add it to the "elif" statement on line 47
+```
+    # dont count devices that cannot be consoled into    
+    elif (response.get("node_definition") == "external_connector" or
+            response.get("node_definition") == "unmanaged_switch" or
+            response.get("node_definition") == "some other node definition that doesnt have a console"):
+        # increment node number
+        n_id = n_id + 1    
+```
+Good luck
+