cisco.catalystcenter.pnp_workflow_info module -- Information module for Pnp Workflow Info
Note
This module is part of the cisco.catalystcenter collection (version 2.1.4).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.pnp_workflow_info.
New in cisco.catalystcenter 3.1.0
Synopsis
This module represents an alias of the module pnp_workflow_v1_info
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 2.3.7.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco CATALYST Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco CATALYST Center SDK to enable debugging. Choices: |
|
The Cisco CATALYST Center hostname. |
|
The Cisco CATALYST Center password to authenticate. |
|
The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Additional headers. |
|
Id path parameter. |
|
Limit query parameter. The number of records to show for this page. The minimum and maximum values are 0 and 500, respectively. |
|
Name query parameter. Workflow Name. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 0. The Minimum value is 0. |
|
Sort query parameter. Comma seperated lost of fields to sort on. |
|
SortOrder query parameter. Sort Order Ascending (asc) or Descending (des). |
|
Type query parameter. Workflow Type. |
|
Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.get_workflow_by_id_v1, device_onboarding_pnp.DeviceOnboardingPnp.get_workflows_v1,
Paths used are get /dna/intent/api/v1/onboarding/pnp-workflow, get /dna/intent/api/v1/onboarding/pnp-workflow/{id},
It should be noted that this module is an alias of pnp_workflow_v1_info
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK
The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Device Onboarding (PnP) GetWorkflowByIdV1
Complete reference of the GetWorkflowByIdV1 API.
- Cisco DNA Center documentation for Device Onboarding (PnP) GetWorkflowsV1
Complete reference of the GetWorkflowsV1 API.
Examples
- name: Get all Pnp Workflow Info
cisco.catalystcenter.pnp_workflow_info:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _debug }}"
headers: "{{my_headers | from_json}}"
limit: 0
offset: 0
sort: []
sortOrder: string
type: []
name: []
register: result
- name: Get Pnp Workflow Info by id
cisco.catalystcenter.pnp_workflow_info:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _debug }}"
headers: "{{my_headers | from_json}}"
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always |