cisco.dnac.pnp_workflow_info (6.13.3) — module

Information 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

Get all Pnp Workflow.

Get Pnp Workflow by id.

Returns a workflow specified by id.

Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get all Pnp Workflow
  cisco.dnac.pnp_workflow_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    limit: 0
    offset: 0
    sort: []
    sortOrder: string
    type: []
    name: []
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get Pnp Workflow by id
  cisco.dnac.pnp_workflow_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

Inputs

    
id:
    description:
    - Id path parameter.
    type: str

name:
    description:
    - Name query parameter. Workflow Name.
    elements: str
    type: list

sort:
    description:
    - Sort query parameter. Comma seperated lost of fields to sort on.
    elements: str
    type: list

type:
    description:
    - Type query parameter. Workflow Type.
    elements: str
    type: list

limit:
    description:
    - Limit query parameter. Limits number of results.
    type: int

offset:
    description:
    - Offset query parameter. Index of first result.
    type: int

headers:
    description: Additional headers.
    type: dict

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

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

sortOrder:
    description:
    - SortOrder query parameter. Sort Order Ascending (asc) or Descending (des).
    type: str

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

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

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

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