.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.template_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.template_workflow_manager module -- Resource module for Template functions +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.27.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.template_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.6.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Configuration Template. - API to create a template by project name and template name. - API to update a template by template name and project name. - API to delete a template by template name and project name. - API to export the projects for given projectNames. - API to export the templates for given templateIds. - API to manage operation create of the resource Configuration Template Import Project. - API to manage operation create of the resource Configuration Template Import Template. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.template_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.9 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of details of templates being managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates: .. rst-class:: ansible-option-title **configuration_templates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Perform operations such as Create/Update/Delete on a template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/author: .. rst-class:: ansible-option-title **author** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identifies the creator of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/composite: .. rst-class:: ansible-option-title **composite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the template is composite. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates: .. rst-class:: ansible-option-title **containing_templates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Refer to a set of templates within the main template to define more complex or modular configurations. This is particularly useful in systems that support hierarchical or nested templates. Here parent templates may contain child templates to form a complete configuration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/composite: .. rst-class:: ansible-option-title **composite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the template is composite. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a description of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/device_types: .. rst-class:: ansible-option-title **device_types** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of dictionaries details the types of devices that the templates can be applied to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/device_types/product_family: .. rst-class:: ansible-option-title **product_family** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the family to which the device belongs. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Cisco Cloud Services Platform"` - :ansible-option-choices-entry:`"Cisco Interfaces and Modules"` - :ansible-option-choices-entry:`"Content Networking"` - :ansible-option-choices-entry:`"Network Management"` - :ansible-option-choices-entry:`"NFV-ThirdParty Devices"` - :ansible-option-choices-entry:`"NFVIS"` - :ansible-option-choices-entry:`"Routers"` - :ansible-option-choices-entry:`"Security and VPN"` - :ansible-option-choices-entry:`"Storage Networking"` - :ansible-option-choices-entry:`"Switches and Hubs"` - :ansible-option-choices-entry:`"Voice and Telephony"` - :ansible-option-choices-entry:`"Wireless Controller"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/device_types/product_series: .. rst-class:: ansible-option-title **product_series** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the series classification of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/device_types/product_type: .. rst-class:: ansible-option-title **product_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Describes the exact type of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier for the template, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/language: .. rst-class:: ansible-option-title **language** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Programming language used for templating. Options are 'JINJA' for Jinja templating or 'VELOCITY' for Apache Velocity. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"JINJA"` - :ansible-option-choices-entry:`"VELOCITY"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Designation of the template, serving as its unique name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/project_description: .. rst-class:: ansible-option-title **project_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Narrative that elaborates on the purpose and scope of the project. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/project_name: .. rst-class:: ansible-option-title **project_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Title of the project within which the template is categorized and managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/tags: .. rst-class:: ansible-option-title **tags** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
A list of dictionaries representing tags associated with the Configuration Template during creation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/tags/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The unique identifier for each tag, presented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/tags/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The descriptive label or name assigned to the tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_content: .. rst-class:: ansible-option-title **template_content** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The actual script or code constituting the body of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params: .. rst-class:: ansible-option-title **template_params** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The customization of the contents within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/binding: .. rst-class:: ansible-option-title **binding** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Associates the parameter with its source. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/custom_order: .. rst-class:: ansible-option-title **custom_order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies a user-defined ordering for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/data_type: .. rst-class:: ansible-option-title **data_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identifies the data type of the parameter (e.g., string, integer, boolean). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/default_value: .. rst-class:: ansible-option-title **default_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Establishes a default value for the parameter, used if no other value is provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a descriptive explanation of the parameter's purpose. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/display_name: .. rst-class:: ansible-option-title **display_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter as displayed to users. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/group: .. rst-class:: ansible-option-title **group** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Categorizes the parameter into a named group for organizational purposes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the parameter, formatted as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/instruction_text: .. rst-class:: ansible-option-title **instruction_text** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Gives guidance or instructions regarding the parameter's use. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique key that identifies the parameter within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/not_param: .. rst-class:: ansible-option-title **not_param** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether the entry is not to be treated as a parameter. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Determines the sequence in which the parameter appears relative to others. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/param_array: .. rst-class:: ansible-option-title **param_array** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the parameter should be treated as an array. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/parameter_name: .. rst-class:: ansible-option-title **parameter_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/provider: .. rst-class:: ansible-option-title **provider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the provider associated with the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/range: .. rst-class:: ansible-option-title **range** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Defines the permissible range for the parameter's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/range/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier for the range, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/range/max_value: .. rst-class:: ansible-option-title **max_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the maximum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/range/min_value: .. rst-class:: ansible-option-title **min_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the minimum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/required: .. rst-class:: ansible-option-title **required** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Dictates whether the parameter is required for template operations. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/selection: .. rst-class:: ansible-option-title **selection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Contains options for parameter selection when a choice is available. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/selection/default_selected_values: .. rst-class:: ansible-option-title **default_selected_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Lists the default values that are preselected. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/selection/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the selection entity, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/selection/selection_type: .. rst-class:: ansible-option-title **selection_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the type of selection, such as 'SINGLE\_SELECT' or 'MULTI\_SELECT'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/template_params/selection/selection_values: .. rst-class:: ansible-option-title **selection_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary of available values for selection. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/containing_templates/version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The current version of template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/custom_params_order: .. rst-class:: ansible-option-title **custom_params_order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies the sequence in which custom parameters or variables should be arranged within the template. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/device_types: .. rst-class:: ansible-option-title **device_types** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of dictionaries details the types of devices that the templates can be applied to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/device_types/product_family: .. rst-class:: ansible-option-title **product_family** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the family to which the device belongs. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Cisco Cloud Services Platform"` - :ansible-option-choices-entry:`"Cisco Interfaces and Modules"` - :ansible-option-choices-entry:`"Content Networking"` - :ansible-option-choices-entry:`"Network Management"` - :ansible-option-choices-entry:`"NFV-ThirdParty Devices"` - :ansible-option-choices-entry:`"NFVIS"` - :ansible-option-choices-entry:`"Routers"` - :ansible-option-choices-entry:`"Security and VPN"` - :ansible-option-choices-entry:`"Storage Networking"` - :ansible-option-choices-entry:`"Switches and Hubs"` - :ansible-option-choices-entry:`"Voice and Telephony"` - :ansible-option-choices-entry:`"Wireless Controller"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/device_types/product_series: .. rst-class:: ansible-option-title **product_series** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the series classification of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/device_types/product_type: .. rst-class:: ansible-option-title **product_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Describes the exact type of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/failure_policy: .. rst-class:: ansible-option-title **failure_policy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Define failure policy if template provisioning fails. failure\_policy will be enabled only when the composite is set to True. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"ABORT\_TARGET\_ON\_ERROR"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/language: .. rst-class:: ansible-option-title **language** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Programming language used for templating. Options are 'JINJA' for Jinja templating or 'VELOCITY' for Apache Velocity. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"JINJA"` - :ansible-option-choices-entry:`"VELOCITY"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/project_description: .. rst-class:: ansible-option-title **project_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Narrative that elaborates on the purpose and scope of the project. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/project_name: .. rst-class:: ansible-option-title **project_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Title of the project within which the template is categorized and managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/software_type: .. rst-class:: ansible-option-title **software_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Applicable device software type. This field is required to create a new template. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"IOS"` - :ansible-option-choices-entry:`"IOS-XE"` - :ansible-option-choices-entry:`"IOS-XR"` - :ansible-option-choices-entry:`"NX-OS"` - :ansible-option-choices-entry:`"Cisco Controller"` - :ansible-option-choices-entry:`"Wide Area Application Services"` - :ansible-option-choices-entry:`"Adaptive Security Appliance"` - :ansible-option-choices-entry:`"NFV-OS"` - :ansible-option-choices-entry:`"Others"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/software_version: .. rst-class:: ansible-option-title **software_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Applicable device software version. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_content: .. rst-class:: ansible-option-title **template_content** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The actual script or code constituting the body of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_description: .. rst-class:: ansible-option-title **template_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a overview of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_name: .. rst-class:: ansible-option-title **template_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of template. This field is required to create a new template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params: .. rst-class:: ansible-option-title **template_params** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The customization of the contents within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/binding: .. rst-class:: ansible-option-title **binding** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Associates the parameter with its source. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/custom_order: .. rst-class:: ansible-option-title **custom_order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies a user-defined ordering for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/data_type: .. rst-class:: ansible-option-title **data_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identifies the data type of the parameter (e.g., string, integer, boolean). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/default_value: .. rst-class:: ansible-option-title **default_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Establishes a default value for the parameter, used if no other value is provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a descriptive explanation of the parameter's purpose. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/display_name: .. rst-class:: ansible-option-title **display_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter as displayed to users. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/group: .. rst-class:: ansible-option-title **group** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Categorizes the parameter into a named group for organizational purposes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the parameter, formatted as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/instruction_text: .. rst-class:: ansible-option-title **instruction_text** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Gives guidance or instructions regarding the parameter's use. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique key that identifies the parameter within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/not_param: .. rst-class:: ansible-option-title **not_param** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether the entry is not to be treated as a parameter. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Determines the sequence in which the parameter appears relative to others. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/param_array: .. rst-class:: ansible-option-title **param_array** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the parameter should be treated as an array. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/parameter_name: .. rst-class:: ansible-option-title **parameter_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/provider: .. rst-class:: ansible-option-title **provider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the provider associated with the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/range: .. rst-class:: ansible-option-title **range** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Defines the permissible range for the parameter's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/range/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier for the range, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/range/max_value: .. rst-class:: ansible-option-title **max_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the maximum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/range/min_value: .. rst-class:: ansible-option-title **min_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the minimum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/required: .. rst-class:: ansible-option-title **required** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Dictates whether the parameter is required for template operations. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/selection: .. rst-class:: ansible-option-title **selection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Contains options for parameter selection when a choice is available. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/selection/default_selected_values: .. rst-class:: ansible-option-title **default_selected_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Lists the default values that are preselected. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/selection/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the selection entity, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/selection/selection_type: .. rst-class:: ansible-option-title **selection_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the type of selection, such as 'SINGLE\_SELECT' or 'MULTI\_SELECT'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_params/selection/selection_values: .. rst-class:: ansible-option-title **selection_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary of available values for selection. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_tag: .. rst-class:: ansible-option-title **template_tag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Refers to a keyword, label, or metadata assigned to a template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_tag/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the tag, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/template_tag/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The current version of template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/configuration_templates/version_description: .. rst-class:: ansible-option-title **version_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Template version comments. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template: .. rst-class:: ansible-option-title **deploy_template** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
To deploy the template to the devices based on either list of site provisionig details with further filtering criteria like device family, device role, device tag or by providing the device specific details which includes device\_ips, device\_hostnames, serial\_numbers or mac\_addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/device_details: .. rst-class:: ansible-option-title **device_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details specific to devices where the template will be deployed, including lists of device IPs, hostnames, serial numbers, or MAC addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/device_details/device_hostnames: .. rst-class:: ansible-option-title **device_hostnames** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list of hostnames of the devices where the template will be deployed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/device_details/device_ips: .. rst-class:: ansible-option-title **device_ips** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list of IP addresses of the devices where the template will be deployed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/device_details/mac_addresses: .. rst-class:: ansible-option-title **mac_addresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list of MAC addresses of the devices where the template will be deployed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/device_details/serial_numbers: .. rst-class:: ansible-option-title **serial_numbers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list of serial numbers of the devices where the template will be deployed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/force_push: .. rst-class:: ansible-option-title **force_push** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean flag to indicate whether the template should be forcefully pushed to the devices, overriding any existing configuration. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/is_composite: .. rst-class:: ansible-option-title **is_composite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Boolean flag indicating whether the template is composite, which means the template is built using multiple smaller templates. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/project_name: .. rst-class:: ansible-option-title **project_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provide the name of project under which the template is available. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/site_provisioning_details: .. rst-class:: ansible-option-title **site_provisioning_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Parameters related to site-based provisioning, allowing the deployment of templates to devices associated with specific sites, with optional filtering by device family, role, or tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/site_provisioning_details/device_family: .. rst-class:: ansible-option-title **device_family** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Family of the devices (e.g., switches, routers) used to filter devices for template deployment. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/site_provisioning_details/device_role: .. rst-class:: ansible-option-title **device_role** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Role of the devices (e.g., access, core, edge) used to filter devices for template deployment. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/site_provisioning_details/device_tag: .. rst-class:: ansible-option-title **device_tag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specific device tag used to filter devices for template deployment. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/site_provisioning_details/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Name of the site where the devices are associated for provisioning. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/template_name: .. rst-class:: ansible-option-title **template_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the template to be deployed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/template_parameters: .. rst-class:: ansible-option-title **template_parameters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
A list of parameter name-value pairs used for customizing the template with specific values for each device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/template_parameters/param_name: .. rst-class:: ansible-option-title **param_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the parameter in the template that needs to be replaced with a specific value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/deploy_template/template_parameters/param_value: .. rst-class:: ansible-option-title **param_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value assigned to the parameter for deployment to devices. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/export: .. rst-class:: ansible-option-title **export** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Perform export on the projects and templates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/export/project: .. rst-class:: ansible-option-title **project** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Export the project(s) details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/export/template: .. rst-class:: ansible-option-title **template** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Export the template(s) details. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/export/template/project_name: .. rst-class:: ansible-option-title **project_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the project under the template available. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/export/template/template_name: .. rst-class:: ansible-option-title **template_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the template which we need to be exported. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import: .. rst-class:: ansible-option-title **import** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Perform import on the projects and templates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/project: .. rst-class:: ansible-option-title **project** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Import the projects. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/project/do_version: .. rst-class:: ansible-option-title **do_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines whether to create a new version of the project with the imported contents. If set to true and the project already exists, a new version will be created. If false, the operation will fail with a 'Project already exists' error if the project already exists. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/project/payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Directly imports configuration data into the system using the provided payload. Offers an alternative to 'project\_file' for importing configurations without referencing an external file. Ignored if 'project\_file' is also provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/project/payload/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the project to be imported. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/project/project_file: .. rst-class:: ansible-option-title **project_file** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` :ansible-option-versionadded:`added in cisco.dnac 6.17.0` .. raw:: html
- .. raw:: html
Specifies the path to a JSON file that contains the import project configuration. If both 'project\_file' and 'payload' are provided, the 'project\_file' will be given priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template: .. rst-class:: ansible-option-title **template** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Import the templates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/do_version: .. rst-class:: ansible-option-title **do_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
DoVersion query parameter. If this flag is true, creates a new version of the template with the imported contents, if the templates already exists. " If false and if template already exists, then operation fails with 'Template already exists' error. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The payload parameter is used to directly import configuration data into the system. The payload provides an alternative way to import configurations without the need to reference an external file. If both 'template\_file' and 'payload' are provided, the 'template\_file' will be given priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/author: .. rst-class:: ansible-option-title **author** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identifies the creator of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/composite: .. rst-class:: ansible-option-title **composite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the template is composite. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates: .. rst-class:: ansible-option-title **containing_templates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Refer to a set of templates within the main template to define more complex or modular configurations. This is particularly useful in systems that support hierarchical or nested templates. Here parent templates may contain child templates to form a complete configuration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/composite: .. rst-class:: ansible-option-title **composite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the template is composite. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a description of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/device_types: .. rst-class:: ansible-option-title **device_types** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of dictionaries details the types of devices that the templates can be applied to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/device_types/product_family: .. rst-class:: ansible-option-title **product_family** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the family to which the device belongs. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Cisco Cloud Services Platform"` - :ansible-option-choices-entry:`"Cisco Interfaces and Modules"` - :ansible-option-choices-entry:`"Content Networking"` - :ansible-option-choices-entry:`"Network Management"` - :ansible-option-choices-entry:`"NFV-ThirdParty Devices"` - :ansible-option-choices-entry:`"NFVIS"` - :ansible-option-choices-entry:`"Routers"` - :ansible-option-choices-entry:`"Security and VPN"` - :ansible-option-choices-entry:`"Storage Networking"` - :ansible-option-choices-entry:`"Switches and Hubs"` - :ansible-option-choices-entry:`"Voice and Telephony"` - :ansible-option-choices-entry:`"Wireless Controller"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/device_types/product_series: .. rst-class:: ansible-option-title **product_series** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the series classification of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/device_types/product_type: .. rst-class:: ansible-option-title **product_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Describes the exact type of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier for the template, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/language: .. rst-class:: ansible-option-title **language** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Programming language used for templating. Options are 'JINJA' for Jinja templating or 'VELOCITY' for Apache Velocity. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"JINJA"` - :ansible-option-choices-entry:`"VELOCITY"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Designation of the template, serving as its unique name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/project_name: .. rst-class:: ansible-option-title **project_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Title of the project within which the template is categorized and managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/tags: .. rst-class:: ansible-option-title **tags** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
A list of dictionaries representing tags associated with the Configuration Template during creation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/tags/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The unique identifier for each tag, presented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/tags/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The descriptive label or name assigned to the tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_content: .. rst-class:: ansible-option-title **template_content** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The actual script or code constituting the body of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params: .. rst-class:: ansible-option-title **template_params** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The customization of the contents within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/binding: .. rst-class:: ansible-option-title **binding** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Associates the parameter with its source. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/custom_order: .. rst-class:: ansible-option-title **custom_order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies a user-defined ordering for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/data_type: .. rst-class:: ansible-option-title **data_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identifies the data type of the parameter (e.g., string, integer, boolean). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/default_value: .. rst-class:: ansible-option-title **default_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Establishes a default value for the parameter, used if no other value is provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a descriptive explanation of the parameter's purpose. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/display_name: .. rst-class:: ansible-option-title **display_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter as displayed to users. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/group: .. rst-class:: ansible-option-title **group** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Categorizes the parameter into a named group for organizational purposes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the parameter, formatted as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/instruction_text: .. rst-class:: ansible-option-title **instruction_text** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Gives guidance or instructions regarding the parameter's use. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique key that identifies the parameter within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/not_param: .. rst-class:: ansible-option-title **not_param** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether the entry is not to be treated as a parameter. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Determines the sequence in which the parameter appears relative to others. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/param_array: .. rst-class:: ansible-option-title **param_array** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the parameter should be treated as an array. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/parameter_name: .. rst-class:: ansible-option-title **parameter_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/provider: .. rst-class:: ansible-option-title **provider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the provider associated with the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/range: .. rst-class:: ansible-option-title **range** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Defines the permissible range for the parameter's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/range/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier for the range, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/range/max_value: .. rst-class:: ansible-option-title **max_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the maximum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/range/min_value: .. rst-class:: ansible-option-title **min_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the minimum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/required: .. rst-class:: ansible-option-title **required** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Dictates whether the parameter is required for template operations. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/selection: .. rst-class:: ansible-option-title **selection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Contains options for parameter selection when a choice is available. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/selection/default_selected_values: .. rst-class:: ansible-option-title **default_selected_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Lists the default values that are preselected. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/selection/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the selection entity, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/selection/selection_type: .. rst-class:: ansible-option-title **selection_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the type of selection, such as 'SINGLE\_SELECT' or 'MULTI\_SELECT'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/template_params/selection/selection_values: .. rst-class:: ansible-option-title **selection_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary of available values for selection. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/containing_templates/version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The current version of template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/custom_params_order: .. rst-class:: ansible-option-title **custom_params_order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies the sequence in which custom parameters or variables should be arranged within the template. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/device_types: .. rst-class:: ansible-option-title **device_types** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of dictionaries details the types of devices that the templates can be applied to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/device_types/product_family: .. rst-class:: ansible-option-title **product_family** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the family to which the device belongs. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Cisco Cloud Services Platform"` - :ansible-option-choices-entry:`"Cisco Interfaces and Modules"` - :ansible-option-choices-entry:`"Content Networking"` - :ansible-option-choices-entry:`"Network Management"` - :ansible-option-choices-entry:`"NFV-ThirdParty Devices"` - :ansible-option-choices-entry:`"NFVIS"` - :ansible-option-choices-entry:`"Routers"` - :ansible-option-choices-entry:`"Security and VPN"` - :ansible-option-choices-entry:`"Storage Networking"` - :ansible-option-choices-entry:`"Switches and Hubs"` - :ansible-option-choices-entry:`"Voice and Telephony"` - :ansible-option-choices-entry:`"Wireless Controller"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/device_types/product_series: .. rst-class:: ansible-option-title **product_series** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the series classification of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/device_types/product_type: .. rst-class:: ansible-option-title **product_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Describes the exact type of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/failure_policy: .. rst-class:: ansible-option-title **failure_policy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Define failure policy if template provisioning fails. failure\_policy will be enabled only when the composite is set to True. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"ABORT\_TARGET\_ON\_ERROR"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/language: .. rst-class:: ansible-option-title **language** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Programming language used for templating. Options are 'JINJA' for Jinja templating or 'VELOCITY' for Apache Velocity. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"JINJA"` - :ansible-option-choices-entry:`"VELOCITY"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/project_description: .. rst-class:: ansible-option-title **project_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Narrative that elaborates on the purpose and scope of the project. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/project_name: .. rst-class:: ansible-option-title **project_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Title of the project within which the template is categorized and managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/software_type: .. rst-class:: ansible-option-title **software_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Applicable device software type. This field is required to create a new template. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"IOS"` - :ansible-option-choices-entry:`"IOS-XE"` - :ansible-option-choices-entry:`"IOS-XR"` - :ansible-option-choices-entry:`"NX-OS"` - :ansible-option-choices-entry:`"Cisco Controller"` - :ansible-option-choices-entry:`"Wide Area Application Services"` - :ansible-option-choices-entry:`"Adaptive Security Appliance"` - :ansible-option-choices-entry:`"NFV-OS"` - :ansible-option-choices-entry:`"Others"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/software_version: .. rst-class:: ansible-option-title **software_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Applicable device software version. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_content: .. rst-class:: ansible-option-title **template_content** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The actual script or code constituting the body of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_description: .. rst-class:: ansible-option-title **template_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a overview of the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_name: .. rst-class:: ansible-option-title **template_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of template. This field is required to create a new template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params: .. rst-class:: ansible-option-title **template_params** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The customization of the contents within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/binding: .. rst-class:: ansible-option-title **binding** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Associates the parameter with its source. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/custom_order: .. rst-class:: ansible-option-title **custom_order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies a user-defined ordering for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/data_type: .. rst-class:: ansible-option-title **data_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identifies the data type of the parameter (e.g., string, integer, boolean). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/default_value: .. rst-class:: ansible-option-title **default_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Establishes a default value for the parameter, used if no other value is provided. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Provides a descriptive explanation of the parameter's purpose. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/display_name: .. rst-class:: ansible-option-title **display_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter as displayed to users. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/group: .. rst-class:: ansible-option-title **group** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Categorizes the parameter into a named group for organizational purposes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the parameter, formatted as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/instruction_text: .. rst-class:: ansible-option-title **instruction_text** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Gives guidance or instructions regarding the parameter's use. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique key that identifies the parameter within the template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/not_param: .. rst-class:: ansible-option-title **not_param** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether the entry is not to be treated as a parameter. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Determines the sequence in which the parameter appears relative to others. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/param_array: .. rst-class:: ansible-option-title **param_array** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies if the parameter should be treated as an array. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/parameter_name: .. rst-class:: ansible-option-title **parameter_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/provider: .. rst-class:: ansible-option-title **provider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Denotes the provider associated with the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/range: .. rst-class:: ansible-option-title **range** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Defines the permissible range for the parameter's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/range/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier for the range, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/range/max_value: .. rst-class:: ansible-option-title **max_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the maximum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/range/min_value: .. rst-class:: ansible-option-title **min_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the minimum allowable value for the parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/required: .. rst-class:: ansible-option-title **required** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Dictates whether the parameter is required for template operations. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/selection: .. rst-class:: ansible-option-title **selection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Contains options for parameter selection when a choice is available. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/selection/default_selected_values: .. rst-class:: ansible-option-title **default_selected_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Lists the default values that are preselected. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/selection/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the selection entity, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/selection/selection_type: .. rst-class:: ansible-option-title **selection_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the type of selection, such as 'SINGLE\_SELECT' or 'MULTI\_SELECT'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_params/selection/selection_values: .. rst-class:: ansible-option-title **selection_values** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary of available values for selection. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_tag: .. rst-class:: ansible-option-title **template_tag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Refers to a keyword, label, or metadata assigned to a template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_tag/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A unique identifier for the tag, represented as a UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/template_tag/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/payload/version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The current version of template. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/project_name: .. rst-class:: ansible-option-title **project_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ProjectName path parameter. Project name to create template under the project. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config/import/template/template_file: .. rst-class:: ansible-option-title **template_file** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the path to a JSON file that contains an import template. If both 'template\_file' and 'payload' are provided, the 'template\_file' will be given priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-config_verify: .. rst-class:: ansible-option-title **config_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set to True to verify the Cisco Catalyst Center after applying the playbook config. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_api_task_timeout: .. rst-class:: ansible-option-title **dnac_api_task_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Defines the timeout in seconds for API calls to retrieve task details. If the task details are not received within this period, the process will end, and a timeout notification will be logged. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`1200` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The hostname of the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable/disable playbook execution logging. When true and dnac\_log\_file\_path is provided, - Create the log file at the execution location with the specified name. When true and dnac\_log\_file\_path is not provided, - Create the log file at the execution location with the name 'dnac.log'. When false, - Logging is disabled. If the log file doesn't exist, - It is created in append or write mode based on the "dnac\_log\_append" flag. If the log file exists, - It is overwritten or appended based on the "dnac\_log\_append" flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_log_append: .. rst-class:: ansible-option-title **dnac_log_append** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_log_file_path: .. rst-class:: ansible-option-title **dnac_log_file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Governs logging. Logs are recorded if dnac\_log is True. If path is not specified, - When 'dnac\_log\_append' is True, 'dnac.log' is generated in the current Ansible directory; logs are appended. - When 'dnac\_log\_append' is False, 'dnac.log' is generated; logs are overwritten. If path is specified, - When 'dnac\_log\_append' is True, the file opens in append mode. - When 'dnac\_log\_append' is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"dnac.log"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_log_level: .. rst-class:: ansible-option-title **dnac_log_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"WARNING"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The password for authentication at the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the port number associated with the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_task_poll_interval: .. rst-class:: ansible-option-title **dnac_task_poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the interval in seconds between successive calls to the API to retrieve task details. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The username for authentication at the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the version of the Cisco Catalyst Center that the SDK should use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The state of Cisco Catalyst Center after module completion. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are configuration\_templates.ConfigurationTemplates.create\_template, configuration\_templates.ConfigurationTemplates.deletes\_the\_template, configuration\_templates.ConfigurationTemplates.update\_template, configuration\_templates.ConfigurationTemplates.export\_projects, configuration\_templates.ConfigurationTemplates.export\_templates, configuration\_templates.ConfigurationTemplates.imports\_the\_projects\_provided, configuration\_templates.ConfigurationTemplates.imports\_the\_templates\_provided, - Paths used are post /dna/intent/api/v1/template-programmer/project/{projectId}/template, delete /dna/intent/api/v1/template-programmer/template/{templateId}, put /dna/intent/api/v1/template-programmer/template, post /dna/intent/api/v1/template-programmer/project/name/exportprojects, post /dna/intent/api/v1/template-programmer/template/exporttemplates, post /dna/intent/api/v1/template-programmer/project/importprojects, post /dna/intent/api/v1/template-programmer/project/name/{projectName}/template/importtemplates, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK - The parameters starting with dnac\_ are used by the Cisco Catalyst Center Python SDK to establish the connection .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create a new template. cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: True config: - configuration_templates: author: string composite: true custom_params_order: true description: string device_types: - product_family: string product_series: string product_type: string failure_policy: string id: string language: string name: string project_name: string project_description: string software_type: string software_version: string tags: - id: string name: string template_content: string version: string - name: Export the projects. cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: True config: export: project: - string - string - name: Export the templates. cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: True config: export: template: - project_name : string template_name: string - project_name: string template_name: string - name: Import the Projects. cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: True config: import: project: do_version: false payload: - name: string - name: string - name: Import the Templates. cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: True config: import: template: do_version: false project_name: string template_file: string - name: Deploy the given template to the devices based on site specific details and other filtering mode cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: True config: deploy_template: project_name: "Sample_Project" template_name: "Sample Template" force_push: true template_parameters: - param_name: "vlan_id" param_value: "1431" - param_name: "vlan_name" param_value: "testvlan31" site_provisioning_details: - site_name: "Global/Bangalore/Building14/Floor1" device_family: "Switches and Hubs" - name: Deploy the given template to the devices based on device specific details cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: True config: deploy_template: project_name: "Sample_Project" template_name: "Sample Template" force_push: true template_parameters: - param_name: "vlan_id" param_value: "1431" - param_name: "vlan_name" param_value: "testvlan31" device_details: device_ips: ["10.1.2.1", "10.2.3.4"] - name: Delete the given project or template from the Cisco Catalyst Center cisco.dnac.template_workflow_manager: 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}}" dnac_log: True dnac_log_level: "{{dnac_log_level}}" state: deleted config_verify: True config: configuration_templates: project_name: "Sample_Project" template_name: "Sample Template" language: "velocity" software_type: "IOS-XE" device_types: - product_family: "Switches and Hubs" .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__return-response_1: .. rst-class:: ansible-option-title **response_1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary with versioning details of the template as returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"{\\n \\"response\\": {\\n \\"endTime\\": 0,\\n \\"version\\": 0,\\n \\"data\\": String,\\n \\"startTime\\": 0,\\n \\"username\\": String,\\n \\"progress\\": String,\\n \\"serviceType\\": String, \\"rootId\\": String,\\n \\"isError\\": bool,\\n \\"instanceTenantId\\": String,\\n \\"id\\": String\\n \\"version\\": 0\\n },\\n \\"msg\\": String\\n}\\n"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__return-response_2: .. rst-class:: ansible-option-title **response_2** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
A list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["{\\n \\"response\\": []", "\\n \\"msg\\": String\\n}\\n"]` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__return-response_3: .. rst-class:: ansible-option-title **response_3** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary with the exisiting template deatails as returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"{\\n \\"response\\": {},\\n \\"msg\\": String\\n}\\n"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__return-response_4: .. rst-class:: ansible-option-title **response_4** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the templates in the list as returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"{\\n \\"response\\": {},\\n \\"msg\\": String\\n}\\n"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.template_workflow_manager_module__return-response_5: .. rst-class:: ansible-option-title **response_5** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the projects in the list as returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"{\\n \\"response\\": {},\\n \\"msg\\": String\\n}\\n"` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary) Akash Bhaskaran (@akabhask) Muthu Rakesh (@MUTHU-RAKESH-27) Abhishek Maheshwari (@abmahesh) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors