Модуль cisco.dnac.template_workflow_manager – Модуль ресурсов для функций шаблонов

config

list / elements=dictionary / required

Список подробных сведений об управляемых шаблонах.

configuration_templates

dictionary

Выполнение операций, таких как создание/обновление/удаление шаблона.

author

string

Указывает создателя шаблона.

composite

boolean

Указывает, является ли шаблон составным.

Варианты:

• false
• true

containing_templates

list / elements=dictionary

Ссылка на набор шаблонов в основном шаблоне для определения более сложных или модульных конфигураций.

Это особенно полезно в системах, которые поддерживают иерархические или вложенные шаблоны.

Здесь родительские шаблоны могут содержать дочерние шаблоны для формирования полной конфигурации.

composite

boolean

Указывает, является ли шаблон составным.

Варианты:

• false
• true

description

string

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

device_types

list / elements=dictionary

Список словарей, содержащих подробные сведения о типах устройств, к которым можно применять шаблоны.

product_family

string

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

Варианты:

• "Cisco Cloud Services Platform"
• "Cisco Interfaces and Modules"
• "Content Networking"
• "Network Management"
• "NFV-ThirdParty Devices"
• "NFVIS"
• "Routers"
• "Security and VPN"
• "Storage Networking"
• "Switches and Hubs"
• "Voice and Telephony"
• "Wireless Controller"

product_series

string

Указывает серию классификации устройства.

product_type

string

Описание точного типа устройства.

id

string

Уникальный идентификатор шаблона, представленный в виде UUID.

language

string

Язык программирования, используемый для создания шаблонов. Варианты: «JINJA» для шаблонизации Jinja или «VELOCITY» для Apache Velocity.

Варианты:

• "JINJA"
• "VELOCITY"

name

string

Обозначение шаблона, служащее его уникальным именем.

project_description

string

Повествование, которое подробно описывает цель и область проекта.

project_name

string

Название проекта, в котором классифицируется и управляется шаблон.

tags

list / elements=dictionary

Список словарей, представляющих теги, связанные с шаблоном конфигурации во время создания.

id

string

Уникальный идентификатор для каждого тега, представленный в виде UUID.

name

string

Описание метки или имени, назначенного тегу.

template_content

string

Фактический сценарий или код, составляющий тело шаблона.

template_params

list / elements=dictionary

Настройка содержимого внутри шаблона.

binding

string

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

custom_order

integer

Задает порядок параметров, определяемый пользователем.

data_type

string

Определяет тип данных параметра (например, строка, целое число, логическое значение).

default_value

string

Устанавливает значение по умолчанию для параметра, используемое, если не указано другое значение.

description

string

Предоставляет описательное пояснение цели параметра.

display_name

string

Имя параметра, отображаемое пользователям.

group

string

Категоризирует параметр в именованную группу в организационных целях.

id

string

Уникальный идентификатор параметра, оформленный как UUID.

instruction_text

string

Дает инструкции по использованию параметра.

key

string

Уникальный ключ, идентифицирующий параметр в шаблоне.

not_param

boolean

Указывает, следует ли рассматривать запись как параметр.

Варианты:

• false
• true

order

integer

Определяет порядок следования параметра относительно других.

param_array

boolean

Указывает, следует ли рассматривать параметр как массив.

Варианты:

• false
• true

parameter_name

string

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

provider

string

Обозначает провайдера, связанного с параметром.

range

list / elements=dictionary

Определяет допустимый диапазон значений параметра.

id

string

Уникальный идентификатор диапазона, представленный как UUID.

max_value

integer

Указывает максимально допустимое значение параметра.

min_value

integer

Указывает минимально допустимое значение параметра.

required

boolean

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

Варианты:

• false
• true

selection

dictionary

Содержит параметры выбора параметра, когда доступен выбор.

default_selected_values

list / elements=string

Перечисляет значения по умолчанию, которые предварительно выбраны.

id

string

Уникальный идентификатор сущности выбора, представленный в виде UUID.

selection_type

string

Указывает тип выбора, например, «SINGLE_SELECT» или «MULTI_SELECT».

selection_values

dictionary

Словарь доступных значений для выбора.

version

string

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

custom_params_order

boolean

Задает порядок, в котором пользовательские параметры или переменные должны быть расположены в шаблоне.

Choices:

• false
• true

device_types

list / elements=dictionary

Список словарей, описывающих типы устройств, к которым можно применить шаблоны.

product_family

string

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

Choices:

• "Cisco Cloud Services Platform"
• "Cisco Interfaces and Modules"
• "Content Networking"
• "Network Management"
• "NFV-ThirdParty Devices"
• "NFVIS"
• "Routers"
• "Security and VPN"
• "Storage Networking"
• "Switches and Hubs"
• "Voice and Telephony"
• "Wireless Controller"

product_series

string

Указывает классификацию серии устройства.

product_type

string

Описывает точный тип устройства.

failure_policy

string

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

failure_policy будет включен только тогда, когда composite установлен в True.

Choices:

• "ABORT_TARGET_ON_ERROR"

id

string

Уникальный идентификатор, представленный в виде UUID.

language

string

Язык программирования, используемый для создания шаблонов. Варианты: «JINJA» для шаблонизации Jinja или «VELOCITY» для Apache Velocity.

Choices:

• "JINJA"
• "VELOCITY"

project_description

string

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

project_name

string

Название проекта, в котором классифицируется и управляется шаблон.

software_type

string

Применимый тип программного обеспечения устройства. Это поле обязательно для создания нового шаблона.

Choices:

• "IOS"
• "IOS-XE"
• "IOS-XR"
• "NX-OS"
• "Cisco Controller"
• "Wide Area Application Services"
• "Adaptive Security Appliance"
• "NFV-OS"
• "Others"

software_version

string

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

template_content

string

Фактический скрипт или код, составляющий тело шаблона.

template_description

string

Предоставляет обзор шаблона.

template_name

string

Название шаблона. Это поле обязательно для создания нового шаблона.

template_params

list / elements=dictionary

Настройка содержимого внутри шаблона.

binding

string

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

custom_order

целое число

Указывает пользовательское упорядочение параметра.

data_type

строка

Определяет тип данных параметра (например, строка, целое число, логическое значение).

default_value

строка

Устанавливает значение по умолчанию для параметра, используемое, если другое значение не предоставлено.

description

строка

Предоставляет описательное объяснение назначения параметра.

display_name

строка

Название параметра, отображаемое пользователям.

group

строка

Размещает параметр в именованную группу для организационных целей.

id

строка

Уникальный идентификатор параметра, отформатированный как UUID.

instruction_text

строка

Предоставляет руководство или инструкции по использованию параметра.

key

строка

Уникальный ключ, идентифицирующий параметр в шаблоне.

not_param

логическое значение

Указывает, что запись не должна рассматриваться как параметр.

Варианты:

• false
• true

order

целое число

Определяет последовательность, в которой параметр отображается относительно других.

param_array

логическое значение

Указывает, следует ли рассматривать параметр как массив.

Варианты:

• false
• true

parameter_name

строка

Название параметра.

provider

строка

Указывает поставщика, связанного с параметром.

range

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

Определяет допустимый диапазон значений параметра.

id

строка

Уникальный идентификатор диапазона, представленный в виде UUID.

max_value

целое число

Указывает максимальное допустимое значение для параметра.

min_value

целое число

Указывает минимальное допустимое значение для параметра.

required

логическое значение

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

Варианты:

• false
• true

selection

словарь

Содержит параметры для выбора параметра, когда доступен выбор.

default_selected_values

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

Перечисляет значения по умолчанию, которые предварительно выбраны.

id

строка

Уникальный идентификатор сущности выбора, представленный в виде UUID.

selection_type

строка

Указывает тип выбора, такой как «SINGLE_SELECT» или «MULTI_SELECT».

selection_values

dictionary

Словарь доступных значений для выбора.

template_tag

list / elements=dictionary

Ссылка на ключевое слово, метку или метаданные, назначенные шаблону.

id

string

Уникальный идентификатор тега, представленный в виде UUID.

name

string

Название тега.

version

string

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

version_description

string

Комментарии к версии шаблона.

export

dictionary

Выполнить экспорт проектов и шаблонов.

project

list / elements=string

Экспорт данных проекта(ов).

template

list / elements=dictionary

Экспорт данных шаблона(ов).

project_name

string

Имя проекта, в котором доступен шаблон.

template_name

string

Имя шаблона, который необходимо экспортировать.

import

dictionary

Выполнить импорт проектов и шаблонов.

project

dictionary

Импорт проектов.

do_version

boolean

Определяет, следует ли создавать новую версию проекта с импортированным содержимым.

Если установлено значение true и проект уже существует, будет создана новая версия.

Если false, операция завершится с ошибкой «Проект уже существует», если проект уже существует.

Choices:

• false
• true

payload

list / elements=dictionary

Непосредственно импортирует данные конфигурации в систему с использованием предоставленного полезного груза.

Предлагает альтернативу «project_file» для импорта конфигураций без ссылки на внешний файл.

Игнорируется, если также предоставлен «project_file».

name

string

Имя проекта для импорта.

project_file

string

added in cisco.dnac 6.17.0

Указывает путь к JSON-файлу, содержащему конфигурацию импорта проекта.

Если предоставлены как «project_file», так и «payload», приоритет будет отдан «project_file».

template

dictionary

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

do_version

boolean

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

Choices:

• false
• true

payload

list / elements=dictionary

Параметр полезной нагрузки используется для непосредственного импорта данных конфигурации в систему.

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

Если предоставлены как «template_file», так и «payload», приоритет будет отдан «template_file».

author

string

Идентифицирует создателя шаблона.

composite

boolean

Указывает, является ли шаблон составным.

Choices:

• false
• true

containing_templates

list / elements=dictionary

Ссылка на набор шаблонов в основном шаблоне для определения более сложных или модульных конфигураций.

Это особенно полезно в системах, которые поддерживают иерархические или вложенные шаблоны.

Здесь родительские шаблоны могут содержать дочерние шаблоны для формирования полной конфигурации.

composite

boolean

Указывает, является ли шаблон составным.

Choices:

• false
• true

description

string

Предоставляет описание шаблона.

device_types

list / elements=dictionary

Список словарей, описывающий типы устройств, к которым можно применить шаблоны.

product_family

string

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

Choices:

• "Cisco Cloud Services Platform"
• "Cisco Interfaces and Modules"
• "Content Networking"
• "Network Management"
• "NFV-ThirdParty Devices"
• "NFVIS"
• "Routers"
• "Security and VPN"
• "Storage Networking"
• "Switches and Hubs"
• "Voice and Telephony"
• "Wireless Controller"

product_series

string

Указывает классификацию серии устройства.

product_type

string

Описывает точный тип устройства.

id

string

Уникальный идентификатор шаблона, представленный в виде UUID.

language

string

Язык программирования, используемый для создания шаблонов. Варианты: «JINJA» для шаблонизации Jinja или «VELOCITY» для Apache Velocity.

Choices:

• "JINJA"
• "VELOCITY"

name

string

Обозначение шаблона, служащее его уникальным именем.

project_name

string

Название проекта, в котором классифицируется и управляется шаблон.

tags

list / elements=dictionary

Список словарей, представляющих теги, связанные с шаблоном конфигурации во время создания.

id

string

Уникальный идентификатор для каждого тега, представленный в виде UUID.

name

string

Описание метки или имени, присвоенного тегу.

template_content

string

Фактический скрипт или код, составляющий тело шаблона.

template_params

list / elements=dictionary

Настройка содержимого внутри шаблона.

binding

string

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

custom_order

integer

Указывает порядок, заданный пользователем, для параметра.

data_type

string

Идентифицирует тип данных параметра (например, строка, целое число, логическое значение).

default_value

string

Устанавливает значение по умолчанию для параметра, используемое, если не указано другое значение.

description

string

Предоставляет описательное объяснение цели параметра.

display_name

string

Имя параметра, отображаемое пользователям.

group

string

Категоризирует параметр в именованную группу в организационных целях.

id

string

Уникальный идентификатор параметра, отформатированный как UUID.

instruction_text

string

Предоставляет рекомендации или инструкции по использованию параметра.

key

string

Уникальный ключ, идентифицирующий параметр в шаблоне.

not_param

boolean

Указывает, следует ли рассматривать запись как параметр.

Choices:

• false
• true

order

integer

Определяет последовательность, в которой параметр отображается относительно других.

param_array

boolean

Указывает, следует ли рассматривать параметр как массив.

Choices:

• false
• true

parameter_name

string

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

provider

string

Обозначает провайдера, связанного с параметром.

range

list / elements=dictionary

Определяет допустимый диапазон значений параметра.

id

string

Уникальный идентификатор диапазона, представленный как UUID.

max_value

integer

Указывает максимальное допустимое значение параметра.

min_value

integer

Указывает минимальное допустимое значение параметра.

required

boolean

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

Choices:

• false
• true

selection

dictionary

Содержит параметры выбора параметра, когда доступен выбор.

default_selected_values

list / elements=string

Перечисляет значения по умолчанию, которые предварительно выбраны.

id

string

Уникальный идентификатор сущности выбора, представленный как UUID.

selection_type

string

Указывает тип выбора, например, «SINGLE_SELECT» или «MULTI_SELECT».

selection_values

dictionary

Словарь доступных значений для выбора.

version

string

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

custom_params_order

boolean

Указывает последовательность, в которой пользовательские параметры или переменные должны быть расположены в шаблоне.

Choices:

• false
• true

device_types

list / elements=dictionary

Список словарей, детализирующих типы устройств, к которым могут применяться шаблоны.

product_family

string

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

Choices:

• "Cisco Cloud Services Platform"
• "Cisco Interfaces and Modules"
• "Content Networking"
• "Network Management"
• "NFV-ThirdParty Devices"
• "NFVIS"
• "Routers"
• "Security and VPN"
• "Storage Networking"
• "Switches and Hubs"
• "Voice and Telephony"
• "Wireless Controller"

product_series

string

Указывает классификацию серии устройства.

product_type

string

Описывает точный тип устройства.

failure_policy

string

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

failure_policy будет включен только тогда, когда composite установлено в True.

Choices:

• "ABORT_TARGET_ON_ERROR"

id

string

Уникальный идентификатор, представленный в виде UUID.

language

string

Язык программирования, используемый для создания шаблонов. Варианты: «JINJA» для шаблонизации Jinja или «VELOCITY» для Apache Velocity.

Choices:

• "JINJA"
• "VELOCITY"

project_description

string

Описание, которое подробно объясняет цель и объем проекта.

project_name

string

Название проекта, в котором классифицируется и управляется шаблон.

software_type

string

Применимый тип программного обеспечения устройства. Это поле обязательно для создания нового шаблона.

Choices:

• "IOS"
• "IOS-XE"
• "IOS-XR"
• "NX-OS"
• "Cisco Controller"
• "Wide Area Application Services"
• "Adaptive Security Appliance"
• "NFV-OS"
• "Others"

software_version

string

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

template_content

string

Фактический сценарий или код, составляющий тело шаблона.

template_description

string

Предоставляет обзор шаблона.

template_name

string

Название шаблона. Это поле обязательно для создания нового шаблона.

template_params

list / elements=dictionary

Настройка содержимого внутри шаблона.

binding

string

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

custom_order

integer

Указывает порядок, заданный пользователем, для параметра.

data_type

string

Идентифицирует тип данных параметра (например, строка, целое число, логическое значение).

default_value

string

Устанавливает значение по умолчанию для параметра, используемое, если не указано другое значение.

description

string

Предоставляет описательное объяснение цели параметра.

display_name

string

Имя параметра, отображаемое пользователям.

group

string

Классифицирует параметр в именованную группу в организационных целях.

id

string

Уникальный идентификатор параметра, оформленный как UUID.

instruction_text

string

Предоставляет руководство или инструкции по использованию параметра.

key

string

Уникальный ключ, идентифицирующий параметр в шаблоне.

not_param

boolean

Указывает, следует ли рассматривать запись не как параметр.

Варианты:

• false
• true

order

integer

Определяет последовательность, в которой параметр отображается относительно других.

param_array

boolean

Указывает, следует ли рассматривать параметр как массив.

Варианты:

• false
• true

parameter_name

string

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

provider

string

Обозначает поставщика, связанного с параметром.

range

list / elements=dictionary

Определяет допустимый диапазон значений параметра.

id

string

Уникальный идентификатор диапазона, представленный как UUID.

max_value

integer

Указывает максимально допустимое значение параметра.

min_value

integer

Указывает минимально допустимое значение параметра.

required

boolean

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

Варианты:

• false
• true

selection

dictionary

Содержит параметры выбора параметра, когда доступен выбор.

default_selected_values

list / elements=string

Перечисляет значения по умолчанию, которые предварительно выбраны.

id

string

Уникальный идентификатор сущности выбора, представленный как UUID.

selection_type

string

Указывает тип выбора, например, «SINGLE_SELECT» или «MULTI_SELECT».

selection_values

dictionary

Словарь доступных значений для выбора.

template_tag

list / elements=dictionary

Ссылка на ключевое слово, метку или метаданные, назначенные шаблону.

id

string

Уникальный идентификатор тега, представленный как UUID.

name

string

Имя тега.

version

string

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

project_name

string

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

template_file

string

Указывает путь к файлу JSON, содержащему шаблон импорта.

Если заданы оба параметра ‘template_file’ и ‘payload’, приоритет будет у ‘template_file’.

config_verify

boolean

Установите в значение True для проверки Cisco Catalyst Center после применения конфигурации playbook.

Варианты:

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

dnac_api_task_timeout

integer

Определяет таймаут в секундах для API-запросов получения деталей задачи. Если данные о задаче не получены в течение этого времени, процесс завершится, и о таймауте будет записано уведомление.

По умолчанию: 1200

dnac_debug

boolean

Указывает, включен ли режим отладки в Cisco Catalyst Center SDK.

Варианты:

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

dnac_host

string / обязательно

Имя хоста Cisco Catalyst Center.

dnac_log

boolean

Флаг для включения/выключения ведения журнала выполнения playbook.

При true и указанном dnac_log_file_path: - Создает файл журнала в текущем месте выполнения с указанным именем.

При true и не указанном dnac_log_file_path: - Создает файл журнала в текущем месте выполнения с именем ‘dnac.log’.

При false: - Ведение журнала отключено.

Если файл журнала не существует: - Создается в режиме добавления или записи в зависимости от флага ‘dnac_log_append’.

Если файл журнала существует: - Перезаписывается или дополняется в зависимости от флага ‘dnac_log_append’.

Варианты:

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

dnac_log_append

boolean

Определяет режим файла. Устанавливается в True для режима «добавления». Устанавливается в False для режима «записи».

Варианты:

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

dnac_log_file_path

string

Управляет ведением журнала. Журналы записываются, если dnac_log имеет значение True.

Если путь не указан: - При ‘dnac_log_append’ = True, создается ‘dnac.log’ в текущем каталоге Ansible; журналы добавляются. - При ‘dnac_log_append’ = False, создается ‘dnac.log’; журналы перезаписываются.

Если путь указан: - При ‘dnac_log_append’ = True, файл открывается в режиме добавления. - При ‘dnac_log_append’ = False, файл открывается в режиме записи (w). - В сценариях совместного использования файлов без режима добавления содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите append в False для 1-го модуля (для перезаписи); для последующих модулей установите append в True.

По умолчанию: "dnac.log"

dnac_log_level

string

Устанавливает порог уровня ведения журнала. Сообщения с уровнем, равным или выше этого, будут записаны в журнал. Уровни перечислены в порядке убывания серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG].

CRITICAL указывает серьезные ошибки, останавливающие программу. Отображаются только сообщения CRITICAL.

ERROR указывает проблемы, препятствующие работе функции. Отображаются сообщения ERROR и CRITICAL.

WARNING указывает потенциальные будущие проблемы. Отображаются сообщения WARNING, ERROR, CRITICAL.

INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR, CRITICAL.

DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала.

По умолчанию: "WARNING"

dnac_password

string

Пароль для аутентификации в Cisco Catalyst Center.

dnac_port

string

Указывает номер порта, связанный с Cisco Catalyst Center.

По умолчанию: "443"

dnac_task_poll_interval

integer

Указывает интервал в секундах между последовательными вызовами API для получения деталей задачи.

По умолчанию: 2

dnac_username

aliases: user

string

Имя пользователя для аутентификации в Cisco Catalyst Center.

По умолчанию: "admin"

dnac_verify

boolean

Флаг для включения или отключения проверки SSL-сертификата.

Варианты:

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

dnac_version

string

Указывает версию Cisco Catalyst Center, которую должен использовать SDK.

По умолчанию: "2.2.3.3"

state

string

Состояние Cisco Catalyst Center после завершения модуля.

Варианты:

• "merged" ← (по умолчанию)
• "deleted"

validate_response_schema

boolean

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

Варианты:

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