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
|
#!/usr/bin/python
# -*- coding:utf-8 -*-
# Copyright(C) 2023 Kaytus Inc. All Rights Reserved.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
---
module: edit_snmp
version_added: "1.0.0"
author:
- WangBaoshan (@ieisystem)
short_description: Set snmp
description:
- Set snmp on kaytus Server.
notes:
- Does not support C(check_mode).
options:
version:
description:
- SNMP trap version option, 0 - 'v1', 1 - 'v2c', 2 - 'v3', 3 - 'all', 4 - 'customize'.
- Only the M5 models support this feature.
choices: [0, 1, 2, 3, 4]
type: int
snmp_status:
description:
- NMP read/write status of customize.
- The input parameters are 'v1get', 'v1set', 'v2cget', 'v2cset', 'v3get', 'v3set', separated by commas, such as v1get, v1set, v2cget.
- Only the M5 models support this feature.
type: list
elements: str
community:
description:
- Community of v1/v2c or v1get/v1set/v2cget/v2cset.
- Only the M5 models support this feature.
type: str
v1status:
description:
- SNMP V1 enable.
choices: ['enable', 'disable']
type: str
v2status:
description:
- SNMP V2 enable.
choices: ['enable', 'disable']
type: str
v3status:
description:
- SNMP V3 enable.
choices: ['enable', 'disable']
type: str
read_community:
description:
- Read Only Community, Community should between 1 and 16 characters.
- Only the M6 models support this feature.
type: str
read_write_community:
description:
- Read And Write Community, Community should between 1 and 16 characters.
- Only the M6 models support this feature.
type: str
v3username:
description:
- Set a username for the V3 trap or v3get/v3set.
type: str
auth_protocol:
description:
- Choose the authentication protocol for the V3 trap or v3get/v3set.
choices: ['NONE', 'SHA', 'MD5']
type: str
auth_password:
description:
- Set the authentication password for the V3 trap or v3get/v3set.
- The password is a string of 8 to 16 alphanumeric characters.
- Required when I(auth_protocol) is either C(SHA) or C(MD5).
type: str
priv_protocol:
description:
- Choose the privacy protocol for the V3 trap or v3get/v3set.
choices: ['NONE', 'DES', 'AES']
type: str
priv_password:
description:
- Set the privacy password for the V3 trap or v3get/v3set.
- The password is a string of 8 to 16 alphanumeric characters.
- Required when I(priv_protocol) is either C(DES) or C(AES).
type: str
extends_documentation_fragment:
- kaytus.ksmanage.ksmanage
'''
EXAMPLES = '''
- name: Snmp test
hosts: ksmanage
no_log: true
connection: local
gather_facts: false
vars:
ksmanage:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Set snmp get/set"
kaytus.ksmanage.edit_snmp:
community: "test"
v3username: "test"
provider: "{{ ksmanage }}"
'''
RETURN = '''
message:
description: Messages returned after module execution.
returned: always
type: str
state:
description: Status after module execution.
returned: always
type: str
changed:
description: Check to see if a change was made on the device.
returned: always
type: bool
'''
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.kaytus.ksmanage.plugins.module_utils.ksmanage import (ksmanage_argument_spec, get_connection)
class SNMP(object):
def __init__(self, argument_spec):
self.spec = argument_spec
self.module = None
self.init_module()
self.results = dict()
def init_module(self):
"""Init module object"""
self.module = AnsibleModule(
argument_spec=self.spec, supports_check_mode=False)
def run_command(self):
self.module.params['subcommand'] = 'setsnmp'
self.results = get_connection(self.module)
if self.results['State'] == 'Success':
self.results['changed'] = True
def show_result(self):
"""Show result"""
self.module.exit_json(**self.results)
def work(self):
"""Worker"""
self.run_command()
self.show_result()
def main():
argument_spec = dict(
version=dict(type='int', required=False, choices=[0, 1, 2, 3, 4]),
snmp_status=dict(type='list', elements='str', required=False),
community=dict(type='str', required=False),
v1status=dict(type='str', required=False, choices=['enable', 'disable']),
v2status=dict(type='str', required=False, choices=['enable', 'disable']),
v3status=dict(type='str', required=False, choices=['enable', 'disable']),
read_community=dict(type='str', required=False),
read_write_community=dict(type='str', required=False),
v3username=dict(type='str', required=False),
auth_protocol=dict(type='str', required=False, choices=['NONE', 'SHA', 'MD5']),
auth_password=dict(type='str', required=False, no_log=True),
priv_protocol=dict(type='str', required=False, choices=['NONE', 'DES', 'AES']),
priv_password=dict(type='str', required=False, no_log=True),
)
argument_spec.update(ksmanage_argument_spec)
snmp_obj = SNMP(argument_spec)
snmp_obj.work()
if __name__ == '__main__':
main()
|
