community.vmware.vcenter_domain_user_group_info – Gather user or group information of a domain
community.vmware.vcenter_domain_user_group_info – Gather user or group information of a domain
Note
This plugin is part of the community.vmware collection (version 1.6.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vcenter_domain_user_group_info
.
New in version 1.6.0: of community.vmware
Synopsis
- This module can be used to gather information about user or group of a domain.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
belongs_to_group string |
If a group existing, returned contains only users or groups that directly belong to the specified group. | |
belongs_to_user string |
If a user existing, returned contains only groups that directly contain the specified user. | |
domain string |
Default: "vsphere.local" |
The domain to be specified searching. |
exact_match boolean |
|
If exact_match is |
find_groups boolean |
|
If find_groups is |
find_users boolean |
|
If find_users is |
hostname string |
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 Environment variable support added in Ansible 2.6. | |
password string |
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
port integer |
Default: 443 |
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
proxy_host string |
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | |
proxy_port integer |
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 | |
search_string string / required |
The search_string is a string to be specified searching. Specify the domain user or group name to be searched. | |
username string |
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
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 | Returned | Description |
---|---|---|
domain_user_groups list / elements=string |
success |
list of domain user and group information
Sample: [ { "fullName": "Administrator vsphere.local", "group": false, "principal": "Administrator" } ] |
Authors
- sky-joker (@sky-joker)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vcenter_domain_user_group_info_module.html