cisco.ise.sg_mapping_group_info модуль – Модуль информации для группы сопоставления SG

Примечание

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

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

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

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

Новый в cisco.ise 1.0.0

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

Обзор

Получить все группы сопоставления SG.
Получить группу сопоставления SG по идентификатору.
Этот API позволяет клиенту получить все группы сопоставления IP и SGT.
Этот API позволяет клиенту получить группу сопоставления IP и SGT по идентификатору.

Примечание

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

Требования

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

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 логический	Флаг для SDK Identity Services Engine для включения отладки. Варианты: `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 предполагает, что вам нужно, чтобы SDK автоматически управлял маркером CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логический	Флаг для включения или отключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Информирует SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логический	Флаг для SDK Identity Services Engine для включения автоматической обработки лимита запросов. Варианты: `false` `true` ← (по умолчанию)
page целое число	Параметр запроса page. Номер страницы.
size целое число	Параметр запроса size. Количество объектов, возвращаемых на странице.
sortasc строка	Параметр запроса sortasc. Сортировка по возрастанию.
sortdsc строка	Параметр запроса sortdsc. Сортировка по убыванию.

Примечания

Примечание

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

См. также

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

Примеры

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

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