Модуль cisco.dnac.template_preview – Модуль ресурса для предварительного просмотра шаблона

Примечание

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

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

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

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

Новая в cisco.dnac 3.1.0

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

Обзор

Управление обновлением операции ресурса Предварительный просмотр шаблона.
API для предварительного просмотра шаблона.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
deviceId строка	UUID устройства для получения предварительного просмотра шаблона.
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"`
params словарь	Параметры для рендеринга предварительного просмотра.
resourceParams словарь	Параметры ресурса для рендеринга предварительного просмотра.
templateId строка	UUID шаблона для получения предварительного просмотра шаблона.
validate_response_schema логическое значение	Флаг для Cisco DNA Center SDK для включения валидации тел запросов по JSON-схеме. Выбираемые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: configuration_templates.ConfigurationTemplates.preview_template,
Используемые пути: put /dna/intent/api/v1/template-programmer/template/preview,
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются SDK Cisco DNAC Python для установления соединения

См. также

Документация Cisco DNA Center для предварительного просмотра шаблонов конфигурации: Полное описание API PreviewTemplate.

Примеры

- name: Update all
  cisco.dnac.template_preview:
    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}}"
    deviceId: string
    params: {}
    resourceParams: {}
    templateId: string

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

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

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

Авторы

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/template_preview_module.html