Documentation

vmware_guest_powerstate – Manages power states of virtual machines in vCenter

New in version 2.5.

Synopsis

  • Power on / Power off / Restart a virtual machine.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
folder
-
Default:
/vm
Destination folder, absolute or relative path to find an existing guest or create the new guest.
The folder should include the datacenter. ESX's datacenter is ha-datacenter
Examples:
folder: /ha-datacenter/vm
folder: ha-datacenter/vm
folder: /datacenter1/vm
folder: datacenter1/vm
folder: /datacenter1/vm/folder1
folder: datacenter1/vm/folder1
folder: /folder1/datacenter1/vm
folder: folder1/datacenter1/vm
folder: /folder1/datacenter1/vm/folder2
folder: vm/folder2
folder: folder2
force
boolean
added in 2.5
    Choices:
  • no ←
  • yes
Ignore warnings and complete the actions.
This parameter is useful while forcing virtual machine state.
hostname
string
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
Environment variable support added in version 2.6.
name
-
Name of the virtual machine to work with.
Virtual machine names in vCenter are not necessarily unique, which may be problematic, see name_match.
name_match
-
    Choices:
  • first ←
  • last
If multiple virtual machines matching the name, use the first or last found.
password
string
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable support added in version 2.6.

aliases: pass, pwd
port
integer
added in 2.5
Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable support added in version 2.6.
scheduled_at
-
Date and time in string format at which specificed task needs to be performed.
The required format for date and time - 'dd/mm/yyyy hh:mm'.
Scheduling task requires vCenter server. A standalone ESXi server does not support this option.
state
-
    Choices:
  • powered-off
  • powered-on
  • reboot-guest
  • restarted
  • shutdown-guest
  • suspended
  • present ←
Set the state of the virtual machine.
state_change_timeout
-
added in 2.6
Default:
0
If the state is set to shutdown-guest, by default the module will return immediately after sending the shutdown signal.
If this argument is set to a positive integer, the module will instead wait for the VM to reach the poweredoff state.
The value sets a timeout in seconds for the module to wait for the state change.
username
string
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable support added in version 2.6.

aliases: admin, user
uuid
-
UUID of the instance to manage if known, this is VMware's unique identifier.
This is required if name is not supplied.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
Environment variable support added in version 2.6.
If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.

Examples

- name: Set the state of a virtual machine to poweroff
  vmware_guest_powerstate:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    folder: /"{{ datacenter_name }}"/vm/my_folder
    name: "{{ guest_name }}"
    state: powered-off
  delegate_to: localhost
  register: deploy

- name: Set the state of a virtual machine to poweroff at given scheduled time
  vmware_guest_powerstate:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    folder: /"{{ datacenter_name }}"/vm/my_folder
    name: "{{ guest_name }}"
    state: powered-off
    scheduled_at: "09/01/2018 10:18"
  delegate_to: localhost
  register: deploy_at_schedule_datetime

- name: Wait for the virtual machine to shutdown
  vmware_guest_powerstate:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: "{{ guest_name }}"
    state: shutdown-guest
    state_change_timeout: 200
  delegate_to: localhost
  register: deploy

Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.