Cisco CUCM AXL Python3 – Adding Lists Of Non Contiguous Extensions To CUCM

By 13th October 2017AXL, Cisco, CUCM

The following script was written for a client who had a large number of non contiguous extensions that they needed adding to CUCM. You could of course bulk import the lines attached to dummy devices but you would have to produce an all fields input file and or template before hand. It is much simpler and quicker via the API.

Complete Code
 
  1. __author__ = "Mitch Dawson"
  2. __contact__ = "info@ucdevops.com"
  3. __copyright__ = "Copyright (C) 2017 - 2018 Ucdevops All Rights Reserved"
  4. __license__ = "GPLv3"
  6. """
  7. This program is free software: you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation, either version 3 of the License, or
  10. (at your option) any later version.
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  17. You should have received a copy of the GNU General Public License
  18. along with this program. If not, see http://www.gnu.org/licenses.
  19. """
  21. from suds.client import Client
  22. from suds.xsd.doctor import ImportDoctor
  23. from suds.xsd.doctor import Import
  24. from suds.cache import NoCache
  26. tns = 'http://www.cisco.com/AXLAPIService/'
  27. imp = Import('http://schemas.xmlsoap.org/soap/encoding/',
  28.              'http://schemas.xmlsoap.org/soap/encoding/')
  29. imp.filter.add(tns)
  31. # Define Authentication Credentials for Cluster
  32. username = 'username'
  33. password = 'password'
  35. # Define AXL URL for Cluster
  36. url = 'https://CUCM:8443/axl/'
  38. # Define WSDL Location
  39. wsdl = 'file:///C:/PathTo/AXLAPI.wsdl'
  41. # Create Suds Client Object
  42. client = Client(location=url, url=wsdl, faults=False, username=username,
  43.                 password=password, plugins=[ImportDoctor(imp)],cache=NoCache()
  44. )
  46. # Define our line object creation function
  47. def lineObject(line):
  48.     """
  49.     Function returns a dictionary object of line attributes and values
  50.     """
  51.     # Create an empty dictionary
  52.     lineObject = {}
  54.     # Create a variable to be used to populate the description,
  55.     # alertingName and asciiAlertingName variables
  56.     description = 'Spare Denver Ext 12.10.17'
  58.     # Format the line value, in this example we prepend '\+' as
  59.     # e164 format is required
  60.     lineObject['pattern'] = '\+' + line
  62.     # Set Urgent Priority
  63.     lineObject['patternUrgency'] = 't'
  65.     # Assign the description variable above
  66.     lineObject['description'] = description
  67.     lineObject['alertingName'] = description
  68.     lineObject['asciiAlertingName'] = description
  70.     # Assign the partition of where the line should reside
  71.     lineObject['routePartitionName'] = 'PAR_RESOURCES'
  73.     # Assign the required Line CSS
  74.     lineObject['shareLineAppearanceCssName'] = 'CSS_US_DEN_839_LINE_IN'
  76.     # Create Call Forward settings object
  77.     cFwdNoVMNoDest = {
  78.         'forwardToVoiceMail': 'f',
  79.         'callingSearchSpaceName': 'CSS_US_DEN_839_LINE_N',
  80.         'destination': ''
  81.     }
  83.     # Create callForward object values
  84.     lineObject['callForwardAll'] = cFwdNoVMNoDest
  85.     lineObject['callForwardBusy'] = cFwdNoVMNoDest
  86.     lineObject['callForwardBusyInt'] = cFwdNoVMNoDest
  87.     lineObject['callForwardNoAnswer'] = cFwdNoVMNoDest
  88.     lineObject['callForwardNoAnswerInt'] = cFwdNoVMNoDest
  89.     lineObject['callForwardNoCoverage'] = cFwdNoVMNoDest
  90.     lineObject['callForwardNoCoverageInt'] = cFwdNoVMNoDest
  91.     lineObject['callForwardOnFailure'] = cFwdNoVMNoDest
  92.     lineObject['callForwardNotRegistered'] = cFwdNoVMNoDest
  93.     lineObject['callForwardNotRegisteredInt'] = cFwdNoVMNoDest
  95.     # Return the lineObject
  96.     return lineObject
  98. # The input list consists of a single column of values in a text file
  99. # Open the input list of numbers, Read it then split on new line
  100. file = open('lines.txt', 'r').read().split('\n')
  102. # Loop through the lines
  103. for line in file:
  104.     # Create a new line object
  105.     lineObj = lineObject(line)
  106.     # Post the new line object to the AXL API
  107.     x = client.service.addLine(lineObj)
  109.     # If the request was successful,
  110.     # the response will return a tuple with status code 200 as the first element
  111.     if x[0] == 200:
  112.         print(
  113.             'Sucessfully added Line {}'.format(lineObj['pattern'])
  114.         )
  116.     else:
  117.         # Anything other than 200 indicates an error
  118.         print(
  119.             'Error adding line {}'.format(lineObj['pattern'])
  120.         )
  121.         print(x[1])
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

Leave a Reply

"