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?: string[]
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.

EndpointID?: string

Unique ID for the service endpoint in a Sandbox.

Gateway?: string

Gateway address for this network.

GlobalIPv6Address?: string

Global IPv6 address.

GlobalIPv6PrefixLen?: number

Mask length of the global IPv6 address.

IPAMConfig?: null | EndpointIPAMConfig
IPAddress?: string

IPv4 address.

IPPrefixLen?: number

Mask length of the IPv4 address.

IPv6Gateway?: string

IPv6 gateway address.

Links?: string[]
MacAddress?: string

MAC address for the endpoint on this network.

NetworkID?: string

Unique ID of the network.