forked from roland-gsell/check_proxmox_backups
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pyproxmox.py
561 lines (446 loc) · 20.3 KB
/
pyproxmox.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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
"""
A python wrapper for the Proxmox 2.x API.
Example usage:
1) Create an instance of the prox_auth class by passing in the
url or ip of a server, username and password:
a = prox_auth('vnode01.example.org','apiuser@pve','examplePassword')
2) Create and instance of the pyproxmox class using the auth object as a parameter:
b = pyproxmox(a)
3) Run the pre defined methods of the pyproxmox class. NOTE: they all return data, usually in JSON format:
status = b.getClusterStatus('vnode01')
For more information see https://github.com/Daemonthread/pyproxmox.
"""
import requests
# Authentication class
class prox_auth:
"""
The authentication class, requires three strings:
1. An IP/resolvable url (minus the https://)
2. Valid username, including the @pve or @pam
3. A password
Creates the required ticket and CSRF prevention token for future connections.
Designed to be instanciated then passed to the new pyproxmox class as an init parameter.
"""
def __init__(self, url, username, password):
self.url = url
self.connect_data = {"username": username, "password": password}
self.full_url = "https://%s:8006/api2/json/access/ticket" % (self.url)
self.response = requests.post(self.full_url, verify=False, data=self.connect_data)
self.returned_data = self.response.json()
self.ticket = {'PVEAuthCookie': self.returned_data['data']['ticket']}
self.CSRF = self.returned_data['data']['CSRFPreventionToken']
# The meat and veg class
class pyproxmox:
"""
A class that acts as a python wrapper for the Proxmox 2.x API.
Requires a valid instance of the prox_auth class when initializing.
GET and POST methods are currently implemented along with quite a few
custom API methods.
"""
# INIT
def __init__(self, auth_class):
"""Take the prox_auth instance and extract the important stuff"""
self.url = auth_class.url
self.ticket = auth_class.ticket
self.CSRF = auth_class.CSRF
def connect(self, conn_type, option, post_data):
"""
The main communication method.
"""
self.full_url = "https://%s:8006/api2/json/%s" % (self.url, option)
httpheaders = {'Accept': 'application/json', 'Content-Type': 'application/x-www-form-urlencoded'}
if conn_type == "post":
httpheaders['CSRFPreventionToken'] = str(self.CSRF)
self.response = requests.post(self.full_url, verify=False,
data=post_data,
cookies=self.ticket,
headers=httpheaders)
elif conn_type == "put":
httpheaders['CSRFPreventionToken'] = str(self.CSRF)
self.response = requests.put(self.full_url, verify=False,
data=post_data,
cookies=self.ticket,
headers=httpheaders)
elif conn_type == "delete":
httpheaders['CSRFPreventionToken'] = str(self.CSRF)
self.response = requests.delete(self.full_url, verify=False,
data=post_data,
cookies=self.ticket,
headers=httpheaders)
elif conn_type == "get":
self.response = requests.get(self.full_url, verify=False,
cookies=self.ticket)
try:
self.returned_data = self.response.json()
return self.returned_data
except Exception:
print("Error in trying to process JSON")
print(self.response)
"""
Methods using the GET protocol to communicate with the Proxmox API.
"""
# Cluster Methods
def getClusterStatus(self):
"""Get cluster status information. Returns JSON"""
data = self.connect('get', 'cluster/status', None)
return data
def getClusterBackupSchedule(self):
"""List vzdump backup schedule. Returns JSON"""
data = self.connect('get', 'cluster/backup', None)
return data
def getClusterVmNextId(self):
"""Get next VM ID of cluster. Returns JSON"""
data = self.connect('get', 'cluster/nextid', None)
return data
def getClusterConfig(self):
"""Get cluster config. Returns JSON"""
data = self.connect('get', 'cluster/config', None)
return data
def getClusterResources(self):
"""Get cluster resources. Returns JSON"""
data = self.connect('get', 'cluster/resources', None)
return data
# Node Methods
def getNodeNetworks(self, node):
"""List available networks. Returns JSON"""
data = self.connect('get', 'nodes/%s/network' % (node), None)
return data
def getNodeInterface(self, node, interface):
"""Read network device configuration. Returns JSON"""
data = self.connect('get', 'nodes/%s/network/%s' % (node, interface), None)
return data
def getNodeContainerIndex(self, node):
"""OpenVZ container index (per node). Returns JSON"""
data = self.connect('get', 'nodes/%s/openvz' % (node), None)
return data
def getNodeVirtualIndex(self, node):
"""Virtual machine index (per node). Returns JSON"""
data = self.connect('get', 'nodes/%s/qemu' % (node), None)
return data
def getNodeServiceList(self, node):
"""Service list. Returns JSON"""
data = self.connect('get', 'nodes/%s/services' % (node), None)
return data
def getNodeServiceState(self, node, service):
"""Read service properties"""
data = self.connect('get', 'nodes/%s/services/%s/state' % (node, service), None)
return data
def getNodeStorage(self, node):
"""Get status for all datastores. Returns JSON"""
data = self.connect('get', 'nodes/%s/storage' % (node), None)
return data
def getNodeFinishedTasks(self, node):
"""Read task list for one node (finished tasks). Returns JSON"""
data = self.connect('get', 'nodes/%s/tasks' % (node), None)
return data
def getNodeDNS(self, node):
"""Read DNS settings. Returns JSON"""
data = self.connect('get', 'nodes/%s/dns' % (node), None)
return data
def getNodeStatus(self, node):
"""Read node status. Returns JSON"""
data = self.connect('get', 'nodes/%s/status' % (node), None)
return data
def getNodeSyslog(self, node):
"""Read system log. Returns JSON"""
data = self.connect('get', 'nodes/%s/syslog' % (node), None)
return data
def getNodeRRD(self, node):
"""Read node RRD statistics. Returns PNG"""
data = self.connect('get', 'nodes/%s/rrd' % (node), None)
return data
def getNodeRRDData(self, node):
"""Read node RRD statistics. Returns RRD"""
data = self.connect('get', 'nodes/%s/rrddata' % (node), None)
return data
def getNodeBeans(self, node):
"""Get user_beancounters failcnt for all active containers. Returns JSON"""
data = self.connect('get', 'nodes/%s/ubfailcnt' % (node), None)
return data
def getNodeTaskByUPID(self, node, upid):
"""Get tasks by UPID. Returns JSON"""
data = self.connect('get', 'nodes/%s/tasks/%s' % (node, upid), None)
return data
def getNodeTaskLogByUPID(self, node, upid):
"""Read task log. Returns JSON"""
data = self.connect('get', 'nodes/%s/tasks/%s/log' % (node, upid), None)
return data
def getNodeTaskStatusByUPID(self, node, upid):
"""Read task status. Returns JSON"""
data = self.connect('get', 'nodes/%s/tasks/%s/status' % (node, upid), None)
return data
# Scan
def getNodeScanMethods(self, node):
"""Get index of available scan methods"""
data = self.connect('get', 'nodes/%s/scan' % (node), None)
return data
def getRemoteiSCSI(self, node):
"""Scan remote iSCSI server."""
data = self.connect('get', 'nodes/%s/scan/iscsi' % (node), None)
return data
def getNodeLVMGroups(self, node):
"""Scan local LVM groups"""
data = self.connect('get', 'nodes/%s/scan/lvm' % (node), None)
return data
def getRemoteNFS(self, node):
"""Scan remote NFS server"""
data = self.connect('get', 'nodes/%s/scan/nfs' % (node), None)
return data
def getNodeUSB(self, node):
"""List local USB devices"""
data = self.connect('get', 'nodes/%s/scan/usb' % (node), None)
return data
# OpenVZ Methods
def getContainerIndex(self, node, vmid):
"""Directory index. Returns JSON"""
data = self.connect('get', 'nodes/%s/openvz/%s' % (node, vmid), None)
return data
def getContainerStatus(self, node, vmid):
"""Get virtual machine status. Returns JSON"""
data = self.connect('get', 'nodes/%s/openvz/%s/status/current' % (node, vmid), None)
return data
def getContainerBeans(self, node, vmid):
"""Get container user_beancounters. Returns JSON"""
data = self.connect('get', 'nodes/%s/openvz/%s/status/ubc' % (node, vmid), None)
return data
def getContainerConfig(self, node, vmid):
"""Get container configuration. Returns JSON"""
data = self.connect('get', 'nodes/%s/openvz/%s/config' % (node, vmid), None)
return data
def getContainerInitLog(self, node, vmid):
"""Read init log. Returns JSON"""
data = self.connect('get', 'nodes/%s/openvz/%s/initlog' % (node, vmid), None)
return data
def getContainerRRD(self, node, vmid):
"""Read VM RRD statistics. Returns PNG"""
data = self.connect('get', 'nodes/%s/openvz/%s/rrd' % (node, vmid), None)
return data
def getContainerRRDData(self, node, vmid):
"""Read VM RRD statistics. Returns RRD"""
data = self.connect('get', 'nodes/%s/openvz/%s/rrddata' % (node, vmid), None)
return data
# KVM Methods
def getVirtualIndex(self, node, vmid):
"""Directory index. Returns JSON"""
data = self.connect('get', 'nodes/%s/qemu/%s' % (node, vmid), None)
return data
def getVirtualStatus(self, node, vmid):
"""Get virtual machine status. Returns JSON"""
data = self.connect('get', 'nodes/%s/qemu/%s/status/current' % (node, vmid), None)
return data
def getVirtualConfig(self, node, vmid):
"""Get virtual machine configuration. Returns JSON"""
data = self.connect('get', 'nodes/%s/qemu/%s/config' % (node, vmid), None)
return data
def getVirtualRRD(self, node, vmid):
"""Read VM RRD statistics. Returns JSON"""
data = self.connect('get', 'nodes/%s/qemu/%s/rrd' % (node, vmid), None)
return data
def getVirtualRRDData(self, node, vmid):
"""Read VM RRD statistics. Returns JSON"""
data = self.connect('get', 'nodes/%s/qemu/%s/rrddata' % (node, vmid), None)
return data
# Storage Methods
def getStorageVolumeData(self, node, storage, volume):
"""Get volume attributes. Returns JSON"""
data = self.connect('get', 'nodes/%s/storage/%s/content/%s' % (node, storage, volume), None)
return data
def getStorageConfig(self, storage):
"""Read storage config. Returns JSON"""
data = self.connect('get', 'storage/%s' % (storage), None)
return data
def getNodeStorageContent(self, node, storage):
"""List storage content. Returns JSON"""
data = self.connect('get', 'nodes/%s/storage/%s/content' % (node, storage), None)
return data
def getNodeStorageRRD(self, node, storage):
"""Read storage RRD statistics. Returns JSON"""
data = self.connect('get', 'nodes/%s/storage/%s/rrd' % (node, storage), None)
return data
def getNodeStorageRRDData(self, node, storage):
"""Read storage RRD statistics. Returns JSON"""
data = self.connect('get', 'nodes/%s/storage/%s/rrddata' % (node, storage), None)
return data
"""
Methods using the POST protocol to communicate with the Proxmox API.
"""
# OpenVZ Methods
def createOpenvzContainer(self, node, post_data):
"""
Create or restore a container. Returns JSON
Requires a dictionary of tuples formatted [('postname1','data'),('postname2','data')]
"""
data = self.connect('post', 'nodes/%s/openvz' % (node), post_data)
return data
def mountOpenvzPrivate(self, node, vmid):
"""Mounts container private area. Returns JSON"""
post_data = None
data = self.connect('post', 'nodes/%s/openvz/%s/status/mount' % (node, vmid), post_data)
return data
def shutdownOpenvzContainer(self, node, vmid):
"""Shutdown the container. Returns JSON"""
post_data = None
data = self.connect('post', 'nodes/%s/openvz/%s/status/shutdown' % (node, vmid), post_data)
return data
def startOpenvzContainer(self, node, vmid):
"""Start the container. Returns JSON"""
post_data = None
data = self.connect('post', 'nodes/%s/openvz/%s/status/start' % (node, vmid), post_data)
return data
def stopOpenvzContainer(self, node, vmid):
"""Stop the container. Returns JSON"""
post_data = None
data = self.connect('post', 'nodes/%s/openvz/%s/status/stop' % (node, vmid), post_data)
return data
def unmountOpenvzPrivate(self, node, vmid):
"""Unmounts container private area. Returns JSON"""
post_data = None
data = self.connect('post', 'nodes/%s/openvz/%s/status/unmount' % (node, vmid), post_data)
return data
def migrateOpenvzContainer(self, node, vmid, target):
"""Migrate the container to another node. Creates a new migration task. Returns JSON"""
post_data = {'target': str(target)}
data = self.connect('post', 'nodes/%s/openvz/%s/migrate' % (node, vmid), post_data)
return data
# KVM Methods
def createVirtualMachine(self, node, post_data):
"""
Create or restore a virtual machine. Returns JSON
"""
data = self.connect('post', "nodes/%s/qemu" % (node), post_data)
return data
def resetVirtualMachine(self, node, vmid):
"""Reset a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/status/reset" % (node, vmid), post_data)
return data
def resumeVirtualMachine(self, node, vmid):
"""Resume a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/status/resume" % (node, vmid), post_data)
return data
def shutdownVirtualMachine(self, node, vmid):
"""Shut down a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/status/shutdown" % (node, vmid), post_data)
return data
def startVirtualMachine(self, node, vmid):
"""Start a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/status/start" % (node, vmid), post_data)
return data
def stopVirtualMachine(self, node, vmid):
"""Stop a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/status/stop" % (node, vmid), post_data)
return data
def suspendVirtualMachine(self, node, vmid):
"""Suspend a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/status/suspend" % (node, vmid), post_data)
return data
def migrateVirtualMachine(self, node, vmid, target):
"""Migrate a virtual machine. Returns JSON"""
post_data = {'target': str(target)}
data = self.connect('post', "nodes/%s/qemu/%s/status/start" % (node, vmid), post_data)
return data
def monitorVirtualMachine(self, node, vmid, command):
"""Send monitor command to a virtual machine. Returns JSON"""
post_data = {'command': str(command)}
data = self.connect('post', "nodes/%s/qemu/%s/monitor" % (node, vmid), post_data)
return data
def vncproxyVirtualMachine(self, node, vmid):
"""Creates a VNC Proxy for a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/vncproxy" % (node, vmid), post_data)
return data
def rollbackVirtualMachine(self, node, vmid, snapname):
"""Rollback a snapshot of a virtual machine. Returns JSON"""
post_data = None
data = self.connect('post', "nodes/%s/qemu/%s/snapshot/%s/rollback" % (node, vmid, snapname), post_data)
return data
def getSnapshotConfigVirtualMachine(self, node, vmid, snapname):
"""Get snapshot config of a virtual machine. Returns JSON"""
post_data = None
data = self.connect('get', "nodes/%s/qemu/%s/snapshot/%s/config" % (node, vmid, snapname), post_data)
return data
"""
Methods using the DELETE protocol to communicate with the Proxmox API.
"""
# OPENVZ
def deleteOpenvzContainer(self, node, vmid):
"""Deletes the specified openvz container"""
data = self.connect('delete', "nodes/%s/openvz/%s" % (node, vmid), None)
return data
# NODE
def deleteNodeNetworkConfig(self, node):
"""Revert network configuration changes."""
data = self.connect('delete', "nodes/%s/network" % (node), None)
return data
def deleteNodeInterface(self, node, interface):
"""Delete network device configuration"""
data = self.connect('delete', "nodes/%s/network/%s" % (node, interface), None)
return data
# KVM
def deleteVirtualMachine(self, node, vmid):
"""Destroy the vm (also delete all used/owned volumes)."""
data = self.connect('delete', "nodes/%s/qemu/%s" % (node, vmid), None)
return data
# POOLS
def deletePool(self, poolid):
"""Delete Pool"""
data = self.connect('delete', "pools/%s" (poolid), None)
return data
# STORAGE
def deleteStorageConfiguration(self, storageid):
"""Delete storage configuration"""
data = self.connect('delete', "storage/%s" % (storageid), None)
return data
"""
Methods using the PUT protocol to communicate with the Proxmox API.
"""
# NODE
def setNodeDNSDomain(self, node, domain):
"""Set the nodes DNS search domain"""
post_data = {'search': str(domain)}
data = self.connect('put', "nodes/%s/dns" % (node), post_data)
return data
def setNodeSubscriptionKey(self, node, key):
"""Set the nodes subscription key"""
post_data = {'key': str(key)}
data = self.connect('put', "nodes/%s/subscription" % (node), post_data)
return data
def setNodeTimeZone(self, node, timezone):
"""Set the nodes timezone"""
post_data = {'timezone': str(timezone)}
data = self.connect('put', "nodes/%s/time" % (node), post_data)
return data
# OPENVZ
def setOpenvzContainerOptions(self, node, vmid, post_data):
"""Set openvz virtual machine options."""
data = self.connect('put', "nodes/%s/openvz/%s/config" % (node, vmid), post_data)
return data
# KVM
def setVirtualMachineOptions(self, node, vmid, post_data):
"""Set KVM virtual machine options."""
data = self.connect('put', "nodes/%s/qemu/%s/config" % (node, vmid), post_data)
return data
def sendKeyEventVirtualMachine(self, node, vmid, key):
"""Send key event to virtual machine"""
post_data = {'key': str(key)}
data = self.connect('put', "nodes/%s/qemu/%s/sendkey" % (node, vmid), post_data)
return data
def unlinkVirtualMachineDiskImage(self, node, vmid, post_data):
"""Unlink disk images"""
data = self.connect('put', "nodes/%s/qemu/%s/unlink" % (node, vmid), post_data)
return data
# POOLS
def setPoolData(self, poolid, post_data):
"""Update pool data."""
data = self.connect('put', "pools/%s" (poolid), post_data)
return data
# STORAGE
def updateStorageConfiguration(self, storageid, post_data):
"""Update storage configuration"""
data = self.connect('put', "storage/%s" % (storageid), post_data)
return data