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