community.vmware.vcenter_domain_user_group_info module – Gather user or group information of a domain
Note
This module is part of the community.vmware collection (version 5.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vcenter_domain_user_group_info
.
Synopsis
This module can be used to gather information about user or group of a domain.
Parameters
Parameter |
Comments |
---|---|
If a group existing, returned contains only users or groups that directly belong to the specified group. |
|
If a user existing, returned contains only groups that directly contain the specified user. |
|
The domain to be specified searching. Default: |
|
If Choices:
|
|
If Choices:
|
|
If Choices:
|
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
The search_string is a string to be specified searching. Specify the domain user or group name to be searched. |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
list of domain user and group information Returned: success Sample: |