.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.pnp_workflow_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.pnp_workflow -- Manage PnpWorkflow objects of DeviceOnboardingPnp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.pnp_workflow`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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. - Adds a PnP Workflow along with the relevant tasks in the workflow into the PnP database. - Returns a workflow specified by id. - Deletes a workflow specified by id. - Updates an existing workflow. - Returns the workflow count. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
_id
string
Workflow's _id.
_state
string
Workflow's state.
addedOn
integer
Workflow's addedOn.
addToInventory
boolean
    Choices:
  • no
  • yes
Workflow's addToInventory.
configId
string
Workflow's configId.
count
boolean
    Choices:
  • no
  • yes
If true gets the number of objects.
Required for state query.
currTaskIdx
integer
Workflow's currTaskIdx.
description
string
Workflow's description.
endTime
integer
Workflow's endTime.
execTime
integer
Workflow's execTime.
id
string / required
Id path parameter.
imageId
string
Workflow's imageId.
instanceType
string
Workflow's instanceType.
lastupdateOn
integer
Workflow's lastupdateOn.
limit
integer
Limits number of results.
name
string
Workflow Name.
Workflow's name.
offset
integer
Index of first result.
sort
string
Comma seperated lost of fields to sort on.
sort_order
string
Sort Order Ascending (asc) or Descending (des).
startTime
integer
Workflow's startTime.
tasks
list / elements=dictionary
Workflow's tasks (list of objects).
currWorkItemIdx
integer
It is the pnp workflow's currWorkItemIdx.
endTime
integer
It is the pnp workflow's endTime.
name
string
It is the pnp workflow's name.
startTime
integer
It is the pnp workflow's startTime.
state
string
It is the pnp workflow's state.
taskSeqNo
integer
It is the pnp workflow's taskSeqNo.
timeTaken
integer
It is the pnp workflow's timeTaken.
type
string
It is the pnp workflow's type.
workItemList
list / elements=dictionary
It is the pnp workflow's workItemList.
command
string
It is the pnp workflow's command.
endTime
integer
It is the pnp workflow's endTime.
outputStr
string
It is the pnp workflow's outputStr.
startTime
integer
It is the pnp workflow's startTime.
state
string
It is the pnp workflow's state.
timeTaken
integer
It is the pnp workflow's timeTaken.
tenantId
string
Workflow's tenantId.
type
string
Workflow Type.
Workflow's type.
useState
string
Workflow's useState.
version
integer
Workflow's version.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.pnp_workflow ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.pnp_workflow** module. `PnpWorkflow reference `_ Complete reference of the PnpWorkflow object model. `PnpWorkflow reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: get_workflows cisco.dnac.pnp_workflow: state: query # required limit: 1 # integer name: SomeValue # string offset: 1 # integer sort: SomeValue # string sort_order: SomeValue # string type: SomeValue # string register: nm_get_workflows - name: add_a_workflow cisco.dnac.pnp_workflow: state: create # required _id: SomeValue # string addToInventory: True # boolean addedOn: 1 # integer configId: SomeValue # string currTaskIdx: 1 # integer description: SomeValue # string endTime: 1 # integer execTime: 1 # integer imageId: SomeValue # string instanceType: # valid values are 'SystemWorkflow', # 'UserWorkflow', # 'SystemResetWorkflow'. SomeValue # string lastupdateOn: 1 # integer name: SomeValue # string startTime: 1 # integer _state: SomeValue # string tasks: - currWorkItemIdx: 1 # integer endTime: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string taskSeqNo: 1 # integer timeTaken: 1 # integer type: SomeValue # string workItemList: - command: SomeValue # string endTime: 1 # integer outputStr: SomeValue # string startTime: 1 # integer state: SomeValue # string timeTaken: 1 # integer tenantId: SomeValue # string type: SomeValue # string useState: SomeValue # string version: 1 # integer - name: get_workflow_by_id cisco.dnac.pnp_workflow: state: query # required id: SomeValue # string, required register: nm_get_workflow_by_id - name: delete_workflow_by_id cisco.dnac.pnp_workflow: state: delete # required id: SomeValue # string, required - name: update_workflow cisco.dnac.pnp_workflow: state: update # required id: SomeValue # string, required _id: SomeValue # string addToInventory: True # boolean addedOn: 1 # integer configId: SomeValue # string currTaskIdx: 1 # integer description: SomeValue # string endTime: 1 # integer execTime: 1 # integer imageId: SomeValue # string instanceType: # valid values are 'SystemWorkflow', # 'UserWorkflow', # 'SystemResetWorkflow'. SomeValue # string lastupdateOn: 1 # integer name: SomeValue # string startTime: 1 # integer _state: SomeValue # string tasks: - currWorkItemIdx: 1 # integer endTime: 1 # integer name: SomeValue # string startTime: 1 # integer state: SomeValue # string taskSeqNo: 1 # integer timeTaken: 1 # integer type: SomeValue # string workItemList: - command: SomeValue # string endTime: 1 # integer outputStr: SomeValue # string startTime: 1 # integer state: SomeValue # string timeTaken: 1 # integer tenantId: SomeValue # string type: SomeValue # string useState: SomeValue # string version: 1 # integer - name: get_workflow_count cisco.dnac.pnp_workflow: state: query # required count: True # boolean, required name: SomeValue # string register: nm_get_workflow_count .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
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:
device_onboarding_pnp.add_a_workflow


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors