Skip to content

ADVA OS ConfigParser Support #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
architekture wants to merge 18 commits into
base: develop
Choose a base branch
from
Open

ADVA OS ConfigParser Support #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
8732ede
Added ADVAConfigParser class.
Dec 15, 2025
1e08e1b
Added parser base mock test.
Dec 15, 2025
3e2a1da
Added compliance testing for adva_fsp150f3 driver.
Dec 15, 2025
277bccb
Renamed FSP150F3 test files for clarity.
Dec 16, 2025
b2880a9
Added FSP150F2 support.
Dec 16, 2025
da53212
Updated files with RUFF formatting.
Dec 16, 2025
c58011c
Added changelog fragment.
Dec 16, 2025
40807ef
Renamed changelog fragment.
Dec 16, 2025
cb1f648
Fixed fragment based on J. Kala's notes.
Dec 16, 2025
2bdf884
Revert "Fixed fragment based on J. Kala's notes."
Dec 16, 2025
04e55d9
Corrected changelog fragment.
Dec 16, 2025
5fe91d3
Ran development_docs.py script.
Dec 16, 2025
e5042af
Update changes/748.added
architekture Dec 22, 2025
763637a
Updated ADVA base model naming per K. Celenza's comments.
Dec 29, 2025
8420d4a
Updated base ADVA parser class per K. Celenza's notes and discussions…
Dec 30, 2025
34f71d3
Updated the compliance received JSON files for both ADVA parsers.
Dec 30, 2025
3e66f3a
Updated tests for ADVA FSP150F3 to use network element intstead of in…
Jan 13, 2026
29d2888
Removed ADVA F2/F3 explicit banner testing after huddle with J. Kala …
Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/748.added
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added parsing for FSP150F2 and FSP150F3 ADVA AOS device configs.
2 changes: 2 additions & 0 deletions docs/dev/include_parser_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
| OS Name | Parser Class |
| ---------- | ------ |
| adva_fsp150f2 | netutils.config.parser.ADVAFSP150F2ConfigParser |
| adva_fsp150f3 | netutils.config.parser.ADVAFSP150F3ConfigParser |
| arista_eos | netutils.config.parser.EOSConfigParser |
| aruba_aoscx | netutils.config.parser.ArubaConfigCXParser |
| aruba_os | netutils.config.parser.ArubaConfigOSParser |
Expand Down
2 changes: 2 additions & 0 deletions docs/user/lib_mapper/netmiko.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
| a10 | → | a10 |
| accedian | → | accedian |
| adtran_os | → | adtran_os |
| adva_fsp150f2 | → | adva_fsp150f2 |
| adva_fsp150f3 | → | adva_fsp150f3 |
| alcatel_aos | → | alcatel_aos |
| alcatel_sros | → | alcatel_sros |
| allied_telesis_awplus | → | allied_telesis_awplus |
Expand Down
2 changes: 2 additions & 0 deletions docs/user/lib_mapper/netmiko_reverse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
| a10 | → | a10 |
| accedian | → | accedian |
| adtran_os | → | adtran_os |
| adva_fsp150f2 | → | adva_fsp150f2 |
| adva_fsp150f3 | → | adva_fsp150f3 |
| alcatel_aos | → | alcatel_aos |
| alcatel_sros | → | alcatel_sros |
| allied_telesis_awplus | → | allied_telesis_awplus |
Expand Down
2 changes: 2 additions & 0 deletions docs/user/lib_mapper/netutilsparser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
| NETUTILSPARSER | | NORMALIZED |
| ---------- | -- | ------ |
| adva_fsp150f2 | → | adva_fsp150f2 |
| adva_fsp150f3 | → | adva_fsp150f3 |
| arista_eos | → | arista_eos |
| aruba_aoscx | → | aruba_aoscx |
| aruba_os | → | aruba_os |
Expand Down
2 changes: 2 additions & 0 deletions docs/user/lib_mapper/netutilsparser_reverse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
| NORMALIZED | | NETUTILSPARSER |
| ---------- | -- | ------ |
| adva_fsp150f2 | → | adva_fsp150f2 |
| adva_fsp150f3 | → | adva_fsp150f3 |
| arista_eos | → | arista_eos |
| aruba_aoscx | → | aruba_aoscx |
| aruba_os | → | aruba_os |
Expand Down
2 changes: 2 additions & 0 deletions docs/user/lib_mapper/ntctemplates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
| a10 | → | a10 |
| accedian | → | accedian |
| adtran_os | → | adtran_os |
| adva_fsp150f2 | → | adva_fsp150f2 |
| adva_fsp150f3 | → | adva_fsp150f3 |
| alcatel_aos | → | alcatel_aos |
| alcatel_sros | → | alcatel_sros |
| allied_telesis_awplus | → | allied_telesis_awplus |
Expand Down
2 changes: 2 additions & 0 deletions docs/user/lib_mapper/ntctemplates_reverse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
| a10 | → | a10 |
| accedian | → | accedian |
| adtran_os | → | adtran_os |
| adva_fsp150f2 | → | adva_fsp150f2 |
| adva_fsp150f3 | → | adva_fsp150f3 |
| alcatel_aos | → | alcatel_aos |
| alcatel_sros | → | alcatel_sros |
| allied_telesis_awplus | → | allied_telesis_awplus |
Expand Down
2 changes: 2 additions & 0 deletions docs/user/lib_mapper/running_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
| NORMALIZED | | RUNNING_CONFIG_COMMAND |
| ---------- | -- | ------ |
| adva_fsp150f2 | → | show running-config |
| adva_fsp150f3 | → | show running-config delta |
| arista_eos | → | show running-config |
| aruba_os | → | show running-configuration |
| aruba_osswitch | → | show running-config |
Expand Down
2 changes: 2 additions & 0 deletions netutils/config/compliance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
from . import parser # pylint: disable=relative-beyond-top-level

parser_map: t.Dict[str, t.Type[parser.BaseConfigParser]] = {
"adva_fsp150f2": parser.ADVAFSP150F2ConfigParser,
"adva_fsp150f3": parser.ADVAFSP150F3ConfigParser,
"arista_eos": parser.EOSConfigParser,
"aruba_aoscx": parser.ArubaConfigCXParser,
"aruba_os": parser.ArubaConfigOSParser,
Expand Down
44 changes: 44 additions & 0 deletions netutils/config/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1891,3 +1891,47 @@ def config_lines_only(self) -> str:
)
self._config = "\n".join(config_lines)
return self._config


class _ADVAConfigParser(BaseSpaceConfigParser):
"""Base ADVA OS ConfigParser class."""

banner_start: t.List[str] = ["security-banner"]

@property
def banner_end(self) -> str:
"""Demarcate End of Banner char."""
return '"'

def _build_banner(self, config_line: str) -> t.Optional[str]:
"""Build banner specific to ADVA AOS devices.

Args:
config_line: The start of the banner config.

Returns:
The next configuration line in the configuration text or None.

Raises:
ValueError when parser is unable to identify the banner end.
"""
if config_line.endswith(self.banner_end):
self._update_config_lines(config_line)
try:
return next(self.generator_config)
except StopIteration:
return None

raise ValueError("Unable to parse banner end.")


class ADVAFSP150F2ConfigParser(_ADVAConfigParser):
"""ADVA OS FSP-150 F2 ConfigParser."""

comment_chars: t.List[str] = ["remark"]


class ADVAFSP150F3ConfigParser(_ADVAConfigParser):
"""ADVA OS FSP-150 F3 ConfigParser."""

comment_chars: t.List[str] = ["#", "Preparing configuration file..."]
8 changes: 8 additions & 0 deletions netutils/lib_mapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@
"a10": "a10",
"accedian": "accedian",
"adtran_os": "adtran_os",
"adva_fsp150f2": "adva_fsp150f2",
"adva_fsp150f3": "adva_fsp150f3",
"alcatel_aos": "alcatel_aos",
"alcatel_sros": "alcatel_sros",
"allied_telesis_awplus": "allied_telesis_awplus",
Expand Down Expand Up @@ -308,6 +310,8 @@

# Running config command
RUNNING_CONFIG_MAPPER: t.Dict[str, str] = {
"adva_fsp150f2": "show running-config",
"adva_fsp150f3": "show running-config delta",
"arista_eos": "show running-config",
"aruba_os": "show running-configuration",
"aruba_osswitch": "show running-config",
Expand Down Expand Up @@ -423,6 +427,8 @@

# Netutils Parser | Normalized
NETUTILSPARSER_LIB_MAPPER: t.Dict[str, str] = {
"adva_fsp150f2": "adva_fsp150f2",
"adva_fsp150f3": "adva_fsp150f3",
"arista_eos": "arista_eos",
"aruba_aoscx": "aruba_aoscx",
"aruba_os": "aruba_os",
Expand Down Expand Up @@ -594,6 +600,8 @@

# Normalized | Netutils Parser
NETUTILSPARSER_LIB_MAPPER_REVERSE: t.Dict[str, str] = {
"adva_fsp150f2": "adva_fsp150f2",
"adva_fsp150f3": "adva_fsp150f3",
"arista_eos": "arista_eos",
"aruba_aoscx": "aruba_aoscx",
"aruba_os": "aruba_os",
Expand Down
101 changes: 101 additions & 0 deletions tests/unit/mock/config/compliance/compliance/adva_fsp150f2/adva_fsp150f2_basic_backup.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
remark ####################################################################
remark #
remark # Database Version: 13.0
remark #
remark ####################################################################
remark #
remark # System
remark #
configure system
sysname "x-dngr-rm-01"
cli-prompt "X-DNGR-RM-01"
contact "XNOC 888-555-1963"
location "1407 Graymalkin LN, North Salem, NY 10560"
ip-address 192.168.0.63 255.255.255.0
security-prompt enable
serial enable
telnet disable
web enable
snmp-dying-gasp enable
temperature-monitoring enable
bwp-mode information-rate
clock timezone utc
sntpclient mode unicast
sntpclient dhcp-supplied disable
sntpclient server 198.51.100.251
syslogclient dhcp-supplied disable
syslogclient server 198.51.100.252
security-banner "Any changes to this system require a change ticket or trouble ticket. Do you really want to proceed?\\n\\nBe sure to notify the XNOC of work being performed BEFORE changes are made.\\n\\nXNOC - 888-555-1963"
pae authentication-control enable
exit

configure system
jumbo-frame enable
exit

remark #
remark # Scheduled Ping
remark #
configure sched ping
frequency 1
severity minor
threshold 1
exit

remark #
remark # Interface: e100-lan-3
remark #
configure interface e100-lan-3
portmode Connection-oriented
remark #
remark # Temporarily assign the interface while configuring it.
remark # Final value will be assignstate disable.
remark #
assignstate enable
media copper
speed 100full
description "P2P-Circuit-2-PORT-DISABLED"
frame-loss-ratio 1.00
evc-mode tls
circuit-name "NO-CIRCUIT-NAME-ASSIGNED"
ingress-buffersize 1274
ingress-cbs 32
ingress-ebs 0
egress-limiting enable
ingress-eir 0
ingress-cir 1024000
egress-buffersize 1274
egress-cbs 32
egress-ebs 64
egress-eir 0
egress-cir 1024000
flowcontrol receive disable
flowcontrol send disable
tagged-frame enable
untagged-frame enable
ctag push 103-0 disable
stag none
wan-if e1000-wan-1
no propagate-fault
qq-ethertype 0x8100
efm-oam localmode passive
cpd-filter efm-oam discard
adminstate enable
port-policing enable

elmi
async-status enable
min-async-status-interval 1
n393 4
t392 15
exit

exit

configure interface e100-lan-3
remark #
remark # Temporarily disable the interface while configuring it.
remark # Final value will be adminstate enable.
remark #
adminstate disable
exit
5 changes: 5 additions & 0 deletions tests/unit/mock/config/compliance/compliance/adva_fsp150f2/adva_fsp150f2_basic_feature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
features = [
Copy link
Contributor

@itdependsnetworks itdependsnetworks Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you test the banner feature explicitly here?

Copy link
Collaborator Author

@architekture architekture Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We certainly can if you prefer. I had it as part of the system featureset since it's not a root-level config context as you'd see with other vendors. Happy to add a banner-specific test for both parsers.

{"name": "system", "ordered": False, "section": ["configure system"]},
{"name": "ping", "ordered": False, "section": ["configure sched ping"]},
{"name": "interface", "ordered": False, "section": ["configure interface"]},
]
101 changes: 101 additions & 0 deletions tests/unit/mock/config/compliance/compliance/adva_fsp150f2/adva_fsp150f2_basic_intended.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
remark ####################################################################
remark #
remark # Database Version: 13.0
remark #
remark ####################################################################
remark #
remark # System
remark #
configure system
sysname "x-dngr-rm-01"
cli-prompt "X-DNGR-RM-01"
contact "XNOC 888-555-1963"
location "1407 Graymalkin LN, North Salem, NY 10560"
ip-address 192.168.0.75 255.255.255.0
security-prompt enable
serial enable
telnet disable
web enable
snmp-dying-gasp enable
temperature-monitoring enable
bwp-mode information-rate
clock timezone utc
sntpclient mode unicast
sntpclient dhcp-supplied disable
sntpclient server 198.51.100.251
syslogclient dhcp-supplied disable
syslogclient server 198.51.100.252
security-banner "Any changes to this system require a change ticket or trouble ticket. Do you really want to proceed?\\n\\nBe sure to notify the XNOC of work being performed BEFORE changes are made.\\n\\nXNOC - 888-555-1963"
pae authentication-control enable
exit

configure system
jumbo-frame enable
exit

remark #
remark # Scheduled Ping
remark #
configure sched ping
frequency 3
severity minor
threshold 5
exit

remark #
remark # Interface: e100-lan-3
remark #
configure interface e100-lan-3
portmode Connection-oriented
remark #
remark # Temporarily assign the interface while configuring it.
remark # Final value will be assignstate disable.
remark #
assignstate enable
media copper
speed 100full
description "P2P-Circuit-2-PORT-DISABLED"
frame-loss-ratio 1.00
evc-mode tls
circuit-name "NO-CIRCUIT-NAME-ASSIGNED"
ingress-buffersize 1274
ingress-cbs 32
ingress-ebs 0
egress-limiting enable
ingress-eir 0
ingress-cir 1024000
egress-buffersize 1274
egress-cbs 32
egress-ebs 64
egress-eir 0
egress-cir 1024000
flowcontrol receive enable
flowcontrol send enable
tagged-frame enable
untagged-frame enable
ctag push 103-0 disable
stag none
wan-if e1000-wan-1
no propagate-fault
qq-ethertype 0x8100
efm-oam localmode passive
cpd-filter efm-oam discard
adminstate enable
port-policing enable

elmi
async-status enable
min-async-status-interval 1
n393 4
t392 15
exit

exit

configure interface e100-lan-3
remark #
remark # Temporarily disable the interface while configuring it.
remark # Final value will be adminstate enable.
remark #
adminstate disable
exit
Loading
Loading