-
Notifications
You must be signed in to change notification settings - Fork 87
Expand file tree
/
Copy pathreference.html
More file actions
797 lines (646 loc) · 72.6 KB
/
Copy pathreference.html
File metadata and controls
797 lines (646 loc) · 72.6 KB
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
---
layout: default
title: Reference
parent: Scripting
---
<link rel="stylesheet" type="text/css" href="{% link assets/styles/reset.css %}">
<link rel="stylesheet" type="text/css" href="{% link assets/styles/dictionary.css %}">
<div class="suite" id="UTM-Suite">
<table class="suite"><tr>
<td>UTM Suite</td>
<td>UTM virtual machines scripting suite.</td>
</tr></table>
<div class="entry" id="UTM-Suite.make">
<p class="entry"><span class="name">make</span> <span class="annot">v</span> : <span class="description">Create a new virtual machine.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">make</span> </p>
<div class="entry">
<p class="entry"><span class="name">new</span> type : <span class="description">Specify 'virtual machine' here.</span></p>
</div>
<div class="entry">
<p class="entry"><span class="name">with properties</span> record : <span class="description">You must specify the backend as well as a configuration with a name. If this is a QEMU virtual machine, you must specify the architecture in the configuration as well.</span></p>
</div>
<div class="entry"><p class="entry">→ specifier : <span class="description">The new virtual machine (as a specifier).</span></p></div>
</div>
</div>
<div class="entry" id="UTM-Suite.application">
<p class="entry"><span class="name">application</span> <span class="annot">n</span> [see also <a href="#UTM-USB-Devices-Suite.application">UTM USB Devices Suite</a>] : <span class="description">An application's top level scripting object.</span></p>
<p class="label">Elements</p>
<p>contains <span><a href="#UTM-Suite.virtual-machine">virtual machines</a></span>.</p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Suite.application.auto-terminate">
<p class="entry"><span class="name">auto terminate</span> <span class="type">(boolean)</span> : <span class="description">Auto terminate the application when all windows are closed?</span></p>
</div>
<div class="entry" id="UTM-Suite.application.UTM-version">
<p class="entry"><span class="name">UTM version</span> <span class="type">(text, r/o)</span> : <span class="description">The version number of UTM.</span></p>
</div>
</div>
<div class="entry" id="UTM-Suite.backend">
<p class="entry"><span class="name">backend</span> <span class="annot">enum</span> : <span class="description">Backend type.</span></p>
<div class="entry"><p class="entry"><span class="name">apple</span> : <span class="description">Apple Virtualization.framework backend.</span></p></div>
<div class="entry"><p class="entry"><span class="name">qemu</span> : <span class="description">QEMU backend.</span></p></div>
<div class="entry"><p class="entry"><span class="name">unavailable</span> : <span class="description">The virtual machine is not currently available.</span></p></div>
</div>
<div class="entry" id="UTM-Suite.status">
<p class="entry"><span class="name">status</span> <span class="annot">enum</span> : <span class="description">Status type.</span></p>
<div class="entry"><p class="entry"><span class="name">stopped</span> : <span class="description">VM is not running.</span></p></div>
<div class="entry"><p class="entry"><span class="name">starting</span> : <span class="description">VM is starting up.</span></p></div>
<div class="entry"><p class="entry"><span class="name">started</span> : <span class="description">VM is running.</span></p></div>
<div class="entry"><p class="entry"><span class="name">pausing</span> : <span class="description">VM is going to pause.</span></p></div>
<div class="entry"><p class="entry"><span class="name">paused</span> : <span class="description">VM is paused.</span></p></div>
<div class="entry"><p class="entry"><span class="name">resuming</span> : <span class="description">VM is resuming from pause.</span></p></div>
<div class="entry"><p class="entry"><span class="name">stopping</span> : <span class="description">VM is stopping.</span></p></div>
</div>
<div class="entry" id="UTM-Suite.stop-method">
<p class="entry"><span class="name">stop method</span> <span class="annot">enum</span> : <span class="description">Stop by method.</span></p>
<div class="entry"><p class="entry"><span class="name">force</span> : <span class="description">Force stop VM by sending stop request to the backend.</span></p></div>
<div class="entry"><p class="entry"><span class="name">kill</span> : <span class="description">Force kill VM by terminating the backend.</span></p></div>
<div class="entry"><p class="entry"><span class="name">request</span> : <span class="description">Send a power down request to the guest OS which may be ignored.</span></p></div>
</div>
<div class="entry" id="UTM-Suite.serial-interface">
<p class="entry"><span class="name">serial interface</span> <span class="annot">enum</span> : <span class="description">Serial port interface.</span></p>
<div class="entry"><p class="entry"><span class="name">ptty</span> : <span class="description">Pseudo TTY port.</span></p></div>
<div class="entry"><p class="entry"><span class="name">tcp</span> : <span class="description">TCP port.</span></p></div>
<div class="entry"><p class="entry"><span class="name">unavailable</span> : <span class="description">Serial interface is currently unavailable or is in use by the GUI.</span></p></div>
</div>
<div class="entry" id="UTM-Suite.start">
<p class="entry"><span class="name">start</span> <span class="annot">v</span> : <span class="description">Start a virtual machine or resume a suspended virtual machine.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">start</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to start.</span></span></p>
<div class="entry">
<p class="entry">[<span class="name">saving</span> boolean] : <span class="description">When false, do not save the VM changes to disk. Default value is true.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">recovery</span> boolean] : <span class="description">When true, start the VM in recovery mode. Default value is false.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Suite.suspend">
<p class="entry"><span class="name">suspend</span> <span class="annot">v</span> : <span class="description">Suspend a running virtual machine to memory.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">suspend</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to suspend.</span></span></p>
<div class="entry">
<p class="entry">[<span class="name">saving</span> boolean] : <span class="description">Save VM state to disk after suspend. Default value is false.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Suite.stop">
<p class="entry"><span class="name">stop</span> <span class="annot">v</span> : <span class="description">Shuts down a running virtual machine.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">stop</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to stop.</span></span></p>
<div class="entry">
<p class="entry">[<span class="name">by</span> force/kill/request] : <span class="description">Method to stop the VM.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Suite.delete">
<p class="entry"><span class="name">delete</span> <span class="annot">v</span> : <span class="description">Delete a virtual machine. All data will be deleted, there is no confirmation!</span></p>
<div class="entry verb-summary"><p class="entry"><span class="name">delete</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">The virtual machine to delete.</span></span></p></div>
</div>
<div class="entry" id="UTM-Suite.duplicate">
<p class="entry"><span class="name">duplicate</span> <span class="annot">v</span> : <span class="description">Copy an virtual machine and all its data.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">duplicate</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">The virtual machine to copy.</span></span></p>
<div class="entry">
<p class="entry">[<span class="name">with properties</span> record] : <span class="description">Only the configuration can be changed.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Suite.import">
<p class="entry"><span class="name">import</span> <span class="annot">v</span> : <span class="description">Import a new virtual machine from a file.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">import</span> </p>
<div class="entry">
<p class="entry"><span class="name">new</span> type : <span class="description">Specify 'virtual machine' here.</span></p>
</div>
<div class="entry">
<p class="entry"><span class="name">from</span> file : <span class="description">The virtual machine file (.utm) to import.</span></p>
</div>
<div class="entry"><p class="entry">→ specifier : <span class="description">The new virtual machine (as a specifier).</span></p></div>
</div>
</div>
<div class="entry" id="UTM-Suite.export">
<p class="entry"><span class="name">export</span> <span class="annot">v</span> : <span class="description">Export a virtual machine to a specified location.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">export</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">The virtual machine to export.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">to</span> file : <span class="description">Location to export the VM to.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Suite.virtual-machine">
<p class="entry"><span class="name">virtual machine</span> <span class="annot">n</span> [see also <a href="#UTM-Guest-Suite.virtual-machine">UTM Guest Suite</a>, <a href="#UTM-Configuration-Suite.virtual-machine">UTM Configuration Suite</a>, <a href="#UTM-USB-Devices-Suite.virtual-machine">UTM USB Devices Suite</a>, <a href="#UTM-Registry-Suite.virtual-machine">UTM Registry Suite</a>, <a href="#UTM-Input-Automation-Suite.virtual-machine">UTM Input Automation Suite</a>] : <span class="description">A virtual machine registered in UTM.</span></p>
<p class="label">Elements</p>
<p>contains <span><a href="#UTM-Suite.serial-port">serial ports</a></span>; contained by <span>application</span>.</p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Suite.virtual-machine.id"><p class="entry"><span class="name">id</span> <span class="type">(text, r/o)</span> : <span class="description">The unique identifier of the VM.</span></p></div>
<div class="entry" id="UTM-Suite.virtual-machine.name"><p class="entry"><span class="name">name</span> <span class="type">(text, r/o)</span> : <span class="description">The name of the VM.</span></p></div>
<div class="entry" id="UTM-Suite.virtual-machine.backend"><p class="entry"><span class="name">backend</span> <span class="type">(apple/qemu/unavailable, r/o)</span> : <span class="description">Emulation/virtualization engine used.</span></p></div>
<div class="entry" id="UTM-Suite.virtual-machine.status"><p class="entry"><span class="name">status</span> <span class="type">(stopped/starting/started/pausing/paused/resuming/stopping, r/o)</span> : <span class="description">Current running status.</span></p></div>
<p class="label">responds to</p>
<a href="#UTM-Suite.start">start</a>, <a href="#UTM-Suite.suspend">suspend</a>, <a href="#UTM-Suite.stop">stop</a>, <a href="#UTM-Suite.delete">delete</a>.</div>
<div class="entry" id="UTM-Suite.serial-port">
<p class="entry"><span class="name">serial port</span> <span class="annot">n</span> : <span class="description">A serial port in the guest that can be connected to from the host.</span></p>
<p class="label">Elements</p>
<p>contained by <span><a href="#UTM-Suite.virtual-machine">virtual machines</a></span>.</p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Suite.serial-port.id"><p class="entry"><span class="name">id</span> <span class="type">(integer, r/o)</span> : <span class="description">The unique identifier of the tag.</span></p></div>
<div class="entry" id="UTM-Suite.serial-port.interface"><p class="entry"><span class="name">interface</span> <span class="type">(ptty/tcp/unavailable, r/o)</span> : <span class="description">The type of serial interface on the host.</span></p></div>
<div class="entry" id="UTM-Suite.serial-port.address"><p class="entry"><span class="name">address</span> <span class="type">(text, r/o)</span> : <span class="description">Host address of the serial port (determined by the interface type).</span></p></div>
<div class="entry" id="UTM-Suite.serial-port.port"><p class="entry"><span class="name">port</span> <span class="type">(integer, r/o)</span> : <span class="description">Port number of the serial port (not used in some interface types).</span></p></div>
</div>
</div>
<div class="suite" id="UTM-Guest-Suite">
<table class="suite"><tr>
<td>UTM Guest Suite</td>
<td>UTM virtual machine guest scripting suite. In order to use these commands, QEMU guest agent must be running.</td>
</tr></table>
<div class="entry" id="UTM-Guest-Suite.virtual-machine">
<p class="entry"><span class="name">virtual machine</span> <span class="annot">n</span> [see also <a href="#UTM-Suite.virtual-machine">UTM Suite</a>, <a href="#UTM-Configuration-Suite.virtual-machine">UTM Configuration Suite</a>, <a href="#UTM-USB-Devices-Suite.virtual-machine">UTM USB Devices Suite</a>, <a href="#UTM-Registry-Suite.virtual-machine">UTM Registry Suite</a>, <a href="#UTM-Input-Automation-Suite.virtual-machine">UTM Input Automation Suite</a>] : <span class="description">Guest agent access.</span></p>
<p class="label">Elements</p>
<p>contains <span><a href="#UTM-Guest-Suite.guest-file">guest files</a></span>, <span><a href="#UTM-Guest-Suite.guest-process">guest processes</a></span>.</p>
<p class="label">responds to</p>
<a href="#UTM-Guest-Suite.open-file">open file</a>, <a href="#UTM-Guest-Suite.execute">execute</a>, <a href="#UTM-Guest-Suite.query-ip">query ip</a>.</div>
<div class="entry" id="UTM-Guest-Suite.open-mode">
<p class="entry"><span class="name">open mode</span> <span class="annot">enum</span> : <span class="description">File open mode.</span></p>
<div class="entry"><p class="entry"><span class="name">reading</span> : <span class="description">Open the file as read only. The file must exist.</span></p></div>
<div class="entry"><p class="entry"><span class="name">writing</span> : <span class="description">Open the file for writing. If the file does not exist, it will be created. If the file exists, it will be overwritten.</span></p></div>
<div class="entry"><p class="entry"><span class="name">appending</span> : <span class="description">Open the file for writing at the end. Offsets are ignored for writes. If the file does not exist, it will be created.</span></p></div>
</div>
<div class="entry" id="UTM-Guest-Suite.open-file">
<p class="entry"><span class="name">open file</span> <span class="annot">v</span> : <span class="description">Open a file on the guest. You must close the file when you are done to prevent leaking guest resources.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">open file</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine of the guest.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">at</span> text : <span class="description">The guest path of the file to open.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">for</span> reading/writing/appending] : <span class="description">Open mode.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">updating</span> boolean] : <span class="description">If true, will open for both reading and writing. The file existance requirement and creation is still governed by the open mode. Default is false.</span></p>
</div>
<div class="entry"><p class="entry">→ <a href="#UTM-Guest-Suite.guest-file">guest file</a> : <span class="description">Guest file to operate on.</span></p></div>
</div>
</div>
<div class="entry" id="UTM-Guest-Suite.execute">
<p class="entry"><span class="name">execute</span> <span class="annot">v</span> : <span class="description">Execute a command or script on the guest.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">execute</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine of the guest.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">at</span> text : <span class="description">Either the full path of the executable to run or an executable found in the guest's PATH environment.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">with arguments</span> list of text] : <span class="description">List of arguments to pass to the executable.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">with environment</span> list of text] : <span class="description">List of environment variables to pass to the executable. Each entry should be in the format NAME=VALUE.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">using input</span> text] : <span class="description">Data to feed into the process's standard input. If using base64 encoding, this should be a valid base64 string.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">base64 encoding</span> boolean] : <span class="description">Input data is base64 encoded. The data will be decoded before being passed to the executable. Default is false.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">output capturing</span> boolean] : <span class="description">If true, the standard output and error will be captured and accessible in the returned object. You need to call update on the object to get the data. Default is false.</span></p>
</div>
<div class="entry"><p class="entry">→ <a href="#UTM-Guest-Suite.guest-process">guest process</a> : <span class="description">Guest process that can be used to fetch the return value and outputs (if captured).</span></p></div>
</div>
</div>
<div class="entry" id="UTM-Guest-Suite.query-ip">
<p class="entry"><span class="name">query ip</span> <span class="annot">v</span> : <span class="description">Query the guest for all IP addresses on its network interfaces (excluding loopback).</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">query ip</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine of the guest.</span></span></p>
<div class="entry">
<p class="entry">→ list of text : <span class="description">List of IP addresses on all network interfaces (excluding loopback). Both IPv4 and IPv6 addresses can be returned. IPv4 addresses will show up before IPv6 addresses if any are available.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Guest-Suite.guest-file">
<p class="entry"><span class="name">guest file</span> <span class="annot">n</span> : <span class="description">A file that resides on the guest.</span></p>
<p class="label">Elements</p>
<p>contained by <span><a href="#UTM-Suite.virtual-machine">virtual machines</a></span>.</p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Guest-Suite.guest-file.id"><p class="entry"><span class="name">id</span> <span class="type">(integer, r/o)</span> : <span class="description">The handle for the file.</span></p></div>
<p class="label">responds to</p>
<a href="#UTM-Guest-Suite.read">read</a>, <a href="#UTM-Guest-Suite.pull">pull</a>, <a href="#UTM-Guest-Suite.write">write</a>, <a href="#UTM-Guest-Suite.push">push</a>, <a href="#UTM-Guest-Suite.close">close</a>.</div>
<div class="entry" id="UTM-Guest-Suite.whence">
<p class="entry"><span class="name">whence</span> <span class="annot">enum</span> : <span class="description">Where to offset from.</span></p>
<div class="entry"><p class="entry"><span class="name">start position</span> : <span class="description">The start of the file (only positive offsets).</span></p></div>
<div class="entry"><p class="entry"><span class="name">current position</span> : <span class="description">The current pointer (both positive and negative offsets).</span></p></div>
<div class="entry"><p class="entry"><span class="name">end position</span> : <span class="description">The end of the file (only negative offsets for reads, both for writes).</span></p></div>
</div>
<div class="entry" id="UTM-Guest-Suite.read">
<p class="entry"><span class="name">read</span> <span class="annot">v</span> : <span class="description">Reads text data from a guest file.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">read</span> <span><a href="#UTM-Guest-Suite.guest-file">guest file</a> : <span class="description">Guest file to read.</span></span></p>
<div class="entry">
<p class="entry">[<span class="name">at offset</span> integer] : <span class="description">Specify the offset to start reading from. Default value is zero.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">from</span> start position/current position/end position] : <span class="description">Specify where the offset is from. Default value is from the current file pointer.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">for length</span> integer] : <span class="description">Amount of bytes to read. The limit is 48 MB. Default is to read until the end.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">base64 encoding</span> boolean] : <span class="description">If true, then the result will be base64 encoded. This is recommended if you are reading a binary file. Default is false.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">closing</span> boolean] : <span class="description">If true, the file will be closed after reading and must be opened again to perform more operations. If false, you can perform multiple reads on the same open file. The default is true.</span></p>
</div>
<div class="entry"><p class="entry">→ text : <span class="description">Data read from the guest file.</span></p></div>
</div>
</div>
<div class="entry" id="UTM-Guest-Suite.pull">
<p class="entry"><span class="name">pull</span> <span class="annot">v</span> : <span class="description">Pulls a file from the guest to the host.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">pull</span> <span><a href="#UTM-Guest-Suite.guest-file">guest file</a> : <span class="description">Guest file to pull.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">to</span> file : <span class="description">The host file in which to save the guest file.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">closing</span> boolean] : <span class="description">If true, the file will be closed after reading and must be opened again to perform more operations. If false, you can perform multiple reads on the same open file. The default is true.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Guest-Suite.write">
<p class="entry"><span class="name">write</span> <span class="annot">v</span> : <span class="description">Writes text data to a guest file.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">write</span> <span><a href="#UTM-Guest-Suite.guest-file">guest file</a> : <span class="description">Guest file to write.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">with data</span> text : <span class="description">Data to write to the guest file. If base64 encoding is specified, this should be a valid base64 string which will be decoded before writing.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">at offset</span> integer] : <span class="description">Specify the offset to start writing to. Default value is zero.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">from</span> start position/current position/end position] : <span class="description">Specify where the offset is from. Default value is from the current file pointer.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">base64 encoding</span> boolean] : <span class="description">If true, then the input data is base64 encoded. This is recommended if you are writing a binary file. Default is false.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">closing</span> boolean] : <span class="description">If true, the file will be closed after writing and must be opened again to perform more operations. If false, you can perform multiple reads on the same open file. The default is true.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Guest-Suite.push">
<p class="entry"><span class="name">push</span> <span class="annot">v</span> : <span class="description">Pushes a file from the host to the guest and closes it.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">push</span> <span><a href="#UTM-Guest-Suite.guest-file">guest file</a> : <span class="description">Guest file to push.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">from</span> file : <span class="description">The host file in which to send to the guest.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">closing</span> boolean] : <span class="description">If true, the file will be closed after writing and must be opened again to perform more operations. If false, you can perform multiple reads on the same open file. The default is true.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Guest-Suite.close">
<p class="entry"><span class="name">close</span> <span class="annot">v</span> : <span class="description">Closes the file and prevent further operations.</span></p>
<div class="entry verb-summary"><p class="entry"><span class="name">close</span> <span><a href="#UTM-Guest-Suite.guest-file">guest file</a> : <span class="description">Guest file to close.</span></span></p></div>
</div>
<div class="entry" id="UTM-Guest-Suite.guest-process">
<p class="entry"><span class="name">guest process</span> <span class="annot">n</span><span class="annot">, pl </span><span class="name">guest processes</span> : <span class="description">A process on the guest.</span></p>
<p class="label">Elements</p>
<p>contained by <span><a href="#UTM-Suite.virtual-machine">virtual machines</a></span>.</p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Guest-Suite.guest-process.id"><p class="entry"><span class="name">id</span> <span class="type">(integer, r/o)</span> : <span class="description">The PID of the process.</span></p></div>
<p class="label">responds to</p>
<a href="#UTM-Guest-Suite.get-result">get result</a>.</div>
<div class="entry" id="UTM-Guest-Suite.execute-result">
<p class="entry"><span class="name">execute result</span> <span class="annot">n</span> : <span class="description">Process results after execution.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Guest-Suite.execute-result.exited">
<p class="entry"><span class="name">exited</span> <span class="type">(boolean, r/o)</span> : <span class="description">If true, the process has terminated.</span></p>
</div>
<div class="entry" id="UTM-Guest-Suite.execute-result.exit-code"><p class="entry"><span class="name">exit code</span> <span class="type">(integer, r/o)</span> : <span class="description">Exit code if it was normally terminated.</span></p></div>
<div class="entry" id="UTM-Guest-Suite.execute-result.signal-code"><p class="entry"><span class="name">signal code</span> <span class="type">(integer, r/o)</span> : <span class="description">Signal number (Linux) or unhandled exception code (Windows) if the process was abnormally terminated.</span></p></div>
<div class="entry" id="UTM-Guest-Suite.execute-result.output-text"><p class="entry"><span class="name">output text</span> <span class="type">(text, r/o)</span> : <span class="description">If capture is enabled, the stdout of the process as text.</span></p></div>
<div class="entry" id="UTM-Guest-Suite.execute-result.error-text"><p class="entry"><span class="name">error text</span> <span class="type">(text, r/o)</span> : <span class="description">If capture is enabled, the stderr of the process as text.</span></p></div>
<div class="entry" id="UTM-Guest-Suite.execute-result.output-data"><p class="entry"><span class="name">output data</span> <span class="type">(text, r/o)</span> : <span class="description">If capture is enabled, the stdout of the process as base64 encoded data.</span></p></div>
<div class="entry" id="UTM-Guest-Suite.execute-result.error-data"><p class="entry"><span class="name">error data</span> <span class="type">(text, r/o)</span> : <span class="description">If capture is enabled, the stderr of the process as base64 encoded data.</span></p></div>
</div>
<div class="entry" id="UTM-Guest-Suite.get-result">
<p class="entry"><span class="name">get result</span> <span class="annot">v</span> : <span class="description">Fetch execution result from the guest.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">get result</span> <span><a href="#UTM-Guest-Suite.guest-process">guest process</a> : <span class="description">Guest process to fetch result from.</span></span></p>
<div class="entry"><p class="entry">→ <a href="#UTM-Guest-Suite.execute-result">execute result</a> : <span class="description">Result from the guest.</span></p></div>
</div>
</div>
</div>
<div class="suite" id="UTM-Configuration-Suite">
<table class="suite"><tr>
<td>UTM Configuration Suite</td>
<td>UTM virtual machine configuration suite. Use this to create and configurate virtual machines.</td>
</tr></table>
<div class="entry" id="UTM-Configuration-Suite.virtual-machine">
<p class="entry"><span class="name">virtual machine</span> <span class="annot">n</span> [see also <a href="#UTM-Suite.virtual-machine">UTM Suite</a>, <a href="#UTM-Guest-Suite.virtual-machine">UTM Guest Suite</a>, <a href="#UTM-USB-Devices-Suite.virtual-machine">UTM USB Devices Suite</a>, <a href="#UTM-Registry-Suite.virtual-machine">UTM Registry Suite</a>, <a href="#UTM-Input-Automation-Suite.virtual-machine">UTM Input Automation Suite</a>] : <span class="description">Virtual machine configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.virtual-machine.configuration">
<p class="entry"><span class="name">configuration</span> <span class="type">(<a href="#UTM-Configuration-Suite.qemu-configuration">qemu configuration</a> or <a href="#UTM-Configuration-Suite.apple-configuration">apple configuration</a>, r/o)</span> : <span class="description">The configuration of the virtual machine.</span></p>
</div>
<p class="label">responds to</p>
<a href="#UTM-Configuration-Suite.update-configuration">update configuration</a>.</div>
<div class="entry" id="UTM-Configuration-Suite.update-configuration">
<p class="entry"><span class="name">update configuration</span> <span class="annot">v</span> : <span class="description">Update the configuration of the virtual machine. The VM must be in the stopped state.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">update configuration</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to configure.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">with</span> <a href="#UTM-Configuration-Suite.qemu-configuration">qemu configuration</a> or <a href="#UTM-Configuration-Suite.apple-configuration">apple configuration</a> : <span class="description">The configuration to update the virtual machine. You cannot change the backend with this!</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration">
<p class="entry"><span class="name">qemu configuration</span> <span class="annot">n</span> : <span class="description">QEMU virtual machine configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.name"><p class="entry"><span class="name">name</span> <span class="type">(text)</span> : <span class="description">Virtual machine name.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.icon"><p class="entry"><span class="name">icon</span> <span class="type">(text)</span> : <span class="description">Virtual machine icon.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.notes"><p class="entry"><span class="name">notes</span> <span class="type">(text)</span> : <span class="description">User-specified notes.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.architecture"><p class="entry"><span class="name">architecture</span> <span class="type">(text)</span> : <span class="description">QEMU system architecture.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.machine"><p class="entry"><span class="name">machine</span> <span class="type">(text)</span> : <span class="description">QEMU target machine (if empty, the default will be used).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.memory"><p class="entry"><span class="name">memory</span> <span class="type">(integer)</span> : <span class="description">RAM size (in mebibytes).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.cpu-cores"><p class="entry"><span class="name">cpu cores</span> <span class="type">(integer)</span> : <span class="description">Number of CPU cores (0 is the default for this host).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.hypervisor"><p class="entry"><span class="name">hypervisor</span> <span class="type">(boolean)</span> : <span class="description">Use the hypervisor (if supported)?</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.uefi"><p class="entry"><span class="name">uefi</span> <span class="type">(boolean)</span> : <span class="description">Use UEFI boot?</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.directory-share-mode"><p class="entry"><span class="name">directory share mode</span> <span class="type">(none/WebDAV/VirtFS)</span> : <span class="description">Mode for directory sharing.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.drives">
<p class="entry"><span class="name">drives</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.qemu-drive-configuration">qemu drive configuration</a>)</span> : <span class="description">List of drive configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.network-interfaces">
<p class="entry"><span class="name">network interfaces</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.qemu-network-configuration">qemu network configuration</a>)</span> : <span class="description">List of network configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.serial-ports">
<p class="entry"><span class="name">serial ports</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.qemu-serial-configuration">qemu serial configuration</a>)</span> : <span class="description">List of serial configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.displays">
<p class="entry"><span class="name">displays</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.qemu-display-configuration">qemu display configuration</a>)</span> : <span class="description">List of display configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-configuration.qemu-additional-arguments">
<p class="entry"><span class="name">qemu additional arguments</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.qemu-argument">qemu argument</a>)</span> : <span class="description">List of qemu arguments.</span></p>
</div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-directory-share-mode">
<p class="entry"><span class="name">qemu directory share mode</span> <span class="annot">enum</span> : <span class="description">Method for sharing directory in QEMU.</span></p>
<div class="entry"><p class="entry"><span class="name">none</span> : <span class="description">Do not enable directory sharing.</span></p></div>
<div class="entry"><p class="entry"><span class="name">WebDAV</span> : <span class="description">Use SPICE WebDav (SPICE guest tools required).</span></p></div>
<div class="entry"><p class="entry"><span class="name">VirtFS</span> : <span class="description">Use VirtFS mount tagged 'share' (VirtFS guest drivers required).</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration">
<p class="entry"><span class="name">qemu drive configuration</span> <span class="annot">n</span> : <span class="description">QEMU virtual existing drive configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration.id"><p class="entry"><span class="name">id</span> <span class="type">(text, r/o)</span> : <span class="description">The unique identifier for this drive (if empty, a new drive will be created).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration.removable"><p class="entry"><span class="name">removable</span> <span class="type">(boolean, r/o)</span> : <span class="description">Is this drive removable (cannot be changed after creation)?</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration.interface"><p class="entry"><span class="name">interface</span> <span class="type">(none/IDE/SCSI/SD/MTD/Floppy/PFlash/VirtIO/NVMe/USB)</span> : <span class="description">The hardware interface this drive is attached to (if empty, the default will be used).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration.host-size"><p class="entry"><span class="name">host size</span> <span class="type">(integer, r/o)</span> : <span class="description">The size of this drive as seen by the host (in MiB).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration.guest-size"><p class="entry"><span class="name">guest size</span> <span class="type">(integer)</span> : <span class="description">The size of this drive as seen by the guest (in MiB).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration.raw"><p class="entry"><span class="name">raw</span> <span class="type">(boolean)</span> : <span class="description">Is this disk image raw format (only for newly created drives)?</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-drive-configuration.source"><p class="entry"><span class="name">source</span> <span class="type">(file)</span> : <span class="description">An existing file to use as the source image.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-configuration">
<p class="entry"><span class="name">qemu network configuration</span> <span class="annot">n</span> : <span class="description">QEMU virtual network configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-configuration.index"><p class="entry"><span class="name">index</span> <span class="type">(integer)</span> : <span class="description">The position of the configuration to update. It can be empty to create a new device. Index is invalid after updating the configuration and must be reset to the current position.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-configuration.hardware"><p class="entry"><span class="name">hardware</span> <span class="type">(text)</span> : <span class="description">Name of the emulated network card (if empty, the default will be used).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-configuration.mode"><p class="entry"><span class="name">mode</span> <span class="type">(emulated/shared/host/bridged)</span> : <span class="description">This determines how the network device is attached to the host.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-configuration.address"><p class="entry"><span class="name">address</span> <span class="type">(text)</span> : <span class="description">MAC address (formatted as XX:XX:XX:XX:XX:XX, if empty a random address will be genertaed)</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-configuration.host-interface"><p class="entry"><span class="name">host interface</span> <span class="type">(text)</span> : <span class="description">Only used in bridged mode. Specify the interface name to bridge to.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-configuration.port-forwards">
<p class="entry"><span class="name">port forwards</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.qemu-port-forward">qemu port forward</a>)</span> : <span class="description">Only used in emulated mode. Allows port forwarding from guest to host.</span></p>
</div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-network-mode">
<p class="entry"><span class="name">qemu network mode</span> <span class="annot">enum</span> : <span class="description">Mode for networking device.</span></p>
<div class="entry"><p class="entry"><span class="name">emulated</span> : <span class="description">Emulate a VLAN.</span></p></div>
<div class="entry"><p class="entry"><span class="name">shared</span> : <span class="description">NAT based sharing with the host.</span></p></div>
<div class="entry"><p class="entry"><span class="name">host</span> : <span class="description">NAT based sharing with no WAN routing.</span></p></div>
<div class="entry"><p class="entry"><span class="name">bridged</span> : <span class="description">Bridged to a host interface.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-port-forward">
<p class="entry"><span class="name">qemu port forward</span> <span class="annot">n</span> : <span class="description">QEMU port forward configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.qemu-port-forward.protocol"><p class="entry"><span class="name">protocol</span> <span class="type">(TCP/UDP)</span> : <span class="description">Protocol of the port that will be forwarded.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-port-forward.host-address"><p class="entry"><span class="name">host address</span> <span class="type">(text)</span> : <span class="description">The host interface IP address to forward to (if empty, it will forward to any interface).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-port-forward.host-port"><p class="entry"><span class="name">host port</span> <span class="type">(integer)</span> : <span class="description">Port number on the host.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-port-forward.guest-address"><p class="entry"><span class="name">guest address</span> <span class="type">(text)</span> : <span class="description">The IP address on the guest subnet to forward from (if empty, any guest IP will be accepted).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-port-forward.guest-port"><p class="entry"><span class="name">guest port</span> <span class="type">(integer)</span> : <span class="description">Port number on the guest.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-serial-configuration">
<p class="entry"><span class="name">qemu serial configuration</span> <span class="annot">n</span> : <span class="description">QEMU virtual serial configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.qemu-serial-configuration.index"><p class="entry"><span class="name">index</span> <span class="type">(integer)</span> : <span class="description">The position of the configuration to update. It can be empty to create a new device. Index is invalid after updating the configuration and must be reset to the current position.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-serial-configuration.hardware"><p class="entry"><span class="name">hardware</span> <span class="type">(text)</span> : <span class="description">Name of the emulated serial device (if empty, the default will be used).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-serial-configuration.interface"><p class="entry"><span class="name">interface</span> <span class="type">(ptty/tcp/unavailable)</span> : <span class="description">The type of serial interface on the host.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-serial-configuration.port"><p class="entry"><span class="name">port</span> <span class="type">(integer)</span> : <span class="description">The port number to listen on when the interface is a TCP server.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-display-configuration">
<p class="entry"><span class="name">qemu display configuration</span> <span class="annot">n</span> : <span class="description">QEMU virtual display configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.qemu-display-configuration.index"><p class="entry"><span class="name">index</span> <span class="type">(integer)</span> : <span class="description">The position of the configuration to update. It can be empty to create a new device. Index is invalid after updating the configuration and must be reset to the current position.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-display-configuration.hardware"><p class="entry"><span class="name">hardware</span> <span class="type">(text)</span> : <span class="description">Name of the emulated display card (required. if given hardware not found, the default will be used).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-display-configuration.dynamic-resolution"><p class="entry"><span class="name">dynamic resolution</span> <span class="type">(boolean)</span> : <span class="description">If true, attempt to use SPICE guest agent to change the display resolution automatically.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-display-configuration.native-resolution"><p class="entry"><span class="name">native resolution</span> <span class="type">(boolean)</span> : <span class="description">If true, use the true (retina) resolution of the display. Otherwise, use the percieved resolution.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-display-configuration.upscaling-filter"><p class="entry"><span class="name">upscaling filter</span> <span class="type">(linear/nearest)</span> : <span class="description">Filter to use when upscaling.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-display-configuration.downscaling-filter"><p class="entry"><span class="name">downscaling filter</span> <span class="type">(linear/nearest)</span> : <span class="description">Filter to use when downscaling.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.qemu-argument">
<p class="entry"><span class="name">qemu argument</span> <span class="annot">n</span> : <span class="description">QEMU argument configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.qemu-argument.argument-string"><p class="entry"><span class="name">argument string</span> <span class="type">(text)</span> : <span class="description">The QEMU argument as a string.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.qemu-argument.file-urls">
<p class="entry"><span class="name">file urls</span> <span class="type">(list of file)</span> : <span class="description">Optional URLs associated with this argument.</span></p>
</div>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration">
<p class="entry"><span class="name">apple configuration</span> <span class="annot">n</span> : <span class="description">Apple virtual machine configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.name"><p class="entry"><span class="name">name</span> <span class="type">(text)</span> : <span class="description">Virtual machine name.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.icon"><p class="entry"><span class="name">icon</span> <span class="type">(text)</span> : <span class="description">Virtual machine icon.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.notes"><p class="entry"><span class="name">notes</span> <span class="type">(text)</span> : <span class="description">User-specified notes.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.memory"><p class="entry"><span class="name">memory</span> <span class="type">(integer)</span> : <span class="description">RAM size (in mebibytes).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.cpu-cores"><p class="entry"><span class="name">cpu cores</span> <span class="type">(integer)</span> : <span class="description">Number of CPU cores (0 is the default for this host).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.directory-shares">
<p class="entry"><span class="name">directory shares</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.apple-directory-share-configuration">apple directory share configuration</a>)</span> : <span class="description">List of directory share configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.drives">
<p class="entry"><span class="name">drives</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.apple-drive-configuration">apple drive configuration</a>)</span> : <span class="description">List of drive configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.network-interfaces">
<p class="entry"><span class="name">network interfaces</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.apple-network-configuration">apple network configuration</a>)</span> : <span class="description">List of network configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.serial-ports">
<p class="entry"><span class="name">serial ports</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.apple-serial-configuration">apple serial configuration</a>)</span> : <span class="description">List of serial configuration.</span></p>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-configuration.displays">
<p class="entry"><span class="name">displays</span> <span class="type">(list of <a href="#UTM-Configuration-Suite.apple-display-configuration">apple display configuration</a>)</span> : <span class="description">List of display configuration.</span></p>
</div>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-directory-share-configuration">
<p class="entry"><span class="name">apple directory share configuration</span> <span class="annot">n</span> : <span class="description">Apple directory share configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.apple-directory-share-configuration.index"><p class="entry"><span class="name">index</span> <span class="type">(integer)</span> : <span class="description">The position of the configuration to update. It can be empty to create a new device. Index is invalid after updating the configuration and must be reset to the current position.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-directory-share-configuration.read-only"><p class="entry"><span class="name">read only</span> <span class="type">(boolean, r/o)</span> : <span class="description">Is this directory read-only?</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-drive-configuration">
<p class="entry"><span class="name">apple drive configuration</span> <span class="annot">n</span> : <span class="description">Apple virtual existing drive configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.apple-drive-configuration.id"><p class="entry"><span class="name">id</span> <span class="type">(text, r/o)</span> : <span class="description">The unique identifier for this drive (if empty, a new drive will be created).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-drive-configuration.removable"><p class="entry"><span class="name">removable</span> <span class="type">(boolean, r/o)</span> : <span class="description">Is this drive removable (cannot be changed after creation)?</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-drive-configuration.host-size"><p class="entry"><span class="name">host size</span> <span class="type">(integer, r/o)</span> : <span class="description">The size of this drive as seen by the host (in MiB).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-drive-configuration.guest-size"><p class="entry"><span class="name">guest size</span> <span class="type">(integer)</span> : <span class="description">The size of this drive as seen by the guest (in MiB).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-drive-configuration.source"><p class="entry"><span class="name">source</span> <span class="type">(file)</span> : <span class="description">An existing file to use as the source image.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-network-configuration">
<p class="entry"><span class="name">apple network configuration</span> <span class="annot">n</span> : <span class="description">Apple virtual network configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.apple-network-configuration.index"><p class="entry"><span class="name">index</span> <span class="type">(integer)</span> : <span class="description">The position of the configuration to update. It can be empty to create a new device. Index is invalid after updating the configuration and must be reset to the current position.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-network-configuration.mode"><p class="entry"><span class="name">mode</span> <span class="type">(shared/bridged)</span> : <span class="description">This determines how the network device is attached to the host.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-network-configuration.address"><p class="entry"><span class="name">address</span> <span class="type">(text)</span> : <span class="description">MAC address (formatted as XX:XX:XX:XX:XX:XX, if empty a random address will be genertaed)</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-network-configuration.host-interface"><p class="entry"><span class="name">host interface</span> <span class="type">(text)</span> : <span class="description">Only used in bridged mode. Specify the interface name to bridge to.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-network-mode">
<p class="entry"><span class="name">apple network mode</span> <span class="annot">enum</span> : <span class="description">Mode for networking device.</span></p>
<div class="entry"><p class="entry"><span class="name">shared</span> : <span class="description">NAT based sharing with the host.</span></p></div>
<div class="entry"><p class="entry"><span class="name">bridged</span> : <span class="description">Bridged to a host interface.</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-serial-configuration">
<p class="entry"><span class="name">apple serial configuration</span> <span class="annot">n</span> : <span class="description">Apple virtual serial configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.apple-serial-configuration.index"><p class="entry"><span class="name">index</span> <span class="type">(integer)</span> : <span class="description">The position of the configuration to update. It can be empty to create a new device. Index is invalid after updating the configuration and must be reset to the current position.</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-serial-configuration.interface"><p class="entry"><span class="name">interface</span> <span class="type">(ptty/tcp/unavailable)</span> : <span class="description">The type of serial interface on the host (only PTTY is supported).</span></p></div>
</div>
<div class="entry" id="UTM-Configuration-Suite.apple-display-configuration">
<p class="entry"><span class="name">apple display configuration</span> <span class="annot">n</span> : <span class="description">Apple virtual display configuration.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Configuration-Suite.apple-display-configuration.id"><p class="entry"><span class="name">id</span> <span class="type">(text, r/o)</span> : <span class="description">The unique identifier for this display (if empty, a new display will be created).</span></p></div>
<div class="entry" id="UTM-Configuration-Suite.apple-display-configuration.dynamic-resolution"><p class="entry"><span class="name">dynamic resolution</span> <span class="type">(boolean)</span> : <span class="description">Dynamic Resolution.</span></p></div>
</div>
</div>
<div class="suite" id="UTM-USB-Devices-Suite">
<table class="suite"><tr>
<td>UTM USB Devices Suite</td>
<td>UTM virtual machine USB devices suite. Use this to connect USB devices from the host to the guest.</td>
</tr></table>
<div class="entry" id="UTM-USB-Devices-Suite.application">
<p class="entry"><span class="name">application</span> <span class="annot">n</span> [see also <a href="#UTM-Suite.application">UTM Suite</a>] : <span class="description">An application's top level scripting object.</span></p>
<p class="label">Elements</p>
<p>contains <span><a href="#UTM-USB-Devices-Suite.usb-device">usb devices</a></span>.</p>
</div>
<div class="entry" id="UTM-USB-Devices-Suite.usb-device">
<p class="entry"><span class="name">usb device</span> <span class="annot">n</span> : <span class="description">A host USB device that is shared with the guest.</span></p>
<p class="label">Elements</p>
<p>contained by <span>application</span>, <span><a href="#UTM-Suite.virtual-machine">virtual machines</a></span>.</p>
<p class="label">Properties</p>
<div class="entry" id="UTM-USB-Devices-Suite.usb-device.id"><p class="entry"><span class="name">id</span> <span class="type">(integer, r/o)</span> : <span class="description">A unique identifier corrosponding to the USB bus and port number.</span></p></div>
<div class="entry" id="UTM-USB-Devices-Suite.usb-device.name"><p class="entry"><span class="name">name</span> <span class="type">(text, r/o)</span> : <span class="description">The name of the USB device.</span></p></div>
<div class="entry" id="UTM-USB-Devices-Suite.usb-device.manufacturer-name"><p class="entry"><span class="name">manufacturer name</span> <span class="type">(text, r/o)</span> : <span class="description">The product name described by the iManufacturer descriptor.</span></p></div>
<div class="entry" id="UTM-USB-Devices-Suite.usb-device.product-name"><p class="entry"><span class="name">product name</span> <span class="type">(text, r/o)</span> : <span class="description">The product name described by the iProduct descriptor.</span></p></div>
<div class="entry" id="UTM-USB-Devices-Suite.usb-device.vendor-id"><p class="entry"><span class="name">vendor id</span> <span class="type">(integer, r/o)</span> : <span class="description">The vendor ID described by the idVendor descriptor.</span></p></div>
<div class="entry" id="UTM-USB-Devices-Suite.usb-device.product-id"><p class="entry"><span class="name">product id</span> <span class="type">(integer, r/o)</span> : <span class="description">The product ID described by the idProduct descriptor.</span></p></div>
<p class="label">responds to</p>
<a href="#UTM-USB-Devices-Suite.connect">connect</a>, <a href="#UTM-USB-Devices-Suite.disconnect">disconnect</a>.</div>
<div class="entry" id="UTM-USB-Devices-Suite.virtual-machine">
<p class="entry"><span class="name">virtual machine</span> <span class="annot">n</span> [see also <a href="#UTM-Suite.virtual-machine">UTM Suite</a>, <a href="#UTM-Guest-Suite.virtual-machine">UTM Guest Suite</a>, <a href="#UTM-Configuration-Suite.virtual-machine">UTM Configuration Suite</a>, <a href="#UTM-Registry-Suite.virtual-machine">UTM Registry Suite</a>, <a href="#UTM-Input-Automation-Suite.virtual-machine">UTM Input Automation Suite</a>] : <span class="description">Virtual machine USB devices.</span></p>
<p class="label">Elements</p>
<p>contains <span><a href="#UTM-USB-Devices-Suite.usb-device">usb devices</a></span>.</p>
</div>
<div class="entry" id="UTM-USB-Devices-Suite.connect">
<p class="entry"><span class="name">connect</span> <span class="annot">v</span> : <span class="description">Connect a USB device to a running VM and remove it from the host.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">connect</span> <span><a href="#UTM-USB-Devices-Suite.usb-device">usb device</a> : <span class="description">The USB device to connect to the VM.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">to</span> <a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">The virtual machine to connect. The virtual machine must be running. Not all backends support USB sharing.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-USB-Devices-Suite.disconnect">
<p class="entry"><span class="name">disconnect</span> <span class="annot">v</span> : <span class="description">Disconnect a USB device from the guest and re-assign it to the host.</span></p>
<div class="entry verb-summary"><p class="entry"><span class="name">disconnect</span> <span><a href="#UTM-USB-Devices-Suite.usb-device">usb device</a> : <span class="description">The USB device to disconnect.</span></span></p></div>
</div>
</div>
<div class="suite" id="UTM-Registry-Suite">
<table class="suite"><tr>
<td>UTM Registry Suite</td>
<td>UTM virtual machine registry suite. Use this to update virtual machine registry.</td>
</tr></table>
<div class="entry" id="UTM-Registry-Suite.virtual-machine">
<p class="entry"><span class="name">virtual machine</span> <span class="annot">n</span> [see also <a href="#UTM-Suite.virtual-machine">UTM Suite</a>, <a href="#UTM-Guest-Suite.virtual-machine">UTM Guest Suite</a>, <a href="#UTM-Configuration-Suite.virtual-machine">UTM Configuration Suite</a>, <a href="#UTM-USB-Devices-Suite.virtual-machine">UTM USB Devices Suite</a>, <a href="#UTM-Input-Automation-Suite.virtual-machine">UTM Input Automation Suite</a>] : <span class="description">Virtual machine registry.</span></p>
<p class="label">Properties</p>
<div class="entry" id="UTM-Registry-Suite.virtual-machine.registry">
<p class="entry"><span class="name">registry</span> <span class="type">(list of file, r/o)</span> : <span class="description">The registry of the virtual machine.</span></p>
</div>
<p class="label">responds to</p>
<a href="#UTM-Registry-Suite.update-registry">update registry</a>.</div>
<div class="entry" id="UTM-Registry-Suite.update-registry">
<p class="entry"><span class="name">update registry</span> <span class="annot">v</span> : <span class="description">Update the registry of the virtual machine.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">update registry</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to update.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">with</span> list of file : <span class="description">The registry to update the virtual machine. Currently you can only change the shared directory with this!</span></p>
</div>
</div>
</div>
</div>
<div class="suite" id="UTM-Input-Automation-Suite">
<table class="suite"><tr>
<td>UTM Input Automation Suite</td>
<td>UTM virtual machine input automation suite. Only supported on QEMU backend.</td>
</tr></table>
<div class="entry" id="UTM-Input-Automation-Suite.virtual-machine">
<p class="entry"><span class="name">virtual machine</span> <span class="annot">n</span> [see also <a href="#UTM-Suite.virtual-machine">UTM Suite</a>, <a href="#UTM-Guest-Suite.virtual-machine">UTM Guest Suite</a>, <a href="#UTM-Configuration-Suite.virtual-machine">UTM Configuration Suite</a>, <a href="#UTM-USB-Devices-Suite.virtual-machine">UTM USB Devices Suite</a>, <a href="#UTM-Registry-Suite.virtual-machine">UTM Registry Suite</a>] : <span class="description">Input automation.</span></p>
<p class="label">responds to</p>
<a href="#UTM-Input-Automation-Suite.input-scan-code">input scan code</a>, <a href="#UTM-Input-Automation-Suite.input-keystroke">input keystroke</a>, <a href="#UTM-Input-Automation-Suite.input-mouse-click">input mouse click</a>.</div>
<div class="entry" id="UTM-Input-Automation-Suite.input-scan-code">
<p class="entry"><span class="name">input scan code</span> <span class="annot">v</span> : <span class="description">Send raw PC AT scan codes. Only supported on QEMU backend.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">input scan code</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to send scan code to.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">codes</span> list of integer : <span class="description">List of PC AT scan codes.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Input-Automation-Suite.modifier-key">
<p class="entry"><span class="name">modifier key</span> <span class="annot">enum</span> : <span class="description">Modifier key to send with keystroke.</span></p>
<div class="entry"><p class="entry"><span class="name">caps lock</span> : <span class="description">Caps Lock (⇪)</span></p></div>
<div class="entry"><p class="entry"><span class="name">shift</span> : <span class="description">Shift (⇧)</span></p></div>
<div class="entry"><p class="entry"><span class="name">control</span> : <span class="description">Control (⌃)</span></p></div>
<div class="entry"><p class="entry"><span class="name">option</span> : <span class="description">Option (⌥)</span></p></div>
<div class="entry"><p class="entry"><span class="name">command</span> : <span class="description">Command (⌘)</span></p></div>
<div class="entry"><p class="entry"><span class="name">escape</span> : <span class="description">Escape (⎋)</span></p></div>
</div>
<div class="entry" id="UTM-Input-Automation-Suite.input-keystroke">
<p class="entry"><span class="name">input keystroke</span> <span class="annot">v</span> : <span class="description">Send text as a sequence of keystrokes to the virtual machine. Only supported on QEMU backend.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">input keystroke</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to send keystrokes to.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">text</span> text : <span class="description">ASCII characters to send as a sequence.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">with modifiers</span> list of caps lock/shift/control/option/command/escape] : <span class="description">List of modifier keys to hold down while sending key sequence.</span></p>
</div>
</div>
</div>
<div class="entry" id="UTM-Input-Automation-Suite.mouse-button">
<p class="entry"><span class="name">mouse button</span> <span class="annot">enum</span> : <span class="description">Mouse button.</span></p>
<div class="entry"><p class="entry"><span class="name">left</span> : <span class="description">Left Click</span></p></div>
<div class="entry"><p class="entry"><span class="name">right</span> : <span class="description">Right Click</span></p></div>
<div class="entry"><p class="entry"><span class="name">middle</span> : <span class="description">Middle Click</span></p></div>
</div>
<div class="entry" id="UTM-Input-Automation-Suite.input-mouse-click">
<p class="entry"><span class="name">input mouse click</span> <span class="annot">v</span> : <span class="description">Send a mouse position and click to the virtual machine. Only supported on QEMU backend.</span></p>
<div class="entry verb-summary">
<p class="entry"><span class="name">input mouse click</span> <span><a href="#UTM-Suite.virtual-machine">virtual machine</a> : <span class="description">Virtual machine to send scan code to.</span></span></p>
<div class="entry">
<p class="entry"><span class="name">at</span> list of integer : <span class="description">X-Y coordinate of the absolute position on screen to perform the click. Must be a list of two numbers.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">to</span> integer] : <span class="description">Which monitor to target (starting at 1). If omitted, the first monitor will be used.</span></p>
</div>
<div class="entry">
<p class="entry">[<span class="name">with mouse button</span> left/right/middle] : <span class="description">Mouse button to click. If omitted, a left click will be used.</span></p>
</div>
</div>
</div>
</div>
