Standard host switch specification
| Name | Description | Type | Notes |
|---|---|---|---|
| cpu_config | Enhanced Networking Stack enabled HostSwitch CPU configuration 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. |
array of CpuCoreConfigForEnhancedNetworkingStackSwitch | |
| host_switch_id | The host switch id. This ID will be used to reference a host switch. 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. |
string | |
| host_switch_mode | Operational mode of a HostSwitch. STANDARD - This mode applies to all the hypervisors. ENS - This is the Enhanced Data Path switch mode. 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). If this property is specified, transport_zone_endpoints must be specified at StandardHostSwitch level. |
string | Enum: STANDARD, ENS, ENS_INTERRUPT |
| host_switch_name | host switch name. This name will be used to reference a host switch. 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. |
string | Default: "nsxDefaultHostSwitch" |
| host_switch_profile_ids | Identifiers of host switch profiles to be associated with this host switch. 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. |
array of HostSwitchProfileTypeIdEntry | |
| host_switch_type | Type of HostSwitch 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. |
string | Enum: NVDS, VDS Default: "NVDS" |
| ip_assignment_spec | Specification for IPs to be used with host switch virtual tunnel endpoints IPs can come from either a static IP pool or an explicitly specified IP list or DHCP. In case a list of IP is specified, the number of IPs provided should be sufficient as per teaming policy associated with host switch uplink profile. |
IpAssignmentSpec (Abstract type: pass one of the following concrete types) AssignedByDhcp StaticIpListSpec StaticIpMacListSpec StaticIpPoolSpec |
|
| is_migrate_pnics | Migrate any pnics which are in use If the pnics specified in the pnics field are used by a single Vsphere Standard Switch or DVS, then migrate the pnics to N-VDS. If any two pnics are not used by the same Vsphere Standard Switch or DVS, it is not supported. In such cases, please migrate them in multiple steps, one Vsphere Standard Switch or DVS at a time. |
boolean | Default: "False" |
| pnics | Physical NICs connected to the host switch Pnic can be specified only for NVDS type of HostSwitch. |
array of Pnic | |
| pnics_uninstall_migration | Physical NICs connected to a switch 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. |
array of Pnic | |
| transport_zone_endpoints | Transport zone endpoints. 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. |
array of TransportZoneEndPoint | |
| uplinks | Uplink/LAG of VMware vSphere Distributed Switch connected to the HostSwitch 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. |
array of VdsUplink | |
| vmk_install_migration | The vmknic and logical switch mappings 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 logical switches on the host switch. The state of this field is realized on the transport node during creation and update. |
array of VmknicNetwork | |
| vmk_uninstall_migration | The vmknic and portgroup mappings 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. |
array of VmknicNetwork |