appliance_shutdown
Schedule or cancel appliance shutdown actions
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.appliance_shutdown
Synopsis
Schedule or cancel appliance shutdown actions
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. | ||||
| delay | int | Minutes after which poweroff should start. If 0 is specified, poweroff will start immediately. Required with I(state=[‘poweroff’, ‘reboot’]) | ||
| reason | string | Reason for peforming poweroff. Required with I(state=[‘poweroff’, ‘reboot’]) | ||
| state | string | yes | Operation to perform; allowed values: cancel, poweroff, reboot. |
Example
yaml
- name: Shutdown the appliance
vmware.vmware_rest.appliance_shutdown:
state: poweroff
reason: this is an example
delay: 600
register: result
- name: Abort the shutdown of the appliance
vmware.vmware_rest.appliance_shutdown:
state: cancel
register: result
- name: Reboot the appliance
vmware.vmware_rest.appliance_shutdown:
state: reboot
reason: this is an example
delay: 600
register: result
- name: Abort the reboot
vmware.vmware_rest.appliance_shutdown:
state: cancel
register: result