Ansible toolkit for VMWare

This role provides multiple actions for use with VMWare clusters, it currently features:

• powerstate : Managing VM powerstates
• provision_guest : Creating/editing VMs and templates (some restrictions may apply!)
• snap : Managing VM snapshots

This role can delegate all required actions to a different machine which can even be different for each targeted VM. Within this role this host is referred to as the 'API host'

For tasks that need to locate VMs within your environment an extra variable is made available with all information of the targeted VMs. This can allow for using VMWare attributes in for example snapshot names. You can find this information in the 'vm_info' variable.

Usage

This module requires the use of PyVmomi and the VMWare SDK, this role will detect and attempt to install all the required dependencies itself.

For detailed instructions on how to install these dependencies manually, please check the example setup.

Note on using it with RHEL 8

This role will work perfectly on both RHEL8, however, due to the required Python version for the vSphere SDK, you need to change the ansible_python_interpreter depending on the vSphere major version. Please see the example playbooks for a means to detect it.

• vSphere 7 SDK requires Python 3.3+
• vSphere 8 SDK requires Python 3.8+, which requires a custom ansible_python_interpreter on RHEL8

This role has been prepared with support for vSphere 7, but this has not been tested.

Multiple vSphere clusters? No problem!

The playbook is configured to use the vSphere credentials and information in the hostvars of the targeted VM. So, configuring for multiple VMware clusters is as easy as defining these credentials for that specific host/group, just like any other variable.

When Ansible runs the playbook, it will lookup all of the required information for that specific targeted VM. The variables that will be lookup per host (and need to be defined in 'group_vars' are:

• vsphere_api_host
• vsphere_datacenter
• vsphere_host
• vsphere_password
• vsphere_username

Powerstate

Supported states are:

• Poweron a VM using either VMWare tools or the virtual power button
• Poweroff a VM using either VMWare tools or the virtual power button
• Reboot/reset a VM using either VMWare tools or the virtual power button

The role will NOT prompt for the required information, it can only be provided using the playbook used to call it:

 - hosts: all
   gather_facts: no
   tasks:
   - import_role:
       name: vmware
     vars:
       target_action: "powerstate"
       target_state: "powered-on"
     run_once: yes

Required variables:

• target_action: one of the playbooks that came with this role
• target_action: one of the states in the supported_states list

Snap

Supported actions are:

• Create snapshots (automatically with a datestamp, or with a provided name)
• Delete given or all snapshots
• Revert to a given snapshot, this script will NOT give you a list to pick from.

The role will NOT prompt for the required information, it can only be provided using the playbook used to call it:

 - hosts: all
   gather_facts: no
   tasks:
   - import_role:
       name: vmware
     vars:
       target_action: "snap"
       target_state: "present"
       target_snapshot_name: ansible_snap_stuff
     run_once: yes

Required variables:

• target_action: one of the playbooks that came with this role
• target_state: one of the actions in the supported_states list

Optional variables:

• target_snapshot_name:
  • When creating snapshots: override the name of the snapshot
  • When reverting/deleting snapshots: the target snapshot to delete

Provision guest

Supported actions are:

• Creating a new VM based of a template or other VM
• Deleting a VM
• Creating a new template based of a VM

The role will NOT prompt for any information required, it can only provided using the playbook used to call it. A default hardware profile is available in the defaults directory.

To create a new VM, follow these steps:

• Create a vars file with the following information (for details, check the documentation for the vmware_guest module and below):
  • Datastore
  • VM folder
  • Template (make sure it exists)
  • Disk setup and disk controller type
  • Network setup
  • RAM and CPU setup
  • VM hardware version and BIOS type
• Add a new entry into the inventory
• Run the playbook, for example:

---
- hosts: new-host.example.com
  gather_facts: no
  tasks:
    - import_role:
        name: vmware
      vars:
        target_action: provision_guest
        target_state: present
        target_esxi_hostname: esxi.example.com
      run_once: yes

Required variables (most of these have a default value):

• target_action: one of the playbooks that came with this role
• target_state: one of the actions in the supported_states list.
• target_esxi_hostname / target_esxi_cluster : The name of the host/cluster where the VM should run on.
• target_folder : The folder in which the VM should be placed
• target_networks : A dictionary with the network setup. Please consult the vmware_guest documentation.
• target_disks : A dictionary with the disk layout. Please consult the vmware_guest documentation.
• target_ram : A dictionary with the memory setup. Please consult the defaults file for an example.
• target_cpu : A dictionary with the CPU setup. Please consult the defaults file for an example.
• target_template: The template to base the VM on, this can be a other VM or a Template.

Optional variables:

• target_force : Ignore any warnings or errors.
• target_scsi : The type of disk controller to use.
• target_boot_firmware: The BIOS type of the VM.
• target_vm_version : The VMWare HW version to use.
• target_customization : Any VMWare customization to run on the VM after it's creation. Please consult the vmware_guest documentation for more information.