vmware.vmware_rest.vcenter_vm_power_info module – Gather information about the power state of a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_power_info.

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This functionality has been moved to vmware.vmware.vm_info.

Alternative:

Use vmware.vmware.vm_info instead.

Synopsis

  • Retrieve the current power state of a virtual machine.

  • The returned details indicate whether the virtual machine is powered on, powered off, or suspended.

  • When the virtual machine is powered off, the result also reports whether it was shut down cleanly, which can be used to detect an unexpected crash.

  • Use this module to check a virtual machine’s power state before performing operations that require it to be in a specific state.

Parameters

Parameter

Comments

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

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.

Choices:

  • false

  • true ← (default)

vm

string / required

Identifier of the virtual machine whose power state information should be gathered.

Must be an identifier (MOID) for a Vm resource.

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Gather power state information for a virtual machine
  vmware.vmware_rest.vcenter_vm_power_info:
    vm: vm-1013
  register: power_info

- name: Fail if the virtual machine is not powered on
  ansible.builtin.assert:
    that:
      - power_info.value.state == "POWERED_ON"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

info

list / elements=string

A list containing the detailed power state information for the queried virtual machine.

Returned: On success

Sample: [{"clean_power_off": true, "state": "POWERED_OFF"}]

value

dictionary

Detailed information about the power state of the virtual machine.

Returned: On success

Sample: {"clean_power_off": true, "state": "POWERED_OFF"}

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ansible Eco Content Team (@eco-ansible-content)