community.vmware.vmware_host_powerstate 模块 – 管理 vCenter 中主机系统的电源状态

注意

此模块是 community.vmware 集合（版本 5.2.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_host_powerstate。

概要 

此模块可用于管理给定 vCenter 基础架构中主机系统的电源状态。
用户可以将电源状态设置为“power-down-to-standby”、“power-up-from-standby”、“shutdown-host”和“reboot-host”。
并非所有主机系统都支持“reboot-host”、“shutdown-host”和“power-down-to-standby”状态。

参数 

参数	注释
cluster_name 字符串	从中将使用所有主机系统的集群的名称。如果未指定 `esxi_hostname`，则此为必需参数。
esxi_hostname 字符串	要使用的主机系统的名称。如果未指定 `cluster_name`，则此为必需参数。
force 布尔值	此参数指定主机是否应继续执行用户定义的电源状态，而不管它是否处于维护模式。如果 `state=reboot-host` 并且 `force=true`，则无论主机系统是否处于维护模式，都会重新启动主机系统。如果 `state=shutdown-host` 并且 `force=true`，则无论主机系统是否处于维护模式，都会关闭主机系统。如果 `state=power-down-to-standby` 并且 `force=true`，则所有关闭的虚拟机都将被疏散。如果 `state=power-up-from-standby` 则不适用。选项 `false` ← (默认) `true`
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定该值，则将改用环境变量 `VMWARE_HOST` 的值。
password 别名: pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定该值，则将改用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定该值，则将改用环境变量 `VMWARE_PORT` 的值。默认: `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果任务中未指定该值，则将改用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定该值，则将改用环境变量 `VMWARE_PROXY_PORT` 的值。
state 字符串	设置主机系统的状态。选项 `"power-down-to-standby"` `"power-up-from-standby"` `"shutdown-host"` ← (默认) `"reboot-host"`
timeout 整数	此参数定义 `state=power-down-to-standby` 或 `state=power-up-from-standby` 的超时。如果 `state=reboot-host` 或 `state=shutdown-host` 则忽略。此参数以秒为单位定义。默认值： `600`
username 别名: admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定该值，则将使用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	允许在 SSL 证书无效时进行连接。当证书不受信任时，设置为 `false`。如果任务中未指定该值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

备注 

注意

所有模块都需要 API 写入权限，因此不支持免费的 ESXi 许可证。
所有变量和 VMware 对象名称都区分大小写。

示例 

- name: Set the state of a host system to reboot
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: reboot-host
  delegate_to: localhost
  register: reboot_host

- name: Set the state of a host system to power down to standby
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: power-down-to-standby
  delegate_to: localhost
  register: power_down

- name: Set the state of all host systems from cluster to reboot
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    state: reboot-host
  delegate_to: localhost
  register: reboot_host

返回值 

常见的返回值记录在这里，以下是此模块独有的字段

键	描述
结果字典	关于主机系统状态的元数据返回值：总是示例： `{"esxi01": {"error": "", "msg": "power down 'esxi01' to standby"}}`

作者

Abhijeet Kasurde (@Akasurde)