3 # Copyright (C) 2014 Cumulus Networks, Inc.
5 # This file is part of Frr.
7 # Frr is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by the
9 # Free Software Foundation; either version 2, or (at your option) any
12 # Frr is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Frr; see the file COPYING. If not, write to the Free
19 # Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24 - reads a frr configuration text file
25 - reads frr's current running configuration via "vtysh -c 'show running'"
26 - compares the two configs and determines what commands to execute to
27 synchronize frr's running configuration with the configuation in the
40 from collections
import OrderedDict
41 from ipaddr
import IPv6Address
, IPNetwork
42 from pprint
import pformat
45 log
= logging
.getLogger(__name__
)
48 class VtyshMarkException(Exception):
52 class Context(object):
55 A Context object represents a section of frr configuration such as:
58 description swp3 -> r8's swp1
63 or a single line context object such as this:
69 def __init__(self
, keys
, lines
):
73 # Keep a dictionary of the lines, this is to make it easy to tell if a
74 # line exists in this Context
75 self
.dlines
= OrderedDict()
78 self
.dlines
[ligne
] = True
80 def add_lines(self
, lines
):
82 Add lines to specified context
85 self
.lines
.extend(lines
)
88 self
.dlines
[ligne
] = True
94 A frr configuration is stored in a Config object. A Config object
95 contains a dictionary of Context objects where the Context keys
96 ('router ospf' for example) are our dictionary key.
101 self
.contexts
= OrderedDict()
103 def load_from_file(self
, filename
):
105 Read configuration from specified file and slurp it into internal memory
106 The internal representation has been marked appropriately by passing it
107 through vtysh with the -m parameter
109 log
.info('Loading Config object from file %s', filename
)
112 file_output
= subprocess
.check_output(['/usr/bin/vtysh', '-m', '-f', filename
],
113 stderr
=subprocess
.STDOUT
)
114 except subprocess
.CalledProcessError
as e
:
115 ve
= VtyshMarkException(e
)
119 for line
in file_output
.split('\n'):
122 # Compress duplicate whitespaces
123 line
= ' '.join(line
.split())
126 qv6_line
= get_normalized_ipv6_line(line
)
127 self
.lines
.append(qv6_line
)
129 self
.lines
.append(line
)
133 def load_from_show_running(self
):
135 Read running configuration and slurp it into internal memory
136 The internal representation has been marked appropriately by passing it
137 through vtysh with the -m parameter
139 log
.info('Loading Config object from vtysh show running')
142 config_text
= subprocess
.check_output(
143 "/usr/bin/vtysh -c 'show run' | /usr/bin/tail -n +4 | /usr/bin/vtysh -m -f -",
144 shell
=True, stderr
=subprocess
.STDOUT
)
145 except subprocess
.CalledProcessError
as e
:
146 ve
= VtyshMarkException(e
)
150 for line
in config_text
.split('\n'):
153 if (line
== 'Building configuration...' or
154 line
== 'Current configuration:' or
158 self
.lines
.append(line
)
164 Return the lines read in from the configuration
167 return '\n'.join(self
.lines
)
169 def get_contexts(self
):
171 Return the parsed context as strings for display, log etc.
174 for (_
, ctx
) in sorted(self
.contexts
.iteritems()):
175 print str(ctx
) + '\n'
177 def save_contexts(self
, key
, lines
):
179 Save the provided key and lines as a context
186 IP addresses specified in "network" statements, "ip prefix-lists"
187 etc. can differ in the host part of the specification the user
188 provides and what the running config displays. For example, user
189 can specify 11.1.1.1/24, and the running config displays this as
190 11.1.1.0/24. Ensure we don't do a needless operation for such
191 lines. IS-IS & OSPFv3 have no "network" support.
193 re_key_rt
= re
.match(r
'(ip|ipv6)\s+route\s+([A-Fa-f:.0-9/]+)(.*)$', key
[0])
195 addr
= re_key_rt
.group(2)
198 newaddr
= IPNetwork(addr
)
199 key
[0] = '%s route %s/%s%s' % (re_key_rt
.group(1),
206 re_key_rt
= re
.match(
207 r
'(ip|ipv6)\s+prefix-list(.*)(permit|deny)\s+([A-Fa-f:.0-9/]+)(.*)$',
211 addr
= re_key_rt
.group(4)
214 newaddr
= '%s/%s' % (IPNetwork(addr
).network
,
215 IPNetwork(addr
).prefixlen
)
221 legestr
= re_key_rt
.group(5)
222 re_lege
= re
.search(r
'(.*)le\s+(\d+)\s+ge\s+(\d+)(.*)', legestr
)
224 legestr
= '%sge %s le %s%s' % (re_lege
.group(1),
228 re_lege
= re
.search(r
'(.*)ge\s+(\d+)\s+le\s+(\d+)(.*)', legestr
)
230 if (re_lege
and ((re_key_rt
.group(1) == "ip" and
231 re_lege
.group(3) == "32") or
232 (re_key_rt
.group(1) == "ipv6" and
233 re_lege
.group(3) == "128"))):
234 legestr
= '%sge %s%s' % (re_lege
.group(1),
238 key
[0] = '%s prefix-list%s%s %s%s' % (re_key_rt
.group(1),
244 if lines
and key
[0].startswith('router bgp'):
247 re_net
= re
.match(r
'network\s+([A-Fa-f:.0-9/]+)(.*)$', line
)
249 addr
= re_net
.group(1)
250 if '/' not in addr
and key
[0].startswith('router bgp'):
251 # This is most likely an error because with no
252 # prefixlen, BGP treats the prefixlen as 8
256 newaddr
= IPNetwork(addr
)
257 line
= 'network %s/%s %s' % (newaddr
.network
,
260 newlines
.append(line
)
262 # Really this should be an error. Whats a network
263 # without an IP Address following it ?
264 newlines
.append(line
)
266 newlines
.append(line
)
270 More fixups in user specification and what running config shows.
271 "null0" in routes must be replaced by Null0, and "blackhole" must
272 be replaced by Null0 as well.
274 if (key
[0].startswith('ip route') or key
[0].startswith('ipv6 route') and
275 'null0' in key
[0] or 'blackhole' in key
[0]):
276 key
[0] = re
.sub(r
'\s+null0(\s*$)', ' Null0', key
[0])
277 key
[0] = re
.sub(r
'\s+blackhole(\s*$)', ' Null0', key
[0])
280 if tuple(key
) not in self
.contexts
:
281 ctx
= Context(tuple(key
), lines
)
282 self
.contexts
[tuple(key
)] = ctx
284 ctx
= self
.contexts
[tuple(key
)]
288 if tuple(key
) not in self
.contexts
:
289 ctx
= Context(tuple(key
), [])
290 self
.contexts
[tuple(key
)] = ctx
292 def load_contexts(self
):
294 Parse the configuration and create contexts for each appropriate block
297 current_context_lines
= []
301 The end of a context is flagged via the 'end' keyword:
310 bgp router-id 10.0.0.1
311 bgp log-neighbor-changes
312 no bgp default ipv4-unicast
313 neighbor EBGP peer-group
314 neighbor EBGP advertisement-interval 1
315 neighbor EBGP timers connect 10
316 neighbor 2001:40:1:4::6 remote-as 40
317 neighbor 2001:40:1:8::a remote-as 40
321 neighbor IBGPv6 activate
322 neighbor 2001:10::2 peer-group IBGPv6
323 neighbor 2001:10::3 peer-group IBGPv6
328 neighbor LEAF activate
332 route-target import 10.1.1.1:10100
333 route-target export 10.1.1.1:10100
339 ospf router-id 10.0.0.1
340 log-adjacency-changes detail
341 timers throttle spf 0 50 5000
346 # The code assumes that its working on the output from the "vtysh -m"
347 # command. That provides the appropriate markers to signify end of
348 # a context. This routine uses that to build the contexts for the
351 # There are single line contexts such as "log file /media/node/zebra.log"
352 # and multi-line contexts such as "router ospf" and subcontexts
353 # within a context such as "address-family" within "router bgp"
354 # In each of these cases, the first line of the context becomes the
355 # key of the context. So "router bgp 10" is the key for the non-address
356 # family part of bgp, "router bgp 10, address-family ipv6 unicast" is
357 # the key for the subcontext and so on.
362 # the keywords that we know are single line contexts. bgp in this case
363 # is not the main router bgp block, but enabling multi-instance
364 oneline_ctx_keywords
= ("access-list ",
385 for line
in self
.lines
:
390 if line
.startswith('!') or line
.startswith('#'):
394 if new_ctx
is True and any(line
.startswith(keyword
) for keyword
in oneline_ctx_keywords
):
395 self
.save_contexts(ctx_keys
, current_context_lines
)
397 # Start a new context
400 current_context_lines
= []
402 log
.debug('LINE %-50s: entering new context, %-50s', line
, ctx_keys
)
403 self
.save_contexts(ctx_keys
, current_context_lines
)
407 self
.save_contexts(ctx_keys
, current_context_lines
)
408 log
.debug('LINE %-50s: exiting old context, %-50s', line
, ctx_keys
)
410 # Start a new context
414 current_context_lines
= []
416 elif line
== "exit-address-family" or line
== "exit" or line
== "exit-vni":
417 # if this exit is for address-family ipv4 unicast, ignore the pop
419 self
.save_contexts(ctx_keys
, current_context_lines
)
421 # Start a new context
422 ctx_keys
= copy
.deepcopy(main_ctx_key
)
423 current_context_lines
= []
424 log
.debug('LINE %-50s: popping from subcontext to ctx%-50s', line
, ctx_keys
)
426 elif new_ctx
is True:
430 ctx_keys
= copy
.deepcopy(main_ctx_key
)
433 current_context_lines
= []
435 log
.debug('LINE %-50s: entering new context, %-50s', line
, ctx_keys
)
437 # The 'vni' keyword under 'router bgp X/address-family l2vpn evpn' creates
438 # a sub-context but the 'vni' keyword in other places (such as 'vrf BLUE')
440 elif ("vni " in line
and
441 len(ctx_keys
) == 2 and
442 ctx_keys
[0].startswith('router bgp') and
443 ctx_keys
[1] == 'address-family l2vpn evpn'):
447 # Save old context first
448 self
.save_contexts(ctx_keys
, current_context_lines
)
449 current_context_lines
= []
450 main_ctx_key
= copy
.deepcopy(ctx_keys
)
451 log
.debug('LINE %-50s: entering sub-context, append to ctx_keys', line
)
453 ctx_keys
.append(line
)
455 elif "address-family " in line
:
458 # Save old context first
459 self
.save_contexts(ctx_keys
, current_context_lines
)
460 current_context_lines
= []
461 main_ctx_key
= copy
.deepcopy(ctx_keys
)
462 log
.debug('LINE %-50s: entering sub-context, append to ctx_keys', line
)
464 if line
== "address-family ipv6":
465 ctx_keys
.append("address-family ipv6 unicast")
466 elif line
== "address-family ipv4":
467 ctx_keys
.append("address-family ipv4 unicast")
468 elif line
== "address-family evpn":
469 ctx_keys
.append("address-family l2vpn evpn")
471 ctx_keys
.append(line
)
474 # Continuing in an existing context, add non-commented lines to it
475 current_context_lines
.append(line
)
476 log
.debug('LINE %-50s: append to current_context_lines, %-50s', line
, ctx_keys
)
478 # Save the context of the last one
479 self
.save_contexts(ctx_keys
, current_context_lines
)
482 def line_to_vtysh_conft(ctx_keys
, line
, delete
):
484 Return the vtysh command for the specified context line
493 for ctx_key
in ctx_keys
:
502 if line
.startswith('no '):
503 cmd
.append('%s' % line
[3:])
505 cmd
.append('no %s' % line
)
511 # If line is None then we are typically deleting an entire
512 # context ('no router ospf' for example)
517 # Only put the 'no' on the last sub-context
518 for ctx_key
in ctx_keys
:
521 if ctx_key
== ctx_keys
[-1]:
522 cmd
.append('no %s' % ctx_key
)
524 cmd
.append('%s' % ctx_key
)
526 for ctx_key
in ctx_keys
:
533 def line_for_vtysh_file(ctx_keys
, line
, delete
):
535 Return the command as it would appear in frr.conf
540 for (i
, ctx_key
) in enumerate(ctx_keys
):
541 cmd
.append(' ' * i
+ ctx_key
)
544 indent
= len(ctx_keys
) * ' '
547 if line
.startswith('no '):
548 cmd
.append('%s%s' % (indent
, line
[3:]))
550 cmd
.append('%sno %s' % (indent
, line
))
553 cmd
.append(indent
+ line
)
555 # If line is None then we are typically deleting an entire
556 # context ('no router ospf' for example)
560 # Only put the 'no' on the last sub-context
561 for ctx_key
in ctx_keys
:
563 if ctx_key
== ctx_keys
[-1]:
564 cmd
.append('no %s' % ctx_key
)
566 cmd
.append('%s' % ctx_key
)
568 for ctx_key
in ctx_keys
:
571 cmd
= '\n' + '\n'.join(cmd
)
573 # There are some commands that are on by default so their "no" form will be
574 # displayed in the config. "no bgp default ipv4-unicast" is one of these.
575 # If we need to remove this line we do so by adding "bgp default ipv4-unicast",
576 # not by doing a "no no bgp default ipv4-unicast"
577 cmd
= cmd
.replace('no no ', '')
582 def get_normalized_ipv6_line(line
):
584 Return a normalized IPv6 line as produced by frr,
585 with all letters in lower case and trailing and leading
586 zeros removed, and only the network portion present if
587 the IPv6 word is a network
590 words
= line
.split(' ')
596 v6word
= IPNetwork(word
)
597 norm_word
= '%s/%s' % (v6word
.network
, v6word
.prefixlen
)
602 norm_word
= '%s' % IPv6Address(word
)
607 norm_line
= norm_line
+ " " + norm_word
609 return norm_line
.strip()
612 def line_exist(lines
, target_ctx_keys
, target_line
, exact_match
=True):
613 for (ctx_keys
, line
) in lines
:
614 if ctx_keys
== target_ctx_keys
:
616 if line
== target_line
:
619 if line
.startswith(target_line
):
624 def ignore_delete_re_add_lines(lines_to_add
, lines_to_del
):
626 # Quite possibly the most confusing (while accurate) variable names in history
627 lines_to_add_to_del
= []
628 lines_to_del_to_del
= []
630 for (ctx_keys
, line
) in lines_to_del
:
633 if ctx_keys
[0].startswith('router bgp') and line
:
635 if line
.startswith('neighbor '):
637 BGP changed how it displays swpX peers that are part of peer-group. Older
638 versions of frr would display these on separate lines:
639 neighbor swp1 interface
640 neighbor swp1 peer-group FOO
642 but today we display via a single line
643 neighbor swp1 interface peer-group FOO
645 This change confuses frr-reload.py so check to see if we are deleting
646 neighbor swp1 interface peer-group FOO
649 neighbor swp1 interface
650 neighbor swp1 peer-group FOO
652 If so then chop the del line and the corresponding add lines
655 re_swpx_int_peergroup
= re
.search('neighbor (\S+) interface peer-group (\S+)', line
)
656 re_swpx_int_v6only_peergroup
= re
.search('neighbor (\S+) interface v6only peer-group (\S+)', line
)
658 if re_swpx_int_peergroup
or re_swpx_int_v6only_peergroup
:
659 swpx_interface
= None
660 swpx_peergroup
= None
662 if re_swpx_int_peergroup
:
663 swpx
= re_swpx_int_peergroup
.group(1)
664 peergroup
= re_swpx_int_peergroup
.group(2)
665 swpx_interface
= "neighbor %s interface" % swpx
666 elif re_swpx_int_v6only_peergroup
:
667 swpx
= re_swpx_int_v6only_peergroup
.group(1)
668 peergroup
= re_swpx_int_v6only_peergroup
.group(2)
669 swpx_interface
= "neighbor %s interface v6only" % swpx
671 swpx_peergroup
= "neighbor %s peer-group %s" % (swpx
, peergroup
)
672 found_add_swpx_interface
= line_exist(lines_to_add
, ctx_keys
, swpx_interface
)
673 found_add_swpx_peergroup
= line_exist(lines_to_add
, ctx_keys
, swpx_peergroup
)
674 tmp_ctx_keys
= tuple(list(ctx_keys
))
676 if not found_add_swpx_peergroup
:
677 tmp_ctx_keys
= list(ctx_keys
)
678 tmp_ctx_keys
.append('address-family ipv4 unicast')
679 tmp_ctx_keys
= tuple(tmp_ctx_keys
)
680 found_add_swpx_peergroup
= line_exist(lines_to_add
, tmp_ctx_keys
, swpx_peergroup
)
682 if not found_add_swpx_peergroup
:
683 tmp_ctx_keys
= list(ctx_keys
)
684 tmp_ctx_keys
.append('address-family ipv6 unicast')
685 tmp_ctx_keys
= tuple(tmp_ctx_keys
)
686 found_add_swpx_peergroup
= line_exist(lines_to_add
, tmp_ctx_keys
, swpx_peergroup
)
688 if found_add_swpx_interface
and found_add_swpx_peergroup
:
690 lines_to_del_to_del
.append((ctx_keys
, line
))
691 lines_to_add_to_del
.append((ctx_keys
, swpx_interface
))
692 lines_to_add_to_del
.append((tmp_ctx_keys
, swpx_peergroup
))
695 We changed how we display the neighbor interface command. Older
696 versions of frr would display the following:
697 neighbor swp1 interface
698 neighbor swp1 remote-as external
699 neighbor swp1 capability extended-nexthop
701 but today we display via a single line
702 neighbor swp1 interface remote-as external
704 and capability extended-nexthop is no longer needed because we
705 automatically enable it when the neighbor is of type interface.
707 This change confuses frr-reload.py so check to see if we are deleting
708 neighbor swp1 interface remote-as (external|internal|ASNUM)
711 neighbor swp1 interface
712 neighbor swp1 remote-as (external|internal|ASNUM)
713 neighbor swp1 capability extended-nexthop
715 If so then chop the del line and the corresponding add lines
717 re_swpx_int_remoteas
= re
.search('neighbor (\S+) interface remote-as (\S+)', line
)
718 re_swpx_int_v6only_remoteas
= re
.search('neighbor (\S+) interface v6only remote-as (\S+)', line
)
720 if re_swpx_int_remoteas
or re_swpx_int_v6only_remoteas
:
721 swpx_interface
= None
724 if re_swpx_int_remoteas
:
725 swpx
= re_swpx_int_remoteas
.group(1)
726 remoteas
= re_swpx_int_remoteas
.group(2)
727 swpx_interface
= "neighbor %s interface" % swpx
728 elif re_swpx_int_v6only_remoteas
:
729 swpx
= re_swpx_int_v6only_remoteas
.group(1)
730 remoteas
= re_swpx_int_v6only_remoteas
.group(2)
731 swpx_interface
= "neighbor %s interface v6only" % swpx
733 swpx_remoteas
= "neighbor %s remote-as %s" % (swpx
, remoteas
)
734 found_add_swpx_interface
= line_exist(lines_to_add
, ctx_keys
, swpx_interface
)
735 found_add_swpx_remoteas
= line_exist(lines_to_add
, ctx_keys
, swpx_remoteas
)
736 tmp_ctx_keys
= tuple(list(ctx_keys
))
738 if found_add_swpx_interface
and found_add_swpx_remoteas
:
740 lines_to_del_to_del
.append((ctx_keys
, line
))
741 lines_to_add_to_del
.append((ctx_keys
, swpx_interface
))
742 lines_to_add_to_del
.append((tmp_ctx_keys
, swpx_remoteas
))
745 We made the 'bgp bestpath as-path multipath-relax' command
746 automatically assume 'no-as-set' since the lack of this option caused
747 weird routing problems. When the running config is shown in
748 releases with this change, the no-as-set keyword is not shown as it
749 is the default. This causes frr-reload to unnecessarily unapply
750 this option only to apply it back again, causing unnecessary session
753 if 'multipath-relax' in line
:
754 re_asrelax_new
= re
.search('^bgp\s+bestpath\s+as-path\s+multipath-relax$', line
)
755 old_asrelax_cmd
= 'bgp bestpath as-path multipath-relax no-as-set'
756 found_asrelax_old
= line_exist(lines_to_add
, ctx_keys
, old_asrelax_cmd
)
758 if re_asrelax_new
and found_asrelax_old
:
760 lines_to_del_to_del
.append((ctx_keys
, line
))
761 lines_to_add_to_del
.append((ctx_keys
, old_asrelax_cmd
))
764 If we are modifying the BGP table-map we need to avoid a del/add and
765 instead modify the table-map in place via an add. This is needed to
766 avoid installing all routes in the RIB the second the 'no table-map'
769 if line
.startswith('table-map'):
770 found_table_map
= line_exist(lines_to_add
, ctx_keys
, 'table-map', False)
773 lines_to_del_to_del
.append((ctx_keys
, line
))
776 More old-to-new config handling. ip import-table no longer accepts
777 distance, but we honor the old syntax. But 'show running' shows only
778 the new syntax. This causes an unnecessary 'no import-table' followed
779 by the same old 'ip import-table' which causes perturbations in
780 announced routes leading to traffic blackholes. Fix this issue.
782 re_importtbl
= re
.search('^ip\s+import-table\s+(\d+)$', ctx_keys
[0])
784 table_num
= re_importtbl
.group(1)
785 for ctx
in lines_to_add
:
786 if ctx
[0][0].startswith('ip import-table %s distance' % table_num
):
787 lines_to_del_to_del
.append((('ip import-table %s' % table_num
,), None))
788 lines_to_add_to_del
.append((ctx
[0], None))
791 ip/ipv6 prefix-list can be specified without a seq number. However,
792 the running config always adds 'seq x', where x is a number incremented
793 by 5 for every element, to the prefix list. So, ignore such lines as
794 well. Sample prefix-list lines:
795 ip prefix-list PR-TABLE-2 seq 5 permit 20.8.2.0/24 le 32
796 ip prefix-list PR-TABLE-2 seq 10 permit 20.8.2.0/24 le 32
797 ipv6 prefix-list vrfdev6-12 permit 2000:9:2::/64 gt 64
799 re_ip_pfxlst
= re
.search('^(ip|ipv6)(\s+prefix-list\s+)(\S+\s+)(seq \d+\s+)(permit|deny)(.*)$',
802 tmpline
= (re_ip_pfxlst
.group(1) + re_ip_pfxlst
.group(2) +
803 re_ip_pfxlst
.group(3) + re_ip_pfxlst
.group(5) +
804 re_ip_pfxlst
.group(6))
805 for ctx
in lines_to_add
:
806 if ctx
[0][0] == tmpline
:
807 lines_to_del_to_del
.append((ctx_keys
, None))
808 lines_to_add_to_del
.append(((tmpline
,), None))
810 if (len(ctx_keys
) == 3 and
811 ctx_keys
[0].startswith('router bgp') and
812 ctx_keys
[1] == 'address-family l2vpn evpn' and
813 ctx_keys
[2].startswith('vni')):
815 re_route_target
= re
.search('^route-target import (.*)$', line
) if line
is not None else False
818 rt
= re_route_target
.group(1).strip()
819 route_target_import_line
= line
820 route_target_export_line
= "route-target export %s" % rt
821 route_target_both_line
= "route-target both %s" % rt
823 found_route_target_export_line
= line_exist(lines_to_del
, ctx_keys
, route_target_export_line
)
824 found_route_target_both_line
= line_exist(lines_to_add
, ctx_keys
, route_target_both_line
)
827 If the running configs has
828 route-target import 1:1
829 route-target export 1:1
831 and the config we are reloading against has
832 route-target both 1:1
834 then we can ignore deleting the import/export and ignore adding the 'both'
836 if found_route_target_export_line
and found_route_target_both_line
:
837 lines_to_del_to_del
.append((ctx_keys
, route_target_import_line
))
838 lines_to_del_to_del
.append((ctx_keys
, route_target_export_line
))
839 lines_to_add_to_del
.append((ctx_keys
, route_target_both_line
))
842 found_add_line
= line_exist(lines_to_add
, ctx_keys
, line
)
845 lines_to_del_to_del
.append((ctx_keys
, line
))
846 lines_to_add_to_del
.append((ctx_keys
, line
))
849 We have commands that used to be displayed in the global part
850 of 'router bgp' that are now displayed under 'address-family ipv4 unicast'
854 neighbor ISL advertisement-interval 0
860 address-family ipv4 unicast
861 neighbor ISL advertisement-interval 0
863 Look to see if we are deleting it in one format just to add it back in the other
865 if ctx_keys
[0].startswith('router bgp') and len(ctx_keys
) > 1 and ctx_keys
[1] == 'address-family ipv4 unicast':
866 tmp_ctx_keys
= list(ctx_keys
)[:-1]
867 tmp_ctx_keys
= tuple(tmp_ctx_keys
)
869 found_add_line
= line_exist(lines_to_add
, tmp_ctx_keys
, line
)
872 lines_to_del_to_del
.append((ctx_keys
, line
))
873 lines_to_add_to_del
.append((tmp_ctx_keys
, line
))
875 for (ctx_keys
, line
) in lines_to_del_to_del
:
876 lines_to_del
.remove((ctx_keys
, line
))
878 for (ctx_keys
, line
) in lines_to_add_to_del
:
879 lines_to_add
.remove((ctx_keys
, line
))
881 return (lines_to_add
, lines_to_del
)
884 def ignore_unconfigurable_lines(lines_to_add
, lines_to_del
):
886 There are certain commands that cannot be removed. Remove
887 those commands from lines_to_del.
889 lines_to_del_to_del
= []
891 for (ctx_keys
, line
) in lines_to_del
:
893 if (ctx_keys
[0].startswith('frr version') or
894 ctx_keys
[0].startswith('frr defaults') or
895 ctx_keys
[0].startswith('password') or
896 ctx_keys
[0].startswith('line vty') or
898 # This is technically "no"able but if we did so frr-reload would
899 # stop working so do not let the user shoot themselves in the foot
901 ctx_keys
[0].startswith('service integrated-vtysh-config')):
903 log
.info("(%s, %s) cannot be removed" % (pformat(ctx_keys
), line
))
904 lines_to_del_to_del
.append((ctx_keys
, line
))
906 for (ctx_keys
, line
) in lines_to_del_to_del
:
907 lines_to_del
.remove((ctx_keys
, line
))
909 return (lines_to_add
, lines_to_del
)
912 def compare_context_objects(newconf
, running
):
914 Create a context diff for the two specified contexts
917 # Compare the two Config objects to find the lines that we need to add/del
922 # Find contexts that are in newconf but not in running
923 # Find contexts that are in running but not in newconf
924 for (running_ctx_keys
, running_ctx
) in running
.contexts
.iteritems():
926 if running_ctx_keys
not in newconf
.contexts
:
928 # We check that the len is 1 here so that we only look at ('router bgp 10')
929 # and not ('router bgp 10', 'address-family ipv4 unicast'). The
930 # latter could cause a false delete_bgpd positive if ipv4 unicast is in
931 # running but not in newconf.
932 if "router bgp" in running_ctx_keys
[0] and len(running_ctx_keys
) == 1:
934 lines_to_del
.append((running_ctx_keys
, None))
936 # We cannot do 'no interface' in FRR, and so deal with it
937 elif running_ctx_keys
[0].startswith('interface'):
938 for line
in running_ctx
.lines
:
939 lines_to_del
.append((running_ctx_keys
, line
))
941 # If this is an address-family under 'router bgp' and we are already deleting the
942 # entire 'router bgp' context then ignore this sub-context
943 elif "router bgp" in running_ctx_keys
[0] and len(running_ctx_keys
) > 1 and delete_bgpd
:
946 # Delete an entire vni sub-context under "address-family l2vpn evpn"
947 elif ("router bgp" in running_ctx_keys
[0] and
948 len(running_ctx_keys
) > 2 and
949 running_ctx_keys
[1].startswith('address-family l2vpn evpn') and
950 running_ctx_keys
[2].startswith('vni ')):
951 lines_to_del
.append((running_ctx_keys
, None))
953 elif ("router bgp" in running_ctx_keys
[0] and
954 len(running_ctx_keys
) > 1 and
955 running_ctx_keys
[1].startswith('address-family')):
956 # There's no 'no address-family' support and so we have to
957 # delete each line individually again
958 for line
in running_ctx
.lines
:
959 lines_to_del
.append((running_ctx_keys
, line
))
962 elif running_ctx_keys
and not any("address-family" in key
for key
in running_ctx_keys
):
963 lines_to_del
.append((running_ctx_keys
, None))
965 elif running_ctx_keys
and not any("vni" in key
for key
in running_ctx_keys
):
966 lines_to_del
.append((running_ctx_keys
, None))
970 for line
in running_ctx
.lines
:
971 lines_to_del
.append((running_ctx_keys
, line
))
973 # Find the lines within each context to add
974 # Find the lines within each context to del
975 for (newconf_ctx_keys
, newconf_ctx
) in newconf
.contexts
.iteritems():
977 if newconf_ctx_keys
in running
.contexts
:
978 running_ctx
= running
.contexts
[newconf_ctx_keys
]
980 for line
in newconf_ctx
.lines
:
981 if line
not in running_ctx
.dlines
:
982 lines_to_add
.append((newconf_ctx_keys
, line
))
984 for line
in running_ctx
.lines
:
985 if line
not in newconf_ctx
.dlines
:
986 lines_to_del
.append((newconf_ctx_keys
, line
))
988 for (newconf_ctx_keys
, newconf_ctx
) in newconf
.contexts
.iteritems():
990 if newconf_ctx_keys
not in running
.contexts
:
991 lines_to_add
.append((newconf_ctx_keys
, None))
993 for line
in newconf_ctx
.lines
:
994 lines_to_add
.append((newconf_ctx_keys
, line
))
996 (lines_to_add
, lines_to_del
) = ignore_delete_re_add_lines(lines_to_add
, lines_to_del
)
997 (lines_to_add
, lines_to_del
) = ignore_unconfigurable_lines(lines_to_add
, lines_to_del
)
999 return (lines_to_add
, lines_to_del
)
1003 def vtysh_config_available():
1005 Return False if no frr daemon is running or some other vtysh session is
1006 in 'configuration terminal' mode which will prevent us from making any
1007 configuration changes.
1011 cmd
= ['/usr/bin/vtysh', '-c', 'conf t']
1012 output
= subprocess
.check_output(cmd
, stderr
=subprocess
.STDOUT
).strip()
1014 if 'VTY configuration is locked by other VTY' in output
:
1016 log
.error("'%s' returned\n%s\n" % (' '.join(cmd
), output
))
1019 except subprocess
.CalledProcessError
as e
:
1020 msg
= "vtysh could not connect with any frr daemons"
1028 if __name__
== '__main__':
1029 # Command line options
1030 parser
= argparse
.ArgumentParser(description
='Dynamically apply diff in frr configs')
1031 parser
.add_argument('--input', help='Read running config from file instead of "show running"')
1032 group
= parser
.add_mutually_exclusive_group(required
=True)
1033 group
.add_argument('--reload', action
='store_true', help='Apply the deltas', default
=False)
1034 group
.add_argument('--test', action
='store_true', help='Show the deltas', default
=False)
1035 parser
.add_argument('--debug', action
='store_true', help='Enable debugs', default
=False)
1036 parser
.add_argument('--stdout', action
='store_true', help='Log to STDOUT', default
=False)
1037 parser
.add_argument('filename', help='Location of new frr config file')
1038 parser
.add_argument('--overwrite', action
='store_true', help='Overwrite frr.conf with running config output', default
=False)
1039 args
= parser
.parse_args()
1042 # For --test log to stdout
1043 # For --reload log to /var/log/frr/frr-reload.log
1044 if args
.test
or args
.stdout
:
1045 logging
.basicConfig(level
=logging
.INFO
,
1046 format
='%(asctime)s %(levelname)5s: %(message)s')
1048 # Color the errors and warnings in red
1049 logging
.addLevelName(logging
.ERROR
, "\033[91m %s\033[0m" % logging
.getLevelName(logging
.ERROR
))
1050 logging
.addLevelName(logging
.WARNING
, "\033[91m%s\033[0m" % logging
.getLevelName(logging
.WARNING
))
1053 if not os
.path
.isdir('/var/log/frr/'):
1054 os
.makedirs('/var/log/frr/')
1056 logging
.basicConfig(filename
='/var/log/frr/frr-reload.log',
1058 format
='%(asctime)s %(levelname)5s: %(message)s')
1060 # argparse should prevent this from happening but just to be safe...
1062 raise Exception('Must specify --reload or --test')
1063 log
= logging
.getLogger(__name__
)
1065 # Verify the new config file is valid
1066 if not os
.path
.isfile(args
.filename
):
1067 msg
= "Filename %s does not exist" % args
.filename
1072 if not os
.path
.getsize(args
.filename
):
1073 msg
= "Filename %s is an empty file" % args
.filename
1078 # Verify that 'service integrated-vtysh-config' is configured
1079 vtysh_filename
= '/etc/frr/vtysh.conf'
1080 service_integrated_vtysh_config
= True
1082 if os
.path
.isfile(vtysh_filename
):
1083 with
open(vtysh_filename
, 'r') as fh
:
1084 for line
in fh
.readlines():
1087 if line
== 'no service integrated-vtysh-config':
1088 service_integrated_vtysh_config
= False
1091 if not service_integrated_vtysh_config
:
1092 msg
= "'service integrated-vtysh-config' is not configured, this is required for 'service frr reload'"
1098 log
.setLevel(logging
.DEBUG
)
1100 log
.info('Called via "%s"', str(args
))
1102 # Create a Config object from the config generated by newconf
1104 newconf
.load_from_file(args
.filename
)
1109 # Create a Config object from the running config
1113 running
.load_from_file(args
.input)
1115 running
.load_from_show_running()
1117 (lines_to_add
, lines_to_del
) = compare_context_objects(newconf
, running
)
1118 lines_to_configure
= []
1121 print "\nLines To Delete"
1122 print "==============="
1124 for (ctx_keys
, line
) in lines_to_del
:
1129 cmd
= line_for_vtysh_file(ctx_keys
, line
, True)
1130 lines_to_configure
.append(cmd
)
1134 print "\nLines To Add"
1135 print "============"
1137 for (ctx_keys
, line
) in lines_to_add
:
1142 cmd
= line_for_vtysh_file(ctx_keys
, line
, False)
1143 lines_to_configure
.append(cmd
)
1148 # We will not be able to do anything, go ahead and exit(1)
1149 if not vtysh_config_available():
1152 log
.debug('New Frr Config\n%s', newconf
.get_lines())
1154 # This looks a little odd but we have to do this twice...here is why
1155 # If the user had this running bgp config:
1158 # neighbor 1.1.1.1 remote-as 50
1159 # neighbor 1.1.1.1 route-map FOO out
1161 # and this config in the newconf config file
1164 # neighbor 1.1.1.1 remote-as 999
1165 # neighbor 1.1.1.1 route-map FOO out
1168 # Then the script will do
1169 # - no neighbor 1.1.1.1 remote-as 50
1170 # - neighbor 1.1.1.1 remote-as 999
1172 # The problem is the "no neighbor 1.1.1.1 remote-as 50" will also remove
1173 # the "neighbor 1.1.1.1 route-map FOO out" line...so we compare the
1174 # configs again to put this line back.
1176 # There are many keywords in FRR that can only appear one time under
1177 # a context, take "bgp router-id" for example. If the config that we are
1178 # reloading against has the following:
1181 # bgp router-id 1.1.1.1
1182 # bgp router-id 2.2.2.2
1184 # The final config needs to contain "bgp router-id 2.2.2.2". On the
1185 # first pass we will add "bgp router-id 2.2.2.2" but then on the second
1186 # pass we will see that "bgp router-id 1.1.1.1" is missing and add that
1187 # back which cancels out the "bgp router-id 2.2.2.2". The fix is for the
1188 # second pass to include all of the "adds" from the first pass.
1189 lines_to_add_first_pass
= []
1193 running
.load_from_show_running()
1194 log
.debug('Running Frr Config (Pass #%d)\n%s', x
, running
.get_lines())
1196 (lines_to_add
, lines_to_del
) = compare_context_objects(newconf
, running
)
1199 lines_to_add_first_pass
= lines_to_add
1201 lines_to_add
.extend(lines_to_add_first_pass
)
1203 # Only do deletes on the first pass. The reason being if we
1204 # configure a bgp neighbor via "neighbor swp1 interface" FRR
1205 # will automatically add:
1208 # ipv6 nd ra-interval 10
1209 # no ipv6 nd suppress-ra
1212 # but those lines aren't in the config we are reloading against so
1213 # on the 2nd pass they will show up in lines_to_del. This could
1214 # apply to other scenarios as well where configuring FOO adds BAR
1216 if lines_to_del
and x
== 0:
1217 for (ctx_keys
, line
) in lines_to_del
:
1222 # 'no' commands are tricky, we can't just put them in a file and
1223 # vtysh -f that file. See the next comment for an explanation
1225 cmd
= line_to_vtysh_conft(ctx_keys
, line
, True)
1228 # Some commands in frr are picky about taking a "no" of the entire line.
1229 # OSPF is bad about this, you can't "no" the entire line, you have to "no"
1230 # only the beginning. If we hit one of these command an exception will be
1231 # thrown. Catch it and remove the last '-c', 'FOO' from cmd and try again.
1234 # frr(config-if)# ip ospf authentication message-digest 1.1.1.1
1235 # frr(config-if)# no ip ospf authentication message-digest 1.1.1.1
1236 # % Unknown command.
1237 # frr(config-if)# no ip ospf authentication message-digest
1238 # % Unknown command.
1239 # frr(config-if)# no ip ospf authentication
1244 _
= subprocess
.check_output(cmd
, stderr
=subprocess
.STDOUT
)
1246 except subprocess
.CalledProcessError
:
1248 # - Pull the last entry from cmd (this would be
1249 # 'no ip ospf authentication message-digest 1.1.1.1' in
1251 # - Split that last entry by whitespace and drop the last word
1252 log
.info('Failed to execute %s', ' '.join(cmd
))
1253 last_arg
= cmd
[-1].split(' ')
1255 if len(last_arg
) <= 2:
1256 log
.error('"%s" we failed to remove this command', original_cmd
)
1259 new_last_arg
= last_arg
[0:-1]
1260 cmd
[-1] = ' '.join(new_last_arg
)
1262 log
.info('Executed "%s"', ' '.join(cmd
))
1266 lines_to_configure
= []
1268 for (ctx_keys
, line
) in lines_to_add
:
1273 cmd
= line_for_vtysh_file(ctx_keys
, line
, False)
1274 lines_to_configure
.append(cmd
)
1276 if lines_to_configure
:
1277 random_string
= ''.join(random
.SystemRandom().choice(
1278 string
.ascii_uppercase
+
1279 string
.digits
) for _
in range(6))
1281 filename
= "/var/run/frr/reload-%s.txt" % random_string
1282 log
.info("%s content\n%s" % (filename
, pformat(lines_to_configure
)))
1284 with
open(filename
, 'w') as fh
:
1285 for line
in lines_to_configure
:
1286 fh
.write(line
+ '\n')
1289 subprocess
.check_output(['/usr/bin/vtysh', '-f', filename
], stderr
=subprocess
.STDOUT
)
1290 except subprocess
.CalledProcessError
as e
:
1291 log
.warning("frr-reload.py failed due to\n%s" % e
.output
)
1295 # Make these changes persistent
1296 if args
.overwrite
or args
.filename
!= '/etc/frr/frr.conf':
1297 subprocess
.call(['/usr/bin/vtysh', '-c', 'write'])