Skip to content

Parse

ntc_templates.parse

ntc_templates.parse.

ParsingException

Bases: Exception

Error that is raised when TextFSM hits an Error state.

Source code in ntc_templates/parse.py 
15
16
class ParsingException(Exception):
    """Error that is raised when TextFSM hits an `Error` state."""

parse_output(platform=None, command=None, data=None, template_dir=None, try_fallback=False)

Return the structured data based on the output from a network device.

Parameters:

Name Type Description Default
platform

The platform the command was run on (e.g., cisco_ios).

 None
command

The command run on the platform (e.g., show int status).

 None
data

The output from running the command.

 None
template_dir

The directory to look for TextFSM templates. Defaults to setting of environment variable or default ntc-templates dir. The specified directory must have a properly configured index file.

 None
try_fallback

Whether to fallback to using the default template directory upon failure with template_dir.

 False

Returns:

Name Type Description
list

The TextFSM table entries as dictionaries.
Source code in ntc_templates/parse.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def parse_output(
    platform=None,
    command=None,
    data=None,
    template_dir=None,
    try_fallback=False,
):
    """Return the structured data based on the output from a network device.

    Args:
        platform: The platform the command was run on (e.g., `cisco_ios`).
        command: The command run on the platform (e.g., `show int status`).
        data: The output from running the command.
        template_dir: The directory to look for TextFSM templates.
            Defaults to setting of environment variable or default ntc-templates dir.
            The specified directory must have a properly configured index file.
        try_fallback: Whether to fallback to using the default template directory upon failure with `template_dir`.

    Returns:
        list: The TextFSM table entries as dictionaries.
    """
    if not HAS_CLITABLE:
        msg = (
            "The TextFSM library is not currently supported on Windows. If you are NOT using Windows "
            "you should be able to 'pip install textfsm' to fix this issue. If you are using Windows "
            "then you will need to install the patch referenced here:\n\n"
            "https://github.com/google/textfsm/pull/82\n\n"
        )
        raise ImportError(msg)

    template_dir = template_dir or _get_template_dir()
    cli_table = clitable.CliTable("index", template_dir)
    attrs = {"Command": command, "Platform": platform}
    try:
        cli_table.ParseCmd(data, attrs)
        structured_data = _clitable_to_dict(cli_table)
    except clitable.CliTableError as err:
        if try_fallback and template_dir != _get_template_dir():
            return parse_output(platform, command, data)
        raise ParsingException(f'Unable to parse command "{command}" on platform {platform} - {str(err)}') from err

    return structured_data