def extract_cdp_data(cdp_table):
"""
Extract only remote host and interface for each local interface in the CDP table
:param cdp_table: The TextFSM output for CDP neighbor detail
:type cdp_table: list of list
:return: A dictionary for each local interface with corresponding remote host and interface.
:rtype: dict
"""
cdp_data = {}
found_intfs = set()
# Loop through all entry, excluding header row
for entry in cdp_table[1:]:
local_intf = utilities.long_int_name(entry[0])
device_id = entry[1]
system_name = entry[2]
remote_intf = utilities.long_int_name(entry[3])
if system_name == "":
system_name = utilities.extract_system_name(device_id)
# 7Ks can give multiple CDP entries when VDCs share the mgmt0 port. If duplicate name is found, remove it
if local_intf in found_intfs:
# Remove from our description list
cdp_data.pop(system_name, None)
else:
cdp_data[local_intf] = (system_name, remote_intf)
found_intfs.add(local_intf)
return cdp_data
def get_desc_table(session):
"""
A function that creates a lookup dictionary that can be used to get the description of an interface.
:param session: The script object that represents this script being executed
:type session: sessions.Session
:return: A dictionary that allows getting the description of an interface by using the interface as the key.
:rtype: dict
"""
send_cmd = "show interface description"
if session.os == "IOS":
int_template = session.script.get_template("cisco_ios_show_interfaces_description.template")
else:
int_template = session.script.get_template("cisco_nxos_show_interface_description.template")
raw_int_desc = session.get_command_output(send_cmd)
desc_list = utilities.textfsm_parse_to_list(raw_int_desc, int_template)
desc_table = {}
# Change interface names to long versions for better matching with other outputs
for entry in desc_list:
intf = utilities.long_int_name(entry[0])
desc_table[intf] = entry[1]
return desc_table
def get_int_status(session):
"""
A function that captures the "show interface status" command and returns the processed output from TextFSM
:param session: The script object that represents this script being executed
:type session: sessions.Session
:return: TextFSM output from processing the "show interface status" command
:rtype: list of list
"""
if session.os == "IOS":
template_file = session.script.get_template(
"cisco_ios_show_interfaces_status.template")
else:
template_file = session.script.get_template(
"cisco_nxos_show_interface_status.template")
raw_int_status = session.get_command_output("show interface status")
fsm_results = utilities.textfsm_parse_to_list(raw_int_status,
template_file)
for entry in fsm_results:
entry[0] = utilities.long_int_name(entry[0])
return fsm_results
def get_desc_table(session):
"""
A function that creates a lookup dictionary that can be used to get the description of an interface.
:param session: The script object that represents this script being executed
:type session: sessions.Session
:return: A dictionary that allows getting the description of an interface by using the interface as the key.
:rtype: dict
"""
send_cmd = "show interface description"
if session.os == "IOS":
int_template = session.script.get_template(
"cisco_ios_show_interfaces_description.template")
else:
int_template = session.script.get_template(
"cisco_nxos_show_interface_description.template")
raw_int_desc = session.get_command_output(send_cmd)
desc_list = utilities.textfsm_parse_to_list(raw_int_desc, int_template)
desc_table = {}
# Change interface names to long versions for better matching with other outputs
for entry in desc_list:
intf = utilities.long_int_name(entry[0])
desc_table[intf] = entry[1]
return desc_table
def add_port_channels(desc_data, pc_data):
for entry in pc_data:
po_name = entry[0]
intf_list = entry[4]
neighbor_set = set()
# For each index in the intf_list
for intf in intf_list:
long_name = utils.long_int_name(intf)
if long_name in desc_data:
neighbor_set.add(desc_data[long_name][0])
if len(neighbor_set) > 0:
desc_data[po_name] = list(neighbor_set)
def add_port_channels(desc_data, pc_data):
"""
Adds port-channel information to our CDP data so that we can also put descriptions on port-channel interfaces that
have members found in the CDP table.
:param desc_data: Our CDP description data that needs to be updated
:type desc_data:
:param pc_data:
:type: pc_data:
"""
for entry in pc_data:
po_name = utilities.long_int_name(entry[0])
intf_list = entry[4]
neighbor_set = set()
# For each index in the intf_list
for intf in intf_list:
long_name = utilities.long_int_name(intf)
if long_name in desc_data:
neighbor_set.add(desc_data[long_name][0])
if len(neighbor_set) > 0:
desc_data[po_name] = list(neighbor_set)
def add_port_channels(desc_data, pc_data):
"""
Adds port-channel information to our CDP data so that we can also put descriptions on port-channel interfaces that
have members found in the CDP table.
:param desc_data: Our CDP description data that needs to be updated
:type desc_data:
:param pc_data:
:type: pc_data:
"""
for entry in pc_data:
po_name = utilities.long_int_name(entry[0])
intf_list = entry[4]
neighbor_set = set()
# For each index in the intf_list
for intf in intf_list:
long_name = utilities.long_int_name(intf)
if long_name in desc_data:
neighbor_set.add(desc_data[long_name][0])
if len(neighbor_set) > 0:
desc_data[po_name] = list(neighbor_set)
def get_arp_info(script):
"""
A function that reads in the "show ip arp" CSV file that should be taken from the default gateway device for the
switch being port mapped, so we can fill in the correct IP addresses for each device.
:param script: The script object that represents this script being executed
:type script: scripts.Script
:return: A dictionary that can be used to lookup both the MAC and IP associated with an interface, or the IP and
VLAN associated with a MAC address.
:rtype: dict
"""
arp_filename = script.file_open_dialog(
"Please select the ARP file to use when looking up MAC addresses.",
"Open", "CSV Files (*.csv)|*.csv||")
if arp_filename == "":
return {}
with open(arp_filename, 'r') as arp_file:
arp_csv = csv.reader(arp_file)
arp_list = [x for x in arp_csv]
arp_lookup = {}
# Process all ARP entries AFTER the header row.
for entry in arp_list[1:]:
# Get the IP address
ip = entry[0]
# Get the MAC address. If 'Incomplete', skip entry
mac = entry[2]
if mac.lower() == 'incomplete':
continue
# Get the VLAN, if SVI is specified.
intf = utilities.long_int_name(entry[3])
if intf.lower().startswith('vlan'):
vlan = intf[4:]
else:
vlan = None
if intf in arp_lookup.keys():
arp_lookup[intf].append((mac, ip))
else:
arp_lookup[intf] = [(mac, ip)]
if mac in arp_lookup.keys():
arp_lookup[mac].append((ip, vlan))
else:
arp_lookup[mac] = [(ip, vlan)]
return arp_lookup
def get_arp_info(script):
"""
A function that reads in the "show ip arp" CSV file that should be taken from the default gateway device for the
switch being port mapped, so we can fill in the correct IP addresses for each device.
:param script: The script object that represents this script being executed
:type script: scripts.Script
:return: A dictionary that can be used to lookup both the MAC and IP associated with an interface, or the IP and
VLAN associated with a MAC address.
:rtype: dict
"""
arp_filename = script.file_open_dialog("Please select the ARP file to use when looking up MAC addresses.", "Open",
"CSV Files (*.csv)|*.csv||")
if arp_filename == "":
return {}
with open(arp_filename, 'r') as arp_file:
arp_csv = csv.reader(arp_file)
arp_list = [x for x in arp_csv]
arp_lookup = {}
# Process all ARP entries AFTER the header row.
for entry in arp_list[1:]:
# Get the IP address
ip = entry[0]
# Get the MAC address. If 'Incomplete', skip entry
mac = entry[2]
if mac.lower() == 'incomplete':
continue
# Get the VLAN, if SVI is specified.
intf = utilities.long_int_name(entry[3])
if intf.lower().startswith('vlan'):
vlan = intf[4:]
else:
vlan = None
if intf in arp_lookup.keys():
arp_lookup[intf].append((mac, ip))
else:
arp_lookup[intf] = [(mac, ip)]
if mac in arp_lookup.keys():
arp_lookup[mac].append((ip, vlan))
else:
arp_lookup[mac] = [(ip, vlan)]
return arp_lookup
def get_int_status(session):
send_cmd = "show interface status"
if session.os == "IOS":
int_template = "textfsm-templates/cisco_ios_show_interfaces_status.template"
else:
int_template = "textfsm-templates/cisco_nxos_show_interface_status.template"
raw_int_status = session.get_command_output(send_cmd)
fsm_results = utils.textfsm_parse_to_list(raw_int_status, int_template)
for entry in fsm_results:
entry[0] = utils.long_int_name(entry[0])
return fsm_results
def get_desc_table(session):
send_cmd = "show interface description"
if session.os == "IOS":
int_template = "textfsm-templates/cisco_ios_show_interfaces_description.template"
else:
int_template = "textfsm-templates/cisco_nxos_show_interface_description.template"
raw_int_desc = session.get_command_output(send_cmd)
desc_list = utils.textfsm_parse_to_list(raw_int_desc, int_template)
desc_table = {}
# Change interface names to long versions for better matching with other outputs
for entry in desc_list:
intf = utils.long_int_name(entry[0])
desc_table[intf] = entry[1]
return desc_table
def get_int_status(session):
"""
A function that captures the "show interface status" command and returns the processed output from TextFSM
:param session: The script object that represents this script being executed
:type session: sessions.Session
:return: TextFSM output from processing the "show interface status" command
:rtype: list of list
"""
if session.os == "IOS":
template_file = session.script.get_template("cisco_ios_show_interfaces_status.template")
else:
template_file = session.script.get_template("cisco_nxos_show_interface_status.template")
raw_int_status = session.get_command_output("show interface status")
fsm_results = utilities.textfsm_parse_to_list(raw_int_status, template_file)
for entry in fsm_results:
entry[0] = utilities.long_int_name(entry[0])
return fsm_results
def get_arp_info(session):
arp_filename = session.file_open_dialog("Please select the ARP file to use when looking up MAC addresses.",
"Open", "CSV Files (*.csv)|*.csv||")
if arp_filename == "":
return {}
with open(arp_filename, 'r') as arp_file:
arp_csv = csv.reader(arp_file)
arp_list = [x for x in arp_csv]
arp_lookup = {}
# Process all ARP entries AFTER the header row.
for entry in arp_list[1:]:
# Get the IP address
ip = entry[0]
# Get the MAC address. If 'Incomplete', skip entry
mac = entry[2]
if mac.lower() == 'incomplete':
continue
# Get the VLAN, if SVI is specified.
intf = utils.long_int_name(entry[3])
if intf.lower().startswith('vlan'):
vlan = intf[4:]
else:
vlan = None
if intf in arp_lookup.keys():
arp_lookup[intf].append((mac, ip))
else:
arp_lookup[intf] = [(mac, ip)]
if mac in arp_lookup.keys():
arp_lookup[mac].append((ip, vlan))
else:
arp_lookup[mac] = [(ip, vlan)]
return arp_lookup
def get_mac_table(session):
"""
A function that captures the mac address table and returns an output dictionary that can be used to look up the MAC
address and VLAN associated with an interface.
:param session: The script object that represents this script being executed
:type session: session.Session
:return: A dictionary that allows lookups of MAC and VLAN information for interfaces
:rtype: dict
"""
send_cmd = "show mac address-table"
peer_link = None # Defining variable to hold peer link information if we have an NXOS output
# TextFSM template for parsing "show mac address-table" output
if session.os == "IOS":
template_file = session.script.get_template(
"cisco_ios_show_mac_addr_table.template")
else:
template_file = session.script.get_template(
"cisco_nxos_show_mac_addr_table.template")
raw_mac = session.get_command_output(send_cmd)
mac_table = utilities.textfsm_parse_to_list(raw_mac,
template_file,
add_header=True)
# Check if IOS mac_table is empty -- if so, it is probably because the switch has an older IOS
# that expects "show mac-address-table" instead of "show mac address-table".
if session.os == "IOS" and len(mac_table) == 1:
send_cmd = "show mac-address-table dynamic"
logger.debug("Retrying with command set to '{0}'".format(send_cmd))
raw_mac = session.get_command_output(send_cmd)
mac_table = utilities.textfsm_parse_to_list(raw_mac,
template_file,
add_header=True)
# Check for vPCs on NXOS to account for "vPC Peer-Link" entries in MAC table of N9Ks
elif session.os == "NXOS":
send_cmd = "show vpc"
vpc_template = session.script.get_template(
"cisco_nxos_show_vpc.template")
raw_show_vpc = session.get_command_output(send_cmd)
vpc_table = utilities.textfsm_parse_to_list(raw_show_vpc, vpc_template)
if len(vpc_table) > 0:
peer_link_record = vpc_table[0]
peer_link = utilities.long_int_name(peer_link_record[1])
else:
peer_link = None
# Convert TextFSM output to a dictionary for lookups
output = {}
for entry in mac_table:
vlan = entry[0]
mac = entry[1]
raw_intf = entry[2]
if "vpc" in raw_intf.lower():
intf = peer_link
else:
intf = utilities.long_int_name(raw_intf)
if intf in output:
output[intf].append((mac, vlan))
else:
output[intf] = [(mac, vlan)]
return output
def get_mac_table(session):
"""
A function that captures the mac address table and returns an output dictionary that can be used to look up the MAC
address and VLAN associated with an interface.
:param session: The script object that represents this script being executed
:type session: session.Session
:return: A dictionary that allows lookups of MAC and VLAN information for interfaces
:rtype: dict
"""
send_cmd = "show mac address-table"
peer_link = None # Defining variable to hold peer link information if we have an NXOS output
# TextFSM template for parsing "show mac address-table" output
if session.os == "IOS":
template_file = session.script.get_template("cisco_ios_show_mac_addr_table.template")
else:
template_file = session.script.get_template("cisco_nxos_show_mac_addr_table.template")
raw_mac = session.get_command_output(send_cmd)
mac_table = utilities.textfsm_parse_to_list(raw_mac, template_file, add_header=True)
# Check if IOS mac_table is empty -- if so, it is probably because the switch has an older IOS
# that expects "show mac-address-table" instead of "show mac address-table".
if session.os == "IOS" and len(mac_table) == 1:
send_cmd = "show mac-address-table dynamic"
logger.debug("Retrying with command set to '{0}'".format(send_cmd))
raw_mac = session.get_command_output(send_cmd)
mac_table = utilities.textfsm_parse_to_list(raw_mac, template_file, add_header=True)
# Check for vPCs on NXOS to account for "vPC Peer-Link" entries in MAC table of N9Ks
elif session.os == "NXOS":
send_cmd = "show vpc"
vpc_template = session.script.get_template("cisco_nxos_show_vpc.template")
raw_show_vpc = session.get_command_output(send_cmd)
vpc_table = utilities.textfsm_parse_to_list(raw_show_vpc, vpc_template)
if len(vpc_table) > 0:
peer_link_record = vpc_table[0]
peer_link = utilities.long_int_name(peer_link_record[1])
else:
peer_link = None
# Convert TextFSM output to a dictionary for lookups
output = {}
for entry in mac_table:
vlan = entry[0]
mac = entry[1]
raw_intf = entry[2]
if "vpc" in raw_intf.lower():
intf = peer_link
else:
intf = utilities.long_int_name(raw_intf)
if intf in output:
output[intf].append((mac, vlan))
else:
output[intf] = [(mac, vlan)]
return output
def script_main(session,
prompt_check_mode=True,
check_mode=True,
enable_pass=None):
"""
| SINGLE device script
| Author: Jamie Caesar
| Email: [email protected]
This script will grab the detailed CDP information from a Cisco IOS or NX-OS device and port-channel information and
generate the commands to update interface descriptions. The user will be prompted to run in "Check Mode" which will
write the configuration changes to a file (for verification or later manual application). If not, then the script
will push the configuration commands to the device and save the configuration.
**Script Settings** (found in settings/settings.ini):
* | **strip_domains** - A list of domain names that will be stripped away if found in
| the CDP remote device name.
* | **take_backups** - If True, the script will save a copy of the running config before
| and after making changes.
* | **rollback_file** - If True, the script will generate a rollback configuration script
| and save it to a file.
:param session: A subclass of the sessions.Session object that represents this particular script session (either
SecureCRTSession or DirectSession)
:type session: sessions.Session
:param prompt_check_mode: A boolean that specifies if we should prompt the user to find out if we should run in
"check mode". We would make this False if we were using this function in a multi-device script, so that the
process can run continually without prompting the user at each device.
:type prompt_check_mode: bool
:param check_mode: A boolean to specify whether we should run in "check mode" (Generate what the script would do
only -- does not push config), or not (Pushes the changes to the device). The default is True for safety
reasons, and this option will be overwritten unless prompt_checkmode is False.
:type check_mode: bool
:param enable_pass: The enable password for the device. Will be passed to start_cisco_session method if available.
:type enable_pass: str
"""
# Get script object that owns this session, so we can check settings, get textfsm templates, etc
script = session.script
# Start session with device, i.e. modify term parameters for better interaction (assuming already connected)
session.start_cisco_session(enable_pass=enable_pass)
# Validate device is running a supported OS
session.validate_os(["IOS", "NXOS"])
if prompt_check_mode:
# Ask if this should be a test run (generate configs only) or full run (push updates to devices)
check_mode_message = "Do you want to run this script in check mode? (Only generate configs)\n" \
"\n" \
"Yes = Connect to device and write change scripts to a file ONLY\n" \
"No = Connect to device and PUSH configuration changes"
message_box_design = ICON_QUESTION | BUTTON_YESNOCANCEL
logger.debug("Prompting the user to run in check mode.")
result = script.message_box(check_mode_message, "Run in Check Mode?",
message_box_design)
if result == IDYES:
check_mode = True
elif result == IDNO:
check_mode = False
else:
session.end_cisco_session()
return
# Get setting if we want to save before/after backups
take_backups = script.settings.getboolean("update_interface_desc",
"take_backups")
if not check_mode and take_backups:
# Save "show run" to file, plus read it back in for processing.
before_filename = session.create_output_filename("1-show-run-BEFORE")
session.write_output_to_file("show run", before_filename)
# Read in contents of file for processing
with open(before_filename, 'r') as show_run:
show_run_before = show_run.read()
else:
# Just read in "show run" contents for processing
show_run_before = session.get_command_output("show run")
# Use TextFSM to extract interface/description pairs from the show run output
desc_template = session.script.get_template(
"cisco_os_show_run_desc.template")
desc_list = utilities.textfsm_parse_to_list(show_run_before, desc_template)
# Turn the TextFSM list into a dictionary we can use to lookup by interface
ex_desc_lookup = {}
# Change interface names to long versions for better matching with other outputs
for entry in desc_list:
intf = utilities.long_int_name(entry[0])
ex_desc_lookup[intf] = entry[1]
# Get CDP Data
raw_cdp = session.get_command_output("show cdp neighbors detail")
# Process CDP Data with TextFSM
template_file = script.get_template("cisco_os_show_cdp_neigh_det.template")
fsm_results = utilities.textfsm_parse_to_list(raw_cdp,
template_file,
add_header=True)
# Get domain names to strip from device IDs from settings file
strip_list = script.settings.getlist("update_interface_desc",
"strip_domains")
# Since "System Name" is a newer NXOS feature -- try to extract it from the device ID when its empty.
for entry in fsm_results:
# entry[2] is system name, entry[1] is device ID. Localhost is a corner case for ESX hosts, where DNS name is
# in DeviceID, but localhost is in System Name
if entry[2] == "" or entry[2] == "localhost":
entry[2] = utilities.extract_system_name(entry[1],
strip_list=strip_list)
# Get Remote name, local and remote interface info to build descriptions.
description_data = extract_cdp_data(fsm_results)
# Capture port-channel output and add details to our description information
if session.os == "NXOS":
raw_pc_output = session.get_command_output("show port-channel summary")
pc_template = script.get_template(
"cisco_nxos_show_portchannel_summary.template")
pc_table = utilities.textfsm_parse_to_list(raw_pc_output,
pc_template,
add_header=False)
add_port_channels(description_data, pc_table)
else:
raw_pc_output = session.get_command_output("show etherchannel summary")
pc_template = script.get_template(
"cisco_ios_show_etherchannel_summary.template")
pc_table = utilities.textfsm_parse_to_list(raw_pc_output,
pc_template,
add_header=False)
add_port_channels(description_data, pc_table)
# Create a list to append configuration commands and rollback commands
config_commands = []
rollback = []
# Get an alphabetically sorted list of interfaces
intf_list = sorted(description_data.keys(), key=utilities.human_sort_key)
# Generate a list of configuration commands (and rollback if necessary)
for interface in intf_list:
# Get existing description
try:
existing_desc = ex_desc_lookup[interface]
except KeyError:
existing_desc = ""
# If a port-channel only use hostname in description
if "port-channel" in interface.lower():
neigh_list = description_data[interface]
# If there is only 1 neighbor, use that
if len(neigh_list) == 1:
new_desc = neigh_list[0]
# If there are 2 neighbors, assume a vPC and label appropriately
if len(neigh_list) == 2:
neigh_list = sorted(neigh_list, key=utilities.human_sort_key)
new_desc = "vPC: {0}, {1}".format(neigh_list[0], neigh_list[1])
# Only update description if we will be making a change
if new_desc != existing_desc:
config_commands.append("interface {0}".format(interface))
config_commands.append(" description {0}".format(new_desc))
rollback.append("interface {0}".format(interface))
if not existing_desc:
rollback.append(" no description")
else:
rollback.append(" description {0}".format(existing_desc))
# For other interfaces, use remote hostname and interface
else:
remote_host = description_data[interface][0]
remote_intf = utilities.short_int_name(
description_data[interface][1])
new_desc = "{0} {1}".format(remote_host, remote_intf)
# Only update description if we will be making a change
if new_desc != existing_desc:
config_commands.append("interface {0}".format(interface))
config_commands.append(" description {0}".format(new_desc))
rollback.append("interface {0}".format(interface))
if not existing_desc:
rollback.append(" no description")
else:
rollback.append(" description {0}".format(existing_desc))
# If in check-mode, generate configuration and write it to a file, otherwise push the config to the device.
if config_commands:
if check_mode:
output_filename = session.create_output_filename("intf-desc")
with open(output_filename, 'wb') as output_file:
for command in config_commands:
output_file.write("{0}\n".format(command))
rollback_filename = session.create_output_filename("intf-rollback")
else:
# Check settings to see if we prefer to save backups before/after applying changes
if take_backups:
# Push configuration, capturing the configure terminal log
output_filename = session.create_output_filename(
"2-CONFIG-RESULTS")
session.send_config_commands(config_commands, output_filename)
# Back up configuration after changes are applied
after_filename = session.create_output_filename(
"3-show-run-AFTER")
session.write_output_to_file("show run", after_filename)
# Set Rollback filename, in case this option is used
rollback_filename = session.create_output_filename(
"4-ROLLBACK")
else:
# Push configuration, capturing the configure terminal log
output_filename = session.create_output_filename(
"CONFIG-RESULTS")
session.send_config_commands(config_commands, output_filename)
# Set Rollback filename, in case this option is used
rollback_filename = session.create_output_filename("ROLLBACK")
# Save configuration
session.save()
# Check our settings to see if we should create a rollback.
create_rollback = script.settings.getboolean("update_interface_desc",
"rollback_file")
if create_rollback:
with open(rollback_filename, 'wb') as output_file:
for command in rollback:
output_file.write("{0}\n".format(command))
# Return terminal parameters back to the original state.
session.end_cisco_session()
def script_main(session, prompt_check_mode=True, check_mode=True, enable_pass=None):
"""
| SINGLE device script
| Author: Jamie Caesar
| Email: [email protected]
This script will grab the detailed CDP information from a Cisco IOS or NX-OS device and port-channel information and
generate the commands to update interface descriptions. The user will be prompted to run in "Check Mode" which will
write the configuration changes to a file (for verification or later manual application). If not, then the script
will push the configuration commands to the device and save the configuration.
Local Settings:
"strip_domains" - A list of domain names that will be stripped away if found in the CDP remote device name.
"take_backups" - If set to True, the script will save a copy of the running config before and after making changes.
"rollback_file" - If set to True, the script will generate a rollback configuration script and save it to a file.
:param session: A subclass of the sessions.Session object that represents this particular script session (either
SecureCRTSession or DirectSession)
:type session: sessions.Session
:param prompt_check_mode: A boolean that specifies if we should prompt the user to find out if we should run in
"check mode". We would make this False if we were using this function in a multi-device script, so that the
process can run continually without prompting the user at each device.
:type prompt_check_mode: bool
:param check_mode: A boolean to specify whether we should run in "check mode" (Generate what the script would do
only -- does not push config), or not (Pushes the changes to the device). The default is True for safety
reasons, and this option will be overwritten unless prompt_checkmode is False.
:type check_mode: bool
:param enable_pass: The enable password for the device. Will be passed to start_cisco_session method if available.
:type enable_pass: str
"""
# Get script object that owns this session, so we can check settings, get textfsm templates, etc
script = session.script
# Start session with device, i.e. modify term parameters for better interaction (assuming already connected)
session.start_cisco_session()
# Validate device is running a supported OS
session.validate_os(["IOS", "NXOS"])
if prompt_check_mode:
# Ask if this should be a test run (generate configs only) or full run (push updates to devices)
check_mode_message = "Do you want to run this script in check mode? (Only generate configs)\n" \
"\n" \
"Yes = Connect to device and write change scripts to a file ONLY\n" \
"No = Connect to device and PUSH configuration changes"
message_box_design = ICON_QUESTION | BUTTON_YESNOCANCEL
logger.debug("Prompting the user to run in check mode.")
result = script.message_box(check_mode_message, "Run in Check Mode?", message_box_design)
if result == IDYES:
check_mode = True
elif result == IDNO:
check_mode = False
else:
session.end_cisco_session()
return
# Get setting if we want to save before/after backups
take_backups = script.settings.getboolean("update_interface_desc", "take_backups")
if not check_mode and take_backups:
# Save "show run" to file, plus read it back in for processing.
before_filename = session.create_output_filename("1-show-run-BEFORE")
session.write_output_to_file("show run", before_filename)
# Read in contents of file for processing
with open(before_filename, 'r') as show_run:
show_run_before = show_run.read()
else:
# Just read in "show run" contents for processing
show_run_before = session.get_command_output("show run")
# Use TextFSM to extract interface/description pairs from the show run output
desc_template = session.script.get_template("cisco_os_show_run_desc.template")
desc_list = utilities.textfsm_parse_to_list(show_run_before, desc_template)
# Turn the TextFSM list into a dictionary we can use to lookup by interface
ex_desc_lookup = {}
# Change interface names to long versions for better matching with other outputs
for entry in desc_list:
intf = utilities.long_int_name(entry[0])
ex_desc_lookup[intf] = entry[1]
# Get CDP Data
raw_cdp = session.get_command_output("show cdp neighbors detail")
# Process CDP Data with TextFSM
template_file = script.get_template("cisco_os_show_cdp_neigh_det.template")
fsm_results = utilities.textfsm_parse_to_list(raw_cdp, template_file, add_header=True)
# Get domain names to strip from device IDs from settings file
strip_list = script.settings.getlist("update_interface_desc", "strip_domains")
# Since "System Name" is a newer NXOS feature -- try to extract it from the device ID when its empty.
for entry in fsm_results:
# entry[2] is system name, entry[1] is device ID. Localhost is a corner case for ESX hosts, where DNS name is
# in DeviceID, but localhost is in System Name
if entry[2] == "" or entry[2] == "localhost":
entry[2] = utilities.extract_system_name(entry[1], strip_list=strip_list)
# Get Remote name, local and remote interface info to build descriptions.
description_data = extract_cdp_data(fsm_results)
# Capture port-channel output and add details to our description information
if session.os == "NXOS":
raw_pc_output = session.get_command_output("show port-channel summary")
pc_template = script.get_template("cisco_nxos_show_portchannel_summary.template")
pc_table = utilities.textfsm_parse_to_list(raw_pc_output, pc_template, add_header=False)
add_port_channels(description_data, pc_table)
else:
raw_pc_output = session.get_command_output("show etherchannel summary")
pc_template = script.get_template("cisco_ios_show_etherchannel_summary.template")
pc_table = utilities.textfsm_parse_to_list(raw_pc_output, pc_template, add_header=False)
add_port_channels(description_data, pc_table)
# Create a list to append configuration commands and rollback commands
config_commands = []
rollback = []
# Get an alphabetically sorted list of interfaces
intf_list = sorted(description_data.keys(), key=utilities.human_sort_key)
# Generate a list of configuration commands (and rollback if necessary)
for interface in intf_list:
# Get existing description
try:
existing_desc = ex_desc_lookup[interface]
except KeyError:
existing_desc = ""
# If a port-channel only use hostname in description
if "port-channel" in interface.lower():
neigh_list = description_data[interface]
# If there is only 1 neighbor, use that
if len(neigh_list) == 1:
new_desc = neigh_list[0]
# If there are 2 neighbors, assume a vPC and label appropriately
if len(neigh_list) == 2:
neigh_list = sorted(neigh_list, key=utilities.human_sort_key)
new_desc = "vPC: {0}, {1}".format(neigh_list[0], neigh_list[1])
# Only update description if we will be making a change
if new_desc != existing_desc:
config_commands.append("interface {0}".format(interface))
config_commands.append(" description {0}".format(new_desc))
rollback.append("interface {0}".format(interface))
if not existing_desc:
rollback.append(" no description")
else:
rollback.append(" description {0}".format(existing_desc))
# For other interfaces, use remote hostname and interface
else:
remote_host = description_data[interface][0]
remote_intf = utilities.short_int_name(description_data[interface][1])
new_desc = "{0} {1}".format(remote_host, remote_intf)
# Only update description if we will be making a change
if new_desc != existing_desc:
config_commands.append("interface {0}".format(interface))
config_commands.append(" description {0}".format(new_desc))
rollback.append("interface {0}".format(interface))
if not existing_desc:
rollback.append(" no description")
else:
rollback.append(" description {0}".format(existing_desc))
# If in check-mode, generate configuration and write it to a file, otherwise push the config to the device.
if config_commands:
if check_mode:
output_filename = session.create_output_filename("intf-desc")
with open(output_filename, 'wb') as output_file:
for command in config_commands:
output_file.write("{0}\n".format(command))
rollback_filename = session.create_output_filename("intf-rollback")
else:
# Check settings to see if we prefer to save backups before/after applying changes
if take_backups:
# Push configuration, capturing the configure terminal log
output_filename = session.create_output_filename("2-CONFIG-RESULTS")
session.send_config_commands(config_commands, output_filename)
# Back up configuration after changes are applied
after_filename = session.create_output_filename("3-show-run-AFTER")
session.write_output_to_file("show run", after_filename)
# Set Rollback filename, in case this option is used
rollback_filename = session.create_output_filename("4-ROLLBACK")
else:
# Push configuration, capturing the configure terminal log
output_filename = session.create_output_filename("CONFIG-RESULTS")
session.send_config_commands(config_commands, output_filename)
# Set Rollback filename, in case this option is used
rollback_filename = session.create_output_filename("ROLLBACK")
# Save configuration
session.save()
# Check our settings to see if we should create a rollback.
create_rollback = script.settings.getboolean("update_interface_desc", "rollback_file")
if create_rollback:
with open(rollback_filename, 'wb') as output_file:
for command in rollback:
output_file.write("{0}\n".format(command))
# Return terminal parameters back to the original state.
session.end_cisco_session()
def per_device_work(session, enable_pass, vlan_set):
"""
This function contains the code that should be executed on each device that this script connects to. It is called
after establishing a connection to each device in the loop above.
You can either put your own code here, or if there is a single-device version of a script that performs the correct
task, it can be imported and called here, essentially making this script connect to all the devices in the chosen
CSV file and then running a single-device script on each of them.
"""
session.start_cisco_session()
script = session.script
hostname = session.hostname
exclude_ports = {}
# Find uplink port via spanning-tree root information, so we can exclude MAC addresses found on that port from
# our analysis.
if session.os == "IOS":
template_file = script.get_template(
"cisco_os_show_spanning-tree_root.template")
else:
template_file = script.get_template(
"cisco_os_show_spanning-tree_root.template")
raw_stp_root = session.get_command_output("show spanning-tree root")
root_results = utilities.textfsm_parse_to_list(raw_stp_root,
template_file,
add_header=False)
for entry in root_results:
vlan_string = entry[0]
vlan = int(vlan_string.split("N")[1])
uplink = utilities.long_int_name(entry[6]).strip()
if uplink:
exclude_ports[vlan] = uplink
# TextFSM template for parsing "show mac address-table" output
if session.os == "NXOS":
template_file = script.get_template(
"cisco_nxos_show_mac_addr_table.template")
else:
template_file = script.get_template(
"cisco_ios_show_mac_addr_table.template")
raw_mac = session.get_command_output("show mac address-table")
fsm_results = utilities.textfsm_parse_to_list(raw_mac,
template_file,
add_header=False)
# Check if IOS mac_table is empty -- if so, it is probably because the switch has an older IOS
# that expects "show mac-address-table" instead of "show mac address-table".
if session.os == "IOS" and len(fsm_results) == 1:
send_cmd = "show mac-address-table dynamic"
logger.debug("Retrying with command set to '{0}'".format(send_cmd))
raw_mac = session.get_command_output(send_cmd)
fsm_results = utilities.textfsm_parse_to_list(raw_mac,
template_file,
add_header=False)
# Find all MAC entries that are from the specific VLAN range and aren't learned from the uplink port for that VLAN
results = []
for entry in fsm_results:
try:
vlan = int(entry[0])
except ValueError:
continue
if vlan in vlan_set:
try:
uplink = exclude_ports[vlan]
except KeyError:
uplink = ""
mac_intf = utilities.long_int_name(entry[2]).lower()
uplink_intf = uplink.strip().lower()
if not mac_intf == uplink_intf:
results.append(entry)
# Return terminal parameters back to starting values
session.end_cisco_session()
return hostname, results
def per_device_work(session, enable_pass, vlan_set):
"""
This function contains the code that should be executed on each device that this script connects to. It is called
after establishing a connection to each device in the loop above.
You can either put your own code here, or if there is a single-device version of a script that performs the correct
task, it can be imported and called here, essentially making this script connect to all the devices in the chosen
CSV file and then running a single-device script on each of them.
"""
session.start_cisco_session()
script = session.script
hostname = session.hostname
exclude_ports = {}
# Find uplink port via spanning-tree root information, so we can exclude MAC addresses found on that port from
# our analysis.
if session.os == "IOS":
template_file = script.get_template("cisco_os_show_spanning-tree_root.template")
else:
template_file = script.get_template("cisco_os_show_spanning-tree_root.template")
raw_stp_root = session.get_command_output("show spanning-tree root")
root_results = utilities.textfsm_parse_to_list(raw_stp_root, template_file, add_header=False)
for entry in root_results:
vlan_string = entry[0]
vlan = int(vlan_string.split("N")[1])
uplink = utilities.long_int_name(entry[6]).strip()
if uplink:
exclude_ports[vlan] = uplink
# TextFSM template for parsing "show mac address-table" output
if session.os == "NXOS":
template_file = script.get_template("cisco_nxos_show_mac_addr_table.template")
else:
template_file = script.get_template("cisco_ios_show_mac_addr_table.template")
raw_mac = session.get_command_output("show mac address-table")
fsm_results = utilities.textfsm_parse_to_list(raw_mac, template_file, add_header=False)
# Check if IOS mac_table is empty -- if so, it is probably because the switch has an older IOS
# that expects "show mac-address-table" instead of "show mac address-table".
if session.os == "IOS" and len(fsm_results) == 1:
send_cmd = "show mac-address-table dynamic"
logger.debug("Retrying with command set to '{0}'".format(send_cmd))
raw_mac = session.get_command_output(send_cmd)
fsm_results = utilities.textfsm_parse_to_list(raw_mac, template_file, add_header=False)
# Find all MAC entries that are from the specific VLAN range and aren't learned from the uplink port for that VLAN
results = []
for entry in fsm_results:
try:
vlan = int(entry[0])
except ValueError:
continue
if vlan in vlan_set:
try:
uplink = exclude_ports[vlan]
except KeyError:
uplink = ""
mac_intf = utilities.long_int_name(entry[2]).lower()
uplink_intf = uplink.strip().lower()
if not mac_intf == uplink_intf:
results.append(entry)
# Return terminal parameters back to starting values
session.end_cisco_session()
return hostname, results
