cisco.dnac.site_wise_product_names_info 模块 – 用于站点设备产品名称信息的模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您正在使用 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,请参阅 要求 以了解详细信息。
要在剧本中使用它,请指定:cisco.dnac.site_wise_product_names_info
。
cisco.dnac 6.15.0 中的新增功能
概要
此模块表示模块 site_wise_product_names_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
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 版本。 默认值: |
|
其他标头。 |
|
限制查询参数。此页面要显示的记录数。最小值和最大值分别为 1 和 500。 |
|
偏移查询参数。此页面要显示的第一个记录;第一个记录编号为 1。最小值为 1。 |
|
ProductName 查询参数。使用网络设备产品名称进行筛选。支持部分不区分大小写的搜索。搜索需要至少 3 个字符。 |
|
SiteId 查询参数。站点标识符,用于获取该站点下所有可用产品的列表。默认值为全局站点。请参阅 https //developer.cisco.com/docs/dna-center/get-site 以了解 siteId。 |
|
用于 Cisco DNA Center SDK 的标志,用于启用针对 JSON 架构验证请求正文。 选项
|
注意
注意
使用的 SDK 方法是 software_image_management_swim.SoftwareImageManagementSwim.returns_network_device_product_names_for_a_site_v1,
使用的路径是 get /dna/intent/api/v1/siteWiseProductNames,
应该注意的是,此模块是 site_wise_product_names_v1_info 的别名
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 关于软件映像管理 (SWIM) 的文档 ReturnsNetworkDeviceProductNamesForASiteV1
ReturnsNetworkDeviceProductNamesForASiteV1 API 的完整参考。
示例
- name: Get all Site Wise Product Names Info
cisco.dnac.site_wise_product_names_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}}"
siteId: string
productName: string
offset: 0
limit: 0
register: result
返回值
通用返回值记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应 返回:始终 示例: |