cisco.dnac.pnp_workflow 模块 – Pnp 工作流的资源模块

注意

此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：cisco.dnac.pnp_workflow。

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 pnp_workflow_v1 的别名

注意

此模块具有相应的 操作插件。

要求

执行此模块的主机需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

_id

字符串

Pnp 工作流的 _id。

addedOn

整数

Pnp 工作流的 addedOn。

addToInventory

布尔值

AddToInventory 标志。

选择

  • false

  • true

configId

字符串

Pnp 工作流的 configId。

currTaskIdx

整数

Pnp 工作流的 currTaskIdx。

description

字符串

Pnp 工作流的描述。

dnac_debug

布尔值

Cisco DNA Center SDK 的标志，用于启用调试。

选择

  • false ← (默认)

  • true

dnac_host

字符串 / 必选

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值： 443

dnac_username

别名：user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值： "admin"

dnac_verify

布尔值

启用或禁用 SSL 证书验证的标志。

选择

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值： "2.3.7.6"

endTime

整数

Pnp 工作流的 endTime。

execTime

整数

Pnp 工作流的 execTime。

id

字符串

Id 路径参数。

imageId

字符串

Pnp 工作流的 imageId。

instanceType

字符串

Pnp 工作流的 instanceType。

lastupdateOn

整数

Pnp 工作流的 lastupdateOn。

name

字符串

Pnp 工作流的名称。

startTime

整数

Pnp 工作流的 startTime。

state_

字符串

Pnp 工作流的状态。

tasks

列表 / 元素=字典

Pnp 工作流的任务。

currWorkItemIdx

整数

Pnp 工作流的 currWorkItemIdx。

endTime

整数

Pnp 工作流的 endTime。

name

字符串

Pnp 工作流的名称。

startTime

整数

Pnp 工作流的 startTime。

state

字符串

Pnp 工作流的状态。

taskSeqNo

整数

Pnp 工作流的 taskSeqNo。

timeTaken

整数

Pnp 工作流的 timeTaken。

type

字符串

Pnp 工作流的类型。

workItemList

列表 / 元素=字典

Pnp 工作流的 workItemList。

command

字符串

Pnp 工作流的命令。

endTime

整数

Pnp 工作流的 endTime。

outputStr

字符串

Pnp 工作流的 outputStr。

startTime

整数

Pnp 工作流的 startTime。

state

字符串

Pnp 工作流的状态。

timeTaken

整数

Pnp 工作流的 timeTaken。

tenantId

字符串

Pnp 工作流的 tenantId。

type

字符串

Pnp 工作流的类型。

useState

字符串

Pnp 工作流的 useState。

validate_response_schema

布尔值

Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。

选择

  • false

  • true ← (默认)

version

整数

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 的完整参考。

Cisco DNA Center 关于设备加入 (PnP) DeleteWorkflowByIdV1 的文档

DeleteWorkflowByIdV1 API 的完整参考。

Cisco 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_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回： 始终

示例： {"_id": "字符串", "addToInventory": true, "addedOn": 0, "configId": "字符串", "currTaskIdx": 0, "description": "字符串", "endTime": 0, "execTime": 0, "imageId": "字符串", "instanceType": "字符串", "lastupdateOn": 0, "name": "字符串", "startTime": 0, "state": "字符串", "tasks": [{"currWorkItemIdx": 0, "endTime": 0, "name": "字符串", "startTime": 0, "state": "字符串", "taskSeqNo": 0, "timeTaken": 0, "type": "字符串", "workItemList": [{"command": "字符串", "endTime": 0, "outputStr": "字符串", "startTime": 0, "state": "字符串", "timeTaken": 0}]}], "tenantId": "字符串", "type": "字符串", "useState": "字符串", "version": 0}

作者

  • Rafael Campos (@racampos)