Interface NetworkCreateRequest

NetworkCreateRequest

interface NetworkCreateRequest {
    Attachable?: boolean;
    CheckDuplicate?: boolean;
    ConfigFrom?: ConfigReference;
    ConfigOnly?: boolean;
    Driver?: string;
    EnableIPv6?: boolean;
    IPAM?: IPAM;
    Ingress?: boolean;
    Internal?: boolean;
    Labels?: {
        [key: string]: string;
    };
    Name: string;
    Options?: {
        [key: string]: string;
    };
    Scope?: string;
}

Properties

Attachable?: boolean

Globally scoped network is manually attachable by regular containers from workers in swarm mode.

CheckDuplicate?: boolean

Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions.

ConfigFrom?: ConfigReference
ConfigOnly?: boolean

Creates 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.

Driver?: string

Name of the network driver plugin to use.

EnableIPv6?: boolean

Enable IPv6 on the network.

IPAM?: IPAM
Ingress?: boolean

Ingress network is the network which provides the routing-mesh in swarm mode.

Internal?: boolean

Restrict external access to the network.

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

User-defined key/value metadata.

Name: string

The network's name.

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

Network specific options to be used by the drivers.

Scope?: string

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