community.windows.win_domain_object_info – Gather information an Active Directory object

Note

This plugin is part of the community.windows collection (version 1.7.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.windows.

To use it in a playbook, specify: community.windows.win_domain_object_info.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Gather information about multiple Active Directory object(s).

Parameters

Parameter	Choices/Defaults	Comments
domain_password string		The password for `domain_username`.
domain_server string		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.
domain_username string		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.
filter string		Specifies a query string using the PowerShell Expression Language syntax. This follows the same rules and formatting as the `-Filter` parameter for the PowerShell AD cmdlets exception there is no variable substitutions. This is mutually exclusive with identity and ldap_filter.
identity string		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.
include_deleted boolean	Choices: no ← yes	Also search for deleted Active Directory objects.
ldap_filter string		Like filter but this is a tradiitional LDAP query string to filter the objects to return. This is mutually exclusive with filter and identity.
properties list / elements=string		A list of properties to return. If a property is `*`, all properties that have a set value on the AD object will be returned. If a property is valid on the object but not set, it is only returned if defined explicitly in this option list. The properties `DistinguishedName`, `Name`, `ObjectClass`, and `ObjectGUID` are always returned. 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.
search_base string		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".
search_scope string	Choices: base one_level subtree	Specify the scope of when searching for an object in the `search_base`. `base` will limit the search to the base object so the maximum number of objects returned is always one. This will not search any objects inside a container.. `one_level` will search the current path and any immediate objects in that path. `subtree` will search the current path and all objects of that path recursively. This cannot be set with identity.

Notes

Note

The sAMAccountType_AnsibleFlags and userAccountControl_AnsibleFlags return 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.

Examples

- name: Get all properties for the specified account using its DistinguishedName
  community.windows.win_domain_object_info:
    identity: CN=Username,CN=Users,DC=domain,DC=com
    properties: '*'

- name: Get the SID for all user accounts as a filter
  community.windows.win_domain_object_info:
    filter: ObjectClass -eq 'user' -and objectCategory -eq 'Person'
    properties:
    - objectSid

- name: Get the SID for all user accounts as a LDAP filter
  community.windows.win_domain_object_info:
    ldap_filter: (&(objectClass=user)(objectCategory=Person))
    properties:
    - objectSid

- name: Search all computer accounts in a specific path that were added after February 1st
  community.windows.win_domain_object_info:
    filter: objectClass -eq 'computer' -and whenCreated -gt '20200201000000.0Z'
    properties: '*'
    search_scope: one_level
    search_base: CN=Computers,DC=domain,DC=com

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
objects list / elements=dictionary	always	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 `Sid` as the SID string and `Name` as the translated SID account name. All byte properties are returned as a base64 string. All security descriptor properties are returned as the SDDL string of that descriptor. The properties `DistinguishedName`, `Name`, `ObjectClass`, and `ObjectGUID` are always returned. Sample: [{ "accountExpires": 0, "adminCount": 1, "CanonicalName": "domain.com/Users/Administrator", "CN": "Administrator", "Created": "2020-01-13T09:03:22.0000000Z", "Description": "Built-in account for administering computer/domain", "DisplayName": null, "DistinguishedName": "CN=Administrator,CN=Users,DC=domain,DC=com", "memberOf": [ "CN=Group Policy Creator Owners,CN=Users,DC=domain,DC=com", "CN=Domain Admins",CN=Users,DC=domain,DC=com" ], "Name": "Administrator", "nTSecurityDescriptor": "O:DAG:DAD:PAI(A;;LCRPLORC;;;AU)(A;;CCDCLCSWRPWPDTLOCRSDRCWDWO;;;SY)(A;;CCDCLCSWRPWPLOCRSDRCWDWO;;;BA)", "ObjectCategory": "CN=Person,CN=Schema,CN=Configuration,DC=domain,DC=com", "ObjectClass": "user", "ObjectGUID": "c8c6569e-4688-4f3c-8462-afc4ff60817b", "objectSid": { "Sid": "S-1-5-21-2959096244-3298113601-420842770-500", "Name": "DOMAIN\Administrator" }, "sAMAccountName": "Administrator", }]

Authors

Jordan Borean (@jborean93)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_domain_object_info_module.html