cisco.dnac.template_project – Manage TemplateProject 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_project.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Returns the projects in the system.

  • Creates a new project.

  • Updates an existing project.

  • Deletes an existing Project.

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
createTime
integer
ProjectDTO's createTime.
description
string
ProjectDTO's description.
id
string
ProjectDTO's id.
lastUpdateTime
integer
ProjectDTO's lastUpdateTime.
name
string
Name of project to be searched.
ProjectDTO's name.
project_id
string
ProjectId path parameter.
Required for state delete.
tags
list / elements=string
ProjectDTO's tags (list of strings).
templates
dictionary
ProjectDTO's templates.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.template_project

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

TemplateProject reference

Complete reference of the TemplateProject object model.

TemplateProject reference

SDK reference.

Examples

- name: get_projects
  cisco.dnac.template_project:
    state: query  # required
    name: SomeValue  # string
  register: nm_get_projects

- name: create_project
  cisco.dnac.template_project:
    state: create  # required
    createTime: 1  #  integer
    description: SomeValue  # string
    id: SomeValue  # string
    lastUpdateTime: 1  #  integer
    name: SomeValue  # string
    tags:
    - SomeValue  # string
    templates: None

- name: update_project
  cisco.dnac.template_project:
    state: update  # required
    createTime: 1  #  integer
    description: SomeValue  # string
    id: SomeValue  # string
    lastUpdateTime: 1  #  integer
    name: SomeValue  # string
    tags:
    - SomeValue  # string
    templates: None

- name: delete_project
  cisco.dnac.template_project:
    state: delete  # required
    project_id: SomeValue  # string, required

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.create_project


Authors

  • Rafael Campos (@racampos)