Spec-Zone.ru › Ansible

Модуль microsoft.ad.object_info – Сбор информации о объекте Active Directory

Примечание

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

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

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

Для использования в playbook, укажите: microsoft.ad.object_info.

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

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

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

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

  • ActiveDirectory PowerShell модуль

Параметры

Параметр

Комментарии

domain_password

string

Пароль для domain_username.

Это может быть установлено в параметрах по умолчанию модуля play в группе group/microsoft.ad.domain.

domain_server

string

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

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

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

Это может быть установлено в параметрах по умолчанию модуля play в группе group/microsoft.ad.domain.

domain_username

string

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

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

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

Это может быть установлено в параметрах по умолчанию модуля play в группе group/microsoft.ad.domain.

filter

string

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

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

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

identity

string

Указывает отдельный объект Active Directory по его distinguished name или 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

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

Возвращает подробные сведения о том, что изменилось (или, возможно, нужно изменить в check_mode), в режиме diff

platform

Платформа: windows

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

Примечания

Примечание

  • Свойства groupType_AnsibleFlags, msDS-SupportedEncryptionTypes_AnsibleFlags, sAMAccountType_AnsibleFlags, и userAccountControl_AnsibleFlags устанавливаются самим модулем в качестве удобного способа отображения значения этих флагов. Эти свойства не могут быть использованы в качестве части фильтра или ldap_фильтра и автоматически добавляются, если эти свойства были запрошены.
  • Этот модуль должен выполняться на целевом хосте 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

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

Примеры

- 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

список / элементы=словарь

Список словарей, представляющих найденные объекты 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/microsoft/ad/object_info_module.html

Spec-Zone.ru

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