Type Alias UpdateDHCPRequest

UpdateDHCPRequest: {
    address?: string;
    dhcpId: string;
    dnsLocalName?: string;
    dnsSearch?: string[];
    dnsServersOverride?: string[];
    enableDynamic?: boolean;
    poolHigh?: string;
    poolLow?: string;
    pushDefaultRoute?: boolean;
    pushDnsServer?: boolean;
    rebindTimer?: string;
    renewTimer?: string;
    subnet?: string;
    validLifetime?: string;
    zone?: Zone;
}

Type declaration

  • Optionaladdress?: 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.

  • dhcpId: string

    DHCP configuration to update.

  • OptionaldnsLocalName?: 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. Allowed characters are a-z0-9-..

  • OptionaldnsSearch?: string[]

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

  • OptionaldnsServersOverride?: string[]

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

  • OptionalenableDynamic?: boolean

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

  • OptionalpoolHigh?: string

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

  • OptionalpoolLow?: string

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

  • OptionalpushDefaultRoute?: boolean

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

  • OptionalpushDnsServer?: boolean

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

  • OptionalrebindTimer?: 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?: string

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

  • Optionalsubnet?: string

    Subnet for the DHCP server.

  • OptionalvalidLifetime?: string

    How long DHCP entries will be valid for.

  • Optionalzone?: Zone

    Zone to target. If none is passed will use default zone from the config.

Settings