cisco.dnac.license_usage_details_info 模块 – 用于许可证使用详细信息的信息模块

注意

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

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

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

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

cisco.dnac 3.1.0中的新增功能

概要

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

注意

此模块具有相应的 action插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

device_type

字符串

Device_type 查询参数。设备类型,例如路由器、交换机、无线设备或ISE。

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

字典

附加的headers。

smart_account_id

字符串

Smart_account_id 路径参数。智能账户的ID。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

virtual_account_name

字符串

Virtual_account_name 路径参数。虚拟账户的名称。输入“All”将显示所有虚拟账户的许可证期限详细信息。

注释

注意

  • 使用的SDK方法是licenses.Licenses.license_usage_details_v1,

  • 使用的路径是get /dna/intent/api/v1/licenses/usage/smartAccount/{smart_account_id}/virtualAccount/{virtual_account_name},

  • 需要注意的是,此模块是license_usage_details_v1_info的别名

  • 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center许可证LicenseUsageDetailsV1文档

LicenseUsageDetailsV1 API的完整参考。

示例

- name: Get License Usage Details Info by name
  cisco.dnac.license_usage_details_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}}"
    device_type: string
    smart_account_id: string
    virtual_account_name: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

示例: {"purchased_dna_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "purchased_ise_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "purchased_network_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_dna_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_ise_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}, "used_network_license": {"license_count_by_type": [{"license_count": 0, "license_type": "string"}], "total_license_count": 0}}

作者

  • Rafael Campos (@racampos)