-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathcluster_node_check.py
442 lines (377 loc) · 14.6 KB
/
cluster_node_check.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
435
436
437
438
439
440
441
442
"""
-------------------------------------------------------------------------------
Written by Thomas Munzer ([email protected])
Github repository: https://github.com/tmunzer/Mist_library/
This script is licensed under the MIT License.
-------------------------------------------------------------------------------
Python script to retrieve the role of each Gateway Cluster nodes across a
whole Organization.
-------
Requirements:
mistapi: https://pypi.org/project/mistapi/
-------
Usage:
This script can be run as is (without parameters), or with the options below.
If no options are defined, or if options are missing, the missing options will
be asked by the script or the default values will be used.
It is recommended to use an environment file to store the required information
to request the Mist Cloud (see https://pypi.org/project/mistapi/ for more
information about the available parameters).
-------
Script Parameters:
-h, --help display this help
-o, --org_id= Mist Org ID
-c, --csv_file= output file (csv)
default: ./cluster_node_check.csv
-d, --datetime append the current date and time (ISO format) to the
backup name
-t, --timestamp append the timestamp at the end of the report and summary files
-l, --log_file= define the filepath/filename where to write the logs
default is "./script.log"
-e, --env= define the env file to use (see mistapi env file
documentation here: https://pypi.org/project/mistapi/)
default is "~/.mist_env"
-------
Examples:
python3 ./cluster_node_check.py
python3 ./cluster_node_check.py -o 203d3d02-xxxx-xxxx-xxxx-76896a3330f4
"""
#####################################################################
#### IMPORTS ####
import logging
import sys
import getopt
import datetime
import tabulate
MISTAPI_MIN_VERSION = "0.46.1"
try:
import mistapi
from mistapi.__logger import console
except:
print(
"""
Critical:
\"mistapi\" package is missing. Please use the pip command to install it.
# Linux/macOS
python3 -m pip install mistapi
# Windows
py -m pip install mistapi
"""
)
sys.exit(2)
#####################################################################
#### PARAMETERS #####
LOG_FILE = "./script.log"
ENV_FILE = "~/.mist_env"
CSV_FILE = "./cluster_node_check.csv"
#####################################################################
#### LOGS ####
LOGGER = logging.getLogger(__name__)
#####################################################################
# PROGRESS BAR AND DISPLAY
class ProgressBar:
def __init__(self):
self.steps_total = 0
self.steps_count = 0
def _pb_update(self, size: int = 80):
if self.steps_count > self.steps_total:
self.steps_count = self.steps_total
percent = self.steps_count / self.steps_total
delta = 17
x = int((size - delta) * percent)
print(f"Progress: ", end="")
print(f"[{'█'*x}{'.'*(size-delta-x)}]", end="")
print(f"{int(percent*100)}%".rjust(5), end="")
def _pb_new_step(
self,
message: str,
result: str,
inc: bool = False,
size: int = 80,
display_pbar: bool = True,
):
if inc:
self.steps_count += 1
text = f"\033[A\033[F{message}"
print(f"{text} ".ljust(size + 4, "."), result)
print("".ljust(80))
if display_pbar:
self._pb_update(size)
def _pb_title(
self, text: str, size: int = 80, end: bool = False, display_pbar: bool = True
):
print("\033[A")
print(f" {text} ".center(size, "-"), "\n\n")
if not end and display_pbar:
print("".ljust(80))
self._pb_update(size)
def set_steps_total(self, steps_total: int):
self.steps_total = steps_total
def log_message(self, message, display_pbar: bool = True):
self._pb_new_step(message, " ", display_pbar=display_pbar)
def log_success(self, message, inc: bool = False, display_pbar: bool = True):
LOGGER.info(f"{message}: Success")
self._pb_new_step(
message, "\033[92m\u2714\033[0m\n", inc=inc, display_pbar=display_pbar
)
def log_warning(self, message, inc: bool = False, display_pbar: bool = True):
LOGGER.warning(f"{message}: Warning")
self._pb_new_step(
message, "\033[93m\u2B58\033[0m\n", inc=inc, display_pbar=display_pbar
)
def log_failure(self, message, inc: bool = False, display_pbar: bool = True):
LOGGER.error(f"{message}: Failure")
self._pb_new_step(
message, "\033[31m\u2716\033[0m\n", inc=inc, display_pbar=display_pbar
)
def log_title(self, message, end: bool = False, display_pbar: bool = True):
LOGGER.info(message)
self._pb_title(message, end=end, display_pbar=display_pbar)
PB = ProgressBar()
#####################################################################
#### FUNCTIONS ####
def get_device_stats(
apisession: mistapi.APISession,
org_id: str
):
message = "retrieving gateway stats"
PB.log_message(message, display_pbar=False)
try:
resp = mistapi.api.v1.orgs.stats.listOrgDevicesStats(apisession, org_id, "gateway", fields="*")
if resp.status_code == 200:
data = mistapi.get_all(apisession, resp)
PB.log_success(message, inc=False, display_pbar=False)
return data
else:
PB.log_failure(message, inc=False, display_pbar=False)
sys.exit(1)
except:
PB.log_failure(message, inc=False, display_pbar=False)
LOGGER.error("Exception occurred", exc_info=True)
sys.exit(1)
def process_device_stats(data: list):
message = f"processing {len(data)} gateways"
PB.log_message(message, display_pbar=False)
clusters = []
for device in data:
if device.get("is_ha"):
cluster_mac = device.get("id").split("-")[4]
cluster_device_id = device.get("id")
cluster_hostname = device.get("hostname")
cluster_site_id = device.get("site_id")
node0_mac = device.get("module_stat", {})[0].get("mac")
node0_role = device.get("module_stat", {})[0].get("vc_role")
node1_mac = device.get("module2_stat", {})[0].get("mac")
node1_role = device.get("module2_stat", {})[0].get("vc_role")
if cluster_mac == node0_mac:
clusters.append({
"site_id": cluster_site_id,
"hostname": cluster_hostname,
"device_id": cluster_device_id,
"node0_mac":node0_mac,
"node0_role":node0_role,
"node1_mac":node1_mac,
"node1_role":node1_role,
})
else:
clusters.append({
"site_id": cluster_site_id,
"hostname": cluster_hostname,
"device_id": cluster_device_id,
"node0_mac":node1_mac,
"node0_role":node1_role,
"node1_mac":node0_mac,
"node1_role":node0_role,
})
PB.log_success(message, inc=False, display_pbar=False)
return clusters
def save_result(clusters: list, csv_file: str, append_dt:bool, append_ts:bool):
message=f"saving result to {csv_file}"
PB.log_message(message, display_pbar=False)
try:
if append_dt:
dt = datetime.datetime.isoformat(datetime.datetime.now()).split('.')[0].replace(':','.')
csv_file = f"{csv_file.replace('.csv', f'_{dt}')}.csv"
elif append_ts:
ts = round(datetime.datetime.timestamp(datetime.datetime.now()))
csv_file = f"{csv_file.replace('.csv', f'_{ts}')}.csv"
with open(csv_file, "w") as f:
f.write("site_id,hostname,device_id,node0_mac,node0_role,node1_mac,node1_role\n")
for c in clusters:
f.write(f"{c.get('site_id')},{c.get('hostname')},{c.get('device_id')},{c.get('node0_mac')},{c.get('node0_role')},{c.get('node1_mac')},{c.get('node1_role')}\n")
PB.log_success(message, inc=False, display_pbar=False)
except:
PB.log_failure(message, inc=False, display_pbar=False)
LOGGER.error("Exception occurred", exc_info=True)
def start(
apisession: mistapi.APISession,
org_id: str,
csv_file: str="./cluster_node_check.csv",
append_dt:bool=False,
append_ts:bool=False
):
"""
Start the process to rename the devices
PARAMS
-------
apisession : mistapi.APISession
mistapi session, already logged in
org_id : str
csv_file : str, default: ./cluster_node_check.csv
output file (csv)
append_dt : bool
append the current date and time (ISO format) to the backup name
append_ts : bool
append the timestamp at the end of the report and summary files
"""
LOGGER.debug("start")
LOGGER.debug(f"start:parameter:org_id:{org_id}")
print()
print()
if not org_id:
org_id = mistapi.cli.select_org(apisession)[0]
if not csv_file:
csv_file = CSV_FILE
data = get_device_stats(apisession, org_id)
clusters = process_device_stats(data)
save_result(clusters, csv_file, append_dt, append_ts)
print(tabulate.tabulate(clusters, headers={
"site_id":"site_id",
"hostname":"hostname",
"device_id":"device_id",
"node0_mac":"node0_mac",
"node0_role":"node0_role",
"node1_mac":"node1_mac",
"node1_role":"node1_role"
}))
print()
print(f"{len(clusters)} clusters detected across the whole organization ({len(data)} gateways)")
print(f"results saved to {csv_file}")
#####################################################################
##### USAGE ####
def usage(error_message: str = None):
"""
display usage
PARAMS
-------
error_message : str
if error_message is set, display it after the usage
"""
print(
"""
-------------------------------------------------------------------------------
Written by Thomas Munzer ([email protected])
Github repository: https://github.com/tmunzer/Mist_library/
This script is licensed under the MIT License.
-------------------------------------------------------------------------------
Python script to retrieve the role of each Gateway Cluster nodes across a
whole Organization.
-------
Requirements:
mistapi: https://pypi.org/project/mistapi/
-------
Usage:
This script can be run as is (without parameters), or with the options below.
If no options are defined, or if options are missing, the missing options will
be asked by the script or the default values will be used.
It is recommended to use an environment file to store the required information
to request the Mist Cloud (see https://pypi.org/project/mistapi/ for more
information about the available parameters).
-------
Script Parameters:
-h, --help display this help
-o, --org_id= Mist Org ID
-c, --csv_file= output file (csv)
default: ./cluster_node_check.csv
-d, --datetime append the current date and time (ISO format) to the
backup name
-t, --timestamp append the timestamp at the end of the report and summary files
-l, --log_file= define the filepath/filename where to write the logs
default is "./script.log"
-e, --env= define the env file to use (see mistapi env file
documentation here: https://pypi.org/project/mistapi/)
default is "~/.mist_env"
-------
Examples:
python3 ./cluster_node_check.py
python3 ./cluster_node_check.py -o 203d3d02-xxxx-xxxx-xxxx-76896a3330f4
"""
)
if error_message:
console.critical(error_message)
sys.exit(0)
def check_mistapi_version():
if mistapi.__version__ < MISTAPI_MIN_VERSION:
LOGGER.critical(
f'"mistapi" package version {MISTAPI_MIN_VERSION} is required, you are currently using version {mistapi.__version__}.'
)
LOGGER.critical(f"Please use the pip command to updated it.")
LOGGER.critical("")
LOGGER.critical(f" # Linux/macOS")
LOGGER.critical(f" python3 -m pip install --upgrade mistapi")
LOGGER.critical("")
LOGGER.critical(f" # Windows")
LOGGER.critical(f" py -m pip install --upgrade mistapi")
print(
f"""
Critical:
\"mistapi\" package version {MISTAPI_MIN_VERSION} is required, you are currently using version {mistapi.__version__}.
Please use the pip command to updated it.
# Linux/macOS
python3 -m pip install --upgrade mistapi
# Windows
py -m pip install --upgrade mistapi
"""
)
sys.exit(2)
else:
LOGGER.info(
f'"mistapi" package version {MISTAPI_MIN_VERSION} is required, '
f"you are currently using version {mistapi.__version__}."
)
#####################################################################
##### ENTRY POINT ####
if __name__ == "__main__":
try:
opts, args = getopt.getopt(
sys.argv[1:],
"ho:c:e:l:dt",
["help", "org_id=", "csv_file=", "env=", "log_file=","timestamp","datetime"],
)
except getopt.GetoptError as err:
console.error(err)
usage()
ORG_ID = None
APPEND_DT = False
APPEND_TS = False
for o, a in opts:
if o in ["-h", "--help"]:
usage()
elif o in ["-o", "--org_id"]:
ORG_ID = a
elif o in ["-c", "--csv_file"]:
CSV_FILE = a
elif o in ["-d", "--datetime"]:
if APPEND_TS:
usage("Invalid Parameters: \"-d\"/\"--date\" and \"-t\"/\"--timestamp\" are exclusive")
else:
APPEND_DT = True
elif o in ["-t", "--timestamp"]:
if APPEND_DT:
usage("Invalid Parameters: \"-d\"/\"--date\" and \"-t\"/\"--timestamp\" are exclusive")
else:
APPEND_TS = True
elif o in ["-e", "--env"]:
ENV_FILE = a
elif o in ["-l", "--log_file"]:
LOG_FILE = a
else:
assert False, "unhandled option"
#### LOGS ####
logging.basicConfig(filename=LOG_FILE, filemode="w")
LOGGER.setLevel(logging.DEBUG)
check_mistapi_version()
### START ###
APISESSION = mistapi.APISession(env_file=ENV_FILE, show_cli_notif=False)
APISESSION.login()
start(APISESSION, ORG_ID, CSV_FILE, APPEND_DT, APPEND_TS)