Skip to content

dsdk / v1.47 / EndpointSettings

Type Alias: EndpointSettings ​

EndpointSettings: object

Configuration for a network endpoint.

Type declaration ​

NameTypeDescription
Aliases?string[]-
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.
DriverOpts?object | nullDriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.
EndpointID?stringUnique ID for the service endpoint in a Sandbox.
Gateway?stringGateway address for this network.
GlobalIPv6Address?stringGlobal IPv6 address.
GlobalIPv6PrefixLen?numberMask length of the global IPv6 address.
IPAddress?stringIPv4 address.
IPAMConfig?EndpointIPAMConfig-
IPPrefixLen?numberMask length of the IPv4 address.
IPv6Gateway?stringIPv6 gateway address.
Links?string[]-
MacAddress?stringMAC address for the endpoint on this network. The network driver might ignore this parameter.
NetworkID?stringUnique ID of the network.