forked from CiscoDevNet/axl-python-zeep-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaxl_add_Remote_Destination.py
More file actions
205 lines (159 loc) · 6.76 KB
/
axl_add_Remote_Destination.py
File metadata and controls
205 lines (159 loc) · 6.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
"""AXL <addRemoteDestination> sample script, using the Zeep SOAP library
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
# import requests
from requests import Session
from requests.auth import HTTPBasicAuth
from zeep import Client, Settings, Plugin
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 = 'schema/AXLAPI.wsdl'
# 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 enable SSL cert checking (recommended for production)
# place the CUCM Tomcat cert .pem file in the root of the project
# and uncomment the two lines below
# CERT = 'changeme.pem'
# session.verify = CERT
session.auth = HTTPBasicAuth( os.getenv( 'USERNAME' ), os.getenv( 'PASSWORD' ) )
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',
f'https://{os.getenv( "CUCM_ADDRESS" )}:8443/axl/' )
# Create an End User
end_user = {
'lastName': 'testEndUser',
'userid': 'testEndUser',
'presenceGroupName': 'Standard Presence Group',
'enableMobility': True
}
# Execute the addUser request
try:
resp = service.addUser( end_user )
except Fault as err:
print("Zeep error: addUser: {0}".format( err ) )
else:
print( "\naddUser response:\n" )
print( resp,"\n" )
input( 'Press Enter to continue...' )
# Create and associate a Remote Destination Profile
remote_destination_profile = {
'name': 'testRemoteDestinationProfile',
'product': 'Remote Destination Profile',
'class': 'Remote Destination Profile',
'protocol': 'Remote Destination',
'protocolSide': 'User',
'devicePoolName': 'Default',
'callInfoPrivacyStatus': 'Default',
'userId': 'testEndUser'
}
# Execute the addRemoteDestinationProfile request
try:
resp = service.addRemoteDestinationProfile( remote_destination_profile )
except Fault as err:
print("Zeep error: addRemoteDestinationProfile: {0}".format( err ) )
else:
print( "\naddRemoteDestinationProfile response:\n" )
print( resp,"\n" )
input( 'Press Enter to continue...' )
# Create a Remote Destination
remote_destination = {
'name': 'testRemoteDestination',
'destination': '4055551212',
'answerTooSoonTimer': 1500,
'answerTooLateTimer': 19000,
'delayBeforeRingingCell': 4000,
'ownerUserId': 'testEndUser',
'enableUnifiedMobility': True,
'remoteDestinationProfileName': 'testRemoteDestinationProfile',
'isMobilePhone': True,
'enableMobileConnect': True
}
# Due to an issue with the AXL schema vs. implementation (11.5/12.5 - CSCvq98025)
# we have to remove the nil <dualModeDeviceName> element Zeep creates
# via the following lines
# Use the Zeep service to create an XML object of the request - don't send
node = client.create_message( service, 'addRemoteDestination', remoteDestination = remote_destination)
# Remove the dualModeDeviceName element
for element in node.xpath("//dualModeDeviceName"):
element.getparent().remove( element )
# Execute the addRemoteDestination request
# This has to be done a little differently since we want to send a custom payload
try:
resp = transport.post_xml(
f'https://{os.getenv( "CUCM_ADDRESS" )}:8443/axl/',
envelope = node,
headers = None
)
except Fault as err:
print("Zeep error: addRemoteDestination: {0}".format( err ) )
else:
print( "\naddRemoteDestination response:\n" )
print( resp.text,"\n" )
input( 'Press Enter to continue...' )
# Cleanup the objects we just created
try:
# removeRemoteDestination uses the destination vs the name
resp = service.removeRemoteDestination( destination = '4055551212' )
except Fault as err:
print( 'Zeep error: removeRemoteDestination: {err}'.format( err = err ) )
else:
print( '\nremoveRemoteDestination response:' )
print( resp, '\n' )
try:
resp = service.removeRemoteDestinationProfile( name = 'testRemoteDestinationProfile' )
except Fault as err:
print( 'Zeep error: remoteRemoveDestinationProfile: {err}'.format( err = err ) )
else:
print( '\nremoveRemoteDestinationProfile response:' )
print( resp, '\n' )
try:
resp = service.removeUser( userid = 'testEndUser' )
except Fault as err:
print( 'Zeep error: removeUser: {err}'.format( err = err ) )
else:
print( '\nremoveUser response:' )
print( resp, '\n' )