Template Text Parser Templates

This repository contains a collection of TTP templates.

If you solved a problem using TTP and feel that your work can be useful to other people, feel free to raise an issue or submit pull request to include your template(s) in this repository. Refer to Contribute Guide for details.

Documentation: https://dmulyalin.github.io/ttp_templates/

Repository: https://github.com/dmulyalin/ttp_templates

TTP: https://ttp.readthedocs.io/

Installation

From PyPi:

pip install ttp-templates

or latest from GitHub master branch (need Git installed on the system):

pip install git+https://github.com/dmulyalin/ttp_templates.git

Sample usage

This example demonstrates how to parse Test Platform output for show run | sec interface command using platform/test_platform_show_run_pipe_sec_interface.txt template.

Code

from ttp_templates import parse_output
import pprint

data = """
interface GigabitEthernet1/3.251
 description Customer #32148
 encapsulation dot1q 251
 ip address 172.16.33.10 255.255.255.128
 shutdown
!
interface GigabitEthernet1/3.251
 description Customer #32148
 encapsulation dot1q 251
 ip address 172.16.33.10 255.255.255.128
 shutdown
"""

result = parse_output(
    data=data,
    platform="Test Platform",
    command="show run | sec interface"
)

pprint.pprint(result)

# prints:
# [[[{'description': 'Customer #32148',
#     'disabled': True,
#     'dot1q': '251',
#     'interface': 'GigabitEthernet1/3.251',
#     'ip': '172.16.33.10',
#     'mask': '255.255.255.128'},
#    {'description': 'Customer #32148',
#     'disabled': True,
#     'dot1q': '251',
#     'interface': 'GigabitEthernet1/3.251',
#     'ip': '172.16.33.10',
#     'mask': '255.255.255.128'}]]]

Sample code to parse Cisco IOS output in a structure compatible with ietf-interfaces YANG module.

Code

from ttp_templates import get_template
from ttp import ttp
import pprint

data1 = """
interface GigabitEthernet1/3.251
 description Customer #32148
 encapsulation dot1q 251
 ip address 172.16.33.10 255.255.255.128
 shutdown
!
interface GigabitEthernet1/4
 description vCPEs access control
 ip address 172.16.33.10 255.255.255.128
!
"""
data2 = """
interface GigabitEthernet1/5
 description Works data
 ip mtu 9000
!
interface GigabitEthernet1/7
 description Works data v6
 ipv6 address 2001::1/64
 ipv6 address 2001:1::1/64
"""

template = get_template(yang="ietf-interfaces", platform="cisco_ios")
parser = ttp(template=template)

parser.add_input(data1)
parser.add_input(data2)

parser.parse()
res = parser.result()
pprint.pprint(res)

# prints:
# [{'comment': '',
#   'exception': {},
#   'result': [{'ietf-interfaces:interfaces': {'interface': [{'admin-status': 'down',
#                                                             'description': 'Customer '
#                                                                            '#32148',
#                                                             'enabled': False,
#                                                             'ietf-ip:ipv4': {'address': [{'ip': '172.16.33.10',
#                                                                                           'netmask': '255.255.255.128',
#                                                                                           'origin': 'static'}]},
#                                                             'if-index': 1,
#                                                             'link-up-down-trap-enable': 'enabled',
#                                                             'name': 'GigabitEthernet1/3.251',
#                                                             'oper-status': 'unknown',
#                                                             'statistics': {'discontinuity-time': '1970-01-01T00:00:00+00:00'},
#                                                             'type': 'iana-if-type:ethernetCsmacd'},
#                                                            {'admin-status': 'up',
#                                                             'description': 'vCPEs '
#                                                                            'access '
#                                                                            'control',
#                                                             'enabled': True,
#                                                             'ietf-ip:ipv4': {'address': [{'ip': '172.16.33.10',
#                                                                                           'netmask': '255.255.255.128',
#                                                                                           'origin': 'static'}]},
#                                                             'if-index': 1,
#                                                             'link-up-down-trap-enable': 'enabled',
#                                                             'name': 'GigabitEthernet1/4',
#                                                             'oper-status': 'unknown',
#                                                             'statistics': {'discontinuity-time': '1970-01-01T00:00:00+00:00'},
#                                                             'type': 'iana-if-type:ethernetCsmacd'}]}},
#              {'ietf-interfaces:interfaces': {'interface': [{'admin-status': 'up',
#                                                             'description': 'Works '
#                                                                            'data',
#                                                             'enabled': True,
#                                                             'ietf-ip:ipv4': {'mtu': 9000},
#                                                             'if-index': 1,
#                                                             'link-up-down-trap-enable': 'enabled',
#                                                             'name': 'GigabitEthernet1/5',
#                                                             'oper-status': 'unknown',
#                                                             'statistics': {'discontinuity-time': '1970-01-01T00:00:00+00:00'},
#                                                             'type': 'iana-if-type:ethernetCsmacd'},
#                                                            {'admin-status': 'up',
#                                                             'description': 'Works '
#                                                                            'data '
#                                                                            'v6',
#                                                             'enabled': True,
#                                                             'ietf-ip:ipv6': {'address': [{'ip': '2001::1',
#                                                                                           'origin': 'static',
#                                                                                           'prefix-length': 64},
#                                                                                          {'ip': '2001:1::1',
#                                                                                           'origin': 'static',
#                                                                                           'prefix-length': 64}]},
#                                                             'if-index': 1,
#                                                             'link-up-down-trap-enable': 'enabled',
#                                                             'name': 'GigabitEthernet1/7',
#                                                             'oper-status': 'unknown',
#                                                             'statistics': {'discontinuity-time': '1970-01-01T00:00:00+00:00'},
#                                                             'type': 'iana-if-type:ethernetCsmacd'}]}}],
#   'valid': {0: True, 1: True}}]

List getter platforms or check whether a getter supports a platform before trying to parse output:

from ttp_templates import list_getter_platforms, is_getter_supported

list_getter_platforms(getter="interfaces")
# ["a10", "arista_eos", "cisco_ios", ...]

is_getter_supported(platform="linux", getter="interfaces")
# True

is_getter_supported(platform="linux", getter="bgp_asn")
# False

How templates collections structured

This repository contains three collections of templates corresponding to folder names:

platform collection - mimics ntc-templates API and follows same naming rule
yang collection - contains templates capable of producing YANG compatible structures out of text data
misc collection - miscellaneous templates for various use cases organized in folders

Platform collection templates files naming rule

{{ vendor_os }}_{{ command_with_underscores }}.txt - lower case only.

Naming rules details:

All space symbols ' ' replaced with underscores.
Pipe symbol | replaced with pipe in template name. For example, template to parse Cisco IOS show run | section interface command output must be named cisco_ios_show_running_config_pipe_section_interface.txt
Dash symbols - replaced with underscores. For example, template to parse Huawei display current-configuration interface command output must be named huawei_display_current_configuration_interface.txt

YANG collection templates files naming rule

{{ YANG module name }}_{{ platform_name }}.txt - lower case only

Naming rules details:

All space symbols ' ' replaced with underscore.
Dash symbol - does not replaced with underscore. For example, template to produce output compatible with openconfig-lldp YANG model for Cisco IOS must be named openconfig-lldp_cisco_xr.txt

Misc collection templates files naming rule

{{ usecase folder }}/{{ template name }}.txt - upper or lower case

Naming rules details:

Nothing replaced with anything, provided template name used as is.

Additional Templates Resources

List of resources with TTP templates:

TTP SrosParser - https://pypi.org/project/ttp-sros-parser/ by h4ndzdatm0ld
Template for parsing "show run" for Cisco IOS - https://github.com/tbotnz/ios-show-run-ttp by tbotnz
Template for Cisco ASA configuration - https://github.com/consentfactory/ttp-cisco-asa-template by consentfactory
- (gist for historical purposes) https://gist.github.com/consentfactory/85872fc83453d1735b15aed3e47a9763

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ttp_templates-0.6.0.tar.gz (103.2 kB view details)

Uploaded Sep 3, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ttp_templates-0.6.0-py3-none-any.whl (211.3 kB view details)

Uploaded Sep 3, 2026 Python 3

File details

Details for the file ttp_templates-0.6.0.tar.gz.

File metadata

Download URL: ttp_templates-0.6.0.tar.gz
Upload date: Sep 3, 2026
Size: 103.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.3.3 CPython/3.13.13 Windows/11

File hashes

Hashes for ttp_templates-0.6.0.tar.gz
Algorithm	Hash digest
SHA256	`528dacdcb04f2bbe3dba12212c493bcbeb5de010aa6ed3340f93a9505c36cac8`
MD5	`2f6dcaa589e0bbca65b707ad65c1477c`
BLAKE2b-256	`db486f796c614b40089323031ea042cf9b971bf47a409925df5e7f91a16e050e`

See more details on using hashes here.

File details

Details for the file ttp_templates-0.6.0-py3-none-any.whl.

File metadata

Download URL: ttp_templates-0.6.0-py3-none-any.whl
Upload date: Sep 3, 2026
Size: 211.3 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.3.3 CPython/3.13.13 Windows/11

File hashes

Hashes for ttp_templates-0.6.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`f2c088ef791584296d3e976587556747eec2dceb2de3143a0b49725aa9bcdd5d`
MD5	`b019e2a4e925b534afa4f0050108d9e5`
BLAKE2b-256	`75f75a9aecf6c584d60fed89017acfe7f06e6e548dec421591970f708e74841f`