:py:mod:`dissect.target.plugins.child.virtualbox`
=================================================

.. py:module:: dissect.target.plugins.child.virtualbox




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.child.virtualbox.VirtualBoxChildTargetPlugin




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

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


   Child target plugin that yields from Oracle VirtualBox VMs.

   Tested with configuration files from major versions 5, 6 and 7.

   .. rubric:: References

   - https://docs.oracle.com/en/virtualization/virtualbox/6.1/admin/TechnicalBackground.html


   .. py:attribute:: __type__
      :value: 'virtualbox'



   .. py:attribute:: USER_PATHS
      :value: ('.VirtualBox', '.config/VirtualBox', 'Library/VirtualBox')



   .. py:attribute:: DEFAULT_PATHS
      :value: ('VirtualBox VMs',)



   .. py:attribute:: vboxes


   .. py:method:: find_vms() -> collections.abc.Iterator[pathlib.Path]

      Yield Oracle VirtualBox ``.vbox`` file(s) found on the target.



   .. 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:: list_children() -> collections.abc.Iterator[dissect.target.helpers.record.ChildTargetRecord]

      Yield :class:`~dissect.target.helpers.record.ChildTargetRecord` records of all
      possible child targets on this target.