Модуль cisco.ise.trustsec_vn_info — Модуль информации для Trustsec VN

Примечание

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

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

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

Для использования в playbook укажите: cisco.ise.trustsec_vn_info.

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

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

Описание

Получить все Trustsec VN.
Получить Trustsec VN по идентификатору.
Получить виртуальную сеть по идентификатору.
Получить все виртуальные сети.

Примечание

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

Требования

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

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 для отправки запросов. Если значение 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 ERS ISE. Если значение 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: virtual_network.VirtualNetwork.get_virtual_network_by_id, virtual_network.VirtualNetwork.get_virtual_networks_generator,
Используемые пути: get /api/v1/trustsec/virtualnetwork, get /api/v1/trustsec/virtualnetwork/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

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

END_OF_DOCUMENT_MARKER

Примеры

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