Модуль cisco.ise.active_directory_info – Модуль информации об Active Directory

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.active_directory_info.

Новая версия в cisco.ise 1.0.0

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

Описание

Получение всех объектов Active Directory.
Получение Active Directory по идентификатору.
Получение Active Directory по имени.
Этот API позволяет клиенту получить Active Directory по имени.
Этот API извлекает данные о точке подключения по идентификатору. Идентификатор можно получить с помощью.
Этот API перечисляет все точки подключения для доменов Active Directory в Cisco ISE.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
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` ← (по умолчанию)
name строка	Параметр пути имени.
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов, возвращаемых на странице.

Примечания

Примечание

Используемые методы SDK: active_directory.ActiveDirectory.get_active_directory_by_id, active_directory.ActiveDirectory.get_active_directory_by_name, active_directory.ActiveDirectory.get_active_directory_generator,
Используемые пути: get /ers/config/activedirectory, get /ers/config/activedirectory/name/{name}, get /ers/config/activedirectory/{id},
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключения из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all Active Directory
  cisco.ise.active_directory_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get Active Directory by id
  cisco.ise.active_directory_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get Active Directory by name
  cisco.ise.active_directory_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
  register: result

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

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

Ключ	Описание
ise_response словарь	Словарь или список, содержащий ответ, возвращаемый Cisco ISE Python SDK Возвращается: всегда Пример: {"adAttributes": {"attributes": [{"defaultValue": "string", "internalName": "string", "name": "string", "type": "string"}]}, "adScopesNames": "string", "adgroups": {"groups": [{"name": "string", "sid": "string", "type": "string"}]}, "advancedSettings": {"agingTime": 0, "authProtectionType": "string", "country": "string", "department": "string", "email": "string", "enableCallbackForDialinClient": true, "enableDialinPermissionCheck": true, "enableFailedAuthProtection": true, "enableMachineAccess": true, "enableMachineAuth": true, "enablePassChange": true, "enableRewrites": true, "failedAuthThreshold": 0, "firstName": "string", "identityNotInAdBehaviour": "string", "jobTitle": "string", "lastName": "string", "locality": "string", "organizationalUnit": "string", "plaintextAuth": true, "rewriteRules": [{"rewriteMatch": "string", "rewriteResult": "string", "rowId": 0}], "schema": "string", "stateOrProvince": "string", "streetAddress": "string", "telephone": "string", "unreachableDomainsBehaviour": "string"}, "description": "string", "domain": "string", "enableDomainAllowedList": true, "enableDomainWhiteList": true, "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string"}
ise_responses список / элементы=словарь Добавлен в cisco.ise 1.1.0	Словарь или список, содержащий ответ, возвращаемый Cisco ISE Python SDK Возвращается: всегда Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"domain\": \"string\",\n \"enableDomainWhiteList\": true,\n \"enableDomainAllowedList\": true,\n \"adgroups\": {\n \"groups\": [\n {\n \"name\": \"string\",\n \"sid\": \"string\",\n \"type\": \"string\"\n }\n ]\n },\n \"advancedSettings\": {\n \"enablePassChange\": true,\n \"enableMachineAuth\": true,\n \"enableMachineAccess\": true,\n \"agingTime\": 0,\n \"enableDialinPermissionCheck\": true,\n \"enableCallbackForDialinClient\": true,\n \"plaintextAuth\": true,\n \"enableFailedAuthProtection\": true,\n \"authProtectionType\": \"string\",\n \"failedAuthThreshold\": 0,\n \"identityNotInAdBehaviour\": \"string\",\n \"unreachableDomainsBehaviour\": \"string\",\n \"enableRewrites\": true,\n \"rewriteRules\": [\n {\n \"rowId\": 0,\n \"rewriteMatch\": \"string\",\n \"rewriteResult\": \"string\"\n }\n ],\n \"firstName\": \"string\",\n \"department\": \"string\",\n \"lastName\": \"string\",\n \"organizationalUnit\": \"string\",\n \"jobTitle\": \"string\",\n \"locality\": \"string\",\n \"email\": \"string\",\n \"stateOrProvince\": \"string\",\n \"telephone\": \"string\",\n \"country\": \"string\",\n \"streetAddress\": \"string\",\n \"schema\": \"string\"\n },\n \"adAttributes\": {\n \"attributes\": [\n {\n \"name\": \"string\",\n \"type\": \"string\",\n \"internalName\": \"string\",\n \"defaultValue\": \"string\"\n }\n ]\n },\n \"adScopesNames\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Ключ

Описание

ise_response

словарь

Словарь или список, содержащий ответ, возвращаемый Cisco ISE Python SDK

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

Пример: {"adAttributes": {"attributes": [{"defaultValue": "string", "internalName": "string", "name": "string", "type": "string"}]}, "adScopesNames": "string", "adgroups": {"groups": [{"name": "string", "sid": "string", "type": "string"}]}, "advancedSettings": {"agingTime": 0, "authProtectionType": "string", "country": "string", "department": "string", "email": "string", "enableCallbackForDialinClient": true, "enableDialinPermissionCheck": true, "enableFailedAuthProtection": true, "enableMachineAccess": true, "enableMachineAuth": true, "enablePassChange": true, "enableRewrites": true, "failedAuthThreshold": 0, "firstName": "string", "identityNotInAdBehaviour": "string", "jobTitle": "string", "lastName": "string", "locality": "string", "organizationalUnit": "string", "plaintextAuth": true, "rewriteRules": [{"rewriteMatch": "string", "rewriteResult": "string", "rowId": 0}], "schema": "string", "stateOrProvince": "string", "streetAddress": "string", "telephone": "string", "unreachableDomainsBehaviour": "string"}, "description": "string", "domain": "string", "enableDomainAllowedList": true, "enableDomainWhiteList": true, "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string"}

ise_responses

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

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

Словарь или список, содержащий ответ, возвращаемый Cisco ISE Python SDK

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"domain\": \"string\",\n \"enableDomainWhiteList\": true,\n \"enableDomainAllowedList\": true,\n \"adgroups\": {\n \"groups\": [\n {\n \"name\": \"string\",\n \"sid\": \"string\",\n \"type\": \"string\"\n }\n ]\n },\n \"advancedSettings\": {\n \"enablePassChange\": true,\n \"enableMachineAuth\": true,\n \"enableMachineAccess\": true,\n \"agingTime\": 0,\n \"enableDialinPermissionCheck\": true,\n \"enableCallbackForDialinClient\": true,\n \"plaintextAuth\": true,\n \"enableFailedAuthProtection\": true,\n \"authProtectionType\": \"string\",\n \"failedAuthThreshold\": 0,\n \"identityNotInAdBehaviour\": \"string\",\n \"unreachableDomainsBehaviour\": \"string\",\n \"enableRewrites\": true,\n \"rewriteRules\": [\n {\n \"rowId\": 0,\n \"rewriteMatch\": \"string\",\n \"rewriteResult\": \"string\"\n }\n ],\n \"firstName\": \"string\",\n \"department\": \"string\",\n \"lastName\": \"string\",\n \"organizationalUnit\": \"string\",\n \"jobTitle\": \"string\",\n \"locality\": \"string\",\n \"email\": \"string\",\n \"stateOrProvince\": \"string\",\n \"telephone\": \"string\",\n \"country\": \"string\",\n \"streetAddress\": \"string\",\n \"schema\": \"string\"\n },\n \"adAttributes\": {\n \"attributes\": [\n {\n \"name\": \"string\",\n \"type\": \"string\",\n \"internalName\": \"string\",\n \"defaultValue\": \"string\"\n }\n ]\n },\n \"adScopesNames\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Авторы

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_info_module.html