cisco.dnac.sites_telemetry_settings_v1_info 模块 – 站点遥测设置 V1 的信息模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您正在使用 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,有关详细信息,请参阅要求。
要在 playbook 中使用它,请指定:cisco.dnac.sites_telemetry_settings_v1_info
。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有站点遥测设置 V1。
检索给定站点的遥测设置。`null` 值表示该设置将从父站点继承。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
_inherited 查询参数。包括为该站点显式设置的设置以及从站点层次结构中较高的站点继承的设置;当 `false` 时,`null` 值表示该站点从父站点或站点层次结构中较高的站点继承该设置。 选项
|
|
Cisco DNA Center SDK 的标志,用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认值: |
|
其他标头。 |
|
Id 路径参数。站点 ID,可从 `/dna/intent/api/v1/sites` 中的 `id` 属性检索。 |
|
Cisco DNA Center SDK 的标志,用于启用针对 JSON 模式验证请求正文。 选项
|
备注
注意
使用的 SDK 方法是 network_settings.NetworkSettings.retrieve_telemetry_settings_for_a_site_v1,
使用的路径是 get /dna/intent/api/v1/sites/{id}/telemetrySettings,
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 文档,了解 Network Settings RetrieveTelemetrySettingsForASiteV1
RetrieveTelemetrySettingsForASiteV1 API 的完整参考。
示例
- name: Get all Sites Telemetry Settings V1
cisco.dnac.sites_telemetry_settings_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}}"
_inherited: True
id: string
register: result
返回值
常见的返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应 返回:始终 示例: |