Cisco CUCM Extension Mobility Api Python3 – Remote Login

By 7th March 2018Cisco, CUCM, EMAPI
Full Code
 
  2. __author__ = "Mitch Dawson"
  3. __contact__ = "info@ucdevops.com"
  4. __copyright__ = "Copyright (C) 2017 - 2021 Ucdevops All Rights Reserved"
  5. __license__ = "GPLv3"
  7. """
  8. This program is free software: you can redistribute it and/or modify
  9. it under the terms of the GNU General Public License as published by
  10. the Free Software Foundation, either version 3 of the License, or
  11. (at your option) any later version.
  13. This program is distributed in the hope that it will be useful,
  14. but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16. GNU General Public License for more details.
  18. You should have received a copy of the GNU General Public License
  19. along with this program. If not, see http://www.gnu.org/licenses.
  20. """
  22. # Import the requests http library.
  23. import requests
  25. # Define our request headers.
  26. header = {
  27.     "Content-Type": "application/x-www-form-urlencoded"
  28. }
  30. # Define our individual cucm extension mobility hosts.
  31. host = "https://cucm1"
  33. # Define our extension mobility api url.
  34. em_url = ":8443/emservice/EMServiceServlet"
  36. # Define our extension mobility proxy user credentials.
  37. # The account needs the "Standard EM Authentication Proxy Rights" role applied.
  38. proxy_user = "username"
  39. proxy_pass = "password"
  42. # Define our Login class.
  43. class Login:
  45.     def __init__(self, url, proxy_user, proxy_password):
  46.         self.url = url
  47.         self.proxy_user = proxy_user
  48.         self.proxy_pass = proxy_password
  50.     def login_msg(self, mac, profile, uid):
  51.         # The function creates our message, required to perform a login request.
  52.         # Takes the Phone MAC, Device Profile Name and userid as input.
  53.         return """
  54.         <request>
  55.             <appInfo>
  56.                 <appID>{0}</appID>
  57.                 <appCertificate>{1}</appCertificate>
  58.             </appInfo>
  59.             <login>
  60.                 <deviceName>{2}</deviceName>
  61.                 <userID>{3}</userID>
  62.                 <deviceProfile>{4}</deviceProfile>
  63.                 <exclusiveDuration>
  64.                     <indefinite></indefinite>
  65.                 </exclusiveDuration>
  66.             </login>
  67.         </request>
  68.         """.format(self.proxy_user, self.proxy_pass, mac, uid, profile)
  70.     def make_request(self, message):
  71.         # The function posts our message to Extension Mobility API
  72.         return requests.post(
  73.             data={"xml": message},
  74.             url=self.url
  75.         )
  77.     def do_login(self, mac, profile, uid):
  78.         # Function which carries out our required steps to perform our login.
  79.         print("*" * 50, "\n")
  80.         print(
  81.             "Logging in User '{}' into Handset {} "
  82.             "with Profile {} .....\n"
  83.             .format(uid, mac, profile)
  84.         )
  85.         print(
  86.             self.make_request(
  87.                 self.login_msg(mac, profile, uid)
  88.             ).text
  89.         )
  90.         print("*" * 50, "\n")
  93. def main():
  95.     # Open and read our csv input file.
  96.     data = open("login.csv", "r").read().split("\n")
  98.     # Instantiate our "Login" class.
  99.     login = Login(
  100.         host + em_url, proxy_user, proxy_pass
  101.     )
  103.     # Loop through our login data skipping our header line.
  104.     for line in data[1:]:
  105.         mac, profile, uid = line.split(",")
  106.         login.do_login(mac, profile, uid)
  108. if __name__ == "__main__":
  109.     main()
  110.  
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

"