Try SpotterManage PnpWorkflow objects of DeviceOnboardingPnp
| "added in version" 1.0 of racampos.dnac"
Authors: first last (@GitHubID)
preview | supported by community
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install racampos.dnac:==0.0.1
collections:
- name: racampos.dnac
version: 0.0.1Returns 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.
- 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: query_result
- 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: SomeValue # string, valid values: 'SystemWorkflow', 'UserWorkflow', 'SystemResetWorkflow'.
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: query_result
- 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: SomeValue # string, valid values: 'SystemWorkflow', 'UserWorkflow', 'SystemResetWorkflow'.
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: query_result
id:
description:
- Id path parameter.
required: true
type: str
_id:
description:
- Workflow's _id.
type: str
name:
description:
- Workflow Name.
- Workflow's name.
type: str
sort:
description:
- Comma seperated lost of fields to sort on.
type: str
type:
description:
- Workflow Type.
- Workflow's type.
type: str
count:
description:
- If true gets the number of objects.
- Required for state query.
type: bool
limit:
description:
- Limits number of results.
type: int
state:
description:
- Workflow's state.
type: str
tasks:
description:
- Workflow's tasks (list of objects).
elements: dict
suboptions:
currWorkItemIdx:
description:
- It is the pnp workflow's currWorkItemIdx.
type: int
endTime:
description:
- It is the pnp workflow's endTime.
type: int
name:
description:
- It is the pnp workflow's name.
type: str
startTime:
description:
- It is the pnp workflow's startTime.
type: int
state:
description:
- It is the pnp workflow's state.
type: str
taskSeqNo:
description:
- It is the pnp workflow's taskSeqNo.
type: int
timeTaken:
description:
- It is the pnp workflow's timeTaken.
type: int
type:
description:
- It is the pnp workflow's type.
type: str
workItemList:
description:
- It is the pnp workflow's workItemList.
elements: dict
suboptions:
command:
description:
- It is the pnp workflow's command.
type: str
endTime:
description:
- It is the pnp workflow's endTime.
type: int
outputStr:
description:
- It is the pnp workflow's outputStr.
type: str
startTime:
description:
- It is the pnp workflow's startTime.
type: int
state:
description:
- It is the pnp workflow's state.
type: str
timeTaken:
description:
- It is the pnp workflow's timeTaken.
type: int
type: list
type: list
offset:
description:
- Index of first result.
type: int
addedOn:
description:
- Workflow's addedOn.
type: int
endTime:
description:
- Workflow's endTime.
type: int
imageId:
description:
- Workflow's imageId.
type: str
version:
description:
- Workflow's version.
type: int
configId:
description:
- Workflow's configId.
type: str
execTime:
description:
- Workflow's execTime.
type: int
tenantId:
description:
- Workflow's tenantId.
type: str
useState:
description:
- Workflow's useState.
type: str
startTime:
description:
- Workflow's startTime.
type: int
sort_order:
description:
- Sort Order Ascending (asc) or Descending (des).
type: str
currTaskIdx:
description:
- Workflow's currTaskIdx.
type: int
description:
description:
- Workflow's description.
type: str
instanceType:
description:
- Workflow's instanceType.
type: str
lastupdateOn:
description:
- Workflow's lastupdateOn.
type: int
addToInventory:
description:
- Workflow's addToInventory.
type: bool
add_a_workflow:
_id:
description: Workflow's Id.
returned: success
sample: <_id>
type: str
addToInventory:
description: Workflow's addToInventory.
returned: success
sample: false
type: bool
addedOn:
description: Workflow's addedOn.
returned: success
sample: 0
type: int
configId:
description: Workflow's Config Id.
returned: success
sample: <configid>
type: str
contains: null
currTaskIdx:
description: Workflow's currTaskIdx.
returned: success
sample: 0
type: int
description:
description: Workflow's Description.
returned: success
sample: <description>
type: str
endTime:
description: Workflow's endTime.
returned: success
sample: 0
type: int
execTime:
description: Workflow's execTime.
returned: success
sample: 0
type: int
imageId:
description: Workflow's Image Id.
returned: success
sample: <imageid>
type: str
instanceType:
description: Workflow's Instance Type.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: Workflow's lastupdateOn.
returned: success
sample: 0
type: int
name:
description: Workflow's Name.
returned: success
sample: <name>
type: str
returned: success
startTime:
description: Workflow's startTime.
returned: success
sample: 0
type: int
state:
description: Workflow's State.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp workflow's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp workflow's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp workflow's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp workflow's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp workflow's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp workflow's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp workflow's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp workflow's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp workflow's workItemList.
returned: success
type: list
description: Workflow's Tasks (list of objects).
returned: success
type: list
tenantId:
description: Workflow's Tenant Id.
returned: success
sample: <tenantid>
type: str
type:
description: Workflow's Type.
returned: success
sample: <type>
type: str
useState:
description: Workflow's Use State.
returned: success
sample: <usestate>
type: str
version:
description: Workflow's version.
returned: success
sample: 0
type: int
delete_workflow_by_id:
_id:
description: Id, property of the response body.
returned: success
sample: <_id>
type: str
addToInventory:
description: AddToInventory, property of the response body.
returned: success
sample: false
type: bool
addedOn:
description: AddedOn, property of the response body.
returned: success
sample: 0
type: int
configId:
description: Config Id, property of the response body.
returned: success
sample: <configid>
type: str
contains: null
currTaskIdx:
description: CurrTaskIdx, property of the response body.
returned: success
sample: 0
type: int
description:
description: Description, property of the response body.
returned: success
sample: <description>
type: str
endTime:
description: EndTime, property of the response body.
returned: success
sample: 0
type: int
execTime:
description: ExecTime, property of the response body.
returned: success
sample: 0
type: int
imageId:
description: Image Id, property of the response body.
returned: success
sample: <imageid>
type: str
instanceType:
description: Instance Type, property of the response body.
returned: success
sample: <instancetype>
type: str
lastupdateOn:
description: LastupdateOn, property of the response body.
returned: success
sample: 0
type: int
name:
description: Name, property of the response body.
returned: success
sample: <name>
type: str
returned: success
startTime:
description: StartTime, property of the response body.
returned: success
sample: 0
type: int
state:
description: State, property of the response body.
returned: success
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp workflow's currWorkItemIdx.
returned: success
sample: 0
type: int
endTime:
description: It is the pnp workflow's endTime.
returned: success
sample: 0
type: int
name:
description: It is the pnp workflow's name.
returned: success
sample: <name>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: success
sample: <state>
type: str
taskSeqNo:
description: It is the pnp workflow's taskSeqNo.
returned: success
sample: 0
type: int
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: success
sample: 0
type: int
type:
description: It is the pnp workflow's type.
returned: success
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp workflow's command.
returned: success
sample: <command>
type: str
endTime:
description: It is the pnp workflow's endTime.
returned: success
sample: 0
type: int
outputStr:
description: It is the pnp workflow's outputStr.
returned: success
sample: <outputstr>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: success
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: success
sample: <state>
type: str
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: success
sample: 0
type: int
description: It is the pnp workflow's workItemList.
returned: success
type: list
description: Tasks, property of the response body (list of objects).
returned: success
type: list
tenantId:
description: Tenant Id, property of the response body.
returned: success
sample: <tenantid>
type: str
type:
description: Type, property of the response body.
returned: success
sample: <type>
type: str
useState:
description: Use State, property of the response body.
returned: success
sample: <usestate>
type: str
version:
description: Version, property of the response body.
returned: success
sample: 0
type: int
get_workflow_by_id:
_id:
description: Id, property of the response body.
returned: always
sample: <_id>
type: str
addToInventory:
description: AddToInventory, property of the response body.
returned: always
sample: false
type: bool
addedOn:
description: AddedOn, property of the response body.
returned: always
sample: 0
type: int
configId:
description: Config Id, property of the response body.
returned: always
sample: <configid>
type: str
contains: null
currTaskIdx:
description: CurrTaskIdx, 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
endTime:
description: EndTime, property of the response body.
returned: always
sample: 0
type: int
execTime:
description: ExecTime, property of the response body.
returned: always
sample: 0
type: int
imageId:
description: Image Id, property of the response body.
returned: always
sample: <imageid>
type: str
instanceType:
description: Instance Type, property of the response body.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: LastupdateOn, 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
returned: always
startTime:
description: StartTime, property of the response body.
returned: always
sample: 0
type: int
state:
description: State, property of the response body.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp workflow's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp workflow's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp workflow's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp workflow's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp workflow's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp workflow's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp workflow's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp workflow's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp workflow's workItemList.
returned: always
type: list
description: Tasks, property of the response body (list of objects).
returned: always
type: list
tenantId:
description: Tenant Id, property of the response body.
returned: always
sample: <tenantid>
type: str
type:
description: Type, property of the response body.
returned: always
sample: <type>
type: str
useState:
description: Use State, property of the response body.
returned: always
sample: <usestate>
type: str
version:
description: Version, property of the response body.
returned: always
sample: 0
type: int
get_workflow_count:
contains: null
description: Returns the workflow count.
response:
description: Response, property of the response body.
returned: always
sample: 0
type: int
returned: always
type: dict
get_workflows:
contains: null
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.
payload:
contains:
_id:
description: It is the pnp workflow's _id.
returned: always
sample: <_id>
type: str
addToInventory:
description: It is the pnp workflow's addToInventory.
returned: always
sample: false
type: bool
addedOn:
description: It is the pnp workflow's addedOn.
returned: always
sample: 0
type: int
configId:
description: It is the pnp workflow's configId.
returned: always
sample: <configid>
type: str
currTaskIdx:
description: It is the pnp workflow's currTaskIdx.
returned: always
sample: 0
type: int
description:
description: It is the pnp workflow's description.
returned: always
sample: <description>
type: str
endTime:
description: It is the pnp workflow's endTime.
returned: always
sample: 0
type: int
execTime:
description: It is the pnp workflow's execTime.
returned: always
sample: 0
type: int
imageId:
description: It is the pnp workflow's imageId.
returned: always
sample: <imageid>
type: str
instanceType:
description: It is the pnp workflow's instanceType.
returned: always
sample: <instancetype>
type: str
lastupdateOn:
description: It is the pnp workflow's lastupdateOn.
returned: always
sample: 0
type: int
name:
description: It is the pnp workflow's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: always
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp workflow's currWorkItemIdx.
returned: always
sample: 0
type: int
endTime:
description: It is the pnp workflow's endTime.
returned: always
sample: 0
type: int
name:
description: It is the pnp workflow's name.
returned: always
sample: <name>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: always
sample: <state>
type: str
taskSeqNo:
description: It is the pnp workflow's taskSeqNo.
returned: always
sample: 0
type: int
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: always
sample: 0
type: int
type:
description: It is the pnp workflow's type.
returned: always
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp workflow's command.
returned: always
sample: <command>
type: str
endTime:
description: It is the pnp workflow's endTime.
returned: always
sample: 0
type: int
outputStr:
description: It is the pnp workflow's outputStr.
returned: always
sample: <outputstr>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: always
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: always
sample: <state>
type: str
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: always
sample: 0
type: int
description: It is the pnp workflow's workItemList.
returned: always
type: list
description: It is the pnp workflow's tasks.
returned: always
type: list
tenantId:
description: It is the pnp workflow's tenantId.
returned: always
sample: <tenantid>
type: str
type:
description: It is the pnp workflow's type.
returned: always
sample: <type>
type: str
useState:
description: It is the pnp workflow's useState.
returned: always
sample: <usestate>
type: str
version:
description: It is the pnp workflow's version.
returned: always
sample: 0
type: int
description: It is the pnp workflow's payload.
returned: always
type: list
returned: always
type: dict
update_workflow:
_id:
description: Workflow's Id.
returned: changed
sample: <_id>
type: str
addToInventory:
description: Workflow's addToInventory.
returned: changed
sample: false
type: bool
addedOn:
description: Workflow's addedOn.
returned: changed
sample: 0
type: int
configId:
description: Workflow's Config Id.
returned: changed
sample: <configid>
type: str
contains: null
currTaskIdx:
description: Workflow's currTaskIdx.
returned: changed
sample: 0
type: int
description:
description: Workflow's Description.
returned: changed
sample: <description>
type: str
endTime:
description: Workflow's endTime.
returned: changed
sample: 0
type: int
execTime:
description: Workflow's execTime.
returned: changed
sample: 0
type: int
imageId:
description: Workflow's Image Id.
returned: changed
sample: <imageid>
type: str
instanceType:
description: Workflow's Instance Type.
returned: changed
sample: <instancetype>
type: str
lastupdateOn:
description: Workflow's lastupdateOn.
returned: changed
sample: 0
type: int
name:
description: Workflow's Name.
returned: changed
sample: <name>
type: str
returned: changed
startTime:
description: Workflow's startTime.
returned: changed
sample: 0
type: int
state:
description: Workflow's State.
returned: changed
sample: <state>
type: str
tasks:
contains:
currWorkItemIdx:
description: It is the pnp workflow's currWorkItemIdx.
returned: changed
sample: 0
type: int
endTime:
description: It is the pnp workflow's endTime.
returned: changed
sample: 0
type: int
name:
description: It is the pnp workflow's name.
returned: changed
sample: <name>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: changed
sample: <state>
type: str
taskSeqNo:
description: It is the pnp workflow's taskSeqNo.
returned: changed
sample: 0
type: int
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: changed
sample: 0
type: int
type:
description: It is the pnp workflow's type.
returned: changed
sample: <type>
type: str
workItemList:
contains:
command:
description: It is the pnp workflow's command.
returned: changed
sample: <command>
type: str
endTime:
description: It is the pnp workflow's endTime.
returned: changed
sample: 0
type: int
outputStr:
description: It is the pnp workflow's outputStr.
returned: changed
sample: <outputstr>
type: str
startTime:
description: It is the pnp workflow's startTime.
returned: changed
sample: 0
type: int
state:
description: It is the pnp workflow's state.
returned: changed
sample: <state>
type: str
timeTaken:
description: It is the pnp workflow's timeTaken.
returned: changed
sample: 0
type: int
description: It is the pnp workflow's workItemList.
returned: changed
type: list
description: Workflow's Tasks (list of objects).
returned: changed
type: list
tenantId:
description: Workflow's Tenant Id.
returned: changed
sample: <tenantid>
type: str
type:
description: Workflow's Type.
returned: changed
sample: <type>
type: str
useState:
description: Workflow's Use State.
returned: changed
sample: <usestate>
type: str
version:
description: Workflow's version.
returned: changed
sample: 0
type: int