cisco.dnac.lan_automation_status_v1_info 模块 – 用于 Lan Automation Status V1 的信息模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.dnac.lan_automation_status_v1_info

cisco.dnac 6.0.0 中的新功能

概要

  • 获取所有 Lan Automation Status V1。

  • 按 id 获取 Lan Automation Status V1。

  • 调用此 API 以基于给定的 Lan Automation 会话 id 获取 LAN Automation 会话状态。

  • 调用此 API 以获取 LAN Automation 会话状态。

注意

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

要求

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

  • 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 路径参数。LAN Automation 会话标识符。

limit

浮点数

Limit 查询参数。要检索的 LAN Automation 会话数。Limit 值可以在 1 到 10 之间。

offset

浮点数

Offset 查询参数。LAN Automation 会话的起始索引。最小值是 1。

validate_response_schema

布尔值

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

选择

  • false

  • true ←(默认)

注释

注意

  • 使用的 SDK 方法为 lan_automation.LanAutomation.lan_automation_status_by_id_v1、lan_automation.LanAutomation.lan_automation_status_v1

  • 使用的路径为 get /dna/intent/api/v1/lan-automation/status、get /dna/intent/api/v1/lan-automation/status/{id}、

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关 LAN Automation LANAutomationStatusByIdV1 的 Cisco DNA Center 文档

LANAutomationStatusByIdV1 API 的完整参考。

有关 LAN Automation LANAutomationStatusV1 的 Cisco DNA Center 文档

LANAutomationStatusV1 API 的完整参考。

示例

- name: Get all Lan Automation Status V1
  cisco.dnac.lan_automation_status_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}}"
    offset: 0
    limit: 0
  register: result

- name: Get Lan Automation Status V1 by id
  cisco.dnac.lan_automation_status_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

返回值

通用返回值记录在此处,以下是此模块特有的字段

描述

dnac_response

字典

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

返回: 始终

示例: {"response": [{"action": "string", "creationTime": "string", "discoveredDeviceList": [{"ipAddressInUseList": ["string"], "name": "string", "serialNumber": "string", "state": "string"}], "discoveredDeviceSiteNameHierarchy": "string", "discoveryDevices": [{}], "discoveryLevel": 0, "discoveryTimeout": 0, "id": "string", "ipPools": [{"ipPoolName": "string", "ipPoolRole": "string"}], "multicastEnabled": true, "peerDeviceManagmentIPAddress": "string", "primaryDeviceInterfaceNames": ["string"], "primaryDeviceManagmentIPAddress": "string", "redistributeIsisToBgp": true, "status": "string"}], "version": "string"}

作者

  • Rafael Campos (@racampos)