Type Alias: Network ​
Network:
object
Type declaration ​
| Name | Type | Description |
|---|---|---|
Attachable? | boolean | Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. |
ConfigFrom? | ConfigReference | - |
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. |
Containers? | object | Contains endpoints attached to the network. |
Created? | string | Date and time at which the network was created in RFC 3339 format with nano-seconds. |
Driver? | string | The name of the driver used to create the network (e.g. bridge, overlay). |
EnableIPv4? | boolean | Whether the network was created with IPv4 enabled. |
EnableIPv6? | boolean | Whether the network was created with IPv6 enabled. |
Id? | string | ID that uniquely identifies a network on a single machine. |
Ingress? | boolean | Whether the network is providing the routing-mesh for the swarm cluster. |
Internal? | boolean | Whether the network is created to only allow internal networking connectivity. |
IPAM? | IPAM | - |
Labels? | object | User-defined key/value metadata. |
Name? | string | Name of the network. |
Options? | object | Network-specific options uses when creating the network. |
Peers? | PeerInfo[] | null | List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. |
Scope? | string | The level at which the network exists (e.g. swarm for cluster-wide or local for machine level) |