Spec-Zone.ru › Ansible

Модуль cisco.ise.sg_to_vn_to_vlan_info – Модуль информации для SG к VN к VLAN

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.sg_to_vn_to_vlan_info.

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

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

Описание

  • Получение всех SG к VN к VLAN.
  • Получение SG к VN к VLAN по идентификатору.
  • Этот API позволяет клиенту получить группу безопасности (security group) по виртуальной сети по идентификатору.
  • Этот API позволяет клиенту получить все правила доступа к группе безопасности (ACL) для виртуальной сети.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

filter

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

Параметр запроса фильтрации. **Простая фильтрация** должна быть доступна через параметр строки запроса фильтра. Структура фильтра — тройка «поле оператор значение», разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию — И, его можно изменить, используя параметр строки запроса «filterType=or».

Каждое описание модели данных ресурса должно указывать, является ли атрибут полем фильтрации.

Оператор «EQ» описывает «Равно».

Оператор «NEQ» описывает «Не равно».

Оператор «GT» описывает «Больше, чем».

Оператор «LT» описывает «Меньше, чем».

Оператор «STARTSW» описывает «Начинается с».

Оператор «NSTARTSW» описывает «Не начинается с».

Оператор «ENDSW» описывает «Заканчивается на».

Оператор «NENDSW» описывает «Не заканчивается на».

Оператор «CONTAINS» описывает «Содержит».

Оператор «NCONTAINS» описывает «Не содержит».

filterType

строка

Параметр запроса filterType. Логический оператор, общий для всех критериев фильтрации, по умолчанию — И, его можно изменить, используя данный параметр.

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 для отправки запросов.

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

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

Варианты:

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

ise_uses_csrf_token

булево

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

Флаг, информирующий SDK, отправлять ли токен CSRF в API ERS ISE.

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

Если истинно, предполагается, что 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

целое число

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

Примечания

Примечание

  • Используемые методы SDK — security_group_to_virtual_network.SecurityGroupToVirtualNetwork.get_security_groups_to_vn_to_vlan_by_id, security_group_to_virtual_network.SecurityGroupToVirtualNetwork.get_security_groups_to_vn_to_vlan_generator,
  • Используемые пути — get /ers/config/sgtvnvlan, get /ers/config/sgtvnvlan/{id},
  • Поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

См. также

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

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

Примеры

- name: Get all SG To VN To VLAN
  cisco.ise.sg_to_vn_to_vlan_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    filter: []
    filterType: AND
  register: result

- name: Get SG To VN To VLAN by id
  cisco.ise.sg_to_vn_to_vlan_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.

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

Пример: {"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "sgtId": "string", "virtualnetworklist": [{"defaultVirtualNetwork": true, "description": "string", "id": "string", "name": "string", "vlans": [{"data": true, "defaultVlan": true, "description": "string", "id": "string", "maxValue": 0, "name": "string"}]}]}

ise_responses

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

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

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

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

Пример: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"sgtId\": \"string\",\n    \"virtualnetworklist\": [\n      {\n        \"id\": \"string\",\n        \"name\": \"string\",\n        \"description\": \"string\",\n        \"defaultVirtualNetwork\": true,\n        \"vlans\": [\n          {\n            \"id\": \"string\",\n            \"name\": \"string\",\n            \"description\": \"string\",\n            \"defaultVlan\": true,\n            \"maxValue\": 0,\n            \"data\": true\n          }\n        ]\n      }\n    ],\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/sg_to_vn_to_vlan_info_module.html

Spec-Zone.ru

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