Skip to content

Network Hierarchy Group

Define groups in the SD-WAN network hierarchy. Groups can nest other groups, regions, and sites. The top-level groups are parented to Global. Supports up to 3 levels of nested groups/regions.

Diagram
NameTypeConstraintMandatoryDefault Value
groupsList[groups]No

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
groupsList[groups]No
regionsList[regions]No
sitesList[sites]No

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
groupsList[groups]No
regionsList[regions]No
sitesList[sites]No

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
groupsList[groups]No
sitesList[sites]No

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
addressClass[address]No
latitudeNumberNo
locationStringNo
longitudeNumberNo
site_idIntegermin: 1, max: 4294967295No

groups (sdwan.network_hierarchy.groups.groups)

Section titled “groups (sdwan.network_hierarchy.groups.groups)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
sitesList[sites]No

regions (sdwan.network_hierarchy.groups.groups)

Section titled “regions (sdwan.network_hierarchy.groups.groups)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
sitesList[sites]No

address (sdwan.network_hierarchy.groups.sites)

Section titled “address (sdwan.network_hierarchy.groups.sites)”
NameTypeConstraintMandatoryDefault Value
cityStringNo
countryStringNo
stateStringNo
streetStringNo
zipcodeStringNo

Example-1: Nested groups with regions and sites

sdwan:
network_hierarchy:
groups:
- name: EMEA-Group
description: EMEA group
regions:
- name: EMEA-Region
description: EMEA region
sites:
- name: London-Site
site_id: 100
groups:
- name: EMEA-UK-Group
description: EMEA UK group

This example shows a top-level group containing a nested region (with a site) and a nested child group.