Welcome to CCUtils documentation!¶

CC Parser¶

ConfigParser¶

Quick Start¶

from ccutils.ccparser import ConfigParser
import pathlib

# Optinal - Create pathlib object pointing to your config file
path_to_file = pathlib.Path("/path/to/config_file.txt")

config = ConfigParser(config=path_to_file, device_type="ios")

# Print number of config lines
print(len(config.lines))

BaseConfigParser¶

Quick Start¶

from ccutils.ccparser import BaseConfigParser
import pathlib

# Optinal - Create pathlib object pointing to your config file
path_to_file = pathlib.Path("/path/to/config_file.txt")

config = BaseConfigParser(config=path_to_file)

# Print number of config lines
print(len(config.lines))

class BaseConfigParser(config=None, verbosity=4, **kwargs)¶

Bases: object

Base Configuration Parser object used for loading configuration files.

Base class for parsing Cisco-like configs

Parameters:	config (`pathlib.Path` or str or list) – Config file in a form of pathlib.Path, or string containing the entire config or list of lines of the config file verbosity (`int`, optional) – Determines the verbosity of logging output, defaults to 4: Info

lines¶

Contains list of all config lines stored as objects (see ccutils.ccparser.BaseConfigLine)

Type:	list

config_lines_str¶

Contains list of all config lines stored as strings

Type:	list

Examples

Possible config inputs:

# Using pathlib
config_file = pathlib.Path("/path/to/config_file.txt")
config = BaseConfigParser(config=config_file)

# Using string
config_string = '''
hostname RouterA
!
interface Ethernet0/0
 description Test Interface
 ip address 10.0.0.1 255.255.255.0
!
end
'''
config = BaseConfigParser(config=config_string)

# Using list
config_list = [
"hostname RouterA",
    "!",
    "interface Ethernet0/0",
    " description Test Interface",
    " ip address 10.0.0.1 255.255.255.0",
    "!",
    "end"
]
config = BaseConfigParser(config=config_list)

INTERFACE_LINE_CLASS¶: alias of ccutils.ccparser.BaseInterfaceLine.BaseInterfaceLine

PATTERN_TYPE¶: alias of re.Pattern

_check_path(filepath)¶

_compile_regex(regex, flags=<RegexFlag.MULTILINE: 8>)¶

Helper function for compiling re patterns from string.

Parameters:	regex (str) – Regex string flags – Flags for regex pattern, default is re.MULTILINE
Returns:

_create_cfg_line_objects()¶: Function for generating self.lines.

_device_tracking_attach_policy_regex = re.compile('^ device-tracking attach-policy (?P<policy>\\S+)')¶

_get_clean_config(first_line_regex='^version \\d+\\.\\d+', last_line_regex='^end')¶

_get_indent(line)¶

_vlan_configuration_regex = re.compile('^vlan configuration (?P<vlan_range>[\\d\\-,]+)', re.MULTILINE)¶

cdp¶

config_lines_obj¶

Kept for backwards compatibility, will be removed in future versions.

Returns:	BaseConfigParser.lines
Return type:	list

domain_name¶

find_objects(regex, flags=<RegexFlag.MULTILINE: 8>)¶

Function for filtering Config Lines Objects based on given regex.

Parameters:	regex (`re.Pattern` or str) – Regex based on which the search is done flags (`int`, optional) – Set custom flags for regex, defaults to `re.MULTILINE`

Examples

Example:

# Initialize the object
config = BaseConfigParser(config="/path/to/config_file.cfg")

# Define regex for matching config lines
interface_regex = r"^ interface"

# Apply the filter
interface_lines = config.find_objects(regex=interface_regex)

# Returns subset of ``self.lines`` which match specified regex

fix_indents()¶

Function for fixing the indentation level of config lines.

Returns:

get_section_by_parents(parents)¶

hostname¶

interface_lines¶

lines = None: This is a URI.

match_to_dict(line, patterns)¶

Parameters:	line – Instance of BaseConfigLine object patterns – List of compiled re patterns minimal_result – Bool, if True, omits keys with value None
Returns:	Dictionary containing named groups across all provided patterns
Return type:	dict

name_servers¶

parse()¶

Entry function which triggers the parsing process. Called automatically when instantiating the object.

Returns:	`None`

property_autoparse(candidate_pattern, patterns)¶

Function for searching multiple patterns across all occurrences of lines that matched candidate_pattern :param candidate_pattern: :param patterns:

Returns:

section_property_autoparse(parent, patterns, return_with_line=False)¶

static_routes¶

vlan_groups¶

vlans¶

vrfs¶

CiscoIosParser¶

Quick Start¶

from ccutils.ccparser import CiscoIosParser
import pathlib

# Optinal - Create pathlib object pointing to your config file
path_to_file = pathlib.Path("/path/to/config_file.txt")

config = CiscoIosParser(config=path_to_file)

# Print number of config lines
print(len(config.lines))

class CiscoIosParser(config=None, verbosity=4, **kwargs)¶

Bases: ccutils.ccparser.BaseConfigParser.BaseConfigParser

INTERFACE_LINE_CLASS¶: alias of ccutils.ccparser.CiscoIosInterfaceLine.CiscoIosInterfaceLine

aaa_authorization_exec_methods¶

aaa_login_methods¶

cdp¶

domain_name¶

hostname¶

isis¶: type: Returns

logging¶

logging_global_params¶

logging_servers¶

name_servers¶

ntp¶

ntp_access_groups¶

ntp_authentication_keys¶

ntp_global_params¶

ntp_peers¶

ntp_servers¶

Property containing DNS servers related data

Returns:

List of name server IP addresses

Example:

[
    "10.0.0.1",
    "10.0.0.2"
]

Returns None if absent

Return type: list

ntp_trusted_keys¶

ospf¶: type: Returns

radius_groups¶

List of RADIUS Server Groups Entries

Example:

[
    {
        "name": "RADIUS-GROUP",
        "source_interface": "Vlan100",
        "servers": [
            {
                "name": "RADIUS-Primary"
            }
        ]
    }
]

Returns None if absent

Type:	Returns
Type:	list

radius_servers¶

List of RADIUS Servers

Example:

[
    {
      "name": "RADIUS-Primary",
      "address_version": "ipv4",
      "server": "10.0.0.1",
      "encryption_type": null,
      "hash": "Test123",
      "timeout": "2",
      "retransmit": "1",
      "auth_port": "1812",
      "acct_port": "1813"
    },
    {
      "name": "RADIUS-Secondary",
      "address_version": "ipv4",
      "server": "10.0.1.1",
      "encryption_type": null,
      "hash": "Test123",
      "timeout": "2",
      "retransmit": "1",
      "auth_port": "1812",
      "acct_port": "1813"
    }
]

Returns None if absent

Type:	Returns
Type:	list

section_unprocessed_lines(parent, check_patterns)¶

tacacs_groups¶

List of TACACS Server entries

Example:

[
    {
        "name": "ISE-TACACS",
        "source_interface": "Loopback0",
        "servers": [
            {
                "name": "ISE-1"
            },
            {
                "name": "ISE-2"
            }
        ]
    }
]

Returns None if absent

Type:	Returns
Type:	list

tacacs_servers¶

List of TACACS Servers

Example:

[
    {
      "name": "ISE-1",
      "address_version": "ipv4",
      "server": "10.0.0.1",
      "encryption_type": "7",
      "hash": "36A03A8A4C00E81F03D62D8B04BBBF4D",
      "timeout": "10",
      "single_connection": true
    },
    {
      "name": "ISE-2",
      "address_version": "ipv4",
      "server": "10.0.1.1",
      "encryption_type": "7",
      "hash": "36A03A8A4C00E81F03D62D8B04BBBF4D",
      "timeout": "10",
      "single_connection": true
    }
]

Returns None if absent

Type:	Returns
Type:	list

vlan_groups¶

vlans¶

vrfs¶

BaseConfigLine¶

class BaseConfigLine(number, text, config, verbosity=3, name='BaseConfigLine')¶

Bases: object

This class is not meant to be instantiated directly, but only from BaseConfigParser instance.

Parameters:	number (int) – Index of line in config text (str) – Text of the config line config (`BaseConfigParser`) – Reference to the parent BaseConfigParser object verbosity (`int`, optional) – Logging output level, defaults to 3: Warning

PATTERN_TYPE¶: alias of re.Pattern

comment_regex = re.compile('^(\\s+)?!.*', re.MULTILINE)¶

get_children()¶

Return all children lines (all following lines with larger indent)

Returns:	List of child config lines (objects)
Return type:	list

get_parent¶

get_parents¶

get_type¶

Return types of config line. Used mostly for filtering purposes.

Currently available values are:

parent
child
interface
comment

Returns:	List of types
Return type:	list

is_child¶

Check whether this line is a child

Returns:	True if line is a child line, False otherwise
Return type:	bool

is_interface¶

is_parent¶

Check whether this line is a parent

Returns:	True if line is a parent line, False otherwise
Return type:	bool

re_match(regex, group=None)¶

re_search(regex, group=None)¶

Search config line for given regex

Parameters:	regex (`re.Pattern` or `str`) – Regex to search for group (`str` or `int`, optional) – Return only specific (named or numbered) group of given regex. If set to “ALL”, return value will be a dictionary with all named groups of the regex.

Examples

Example:

# Given the following line stored in `line` variable
# " ip address 10.0.0.1 255.255.255"
pattern = r"^ ip address (?P<ip>\S+) (?P<mask>\S+)"

# Basic search
result = line.re_search(regex=pattern)
print(result)
# Returns: " ip address 10.0.0.1 255.255.255"

# Search for specific group
result = line.re_search(regex=pattern, group="ip")
print(result)
# Returns: "10.0.0.1"

# Get all named groups
result = line.re_search(regex=pattern, group="ALL")
print(result)
# Returns: {"ip": "10.0.0.1", "mask": "255.255.255"}

Returns:	String that matched given regex, or, if group was provided, returns only specific group. Returns `None` if regex did not match.
Return type:	str

re_search_children(regex, group=None)¶

Search all children for given regex.

Parameters:

regex (re.Pattern or str) – Regex to search for
group (str or int, optional) – Return only specific (named or numbered) group of given regex. If set to “ALL”, return value will be a dictionary with all named groups of the regex.

Returns:

List of all child object which match given regex, or, if group was provided, returns list containing matched grop across all children.

Example:

# Given following config section, interface line stored in `line` variable
config = '''
interface Ethernet0/0
 description Test Interface
 ip address 10.0.0.1 255.255.255.0
 ip address 10.0.1.1 255.255.255.0 secondary
!
'''
pattern = r"^ ip address (?P<ip>\S+) (?P<mask>\S+)"

result = line.re_search_children(regex=pattern)
print(result)
# Returns: [
#   [BaseConfigLine #2 (child): ip address 10.0.0.1 255.255.255.0],
#   [BaseConfigLine #3 (child): ip address 10.0.1.1 255.255.255.0 secondary]
# ]

result = line.re_search_children(regex=pattern, group="ip")
print(result)
# Returns: [
#   "10.0.0.1",
#   "10.0.1.1"
# ]

result = line.re_search_children(regex=pattern, group="ALL")
print(result)
# Returns: [
#   {"ip": "10.0.0.1", "mask": "255.255.255.0"},
#   {"ip": "10.0.1.1", "mask": "255.255.255.0"}
# ]

Return type:

list

return_obj()¶

BaseInterfaceLine¶

class BaseInterfaceLine(number, text, config, verbosity=3, name='BaseInterfaceLine')¶

Bases: ccutils.ccparser.BaseConfigLine.BaseConfigLine

Object for retrieving various config options on the interface level.

This class is not meant to be instantiated directly, but only from BaseConfigParser instance.

Parameters:	number (int) – Index of line in config text (str) – Text of the config line config (`BaseConfigParser`) – Reference to the parent BaseConfigParser object verbosity (`int`, optional) – Logging output level, defaults to 3: Warning

access_vlan¶

Return a number of access VLAN or None if the command switchport access vlan x is not present.

Caution: This does not mean the interface is necessarily an access port.

Returns:	Number of access VLAN or None Returns `None` if absent
Return type:	int

bandwidth¶

Return bandwidth of the interface set by command bandwidth X.

Returns:	Bandwidth Returns `None` if absent
Return type:	int

cdp¶

Checks whether CDP is enabled on the interface. This property takes global CDP configuration into account, meaning if there is no specific configuration on the interface level, it will return state based on the entire config (eg. no cdp run in the global config will make this property be False)

Returns:	`True` if CDP is enabled, `False` otherwise
Return type:	bool

channel_group¶

Return a dictionary describing Port-channel/Etherchannel related configuration

Returns:

Channel-group parameters

Example:

{"channel_group_number": "1", "channel_group_mode": "active"}

Otherwise returns None

Return type: dict

delay¶

Return delay of the interface set by command delay X.

Returns:	Delay Returns `None` if absent
Return type:	int

description¶

Returns description of the interface.

Returns:	Interface description Returns `None` if absent
Return type:	str

device_tracking_policy¶

duplex¶

Return duplex of the interface set by command duplex X.

Returns:	Duplex Returns `None` if absent
Return type:	str

encapsulation¶

Return encapsulation type and tag for subinterfaces

Returns:

Encapsualtion parameters

Example:

{"type": "dot1q", "tag": 10, "native": False}

Returns None if absent

Return type: dict

flags¶

List of flags/tags describing basic properties of the interface. Used for filtering purposes. Currently supported flags are:

l2 - Interface is switched port

l3 - Interface is routed port

physical - Interface is a physical interface (Only *Ethernet interfaces)

svi - Interface is SVI (VLAN Interface)

port-channel - Interface is port-channel

pc-member - Interface is a member of Port-channel

tunnel - Interface is a Tunnel

Returns:	List of flags
Return type:	list

get_unprocessed¶

Return a list of config lines under the interface, which did not match any of the existing regex patterns. Mostly for development/testing purposes.

By default returns list of objects.

Parameters:	return_type (str) – Set this to “text” to receive list of strings
Returns:	List of unprocessed config lines
Return type:	list

helper_address¶

Return a list of IP addresses specified with ip helper-address command (DHCP relay).

Returns:	List of helper addresses Returns `None` if absent
Return type:	list

interface_description¶

interface_name¶

ip_addresses¶

Return list of IP addresses present on the interface

Returns:

List of dictionaries representing individual IP addresses

Example:

[
    {
        "ip_address": "10.0.0.1",
        "mask": "255.255.255.0",
        "secondary": False
    },
    {
        "ip_address": "10.0.1.1",
        "mask": "255.255.255.0",
        "secondary": True
    }
]

If there is no IP address present on the interface, an empty list is returned.

Return type: list

ip_mtu¶

Return IP MTU of the interface set by command ip mtu X.

Returns:	IP MTU Returns `None` if absent
Return type:	int

ip_unnumbered_interface¶

keepalive¶

load_interval¶

Return Load Interval of the interface set by command load-interval X.

Returns:	Load Interval Returns `None` if absent
Return type:	int

logging_events¶

mtu¶

Return MTU of the interface set by command mtu X.

Returns:	MTU Returns `None` if absent
Return type:	int

name¶

Return name of the interface, such as GigabitEthernet0/1.

Returns:	Name of the interface
Return type:	str

native_vlan¶

Return Native VLAN of L2 Interface

Returns:	Native VLAN Number (None if absent) Returns `None` if absent
Return type:	int

ospf¶

Return OSPF interface parameters

Returns:

OSPF parameters

Example:

{"process_id": 1, "area": 0, "network_type": "point-to-point", "priority": 200}

Returns None if absent

Return type: dict

ospf_priority¶

Returns OSPF priority of the interface.

Returns:	OSPF Priority or None
Return type:	int

port_mode¶

Checks whether the interface is running in switched (l2) or routed (l3) mode.

Returns:	l2 or l3
Return type:	str

service_instances¶

service_policy¶

Return names of applied service policies

Returns:

Dictionary containing names of both input and output policies.

Example:

{"input": "TEST_INPUT_POLICY", "output": "TEST_OUTPUT_POLICY"}

If there are no policies specified, returns:

{"input": None, "output": None}

Return type: dict

shutdown¶

speed¶

Return speed of the interface set by command speed X

Returns:	Speed Returns `None` if absent
Return type:	int

standby¶

HSRP related configuration. Groups, IP addresses, hello/hold timers, priority and authentication.

Returns:	Dictionary with top level keys being HSRP groups.

storm_control¶

switchport_mode¶

Return L2 Mode of interface, either access or trunk

Returns:	“access” or “trunk” Returns `None` if absent
Return type:	str

switchport_nonegotiate¶

Check whether the port is running DTP or not. Checks for presence of switchport nonegotiate command

Returns:	`True` if command is present, `False` otherwise
Return type:	bool

tcp_mss¶

Return TCP Max Segment Size of the interface set by command ip tcp adjust-mss X.

Returns:	TCP MSS Returns `None` if absent
Return type:	int

trunk_allowed_vlans¶

Return a expanded list of VLANs allowed with switchport trunk allowed vlan x,y,z.

Caution: This does not mean the interface is necessarily a trunk port.

Returns:

Expanded list of allowed VLANs

Returns None if absent

Returns “none” if switchport trunk allowed vlan none

Return type: list

trunk_encapsulation¶

Return encapsulation on trunk interfaces

Returns:	“dot1q” or “isl” Returns `None` if absent
Return type:	str

tunnel_properties¶

Return properties related to Tunnel interfaces

Returns:

Dictionary with tunnel properties.

Example:

{
    "source": "Loopback0",
    "destination": "10.0.0.1",
    "vrf": None,
    "mode": "ipsec ipv4",
    "ipsec_profile": "TEST_IPSEC_PROFILE"
}

Returns None if absent

Return type: dict

voice_vlan¶

Return a number of voice VLAN

Returns:	Number of voice VLAN or None Returns `None` if absent
Return type:	int

vrf¶

Return VRF of the interface

Returns:	Name of the VRF Returns `None` if absent
Return type:	str

CiscoIosInterfaceLine¶

class CiscoIosInterfaceLine(number, text, config, verbosity=3)¶

Bases: ccutils.ccparser.BaseInterfaceLine.BaseInterfaceLine

access_vlan¶

Return a number of access VLAN or None if the command switchport access vlan x is not present.

Caution: This does not mean the interface is necessarily an access port.

Returns:	Number of access VLAN or None Returns `None` if absent
Return type:	int

bandwidth¶

Return bandwidth of the interface set by command bandwidth X.

Returns:	Bandwidth Returns `None` if absent
Return type:	int

bfd¶

cdp¶

Checks whether CDP is enabled on the interface. This property takes global CDP configuration into account, meaning if there is no specific configuration on the interface level, it will return state based on the entire config (eg. no cdp run in the global config will make this property be False)

Returns:	`True` if CDP is enabled, `False` otherwise
Return type:	bool

channel_group¶

Return a dictionary describing Port-channel/Etherchannel related configuration

Returns:

Channel-group parameters

Example:

{"channel_group_number": "1", "channel_group_mode": "active"}

Otherwise returns None

Return type: dict

delay¶

Return delay of the interface set by command delay X.

Returns:	Delay Returns `None` if absent
Return type:	int

description¶

Returns description of the interface.

Returns:	Interface description Returns `None` if absent
Return type:	str

device_tracking_policy¶

duplex¶

Return duplex of the interface set by command duplex X.

Returns:	Duplex Returns `None` if absent
Return type:	str

encapsulation¶

Return encapsulation type and tag for subinterfaces

Returns:

Encapsualtion parameters

Example:

{"type": "dot1q", "tag": 10, "native": False}

Returns None if absent

Return type: dict

flags¶

List of flags/tags describing basic properties of the interface. Used for filtering purposes. Currently supported flags are:

l2 - Interface is switched port

l3 - Interface is routed port

physical - Interface is a physical interface (Only *Ethernet interfaces)

svi - Interface is SVI (VLAN Interface)

port-channel - Interface is port-channel

pc-member - Interface is a member of Port-channel

tunnel - Interface is a Tunnel

Returns:	List of flags
Return type:	list

get_unprocessed¶

Return a list of config lines under the interface, which did not match any of the existing regex patterns. Mostly for development/testing purposes.

By default returns list of objects.

Parameters:	return_type (str) – Set this to “text” to receive list of strings
Returns:	List of unprocessed config lines
Return type:	list

helper_address¶

Return a list of IP addresses specified with ip helper-address command (DHCP relay).

Returns:	List of helper addresses Returns `None` if absent
Return type:	list

interface_description¶

interface_name¶

ip_addresses¶

Return list of IP addresses present on the interface

Returns:

List of dictionaries representing individual IP addresses

Example:

[
    {
        "ip_address": "10.0.0.1",
        "mask": "255.255.255.0",
        "secondary": False
    },
    {
        "ip_address": "10.0.1.1",
        "mask": "255.255.255.0",
        "secondary": True
    }
]

If there is no IP address present on the interface, an empty list is returned.

Return type: list

ip_mtu¶

Return IP MTU of the interface set by command ip mtu X.

Returns:	IP MTU Returns `None` if absent
Return type:	int

ip_unnumbered_interface¶

isis¶

Return IS-IS interface parameters

Returns:

IS-IS parameters

Example:

{}

Returns None if absent

Return type: dict

keepalive¶

load_interval¶

Return Load Interval of the interface set by command load-interval X.

Returns:	Load Interval Returns `None` if absent
Return type:	int

logging_events¶

mtu¶

Return MTU of the interface set by command mtu X.

Returns:	MTU Returns `None` if absent
Return type:	int

name¶

Return name of the interface, such as GigabitEthernet0/1.

Returns:	Name of the interface
Return type:	str

native_vlan¶

Return Native VLAN of L2 Interface

Returns:	Native VLAN Number (None if absent) Returns `None` if absent
Return type:	int

negotiation¶

ospf¶

Return OSPF interface parameters

Returns:

OSPF parameters

Example:

{"process_id": 1, "area": 0, "network_type": "point-to-point", "priority": 200}

Returns None if absent

Return type: dict

ospf_priority¶

Returns OSPF priority of the interface.

Returns:	OSPF Priority or None
Return type:	int

port_mode¶

Checks whether the interface is running in switched (l2) or routed (l3) mode.

Returns:	l2 or l3
Return type:	str

service_instances¶

service_policy¶

Return names of applied service policies

Returns:

Dictionary containing names of both input and output policies.

Example:

{"input": "TEST_INPUT_POLICY", "output": "TEST_OUTPUT_POLICY"}

If there are no policies specified, returns:

{"input": None, "output": None}

Return type: dict

shutdown¶

speed¶

Return speed of the interface set by command speed X

Returns:	Speed Returns `None` if absent
Return type:	int

standby¶

HSRP related configuration. Groups, IP addresses, hello/hold timers, priority and authentication.

Returns:	Dictionary with top level keys being HSRP groups.

storm_control¶

switchport_mode¶

Return L2 Mode of interface, either access or trunk

Returns:	“access” or “trunk” Returns `None` if absent
Return type:	str

switchport_nonegotiate¶

Check whether the port is running DTP or not. Checks for presence of switchport nonegotiate command

Returns:	`True` if command is present, `False` otherwise
Return type:	bool

tcp_mss¶

Return TCP Max Segment Size of the interface set by command ip tcp adjust-mss X.

Returns:	TCP MSS Returns `None` if absent
Return type:	int

trunk_allowed_vlans¶

Return a expanded list of VLANs allowed with switchport trunk allowed vlan x,y,z.

Caution: This does not mean the interface is necessarily a trunk port.

Returns:

Expanded list of allowed VLANs

Returns None if absent

Returns “none” if switchport trunk allowed vlan none

Return type: list

trunk_encapsulation¶

Return encapsulation on trunk interfaces

Returns:	“dot1q” or “isl” Returns `None` if absent
Return type:	str

tunnel_properties¶

Return properties related to Tunnel interfaces

Returns:

Dictionary with tunnel properties.

Example:

{
    "source": "Loopback0",
    "destination": "10.0.0.1",
    "vrf": None,
    "mode": "ipsec ipv4",
    "ipsec_profile": "TEST_IPSEC_PROFILE"
}

Returns None if absent

Return type: dict

voice_vlan¶

Return a number of voice VLAN

Returns:	Number of voice VLAN or None Returns `None` if absent
Return type:	int

vrf¶

Return VRF of the interface

Returns:	Name of the VRF Returns `None` if absent
Return type:	str

ConfigToJson¶

class ConfigToJson(config, omit_empty=False, verbosity=3)¶

Bases: object

Parameters:	config – Reference to the parent BaseConfigParser object verbosity (int) – Logging output level

get_interface_list(flags_filter=None)¶

get_ordered_interfaces()¶

Return interfaces as OrderedDict

Returns:	Interface section as OrderedDict
Return type:	(`OrderedDict`)

static jprint(data)¶

parse_common()¶

parse_interfaces()¶

Returns:

to_json(indent=2)¶

Return JSON formatted structure describing configuration

Parameters:	indent (int) – Set JSON indent, defaults to 2
Returns:	JSON string
Return type:	str

to_yaml()¶

Return YAML formatted structure describing configuration

Returns:	YAML string
Return type:	str

ConfigMigration¶

class ConfigMigration(hostname, excel_path, excel_sheet, old_config_folder, verbosity=1)¶

Bases: object

check_standby()¶

get_context_for_new_interface(new_interface)¶

get_interface_mapping()¶

get_new_interface(old_host, old_interface)¶

get_old_configs()¶

get_old_ctj()¶

get_old_hostnames(column='Old Host')¶

merge_vlans()¶

merge_vrfs()¶

user_selection(prompt, options)¶

CC Templater¶

class CCTemplater(template_folder=None)¶

Bases: object

render(template_name, context)¶

Templates¶

Placeholder¶

Utils¶

Common Utils¶

class UnsortableList¶

sort(*args, **kwargs)¶: Stable sort IN PLACE.

class UnsortableOrderedDict¶

items() → a set-like object providing a view on D's items¶

check_path(path, create=False)¶

Parameters:	path – create –
Returns:

convert_interface_name(interface: str, out: str = 'long')¶

This function converts interface names between long and short variants. For example Fa0/1 -> FastEthernet0/1 or the other way around.

Parameters:	interface – out –
Return type:	str
Returns:	Interface string

get_logger(name, verbosity=4)¶

match_to_json(match, groups)¶

This function converts re match object to dict

Parameters:	match – re.match object groups – list
Return type:	dict
Returns:	Dictionary with matched groups

split_interface_name(interface: str)¶

This function takes in interface string such as “GigabitEthernet0/10” and returns a list containing name and number, such as [“GigabitEthernet”, “0/10”]

Parameters:	interface (str) – Interface to perform split on
Returns:	List containing name and number of interface, such as `["GigabitEthernet", "0/10"]`
Return type:	list

CiscoRange¶

class CiscoRange(text, verbosity=3)¶

Bases: collections.abc.MutableSequence

CHANNEL_REGEX = re.compile('\\:(?P<number>\\d+)')¶

PREFIX_REGEX = re.compile('^[A-z\\-]+(?=\\d)', re.MULTILINE)¶

PREFIX_SLOT_REGEX = re.compile('(?P<prefix_slot>^[A-z\\-]+(?=\\d)(?:\\d+/)*)(?P<number>\\d+)', re.MULTILINE)¶

RANGE_REGEX = re.compile('\\d+\\s*-\\s*\\d+')¶

SUBINT_REGEX = re.compile('\\.(?P<number>\\d+)$')¶

SUFFIX_REGEX = re.compile('\\d.*?$')¶

add(data)¶

check_prefix(data)¶

compress_list(data)¶

has_prefix(data)¶

insert(index, value)¶: S.insert(index, value) – insert value before index

static int_or_none(item)¶

remove(data)¶: S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

sort_list(data)¶

split_item(item)¶

split_text(text)¶

split_to_list(data)¶

to_string()¶

Welcome to CCUtils documentation!¶

CC Parser¶

ConfigParser¶

Quick Start¶

BaseConfigParser¶

Quick Start¶

CiscoIosParser¶

Quick Start¶

BaseConfigLine¶

BaseInterfaceLine¶

CiscoIosInterfaceLine¶

ConfigToJson¶

ConfigMigration¶

CC Templater¶

CC Templater¶

Templates¶

Placeholder¶

Utils¶

Common Utils¶

CiscoRange¶

Indices and tables¶