Spec-Zone.ru › Ansible

Модуль cisco.dnac.configuration_template_import_template — Модуль ресурса для импорта шаблонов конфигурации

Примечание

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

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

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

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

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

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

Обзор

  • Управление операцией создания ресурса Шаблон импорта шаблона конфигурации.
  • Импортирует шаблоны, предоставленные в DTO по имени проекта.

Примечание

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

Требования

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

  • 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"

doVersion

boolean

Параметр запроса DoVersion. Если этот флаг имеет значение true, то создаётся новая версия шаблона с импортированным содержимым в случае, если шаблон уже существует. Если этот флаг имеет значение false и шаблон уже существует, то операция завершается ошибкой «Шаблон уже существует».

Варианты:

  • false
  • true

payload

list / элементы=словарь

Загрузка шаблона импорта конфигурационного шаблона.

author

string

Автор шаблона.

composite

boolean

Является ли это составным шаблоном.

Варианты:

  • false
  • true

containingTemplates

list / элементы=словарь

Включенные в шаблон импорта конфигурационных шаблонов.

composite

boolean

Является ли это составным шаблоном.

Варианты:

  • false
  • true

description

string

Описание шаблона.

deviceTypes

list / элементы=словарь

Типы устройств шаблона импорта конфигурационного шаблона.

productFamily

string

Семейство устройств.

productSeries

string

Серия устройств.

productType

string

Тип устройства.

id

string

UUID шаблона.

language

string

Язык шаблона (JINJA или VELOCITY).

name

string

Имя шаблона.

projectName

string

Имя проекта.
END_OF_DOCUMENT_MARKER

rollbackTemplateParams

list / elements=dictionary

Параметр rollbackTemplateParams для импорта шаблона конфигурации.

binding

string

Привязка к источнику.

customOrder

integer

CustomOrder параметра шаблона.

dataType

string

Тип данных параметра шаблона.

defaultValue

string

Значение по умолчанию параметра шаблона.

description

string

Описание параметра шаблона.

displayName

string

Отображаемое имя параметра.

group

string

Группа.

id

string

UUID параметра шаблона.

instructionText

string

Инструкции для параметра.

key

string

Ключ.

notParam

boolean

Не является ли переменной.

Варианты:

  • false
  • true

order

integer

Порядок параметра шаблона.

paramArray

boolean

Является ли массивом.

Варианты:

  • false
  • true

parameterName

string

Имя параметра шаблона.

provider

string

Провайдер.

range

list / elements=dictionary

Диапазон для импорта шаблона конфигурации.

id

string

UUID диапазона.

maxValue

integer

Максимальное значение диапазона.

minValue

integer

Минимальное значение диапазона.

required

boolean

Обязательный ли параметр.

Варианты:

  • false
  • true

selection

dictionary

Выбор для импорта шаблона конфигурации.

defaultSelectedValues

list / elements=string

Значения выбора по умолчанию.

id

string

UUID выбора.

selectionType

string

Тип выбора (SINGLE_SELECT или MULTI_SELECT).

selectionValues

dictionary

Значения выбора.

tags

list / elements=dictionary

Теги Configuration Template Import Template.

id

string

UUID тега.

name

string

Имя тега.

templateContent

string

Содержание шаблона.

templateParams

list / elements=dictionary

templateParams Configuration Template Import Template.

binding

string

Привязка к источнику.

customOrder

integer

CustomOrder параметра шаблона.

dataType

string

Тип данных параметра шаблона.

defaultValue

string

Значение по умолчанию параметра шаблона.

description

string

Описание параметра шаблона.

displayName

string

Отображаемое имя параметра.

group

string

Группа.

id

string

UUID параметра шаблона.

instructionText

string

Инструкции для параметра.

key

string

Ключ.

notParam

boolean

Не является ли переменной.

Варианты:

  • false
  • true

order

integer

Порядок параметра шаблона.

paramArray

boolean

Является ли массивом.

Варианты:

  • false
  • true

parameterName

string

Имя параметра шаблона.

provider

string

Провайдер.

range

list / elements=dictionary

Диапазон Configuration Template Import Template.

id

string

UUID диапазона.

maxValue

integer

Максимальное значение диапазона.

minValue

integer

Минимальное значение диапазона.

required

boolean

Является ли параметр обязательным.

Choices:

  • false
  • true

selection

dictionary

Выбор шаблона импорта шаблона конфигурации.

defaultSelectedValues

list / elements=string

Значения выбора по умолчанию.

id

string

UUID выбора.

selectionType

string

Тип выбора (SINGLE_SELECT или MULTI_SELECT).

selectionValues

dictionary

Значения выбора.

version

string

Текущая версия шаблона.

createTime

integer

Время создания шаблона.

customParamsOrder

boolean

Порядок пользовательских параметров.

Choices:

  • false
  • true

description

string

Описание шаблона.

deviceTypes

list / elements=dictionary

Типы устройств шаблона импорта шаблона конфигурации.

productFamily

string

Семейство устройств.

productSeries

string

Серия устройств.

productType

string

Тип устройства.

failurePolicy

string

Определите политику сбоя, если предоставление шаблона завершилось неудачей.

id

string

UUID шаблона.

language

string

Язык шаблона (JINJA или VELOCITY).

lastUpdateTime

integer

Время обновления шаблона.

latestVersionTime

integer

Время последней версии шаблона.

name

string

Имя шаблона.

parentTemplateId

string

ID родительского шаблона.

projectId

string

UUID проекта.

projectName

string

Название проекта.

rollbackTemplateContent

string

Содержание шаблона отката.

rollbackTemplateParams

list / elements=dictionary

Параметр rollbackTemplateParams для импорта шаблона конфигурации.

binding

string

Привязка к источнику.

customOrder

integer

CustomOrder параметра шаблона.

dataType

string

Тип данных параметра шаблона.

defaultValue

string

Значение по умолчанию параметра шаблона.

description

string

Описание параметра шаблона.

displayName

string

Отображаемое имя параметра.

group

string

Группа.

id

string

UUID параметра шаблона.

instructionText

string

Инструкции для параметра.

key

string

Ключ.

notParam

boolean

Не является переменной.

Варианты:

  • false
  • true

order

integer

Порядок параметра шаблона.

paramArray

boolean

Является ли массивом.

Варианты:

  • false
  • true

parameterName

string

Имя параметра шаблона.

provider

string

Провайдер.

range

list / elements=dictionary

Диапазон для импорта шаблона конфигурации.

id

string

UUID диапазона.

maxValue

integer

Максимальное значение диапазона.

minValue

integer

Минимальное значение диапазона.

required

boolean

Обязательный ли параметр.

Варианты:

  • false
  • true

selection

dictionary

Выбор для импорта шаблона конфигурации.

defaultSelectedValues

list / elements=string

Значения выбора по умолчанию.

id

string

UUID выбора.

selectionType

string

Тип выбора (SINGLE_SELECT или MULTI_SELECT).

selectionValues

dictionary

Значения выбора.

softwareType

string

Применимый тип программного обеспечения устройства.

softwareVariant

string

Применимый вариант программного обеспечения устройства.

softwareVersion

string

Применимая версия программного обеспечения устройства.

tags

list / elements=dictionary

Теги шаблона импорта конфигурации.

id

string

UUID тега.

name

string

Имя тега.

templateContent

string

Содержимое шаблона.

templateParams

list / elements=dictionary

Параметры шаблона импорта конфигурации.

binding

string

Привязка к источнику.

customOrder

integer

CustomOrder параметра шаблона.

dataType

string

Тип данных параметра шаблона.

defaultValue

string

Значение по умолчанию параметра шаблона.

description

string

Описание параметра шаблона.

displayName

string

Отображаемое имя параметра.

group

string

Группа.

id

string

UUID параметра шаблона.

instructionText

string

Инструкции для параметра.

key

string

Ключ.

notParam

boolean

Не является переменной.

Варианты:

  • false
  • true

order

integer

Порядок параметра шаблона.

paramArray

boolean

Является ли массивом.

Варианты:

  • false
  • true

parameterName

string

Имя параметра шаблона.

provider

string

Провайдер.

range

list / elements=dictionary

Диапазон шаблона импорта конфигурации.

id

string

UUID диапазона.

maxValue

integer

Максимальное значение диапазона.

minValue

integer

Минимальное значение диапазона.

required

boolean

Является ли параметр обязательным.

Варианты:

  • false
  • true

selection

dictionary

Выбор шаблона импорта конфигурации.

defaultSelectedValues

list / elements=string

Значения выбора по умолчанию.

id

string

UUID выбора.

selectionType

string

Тип выбора (SINGLE_SELECT или MULTI_SELECT).

selectionValues

dictionary

Значения выбора.

validationErrors

dictionary

Ошибка валидации шаблона импорта конфигурации.

rollbackTemplateErrors

dictionary

Ошибки валидации или конфликты дизайна шаблона отката.

templateErrors

dictionary

Ошибки валидации или конфликты дизайна.

templateId

string

UUID шаблона.

templateVersion

string

Текущая версия шаблона.

version

string

Текущая версия шаблона.

projectName

string

Параметр пути projectName. Имя проекта, под которым создать шаблон.

validate_response_schema

boolean

Флаг для Cisco DNA Center SDK, чтобы включить валидацию тел запросов по схеме JSON.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Используемый метод SDK — configuration_templates.ConfigurationTemplates.imports_the_templates_provided,
  • Используемые пути — post /dna/intent/api/v1/template-programmer/project/name/{projectName}/template/importtemplates,
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

Документация Cisco DNA Center по Configuration Templates ImportsTheTemplatesProvided

Полная справка по API ImportsTheTemplatesProvided.

Примеры

- name: Create
  cisco.dnac.configuration_template_import_template:
    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}}"
    doVersion: true
    payload:
    - author: string
      composite: true
      containingTemplates:
      - composite: true
        description: string
        deviceTypes:
        - productFamily: string
          productSeries: string
          productType: string
        id: string
        language: string
        name: string
        projectName: string
        rollbackTemplateParams:
        - binding: string
          customOrder: 0
          dataType: string
          defaultValue: string
          description: string
          displayName: string
          group: string
          id: string
          instructionText: string
          key: string
          notParam: true
          order: 0
          paramArray: true
          parameterName: string
          provider: string
          range:
          - id: string
            maxValue: 0
            minValue: 0
          required: true
          selection:
            defaultSelectedValues:
            - string
            id: string
            selectionType: string
            selectionValues: {}
        tags:
        - id: string
          name: string
        templateContent: string
        templateParams:
        - binding: string
          customOrder: 0
          dataType: string
          defaultValue: string
          description: string
          displayName: string
          group: string
          id: string
          instructionText: string
          key: string
          notParam: true
          order: 0
          paramArray: true
          parameterName: string
          provider: string
          range:
          - id: string
            maxValue: 0
            minValue: 0
          required: true
          selection:
            defaultSelectedValues:
            - string
            id: string
            selectionType: string
            selectionValues: {}
        version: string
      createTime: 0
      customParamsOrder: true
      description: string
      deviceTypes:
      - productFamily: string
        productSeries: string
        productType: string
      failurePolicy: string
      id: string
      language: string
      lastUpdateTime: 0
      latestVersionTime: 0
      name: string
      parentTemplateId: string
      projectId: string
      projectName: string
      rollbackTemplateContent: string
      rollbackTemplateParams:
      - binding: string
        customOrder: 0
        dataType: string
        defaultValue: string
        description: string
        displayName: string
        group: string
        id: string
        instructionText: string
        key: string
        notParam: true
        order: 0
        paramArray: true
        parameterName: string
        provider: string
        range:
        - id: string
          maxValue: 0
          minValue: 0
        required: true
        selection:
          defaultSelectedValues:
          - string
          id: string
          selectionType: string
          selectionValues: {}
      softwareType: string
      softwareVariant: string
      softwareVersion: string
      tags:
      - id: string
        name: string
      templateContent: string
      templateParams:
      - binding: string
        customOrder: 0
        dataType: string
        defaultValue: string
        description: string
        displayName: string
        group: string
        id: string
        instructionText: string
        key: string
        notParam: true
        order: 0
        paramArray: true
        parameterName: string
        provider: string
        range:
        - id: string
          maxValue: 0
          minValue: 0
        required: true
        selection:
          defaultSelectedValues:
          - string
          id: string
          selectionType: string
          selectionValues: {}
      validationErrors:
        rollbackTemplateErrors: {}
        templateErrors: {}
        templateId: string
        templateVersion: string
      version: string
    projectName: string

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

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

Ключ

Описание

dnac_response

dictionary

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

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "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_import_template_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API