blob: 10319f53fe7293663868bccedd8015c5b79dc04d (
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
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
|
#!/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_membership_info
short_description: Information module for Site Membership
description:
- Get Site Membership by id.
- Getting the site children details and device details.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
siteId:
description:
- SiteId path parameter. Site id to retrieve device associated with the site.
type: str
offset:
description:
- Offset query parameter. Offset/starting row.
type: float
limit:
description:
- Limit query parameter. Number of sites to be retrieved.
type: float
deviceFamily:
description:
- DeviceFamily query parameter. Device family name.
type: str
serialNumber:
description:
- SerialNumber query parameter. Device serial number.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Sites GetMembership
description: Complete reference of the GetMembership API.
link: https://developer.cisco.com/docs/dna-center/#!get-membership
notes:
- SDK Method used are
sites.Sites.get_membership,
- Paths used are
get /dna/intent/api/v1/membership/{siteId},
"""
EXAMPLES = r"""
- name: Get Site Membership by id
cisco.dnac.site_membership_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}}"
offset: 0
limit: 0
deviceFamily: string
serialNumber: string
siteId: 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: dict
sample: >
{
"site": {
"response": [
{}
],
"version": "string"
},
"device": [
{
"response": [
{}
],
"version": "string",
"siteId": "string"
}
]
}
"""
|
