Модуль cisco.ise.sxp_vpns_info – Модуль информации для SXP VPN

Примечание

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

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

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

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Получение всех SXP VPN.
Получение SXP VPN по идентификатору.
Этот API позволяет клиенту получить SXP VPN по идентификатору.
Этот API позволяет клиенту получить все SXP VPN.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
filter list / elements=string	Параметр запроса фильтра. Простая фильтрация должна быть доступна через параметр строки запроса filter. Структура фильтра представляет собой тройку поле-оператор-значение, разделенные точками. Можно отправить более одного фильтра. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию будет AND и может быть изменен с помощью параметра строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут отфильтрованным полем. Оператор ‘EQ’ описывает ‘Равно’. Оператор ‘NEQ’ описывает ‘Не равно’. Оператор ‘GT’ описывает ‘Больше чем’. Оператор ‘LT’ описывает ‘Меньше чем’. Оператор ‘STARTSW’ описывает ‘Начинается с’. Оператор ‘NSTARTSW’ описывает ‘Не начинается с’. Оператор ‘ENDSW’ описывает ‘Заканчивается на’. Оператор ‘NENDSW’ описывает ‘Не заканчивается на’. Оператор ‘CONTAINS’ описывает ‘Содержит’. Оператор ‘NCONTAINS’ описывает ‘Не содержит’.
filterType string	Параметр запроса FilterType. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию будет AND и может быть изменен с помощью этого параметра.
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 added in cisco.ise 3.0.0	Время ожидания (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / required	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean added in cisco.ise 1.1.0	Флаг, который сообщает SDK, следует ли использовать API Gateway Identity Services Engine для отправки запросов. Если это true, используется API Gateway ISE и запросы отправляются по адресу https://{{ise_hostname}}. Если это false, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (default)
ise_uses_csrf_token boolean added in 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. Количество возвращаемых объектов на странице.
sortasc string	Параметр запроса Sortasc. Сортировка по возрастанию.
sortdsc string	Параметр запроса Sortdsc. Сортировка по убыванию.

Примечания

Примечание

Используемые методы SDK: sxp_vpns.SxpVpns.get_sxp_vpn_by_id, sxp_vpns.SxpVpns.get_sxp_vpns_generator,
Используемые пути: get /ers/config/sxpvpns, get /ers/config/sxpvpns/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Get all SXP VPNs
  cisco.ise.sxp_vpns_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    filter: []
    filterType: AND
    sortasc: string
    sortdsc: string
  register: result

- name: Get SXP VPNs by id
  cisco.ise.sxp_vpns_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 Возвращается: всегда Пример: `{"id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "sxpVpnName": "string"}`
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0	Словарь или список со значением, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"sxpVpnName\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\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/sxp_vpns_info_module.html