1.. _vmware_ansible_intro:
2
3**********************************
4Introduction to Ansible for VMware
5**********************************
6
7.. contents:: Topics
8
9Introduction
10============
11
12Ansible provides various modules to manage VMware infrastructure, which includes datacenter, cluster,
13host system and virtual machine.
14
15Requirements
16============
17
18Ansible VMware modules are written on top of `pyVmomi <https://github.com/vmware/pyvmomi>`_.
19pyVmomi is the Python SDK for the VMware vSphere API that allows user to manage ESX, ESXi,
20and vCenter infrastructure. You can install pyVmomi using pip:
21
22.. code-block:: bash
23
24    $ pip install pyvmomi
25
26Ansible VMware modules leveraging latest vSphere(6.0+) features are using `vSphere Automation Python SDK <https://github.com/vmware/vsphere-automation-sdk-python>`_. The vSphere Automation Python SDK also has client libraries, documentation, and sample code for VMware Cloud on AWS Console APIs, NSX VMware Cloud on AWS integration APIs, VMware Cloud on AWS site recovery APIs, NSX-T APIs.
27
28You can install vSphere Automation Python SDK using pip:
29
30.. code-block:: bash
31
32     $ pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git
33
34Note:
35   Installing vSphere Automation Python SDK also installs ``pyvmomi``. A separate installation of ``pyvmomi`` is not required.
36
37vmware_guest module
38===================
39
40The :ref:`vmware_guest<vmware_guest_module>` module manages various operations related to virtual machines in the given ESXi or vCenter server.
41
42
43.. seealso::
44
45    `pyVmomi <https://github.com/vmware/pyvmomi>`_
46        The GitHub Page of pyVmomi
47    `pyVmomi Issue Tracker <https://github.com/vmware/pyvmomi/issues>`_
48        The issue tracker for the pyVmomi project
49    `govc <https://github.com/vmware/govmomi/tree/master/govc>`_
50        govc is a vSphere CLI built on top of govmomi
51    :ref:`working_with_playbooks`
52        An introduction to playbooks
53
54