community.vmware.vmware_host_lockdown_exceptions 模块 – 管理锁定模式例外用户

注意

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

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

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

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

community.vmware 3.1.0 中的新增功能

概要 

此模块可用于管理锁定模式例外用户。
请仅指定 hostname 作为 vCenter IP 或主机名，因为无法从独立的 ESXi 服务器执行锁定操作。

参数 

参数	注释
cluster_name 字符串	集群名称。给定集群中的所有主机系统都用于管理例外用户。如果未设置 `esxi_hostname`，则为必填参数。
esxi_hostname 列表 / elements=string	要管理例外用户的 ESXi 主机名列表。如果未设置 `cluster_name`，则为必填参数。
exception_users 列表 / elements=string / 必填	锁定模式例外用户列表。要删除所有例外用户，请 `state=set` 空列表。
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`，请确保给定的用户不是锁定模式例外用户。如果 `set`，将替换已定义的锁定模式例外用户列表。选择 `"present"` ← (默认) `"absent"` `"set"`
用户名别名: admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定该值，则将使用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	允许在 SSL 证书无效时进行连接。当证书不受信任时，设置为 `false`。如果任务中未指定该值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选择 `false` `true` ← (默认)

备注 

注意

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

示例 

- name: Remove all Lockdown Mode Exception Users on a host
  community.vmware.vmware_host_lockdown:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    exception_users: []
    state: set
  delegate_to: localhost

返回值 

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

键	描述
results 字典	关于主机系统例外用户的元数据返回: 总是示例: `{"host_lockdown_exceptions": {"DC0_C0": {"current_exception_users": [], "desired_exception_users": [], "previous_exception_users": ["root"]}}}`

作者

Mario Lenz (@mariolenz)