community.vmware.vmware_maintenancemode 模块 – 将主机置于维护模式

注意

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

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

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

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

概要

  • 此模块可用于将 ESXi 主机置于维护模式。

  • 支持选择 VSAN 兼容的维护模式。

参数

参数

注释

esxi_hostname

字符串 / 必需

在 vCenter 中定义的主机名称。

evacuate

布尔值

如果设置为 true，则清空所有已关闭的虚拟机。

选项

  • 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

字符串

进入或退出维护模式。

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

指定操作的超时时间。

默认值： 0

username

别名：admin，user

字符串

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

如果任务中未指定此值，则将使用环境变量 VMWARE_USER 的值。

validate_certs

布尔值

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

如果任务中未指定此值，则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

vsan

别名：vsan_mode

字符串

指定要进入的哪个 VSAN 兼容模式。

选项

  • "ensureObjectAccessibility"

  • "evacuateAllData"

  • "noAction"

注释

注意

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

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

示例

- name: Enter VSAN-Compliant Maintenance Mode
  community.vmware.vmware_maintenancemode:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    vsan: ensureObjectAccessibility
    evacuate: true
    timeout: 3600
    state: present
  delegate_to: localhost

返回值

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

键

描述

hostname

字符串

vCenter 中的主机名称

返回：始终

示例： "esxi.local.domain"

hostsystem

字符串

vim 引用名称

返回：始终

示例： "'vim.HostSystem:host-236'"

状态

字符串

采取的操作

返回：始终

示例： "ENTER"

作者

  • Jay Jahns (@jjahns)

  • Abhijeet Kasurde (@Akasurde)