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 列表 / 元素=字符串	要管理例外用户的ESXi主机名列表。如果未设置 `cluster_name`，则为必需参数。
exception_users 列表 / 元素=字符串 / 必需	锁定模式例外用户列表。要删除所有例外用户，请使用 `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)