Skip to main content

Interface: EndpointSettings

Defined in: packages/extension-api/src/extension-api.d.ts:3278

Properties​

Aliases?​

optional Aliases?: string[]

Defined in: packages/extension-api/src/extension-api.d.ts:3291

DNSNames?​

optional DNSNames?: string[]

Defined in: packages/extension-api/src/extension-api.d.ts:3346

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.

DriverOpts?​

optional DriverOpts?: object

Defined in: packages/extension-api/src/extension-api.d.ts:3336

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

EndpointID?​

optional EndpointID?: string

Defined in: packages/extension-api/src/extension-api.d.ts:3301

Unique ID for the service endpoint in a Sandbox.

Gateway?​

optional Gateway?: string

Defined in: packages/extension-api/src/extension-api.d.ts:3306

Gateway address for this network.

GlobalIPv6Address?​

optional GlobalIPv6Address?: string

Defined in: packages/extension-api/src/extension-api.d.ts:3326

Global IPv6 address.

GlobalIPv6PrefixLen?​

optional GlobalIPv6PrefixLen?: number

Defined in: packages/extension-api/src/extension-api.d.ts:3331

Mask length of the global IPv6 address.

IPAddress?​

optional IPAddress?: string

Defined in: packages/extension-api/src/extension-api.d.ts:3311

IPv4 address.

IPAMConfig?​

optional IPAMConfig?: EndpointIPAMConfig

Defined in: packages/extension-api/src/extension-api.d.ts:3282

EndpointIPAMConfig represents an endpoint's IPAM configuration.

IPPrefixLen?​

optional IPPrefixLen?: number

Defined in: packages/extension-api/src/extension-api.d.ts:3316

Mask length of the IPv4 address.

IPv6Gateway?​

optional IPv6Gateway?: string

Defined in: packages/extension-api/src/extension-api.d.ts:3321

IPv6 gateway address.

optional Links?: string[]

Defined in: packages/extension-api/src/extension-api.d.ts:3284

MacAddress?​

optional MacAddress?: string

Defined in: packages/extension-api/src/extension-api.d.ts:3289

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

NetworkID?​

optional NetworkID?: string

Defined in: packages/extension-api/src/extension-api.d.ts:3296

Unique ID of the network.