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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
#!/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_update
short_description: Resource module for Site Update
description:
- Manage operation update of the resource Site Update.
- Update site area/building/floor with specified hierarchy and new values.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
site:
description: Site Update's site.
suboptions:
area:
description: Site Update's area.
suboptions:
name:
description: Area name.
type: str
parentName:
description: Parent hierarchical name (Example Global/USA/CA).
type: str
type: dict
building:
description: Site Update's building.
suboptions:
address:
description: Building address (Example 4900 Marie P. Debartolo Way, Santa
Clara, California 95054, United States).
type: str
country:
description: Country name. This field is mandatory for air-gapped networks
(Example United States).
type: str
latitude:
description: Building latitude (Example 37.403712).
type: float
longitude:
description: Building longitude (Example -121.971063).
type: float
name:
description: Building name.
type: str
parentName:
description: Parent hierarchical name (Example Global/USA/CA/SantaClara).
type: str
type: dict
floor:
description: Site Update's floor.
suboptions:
floorNumber:
description: Floor Number (Example 3).
type: float
height:
description: Floor height in feet (Example 10).
type: float
length:
description: Floor length in feet (Example 100).
type: float
name:
description: Floor name.
type: str
rfModel:
description: RF model (Example Cubes And Walled Offices).
type: str
width:
description: Floor width in feet (Example 200).
type: float
type: dict
type: dict
siteId:
description: SiteId path parameter. Site id to which site details to be updated.
type: str
type:
description: Site type.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Sites UpdateSite
description: Complete reference of the UpdateSite API.
link: https://developer.cisco.com/docs/dna-center/#!update-site
notes:
- SDK Method used are
sites.Sites.update_site,
- Paths used are
put /dna/intent/api/v1/site/{siteId},
"""
EXAMPLES = r"""
- name: Update by id
cisco.dnac.site_update:
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}}'
site:
area:
name: string
parentName: string
building:
address: string
country: string
latitude: 0
longitude: 0
name: string
parentName: string
floor:
floorNumber: 0
height: 0
length: 0
name: string
rfModel: string
width: 0
siteId: string
type: string
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"result": "string",
"response": {
"endTime": "string",
"version": "string",
"startTime": "string",
"progress": "string",
"data": "string",
"serviceType": "string",
"operationIdList": [
"string"
],
"isError": "string",
"rootId": "string",
"instanceTenantId": "string",
"id": "string"
},
"status": "string"
}
"""
|
