Spec-Zone.ru › Ansible

модуль microsoft.ad.object_info — сбор сведений об объекте Active Directory

Примечание

Этот модуль входит в коллекцию microsoft.ad (версия 1.10.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install microsoft.ad. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: microsoft.ad.object_info.

  • Краткое описание
  • Требования
  • Параметры
  • Атрибуты
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

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

  • Сбор сведений о нескольких объектах Active Directory.

Требования

На узле, где выполняется этот модуль, должны быть установлены следующие компоненты.

  • ActiveDirectory модуль PowerShell

Параметры

Параметр

Комментарии

domain_password

string

Пароль для domain_username.

Его можно задать в разделе значений модуля по умолчанию для сценария, в группе group/microsoft.ad.domain.

domain_server

string

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

Можно указать полное доменное имя (FQDN) или имя NetBIOS.

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

Его можно задать в разделе значений модуля по умолчанию для сценария, в группе group/microsoft.ad.domain.

domain_username

string

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

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

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

Его можно задать в разделе значений модуля по умолчанию для сценария, в группе group/microsoft.ad.domain.

filter

string

Задаёт строку запроса с использованием синтаксиса языка выражений PowerShell.

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

Этот параметр нельзя использовать одновременно с 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 | Select-Object -ExpandProperty defaultNamingContext.

search_scope

string

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

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

Значение one_level позволяет искать в текущем пути и среди непосредственных объектов в этом пути.

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

Нельзя задать вместе с identity.

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

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

diff_mode

Поддержка: отсутствует

В режиме diff возвращает сведения об изменениях (или о возможных изменениях в режиме check_mode).

platform

Платформа: windows

Целевые операционные системы и семейства ОС, с которыми можно работать.

Примечания

Примечание

  • Возвращаемые свойства groupType_AnsibleFlags, msDS-SupportedEncryptionTypes_AnsibleFlags, sAMAccountType_AnsibleFlags и userAccountControl_AnsibleFlags задаются самим модулем, чтобы упростить просмотр значений соответствующих флагов. Эти свойства нельзя использовать в составе filter или ldap_filter; они добавляются автоматически, если были запрошены.
  • Этот модуль необходимо запускать на целевом узле Windows, где установлен модуль ActiveDirectory.

См. также

См. также

microsoft.ad.domain

Обеспечивает существование домена Windows.

microsoft.ad.domain_controller

Управление состоянием контроллера домена или рядового сервера на узле Windows.

microsoft.ad.group

Управление объектами групп Active Directory.

microsoft.ad.object

Управление объектами Active Directory.

microsoft.ad.user

Управление пользователями Active Directory.

microsoft.ad.computer

Управление объектами компьютеров Active Directory.

Руководство по миграции

Этот модуль заменяет community.windows.win_domain_object_info. Подробности см. в руководстве по миграции.

community.windows.win_domain_object_info

Официальная документация по модулю community.windows.win_domain_object_info.

Примеры

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

- name: Get the SID for all user accounts as a filter
  microsoft.ad.object_info:
    filter: ObjectClass -eq 'user' -and objectCategory -eq 'Person'
    properties:
      - objectSid

- name: Get the SID for all user accounts as a LDAP filter
  microsoft.ad.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
  microsoft.ad.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

list / elements=dictionary

Список словарей, содержащих найденные объекты 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"

Авторы

  • Jordan Borean (@jborean93)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Сообщить о проблеме
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/microsoft/ad/object_info_module.html

Spec-Zone.ru

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