blob: 729505039fa1ea582ce29661ecb77c430923cf58 (
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
|
#!/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: snmpv3_credential
short_description: Resource module for Snmpv3 Credential
description:
- Manage operations create and update of the resource Snmpv3 Credential.
- Adds global SNMPv3 credentials.
- Updates global SNMPv3 credential.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
authPassword:
description: Auth Password for SNMP.
type: str
authType:
description: SNMP auth protocol. 'SHA' or 'MD5'.
type: str
comments:
description: Comments to identify the SNMPv3 credential.
type: str
credentialType:
description: Credential type to identify the application that uses the SNMPv3 credential.
type: str
description:
description: Description for Snmp V3 Credential.
type: str
id:
description: Id of the SNMP V3 Credential in UUID format.
type: str
instanceTenantId:
description: Deprecated.
type: str
instanceUuid:
description: Deprecated.
type: str
privacyPassword:
description: Privacy Password for SNMP privacy.
type: str
privacyType:
description: SNMP privacy protocol.
type: str
snmpMode:
description: Mode of SNMP. 'AUTHPRIV' or 'AUTHNOPRIV' or 'NOAUTHNOPRIV'.
type: str
username:
description: SNMP V3 Username.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Discovery CreateSNMPv3Credentials
description: Complete reference of the CreateSNMPv3Credentials API.
link: https://developer.cisco.com/docs/dna-center/#!create-snm-pv-3-credentials
- name: Cisco DNA Center documentation for Discovery UpdateSNMPv3Credentials
description: Complete reference of the UpdateSNMPv3Credentials API.
link: https://developer.cisco.com/docs/dna-center/#!update-snm-pv-3-credentials
notes:
- SDK Method used are
discovery.Discovery.create_snmpv3_credentials,
discovery.Discovery.update_snmpv3_credentials,
- Paths used are
post /dna/intent/api/v1/global-credential/snmpv3,
put /dna/intent/api/v1/global-credential/snmpv3,
"""
EXAMPLES = r"""
- name: Update all
cisco.dnac.snmpv3_credential:
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
authType: string
comments: string
credentialType: string
description: string
id: string
instanceTenantId: string
instanceUuid: string
privacyPassword: string
privacyType: string
snmpMode: string
username: string
- name: Create
cisco.dnac.snmpv3_credential:
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
authType: string
comments: string
credentialType: string
description: string
id: string
instanceTenantId: string
instanceUuid: string
privacyPassword: string
privacyType: string
snmpMode: 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: >
{
"response": {
"taskId": "string",
"url": "string"
},
"version": "string"
}
"""
|
