blob: d1c9627fa00f6c6d5d1a7d5a3771c79c94292fc2 (
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
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
|
#!/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_create
short_description: Resource module for Site Create
description:
- Manage operation create of the resource Site Create.
- Creates site with area/building/floor with specified hierarchy.
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 Create's site.
suboptions:
area:
description: Site Create's area.
suboptions:
name:
description: Name of the area (eg Area1).
type: str
parentName:
description: Parent name of the area to be created.
type: str
type: dict
building:
description: Site Create's building.
suboptions:
address:
description: Address of the building to be created.
type: str
country:
description: Country (eg United States).
type: str
latitude:
description: Latitude coordinate of the building (eg 37.338).
type: float
longitude:
description: Longitude coordinate of the building (eg -121.832).
type: float
name:
description: Name of the building (eg building1).
type: str
parentName:
description: Parent name of building to be created.
type: str
type: dict
floor:
description: Site Create's floor.
suboptions:
floorNumber:
description: Floor number. (eg 5).
type: float
height:
description: Height of the floor. Unit of measure is ft. (eg 15).
type: float
length:
description: Length of the floor. Unit of measure is ft. (eg 100).
type: float
name:
description: Name of the floor (eg floor-1).
type: str
parentName:
description: Parent name of the floor to be created.
type: str
rfModel:
description: Type of floor (eg Cubes And Walled Offices0.
type: str
width:
description: Width of the floor. Unit of measure is ft. (eg 100).
type: float
type: dict
type: dict
type:
description: Type of site to create (eg area, building, floor).
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Sites CreateSite
description: Complete reference of the CreateSite API.
link: https://developer.cisco.com/docs/dna-center/#!create-site
notes:
- SDK Method used are
sites.Sites.create_site,
- Paths used are
post /dna/intent/api/v1/site,
"""
EXAMPLES = r"""
- name: Create
cisco.dnac.site_create:
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
parentName: string
rfModel: string
width: 0
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: >
{
"executionId": "string",
"executionStatusUrl": "string",
"message": "string"
}
"""
|
