1.. _vmware_inventory_vm_attributes: 2 3******************************************************************* 4Using Virtual machine attributes in VMware dynamic inventory plugin 5******************************************************************* 6 7.. contents:: 8 :local: 9 10Virtual machine attributes 11========================== 12 13You can use virtual machine properties which can be used to populate ``hostvars`` for the given 14virtual machine in a VMware dynamic inventory plugin. 15 16capability 17---------- 18 19This section describes settings for the runtime capabilities of the virtual machine. 20 21snapshotOperationsSupported (bool) 22^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 23 24 Indicates whether or not a virtual machine supports snapshot operations. 25 26multipleSnapshotsSupported (bool) 27^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 28 29 Indicates whether or not a virtual machine supports multiple snapshots. 30 This value is not set when the virtual machine is unavailable, for instance, when it is being created or deleted. 31 32snapshotConfigSupported (bool) 33^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 34 35 Indicates whether or not a virtual machine supports snapshot config. 36 37poweredOffSnapshotsSupported (bool) 38^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 39 40 Indicates whether or not a virtual machine supports snapshot operations in ``poweredOff`` state. 41 42memorySnapshotsSupported (bool) 43^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 44 45 Indicates whether or not a virtual machine supports memory snapshots. 46 47revertToSnapshotSupported (bool) 48^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 49 50 Indicates whether or not a virtual machine supports reverting to a snapshot. 51 52quiescedSnapshotsSupported (bool) 53^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 54 55 Indicates whether or not a virtual machine supports quiesced snapshots. 56 57disableSnapshotsSupported (bool) 58^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 59 60 Indicates whether or not snapshots can be disabled. 61 62lockSnapshotsSupported (bool) 63^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 64 65 Indicates whether or not the snapshot tree can be locked. 66 67consolePreferencesSupported (bool) 68^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 69 70 Indicates whether console preferences can be set for the virtual machine. 71 72cpuFeatureMaskSupported (bool) 73^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 74 75 Indicates whether CPU feature requirements masks can be set for the virtual machine. 76 77s1AcpiManagementSupported (bool) 78^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 79 80 Indicates whether or not a virtual machine supports ACPI S1 settings management. 81 82settingScreenResolutionSupported (bool) 83^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 84 85 Indicates whether or not the virtual machine supports setting the screen resolution of the console window. 86 87toolsAutoUpdateSupported (bool) 88^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 89 90 Supports tools auto-update. 91 92vmNpivWwnSupported (bool) 93^^^^^^^^^^^^^^^^^^^^^^^^^ 94 95 Supports virtual machine NPIV WWN. 96 97npivWwnOnNonRdmVmSupported (bool) 98^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 99 100 Supports assigning NPIV WWN to virtual machines that do not have RDM disks. 101 102vmNpivWwnDisableSupported (bool) 103^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 104 105 Indicates whether the NPIV disabling operation is supported on the virtual machine. 106 107vmNpivWwnUpdateSupported (bool) 108^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 109 110 Indicates whether the update of NPIV WWNs are supported on the virtual machine. 111 112swapPlacementSupported (bool) 113^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 114 115 Flag indicating whether the virtual machine has a configurable (swapfile placement policy). 116 117toolsSyncTimeSupported (bool) 118^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 119 120 Indicates whether asking tools to sync time with the host is supported. 121 122virtualMmuUsageSupported (bool) 123^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 124 125 Indicates whether or not the use of nested page table hardware support can be explicitly set. 126 127diskSharesSupported (bool) 128^^^^^^^^^^^^^^^^^^^^^^^^^^ 129 130 Indicates whether resource settings for disks can be applied to the virtual machine. 131 132bootOptionsSupported (bool) 133^^^^^^^^^^^^^^^^^^^^^^^^^^^ 134 135 Indicates whether boot options can be configured for the virtual machine. 136 137bootRetryOptionsSupported (bool) 138^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 139 140 Indicates whether automatic boot retry can be configured for the virtual machine. 141 142settingVideoRamSizeSupported (bool) 143^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 144 145 Flag indicating whether the video RAM size of the virtual machine can be configured. 146 147settingDisplayTopologySupported (bool) 148^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 149 150 Indicates whether or not the virtual machine supports setting the display topology of the console window. 151 152recordReplaySupported (bool) 153^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 154 155 Indicates whether record and replay functionality is supported on the virtual machine. 156 157changeTrackingSupported (bool) 158^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 159 160 Indicates that change tracking is supported for virtual disks of the virtual machine. 161 However, even if change tracking is supported, it might not be available for all disks of the virtual machine. 162 For example, passthru raw disk mappings or disks backed by any Ver1BackingInfo cannot be tracked. 163 164multipleCoresPerSocketSupported (bool) 165^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 166 167 Indicates whether multiple virtual cores per socket is supported on the virtual machine. 168 169hostBasedReplicationSupported (bool) 170^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 171 172 Indicates that host based replication is supported on the virtual machine. 173 However, even if host based replication is supported, it might not be available for all disk types. 174 For example, passthru raw disk mappings can not be replicated. 175 176guestAutoLockSupported (bool) 177^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 178 179 Indicates whether or not guest autolock is supported on the virtual machine. 180 181memoryReservationLockSupported (bool) 182^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 183 184 Indicates whether :ref:`memory_reservation_locked_to_max` may be set to true for the virtual machine. 185 186featureRequirementSupported (bool) 187^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 188 189 Indicates whether the featureRequirement feature is supported. 190 191poweredOnMonitorTypeChangeSupported (bool) 192^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 193 194 Indicates whether a monitor type change is supported while the virtual machine is in the ``poweredOn`` state. 195 196seSparseDiskSupported (bool) 197^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 198 199 Indicates whether the virtual machine supports the Flex-SE (space-efficent, sparse) format for virtual disks. 200 201nestedHVSupported (bool) 202^^^^^^^^^^^^^^^^^^^^^^^^ 203 204 Indicates whether the virtual machine supports nested hardware-assisted virtualization. 205 206vPMCSupported (bool) 207^^^^^^^^^^^^^^^^^^^^ 208 209 Indicates whether the virtual machine supports virtualized CPU performance counters. 210 211 212config 213------ 214 215This section describes the configuration settings of the virtual machine, including the name and UUID. 216This property is set when a virtual machine is created or when the ``reconfigVM`` method is called. 217The virtual machine configuration is not guaranteed to be available. 218For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the initial phases of virtual machine creation. 219 220changeVersion (str) 221^^^^^^^^^^^^^^^^^^^ 222 223 The changeVersion is a unique identifier for a given version of the configuration. 224 Each change to the configuration updates this value. This is typically implemented as an ever increasing count or a time-stamp. 225 However, a client should always treat this as an opaque string. 226 227modified (datetime) 228^^^^^^^^^^^^^^^^^^^ 229 230 Last time a virtual machine's configuration was modified. 231 232name (str) 233^^^^^^^^^^ 234 235 Display name of the virtual machine. Any / (slash), \ (backslash), character used in this name element is escaped. Similarly, any % (percent) character used in this name element is escaped, unless it is used to start an escape sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or %5c, and a percent is escaped as %25. 236 237.. _guest_full_name: 238 239guestFullName (str) 240^^^^^^^^^^^^^^^^^^^ 241 242 This is the full name of the guest operating system for the virtual machine. For example: Windows 2000 Professional. See :ref:`alternate_guest_name`. 243 244version (str) 245^^^^^^^^^^^^^ 246 247 The version string for the virtual machine. 248 249uuid (str) 250^^^^^^^^^^ 251 252 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format. 253 254instanceUuid (str, optional) 255^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 256 257 VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID. 258 259npivNodeWorldWideName (long, optional) 260^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 261 262 A 64-bit node WWN (World Wide Name). 263 264npivPortWorldWideName (long, optional) 265^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 266 267 A 64-bit port WWN (World Wide Name). 268 269npivWorldWideNameType (str, optional) 270^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 271 272 The source that provides/generates the assigned WWNs. 273 274npivDesiredNodeWwns (short, optional) 275^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 276 277 The NPIV node WWNs to be extended from the original list of WWN numbers. 278 279npivDesiredPortWwns (short, optional) 280^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 281 282 The NPIV port WWNs to be extended from the original list of WWN numbers. 283 284npivTemporaryDisabled (bool, optional) 285^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 286 287 This property is used to enable or disable the NPIV capability on a desired virtual machine on a temporary basis. 288 289npivOnNonRdmDisks (bool, optional) 290^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 291 292 This property is used to check whether the NPIV can be enabled on the Virtual machine with non-rdm disks in the configuration, so this is potentially not enabling npiv on vmfs disks. 293 Also this property is used to check whether RDM is required to generate WWNs for a virtual machine. 294 295locationId (str, optional) 296^^^^^^^^^^^^^^^^^^^^^^^^^^ 297 298 Hash incorporating the virtual machine's config file location and the UUID of the host assigned to run the virtual machine. 299 300template (bool) 301^^^^^^^^^^^^^^^ 302 303 Flag indicating whether or not a virtual machine is a template. 304 305guestId (str) 306^^^^^^^^^^^^^ 307 308 Guest operating system configured on a virtual machine. 309 310.. _alternate_guest_name: 311 312alternateGuestName (str) 313^^^^^^^^^^^^^^^^^^^^^^^^ 314 315 Used as display name for the operating system if guestId isotherorother-64. See :ref:`guest_full_name`. 316 317annotation (str, optional) 318^^^^^^^^^^^^^^^^^^^^^^^^^^ 319 320 Description for the virtual machine. 321 322files (vim.vm.FileInfo) 323^^^^^^^^^^^^^^^^^^^^^^^ 324 325 Information about the files associated with a virtual machine. 326 This information does not include files for specific virtual disks or snapshots. 327 328tools (vim.vm.ToolsConfigInfo, optional) 329^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 330 331 Configuration of VMware Tools running in the guest operating system. 332 333flags (vim.vm.FlagInfo) 334^^^^^^^^^^^^^^^^^^^^^^^ 335 336 Additional flags for a virtual machine. 337 338consolePreferences (vim.vm.ConsolePreferences, optional) 339^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 340 341 Legacy console viewer preferences when doing power operations. 342 343defaultPowerOps (vim.vm.DefaultPowerOpInfo) 344^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 345 346 Configuration of default power operations. 347 348hardware (vim.vm.VirtualHardware) 349^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 350 351 Processor, memory, and virtual devices for a virtual machine. 352 353cpuAllocation (vim.ResourceAllocationInfo, optional) 354^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 355 356 Resource limits for CPU. 357 358memoryAllocation (vim.ResourceAllocationInfo, optional) 359^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 360 361 Resource limits for memory. 362 363latencySensitivity (vim.LatencySensitivity, optional) 364^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 365 366 The latency-sensitivity of the virtual machine. 367 368memoryHotAddEnabled (bool, optional) 369^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 370 371 Whether memory can be added while the virtual machine is running. 372 373cpuHotAddEnabled (bool, optional) 374^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 375 376 Whether virtual processors can be added while the virtual machine is running. 377 378cpuHotRemoveEnabled (bool, optional) 379^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 380 381 Whether virtual processors can be removed while the virtual machine is running. 382 383hotPlugMemoryLimit (long, optional) 384^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 385 386 The maximum amount of memory, in MB, than can be added to a running virtual machine. 387 388hotPlugMemoryIncrementSize (long, optional) 389^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 390 391 Memory, in MB that can be added to a running virtual machine. 392 393cpuAffinity (vim.vm.AffinityInfo, optional) 394^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 395 396 Affinity settings for CPU. 397 398memoryAffinity (vim.vm.AffinityInfo, optional) 399^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 400 401 Affinity settings for memory. 402 403networkShaper (vim.vm.NetworkShaperInfo, optional) 404^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 405 406 Resource limits for network. 407 408extraConfig (vim.option.OptionValue, optional) 409^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 410 411 Additional configuration information for the virtual machine. 412 413cpuFeatureMask (vim.host.CpuIdInfo, optional) 414^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 415 416 Specifies CPU feature compatibility masks that override the defaults from the ``GuestOsDescriptor`` of the virtual machine's guest OS. 417 418datastoreUrl (vim.vm.ConfigInfo.DatastoreUrlPair, optional) 419^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420 421 Enumerates the set of datastores that the virtual machine is stored on, as well as the URL identification for each of these. 422 423swapPlacement (str, optional) 424^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 425 426 Virtual machine swapfile placement policy. 427 428bootOptions (vim.vm.BootOptions, optional) 429^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 430 431 Configuration options for the boot behavior of the virtual machine. 432 433ftInfo (vim.vm.FaultToleranceConfigInfo, optional) 434^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 435 436 Fault tolerance settings for the virtual machine. 437 438vAppConfig (vim.vApp.VmConfigInfo, optional) 439^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 440 441 vApp meta-data for the virtual machine. 442 443vAssertsEnabled (bool, optional) 444^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 445 446 Indicates whether user-configured virtual asserts will be triggered during virtual machine replay. 447 448changeTrackingEnabled (bool, optional) 449^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 450 451 Indicates whether changed block tracking for the virtual machine's disks is active. 452 453firmware (str, optional) 454^^^^^^^^^^^^^^^^^^^^^^^^ 455 456 Information about firmware type for the virtual machine. 457 458maxMksConnections (int, optional) 459^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 460 461 Indicates the maximum number of active remote display connections that the virtual machine will support. 462 463guestAutoLockEnabled (bool, optional) 464^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 465 466 Indicates whether the guest operating system will logout any active sessions whenever there are no remote display connections open to the virtual machine. 467 468managedBy (vim.ext.ManagedByInfo, optional) 469^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 470 471 Specifies that the virtual machine is managed by a VC Extension. 472 473.. _memory_reservation_locked_to_max: 474 475memoryReservationLockedToMax (bool, optional) 476^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 477 478 If set true, memory resource reservation for the virtual machine will always be equal to the virtual machine's memory size; increases in memory size will be rejected when a corresponding reservation increase is not possible. 479 480initialOverhead (vim.vm.ConfigInfo.OverheadInfo), optional) 481^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 482 483 Set of values to be used only to perform admission control when determining if a host has sufficient resources for the virtual machine to power on. 484 485nestedHVEnabled (bool, optional) 486^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 487 488 Indicates whether the virtual machine is configured to use nested hardware-assisted virtualization. 489 490vPMCEnabled (bool, optional) 491^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 492 493 Indicates whether the virtual machine have virtual CPU performance counters enabled. 494 495scheduledHardwareUpgradeInfo (vim.vm.ScheduledHardwareUpgradeInfo, optional) 496^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 497 498 Configuration of scheduled hardware upgrades and result from last attempt to run scheduled hardware upgrade. 499 500vFlashCacheReservation (long, optional) 501^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 502 503 Specifies the total vFlash resource reservation for the vFlash caches associated with the virtual machine's virtual disks, in bytes. 504 505layout 506------ 507 508Detailed information about the files that comprise the virtual machine. 509 510configFile (str, optional) 511^^^^^^^^^^^^^^^^^^^^^^^^^^ 512 513 A list of files that makes up the configuration of the virtual machine (excluding the .vmx file, since that file is represented in the FileInfo). 514 These are relative paths from the configuration directory. 515 A slash is always used as a separator. 516 This list will typically include the NVRAM file, but could also include other meta-data files. 517 518logFile (str, optional) 519^^^^^^^^^^^^^^^^^^^^^^^ 520 521 A list of files stored in the virtual machine's log directory. 522 These are relative paths from the ``logDirectory``. 523 A slash is always used as a separator. 524 525disk (vim.vm.FileLayout.DiskLayout, optional) 526^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 527 528 Files making up each virtual disk. 529 530snapshot (vim.vm.FileLayout.SnapshotLayout, optional) 531^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 532 533 Files of each snapshot. 534 535swapFile (str, optional) 536^^^^^^^^^^^^^^^^^^^^^^^^ 537 538 The swapfile specific to the virtual machine, if any. This is a complete datastore path, not a relative path. 539 540 541layoutEx 542-------- 543 544Detailed information about the files that comprise the virtual machine. 545 546file (vim.vm.FileLayoutEx.FileInfo, optional) 547^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 548 549 Information about all the files that constitute the virtual machine including configuration files, disks, swap file, suspend file, log files, core files, memory file and so on. 550 551disk (vim.vm.FileLayoutEx.DiskLayout, optional) 552^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 553 554 Layout of each virtual disk attached to the virtual machine. 555 For a virtual machine with snaphots, this property gives only those disks that are attached to it at the current point of running. 556 557snapshot (vim.vm.FileLayoutEx.SnapshotLayout, optional) 558^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 559 560 Layout of each snapshot of the virtual machine. 561 562timestamp (datetime) 563^^^^^^^^^^^^^^^^^^^^ 564 565 Time when values in this structure were last updated. 566 567storage (vim.vm.StorageInfo) 568---------------------------- 569 570Storage space used by the virtual machine, split by datastore. 571 572perDatastoreUsage (vim.vm.StorageInfo.UsageOnDatastore, optional) 573^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 574 575 Storage space used by the virtual machine on all datastores that it is located on. 576 Total storage space committed to the virtual machine across all datastores is simply an aggregate of the property ``committed`` 577 578timestamp (datetime) 579^^^^^^^^^^^^^^^^^^^^ 580 581 Time when values in this structure were last updated. 582 583environmentBrowser (vim.EnvironmentBrowser) 584------------------------------------------- 585 586The current virtual machine's environment browser object. 587This contains information on all the configurations that can be used on the virtual machine. 588This is identical to the environment browser on the ComputeResource to which the virtual machine belongs. 589 590datastoreBrowser (vim.host.DatastoreBrowser) 591^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 592 593 DatastoreBrowser to browse datastores that are available on this entity. 594 595resourcePool (vim.ResourcePool) 596------------------------------- 597 598The current resource pool that specifies resource allocation for the virtual machine. 599This property is set when a virtual machine is created or associated with a different resource pool. 600Returns null if the virtual machine is a template or the session has no access to the resource pool. 601 602summary (vim.ResourcePool.Summary) 603^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 604 605 Basic information about a resource pool. 606 607runtime (vim.ResourcePool.RuntimeInfo) 608^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 609 610 Runtime information about a resource pool. 611 612owner (vim.ComputeResource) 613^^^^^^^^^^^^^^^^^^^^^^^^^^^ 614 615 The ComputeResource to which this set of one or more nested resource pools belong. 616 617resourcePool (vim.ResourcePool) 618^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 619 620 The set of child resource pools. 621 622vm (vim.VirtualMachine) 623^^^^^^^^^^^^^^^^^^^^^^^ 624 625 The set of virtual machines associated with this resource pool. 626 627config (vim.ResourceConfigSpec) 628^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 629 630 Configuration of this resource pool. 631 632childConfiguration (vim.ResourceConfigSpec) 633^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 634 635 The resource configuration of all direct children (VirtualMachine and ResourcePool) of this resource group. 636 637parentVApp (vim.ManagedEntity) 638------------------------------ 639 640Reference to the parent vApp. 641 642parent (vim.ManagedEntity) 643^^^^^^^^^^^^^^^^^^^^^^^^^^ 644 645 Parent of this entity. 646 This value is null for the root object and for (VirtualMachine) objects that are part of a (VirtualApp). 647 648customValue (vim.CustomFieldsManager.Value) 649^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 650 651 Custom field values. 652 653overallStatus (vim.ManagedEntity.Status) 654^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 655 656 General health of this managed entity. 657 658configStatus (vim.ManagedEntity.Status) 659^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 660 661 The configStatus indicates whether or not the system has detected a configuration issue involving this entity. 662 For example, it might have detected a duplicate IP address or MAC address, or a host in a cluster might be out of ``compliance.property``. 663 664configIssue (vim.event.Event) 665^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 666 667 Current configuration issues that have been detected for this entity. 668 669effectiveRole (int) 670^^^^^^^^^^^^^^^^^^^ 671 672 Access rights the current session has to this entity. 673 674permission (vim.AuthorizationManager.Permission) 675^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 676 677 List of permissions defined for this entity. 678 679name (str) 680^^^^^^^^^^ 681 682 Name of this entity, unique relative to its parent. 683 Any / (slash), \ (backslash), character used in this name element will be escaped. 684 Similarly, any % (percent) character used in this name element will be escaped, unless it is used to start an escape sequence. 685 A slash is escaped as %2F or %2f. A backslash is escaped as %5C or %5c, and a percent is escaped as %25. 686 687disabledMethod (str) 688^^^^^^^^^^^^^^^^^^^^ 689 690 List of operations that are disabled, given the current runtime state of the entity. 691 For example, a power-on operation always fails if a virtual machine is already powered on. 692 693recentTask (vim.Task) 694^^^^^^^^^^^^^^^^^^^^^ 695 696 The set of recent tasks operating on this managed entity. 697 A task in this list could be in one of the four states: pending, running, success or error. 698 699declaredAlarmState (vim.alarm.AlarmState) 700^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 701 702 A set of alarm states for alarms that apply to this managed entity. 703 704triggeredAlarmState (vim.alarm.AlarmState) 705^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 706 707 A set of alarm states for alarms triggered by this entity or by its descendants. 708 709alarmActionsEnabled (bool) 710^^^^^^^^^^^^^^^^^^^^^^^^^^ 711 712 Whether alarm actions are enabled for this entity. True if enabled; false otherwise. 713 714tag (vim.Tag) 715^^^^^^^^^^^^^ 716 717 The set of tags associated with this managed entity. Experimental. Subject to change. 718 719resourceConfig (vim.ResourceConfigSpec) 720--------------------------------------- 721 722 The resource configuration for a virtual machine. 723 724entity (vim.ManagedEntity, optional) 725^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 726 727 Reference to the entity with this resource specification: either a VirtualMachine or a ResourcePool. 728 729changeVersion (str, optional) 730^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 731 732 The changeVersion is a unique identifier for a given version of the configuration. Each change to the configuration will update this value. 733 This is typically implemented as an ever increasing count or a time-stamp. 734 735 736lastModified (datetime, optional) 737^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 738 739 Timestamp when the resources were last modified. This is ignored when the object is used to update a configuration. 740 741cpuAllocation (vim.ResourceAllocationInfo) 742^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 743 744 Resource allocation for CPU. 745 746memoryAllocation (vim.ResourceAllocationInfo) 747^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 748 749 Resource allocation for memory. 750 751runtime (vim.vm.RuntimeInfo) 752---------------------------- 753 754Execution state and history for the virtual machine. 755 756device (vim.vm.DeviceRuntimeInfo, optional) 757^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 758 759 Per-device runtime info. This array will be empty if the host software does not provide runtime info for any of the device types currently in use by the virtual machine. 760 761host (vim.HostSystem, optional) 762^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 763 764 The host that is responsible for running a virtual machine. 765 This property is null if the virtual machine is not running and is not assigned to run on a particular host. 766 767connectionState (vim.VirtualMachine.ConnectionState) 768^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 769 770 Indicates whether or not the virtual machine is available for management. 771 772powerState (vim.VirtualMachine.PowerState) 773^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 774 775 The current power state of the virtual machine. 776 777faultToleranceState (vim.VirtualMachine.FaultToleranceState) 778^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 779 780 The fault tolerance state of the virtual machine. 781 782dasVmProtection (vim.vm.RuntimeInfo.DasProtectionState, optional) 783^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 784 785 The vSphere HA protection state for a virtual machine. 786 Property is unset if vSphere HA is not enabled. 787 788toolsInstallerMounted (bool) 789^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 790 791 Flag to indicate whether or not the VMware Tools installer is mounted as a CD-ROM. 792 793suspendTime (datetime, optional) 794^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 795 796 The timestamp when the virtual machine was most recently suspended. 797 This property is updated every time the virtual machine is suspended. 798 799bootTime (datetime, optional) 800^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 801 802 The timestamp when the virtual machine was most recently powered on. 803 This property is updated when the virtual machine is powered on from the poweredOff state, and is cleared when the virtual machine is powered off. 804 This property is not updated when a virtual machine is resumed from a suspended state. 805 806suspendInterval (long, optional) 807^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 808 809 The total time the virtual machine has been suspended since it was initially powered on. 810 This time excludes the current period, if the virtual machine is currently suspended. 811 This property is updated when the virtual machine resumes, and is reset to zero when the virtual machine is powered off. 812 813question (vim.vm.QuestionInfo, optional) 814^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 815 816 The current question, if any, that is blocking the virtual machine's execution. 817 818memoryOverhead (long, optional) 819^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 820 821 The amount of memory resource (in bytes) that will be used by the virtual machine above its guest memory requirements. 822 This value is set if and only if the virtual machine is registered on a host that supports memory resource allocation features. 823 For powered off VMs, this is the minimum overhead required to power on the VM on the registered host. 824 For powered on VMs, this is the current overhead reservation, a value which is almost always larger than the minimum overhead, and which grows with time. 825 826maxCpuUsage (int, optional) 827^^^^^^^^^^^^^^^^^^^^^^^^^^^ 828 829 Current upper-bound on CPU usage. 830 The upper-bound is based on the host the virtual machine is current running on, as well as limits configured on the virtual machine itself or any parent resource pool. 831 Valid while the virtual machine is running. 832 833maxMemoryUsage (int, optional) 834^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 835 836 Current upper-bound on memory usage. 837 The upper-bound is based on memory configuration of the virtual machine, as well as limits configured on the virtual machine itself or any parent resource pool. 838 Valid while the virtual machine is running. 839 840numMksConnections (int) 841^^^^^^^^^^^^^^^^^^^^^^^ 842 843 Number of active MKS connections to the virtual machine. 844 845recordReplayState (vim.VirtualMachine.RecordReplayState) 846^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 847 848 Record / replay state of the virtual machine. 849 850cleanPowerOff (bool, optional) 851^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 852 853 For a powered off virtual machine, indicates whether the virtual machine's last shutdown was an orderly power off or not. 854 Unset if the virtual machine is running or suspended. 855 856needSecondaryReason (str, optional) 857^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 858 859 If set, indicates the reason the virtual machine needs a secondary. 860 861onlineStandby (bool) 862^^^^^^^^^^^^^^^^^^^^ 863 864 This property indicates whether the guest has gone into one of the s1, s2 or s3 standby modes. False indicates the guest is awake. 865 866minRequiredEVCModeKey (str, optional) 867^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 868 869 For a powered-on or suspended virtual machine in a cluster with Enhanced VMotion Compatibility (EVC) enabled, this identifies the least-featured EVC mode (among those for the appropriate CPU vendor) that could admit the virtual machine. 870 This property will be unset if the virtual machine is powered off or is not in an EVC cluster. 871 This property may be used as a general indicator of the CPU feature baseline currently in use by the virtual machine. 872 However, the virtual machine may be suppressing some of the features present in the CPU feature baseline of the indicated mode, either explicitly (in the virtual machine's configured ``cpuFeatureMask``) or implicitly (in the default masks for the ``GuestOsDescriptor`` appropriate for the virtual machine's configured guest OS). 873 874consolidationNeeded (bool) 875^^^^^^^^^^^^^^^^^^^^^^^^^^ 876 877 Whether any disk of the virtual machine requires consolidation. 878 This can happen for example when a snapshot is deleted but its associated disk is not committed back to the base disk. 879 880offlineFeatureRequirement (vim.vm.FeatureRequirement, optional) 881^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 882 883 These requirements must have equivalent host capabilities ``featureCapability`` in order to power on. 884 885featureRequirement (vim.vm.FeatureRequirement, optional) 886^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 887 888 These requirements must have equivalent host capabilities ``featureCapability`` in order to power on, resume, or migrate to the host. 889 890featureMask (vim.host.FeatureMask, optional) 891^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 892 893 The masks applied to an individual virtual machine as a result of its configuration. 894 895vFlashCacheAllocation (long, optional) 896^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 897 898 Specifies the total allocated vFlash resource for the vFlash caches associated with VM's VMDKs when VM is powered on, in bytes. 899 900 901guest (vim.vm.GuestInfo) 902------------------------ 903 904Information about VMware Tools and about the virtual machine from the perspective of VMware Tools. 905Information about the guest operating system is available in VirtualCenter. 906Guest operating system information reflects the last known state of the virtual machine. 907For powered on machines, this is current information. 908For powered off machines, this is the last recorded state before the virtual machine was powered off. 909 910toolsStatus (vim.vm.GuestInfo.ToolsStatus, optional) 911^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 912 913 Current status of VMware Tools in the guest operating system, if known. 914 915toolsVersionStatus (str, optional) 916^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 917 918 Current version status of VMware Tools in the guest operating system, if known. 919 920toolsVersionStatus2 (str, optional) 921^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 922 923 Current version status of VMware Tools in the guest operating system, if known. 924 925toolsRunningStatus (str, optional) 926^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 927 928 Current running status of VMware Tools in the guest operating system, if known. 929 930toolsVersion (str, optional) 931^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 932 933 Current version of VMware Tools, if known. 934 935guestId (str, optional) 936^^^^^^^^^^^^^^^^^^^^^^^ 937 938 Guest operating system identifier (short name), if known. 939 940guestFamily (str, optional) 941^^^^^^^^^^^^^^^^^^^^^^^^^^^ 942 943 Guest operating system family, if known. 944 945guestFullName (str, optional) 946^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 947 948 See :ref:`guest_full_name`. 949 950hostName (str, optional) 951^^^^^^^^^^^^^^^^^^^^^^^^ 952 953 Hostname of the guest operating system, if known. 954 955ipAddress (str, optional) 956^^^^^^^^^^^^^^^^^^^^^^^^^ 957 958 Primary IP address assigned to the guest operating system, if known. 959 960net (vim.vm.GuestInfo.NicInfo, optional) 961^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 962 963 Guest information about network adapters, if known. 964 965ipStack (vim.vm.GuestInfo.StackInfo, optional) 966^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 967 968 Guest information about IP networking stack, if known. 969 970disk (vim.vm.GuestInfo.DiskInfo, optional) 971^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 972 973 Guest information about disks. 974 You can obtain Linux guest disk information for the following file system types only: Ext2, Ext3, Ext4, ReiserFS, ZFS, NTFS, VFAT, UFS, PCFS, HFS, and MS-DOS. 975 976screen (vim.vm.GuestInfo.ScreenInfo, optional) 977^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 978 979 Guest screen resolution info, if known. 980 981guestState (str) 982^^^^^^^^^^^^^^^^ 983 984 Operation mode of guest operating system. 985 986appHeartbeatStatus (str, optional) 987^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 988 989 Application heartbeat status. 990 991appState (str, optional) 992^^^^^^^^^^^^^^^^^^^^^^^^ 993 994 Application state. 995 If vSphere HA is enabled and the vm is configured for Application Monitoring and this field's value is ``appStateNeedReset`` then HA will attempt immediately reset the virtual machine. 996 There are some system conditions which may delay the immediate reset. 997 The immediate reset will be performed as soon as allowed by vSphere HA and ESX. 998 If during these conditions the value is changed to ``appStateOk`` the reset will be cancelled. 999 1000guestOperationsReady (bool, optional) 1001^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1002 1003 Guest Operations availability. If true, the vitrual machine is ready to process guest operations. 1004 1005interactiveGuestOperationsReady (bool, optional) 1006^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1007 1008 Interactive Guest Operations availability. If true, the virtual machine is ready to process guest operations as the user interacting with the guest desktop. 1009 1010generationInfo (vim.vm.GuestInfo.NamespaceGenerationInfo, privilege: VirtualMachine.Namespace.EventNotify, optional) 1011^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1012 1013 A list of namespaces and their corresponding generation numbers. Only namespaces with non-zero ``maxSizeEventsFromGuest`` are guaranteed to be present here. 1014 1015 1016summary (vim.vm.Summary) 1017------------------------ 1018 1019 Basic information about the virtual machine. 1020 1021vm (vim.VirtualMachine, optional) 1022^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1023 1024 Reference to the virtual machine managed object. 1025 1026runtime (vim.vm.RuntimeInfo) 1027^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1028 1029 Runtime and state information of a running virtual machine. 1030 Most of this information is also available when a virtual machine is powered off. 1031 In that case, it contains information from the last run, if available. 1032 1033guest (vim.vm.Summary.GuestSummary, optional) 1034^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1035 1036 Guest operating system and VMware Tools information. 1037 1038config (vim.vm.Summary.ConfigSummary) 1039^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1040 1041 Basic configuration information about the virtual machine. 1042 This information is not available when the virtual machine is unavailable, for instance, when it is being created or deleted. 1043 1044storage (vim.vm.Summary.StorageSummary, optional) 1045^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1046 1047 Storage information of the virtual machine. 1048 1049quickStats (vim.vm.Summary.QuickStats) 1050^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1051 1052 A set of statistics that are typically updated with near real-time regularity. 1053 1054overallStatus (vim.ManagedEntity.Status) 1055^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1056 1057 Overall alarm status on this node. 1058 1059customValue (vim.CustomFieldsManager.Value, optional) 1060^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1061 1062 Custom field values. 1063 1064 1065datastore (vim.Datastore) 1066------------------------- 1067 1068 A collection of references to the subset of datastore objects in the datacenter that is used by the virtual machine. 1069 1070info (vim.Datastore.Info) 1071^^^^^^^^^^^^^^^^^^^^^^^^^ 1072 1073 Specific information about the datastore. 1074 1075summary (vim.Datastore.Summary) 1076^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1077 1078 Global properties of the datastore. 1079 1080host (vim.Datastore.HostMount) 1081^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1082 1083 Hosts attached to this datastore. 1084 1085vm (vim.VirtualMachine) 1086^^^^^^^^^^^^^^^^^^^^^^^ 1087 1088 Virtual machines stored on this datastore. 1089 1090browser (vim.host.DatastoreBrowser) 1091^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1092 1093 DatastoreBrowser used to browse this datastore. 1094 1095capability (vim.Datastore.Capability) 1096^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1097 1098 Capabilities of this datastore. 1099 1100iormConfiguration (vim.StorageResourceManager.IORMConfigInfo) 1101^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1102 1103 Configuration of storage I/O resource management for the datastore. 1104 Currently VMware only support storage I/O resource management on VMFS volumes of a datastore. 1105 This configuration may not be available if the datastore is not accessible from any host, or if the datastore does not have VMFS volume. 1106 1107network (vim.Network) 1108--------------------- 1109 1110 A collection of references to the subset of network objects in the datacenter that is used by the virtual machine. 1111 1112name (str) 1113^^^^^^^^^^ 1114 1115 Name of this network. 1116 1117summary (vim.Network.Summary) 1118^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1119 1120 Properties of a network. 1121 1122host (vim.HostSystem) 1123^^^^^^^^^^^^^^^^^^^^^ 1124 1125 Hosts attached to this network. 1126 1127vm (vim.VirtualMachine) 1128^^^^^^^^^^^^^^^^^^^^^^^ 1129 1130 Virtual machines using this network. 1131 1132 1133snapshot (vim.vm.SnapshotInfo) 1134------------------------------- 1135 1136Current snapshot and tree. 1137The property is valid if snapshots have been created for the virtual machine. 1138 1139currentSnapshot (vim.vm.Snapshot, optional) 1140^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1141 1142 Current snapshot of the virtual machineThis property is set by calling ``Snapshot.revert`` or ``VirtualMachine.createSnapshot``. 1143 This property will be empty when the working snapshot is at the root of the snapshot tree. 1144 1145rootSnapshotList (vim.vm.SnapshotTree) 1146^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1147 1148 Data for the entire set of snapshots for one virtual machine. 1149 1150rootSnapshot (vim.vm.Snapshot) 1151------------------------------ 1152 1153The roots of all snapshot trees for the virtual machine. 1154 1155config (vim.vm.ConfigInfo) 1156^^^^^^^^^^^^^^^^^^^^^^^^^^ 1157 1158 Information about the configuration of the virtual machine when this snapshot was taken. 1159 The datastore paths for the virtual machine disks point to the head of the disk chain that represents the disk at this given snapshot. 1160 1161childSnapshot (vim.vm.Snapshot) 1162^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1163 1164 All snapshots for which this snapshot is the parent. 1165 1166guestHeartbeatStatus (vim.ManagedEntity.Status) 1167----------------------------------------------- 1168 1169 The guest heartbeat. 1170 1171.. seealso:: 1172 1173 `pyVmomi <https://github.com/vmware/pyvmomi>`_ 1174 The GitHub Page of pyVmomi 1175 `pyVmomi Issue Tracker <https://github.com/vmware/pyvmomi/issues>`_ 1176 The issue tracker for the pyVmomi project 1177 rst/scenario_guides/guide_vmware.rst 1178 The GitHub Page of vSphere Automation SDK for Python 1179 `vSphere Automation SDK Issue Tracker <https://github.com/vmware/vsphere-automation-sdk-python/issues>`_ 1180 The issue tracker for vSphere Automation SDK for Python 1181 :ref:`working_with_playbooks` 1182 An introduction to playbooks 1183 :ref:`playbooks_vault` 1184 Using Vault in playbooks 1185