Модуль cisco.ise.anc_policy_info – Модуль информации для политики ANC
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: cisco.ise.anc_policy_info.
Добавлена в cisco.ise 1.0.0
Обзор
- Получить все политики ANC.
- Получить политику ANC по идентификатору.
- Получить политику ANC по имени.
- Этот API позволяет клиенту получать все политики ANC.
- Этот API позволяет клиенту получать политику ANC по ID.
- Этот API позволяет клиенту получать политику ANC по имени.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 для включения отладки. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0 | Таймаут (в секундах) для RESTful HTTP запросов. По умолчанию: |
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). Варианты:
|
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0 | Флаг, сообщающий SDK, отправлять ли токен CSRF в ERS APIs ISE. Если true, SDK предполагает, что проверка CSRF вашего ISE включена. Если true, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify логическое | Флаг для включения или отключения проверки SSL сертификата. Варианты:
|
ise_version строка | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit логическое | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты:
|
name строка | Параметр пути name. |
page целое число | Параметр запроса страницы. Номер страницы. |
size целое число | Параметр запроса размера. Количество объектов, возвращаемых на странице. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: anc_policy.AncPolicy.get_anc_policy_by_id, anc_policy.AncPolicy.get_anc_policy_by_name, anc_policy.AncPolicy.get_anc_policy_generator,
- Используемые пути: get /ers/config/ancpolicy, get /ers/config/ancpolicy/name/{name}, get /ers/config/ancpolicy/{id},
- Поддерживает
check_mode - Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all ANC Policy
cisco.ise.anc_policy_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 ANC Policy by id
cisco.ise.anc_policy_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get ANC Policy by name
cisco.ise.anc_policy_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
name: string
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0 | Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/anc_policy_info_module.html