Interface Network

Network

interface Network {
    Attachable?: boolean;
    ConfigFrom?: ConfigReference;
    ConfigOnly?: boolean;
    Containers?: {
        [key: string]: NetworkContainer;
    };
    Created?: string;
    Driver?: string;
    EnableIPv6?: boolean;
    IPAM?: IPAM;
    Id?: string;
    Ingress?: boolean;
    Internal?: boolean;
    Labels?: {
        [key: string]: string;
    };
    Name?: string;
    Options?: {
        [key: string]: string;
    };
    Peers?: null | PeerInfo[];
    Scope?: string;
}

Properties

Attachable? ConfigFrom? ConfigOnly? Containers? Created? Driver? EnableIPv6? IPAM? Id? Ingress? Internal? Labels? Name? Options? Peers? Scope?

Properties

OptionalAttachable

Attachable?: boolean

Wheter a global / swarm scope network is manually attachable by regular containers from workers in swarm mode.

OptionalConfigFrom

ConfigFrom?: ConfigReference

OptionalConfigOnly

ConfigOnly?: boolean

Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services.

OptionalContainers

Containers?: {
    [key: string]: NetworkContainer;
}

Contains endpoints attached to the network.

OptionalCreated

Created?: string

Date and time at which the network was created in RFC 3339 format with nano-seconds.

OptionalDriver

Driver?: string

The name of the driver used to create the network (e.g. bridge, overlay).

OptionalEnableIPv6

EnableIPv6?: boolean

Whether the network was created with IPv6 enabled.

OptionalIPAM

IPAM?: IPAM

OptionalId

Id?: string

ID that uniquely identifies a network on a single machine.

OptionalIngress

Ingress?: boolean

Whether the network is providing the routing-mesh for the swarm cluster.

OptionalInternal

Internal?: boolean

Whether the network is created to only allow internal networking connectivity.

OptionalLabels

Labels?: {
    [key: string]: string;
}

User-defined key/value metadata.

OptionalName

Name?: string

Name of the network.

OptionalOptions

Options?: {
    [key: string]: string;
}

Network-specific options uses when creating the network.

OptionalPeers

Peers?: null | PeerInfo[]

List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types.

OptionalScope

Scope?: string

The level at which the network exists (e.g. swarm for cluster-wide or local for machine level)

Settings

Member Visibility

On This Page

Properties