Package com.vmware.nsx.model

Class VsphereDeploymentConfig

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class VsphereDeploymentConfig
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    The Vsphere deployment configuration determines where to deploy the edge node. It contains settings that are applied during install time. Use EdgeNodeSettings to specify host name, SSH, NTP and DNS settings for both deployment and consequent update. These settings are editable for manually deployed edge nodes as well. EdgeNodeSettings reports current values configured on the edge node.
    See Also:
    Serialized Form

    • 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

      • IPV6ASSIGNMENT_TYPE_STATIC

        public static final java.lang.String IPV6ASSIGNMENT_TYPE_STATIC
        See Also:
        Constant Field Values

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • VsphereDeploymentConfig

        public VsphereDeploymentConfig()
        Default constructor.

      • VsphereDeploymentConfig

        protected VsphereDeploymentConfig​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getAdvancedConfiguration

        @Deprecated
public java.util.List<KeyValuePair> getAdvancedConfiguration()
        Deprecated.
        This field is deprecated. EdgeNodeSettings field 'advanced_configuration' must be used instead. Array of additional specific properties for advanced or cloud-specific deployments in key-value format.
        Returns:
        The current value of the property.

      • setAdvancedConfiguration

        @Deprecated
public void setAdvancedConfiguration​(java.util.List<KeyValuePair> advancedConfiguration)
        Deprecated.
        This field is deprecated. EdgeNodeSettings field 'advanced_configuration' must be used instead. Array of additional specific properties for advanced or cloud-specific deployments in key-value format.
        Parameters:
        advancedConfiguration - New value for the property.

      • getComputeFolderId

        public java.lang.String getComputeFolderId()
        The edge node vm will be deployed on the specified compute folder created in a datacenter, if compute folder is specified. Note - User must ensure that compute folder is accessible by specified cluster/host.
        Returns:
        The current value of the property.

      • setComputeFolderId

        public void setComputeFolderId​(java.lang.String computeFolderId)
        The edge node vm will be deployed on the specified compute folder created in a datacenter, if compute folder is specified. Note - User must ensure that compute folder is accessible by specified cluster/host.
        Parameters:
        computeFolderId - New value for the property.

      • getComputeId

        public java.lang.String getComputeId()
        The edge node vm will be deployed on the specified cluster or resourcepool. Note - all the hosts must have nsx fabric prepared in the specified cluster.
        Returns:
        The current value of the property.

      • setComputeId

        public void setComputeId​(java.lang.String computeId)
        The edge node vm will be deployed on the specified cluster or resourcepool. Note - all the hosts must have nsx fabric prepared in the specified cluster.
        Parameters:
        computeId - New value for the property.

      • getDataNetworkIds

        public java.util.List<java.lang.String> getDataNetworkIds()
        List of distributed portgroups, VLAN logical switch identifiers or segment paths to which the datapath serving vnics of edge node vm will be connected. If a VM network interface is not configured, it is disconnected and represented as an empty string.
        Returns:
        The current value of the property.

      • setDataNetworkIds

        public void setDataNetworkIds​(java.util.List<java.lang.String> dataNetworkIds)
        List of distributed portgroups, VLAN logical switch identifiers or segment paths to which the datapath serving vnics of edge node vm will be connected. If a VM network interface is not configured, it is disconnected and represented as an empty string.
        Parameters:
        dataNetworkIds - New value for the property.

      • getDefaultGatewayAddresses

        public java.util.List<java.lang.String> getDefaultGatewayAddresses()
        The default gateway for edge node must be specified if all the nodes it communicates with are not in the same subnet. Note: IPv4, IPv6 and Dual Stack Address is supported and it must belong to management network. format: ip
        Returns:
        The current value of the property.

      • setDefaultGatewayAddresses

        public void setDefaultGatewayAddresses​(java.util.List<java.lang.String> defaultGatewayAddresses)
        The default gateway for edge node must be specified if all the nodes it communicates with are not in the same subnet. Note: IPv4, IPv6 and Dual Stack Address is supported and it must belong to management network. format: ip
        Parameters:
        defaultGatewayAddresses - New value for the property.

      • getHostId

        public java.lang.String getHostId()
        The edge node vm will be deployed on the specified Host within the cluster if host_id is specified. Note - User must ensure that storage and specified networks are accessible by this host.
        Returns:
        The current value of the property.

      • setHostId

        public void setHostId​(java.lang.String hostId)
        The edge node vm will be deployed on the specified Host within the cluster if host_id is specified. Note - User must ensure that storage and specified networks are accessible by this host.
        Parameters:
        hostId - New value for the property.

      • getIpv4AssignmentDisabled

        public java.lang.Boolean getIpv4AssignmentDisabled()
        This flag represents whether IPv4 configuration is enabled or not. This flag is especially important when IPv6 only configuration is required and value should be true.
        Returns:
        The current value of the property.

      • setIpv4AssignmentDisabled

        public void setIpv4AssignmentDisabled​(java.lang.Boolean ipv4AssignmentDisabled)
        This flag represents whether IPv4 configuration is enabled or not. This flag is especially important when IPv6 only configuration is required and value should be true.
        Parameters:
        ipv4AssignmentDisabled - New value for the property.

      • getIpv4AssignmentEnabled

        @Deprecated
public java.lang.Boolean getIpv4AssignmentEnabled()
        Deprecated.
        This flag represents whether IPv4 configuration is enabled or not. This flag is especially important when IPv6 only configuration is required and value should be false.
        Returns:
        The current value of the property.

      • setIpv4AssignmentEnabled

        @Deprecated
public void setIpv4AssignmentEnabled​(java.lang.Boolean ipv4AssignmentEnabled)
        Deprecated.
        This flag represents whether IPv4 configuration is enabled or not. This flag is especially important when IPv6 only configuration is required and value should be false.
        Parameters:
        ipv4AssignmentEnabled - New value for the property.

      • getIpv6AssignmentType

        public java.lang.String getIpv6AssignmentType()
        Possible values are: IPv6 assignment type e.g STATIC, DHCPV6, SLAAC. if enum value is STATIC then management_port_subnets is mandatory. In this iteration DHCPV6 and SLAAC are not supported.
        Returns:
        The current value of the property.

      • setIpv6AssignmentType

        public void setIpv6AssignmentType​(java.lang.String ipv6AssignmentType)
        Possible values are: IPv6 assignment type e.g STATIC, DHCPV6, SLAAC. if enum value is STATIC then management_port_subnets is mandatory. In this iteration DHCPV6 and SLAAC are not supported.
        Parameters:
        ipv6AssignmentType - New value for the property.

      • getManagementNetworkId

        public java.lang.String getManagementNetworkId()
        Distributed portgroup identifier to which the management vnic of edge node vm will be connected. This portgroup must have connectivity with MP and CCP. A VLAN logical switch identifier may also be specified. If VM network interface is not connected, it is represented as an empty string.
        Returns:
        The current value of the property.

      • setManagementNetworkId

        public void setManagementNetworkId​(java.lang.String managementNetworkId)
        Distributed portgroup identifier to which the management vnic of edge node vm will be connected. This portgroup must have connectivity with MP and CCP. A VLAN logical switch identifier may also be specified. If VM network interface is not connected, it is represented as an empty string.
        Parameters:
        managementNetworkId - New value for the property.

      • getManagementPortSubnets

        public java.util.List<IPSubnet> getManagementPortSubnets()
        IP Address and subnet configuration for the management port. Note: IPv4, IPv6 and Dual Stack Address is supported.
        Returns:
        The current value of the property.

      • setManagementPortSubnets

        public void setManagementPortSubnets​(java.util.List<IPSubnet> managementPortSubnets)
        IP Address and subnet configuration for the management port. Note: IPv4, IPv6 and Dual Stack Address is supported.
        Parameters:
        managementPortSubnets - New value for the property.

      • getReservationInfo

        public ReservationInfo getReservationInfo()
        Returns:
        The current value of the property.

      • setReservationInfo

        public void setReservationInfo​(ReservationInfo reservationInfo)
        Parameters:
        reservationInfo - New value for the property.

      • getResourceAllocation

        public ResourceAssignment getResourceAllocation()
        Returns:
        The current value of the property.

      • setResourceAllocation

        public void setResourceAllocation​(ResourceAssignment resourceAllocation)
        Parameters:
        resourceAllocation - New value for the property.

      • getStorageId

        public java.lang.String getStorageId()
        The edge node vm will be deployed on the specified datastore. User must ensure that storage is accessible by the specified cluster/host.
        Returns:
        The current value of the property.

      • setStorageId

        public void setStorageId​(java.lang.String storageId)
        The edge node vm will be deployed on the specified datastore. User must ensure that storage is accessible by the specified cluster/host.
        Parameters:
        storageId - New value for the property.

      • getVcId

        public java.lang.String getVcId()
        The vc specific identifiers will be resolved on this VC. So all other identifiers specified here must belong to this vcenter server.
        Returns:
        The current value of the property.

      • setVcId

        public void setVcId​(java.lang.String vcId)
        The vc specific identifiers will be resolved on this VC. So all other identifiers specified here must belong to this vcenter server.
        Parameters:
        vcId - 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 VsphereDeploymentConfig _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 VsphereDeploymentConfig _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.