Модуль cisco.ise.sgt_info – Модуль информации для SGt

Примечание

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

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

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

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

Новое в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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 в ERS API 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 целое число	Параметр запроса page. Номер страницы.
size целое число	Параметр запроса size. Количество объектов на странице.
sortasc строка	Параметр запроса sortasc. Сортировка по возрастанию.
sortdsc строка	Параметр запроса sortdsc. Сортировка по убыванию.

Примечания

Примечание

Используемые методы SDK: security_groups.SecurityGroups.get_security_group_by_id, security_groups.SecurityGroups.get_security_groups_generator,
Используемые пути: get /ers/config/sgt, get /ers/config/sgt/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

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

Примеры

- name: Get all SGt
  cisco.ise.sgt_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 SGt by id
  cisco.ise.sgt_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 Возвращается: всегда Пример: `{"defaultSGACLs": [{}], "description": "string", "generationId": "string", "id": "string", "isReadOnly": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "propogateToApic": true, "value": 0}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список со значением, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"value\": 0,\n \"generationId\": \"string\",\n \"isReadOnly\": true,\n \"propogateToApic\": true,\n \"defaultSGACLs\": [\n {}\n ],\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"`

Ключ

Описание

ise_response

словарь

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

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

Пример: {"defaultSGACLs": [{}], "description": "string", "generationId": "string", "id": "string", "isReadOnly": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "propogateToApic": true, "value": 0}

ise_responses

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

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

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"value\": 0,\n \"generationId\": \"string\",\n \"isReadOnly\": true,\n \"propogateToApic\": true,\n \"defaultSGACLs\": [\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/sgt_info_module.html