blob: 2f213aa9760c9773aea24b1abef54b96404ebdc7 (
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
|
#!/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: sda_fabric_zones
short_description: Resource module for Sda Fabriczones
description:
- Manage operations create, update and delete of the resource Sda Fabriczones.
- Adds a fabric zone based on user input.
- Deletes a fabric zone based on id.
- Updates a fabric zone based on user input.
version_added: '6.14.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
id:
description: Id path parameter. ID of the fabric zone to be deleted.
type: str
payload:
description: Sda Fabric Zones's payload.
elements: dict
suboptions:
authenticationProfileName:
description: Authentication profile used for this fabric.
type: str
id:
description: ID of the fabric zone (updating this field is not allowed).
type: str
siteId:
description: ID of the network hierarchy (updating this field is not allowed).
type: str
type: list
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for SDA AddFabricZone
description: Complete reference of the AddFabricZone API.
link: https://developer.cisco.com/docs/dna-center/#!add-fabric-zone
- name: Cisco DNA Center documentation for SDA DeleteFabricZoneById
description: Complete reference of the DeleteFabricZoneById API.
link: https://developer.cisco.com/docs/dna-center/#!delete-fabric-zone-by-id
- name: Cisco DNA Center documentation for SDA UpdateFabricZone
description: Complete reference of the UpdateFabricZone API.
link: https://developer.cisco.com/docs/dna-center/#!update-fabric-zone
notes:
- SDK Method used are
sda.Sda.add_fabric_zone,
sda.Sda.delete_fabric_zone_by_id,
sda.Sda.update_fabric_zone,
- Paths used are
post /dna/intent/api/v1/sda/fabricZones,
delete /dna/intent/api/v1/sda/fabricZones/{id},
put /dna/intent/api/v1/sda/fabricZones,
"""
EXAMPLES = r"""
- name: Update all
cisco.dnac.sda_fabric_zones:
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}}"
state: present
payload:
- authenticationProfileName: string
id: string
siteId: string
- name: Create
cisco.dnac.sda_fabric_zones:
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}}"
state: present
payload:
- authenticationProfileName: string
siteId: string
- name: Delete by id
cisco.dnac.sda_fabric_zones:
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}}"
state: absent
id: 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: >
{
"response": {
"taskId": "string",
"url": "string"
},
"version": "string"
}
"""
|
