com.vmware.nsx.model

Class EdgeNodeSettings

java.lang.Object

com.vmware.nsx.model.EdgeNodeSettings

All Implemented Interfaces:

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

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

The settings are used during deployment and consequent update of an edge, unless indicated otherwise. These settings are editable for manually deployed edge nodes as well. If using DHCP, you must leave the following fields unset: search_domains, management_port_subnets, dns_servers and default_gateway_addresses. EdgeNodeSettings reports current values configured on the edge node. If the settings lag with actual state on the edge, these may be refreshed at NSX Manager using API POST api/v1/transport-nodes /<transport-node-id>?action=refresh_node_configuration&resource_type= EdgeNode

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	EdgeNodeSettings() Default constructor.
protected	EdgeNodeSettings(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 EdgeNodeSettings	_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 EdgeNodeSettings	_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<KeyValuePair>	getAdvancedConfiguration() Array of additional specific properties for advanced or cloud- specific deployments in key-value format.
java.lang.Boolean	getAllowSshRootLogin() Allowing root SSH logins is not recommended for security reasons.
java.util.List<java.lang.String>	getDnsServers() List of DNS servers.
java.lang.Boolean	getEnableSsh() Enabling SSH service is not recommended for security reasons.
java.lang.Boolean	getEnableUptMode()
java.lang.String	getHostname() Host name or FQDN for edge node.
java.util.List<java.lang.String>	getNtpServers() List of NTP servers.
java.util.List<java.lang.String>	getSearchDomains() List of domain names that are used to complete unqualified host names.
java.util.List<SyslogConfiguration>	getSyslogServers() List of Syslog server configuration.
int	hashCode()
void	setAdvancedConfiguration(java.util.List<KeyValuePair> advancedConfiguration) Array of additional specific properties for advanced or cloud- specific deployments in key-value format.
void	setAllowSshRootLogin(java.lang.Boolean allowSshRootLogin) Allowing root SSH logins is not recommended for security reasons.
void	setDnsServers(java.util.List<java.lang.String> dnsServers) List of DNS servers.
void	setEnableSsh(java.lang.Boolean enableSsh) Enabling SSH service is not recommended for security reasons.
void	setEnableUptMode(java.lang.Boolean enableUptMode)
void	setHostname(java.lang.String hostname) Host name or FQDN for edge node.
void	setNtpServers(java.util.List<java.lang.String> ntpServers) List of NTP servers.
void	setSearchDomains(java.util.List<java.lang.String> searchDomains) List of domain names that are used to complete unqualified host names.
void	setSyslogServers(java.util.List<SyslogConfiguration> syslogServers) List of Syslog server 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

EdgeNodeSettings

public EdgeNodeSettings()

Default constructor.

EdgeNodeSettings

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

Method Detail

getAdvancedConfiguration

public java.util.List<KeyValuePair> getAdvancedConfiguration()

Array of additional specific properties for advanced or cloud- specific deployments in key-value format.

Returns:

The current value of the property.

setAdvancedConfiguration

public void setAdvancedConfiguration(java.util.List<KeyValuePair> advancedConfiguration)

Array of additional specific properties for advanced or cloud- specific deployments in key-value format.

Parameters:

advancedConfiguration - New value for the property.

getAllowSshRootLogin

public java.lang.Boolean getAllowSshRootLogin()

Allowing root SSH logins is not recommended for security reasons. Edit of this property is not supported when updating transport node. Use the CLI to change this property.

Returns:

The current value of the property.

setAllowSshRootLogin

public void setAllowSshRootLogin(java.lang.Boolean allowSshRootLogin)

Allowing root SSH logins is not recommended for security reasons. Edit of this property is not supported when updating transport node. Use the CLI to change this property.

Parameters:

allowSshRootLogin - New value for the property.

getDnsServers

public java.util.List<java.lang.String> getDnsServers()

List of DNS servers. format: ip

Returns:

The current value of the property.

setDnsServers

public void setDnsServers(java.util.List<java.lang.String> dnsServers)

List of DNS servers. format: ip

Parameters:

dnsServers - New value for the property.

getEnableSsh

public java.lang.Boolean getEnableSsh()

Enabling SSH service is not recommended for security reasons.

Returns:

The current value of the property.

setEnableSsh

public void setEnableSsh(java.lang.Boolean enableSsh)

Enabling SSH service is not recommended for security reasons.

Parameters:

enableSsh - New value for the property.

getEnableUptMode

public java.lang.Boolean getEnableUptMode()

Returns:

The current value of the property.

setEnableUptMode

public void setEnableUptMode(java.lang.Boolean enableUptMode)

Parameters:

enableUptMode - New value for the property.

getHostname

public java.lang.String getHostname()

Host name or FQDN for edge node.

Returns:

The current value of the property.

setHostname

public void setHostname(java.lang.String hostname)

Host name or FQDN for edge node.

Parameters:

hostname - New value for the property.

getNtpServers

public java.util.List<java.lang.String> getNtpServers()

List of NTP servers. format: hostname-or-ip

Returns:

The current value of the property.

setNtpServers

public void setNtpServers(java.util.List<java.lang.String> ntpServers)

List of NTP servers. format: hostname-or-ip

Parameters:

ntpServers - New value for the property.

getSearchDomains

public java.util.List<java.lang.String> getSearchDomains()

List of domain names that are used to complete unqualified host names.

Returns:

The current value of the property.

setSearchDomains

public void setSearchDomains(java.util.List<java.lang.String> searchDomains)

List of domain names that are used to complete unqualified host names.

Parameters:

searchDomains - New value for the property.

getSyslogServers

public java.util.List<SyslogConfiguration> getSyslogServers()

List of Syslog server configuration.

Returns:

The current value of the property.

setSyslogServers

public void setSyslogServers(java.util.List<SyslogConfiguration> syslogServers)

List of Syslog server configuration.

Parameters:

syslogServers - 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 EdgeNodeSettings _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 EdgeNodeSettings _newInstance2(com.vmware.vapi.data.StructValue structValue)

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