def collect_facts(module, result): out = run_commands(module, ['show management api http-commands | json']) facts = dict(eos_eapi_urls=dict()) for each in out[0]['urls']: intf, url = each.split(' : ') key = str(intf).strip() if key not in facts['eos_eapi_urls']: facts['eos_eapi_urls'][key] = list() facts['eos_eapi_urls'][key].append(str(url).strip()) result['ansible_facts'] = facts
def collect_facts(module, result): out = run_commands(module, ["show management api http-commands | json"]) facts = dict(eos_eapi_urls=dict()) for each in out[0]["urls"]: intf, url = each.split(":", 1) key = str(intf).strip() if key not in facts["eos_eapi_urls"]: facts["eos_eapi_urls"][key] = list() facts["eos_eapi_urls"][key].append(str(url).strip()) result["ansible_facts"] = facts
def get_os_version(module): os_version = "4.20.10" response = run_commands(module, 'show version | grep "Software image version"') version_match = re.search(r"Software image version:\s+([\d\.]+)", response[0], re.M) if version_match: v = version_match.group(1).split(".") os_version = tuple(int(digit) for digit in v) return os_version
def map_config_to_obj(module, warnings): config = get_config(module, flags=["| section interface"]) configobj = NetworkConfig(indent=3, contents=config) match = re.findall(r"^interface (\S+)", config, re.M) if not match: return list() instances = list() for item in set(match): command = { "command": "show interfaces {0} switchport | include Switchport".format(item), "output": "text", } command_result = run_commands(module, command, check_rc=False) if "Interface does not exist" in command_result[0]: warnings.append( "Could not gather switchport information for {0}: {1}".format( item, command_result[0])) continue if command_result[0]: switchport_cfg = command_result[0].split(":")[1].strip() if switchport_cfg == "Enabled": state = "present" else: state = "absent" obj = { "name": item.lower(), "state": state, "access_vlan": parse_config_argument(configobj, item, "switchport access vlan"), "native_vlan": parse_config_argument(configobj, item, "switchport trunk native vlan"), "trunk_allowed_vlans": parse_config_argument(configobj, item, "switchport trunk allowed vlan"), } if obj["access_vlan"]: obj["mode"] = "access" else: obj["mode"] = "trunk" instances.append(obj) return instances
def main(): """entry point for module execution """ argument_spec = dict(commands=dict(type='list', required=True), 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')) argument_spec.update(eos_argument_spec) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) warnings = list() result = {'changed': False, 'warnings': warnings} commands = parse_commands(module, warnings) wait_for = module.params['wait_for'] or list() try: conditionals = [Conditional(c) for c in wait_for] except AttributeError as exc: module.fail_json(msg=to_text(exc)) 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 been satisfied' module.fail_json(msg=msg, failed_conditions=failed_conditions) result.update({ 'stdout': responses, 'stdout_lines': list(to_lines(responses)), }) module.exit_json(**result)
def map_config_to_obj(module): out = run_commands(module, ["show management api http-commands | json"]) return { "http": out[0]["httpServer"]["configured"], "http_port": out[0]["httpServer"]["port"], "https": out[0]["httpsServer"]["configured"], "https_port": out[0]["httpsServer"]["port"], "local_http": out[0]["localHttpServer"]["configured"], "local_http_port": out[0]["localHttpServer"]["port"], "socket": out[0]["unixSocketServer"]["configured"], "vrf": out[0]["vrf"] or "default", "state": parse_state(out), }
def map_config_to_obj(module): out = run_commands(module, ['show management api http-commands | json']) return { 'http': out[0]['httpServer']['configured'], 'http_port': out[0]['httpServer']['port'], 'https': out[0]['httpsServer']['configured'], 'https_port': out[0]['httpsServer']['port'], 'local_http': out[0]['localHttpServer']['configured'], 'local_http_port': out[0]['localHttpServer']['port'], 'socket': out[0]['unixSocketServer']['configured'], 'vrf': out[0]['vrf'] or "default", 'state': parse_state(out) }
def validate_vrf(value, module): out = run_commands(module, ['show vrf']) configured_vrfs = [] lines = out[0].strip().splitlines()[3:] for l in lines: if not l: continue splitted_line = re.split(r'\s{2,}', l.strip()) if len(splitted_line) > 2: configured_vrfs.append(splitted_line[0]) configured_vrfs.append('default') if value not in configured_vrfs: module.fail_json(msg='vrf `%s` is not configured on the system' % value)
def validate_vrf(value, module): out = run_commands(module, ["show vrf"]) configured_vrfs = [] lines = out[0].strip().splitlines()[3:] for line in lines: if not line: continue splitted_line = re.split(r"\s{2,}", line.strip()) if len(splitted_line) > 2: configured_vrfs.append(splitted_line[0]) configured_vrfs.append("default") if value not in configured_vrfs: module.fail_json(msg="vrf `%s` is not configured on the system" % value)
def map_config_to_obj(module): output = run_commands(module, ["show banner %s" % module.params["banner"]]) obj = {"banner": module.params["banner"], "state": "absent"} if output: if is_local_eapi(module): # On EAPI we need to extract the banner text from dict key # 'loginBanner' if module.params["banner"] == "login": banner_response_key = "loginBanner" else: banner_response_key = "motd" if (isinstance(output[0], dict) and banner_response_key in output[0].keys()): obj["text"] = output[0] else: obj["text"] = output[0] obj["state"] = "present" return obj
def map_config_to_obj(module): output = run_commands(module, ['show banner %s' % module.params['banner']]) obj = {'banner': module.params['banner'], 'state': 'absent'} if output: if is_local_eapi(module): # On EAPI we need to extract the banner text from dict key # 'loginBanner' if module.params['banner'] == 'login': banner_response_key = 'loginBanner' else: banner_response_key = 'motd' if isinstance(output[0], dict) and banner_response_key in output[0].keys(): obj['text'] = output[0] else: obj['text'] = output[0] obj['state'] = 'present' return obj
def map_config_to_obj(module): objs = [] output = run_commands(module, {'command': 'show vrf', 'output': 'text'}) lines = output[0].strip().splitlines()[3:] out_len = len(lines) index = 0 while out_len > index: line = lines[index] if not line: continue splitted_line = re.split(r'\s{2,}', line.strip()) if len(splitted_line) == 1: index += 1 continue else: obj = dict() obj['name'] = splitted_line[0] obj['rd'] = splitted_line[1] obj['interfaces'] = [] if len(splitted_line) > 4: obj['interfaces'] = [] interfaces = splitted_line[4] if interfaces.endswith(','): while interfaces.endswith(','): # gather all comma separated interfaces if out_len <= index: break index += 1 line = lines[index] vrf_line = re.split(r'\s{2,}', line.strip()) interfaces += vrf_line[-1] for i in interfaces.split(','): obj['interfaces'].append(i.strip().lower()) index += 1 objs.append(obj) return objs
def map_config_to_obj(module): objs = [] output = run_commands(module, {"command": "show vrf", "output": "text"}) lines = output[0].strip().splitlines()[3:] out_len = len(lines) index = 0 while out_len > index: line = lines[index] if not line: continue splitted_line = re.split(r"\s{2,}", line.strip()) if len(splitted_line) == 1: index += 1 continue obj = dict() obj["name"] = splitted_line[0] obj["rd"] = splitted_line[1] obj["interfaces"] = [] if len(splitted_line) > 4: obj["interfaces"] = [] interfaces = splitted_line[4] if interfaces.endswith(","): while interfaces.endswith(","): # gather all comma separated interfaces if out_len <= index: break index += 1 line = lines[index] vrf_line = re.split(r"\s{2,}", line.strip()) interfaces += vrf_line[-1] for i in interfaces.split(","): obj["interfaces"].append(i.strip().lower()) index += 1 objs.append(obj) return objs
def map_config_to_obj(module, warnings): config = get_config(module, flags=['| section interface']) configobj = NetworkConfig(indent=3, contents=config) match = re.findall(r'^interface (\S+)', config, re.M) if not match: return list() instances = list() for item in set(match): command = {'command': 'show interfaces {0} switchport | include Switchport'.format(item), 'output': 'text'} command_result = run_commands(module, command, check_rc=False) if "Interface does not exist" in command_result[0]: warnings.append("Could not gather switchport information for {0}: {1}".format(item, command_result[0])) continue if command_result[0]: switchport_cfg = command_result[0].split(':')[1].strip() if switchport_cfg == 'Enabled': state = 'present' else: state = 'absent' obj = { 'name': item.lower(), 'state': state, 'access_vlan': parse_config_argument(configobj, item, 'switchport access vlan'), 'native_vlan': parse_config_argument(configobj, item, 'switchport trunk native vlan'), 'trunk_allowed_vlans': parse_config_argument(configobj, item, 'switchport trunk allowed vlan'), } if obj['access_vlan']: obj['mode'] = 'access' else: obj['mode'] = 'trunk' instances.append(obj) return instances
def map_config_to_obj(module): objs = [] vlans = run_commands(module, ['show vlan configured-ports | json']) for vlan in vlans[0]['vlans']: obj = {} obj['vlan_id'] = vlan obj['name'] = vlans[0]['vlans'][vlan]['name'] obj['state'] = vlans[0]['vlans'][vlan]['status'] obj['interfaces'] = [] interfaces = vlans[0]['vlans'][vlan] for interface in interfaces['interfaces']: obj['interfaces'].append(interface) if obj['state'] == 'suspended': obj['state'] = 'suspend' objs.append(obj) return objs
def map_config_to_obj(module): objs = [] vlans = run_commands(module, ["show vlan configured-ports | json"]) for vlan in vlans[0]["vlans"]: obj = {} obj["vlan_id"] = vlan obj["name"] = vlans[0]["vlans"][vlan]["name"] obj["state"] = vlans[0]["vlans"][vlan]["status"] obj["interfaces"] = [] interfaces = vlans[0]["vlans"][vlan] for interface in interfaces["interfaces"]: obj["interfaces"].append(interface) if obj["state"] == "suspended": obj["state"] = "suspend" objs.append(obj) return objs
def main(): """ main entry point for module execution """ backup_spec = dict(filename=dict(), dir_path=dict(type="path")) argument_spec = dict( src=dict(type="path"), lines=dict(aliases=["commands"], type="list", elements="str"), parents=dict(type="list", elements="str"), before=dict(type="list", elements="str"), after=dict(type="list", elements="str"), match=dict(default="line", choices=["line", "strict", "exact", "none"]), replace=dict(default="line", choices=["line", "block", "config"]), defaults=dict(type="bool", default=False), backup=dict(type="bool", default=False), backup_options=dict(type="dict", options=backup_spec), save_when=dict(choices=["always", "never", "modified", "changed"], default="never"), diff_against=dict( choices=["startup", "session", "intended", "running"], default="session", ), diff_ignore_lines=dict(type="list", elements="str"), running_config=dict(aliases=["config"]), intended_config=dict(), ) argument_spec.update(eos_argument_spec) mutually_exclusive = [("lines", "src"), ("parents", "src")] required_if = [ ("match", "strict", ["lines"]), ("match", "exact", ["lines"]), ("replace", "block", ["lines"]), ("replace", "config", ["src"]), ("diff_against", "intended", ["intended_config"]), ] module = AnsibleModule( argument_spec=argument_spec, mutually_exclusive=mutually_exclusive, required_if=required_if, supports_check_mode=True, ) warnings = list() result = {"changed": False} if warnings: result["warnings"] = warnings diff_ignore_lines = module.params["diff_ignore_lines"] config = None contents = None flags = ["all"] if module.params["defaults"] else [] connection = get_connection(module) # Refuse to diff_against: session if sessions are disabled if (module.params["diff_against"] == "session" and not connection.supports_sessions): module.fail_json( msg= "Cannot diff against sessions when sessions are disabled. Please change diff_against to another value" ) if module.params["backup"] or (module._diff and module.params["diff_against"] == "running"): contents = get_config(module, flags=flags) config = NetworkConfig(indent=1, contents=contents) if module.params["backup"]: result["__backup__"] = contents if any((module.params["src"], module.params["lines"])): match = module.params["match"] replace = module.params["replace"] path = module.params["parents"] candidate = get_candidate(module) running = get_running_config(module, contents, flags=flags) try: response = connection.get_diff( candidate=candidate, running=running, diff_match=match, diff_ignore_lines=diff_ignore_lines, path=path, diff_replace=replace, ) except ConnectionError as exc: module.fail_json(msg=to_text(exc, errors="surrogate_then_replace")) config_diff = response["config_diff"] if config_diff: commands = config_diff.split("\n") if module.params["before"]: commands[:0] = module.params["before"] if module.params["after"]: commands.extend(module.params["after"]) result["commands"] = commands result["updates"] = commands replace = module.params["replace"] == "config" commit = not module.check_mode response = load_config(module, commands, replace=replace, commit=commit) result["changed"] = True if module.params["diff_against"] == "session": if "diff" in response: result["diff"] = {"prepared": response["diff"]} else: result["changed"] = False if "session" in response: result["session"] = response["session"] running_config = module.params["running_config"] startup_config = None if module.params["save_when"] == "always": save_config(module, result) elif module.params["save_when"] == "modified": output = run_commands( module, [ { "command": "show running-config", "output": "text" }, { "command": "show startup-config", "output": "text" }, ], ) running_config = NetworkConfig(indent=3, contents=output[0], ignore_lines=diff_ignore_lines) startup_config = NetworkConfig(indent=3, contents=output[1], ignore_lines=diff_ignore_lines) if running_config.sha1 != startup_config.sha1: save_config(module, result) elif module.params["save_when"] == "changed" and result["changed"]: save_config(module, result) if module._diff: if not running_config: output = run_commands(module, { "command": "show running-config", "output": "text" }) contents = output[0] else: contents = running_config # recreate the object in order to process diff_ignore_lines running_config = NetworkConfig(indent=3, contents=contents, ignore_lines=diff_ignore_lines) if module.params["diff_against"] == "running": if module.check_mode: module.warn( "unable to perform diff against running-config due to check mode" ) contents = None else: contents = config.config_text elif module.params["diff_against"] == "startup": if not startup_config: output = run_commands( module, { "command": "show startup-config", "output": "text" }, ) contents = output[0] else: contents = startup_config.config_text elif module.params["diff_against"] == "intended": contents = module.params["intended_config"] if contents is not None: base_config = NetworkConfig(indent=3, contents=contents, ignore_lines=diff_ignore_lines) if running_config.sha1 != base_config.sha1: if module.params["diff_against"] == "intended": before = running_config after = base_config elif module.params["diff_against"] in ("startup", "running"): before = base_config after = running_config result.update({ "changed": True, "diff": { "before": str(before), "after": str(after) }, }) module.exit_json(**result)
def check_declarative_intent_params(module, want, result): failed_conditions = [] have_neighbors = None for w in want: want_state = w.get('state') want_tx_rate = w.get('tx_rate') want_rx_rate = w.get('rx_rate') want_neighbors = w.get('neighbors') if want_state not in ('up', 'down') and not want_tx_rate and not want_rx_rate and not want_neighbors: continue if result['changed']: sleep(w['delay']) command = {'command': 'show interfaces %s' % w['name'], 'output': 'text'} output = run_commands(module, [command]) if want_state in ('up', 'down'): match = re.search(r'%s (\w+)' % 'line protocol is', output[0], re.M) have_state = None if match: have_state = match.group(1) if have_state is None or not conditional(want_state, have_state.strip()): failed_conditions.append('state ' + 'eq(%s)' % want_state) if want_tx_rate: match = re.search(r'%s (\d+)' % 'output rate', output[0], re.M) have_tx_rate = None if match: have_tx_rate = match.group(1) if have_tx_rate is None or not conditional(want_tx_rate, have_tx_rate.strip(), cast=int): failed_conditions.append('tx_rate ' + want_tx_rate) if want_rx_rate: match = re.search(r'%s (\d+)' % 'input rate', output[0], re.M) have_rx_rate = None if match: have_rx_rate = match.group(1) if have_rx_rate is None or not conditional(want_rx_rate, have_rx_rate.strip(), cast=int): failed_conditions.append('rx_rate ' + want_rx_rate) if want_neighbors: have_host = [] have_port = [] if have_neighbors is None: command = {'command': 'show lldp neighbors {0}'.format(w['name']), 'output': 'text'} have_neighbors = run_commands(module, [command]) if have_neighbors[0]: lines = have_neighbors[0].strip().split('\n') col = None for index, line in enumerate(lines): if re.search(r"^Port\s+Neighbor Device ID\s+Neighbor Port ID\s+TTL", line): col = index break if col and col < len(lines) - 1: for items in lines[col + 1:]: value = re.split(r'\s+', items) try: have_port.append(value[2]) have_host.append(value[1]) except IndexError: pass for item in want_neighbors: host = item.get('host') port = item.get('port') if host and host not in have_host: failed_conditions.append('host ' + host) if port and port not in have_port: failed_conditions.append('port ' + port) return failed_conditions
def main(): """ main entry point for module execution """ backup_spec = dict(filename=dict(), dir_path=dict(type='path')) argument_spec = dict( src=dict(type='path'), lines=dict(aliases=['commands'], type='list'), parents=dict(type='list'), before=dict(type='list'), after=dict(type='list'), match=dict(default='line', choices=['line', 'strict', 'exact', 'none']), replace=dict(default='line', choices=['line', 'block', 'config']), defaults=dict(type='bool', default=False), backup=dict(type='bool', default=False), backup_options=dict(type='dict', options=backup_spec), save_when=dict(choices=['always', 'never', 'modified', 'changed'], default='never'), diff_against=dict( choices=['startup', 'session', 'intended', 'running'], default='session'), diff_ignore_lines=dict(type='list'), running_config=dict(aliases=['config']), intended_config=dict(), ) argument_spec.update(eos_argument_spec) mutually_exclusive = [('lines', 'src'), ('parents', 'src')] required_if = [('match', 'strict', ['lines']), ('match', 'exact', ['lines']), ('replace', 'block', ['lines']), ('replace', 'config', ['src']), ('diff_against', 'intended', ['intended_config'])] module = AnsibleModule(argument_spec=argument_spec, mutually_exclusive=mutually_exclusive, required_if=required_if, supports_check_mode=True) warnings = list() result = {'changed': False} if warnings: result['warnings'] = warnings diff_ignore_lines = module.params['diff_ignore_lines'] config = None contents = None flags = ['all'] if module.params['defaults'] else [] connection = get_connection(module) # Refuse to diff_against: session if sessions are disabled if module.params[ 'diff_against'] == 'session' and not connection.supports_sessions: module.fail_json( msg= "Cannot diff against sessions when sessions are disabled. Please change diff_against to another value" ) if module.params['backup'] or (module._diff and module.params['diff_against'] == 'running'): contents = get_config(module, flags=flags) config = NetworkConfig(indent=1, contents=contents) if module.params['backup']: result['__backup__'] = contents if any((module.params['src'], module.params['lines'])): match = module.params['match'] replace = module.params['replace'] path = module.params['parents'] candidate = get_candidate(module) running = get_running_config(module, contents, flags=flags) try: response = connection.get_diff(candidate=candidate, running=running, diff_match=match, diff_ignore_lines=diff_ignore_lines, path=path, diff_replace=replace) except ConnectionError as exc: module.fail_json(msg=to_text(exc, errors='surrogate_then_replace')) config_diff = response['config_diff'] if config_diff: commands = config_diff.split('\n') if module.params['before']: commands[:0] = module.params['before'] if module.params['after']: commands.extend(module.params['after']) result['commands'] = commands result['updates'] = commands replace = module.params['replace'] == 'config' commit = not module.check_mode response = load_config(module, commands, replace=replace, commit=commit) result['changed'] = True if module.params['diff_against'] == 'session': if 'diff' in response: result['diff'] = {'prepared': response['diff']} else: result['changed'] = False if 'session' in response: result['session'] = response['session'] running_config = module.params['running_config'] startup_config = None if module.params['save_when'] == 'always': save_config(module, result) elif module.params['save_when'] == 'modified': output = run_commands(module, [{ 'command': 'show running-config', 'output': 'text' }, { 'command': 'show startup-config', 'output': 'text' }]) running_config = NetworkConfig(indent=3, contents=output[0], ignore_lines=diff_ignore_lines) startup_config = NetworkConfig(indent=3, contents=output[1], ignore_lines=diff_ignore_lines) if running_config.sha1 != startup_config.sha1: save_config(module, result) elif module.params['save_when'] == 'changed' and result['changed']: save_config(module, result) if module._diff: if not running_config: output = run_commands(module, { 'command': 'show running-config', 'output': 'text' }) contents = output[0] else: contents = running_config # recreate the object in order to process diff_ignore_lines running_config = NetworkConfig(indent=3, contents=contents, ignore_lines=diff_ignore_lines) if module.params['diff_against'] == 'running': if module.check_mode: module.warn( "unable to perform diff against running-config due to check mode" ) contents = None else: contents = config.config_text elif module.params['diff_against'] == 'startup': if not startup_config: output = run_commands(module, { 'command': 'show startup-config', 'output': 'text' }) contents = output[0] else: contents = startup_config.config_text elif module.params['diff_against'] == 'intended': contents = module.params['intended_config'] if contents is not None: base_config = NetworkConfig(indent=3, contents=contents, ignore_lines=diff_ignore_lines) if running_config.sha1 != base_config.sha1: if module.params['diff_against'] == 'intended': before = running_config after = base_config elif module.params['diff_against'] in ('startup', 'running'): before = base_config after = running_config result.update({ 'changed': True, 'diff': { 'before': str(before), 'after': str(after) } }) module.exit_json(**result)
def populate(self): self.responses = run_commands(self.module, list(self.COMMANDS), check_rc=False)
def check_declarative_intent_params(module, want, result): failed_conditions = [] have_neighbors = None for w in want: want_state = w.get("state") want_tx_rate = w.get("tx_rate") want_rx_rate = w.get("rx_rate") want_neighbors = w.get("neighbors") if ( want_state not in ("up", "down") and not want_tx_rate and not want_rx_rate and not want_neighbors ): continue if result["changed"]: sleep(w["delay"]) command = { "command": "show interfaces %s" % w["name"], "output": "text", } output = run_commands(module, [command]) if want_state in ("up", "down"): match = re.search( r"%s (\w+)" % "line protocol is", output[0], re.M ) have_state = None if match: have_state = match.group(1) if have_state is None or not conditional( want_state, have_state.strip() ): failed_conditions.append("state " + "eq(%s)" % want_state) if want_tx_rate: match = re.search(r"%s (\d+)" % "output rate", output[0], re.M) have_tx_rate = None if match: have_tx_rate = match.group(1) if have_tx_rate is None or not conditional( want_tx_rate, have_tx_rate.strip(), cast=int ): failed_conditions.append("tx_rate " + want_tx_rate) if want_rx_rate: match = re.search(r"%s (\d+)" % "input rate", output[0], re.M) have_rx_rate = None if match: have_rx_rate = match.group(1) if have_rx_rate is None or not conditional( want_rx_rate, have_rx_rate.strip(), cast=int ): failed_conditions.append("rx_rate " + want_rx_rate) if want_neighbors: have_host = [] have_port = [] if have_neighbors is None: command = { "command": "show lldp neighbors {0}".format(w["name"]), "output": "text", } have_neighbors = run_commands(module, [command]) if have_neighbors[0]: lines = have_neighbors[0].strip().split("\n") col = None for index, line in enumerate(lines): if re.search( r"^Port\s+Neighbor Device ID\s+Neighbor Port ID\s+TTL", line, ): col = index break if col and col < len(lines) - 1: idx = col + 1 for items in lines[idx:]: value = re.split(r"\s+", items) try: have_port.append(value[2]) have_host.append(value[1]) except IndexError: pass for item in want_neighbors: host = item.get("host") port = item.get("port") if host and host not in have_host: failed_conditions.append("host " + host) if port and port not in have_port: failed_conditions.append("port " + port) return failed_conditions