cisco.ise.csr_info модуль — Модуль информации для CSR
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в плейбуке, укажите: cisco.ise.csr_info.
Новая в cisco.ise 1.0.0
Синопсис
- Получить все CSR.
- Получить CSR по идентификатору.
- Этот API отображает детали запроса на подпись сертификата (CSR) конкретного узла для заданного имени хоста и ID.
- Этот API поддерживает фильтрацию, сортировку и пагинацию.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter string | Параметр запроса фильтра. .. Контейнер **Простая фильтрация** должен быть доступен через параметр строки запроса filter. Структура фильтра представляет собой тройку поле-оператор-значение, разделенные точками. Можно отправить более одного фильтра. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса *”filterType=or”*. Описание модели данных каждого ресурса должно указывать, является ли атрибут фильтруемым полем. Оператор ‘EQ’ означает ‘Равно’. Оператор ‘NEQ’ означает ‘Не равно’. Оператор ‘GT’ означает ‘Больше чем’. Оператор ‘LT’ означает ‘Меньше чем’. Оператор ‘STARTSW’ означает ‘Начинается с’. Оператор ‘NSTARTSW’ означает ‘Не начинается с’. Оператор ‘ENDSW’ означает ‘Заканчивается на’. Оператор ‘NENDSW’ означает ‘Не заканчивается на’. Оператор ‘CONTAINS’ означает ‘Содержит’. Оператор ‘NCONTAINS’ означает ‘Не содержит’. |
filterType string | Параметр запроса FilterType. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр. |
hostName string | Параметр пути HostName. Имя хоста, для которого должны быть возвращены CSR. |
id string | Параметр пути Id. ID возвращаемого запроса на подпись сертификата. |
ise_debug boolean | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname string / required | Имя хоста Identity Services Engine. |
ise_password string / required | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0 | Время ожидания (в секундах) для HTTP-запросов RESTful. По умолчанию: |
ise_username string / required | Имя пользователя Identity Services Engine для аутентификации. |
ise_uses_api_gateway boolean добавлено в cisco.ise 1.1.0 | Флаг, который сообщает SDK, следует ли использовать шлюз API Identity Services Engine для отправки запросов. Если он истинно, то используется шлюз API ISE и запросы отправляются на https://{{ise_hostname}}. Если он ложно, то запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0 | Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если это True, SDK предполагает, что проверка CSRF вашего ISE включена. Если это True, он предполагает, что вам нужно, чтобы SDK автоматически управлял токеном CSRF для вас. Варианты:
|
ise_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
ise_version string | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate-limit boolean | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты:
|
page integer | Параметр запроса Page. Номер страницы. |
size integer | Параметр запроса Size. Количество объектов, возвращаемых на странице. |
sort string | Параметр запроса Sort. Тип сортировки - asc или desc. |
sortBy string | Параметр запроса SortBy. Столбец сортировки, по которому необходимо отсортировать объекты. |
Примечания
Примечание
- Используемые методы SDK: certificates.Certificates.get_csr_by_id, certificates.Certificates.get_csrs_generator,
- Используемые пути: get /api/v1/certs/certificate-signing-request, get /api/v1/certs/certificate-signing-request/{hostName}/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
См. также
См. также
- Документация Cisco ISE по сертификатам
-
Полное описание API сертификатов.
Примеры
- name: Get all CSR
cisco.ise.csr_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 CSR by id
cisco.ise.csr_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
hostName: string
id: string
register: result
Значения возврата
Общие значения возврата описаны здесь, а следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0 | Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/csr_info_module.html
