Network Hierarchy Group
Catalyst SD-WANDefine 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
Section titled “Diagram”Classes
Section titled “Classes”network_hierarchy (sdwan)
Section titled “network_hierarchy (sdwan)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| groups | List | [groups] | No |
groups (sdwan.network_hierarchy)
Section titled “groups (sdwan.network_hierarchy)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| groups | List | [groups] | No | |
| regions | List | [regions] | No | |
| sites | List | [sites] | No |
groups (sdwan.network_hierarchy.groups)
Section titled “groups (sdwan.network_hierarchy.groups)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| groups | List | [groups] | No | |
| regions | List | [regions] | No | |
| sites | List | [sites] | No |
regions (sdwan.network_hierarchy.groups)
Section titled “regions (sdwan.network_hierarchy.groups)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| groups | List | [groups] | No | |
| sites | List | [sites] | No |
sites (sdwan.network_hierarchy.groups)
Section titled “sites (sdwan.network_hierarchy.groups)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| address | Class | [address] | No | |
| latitude | Number | No | ||
| location | String | No | ||
| longitude | Number | No | ||
| site_id | Integer | min: 1, max: 4294967295 | No |
groups (sdwan.network_hierarchy.groups.groups)
Section titled “groups (sdwan.network_hierarchy.groups.groups)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| sites | List | [sites] | No |
regions (sdwan.network_hierarchy.groups.groups)
Section titled “regions (sdwan.network_hierarchy.groups.groups)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| sites | List | [sites] | No |
address (sdwan.network_hierarchy.groups.sites)
Section titled “address (sdwan.network_hierarchy.groups.sites)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| city | String | No | ||
| country | String | No | ||
| state | String | No | ||
| street | String | No | ||
| zipcode | String | No |
Examples
Section titled “Examples”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 groupThis example shows a top-level group containing a nested region (with a site) and a nested child group.