Metadata-Version: 2.1
Name: vix
Version: 1.0.8
Summary: VMware VIX binding for Python (unofficial)
Home-page: https://github.com/naim94a/vix
Author: Naim A.
Author-email: naim94a@gmail.com
License: GPLv3
Project-URL: Documentation, https://naim94a.github.io/vix
Project-URL: Source, https://github.com/naim94a/vix
Project-URL: Bugs & Features, https://github.com/naim94a/vix/issues
Keywords: vmware python api vix
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Systems Administration
License-File: LICENSE.txt

VIX
===

.. image:: https://img.shields.io/pypi/dm/vix.svg?style=plastic   :alt: PyPI - Downloads
   :target: https://pypi.org/project/vix/

VIX is a object oriented python wrapper for `VMware's VIX API`_.

Installing
----------

Install and update using `pip`_:

.. code-block:: text

    pip install -U vix

Quick Example
-------------

.. code-block:: python

    from vix import VixHost, VixError
    
    host = VixHost()

    try:
        vm = host.open_vm(r'/home/root/VirtualMachines/Debian/Debian.vmx')
        snapshot = vm.create_snapshot(
            'Testing VIX',
            'Well, this is great!',
            include_memory=True
        )
        print('Snapshot created!')
    except VixError as ex:
        print("Something went wrong :( {0}".format(ex))

Features
--------

The full VIX API was wrapped, some of the supported operations include:

- Power on & power off VMs.
- Manage snapshots (with or without memory)
- Cloning (linked or full)
- Script & Command execution on guests

  - Executing scripts and processes
  - Manage directories, files & processes

- Control VMs environment
- Manage shared folders
- Create screenshot of guest VMs

.. _VMware's VIX API: https://www.vmware.com/support/developer/vix-api/
.. _pip: https://pip.pypa.io/en/stable/quickstart


