vcenter_vm_guest_power

Issues a request to the guest operating system asking it to perform a soft shutdown, standby (suspend) or soft reboot

Collection: vmware.vmware_rest

Full Name: vmware.vmware_rest.vcenter_vm_guest_power

Synopsis

Issues a request to the guest operating system asking it to perform a soft shutdown, standby (suspend) or soft reboot

Parameters

Name	Type	Required	Default	Description
vcenter_hostname	string	yes		The hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
vcenter_username	string	yes		The vSphere vCenter username
If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
vcenter_password	string	yes		The vSphere vCenter password
If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
vcenter_validate_certs	bool		`true`	Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead.
vcenter_rest_log_file	string			You can use this optional parameter to set the location of a log file.
This file will be used to record the HTTP REST interaction.
The file will be stored on the host that runs the module.
If the value is not specified in the task, the value of
environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
session_timeout	float			Timeout settings for client session.
The maximal number of seconds for the whole operation including connection establishment, request sending and response.
The default value is 300s.
state	string	yes		Operation to perform; allowed values: reboot, shutdown, standby.
vm	string	yes		Identifier of the virtual machine.
The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). This parameter is mandatory.

Example

yaml

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
    disks:
    - type: SATA
      backing:
        type: VMDK_FILE
        vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk'
    - type: SATA
      new_vmdk:
        name: second_disk
        capacity: 32000000000
    cdroms:
    - type: SATA
      sata:
        bus: 0
        unit: 2
    nics:
    - backing:
        type: STANDARD_PORTGROUP
        network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: my_vm

- name: Shut down the VM
  vmware.vmware_rest.vcenter_vm_guest_power:
    state: shutdown
    vm: '{{ my_vm.id }}'