com.vmware.nsx_policy.model

Class RouteBasedL3VpnSession

java.lang.Object

com.vmware.nsx_policy.model.RouteBasedL3VpnSession

All Implemented Interfaces:

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

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

A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	_TYPE_IDENTIFIER Identifier denoting this class, when it is used in polymorphic context.

Constructor Summary

Constructors

Modifier	Constructor and Description
	RouteBasedL3VpnSession() Default constructor.
protected	RouteBasedL3VpnSession(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 RouteBasedL3VpnSession	_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 RouteBasedL3VpnSession	_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.Boolean	getDefaultRuleLogging() Indicates if logging should be enabled for the default whitelisting rule for the VTI interface.
java.lang.Boolean	getForceWhitelisting() The default firewall rule Action is set to DROP if true otherwise set to ALLOW.
java.lang.String	getResourceType() Possible values are: L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSION L3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION - A Policy Based L3Vpn is a configuration in which protect rules to match local and remote subnet needs to be defined.
java.lang.String	getRoutingConfigPath() Deprecated.
java.util.List<TunnelSubnet>	getTunnelSubnets() Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session.
int	hashCode()
void	setDefaultRuleLogging(java.lang.Boolean defaultRuleLogging) Indicates if logging should be enabled for the default whitelisting rule for the VTI interface.
void	setForceWhitelisting(java.lang.Boolean forceWhitelisting) The default firewall rule Action is set to DROP if true otherwise set to ALLOW.
void	setRoutingConfigPath(java.lang.String routingConfigPath) Deprecated.
void	setTunnelSubnets(java.util.List<TunnelSubnet> tunnelSubnets) Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_TYPE_IDENTIFIER

public static final java.lang.String _TYPE_IDENTIFIER

Identifier denoting this class, when it is used in polymorphic context.

This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

RouteBasedL3VpnSession

public RouteBasedL3VpnSession()

Default constructor.

RouteBasedL3VpnSession

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

Method Detail

getDefaultRuleLogging

public java.lang.Boolean getDefaultRuleLogging()

Indicates if logging should be enabled for the default whitelisting rule for the VTI interface.

Returns:

The current value of the property.

setDefaultRuleLogging

public void setDefaultRuleLogging(java.lang.Boolean defaultRuleLogging)

Indicates if logging should be enabled for the default whitelisting rule for the VTI interface.

Parameters:

defaultRuleLogging - New value for the property.

getForceWhitelisting

public java.lang.Boolean getForceWhitelisting()

The default firewall rule Action is set to DROP if true otherwise set to ALLOW.

Returns:

The current value of the property.

setForceWhitelisting

public void setForceWhitelisting(java.lang.Boolean forceWhitelisting)

The default firewall rule Action is set to DROP if true otherwise set to ALLOW.

Parameters:

forceWhitelisting - New value for the property.

getRoutingConfigPath

@Deprecated
public java.lang.String getRoutingConfigPath()

Deprecated.

This is a deprecated field. Any specified value is not saved and will be ignored.

Returns:

The current value of the property.

setRoutingConfigPath

@Deprecated
public void setRoutingConfigPath(java.lang.String routingConfigPath)

Deprecated.

This is a deprecated field. Any specified value is not saved and will be ignored.

Parameters:

routingConfigPath - New value for the property.

getTunnelSubnets

public java.util.List<TunnelSubnet> getTunnelSubnets()

Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session. A max of one tunnel subnet is allowed.

Returns:

The current value of the property.

setTunnelSubnets

public void setTunnelSubnets(java.util.List<TunnelSubnet> tunnelSubnets)

Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session. A max of one tunnel subnet is allowed.

Parameters:

tunnelSubnets - New value for the property.

getResourceType

public java.lang.String getResourceType()

Possible values are:

• L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSION
• L3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION

- A Policy Based L3Vpn is a configuration in which protect rules to match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn. The value of this property is automatically populated to "RouteBasedL3VpnSession".

Returns:

The current value of 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 RouteBasedL3VpnSession _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 RouteBasedL3VpnSession _newInstance2(com.vmware.vapi.data.StructValue structValue)

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