Модуль cisco.ise.custom_attributes_info – Модуль информации о пользовательских атрибутах

Примечание

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

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

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

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

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

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

Описание

Получение информации обо всех пользовательских атрибутах.
Получение информации о пользовательских атрибутах по имени.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
ise_debug boolean	Флаг для 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 boolean добавлен в 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 boolean добавлен в cisco.ise 3.0.0	Флаг, информирующий SDK о необходимости отправки токена CSRF в API ISE ERS. Если значение True, SDK предполагает, что проверка CSRF ISE включена. Если значение True, SDK предполагает, что вам нужно, чтобы SDK автоматически управлял токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify boolean	Флаг для включения или выключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK, позволяющий включить автоматическую обработку лимитов запросов. Варианты: `false` `true` ← (по умолчанию)
name строка	Параметр пути name. Имя пользовательского атрибута.

Примечания

Примечание

Используемые методы SDK: customattributes.Customattributes.get, customattributes.Customattributes.list,
Используемые пути: get /api/v1/endpoint-custom-attribute, get /api/v1/endpoint-custom-attribute/{name},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all Custom Attributes Info
  cisco.ise.custom_attributes_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
  register: result

- name: Get Custom Attributes Info by name
  cisco.ise.custom_attributes_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
  register: result

Возвращаемые значения

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

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

Авторы

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/custom_attributes_info_module.html