You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

How to run a virtual machine

Introduction 

This section covers the power management of your virtual machine.

Power information 

Use vcenter_vm_power_info to know the power state of the VM.

- name: Get guest power information
  vmware.vmware_rest.vcenter_vm_power_info:
    vm: '{{ test_vm1_info.id }}'
  register: _result

Result 

{
    "value": {
        "state": "POWERED_ON"
    },
    "changed": false
}

How to start a virtual machine 

Use the vcenter_vm_power module to start your VM:

- name: Turn the power of the VM on
  vmware.vmware_rest.vcenter_vm_power:
    state: start
    vm: '{{ test_vm1_info.id }}'

Result 

{
    "changed": false
}

How to wait until my virtual machine is ready 

If your virtual machine runs VMware Tools, you can build a loop around the center_vm_tools_info module:

- name: Wait until my VM is ready
  vmware.vmware_rest.vcenter_vm_tools_info:
    vm: '{{ test_vm1_info.id }}'
  register: vm_tools_info
  until:
  - vm_tools_info is not failed
  - vm_tools_info.value.run_state == "RUNNING"
  retries: 60
  delay: 5

Result 

{
    "value": {
        "auto_update_supported": false,
        "upgrade_policy": "MANUAL",
        "install_attempt_count": 0,
        "version_status": "UNMANAGED",
        "version_number": 10346,
        "run_state": "RUNNING",
        "version": "10346",
        "install_type": "OPEN_VM_TOOLS"
    },
    "changed": false
}