vmware.vmware_rest.appliance_shutdown module – Power off or reboot the vCenter Server Appliance.

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.appliance_shutdown.

New in vmware.vmware_rest 5.0.0

Synopsis

Parameters

Parameter

Comments

delay

integer

The number of minutes to wait before the poweroff or reboot begins.

When set to 0, the action starts immediately.

Required when state=poweroff or state=reboot. Ignored when state=cancel.

reason

string

A message describing why the appliance is being powered off or rebooted.

Required when state=poweroff or state=reboot. Ignored when state=cancel.

session_timeout

float

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

Default: 300.0

state

string / required

The shutdown action to perform on the appliance.

Use poweroff to power off the appliance.

Use reboot to reboot the appliance.

Use cancel to cancel a pending shutdown or reboot.

None of these actions are idempotent.

Choices:

  • "cancel"

  • "poweroff"

  • "reboot"

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)

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: Reboot the appliance immediately
  vmware.vmware_rest.appliance_shutdown:
    state: reboot
    delay: 0
    reason: Applying configuration changes

- name: Schedule a poweroff in 10 minutes
  vmware.vmware_rest.appliance_shutdown:
    state: poweroff
    delay: 10
    reason: Planned maintenance window

- name: Cancel a pending shutdown or reboot
  vmware.vmware_rest.appliance_shutdown:
    state: cancel

Return Values

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

Key

Description

value

any

The raw API response body from the vCenter operation. Empty when the operation returns no content.

Returned: On success

Sample: {}

Authors

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