"""AXL addRegion sample script, using the Zeep SOAP library Creates a new Device Pool, then creates a new Media Resource Group List and updates the Device Pool. Copyright (c) 2018 Cisco and/or its affiliates. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ from lxml import etree from requests import Session from requests.auth import HTTPBasicAuth from zeep import Client, Settings, Plugin, xsd from zeep.transports import Transport from zeep.exceptions import Fault import sys # Edit .env file to specify your Webex site/user details import os from dotenv import load_dotenv load_dotenv() # Change to true to enable output of request/response headers and XML DEBUG = False # The WSDL is a local file in the working directory, see README WSDL_FILE = 'AXLAPI.wsdl' CUCM_URL = 'https://10.1.240.88:8443/axl/' USERNAME = 'administrator' PASSWORD = 'P@ssw0rd123' # This class lets you view the incoming and outgoing http headers and XML class MyLoggingPlugin( Plugin ): def egress( self, envelope, http_headers, operation, binding_options ): # Format the request body as pretty printed XML xml = etree.tostring( envelope, pretty_print = True, encoding = 'unicode') print( f'\nRequest\n-------\nHeaders:\n{http_headers}\n\nBody:\n{xml}' ) def ingress( self, envelope, http_headers, operation ): # Format the response body as pretty printed XML xml = etree.tostring( envelope, pretty_print = True, encoding = 'unicode') print( f'\nResponse\n-------\nHeaders:\n{http_headers}\n\nBody:\n{xml}' ) # The first step is to create a SOAP client session session = Session() # We avoid certificate verification by default session.verify = False # To enabled SSL cert checking (recommended for production) # place the CUCM Tomcat cert .pem file in the root of the project # and uncomment the line below # session.verify = 'changeme.pem' # Add Basic Auth credentials session.auth = HTTPBasicAuth(USERNAME, PASSWORD) # Create a Zeep transport and set a reasonable timeout value transport = Transport( session = session, timeout = 10 ) # strict=False is not always necessary, but it allows zeep to parse imperfect XML settings = Settings( strict = False, xml_huge_tree = True ) # If debug output is requested, add the MyLoggingPlugin callback plugin = [ MyLoggingPlugin() ] if DEBUG else [ ] # Create the Zeep client with the specified settings client = Client( WSDL_FILE, settings = settings, transport = transport, plugins = plugin ) # Create the Zeep service binding to AXL at the specified CUCM service = client.create_service("{http://www.cisco.com/AXLAPIService/}AXLAPIBinding", CUCM_URL) # Create a test Region region = { 'name': 'testRegion', 'relatedRegions': { 'relatedRegion': [] } } # Create a relatedRegion sub object related_region = { 'regionName': 'testRegionn', 'bandwidth': '76 kbps', 'videoBandwidth': '512', 'lossyNetwork': 'Low Loss', 'codecPreference': 'Factory Default low loss', 'immersiveVideoBandwidth' : '1024', } # Add the relatedRegion to the region.relatedRegions array region['relatedRegions']['relatedRegion'].append( related_region ) # Execute the addRegion request try: resp = service.addRegion( region ) except Fault as err: print( f'Zeep error: addRegion: { err }' ) sys.exit( 1 ) print( '\naddRegion response:\n' ) print( resp,'\n' ) input( 'Press Enter to continue...' ) # Cleanup the objects we just created try: resp = service.removeRegion( name = 'testRegion') except Fault as err: print( f'Zeep error: removeRegion: { err }' ) sys.exit( 1 ) print( '\nremoveRegion response:' ) print( resp, '\n' )