com.vmware.nsx.model

Class StandardHostSwitch.Builder

java.lang.Object

com.vmware.nsx.model.StandardHostSwitch.Builder

Enclosing class:

StandardHostSwitch

public static final class StandardHostSwitch.Builder
extends java.lang.Object

Builder class for StandardHostSwitch.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of StandardHostSwitch.

Method Summary

Modifier and Type	Method and Description
StandardHostSwitch	build()
StandardHostSwitch.Builder	setCpuConfig(java.util.List<CpuCoreConfigForEnhancedNetworkingStackSwitch> cpuConfig) CPU configuration specifies number of Logical cpu cores (Lcores) per Non Uniform Memory Access (NUMA) node dedicated to Enhanced Networking Stack enabled HostSwitch to get the best performance.
StandardHostSwitch.Builder	setHostSwitchId(java.lang.String hostSwitchId) This field is writable only in case of VDS type HostSwitch and system generated for NVDS type.
StandardHostSwitch.Builder	setHostSwitchMode(java.lang.String hostSwitchMode) Possible values are: StandardHostSwitch.HOST_SWITCH_MODE_STANDARD StandardHostSwitch.HOST_SWITCH_MODE_ENS StandardHostSwitch.HOST_SWITCH_MODE_ENS_INTERRUPT StandardHostSwitch.HOST_SWITCH_MODE_LEGACY STANDARD - This mode applies to all transport nodes.
StandardHostSwitch.Builder	setHostSwitchName(java.lang.String hostSwitchName) This field is writable only in case of NVDS type HostSwitch and system generated for VDS type.
StandardHostSwitch.Builder	setHostSwitchProfileIds(java.util.List<HostSwitchProfileTypeIdEntry> hostSwitchProfileIds) Host switch profiles bound to this host switch.
StandardHostSwitch.Builder	setHostSwitchType(java.lang.String hostSwitchType) Possible values are: StandardHostSwitch.HOST_SWITCH_TYPE_NVDS StandardHostSwitch.HOST_SWITCH_TYPE_VDS VDS represents VMware vSphere Distributed Switch from vSphere that is used as HostSwitch through TransportNode or TransportNodeProfile configuration.
StandardHostSwitch.Builder	setIpAssignmentSpec(com.vmware.vapi.bindings.Structure ipAssignmentSpec)
StandardHostSwitch.Builder	setIpv6AssignmentSpec(com.vmware.vapi.bindings.Structure ipv6AssignmentSpec)
StandardHostSwitch.Builder	setIsMigratePnics(java.lang.Boolean isMigratePnics) When using the Quick Start workflow on 7.0 and above vCenter clusters, if the pnics specified in the pnics field are used by a single VSS HostSwitch, then they are migrated over to recommended VDS HostSwitch.
StandardHostSwitch.Builder	setPnics(java.util.List<Pnic> pnics) When using the Quick Start workflow on 7.0 and above vCenter clusters, pnic information will be populated by the recommendation engine when providing a VDS HostSwitch based recommendation for a VSS HostSwitch.
StandardHostSwitch.Builder	setPnicsUninstallMigration(java.util.List<Pnic> pnicsUninstallMigration) This is only supported for NVDS type of host switch.
StandardHostSwitch.Builder	setPortgroupTransportZoneId(java.lang.String portgroupTransportZoneId) A transport zone will be created for each DVS found across all hosts in a cluster that is installed for NSX on DVPG.
StandardHostSwitch.Builder	setTransportNodeProfileSubConfigs(java.util.List<TransportNodeProfileSubConfig> transportNodeProfileSubConfigs) This field is supported only for Tranport Node Profile Configurations.
StandardHostSwitch.Builder	setTransportZoneEndpoints(java.util.List<TransportZoneEndPoint> transportZoneEndpoints) List of TransportZones that are to be associated with specified host switch.
StandardHostSwitch.Builder	setUplinks(java.util.List<VdsUplink> uplinks) If VDS is used as a HostSwitch this attribute must be specified.
StandardHostSwitch.Builder	setVmkInstallMigration(java.util.List<VmknicNetwork> vmkInstallMigration) When using the Quick Start workflow on 7.0 and above vCenter clusters, vmnk_install_migration will be populated by the recommendation engine when providing a VDS HostSwitch based recommendation for a VSS HostSwitch.
StandardHostSwitch.Builder	setVmkUninstallMigration(java.util.List<VmknicNetwork> vmkUninstallMigration) This is only supported for NVDS type of host switch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of StandardHostSwitch.

Method Detail

setCpuConfig

public StandardHostSwitch.Builder setCpuConfig(java.util.List<CpuCoreConfigForEnhancedNetworkingStackSwitch> cpuConfig)

CPU configuration specifies number of Logical cpu cores (Lcores) per Non Uniform Memory Access (NUMA) node dedicated to Enhanced Networking Stack enabled HostSwitch to get the best performance.

Parameters:

cpuConfig - New value for the property.

setHostSwitchId

public StandardHostSwitch.Builder setHostSwitchId(java.lang.String hostSwitchId)

This field is writable only in case of VDS type HostSwitch and system generated for NVDS type. For VDS type host switch, This field is used to lookup a VDS from corresponding Compute Manager and then can be configured for logical networking. For NVDS type host switch, This field is system generated and if provided will be overwritten.

Parameters:

hostSwitchId - New value for the property.

setHostSwitchMode

public StandardHostSwitch.Builder setHostSwitchMode(java.lang.String hostSwitchMode)

Possible values are:

• StandardHostSwitch.HOST_SWITCH_MODE_STANDARD
• StandardHostSwitch.HOST_SWITCH_MODE_ENS
• StandardHostSwitch.HOST_SWITCH_MODE_ENS_INTERRUPT
• StandardHostSwitch.HOST_SWITCH_MODE_LEGACY

STANDARD - This mode applies to all transport nodes. The realized host switch mode will be chosen automatically (best applicable as per uplink capabilities) by the data-plane in the transport node and may change in future. ENS - This is the Enhanced Data Path switch mode for ESX host tranport node. This mode provides accelerated networking performances but also introduces additional prerequisites. In order to benefit from this mode, workloads will be need to be compiled with DPDK and will use VMXNET3 for their vNIC. This mode is only available on ESX hypervisor (6.7 and above, recommended 6.7 U2 and above) and unavailable on KVM, EDGE and Public Cloud Gateway. Not all NSX features are available in this mode, please consult the documentation. ENS_INTERRUPT - This is an interrupt driven variant of the Enhanced Data Path mode. Please, consult your account representative for applicability. This mode is available only on ESX hypervisor (7.0 and above). LEGACY - This mode applies to all transport nodes. This mode was formerly called as STANDARD and is realized as pktHandle. IMPORTANT: ENS and ENS_INTERRUPT modes require a higher tier of NSX licenses. ENS and ENS_INTERRUPT with classic Nic - NSX advanced or higher ENS with SmartNic : NSX Enterprise Plus or higher. Please consult NSX documentation for complete details.

Parameters:

hostSwitchMode - New value for the property.

setHostSwitchName

public StandardHostSwitch.Builder setHostSwitchName(java.lang.String hostSwitchName)

This field is writable only in case of NVDS type HostSwitch and system generated for VDS type. For NVDS type host switch, If this name is unset or empty then the default host switch name will be used. The name must be unique among all host switches specified in a given transport node; unset name, empty name and the default host switch name are considered the same in terms of uniqueness. For VDS type host switch, Manager fetches VDS name from corresponding Compute Manager and populates this field. If VDS name is given (correct or incorrect) it is ignored and overwritten with correct one.

Parameters:

hostSwitchName - New value for the property.

setHostSwitchProfileIds

public StandardHostSwitch.Builder setHostSwitchProfileIds(java.util.List<HostSwitchProfileTypeIdEntry> hostSwitchProfileIds)

Host switch profiles bound to this host switch. If a profile ID is not provided for any HostSwitchProfileType that is supported by the transport node, the corresponding default profile will be bound to the host switch. If transport node is created using Policy APIs, use policyPaths instead of UUIDs.

Parameters:

hostSwitchProfileIds - New value for the property.

setHostSwitchType

public StandardHostSwitch.Builder setHostSwitchType(java.lang.String hostSwitchType)

Possible values are:

• StandardHostSwitch.HOST_SWITCH_TYPE_NVDS
• StandardHostSwitch.HOST_SWITCH_TYPE_VDS

VDS represents VMware vSphere Distributed Switch from vSphere that is used as HostSwitch through TransportNode or TransportNodeProfile configuration. When VDS is used as a HostSwitch, Hosts have to be added to VDS from vSphere and VDS instance is created on Hosts. To configure NSX on such hosts, you can use this VDS as a HostSwitch from NSX manager. vCenter has the ownership of MTU, LAG, NIOC and LLDP configuration of such VDS backed HostSwitch. Remaining configuration (e.g. UplinkHostswitchProfile) will be managed by NSX. NVDS represents NSX Virtual Switch which is NSX native HostSwitch. All configurations of NVDS will be managed by NSX. HostSwitch of type NVDS has been deprecated on ESX hosts that are managed by a vCenter Server.

Parameters:

hostSwitchType - New value for the property.

setIpAssignmentSpec

public StandardHostSwitch.Builder setIpAssignmentSpec(com.vmware.vapi.bindings.Structure ipAssignmentSpec)

Parameters:

ipAssignmentSpec - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in IpAssignmentSpec. When methods return a value of this class as a return value, the property will contain all the properties defined in IpAssignmentSpec.

setIpv6AssignmentSpec

public StandardHostSwitch.Builder setIpv6AssignmentSpec(com.vmware.vapi.bindings.Structure ipv6AssignmentSpec)

Parameters:

ipv6AssignmentSpec - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in Ipv6AssignmentSpec. When methods return a value of this class as a return value, the property will contain all the properties defined in Ipv6AssignmentSpec.

setIsMigratePnics

public StandardHostSwitch.Builder setIsMigratePnics(java.lang.Boolean isMigratePnics)

When using the Quick Start workflow on 7.0 and above vCenter clusters, if the pnics specified in the pnics field are used by a single VSS HostSwitch, then they are migrated over to recommended VDS HostSwitch. If any two pnics are not used by the same VSS HostSwitch or VDS HostSwitch, it is not supported. In such cases, please migrate them in multiple steps, one VSS HostSwitch or VDS HostSwitch at a time.

Parameters:

isMigratePnics - New value for the property.

setPnics

public StandardHostSwitch.Builder setPnics(java.util.List<Pnic> pnics)

When using the Quick Start workflow on 7.0 and above vCenter clusters, pnic information will be populated by the recommendation engine when providing a VDS HostSwitch based recommendation for a VSS HostSwitch.

Parameters:

pnics - New value for the property.

setPnicsUninstallMigration

public StandardHostSwitch.Builder setPnicsUninstallMigration(java.util.List<Pnic> pnicsUninstallMigration)

This is only supported for NVDS type of host switch. If this is specified for VDS type of host switch, an error will be returned to user. The pnics to be migrated out to a non N-VDS switch during transport node deletion.

Parameters:

pnicsUninstallMigration - New value for the property.

setPortgroupTransportZoneId

public StandardHostSwitch.Builder setPortgroupTransportZoneId(java.lang.String portgroupTransportZoneId)

A transport zone will be created for each DVS found across all hosts in a cluster that is installed for NSX on DVPG. This field, populated by NSX, is the ID of the transport zone created for the DVS this host switch represents. All discovered segments created for the DVPGs found on the DVS will have this ID specified as the transport zone id.

Parameters:

portgroupTransportZoneId - New value for the property.

setTransportNodeProfileSubConfigs

public StandardHostSwitch.Builder setTransportNodeProfileSubConfigs(java.util.List<TransportNodeProfileSubConfig> transportNodeProfileSubConfigs)

This field is supported only for Tranport Node Profile Configurations. This field is used for adding a subset of the host switch configuration under a Transport Node Profile. This field is applicable only for a VDS based host switch and not for an NVDS based host switch.

Parameters:

transportNodeProfileSubConfigs - New value for the property.

setTransportZoneEndpoints

public StandardHostSwitch.Builder setTransportZoneEndpoints(java.util.List<TransportZoneEndPoint> transportZoneEndpoints)

List of TransportZones that are to be associated with specified host switch. If this property is specified, host_switch_mode at StandardHostSwitch level must be specified.

Parameters:

transportZoneEndpoints - New value for the property.

setUplinks

public StandardHostSwitch.Builder setUplinks(java.util.List<VdsUplink> uplinks)

If VDS is used as a HostSwitch this attribute must be specified. You can associate uplinks from UplinkHostSwitchProfile to either VDS uplink or LAG. VDS uplink or LAG will inherit the global VDS level teaming policy from vSphere. NSX managed uplink or LAG will have NSX teaming policy configured through UplinkHostSwitchProfile.

Parameters:

uplinks - New value for the property.

setVmkInstallMigration

public StandardHostSwitch.Builder setVmkInstallMigration(java.util.List<VmknicNetwork> vmkInstallMigration)

When using the Quick Start workflow on 7.0 and above vCenter clusters, vmnk_install_migration will be populated by the recommendation engine when providing a VDS HostSwitch based recommendation for a VSS HostSwitch. It will contain The vmk interfaces and the associated logical switches on the HostSwitch. The state of this field is realized on the transport node during creation

Parameters:

vmkInstallMigration - New value for the property.

setVmkUninstallMigration

public StandardHostSwitch.Builder setVmkUninstallMigration(java.util.List<VmknicNetwork> vmkUninstallMigration)

This is only supported for NVDS type of host switch. If this is specified for VDS type of host switch, an error will be returned to user. The vmk interfaces and the associated portgroups on the VSS/DVS. This field is realized on the host during transport node deletion or NSX uninstallation to specify the destination for all vmks on N-VDS switches.

Parameters:

vmkUninstallMigration - New value for the property.

build

public StandardHostSwitch build()