cisco.dnac.discovery_range_delete_v1 模块 – 用于发现范围删除 V1 的资源模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您使用的是 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,请参阅要求了解详细信息。
要在剧本中使用它,请指定:cisco.dnac.discovery_range_delete_v1
。
cisco.dnac 3.1.0 中的新增功能
概要
管理资源发现范围删除 V1 的删除操作。
停止给定范围的发现并删除它们。
注意
此模块具有相应的操作插件。
要求
执行此模块的主机上需要以下要求。
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 版本。 默认: |
|
RecordsToDelete 路径参数。要从起始索引中删除的记录数。 |
|
StartIndex 路径参数。记录的起始索引。 |
|
用于 Cisco DNA Center SDK 以启用针对 JSON 模式验证请求体的标志。 选项
|
注释
注意
使用的 SDK 方法是 discovery.Discovery.delete_discovery_by_specified_range_v1,
使用的路径是 delete /dna/intent/api/v1/discovery/{startIndex}/{recordsToDelete},
不支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 文档,了解发现 DeleteDiscoveryBySpecifiedRangeV1
DeleteDiscoveryBySpecifiedRangeV1 API 的完整参考。
示例
- name: Delete all
cisco.dnac.discovery_range_delete_v1:
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}}"
recordsToDelete: 0
startIndex: 0
返回值
常用返回值记录在 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应 返回:始终 示例: |