VNFDomainMapping

This represents domain segment identifier which is unique for domain per NSGateway.

Overview

associatedDomainID string read only   autogenerated  
associatedDomainName string read only  
associatedEnterpriseID string read only  
associatedNSGatewayID string
associatedNSGatewayName string
autoCreated boolean read only   autogenerated  
embeddedMetadata list read only   autogenerated  
enterpriseName string read only   filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
segmentationID integer creation only  
segmentationType enum (VLAN) creation only  
serviceId string read only   autogenerated  

API Resource

/vnfdomainmappings/id
delete get

Parents

/domains/id/vnfdomainmappings
get post
/aggregateddomains/id/vnfdomainmappings
get post

Children

/vnfdomainmappings/id/metadatas
get post
/vnfdomainmappings/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedDomainID string read only   autogenerated  
Discussion

ID of the associated Domain

Charateristics

Format: free
SDK attribute: associatedDomainID

associatedDomainName string read only  
Discussion

Name of the associated Domain

Charateristics

Format: free
SDK attribute: associatedDomainName

associatedEnterpriseID string read only  
Discussion

ID of the associated Enterprise

Charateristics

Format: free
SDK attribute: associatedEnterpriseID

associatedNSGatewayID string
Discussion

Associated NS Gateway

Charateristics

Format: free
SDK attribute: associatedNSGatewayID

associatedNSGatewayName string
Discussion

Name of associated NSGateway

Charateristics

Format: free
SDK attribute: associatedNSGatewayName

autoCreated boolean read only   autogenerated  
Discussion

Indicates that this domain mapping was auto created by the system

Charateristics

Default value: false
SDK attribute: autoCreated

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

enterpriseName string read only   filterable   orderable  
Discussion

Name of the associated Enterprise

Charateristics

Format: free
Max length: 255
SDK attribute: enterpriseName

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

segmentationID integer creation only  
Discussion

The segmentation ID (1-4095).

Charateristics

Min value: 1
Max value: 4095
SDK attribute: segmentationID

segmentationType enum creation only  
Discussion

The type of segmentation that is used.

Charateristics

Allowed values: VLAN
Default value: VLAN
SDK attribute: segmentationType

serviceId string read only   autogenerated  
Discussion

Service ID of the associated Domain

Charateristics

Format: free
SDK attribute: serviceId