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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
#!/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: site_v2_info
short_description: Information module for Site V2
description:
- Get all Site V2.
- >
API to get sites by site-name-hierarchy or siteId or type. List all sites if these parameters are not given as an
input.
version_added: '6.14.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
groupNameHierarchy:
description:
- GroupNameHierarchy query parameter. Site name hierarchy (E.g. Global/USA/CA).
type: str
id:
description:
- Id query parameter. Site Id.
type: str
type:
description:
- Type query parameter. Site type (Acceptable values area, building, floor).
type: str
offset:
description:
- Offset query parameter. Offset/starting index for pagination.
type: str
limit:
description:
- Limit query parameter. Number of sites to be listed. Default and max supported value is 500.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Sites GetSiteV2
description: Complete reference of the GetSiteV2 API.
link: https://developer.cisco.com/docs/dna-center/#!get-site-v-2
notes:
- SDK Method used are
sites.Sites.get_site_v2,
- Paths used are
get /dna/intent/api/v2/site,
"""
EXAMPLES = r"""
- name: Get all Site V2
cisco.dnac.site_v2_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}}"
groupNameHierarchy: string
id: string
type: string
offset: string
limit: string
register: result
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: list
elements: dict
sample: >
[
{
"parentId": "string",
"groupTypeList": [
"string"
],
"groupHierarchy": "string",
"additionalInfo": [
{
"nameSpace": "string",
"attributes": {
"addressInheritedFrom": "string",
"type": "string",
"country": "string",
"address": "string",
"latitude": "string",
"longitude": "string"
}
}
],
"groupNameHierarchy": "string",
"name": "string",
"instanceTenantId": "string",
"id": "string"
}
]
"""
|
