Модуль cisco.ise.trustsec_vn_vlan_mapping_info – Модуль информации для сопоставления VN VLAN Trustsec

Примечание

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

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

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

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

Новая версия в cisco.ise 2.0.0

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

Краткое описание

Получить все сопоставления Trustsec VN VLAN.
Получить сопоставление Trustsec VN VLAN по идентификатору.
Получить сопоставление VN-Vlan по идентификатору.
Получить все сопоставления VN-Vlan.

Примечание

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

Требования

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

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 и может быть изменен с помощью параметра.
id string	Параметр пути Id.
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (по умолчанию) `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` ← (по умолчанию)
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0	Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если он истинен, SDK предполагает, что проверка CSRF вашего ISE включена. Если он истинен, предполагается, что вам нужно, чтобы SDK автоматически управлял токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version string	Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты: `false` `true` ← (по умолчанию)
page integer	Параметр запроса Page. Номер страницы.
size integer	Параметр запроса Size. Количество возвращаемых объектов на странице.
sort string	Параметр запроса Sort. Тип сортировки - asc или desc.
sortBy string	Параметр запроса SortBy. Столбец сортировки, по которому необходимо отсортировать объекты.

Примечания

Примечание

Используемые методы SDK: vn_vlan_mapping.VnVlanMapping.get_vn_vlan_mapping_by_id, vn_vlan_mapping.VnVlanMapping.get_vn_vlan_mapping_list_generator,
Используемые пути: get /api/v1/trustsec/vnvlanmapping, get /api/v1/trustsec/vnvlanmapping/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует какие-либо плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

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

Примеры

- name: Get all Trustsec VN VLAN Mapping
  cisco.ise.trustsec_vn_vlan_mapping_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 Trustsec VN VLAN Mapping by id
  cisco.ise.trustsec_vn_vlan_mapping_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 Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"isData\": true,\n \"isDefaultVlan\": true,\n \"lastUpdate\": \"string\",\n \"maxValue\": 0,\n \"name\": \"string\",\n \"vnId\": \"string\",\n \"vnName\": \"string\"\n }\n]\n"`
ise_responses список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"isData\": true,\n \"isDefaultVlan\": true,\n \"lastUpdate\": \"string\",\n \"maxValue\": 0,\n \"name\": \"string\",\n \"vnId\": \"string\",\n \"vnName\": \"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/trustsec_vn_vlan_mapping_info_module.html