Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

Описание

  • Получение всех сопоставлений Trustsec SG VN.
  • Получение сопоставления Trustsec SG VN по идентификатору.
  • Получение сопоставления группы безопасности и виртуальной сети по идентификатору.
  • Получение всех сопоставлений группы безопасности и виртуальной сети.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

filter

строка

Параметр запроса фильтрации. .. Контейнер **Простая фильтрация** должна быть доступна через параметр строки запроса 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 для включения отладки.

Варианты:

  • false ← (по умолчанию)
  • true

ise_hostname

строка / обязательно

Имя хоста Identity Services Engine.

ise_password

строка / обязательно

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

целое число

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

Таймаут (в секундах) для RESTful HTTP-запросов.

По умолчанию: 60

ise_username

строка / обязательно

Имя пользователя Identity Services Engine для аутентификации.

ise_uses_api_gateway

логическое

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

Флаг, который сообщает SDK, использовать ли API шлюз Identity Services Engine для отправки запросов.

Если значение true, используется API шлюз ISE и запросы отправляются на https://{{ise_hostname}}.

Если значение false, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid).

Варианты:

  • false
  • true ← (по умолчанию)

ise_uses_csrf_token

логическое

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

Флаг, который сообщает SDK, отправлять ли токен CSRF в API ISE ERS.

Если значение True, SDK предполагает, что проверка CSRF в ISE включена.

Если значение True, предполагается, что SDK должен автоматически управлять токеном CSRF.

Варианты:

  • false ← (по умолчанию)
  • true

ise_verify

логическое

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (по умолчанию)

ise_version

строка

Сообщает SDK, какую версию Identity Services Engine использовать.

По умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

логическое

Флаг для Identity Services Engine SDK для включения автоматического управления лимитом запросов.

Варианты:

  • false
  • true ← (по умолчанию)

page

целое число

Параметр запроса страницы. Номер страницы.

size

целое число

Параметр запроса размера. Количество объектов, возвращаемых на странице.

sort

строка

Параметр запроса сортировки. Тип сортировки - asc или desc.

sortBy

строка

Параметр запроса sortBy. Столбец, по которому нужно отсортировать объекты.

Примечания

Примечание

  • Используемые методы SDK: sg_vn_mapping.SgVnMapping.get_sg_vn_mapping_by_id, sg_vn_mapping.SgVnMapping.get_sg_vn_mapping_list_generator,
  • Используемые пути: get /api/v1/trustsec/sgvnmapping, get /api/v1/trustsec/sgvnmapping/{id},
  • Поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

См. также

Документация Cisco ISE для sgVnMapping

Полное описание API sgVnMapping.

Примеры

- name: Get all Trustsec SG VN Mapping
  cisco.ise.trustsec_sg_vn_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 SG VN Mapping by id
  cisco.ise.trustsec_sg_vn_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    \"lastUpdate\": \"string\",\n    \"sgName\": \"string\",\n    \"sgtId\": \"string\",\n    \"vnId\": \"string\",\n    \"vnName\": \"string\"\n  }\n]\n"

ise_responses

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

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

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

Пример: "[\n  {\n    \"id\": \"string\",\n    \"lastUpdate\": \"string\",\n    \"sgName\": \"string\",\n    \"sgtId\": \"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_sg_vn_mapping_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API