Модуль cisco.dnac.endpoint_analytics_profiling_rules_info – Модуль информации о правилах профилирования Endpoint Analytics
Примечание
Этот модуль входит в коллекцию cisco.dnac (версия 6.20.0).
Если вы используете пакет ansible, эта коллекция, возможно, уже установлена. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в playbook, укажите: cisco.dnac.endpoint_analytics_profiling_rules_info.
Новая функция в cisco.dnac 4.0.0
Обзор
- Получение всех правил профилирования Endpoint Analytics.
- Получение правил профилирования Endpoint Analytics по идентификатору.
- Получение подробностей о правиле профилирования для заданного ‘ruleId’.
- Этот API получает список правил профилирования. Его можно использовать для отображения правил профилирования в клиентских приложениях или для экспорта из среды. API ‘POST /profiling-rules/bulk’ можно использовать для импорта таких экспортированных правил в другую среду. Если этот API используется для экспорта правил для импорта в другую систему Cisco DNA Center, убедитесь, что параметр ‘includeDeleted’ имеет значение ‘true’, чтобы правилу, удалённые правила синхронизировались корректно. Используйте параметры запроса для фильтрации данных по необходимости. Если фильтр не задан, в ответе будут только правила типа ‘Custom Rule’. По умолчанию ответ ограничен 500 записями. Используйте параметр ‘limit’, чтобы получить больше записей, если необходимо. API ‘GET /profiling-rules/count’ можно использовать для определения общего количества правил в системе.
Примечание
У этого модуля есть соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- dnacentersdk >= 2.7.2
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
dnac_debug boolean | Флаг для Cisco DNA Center SDK, позволяющий включить отладку. Варианты:
|
dnac_host строка / обязательно | Имя хоста Cisco DNA Center. |
dnac_password строка | Пароль Cisco DNA Center для аутентификации. |
dnac_port целое число | Порт Cisco DNA Center. По умолчанию: |
dnac_username псевдонимы: user строка | Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version строка | Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: |
headers словарь | Дополнительные заголовки. |
includeDeleted boolean | Параметр includeDeleted. Флаг, указывающий, должны ли удаленные правила быть включены в извлекаемые записи. Варианты:
|
limit целое число | Параметр limit. Максимальное количество извлекаемых записей. Если не указано, по умолчанию извлекается 500 записей. Для извлечения всех записей в системе укажите большое значение для этого параметра. |
offset целое число | Параметр offset. Смещение записи, с которого начинается извлечение данных. Смещение начинается с нуля. |
order строка | Параметр order. Порядок, используемый для сортировки. |
ruleId строка | Параметр ruleId. Уникальный идентификатор правила. |
ruleType строка | Параметр ruleType. Используйте список типов правил через запятую для фильтрации данных. По умолчанию используется «Custom Rule». |
sortBy строка | Параметр sortBy. Название столбца для сортировки результатов. Обратите внимание, что извлечение может занять больше времени, если запрошена сортировка. |
validate_response_schema boolean | Флаг для Cisco DNA Center SDK, позволяющий включить валидацию заголовков запросов по отношению к схеме JSON. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: policy.Policy.get_details_of_a_single_profiling_rule, policy.Policy.get_list_of_profiling_rules,
- Используемые пути: get /dna/intent/api/v1/endpoint-analytics/profiling-rules, get /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
Примеры
- name: Get all Endpoint Analytics Profiling Rules
cisco.dnac.endpoint_analytics_profiling_rules_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers:
custom: value
ruleType: string
includeDeleted: True
limit: 0
offset: 0
sortBy: string
order: string
register: result
- name: Get Endpoint Analytics Profiling Rules by id
cisco.dnac.endpoint_analytics_profiling_rules_info:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
headers:
custom: value
ruleId: string
register: result
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
dnac_response словарь | Словарь или список с ответом, возвращённым Cisco DNAC 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/dnac/endpoint_analytics_profiling_rules_info_module.html
