Модуль cisco.ise.active_directory_leave_domain — Модуль ресурса для выхода из домена Active Directory

Примечание

Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).

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

Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные компоненты. Подробную информацию см. в разделе Требования.

Для использования в плейбуке укажите: cisco.ise.active_directory_leave_domain.

Добавлена в cisco.ise 1.0.0

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

Описание

Управление обновлением ресурса выхода из домена Active Directory.
Этот API заставляет узел Cisco ISE выйти из домена Active Directory.

Примечание

Для этого модуля есть соответствующий плагин действия.

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
additionalData список / элементы=словарь	Дополнительные данные выхода из домена Active Directory.
name строка	Имя выхода из домена Active Directory.
value строка	Значение выхода из домена Active Directory.
id строка	Параметр пути идентификатора.
ise_debug булево	Флаг для включения отладки в Identity Services Engine SDK. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлено в cisco.ise 3.0.0	Время ожидания (в секундах) для запросов RESTful HTTP. По умолчанию: `60`
ise_username строка / обязательно	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway булево добавлено в cisco.ise 1.1.0	Флаг, информирующий SDK о том, следует ли использовать API шлюз Identity Services Engine для отправки запросов. Если значение true, то используется API шлюз ISE и запросы отправляются на https://{{ise_hostname}}. Если значение false, то запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token булево добавлено в cisco.ise 3.0.0	Флаг, информирующий SDK, нужно ли отправлять токен CSRF в API ERS ISE. Если значение True, то SDK предполагает, что проверка CSRF ISE включена. Если значение True, то предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify булево	Флаг для включения или отключения проверки SSL-сертификата. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Информирует SDK о версии Identity Services Engine, которую следует использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit булево	Флаг для включения автоматической обработки ограничений скорости в Identity Services Engine SDK. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK — active_directory.ActiveDirectory.leave_domain,
Используемые пути — put /ers/config/activedirectory/{id}/leave,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update all
  cisco.ise.active_directory_leave_domain:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    additionalData:
    - name: username
      value: Required. The domain user to use
    - name: password
      value: Required. The domain user's password
    - name: node
      value: Required. The name of the ISE node to leave the domain. The node names can
        be retrieved with the "Node Details/Get All" ERS operation
    - name: orgunit
      value: Optional. The organizational unit in AD where the machine object for the
        joined ISE will be stored
    id: string

Значения возврата

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{}`

Авторы

Rafael Campos (@racampos)

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

© 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/cisco/ise/active_directory_leave_domain_module.html