Модуль cisco.ise.filter_policy_info – Информационный модуль для политики фильтрации

Примечание

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

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

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

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

Новое в cisco.ise 1.0.0

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

Краткое описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
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	Время ожидания (в секундах) для HTTP-запросов RESTful. По умолчанию: `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 целое число	Параметр запроса page. Номер страницы.
size целое число	Параметр запроса size. Количество возвращаемых объектов на странице.

Примечания

Примечание

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

Примеры

- name: Get all Filter Policy
  cisco.ise.filter_policy_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get Filter Policy by id
  cisco.ise.filter_policy_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 Возвращается: всегда Пример: `{"domains": "string", "sgt": "string", "subnet": "string", "vn": "string"}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"subnet\": \"string\",\n \"domains\": \"string\",\n \"sgt\": \"string\",\n \"vn\": \"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/filter_policy_info_module.html