cisco.dnac.pnp_workflow 模块 – PnP 工作流资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在剧本中使用它，请指定：cisco.dnac.pnp_workflow。
cisco.dnac 3.1.0 中的新增功能
概要
此模块表示模块 pnp_workflow_v1 的别名。
注意
此模块具有相应的 action 插件。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
PnP 工作流的 _id。 |
|
PnP 工作流的 addedOn。 |
|
AddToInventory 标志。 选项
|
|
PnP 工作流的 configId。 |
|
PnP 工作流的 currTaskIdx。 |
|
PnP 工作流的描述。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
PnP 工作流的 endTime。 |
|
PnP 工作流的 execTime。 |
|
Id 路径参数。 |
|
PnP 工作流的 imageId。 |
|
PnP 工作流的 instanceType。 |
|
PnP 工作流的 lastupdateOn。 |
|
PnP 工作流的名称。 |
|
PnP 工作流的 startTime。 |
|
PnP 工作流的状态。 |
|
PnP 工作流的任务。 |
|
PnP 工作流的 currWorkItemIdx。 |
|
PnP 工作流的 endTime。 |
|
PnP 工作流的名称。 |
|
PnP 工作流的 startTime。 |
|
PnP 工作流的状态。 |
|
PnP 工作流的 taskSeqNo。 |
|
PnP 工作流的 timeTaken。 |
|
PnP 工作流的类型。 |
|
PnP 工作流的 workItemList。 |
|
PnP 工作流的 command。 |
|
PnP 工作流的 endTime。 |
|
PnP 工作流的 outputStr。 |
|
PnP 工作流的 startTime。 |
|
PnP 工作流的状态。 |
|
PnP 工作流的 timeTaken。 |
|
PnP 工作流的 tenantId。 |
|
PnP 工作流的类型。 |
|
PnP 工作流的 useState。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
|
PnP 工作流的版本。 |
备注
注意
使用的 SDK 方法为 device_onboarding_pnp.DeviceOnboardingPnp.add_a_workflow_v1、device_onboarding_pnp.DeviceOnboardingPnp.delete_workflow_by_id_v1、device_onboarding_pnp.DeviceOnboardingPnp.update_workflow_v1，
使用的路径为 post /dna/intent/api/v1/onboarding/pnp-workflow、delete /dna/intent/api/v1/onboarding/pnp-workflow/{id}、put /dna/intent/api/v1/onboarding/pnp-workflow/{id}，
需要注意的是，此模块是 pnp_workflow_v1 的别名。
不支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 设备上线 (PnP) AddAWorkflowV1 的文档
AddAWorkflowV1 API 的完整参考。
- 思科 DNA Center 设备上线 (PnP) DeleteWorkflowByIdV1 文档
DeleteWorkflowByIdV1 API 的完整参考。
- 思科 DNA Center 设备上线 (PnP) UpdateWorkflowV1 文档
UpdateWorkflowV1 API 的完整参考。
示例
- name: Create
cisco.dnac.pnp_workflow:
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}}"
state: present
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state_: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
- name: Delete by id
cisco.dnac.pnp_workflow:
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}}"
state: absent
id: string
- name: Update by id
cisco.dnac.pnp_workflow:
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}}"
state: present
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
id: string
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state_: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含思科 DNAC Python SDK 返回的响应的字典或列表 返回值：始终返回 示例： |