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

Примечание

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

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

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

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

Новая в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
filter список / элементы=строка	Параметр запроса фильтра. Простой фильтр должен быть доступен через параметр строки запроса фильтра. Структура фильтра — тройка поля, оператора и значения, разделенных точками. Можно передать несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтра, будет по умолчанию И, и его можно изменить, используя параметр строки запроса «filterType=или». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор «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 целое число	Параметр запроса размера. Количество объектов, возвращаемых на странице.
sortasc строка	Параметр запроса sortasc. Сортировка по возрастанию.
sortdsc строка	Параметр запроса sortdsc. Сортировка по убыванию.

Примечания

Примечание

Используемые методы SDK: ip_to_sgt_mapping.IpToSgtMapping.get_ip_to_sgt_mapping_by_id, ip_to_sgt_mapping.IpToSgtMapping.get_ip_to_sgt_mapping_generator,
Используемые пути: get /ers/config/sgmapping, get /ers/config/sgmapping/{id},
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины соединения ansible, а вместо этого использует встроенный менеджер соединений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

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

Примеры

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"deployTo": "string", "deployType": "string", "hostIp": "string", "hostName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "mappingGroup": "string", "name": "string", "sgt": "string"}

ise_responses

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

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

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"sgt\": \"string\",\n \"deployTo\": \"string\",\n \"deployType\": \"string\",\n \"hostName\": \"string\",\n \"hostIp\": \"string\",\n \"mappingGroup\": \"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_info_module.html