mirror of https://github.com/ansible/ansible.git
Add cli and netconf ability from ansible itself for cloudengine ce modules (#41357)
* for shippable for shippable * add cliconf * add network_cli * add cliconf and network cli and netconf * modify bugs of netconf * add shippable modify * update shippable update shippablepull/41530/head
Biao Liu
6 years ago
committed by
Ganesh Nalawade
parent
79dd206b3e
commit
d90d8e7f99
@ -0,0 +1,93 @@
|
|||||||
|
#
|
||||||
|
# (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/>.
|
||||||
|
#
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import re
|
||||||
|
import json
|
||||||
|
|
||||||
|
from itertools import chain
|
||||||
|
|
||||||
|
from ansible.module_utils._text import to_text
|
||||||
|
from ansible.module_utils.network.common.utils import to_list
|
||||||
|
from ansible.plugins.cliconf import CliconfBase, enable_mode
|
||||||
|
|
||||||
|
|
||||||
|
class Cliconf(CliconfBase):
|
||||||
|
|
||||||
|
def get_device_info(self):
|
||||||
|
device_info = {}
|
||||||
|
|
||||||
|
device_info['network_os'] = 'ce'
|
||||||
|
reply = self.get(b'display version')
|
||||||
|
data = to_text(reply, errors='surrogate_or_strict').strip()
|
||||||
|
|
||||||
|
match = re.search(r'^Huawei.+\n.+\Version\s+(\S+)', data)
|
||||||
|
if match:
|
||||||
|
device_info['network_os_version'] = match.group(1).strip(',')
|
||||||
|
|
||||||
|
match = re.search(r'^Huawei(.+)\n.+\(\S+\s+\S+\)', data, re.M)
|
||||||
|
if match:
|
||||||
|
device_info['network_os_model'] = match.group(1)
|
||||||
|
|
||||||
|
match = re.search(r'HUAWEI\s+(\S+)\s+uptime', data, re.M)
|
||||||
|
if match:
|
||||||
|
device_info['network_os_hostname'] = match.group(1)
|
||||||
|
|
||||||
|
return device_info
|
||||||
|
|
||||||
|
@enable_mode
|
||||||
|
def get_config(self, source='running', format='text', flags=None):
|
||||||
|
if source not in ('running'):
|
||||||
|
return self.invalid_params("fetching configuration from %s is not supported" % source)
|
||||||
|
|
||||||
|
if not flags:
|
||||||
|
flags = []
|
||||||
|
|
||||||
|
cmd = 'display current-configuration'
|
||||||
|
|
||||||
|
return self.send_command(cmd)
|
||||||
|
|
||||||
|
@enable_mode
|
||||||
|
def edit_config(self, command):
|
||||||
|
results = []
|
||||||
|
for cmd in chain(['configure terminal'], to_list(command), ['end']):
|
||||||
|
if isinstance(cmd, dict):
|
||||||
|
command = cmd['command']
|
||||||
|
prompt = cmd['prompt']
|
||||||
|
answer = cmd['answer']
|
||||||
|
newline = cmd.get('newline', True)
|
||||||
|
else:
|
||||||
|
command = cmd
|
||||||
|
prompt = None
|
||||||
|
answer = None
|
||||||
|
newline = True
|
||||||
|
|
||||||
|
results.append(self.send_command(command, prompt, answer, False, newline))
|
||||||
|
return results[1:-1]
|
||||||
|
|
||||||
|
def get(self, command, prompt=None, answer=None, sendonly=False):
|
||||||
|
return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
|
||||||
|
|
||||||
|
def get_capabilities(self):
|
||||||
|
result = {}
|
||||||
|
result['rpc'] = self.get_base_rpc()
|
||||||
|
result['network_api'] = 'cliconf'
|
||||||
|
result['device_info'] = self.get_device_info()
|
||||||
|
return json.dumps(result)
|
||||||
@ -0,0 +1,217 @@
|
|||||||
|
#
|
||||||
|
# (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/>.
|
||||||
|
#
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import json
|
||||||
|
import re
|
||||||
|
|
||||||
|
from ansible import constants as C
|
||||||
|
from ansible.module_utils._text import to_text, to_bytes
|
||||||
|
from ansible.errors import AnsibleConnectionFailure, AnsibleError
|
||||||
|
from ansible.plugins.netconf import NetconfBase
|
||||||
|
from ansible.plugins.netconf import ensure_connected
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ncclient import manager
|
||||||
|
from ncclient.operations import RPCError
|
||||||
|
from ncclient.transport.errors import SSHUnknownHostError
|
||||||
|
from ncclient.xml_ import to_ele, to_xml, new_ele
|
||||||
|
except ImportError:
|
||||||
|
raise AnsibleError("ncclient is not installed")
|
||||||
|
|
||||||
|
try:
|
||||||
|
from __main__ import display
|
||||||
|
except ImportError:
|
||||||
|
from ansible.utils.display import Display
|
||||||
|
display = Display()
|
||||||
|
|
||||||
|
|
||||||
|
class Netconf(NetconfBase):
|
||||||
|
|
||||||
|
def get_text(self, ele, tag):
|
||||||
|
try:
|
||||||
|
return to_text(ele.find(tag).text, errors='surrogate_then_replace').strip()
|
||||||
|
except AttributeError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def get_device_info(self):
|
||||||
|
device_info = dict()
|
||||||
|
device_info['network_os'] = 'ce'
|
||||||
|
ele = new_ele('get-software-information')
|
||||||
|
data = self.execute_rpc(to_xml(ele))
|
||||||
|
reply = to_ele(to_bytes(data, errors='surrogate_or_strict'))
|
||||||
|
sw_info = reply.find('.//software-information')
|
||||||
|
|
||||||
|
device_info['network_os_version'] = self.get_text(sw_info, 'ce-version')
|
||||||
|
device_info['network_os_hostname'] = self.get_text(sw_info, 'host-name')
|
||||||
|
device_info['network_os_model'] = self.get_text(sw_info, 'product-model')
|
||||||
|
|
||||||
|
return device_info
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def execute_rpc(self, name):
|
||||||
|
"""RPC to be execute on remote device
|
||||||
|
:name: Name of rpc in string format"""
|
||||||
|
return self.rpc(name)
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def load_configuration(self, *args, **kwargs):
|
||||||
|
"""Loads given configuration on device
|
||||||
|
:format: Format of configuration (xml, text, set)
|
||||||
|
:action: Action to be performed (merge, replace, override, update)
|
||||||
|
:target: is the name of the configuration datastore being edited
|
||||||
|
:config: is the configuration in string format."""
|
||||||
|
if kwargs.get('config'):
|
||||||
|
kwargs['config'] = to_bytes(kwargs['config'], errors='surrogate_or_strict')
|
||||||
|
if kwargs.get('format', 'xml') == 'xml':
|
||||||
|
kwargs['config'] = to_ele(kwargs['config'])
|
||||||
|
|
||||||
|
try:
|
||||||
|
return self.m.load_configuration(*args, **kwargs).data_xml
|
||||||
|
except RPCError as exc:
|
||||||
|
raise Exception(to_xml(exc.xml))
|
||||||
|
|
||||||
|
def get_capabilities(self):
|
||||||
|
result = dict()
|
||||||
|
result['rpc'] = self.get_base_rpc() + ['commit', 'discard_changes', 'validate', 'lock', 'unlock', 'copy_copy',
|
||||||
|
'execute_rpc', 'load_configuration', 'get_configuration', 'command',
|
||||||
|
'reboot', 'halt']
|
||||||
|
result['network_api'] = 'netconf'
|
||||||
|
result['device_info'] = self.get_device_info()
|
||||||
|
result['server_capabilities'] = [c for c in self.m.server_capabilities]
|
||||||
|
result['client_capabilities'] = [c for c in self.m.client_capabilities]
|
||||||
|
result['session_id'] = self.m.session_id
|
||||||
|
return json.dumps(result)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def guess_network_os(obj):
|
||||||
|
|
||||||
|
try:
|
||||||
|
m = manager.connect(
|
||||||
|
host=obj._play_context.remote_addr,
|
||||||
|
port=obj._play_context.port or 830,
|
||||||
|
username=obj._play_context.remote_user,
|
||||||
|
password=obj._play_context.password,
|
||||||
|
key_filename=obj._play_context.private_key_file,
|
||||||
|
hostkey_verify=C.HOST_KEY_CHECKING,
|
||||||
|
look_for_keys=C.PARAMIKO_LOOK_FOR_KEYS,
|
||||||
|
allow_agent=obj._play_context.allow_agent,
|
||||||
|
timeout=obj._play_context.timeout
|
||||||
|
)
|
||||||
|
except SSHUnknownHostError as exc:
|
||||||
|
raise AnsibleConnectionFailure(str(exc))
|
||||||
|
|
||||||
|
guessed_os = None
|
||||||
|
for c in m.server_capabilities:
|
||||||
|
if re.search('huawei', c):
|
||||||
|
guessed_os = 'ce'
|
||||||
|
break
|
||||||
|
|
||||||
|
m.close_session()
|
||||||
|
return guessed_os
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def get_configuration(self, *args, **kwargs):
|
||||||
|
"""Retrieve all or part of a specified configuration.
|
||||||
|
:format: format in configuration should be retrieved
|
||||||
|
:filter: specifies the portion of the configuration to retrieve
|
||||||
|
(by default entire configuration is retrieved)"""
|
||||||
|
return self.m.get_configuration(*args, **kwargs).data_xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def compare_configuration(self, *args, **kwargs):
|
||||||
|
"""Compare configuration
|
||||||
|
:rollback: rollback id"""
|
||||||
|
return self.m.compare_configuration(*args, **kwargs).data_xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def execute_action(self, xml_str):
|
||||||
|
"""huawei execute-action"""
|
||||||
|
con_obj = None
|
||||||
|
try:
|
||||||
|
con_obj = self.m.action(action=xml_str)
|
||||||
|
except RPCError as exc:
|
||||||
|
raise Exception(to_xml(exc.xml))
|
||||||
|
|
||||||
|
return con_obj.xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def halt(self):
|
||||||
|
"""reboot the device"""
|
||||||
|
return self.m.halt().data_xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def reboot(self):
|
||||||
|
"""reboot the device"""
|
||||||
|
return self.m.reboot().data_xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def halt(self):
|
||||||
|
"""reboot the device"""
|
||||||
|
return self.m.halt().data_xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def get(self, *args, **kwargs):
|
||||||
|
try:
|
||||||
|
return self.m.get(*args, **kwargs).data_xml
|
||||||
|
except RPCError as exc:
|
||||||
|
raise Exception(to_xml(exc.xml))
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def get_config(self, *args, **kwargs):
|
||||||
|
try:
|
||||||
|
return self.m.get_config(*args, **kwargs).data_xml
|
||||||
|
except RPCError as exc:
|
||||||
|
raise Exception(to_xml(exc.xml))
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def edit_config(self, *args, **kwargs):
|
||||||
|
try:
|
||||||
|
return self.m.edit_config(*args, **kwargs).xml
|
||||||
|
except RPCError as exc:
|
||||||
|
raise Exception(to_xml(exc.xml))
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def execute_nc_cli(self, *args, **kwargs):
|
||||||
|
try:
|
||||||
|
return self.m.cli(*args, **kwargs).xml
|
||||||
|
except RPCError as exc:
|
||||||
|
raise Exception(to_xml(exc.xml))
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def commit(self, *args, **kwargs):
|
||||||
|
try:
|
||||||
|
return self.m.commit(*args, **kwargs).data_xml
|
||||||
|
except RPCError as exc:
|
||||||
|
raise Exception(to_xml(exc.xml))
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def validate(self, *args, **kwargs):
|
||||||
|
return self.m.validate(*args, **kwargs).data_xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def discard_changes(self, *args, **kwargs):
|
||||||
|
return self.m.discard_changes(*args, **kwargs).data_xml
|
||||||
|
|
||||||
|
@ensure_connected
|
||||||
|
def execute_rpc(self, name):
|
||||||
|
"""RPC to be execute on remote device
|
||||||
|
:name: Name of rpc in string format"""
|
||||||
|
return self.rpc(name)
|
||||||
Loading…
Reference in New Issue