Interacting with Collaboration Endpoints via SSH using Python – Configuring SNMP & Syslog

There are limitations on the values that can be configured via Cisco Unified Communications Manager Administration for Cisco Video Conference devices. For example, In order to configure SNMP monitoring you would need to login to the endpoint and configure the settings manually which can can take a considerable amount of time for a large number of endpoints.

The following code demonstrates how you can configure the appropriate settings using SSH. The program utilises a csv input file of VC unit FQDN’s or Ip’s in this instance as I had exported a number of other pieces of data such as the device description and Mac address for visibiltiy when running through large numbers of devices. I have also structured the application so that we can take advantage of Pythons multiprocessing support and divide the work up amongst multiple processes.

Commands Applied
 
  2. xConfiguration Logging Internal Mode: On
  3. xConfiguration Logging External Mode: On
  4. xConfiguration Logging External Protocol: Syslog
  5. xConfiguration Logging External Server Port: 514
  6. xConfiguration Logging External Server Address: 2.2.2.2
  7. xconfiguration NetworkServices SNMP Mode: ReadOnly
  8. xconfiguration NetworkServices SNMP CommunityName: mysnmpcommunity
  9. xConfiguration NetworkServices SNMP Host 1 Address: 1.1.1.1
  10. xConfiguration NetworkServices SNMP Host 2 Address: 1.1.1.2
  11. xConfiguration NetworkServices SNMP Host 3 Address: 1.1.1.3
  12.  
Full Code
 
  1. from netmiko import ConnectHandler
  2. import csv
  3. import time
  4. from multiprocessing import Pool
  6. # Define the SSH Credentials.
  7. ssh_user = "sshuser"
  8. ssh_pass = "sshpass"
  10. # Define the VC Hosts File.
  11. vc_hosts_file = "vchosts.csv"
  13. # Define the VC Commands File.
  14. vc_config_commands = "vccommands.txt"
  16. # Open the input host file.
  17. vc_hosts = open(vc_hosts_file, "r")
  19. # Open the input commands file.
  20. commands = open(vc_config_commands, "r").read().splitlines()
  22. # Create a list of csv reader objects.
  23. hosts = [row for row in csv.DictReader(vc_hosts)]
  25. # Function to return our data object to be passed to the ConnectHandler.
  26. def create_data(ip):
  27.     return {
  28.         'device_type': 'cisco_tp',
  29.         'host':   ip,
  30.         'username': ssh_user,
  31.         'password': ssh_pass,
  32.     }
  34. # Returns a Netmiko ConnectHandler object configured with our parameters.
  35. def create_handler(data):
  36.     return ConnectHandler(**data)
  38. # Function actually applies the configuration commands via the ConnectHandler.
  39. def configure_host(handler, commands):
  40.     # Define the error place holder
  41.     error = None
  43.     # Iterate through the commands that we want to apply
  44.     for command in commands:
  46.         print(f"Sending Command = {command}")
  48.         # Send the command to the device via the handler, using "send_command_timing", this function
  49.         # will wait an additional two seconds to receive a response from the device.
  50.         response = handler.send_command_timing(command)
  52.         # Successful commands will receive text containing "OK".
  53.         # Print the output if we received an error.
  54.         if "OK" not in response:
  56.             # print out the
  57.             error = response
  59.             # Break out of the command loop if an error was received
  60.             break
  62.     # Return the error value
  63.     return error
  66. def run(host):
  67.     print("#" * 100)
  68.     print(f"Device {hosts.index(host)} / {len(hosts)}")
  70.     # Try and Except Block
  71.     try:
  73.         # Break out the MAC Address.
  74.         mac = host["Mac"]
  76.         # Break Out the Description.
  77.         description = host["Description"]
  79.         # Break out the IP Address.
  80.         ip = host["Ip"]
  82.         print(f"Configuring Host - {mac} - {description} - {ip}")
  84.         # Create the Data Dictionary for the connect handler.
  85.         data = create_data(ip)
  87.         # Create a handler for each host.
  88.         handler = create_handler(data)
  90.         # Configure the device with the saved commands.
  91.         error = configure_host(handler, commands)
  93.         # Check the value of error.
  94.         if error != None:
  95.             print("Error Received", error)
  96.         else:
  97.             print("Success")
  99.         # Disconnect the Handler.
  100.         handler.disconnect()
  102.     # Catch A Generic Exception.
  103.     except Exception as e:
  104.         print(str(e))
  105.         pass
  107. def main():
  109.     # Define a process pool.
  110.     pool = Pool(processes=4)
  112.     # Map the pool to our function.
  113.     pool.map(run, hosts)
  116. if __name__ == "__main__":
  117.     main()
  118.  
Mitch

Author Mitch

I am an independent IT Consultant with specialities in Software Development, Enterprise Unified Communication, Network and Security platforms. In addition to my day to day work, I develop bespoke applications and I hope that through ucdevops.com I can build relationships with clients, business partners and fellow engineers by providing solutions to complex problems through the use of programming.

More posts by Mitch
"