Class SegmentAdvancedConfig

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class SegmentAdvancedConfig
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Advanced configuration for Segment
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        SegmentAdvancedConfig()
      Default constructor.
      protected SegmentAdvancedConfig​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 SegmentAdvancedConfig _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 SegmentAdvancedConfig _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.util.List<java.lang.String> getAddressPoolPaths()
      Policy path to IP address pools.
      java.lang.String getConnectivity()
      Possible values are: CONNECTIVITY_ON CONNECTIVITY_OFF Connectivity configuration to manually connect (ON) or disconnect (OFF) Tier-0/Tier1 segment from corresponding gateway.
      java.lang.Boolean getHybrid()
      When set to true, all the ports created on this segment will behave in a hybrid fashion.
      java.lang.Boolean getInterRouter()
      When set to true, any port attached to this logical switch will not be visible through VC/ESX UI
      java.lang.Boolean getLocalEgress()
      This property is used to enable proximity routing with local egress.
      java.util.List<LocalEgressRoutingEntry> getLocalEgressRoutingPolicies()
      An ordered list of routing policies to forward traffic to the next hop.
      java.lang.Boolean getMulticast()
      Enable multicast on the downlink LRP created to connect the segment to Tier0/Tier1 gateway.
      java.lang.String getNdraProfilePath()
      This profile is applie dto the downlink logical router port created while attaching this semgnet to tier-0 or tier-1.
      java.lang.Boolean getNodeLocalSwitch()
      A behaviour required for Firewall As A Service (FaaS) where the segment BUM traffic is confined within the edge node that this segment belongs to.
      java.lang.String getOriginId()
      ID populated by NSX when NSX on DVPG is used to indicate the source DVPG.
      java.lang.String getOriginType()
      Possible values are: ORIGIN_TYPE_VCENTER The type of source from where the DVPortgroup is discovered
      java.lang.String getUplinkTeamingPolicyName()
      The name of the switching uplink teaming policy for the Segment.
      java.lang.String getUrpfMode()
      Possible values are: URPF_MODE_NONE URPF_MODE_STRICT This URPF mode is applied to the downlink logical router port created while attaching this segment to tier-0 or tier-1.
      int hashCode()  
      void setAddressPoolPaths​(java.util.List<java.lang.String> addressPoolPaths)
      Policy path to IP address pools.
      void setConnectivity​(java.lang.String connectivity)
      Possible values are: CONNECTIVITY_ON CONNECTIVITY_OFF Connectivity configuration to manually connect (ON) or disconnect (OFF) Tier-0/Tier1 segment from corresponding gateway.
      void setHybrid​(java.lang.Boolean hybrid)
      When set to true, all the ports created on this segment will behave in a hybrid fashion.
      void setInterRouter​(java.lang.Boolean interRouter)
      When set to true, any port attached to this logical switch will not be visible through VC/ESX UI
      void setLocalEgress​(java.lang.Boolean localEgress)
      This property is used to enable proximity routing with local egress.
      void setLocalEgressRoutingPolicies​(java.util.List<LocalEgressRoutingEntry> localEgressRoutingPolicies)
      An ordered list of routing policies to forward traffic to the next hop.
      void setMulticast​(java.lang.Boolean multicast)
      Enable multicast on the downlink LRP created to connect the segment to Tier0/Tier1 gateway.
      void setNdraProfilePath​(java.lang.String ndraProfilePath)
      This profile is applie dto the downlink logical router port created while attaching this semgnet to tier-0 or tier-1.
      void setNodeLocalSwitch​(java.lang.Boolean nodeLocalSwitch)
      A behaviour required for Firewall As A Service (FaaS) where the segment BUM traffic is confined within the edge node that this segment belongs to.
      void setOriginId​(java.lang.String originId)
      ID populated by NSX when NSX on DVPG is used to indicate the source DVPG.
      void setOriginType​(java.lang.String originType)
      Possible values are: ORIGIN_TYPE_VCENTER The type of source from where the DVPortgroup is discovered
      void setUplinkTeamingPolicyName​(java.lang.String uplinkTeamingPolicyName)
      The name of the switching uplink teaming policy for the Segment.
      void setUrpfMode​(java.lang.String urpfMode)
      Possible values are: URPF_MODE_NONE URPF_MODE_STRICT This URPF mode is applied to the downlink logical router port created while attaching this segment to tier-0 or tier-1.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • CONNECTIVITY_OFF

        public static final java.lang.String CONNECTIVITY_OFF
        See Also:
        Constant Field Values
      • ORIGIN_TYPE_VCENTER

        public static final java.lang.String ORIGIN_TYPE_VCENTER
        See Also:
        Constant Field Values
      • URPF_MODE_STRICT

        public static final java.lang.String URPF_MODE_STRICT
        See Also:
        Constant Field Values
      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • SegmentAdvancedConfig

        public SegmentAdvancedConfig()
        Default constructor.
      • SegmentAdvancedConfig

        protected SegmentAdvancedConfig​(com.vmware.vapi.data.StructValue __dynamicStructureFields)
    • Method Detail

      • getConnectivity

        public java.lang.String getConnectivity()
        Possible values are: Connectivity configuration to manually connect (ON) or disconnect (OFF) Tier-0/Tier1 segment from corresponding gateway. This property does not apply to VLAN backed segments. VLAN backed segments with connectivity OFF does not affect its layer-2 connectivity.
        Returns:
        The current value of the property.
      • setConnectivity

        public void setConnectivity​(java.lang.String connectivity)
        Possible values are: Connectivity configuration to manually connect (ON) or disconnect (OFF) Tier-0/Tier1 segment from corresponding gateway. This property does not apply to VLAN backed segments. VLAN backed segments with connectivity OFF does not affect its layer-2 connectivity.
        Parameters:
        connectivity - New value for the property.
      • getAddressPoolPaths

        public java.util.List<java.lang.String> getAddressPoolPaths()
        Policy path to IP address pools.
        Returns:
        The current value of the property.
      • setAddressPoolPaths

        public void setAddressPoolPaths​(java.util.List<java.lang.String> addressPoolPaths)
        Policy path to IP address pools.
        Parameters:
        addressPoolPaths - New value for the property.
      • getHybrid

        public java.lang.Boolean getHybrid()
        When set to true, all the ports created on this segment will behave in a hybrid fashion. The hybrid port indicates to NSX that the VM intends to operate in underlay mode, but retains the ability to forward egress traffic to the NSX overlay network. This property is only applicable for segment created with transport zone type OVERLAY_STANDARD. This property cannot be modified after segment is created.
        Returns:
        The current value of the property.
      • setHybrid

        public void setHybrid​(java.lang.Boolean hybrid)
        When set to true, all the ports created on this segment will behave in a hybrid fashion. The hybrid port indicates to NSX that the VM intends to operate in underlay mode, but retains the ability to forward egress traffic to the NSX overlay network. This property is only applicable for segment created with transport zone type OVERLAY_STANDARD. This property cannot be modified after segment is created.
        Parameters:
        hybrid - New value for the property.
      • getInterRouter

        public java.lang.Boolean getInterRouter()
        When set to true, any port attached to this logical switch will not be visible through VC/ESX UI
        Returns:
        The current value of the property.
      • setInterRouter

        public void setInterRouter​(java.lang.Boolean interRouter)
        When set to true, any port attached to this logical switch will not be visible through VC/ESX UI
        Parameters:
        interRouter - New value for the property.
      • getLocalEgress

        public java.lang.Boolean getLocalEgress()
        This property is used to enable proximity routing with local egress. When set to true, logical router interface (downlink) connecting Segment to Tier0/Tier1 gateway is configured with prefix-length 32.
        Returns:
        The current value of the property.
      • setLocalEgress

        public void setLocalEgress​(java.lang.Boolean localEgress)
        This property is used to enable proximity routing with local egress. When set to true, logical router interface (downlink) connecting Segment to Tier0/Tier1 gateway is configured with prefix-length 32.
        Parameters:
        localEgress - New value for the property.
      • getLocalEgressRoutingPolicies

        public java.util.List<LocalEgressRoutingEntry> getLocalEgressRoutingPolicies()
        An ordered list of routing policies to forward traffic to the next hop.
        Returns:
        The current value of the property.
      • setLocalEgressRoutingPolicies

        public void setLocalEgressRoutingPolicies​(java.util.List<LocalEgressRoutingEntry> localEgressRoutingPolicies)
        An ordered list of routing policies to forward traffic to the next hop.
        Parameters:
        localEgressRoutingPolicies - New value for the property.
      • getMulticast

        public java.lang.Boolean getMulticast()
        Enable multicast on the downlink LRP created to connect the segment to Tier0/Tier1 gateway.
        Returns:
        The current value of the property.
      • setMulticast

        public void setMulticast​(java.lang.Boolean multicast)
        Enable multicast on the downlink LRP created to connect the segment to Tier0/Tier1 gateway.
        Parameters:
        multicast - New value for the property.
      • getNdraProfilePath

        public java.lang.String getNdraProfilePath()
        This profile is applie dto the downlink logical router port created while attaching this semgnet to tier-0 or tier-1. If this field is empty, NDRA profile of the router is applied to the newly created port.
        Returns:
        The current value of the property.
      • setNdraProfilePath

        public void setNdraProfilePath​(java.lang.String ndraProfilePath)
        This profile is applie dto the downlink logical router port created while attaching this semgnet to tier-0 or tier-1. If this field is empty, NDRA profile of the router is applied to the newly created port.
        Parameters:
        ndraProfilePath - New value for the property.
      • getNodeLocalSwitch

        public java.lang.Boolean getNodeLocalSwitch()
        A behaviour required for Firewall As A Service (FaaS) where the segment BUM traffic is confined within the edge node that this segment belongs to.
        Returns:
        The current value of the property.
      • setNodeLocalSwitch

        public void setNodeLocalSwitch​(java.lang.Boolean nodeLocalSwitch)
        A behaviour required for Firewall As A Service (FaaS) where the segment BUM traffic is confined within the edge node that this segment belongs to.
        Parameters:
        nodeLocalSwitch - New value for the property.
      • getOriginId

        public java.lang.String getOriginId()
        ID populated by NSX when NSX on DVPG is used to indicate the source DVPG. Currently, only DVPortgroups are identified as Discovered Segments. The origin_id is the identifier of DVPortgroup from the source vCenter server.
        Returns:
        The current value of the property.
      • setOriginId

        public void setOriginId​(java.lang.String originId)
        ID populated by NSX when NSX on DVPG is used to indicate the source DVPG. Currently, only DVPortgroups are identified as Discovered Segments. The origin_id is the identifier of DVPortgroup from the source vCenter server.
        Parameters:
        originId - New value for the property.
      • getOriginType

        public java.lang.String getOriginType()
        Possible values are: The type of source from where the DVPortgroup is discovered
        Returns:
        The current value of the property.
      • setOriginType

        public void setOriginType​(java.lang.String originType)
        Possible values are: The type of source from where the DVPortgroup is discovered
        Parameters:
        originType - New value for the property.
      • getUplinkTeamingPolicyName

        public java.lang.String getUplinkTeamingPolicyName()
        The name of the switching uplink teaming policy for the Segment. This name corresponds to one of the switching uplink teaming policy names listed in TransportZone associated with the Segment. See transport_zone_path property above for more details. When this property is not specified, the segment will not have a teaming policy associated with it and the host switch's default teaming policy will be used by MP.
        Returns:
        The current value of the property.
      • setUplinkTeamingPolicyName

        public void setUplinkTeamingPolicyName​(java.lang.String uplinkTeamingPolicyName)
        The name of the switching uplink teaming policy for the Segment. This name corresponds to one of the switching uplink teaming policy names listed in TransportZone associated with the Segment. See transport_zone_path property above for more details. When this property is not specified, the segment will not have a teaming policy associated with it and the host switch's default teaming policy will be used by MP.
        Parameters:
        uplinkTeamingPolicyName - New value for the property.
      • getUrpfMode

        public java.lang.String getUrpfMode()
        Possible values are: This URPF mode is applied to the downlink logical router port created while attaching this segment to tier-0 or tier-1.
        Returns:
        The current value of the property.
      • setUrpfMode

        public void setUrpfMode​(java.lang.String urpfMode)
        Possible values are: This URPF mode is applied to the downlink logical router port created while attaching this segment to tier-0 or tier-1.
        Parameters:
        urpfMode - 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 SegmentAdvancedConfig _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 SegmentAdvancedConfig _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.