cisco.dnac.sites_info 模块 – 站点信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定:cisco.dnac.sites_info
。
cisco.dnac 6.15.0 中的新增功能
概要
此模块代表模块 sites_v1_info 的别名
注意
此模块具有相应的 action 插件。
要求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
_unitsOfMeasure 查询参数。楼层计量单位。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值: |
|
附加的 headers。 |
|
Limit 查询参数。此页要显示的记录数。 |
|
Name 查询参数。站点名称。 |
|
NameHierarchy 查询参数。站点名称层次结构。 |
|
Offset 查询参数。此页要显示的第一条记录;第一条记录编号为 1。 |
|
Type 查询参数。站点类型。 |
|
用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求体的标志。 选项
|
备注
注意
使用的 SDK 方法是 site_design.SiteDesign.get_sites_v1,
使用的路径是 get /dna/intent/api/v1/sites,
需要注意的是,此模块是 sites_v1_info 的别名
支持
check_mode
插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 站点设计 GetSitesV1 文档
GetSitesV1 API 的完整参考。
示例
- name: Get all Sites Info
cisco.dnac.sites_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}}"
name: string
nameHierarchy: string
type: string
_unitsOfMeasure: string
offset: 0
limit: 0
register: result
返回值
常见的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值:始终 示例: |