community.windows.win_domain_object_info module – Gather information an Active Directory object
This module is part of the community.windows collection (version 2.1.0).
You might already have this collection installed if you are using the
It is not included in
To check whether it is installed, run
ansible-galaxy collection list.
To install it, use:
ansible-galaxy collection install community.windows.
To use it in a playbook, specify:
- Removed in:
This module has been moved into the
Use the microsoft.ad.object_info module instead.
Gather information about multiple Active Directory object(s).
The password for
Specified the Active Directory Domain Services instance to connect to.
Can be in the form of an FQDN or NetBIOS name.
If not specified then the value is based on the default domain of the computer running PowerShell.
The username to use when interacting with AD.
If this is not set then the user that is used for authentication will be the connection user.
Ansible will be unable to use the connection user unless auth is Kerberos with credential delegation or CredSSP, or become is used on the task.
Specifies a query string using the PowerShell Expression Language syntax.
This follows the same rules and formatting as the
This is mutually exclusive with identity and ldap_filter.
Specifies a single Active Directory object by its distinguished name or its object GUID.
This is mutually exclusive with filter and ldap_filter.
This cannot be used with either the search_base or search_scope options.
Also search for deleted Active Directory objects.
Like filter but this is a tradiitional LDAP query string to filter the objects to return.
This is mutually exclusive with filter and identity.
A list of properties to return.
If a property is
If a property is valid on the object but not set, it is only returned if defined explicitly in this option list.
Specifying multiple properties can have a performance impact, it is best to only return what is needed.
If an invalid property is specified then the module will display a warning for each object it is invalid on.
Specify the Active Directory path to search for objects in.
This cannot be set with identity.
By default the search base is the default naming context of the target AD instance which is the DN returned by “(Get-ADRootDSE).defaultNamingContext”.
Specify the scope of when searching for an object in the
This cannot be set with identity.
userAccountControl_AnsibleFlagsreturn property is something set by the module itself as an easy way to view what those flags represent. These properties cannot be used as part of the filter or ldap_filter and are automatically added if those properties were requested.
This must be run on a host that has the ActiveDirectory powershell module installed.
- name: Get all properties for the specified account using its DistinguishedName
- name: Get the SID for all user accounts as a filter
filter: ObjectClass -eq 'user' -and objectCategory -eq 'Person'
- name: Get the SID for all user accounts as a LDAP filter
- name: Search all computer accounts in a specific path that were added after February 1st
filter: objectClass -eq 'computer' -and whenCreated -gt '20200201000000.0Z'
Common return values are documented here, the following are the fields unique to this module:
A list of dictionaries that are the Active Directory objects found and the properties requested.
The dict’s keys are the property name and the value is the value for the property.
All date properties are return in the ISO 8601 format in the UTC timezone.
All SID properties are returned as a dict with the keys
All byte properties are returned as a base64 string.
All security descriptor properties are returned as the SDDL string of that descriptor.
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.