VPort

VPorts are a new level in the domain hierarchy, intended to provide more granular configuration than at subnet, and also support a split workflow, where the vPort is configured and associated with a VM port (or gateway port) before the port exists.

Overview

active boolean
addressSpoofing enum (DISABLED | ENABLED | INHERITED) required  
associatedFloatingIPID string
associatedMulticastChannelMapID string
associatedSendMulticastChannelMapID string
associatedSSID string
associatedTrunkID string
description string
domainID string
DPI enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
flowCollectionEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
gatewayMACMoveRole enum (SECONDARY | TERTIARY) filterable   orderable  
hasAttachedInterfaces boolean
lastUpdatedBy string autogenerated  
multicast enum (DISABLED | ENABLED | INHERITED) filterable  
multiNICVPortID string
name string required   filterable   orderable  
operationalState enum (DOWN | INIT | UP)
segmentationID integer orderable  
segmentationType enum (VLAN) filterable   orderable  
subType enum (NONE | VNF) filterable   orderable  
systemType enum (HARDWARE | HARDWARE_VTEP | NUAGE_1 | NUAGE_2 | NUAGE_VRSG | SOFTWARE) filterable  
trunkRole enum (PARENT_PORT | SUB_PORT) filterable   orderable  
type enum (BRIDGE | CONTAINER | HOST | VM) required   filterable  
VLANID string
zoneID string

API Resource

/vports/id
delete get put

Parents

/zones/id/vports
get
/overlaymirrordestinations/id/vports
get put
/redirectiontargets/id/vports
get put
/multinicvports/id/vports
get
/subnets/id/vports
get post
/policygroups/id/vports
get put
/trunks/id/vports
get
/vrss/id/vports
get
/domains/id/vports
get
/l2domains/id/vports
get post
/floatingips/id/vports
get

Children

/vports/id/tcas
get post
/vports/id/metadatas
get post
/vports/id/aggregatemetadatas
get
/vports/id/bgpneighbors
get post
/vports/id/egressaclentrytemplates
get
/vports/id/dhcpoptions
get post
/vports/id/virtualips
get post
/vports/id/alarms
get
/vports/id/globalmetadatas
get post put
/vports/id/vms
get
/vports/id/vminterfaces
get post
/vports/id/vnfinterfaces
get
/vports/id/ingressaclentrytemplates
get
/vports/id/ingressadvfwdentrytemplates
get
/vports/id/jobs
get post
/vports/id/containers
get
/vports/id/containerinterfaces
get
/vports/id/portmappings
get
/vports/id/qos
get post
/vports/id/hostinterfaces
get post
/vports/id/vportmirrors
get post
/vports/id/bridgeinterfaces
get post
/vports/id/vrss
get
/vports/id/trunks
get
/vports/id/statistics
get
/vports/id/statisticspolicies
get post
/vports/id/eventlogs
get

Members

/vports/id/redirectiontargets
get put
/vports/id/policygroups
get put
/vports/id/applicationperformancemanagements
get put

Attributes documentation

active boolean
Discussion

Indicates if this vport is up or down

Charateristics

Format: free
SDK attribute: active

addressSpoofing enum required  
Discussion

Indicates if address spoofing is ENABLED/DISABLED/INHERITED for this vport.

Charateristics

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

associatedFloatingIPID string
Discussion

Id of Floating IP address associated to this vport

Charateristics

Format: free
SDK attribute: associatedFloatingIPID

associatedMulticastChannelMapID string
Discussion

The ID of the receive Multicast Channel Map this Vport is associated with. This has to be set when enableMultiCast is set to ENABLED

Charateristics

Format: free
SDK attribute: associatedMulticastChannelMapID

associatedSendMulticastChannelMapID string
Discussion

The ID of the send Multicast Channel Map this Vport is associated with. This has to be set when enableMultiCast is set to ENABLED

Charateristics

Format: free
SDK attribute: associatedSendMulticastChannelMapID

associatedSSID string
Discussion

The UUID of the SSID Connection tied to this instance of a vPort.

Charateristics

Format: free
SDK attribute: associatedSSID

associatedTrunkID string
Discussion

The trunk uuid associated with another vport of trunkRole PARENT_PORT. Can be specified only if trunkRole of this vport is SUB_PORT.

Charateristics

Format: free
SDK attribute: associatedTrunkID

description string
Discussion

Description for this vport

Charateristics

Format: free
SDK attribute: description

domainID string
Discussion

ID the Domain associated with the VPort

Charateristics

Format: free
SDK attribute: domainID

DPI enum filterable   orderable  
Discussion

determines whether or not Deep packet inspection is enabled

Charateristics

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

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

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

gatewayMACMoveRole enum filterable   orderable  
Discussion

Role of the gateway vport when handling mac move errors

Charateristics

Allowed values: SECONDARY, TERTIARY
SDK attribute: gatewayMACMoveRole

hasAttachedInterfaces boolean
Discussion

Indicates that this vport has attached interfaces

Charateristics

Format: free
SDK attribute: hasAttachedInterfaces

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

multicast enum filterable  
Discussion

Indicates multicast policy on Vport.

Charateristics

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

multiNICVPortID string
Discussion

ID of the Multi NIC VPort associated with the VPort

Charateristics

Format: free
SDK attribute: multiNICVPortID

name string required   filterable   orderable  
Discussion

Name of the vport. Valid characters are alphabets, numbers, space and hyphen( - ).

Charateristics

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

operationalState enum
Discussion

Operational State of the VPort. Possible values are INIT, UP, DOWN.

Charateristics

Allowed values: DOWN, INIT, UP
Format: free
SDK attribute: operationalState

segmentationID integer orderable  
Discussion

The VLAN Number (1-4095), valid only if the trunkRole is SUB_PORT

Charateristics

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

segmentationType enum filterable   orderable  
Discussion

The type of segmentation that is used. This must be VLAN for vports with trunkRole set to SUB_PORT. This can not be specified for a parent vport (trunkRole = PARENT_PORT)

Charateristics

Allowed values: VLAN
SDK attribute: segmentationType

subType enum filterable   orderable  
Discussion

Sub type of vport - possible values are NONE/VNF

Charateristics

Allowed values: NONE, VNF
Default value: NONE
SDK attribute: subType

systemType enum filterable  
Discussion

Indicates what system it is.

Charateristics

Allowed values: HARDWARE, HARDWARE_VTEP, NUAGE_1, NUAGE_2, NUAGE_VRSG, SOFTWARE
SDK attribute: systemType

trunkRole enum filterable   orderable  
Discussion

Indicates the role of the vport in trunking operations

Charateristics

Allowed values: PARENT_PORT, SUB_PORT
SDK attribute: trunkRole

type enum required   filterable  
Discussion

Type of vport. Possible values are VM, HOST, BRIDGE, CONTAINER.

Charateristics

Allowed values: BRIDGE, CONTAINER, HOST, VM
SDK attribute: type

VLANID string
Discussion

associated Vlan of this vport - applicable for type host/bridge

Charateristics

Format: free
SDK attribute: VLANID

zoneID string
Discussion

ID the Zone associated with the VPort

Charateristics

Format: free
SDK attribute: zoneID