/
ix.py
319 lines (272 loc) · 9.84 KB
/
ix.py
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
#
# (c) 2017 Red Hat Inc.
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
DOCUMENTATION = """
author: Yushi Takeda (@ruc_dev)
name: ix
short_description: Use ix cliconf to run command on NEC IX platform
description:
- ""
version_added: 0.1.0
"""
import re
import json
from functools import wraps
from ansible.module_utils._text import to_text
from ansible_collections.ansible.netcommon.plugins.plugin_utils.cliconf_base import (
CliconfBase,
)
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import (
to_list,
)
from ansible.module_utils.common._collections_compat import Mapping
from ansible.errors import AnsibleConnectionFailure
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import (
NetworkConfig,
dumps,
)
from ansible.utils.display import Display
display = Display()
SVINTR_CONFIG = "svintr-config"
def configure_mode(func):
@wraps(func)
def wrapped(self, *args, **kwargs):
prompt = self._connection.get_prompt()
if (
not to_text(prompt, errors="surrogate_or_strict")
.strip()
.endswith("(config)#")
):
# self.send_command(SVINTR_CONFIG)
self.send_command("configure")
return func(self, *args, **kwargs)
return wrapped
class Cliconf(CliconfBase):
def __init__(self, *args, **kwargs):
self._device_info = {}
display.vvvvv("cliconf init")
super(Cliconf, self).__init__(*args, **kwargs)
@configure_mode
def get_config(self, source="running", flags=None, format=None):
if source not in ("running", "startup"):
raise ValueError(
# running, startup以外はエラーとする
f"fetching configuration for {source} is not supported"
)
if format:
raise ValueError(f"'format' value {format} is not supported for get_config")
if not flags:
flags = []
cmd = ""
if source == "running":
cmd = "show running-config"
cmd += " ".join(to_list(flags))
cmd = cmd.strip()
return self.send_command(cmd)
def get_diff(
self,
candidate=None,
running=None,
diff_match=None,
diff_ignore_lines=None,
path=None,
diff_replace=None,
):
diff = {}
device_operations = self.get_device_operations()
option_values = self.get_option_values()
if candidate is None and device_operations["supports_generate_diff"]:
raise ValueError("candidate configuration is required to generate diff")
if diff_match not in option_values["diff_match"]:
raise ValueError(
f"'match' value {diff_match} in invalid, valid values are {', '.join(option_values['diff_match'])}"
)
if diff_replace not in option_values["diff_replace"]:
raise ValueError(
f"'replace' value {diff_replace} in invalid, valid values are {', '.join(option_values['diff_replace'])}"
)
candidate_obj = NetworkConfig(indent=1)
# TODO: バナーに対応させる
# want_src, want_banners = self._extract_banners(candi)
candidate_obj.load(candidate)
if running and diff_match != "none":
# have_src, have_banners = self._extract_banners(running)
running_obj = NetworkConfig(
indent=1, contents=running, ignore_lines=diff_ignore_lines
)
configdiffobjs = candidate_obj.difference(
running_obj, path=path, match=diff_match, replace=diff_replace
)
else:
configdiffobjs = candidate_obj.items
have_banners = {}
diff["config_diff"] = (
dumps(configdiffobjs, "commands") if configdiffobjs else ""
)
# banners = self.__diff_banners(want_banners, have_banners)
# diff["banner_diff"] = banners if banners else {}
return diff
def get_device_info(self) -> dict:
if not self._device_info:
device_info = {}
device_info["network_os"] = "ix"
reply = self.get(command="show version")
data = to_text(reply, errors="surrogate_or_strict")
version_pattern = r"IX Series (.+) Software, Version (\S+),"
match = re.search(version_pattern, data, re.M)
if match:
device_info["network_os_version"] = match.group(2)
# TODO: hostnameとnetwork_os_modelの取得方法を追加する
self.send_command(SVINTR_CONFIG)
self.send_command("configure")
self.send_command("terminal length 0")
reply = self.get(command="show running-config")
data = to_text(reply, errors="surrogate_or_strict")
match = re.search(r"hostname (.+)", data, re.M)
if match:
device_info["network_os_hostname"] = match.group(1)
self._device_info = device_info
return self._device_info
def get(
self,
command=None,
prompt=None,
answer=None,
sendonly=False,
newline=True,
output=None,
check_all=False,
):
if not command:
raise ValueError("must provide value of command to execute")
if output:
raise ValueError(f"'output' value {output} is not supported for get")
return self.send_command(
command=command,
prompt=prompt,
answer=answer,
sendonly=sendonly,
newline=newline,
check_all=check_all,
)
@configure_mode
def configure_get(
self,
command=None,
prompt=None,
answer=None,
sendonly=False,
newline=True,
output=None,
check_all=False,
):
return self.get(
command,
prompt,
answer,
sendonly,
newline,
output,
check_all,
)
def get_capabilities(self) -> str:
result = super(Cliconf, self).get_capabilities()
result["rpc"] += ["get_diff", "run_commands"]
result["device_operations"] = self.get_device_operations()
return json.dumps(result)
def get_device_operations(self) -> dict:
return {
"supports_diff_replace": True,
"supports_commit": False,
"supports_rollback": False,
"supports_onbox_diff": False,
"supports_commit_comment": False,
"supports_multiline_delimiter": False,
"supports_diff_match": True,
"supports_diff_ignore_lines": True,
"supports_generate_diff": True,
"supports_replace": False,
}
def get_option_values(self):
return {
"format": ["text"],
"diff_match": ["line", "strict", "exact", "none"],
"diff_replace": ["line", "block"],
"output": [],
}
def run_commands(self, commands=None, check_rc=True) -> list:
if commands is None:
raise ValueError("'commands' value is required")
responses = list()
for cmd in to_list(commands):
if not isinstance(cmd, Mapping):
cmd = {"command": cmd}
output = cmd.pop("output", None)
if output:
raise ValueError(
f"'output' value {output} is not supported for run_commands"
)
try:
out = self.send_command(**cmd)
except AnsibleConnectionFailure as e:
if check_rc:
raise
out = getattr(e, "err", to_text(e))
responses.append(out)
return responses
@configure_mode
def run_configs(self, commands=None, check_rc=True) -> list:
return self.run_commands(commands=commands, check_rc=check_rc)
@configure_mode
def edit_config(
self, candidate=None, commit=True, replace=None, diff=False, comment=None
):
resp = {}
operations = self.get_device_operations()
self.check_edit_config_capability(
operations, candidate, commit, replace, comment
)
results = []
requests = []
if commit:
self.send_command("configure")
for line in to_list(candidate):
if not isinstance(line, Mapping):
line = {"command": line}
cmd = line["command"]
if cmd != "exit":
results.append(self.send_command(**line))
requests.append(cmd)
self.send_command("configure")
self.send_command("exit")
else:
raise ValueError("check mode is not supported")
resp["request"] = requests
resp["response"] = results
return resp
def get_default_flag(self):
self.send_command(SVINTR_CONFIG)
out = self.get("show running-config ?")
out = to_text(out, errors="surrogate_then_replace")
commands = set()
for line in out.splitlines():
if line.strip():
commands.add(line.strip().split()[0])
if "all" in commands:
return "all"
else:
return "full"