Модуль cisco.dnac.reports – Модуль ресурсов для отчетов

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.reports.

Новый в cisco.dnac 3.1.0

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

Описание

Управление операциями создания и удаления ресурсов Отчетов.
Создание/планирование конфигурации отчета. Используйте API «Получить детали просмотра для заданной группы и представления» для получения метаданных, необходимых для настройки отчета.
Удаление запланированной конфигурации отчета. Также удаляются и исполнения отчетов.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dataCategory строка	Категория группы представлений для отчета.
deliveries список / элементы=словарь	Массив доступных каналов доставки.
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"`
name строка	Имя отчета.
reportId строка	Параметр пути ReportId. ReportId отчета.
schedule словарь	Расписание отчета.
tags список / элементы=строка	Массив тегов для отчета.
validate_response_schema логический	Флаг для Cisco DNA Center SDK для включения валидации запрошенных тел по схеме JSON. Варианты: `false` `true` ← (по умолчанию)
view словарь	Представление отчета.
fieldGroups список / элементы=словарь	Группы полей отчета.
fieldGroupDisplayName строка	Метка/имя отображения группы полей для пользователя.
fieldGroupName строка	Имя группы полей.
fields список / элементы=словарь	Поля отчета.
displayName строка	Метка/имя отображения поля.
name строка	Имя поля.
filters список / элементы=словарь	Фильтры отчета.
displayName строка	Метка/имя отображения фильтра.
name строка	Имя фильтра.
type строка	Тип фильтра.

END_OF_DOCUMENT_MARKER

значение словарь	Значение фильтра. Тип данных зависит от типа фильтра. Используйте определения фильтров из представления для получения вариантов фильтра.
формат словарь	Формат отчета.
типФормата строка	Тип формата отчета.
имя строка	Имя формата отчета.
имя строка	Имя представления.
idПредставления строка	Идентификатор представления.
idГруппыПредставлений строка	Идентификатор группы представлений для отчета.
версияГруппыПредставлений строка	Версия группы представлений для отчета.

Примечания

Примечание

Используемые методы SDK: reports.Reports.create_or_schedule_a_report, reports.Reports.delete_a_scheduled_report,
Используемые пути: post /dna/intent/api/v1/data/reports, delete /dna/intent/api/v1/data/reports/{reportId},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center по созданию или планированию отчета: Полное описание API CreateOrScheduleAReport.
Документация Cisco DNA Center по удалению запланированного отчета: Полное описание API DeleteAScheduledReport.

Примеры

- name: Create
  cisco.dnac.reports:
    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
    dataCategory: string
    deliveries:
    - {}
    name: string
    schedule: {}
    tags:
    - string
    view:
      fieldGroups:
      - fieldGroupDisplayName: string
        fieldGroupName: string
        fields:
        - displayName: string
          name: string
      filters:
      - displayName: string
        name: string
        type: string
        value: {}
      format:
        formatType: string
        name: string
      name: string
      viewId: string
    viewGroupId: string
    viewGroupVersion: string

- name: Delete by id
  cisco.dnac.reports:
    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
    reportId: string

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

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

Ключ	Описание
ответ_dnac словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращаемое значение: всегда Пример: {"dataCategory": "string", "deliveries": [{}], "executionCount": 0, "executions": [{"endTime": 0, "errors": ["string"], "executionId": "string", "processStatus": "string", "requestStatus": "string", "startTime": 0, "warnings": ["string"]}], "name": "string", "reportId": "string", "reportWasExecuted": true, "schedule": {}, "tags": ["string"], "view": {"description": "string", "fieldGroups": [{"fieldGroupDisplayName": "string", "fieldGroupName": "string", "fields": [{"displayName": "string", "name": "string"}]}], "filters": [{"displayName": "string", "name": "string", "type": "string", "value": {}}], "format": {"formatType": "string", "name": "string"}, "name": "string", "viewId": "string", "viewInfo": "string"}, "viewGroupId": "string", "viewGroupVersion": "string"}

Ключ

Описание

ответ_dnac

словарь

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

Возвращаемое значение: всегда

Пример: {"dataCategory": "string", "deliveries": [{}], "executionCount": 0, "executions": [{"endTime": 0, "errors": ["string"], "executionId": "string", "processStatus": "string", "requestStatus": "string", "startTime": 0, "warnings": ["string"]}], "name": "string", "reportId": "string", "reportWasExecuted": true, "schedule": {}, "tags": ["string"], "view": {"description": "string", "fieldGroups": [{"fieldGroupDisplayName": "string", "fieldGroupName": "string", "fields": [{"displayName": "string", "name": "string"}]}], "filters": [{"displayName": "string", "name": "string", "type": "string", "value": {}}], "format": {"formatType": "string", "name": "string"}, "name": "string", "viewId": "string", "viewInfo": "string"}, "viewGroupId": "string", "viewGroupVersion": "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/reports_module.html