Provides detailed information about a Docker network. More...

Inheritance diagram for DockerSdk.Networks.INetworkInfo:

Properties
IReadOnlyList< IContainer >	AttachedContainers `[get]`
	Gets the containers that are attached to the network. More...

DateTimeOffset	CreationTime `[get]`
	Gets the date and time at which the network was created. More...

IReadOnlyList< INetworkEndpoint >	Endpoints `[get]`
	Gets the endpoints that exist for the network. An endpoint defines an attachment point between a network and a container. More...

IReadOnlyDictionary< ContainerName, INetworkEndpoint >	EndpointsByContainerName `[get]`
	Gets a mapping from container names to endpoints. An endpoint defines an attachment point between a network and a container. More...

string	IpamDriverName `[get]`
	Gets the type of Docker IPAM driver that the network uses. More...

IReadOnlyDictionary< string, string >	IpamDriverOptions `[get]`
	Gets a list of the options provided to the network's IPAM driver. More...

bool	IsAttachable `[get]`
	Gets a value indicating whether the network can be attached to a container. More...

bool	IsIngress `[get]`
	Gets a value indicating whether the network is a swarm routing-mesh network. More...

bool	IsInternalOnly `[get]`
	Gets a value indicating whether the network is "internal". More...

bool	IsIPv6Enabled `[get]`
	Gets a value indicating whether IPv6 networking is enabled. More...

IReadOnlyDictionary< string, string >	Labels `[get]`
	Gets the labels and their values that have been applied to the network. More...

NetworkName	Name `[get]`
	Gets the network's name. More...

string	NetworkDriverName `[get]`
	Gets the string identifier for the network driver that operates this network. More...

IReadOnlyDictionary< string, string >	NetworkDriverOptions `[get]`
	Gets a list of the options provided to the network driver. More...

IReadOnlyList< NetworkPool >	Pools `[get]`
	Gets the address pools that the IPAM driver can use when assigning IP addresses. More...

NetworkScope	Scope `[get]`
	Gets the network's scope. More...

Properties inherited from DockerSdk.Networks.INetwork
NetworkFullId	Id `[get]`
	Gets the networks's full ID. More...

Additional Inherited Members
Public Member Functions inherited from DockerSdk.Networks.INetwork
Task	AttachAsync (ContainerReference container, CancellationToken ct=default)
	Attaches the network to a Docker container. More...

Task	AttachAsync (ContainerReference container, AttachNetworkOptions options, CancellationToken ct=default)
	Attaches the network to a Docker container. More...

Task	AttachAsync (string container, CancellationToken ct=default)
	Attaches the network to a Docker container. More...

Task	AttachAsync (string container, AttachNetworkOptions options, CancellationToken ct=default)
	Attaches the network to a Docker container. More...

Task< INetworkInfo >	GetDetailsAsync (CancellationToken ct=default)
	Loads detailed information about the Docker network. More...

Detailed Description

Provides detailed information about a Docker network.

This class holds a snapshot in time. Its information is immutable once created.

Property Documentation

◆ AttachedContainers

IReadOnlyList<IContainer> DockerSdk.Networks.INetworkInfo.AttachedContainers

get

Gets the containers that are attached to the network.

See also: Endpoints, EndpointsByContainerName

◆ CreationTime

DateTimeOffset DockerSdk.Networks.INetworkInfo.CreationTime

get

Gets the date and time at which the network was created.

◆ Endpoints

IReadOnlyList<INetworkEndpoint> DockerSdk.Networks.INetworkInfo.Endpoints

get

Gets the endpoints that exist for the network. An endpoint defines an attachment point between a network and a container.

See also: AttachedContainers, EndpointsByContainerName

◆ EndpointsByContainerName

IReadOnlyDictionary<ContainerName, INetworkEndpoint> DockerSdk.Networks.INetworkInfo.EndpointsByContainerName

get

Gets a mapping from container names to endpoints. An endpoint defines an attachment point between a network and a container.

See also: Endpoints, AttachedContainers

◆ IpamDriverName

string DockerSdk.Networks.INetworkInfo.IpamDriverName

get

Gets the type of Docker IPAM driver that the network uses.

◆ IpamDriverOptions

IReadOnlyDictionary<string, string> DockerSdk.Networks.INetworkInfo.IpamDriverOptions

get

Gets a list of the options provided to the network's IPAM driver.

◆ IsAttachable

bool DockerSdk.Networks.INetworkInfo.IsAttachable

get

Gets a value indicating whether the network can be attached to a container.

◆ IsIngress

bool DockerSdk.Networks.INetworkInfo.IsIngress

get

Gets a value indicating whether the network is a swarm routing-mesh network.

There can only be one ingress network at a time. Ingress networks can only be swarm-scoped, and cannot be attachable.

◆ IsInternalOnly

bool DockerSdk.Networks.INetworkInfo.IsInternalOnly

get

Gets a value indicating whether the network is "internal".

By default, when you connect a container to a network, Docker also connects it to the Internet. Creating the network as internal prevents that.

◆ IsIPv6Enabled

bool DockerSdk.Networks.INetworkInfo.IsIPv6Enabled

get

Gets a value indicating whether IPv6 networking is enabled.

◆ Labels

IReadOnlyDictionary<string, string> DockerSdk.Networks.INetworkInfo.Labels

get

Gets the labels and their values that have been applied to the network.

◆ Name

NetworkName DockerSdk.Networks.INetworkInfo.Name

get

Gets the network's name.

◆ NetworkDriverName

string DockerSdk.Networks.INetworkInfo.NetworkDriverName

get

Gets the string identifier for the network driver that operates this network.

Built-in network drivers include "bridge", "overlay", "macvlan", and "none". Docker plugins may provide additional network drivers.

◆ NetworkDriverOptions

IReadOnlyDictionary<string, string> DockerSdk.Networks.INetworkInfo.NetworkDriverOptions

get

Gets a list of the options provided to the network driver.

◆ Pools

IReadOnlyList<NetworkPool> DockerSdk.Networks.INetworkInfo.Pools

get

Gets the address pools that the IPAM driver can use when assigning IP addresses.

◆ Scope

NetworkScope DockerSdk.Networks.INetworkInfo.Scope

get

Gets the network's scope.

The documentation for this interface was generated from the following file:

Networks/INetworkInfo.cs

Properties

Additional Inherited Members