Type Alias CreateDHCPRequest

CreateDHCPRequest: {
    address?: string;
    dnsLocalName?: string;
    dnsSearch?: string[];
    dnsServersOverride?: string[];
    enableDynamic?: boolean;
    poolHigh?: string;
    poolLow?: string;
    projectId?: 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 gateway's address in the Private Network. Defaults to the first address of the subnet.

  • OptionaldnsLocalName?: string

    TLD given to hostnames in the Private Network. Allowed characters are a-z0-9-.. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to priv.

  • 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. Defaults to the last address of the subnet.

  • OptionalpoolLow?: string

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

  • OptionalprojectId?: string

    Project to create the DHCP configuration in.

  • OptionalpushDefaultRoute?: boolean

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

  • OptionalpushDnsServer?: boolean

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

  • 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. Defaults to 51m (3060s).

  • OptionalrenewTimer?: string

    After how long a renew will be attempted. Must be 30s lower than rebind_timer. Defaults to 50m (3000s).

  • subnet: string

    Subnet for the DHCP server.

  • OptionalvalidLifetime?: string

    How long DHCP entries will be valid for. Defaults to 1h (3600s).

  • Optionalzone?: Zone

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

Settings