-
Notifications
You must be signed in to change notification settings - Fork 0
/
esight_connector.py
436 lines (345 loc) · 15 KB
/
esight_connector.py
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# !/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Author: Gonçalo Leal (goncalolealsilva@ua.pt)
# Date: 28-05-2022
# Description:
# eSight Adapter to get 5G Core metrics
import time
import json
import logging
import requests
from esight_exceptions import CouldNotLoginOnEsight, UnexpectedError
class Esight_Connector:
auth_token = ""
expires_at = ""
system_id = "NMSinfo3"
def __init__(self, address, username, password):
logging.basicConfig(format='[%(levelname)s] - %(asctime)s -> %(message)s', level=logging.INFO, datefmt='%d-%m-%Y %H:%M:%S')
self.address = address
self.username = username
self.password = password
self.authenticate()
# DECORATORS
# Auth Decorator
def requires_auth(func, *args, **kwargs):
def wrapper(self, *args, **kwargs):
try:
self.update_auth_token()
return func(self, *args, **kwargs)
except Exception as e:
logging.exception("Auth Required: To call this function you need to be authenticated in eSight! - " + str(e))
raise UnexpectedError("Auth Required: To call this function you need to be authenticated in eSight! - " + str(e))
return wrapper
def update_auth_token(self):
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.get(
f"https://{self.address}/network/port",
headers = {
"openid": f"{self.auth_token}"
},
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["description"] == "openid auth failed.":
self.authenticate()
elif response_data["description"] != "Operation success":
raise UnexpectedError("Something happened, check your connection.")
def authenticate(self):
try:
data = json.dumps({
"userid": self.username,
"value": self.password,
})
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.put(
f"https://{self.address}/sm/session",
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
},
data = data,
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["description"] == "Operation success.":
self.auth_token = response_data["data"]
else:
raise CouldNotLoginOnEsight()
except:
raise CouldNotLoginOnEsight()
@requires_auth
def get_interfaces_list(self):
try:
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.get(
f"https://{self.address}/network/port",
headers = {
'openid': f'{self.auth_token}'
},
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(f"get_interfaces_list: Something happened, could not get sending rate for interface {name}.")
raise UnexpectedError(f"Something happened, could not get sending rate for interface {name}.")
return []
logging.info("get_interfaces_list: OK")
return response_data["data"]
except:
logging.exception(f"get_interfaces_list: Error")
raise CouldNotLoginOnEsight()
return []
@requires_auth
def create_task(self, task_id, nedn, name, resource_type, group_key, indicators_data, period):
try:
data = json.dumps({
'systemID': self.system_id,
'taskID': task_id,
'neDN': nedn,
'subResourceName': name,
'subResourceType': resource_type,
'indicatorsGroupKey': group_key,
'indicatorsData': indicators_data,
'periodType': period
})
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.put(
f"https://{self.address}/pm/realtimePerformance",
headers = {
'openid': f'{self.auth_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
},
data = data,
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(response_data)
logging.exception(f"create_task: Something happened, could not create task for {name}.")
return False
logging.info("create_task: OK")
return True
except:
logging.exception(f"create_task: Error")
raise UnexpectedError(f"Something happened, could not create task for {name}.")
return False
@requires_auth
def delete_task(self, task_id):
try:
data = json.dumps({
'systemID': self.system_id,
'taskID': task_id
})
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.delete(
f"https://{self.address}/pm/realtimePerformance",
headers = {
'openid': f'{self.auth_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
},
data = data,
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(f"delete_task: Something happened, could not create task for {name}.")
raise UnexpectedError(f"Something happened, could not create task for {name}.")
logging.info("delete_task: OK")
except:
logging.exception("delete_task: Error")
raise UnexpectedError(f"Something happened, could not create task for {name}.")
def get_interface_sending_rate(self, nedn, name, start, finish):
try:
data = json.dumps({
'mos': '[{"dn": "'+ nedn +'", "displayValue": "'+ name +'"}]',
'indexKeys': '[{"resourceType":"interface","measUnitKey":"ifXTrafficStat","measTypeKey":"ifHCOutOctetsSpeed"}]',
'beginTime': start,
'endTime': finish
})
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.post(
f"https://{self.address}/pm/historyByIndexKeys",
headers = {
'openid': f'{self.auth_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
},
data = data,
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(f"get_interface_sending_rate: Something happened, could not get sending rate for interface {name}.")
raise UnexpectedError(f"Something happened, could not get sending rate for interface {name}.")
return json.loads({})
logging.info("get_interface_sending_rate: OK")
return response_data
except:
logging.exception("get_interface_sending_rate: Error")
raise UnexpectedError(f"Something happened, could not get sending rate for interface {name}.")
return json.loads({})
def get_interface_receiving_rate(self, nedn, name, start, finish):
try:
data = json.dumps({
'mos': '[{"dn": "'+ nedn +'", "displayValue": "'+ name +'"}]',
'indexKeys': '[{"resourceType":"interface","measUnitKey":"ifXTrafficStat","measTypeKey":"ifHCInOctetsSpeed"}]',
'beginTime': start,
'endTime': finish
})
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.post(
f"https://{self.address}/pm/historyByIndexKeys",
headers = {
'openid': f'{self.auth_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
},
data = data,
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(f"get_interface_receiving_rate: Something happened, could not get receiving rate for interface {name}.")
raise UnexpectedError(f"Something happened, could not get receiving rate for interface {name}.")
return json.loads({})
logging.info("get_interface_receiving_rate: OK")
return response_data
except:
logging.exception("get_interface_receiving_rate: Error")
raise UnexpectedError(f"Something happened, could not get receiving rate for interface {name}.")
return json.loads({})
@requires_auth
def get_network_devices_list(self):
try:
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.get(
f"https://{self.address}/network/nedevice",
headers = {
'openid': f'{self.auth_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
},
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(f"get_network_devices_list: Something happened, could not get receiving rate for interface {name}.")
raise UnexpectedError(f"Something happened, could not get receiving rate for interface {name}.")
return []
logging.info("get_network_devices_list: OK")
return response_data["data"]
except:
logging.exception("get_network_devices_list: Error")
raise CouldNotLoginOnEsight()
return []
@requires_auth
def get_slots_list(self, nedn):
try:
data = json.dumps({
'nedn': nedn
})
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.get(
f"https://{self.address}/network/slot",
headers = {
'openid': f'{self.auth_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
},
data = data,
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(f"get_slots_list: Something happened, could not get receiving rate for interface {name}.")
raise UnexpectedError(f"Something happened, could not get receiving rate for interface {name}.")
return []
logging.info("get_slots_list: OK")
return response_data["data"]
except:
logging.exception("get_slots_list: Error")
raise CouldNotLoginOnEsight()
return []
def get_task_metrics(self, nedn, name, resource_type, unit_key, type_key, start, finish):
try:
data = json.dumps({
'mos': '[{"dn": "'+ nedn +'", "displayValue": "'+ name +'"}]',
'indexKeys': '[{"resourceType":"'+ resource_type +'","measUnitKey": "'+ unit_key +'","measTypeKey":"'+ type_key +'"}]',
'beginTime': start,
'endTime': finish
})
# Avoid getting "Adding certificate verification is strongly advised" warnings
requests.packages.urllib3.disable_warnings()
response = requests.post(
f"https://{self.address}/pm/historyByIndexKeys",
headers = {
'openid': f'{self.auth_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
},
data = data,
timeout = 5,
verify = False
)
# check response status
response.raise_for_status()
# get data
response_data = json.loads(response.text)
if response_data["code"] != 0:
logging.info(f"get_task_metrics: Something happened, could not get task metrics {name}.")
raise UnexpectedError(f"Something happened, could not get task metrics {name}.")
return json.loads({})
logging.info("get_task_metrics: OK")
return response_data["data"]
except:
logging.exception("get_task_metrics: Error")
raise UnexpectedError(f"Something happened, could not get task metrics {name}.")
return json.loads({})