topic Re: python client for AXL in Management

python client for AXL

jseynaev — Fri, 28 Nov 2014 15:19:52 GMT

Hello,

I have a nice working toolset that is interacting very well with AXL interface using PHP.

However, we are looking to switch to python (it does look like this would be a lot easier to process data coming in). Unfortunately, i can't find any working example to connect to the AXL interface.

suds seems to be the way to go, but that's not working on python3. I'm happy doing this in python2, but still, i don't get suds to get the works done ... any working example is welcome! (i'll give you a working PHP example in return 😜 )

Jan.

Re: python client for AXL

jocreed — Mon, 01 Dec 2014 15:34:42 GMT

Jan,

Below I have provided some sample code to use with AXL. I use the "Requests" libraries to process HTTP so if you use the below code exactly you will need to download the Requests library for python. Also, and I am sure you know this, but please change your keep your AXL version consistent with the CUCM you are using. The below code is using AXL 8.5. Let me know if you have any questions.

Thank You,

Jock

import requests

import xml.etree.ElementTree as ET

soaprequest = '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/8.5"><soapenv:Header /><soapenv:Body><ns:listPhone><searchCriteria><name>SEP%</name></searchCriteria><returnedTags><name></name></returnedTags></ns:listPhone></soapenv:Body></soapenv:Envelope>'

soapheaders = {'Content-type':'text/xml', 'SOAPAction':'CUCM:DB ver=8.5 listPhone'}

AXLRequest = requests.post('https://CMServer:8443/axl/', data = soaprequest, headers = soapheaders, verify = False, auth=('username','password'))

root = ET.fromstring(AXLRequest.text)

DeviceNames = []

for phone in root.iter('phone'):

DeviceNames.append(phone.find('name').text)

#print phone.find('name').text

print DeviceNames

Re: python client for AXL

jseynaev — Mon, 01 Dec 2014 16:43:51 GMT

Thx Kristopher, that's indeed working and a good first step 😉

Kind of complicated, though. I do use quite a few methods and with the php SoapClient, i can just load the connection with the xdml file and give the parameters in a nice array / list ... and get the stuff back in sort of a nice way.

So if anyone can give a working example using SUDS, that would be perfect.

I did find something that's working in Python2 for the RIS interface:

Parky's Place: Using Python to call Cisco Communications Manager Serviceability SOAP API

Havent' been able to port that to work with AXL though ...

Re: python client for AXL

npetrele — Mon, 01 Dec 2014 20:43:11 GMT

For what it's worth, I've tried AXL with Python Suds and pysimplesoap. Suds seems to create XML that AXL doesn't like, and I get this error when I try to use an API:

AttributeError: 'NoneType' object has no attribute 'promotePrefixes'

I get a little farther with Pysimplesoap, but in the end I haven't figured out how to call an API. Here's code to get you started, though, if you're interested (substitute your own username, password, and server, and point to the place where you have the WSDL and XSDs):

from pysimplesoap.client import SoapClient

import base64

wsdl="http://localhost/AXLAPI.wsdl"

location="https://server:8443/axl"

action="https://server:8443/axl"

ns='http://schemas.cisco.com/ast/soap/'

username="username"

password="password"

toencode=username + ':' + password

encoded=base64.b64encode(bytes(toencode,"utf-8"))

client = SoapClient(wsdl=wsdl, location=location, action=action, ns=ns, http_headers={'Authorization': 'Basic %s' % encoded})

print(client.help('listPhone'))

Re: python client for AXL

jocreed — Mon, 01 Dec 2014 23:07:28 GMT

try this Python SUDS code. I am running this on Python 2.7.8 on Windows 7

from suds.client import Client

cmserver = '10.10.10.10'

cmport = '8443'

wsdl = 'file:///your/system/path/schema/current/AXLAPI.wsdl'

location = 'https://' + cmserver + ':' + cmport + '/axl/'

username = 'username'

password = 'password'

client = Client(wsdl,location=location, username=username, password=password)

result = client.service.listPhone({'name':'SEP%'},{'name':'','model':''})

for node in result['return']['phone']:

print str(node['name']), str(node['model'])

Re: python client for AXL

jseynaev — Wed, 03 Dec 2014 23:04:14 GMT

Waw, i think i have figured it out ... but it's a bit a painful one. Got it working for get* methods too now, list is working also (as it always did), still have to try add* stuff.

So, here's how it goes:

Windows7 (shouldn't matter that much) and Python3.4.2
install suds-jurko with pip
PATCH the file (not kidding) C:\Python34\Lib\site-packages\suds\bindings\document.py
you just need to comment out line 141:
if not child.isattr():
(there's only one line like this, so you can't miss)
TADAA, all is working. if i understand it correct, suds does not pull in 'optional' stuff from wsdl and with the above patch it should do that now

As I don't know suds at all, here's a very rudimentary example for a get* request (pretty much based on the answers above ;p)

wsdl = 'file:///C:/path/to/your/matching/AXLAPI.wsdl'

from suds.client import Client

client = Client(wsdl,location='https://yourserverhere:8443/axl/',username='yourusername',password='yourpassword')

phone = client.service.getPhone(name='test')

print(phone)

(reply){

return =

(return){

phone =

(RPhone){

_uuid = "{50BCA715-C781-C8B0-CC90-E0B95CB2F1AD}"

_ctiid = 9

name = "jseynaev-test"

description = "jseynaev-test"

product = "Cisco IP Communicator"

< ... very long list of params ... >

Let me know if this works for you too!

Jan.

Re: python client for AXL

npetrele — Wed, 03 Dec 2014 23:28:24 GMT

I did a pip install suds-jurko with Python34, and it didn't install C:\Python34\Lib\site-packages\suds\bindings\document.py. I believe everything necessary is packed in the egg file, and I didn't extract it or edit document.py there.

However, the following code still worked fine for me:

from suds.client import Client

from suds.transport.https import HttpAuthenticated

cmserver = 'server'

cmport = '8443'

wsdl = 'PATH/TO/AXLAPI.wsdl'

location = 'https://' + cmserver + ':' + cmport + '/axl/'

username = 'username'

password = 'password'

client = Client(wsdl,location=location, transport = HttpAuthenticated(username=username, password=password))

result = client.service.listPhone({'name':'SEP%'},{'name':'','model':''})

for node in result['return']['phone']:

print (str(node['name']), str(node['model']))

Re: python client for AXL

jseynaev — Thu, 04 Dec 2014 08:41:02 GMT

Yes, the list* calls seem to work fine 'out of the box', however, things like getPhone or getRegion (try e.g. region = client.service.getRegion(name='Default')) throw an error of some non-defined property ...

Not sure how the whole pip install works, but for me that's where the file was, maybe it installed it somewhere in your home directory? (i choose to install 'for everyone on this pc')

Re: python client for AXL

dstaudt — Thu, 04 Dec 2014 15:38:29 GMT

I suspect the <returnedTags> element is required for those requests:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/10.5">

<soapenv:Header/>

<soapenv:Body>

<ns:getPhone sequence="1">

<name>IPCMRAEU5UCM5X7</name>

<returnedTags>

<name/>

</returnedTags>

</ns:getPhone>

</soapenv:Body>

</soapenv:Envelope>

Re: python client for AXL

npetrele — Thu, 04 Dec 2014 16:15:03 GMT

This works for me in the above example in place of listPhone:

result = client.service.getPhone(name='SEP010101010101')

print(result)

I tried various ways of specifying returnedTags, but nothing I tried worked. Suds is not extremely well documented when it comes to using a WSDL like AXLAPI. By the way, I'm using the 10.5 WSDL against a 10.5 CUCM.

Re: python client for AXL

jocreed — Thu, 04 Dec 2014 16:37:59 GMT

I agree with Nick. There is not a lot of documentation for using AXL with suds or any other python soap handlerfor that matter, even pysimplesoap. His assessment is also correct with usage of tags. Trying to find out exactly what works with suds was a little difficult. when I posted my code in my last post the only way I was able to figure it out for the listPhone was through a little trial and error with the tags. Also, I was able to get it to work without patching the file you mentioned

I think depending on the call you are using you might have to adjust how you write the tags, so you might have a little trial and error on that one. which would be a benefit in the future maintaining your code. That being said you could always use the old fashioned way like my very first post on this thread, depends on your preference and how simple or complex you want to make it considering your trade offs of time and how mush maintenance you are willing to do to your code.

Below is the final code sample I have combining Nick's testing and my own. Let us know if that works for you or if you are having trouble with any other calls in AXL.

from suds.client import Client

cmserver = '10.10.10.10'

cmport = '8443'

wsdl = 'file:///your/file/location/schema/current/AXLAPI.wsdl'

location = 'https://' + cmserver + ':' + cmport + '/axl/'

username = 'user'

password = 'pass'

client = Client(wsdl,location=location, username=username, password=password)

result = client.service.getPhone(name = 'IPCMRAEU5UCM5X7')

print result

Re: python client for AXL

jocreed — Thu, 04 Dec 2014 17:07:31 GMT

I forgot to mention that in my last post the code is utilizing the 9.1 version of AXL.

Re: python client for AXL

jocreed — Thu, 11 Dec 2014 19:15:27 GMT

Jan,

did you ever get the answer you were looking for?.

I hope you are having a good day.

Thank You,

Jock

Re: python client for AXL

jseynaev — Fri, 12 Dec 2014 08:35:21 GMT

Yes, as I stated in my earlier post, if I do that patch, all is working fine...

Pretty much agree on all of the above, it's a bit of trial and error, indeed.

Re: python client for AXL

bradleysearle — Tue, 05 May 2015 12:18:36 GMT

Pretty good info here, looks like your still the man Jan . Thanks ALL for the use full tips! I managed to get python talking to AXL. I had some errors around SSL, so i used urllib for the authentication. Should be able to use the SSL cert for authentication with minimal modifications. Hopefully this can save someone else from bashing their head against a wall

#Environment

#Centos7/UCM8.5/Python3/suds-jurko

#Note no patching of the file was required, I used the suds-jurko(0.6) from pip install.

#http://smirnov-am.blogspot.com.au/2015/04/monitoring-device-registration-with.html

#got the SSL workaround from above blog

import ssl

import urllib

from suds.transport.https import HttpAuthenticated

from suds.client import Client

t = HttpAuthenticated(username='AXL_USER', password='axlPass')

t.handler=urllib.request.HTTPBasicAuthHandler(t.pm)

ssl_def_context = ssl.create_default_context()

ssl_def_context.check_hostname = False

ssl_def_context.verify_mode = ssl.CERT_NONE

t1=urllib.request.HTTPSHandler(context=ssl_def_context)

t.urlopener = urllib.request.build_opener(t.handler,t1)

wsdl = 'file:///path/to/your/axl/file/axlsqltoolkit/schema/8.5/AXLAPI.wsdl'

client=Client(wsdl, location='https://10.1.1.1:8443/axl/', transport=t)

#Usage

phone = client.service.getPhone(name='SMITH-TEST')

print(phone['return']['phone']['lines']['line'][0]['dirn']['pattern'])

86116094

phones = client.service.listPhone({'devicePoolName':'CNT_DP'},{'name':'','model':''})

for i in phone['return']['phone']:

print(i['name'], i['model'])

dp = client.service.listDevicePool({'name':'%'},{'name':''})

for i in dp['return']['devicePool']:

print(i['name'])

Will try out some add methods now and see how that goes.

Re: python client for AXL

jocreed — Wed, 06 May 2015 17:08:35 GMT

Thank you Bradley for your contributions 🙂

Re: python client for AXL

bradleysearle — Wed, 06 May 2015 22:50:44 GMT

Hi Jock and all,

Have you had any luck adding phones or phone profiles with Python/Suds. If so is it possible to share the code please ?

For example to add a phone I have tried a number of combinations here is one;

ap = client.service.addPhone({

"name" : "AAAABBBBCCCCDDDD",

"product": "Cisco 7975",

"class": "Phone",

"protocol": "SCCP",

"protocolSide": "User",

"devicePoolName": "test_dp",

"commonPhoneConfigName": "Standard Common Phone Profile",

"locationName": "Hub_None",

"securityProfileName": "Cisco 7975 - Standard SCCP Non-Secure Profile",

})

Everything I have tried has failed. Any help would be appreciated.

Cheers,

Brad

Re: python client for AXL

jocreed — Thu, 07 May 2015 22:26:01 GMT

I am attaching the code below that worked for me. I needed to add a few elements to make it work. A little trial and error, but you could always try to do a little pruning if you see any elements I have included that you think are not necessary. I also included some debugging function which I have always found useful. Just be careful what you turn on to be at the DEBUG level, you may get more than you bargain with if you set everything to DEBUG.

Let me know what you think.

from suds.xsd.doctor import Import

from suds.xsd.doctor import ImportDoctor

from suds.client import Client

from suds.transport.https import HttpAuthenticated

import logging

cmserver = 'your.cucm.com'

cmport = '8443'

wsdl = 'file:///Your/location/ofWSDL/axlsqltoolkit10(5)/schema/current/AXLAPI.wsdl'

location = 'https://' + cmserver + ':' + cmport + '/axl/'

username = <USERNAME>

password = <PASSWORD>

logging.basicConfig(level=logging.CRITICAL)

logging.getLogger('suds.client').setLevel(logging.DEBUG)

logging.getLogger('suds.transport').setLevel(logging.DEBUG)

logging.getLogger('suds.xsd.schema').setLevel(logging.CRITICAL)

logging.getLogger('suds.wsdl').setLevel(logging.CRITICAL)

client = Client(wsdl,location=location, username=username, password=password)

#print client

result = client.service.addPhone({'name':'SEP018888675309','class':'Phone','product':'Cisco 7975','protocol':'SCCP',

'protocolSide':'User','devicePoolName':'Default',

'commonPhoneConfigName':'Standard Common Phone Profile',

'locationName':'Hub_None','securityProfileName':'Cisco 7975 - Standard SCCP Non-Secure Profile',

'useTrustedRelayPoint':'Default','presenceGroupName':'Standard Presence Group','phoneTemplateName':'Standard 7975 SCCP',

})

print result

Re: python client for AXL

bradleysearle — Thu, 07 May 2015 23:14:14 GMT

Thank you Jock ! that worked Looks like I wasn't using a valid mac add (slaps face)

I did a bit of experimenting and found this to be the least number of elements that can be used for 7975

#add Phone

ap = client.service.addPhone({

'name': 'SEPAAAABBBB2222',

'product': 'Cisco 7975',

'class': 'Phone',

'protocol': 'SCCP',

'devicePoolName': 'test_dp',

})

note that I am using ucm10.5 for my test server.

Thank you again, much appreciated.

Re: python client for AXL

jocreed — Fri, 08 May 2015 21:13:26 GMT

Bradley, Awesome, I am glad that worked for you. Thanks for finding out the least number elements required for adding a 7975 phone. that will come in handy. I am also running this against 10.5 I might give it a shot against the 9.1 and 10.0 servers in our lab just to make sure that works as well. Probably will, but you never know.