Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Новая версия в cisco.dnac 3.1.0

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

Описание

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

Примечание

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

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.5

Параметры

Параметр

Комментарии

автор

строка

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

составной

логическое

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

Выбор:

  • false
  • true

containingTemplates

список / элементы=словарь

Шаблон конфигурации containingTemplates.

составной

логическое

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

Выбор:

  • false
  • true

описание

строка

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

deviceTypes

список / элементы=словарь

Шаблон конфигурации deviceTypes.

productFamily

строка

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

productSeries

строка

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

productType

строка

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

id

строка

UUID шаблона.

язык

строка

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

название

строка

Название шаблона.

projectName

строка

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

rollbackTemplateParams

список / элементы=словарь

Шаблон конфигурации rollbackTemplateParams.

binding

строка

Связь с источником.

customOrder

целое число

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

dataType

строка

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

defaultValue

строка

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

описание

строка

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

displayName

строка

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

группа

строка

Группа.

id

строка

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

instructionText

строка

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

ключ

строка

Ключ.

notParam

логическое

Это не переменная.

Выбор:

  • false
  • true
END_OF_DOCUMENT_MARKER

Порядок

целое число

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

paramArray

логическое

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

Варианты:

  • false
  • true

Имя параметра

строка

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

Поставщик

строка

Поставщик.

Диапазон

список / элементы=словарь

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

Идентификатор

строка

UUID диапазона.

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

целое число

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

Минимальное значение

целое число

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

Обязательный

логическое

Требуется ли параметр.

Варианты:

  • false
  • true

Выбор

словарь

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

Значения по умолчанию

список / элементы=строка

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

Идентификатор

строка

UUID выбора.

Тип выбора

строка

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

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

словарь

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

Теги

список / элементы=словарь

Теги модуля создания шаблона конфигурации.

Идентификатор

строка

UUID тега.

Имя

строка

Имя тега.

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

строка

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

templateParams

список / элементы=словарь

templateParams модуля создания шаблона конфигурации.

Связывание

строка

Связывание с источником.

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

целое число

Пользовательский порядок параметра шаблона.

Тип данных

строка

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

Значение по умолчанию

строка

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

Описание

строка

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

Имя для отображения

строка

Имя параметра для отображения.

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

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

version

string

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

createTime

integer

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

customParamsOrder

boolean

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

Варианты:

  • false
  • true

description

string

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

deviceTypes

list / elements=dictionary

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

productFamily

string

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

productSeries

string

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

productType

string

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

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"

failurePolicy

string

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

id

string

UUID шаблона.

language

string

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

lastUpdateTime

integer

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

latestVersionTime

integer

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

name

string

Название шаблона.

parentTemplateId

string

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

projectId

string

UUID проекта.

projectName

string

Имя проекта.

rollbackTemplateContent

string

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

rollbackTemplateParams

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

rollbackTemplateParams модуля Configuration Template Create.

binding

string

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

customOrder

integer

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

dataType

string

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

defaultValue

string

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

description

string

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

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

список / элементы=словарь

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

binding

строка

Связь с источником.

customOrder

целое число

Пользовательский порядок параметра шаблона.

dataType

строка

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

defaultValue

строка

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

description

строка

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

displayName

строка

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

group

строка

Группа.

id

строка

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

instructionText

строка

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

key

строка

Ключ.

notParam

булево

Это не переменная?

Варианты:

  • false
  • true

order

целое число

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

paramArray

булево

Это массив?

Варианты:

  • false
  • true

parameterName

строка

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

provider

строка

Поставщик.

range

список / элементы=словарь

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

id

строка

UUID диапазона.

maxValue

целое число

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

minValue

целое число

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

required

булево

Параметр обязателен?

Варианты:

  • false
  • true

selection

словарь

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

defaultSelectedValues

список / элементы=строка

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

id

строка

UUID выбора.

selectionType

строка

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

selectionValues

словарь

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

validate_response_schema

булево

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

Варианты:

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

validationErrors

словарь

validationErrors модуля Создание шаблона конфигурации.

rollbackTemplateErrors

словарь

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

templateErrors

словарь

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

templateId

строка

UUID шаблона.

templateVersion

строка

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

version

строка

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

Примечания

Примечание

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

См. также

См. также

Документация Cisco DNA Center по шаблонам конфигурации CreateTemplate

Полное описание API CreateTemplate.

Примеры

- name: Create
  cisco.dnac.configuration_template_create:
    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}}"
    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

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

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

Ключ

Описание

dnac_response

словарь

Словарь или список с ответом, возвращаемым 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_create_module.html

Spec-Zone.ru

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