Модуль cisco.dnac.configuration_template_deploy – Модуль ресурсов для развертывания шаблонов конфигурации

Примечание

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

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

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

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

Новая функция в cisco.dnac 3.1.0

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

Обзор

Управление операцией создания ресурса Развертывание шаблона конфигурации.
API для развертывания шаблона.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
forcePushTemplate boolean	Флаг ForcePushTemplate. Варианты: `false` `true`
isComposite boolean	Флаг составного шаблона. Варианты: `false` `true`
mainTemplateId string	Основной UUID шаблона для шаблона с версиями.
memberTemplateDeploymentInfo list / elements=dictionary	MemberTemplateDeploymentInfo.
targetInfo list / elements=dictionary	targetInfo для развёртывания шаблона конфигурации.
hostName string	Имя хоста устройства обязательно, если targetType — MANAGED_DEVICE_HOSTNAME.
id string	UUID целевого объекта обязателен, если targetType — MANAGED_DEVICE_UUID.
params dictionary	Параметры/значения шаблона для подготовки.
resourceParams list / elements=dictionary	Параметры ресурсов для подготовки. Подробности использования см. на странице функций.
type string	Тип целевого устройства.
versionedTemplateId string	UUID шаблона с версиями для подготовки.
templateId string	UUID шаблона для подготовки.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (default)

Примечания

Примечание

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

См. также

Документация Cisco DNA Center по развёртыванию шаблонов конфигурации DeployTemplate: Полная справка по API DeployTemplate.

Примеры

- name: Create
  cisco.dnac.configuration_template_deploy:
    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}}"
    forcePushTemplate: true
    isComposite: true
    mainTemplateId: string
    memberTemplateDeploymentInfo:
    - {}
    targetInfo:
    - hostName: string
      id: string
      params: {}
      resourceParams:
      - {}
      type: string
      versionedTemplateId: string
    templateId: string

Значения возврата

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"deploymentId": "string", "deploymentName": "string", "devices": [{"detailedStatusMessage": "string", "deviceId": "string", "duration": "string", "endTime": "string", "identifier": "string", "ipAddress": "string", "name": "string", "startTime": "string", "status": "string", "targetType": "string"}], "duration": "string", "endTime": "string", "projectName": "string", "startTime": "string", "status": "string", "statusMessage": "string", "templateName": "string", "templateVersion": "string"}`

Ключ

Описание

dnac_response

словарь

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

Возвращается: всегда

Пример: {"deploymentId": "string", "deploymentName": "string", "devices": [{"detailedStatusMessage": "string", "deviceId": "string", "duration": "string", "endTime": "string", "identifier": "string", "ipAddress": "string", "name": "string", "startTime": "string", "status": "string", "targetType": "string"}], "duration": "string", "endTime": "string", "projectName": "string", "startTime": "string", "status": "string", "statusMessage": "string", "templateName": "string", "templateVersion": "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/configuration_template_deploy_module.html