racampos.dnac.template_project (0.0.1) — module

Manage TemplateProject objects of ConfigurationTemplates

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Returns the projects in the system.

Creates a new project.

Updates an existing project.

Deletes an existing Project.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_projects
  cisco.dnac.template_project:
    state: query  # required
    name: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: delete_project
  cisco.dnac.template_project:
    state: delete  # required
    project_id: SomeValue  # string, required

Inputs

    
id:
    description:
    - ProjectDTO's id.
    type: str

name:
    description:
    - Name of project to be searched.
    - ProjectDTO's name.
    type: str

tags:
    description:
    - ProjectDTO's tags (list of strings).
    type: list

templates:
    description:
    - ProjectDTO's templates.
    type: dict

createTime:
    description:
    - ProjectDTO's createTime.
    type: int

project_id:
    description:
    - ProjectId path parameter.
    - Required for state delete.
    type: str

description:
    description:
    - ProjectDTO's description.
    type: str

lastUpdateTime:
    description:
    - ProjectDTO's lastUpdateTime.
    type: int

Outputs

create_project:
  contains: null
  description: Creates a new project.
  response:
    contains:
      taskId:
        description: It is the template project's taskId.
        returned: success
        type: dict
      url:
        description: It is the template project's url.
        returned: success
        sample: <url>
        type: str
    description: ProjectDTO's response.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: ProjectDTO's version.
    returned: success
    sample: '1.0'
    type: str
delete_project:
  contains: null
  description: Deletes an existing Project.
  response:
    contains:
      taskId:
        description: It is the template project's taskId.
        returned: success
        type: dict
      url:
        description: It is the template project's url.
        returned: success
        sample: <url>
        type: str
    description: Response, property of the response body.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: Version, property of the response body.
    returned: success
    sample: '1.0'
    type: str
get_projects:
  contains: null
  description: Returns the projects in the system.
  payload:
    contains:
      id:
        description: It is the template project's id.
        returned: always
        sample: '478012'
        type: str
      name:
        description: It is the template project's name.
        returned: always
        sample: <name>
        type: str
      templates:
        contains:
          composite:
            description: It is the template project's composite.
            returned: always
            sample: false
            type: bool
          id:
            description: It is the template project's id.
            returned: always
            sample: '478012'
            type: str
          name:
            description: It is the template project's name.
            returned: always
            sample: <name>
            type: str
        description: It is the template project's templates.
        returned: always
        type: list
    description: It is the template project's payload.
    returned: always
    type: list
  returned: always
  type: dict
update_project:
  contains: null
  description: Updates an existing project.
  response:
    contains:
      taskId:
        description: It is the template project's taskId.
        returned: changed
        type: dict
      url:
        description: It is the template project's url.
        returned: changed
        sample: <url>
        type: str
    description: ProjectDTO's response.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: ProjectDTO's version.
    returned: changed
    sample: '1.0'
    type: str

See also