vmware.vmware_rest.appliance_shutdown 模块 – 取消待定的关机操作。

注意

此模块是 vmware.vmware_rest 集合 (版本 4.3.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install vmware.vmware_rest。您需要其他要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定： vmware.vmware_rest.appliance_shutdown。

vmware.vmware_rest 2.0.0 中的新增功能

概要 

取消待定的关机操作。

要求 

执行此模块的主机需要以下要求。

vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp

参数 

参数	注释
delay 整数	几分钟后开始关机。如果指定为 0，则会立即开始关机。 state=[‘poweroff’, ‘reboot’] 时必填
reason 字符串	执行关机的原因。 state=[‘poweroff’, ‘reboot’] 时必填
session_timeout 浮点数 vmware.vmware_rest 2.1.0 中新增	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
state 字符串 / 必填	选项 `"cancel"` `"poweroff"` `"reboot"`
vcenter_hostname 字符串 / 必填	vSphere vCenter 的主机名或 IP 地址如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
vcenter_password 字符串 / 必填	vSphere vCenter 密码如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
vcenter_rest_log_file 字符串	您可以使用此可选参数来设置日志文件的位置。此文件将用于记录 HTTP REST 交互。该文件将存储在运行模块的主机上。如果任务中未指定此值，则将使用环境变量 `VMWARE_REST_LOG_FILE` 的值。
vcenter_username 字符串 / 必填	vSphere vCenter 用户名如果任务中未指定此值，则将使用环境变量 `VMWARE_USER` 的值。
vcenter_validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为 `false`。如果任务中未指定此值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

注释 

注意

在 vSphere 7.0.3 上测试过

示例 

- 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

返回值 

常用返回值已在此处记录此处，以下是此模块独有的字段

键	描述
值字典	中止重启返回：成功时示例： `{}`

作者

Ansible 云团队 (@ansible-collections)