cisco.dnac.license_device_license_summary_v1_info 模块 – License Device License Summary V1 的信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有 License Device License Summary V1。

  • 显示设备的许可证摘要。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

device_type

字符串

Device_type 查询参数。设备类型。有效值包括路由器、交换机和集线器、无线控制器。

device_uuid

字符串

Device_uuid 查询参数。设备 ID。

dna_level

字符串

Dna_level 查询参数。设备 Cisco DNA 许可证级别。有效值包括 Advantage、Essentials。

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

字典

其他标头。

limit

浮点数

Limit 查询参数。

order

字符串

Order 查询参数。排序顺序。

page_number

浮点数

Page_number 查询参数。响应的页码。

registration_status

字符串

Registration_status 查询参数。设备的智能许可证注册状态。有效值包括未知、NA、未注册、已注册、注册过期、正在进行的预留、已注册_slr、已注册_plr、已注册_satellite。

smart_account_id

字符串

Smart_account_id 查询参数。智能帐户的 ID。

sort_by

字符串

Sort_by 查询参数。按字段排序结果。

validate_response_schema

布尔值

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

选择

  • false

  • true ← (默认)

virtual_account_name

字符串

Virtual_account_name 查询参数。虚拟帐户的名称。

说明

注意

  • 使用的 SDK 方法为 licenses.Licenses.device_license_summary_v1,

  • 使用的路径为 get /dna/intent/api/v1/licenses/device/summary,

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于 Licenses DeviceLicenseSummaryV1 的文档

DeviceLicenseSummaryV1 API 的完整参考。

示例

- name: Get all License Device License Summary V1
  cisco.dnac.license_device_license_summary_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}}"
    page_number: 0
    order: string
    sort_by: string
    dna_level: string
    device_type: string
    limit: 0
    registration_status: string
    virtual_account_name: string
    smart_account_id: string
    device_uuid: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回: 始终

示例: {"response": [{"authorization_status": "字符串", "customer_tag1": "字符串", "customer_tag2": "字符串", "customer_tag3": "字符串", "customer_tag4": "字符串", "device_name": "字符串", "device_type": "字符串", "device_uuid": "字符串", "dna_level": "字符串", "evaluation_license_expiry": "字符串", "hsec_status": "字符串", "ip_address": "字符串", "is_license_expired": true, "is_performance_allowed": true, "is_wireless": true, "is_wireless_capable": true, "last_successful_rum_usage_upload_time": "字符串", "last_updated_time": "字符串", "license_mode": "字符串", "mac_address": "字符串", "model": "字符串", "network_license": "字符串", "performance_license": "字符串", "registration_status": "字符串", "reservation_status": "字符串", "site": "字符串", "sle_auth_code": "字符串", "sle_state": "字符串", "smart_account_name": "字符串", "software_version": "字符串", "throughput_level": "字符串", "total_access_point_count": 0, "virtual_account_name": "字符串", "wireless_capable_dna_license": "字符串", "wireless_capable_network_license": "字符串"}], "version": "字符串"}

作者

  • Rafael Campos (@racampos)