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

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
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 в 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: security_groups_acls.SecurityGroupsAcls.get_security_groups_acl_by_id, security_groups_acls.SecurityGroupsAcls.get_security_groups_acl_generator,
Используемые пути: get /ers/config/sgacl, get /ers/config/sgacl/{id},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

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

Примеры

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"aclcontent": "string", "description": "string", "generationId": "string", "id": "string", "ipVersion": "string", "isReadOnly": true, "link": {"href": "string", "rel": "string", "type": "string"}, "modelledContent": {}, "name": "string"}

ise_responses

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

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

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"generationId\": \"string\",\n \"aclcontent\": \"string\",\n \"isReadOnly\": true,\n \"modelledContent\": {},\n \"ipVersion\": \"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_acl_info_module.html