Topology Mesh Policy
Catalyst SD-WANConfigure mesh topology policies for full-mesh connectivity between specified sites through target VPNs.
Sites are listed in sites, or by network hierarchy group or region in site_groups. A group expands to every site under it, and a region means the sites under that region. The groups can be declared under sdwan.network_hierarchy (Example-3) or exist only on the SD-WAN Manager; see the note below.
A topology profile needs a topology group with the same name (sdwan.topology_groups, see the Topology Group page) to be deployed properly. The examples include the group with activate: false; set activate: true to push the policies to the controllers.
Configure mesh topology policies for full-mesh connectivity between specified sites through target VPNs.
sites also accepts network hierarchy groups and regions via the paired site_groups key - a group name expands to every site nested under it, unioned with any sites listed directly. See Example-3 and the version note below.
Diagram
Section titled “Diagram”Classes
Section titled “Classes”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| feature_ | Class | feature_ | No |
feature_profiles (sdwan)
Section titled “feature_profiles (sdwan)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| topology_ | List | topology_ | No |
topology_profiles (sdwan.feature_profiles)
Section titled “topology_profiles (sdwan.feature_profiles)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| mesh_policies | List | mesh_policies | No |
mesh_policies (sdwan.feature_profiles.topology_profiles)
Section titled “mesh_policies (sdwan.feature_profiles.topology_profiles)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| lan_vpn_names | List | String[Regex: ^[^&<>! "]{1,128}$] | Yes | |
| sites | List | String | No | |
| site_groups | List | String | No |
Examples
Section titled “Examples”Example-1: This example demonstrates a basic mesh topology connecting three sites with full-mesh connectivity through a single VPN.
sdwan: topology_groups: - name: topology_profile_1 description: mesh topology topology_profile: topology_profile_1 activate: false feature_profiles: topology_profiles: - name: topology_profile_1 description: mesh topology mesh_policies: - name: mesh_basic lan_vpn_names: - service_lan_vpn1 sites: - SITE_100 - SITE_200 - SITE_300Example-2: This example demonstrates a mesh topology spanning multiple VPNs with several sites.
sdwan: topology_groups: - name: topology_profile_2 description: multi vpn mesh topology topology_profile: topology_profile_2 activate: false feature_profiles: topology_profiles: - name: topology_profile_2 description: multi vpn mesh topology mesh_policies: - name: mesh_multi_vpn lan_vpn_names: - service_lan_vpn1 - service_lan_vpn2 sites: - SITE_100 - SITE_200 - SITE_300 - SITE_400Note:
lan_vpn_namesreferences service LAN VPN feature names (not VPN IDs). If a VPN needs renumbering, create a new LAN VPN feature with the desired VPN ID rather than modifying the existing one in-place.
Example-3: This example demonstrates full-mesh targeting by network hierarchy group instead of listing individual sites. CAMPUS is a group declared under sdwan.network_hierarchy that expands to every site nested under it.
sdwan: manager_version: "20.18.4" network_hierarchy: groups: - name: CAMPUS sites: - name: SITE_100 site_id: 100 - name: SITE_200 site_id: 200 - name: SITE_300 site_id: 300 topology_groups: - name: topology_profile_3 description: group-targeted mesh topology topology_profile: topology_profile_3 activate: false feature_profiles: topology_profiles: - name: topology_profile_3 description: group-targeted mesh topology mesh_policies: - name: mesh_by_group lan_vpn_names: - service_lan_vpn1 site_groups: - CAMPUSNote: site targeting and Manager version
- A group in
site_groupsdeclared undersdwan.network_hierarchy, and a site insitesdeclared there, are resolved from the declared hierarchy. A group that is not declared (for example one maintained in the Manager GUI) is looked up on the SD-WAN Manager at plan time, together with any undeclared site names. This needs Manager 20.18 or higher (manager_versionunset or 20.18+), provider 0.11.7 or later and module 1.5.1 or later; withmanager_versionbelow 20.18 an undeclared group fails validation. See “Site targeting, Manager version and the network hierarchy” on the Topology Custom Policy page.- On Manager 20.18 or higher, with a declared hierarchy or an undeclared group, sites are sent as hierarchy UUIDs. An unset
manager_versionis read as 20.18.- Set
manager_versionbelow 20.18 (for example"20.15") to send plain site names, for Managers that predate hierarchy UUIDs.- A
site_groupsentry that has no sites (an empty group, declared or on the Manager) fails the plan, because at least one site must resolve.
Examples
Section titled “Examples”Example-1: This example demonstrates a basic mesh topology connecting three sites with full-mesh connectivity through a single VPN.
sdwan: feature_profiles: topology_profiles: - name: topology_profile_1 description: mesh topology mesh_policies: - name: mesh_basic lan_vpn_names: - service_lan_vpn1 sites: - SITE_100 - SITE_200 - SITE_300Example-2: This example demonstrates a mesh topology spanning multiple VPNs with several sites.
sdwan: feature_profiles: topology_profiles: - name: topology_profile_2 description: multi vpn mesh topology mesh_policies: - name: mesh_multi_vpn lan_vpn_names: - service_lan_vpn1 - service_lan_vpn2 sites: - SITE_100 - SITE_200 - SITE_300 - SITE_400Note:
lan_vpn_namesreferences service LAN VPN feature names (not VPN IDs). If a VPN needs renumbering, create a new LAN VPN feature with the desired VPN ID rather than modifying the existing one in-place.
Example-3: This example demonstrates full-mesh targeting by network hierarchy group instead of listing individual sites. CAMPUS is a group declared under sdwan.network_hierarchy that expands to every site nested under it.
sdwan: manager_version: "20.18.4" network_hierarchy: groups: - name: CAMPUS sites: - name: SITE_100 site_id: 100 - name: SITE_200 site_id: 200 - name: SITE_300 site_id: 300 feature_profiles: topology_profiles: - name: topology_profile_3 description: group-targeted mesh topology mesh_policies: - name: mesh_by_group lan_vpn_names: - service_lan_vpn1 site_groups: - CAMPUSNote: site targeting and Manager version
- A group name in
site_groupsmust be declared as agrouporregionundersdwan.network_hierarchy, and a plain site name insitesmust be declared as asitethere too - directly, or nested under any group/region. An undeclared name fails validation.- When
sdwan.network_hierarchyis declared, every resolved site is sent as a network hierarchy UUID on Manager 20.18.1 and later. An unsetmanager_versionis treated as 20.18.1+.- Set
manager_versionbelow 20.18 (e.g."20.15") to send plain site names on the wire instead, for Managers that predate hierarchy UUIDs.manager_versionis required wheneversdwan.network_hierarchyis declared - validation rejects the combination of a declared hierarchy and an unset version.- A
site_groupsentry that expands to no sites (an empty group) fails the plan - at least one site must resolve.