Модуль cisco.dnac.reports_view_group_info – Информационный модуль для группы отчётов

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.dnac.reports_view_group_info.

Впервые появился в cisco.dnac 3.1.0

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

Описание

Получить все группы отчётов.
Получить группу отчётов по идентификатору.
Получить список сводных данных всех групп представлений.
Получить список сводных данных всех представлений в группе представлений. Используйте API «Получить все группы представлений», чтобы получить viewGroupIds, необходимые в качестве параметра запроса для этого API для доступных групп представлений.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK, чтобы включить отладку. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers dictionary	Дополнительные заголовки.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, чтобы включить проверку тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)
viewGroupId string	Параметр пути viewGroupId. Идентификатор viewgroup.

Примечания

Примечание

Используемые методы SDK: reports.Reports.get_all_view_groups, reports.Reports.get_views_for_a_given_view_group
Используемые пути: get /dna/intent/api/v1/data/view-groups, get /dna/intent/api/v1/data/view-groups/{viewGroupId}
Поддерживает check_mode
Плагин работает на узле управления и не использует никаких плагинов подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для создания подключения

См. также

Документация Cisco DNA Center для Reports GetAllViewGroups: Полное руководство по API GetAllViewGroups.
Документация Cisco DNA Center для Reports GetViewsForAGivenViewGroup: Полное руководство по API GetViewsForAGivenViewGroup.

Примеры

- name: Get all Reports View Group
  cisco.dnac.reports_view_group_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: "{{my_headers | from_json}}"
  register: result

- name: Get Reports View Group by id
  cisco.dnac.reports_view_group_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: "{{my_headers | from_json}}"
    viewGroupId: string
  register: result

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

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

Ключ	Описание
dnac_response dictionary	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращаемое значение: всегда Пример: `{"viewGroupId": "string", "views": [{"description": "string", "viewId": "string", "viewName": "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_view_group_info_module.html