blob: 41d9a29d6a621016e336516d2d29e4a5461c32ff (
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
|
#!/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_snmp_config
short_description: Resource module for Event Snmp Config
description:
- Manage operations create and update of the resource Event Snmp Config.
- Create SNMP Destination.
- Update SNMP Destination.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
authPassword:
description: Auth Password.
type: str
community:
description: Required only if snmpVersion is V2C.
type: str
configId:
description: Config Id.
type: str
description:
description: Description.
type: str
ipAddress:
description: Ip Address.
type: str
name:
description: Name.
type: str
port:
description: Port.
type: str
privacyPassword:
description: Privacy Password.
type: str
snmpAuthType:
description: Snmp Auth Type.
type: str
snmpMode:
description: If snmpVersion is V3 it is required and cannot be NONE.
type: str
snmpPrivacyType:
description: Snmp Privacy Type.
type: str
snmpVersion:
description: Snmp Version.
type: str
userName:
description: Required only if snmpVersion is V3.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Event Management CreateSNMPDestination
description: Complete reference of the CreateSNMPDestination API.
link: https://developer.cisco.com/docs/dna-center/#!create-snmp-destination
- name: Cisco DNA Center documentation for Event Management UpdateSNMPDestination
description: Complete reference of the UpdateSNMPDestination API.
link: https://developer.cisco.com/docs/dna-center/#!update-snmp-destination
notes:
- SDK Method used are
event_management.EventManagement.create_snmp_destination,
event_management.EventManagement.update_snmp_destination,
- Paths used are
post /dna/intent/api/v1/event/snmp-config,
put /dna/intent/api/v1/event/snmp-config,
"""
EXAMPLES = r"""
- name: Create
cisco.dnac.event_snmp_config:
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
authPassword: string
community: string
description: string
ipAddress: string
name: string
port: string
privacyPassword: string
snmpAuthType: string
snmpMode: string
snmpPrivacyType: string
snmpVersion: string
userName: string
- name: Update all
cisco.dnac.event_snmp_config:
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
authPassword: string
community: string
configId: string
description: string
ipAddress: string
name: string
port: string
privacyPassword: string
snmpAuthType: string
snmpMode: string
snmpPrivacyType: string
snmpVersion: string
userName: 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: >
{
"errorMessage": {
"errors": [
{}
]
},
"apiStatus": "string",
"statusMessage": "string"
}
"""
|
