ansible/docs/docsite/rst/scenario_guides/guide_vmware.rst
scottb 373b1dcf59
Core Docs Refactor and Redesign (#36067)
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
2018-02-13 07:23:55 -08:00

2.1 KiB

Getting Started with VMware

Introduction

Ansible provides various modules to manage VMware infrastructure, which includes datacenter, cluster, host system and virtual machine.

Requirements

Ansible VMware modules are written on top of pyVmomi. pyVmomi is the Python SDK for the VMware vSphere API that allows user to manage ESX, ESXi, and vCenter infrastcture. You can install pyVmomi using pip:

$ pip install pyvmomi

vmware_guest module

The :ref:vmware_guest <vmware_guest>module is used to manage various operations related to virtual machines in the given ESXi or vCenter server.

Prior to Ansible version 2.5, folder was an optional parameter with a default value of /vm. The folder parameter

was used to discover information about virtual machines in the given infrastructure.

Starting with Ansible version 2.5, folder is still an optional parameter with no default value. This parameter will be now used to identify a user's virtual machine, if multiple virtual machines or virtual machine templates are found with same name. VMware does not restrict the system administrator from creating virtual machines with same name.

Debugging

When debugging or creating a new issue, you will need information about your VMware infrastructure. You can get this information using govc, For example:

$ export GOVC_USERNAME=ESXI_OR_VCENTER_USERNAME
$ export GOVC_PASSWORD=ESXI_OR_VCENTER_PASSWORD
$ export GOVC_URL=https://ESXI_OR_VCENTER_HOSTNAME:443
$ govc find /
pyVmomi

The GitHub Page of pyVmomi

pyVmomi Issue Tracker

The issue tracker for the pyVmomi project

govc

govc is a vSphere CLI built on top of govmomi

playbooks

An introduction to playbooks