:py:mod:`dissect.target.plugins.os.unix.esxi.vm`
================================================

.. py:module:: dissect.target.plugins.os.unix.esxi.vm




Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.esxi.vm.VirtualMachinePlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.esxi.vm.VirtualMachineInventoryRecord
   dissect.target.plugins.os.unix.esxi.vm.VirtualMachineOrphanRecord


.. py:data:: VirtualMachineInventoryRecord

.. py:data:: VirtualMachineOrphanRecord

.. py:class:: VirtualMachinePlugin(target: dissect.target.target.Target)

   Bases: :py:obj:`dissect.target.plugin.Plugin`


   Plugin to list ESXi virtual machines.


   .. py:attribute:: __namespace__
      :value: 'vm'


      Defines the plugin namespace.


   .. py:method:: check_compatible() -> None

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with the current target (``self.target``).
      For example, check if a certain file exists. Otherwise it should raise an
      :class:`UnsupportedPluginError`.

      :raises UnsupportedPluginError: If the plugin could not be loaded.



   .. py:method:: inventory() -> collections.abc.Iterator[VirtualMachineInventoryRecord]

      Yield all virtual machines registered on the ESXi host.



   .. py:method:: orphaned() -> collections.abc.Iterator[VirtualMachineOrphanRecord]

      Yield all virtual machines found at ``/vmfs/volumes/*/*/*.vmx`` that are NOT in the inventory.

      NOTE: If the target is part of a cluster, this may yield "false positives" for VMs registered
      on other hosts in the cluster.