DUCGroup

A logical group of 1 or more NSGs of personality NSG-UBR, that are used to provide connectivity between NSGs in disjoint underlays.

Overview

associatedPerformanceMonitorID string
description string filterable   orderable  
ducMeshGroupID integer read only   autogenerated   filterable   orderable   locally unique  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
function enum (GATEWAY | HUB | UBR) filterable  
lastUpdatedBy string autogenerated  
name string filterable   orderable  

API Resource

/ducgroups/id
delete get put

Parents

/ducgroups
get post

Children

/ducgroups/id/metadatas
get post
/ducgroups/id/globalmetadatas
get post put

Members

/ducgroups/id/nsgateways
get post put

Attributes documentation

associatedPerformanceMonitorID string
Discussion

Identification of the Performance Monitoring Probe that is associated with this instance of a UBR Group.

Charateristics

Format: free
SDK attribute: associatedPerformanceMonitorID

description string filterable   orderable  
Discussion

Description of the UBR Group.

Charateristics

Format: free
Max length: 255
SDK attribute: description

ducMeshGroupID integer read only   autogenerated   filterable   orderable   locally unique  
Discussion

Unique Identifier for DUC Group, autogenerated by VSD.

Charateristics

Min value: 4096
Max value: 5120
SDK attribute: ducMeshGroupID

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

function enum filterable  
Discussion

The function of the group

Charateristics

Allowed values: GATEWAY, HUB, UBR
Default value: UBR
SDK attribute: function

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string filterable   orderable  
Discussion

Name given to the UBR Group.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name