community.vmware.vcenter_domain_user_group_info 模块 – 收集域的用户或组信息

注意

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

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

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

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

概要 

此模块可用于收集有关域用户或组的信息。

参数 

参数	注释
belongs_to_group 字符串	如果存在组，则返回的结果仅包含直接属于指定组的用户或组。
belongs_to_user 字符串	如果存在用户，则返回的结果仅包含直接包含指定用户的组。
domain 字符串	要指定的搜索域。默认值： `"vsphere.local"`
exact_match 布尔值	如果为 `true`，则表示传递的 `search_string` 应与用户或组名称完全匹配。选项 `false` ← (默认) `true`
find_groups 布尔值	如果为 `true`，则域组将包含在结果中。选项 `false` `true` ← (默认)
find_users 布尔值	如果为 `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` 的值。
search_string 字符串 / 必需	search_string 是要指定的搜索字符串。指定要搜索的域用户或组名称。
username 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定值，则将使用环境变量`VMWARE_USER`的值。
validate_certs 布尔值	允许在SSL证书无效时连接。当证书不受信任时，将其设置为`false`。如果任务中未指定值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认)

备注 

注意

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

示例 

- name: Gather all domain user and group of vsphere.local
  community.vmware.vcenter_domain_user_group_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    domain: vsphere.local
    search_string: ''
  register: gather_all_domain_user_group_result

- name: Gather all domain user and group included the administrator string
  community.vmware.vcenter_domain_user_group_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    domain: vsphere.local
    search_string: administrator
  register: gather_domain_user_group_result

- name: Gather all domain user of vsphere.local
  community.vmware.vcenter_domain_user_group_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    domain: vsphere.local
    search_string: ''
    find_users: true
    find_groups: false
  register: gather_all_domain_user_result

- name: Gather administrator user by exact match condition
  community.vmware.vcenter_domain_user_group_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    domain: vsphere.local
    search_string: "vsphere.local\\administrator"
    exact_match: true
  register: gather_administrator_user_exact_match_result

返回值 

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

键	描述
domain_user_groups 列表 / 元素=字符串	域用户和组信息列表返回：成功示例：`["[\n {\n \"fullName\": \"Administrator vsphere.local\"", "\n \"group\": false", "\n \"principal\": \"Administrator\"\n }\n]"]`

作者

sky-joker (@sky-joker)