You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The below requirements are needed on the host that executes this module.
vSphere 7.0.3 or greater
python >= 3.6
aiohttp
Parameters
Parameter
Choices/Defaults
Comments
delay
integer
Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately. Required with state=['poweroff', 'reboot']
reason
string
Reason for peforming poweroff. Required with state=['poweroff', 'reboot']
session_timeout
float
added in 2.1.0
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
/ required
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_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 run the module.
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
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.
Notes
Note
- Tested on vSphere 7.0.3
Examples
- name: Shutdown the appliancevmware.vmware_rest.appliance_shutdown:
state: poweroffreason: this is an exampledelay: 600register: result
- name: Abort the shutdown of the appliancevmware.vmware_rest.appliance_shutdown:
state: cancelregister: result
- name: Reboot the appliancevmware.vmware_rest.appliance_shutdown:
state: rebootreason: this is an exampledelay: 600register: result
- name: Abort the rebootvmware.vmware_rest.appliance_shutdown:
state: cancelregister: result
Return Values
Common return values are documented here, the following are the fields unique to this module: