community.vmware.vmware_host_lockdown 模块 – 管理 ESXi 主机的本地管理帐户的管理员权限

注意

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

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

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

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

概要 

当给定 ESXi 主机名时，可以使用此模块来管理主机的本地管理帐户的管理员权限。
此模块具有破坏性，因为管理员权限是使用 API 进行管理的，请仔细阅读选项并继续操作。
请仅将 hostname 指定为 vCenter IP 或主机名，因为无法从独立的 ESXi 服务器执行锁定操作。

参数 

参数	注释
cluster_name 字符串	集群的名称。使用给定集群中的所有主机系统来管理锁定。如果未设置 `esxi_hostname`，则为必需参数。
esxi_hostname 列表 / 元素=字符串	要管理锁定的 ESXi 主机名列表。如果未设置 `cluster_name`，则为必需参数。有关规范，请参见示例。
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 字符串	主机系统的状态如果设置为 `disabled`，则所有主机系统都将从锁定模式中删除。如果主机系统已退出锁定模式并设置为 `disabled`，则不会采取任何操作。如果设置为 `normal`，则所有主机系统都将设置为锁定模式。如果主机系统已处于锁定模式并设置为 `normal`，则不会采取任何操作。如果设置为 `strict`，则所有主机系统都将设置为严格锁定模式。如果主机系统已处于严格锁定模式并设置为 `strict`，则不会采取任何操作。选择 `"disabled"` `"normal"` ←（默认） `"strict"`
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定该值，则将改为使用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果任务中未指定该值，则将改为使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选择 `false` `true` ←（默认）

说明 

注意

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

示例 

- name: Enter host system into lockdown mode
  community.vmware.vmware_host_lockdown:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: normal
  delegate_to: localhost

- name: Exit host systems from lockdown mode
  community.vmware.vmware_host_lockdown:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: disabled
  delegate_to: localhost

- name: Enter host systems into lockdown mode
  community.vmware.vmware_host_lockdown:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname:
        - '{{ esxi_hostname_1 }}'
        - '{{ esxi_hostname_2 }}'
    state: normal
  delegate_to: localhost

- name: Exit host systems from lockdown mode
  community.vmware.vmware_host_lockdown:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname:
        - '{{ esxi_hostname_1 }}'
        - '{{ esxi_hostname_2 }}'
    state: disabled
  delegate_to: localhost

- name: Enter all host system from cluster into lockdown mode
  community.vmware.vmware_host_lockdown:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    state: normal
  delegate_to: localhost

返回值 

通用的返回值已在这里文档中说明，以下是此模块特有的字段

键	描述
results 字典	关于主机系统锁定状态的元数据返回: 总是示例: `{"host_lockdown_state": {"DC0_C0": {"current_state": "normal", "desired_state": "normal", "previous_state": "disabled"}}}`

作者

Abhijeet Kasurde (@Akasurde)