summaryrefslogtreecommitdiff
path: root/src/migration-scripts/quagga/2-to-3
blob: d62c387ba4dea4717a7e99882a39fe125ea33e68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# Copyright 2018-2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library.  If not, see <http://www.gnu.org/licenses/>.

from vyos.configtree import ConfigTree


def migrate_neighbor(config, neighbor_path, neighbor):
    if config.exists(neighbor_path):
        neighbors = config.list_nodes(neighbor_path)
        for neighbor in neighbors:
            # Move the valueless options: as-override, next-hop-self, route-reflector-client, route-server-client,
            # remove-private-as
            for valueless_option in ['as-override', 'nexthop-self', 'route-reflector-client', 'route-server-client',
                                     'remove-private-as']:
                if config.exists(neighbor_path + [neighbor, valueless_option]):
                    config.set(neighbor_path + [neighbor] + af_path + [valueless_option])
                    config.delete(neighbor_path + [neighbor, valueless_option])

            # Move filter options: distribute-list, filter-list, prefix-list, and route-map
            # They share the same syntax inside so we can group them
            for filter_type in ['distribute-list', 'filter-list', 'prefix-list', 'route-map']:
                if config.exists(neighbor_path + [neighbor, filter_type]):
                    for filter_dir in ['import', 'export']:
                        if config.exists(neighbor_path + [neighbor, filter_type, filter_dir]):
                            filter_name = config.return_value(neighbor_path + [neighbor, filter_type, filter_dir])
                            config.set(neighbor_path + [neighbor] + af_path + [filter_type, filter_dir], value=filter_name)
                    config.delete(neighbor_path + [neighbor, filter_type])

            # Move simple leaf node options: maximum-prefix, unsuppress-map, weight
            for leaf_option in ['maximum-prefix', 'unsuppress-map', 'weight']:
                if config.exists(neighbor_path + [neighbor, leaf_option]):
                    if config.exists(neighbor_path + [neighbor, leaf_option]):
                        leaf_opt_value = config.return_value(neighbor_path + [neighbor, leaf_option])
                        config.set(neighbor_path + [neighbor] + af_path + [leaf_option], value=leaf_opt_value)
                        config.delete(neighbor_path + [neighbor, leaf_option])

            # The rest is special cases, for better or worse

            # Move allowas-in
            if config.exists(neighbor_path + [neighbor, 'allowas-in']):
                if config.exists(neighbor_path + [neighbor, 'allowas-in', 'number']):
                    allowas_in = config.return_value(neighbor_path + [neighbor, 'allowas-in', 'number'])
                    config.set(neighbor_path + [neighbor] + af_path + ['allowas-in', 'number'], value=allowas_in)
                config.delete(neighbor_path + [neighbor, 'allowas-in'])

            # Move attribute-unchanged options
            if config.exists(neighbor_path + [neighbor, 'attribute-unchanged']):
                for attr in ['as-path', 'med', 'next-hop']:
                    if config.exists(neighbor_path + [neighbor, 'attribute-unchanged', attr]):
                        config.set(neighbor_path + [neighbor] + af_path + ['attribute-unchanged', attr])
                        config.delete(neighbor_path + [neighbor, 'attribute-unchanged', attr])
                config.delete(neighbor_path + [neighbor, 'attribute-unchanged'])

            # Move capability options
            if config.exists(neighbor_path + [neighbor, 'capability']):
                # "capability dynamic" is a peer-global option, we only migrate ORF
                if config.exists(neighbor_path + [neighbor, 'capability', 'orf']):
                    if config.exists(neighbor_path + [neighbor, 'capability', 'orf', 'prefix-list']):
                        for orf in ['send', 'receive']:
                            if config.exists(neighbor_path + [neighbor, 'capability', 'orf', 'prefix-list', orf]):
                                config.set(neighbor_path + [neighbor] + af_path + ['capability', 'orf', 'prefix-list', orf])
                                config.delete(neighbor_path + [neighbor, 'capability', 'orf', 'prefix-list', orf])
                        config.delete(neighbor_path + [neighbor, 'capability', 'orf', 'prefix-list'])
                    config.delete(neighbor_path + [neighbor, 'capability', 'orf'])

            # Move default-originate
            if config.exists(neighbor_path + [neighbor, 'default-originate']):
                if config.exists(neighbor_path + [neighbor, 'default-originate', 'route-map']):
                    route_map = config.return_value(neighbor_path + [neighbor, 'default-originate', 'route-map'])
                    config.set(neighbor_path + [neighbor] + af_path + ['default-originate', 'route-map'], value=route_map)
                else:
                    # Empty default-originate node is meaningful so we re-create it
                    config.set(neighbor_path + [neighbor] + af_path + ['default-originate'])
                config.delete(neighbor_path + [neighbor, 'default-originate'])

            # Move soft-reconfiguration
            if config.exists(neighbor_path + [neighbor, 'soft-reconfiguration']):
                if config.exists(neighbor_path + [neighbor, 'soft-reconfiguration', 'inbound']):
                    config.set(neighbor_path + [neighbor] + af_path + ['soft-reconfiguration', 'inbound'])
                # Empty soft-reconfiguration is meaningless, so we just remove it
                config.delete(neighbor_path + [neighbor, 'soft-reconfiguration'])

            # Move disable-send-community
            if config.exists(neighbor_path + [neighbor, 'disable-send-community']):
                for comm_type in ['standard', 'extended']:
                    if config.exists(neighbor_path + [neighbor, 'disable-send-community', comm_type]):
                        config.set(neighbor_path + [neighbor] + af_path + ['disable-send-community', comm_type])
                        config.delete(neighbor_path + [neighbor, 'disable-send-community', comm_type])
                config.delete(neighbor_path + [neighbor, 'disable-send-community'])


def migrate(config: ConfigTree) -> None:
    if not config.exists(['protocols', 'bgp']):
        # Nothing to do
        return

    # Just to avoid writing it so many times
    af_path = ['address-family', 'ipv4-unicast']

    # Check if BGP is actually configured and obtain the ASN
    asn_list = config.list_nodes(['protocols', 'bgp'])
    if asn_list:
        # There's always just one BGP node, if any
        asn = asn_list[0]
        bgp_path = ['protocols', 'bgp', asn]
    else:
        # There's actually no BGP, just its empty shell
        return

    ## Move global IPv4-specific BGP options to "address-family ipv4-unicast"

    # Move networks
    network_path = ['protocols', 'bgp', asn, 'network']
    if config.exists(network_path):
        config.set(bgp_path + af_path + ['network'])
        config.set_tag(bgp_path + af_path + ['network'])

        networks = config.list_nodes(network_path)
        for network in networks:
            config.set(bgp_path + af_path + ['network', network])
            if config.exists(network_path + [network, 'route-map']):
                route_map = config.return_value(network_path + [network, 'route-map'])
                config.set(bgp_path + af_path + ['network', network, 'route-map'], value=route_map)
        config.delete(network_path)

    # Move aggregate-address statements
    aggregate_path = ['protocols', 'bgp', asn, 'aggregate-address']
    if config.exists(aggregate_path):
        config.set(bgp_path + af_path + ['aggregate-address'])
        config.set_tag(bgp_path + af_path + ['aggregate-address'])

        aggregates = config.list_nodes(aggregate_path)
        for aggregate in aggregates:
            config.set(bgp_path + af_path + ['aggregate-address', aggregate])
            if config.exists(aggregate_path + [aggregate, 'as-set']):
                config.set(bgp_path + af_path + ['aggregate-address', aggregate, 'as-set'])
            if config.exists(aggregate_path + [aggregate, 'summary-only']):
                config.set(bgp_path + af_path + ['aggregate-address', aggregate, 'summary-only'])
        config.delete(aggregate_path)

    ## Migrate neighbor options
    neighbor_path = ['protocols', 'bgp', asn, 'neighbor']
    if config.exists(neighbor_path):
        neighbors = config.list_nodes(neighbor_path)
        for neighbor in neighbors:
            migrate_neighbor(config, neighbor_path, neighbor)

    peer_group_path = ['protocols', 'bgp', asn, 'peer-group']
    if config.exists(peer_group_path):
        peer_groups = config.list_nodes(peer_group_path)
        for peer_group in peer_groups:
            migrate_neighbor(config, peer_group_path, peer_group)

    ## Migrate redistribute statements
    redistribute_path = ['protocols', 'bgp', asn, 'redistribute']
    if config.exists(redistribute_path):
        config.set(bgp_path + af_path + ['redistribute'])

        redistributes = config.list_nodes(redistribute_path)
        for redistribute in redistributes:
            config.set(bgp_path + af_path + ['redistribute', redistribute])
            if config.exists(redistribute_path + [redistribute, 'metric']):
                redist_metric = config.return_value(redistribute_path + [redistribute, 'metric'])
                config.set(bgp_path + af_path + ['redistribute', redistribute, 'metric'], value=redist_metric)
            if config.exists(redistribute_path + [redistribute, 'route-map']):
                redist_route_map = config.return_value(redistribute_path + [redistribute, 'route-map'])
                config.set(bgp_path + af_path + ['redistribute', redistribute, 'route-map'], value=redist_route_map)

        config.delete(redistribute_path)