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

accessRestrictionEnabled boolean filterable   orderable  
active boolean
addressSpoofing enum (DISABLED | ENABLED | INHERITED) required  
assocEntityID string filterable  
associatedEgressProfileID string filterable   orderable  
associatedFloatingIPID string
associatedGatewayID string read only   filterable   orderable  
associatedGatewayPersonality enum (DC7X50 | EVDF | EVDFB | HARDWARE_VTEP | NETCONF_7X50 | NETCONF_THIRDPARTY_HW_VTEP | NSG | NSGBR | NSGDUC | NUAGE_210_WBX_32_Q | NUAGE_210_WBX_48_S | OTHER | SR_LINUX | UNMANAGED_GATEWAY | VDF | VDFG | VRSB | VRSG | VSA | VSG) read only   filterable   orderable  
associatedGatewayType string read only  
associatedIngressProfileID string filterable   orderable  
associatedMulticastChannelMapID string
associatedSecondaryFIPID string
associatedSendMulticastChannelMapID string
associatedSSID string
associatedTrunkID string
autoCreated boolean read only  
backhaulSubnetVNID integer read only   autogenerated  
color integer
creationDate string read only   autogenerated   orderable  
description string
domainID string
domainName string read only  
domainServiceLabel string
domainVLANID integer read only  
DPI enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
esGroupVPortInfos list read only   filterable   orderable  
externalID string filterable   orderable   locally unique  
FIPIgnoreDefaultRoute enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
flowCount integer filterable   orderable  
flowLimitEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
flowSetupRate integer filterable   orderable  
flowSetupRateLimitEnabled enum (DISABLED | ENABLED | INHERITED) filterable   orderable  
gatewayMACMoveRole enum (SECONDARY | TERTIARY)
gatewayPortName string
gwEligible boolean read only   filterable   orderable  
hasAttachedInterfaces boolean
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
multicast enum (DISABLED | ENABLED | INHERITED) filterable  
multiNICVPortID string
name string required   filterable   orderable  
operationalState enum (DEGRADED | DOWN | INIT | UP)
owner string autogenerated  
peerOperationalState enum (DOWN | INIT | UP)
routed boolean read only  
segmentationID integer
segmentationType enum (VLAN)
serviceID integer
subnetVNID integer read only  
subType enum (NONE | VNF) read only   filterable  
systemType enum (HARDWARE | HARDWARE_VTEP | NUAGE_1 | NUAGE_2 | NUAGE_VRSG | SOFTWARE) filterable  
trunkRole enum (PARENT_PORT | SUB_PORT) read only   filterable  
type enum (BRIDGE | CONTAINER | HOST | VM) required   filterable  
VLAN integer read only  
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
/egressprofiles/id/vports
get
/floatingips/id/vports
get
/domains/id/vports
get
/l2domains/id/vports
get post
/aggregateddomains/id/vports
get
/ingressprofiles/id/vports
get

Children

/vports/id/tcas
get post
/vports/id/scheduledtestsuiteruns
get post
/vports/id/deploymentfailures
get post put
/vports/id/permissions
delete get post put
/vports/id/testsuiteruns
delete 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/dhcpv6options
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

Attributes documentation

accessRestrictionEnabled boolean filterable   orderable  
Discussion

Enable Access Restriction

Charateristics

Default value: false
SDK attribute: accessRestrictionEnabled

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
SDK attribute: addressSpoofing

assocEntityID string filterable  
Discussion

UUID of the entity to which the vport is associated to. This could be UUID of a SUBNET or a L2DOMAIN

Charateristics

Format: free
SDK attribute: assocEntityID

associatedEgressProfileID string filterable   orderable  
Discussion

UUID of the Egress Profile associated with this Vport entity.

Charateristics

Format: free
SDK attribute: associatedEgressProfileID

associatedFloatingIPID string
Discussion

Id of Floating IP address associated to this VPort

Charateristics

Format: free
SDK attribute: associatedFloatingIPID

associatedGatewayID string read only   filterable   orderable  
Discussion

Associated gateway ID of VPort

Charateristics

Format: free
SDK attribute: associatedGatewayID

associatedGatewayPersonality enum read only   filterable   orderable  
Discussion

Personality of the associated Gateway

Charateristics

Allowed values: DC7X50, EVDF, EVDFB, HARDWARE_VTEP, NETCONF_7X50, NETCONF_THIRDPARTY_HW_VTEP, NSG, NSGBR, NSGDUC, NUAGE_210_WBX_32_Q, NUAGE_210_WBX_48_S, OTHER, SR_LINUX, UNMANAGED_GATEWAY, VDF, VDFG, VRSB, VRSG, VSA, VSG
SDK attribute: associatedGatewayPersonality

associatedGatewayType string read only  
Discussion

Associated gateway type of VPort.

Charateristics

SDK attribute: associatedGatewayType

associatedIngressProfileID string filterable   orderable  
Discussion

UUID of the Ingress Profile associated with this Vport entity.

Charateristics

Format: free
SDK attribute: associatedIngressProfileID

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

associatedSecondaryFIPID string
Discussion

ID of Secondary Floating IP address associated to this vport.

Charateristics

Format: free
SDK attribute: associatedSecondaryFIPID

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

autoCreated boolean read only  
Discussion

Indicates if vport was auto created by the system

Charateristics

Default value: false
SDK attribute: autoCreated

backhaulSubnetVNID integer read only   autogenerated  
Discussion

Backhaul subnet VNID of the L3Domain associated with the VPort. This is exposed for Netconf manager

Charateristics

SDK attribute: backhaulSubnetVNID

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 associated Domain's Tunnel Type is MPLSoUDP. Valid range is 1 - 4294967295. If 0 is provided, color will be derived from the associated Domain.

Charateristics

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

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

domainName string read only  
Discussion

Name of the Domain associated with the VPort. This is exposed for Netconf manager

Charateristics

Format: free
SDK attribute: domainName

domainServiceLabel string
Discussion

Service ID of Domain.

Charateristics

Format: free
SDK attribute: domainServiceLabel

domainVLANID integer read only  
Discussion

Backhaul vlan id the L3Domain associated with the VPort. This is exposed for Netconf manager

Charateristics

SDK attribute: domainVLANID

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

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

esGroupVPortInfos list read only   filterable   orderable  
Discussion

Array of the embedded resource VPortInfo for each gateway member of ethernet segment group

Charateristics

SDK attribute: esGroupVPortInfos

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

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, INHERITED
SDK attribute: FIPIgnoreDefaultRoute

flowCount integer filterable   orderable  
Discussion

Maximum number of data flows allowed for a VPort. If "Flow Limit Enabled" parameter is ENABLED/DISABLED/INHERITED, Flow Count parameter is configured/ignored/derived from parent domain respectively.

Charateristics

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

flowLimitEnabled enum filterable   orderable  
Discussion

Indicates if flow limit is enabled or disabled or "Flow Count" attribute is derived from the parent Domain on this VPort . Possible values are ENABLED, DISABLED or INHERITED.

Charateristics

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

flowSetupRate integer filterable   orderable  
Discussion

Committed flow setup rate in pps for this VPort. If Flow Setup Rate Limit parameter is ENABLED/DISABLED/INHERITED, flow setup rate parameter is configured/ignored/derived from parent domain respectively.

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 or disabled or derived from parent Domain. Possible values are ENABLED, DISABLED or INHERITED.

Charateristics

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

gatewayMACMoveRole enum
Discussion

Role of the gateway vport when handling MAC move errors

Charateristics

Allowed values: SECONDARY, TERTIARY
SDK attribute: gatewayMACMoveRole

gatewayPortName string
Discussion

Gateway portname eg: eth1 - applicable for type host/bridge

Charateristics

Format: free
SDK attribute: gatewayPortName

gwEligible boolean read only   filterable   orderable  
Discussion

Indicates that this vport is eligible to be given in gateway vport config request. It becomes eligible when it has properly attached host or bridge interfaces.

Charateristics

Default value: false
SDK attribute: gwEligible

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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

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

Charateristics

Allowed values: DEGRADED, DOWN, INIT, UP
SDK attribute: operationalState

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

peerOperationalState enum
Discussion

Operational state of the peer vport in multichassis lag scenario

Charateristics

Allowed values: DOWN, INIT, UP
SDK attribute: peerOperationalState

routed boolean read only  
Discussion

Indicates if this VPort is in routed mode. Applicable for Cisco 9K only.

Charateristics

Default value: false
SDK attribute: routed

segmentationID integer
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
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

serviceID integer
Discussion

The service ID used by the VSCs to identify the subnet associated with this vport

Charateristics

Format: free
SDK attribute: serviceID

subnetVNID integer read only  
Discussion

VNID of the associated subnet or L2domain with the VPort. This is exposed for Netconf manager

Charateristics

SDK attribute: subnetVNID

subType enum read only   filterable  
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 read only   filterable  
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

VLAN integer read only  
Discussion

VLAN number of the associated VLAN of this vport - applicable for type host or bridge

Charateristics

SDK attribute: VLAN

VLANID string
Discussion

UUID of the associated VLAN of this vport - applicable for type host or bridge

Charateristics

Format: free
SDK attribute: VLANID

zoneID string
Discussion

ID the Zone associated with the VPort

Charateristics

Format: free
SDK attribute: zoneID