Spec-Zone.ru › Ansible 2.10

community.windows.win_domain_object_info – Сбор информации об объекте Active Directory

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

Для его установки используйте: ansible-galaxy collection install community.windows.

Для использования в книге задач укажите: community.windows.win_domain_object_info.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Сбор информации о нескольких объектах Active Directory.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
domain_password
строка
Пароль для domain_username.
domain_server
строка
Указывает экземпляр служб домена Active Directory, к которому требуется подключиться.
Может быть в формате FQDN или имени NetBIOS.
Если не указано, значение основано на домене по умолчанию компьютера, на котором выполняется PowerShell.
domain_username
строка
Имя пользователя для взаимодействия с AD.
Если не указано, пользователь, используемый для проверки подлинности, будет пользователем подключения.
Ansible не сможет использовать пользователя подключения, если аутентификация не Kerberos с делегированием учетных данных или CredSSP, или если используется become на задаче.
filter
строка
Указывает строку запроса, используя синтаксис языка выражений PowerShell.
Следует тем же правилам и формату, что и параметр -Filter, для командлетов PowerShell AD, за исключением отсутствия подстановки переменных.
Взаимоисключающий с параметрами identity и ldap_filter.
identity
строка
Указывает один объект Active Directory по его полному имени или GUID объекта.
Взаимоисключающий с параметрами filter и ldap_filter.
Не может использоваться с параметрами search_base или search_scope.
include_deleted
булево
    Варианты:
  • нет ←
  • да
Также искать удалённые объекты Active Directory.
ldap_filter
строка
Подобно параметру filter, но это традиционная LDAP-строка запроса для фильтрации возвращаемых объектов.
Взаимоисключающий с параметрами filter и identity.
properties
список / элементы=строка
Список свойств для возврата.
Если свойство *, будут возвращены все свойства, имеющие установленное значение в объекте AD.
Если свойство допустимо для объекта, но не установлено, оно возвращается только если явно определено в этом списке вариантов.
Свойства DistinguishedName, Name, ObjectClass, и ObjectGUID всегда возвращаются.
Указание нескольких свойств может повлиять на производительность, лучше возвращать только необходимые.
Если указано недопустимое свойство, модуль выведет предупреждение для каждого объекта, для которого оно недопустимо.
search_base
строка
Укажите путь Active Directory для поиска объектов.
Не может быть установлено с параметром identity.
По умолчанию базой поиска является контекст именования по умолчанию целевого экземпляра AD, который является DN, возвращаемым "(Get-ADRootDSE).defaultNamingContext".
search_scope
строка
    Варианты:
  • base
  • one_level
  • subtree
Укажите область поиска объекта в search_base.
base ограничит поиск базовым объектом, поэтому максимальное количество возвращаемых объектов всегда равно одному. Это не будет искать объекты внутри контейнера.
one_level будет искать текущий путь и любые непосредственные объекты в этом пути.
subtree будет искать текущий путь и все объекты этого пути рекурсивно.
Не может быть установлено с параметром identity.

Примечания

Примечание

  • Свойства sAMAccountType_AnsibleFlags и userAccountControl_AnsibleFlags возвращаются модулем, чтобы легко просмотреть, что представляют эти флаги. Эти свойства не могут использоваться в качестве части параметров filter или ldap_filter и автоматически добавляются, если были запрошены эти свойства.

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
objects
список / элементы=словарь
всегда
Список словарей, представляющих найденные объекты Active Directory и запрошенные свойства.
Ключи словаря — имя свойства, значение — значение свойства.
Все свойства даты возвращаются в формате ISO 8601 в часовом поясе UTC.
Все свойства SID возвращаются как словарь с ключами Sid в качестве строки SID и Name в качестве переведенного имени учетной записи SID.
Все свойства типа байт возвращаются как строка base64.
Все свойства дескрипторов безопасности возвращаются как строка SDDL этого дескриптора.
Свойства DistinguishedName, Name, ObjectClass, и ObjectGUID всегда возвращаются.

Пример:
[{ "accountExpires": 0, "adminCount": 1, "CanonicalName": "domain.com/Users/Administrator", "CN": "Administrator", "Created": "2020-01-13T09:03:22.0000000Z", "Description": "Встроенная учетная запись для администрирования компьютера/домена", "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", }]


Авторы

  • Jordan Borean (@jborean93)

© 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/windows/win_domain_object_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API