Domain

This object is used to manipulate domain state. A domain corresponds to a distributed Virtual Router and Switch.

Overview

advertiseCriteria enum (HUB_ROUTES)
aggregateFlowsEnabled boolean filterable   orderable  
aggregationFlowType enum (PBR_BASED | ROUTE_BASED) filterable   orderable  
associatedBGPProfileID string
associatedIDPProfileID string
associatedMulticastChannelMapID string
associatedPATMapperID string
associatedSharedPATMapperID string
associatedUnderlayID string
backHaulRouteDistinguisher string
backHaulRouteTarget string
backHaulServiceID integer autogenerated  
backHaulVNID integer
BGPEnabled boolean read only   filterable  
color integer
createBackHaulSubnet boolean filterable   orderable  
creationDate string read only   autogenerated   orderable  
customerID integer filterable   orderable  
description string filterable   orderable  
DHCPBehavior enum (CONSUME | FLOOD | OVERLAY_RELAY | UNDERLAY_RELAY)
DHCPServerAddress string
dhcpServerAddresses list
domainAggregationEnabled boolean filterable   orderable  
domainID integer filterable  
domainVLANID integer locally unique  
DPI enum (DISABLED | ENABLED) filterable   orderable  
ECMPCount integer
embeddedMetadata list read only   autogenerated  
encryption enum (DISABLED | ENABLED) filterable   orderable  
enterpriseID string read only  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
EVPNRT5Type enum (IP | MAC)
exportRouteTarget string filterable   orderable  
externalID string filterable   orderable   locally unique  
externalLabel string filterable   orderable  
fecEnabled boolean filterable   orderable  
FIPIgnoreDefaultRoute enum (DISABLED | ENABLED) filterable   orderable  
FIPUnderlay boolean filterable   orderable  
flowCollectionEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
flowCount integer filterable   orderable  
flowLimitEnabled enum (DISABLED | ENABLED) filterable   orderable  
flowSetupRate integer filterable   orderable  
flowSetupRateLimitEnabled enum (DISABLED | ENABLED) filterable   orderable  
globalRoutingEnabled boolean filterable  
GRTEnabled boolean filterable   orderable  
importRouteTarget string filterable   orderable  
IPv4IBGPMaxPaths integer required   orderable  
IPv6IBGPMaxPaths integer required   orderable  
l2DomainAggregationEnabled boolean creation only   filterable   orderable  
labelID integer read only   filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
leakingEnabled boolean filterable  
localAS integer
loopbackIntfDescription string orderable  
loopbackIntfEnabled boolean
loopbackIntfId integer locally unique  
loopbackIntfIPv4Address string
loopbackIntfIPv6Address string
maintenanceMode enum (DISABLED | ENABLED)
multicast enum (DISABLED | ENABLED | INHERITED) filterable  
name string required   filterable   orderable  
owner string autogenerated  
PATEnabled enum (DISABLED | ENABLED) filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
policyChangeStatus enum (APPLIED | DISCARDED | STARTED) filterable  
routeDistinguisher string filterable   orderable  
routeTarget string filterable   orderable  
secondaryDHCPServerAddress string
secondaryRouteTarget string read only   autogenerated   filterable   orderable   locally unique  
serviceID integer autogenerated   filterable   orderable  
stretched boolean
templateID string required  
threatIntelligenceEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
tunnelType enum (DC_DEFAULT | GRE | MPLSoUDP | VLAN | VXLAN)
underlayEnabled enum (DISABLED | ENABLED) filterable   orderable  
uplinkPreference enum (PRIMARY | PRIMARY_SECONDARY | SECONDARY | SECONDARY_PRIMARY | SYMMETRIC)
VXLANECMPEnabled boolean filterable   orderable  

API Resource

/domains/id
delete get put

Parents

/enterprises/id/domains
get post
/domains
get
/firewallacls/id/domains
get put
/netconfgateways/id/domains
get
/domains/id/domains
get put
/gateways/id/domains
get
/aggregateddomains/id/domains
get put
/domaintemplates/id/domains
get put
/ethernetsegmentgwgroups/id/domains
get

Children

/domains/id/tcas
get post
/domains/id/redirectiontargets
get post
/domains/id/deploymentfailures
get
/domains/id/permissions
get post
/domains/id/metadatas
get post
/domains/id/networkperformancebindings
get post
/domains/id/pgexpressions
get post
/domains/id/egressaclentrytemplates
get
/domains/id/egressacltemplates
get post
/domains/id/egressadvfwdtemplates
get post
/domains/id/egressauditaclentrytemplates
get
/domains/id/egressauditacltemplates
get post
/domains/id/egressdomainfloatingipacltemplates
get post
/domains/id/dhcpoptions
get post
/domains/id/dhcpv6options
get post
/domains/id/links
get post put
/domains/id/firewallacls
get
/domains/id/mirrordestinationgroups
get post
/domains/id/virtualfirewallpolicies
get post
/domains/id/virtualfirewallrules
get
/domains/id/alarms
get
/domains/id/floatingips
get post
/domains/id/globalmetadatas
get post put
/domains/id/vms
get
/domains/id/vminterfaces
get
/domains/id/vnfdomainmappings
get post
/domains/id/ingressaclentrytemplates
get post
/domains/id/ingressacltemplates
get post
/domains/id/ingressadvfwdtemplates
get post
/domains/id/ingressauditaclentrytemplates
get
/domains/id/ingressauditacltemplates
get post
/domains/id/jobs
post
/domains/id/policygroups
get post
/domains/id/domaintemplates
get put
/domains/id/zones
get post
/domains/id/containers
get
/domains/id/containerinterfaces
get
/domains/id/forwardingpathlists
get post
/domains/id/qos
get post
/domains/id/hostinterfaces
get
/domains/id/routingpolicies
get post
/domains/id/routingpolicyassociations
get post
/domains/id/routingpolicybindings
get post
/domains/id/spatsourcespools
get post put
/domains/id/uplinkroutedistinguishers
get
/domains/id/vpnconnections
get post
/domains/id/vports
get
/domains/id/applications
get
/domains/id/applicationperformancemanagementbindings
get post
/domains/id/bridgeinterfaces
get
/domains/id/groups
get put
/domains/id/nsgatewayssummaries
get
/domains/id/nsgroutingpolicybindings
get post
/domains/id/ospfinstances
get post
/domains/id/staticroutes
get post
/domains/id/statistics
get
/domains/id/statisticspolicies
get post
/domains/id/subnets
get
/domains/id/eventlogs
get

Members

/domains/id/gateways
get
/domains/id/netconfgateways
get put
/domains/id/networkmacrogroups
get put
/domains/id/aggregateddomains
get put
/domains/id/domains
get put

Attributes documentation

advertiseCriteria enum
Discussion

Set this attribute to allow the spoke domain routes to be leaked into the hub domain.

Charateristics

Allowed values: HUB_ROUTES
SDK attribute: advertiseCriteria

aggregateFlowsEnabled boolean filterable   orderable  
Discussion

Flag to enable aggregate flows on this domain.

Charateristics

Default value: false
SDK attribute: aggregateFlowsEnabled

aggregationFlowType enum filterable   orderable  
Discussion

Indicates type of Aggregation Flow.

Charateristics

Allowed values: PBR_BASED, ROUTE_BASED
SDK attribute: aggregationFlowType

associatedBGPProfileID string
Discussion

None

Charateristics

Format: free
SDK attribute: associatedBGPProfileID

associatedIDPProfileID string
Discussion

The associated IDP Profile ID

Charateristics

Format: free
SDK attribute: associatedIDPProfileID

associatedMulticastChannelMapID string
Discussion

The ID of the Multi Cast Channel Map this domain is associated with. This has to be set when enableMultiCast is set to ENABLED

Charateristics

Format: free
SDK attribute: associatedMulticastChannelMapID

associatedPATMapperID string
Discussion

The ID of the PatMapper entity to which this l3-domain is associated to.

Charateristics

Format: free
SDK attribute: associatedPATMapperID

associatedSharedPATMapperID string
Discussion

The ID of the PatMapper entity to which this SharedNetworkResource is associated to.

Charateristics

Format: free
SDK attribute: associatedSharedPATMapperID

associatedUnderlayID string
Discussion

The ID of the Underlay entity to which this L3 Domain is associated.

Charateristics

Format: free
SDK attribute: associatedUnderlayID

backHaulRouteDistinguisher string
Discussion

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]

Charateristics

Format: free
SDK attribute: backHaulRouteDistinguisher

backHaulRouteTarget string
Discussion

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]

Charateristics

Format: free
SDK attribute: backHaulRouteTarget

backHaulServiceID integer autogenerated  
Discussion

The backhaul serviceID of the Virtual Router created in VSC and is associated with this object. This is auto-generated by VSD

Charateristics

Min value: 20001
Max value: 2147483648
SDK attribute: backHaulServiceID

backHaulVNID integer
Discussion

Current backhaul network's globally unique VXLAN network identifier

Charateristics

Format: free
Min value: 1
Max value: 16777215
SDK attribute: backHaulVNID

BGPEnabled boolean read only   filterable  
Discussion

Read only flag to display if BGP is enabled for this domain

Charateristics

SDK attribute: BGPEnabled

color integer
Discussion

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.

Charateristics

Default value: 0
Max value: 4294967295
SDK attribute: color

createBackHaulSubnet boolean filterable   orderable  
Discussion

Determines if BackHaul Subnet should be created or not.

Charateristics

Default value: true
SDK attribute: createBackHaulSubnet

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

customerID integer filterable   orderable  
Discussion

The customerID that is created in the VSC and identifies this dVRS. This is auto-generated by VSD

Charateristics

Format: free
SDK attribute: customerID

description string filterable   orderable  
Discussion

A description string of the domain that is provided by the user

Charateristics

Format: free
Max length: 255
SDK attribute: description

DHCPBehavior enum
Discussion

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.

Charateristics

Allowed values: CONSUME, FLOOD, OVERLAY_RELAY, UNDERLAY_RELAY
SDK attribute: DHCPBehavior

DHCPServerAddress string
Discussion

when DHCPBehaviorType is RELAY, then DHCP Server IP Address needs to be set

Charateristics

Format: free
SDK attribute: DHCPServerAddress

dhcpServerAddresses list
Discussion

when DHCPBehaviorType is RELAY, then DHCP Server IP Address needs to be set

Charateristics

Format: free
SDK attribute: dhcpServerAddresses

domainAggregationEnabled boolean filterable   orderable  
Discussion

Indicates if this Domain Aggregation is enabled on this Domain.

Charateristics

Default value: false
SDK attribute: domainAggregationEnabled

domainID integer filterable  
Discussion

A unique 20-bitID editable however could be auto-generated by VSD.

Charateristics

Min value: 1
Max value: 1048575
SDK attribute: domainID

domainVLANID integer locally unique  
Discussion

None

Charateristics

SDK attribute: domainVLANID

DPI enum filterable   orderable  
Discussion

determines whether or not Deep packet inspection is enabled

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: DPI

ECMPCount integer
Discussion

Domain specific Equal-cost multi-path routing count, ECMPCount = 1 means no ECMP

Charateristics

Format: free
Min value: 1
Max value: 8
SDK attribute: ECMPCount

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

encryption enum filterable   orderable  
Discussion

Determines whether IPSEC is enabled Possible values are ENABLED, DISABLED.

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: encryption

enterpriseID string read only  
Discussion

Enterprise ID

Charateristics

Format: free
SDK attribute: enterpriseID

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

EVPNRT5Type enum
Discussion

Determines whether EVPN-RT5 are enabled on this domain.

Charateristics

Allowed values: IP, MAC
Default value: IP
SDK attribute: EVPNRT5Type

exportRouteTarget string filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: exportRouteTarget

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

externalLabel string filterable   orderable  
Discussion

External label given to Domain

Charateristics

Format: free
Min length: 1
Max length: 32
SDK attribute: externalLabel

fecEnabled boolean filterable   orderable  
Discussion

Indicates if FEC (Forward Error Correction) is enabled on this Domain.

Charateristics

Default value: false
SDK attribute: fecEnabled

FIPIgnoreDefaultRoute enum filterable   orderable  
Discussion

Determines whether the default Overlay route will be ignored or not when a VM has FIP so that it takes Underlay route.

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: FIPIgnoreDefaultRoute

FIPUnderlay boolean filterable   orderable  
Discussion

Boolean flag to indicate whether this is a Floating IP to underlay domain or not

Charateristics

Default value: false
SDK attribute: FIPUnderlay

flowCollectionEnabled enum filterable   orderable  
Discussion

Determines whether or not flow collection is enabled.

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: flowCollectionEnabled

flowCount integer filterable   orderable  
Discussion

Maximum number of data flows allowed for a VPort.

Charateristics

Min value: 1
Max value: 500000
SDK attribute: flowCount

flowLimitEnabled enum filterable   orderable  
Discussion

Indicates if flow limit is enabled on this Domain. Possible values are ENABLED or DISABLED.

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: flowLimitEnabled

flowSetupRate integer filterable   orderable  
Discussion

Committed flow setup rate in pps for a VPort. Applicable when flow setup rate limit is ENABLED.

Charateristics

Default value: 1000
Min value: 1
Max value: 40000
SDK attribute: flowSetupRate

flowSetupRateLimitEnabled enum filterable   orderable  
Discussion

Indicates if flow setup rate limit is enabled on this Domain. Possible values are ENABLED or DISABLED.

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: flowSetupRateLimitEnabled

globalRoutingEnabled boolean filterable  
Discussion

Indicates if this domain is a globally routable domain or not - boolean true/false

Charateristics

SDK attribute: globalRoutingEnabled

GRTEnabled boolean filterable   orderable  
Discussion

Determines if GRT is enabled on this domain.

Charateristics

Default value: false
SDK attribute: GRTEnabled

importRouteTarget string filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: importRouteTarget

IPv4IBGPMaxPaths integer required   orderable  
Discussion

IPv4 IBGP Max Paths. Applicable for third-party Netconf Gateways only

Charateristics

Default value: 1
Min value: 1
Max value: 64
SDK attribute: IPv4IBGPMaxPaths

IPv6IBGPMaxPaths integer required   orderable  
Discussion

IPv6 IBGP Max Paths. Applicable for third-party Netconf Gateways only

Charateristics

Default value: 1
Min value: 1
Max value: 64
SDK attribute: IPv6IBGPMaxPaths

l2DomainAggregationEnabled boolean creation only   filterable   orderable  
Discussion

Indicates if L2 Domain Aggregation is enabled on this Domain.

Charateristics

Default value: false
SDK attribute: l2DomainAggregationEnabled

labelID integer read only   filterable   orderable  
Discussion

The label associated with the dVRS. This is a read only attribute

Charateristics

Format: free
SDK attribute: labelID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

leakingEnabled boolean filterable  
Discussion

Indicates if this domain is a leakable domain or not - boolean true/false

Charateristics

SDK attribute: leakingEnabled

localAS integer
Discussion

Local autonomous system for the domain

Charateristics

Format: free
Min value: 1
Max value: 4294967295
SDK attribute: localAS

loopbackIntfDescription string orderable  
Discussion

Loopback Interface description.

Charateristics

Format: free
Max length: 255
SDK attribute: loopbackIntfDescription

loopbackIntfEnabled boolean
Discussion

Indicates if Loopback interface is enabled or not. Applicable for third-party Netconf Gateways only.

Charateristics

Default value: false
SDK attribute: loopbackIntfEnabled

loopbackIntfId integer locally unique  
Discussion

Loopback interface ID of domain.

Charateristics

Max value: 1023
SDK attribute: loopbackIntfId

loopbackIntfIPv4Address string
Discussion

Loopback interface IPv4 Host Address.

Charateristics

Format: free
Max length: 255
SDK attribute: loopbackIntfIPv4Address

loopbackIntfIPv6Address string
Discussion

Loopback interface IPv6 Host Address.

Charateristics

Format: free
Max length: 255
SDK attribute: loopbackIntfIPv6Address

maintenanceMode enum
Discussion

Enum that indicates if the Domain is accepting VM activation requests. Possible values are DISABLED, ENABLED.

Charateristics

Allowed values: DISABLED, ENABLED
SDK attribute: maintenanceMode

multicast enum filterable  
Discussion

multicast is enum that indicates multicast policy on domain. Possible values are ENABLED ,DISABLED and INHERITED Possible values are INHERITED, ENABLED, DISABLED, .

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Format: free
SDK attribute: multicast

name string required   filterable   orderable  
Discussion

The name of the domain. Valid characters are alphabets, numbers, space and hyphen( - ).

Charateristics

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

PATEnabled enum filterable   orderable  
Discussion

Indicates whether PAT is enabled for the subnets in this domain - ENABLED/DISABLED Possible values are ENABLED, DISABLED.

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: PATEnabled

permittedAction enum
Discussion

The permitted action to USE/DEPLOY for the Domain Possible values are USE, READ, ALL, INSTANTIATE, EXTEND, DEPLOY, .

Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
Format: free
SDK attribute: permittedAction

policyChangeStatus enum filterable  
Discussion

None

Charateristics

Allowed values: APPLIED, DISCARDED, STARTED
Format: free
SDK attribute: policyChangeStatus

routeDistinguisher string filterable   orderable  
Discussion

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]

Charateristics

Format: free
Max length: 255
SDK attribute: routeDistinguisher

routeTarget string filterable   orderable  
Discussion

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]

Charateristics

Format: free
Max length: 255
SDK attribute: routeTarget

secondaryDHCPServerAddress string
Discussion

when DHCPBehaviorType is RELAY, then DHCP Server IP Address needs to be set

Charateristics

Format: free
SDK attribute: secondaryDHCPServerAddress

secondaryRouteTarget string read only   autogenerated   filterable   orderable   locally unique  
Discussion

Secondary route target associated with the dVRS. It is a parameter that is auto-managed by VSD. System generates this identifier automatically.

Charateristics

Format: free
Max length: 255
SDK attribute: secondaryRouteTarget

serviceID integer autogenerated   filterable   orderable  
Discussion

The serviceID of the Virtual Router created in VSC and is associated with this object. This is auto-generated by VSD

Charateristics

Min value: 1
SDK attribute: serviceID

stretched boolean
Discussion

Indicates whether this domain is stretched, if so, remote VM resolutions will be allowed

Charateristics

SDK attribute: stretched

templateID string required  
Discussion

The ID of the template that this domain was created from. This should be set when instantiating a domain

Charateristics

Format: free
SDK attribute: templateID

threatIntelligenceEnabled enum filterable   orderable  
Discussion

Determines whether or not threat intelligence is enabled

Charateristics

Allowed values: DISABLED, ENABLED, INHERITED
Default value: INHERITED
SDK attribute: threatIntelligenceEnabled

tunnelType enum
Discussion

Default Domain Tunnel Type

Charateristics

Allowed values: DC_DEFAULT, GRE, MPLSoUDP, VLAN, VXLAN
SDK attribute: tunnelType

underlayEnabled enum filterable   orderable  
Discussion

Indicates whether UNDERLAY is enabled for the subnets in this domain

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: underlayEnabled

uplinkPreference enum
Discussion

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, .

Charateristics

Allowed values: PRIMARY, PRIMARY_SECONDARY, SECONDARY, SECONDARY_PRIMARY, SYMMETRIC
Format: free
SDK attribute: uplinkPreference

VXLANECMPEnabled boolean filterable   orderable  
Discussion

Determines whether VXLAN-ECMP are enabled on this domain.

Charateristics

Default value: false
SDK attribute: VXLANECMPEnabled