blob: 154c54b255d395627feb36d5dc38fac6a39fd4c0 (
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
#!/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: event_subscription_rest
short_description: Resource module for Event Subscription Rest
description:
- Manage operations create and update of the resource Event Subscription Rest.
- Create Rest/Webhook Subscription Endpoint for list of registered events.
- Update Rest/Webhook Subscription Endpoint for list of registered events.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
payload:
description: Event Subscription Rest's payload.
elements: dict
suboptions:
description:
description: Description.
type: str
filter:
description: Event Subscription Rest's filter.
suboptions:
categories:
description: Categories.
elements: str
type: list
domainsSubdomains:
description: Event Subscription Rest's domainsSubdomains.
elements: dict
suboptions:
domain:
description: Domain.
type: str
subDomains:
description: Sub Domains.
elements: str
type: list
type: list
eventIds:
description: Event Ids (Comma separated event ids).
elements: str
type: list
severities:
description: Severities.
elements: str
type: list
siteIds:
description: Site Ids.
elements: str
type: list
sources:
description: Sources.
elements: str
type: list
types:
description: Types.
elements: str
type: list
type: dict
name:
description: Name.
type: str
subscriptionEndpoints:
description: Event Subscription Rest's subscriptionEndpoints.
elements: dict
suboptions:
instanceId:
description: (From Get Rest/Webhook Subscription Details --> pick instanceId).
type: str
subscriptionDetails:
description: Event Subscription Rest's subscriptionDetails.
suboptions:
connectorType:
description: Connector Type (Must be REST).
type: str
type: dict
type: list
subscriptionId:
description: Subscription Id (Unique UUID).
type: str
version:
description: Version.
type: str
type: list
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Event Management CreateRestWebhookEventSubscription
description: Complete reference of the CreateRestWebhookEventSubscription API.
link: https://developer.cisco.com/docs/dna-center/#!create-rest-webhook-event-subscription
- name: Cisco DNA Center documentation for Event Management UpdateRestWebhookEventSubscription
description: Complete reference of the UpdateRestWebhookEventSubscription API.
link: https://developer.cisco.com/docs/dna-center/#!update-rest-webhook-event-subscription
notes:
- SDK Method used are
event_management.EventManagement.create_rest_webhook_event_subscription,
event_management.EventManagement.update_rest_webhook_event_subscription,
- Paths used are
post /dna/intent/api/v1/event/subscription/rest,
put /dna/intent/api/v1/event/subscription/rest,
"""
EXAMPLES = r"""
- name: Create
cisco.dnac.event_subscription_rest:
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:
- description: string
filter:
categories:
- string
domainsSubdomains:
- domain: string
subDomains:
- string
eventIds:
- string
severities:
- string
siteIds:
- string
sources:
- string
types:
- string
name: string
subscriptionEndpoints:
- instanceId: string
subscriptionDetails:
connectorType: string
subscriptionId: string
version: string
- name: Update all
cisco.dnac.event_subscription_rest:
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:
- description: string
filter:
categories:
- string
domainsSubdomains:
- domain: string
subDomains:
- string
eventIds:
- string
severities:
- string
siteIds:
- string
sources:
- string
types:
- string
name: string
subscriptionEndpoints:
- instanceId: string
subscriptionDetails:
connectorType: string
subscriptionId: string
version: 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: >
{
"statusUri": "string"
}
"""
|
