community.vmware.vmware_host_powermgmt_policy 模块 – 管理 ESXI 主机系统的电源管理策略

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.vmware

要在 Playbook 中使用它,请指定:community.vmware.vmware_host_powermgmt_policy

概要

  • 此模块可用于管理给定 vCenter 基础架构中 ESXi 主机系统的电源管理策略。

参数

参数

注释

cluster_name

字符串

将从中选择所有主机系统的集群的名称。

如果未指定 esxi_hostname,则此参数为必填参数。

esxi_hostname

字符串

要使用的主机系统的名称。

如果未指定 cluster_name,则此参数为必填参数。

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

如果任务中未指定该值,则将改为使用环境变量 VMWARE_HOST 的值。

password

别名:pass, pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

如果任务中未指定该值,则将改为使用环境变量 VMWARE_PASSWORD 的值。

policy

字符串

设置主机系统的电源管理策略。

选项

  • "high-performance"

  • "balanced" ← (默认)

  • "low-power"

  • "custom"

port

整数

vSphere vCenter 或 ESXi 服务器的端口号。

如果任务中未指定该值,则将改为使用环境变量 VMWARE_PORT 的值。

默认: 443

proxy_host

字符串

将接收所有 HTTPS 请求并转发它们的代理地址。

格式为主机名或 IP。

如果任务中未指定该值,则将改为使用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

整数

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果任务中未指定该值,则将改为使用环境变量 VMWARE_PROXY_PORT 的值。

username

别名:admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果任务中未指定该值,则将改为使用环境变量 VMWARE_USER 的值。

validate_certs

布尔值

当 SSL 证书无效时允许连接。当证书不受信任时,设置为 false

如果任务中未指定该值,则将改为使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

说明

注意

  • 所有模块都需要 API 写入权限,因此不受免费 ESXi 许可证支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Set the Power Management Policy of a host system to high-performance
  community.vmware.vmware_host_powermgmt_policy:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_host }}'
    policy: high-performance
  delegate_to: localhost

- name: Set the Power Management Policy of all host systems from cluster to high-performance
  community.vmware.vmware_host_powermgmt_policy:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    policy: high-performance
  delegate_to: localhost

返回值

常见的返回值已在此处记录,以下是此模块特有的字段

描述

result

字典

关于主机系统电源管理策略的元数据

返回: 总是

示例: {"changed": true, "result": {"esxi01": {"changed": true, "current_state": "high-performance", "desired_state": "high-performance", "msg": "电源策略已更改", "previous_state": "balanced"}}}

作者

  • Christian Kotte (@ckotte)