com.vmware.vcenter.namespace_management.networks.edges

Class NSXConfig

java.lang.Object

com.vmware.vcenter.namespace_management.networks.edges.NSXConfig

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class NSXConfig
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

NSXConfig class describes the configuration for NSX-T Edge services. This class was added in vSphere API 8.0.0.1.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NSXConfig.Builder Builder class for NSXConfig.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	NSXConfig() Default constructor.
protected	NSXConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static NSXConfig	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static NSXConfig	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.String	getDefaultIngressTLSCertificate() getDefaultIngressTLSCertificate() defines a default certificate that is served on Ingress services, when another certificate is not presented.
java.lang.String	getEdgeClusterID() getEdgeClusterID() defines the NSX Edge Cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT.
java.util.List<IPRange>	getEgressIPRanges() getEgressIPRanges() lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs.
LoadBalancerSize	getLoadBalancerSize() getLoadBalancerSize() describes the load balancer sizing options available.
NSXRoutingMode	getRoutingMode() getRoutingMode() enables the network topology in either NAT mode or Routed Mode.
java.lang.String	getT0Gateway() getT0Gateway() specifies the default Tier-0 gateway ID for the namespaces configuration.
int	hashCode()
void	setDefaultIngressTLSCertificate(java.lang.String defaultIngressTLSCertificate) getDefaultIngressTLSCertificate() defines a default certificate that is served on Ingress services, when another certificate is not presented.
void	setEdgeClusterID(java.lang.String edgeClusterID) getEdgeClusterID() defines the NSX Edge Cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT.
void	setEgressIPRanges(java.util.List<IPRange> egressIPRanges) getEgressIPRanges() lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs.
void	setLoadBalancerSize(LoadBalancerSize loadBalancerSize) getLoadBalancerSize() describes the load balancer sizing options available.
void	setRoutingMode(NSXRoutingMode routingMode) getRoutingMode() enables the network topology in either NAT mode or Routed Mode.
void	setT0Gateway(java.lang.String t0Gateway) getT0Gateway() specifies the default Tier-0 gateway ID for the namespaces configuration.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

NSXConfig

public NSXConfig()

Default constructor.

NSXConfig

protected NSXConfig(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getEdgeClusterID

public java.lang.String getEdgeClusterID()

getEdgeClusterID() defines the NSX Edge Cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT. This property was added in vSphere API 8.0.0.1. Defaults to a the edge cluster created earliest.

Returns:

The current value of the property.

setEdgeClusterID

public void setEdgeClusterID(java.lang.String edgeClusterID)

getEdgeClusterID() defines the NSX Edge Cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT. This property was added in vSphere API 8.0.0.1. Defaults to a the edge cluster created earliest.

Parameters:

edgeClusterID - New value for the property.

getDefaultIngressTLSCertificate

public java.lang.String getDefaultIngressTLSCertificate()

getDefaultIngressTLSCertificate() defines a default certificate that is served on Ingress services, when another certificate is not presented. This configuration applies to all namespaces by default. This property was added in vSphere API 8.0.0.1. If unset, there will be no certificate served on Ingress.

Returns:

The current value of the property.

setDefaultIngressTLSCertificate

public void setDefaultIngressTLSCertificate(java.lang.String defaultIngressTLSCertificate)

getDefaultIngressTLSCertificate() defines a default certificate that is served on Ingress services, when another certificate is not presented. This configuration applies to all namespaces by default. This property was added in vSphere API 8.0.0.1. If unset, there will be no certificate served on Ingress.

Parameters:

defaultIngressTLSCertificate - New value for the property.

getRoutingMode

public NSXRoutingMode getRoutingMode()

getRoutingMode() enables the network topology in either NAT mode or Routed Mode. Enabling routed mode will result in all the workloads i.e vSphere PODs, VMs and Tanzu clusters Node IPs to be directly accessible from networks beyond the Tier-0 router. Once a namespace mode is applied, it cannot be changed. This property was added in vSphere API 8.0.0.1. The default setting is NAT mode.

Returns:

The current value of the property.

setRoutingMode

public void setRoutingMode(NSXRoutingMode routingMode)

getRoutingMode() enables the network topology in either NAT mode or Routed Mode. Enabling routed mode will result in all the workloads i.e vSphere PODs, VMs and Tanzu clusters Node IPs to be directly accessible from networks beyond the Tier-0 router. Once a namespace mode is applied, it cannot be changed. This property was added in vSphere API 8.0.0.1. The default setting is NAT mode.

Parameters:

routingMode - New value for the property.

getEgressIPRanges

public java.util.List<IPRange> getEgressIPRanges()

getEgressIPRanges() lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs. These ranges must not overlap with other IP ranges on this network. This property was added in vSphere API 8.0.0.1. If this range is empty, network traffic will not be able to exit the cluster.

Returns:

The current value of the property.

setEgressIPRanges

public void setEgressIPRanges(java.util.List<IPRange> egressIPRanges)

getEgressIPRanges() lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs. These ranges must not overlap with other IP ranges on this network. This property was added in vSphere API 8.0.0.1. If this range is empty, network traffic will not be able to exit the cluster.

Parameters:

egressIPRanges - New value for the property.

getT0Gateway

public java.lang.String getT0Gateway()

getT0Gateway() specifies the default Tier-0 gateway ID for the namespaces configuration. This property was added in vSphere API 8.0.0.1. If unset, the default Tier-0 gateway from the edge cluster is used.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: NSXTier0Gateway. When methods return a value of this class as a return value, the property will be an identifier for the resource type: NSXTier0Gateway.

setT0Gateway

public void setT0Gateway(java.lang.String t0Gateway)

getT0Gateway() specifies the default Tier-0 gateway ID for the namespaces configuration. This property was added in vSphere API 8.0.0.1. If unset, the default Tier-0 gateway from the edge cluster is used.

Parameters:

t0Gateway - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: NSXTier0Gateway. When methods return a value of this class as a return value, the property will be an identifier for the resource type: NSXTier0Gateway.

getLoadBalancerSize

public LoadBalancerSize getLoadBalancerSize()

getLoadBalancerSize() describes the load balancer sizing options available. Larger sizes support more active virtual servers, but consume more resources. This property was added in vSphere API 8.0.0.1. If unset, the size defaults to small.

Returns:

The current value of the property.

setLoadBalancerSize

public void setLoadBalancerSize(LoadBalancerSize loadBalancerSize)

getLoadBalancerSize() describes the load balancer sizing options available. Larger sizes support more active virtual servers, but consume more resources. This property was added in vSphere API 8.0.0.1. If unset, the size defaults to small.

Parameters:

loadBalancerSize - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static NSXConfig _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static NSXConfig _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.