cisco.dnac.product_names_v1_info 模块 – 产品名称 V1 的信息模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要 

获取所有产品名称 V1。
按名称获取产品名称 V1。
根据筛选条件获取网络设备产品名称、其序号和支持的 PID 列表。
获取网络设备产品名称、其序号和支持的 PID。

注意

此模块有一个对应的 action 插件。

要求 

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

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 字典	其他标头。
limit 浮点数	限制查询参数。此页面要显示的记录数。最小值和最大值分别为 1 和 500。
offset 浮点数	偏移量查询参数。此页面要显示的第一个记录；第一个记录编号为 1。最小值为 1。
productId 字符串	ProductId 查询参数。使用产品 ID (PID) 进行筛选。
productName 字符串	ProductName 查询参数。使用网络设备产品名称进行筛选。支持部分不区分大小写的搜索。搜索至少需要 3 个字符。
productNameOrdinal 浮点数	ProductNameOrdinal 路径参数。产品名称序号是每个网络设备产品的唯一值。
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。选项 `false` `true` ←（默认）

备注 

注意

使用的 SDK 方法是 software_image_management_swim.SoftwareImageManagementSwim.retrieve_network_device_product_name_v1, software_image_management_swim.SoftwareImageManagementSwim.retrieves_the_list_of_network_device_product_names_v1,
使用的路径是 get /dna/intent/api/v1/productNames, get /dna/intent/api/v1/productNames/{productNameOrdinal},
支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

有关软件映像管理 (SWIM) RetrieveNetworkDeviceProductNameV1 的 Cisco DNA Center 文档: RetrieveNetworkDeviceProductNameV1 API 的完整参考。
有关软件映像管理 (SWIM) RetrievesTheListOfNetworkDeviceProductNamesV1 的 Cisco DNA Center 文档: RetrievesTheListOfNetworkDeviceProductNamesV1 API 的完整参考。

示例 

- name: Get all Product Names V1
  cisco.dnac.product_names_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}}"
    productName: string
    productId: string
    offset: 0
    limit: 0
  register: result

- name: Get Product Names V1 by name
  cisco.dnac.product_names_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}}"
    productNameOrdinal: 0
  register: result

返回值 

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

键	描述
dnac_response 字典	一个字典或列表，包含 Cisco DNAC Python SDK 返回的响应。返回: 总是示例: `{"response": {"id": "string", "productIds": ["string"], "productName": "string", "productNameOrdinal": 0}, "version": "string"}`

作者

Rafael Campos (@racampos)