Interface DHCP

interface DHCP {
    address: string;
    createdAt?: Date;
    dnsLocalName: string;
    dnsSearch: string[];
    dnsServersOverride: string[];
    enableDynamic: boolean;
    id: string;
    organizationId: string;
    poolHigh: string;
    poolLow: string;
    projectId: string;
    pushDefaultRoute: boolean;
    pushDnsServer: boolean;
    rebindTimer?: string;
    renewTimer?: string;
    subnet: string;
    updatedAt?: Date;
    validLifetime?: string;
    zone: Zone;
}

Properties

address createdAt? dnsLocalName dnsSearch dnsServersOverride enableDynamic id organizationId poolHigh poolLow projectId pushDefaultRoute pushDnsServer rebindTimer? renewTimer? subnet updatedAt? validLifetime? zone

Properties

address

address: string

IP address of the DHCP server. This will be the Public Gateway's address in the Private Network. It must be part of config's subnet.

OptionalcreatedAt

createdAt?: Date

Date the DHCP configuration was created.

dnsLocalName

dnsLocalName: string

TLD given to hostnames in the Private Networks. If an Instance with hostname foo gets a lease, and this is set to bar, foo.bar will resolve.

dnsSearch

dnsSearch: string[]

Array of search paths in addition to the pushed DNS configuration.

dnsServersOverride

dnsServersOverride: string[]

Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself.

enableDynamic

enableDynamic: boolean

Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out.

id

id: string

ID of the DHCP config.

organizationId

organizationId: string

Owning Organization.

poolHigh

poolHigh: string

High IP (inclusive) of the dynamic address pool. Must be in the config's subnet.

poolLow

poolLow: string

Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet.

projectId

projectId: string

Owning Project.

pushDefaultRoute

pushDefaultRoute: boolean

Defines whether the gateway should push a default route to DHCP clients, or only hand out IPs.

pushDnsServer

pushDnsServer: boolean

Defines whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution.

OptionalrebindTimer

rebindTimer?: string

After how long a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than valid_lifetime.

OptionalrenewTimer

renewTimer?: string

After how long a renew will be attempted. Must be 30s lower than rebind_timer.

subnet

subnet: string

Subnet for the DHCP server.

OptionalupdatedAt

updatedAt?: Date

Configuration last modification date.

OptionalvalidLifetime

validLifetime?: string

How long DHCP entries will be valid for.

zone

zone: Zone

Zone of this DHCP configuration.

Settings

On This Page

Properties