This object is used to manipulate domain state. A domain corresponds to a distributed Virtual Router and Switch.
Set this attribute to allow the spoke domain routes to be leaked into the hub domain.
Allowed values: HUB_ROUTES
SDK attribute: advertiseCriteria
Flag to enable aggregate flows on this domain.
Default value: false
SDK attribute: aggregateFlowsEnabled
Indicates type of Aggregation Flow.
Allowed values: PBR_BASED, ROUTE_BASED
SDK attribute: aggregationFlowType
None
Format: free
SDK attribute: associatedBGPProfileID
The associated IDP Profile ID
Format: free
SDK attribute: associatedIDPProfileID
The ID of the Multi Cast Channel Map this domain is associated with. This has to be set when enableMultiCast is set to ENABLED
Format: free
SDK attribute: associatedMulticastChannelMapID
The ID of the PatMapper entity to which this l3-domain is associated to.
Format: free
SDK attribute: associatedPATMapperID
The ID of the Underlay entity to which this L3 Domain is associated.
Format: free
SDK attribute: associatedUnderlayID
Route distinguisher associated with the backhaul service in dVRS. If not provided, system generates this identifier automatically. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]
Format: free
SDK attribute: backHaulRouteDistinguisher
Route target associated with the backhaul service in dVRS. If not provided, system generates this identifier automatically. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]
Format: free
SDK attribute: backHaulRouteTarget
The backhaul serviceID of the Virtual Router created in VSC and is associated with this object. This is auto-generated by VSD
Min value: 20001
Max value: 2147483648
SDK attribute: backHaulServiceID
Current backhaul network's globally unique VXLAN network identifier
Format: free
Min value: 1
Max value: 16777215
SDK attribute: backHaulVNID
Read only flag to display if BGP is enabled for this domain
SDK attribute: BGPEnabled
The color encoded with a traffic engineering constraint such as minimum latency, hops, maximum bandwidth, etc. This is used for NFIX(Network Function Interconnect). Color is applicable only when the selected Tunnel Type is MPLSoUDP. Valid range is 1 - 4294967295. 0 for other Tunnel Types.
Default value: 0
Max value: 4294967295
SDK attribute: color
Determines if BackHaul Subnet should be created or not.
Default value: true
SDK attribute: createBackHaulSubnet
Time stamp when this object was created.
SDK attribute: creationDate
The customerID that is created in the VSC and identifies this dVRS. This is auto-generated by VSD
Format: free
SDK attribute: customerID
A description string of the domain that is provided by the user
Format: free
Max length: 255
SDK attribute: description
DHCPBehaviorType is an enum that indicates DHCP Behavior of VRS having VM's under this domain. Possible values are FLOOD, CONSUME, OVERLAY_RELAY, UNDERLAY_RELAY.
Allowed values: CONSUME, FLOOD, OVERLAY_RELAY, UNDERLAY_RELAY
SDK attribute: DHCPBehavior
when DHCPBehaviorType is RELAY, then DHCP Server IP Address needs to be set
Format: free
SDK attribute: DHCPServerAddress
when DHCPBehaviorType is RELAY, then DHCP Server IP Address needs to be set
Format: free
SDK attribute: dhcpServerAddresses
Indicates if this Domain Aggregation is enabled on this Domain.
Default value: false
SDK attribute: domainAggregationEnabled
A unique 20-bitID editable however could be auto-generated by VSD.
Min value: 1
Max value: 1048575
SDK attribute: domainID
None
SDK attribute: domainVLANID
determines whether or not Deep packet inspection is enabled
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: DPI
Domain specific Equal-cost multi-path routing count, ECMPCount = 1 means no ECMP
Format: free
Min value: 1
Max value: 8
SDK attribute: ECMPCount
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.
SDK attribute: embeddedMetadata
Determines whether IPSEC is enabled Possible values are ENABLED, DISABLED.
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: encryption
Enterprise ID
Format: free
SDK attribute: enterpriseID
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
Determines whether EVPN-RT5 are enabled on this domain.
Allowed values: IP, MAC
Default value: IP
SDK attribute: EVPNRT5Type
Route target associated with the dVRS. It is an optional parameterthat can be provided by the user or auto-managed by VSDSystem generates this identifier automatically, if not provided
Format: free
SDK attribute: exportRouteTarget
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
External label given to Domain
Format: free
Min length: 1
Max length: 32
SDK attribute: externalLabel
Indicates if FEC (Forward Error Correction) is enabled on this Domain.
Default value: false
SDK attribute: fecEnabled
Determines whether the default Overlay route will be ignored or not when a VM has FIP so that it takes Underlay route.
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: FIPIgnoreDefaultRoute
Boolean flag to indicate whether this is a Floating IP to underlay domain or not
Default value: false
SDK attribute: FIPUnderlay
Determines whether or not flow collection is enabled.
Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: flowCollectionEnabled
Maximum number of data flows allowed for a VPort.
Min value: 1
Max value: 500000
SDK attribute: flowCount
Indicates if flow limit is enabled on this Domain. Possible values are ENABLED or DISABLED.
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: flowLimitEnabled
Committed flow setup rate in pps for a VPort. Applicable when flow setup rate limit is ENABLED.
Default value: 1000
Min value: 1
Max value: 40000
SDK attribute: flowSetupRate
Indicates if flow setup rate limit is enabled on this Domain. Possible values are ENABLED or DISABLED.
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: flowSetupRateLimitEnabled
Indicates if this domain is a globally routable domain or not - boolean true/false
SDK attribute: globalRoutingEnabled
Determines if GRT is enabled on this domain.
Default value: false
SDK attribute: GRTEnabled
Route distinguisher associated with the dVRS. It is an optional parameter that can be provided by the user or auto-managed by VSD. System generates this identifier automatically, if not provided
Format: free
SDK attribute: importRouteTarget
The label associated with the dVRS. This is a read only attribute
Format: free
SDK attribute: labelID
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Time stamp when this object was last updated.
SDK attribute: lastUpdatedDate
Indicates if this domain is a leakable domain or not - boolean true/false
SDK attribute: leakingEnabled
Local autonomous system for the domain
Format: free
Min value: 1
Max value: 4294967295
SDK attribute: localAS
Enum that indicates if the Domain is accepting VM activation requests. Possible values are DISABLED, ENABLED.
Allowed values: DISABLED, ENABLED
SDK attribute: maintenanceMode
multicast is enum that indicates multicast policy on domain. Possible values are ENABLED ,DISABLED and INHERITED Possible values are INHERITED, ENABLED, DISABLED, .
Allowed values: DISABLED, ENABLED, INHERITED
Format: free
SDK attribute: multicast
The name of the domain. Valid characters are alphabets, numbers, space and hyphen( - ).
Format: free
Min length: 1
Max length: 64
SDK attribute: name
Identifies the user that has created this object.
Format: free
SDK attribute: owner
Indicates whether PAT is enabled for the subnets in this domain - ENABLED/DISABLED Possible values are ENABLED, DISABLED.
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: PATEnabled
The permitted action to USE/DEPLOY for the Domain Possible values are USE, READ, ALL, INSTANTIATE, EXTEND, DEPLOY, .
Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
Format: free
SDK attribute: permittedAction
None
Allowed values: APPLIED, DISCARDED, STARTED
Format: free
SDK attribute: policyChangeStatus
Route distinguisher associated with the dVRS. If not provided, system generates this identifier automatically. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]
Format: free
Max length: 255
SDK attribute: routeDistinguisher
Route target associated with the dVRS. If not provided, system generates this identifier automatically. Supported formats are: [2-byte ASN]:[4-byte value] or [4-byte ASN]:[2-byte value]
Format: free
Max length: 255
SDK attribute: routeTarget
when DHCPBehaviorType is RELAY, then DHCP Server IP Address needs to be set
Format: free
SDK attribute: secondaryDHCPServerAddress
Secondary route target associated with the dVRS. It is a parameter that is auto-managed by VSD. System generates this identifier automatically.
Format: free
Max length: 255
SDK attribute: secondaryRouteTarget
The serviceID of the Virtual Router created in VSC and is associated with this object. This is auto-generated by VSD
Min value: 1
SDK attribute: serviceID
Indicates whether this domain is streched,if so remote VM resolutions will be allowed
SDK attribute: stretched
The ID of the template that this domain was created from. This should be set when instantiating a domain
Format: free
SDK attribute: templateID
Determines whether or not threat intelligence is enabled
Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: threatIntelligenceEnabled
Default Domain Tunnel Type
Allowed values: DC_DEFAULT, GRE, MPLSoUDP, VLAN, VXLAN
SDK attribute: tunnelType
Indicates whether UNDERLAY is enabled for the subnets in this domain
Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: underlayEnabled
Indicates the preferencial path selection for network traffic in this domain - Default is Primary 1 and Secondary 2. Possible values are PRIMARY_SECONDARY, SECONDARY_PRIMARY, PRIMARY, SECONDARY, SYMMETRIC, .
Allowed values: PRIMARY, PRIMARY_SECONDARY, SECONDARY, SECONDARY_PRIMARY, SYMMETRIC
Format: free
SDK attribute: uplinkPreference
Determines whether VXLAN-ECMP are enabled on this domain.
Default value: false
SDK attribute: VXLANECMPEnabled