racampos.dnac.template (0.0.1) — module

Manage Template 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

Creates a new Template.

List the Templates available.

Updates an existing Template.

Returns details of the specified Template.

Deletes an existing Template.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create_template
  cisco.dnac.template:
    state: create  # required
    project_id: SomeValue  # string, required
    author: SomeValue  # string
    composite: True  # boolean
    containingTemplates:
    - composite: True  # boolean
      id: SomeValue  # string
      name: SomeValue  # string
      version: SomeValue  # string
    createTime: 1  #  integer
    description: SomeValue  # string
    deviceTypes:
    - productFamily: SomeValue  # string
      productSeries: SomeValue  # string
      productType: SomeValue  # string
    failurePolicy: SomeValue  # string, valid values: 'ABORT_ON_ERROR', 'CONTINUE_ON_ERROR', 'ROLLBACK_ON_ERROR', 'ROLLBACK_TARGET_ON_ERROR', 'ABORT_TARGET_ON_ERROR'.
    id: SomeValue  # string
    lastUpdateTime: 1  #  integer
    name: SomeValue  # string
    parentTemplateId: SomeValue  # string
    projectId: SomeValue  # string
    projectName: SomeValue  # string
    rollbackTemplateContent: SomeValue  # string
    rollbackTemplateParams:
    - binding: SomeValue  # string
      dataType: SomeValue  # string
      defaultValue: SomeValue  # string
      description: SomeValue  # string
      displayName: SomeValue  # string
      group: SomeValue  # string
      id: SomeValue  # string
      instructionText: SomeValue  # string
      key: SomeValue  # string
      notParam: True  # boolean
      order: 1  #  integer
      paramArray: True  # boolean
      parameterName: SomeValue  # string
      provider: SomeValue  # string
      range:
      - id: SomeValue  # string
        maxValue: 1  #  integer
        minValue: 1  #  integer
      required: True  # boolean
      selection:
        id: SomeValue  # string
        selectionType: SomeValue  # string
        selectionValues:
    softwareType: SomeValue  # string
    softwareVariant: SomeValue  # string
    softwareVersion: SomeValue  # string
    tags:
    - SomeValue  # string
    templateContent: SomeValue  # string
    templateParams:
    - binding: SomeValue  # string
      dataType: SomeValue  # string
      defaultValue: SomeValue  # string
      description: SomeValue  # string
      displayName: SomeValue  # string
      group: SomeValue  # string
      id: SomeValue  # string
      instructionText: SomeValue  # string
      key: SomeValue  # string
      notParam: True  # boolean
      order: 1  #  integer
      paramArray: True  # boolean
      parameterName: SomeValue  # string
      provider: SomeValue  # string
      range:
      - id: SomeValue  # string
        maxValue: 1  #  integer
        minValue: 1  #  integer
      required: True  # boolean
      selection:
        id: SomeValue  # string
        selectionType: SomeValue  # string
        selectionValues:
    version: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: gets_the_templates_available
  cisco.dnac.template:
    state: query  # required
    filter_conflicting_templates: True  # boolean
    product_family: SomeValue  # string
    product_series: SomeValue  # string
    product_type: SomeValue  # string
    project_id: SomeValue  # string
    software_type: SomeValue  # string
    software_version: SomeValue  # string
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: update_template
  cisco.dnac.template:
    state: update  # required
    author: SomeValue  # string
    composite: True  # boolean
    containingTemplates:
    - composite: True  # boolean
      id: SomeValue  # string
      name: SomeValue  # string
      version: SomeValue  # string
    createTime: 1  #  integer
    description: SomeValue  # string
    deviceTypes:
    - productFamily: SomeValue  # string
      productSeries: SomeValue  # string
      productType: SomeValue  # string
    failurePolicy: SomeValue  # string, valid values: 'ABORT_ON_ERROR', 'CONTINUE_ON_ERROR', 'ROLLBACK_ON_ERROR', 'ROLLBACK_TARGET_ON_ERROR', 'ABORT_TARGET_ON_ERROR'.
    id: SomeValue  # string
    lastUpdateTime: 1  #  integer
    name: SomeValue  # string
    parentTemplateId: SomeValue  # string
    projectId: SomeValue  # string
    projectName: SomeValue  # string
    rollbackTemplateContent: SomeValue  # string
    rollbackTemplateParams:
    - binding: SomeValue  # string
      dataType: SomeValue  # string
      defaultValue: SomeValue  # string
      description: SomeValue  # string
      displayName: SomeValue  # string
      group: SomeValue  # string
      id: SomeValue  # string
      instructionText: SomeValue  # string
      key: SomeValue  # string
      notParam: True  # boolean
      order: 1  #  integer
      paramArray: True  # boolean
      parameterName: SomeValue  # string
      provider: SomeValue  # string
      range:
      - id: SomeValue  # string
        maxValue: 1  #  integer
        minValue: 1  #  integer
      required: True  # boolean
      selection:
        id: SomeValue  # string
        selectionType: SomeValue  # string
        selectionValues:
    softwareType: SomeValue  # string
    softwareVariant: SomeValue  # string
    softwareVersion: SomeValue  # string
    tags:
    - SomeValue  # string
    templateContent: SomeValue  # string
    templateParams:
    - binding: SomeValue  # string
      dataType: SomeValue  # string
      defaultValue: SomeValue  # string
      description: SomeValue  # string
      displayName: SomeValue  # string
      group: SomeValue  # string
      id: SomeValue  # string
      instructionText: SomeValue  # string
      key: SomeValue  # string
      notParam: True  # boolean
      order: 1  #  integer
      paramArray: True  # boolean
      parameterName: SomeValue  # string
      provider: SomeValue  # string
      range:
      - id: SomeValue  # string
        maxValue: 1  #  integer
        minValue: 1  #  integer
      required: True  # boolean
      selection:
        id: SomeValue  # string
        selectionType: SomeValue  # string
        selectionValues:
    version: SomeValue  # string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_template_details
  cisco.dnac.template:
    state: query  # required
    template_id: SomeValue  # string, required
    latest_version: True  # boolean
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: delete_template
  cisco.dnac.template:
    state: delete  # required
    template_id: SomeValue  # string, required

Inputs

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

name:
    description:
    - TemplateDTO's name.
    type: str

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

author:
    description:
    - TemplateDTO's author.
    type: str

version:
    description:
    - TemplateDTO's version.
    type: str

composite:
    description:
    - TemplateDTO's composite.
    type: bool

projectId:
    description:
    - TemplateDTO's projectId.
    type: str

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

project_id:
    description:
    - ProjectId path parameter.
    - ProjectId query parameter.
    - Required for state create.
    required: true
    type: str

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

deviceTypes:
    description:
    - TemplateDTO's deviceTypes (list of objects).
    elements: dict
    suboptions:
      productFamily:
        description:
        - It is the Template's productFamily.
        type: str
      productSeries:
        description:
        - It is the Template's productSeries.
        type: str
      productType:
        description:
        - It is the Template's productType.
        type: str
    type: list

projectName:
    description:
    - TemplateDTO's projectName.
    type: str

template_id:
    description:
    - TemplateId path parameter.
    required: true
    type: str

product_type:
    description:
    - ProductType query parameter.
    type: str

softwareType:
    description:
    - TemplateDTO's softwareType.
    type: str

failurePolicy:
    description:
    - TemplateDTO's failurePolicy.
    type: str

software_type:
    description:
    - SoftwareType query parameter.
    type: str

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

latest_version:
    description:
    - LatestVersion query parameter.
    type: bool

product_family:
    description:
    - ProductFamily query parameter.
    type: str

product_series:
    description:
    - ProductSeries query parameter.
    type: str

templateParams:
    description:
    - TemplateDTO's TemplateParams (list of objects).
    elements: dict
    suboptions:
      binding:
        description:
        - It is the Template's binding.
        type: str
      dataType:
        description:
        - It is the Template's dataType.
        type: str
      defaultValue:
        description:
        - It is the Template's defaultValue.
        type: str
      description:
        description:
        - It is the Template's description.
        type: str
      displayName:
        description:
        - It is the Template's displayName.
        type: str
      group:
        description:
        - It is the Template's group.
        type: str
      id:
        description:
        - It is the Template's id.
        type: str
      instructionText:
        description:
        - It is the Template's instructionText.
        type: str
      key:
        description:
        - It is the Template's key.
        type: str
      notParam:
        description:
        - It is the Template's notParam.
        type: bool
      order:
        description:
        - It is the Template's order.
        type: int
      paramArray:
        description:
        - It is the Template's paramArray.
        type: bool
      parameterName:
        description:
        - It is the Template's parameterName.
        type: str
      provider:
        description:
        - It is the Template's provider.
        type: str
      range:
        description:
        - It is the Template's range.
        elements: dict
        suboptions:
          id:
            description:
            - It is the Template's id.
            type: str
          maxValue:
            description:
            - It is the Template's maxValue.
            type: int
          minValue:
            description:
            - It is the Template's minValue.
            type: int
        type: list
      required:
        description:
        - It is the Template's required.
        type: bool
      selection:
        description:
        - It is the Template's selection.
        suboptions:
          id:
            description:
            - It is the Template's id.
            type: str
          selectionType:
            description:
            - It is the Template's selectionType.
            type: str
          selectionValues:
            description:
            - It is the Template's selectionValues.
            type: dict
        type: dict
    type: list

softwareVariant:
    description:
    - TemplateDTO's softwareVariant.
    type: str

softwareVersion:
    description:
    - TemplateDTO's softwareVersion.
    type: str

templateContent:
    description:
    - TemplateDTO's TemplateContent.
    type: str

parentTemplateId:
    description:
    - TemplateDTO's parentTemplateId.
    type: str

software_version:
    description:
    - SoftwareVersion query parameter.
    type: str

containingTemplates:
    description:
    - TemplateDTO's containingTemplates (list of objects).
    elements: dict
    suboptions:
      composite:
        description:
        - It is the Template's composite.
        type: bool
      id:
        description:
        - It is the Template's id.
        type: str
      name:
        description:
        - It is the Template's name.
        type: str
      version:
        description:
        - It is the Template's version.
        type: str
    type: list

rollbackTemplateParams:
    description:
    - TemplateDTO's rollbackTemplateParams (list of objects).
    elements: dict
    suboptions:
      binding:
        description:
        - It is the Template's binding.
        type: str
      dataType:
        description:
        - It is the Template's dataType.
        type: str
      defaultValue:
        description:
        - It is the Template's defaultValue.
        type: str
      description:
        description:
        - It is the Template's description.
        type: str
      displayName:
        description:
        - It is the Template's displayName.
        type: str
      group:
        description:
        - It is the Template's group.
        type: str
      id:
        description:
        - It is the Template's id.
        type: str
      instructionText:
        description:
        - It is the Template's instructionText.
        type: str
      key:
        description:
        - It is the Template's key.
        type: str
      notParam:
        description:
        - It is the Template's notParam.
        type: bool
      order:
        description:
        - It is the Template's order.
        type: int
      paramArray:
        description:
        - It is the Template's paramArray.
        type: bool
      parameterName:
        description:
        - It is the Template's parameterName.
        type: str
      provider:
        description:
        - It is the Template's provider.
        type: str
      range:
        description:
        - It is the Template's range.
        elements: dict
        suboptions:
          id:
            description:
            - It is the Template's id.
            type: str
          maxValue:
            description:
            - It is the Template's maxValue.
            type: int
          minValue:
            description:
            - It is the Template's minValue.
            type: int
        type: list
      required:
        description:
        - It is the Template's required.
        type: bool
      selection:
        description:
        - It is the Template's selection.
        suboptions:
          id:
            description:
            - It is the Template's id.
            type: str
          selectionType:
            description:
            - It is the Template's selectionType.
            type: str
          selectionValues:
            description:
            - It is the Template's selectionValues.
            type: dict
        type: dict
    type: list

rollbackTemplateContent:
    description:
    - TemplateDTO's rollbackTemplateContent.
    type: str

filter_conflicting_templates:
    description:
    - FilterConflictingTemplates query parameter.
    type: bool

Outputs

create_template:
  contains: null
  description: Creates a new Template.
  response:
    contains:
      taskId:
        description: It is the Template's taskId.
        returned: success
        type: dict
      url:
        description: It is the Template's url.
        returned: success
        sample: <url>
        type: str
    description: TemplateDTO's response.
    returned: success
    type: dict
  returned: success
  type: dict
  version:
    description: TemplateDTO's version.
    returned: success
    sample: '1.0'
    type: str
delete_template:
  contains: null
  description: Deletes an existing Template.
  response:
    contains:
      taskId:
        description: It is the Template's taskId.
        returned: success
        type: dict
      url:
        description: It is the Template'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_template_details:
  author:
    description: Author, property of the response body.
    returned: always
    sample: <author>
    type: str
  composite:
    description: Composite, property of the response body.
    returned: always
    sample: false
    type: bool
  containingTemplates:
    contains:
      composite:
        description: It is the Template's composite.
        returned: always
        sample: false
        type: bool
      id:
        description: It is the Template's id.
        returned: always
        sample: '478012'
        type: str
      name:
        description: It is the Template's name.
        returned: always
        sample: <name>
        type: str
      version:
        description: It is the Template's version.
        returned: always
        sample: '1.0'
        type: str
    description: ContainingTemplates, property of the response body (list of objects).
    returned: always
    type: list
  contains: null
  createTime:
    description: CreateTime, property of the response body.
    returned: always
    sample: 0
    type: int
  description:
    description: Description, property of the response body.
    returned: always
    sample: <description>
    type: str
  deviceTypes:
    contains:
      productFamily:
        description: It is the Template's productFamily.
        returned: always
        sample: <productfamily>
        type: str
      productSeries:
        description: It is the Template's productSeries.
        returned: always
        sample: <productseries>
        type: str
      productType:
        description: It is the Template's productType.
        returned: always
        sample: <producttype>
        type: str
    description: DeviceTypes, property of the response body (list of objects).
    returned: always
    type: list
  failurePolicy:
    description: FailurePolicy, property of the response body.
    returned: always
    sample: <failurepolicy>
    type: str
  id:
    description: Id, property of the response body.
    returned: always
    sample: '478012'
    type: str
  lastUpdateTime:
    description: LastUpdateTime, property of the response body.
    returned: always
    sample: 0
    type: int
  name:
    description: Name, property of the response body.
    returned: always
    sample: <name>
    type: str
  parentTemplateId:
    description: ParentTemplateId, property of the response body.
    returned: always
    sample: <parenttemplateid>
    type: str
  projectId:
    description: ProjectId, property of the response body.
    returned: always
    sample: <projectid>
    type: str
  projectName:
    description: ProjectName, property of the response body.
    returned: always
    sample: <projectname>
    type: str
  returned: always
  rollbackTemplateContent:
    description: RollbackTemplateContent, property of the response body.
    returned: always
    sample: <rollbacktemplatecontent>
    type: str
  rollbackTemplateParams:
    contains:
      binding:
        description: It is the Template's binding.
        returned: always
        sample: <binding>
        type: str
      dataType:
        description: It is the Template's dataType.
        returned: always
        sample: <datatype>
        type: str
      defaultValue:
        description: It is the Template's defaultValue.
        returned: always
        sample: <defaultvalue>
        type: str
      description:
        description: It is the Template's description.
        returned: always
        sample: <description>
        type: str
      displayName:
        description: It is the Template's displayName.
        returned: always
        sample: <displayname>
        type: str
      group:
        description: It is the Template's group.
        returned: always
        sample: <group>
        type: str
      id:
        description: It is the Template's id.
        returned: always
        sample: '478012'
        type: str
      instructionText:
        description: It is the Template's instructionText.
        returned: always
        sample: <instructiontext>
        type: str
      key:
        description: It is the Template's key.
        returned: always
        sample: <key>
        type: str
      notParam:
        description: It is the Template's notParam.
        returned: always
        sample: false
        type: bool
      order:
        description: It is the Template's order.
        returned: always
        sample: 0
        type: int
      paramArray:
        description: It is the Template's paramArray.
        returned: always
        sample: false
        type: bool
      parameterName:
        description: It is the Template's parameterName.
        returned: always
        sample: <parametername>
        type: str
      provider:
        description: It is the Template's provider.
        returned: always
        sample: <provider>
        type: str
      range:
        contains:
          id:
            description: It is the Template's id.
            returned: always
            sample: '478012'
            type: str
          maxValue:
            description: It is the Template's maxValue.
            returned: always
            sample: 0
            type: int
          minValue:
            description: It is the Template's minValue.
            returned: always
            sample: 0
            type: int
        description: It is the Template's range.
        returned: always
        type: list
      required:
        description: It is the Template's required.
        returned: always
        sample: false
        type: bool
      selection:
        contains:
          id:
            description: It is the Template's id.
            returned: always
            sample: '478012'
            type: str
          selectionType:
            description: It is the Template's selectionType.
            returned: always
            sample: <selectiontype>
            type: str
          selectionValues:
            description: It is the Template's selectionValues.
            returned: always
            type: dict
        description: It is the Template's selection.
        returned: always
        type: dict
    description: RollbackTemplateParams, property of the response body (list of objects).
    returned: always
    type: list
  softwareType:
    description: SoftwareType, property of the response body.
    returned: always
    sample: <softwaretype>
    type: str
  softwareVariant:
    description: SoftwareVariant, property of the response body.
    returned: always
    sample: <softwarevariant>
    type: str
  softwareVersion:
    description: SoftwareVersion, property of the response body.
    returned: always
    sample: <softwareversion>
    type: str
  tags:
    description: Tags, property of the response body (list of strings).
    returned: always
    type: list
  templateContent:
    description: TemplateContent, property of the response body.
    returned: always
    sample: <templatecontent>
    type: str
  templateParams:
    contains:
      binding:
        description: It is the Template's binding.
        returned: always
        sample: <binding>
        type: str
      dataType:
        description: It is the Template's dataType.
        returned: always
        sample: <datatype>
        type: str
      defaultValue:
        description: It is the Template's defaultValue.
        returned: always
        sample: <defaultvalue>
        type: str
      description:
        description: It is the Template's description.
        returned: always
        sample: <description>
        type: str
      displayName:
        description: It is the Template's displayName.
        returned: always
        sample: <displayname>
        type: str
      group:
        description: It is the Template's group.
        returned: always
        sample: <group>
        type: str
      id:
        description: It is the Template's id.
        returned: always
        sample: '478012'
        type: str
      instructionText:
        description: It is the Template's instructionText.
        returned: always
        sample: <instructiontext>
        type: str
      key:
        description: It is the Template's key.
        returned: always
        sample: <key>
        type: str
      notParam:
        description: It is the Template's notParam.
        returned: always
        sample: false
        type: bool
      order:
        description: It is the Template's order.
        returned: always
        sample: 0
        type: int
      paramArray:
        description: It is the Template's paramArray.
        returned: always
        sample: false
        type: bool
      parameterName:
        description: It is the Template's parameterName.
        returned: always
        sample: <parametername>
        type: str
      provider:
        description: It is the Template's provider.
        returned: always
        sample: <provider>
        type: str
      range:
        contains:
          id:
            description: It is the Template's id.
            returned: always
            sample: '478012'
            type: str
          maxValue:
            description: It is the Template's maxValue.
            returned: always
            sample: 0
            type: int
          minValue:
            description: It is the Template's minValue.
            returned: always
            sample: 0
            type: int
        description: It is the Template's range.
        returned: always
        type: list
      required:
        description: It is the Template's required.
        returned: always
        sample: false
        type: bool
      selection:
        contains:
          id:
            description: It is the Template's id.
            returned: always
            sample: '478012'
            type: str
          selectionType:
            description: It is the Template's selectionType.
            returned: always
            sample: <selectiontype>
            type: str
          selectionValues:
            description: It is the Template's selectionValues.
            returned: always
            type: dict
        description: It is the Template's selection.
        returned: always
        type: dict
    description: TemplateParams, property of the response body (list of objects).
    returned: always
    type: list
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
gets_the_templates_available:
  contains: null
  description: List the Templates available.
  returned: always
  type: dict
update_template:
  contains: null
  description: Updates an existing Template.
  response:
    contains:
      taskId:
        description: It is the Template's taskId.
        returned: changed
        type: dict
      url:
        description: It is the Template's url.
        returned: changed
        sample: <url>
        type: str
    description: TemplateDTO's response.
    returned: changed
    type: dict
  returned: changed
  type: dict
  version:
    description: TemplateDTO's version.
    returned: changed
    sample: '1.0'
    type: str

See also