Модуль cisco.dnac.endpoint_analytics_profiling_rules – Модуль ресурсов для правил профилирования Endpoint Analytics

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.endpoint_analytics_profiling_rules.

Новая версия в cisco.dnac 4.0.0

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

Обзор

Управление операциями создания, обновления и удаления ресурсов правил профилирования Endpoint Analytics.
Создание правила профилирования из тела запроса.
Удаление правила профилирования для заданного ‘ruleId’.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.9

Параметры

Параметр	Комментарии
clusterId строка	Уникальный идентификатор кластера ML. Применимо только для правила «ML Rule».
conditionGroups словарь	Группа условий правил анализа профилей конечных устройств.
condition словарь	Условие правил анализа профилей конечных устройств.
attribute строка	Атрибут правил анализа профилей конечных устройств.
attributeDictionary строка	Словарь атрибутов правил анализа профилей конечных устройств.
operator строка	Оператор правил анализа профилей конечных устройств.
value строка	Значение правил анализа профилей конечных устройств.
conditionGroup список / элементы=словарь	Группа условий правил анализа профилей конечных устройств.
operator строка	Оператор правил анализа профилей конечных устройств.
type строка	Тип правил анализа профилей конечных устройств.
dnac_debug логический	Флаг для включения отладки Cisco DNA Center SDK. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логический	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
isDeleted логический	Флаг, указывающий, было ли правило удалено. Варианты: `false` `true`
lastModifiedBy строка	Пользователь, который последний раз изменил правило. Оно является только для чтения и игнорируется, если указано в запросе ввода.
lastModifiedOn целое число	Отметка времени (в миллисекундах эпохи) последнего изменения. Оно является только для чтения и игнорируется, если указано в запросе ввода.
pluginId строка	Плагин для правила. Применимо только для правил «Cisco Default».
rejected логический	Флаг, указывающий, было ли правило отклонено пользователем. Применимо только для правила «ML Rule». Варианты: `false` `true`
result словарь	Результат правил анализа профилей конечных устройств.

deviceType список / элементы=строка	Список типов устройств, определённых текущим правилом.
hardwareManufacturer список / элементы=строка	Список производителей оборудования, определённых текущим правилом.
hardwareModel список / элементы=строка	Список моделей оборудования, определённых текущим правилом.
operatingSystem список / элементы=строка	Список операционных систем, определённых текущим правилом.
ruleId строка	Уникальный идентификатор правила. Обычно генерируется системой, и клиенту не нужно его предоставлять для вновь создаваемых правил.
ruleName строка	Наименование правила, понятное пользователю.
rulePriority целое число	Приоритет правила.
ruleType строка	Тип правила. Допустимые значения: «Cisco Default - Static», «Cisco Default - Dynamic», «Custom Rule», «ML Rule».
ruleVersion целое число	Версия правила.
sourcePriority целое число	Приоритет источника для правила.
usedAttributes список / элементы=строка	Список атрибутов, используемых в правиле. Применимо только для правил «Cisco Default».
validate_response_schema логическое	Флаг для Cisco DNA Center SDK для включения валидации тел запросов по JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: policy.Policy.create_a_profiling_rule, policy.Policy.delete_an_existing_profiling_rule, policy.Policy.update_an_existing_profiling_rule,
Используемые пути: post /dna/intent/api/v1/endpoint-analytics/profiling-rules, delete /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId},
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

Примеры

- name: Create
  cisco.dnac.endpoint_analytics_profiling_rules:
    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}}"
    state: present
    clusterId: string
    conditionGroups:
      condition:
        attribute: string
        attributeDictionary: string
        operator: string
        value: string
      conditionGroup:
      - {}
      operator: string
      type: string
    isDeleted: true
    lastModifiedBy: string
    lastModifiedOn: 0
    pluginId: string
    rejected: true
    result:
      deviceType:
      - string
      hardwareManufacturer:
      - string
      hardwareModel:
      - string
      operatingSystem:
      - string
    ruleId: string
    ruleName: string
    rulePriority: 0
    ruleType: string
    ruleVersion: 0
    sourcePriority: 0
    usedAttributes:
    - string

- name: Update by id
  cisco.dnac.endpoint_analytics_profiling_rules:
    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}}"
    state: present
    clusterId: string
    conditionGroups:
      condition:
        attribute: string
        attributeDictionary: string
        operator: string
        value: string
      conditionGroup:
      - {}
      operator: string
      type: string
    isDeleted: true
    lastModifiedBy: string
    lastModifiedOn: 0
    pluginId: string
    rejected: true
    result:
      deviceType:
      - string
      hardwareManufacturer:
      - string
      hardwareModel:
      - string
      operatingSystem:
      - string
    ruleId: string
    ruleName: string
    rulePriority: 0
    ruleType: string
    ruleVersion: 0
    sourcePriority: 0
    usedAttributes:
    - string

- name: Delete by id
  cisco.dnac.endpoint_analytics_profiling_rules:
    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}}"
    state: absent
    ruleId: string

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"id": "string", "link": "string"}`

Авторы

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/dnac/endpoint_analytics_profiling_rules_module.html