-
Notifications
You must be signed in to change notification settings - Fork 0
/
isi_snaplock.py
329 lines (299 loc) · 13.1 KB
/
isi_snaplock.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
from getpass import getpass
import argparse
import logging
import sys
import base64
import os
import datetime
import ipaddress
import json
import requests
import urllib3
import pandas as pd
def validateinput(ip):
"""This function checks for valid input"""
try:
ipaddress.ip_address(ip)
except ValueError:
print("\nPlease enter a valid IP address!\n")
sys.exit()
def printbanner():
"""This function prints a banner"""
print(
"""
Welcome to
____ _ _
/ ___| _ __ __ _ _ __ | | ___ ___| | __
\___ \| '_ \ / _` | '_ \| |/ _ \ / __| |/ /
___) | | | | (_| | |_) | | (_) | (__| <
|____/|_| |_|\__,_| .__/|_|\___/ \___|_|\_\\
|_|\n"""
)
def datetoepoch():
"""This function converts a datetime, checks validity, then returns epoch time"""
date_entry = input(
"\nType a date in YYYY-MM-DD-HH-MM-SS format (24h) or "
+ "leave blank for the lock to never expire and hit <enter>: \n"
)
if date_entry:
year, month, day, hour, minute, second = map(int, date_entry.split("-"))
expirydate = int(
datetime.datetime(year, month, day, hour, minute, second).timestamp()
)
currentdate = int(datetime.datetime.now().timestamp())
else:
return 0
if expirydate < currentdate:
print("\nDate entered must be greater than current date!\n")
datetoepoch()
else:
return expirydate
def getsession(uri):
"""This function gets a session and sets headers, returns session"""
creds = "creds.json"
if os.path.isfile(creds):
with open(creds, "r", encoding="utf-8") as f:
data = json.load(f)
user = data["username"]
p = base64.b64decode(data["password"]).decode("utf-8")
elif os.path.isfile(creds) is False:
user = input("Please provide your user name? \n")
print("\nPlease provide the password for your user account...\n")
p = getpass()
print("\n\nAttempting session to " + uri + " ...\n")
headers = {"Content-Type": "application/json"}
data = json.dumps({"username": user, "password": p, "services": ["platform"]})
api_session = requests.Session()
response = api_session.post(
uri + "/session/1/session", data=data, headers=headers, verify=False
)
if response.status_code == 200 or response.status_code == 201:
print("Session to " + uri + " established.\n")
logging.info("API session created successfully by " + user + " at " + uri)
elif response.status_code != 200 or response.status_code != 201:
print(
"\nSession to "
+ uri
+ " not established. Please check your password, user name, or IP and try again.\n"
)
logging.info("Creation of API session by " + user + " at " + uri + " unsuccessful")
sys.exit()
api_session.headers["referer"] = uri
api_session.headers["X-CSRF-Token"] = api_session.cookies.get("isicsrf")
return api_session, user
def getsnapshots(api_session, uri):
"""This function lists all Snapshots,then prompts to write to csv,
then prints the dataframe"""
resourceurl = "/platform/1/snapshot/snapshots"
snapresult = api_session[0].get(uri + resourceurl, verify=False)
if snapresult.status_code == 200 or snapresult.status_code == 201:
logging.info("GET request at by " + api_session[1] + " at " + uri + resourceurl + " successful")
snapresult = json.loads(snapresult.content.decode(encoding="UTF-8"))
elif snapresult.status_code != 200 or snapresult.status_code != 201:
logging.info("GET request at by " + api_session[1] + " at " + uri + resourceurl + " unsuccessful")
print(
"\nIssue encountered with retrieving snapshots at "
+ uri
+ " Please try again.\n"
)
return 0
pd.set_option("display.max_rows", None)
df = pd.DataFrame(
snapresult["snapshots"], columns=["id", "name", "path", "size", "has_locks"]
)
if df.empty:
print("\nThere are no snapshots!")
return 0
else:
csvinquiry = input(
"\nWould you also like a csv file of snapshots written to "
+ os.getcwd()
+ " ? (y/n): "
)
todaysdate = str(datetime.date.today())
if csvinquiry == "y":
csvpath = "snapshot_list_results_" + todaysdate + ".csv"
df.to_csv(csvpath, encoding="utf-8", index=False)
print("\n\nList of Snapshots:")
return print(df.to_string(index=False))
elif csvinquiry == "n":
print("\n\nList of Snapshots:")
return print(df.to_string(index=False))
else:
print(
"\nYou have entered a value other than (y) or (n) as a"
"response to writing csv file. Please try again.\n"
)
return 0
def locksnapshot(api_session, uri):
"""This function will lock a snapshot"""
print("\nBe advised, a single snapshot can only have a maximum of 16 locks.\n")
snapid = input("\nWhat is the ID of the snapshot you would like to lock?\n")
epoch = datetoepoch()
resourceurl = "/platform/12/snapshot/snapshots/" + snapid + "/locks"
lockcount = api_session[0].get(uri + resourceurl, verify=False)
if lockcount.status_code == 200 or lockcount.status_code == 201:
logging.info("GET request at by " + api_session[1] + " at " + uri + resourceurl + " successful")
lockcount = json.loads(lockcount.content.decode(encoding="UTF-8"))
elif lockcount.status_code != 200 or lockcount.status_code != 201:
logging.info("GET request at by " + api_session[1] + " at " + uri + resourceurl + " unsuccessful")
print(
"\nIssue encountered with retrieving the # of locks currently on Snapshot ID: "
+ snapid
+ " Please try again.\n"
)
displaymenu()
lockcount = lockcount["total"]
print(
"\nThere are currently "
+ str(lockcount)
+ " locks on Snapshot ID: "
+ snapid
+ ".\n"
)
if lockcount < 16:
print(
"\nYou can create "
+ str(16 - lockcount)
+ " more locks on the provided snapshot ID.\n"
)
print("\nProceeding with creation of snapshot lock...\n")
if epoch == 0:
noxdata = json.dumps({"comment": "This lock was created by isi_snaplock."})
response = api_session[0].post(uri + resourceurl, data=noxdata, verify=False)
if response.status_code == 200 or response.status_code == 201:
logging.info("POST request by " + api_session[1] + " at " + uri + resourceurl + " successful")
response = json.loads(response.content.decode(encoding="UTF-8"))
lockid = response["id"]
print("\nLock ID " + str(lockid) + " created.")
elif response.status_code != 200 or response.status_code != 201:
logging.info("POST request by " + api_session[1] + " at " + uri + resourceurl + " unsuccessful")
print("\nLock creation encountered an issue. Try again!")
elif epoch != 0:
xdata = json.dumps(
{"comment": "This lock was created by isi_snaplock.", "expires": epoch}
)
response = api_session[0].post(uri + resourceurl, data=xdata, verify=False)
if response.status_code == 200 or response.status_code == 201:
logging.info("POST requestby " + api_session[1] + " at " + uri + resourceurl + " successful")
response = json.loads(response.content.decode(encoding="UTF-8"))
lockid = response["id"]
print("\nLock ID " + str(lockid) + " created.\n")
elif response.status_code != 200 or response.status_code != 201:
logging.info("POST request by " + api_session[1] + " at " + uri + resourceurl + " unsuccessful")
print("\nLock creation encountered an issue. Try again!")
elif lockcount >= 16:
print(
"\nSnapshot ID: "
+ snapid
+ " has reached the maximum # of allowed locks.\n"
)
displaymenu()
def listlocks(api_session, uri):
"""This function will list all locks for a snapshot"""
snapid = input(
"\nWhat is the ID of the snapshot that you want to list all locks?\n"
)
resourceurl = "/platform/12/snapshot/snapshots/" + snapid + "/locks"
locklist = api_session[0].get(uri + resourceurl, verify=False)
if locklist.status_code == 200 or locklist.status_code == 201:
logging.info("GET request by " + api_session[1] + " at " + uri + resourceurl + " successful")
locklist = json.loads(locklist.content.decode(encoding="UTF-8"))
elif locklist.status_code != 200 or locklist.status_code != 201:
logging.info("GET request by " + api_session[1] + " at " + uri + resourceurl + " unsuccessful")
print(
"\nIssue encountered with retrieving the list of locks currently on Snapshot ID: "
+ snapid
+ " Please try again.\n"
)
displaymenu()
pd.set_option("display.max_rows", None)
df = pd.DataFrame(locklist["locks"], columns=["id", "expires", "comment", "count"])
if df.empty:
print("\nThere are no locks for Snapshot ID " + str(snapid) + "!\n")
else:
df["expires"] = pd.to_datetime(df["expires"], unit="s")
df.columns.values[1] = "expires(GMT)"
print("\n\nList of Locks for Snapshot ID " + str(snapid) + ": \n")
print(df.to_string(index=False))
print("\n\nTake note of the Lock ID!")
def delete1lock(api_session, uri):
"""This function will delete a snapshot lock"""
snapid = input("\nWhat is the ID of the snapshot that you want to delete a lock?\n")
lockid = input(
"\nWhat is the ID of the lock you want to delete for Snapshot ID "
+ str(snapid)
+ "?\n"
)
resourceurl = "/platform/12/snapshot/snapshots/" + snapid + "/locks/" + lockid
response = api_session[0].delete(uri + resourceurl, verify=False)
if response.status_code == 200 or response.status_code == 204:
logging.info("DELETE request by " + api_session[1] + " at " + uri + resourceurl + " successful")
print("\nLock ID " + str(lockid) + " deleted.")
elif response.status_code != 200 or response.status_code != 204:
logging.info("DELETE request by " + api_session[1] + " at " + uri + resourceurl + " unsuccessful")
print("\nLock deletion encountered an issue. Try again!\n")
def deletealllocks(api_session, uri):
"""This function will delete all locks for a snapshot"""
snapid = input(
"\nWhat is the ID of the snapshot that you want to delete ALL locks?\n"
)
resourceurl = "/platform/12/snapshot/snapshots/" + snapid + "/locks"
response = api_session[0].delete(uri + resourceurl, verify=False)
if response.status_code == 200 or response.status_code == 204:
logging.info("DELETE request by " + api_session[1] + " at " + uri + resourceurl + " successful")
print("\nAll locks deleted for Snapshot ID " + str(snapid))
elif response.status_code != 200 or response.status_code != 204:
logging.info("DELETE request by " + api_session[1] + " at " + uri + resourceurl + " unsuccessful")
print("\nLock deletion encountered an issue. Try again!\n")
def displaymenu():
"""This function displays the ChangeList Tool menu options"""
print("\nWhat would you like to do? (Type a number, hit <Enter>)")
userinput = input(
"[1] List ALL Snapshots [2] Lock a Snapshot\n"
"[3] List Locks for a Snapshot [4] Delete a Snapshot Lock\n"
"[5] Delete ALL Locks from a Snapshot [6] Quit Snaplock\n"
)
return userinput
def main():
"""This function is the main function that runs the isi_snaplock"""
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
parser = argparse.ArgumentParser(description="Menu driven snaplock tool")
parser.add_argument("ip", help="Enter a valid IP address")
args = parser.parse_args()
ip = args.ip
logging.basicConfig(
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
filename="isi_tools.log",
level=logging.INFO,
)
validateinput(ip)
printbanner()
port = 8080
uri = "https://" + str(ip) + ":" + str(port)
api_session = getsession(uri)
sentinel = 0
while sentinel == 0:
choice = displaymenu()
if choice == "1":
getsnapshots(api_session, uri)
print("\n\n")
elif choice == "2":
locksnapshot(api_session, uri)
print("\n\n")
elif choice == "3":
listlocks(api_session, uri)
print("\n\n")
elif choice == "4":
delete1lock(api_session, uri)
print("\n\n")
elif choice == "5":
deletealllocks(api_session, uri)
print("\n\n")
elif choice == "6":
sentinel = 1
break
elif choice < "1" or choice > "6":
print("\nERROR: Input is not a valid option. Please re-enter!\n")
if __name__ == "__main__":
main()