The schema for
DHCP configuration consists of an object that has a data structure containing
general properties and the following objects:
■
|
staticBindings (Array)
|
■
|
ipPools (Array)
|
■
|
logging
|
For an example of the data
structure for the DHCP object, see
Example: Request and
Response to Get DHCP Configuration.
DHCP
CONFIGURATION
|
|
|
|
|
featureType
|
String
|
Yes
|
Identifies the
Advanced
Networking Services feature
Note
This element is set
as
"featureType" :
"dhcp_4.0". This value is required. Do not change it.
|
|
version
|
Number
|
Yes
|
Current version of the DHCP configuration
|
|
enabled
|
Boolean
|
No
|
Enables DHCP configuration
|
If you have services running on
a virtual machine and do not want the IP address to be changed, you can bind an
IP address to the MAC address of the virtual machine.
Important
The IP
address you bind must not overlap with an IP address in any other IP pool
configured for
vCloud Air.
Configure static bindings for
vCloud Air by
setting values for the following elements. Values can be strings, numbers,
objects, arrays, or literals (true, false, or null).
STATIC BINDING
(staticBindings –
Array)
|
|
|
|
|
autoConfigureDNS
|
Boolean
|
No
|
Uses the DNS service configuration for the DHCP
binding
By default,
autoConfigureDNS is set
to
true.
|
|
defaultGateway
|
String
|
No
|
The default IP address of the edge gateway
If the assigned IP
address belongs to a subnet of the edge gateway vNIC,
Advanced
Networking Services uses this IP address by default as the primary IP
address of the vNIC subnet.
When you do not set the
default gateway IP address, the internal interface of the edge gateway instance
is taken as the default gateway and client hosts will not get the default
gateway IP address from the DHCP server.
|
|
domainName
|
String
|
Yes
|
The domain name of the DNS server
|
|
primaryNameServer
|
String
|
No
|
The (master) authoritative name server for the
edge gateway
When
autoConfigDNS is set to
true, the DNS primary
IP addresses are generated from the DNS service.
When you do not set
autoConfigureDNS, use
primaryNameServer to
configure the DNS service. You must set the IP address of a DNS server for
hostname-to-IP address resolution.
|
|
secondaryNameServer
|
String
|
No
|
The backup (slave)
authoritative name server for the edge gateway
When
autoConfigDNS is set to
true, the secondary DNS
IP addresses are generated from the DNS service.
When you do not set
autoConfigureDNS, use
secondaryNameServer to
configure the DNS service. You must set the IP address of a DNS server for
hostname-to-IP address resolution.
|
|
leaseTime
|
String
|
No
|
Whether to lease the IP address to the client
Set a value in seconds.
By default, the value is
86400. To set the lease
to never expire, set this value to
infinite.
|
|
subnetMask
|
String
|
No
|
The subnet mask for the bound IP address
If the assigned IP
address belongs to a subnet of the edge gateway vNIC,
Advanced
Networking Services uses the
subnetMask of this vNIC
subnet; otherwise, the subnet mask is set to the default value of
255.255.255.0.
|
|
vmId
|
String
|
No
|
The virtual machine to bind
The virtual machine must
be bound to the vNIC set with
vnicId.
|
|
vnicId
|
Integer
|
No
|
The virtual machine vNIC to bind to the IP
address
Set a value from 0 to 9.
|
|
hostname
|
String
|
Yes
|
The host name of the DHCP client virtual
machine
|
|
macAddress
|
String
|
Yes
|
The MAC address of the virtual machine
|
|
ipAddress
|
String
|
Yes
|
The IP address bound to the MAC address of the
specified virtual machine
The IP address can
belong to a subnet of the edge gateway vNIC or be set to any valid IP address.
Important
The
IP address cannot overlap with any primary or secondary IP addresses defined
explicitly for the vNIC.
If the IP address does
not belong to any subnet of the edge gateway vNIC, you must ensure that the IP
address and subnet mask for the edge gateway are correctly configured.
|
The DHCP service requires a pool
of IP addresses. An IP pool is a sequential range of IP addresses within the
network. Virtual machines protected by the edge gateway that do not have an
address binding are allocated an IP address from this pool.
Important
An IP pool's
range cannot intersect one another, thus one IP address can belong to only one
IP pool.
Configure the DHCP IP pool for
by setting values for the following elements. Values can be strings, numbers,
objects, arrays, or literals (true, false, or null).
DHCP IP POOL
(ipPools –
Array)
|
|
|
|
|
autoConfigureDNS
|
Boolean
|
No
|
Uses the DNS service configuration for the
DHCP binding
By default,
autoConfigureDNS is set
to
true.
|
|
defaultGateway
|
String
|
No
|
The default gateway IP address
When the value of
ipRange belongs to a
subnet of the edge gateway vNIC,
Advanced
Networking Services uses this IP address by default as the primary IP
address of the vNIC subnet; otherwise, ensure you have set the correct IP
address for the edge gateway.
When you do not set the
default gateway IP address, the internal interface of the edge gateway instance
is taken as the default gateway and client hosts will not get the default
gateway IP address from the DHCP server.
|
|
domainName
|
String
|
Yes
|
The domain name of the DNS server
|
|
primaryNameServer
|
String
|
No
|
The (master) authoritative name server for the
edge gateway
When
autoConfigDNS is set to
true, the DNS primary
IP addresses are generated from the DNS service.
When you do not set
autoConfigureDNS, use
primaryNameServer to
configure the DNS service. You must set the IP address of a DNS server for
hostname-to-IP address resolution.
|
|
secondaryNameServer
|
String
|
No
|
The backup (slave)
authoritative name server for the edge gateway
When
autoConfigDNS is set to
true, the DNS secondary
IP addresses are generated from the DNS service.
When you do not set
autoConfigureDNS, use
secondaryNameServer to
configure the DNS service. You must set the IP address of a DNS server for
hostname-to-IP address resolution.
|
|
leaseTime
|
String
|
No
|
Whether to lease the IP address to the client
Set a value in seconds.
By default, the value is
86400. To set the lease
to never expire, set this value to
infinite.
|
|
dnsType
|
String
|
No
|
Sets the DNS type
Because DHCP selects the
IP address for the IP pool randomly, the FQDN and the IP address of the nodes
in a cluster are random. A Hadoop user or application cannot identify where the
master nodes are unless they do a query to Big Data Extensions. Even when the
user knows the original IP address, the address might change when the cluster
is restarted. Therefore, it is difficult for the Hadoop user or application to
access the cluster.
Therefore, set a value
for the
dnsType:
■
|
normal
The DNS server
provides both forward and reverse FQDN to IP address resolution. Reverse DNS
provides IP address to domain name mapping. Forward (normal) DNS maps domain
names to IP addresses. By default, the
dnsType is set to
normal.
|
■
|
dynamic
Dynamic DNS (DDNS or
DynDNS) is a method of automatically updating a name server in the Domain Name
System (DNS) with the active DNS configuration of its configured hostnames, IP
addresses, or other information. Big Data Extensions integrates with a dynamic
DNS server in its network through which it provides meaningful hostnames to the
nodes in a Hadoop cluster. The cluster will automatically register with the DNS
server.
|
■
|
others
The VLAN does not
have a DNS server, or it does not provide normal DNS resolution or Dynamic DNS
services. In this case, you must add FQDN and IP address mapping for all nodes
in the
/etc/hosts file for
each node in the cluster. Through this mapping of hostnames to IP addresses
each node can contact another node in the cluster.
|
|
|
subnetMask
|
String
|
No
|
When the assigned IP address belongs to a
subnet of the edge gateway vNIC,
Advanced
Networking Services uses the
subnetMask of this vNIC
subnet; otherwise, the subnet mask is set to the default value of
255.255.255.0.
|
|
ipRange
|
String
|
Yes
|
Sets the IP address range
The
ipRange can belong to a
subnet of the edge gateway vNIC or any valid
ipRange outside any
edge gateway subnets.
Important
The
ipRange cannot overlap
with any primary or secondary IP addresses defined explicitly for the vNIC.
When theipRange does not belong
to any subnet of the edge gateway vNIC, you must ensure that the IP address and
subnet mask for the edge gateway are correctly configured.
|
|
allowHugeRange
|
Boolean
|
No
|
Allows you to set the
value of
ipRange higher than
65535
To protect to memory consumption, by default,
Advanced
Networking Services does not allow you to specify an IP range that contains
more than 65535 IP addresses. To set the value of
ipRange higher than
65535, you must
explicitly set
allowHugeRange to
true.
By default,
allowHugeRange is set
to
false.
|
LOGGING (logging)
|
|
|
|
|
enable
|
Boolean
|
No
|
The DHCP service for the edge gateway collects
traffic logs
|
|
logLevel
|
String
|
No
|
The log level to use; for example,
info
|