Модуль cisco.ise.trusted_certificate_info – Модуль информации о доверенном сертификате
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования его в книге задач, укажите: cisco.ise.trusted_certificate_info.
Новая в cisco.ise 1.0.0
Обзор
- Получение всех доверенных сертификатов.
- Получение доверенного сертификата по id.
- Этот API может отображать подробности доверенного сертификата на основе заданного идентификатора.
- Этот API поддерживает фильтрацию, сортировку и пагинацию.
Примечание
Для этого модуля есть соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter строка | Параметр запроса для фильтрации. .. Контейнер **Простая фильтрация** должна быть доступна через строковый параметр запроса filter. Структура фильтра — тройка «поле оператор значение», разделенные точками. Можно указать несколько фильтров. По умолчанию логический оператор для всех критериев фильтра — И, и его можно изменить, используя параметр строки запроса *”filterType=или”*. Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор ‘EQ’ означает «Равно». Оператор ‘NEQ’ означает «Не равно». Оператор ‘GT’ означает «Больше, чем». Оператор ‘LT’ означает «Меньше, чем». Оператор ‘STARTSW’ означает «Начинается с». Оператор ‘NSTARTSW’ означает «Не начинается с». Оператор ‘ENDSW’ означает «Заканчивается на». Оператор ‘NENDSW’ означает «Не заканчивается на». Оператор ‘CONTAINS’ означает «Содержит». Оператор ‘NCONTAINS’ означает «Не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию — И, и его можно изменить с помощью этого параметра. |
id строка | Параметр пути id. Идентификатор доверенного сертификата. |
ise_debug булево | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0 | Таймаут (в секундах) для запросов RESTful HTTP. По умолчанию: |
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). Варианты:
|
ise_uses_csrf_token булево добавлен в cisco.ise 3.0.0 | Флаг, который сообщает SDK, отправлять ли токен CSRF в API ERS ISE. Если значение True, SDK предполагает, что проверка CSRF ISE включена. Если значение True, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify булево | Флаг для включения или выключения проверки сертификата SSL. Варианты:
|
ise_version строка | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit булево | Флаг для Identity Services Engine SDK для включения автоматической обработки лимитов запросов. Варианты:
|
page целое число | Параметр запроса page. Номер страницы. |
size целое число | Параметр запроса size. Количество объектов на странице. |
sort строка | Параметр запроса sort. Тип сортировки — asc или desc. |
sortBy строка | Параметр запроса sortBy. Столбец, по которому нужно отсортировать объекты. |
Примечания
Примечание
- Используемые методы SDK — certificates.Certificates.get_trusted_certificate_by_id, certificates.Certificates.get_trusted_certificates_generator,
- Используемые пути — get /api/v1/certs/trusted-certificate, get /api/v1/certs/trusted-certificate/{id},
- Поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Python SDK Cisco ISE для установления соединения
См. также
См. также
- Документация Cisco ISE по сертификатам
-
Полная справка по API сертификатов.
Примеры
- name: Get all Trusted Certificate
cisco.ise.trusted_certificate_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
page: 0
size: 0
sort: string
sortBy: string
filter: string
filterType: string
register: result
- name: Get Trusted Certificate by id
cisco.ise.trusted_certificate_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
Значения возврата
Общие значения возврата задокументированы здесь, ниже приведены поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список со значением, возвращённым SDK Cisco ISE Python. Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0 | Словарь или список со значением, возвращённым SDK Cisco ISE Python. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/trusted_certificate_info_module.html
