Модуль cisco.ise.sxp_local_bindings_info — Модуль информации для локальных привязок SXP
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: cisco.ise.sxp_local_bindings_info.
Новая в cisco.ise 1.0.0
Описание
- Получить все локальные привязки SXP.
- Получить локальные привязки SXP по идентификатору.
- Этот API позволяет клиенту получить локальную привязку SXP по идентификатору.
- Этот API позволяет клиенту получить все локальные привязки SXP.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтрации. **Простая фильтрация** должна быть доступна через строковый параметр запроса фильтра. Структура фильтра — тройка: поле, оператор и значение, разделенные точками. Можно передать несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем для фильтрации. Оператор ‘EQ’ описывает «равно». Оператор ‘NEQ’ описывает «не равно». Оператор ‘GT’ описывает «больше, чем». Оператор ‘LT’ описывает «меньше, чем». Оператор ‘STARTSW’ описывает «начинается с». Оператор ‘NSTARTSW’ описывает «не начинается с». Оператор ‘ENDSW’ описывает «заканчивается на». Оператор ‘NENDSW’ описывает «не заканчивается на». Оператор ‘CONTAINS’ описывает «содержит». Оператор ‘NCONTAINS’ описывает «не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию — AND, и его можно изменить, используя этот параметр. |
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 для отправки запросов. Если значение истинно, используется API шлюз ISE, и запросы отправляются по адресу https://{{ise_hostname}}. Если ложно, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token логическое значение добавлен в cisco.ise 3.0.0 | Флаг, информирующий SDK о том, отправлять ли токен CSRF в ERS API ISE. Если значение истинно, SDK предполагает, что проверка CSRF ISE включена. Если значение истинно, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify логическое значение | Флаг для включения или отключения проверки SSL сертификатов. Варианты:
|
ise_version строка | Информирует SDK о версии Identity Services Engine, которую использовать. По умолчанию: |
ise_wait_on_rate_limit логическое значение | Флаг для Identity Services Engine SDK для включения автоматической обработки лимитов скорости. Варианты:
|
page целое число | Параметр запроса страницы. Номер страницы. |
size целое число | Параметр запроса размера. Количество объектов, возвращаемых на странице. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: sxp_local_bindings.SxpLocalBindings.get_sxp_local_bindings_by_id, sxp_local_bindings.SxpLocalBindings.get_sxp_local_bindings_generator,
- Используемые пути: get /ers/config/sxplocalbindings, get /ers/config/sxplocalbindings/{id},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all SXP Local Bindings
cisco.ise.sxp_local_bindings_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
page: 1
size: 20
sortasc: string
sortdsc: string
filter: []
filterType: AND
register: result
- name: Get SXP Local Bindings by id
cisco.ise.sxp_local_bindings_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
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/sxp_local_bindings_info_module.html
