Interacting with the Collaboration Endpoint Api 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 the Collaboration Endpoint Api.

Full Code
 
  1. from requests import Session
  2. import requests
  3. requests.packages.urllib3.disable_warnings()
  4. import xmltodict
  6. # Define the Api user credential
  7. user = "apiuser"
  8. # Define the Api Password Credential
  9. pwd = "apipass"
  10. # Define the url for the put request
  11. put_xml = "/putxml"
  12. # HTTP Content Header
  13. headers = {"Content-Type": "text/xml"}
  14. # Define the first SNMP Server
  15. snmp_server_1 = "10.10.10.1"
  16. # Define the second SNMP Server
  17. snmp_server_2 = "10.10.10.2"
  18. # Define the Syslog Server
  19. syslog_server= "10.10.10.3"
  20. # Define the Syslog Port
  21. syslog_port = "514"
  22. # Define the SNMP Read Only Community
  23. snmp_ro_community = "mysnmpstring"
  24. # Define the SNMP Mode
  25. snmp_mode = "ReadOnly"
  27. # Define our Logging Structure to hold the parameters
  28. logging = {
  29. "Configuration": {
  30. "Logging": {
  31. # The Configuration Section for external logging
  32. "External": {
  33. # Select mode ON
  34. "Mode": "On",
  35. # Use standard Syslog / no TLS
  36. "Protocol": "Syslog",
  37. # Disable TlsVerify for cosmetic purposes
  38. "TlsVerify": "Off",
  39. # Configure the Server Address and the Port
  40. "Server": {
  41. "Address": syslog_server,
  42. "Port": syslog_port
  43. }
  44. }
  45. }
  46. }
  47. }
  49. # Define our Snmp Structure to hold the parameters
  50. snmp = {
  51. "Configuration": {
  52. "NetworkServices": {
  53. "SNMP": {
  54. # Configure the SNMP Read Only Community
  55. "CommunityName": snmp_ro_community,
  56. # Configure the SNMP hosts that can talk to the device
  57. "Host 1 Address": snmp_server_1,
  58. "Host 2 Address": snmp_server_2,
  59. # Configure the SNMP Mode
  60. "Mode": snmp_mode,
  61. }
  62. }
  63. }
  64. }
  66. # Define a function to configure the logging parameters
  67. def configure_logging(vc):
  68. # Build the url
  69. url = "https://" + vc + put_xml
  70. # Make the POST request
  71. r = requests.post(
  72. # Build the url
  73. url=url,
  74. # Add the Content Headers
  75. headers=headers,
  76. # Disable certificate validation
  77. verify=False,
  78. # Provide the Basic auth credentials
  79. auth=(user, pwd),
  80. # Parse the dictionary structure and add the generate XML Body to the request
  81. data=xmltodict.unparse(logging)
  82. )
  83. # Print the output
  84. print(r.status_code, r.text)
  86. # Define a function to configure the logging parameters
  87. def configure_snmp(vc):
  88. # Build the url
  89. url = "https://" + vc + put_xml
  90. # Make the POST request
  91. r = requests.post(
  92. # Build the url
  93. url=url,
  94. # Add the Content Headers
  95. headers=headers,
  96. # Disable certificate validation
  97. verify=False,
  98. # Provide the Basic auth credentials
  99. auth=(user, pwd),
  100. # Parse the dictionary structure and add the generate XML Body to the request
  101. data=xmltodict.unparse(snmp)
  102. )
  103. # Print the output
  104. print(r.status_code, r.text)
  106. def main():
  107. # Define the input filename of ip addresses
  108. file_name = "vc1.txt"
  109. # Open the input file
  110. print("Opening input file .. {}".format(file_name))
  111. vc_hosts = open(file_name, "r").read().split("\n")
  112. # Iterate through our Hosts
  113. for vc in vc_hosts:
  114. print("#" * 100)
  115. # Create a Try & Accept Loop To Catch non responsive devices
  116. try:
  117. print("Configuring SNMP & Syslog on device ....'{}'".format(vc))
  118. # Call the Configure Logging & Syslog Functions
  119. configure_logging(vc)
  120. configure_snmp(vc)
  121. except Exception as e:
  122. print(str(e))
  123. else:
  124. # When we have a compatible session
  125. print("Configuration completed successfully...")
  127. if __name__ == "__main__":
  128. main()
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
"