blob: 6846a016679377dd0d1c7ad4ea48738be414e233 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: discovery_range_delete
short_description: Resource module for Discovery Range Delete
description:
- Manage operation delete of the resource Discovery Range Delete.
- Stops discovery for the given range and removes them.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
recordsToDelete:
description: RecordsToDelete path parameter. Number of records to delete from the
starting index.
type: int
startIndex:
description: StartIndex path parameter. Starting index for the records.
type: int
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Discovery DeleteDiscoveryBySpecifiedRange
description: Complete reference of the DeleteDiscoveryBySpecifiedRange API.
link: https://developer.cisco.com/docs/dna-center/#!delete-discovery-by-specified-range
notes:
- SDK Method used are
discovery.Discovery.delete_discovery_by_specified_range,
- Paths used are
delete /dna/intent/api/v1/discovery/{startIndex}/{recordsToDelete},
"""
EXAMPLES = r"""
- name: Delete all
cisco.dnac.discovery_range_delete:
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
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"response": {
"taskId": "string",
"url": "string"
},
"version": "string"
}
"""
|
