:py:mod:`dissect.hypervisor.descriptor.vbox`
============================================

.. py:module:: dissect.hypervisor.descriptor.vbox




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.hypervisor.descriptor.vbox.VBox
   dissect.hypervisor.descriptor.vbox.Machine
   dissect.hypervisor.descriptor.vbox.HardDisk
   dissect.hypervisor.descriptor.vbox.Snapshot
   dissect.hypervisor.descriptor.vbox.Hardware




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.hypervisor.descriptor.vbox.NS


.. py:data:: NS
   :value: '{http://www.virtualbox.org/}'


.. py:class:: VBox(fh: TextIO)

   VirtualBox XML descriptor parser.

   :param fh: A file-like object of the VirtualBox XML descriptor.


   .. py:attribute:: machine


   .. py:method:: __repr__() -> str


   .. py:property:: uuid
      :type: uuid.UUID | None


      The VM UUID.


   .. py:property:: name
      :type: str | None


      The VM name.


   .. py:property:: media
      :type: dict[uuid.UUID, HardDisk]


      The media (disks) registry.


   .. py:property:: hardware
      :type: Hardware


      The current machine hardware state.


   .. py:property:: snapshots
      :type: dict[uuid.UUID, Snapshot]


      All snapshots.


.. py:class:: Machine(vbox: VBox, element: xml.etree.ElementTree.Element)

   .. py:attribute:: vbox


   .. py:attribute:: element


   .. py:method:: __repr__() -> str


   .. py:property:: uuid
      :type: uuid.UUID


      The machine UUID.


   .. py:property:: name
      :type: str


      The machine name.


   .. py:property:: current_snapshot
      :type: uuid.UUID | None


      The current snapshot UUID.


   .. py:property:: media
      :type: dict[uuid.UUID, HardDisk]


      The media (disks) registry.


   .. py:property:: hardware
      :type: Hardware


      The machine hardware state.


   .. py:property:: snapshots
      :type: dict[uuid.UUID, Snapshot]


      All snapshots.


   .. py:property:: parent
      :type: Snapshot | None



.. py:class:: HardDisk(vbox: VBox, element: xml.etree.ElementTree.Element, parent: HardDisk | None = None)

   .. py:attribute:: vbox


   .. py:attribute:: element


   .. py:attribute:: parent
      :value: None



   .. py:method:: __repr__() -> str


   .. py:property:: uuid
      :type: uuid.UUID


      The disk UUID.


   .. py:property:: location
      :type: str


      The disk location.


   .. py:property:: type
      :type: str | None


      The disk type.


   .. py:property:: format
      :type: str


      The disk format.


   .. py:property:: properties
      :type: dict[str, str]


      The disk properties.


   .. py:property:: is_encrypted
      :type: bool


      Whether the disk is encrypted.


.. py:class:: Snapshot(vbox: VBox, element: xml.etree.ElementTree.Element, parent: Snapshot | Machine | None = None)

   .. py:attribute:: vbox


   .. py:attribute:: element


   .. py:attribute:: parent
      :value: None



   .. py:method:: __repr__() -> str


   .. py:property:: uuid
      :type: uuid.UUID


      The snapshot UUID.


   .. py:property:: name
      :type: str


      The snapshot name.


   .. py:property:: ts
      :type: datetime.datetime


      The snapshot timestamp.


   .. py:property:: hardware
      :type: Hardware


      The snapshot hardware state.


.. py:class:: Hardware(vbox: VBox, element: xml.etree.ElementTree.Element)

   .. py:attribute:: vbox


   .. py:attribute:: element


   .. py:method:: __repr__() -> str


   .. py:property:: disks
      :type: list[HardDisk]


      All attached hard disks.