Hey guys,
Following my post about the overview of Cisco CUCM – SOAP (read it HERE), I’m going to show you now how to send some basic requests using Python.
To be able to do that, you will need to have:
- Python installed (download it here)
- AXLSQLToolkit
- Python Libraries (Zeep, urllib3 , requests – installed via PIP)
After installing Python and its libraries, let’s go to the codes!
To run my codes, I use PyCharm….but you can use any other software of your preference.
Firstly, you have to declare your libraries:
*Code will be passed at the end of the article 
Now you have to enter your CUCM information, such as IP, username and password.
We are going to use ZEEP to create SOAP requests. In case of any fault, Zeep will show what SOAP envelope that was sent and the response from CUCM AXL.
If you’re not disabling SSL verification, host should be the FQDN of the server rather than IP.
To start with a simple request, I’ll show you how to list Phones.
Have in hands the Cisco DevNet AXL Schema Reference. It will help you to understand each request, which argument you must send as a searchCriteria and which arguments you must expect as returnedTags.
Only declared arguments in the returnedTags will be displayed. The rest will be showed as none.
For example, I want to list a phone, based on the Device Name, and want to have the arguments name, description, model and device pool being returned to me.
The code will look like this:
The result will like this:
{
‘return’: {
‘phone’: [
{
‘name’: ‘SEP0004F2F01F1A’,
‘description’: ‘Meeting Room’,
‘product’: None,
‘model’: ‘Cisco 7937’,
‘class’: None,
‘protocol’: None,
‘protocolSide’: None,
‘callingSearchSpaceName’: None,
‘devicePoolName’: {
‘_value_1’: ‘BE_KNO_DP’,
‘uuid’: ‘{960A36D4-C7ED-49B8-A53C-B188BE30635A}’
},
‘commonDeviceConfigName’: None,
‘commonPhoneConfigName’: None,
‘networkLocation’: None,
‘locationName’: None,
‘mediaResourceListName’: None,
‘networkHoldMohAudioSourceId’: None,
‘userHoldMohAudioSourceId’: None,
‘automatedAlternateRoutingCssName’: None,
‘aarNeighborhoodName’: None,
‘loadInformation’: None,
‘traceFlag’: None,
‘mlppIndicationStatus’: None,
‘preemption’: None,
‘useTrustedRelayPoint’: None,
‘retryVideoCallAsAudio’: None,
‘securityProfileName’: None,
‘sipProfileName’: None,
‘cgpnTransformationCssName’: None,
‘useDevicePoolCgpnTransformCss’: None,
‘geoLocationName’: None,
‘geoLocationFilterName’: None,
‘sendGeoLocation’: None,
‘numberOfButtons’: None,
‘phoneTemplateName’: None,
‘primaryPhoneName’: None,
‘ringSettingIdleBlfAudibleAlert’: None,
‘ringSettingBusyBlfAudibleAlert’: None,
‘userLocale’: None,
‘networkLocale’: None,
‘idleTimeout’: None,
‘authenticationUrl’: None,
‘directoryUrl’: None,
‘idleUrl’: None,
‘informationUrl’: None,
‘messagesUrl’: None,
‘proxyServerUrl’: None,
‘servicesUrl’: None,
‘softkeyTemplateName’: None,
‘loginUserId’: None,
‘defaultProfileName’: None,
‘enableExtensionMobility’: None,
‘currentProfileName’: None,
‘loginTime’: None,
‘loginDuration’: None,
‘currentConfig’: None,
‘singleButtonBarge’: None,
‘joinAcrossLines’: None,
‘builtInBridgeStatus’: None,
‘callInfoPrivacyStatus’: None,
‘hlogStatus’: None,
‘ownerUserName’: None,
‘ignorePresentationIndicators’: None,
‘packetCaptureMode’: None,
‘packetCaptureDuration’: None,
‘subscribeCallingSearchSpaceName’: None,
‘rerouteCallingSearchSpaceName’: None,
‘allowCtiControlFlag’: None,
‘presenceGroupName’: None,
‘unattendedPort’: None,
‘requireDtmfReception’: None,
‘rfc2833Disabled’: None,
‘certificateOperation’: None,
‘authenticationMode’: None,
‘keySize’: None,
‘keyOrder’: None,
‘ecKeySize’: None,
‘authenticationString’: None,
‘certificateStatus’: None,
‘upgradeFinishTime’: None,
‘deviceMobilityMode’: None,
‘roamingDevicePoolName’: None,
‘remoteDevice’: None,
‘dndOption’: None,
‘dndRingSetting’: None,
‘dndStatus’: None,
‘isActive’: None,
‘isDualMode’: None,
‘mobilityUserIdName’: None,
‘phoneSuite’: None,
‘phoneServiceDisplay’: None,
‘isProtected’: None,
‘mtpRequired’: None,
‘mtpPreferedCodec’: None,
‘dialRulesName’: None,
‘sshUserId’: None,
‘digestUser’: None,
‘outboundCallRollover’: None,
‘hotlineDevice’: None,
‘secureInformationUrl’: None,
‘secureDirectoryUrl’: None,
‘secureMessageUrl’: None,
‘secureServicesUrl’: None,
‘secureAuthenticationUrl’: None,
‘secureIdleUrl’: None,
‘alwaysUsePrimeLine’: None,
‘alwaysUsePrimeLineForVoiceMessage’: None,
‘featureControlPolicy’: None,
‘deviceTrustMode’: None,
‘earlyOfferSupportForVoiceCall’: None,
‘requireThirdPartyRegistration’: None,
‘blockIncomingCallsWhenRoaming’: None,
‘homeNetworkId’: None,
‘AllowPresentationSharingUsingBfcp’: None,
‘confidentialAccess’: None,
‘requireOffPremiseLocation’: None,
‘allowiXApplicableMedia’: None,
‘enableCallRoutingToRdWhenNoneIsActive’: None,
‘ctiid’: None,
‘uuid’: ‘{81F827A6-3B58-F7F0-39BF-DBA51E81B606}’
}
]
},
‘sequence’: None
}
As I mentioned, if you don’t declare you want to have your argument being returned, it will be displayed as None.
Right. Now, you have to use your Python skills to take any action based on your output.
For example, if you want to isolate the returned tags to save them in a variable, you can use a For Loop to do something like that:
And the result will be this:
Now, you can use the Cisco DevNet AXL Schema Reference to explore all possibilities you have.
You can, for example, add new phones, new lines…
Adding Lines
According to the Schema, you don’t have Search Criteria or Returned Tags in the addLine request.
So, the code you be like this:
This is the line we’ve just added:
As I always say…now, sky is the limit!
You can do whatever you want by following the Schema….like add/delete/list Phones, lines, Device Pool, Device Profile, etc, etc, etc…
Hope you liked it
See you!
Whole Code
from zeep import Client
from zeep.cache import SqliteCache
from zeep.transports import Transport
from zeep.exceptions import Fault
from zeep.plugins import HistoryPlugin
from requests import Session
from requests.auth import HTTPBasicAuth
from urllib3 import disable_warnings
from urllib3.exceptions import InsecureRequestWarning
from lxml import etree
disable_warnings(InsecureRequestWarning)
username = ‘admin’
password = ‘Cisco123’
hostIP = ‘192.168.1.10’
location = ‘https://192.168.1.10:8443/axl/’.format(host=hostIP)
binding = “{http://www.cisco.com/AXLAPIService/}AXLAPIBinding”
wsdl = ‘file://C:/Users/user123/AppData/Local/Programs/Python/Python38-32/axlsqltoolkit/schema/11.5/AXLAPI.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])
service = client.create_service(binding, location)
def show_history():
for hist in [history.last_sent, history.last_received]:
print(etree.tostring(hist[“envelope”], encoding=”unicode”, pretty_print=True))
try:
resp = service.listPhone(searchCriteria={‘name’: ‘SEP0004F2F01F1A’},
returnedTags={‘name’: ”, ‘description’: ”,
‘model’: ”, ‘devicePoolName’: ”})
print(resp)
except Fault:
show_history()
phone_list = resp[‘return’].phone
for phone in phone_list:
print(phone[‘name’])
print(phone[‘description’])
print(phone[‘model’])
print(phone[‘devicePoolName’]._value_1)
try:
resp = service.addLine(line={‘pattern’: ‘707080’, ‘usage’: ‘Device’,
‘description’: ‘Test’, ‘routePartitionName’: ‘ONCLUSTER’})
print(resp)
except Fault:
show_history()
to send this request. The Response will show up at right:
