cisco.dnac.configuration_template_info (6.13.3) — module

Information module for Configuration Template

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Configuration Template.

Get Configuration Template by id.

Details of the template by its id.

List the templates available.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get all Configuration Template
  cisco.dnac.configuration_template_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    projectId: string
    softwareType: string
    softwareVersion: string
    productFamily: string
    productSeries: string
    productType: string
    filterConflictingTemplates: True
    tags: []
    projectNames: []
    unCommitted: True
    sortOrder: string
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get Configuration Template by id
  cisco.dnac.configuration_template_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    latestVersion: True
    templateId: string
  register: result

Inputs

    
tags:
    description:
    - Tags query parameter. Filter template(s) based on tags.
    elements: str
    type: list

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

projectId:
    description:
    - ProjectId query parameter. Filter template(s) based on project UUID.
    type: str

sortOrder:
    description:
    - SortOrder query parameter. Sort Order Ascending (asc) or Descending (des).
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

templateId:
    description:
    - TemplateId path parameter. TemplateId(UUID) to get details of the template.
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

productType:
    description:
    - ProductType query parameter. Filter template(s) based on device type.
    type: str

unCommitted:
    description:
    - UnCommitted query parameter. Filter template(s) based on template commited or not.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

projectNames:
    description:
    - ProjectNames query parameter. Filter template(s) based on project names.
    elements: str
    type: list

softwareType:
    description:
    - SoftwareType query parameter. Filter template(s) based software type.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

latestVersion:
    description:
    - LatestVersion query parameter. LatestVersion flag to get the latest versioned template.
    type: bool

productFamily:
    description:
    - ProductFamily query parameter. Filter template(s) based on device family.
    type: str

productSeries:
    description:
    - ProductSeries query parameter. Filter template(s) based on device series.
    type: str

softwareVersion:
    description:
    - SoftwareVersion query parameter. Filter template(s) based softwareVersion.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

filterConflictingTemplates:
    description:
    - FilterConflictingTemplates query parameter. Filter template(s) based on confliting
      templates.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"tags\": [\n    {\n      \"id\": \"string\",\n      \"name\": \"\
    string\"\n    }\n  ],\n  \"author\": \"string\",\n  \"composite\": true,\n  \"\
    containingTemplates\": [\n    {\n      \"tags\": [\n        {\n          \"id\"\
    : \"string\",\n          \"name\": \"string\"\n        }\n      ],\n      \"composite\"\
    : true,\n      \"description\": \"string\",\n      \"deviceTypes\": [\n      \
    \  {\n          \"productFamily\": \"string\",\n          \"productSeries\": \"\
    string\",\n          \"productType\": \"string\"\n        }\n      ],\n      \"\
    id\": \"string\",\n      \"language\": \"string\",\n      \"name\": \"string\"\
    ,\n      \"projectName\": \"string\",\n      \"rollbackTemplateParams\": [\n \
    \       {\n          \"binding\": \"string\",\n          \"customOrder\": 0,\n\
    \          \"dataType\": \"string\",\n          \"defaultValue\": \"string\",\n\
    \          \"description\": \"string\",\n          \"displayName\": \"string\"\
    ,\n          \"group\": \"string\",\n          \"id\": \"string\",\n         \
    \ \"instructionText\": \"string\",\n          \"key\": \"string\",\n         \
    \ \"notParam\": true,\n          \"order\": 0,\n          \"paramArray\": true,\n\
    \          \"parameterName\": \"string\",\n          \"provider\": \"string\"\
    ,\n          \"range\": [\n            {\n              \"id\": \"string\",\n\
    \              \"maxValue\": 0,\n              \"minValue\": 0\n            }\n\
    \          ],\n          \"required\": true,\n          \"selection\": {\n   \
    \         \"defaultSelectedValues\": [\n              \"string\"\n           \
    \ ],\n            \"id\": \"string\",\n            \"selectionType\": \"string\"\
    ,\n            \"selectionValues\": {}\n          }\n        }\n      ],\n   \
    \   \"templateContent\": \"string\",\n      \"templateParams\": [\n        {\n\
    \          \"binding\": \"string\",\n          \"customOrder\": 0,\n         \
    \ \"dataType\": \"string\",\n          \"defaultValue\": \"string\",\n       \
    \   \"description\": \"string\",\n          \"displayName\": \"string\",\n   \
    \       \"group\": \"string\",\n          \"id\": \"string\",\n          \"instructionText\"\
    : \"string\",\n          \"key\": \"string\",\n          \"notParam\": true,\n\
    \          \"order\": 0,\n          \"paramArray\": true,\n          \"parameterName\"\
    : \"string\",\n          \"provider\": \"string\",\n          \"range\": [\n \
    \           {\n              \"id\": \"string\",\n              \"maxValue\":\
    \ 0,\n              \"minValue\": 0\n            }\n          ],\n          \"\
    required\": true,\n          \"selection\": {\n            \"defaultSelectedValues\"\
    : [\n              \"string\"\n            ],\n            \"id\": \"string\"\
    ,\n            \"selectionType\": \"string\",\n            \"selectionValues\"\
    : {}\n          }\n        }\n      ],\n      \"version\": \"string\"\n    }\n\
    \  ],\n  \"createTime\": 0,\n  \"customParamsOrder\": true,\n  \"description\"\
    : \"string\",\n  \"deviceTypes\": [\n    {\n      \"productFamily\": \"string\"\
    ,\n      \"productSeries\": \"string\",\n      \"productType\": \"string\"\n \
    \   }\n  ],\n  \"failurePolicy\": \"string\",\n  \"id\": \"string\",\n  \"language\"\
    : \"string\",\n  \"lastUpdateTime\": 0,\n  \"latestVersionTime\": 0,\n  \"name\"\
    : \"string\",\n  \"parentTemplateId\": \"string\",\n  \"projectId\": \"string\"\
    ,\n  \"projectName\": \"string\",\n  \"rollbackTemplateContent\": \"string\",\n\
    \  \"rollbackTemplateParams\": [\n    {\n      \"binding\": \"string\",\n    \
    \  \"customOrder\": 0,\n      \"dataType\": \"string\",\n      \"defaultValue\"\
    : \"string\",\n      \"description\": \"string\",\n      \"displayName\": \"string\"\
    ,\n      \"group\": \"string\",\n      \"id\": \"string\",\n      \"instructionText\"\
    : \"string\",\n      \"key\": \"string\",\n      \"notParam\": true,\n      \"\
    order\": 0,\n      \"paramArray\": true,\n      \"parameterName\": \"string\"\
    ,\n      \"provider\": \"string\",\n      \"range\": [\n        {\n          \"\
    id\": \"string\",\n          \"maxValue\": 0,\n          \"minValue\": 0\n   \
    \     }\n      ],\n      \"required\": true,\n      \"selection\": {\n       \
    \ \"defaultSelectedValues\": [\n          \"string\"\n        ],\n        \"id\"\
    : \"string\",\n        \"selectionType\": \"string\",\n        \"selectionValues\"\
    : {}\n      }\n    }\n  ],\n  \"softwareType\": \"string\",\n  \"softwareVariant\"\
    : \"string\",\n  \"softwareVersion\": \"string\",\n  \"templateContent\": \"string\"\
    ,\n  \"templateParams\": [\n    {\n      \"binding\": \"string\",\n      \"customOrder\"\
    : 0,\n      \"dataType\": \"string\",\n      \"defaultValue\": \"string\",\n \
    \     \"description\": \"string\",\n      \"displayName\": \"string\",\n     \
    \ \"group\": \"string\",\n      \"id\": \"string\",\n      \"instructionText\"\
    : \"string\",\n      \"key\": \"string\",\n      \"notParam\": true,\n      \"\
    order\": 0,\n      \"paramArray\": true,\n      \"parameterName\": \"string\"\
    ,\n      \"provider\": \"string\",\n      \"range\": [\n        {\n          \"\
    id\": \"string\",\n          \"maxValue\": 0,\n          \"minValue\": 0\n   \
    \     }\n      ],\n      \"required\": true,\n      \"selection\": {\n       \
    \ \"defaultSelectedValues\": [\n          \"string\"\n        ],\n        \"id\"\
    : \"string\",\n        \"selectionType\": \"string\",\n        \"selectionValues\"\
    : {}\n      }\n    }\n  ],\n  \"validationErrors\": {\n    \"rollbackTemplateErrors\"\
    : {},\n    \"templateErrors\": {},\n    \"templateId\": \"string\",\n    \"templateVersion\"\
    : \"string\"\n  },\n  \"version\": \"string\"\n}\n"
  type: dict

See also