cisco.dnac.template_preview – Manage TemplatePreview objects of ConfigurationTemplates

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.template_preview.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Previews an existing template.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
params
dictionary
TemplatePreviewRequestDTO's params.
templateId
string
TemplatePreviewRequestDTO's templateId.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.template_preview

The official documentation on the cisco.dnac.plugins.module_utils.definitions.template_preview module.

TemplatePreview reference

Complete reference of the TemplatePreview object model.

TemplatePreview reference

SDK reference.

Examples

- name: preview_template
  cisco.dnac.template_preview:
    state: update  # required
    params:
    templateId: SomeValue  # string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function

sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
configuration_templates.preview_template


Authors

  • Rafael Campos (@racampos)