Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции community.windows (версия 2.3.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

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

  • УСТАРЕВШИЙ
  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕВШИЙ

Удалено в:

версия 3.0.0

Почему:

Этот модуль был перемещен в коллекцию microsoft.ad.

Альтернатива:

Вместо этого используйте модуль microsoft.ad.object_info.

Краткое описание

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

Параметры

Параметр

Комментарии

domain_password

string

Пароль для domain_username.

domain_server

string

Указывает экземпляр служб домена Active Directory для подключения.

Может быть в виде полного доменного имени или имени NetBIOS.

Если не указано, то значение основано на домене по умолчанию компьютера, на котором выполняется PowerShell.

domain_username

string

Имя пользователя, используемое при взаимодействии с AD.

Если это не установлено, то для аутентификации будет использоваться пользователь соединения.

Ansible не сможет использовать пользователя соединения, если аутентификация Kerberos с делегированием учетных данных или CredSSP, или используется become для задачи.

filter

string

Указывает строку запроса, используя синтаксис языка выражений PowerShell.

Он следует тем же правилам и форматированию, что и параметр -Filter для командлетов PowerShell AD, за исключением того, что нет подстановок переменных.

Взаимоисключающий с identity и ldap_filter.

identity

string

Указывает один объект Active Directory по его полному имени или GUID объекта.

Взаимоисключающий с filter и ldap_filter.

Это не может использоваться ни с параметрами search_base, ни с search_scope.

include_deleted

boolean

Также искать удаленные объекты Active Directory.

Варианты:

  • false ← (по умолчанию)
  • true

ldap_filter

string

Как filter, но это традиционная строка запроса LDAP для фильтрации возвращаемых объектов.

Взаимоисключающий с filter и identity.

properties

list / elements=string

Список свойств для возврата.

Если свойство *, будут возвращены все свойства, имеющие установленное значение в объекте AD.

Если свойство действительно для объекта, но не установлено, оно возвращается только в том случае, если оно явно определено в этом списке параметров.

Свойства DistinguishedName, Name, ObjectClass и ObjectGUID всегда возвращаются.

Указание нескольких свойств может повлиять на производительность, лучше возвращать только то, что необходимо.

Если указано недопустимое свойство, модуль отобразит предупреждение для каждого объекта, для которого оно недопустимо.

search_base

string

Укажите путь Active Directory для поиска объектов.

Это не может быть установлено с identity.

По умолчанию базой поиска является контекст именования по умолчанию целевого экземпляра AD, который является DN, возвращаемым “(Get-ADRootDSE).defaultNamingContext”.

search_scope

string

Укажите область поиска объекта в search_base.

base ограничит поиск базовым объектом, поэтому максимальное количество возвращаемых объектов всегда равно одному. Это не будет искать объекты внутри контейнера.

one_level будет искать текущий путь и все непосредственные объекты на этом пути.

subtree будет искать текущий путь и все объекты этого пути рекурсивно.

Это не может быть установлено с identity.

Варианты:

  • "base"
  • "one_level"
  • "subtree"

Примечания

Примечание

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

Примеры

- 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 всегда возвращаются.

Возвращается: всегда

Пример: "[{\n  \"accountExpires\": 0,\n  \"adminCount\": 1,\n  \"CanonicalName\": \"domain.com/Users/Administrator\",\n  \"CN\": \"Administrator\",\n  \"Created\": \"2020-01-13T09:03:22.0000000Z\",\n  \"Description\": \"Built-in account for administering computer/domain\",\n  \"DisplayName\": null,\n  \"DistinguishedName\": \"CN=Administrator,CN=Users,DC=domain,DC=com\",\n  \"memberOf\": [\n    \"CN=Group Policy Creator Owners,CN=Users,DC=domain,DC=com\",\n    \"CN=Domain Admins\",CN=Users,DC=domain,DC=com\"\n  ],\n  \"Name\": \"Administrator\",\n  \"nTSecurityDescriptor\": \"O:DAG:DAD:PAI(A;;LCRPLORC;;;AU)(A;;CCDCLCSWRPWPDTLOCRSDRCWDWO;;;SY)(A;;CCDCLCSWRPWPLOCRSDRCWDWO;;;BA)\",\n  \"ObjectCategory\": \"CN=Person,CN=Schema,CN=Configuration,DC=domain,DC=com\",\n  \"ObjectClass\": \"user\",\n  \"ObjectGUID\": \"c8c6569e-4688-4f3c-8462-afc4ff60817b\",\n  \"objectSid\": {\n    \"Sid\": \"S-1-5-21-2959096244-3298113601-420842770-500\",\n    \"Name\": \"DOMAIN\\Administrator\"\n  },\n  \"sAMAccountName\": \"Administrator\",\n}]\n"

Состояние

  • Этот модуль будет удалён в версии 3.0.0. [устарел]
  • Дополнительную информацию см. в разделе УСТАРЕВШЕЕ.

Авторы

  • Jordan Borean (@jborean93)

Ссылки на сборку

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 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

Spec-Zone.ru

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