cisco.dnac.reserve_ip_subpool_v1_info 模块 – Reserve Ip Subpool V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要满足进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 Playbook 中使用它，请指定：cisco.dnac.reserve_ip_subpool_v1_info。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有 Reserve Ip Subpool V1。
用于获取 IP 子池信息的 API。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
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。 默认值： |
|
GroupName 查询参数。组的名称。 |
|
其他标头。 |
|
IgnoreInheritedGroups 查询参数。忽略从父站点继承的池。必须传递 siteId 或 ignoreInheritedGroups。它们也可以一起使用。 |
|
Limit 查询参数。要检索的保留池的数量。如果未指定，则默认值为 25。允许的最大限制为 500。 |
|
Offset 查询参数。偏移量/起始行。从 1 开始索引。 |
|
PoolUsage 查询参数。可以取值为空、部分已满或空-部分已满。 |
|
SiteId 查询参数。从中检索关联的保留池的站点的站点 ID。必须使用 siteId（每个站点的查询）或 ignoreInheritedGroups。它们也可以一起使用。 |
|
用于启用 Cisco DNA Center SDK 根据 JSON 架构验证请求体的标志。 选项
|
注释
注意
使用的 SDK 方法是 network_settings.NetworkSettings.get_reserve_ip_subpool_v1，
使用的路径是 get /dna/intent/api/v1/reserve-ip-subpool，
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关网络设置 GetReserveIPSubpoolV1 的 Cisco DNA Center 文档
GetReserveIPSubpoolV1 API 的完整参考。
示例
- name: Get all Reserve Ip Subpool V1
cisco.dnac.reserve_ip_subpool_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}}"
siteId: string
offset: 0
limit: 0
ignoreInheritedGroups: string
poolUsage: string
groupName: string
register: result
返回值
常见的返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应 已返回： 总是 示例: |