Skip to main content

Interface: EndpointSettings

Properties

Aliases?

optional Aliases: string[]

Source

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


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.

Source

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


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

Source

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


EndpointID?

optional EndpointID: string

Unique ID for the service endpoint in a Sandbox.

Source

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


Gateway?

optional Gateway: string

Gateway address for this network.

Source

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


GlobalIPv6Address?

optional GlobalIPv6Address: string

Global IPv6 address.

Source

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


GlobalIPv6PrefixLen?

optional GlobalIPv6PrefixLen: number

Mask length of the global IPv6 address.

Source

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


IPAMConfig?

optional IPAMConfig: EndpointIPAMConfig

EndpointIPAMConfig represents an endpoint's IPAM configuration.

Source

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


IPAddress?

optional IPAddress: string

IPv4 address.

Source

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


IPPrefixLen?

optional IPPrefixLen: number

Mask length of the IPv4 address.

Source

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


IPv6Gateway?

optional IPv6Gateway: string

IPv6 gateway address.

Source

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


optional Links: string[]

Source

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


MacAddress?

optional MacAddress: string

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

Source

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


NetworkID?

optional NetworkID: string

Unique ID of the network.

Source

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