Skip to content

Network Hierarchy Region

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

Diagram
NameTypeConstraintMandatoryDefault Value
network_hierarchyClassnetwork_hierarchyNo

NameTypeConstraintMandatoryDefault Value
regionsListregionsNo

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

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
groupsListgroupsNo
regionsListregionsNo
sitesListsitesNo

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

groups (sdwan.network_hierarchy.regions.groups)

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

regions (sdwan.network_hierarchy.regions.groups)

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

address (sdwan.network_hierarchy.regions.sites)

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

Example-1: Region with a nested group and site

sdwan:
network_hierarchy:
regions:
- name: NA-Region
description: North America region
groups:
- name: NA-Group
sites:
- name: SJ-Site
site_id: 200

This example shows a top-level region containing a nested group, which in turn contains a site.