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。要使用此模块，您需要其他要求，请参阅 要求了解详细信息。
要在剧本中使用它，请指定：cisco.dnac.product_names_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有产品名称 V1。
按名称获取产品名称 V1。
根据筛选条件获取网络设备产品名称、序号和支持的 PID 列表。
获取网络设备产品名称、序号和支持的 PID。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
附加的头部信息。 |
|
Limit 查询参数。此页显示的记录数。最小值和最大值分别为 1 和 500。 |
|
Offset 查询参数。此页显示的第一条记录；第一条记录编号为 1。最小值为 1。 |
|
ProductId 查询参数。使用产品 ID (PID) 筛选。 |
|
ProductName 查询参数。使用网络设备产品名称筛选。支持部分不区分大小写的搜索。搜索至少需要 3 个字符。 |
|
ProductNameOrdinal 路径参数。产品名称序号是每个网络设备产品的唯一值。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
备注
注意
使用的 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 用于建立连接
另请参见
另请参见
- Cisco DNA Center 软件镜像管理 (SWIM) RetrieveNetworkDeviceProductNameV1 文档
RetrieveNetworkDeviceProductNameV1 API 的完整参考。
- Cisco DNA Center 软件镜像管理 (SWIM) RetrievesTheListOfNetworkDeviceProductNamesV1 文档
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
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回：始终 示例： |