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
(added in 2.5)
|
|
Ignore warnings and complete the actions.
This parameter is useful while forcing virtual machine state.
|
hostname |
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 supported 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 |
|
If multiple virtual machines matching the name, use the first or last found.
|
password |
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 supported added in version 2.6.
aliases: pass, pwd |
|
port
(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 supported 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 |
|
Set the state of the virtual machine.
|
username |
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 supported added in version 2.6.
aliases: user, admin |
|
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 |
True
|
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 supported added in version 2.6.
|
Examples
- name: Set the state of a virtual machine to poweroff vmware_guest_powerstate: hostname: 192.0.2.44 username: [email protected] password: vmware validate_certs: no folder: /testvms name: testvm_2 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: 192.0.2.44 username: [email protected] password: vmware validate_certs: no folder: /datacenter-1/vm/my_folder name: testvm_2 state: powered-off scheduled_at: "09/01/2018 10:18" delegate_to: localhost register: deploy_at_schedule_datetime
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Abhijeet Kasurde (@akasurde) <akasurde@redhat.com>
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/vmware_guest_powerstate_module.html