forked from ttarvis/node-proxmox
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathDocumentation.html
20370 lines (20282 loc) · 330 KB
/
Documentation.html
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<head>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<title>Proxmox API Documentation</title>
</head>
<body>
<div class="backtotopcontainer" style="position: fixed;">
<a href="#index"> <button type="button" name="button" value="">back to index</button> </a>
</div>
<div class="container-fluid">
<div class="row">
<div class="col-md-1"></div>
<div class="col-md-1">
<h2 id="index">Index</h2>
<b>vm functions</b>
<span>hover over for info</span>
<span title="returns a list of all Vm's on that node"><a href="#getQemu">getQemu()</a></span>
<span title="Creates a new VM"><a href="#makeQemu">createQemu()</a></span>
<span title="Gets details about requested VM"><a href="#qemu.get">qemu.get()</a></span>
<span title="Deletes requested VM"><a href="#qemu.del">qemu.del()</a></span>
<br> <br>
<span title="returns list of firewall info"><a href="#qemu.firewall.list">qemu.firewall.list()</a></span>
<span title="return list of firewall rules"><a href="#qemu.firewall.listRules">qemu.firewall.listRules()</a></span>
<span title="creates a new ruleset for firewall"><a href="#qemu.firewall.createRule">qemu.firewall.createRule()</a></span>
<span title="gets specific info on a firewall rule"><a href="#qemu.firewall.getRule">qemu.firewall.getRule()</a></span>
<span title="updates the given firewall rule"><a href="#qemu.firewall.updateRule">qemu.firewall.updateRule()</a></span>
<span title="deletes a rule from the firewall"><a href="#qemu.firewall.deleteRule">qemu.firewall.deleteRule()</a></span>
<span title="returns a list of aliases the firewall knows"><a href="#qemu.firewall.listAlias">qemu.firewall.listAlias()</a></span>
<span title="adds a new alias to the firewall"><a href="#qemu.firewall.createAlias">qemu.firewall.createAlias()</a></span>
<span title="gets detailed info of requested alias"><a href="#qemu.firewall.getAlias">qemu.firewall.getAlias()</a></span>
<span title="updates alias"><a href="#qemu.firewall.updateAlias">qemu.firewall.updateAlias()</a></span>
<span title="deletes alias"><a href="#qemu.firewall.deleteAlias">qemu.firewall.deleteAlias()</a></span>
<span title="returns a list of ip sets"><a href="#qemu.firewall.listIpset">qemu.firewall.listIpset()</a></span>
<span title="creates a new ip set"><a href="#qemu.firewall.createIpset">qemu.firewall.createIpset()</a></span>
<span title="gets content of an ipset"><a href="#qemu.firewall.getIpsetContent">qemu.firewall.getIpsetContent()</a></span>
<span title="adds a given ip to the ipset"><a href="#qemu.firewall.addIpToIpset">qemu.firewall.addIpToIpset()</a></span>
<span title="deletes an ipset"><a href="#qemu.firewall.deleteIpset">qemu.firewall.deleteIpset()</a></span>
<span title="gets an ip from an ipset"><a href="#qemu.firewall.getIpfromIpset">qemu.firewall.getIpfromIpset()</a></span>
<span title="updates an ip from an ipset"><a href="#qemu.firewall.updateIpfromIpset">qemu.firewall.updateIpfromIpset()</a></span>
<span title="deletes an ip from an ipset"><a href="#qemu.firewall.deleteIpfromIpset">qemu.firewall.deleteIpfromIpset()</a></span>
<span title="gets the setting of a firewall"><a href="#qemu.firewall.getOptions">qemu.firewall.getOptions()</a></span>
<span title="sets the settings for a firewall"><a href="#qemu.firewall.setOptions">qemu.firewall.setOptions()</a></span>
<span title="gets the logs from a firewall"><a href="#qemu.firewall.getLog">qemu.firewall.getLog()</a></span>
<span title="gets the refs from a firewall"><a href="#qemu.firewall.getRefs">qemu.firewall.getRefs()</a></span>
<br> <br>
<span title="gets the status of a VM"><a href="#qemu.getStatus">qemu.getStatus()</a></span>
<span title="gets the current status of a VM"><a href="#qemu.getStatusCurrent">qemu.getStatusCurrent()</a></span>
<span title="start a VM"><a href="#qemu.start">qemu.start()</a></span>
<span title="stops a VM"><a href="#qemu.stop">qemu.stop()</a></span>
<span title="resets a VM"><a href="#qemu.reset">qemu.reset()</a></span>
<span title="shuts a VM down"><a href="#qemu.shutdown">qemu.shutdown()</a></span>
<span title="suspends a VM"><a href="#qemu.suspend">qemu.suspend()</a></span>
<span title="resumes a VM"><a href="#qemu.resume">qemu.resume()</a></span>
<br> <br>
<span title="returns a list of snapshots the vm has"><a href="#qemu.snapshot.list">qemu.snapshot.list()</a></span>
<span title="makes a new snapshot of the vm"><a href="#qemu.snapshot.make">qemu.snapshot.make()</a></span>
<span title="gets details about a snapshot of the vm"><a href="#qemu.snapshot.get">qemu.snapshot.get()</a></span>
<span title="deletes a snapshot from the vm"><a href="#qemu.snapshot.delete">qemu.snapshot.delete()</a></span>
<span title="gets the settings of the snapshot"><a href="#qemu.snapshot.getConfig">qemu.snapshot.getConfig()</a></span>
<span title="updates the settings of a snapshot"><a href="#qemu.snapshot.putConfig">qemu.snapshot.putConfig()</a></span>
<span title="rolls a vm back to the snapshot state"><a href="#qemu.snapshot.rollback">qemu.snapshot.rollback()</a></span>
<br> <br>
<span title="gets the rrd"><a href="#qemu.rrd">qemu.rrd()</a></span>
<span title="gets the rrd data"><a href="#qemu.rrdData">qemu.rrdData()</a></span>
<span title="gets the config of the Vm"><a href="#qemu.getConfig">qemu.getConfig()</a></span>
<span title="updates the config of the VM"><a href="#qemu.updateConfig">qemu.updateConfig()</a></span>
<span title="sets the config of a vm"><a href="#qemu.setConfig">qemu.setConfig()</a></span>
<span title="gets info about a Vm including pending changes"><a href="#qemu.pending">qemu.pending()</a></span>
<span title="unlinks a vm"><a href="#qemu.unlink">qemu.unlink()</a></span>
<span title="vncproxy"><a href="#qemu.vncproxy">qemu.vncproxy()</a></span>
<span title="vncwebsocket"><a href="#qemu.vncwebsocket">qemu.vncwebsocket()</a></span>
<span title="spiceproxy"><a href="#qemu.spiceproxy">qemu.spiceproxy()</a></span>
<span title="sends a key to the vm"><a href="#qemu.sendkey">qemu.sendkey()</a></span>
<span title="checks if the Vm has a requested feature"><a href="#qemu.feature">qemu.feature()</a></span>
<span title="clones a vm"><a href="#qemu.clone">qemu.clone()</a></span>
<span title="moves a disk"><a href="#qemu.moveDisk">qemu.moveDisk()</a></span>
<span title="migrates a vm"><a href="#qemu.migrate">qemu.migrate()</a></span>
<span title="monitors a vm"><a href="#qemu.monitor">qemu.monitor()</a></span>
<span title="resizes a vm"><a href="#qemu.resize">qemu.resize()</a></span>
<span title="creates a template of the VM"><a href="#qemu.template">qemu.template()</a></span>
<br> <br>
<b>network functions</b>
<span>hover over for info</span>
<span title="returns a list of all interfaces"><a href="#network.list">network.list()</a></span>
<span title="creates a new interface"><a href="#network.create">network.create()</a></span>
<span title="deletes all interfaces"><a href="#network.delete">network.delete()</a></span>
<span title="gets details of requested interface"><a href="#network.get">network.get()</a></span>
<span title="updates the interface"><a href="#network.update">network.update()</a></span>
<span title="deletes the interface"><a href="#network.deleteIface">network.deleteIface()</a></span>
<br> <br>
<b>access functions </b>
<span>hover over for info</span>
<span title="returns a list of all users"><a href="#access.listUsers">access.listUsers()</a></span>
<span title="creates a new user"><a href="#access.createUser">access.createUser()</a></span>
<span title="get details about user"><a href="#access.getUser">access.getUser()</a></span>
<span title="updates a users info"><a href="#access.updateUser">access.updateUser()</a></span>
<span title="deletes a user"><a href="#access.deleteUser">access.deleteUser()</a></span>
<br> <br>
<span title="lists all groups"><a href="#access.listGroups">access.listGroups()</a></span>
<span title="creates a new group"><a href="#access.createGroup">access.createGroup()</a></span>
<span title="gets details about a group"><a href="#access.getGroup">access.getGroup()</a></span>
<span title="updates a groups info"><a href="#access.updateGroup">access.updateGroup()</a></span>
<span title="deletes a group"><a href="#access.deleteGroup">access.deleteGroup()</a></span>
<br> <br>
<span title="returns a list of all roles"><a href="#access.listRoles">access.listRoles()</a></span>
<span title="creates a new role"><a href="#access.createRole">access.createRole()</a></span>
<span title="gets details about a role"><a href="#access.getRole">access.getRole()</a></span>
<span title="updates a role"><a href="#access.updateRole">access.updateRole()</a></span>
<span title="deletes a role"><a href="#access.deleteRole">access.deleteRole()</a></span>
<br> <br>
<span title="returns a list of all domains / realms"><a href="#access.listDomains">access.listDomains()</a></span>
<span title="creates a new domain"><a href="#access.createDomain">access.createDomain()</a></span>
<span title="gets details about a domain"><a href="#access.getDomain">access.getDomain()</a></span>
<span title="updates a domain"><a href="#access.updateDomain">access.updateDomain()</a></span>
<span title="deletes a domain"><a href="#access.deleteDomain">access.deleteDomain()</a></span>
<br> <br>
<span title="gets acl"><a href="#access.getAcl">access.getAcl()</a></span>
<span title="sets the acl"><a href="#access.updateAcl">access.updateAcl()</a></span>
<span title="gets ticket"><a href="#access.getTicket">access.getTicket()</a></span>
<span title="posts a ticket"><a href="#access.postTicket">access.postTicket()</a></span>
<span title="changes a password"><a href="#access.password">access.password()</a></span>
<br> <br>
<b>pool functions</b>
<span title="returns a list of all pools"><a href="#pools.list">pools.list()</a></span>
<span title="creates a new pool"><a href="#pools.create">pools.create()</a></span>
<span title="gets details about a pool"><a href="#pools.get">pools.get()</a></span>
<span title="updates a pool"><a href="#pools.update">pools.update()</a></span>
<span title="deletes a pool"><a href="#pools.delete">pools.delete()</a></span>
<br> <br>
<b>storage functions</b>
<span title="returns a list of all storage devices"><a href="#storage.list">storage.list()</a></span>
<span title="creates a new storage partition"><a href="#storage.create">storage.create()</a></span>
<span title="gets details about partition"><a href="#storage.get">storage.get()</a></span>
<span title="updates a partition"><a href="#storage.update">storage.update()</a></span>
<span title="deletes a partition"><a href="#storage.delete">storage.delete()</a></span>
</div>
<div class="col-md-10"></div>
</div>
<div class="row">
<div class="col-md-1"> </div>
<div class="col-md-10">
<h2>
/nodes/{node}/qemu <br> Proxmox.getQemu(node, callback) <br> Proxmox.postQemu(node, data, callback)
</h2>
<div class="JSexample" id="getQemu" >
<div class="row">
<div class="col-md-1"></div>
<div class="col-md-3" style="border: 1px solid grey">
<span>Proxmox = require('proxmox')('user','password','server');</span>
<span>Proxmox.getQemu('testNode', function (err, data) { </span>
<span> if (err) { </span>
<span> throw err; </span>
<span>} else { </span>
<span> console.log(data); </span>
<span> } </span>
<span> }); </span>
</div>
<div class="col-md-8"></div>
</div>
</div>
<br>
<div class="JSexample" id="makeQemu">
<div class="row">
<div class="col-md-1"></div>
<div class="col-md-3" style="border: 1px solid grey">
<span>Proxmox = require('proxmox')('user','password','server');</span>
<span>Proxmox.createQemu('testNode',{paramaters}, function (err, data) { </span>
<span> if (err) { </span>
<span> throw err; </span>
<span>} else { </span>
<span> console.log(data); </span>
<span> } </span>
<span> }); </span>
</div>
<div class="col-md-8"></div>
</div>
</div>
<b>
GET
</b>
<i>
Description:
</i>
<i>
Permissions:
</i>
<table class=".table table-striped table-bordered">
<thead>
<tr>
<th scope="col" width="100px">
User
</th>
<th scope="col">
Permissions
</th>
<th scope="col">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
all
</td>
<td>
N/A
</td>
<td>
Only list VMs where you have VM.Audit permissons on /vms/
<vmid>
.
</vmid>
</td>
</tr>
</tbody>
</table>
<i>
Parameters:
</i>
<table class=".table table-striped table-bordered">
<thead>
<tr>
<th scope="col" width="100px">
Name
</th>
<th scope="col" width="100px">
Type
</th>
<th scope="col" width="100px">
Format
</th>
<th scope="col">
Description
</th>
<th scope="col">
Optional
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
node
</td>
<td>
string
</td>
<td>
pve-node
</td>
<td>
The cluster node name.
</td>
<td>
</td>
</tr>
</tbody>
</table>
<i>
Return:
</i>
<table class=".table table-striped table-bordered">
<thead>
<tr>
<th scope="col" width="100px">
Name
</th>
<th scope="col" width="100px">
Type
</th>
<th scope="col" width="100px">
Format
</th>
<th scope="col">
Description
</th>
<th scope="col">
Optional
</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
<i>
Usage:
</i>
<b>
POST
</b>
<i>
Description:
</i>
<i>
Permissions:
</i>
<table class=".table table-striped table-bordered">
<thead>
<tr>
<th scope="col" width="100px">
User
</th>
<th scope="col">
Permissions
</th>
<th scope="col">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
all
</td>
<td>
N/A
</td>
<td>
You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. For restore (option 'archive') it is enough if the user has 'VM.Backup' permission and the VM already exists. If you create disks you need 'Datastore.AllocateSpace' on any used storage.
</td>
</tr>
</tbody>
</table>
<i>
Parameters:
</i>
<table class=".table table-striped table-bordered">
<thead>
<tr>
<th scope="col" width="100px">
Name
</th>
<th scope="col" width="100px">
Type
</th>
<th scope="col" width="100px">
Format
</th>
<th scope="col">
Description
</th>
<th scope="col">
Optional
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
cdrom
</td>
<td>
string
</td>
<td>
pve-qm-drive
</td>
<td>
This is an alias for option -ide2
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
force
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Allow to overwrite existing VM.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
boot
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
Boot on floppy (a) hard disk (c) CD-ROM (d) or network (n).
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
startup
</td>
<td>
string
</td>
<td>
pve-startup-order
</td>
<td>
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds which specifies a delay to wait before the next VM is started or stopped.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
agent
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Enable/disable Qemu GuestAgent.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
vga
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8 and 'cirrur' for other OS types. Option 'qxl' enables the SPICE display sever. You can also run without any graphic card using a serial devive as terminal.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
parallel[n]
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
Map host parallel devices (n is 0 to 2).
<p>
</p>
<p>
Note: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
</p>
<p>
Experimental: user reported problems with this option.
</p>
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
numa[n]
</td>
<td>
string
</td>
<td>
pve-qm-numanode
</td>
<td>
numa topology
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
keyboard
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
Keybord layout for vnc server. Default is read from the datacenter configuration file.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
watchdog
</td>
<td>
string
</td>
<td>
pve-qm-watchdog
</td>
<td>
Create a virtual hardware watchdog device. Once enabled (by a guest action) the watchdog must be periodically polled by an agent inside the guest or else the guest will be restarted (or execute the action specified)
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
bootdisk
</td>
<td>
string
</td>
<td>
pve-qm-bootdisk
</td>
<td>
Enable booting from specified disk.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
sockets
</td>
<td>
integer
</td>
<td>
N/A
</td>
<td>
The number of CPU sockets.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
template
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Enable/disable Template.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
net[n]
</td>
<td>
string
</td>
<td>
pve-qm-net
</td>
<td>
Specify network devices.
<p>
</p>
<p>
MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
</p>
<p>
XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
<br>
automatically generated if not specified.
</br>
</p>
<p>
The bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
</p>
<p>
Option 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number unit is 'Megabytes per second'.
</p>
<p>
If you specify no bridge we create a kvm 'user' (NATed) network device which provides DHCP and DNS services. The following addresses are used:
</p>
<p>
10.0.2.2 Gateway
<br>
10.0.2.3 DNS Server
<br>
10.0.2.4 SMB Server
</br>
</br>
</p>
<p>
The DHCP server assign addresses to the guest starting from 10.0.2.15.
</p>
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
hotplug
</td>
<td>
string
</td>
<td>
pve-hotplug-features
</td>
<td>
Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network' 'disk' 'cpu' 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'networkdiskusb'.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
archive
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
The backup file.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
balloon
</td>
<td>
integer
</td>
<td>
N/A
</td>
<td>
Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
cpuunits
</td>
<td>
integer
</td>
<td>
N/A
</td>
<td>
CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
<p>
</p>
<p>
NOTE: You can disable fair-scheduler configuration by setting this to 0.
</p>
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
storage
</td>
<td>
string
</td>
<td>
pve-storage-id
</td>
<td>
Default storage.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
reboot
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Allow reboot. If set to '0' the VM exit on reboot.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
shares
</td>
<td>
integer
</td>
<td>
N/A
</td>
<td>
Amount of memory shares for auto-ballooning. The larger the number is the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
serial[n]
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
Create a serial device inside the VM (n is 0 to 3) and pass through a host serial device (i.e. /dev/ttyS0) or create a unix socket on the host side (use 'qm terminal' to open a terminal connection).
<p>
</p>
<p>
Note: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
</p>
<p>
Experimental: user reported problems with this option.
</p>
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
machine
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
Specific the Qemu machine type.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
freeze
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Freeze CPU at startup (use 'c' monitor command to start execution).
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
smp
</td>
<td>
integer
</td>
<td>
N/A
</td>
<td>
The number of CPUs. Please use option -sockets instead.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
tablet
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Enable/disable the usb tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host you may consider disabling this to save some context switches. This is turned of by default if you use spice (vga=qxl).
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
autostart
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Automatic restart after crash (currently ignored).
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
lock
</td>
<td>
string
</td>
<td>
N/A
</td>
<td>
Lock/unlock the VM.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
migrate_downtime
</td>
<td>
number
</td>
<td>
N/A
</td>
<td>
Set maximum tolerated downtime (in seconds) for migrations.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
ide[n]
</td>
<td>
string
</td>
<td>
pve-qm-drive
</td>
<td>
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
localtime
</td>
<td>
boolean
</td>
<td>
N/A
</td>
<td>
Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
</td>
<td>
<center>
<img src="purpletick.gif" style="filter: sepia(100%);"/>
</center>
</td>
</tr>
<tr>
<td>
node
</td>
<td>
string
</td>
<td>