Spec-Zone.ru › Ansible

Модуль cisco.dnac.configuration_template – Модуль ресурса Шаблон конфигурации

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.configuration_template.

Добавлен в cisco.dnac 3.1.0

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

Описание

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

Примечание

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

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.5

Параметры

Параметр

Комментарии

author

string

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

composite

boolean

Это составной шаблон.

Варианты:

  • false
  • true

containingTemplates

list / elements=dictionary

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

composite

boolean

Это составной шаблон.

Варианты:

  • false
  • true

description

string

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

deviceTypes

list / elements=dictionary

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

productFamily

string

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

productSeries

string

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

productType

string

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

id

string

UUID шаблона.

language

string

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

name

string

Имя шаблона.

projectName

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

Это массив.

Choices:

  • false
  • true

parameterName

string

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

provider

string

Провайдер.

range

list / elements=dictionary

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

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

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

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

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

version

string

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

createTime

integer

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

customParamsOrder

boolean

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

Варианты:

  • false
  • true

description

string

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

deviceTypes

list / elements=dictionary

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

productFamily

string

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

productSeries

string

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

productType

string

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

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 / elements=dictionary

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

binding

string

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

customOrder

integer

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

dataType

string

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

defaultValue

string

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

description

string

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

displayName

string

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

group

string

Группа.

id

string

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

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

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

templateId

string

Параметр пути templateId. templateId (UUID) удаляемого шаблона.

templateParams

list / elements=dictionary

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

binding

string

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

customOrder

integer

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

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

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

validate_response_schema

boolean

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

Варианты:

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

validationErrors

dictionary

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

rollbackTemplateErrors

dictionary

Ошибки проверки или конфликты в структуре шаблона отката.

templateErrors

dictionary

Ошибки проверки или конфликты структуры шаблона.

templateId

string

UUID шаблона.

templateVersion

string

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

version

string

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

Примечания

Примечание

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

См. также

См. также

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

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

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

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

Примеры

- name: Update all
  cisco.dnac.configuration_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}}"
    state: present
    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

- name: Delete by id
  cisco.dnac.configuration_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}}"
    state: absent
    templateId: 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_module.html

Spec-Zone.ru

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