Модуль cisco.ise.system_certificate_info – Модуль информации о сертификате системы

Примечание

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

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

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

Для использования в книге задач укажите: cisco.ise.system_certificate_info.

Введено в cisco.ise 1.0.0

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

Описание

Получение сертификата системы по идентификатору.
Получение сертификата системы по имени.
Этот API предоставляет детали сертификата системы конкретного узла на основе заданного имени хоста и идентификатора.
Этот API поддерживает фильтрацию, сортировку и пагинацию.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
filter string	Параметр запроса фильтра. .. Контейнер Простая фильтрация должен быть доступен через параметр строки запроса фильтра. Структура фильтра представляет собой тройку поле-оператор-значение, разделенные точками. Можно отправить более одного фильтра. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса ”filterType=or”. В описании модели данных каждого ресурса следует указать, является ли атрибут фильтруемым полем. Оператор ‘EQ’ означает ‘Равно’. Оператор ‘NEQ’ означает ‘Не равно’. Оператор ‘GT’ означает ‘Больше чем’. Оператор ‘LT’ означает ‘Меньше чем’. Оператор ‘STARTSW’ означает ‘Начинается с’. Оператор ‘NSTARTSW’ означает ‘Не начинается с’. Оператор ‘ENDSW’ означает ‘Заканчивается на’. Оператор ‘NENDSW’ означает ‘Не заканчивается на’. Оператор ‘CONTAINS’ означает ‘Содержит’. Оператор ‘NCONTAINS’ означает ‘Не содержит’.
filterType string	Параметр запроса FilterType. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр.
hostName string	Параметр пути HostName. Имя хоста, для которого должны быть возвращены системные сертификаты.
id string	Параметр пути Id. Идентификатор системного сертификата.
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (default) `true`
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. По умолчанию: `60`
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). Варианты: `false` `true` ← (default)
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0	Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если он True, SDK предполагает, что ваша проверка CSRF ISE включена. Если он True, он предполагает, что вам нужно, чтобы SDK автоматически управлял токеном CSRF для вас. Варианты: `false` ← (default) `true`
ise_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
ise_version string	Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты: `false` `true` ← (default)
page integer	Параметр запроса Page. Номер страницы.
size integer	Параметр запроса Size. Количество возвращаемых объектов на страницу.
sort string	Параметр запроса Sort. Тип сортировки - asc или desc.
sortBy string	Параметр запроса SortBy. Столбец сортировки, по которому необходимо отсортировать объекты.

Примечания

Примечание

Используемые методы SDK: certificates.Certificates.get_system_certificate_by_id, certificates.Certificates.get_system_certificates,
Используемые пути: get /api/v1/certs/system-certificate/{hostName}, get /api/v1/certs/system-certificate/{hostName}/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

Документация Cisco ISE по сертификатам: Полная справка по API сертификатов.

Примеры

- name: Get System Certificate by id
  cisco.ise.system_certificate_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    hostName: string
    id: string
  register: result

- name: Get System Certificate by name
  cisco.ise.system_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
    hostName: string
  register: result

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"expirationDate": "string", "friendlyName": "string", "groupTag": "string", "id": "string", "issuedBy": "string", "issuedTo": "string", "keySize": 0, "link": {"href": "string", "rel": "string", "type": "string"}, "portalsUsingTheTag": "string", "selfSigned": true, "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "usedBy": "string", "validFrom": "string"}`
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: "[\n {\n \"expirationDate\": \"string\",\n \"friendlyName\": \"string\",\n \"groupTag\": \"string\",\n \"id\": \"string\",\n \"issuedBy\": \"string\",\n \"issuedTo\": \"string\",\n \"keySize\": 0,\n \"link\": {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"type\": \"string\"\n },\n \"portalsUsingTheTag\": \"string\",\n \"selfSigned\": true,\n \"serialNumberDecimalFormat\": \"string\",\n \"sha256Fingerprint\": \"string\",\n \"signatureAlgorithm\": \"string\",\n \"usedBy\": \"string\",\n \"validFrom\": \"string\"\n }\n]\n"

Ключ

Описание

ise_response

словарь

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

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

Пример: {"expirationDate": "string", "friendlyName": "string", "groupTag": "string", "id": "string", "issuedBy": "string", "issuedTo": "string", "keySize": 0, "link": {"href": "string", "rel": "string", "type": "string"}, "portalsUsingTheTag": "string", "selfSigned": true, "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "usedBy": "string", "validFrom": "string"}

ise_responses

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

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

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

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

Пример: "[\n {\n \"expirationDate\": \"string\",\n \"friendlyName\": \"string\",\n \"groupTag\": \"string\",\n \"id\": \"string\",\n \"issuedBy\": \"string\",\n \"issuedTo\": \"string\",\n \"keySize\": 0,\n \"link\": {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"type\": \"string\"\n },\n \"portalsUsingTheTag\": \"string\",\n \"selfSigned\": true,\n \"serialNumberDecimalFormat\": \"string\",\n \"sha256Fingerprint\": \"string\",\n \"signatureAlgorithm\": \"string\",\n \"usedBy\": \"string\",\n \"validFrom\": \"string\"\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/system_certificate_info_module.html