Ansible 2.3 feature support for dellos6. (#23084)

* Ansible 2.3 feature support for dellos6.

- With the new Ansible 2.3 infra changes, the dellos modules doesn't work
  (the new infra changes are not backward compatible), so added the below
  changes support it.
- Added the new terminal plugin for DellOS6
- Added the new action plugin for DellOS6
- Modified the modules to work with the new infra.
- with that it adds support for DellOS6 Persistent Connection support.

* Remove pep8 confirming files from dellos6.py and dellos6_config legacy-files
This commit is contained in:
Senthil Kumar Ganesan 2017-03-30 06:26:32 -07:00 committed by Ricardo Carrillo Cruz
commit a0344acd78
9 changed files with 580 additions and 246 deletions

View file

@ -141,13 +141,13 @@ warnings:
sample: ['...', '...']
"""
from ansible.module_utils.basic import get_exception
from ansible.module_utils.netcli import CommandRunner, FailedConditionsError
from ansible.module_utils.network import NetworkModule, NetworkError
import ansible.module_utils.dellos6
from ansible.module_utils.six import string_types
import time
VALID_KEYS = ['command', 'prompt', 'response']
from ansible.module_utils.dellos6 import run_commands
from ansible.module_utils.dellos6 import dellos6_argument_spec, check_args
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.network_common import ComplexList
from ansible.module_utils.netcli import Conditional
def to_lines(stdout):
@ -156,76 +156,86 @@ def to_lines(stdout):
item = str(item).split('\n')
yield item
def parse_commands(module):
for cmd in module.params['commands']:
if isinstance(cmd, string_types):
cmd = dict(command=cmd, output=None)
elif 'command' not in cmd:
module.fail_json(msg='command keyword argument is required')
elif not set(cmd.keys()).issubset(VALID_KEYS):
module.fail_json(msg='unknown keyword specified')
yield cmd
def parse_commands(module, warnings):
command = ComplexList(dict(
command=dict(key=True),
prompt=dict(),
answer=dict()
), module)
commands = command(module.params['commands'])
for index, item in enumerate(commands):
if module.check_mode and not item['command'].startswith('show'):
warnings.append(
'only show commands are supported when using check mode, not '
'executing `%s`' % item['command']
)
elif item['command'].startswith('conf'):
module.fail_json(
msg='dellos6_command does not support running config mode '
'commands. Please use dellos6_config instead'
)
return commands
def main():
spec = dict(
"""main entry point for module execution
"""
argument_spec = dict(
# { command: <str>, prompt: <str>, response: <str> }
commands=dict(type='list', required=True),
wait_for=dict(type='list'),
wait_for=dict(type='list', aliases=['waitfor']),
match=dict(default='all', choices=['all', 'any']),
retries=dict(default=10, type='int'),
interval=dict(default=1, type='int')
)
module = NetworkModule(argument_spec=spec,
connect_on_load=False,
argument_spec.update(dellos6_argument_spec)
module = AnsibleModule(argument_spec=argument_spec,
supports_check_mode=True)
commands = list(parse_commands(module))
conditionals = module.params['wait_for'] or list()
result = {'changed': False}
warnings = list()
runner = CommandRunner(module)
for cmd in commands:
if module.check_mode and not cmd['command'].startswith('show'):
warnings.append('only show commands are supported when using '
'check mode, not executing `%s`' % cmd)
else:
if cmd['command'].startswith('conf'):
module.fail_json(msg='dellos6_command does not support running '
'config mode commands. Please use '
'dellos6_config instead')
try:
runner.add_command(**cmd)
except AddCommandError:
exc = get_exception()
warnings.append('duplicate command detected: %s' % cmd)
for item in conditionals:
runner.add_conditional(item)
runner.retries = module.params['retries']
runner.interval = module.params['interval']
try:
runner.run()
except FailedConditionsError:
exc = get_exception()
module.fail_json(msg=str(exc), failed_conditions=exc.failed_conditions)
except NetworkError:
exc = get_exception()
module.fail_json(msg=str(exc))
result = dict(changed=False)
result['stdout'] = list()
for cmd in commands:
try:
output = runner.get_command(cmd['command'])
except ValueError:
output = 'command not executed due to check_mode, see warnings'
result['stdout'].append(output)
check_args(module, warnings)
commands = parse_commands(module, warnings)
result['warnings'] = warnings
result['stdout_lines'] = list(to_lines(result['stdout']))
wait_for = module.params['wait_for'] or list()
conditionals = [Conditional(c) for c in wait_for]
retries = module.params['retries']
interval = module.params['interval']
match = module.params['match']
while retries > 0:
responses = run_commands(module, commands)
for item in list(conditionals):
if item(responses):
if match == 'any':
conditionals = list()
break
conditionals.remove(item)
if not conditionals:
break
time.sleep(interval)
retries -= 1
if conditionals:
failed_conditions = [item.raw for item in conditionals]
msg = 'One or more conditional statements have not be satisfied'
module.fail_json(msg=msg, failed_conditions=failed_conditions)
result = {
'changed': False,
'stdout': responses,
'stdout_lines': list(to_lines(responses))
}
module.exit_json(**result)

View file

@ -194,9 +194,12 @@ saved:
sample: True
"""
from ansible.module_utils.netcfg import dumps
from ansible.module_utils.network import NetworkModule
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.netcfg import NetworkConfig, dumps
from ansible.module_utils.dellos6 import get_config, get_sublevel_config, Dellos6NetworkConfig
from ansible.module_utils.dellos6 import dellos6_argument_spec, check_args
from ansible.module_utils.dellos6 import load_config, run_commands
from ansible.module_utils.dellos6 import WARNING_PROMPTS_RE
def get_candidate(module):
@ -223,16 +226,18 @@ def main():
match=dict(default='line',
choices=['line', 'strict', 'exact', 'none']),
replace=dict(default='line', choices=['line', 'block']),
update=dict(choices=['merge', 'check'], default='merge'),
save=dict(type='bool', default=False),
config=dict(),
backup=dict(type='bool', default=False)
)
argument_spec.update(dellos6_argument_spec)
mutually_exclusive = [('lines', 'src')]
module = NetworkModule(argument_spec=argument_spec,
connect_on_load=False,
module = AnsibleModule(argument_spec=argument_spec,
mutually_exclusive=mutually_exclusive,
supports_check_mode=True)
@ -240,21 +245,26 @@ def main():
match = module.params['match']
replace = module.params['replace']
result = dict(changed=False, saved=False)
candidate = get_candidate(module)
warnings = list()
check_args(module, warnings)
result = dict(changed=False, saved=False, warnings=warnings)
candidate = get_candidate(module)
if match != 'none':
config = get_config(module)
config = Dellos6NetworkConfig(contents=config, indent=0)
if parents:
config = get_sublevel_config(config, module)
configobjs = candidate.difference(config, match=match, replace=replace)
else:
configobjs = candidate.items
if module.params['backup']:
result['__backup__'] = module.cli('show running-config')[0]
result['__backup__'] = get_config(module)
commands = list()
if configobjs:
commands = dumps(configobjs, 'commands')
commands = commands.split('\n')
@ -266,17 +276,16 @@ def main():
commands.extend(module.params['after'])
if not module.check_mode and module.params['update'] == 'merge':
response = module.config.load_config(commands)
result['responses'] = response
load_config(module, commands)
if module.params['save']:
module.config.save_config()
cmd = {'command': 'copy runing-config startup-config', 'prompt': WARNING_PROMPTS_RE, 'answer': 'yes'}
run_commands(module, [cmd])
result['saved'] = True
result['changed'] = True
result['updates'] = commands
module.exit_json(**result)
if __name__ == '__main__':

View file

@ -122,32 +122,46 @@ ansible_net_neighbors:
"""
import re
import itertools
from ansible.module_utils.dellos6 import run_commands
from ansible.module_utils.dellos6 import dellos6_argument_spec, check_args
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.six import iteritems
from ansible.module_utils.six.moves import zip
from ansible.module_utils.netcli import CommandRunner
from ansible.module_utils.network import NetworkModule
import ansible.module_utils.dellos6
class FactsBase(object):
def __init__(self, runner):
self.runner = runner
self.facts = dict()
COMMANDS = list()
def __init__(self, module):
self.module = module
self.facts = dict()
self.responses = None
def populate(self):
self.responses = run_commands(self.module, self.COMMANDS, check_rc=False)
def run(self, cmd):
return run_commands(self.module, cmd, check_rc=False)
self.commands()
class Default(FactsBase):
def commands(self):
self.runner.add_command('show version')
self.runner.add_command('show running-config | include hostname')
COMMANDS = [
'show version',
'show running-config | include hostname'
]
def populate(self):
data = self.runner.get_command('show version')
super(Default, self).populate()
data = self.responses[0]
self.facts['version'] = self.parse_version(data)
self.facts['serialnum'] = self.parse_serialnum(data)
self.facts['model'] = self.parse_model(data)
self.facts['image'] = self.parse_image(data)
hdata =self.runner.get_command('show running-config | include hostname')
hdata = self.responses[0]
self.facts['hostname'] = self.parse_hostname(hdata)
def parse_version(self, data):
@ -178,12 +192,13 @@ class Default(FactsBase):
class Hardware(FactsBase):
def commands(self):
self.runner.add_command('show memory cpu')
COMMANDS = [
'show memory cpu'
]
def populate(self):
data = self.runner.get_command('show memory cpu')
super(Hardware, self).populate()
data = self.responses[0]
match = re.findall('\s(\d+)\s', data)
if match:
self.facts['memtotal_mb'] = int(match[0]) / 1024
@ -192,38 +207,40 @@ class Hardware(FactsBase):
class Config(FactsBase):
def commands(self):
self.runner.add_command('show running-config')
COMMANDS = ['show running-config']
def populate(self):
self.facts['config'] = self.runner.get_command('show running-config')
super(Config, self).populate()
self.facts['config'] = self.responses[0]
class Interfaces(FactsBase):
def commands(self):
self.runner.add_command('show interfaces')
self.runner.add_command('show interfaces status')
self.runner.add_command('show interfaces transceiver properties')
self.runner.add_command('show ip int')
self.runner.add_command('show lldp')
self.runner.add_command('show lldp remote-device all')
COMMANDS = [
'show interfaces',
'show interfaces status',
'show interfaces transceiver properties',
'show ip int',
'show lldp',
'show lldp remote-device all'
]
def populate(self):
vlan_info = dict()
data = self.runner.get_command('show interfaces')
super(Interfaces, self).populate()
data = self.responses[0]
interfaces = self.parse_interfaces(data)
desc = self.runner.get_command('show interfaces status')
properties = self.runner.get_command('show interfaces transceiver properties')
vlan = self.runner.get_command('show ip int')
desc = self.responses[1]
properties = self.responses[2]
vlan = self.responses[3]
vlan_info = self.parse_vlan(vlan)
self.facts['interfaces'] = self.populate_interfaces(interfaces,desc,properties)
self.facts['interfaces'] = self.populate_interfaces(interfaces, desc, properties)
self.facts['interfaces'].update(vlan_info)
if 'LLDP is not enabled' not in self.runner.get_command('show lldp'):
neighbors = self.runner.get_command('show lldp remote-device all')
if 'LLDP is not enabled' not in self.responses[4]:
neighbors = self.responses[5]
self.facts['neighbors'] = self.parse_neighbors(neighbors)
def parse_vlan(self,vlan):
facts =dict()
def parse_vlan(self, vlan):
facts = dict()
vlan_info, vlan_info_next = vlan.split('---------- ----- --------------- --------------- -------')
for en in vlan_info_next.splitlines():
if en == '':
@ -233,7 +250,7 @@ class Interfaces(FactsBase):
if intf not in facts:
facts[intf] = list()
fact = dict()
matc=re.search('^([\w+\s\d]*)\s+(\S+)\s+(\S+)',en)
matc = re.search('^([\w+\s\d]*)\s+(\S+)\s+(\S+)', en)
fact['address'] = matc.group(2)
fact['masklen'] = matc.group(3)
facts[intf].append(fact)
@ -243,15 +260,15 @@ class Interfaces(FactsBase):
facts = dict()
for key, value in interfaces.items():
intf = dict()
intf['description'] = self.parse_description(key,desc)
intf['description'] = self.parse_description(key, desc)
intf['macaddress'] = self.parse_macaddress(value)
intf['mtu'] = self.parse_mtu(value)
intf['bandwidth'] = self.parse_bandwidth(value)
intf['mediatype'] = self.parse_mediatype(key,properties)
intf['mediatype'] = self.parse_mediatype(key, properties)
intf['duplex'] = self.parse_duplex(value)
intf['lineprotocol'] = self.parse_lineprotocol(value)
intf['operstatus'] = self.parse_operstatus(value)
intf['type'] = self.parse_type(key,properties)
intf['type'] = self.parse_type(key, properties)
facts[key] = intf
return facts
@ -265,8 +282,11 @@ class Interfaces(FactsBase):
if intf not in facts:
facts[intf] = list()
fact = dict()
fact['host'] = self.parse_lldp_host(en.split()[4])
fact['port'] = self.parse_lldp_port(en.split()[3])
if (len(en.split()) > 4):
fact['host'] = self.parse_lldp_host(en.split()[4])
else:
fact['host'] = "Null"
facts[intf].append(fact)
return facts
@ -287,11 +307,14 @@ class Interfaces(FactsBase):
def parse_description(self, key, desc):
desc, desc_next = desc.split('--------- --------------- ------ ------- ---- ------ ----- -- -------------------')
desc_val, desc_info = desc_next.split('Oob')
if desc_next.find('Oob') > 0:
desc_val, desc_info = desc_next.split('Oob')
elif desc_next.find('Port') > 0:
desc_val, desc_info = desc_next.split('Port')
for en in desc_val.splitlines():
if key in en:
match = re.search('^(\S+)\s+(\S+)', en)
if match.group(2) in ['Full','N/A']:
if match.group(2) in ['Full', 'N/A']:
return "Null"
else:
return match.group(2)
@ -307,9 +330,9 @@ class Interfaces(FactsBase):
return int(match.group(2))
def parse_bandwidth(self, data):
match = re.search(r'Port Speed(.+)\s(\d+)\n', data)
match = re.search(r'Port Speed\s*[:\s\.]+\s(\d+)\n', data)
if match:
return int(match.group(2))
return int(match.group(1))
def parse_duplex(self, data):
match = re.search(r'Port Mode\s([A-Za-z]*)(.+)\s([A-Za-z/]*)\n', data)
@ -318,40 +341,43 @@ class Interfaces(FactsBase):
def parse_mediatype(self, key, properties):
mediatype, mediatype_next = properties.split('--------- ------- --------------------- --------------------- --------------')
flag=1
flag = 1
for en in mediatype_next.splitlines():
if key in en:
flag=0
match = re.search('^(\S+)\s+(\S+)\s+(\S+)',en)
flag = 0
match = re.search('^(\S+)\s+(\S+)\s+(\S+)', en)
if match:
strval = match.group(3)
return match.group(3)
if flag==1:
if flag == 1:
return "null"
def parse_type(self, key, properties):
type_val, type_val_next = properties.split('--------- ------- --------------------- --------------------- --------------')
flag=1
flag = 1
for en in type_val_next.splitlines():
if key in en:
flag=0
match = re.search('^(\S+)\s+(\S+)\s+(\S+)',en)
flag = 0
match = re.search('^(\S+)\s+(\S+)\s+(\S+)', en)
if match:
strval = match.group(2)
return match.group(2)
if flag==1:
if flag == 1:
return "null"
def parse_lineprotocol(self, data):
match = re.search(r'Link Status.*\s(\S+)\s+(\S+)\n', data)
if match:
strval= match.group(2)
return strval.strip('/')
data = data.splitlines()
for d in data:
match = re.search(r'^Link Status\s*[:\s\.]+\s(\S+)', d)
if match:
return match.group(1)
def parse_operstatus(self, data):
match = re.search(r'Link Status.*\s(\S+)\s+(\S+)\n', data)
if match:
return match.group(1)
data = data.splitlines()
for d in data:
match = re.search(r'^Link Status\s*[:\s\.]+\s(\S+)', d)
if match:
return match.group(1)
def parse_lldp_intf(self, data):
match = re.search(r'^([A-Za-z0-9/]*)', data)
@ -359,7 +385,7 @@ class Interfaces(FactsBase):
return match.group(1)
def parse_lldp_host(self, data):
match = re.search(r'^([A-Za-z0-9]*)', data)
match = re.search(r'^([A-Za-z0-9-]*)', data)
if match:
return match.group(1)
@ -378,11 +404,18 @@ FACT_SUBSETS = dict(
VALID_SUBSETS = frozenset(FACT_SUBSETS.keys())
def main():
spec = dict(
"""main entry point for module execution
"""
argument_spec = dict(
gather_subset=dict(default=['!config'], type='list')
)
module = NetworkModule(argument_spec=spec, supports_check_mode=True)
argument_spec.update(dellos6_argument_spec)
module = AnsibleModule(argument_spec=argument_spec,
supports_check_mode=True)
gather_subset = module.params['gather_subset']
@ -420,27 +453,23 @@ def main():
facts = dict()
facts['gather_subset'] = list(runable_subsets)
runner = CommandRunner(module)
instances = list()
for key in runable_subsets:
instances.append(FACT_SUBSETS[key](runner))
runner.run()
instances.append(FACT_SUBSETS[key](module))
try:
for inst in instances:
inst.populate()
facts.update(inst.facts)
except Exception:
module.exit_json(out=module.from_json(runner.items))
for inst in instances:
inst.populate()
facts.update(inst.facts)
ansible_facts = dict()
for key, value in facts.items():
for key, value in iteritems(facts):
key = 'ansible_net_%s' % key
ansible_facts[key] = value
module.exit_json(ansible_facts=ansible_facts)
warnings = list()
check_args(module, warnings)
module.exit_json(ansible_facts=ansible_facts, warnings=warnings)
if __name__ == '__main__':
main()