cisco.catalystcenter.configuration_template_project module -- Resource module for Configuration Template Project

Note

This module is part of the cisco.catalystcenter collection (version 2.2.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.configuration_template_project.

New in cisco.catalystcenter 3.1.0

Synopsis

• Manage operations create, update and delete of the resource Configuration Template Project.

• This API is used to create a new project.

• Deletes the project by its id.

• This API is used to update an existing project.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
createTime integer	Create time of project.
description string	Description of project.
id string	UUID of project.
lastUpdateTime integer	Update time of project.
name string	Name of project.
projectId string	ProjectId path parameter. ProjectId(UUID) of project to be deleted.
tags list / elements=dictionary	Configuration Template Project's tags.
id string	UUID of tag.
name string	Name of tag.
templates list / elements=dictionary	List of templates within the project.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are configuration_templates.ConfigurationTemplates.create_project, configuration_templates.ConfigurationTemplates.deletes_the_project, configuration_templates.ConfigurationTemplates.update_project,

• Paths used are post /dna/intent/api/v1/template-programmer/project, delete /dna/intent/api/v1/template-programmer/project/{projectId}, put /dna/intent/api/v1/template-programmer/project,

• Does not support 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 CreateProject

Complete reference of the CreateProject API.

Cisco DNA Center documentation for Configuration Templates DeletesTheProject

Complete reference of the DeletesTheProject API.

Cisco DNA Center documentation for Configuration Templates UpdateProject

Complete reference of the UpdateProject API.

Examples

---
- name: Create
  cisco.catalystcenter.configuration_template_project:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    createTime: 0
    description: string
    id: string
    lastUpdateTime: 0
    name: string
    tags:
      - id: string
        name: string
    templates:
      - {}
- name: Update all
  cisco.catalystcenter.configuration_template_project:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    createTime: 0
    description: string
    id: string
    lastUpdateTime: 0
    name: string
    tags:
      - id: string
        name: string
    templates: {}
- name: Delete by id
  cisco.catalystcenter.configuration_template_project:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: absent
    projectId: string

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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)