There a couple client choices for python to generate a soap request to access data from CUCM. Not trying to reinvent the wheel I used examples that were readily available online for another client that hasn't been updated/supported in a while. At the recommendation of another engineer I wanted to challenge myself to migrate to a modern/actively maintained soap client for python, which leads us to zeep. Some benefits of zeep is the project is actively maintained, python2/3 support, faster than other clients (definitely noticeable on larger UC clusters), good documentation and some nice helper features. There are limited examples available with zeep (especially UC related) so I thought I'd share a RISPort70 request to CUCM 11.5 and some of the hurdles I had getting it working in hopes it might benefit others. First off, read the docs. Zeep has some good documentation and an active community. Familiarize yourself with the wsdl you're working with, Cisco provides really nice docs in the DevNet API Developer Guide: https://developer.cisco.com/site/sxml/documents/api-reference/risport/ Another tool that helped me out was using SoapUI to examine the wsdl, zeep also comes bundled with a wsdl inspector that helps view the client operations.
python -mzeep <wsdl>
I got tripped up on selectCmDevice as it has some nested complex data objects. I tried passing the client straight kwargs for the selection criteria, which worked but did not honor the complex data "SelectItems" (at least with child dictionaries in the parent kwargs). This led me to creating a factory with zeep that we can use to send the nested data to CUCM. The zeep history plugin really helped me out, you can view your sent/received soap envelope to see if your constructing the xml the way the DevNet guide expects. My use case is more focused towards all registered phones in the cluster, but included is a loop to iterate over a list of mac addresses in case individual devices are desired. Hopefully the below can help, thanks again for the great community! Python 3.5.2 Zeep 2.5.0 CUCM 11.5.1(SU4)
from zeep import Client
from zeep.cache import SqliteCache
from zeep.transports import Transport
from zeep.plugins import HistoryPlugin
from requests import Session
from requests.auth import HTTPBasicAuth
from lxml import etree
import urllib3
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
username = 'username'
password = 'password'
wsdl = 'file:///path/to/RISService70.wsdl'
session = Session()
session.verify = False
session.auth = HTTPBasicAuth(username, password)
transport = Transport(cache=SqliteCache(), session=session, timeout=20)
history = HistoryPlugin()
client = Client(wsdl=wsdl, transport=transport, plugins=[history])
factory = client.type_factory('ns0')
macs = ['SEP111122223333', 'SEP222233334444'] #'*' for all
item=[]
for mac in macs:
item.append(factory.SelectItem(Item=mac))
Item = factory.ArrayOfSelectItem(item)
stateInfo = ''
criteria = factory.CmSelectionCriteria(
MaxReturnedDevices = 1000,
DeviceClass='Phone',
Model=537, #255 for all
Status='Registered',
NodeName='',
SelectBy='Name',
SelectItems=Item,
Protocol='Any',
DownloadStatus='Any'
)
result = client.service.selectCmDevice(stateInfo, criteria)
print(result)
#troubleshooting soap envelope
for hist in [history.last_sent, history.last_received]:
print(etree.tostring(hist["envelope"], encoding="unicode", pretty_print=True))
... View more
.jpg "VIP Advisor"){kind=icon}
