cisco.dnac.pnp_workflow (6.13.3) — module

Resource module for Pnp Workflow

| "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

Manage operations create, update and delete of the resource Pnp Workflow.

Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database.

Deletes a workflow specified by id.

Updates an existing workflow.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create
  cisco.dnac.pnp_workflow:
    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}}"
    state: present
    _id: string
    addToInventory: true
    addedOn: 0
    configId: string
    currTaskIdx: 0
    description: string
    endTime: 0
    execTime: 0
    imageId: string
    instanceType: string
    lastupdateOn: 0
    name: string
    startTime: 0
    state_: string
    tasks:
    - currWorkItemIdx: 0
      endTime: 0
      name: string
      startTime: 0
      state: string
      taskSeqNo: 0
      timeTaken: 0
      type: string
      workItemList:
      - command: string
        endTime: 0
        outputStr: string
        startTime: 0
        state: string
        timeTaken: 0
    tenantId: string
    type: string
    useState: string
    version: 0
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete by id
  cisco.dnac.pnp_workflow:
    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}}"
    state: absent
    id: string
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update by id
  cisco.dnac.pnp_workflow:
    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}}"
    state: present
    _id: string
    addToInventory: true
    addedOn: 0
    configId: string
    currTaskIdx: 0
    description: string
    endTime: 0
    execTime: 0
    id: string
    imageId: string
    instanceType: string
    lastupdateOn: 0
    name: string
    startTime: 0
    state_: string
    tasks:
    - currWorkItemIdx: 0
      endTime: 0
      name: string
      startTime: 0
      state: string
      taskSeqNo: 0
      timeTaken: 0
      type: string
      workItemList:
      - command: string
        endTime: 0
        outputStr: string
        startTime: 0
        state: string
        timeTaken: 0
    tenantId: string
    type: string
    useState: string
    version: 0

Inputs

    
id:
    description: Id path parameter.
    type: str

_id:
    description: Pnp Workflow's _id.
    type: str

name:
    description: Pnp Workflow's name.
    type: str

type:
    description: Pnp Workflow's type.
    type: str

tasks:
    description: Pnp Workflow's tasks.
    elements: dict
    suboptions:
      currWorkItemIdx:
        description: Pnp Workflow's currWorkItemIdx.
        type: int
      endTime:
        description: Pnp Workflow's endTime.
        type: int
      name:
        description: Pnp Workflow's name.
        type: str
      startTime:
        description: Pnp Workflow's startTime.
        type: int
      state:
        description: Pnp Workflow's state.
        type: str
      taskSeqNo:
        description: Pnp Workflow's taskSeqNo.
        type: int
      timeTaken:
        description: Pnp Workflow's timeTaken.
        type: int
      type:
        description: Pnp Workflow's type.
        type: str
      workItemList:
        description: Pnp Workflow's workItemList.
        elements: dict
        suboptions:
          command:
            description: Pnp Workflow's command.
            type: str
          endTime:
            description: Pnp Workflow's endTime.
            type: int
          outputStr:
            description: Pnp Workflow's outputStr.
            type: str
          startTime:
            description: Pnp Workflow's startTime.
            type: int
          state:
            description: Pnp Workflow's state.
            type: str
          timeTaken:
            description: Pnp Workflow's timeTaken.
            type: int
        type: list
    type: list

state_:
    description: Pnp Workflow's state.
    type: str

addedOn:
    description: Pnp Workflow's addedOn.
    type: int

endTime:
    description: Pnp Workflow's endTime.
    type: int

imageId:
    description: Pnp Workflow's imageId.
    type: str

version:
    description: Pnp Workflow's version.
    type: int

configId:
    description: Pnp Workflow's configId.
    type: str

execTime:
    description: Pnp Workflow's execTime.
    type: int

tenantId:
    description: Pnp Workflow's tenantId.
    type: str

useState:
    description: Pnp Workflow's useState.
    type: str

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

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

startTime:
    description: Pnp Workflow's startTime.
    type: int

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

currTaskIdx:
    description: Pnp Workflow's currTaskIdx.
    type: int

description:
    description: Pnp Workflow's description.
    type: str

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

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

instanceType:
    description: Pnp Workflow's instanceType.
    type: str

lastupdateOn:
    description: Pnp Workflow's lastupdateOn.
    type: int

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

addToInventory:
    description: AddToInventory flag.
    type: bool

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

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"_id\": \"string\",\n  \"state\": \"string\",\n  \"type\": \"string\"\
    ,\n  \"description\": \"string\",\n  \"lastupdateOn\": 0,\n  \"imageId\": \"string\"\
    ,\n  \"currTaskIdx\": 0,\n  \"addedOn\": 0,\n  \"tasks\": [\n    {\n      \"state\"\
    : \"string\",\n      \"type\": \"string\",\n      \"currWorkItemIdx\": 0,\n  \
    \    \"taskSeqNo\": 0,\n      \"endTime\": 0,\n      \"startTime\": 0,\n     \
    \ \"workItemList\": [\n        {\n          \"state\": \"string\",\n         \
    \ \"command\": \"string\",\n          \"outputStr\": \"string\",\n          \"\
    endTime\": 0,\n          \"startTime\": 0,\n          \"timeTaken\": 0\n     \
    \   }\n      ],\n      \"timeTaken\": 0,\n      \"name\": \"string\"\n    }\n\
    \  ],\n  \"addToInventory\": true,\n  \"instanceType\": \"string\",\n  \"endTime\"\
    : 0,\n  \"execTime\": 0,\n  \"startTime\": 0,\n  \"useState\": \"string\",\n \
    \ \"configId\": \"string\",\n  \"name\": \"string\",\n  \"version\": 0,\n  \"\
    tenantId\": \"string\"\n}\n"
  type: dict

See also