com.vmware.nsx.model

Class IPv4DhcpServer

java.lang.Object

com.vmware.nsx.model.IPv4DhcpServer

All Implemented Interfaces:

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

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

DHCP server to support IPv4 DHCP service. Properties defined at DHCP server level can be overridden by ip-pool or static-binding level properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	IPv4DhcpServer() Default constructor.
protected	IPv4DhcpServer(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 IPv4DhcpServer	_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 IPv4DhcpServer	_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	getDhcpServerIp() DHCP server ip in CIDR format.
java.util.List<java.lang.String>	getDnsNameservers() Primary and secondary DNS server address to assign host.
java.lang.String	getDomainName() Host name or prefix to be assigned to host.
java.lang.String	getGatewayIp() Gateway ip to be assigned to host.
java.lang.Boolean	getMonitorIppoolUsage() Enable or disable monitoring of DHCP ip-pools usage.
DhcpOptions	getOptions()
int	hashCode()
void	setDhcpServerIp(java.lang.String dhcpServerIp) DHCP server ip in CIDR format.
void	setDnsNameservers(java.util.List<java.lang.String> dnsNameservers) Primary and secondary DNS server address to assign host.
void	setDomainName(java.lang.String domainName) Host name or prefix to be assigned to host.
void	setGatewayIp(java.lang.String gatewayIp) Gateway ip to be assigned to host.
void	setMonitorIppoolUsage(java.lang.Boolean monitorIppoolUsage) Enable or disable monitoring of DHCP ip-pools usage.
void	setOptions(DhcpOptions options)
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

IPv4DhcpServer

public IPv4DhcpServer()

Default constructor.

IPv4DhcpServer

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

Method Detail

getDhcpServerIp

public java.lang.String getDhcpServerIp()

DHCP server ip in CIDR format. format: ipv4-cidr-block

Returns:

The current value of the property.

setDhcpServerIp

public void setDhcpServerIp(java.lang.String dhcpServerIp)

DHCP server ip in CIDR format. format: ipv4-cidr-block

Parameters:

dhcpServerIp - New value for the property.

getDnsNameservers

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

Primary and secondary DNS server address to assign host. They can be overridden by ip-pool or static-binding level property. format: ipv4

Returns:

The current value of the property.

setDnsNameservers

public void setDnsNameservers(java.util.List<java.lang.String> dnsNameservers)

Primary and secondary DNS server address to assign host. They can be overridden by ip-pool or static-binding level property. format: ipv4

Parameters:

dnsNameservers - New value for the property.

getDomainName

public java.lang.String getDomainName()

Host name or prefix to be assigned to host. It can be overridden by ip-pool or static-binding level property. format: hostname

Returns:

The current value of the property.

setDomainName

public void setDomainName(java.lang.String domainName)

Host name or prefix to be assigned to host. It can be overridden by ip-pool or static-binding level property. format: hostname

Parameters:

domainName - New value for the property.

getGatewayIp

public java.lang.String getGatewayIp()

Gateway ip to be assigned to host. It can be overridden by ip-pool or static-binding level property. format: ipv4

Returns:

The current value of the property.

setGatewayIp

public void setGatewayIp(java.lang.String gatewayIp)

Gateway ip to be assigned to host. It can be overridden by ip-pool or static-binding level property. format: ipv4

Parameters:

gatewayIp - New value for the property.

getMonitorIppoolUsage

public java.lang.Boolean getMonitorIppoolUsage()

Enable or disable monitoring of DHCP ip-pools usage. When enabled, system events are generated when pool usage exceeds the configured thresholds. System events can be viewed in REST API /api/v2/hpm/alarms

Returns:

The current value of the property.

setMonitorIppoolUsage

public void setMonitorIppoolUsage(java.lang.Boolean monitorIppoolUsage)

Enable or disable monitoring of DHCP ip-pools usage. When enabled, system events are generated when pool usage exceeds the configured thresholds. System events can be viewed in REST API /api/v2/hpm/alarms

Parameters:

monitorIppoolUsage - New value for the property.

getOptions

public DhcpOptions getOptions()

Returns:

The current value of the property.

setOptions

public void setOptions(DhcpOptions options)

Parameters:

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

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