cisco.catalystcenter.templates_template_id_versions_info module -- Information module for Templates Template Id Versions

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.templates_template_id_versions_info.

New in cisco.catalystcenter 6.17.0

Synopsis

  • Get all Templates Template Id Versions.

  • Get Templates Template Id Versions by id.

  • Get a template's version by the version ID.

  • Get a template's version information.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

headers

dictionary

Additional headers.

latestVersion

boolean

LatestVersion query parameter. Filter response to only include the latest version of a template.

Choices:

limit

integer

Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

templateId

string

TemplateId path parameter. The id of the template to get versions of, retrieveable from `GET /dna/intent/api/v1/templates`.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

versionId

string

VersionId path parameter. The id of the versioned template to get versions of, retrieveable from `GET /dna/intent/api/v1/templates/{id}/versions`.

versionNumber

integer

VersionNumber query parameter. Filter response to only get the template version that matches this version number.

Notes

Note

  • SDK Method used are configuration_templates.ConfigurationTemplates.get_template_version, configuration_templates.ConfigurationTemplates.get_template_versions,

  • Paths used are get /dna/intent/api/v1/templates/{templateId}/versions, get /dna/intent/api/v1/templates/{templateId}/versions/{versionId},

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Configuration Templates GetTemplateVersion

Complete reference of the GetTemplateVersion API.

Cisco DNA Center documentation for Configuration Templates GetTemplateVersions

Complete reference of the GetTemplateVersions API.

Examples

---
- name: Get all Templates Template Id Versions
  cisco.catalystcenter.templates_template_id_versions_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    versionNumber: 0
    latestVersion: true
    order: string
    limit: 0
    offset: 0
    templateId: string
  register: result
- name: Get Templates Template Id Versions by id
  cisco.catalystcenter.templates_template_id_versions_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    templateId: string
    versionId: string
  register: result

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"CompositeTemplate": {"author": "string", "description": "string", "failurePolicy": "string", "lastUpdateTime": 0, "name": "string", "products": [{"productFamily": "string", "productName": "string", "productSeries": "string"}], "projectId": "string", "softwareFamily": "string", "templateId": "string", "type": "string"}, "RegularTemplate": {"author": "string", "description": "string", "language": "string", "lastUpdateTime": 0, "name": "string", "products": [{"productFamily": "string", "productName": "string", "productSeries": "string"}], "projectId": "string", "softwareFamily": "string", "templateContent": "string", "templateId": "string", "type": "string"}, "version": 0, "versionId": "string", "versionTime": 0}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)