cisco.dnac.pnp_workflow_info 模块 – Pnp 工作流信息的信息模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.pnp_workflow_info

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

headers

字典

其他标头。

id

字符串

Id 路径参数。

limit

整数

Limit 查询参数。限制结果数量。

name

列表 / 元素=字典

Name 查询参数。工作流名称。

offset

整数

Offset 查询参数。第一个结果的索引。

sort

列表 / 元素=字符串

Sort 查询参数。用逗号分隔的要排序的字段列表。

sortOrder

字符串

SortOrder 查询参数。排序顺序为升序 (asc) 或降序 (des)。

type

列表 / 元素=字符串

Type 查询参数。工作流类型。

validate_response_schema

布尔值

用于启用 Cisco DNA Center SDK 根据 JSON 模式验证请求主体的标志。

选择

  • false

  • true ← (默认)

注意

注意

  • 使用的 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},

  • 应该注意的是,此模块是 pnp_workflow_v1_info 的别名

  • 支持 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 Info
  cisco.dnac.pnp_workflow_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 Info by id
  cisco.dnac.pnp_workflow_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

返回值

常见返回值记录在此处,以下是此模块独有的字段

描述

dnac_response

字典

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

返回: 始终

示例: {"_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}

作者

  • Rafael Campos (@racampos)