Trunk

A trunk is used to attach multiple vPorts to a single NIC on a VM. These sub-vPorts are separated by a segmentation identifier (currently the VLAN ID) so the attached VM can distinguish between traffic on the sub-vPorts.

Overview

associatedVPortID string required   creation only  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable  

API Resource

/trunks/id
delete get put

Parents

/enterprises/id/trunks
get post
/vports/id/trunks
get

Children

/trunks/id/permissions
delete get post put
/trunks/id/metadatas
get post
/trunks/id/globalmetadatas
get post put
/trunks/id/vports
get

Members

This object has no members.

Attributes documentation

associatedVPortID string required   creation only  
Discussion

the uuid of the parent vport (the trunkRole of the parent vport must be PARENT_PORT)

Charateristics

Format: free
SDK attribute: associatedVPortID

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable  
Discussion

The name of the trunk

Charateristics

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