cisco.dnac.pnp_workflow_v1_info 模块 – Pnp Workflow V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.dnac.pnp_workflow_v1_info。
cisco.dnac 3.1.0 中的新功能
概要
获取所有 Pnp Workflow V1。
按 ID 获取 Pnp Workflow V1。
返回由 ID 指定的工作流。
返回基于筛选条件的工作流列表。如果未指定限制，则默认返回 50 个工作流。此端点也支持分页和排序。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
用于 Cisco DNA Center SDK 启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认值: |
|
其他标头。 |
|
Id 路径参数。 |
|
限制查询参数。限制结果数。 |
|
名称查询参数。工作流名称。 |
|
偏移查询参数。第一个结果的索引。 |
|
排序查询参数。以逗号分隔的要排序的字段列表。 |
|
SortOrder 查询参数。排序顺序升序 (asc) 或降序 (des)。 |
|
类型查询参数。工作流类型。 |
|
用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求主体的标志。 选项
|
注意
注意
使用的 SDK 方法是 device_onboarding_pnp.DeviceOnboardingPnp.get_workflow_by_id_v1, device_onboarding_pnp.DeviceOnboardingPnp.get_workflows_v1,
使用的路径是 get /dna/intent/api/v1/onboarding/pnp-workflow, get /dna/intent/api/v1/onboarding/pnp-workflow/{id},
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 文档，了解设备入职 (PnP) GetWorkflowByIdV1
GetWorkflowByIdV1 API 的完整参考。
- Cisco DNA Center 文档，了解设备入职 (PnP) GetWorkflowsV1
GetWorkflowsV1 API 的完整参考。
示例
- name: Get all Pnp Workflow V1
cisco.dnac.pnp_workflow_v1_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
- name: Get Pnp Workflow V1 by id
cisco.dnac.pnp_workflow_v1_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
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回: 始终 示例: |