Skip to main content

Interface: EndpointSettings

Properties​

Aliases?​

optional Aliases: string[]

Defined in​

packages/extension-api/src/extension-api.d.ts:2951

DNSNames?​

optional DNSNames: string[]

List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname.

These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet.

Defined in​

packages/extension-api/src/extension-api.d.ts:3006

DriverOpts?​

optional DriverOpts: object

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

Index Signature​

[key: string]: string

Defined in​

packages/extension-api/src/extension-api.d.ts:2996

EndpointID?​

optional EndpointID: string

Unique ID for the service endpoint in a Sandbox.

Defined in​

packages/extension-api/src/extension-api.d.ts:2961

Gateway?​

optional Gateway: string

Gateway address for this network.

Defined in​

packages/extension-api/src/extension-api.d.ts:2966

GlobalIPv6Address?​

optional GlobalIPv6Address: string

Global IPv6 address.

Defined in​

packages/extension-api/src/extension-api.d.ts:2986

GlobalIPv6PrefixLen?​

optional GlobalIPv6PrefixLen: number

Mask length of the global IPv6 address.

Defined in​

packages/extension-api/src/extension-api.d.ts:2991

IPAddress?​

optional IPAddress: string

IPv4 address.

Defined in​

packages/extension-api/src/extension-api.d.ts:2971

IPAMConfig?​

optional IPAMConfig: EndpointIPAMConfig

EndpointIPAMConfig represents an endpoint's IPAM configuration.

Defined in​

packages/extension-api/src/extension-api.d.ts:2942

IPPrefixLen?​

optional IPPrefixLen: number

Mask length of the IPv4 address.

Defined in​

packages/extension-api/src/extension-api.d.ts:2976

IPv6Gateway?​

optional IPv6Gateway: string

IPv6 gateway address.

Defined in​

packages/extension-api/src/extension-api.d.ts:2981

optional Links: string[]

Defined in​

packages/extension-api/src/extension-api.d.ts:2944

MacAddress?​

optional MacAddress: string

MAC address for the endpoint on this network. The network driver might ignore this parameter.

Defined in​

packages/extension-api/src/extension-api.d.ts:2949

NetworkID?​

optional NetworkID: string

Unique ID of the network.

Defined in​

packages/extension-api/src/extension-api.d.ts:2956