Skip to content

Topology Group

Topology groups are used to organize and activate or push control policies like custom, hub spoke and mesh created under topology profiles to the SD-WAN controllers. Only one topology group can be active at a time.

A topology profile needs a topology group to be deployed properly, so profiles and groups map one to one: the group has the same name and description as the profile it references.

Topology groups are used to organize and activate or push control policies like custom, hub spoke and mesh created under topology profiles to the SD-WAN controllers. Only one topology group can be active at a time.

Diagram
NameTypeConstraintMandatoryDefault Value
topology_groupsListtopology_groupsNo

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
activateBooleantrue, falseNo
topology_profileStringRegex: ^[^&<>! "]{1,128}$Yes

Example-1: This example demonstrates creating a topology group that references a topology profile and activates it. The topology group name must match the referenced topology profile name. The policy targets SITE_100 and SITE_200 by name; groups and regions from the network hierarchy can be used instead (see the Topology Custom Policy page).

sdwan:
topology_groups:
- name: prod_topology
description: production topology
topology_profile: prod_topology
activate: true
feature_profiles:
topology_profiles:
- name: prod_topology
description: production topology
custom_policies:
- name: route_control
default_action: reject
level: sites
inbound_sites:
- SITE_100
outbound_sites:
- SITE_200
sequences:
- sequence_id: 1
sequence_name: accept_all
base_action: accept
type: route
protocol: ipv4

Note: In the above example, the referenced topology_profile must be defined under sdwan.feature_profiles.topology_profiles with at least one policy (custom_policies, hub_spoke_policies, or mesh_policies). Conversely, every topology profile needs a topology group; define both together, as above.

Example-2: This example demonstrates a topology group with activate set to false (topology is configured but not pushed to controllers).

sdwan:
topology_groups:
- name: staging_topology
description: staging topology
topology_profile: staging_topology
activate: false

Example-1: This example demonstrates creating a topology group that references a topology profile and activates it. The topology group name must match the referenced topology profile name.

sdwan:
topology_groups:
- name: prod_topology
description: production topology
topology_profile: prod_topology
activate: true
feature_profiles:
topology_profiles:
- name: prod_topology
description: production topology
custom_policies:
- name: route_control
default_action: reject
level: sites
inbound_sites:
- SITE_100
outbound_sites:
- SITE_200
sequences:
- sequence_id: 1
sequence_name: accept_all
base_action: accept
type: route
protocol: ipv4

Note: In the above example, the referenced topology_profile must be defined under sdwan.feature_profiles.topology_profiles with at least one policy (custom_policies, hub_spoke_policies, or mesh_policies).

Example-2: This example demonstrates a topology group with activate set to false (topology is configured but not pushed to controllers).

sdwan:
topology_groups:
- name: staging_topology
description: staging topology
topology_profile: staging_topology
activate: false