Interface EndpointSettings

Configuration for a network endpoint. EndpointSettings

interface EndpointSettings {
    Aliases?: string[];
    DriverOpts?: null | {
        [key: string]: string;
    };
    EndpointID?: string;
    Gateway?: string;
    GlobalIPv6Address?: string;
    GlobalIPv6PrefixLen?: number;
    IPAMConfig?: null | EndpointIPAMConfig;
    IPAddress?: string;
    IPPrefixLen?: number;
    IPv6Gateway?: string;
    Links?: string[];
    MacAddress?: string;
    NetworkID?: string;
}

Properties

Aliases? DriverOpts? EndpointID? Gateway? GlobalIPv6Address? GlobalIPv6PrefixLen? IPAMConfig? IPAddress? IPPrefixLen? IPv6Gateway? Links? MacAddress? NetworkID?

Properties

OptionalAliases

Aliases?: string[]

OptionalDriverOpts

DriverOpts?: null | {
    [key: string]: string;
}

DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.

OptionalEndpointID

EndpointID?: string

Unique ID for the service endpoint in a Sandbox.

OptionalGateway

Gateway?: string

Gateway address for this network.

OptionalGlobalIPv6Address

GlobalIPv6Address?: string

Global IPv6 address.

OptionalGlobalIPv6PrefixLen

GlobalIPv6PrefixLen?: number

Mask length of the global IPv6 address.

OptionalIPAMConfig

IPAMConfig?: null | EndpointIPAMConfig

OptionalIPAddress

IPAddress?: string

IPv4 address.

OptionalIPPrefixLen

IPPrefixLen?: number

Mask length of the IPv4 address.

OptionalIPv6Gateway

IPv6Gateway?: string

IPv6 gateway address.

OptionalLinks

Links?: string[]

OptionalMacAddress

MacAddress?: string

MAC address for the endpoint on this network.

OptionalNetworkID

NetworkID?: string

Unique ID of the network.

Settings

Member Visibility

On This Page

Properties