This repository has been archived by the owner on Feb 16, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vix.pxd
900 lines (775 loc) · 42.2 KB
/
vix.pxd
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
cdef extern from "vmware-vix/vm_basic_types.h":
ctypedef unsigned long long uint64
ctypedef long long int64
ctypedef char Bool
cdef extern from "vmware-vix/vix.h":
ctypedef int VixHandle
ctypedef enum:
VIX_INVALID_HANDLE = 0
ctypedef enum VixHandleType:
VIX_HANDLETYPE_NONE = 0,
VIX_HANDLETYPE_HOST = 2,
VIX_HANDLETYPE_VM = 3,
VIX_HANDLETYPE_NETWORK = 5,
VIX_HANDLETYPE_JOB = 6,
VIX_HANDLETYPE_SNAPSHOT = 7,
VIX_HANDLETYPE_PROPERTY_LIST = 9,
VIX_HANDLETYPE_METADATA_CONTAINER = 11
ctypedef enum VixError:
VIX_OK = 0,
# General Errors
VIX_E_FAIL = 1,
VIX_E_OUT_OF_MEMORY = 2,
VIX_E_INVALID_ARG = 3,
VIX_E_FILE_NOT_FOUND = 4,
VIX_E_OBJECT_IS_BUSY = 5,
VIX_E_NOT_SUPPORTED = 6,
VIX_E_FILE_ERROR = 7,
VIX_E_DISK_FULL = 8,
VIX_E_INCORRECT_FILE_TYPE = 9,
VIX_E_CANCELLED = 10,
VIX_E_FILE_READ_ONLY = 11,
VIX_E_FILE_ALREADY_EXISTS = 12,
VIX_E_FILE_ACCESS_ERROR = 13,
VIX_E_REQUIRES_LARGE_FILES = 14,
VIX_E_FILE_ALREADY_LOCKED = 15,
VIX_E_VMDB = 16,
VIX_E_NOT_SUPPORTED_ON_REMOTE_OBJECT = 20,
VIX_E_FILE_TOO_BIG = 21,
VIX_E_FILE_NAME_INVALID = 22,
VIX_E_ALREADY_EXISTS = 23,
VIX_E_BUFFER_TOOSMALL = 24,
VIX_E_OBJECT_NOT_FOUND = 25,
VIX_E_HOST_NOT_CONNECTED = 26,
VIX_E_INVALID_UTF8_STRING = 27,
VIX_E_OPERATION_ALREADY_IN_PROGRESS = 31,
VIX_E_UNFINISHED_JOB = 29,
VIX_E_NEED_KEY = 30,
VIX_E_LICENSE = 32,
VIX_E_VM_HOST_DISCONNECTED = 34,
VIX_E_AUTHENTICATION_FAIL = 35,
VIX_E_HOST_CONNECTION_LOST = 36,
VIX_E_DUPLICATE_NAME = 41,
# Handle Errors
VIX_E_INVALID_HANDLE = 1000,
VIX_E_NOT_SUPPORTED_ON_HANDLE_TYPE = 1001,
VIX_E_TOO_MANY_HANDLES = 1002,
# XML Errors
VIX_E_NOT_FOUND = 2000,
VIX_E_TYPE_MISMATCH = 2001,
VIX_E_INVALID_XML = 2002,
# VM Control Errors
VIX_E_TIMEOUT_WAITING_FOR_TOOLS = 3000,
VIX_E_UNRECOGNIZED_COMMAND = 3001,
VIX_E_OP_NOT_SUPPORTED_ON_GUEST = 3003,
VIX_E_PROGRAM_NOT_STARTED = 3004,
VIX_E_CANNOT_START_READ_ONLY_VM = 3005,
VIX_E_VM_NOT_RUNNING = 3006,
VIX_E_VM_IS_RUNNING = 3007,
VIX_E_CANNOT_CONNECT_TO_VM = 3008,
VIX_E_POWEROP_SCRIPTS_NOT_AVAILABLE = 3009,
VIX_E_NO_GUEST_OS_INSTALLED = 3010,
VIX_E_VM_INSUFFICIENT_HOST_MEMORY = 3011,
VIX_E_SUSPEND_ERROR = 3012,
VIX_E_VM_NOT_ENOUGH_CPUS = 3013,
VIX_E_HOST_USER_PERMISSIONS = 3014,
VIX_E_GUEST_USER_PERMISSIONS = 3015,
VIX_E_TOOLS_NOT_RUNNING = 3016,
VIX_E_GUEST_OPERATIONS_PROHIBITED = 3017,
VIX_E_ANON_GUEST_OPERATIONS_PROHIBITED = 3018,
VIX_E_ROOT_GUEST_OPERATIONS_PROHIBITED = 3019,
VIX_E_MISSING_ANON_GUEST_ACCOUNT = 3023,
VIX_E_CANNOT_AUTHENTICATE_WITH_GUEST = 3024,
VIX_E_UNRECOGNIZED_COMMAND_IN_GUEST = 3025,
VIX_E_CONSOLE_GUEST_OPERATIONS_PROHIBITED = 3026,
VIX_E_MUST_BE_CONSOLE_USER = 3027,
VIX_E_VMX_MSG_DIALOG_AND_NO_UI = 3028,
# VIX_E_NOT_ALLOWED_DURING_VM_RECORDING = 3029,
# VIX_E_NOT_ALLOWED_DURING_VM_REPLAY = 3030,
VIX_E_OPERATION_NOT_ALLOWED_FOR_LOGIN_TYPE = 3031,
VIX_E_LOGIN_TYPE_NOT_SUPPORTED = 3032,
VIX_E_EMPTY_PASSWORD_NOT_ALLOWED_IN_GUEST = 3033,
VIX_E_INTERACTIVE_SESSION_NOT_PRESENT = 3034,
VIX_E_INTERACTIVE_SESSION_USER_MISMATCH = 3035,
# VIX_E_UNABLE_TO_REPLAY_VM = 3039,
VIX_E_CANNOT_POWER_ON_VM = 3041,
VIX_E_NO_DISPLAY_SERVER = 3043,
# VIX_E_VM_NOT_RECORDING = 3044,
# VIX_E_VM_NOT_REPLAYING = 3045,
VIX_E_TOO_MANY_LOGONS = 3046,
VIX_E_INVALID_AUTHENTICATION_SESSION = 3047,
# VM Errors
VIX_E_VM_NOT_FOUND = 4000,
VIX_E_NOT_SUPPORTED_FOR_VM_VERSION = 4001,
VIX_E_CANNOT_READ_VM_CONFIG = 4002,
VIX_E_TEMPLATE_VM = 4003,
VIX_E_VM_ALREADY_LOADED = 4004,
VIX_E_VM_ALREADY_UP_TO_DATE = 4006,
VIX_E_VM_UNSUPPORTED_GUEST = 4011,
# Property Errors
VIX_E_UNRECOGNIZED_PROPERTY = 6000,
VIX_E_INVALID_PROPERTY_VALUE = 6001,
VIX_E_READ_ONLY_PROPERTY = 6002,
VIX_E_MISSING_REQUIRED_PROPERTY = 6003,
VIX_E_INVALID_SERIALIZED_DATA = 6004,
VIX_E_PROPERTY_TYPE_MISMATCH = 6005,
# Completion Errors
VIX_E_BAD_VM_INDEX = 8000,
# Message Errors
VIX_E_INVALID_MESSAGE_HEADER = 10000,
VIX_E_INVALID_MESSAGE_BODY = 10001,
# Snapshot errors
VIX_E_SNAPSHOT_INVAL = 13000,
VIX_E_SNAPSHOT_DUMPER = 13001,
VIX_E_SNAPSHOT_DISKLIB = 13002,
VIX_E_SNAPSHOT_NOTFOUND = 13003,
VIX_E_SNAPSHOT_EXISTS = 13004,
VIX_E_SNAPSHOT_VERSION = 13005,
VIX_E_SNAPSHOT_NOPERM = 13006,
VIX_E_SNAPSHOT_CONFIG = 13007,
VIX_E_SNAPSHOT_NOCHANGE = 13008,
VIX_E_SNAPSHOT_CHECKPOINT = 13009,
VIX_E_SNAPSHOT_LOCKED = 13010,
VIX_E_SNAPSHOT_INCONSISTENT = 13011,
VIX_E_SNAPSHOT_NAMETOOLONG = 13012,
VIX_E_SNAPSHOT_VIXFILE = 13013,
VIX_E_SNAPSHOT_DISKLOCKED = 13014,
VIX_E_SNAPSHOT_DUPLICATEDDISK = 13015,
VIX_E_SNAPSHOT_INDEPENDENTDISK = 13016,
VIX_E_SNAPSHOT_NONUNIQUE_NAME = 13017,
VIX_E_SNAPSHOT_MEMORY_ON_INDEPENDENT_DISK = 13018,
VIX_E_SNAPSHOT_MAXSNAPSHOTS = 13019,
VIX_E_SNAPSHOT_MIN_FREE_SPACE = 13020,
VIX_E_SNAPSHOT_HIERARCHY_TOODEEP = 13021,
VIX_E_SNAPSHOT_RRSUSPEND = 13022,
VIX_E_SNAPSHOT_NOT_REVERTABLE = 13024,
# Host Errors
VIX_E_HOST_DISK_INVALID_VALUE = 14003,
VIX_E_HOST_DISK_SECTORSIZE = 14004,
VIX_E_HOST_FILE_ERROR_EOF = 14005,
VIX_E_HOST_NETBLKDEV_HANDSHAKE = 14006,
VIX_E_HOST_SOCKET_CREATION_ERROR = 14007,
VIX_E_HOST_SERVER_NOT_FOUND = 14008,
VIX_E_HOST_NETWORK_CONN_REFUSED = 14009,
VIX_E_HOST_TCP_SOCKET_ERROR = 14010,
VIX_E_HOST_TCP_CONN_LOST = 14011,
VIX_E_HOST_NBD_HASHFILE_VOLUME = 14012,
VIX_E_HOST_NBD_HASHFILE_INIT = 14013,
# Disklib Errors
VIX_E_DISK_INVAL = 16000,
VIX_E_DISK_NOINIT = 16001,
VIX_E_DISK_NOIO = 16002,
VIX_E_DISK_PARTIALCHAIN = 16003,
VIX_E_DISK_NEEDSREPAIR = 16006,
VIX_E_DISK_OUTOFRANGE = 16007,
VIX_E_DISK_CID_MISMATCH = 16008,
VIX_E_DISK_CANTSHRINK = 16009,
VIX_E_DISK_PARTMISMATCH = 16010,
VIX_E_DISK_UNSUPPORTEDDISKVERSION = 16011,
VIX_E_DISK_OPENPARENT = 16012,
VIX_E_DISK_NOTSUPPORTED = 16013,
VIX_E_DISK_NEEDKEY = 16014,
VIX_E_DISK_NOKEYOVERRIDE = 16015,
VIX_E_DISK_NOTENCRYPTED = 16016,
VIX_E_DISK_NOKEY = 16017,
VIX_E_DISK_INVALIDPARTITIONTABLE = 16018,
VIX_E_DISK_NOTNORMAL = 16019,
VIX_E_DISK_NOTENCDESC = 16020,
VIX_E_DISK_NEEDVMFS = 16022,
VIX_E_DISK_RAWTOOBIG = 16024,
VIX_E_DISK_TOOMANYOPENFILES = 16027,
VIX_E_DISK_TOOMANYREDO = 16028,
VIX_E_DISK_RAWTOOSMALL = 16029,
VIX_E_DISK_INVALIDCHAIN = 16030,
VIX_E_DISK_KEY_NOTFOUND = 16052,
VIX_E_DISK_SUBSYSTEM_INIT_FAIL = 16053,
VIX_E_DISK_INVALID_CONNECTION = 16054,
VIX_E_DISK_ENCODING = 16061,
VIX_E_DISK_CANTREPAIR = 16062,
VIX_E_DISK_INVALIDDISK = 16063,
VIX_E_DISK_NOLICENSE = 16064,
VIX_E_DISK_NODEVICE = 16065,
VIX_E_DISK_UNSUPPORTEDDEVICE = 16066,
VIX_E_DISK_CAPACITY_MISMATCH = 16067,
VIX_E_DISK_PARENT_NOTALLOWED = 16068,
VIX_E_DISK_ATTACH_ROOTLINK = 16069,
# Crypt Library Errors
VIX_E_CRYPTO_UNKNOWN_ALGORITHM = 17000,
VIX_E_CRYPTO_BAD_BUFFER_SIZE = 17001,
VIX_E_CRYPTO_INVALID_OPERATION = 17002,
VIX_E_CRYPTO_RANDOM_DEVICE = 17003,
VIX_E_CRYPTO_NEED_PASSWORD = 17004,
VIX_E_CRYPTO_BAD_PASSWORD = 17005,
VIX_E_CRYPTO_NOT_IN_DICTIONARY = 17006,
VIX_E_CRYPTO_NO_CRYPTO = 17007,
VIX_E_CRYPTO_ERROR = 17008,
VIX_E_CRYPTO_BAD_FORMAT = 17009,
VIX_E_CRYPTO_LOCKED = 17010,
VIX_E_CRYPTO_EMPTY = 17011,
VIX_E_CRYPTO_KEYSAFE_LOCATOR = 17012,
# Remoting Errors
VIX_E_CANNOT_CONNECT_TO_HOST = 18000,
VIX_E_NOT_FOR_REMOTE_HOST = 18001,
VIX_E_INVALID_HOSTNAME_SPECIFICATION = 18002,
# Screen Capture Errors
VIX_E_SCREEN_CAPTURE_ERROR = 19000,
VIX_E_SCREEN_CAPTURE_BAD_FORMAT = 19001,
VIX_E_SCREEN_CAPTURE_COMPRESSION_FAIL = 19002,
VIX_E_SCREEN_CAPTURE_LARGE_DATA = 19003,
# Guest Errors
VIX_E_GUEST_VOLUMES_NOT_FROZEN = 20000,
VIX_E_NOT_A_FILE = 20001,
VIX_E_NOT_A_DIRECTORY = 20002,
VIX_E_NO_SUCH_PROCESS = 20003,
VIX_E_FILE_NAME_TOO_LONG = 20004,
VIX_E_OPERATION_DISABLED = 20005,
# Tools Install Errors
VIX_E_TOOLS_INSTALL_NO_IMAGE = 21000,
VIX_E_TOOLS_INSTALL_IMAGE_INACCESIBLE = 21001,
VIX_E_TOOLS_INSTALL_NO_DEVICE = 21002,
VIX_E_TOOLS_INSTALL_DEVICE_NOT_CONNECTED = 21003,
VIX_E_TOOLS_INSTALL_CANCELLED = 21004,
VIX_E_TOOLS_INSTALL_INIT_FAILED = 21005,
VIX_E_TOOLS_INSTALL_AUTO_NOT_SUPPORTED = 21006,
VIX_E_TOOLS_INSTALL_GUEST_NOT_READY = 21007,
VIX_E_TOOLS_INSTALL_SIG_CHECK_FAILED = 21008,
VIX_E_TOOLS_INSTALL_ERROR = 21009,
VIX_E_TOOLS_INSTALL_ALREADY_UP_TO_DATE = 21010,
VIX_E_TOOLS_INSTALL_IN_PROGRESS = 21011,
VIX_E_TOOLS_INSTALL_IMAGE_COPY_FAILED = 21012,
# Wrapper Errors
VIX_E_WRAPPER_WORKSTATION_NOT_INSTALLED = 22001,
VIX_E_WRAPPER_VERSION_NOT_FOUND = 22002,
VIX_E_WRAPPER_SERVICEPROVIDER_NOT_FOUND = 22003,
VIX_E_WRAPPER_PLAYER_NOT_INSTALLED = 22004,
VIX_E_WRAPPER_RUNTIME_NOT_INSTALLED = 22005,
VIX_E_WRAPPER_MULTIPLE_SERVICEPROVIDERS = 22006,
# FuseMnt Errors
VIX_E_MNTAPI_MOUNTPT_NOT_FOUND = 24000,
VIX_E_MNTAPI_MOUNTPT_IN_USE = 24001,
VIX_E_MNTAPI_DISK_NOT_FOUND = 24002,
VIX_E_MNTAPI_DISK_NOT_MOUNTED = 24003,
VIX_E_MNTAPI_DISK_IS_MOUNTED = 24004,
VIX_E_MNTAPI_DISK_NOT_SAFE = 24005,
VIX_E_MNTAPI_DISK_CANT_OPEN = 24006,
VIX_E_MNTAPI_CANT_READ_PARTS = 24007,
VIX_E_MNTAPI_UMOUNT_APP_NOT_FOUND = 24008,
VIX_E_MNTAPI_UMOUNT = 24009,
VIX_E_MNTAPI_NO_MOUNTABLE_PARTITONS = 24010,
VIX_E_MNTAPI_PARTITION_RANGE = 24011,
VIX_E_MNTAPI_PERM = 24012,
VIX_E_MNTAPI_DICT = 24013,
VIX_E_MNTAPI_DICT_LOCKED = 24014,
VIX_E_MNTAPI_OPEN_HANDLES = 24015,
VIX_E_MNTAPI_CANT_MAKE_VAR_DIR = 24016,
VIX_E_MNTAPI_NO_ROOT = 24017,
VIX_E_MNTAPI_LOOP_FAILED = 24018,
VIX_E_MNTAPI_DAEMON = 24019,
VIX_E_MNTAPI_INTERNAL = 24020,
VIX_E_MNTAPI_SYSTEM = 24021,
VIX_E_MNTAPI_NO_CONNECTION_DETAILS = 24022,
# FuseMnt errors: Do not exceed 24299
# VixMntapi Errors
VIX_E_MNTAPI_INCOMPATIBLE_VERSION = 24300,
VIX_E_MNTAPI_OS_ERROR = 24301,
VIX_E_MNTAPI_DRIVE_LETTER_IN_USE = 24302,
VIX_E_MNTAPI_DRIVE_LETTER_ALREADY_ASSIGNED = 24303,
VIX_E_MNTAPI_VOLUME_NOT_MOUNTED = 24304,
VIX_E_MNTAPI_VOLUME_ALREADY_MOUNTED = 24305,
VIX_E_MNTAPI_FORMAT_FAILURE = 24306,
VIX_E_MNTAPI_NO_DRIVER = 24307,
VIX_E_MNTAPI_ALREADY_OPENED = 24308,
VIX_E_MNTAPI_ITEM_NOT_FOUND = 24309,
VIX_E_MNTAPI_UNSUPPROTED_BOOT_LOADER = 24310,
VIX_E_MNTAPI_UNSUPPROTED_OS = 24311,
VIX_E_MNTAPI_CODECONVERSION = 24312,
VIX_E_MNTAPI_REGWRITE_ERROR = 24313,
VIX_E_MNTAPI_UNSUPPORTED_FT_VOLUME = 24314,
VIX_E_MNTAPI_PARTITION_NOT_FOUND = 24315,
VIX_E_MNTAPI_PUTFILE_ERROR = 24316,
VIX_E_MNTAPI_GETFILE_ERROR = 24317,
VIX_E_MNTAPI_REG_NOT_OPENED = 24318,
VIX_E_MNTAPI_REGDELKEY_ERROR = 24319,
VIX_E_MNTAPI_CREATE_PARTITIONTABLE_ERROR = 24320,
VIX_E_MNTAPI_OPEN_FAILURE = 24321,
VIX_E_MNTAPI_VOLUME_NOT_WRITABLE = 24322,
# Network Errors
VIX_E_NET_HTTP_UNSUPPORTED_PROTOCOL = 30001,
VIX_E_NET_HTTP_URL_MALFORMAT = 30003,
VIX_E_NET_HTTP_COULDNT_RESOLVE_PROXY = 30005,
VIX_E_NET_HTTP_COULDNT_RESOLVE_HOST = 30006,
VIX_E_NET_HTTP_COULDNT_CONNECT = 30007,
VIX_E_NET_HTTP_HTTP_RETURNED_ERROR = 30022,
VIX_E_NET_HTTP_OPERATION_TIMEDOUT = 30028,
VIX_E_NET_HTTP_SSL_CONNECT_ERROR = 30035,
VIX_E_NET_HTTP_TOO_MANY_REDIRECTS = 30047,
VIX_E_NET_HTTP_TRANSFER = 30200,
VIX_E_NET_HTTP_SSL_SECURITY = 30201,
VIX_E_NET_HTTP_GENERIC = 30202,
char *Vix_GetErrorText(VixError err, char *locale)
ctypedef enum VixPropertyType:
VIX_PROPERTYTYPE_ANY = 0,
VIX_PROPERTYTYPE_INTEGER = 1,
VIX_PROPERTYTYPE_STRING = 2,
VIX_PROPERTYTYPE_BOOL = 3,
VIX_PROPERTYTYPE_HANDLE = 4,
VIX_PROPERTYTYPE_INT64 = 5,
VIX_PROPERTYTYPE_BLOB = 6
ctypedef enum VixPropertyID:
VIX_PROPERTY_NONE = 0,
# Properties used by several handle types
VIX_PROPERTY_META_DATA_CONTAINER = 2,
# VIX_HANDLETYPE_HOST properties
VIX_PROPERTY_HOST_HOSTTYPE = 50,
VIX_PROPERTY_HOST_API_VERSION = 51,
# VIX_HANDLETYPE_VM properties
VIX_PROPERTY_VM_NUM_VCPUS = 101,
VIX_PROPERTY_VM_VMX_PATHNAME = 103,
VIX_PROPERTY_VM_VMTEAM_PATHNAME = 105,
VIX_PROPERTY_VM_MEMORY_SIZE = 106,
VIX_PROPERTY_VM_READ_ONLY = 107,
VIX_PROPERTY_VM_NAME = 108,
VIX_PROPERTY_VM_GUESTOS = 109,
VIX_PROPERTY_VM_IN_VMTEAM = 128,
VIX_PROPERTY_VM_POWER_STATE = 129,
VIX_PROPERTY_VM_TOOLS_STATE = 152,
VIX_PROPERTY_VM_IS_RUNNING = 196,
VIX_PROPERTY_VM_SUPPORTED_FEATURES = 197,
# VIX_PROPERTY_VM_IS_RECORDING = 236,
# VIX_PROPERTY_VM_IS_REPLAYING = 237,
VIX_PROPERTY_VM_SSL_ERROR = 293,
# Result properties; these are returned by various procedures
VIX_PROPERTY_JOB_RESULT_ERROR_CODE = 3000, # int64
VIX_PROPERTY_JOB_RESULT_VM_IN_GROUP = 3001, # handle
VIX_PROPERTY_JOB_RESULT_USER_MESSAGE = 3002, # char*
VIX_PROPERTY_JOB_RESULT_EXIT_CODE = 3004, # int
VIX_PROPERTY_JOB_RESULT_COMMAND_OUTPUT = 3005, # char*
VIX_PROPERTY_JOB_RESULT_HANDLE = 3010, # handle
VIX_PROPERTY_JOB_RESULT_GUEST_OBJECT_EXISTS = 3011, # bool
VIX_PROPERTY_JOB_RESULT_GUEST_PROGRAM_ELAPSED_TIME = 3017, # int
VIX_PROPERTY_JOB_RESULT_GUEST_PROGRAM_EXIT_CODE = 3018, # int
VIX_PROPERTY_JOB_RESULT_ITEM_NAME = 3035, # char*
VIX_PROPERTY_JOB_RESULT_FOUND_ITEM_DESCRIPTION = 3036, # char*
VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_COUNT = 3046, # int
VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_HOST = 3048, # char*
VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_FLAGS = 3049, # int
VIX_PROPERTY_JOB_RESULT_PROCESS_ID = 3051, # int64
VIX_PROPERTY_JOB_RESULT_PROCESS_OWNER = 3052, # char*
VIX_PROPERTY_JOB_RESULT_PROCESS_COMMAND = 3053, # char*
VIX_PROPERTY_JOB_RESULT_FILE_FLAGS = 3054, # int
VIX_PROPERTY_JOB_RESULT_PROCESS_START_TIME = 3055, # int
VIX_PROPERTY_JOB_RESULT_VM_VARIABLE_STRING = 3056, # char*
VIX_PROPERTY_JOB_RESULT_PROCESS_BEING_DEBUGGED = 3057, # bool
VIX_PROPERTY_JOB_RESULT_SCREEN_IMAGE_SIZE = 3058, # int
VIX_PROPERTY_JOB_RESULT_SCREEN_IMAGE_DATA = 3059, # blob
VIX_PROPERTY_JOB_RESULT_FILE_SIZE = 3061, # int64
VIX_PROPERTY_JOB_RESULT_FILE_MOD_TIME = 3062, # int64
VIX_PROPERTY_JOB_RESULT_EXTRA_ERROR_INFO = 3084, # char*
# Event properties; these are sent in the moreEventInfo for some events
VIX_PROPERTY_FOUND_ITEM_LOCATION = 4010,
# VIX_HANDLETYPE_SNAPSHOT properties
VIX_PROPERTY_SNAPSHOT_DISPLAYNAME = 4200,
VIX_PROPERTY_SNAPSHOT_DESCRIPTION = 4201,
VIX_PROPERTY_SNAPSHOT_POWERSTATE = 4205,
# VIX_PROPERTY_SNAPSHOT_IS_REPLAYABLE = 4207,
VIX_PROPERTY_GUEST_SHAREDFOLDERS_SHARES_PATH = 4525,
# Virtual machine encryption properties
VIX_PROPERTY_VM_ENCRYPTION_PASSWORD = 7001,
ctypedef enum VixEventType:
VIX_EVENTTYPE_JOB_COMPLETED = 2,
VIX_EVENTTYPE_JOB_PROGRESS = 3,
VIX_EVENTTYPE_FIND_ITEM = 8,
VIX_EVENTTYPE_CALLBACK_SIGNALLED = 2, # Deprecated - Use
# VIX_EVENTTYPE_JOB_COMPLETED
ctypedef enum:
VIX_FILE_ATTRIBUTES_DIRECTORY = 0x0001,
VIX_FILE_ATTRIBUTES_SYMLINK = 0x0002,
# Procedures of this type are called when an event happens on a handle
ctypedef void VixEventProc(VixHandle handle,
VixEventType eventType,
VixHandle moreEventInfo,
void *clientData)
# Handle Property functions
void Vix_ReleaseHandle(VixHandle handle)
void Vix_AddRefHandle(VixHandle handle)
VixHandleType Vix_GetHandleType(VixHandle handle)
VixError Vix_GetProperties(VixHandle handle,
VixPropertyID firstPropertyID, ...)
VixError Vix_GetPropertyType(VixHandle handle, VixPropertyID propertyID,
VixPropertyType *propertyType)
void Vix_FreeBuffer(void *p)
ctypedef int VixHostOptions
ctypedef enum:
VIX_HOSTOPTION_VERIFY_SSL_CERT = 0x4000,
ctypedef enum VixServiceProvider:
VIX_SERVICEPROVIDER_DEFAULT = 1,
VIX_SERVICEPROVIDER_VMWARE_SERVER = 2,
VIX_SERVICEPROVIDER_VMWARE_WORKSTATION = 3,
VIX_SERVICEPROVIDER_VMWARE_PLAYER = 4,
VIX_SERVICEPROVIDER_VMWARE_VI_SERVER = 10,
VIX_SERVICEPROVIDER_VMWARE_WORKSTATION_SHARED = 11,
# VIX_API_VERSION tells VixHost_Connect to use the latest API version
# that is available for the product specified in the VixServiceProvider
# parameter.
ctypedef enum:
VIX_API_VERSION = -1
VixHandle VixHost_Connect(int apiVersion,
VixServiceProvider hostType,
char *hostName,
int hostPort,
char *userName,
char *password,
VixHostOptions options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
void VixHost_Disconnect(VixHandle hostHandle)
# VM Registration
VixHandle VixHost_RegisterVM(VixHandle hostHandle,
char *vmxFilePath,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixHost_UnregisterVM(VixHandle hostHandle,
char *vmxFilePath,
VixEventProc *callbackProc,
void *clientData)
# VM Search
ctypedef enum VixFindItemType:
VIX_FIND_RUNNING_VMS = 1,
VIX_FIND_REGISTERED_VMS = 4,
VixHandle VixHost_FindItems(VixHandle hostHandle,
VixFindItemType searchType,
VixHandle searchCriteria,
int timeout,
VixEventProc *callbackProc,
void *clientData)
ctypedef int VixVMOpenOptions
ctypedef enum:
VIX_VMOPEN_NORMAL = 0,
VixHandle VixHost_OpenVM(VixHandle hostHandle,
char *vmxFilePathName,
VixVMOpenOptions options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
# PropertyList
VixError VixPropertyList_AllocPropertyList(VixHandle hostHandle,
VixHandle *resultHandle,
int firstPropertyID,
...)
# VIX VM
VixHandle VixVM_Open(VixHandle hostHandle,
char *vmxFilePathName,
VixEventProc *callbackProc,
void *clientData)
ctypedef int VixVMPowerOpOptions
ctypedef enum:
VIX_VMPOWEROP_NORMAL = 0,
VIX_VMPOWEROP_FROM_GUEST = 0x0004,
VIX_VMPOWEROP_SUPPRESS_SNAPSHOT_POWERON = 0x0080,
VIX_VMPOWEROP_LAUNCH_GUI = 0x0200,
VIX_VMPOWEROP_START_VM_PAUSED = 0x1000,
# Power operations
VixHandle VixVM_PowerOn(VixHandle vmHandle,
VixVMPowerOpOptions powerOnOptions,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_PowerOff(VixHandle vmHandle,
VixVMPowerOpOptions powerOffOptions,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_Reset(VixHandle vmHandle,
VixVMPowerOpOptions resetOptions,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_Suspend(VixHandle vmHandle,
VixVMPowerOpOptions suspendOptions,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_Pause(VixHandle vmHandle,
int options,
VixHandle propertyList,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_Unpause(VixHandle vmHandle,
int options,
VixHandle propertyList,
VixEventProc *callbackProc,
void *clientData)
ctypedef int VixVMDeleteOptions
ctypedef enum:
VIX_VMDELETE_DISK_FILES = 0x0002,
VixHandle VixVM_Delete(VixHandle vmHandle,
VixVMDeleteOptions deleteOptions,
VixEventProc *callbackProc,
void *clientData)
ctypedef int VixPowerState
ctypedef enum:
VIX_POWERSTATE_POWERING_OFF = 0x0001,
VIX_POWERSTATE_POWERED_OFF = 0x0002,
VIX_POWERSTATE_POWERING_ON = 0x0004,
VIX_POWERSTATE_POWERED_ON = 0x0008,
VIX_POWERSTATE_SUSPENDING = 0x0010,
VIX_POWERSTATE_SUSPENDED = 0x0020,
VIX_POWERSTATE_TOOLS_RUNNING = 0x0040,
VIX_POWERSTATE_RESETTING = 0x0080,
VIX_POWERSTATE_BLOCKED_ON_MSG = 0x0100,
VIX_POWERSTATE_PAUSED = 0x0200,
VIX_POWERSTATE_RESUMING = 0x0800,
ctypedef int VixToolsState
ctypedef enum:
VIX_TOOLSSTATE_UNKNOWN = 0x0001,
VIX_TOOLSSTATE_RUNNING = 0x0002,
VIX_TOOLSSTATE_NOT_INSTALLED = 0x0004,
ctypedef enum:
VIX_VM_SUPPORT_SHARED_FOLDERS = 0x0001,
VIX_VM_SUPPORT_MULTIPLE_SNAPSHOTS = 0x0002,
VIX_VM_SUPPORT_TOOLS_INSTALL = 0x0004,
VIX_VM_SUPPORT_HARDWARE_UPGRADE = 0x0008,
# Guest operations
VixHandle VixVM_WaitForToolsInGuest(VixHandle vmHandle,
int timeoutInSeconds,
VixEventProc *callbackProc,
void *clientData)
# VixVM_LoginInGuest option flags
ctypedef enum:
VIX_LOGIN_IN_GUEST_REQUIRE_INTERACTIVE_ENVIRONMENT = 0x08
VixHandle VixVM_LoginInGuest(VixHandle vmHandle,
char *userName,
char *password,
int options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_LogoutFromGuest(VixHandle vmHandle,
VixEventProc *callbackProc,
void *clientData)
# Guest Process functions
ctypedef int VixRunProgramOptions
ctypedef enum:
VIX_RUNPROGRAM_RETURN_IMMEDIATELY = 0x0001,
VIX_RUNPROGRAM_ACTIVATE_WINDOW = 0x0002
VixHandle VixVM_RunProgramInGuest(VixHandle vmHandle,
char *guestProgramName,
char *commandLineArgs,
VixRunProgramOptions options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_ListProcessesInGuest(VixHandle vmHandle,
int options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_KillProcessInGuest(VixHandle vmHandle,
uint64 pid,
int options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_RunScriptInGuest(VixHandle vmHandle,
char *interpreter,
char *scriptText,
VixRunProgramOptions options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
# Guest File functions
VixHandle VixVM_CopyFileFromHostToGuest(VixHandle vmHandle,
char *hostPathName,
char *guestPathName,
int options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_CopyFileFromGuestToHost(VixHandle vmHandle,
char *guestPathName,
char *hostPathName,
int options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_DeleteFileInGuest(VixHandle vmHandle,
char *guestPathName,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_FileExistsInGuest(VixHandle vmHandle,
char *guestPathName,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_RenameFileInGuest(VixHandle vmHandle,
char *oldName,
char *newName,
int options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_CreateTempFileInGuest(VixHandle vmHandle,
int options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_GetFileInfoInGuest(VixHandle vmHandle,
char *pathName,
VixEventProc *callbackProc,
void *clientData)
# Guest Directory functions
VixHandle VixVM_ListDirectoryInGuest(VixHandle vmHandle,
char *pathName,
int options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_CreateDirectoryInGuest(VixHandle vmHandle,
char *pathName,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_DeleteDirectoryInGuest(VixHandle vmHandle,
char *pathName,
int options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_DirectoryExistsInGuest(VixHandle vmHandle,
char *pathName,
VixEventProc *callbackProc,
void *clientData)
# Guest Variable Functions
ctypedef enum:
VIX_VM_GUEST_VARIABLE = 1,
VIX_VM_CONFIG_RUNTIME_ONLY = 2,
VIX_GUEST_ENVIRONMENT_VARIABLE = 3,
VixHandle VixVM_ReadVariable(VixHandle vmHandle,
int variableType,
char *name,
int options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_WriteVariable(VixHandle vmHandle,
int variableType,
char *valueName,
char *value,
int options,
VixEventProc *callbackProc,
void *clientData)
# Snapshot functions that operate on a VM
VixError VixVM_GetNumRootSnapshots(VixHandle vmHandle,
int *result)
VixError VixVM_GetRootSnapshot(VixHandle vmHandle,
int index,
VixHandle *snapshotHandle)
VixError VixVM_GetCurrentSnapshot(VixHandle vmHandle,
VixHandle *snapshotHandle)
VixError VixVM_GetNamedSnapshot(VixHandle vmHandle,
char *name,
VixHandle *snapshotHandle)
ctypedef int VixRemoveSnapshotOptions
ctypedef enum:
VIX_SNAPSHOT_REMOVE_CHILDREN = 0x0001,
VixHandle VixVM_RemoveSnapshot(VixHandle vmHandle,
VixHandle snapshotHandle,
VixRemoveSnapshotOptions options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_RevertToSnapshot(VixHandle vmHandle,
VixHandle snapshotHandle,
VixVMPowerOpOptions options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
ctypedef int VixCreateSnapshotOptions
ctypedef enum:
VIX_SNAPSHOT_INCLUDE_MEMORY = 0x0002,
VixHandle VixVM_CreateSnapshot(VixHandle vmHandle,
char *name,
char *description,
VixCreateSnapshotOptions options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
# Shared Folders Functions
ctypedef int VixMsgSharedFolderOptions
ctypedef enum:
VIX_SHAREDFOLDER_WRITE_ACCESS = 0x04
VixHandle VixVM_EnableSharedFolders(VixHandle vmHandle,
Bool enabled,
int options,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_GetNumSharedFolders(VixHandle vmHandle,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_GetSharedFolderState(VixHandle vmHandle,
int index,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_SetSharedFolderState(VixHandle vmHandle,
char *shareName,
char *hostPathName,
VixMsgSharedFolderOptions flags,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_AddSharedFolder(VixHandle vmHandle,
char *shareName,
char *hostPathName,
VixMsgSharedFolderOptions flags,
VixEventProc *callbackProc,
void *clientData)
VixHandle VixVM_RemoveSharedFolder(VixHandle vmHandle,
char *shareName,
int flags,
VixEventProc *callbackProc,
void *clientData)
# Screen Capture
ctypedef enum:
VIX_CAPTURESCREENFORMAT_PNG = 0x01,
VIX_CAPTURESCREENFORMAT_PNG_NOCOMPRESS = 0x02,
VixHandle VixVM_CaptureScreenImage(VixHandle vmHandle,
int captureType,
VixHandle additionalProperties,
VixEventProc *callbackProc,
void *clientdata)
# VM Cloning --
ctypedef enum VixCloneType:
VIX_CLONETYPE_FULL = 0,
VIX_CLONETYPE_LINKED = 1,
VixHandle VixVM_Clone(VixHandle vmHandle,
VixHandle snapshotHandle,
VixCloneType cloneType,
char *destConfigPathName,
int options,
VixHandle propertyListHandle,
VixEventProc *callbackProc,
void *clientData)
# Misc Functions
VixHandle VixVM_UpgradeVirtualHardware(VixHandle vmHandle,
int options,
VixEventProc *callbackProc,
void *clientData)
ctypedef enum:
VIX_INSTALLTOOLS_MOUNT_TOOLS_INSTALLER = 0x00,
VIX_INSTALLTOOLS_AUTO_UPGRADE = 0x01,
VIX_INSTALLTOOLS_RETURN_IMMEDIATELY = 0x02
VixHandle VixVM_InstallTools(VixHandle vmHandle,
int options,
char *commandLineArgs,
VixEventProc *callbackProc,
void *clientData)
# VIX Job
VixError VixJob_Wait(VixHandle jobHandle,
VixPropertyID firstPropertyID,
...)
VixError VixJob_CheckCompletion(VixHandle jobHandle,
Bool *complete)
VixError VixJob_GetError(VixHandle jobHandle)
int VixJob_GetNumProperties(VixHandle jobHandle,
int resultPropertyID)
VixError VixJob_GetNthProperties(VixHandle jobHandle,
int index,
int propertyID,
...)
# VIX Snapshot
VixError VixSnapshot_GetNumChildren(VixHandle parentSnapshotHandle,
int *numChildSnapshots)
VixError VixSnapshot_GetChild(VixHandle parentSnapshotHandle,
int index,
VixHandle *childSnapshotHandle)
VixError VixSnapshot_GetParent(VixHandle snapshotHandle,
VixHandle *parentSnapshotHandle)