Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.model/NetworkCreateRequest

NetworkCreateRequest

@Serializable

data class NetworkCreateRequest(val name: String, val driver: String? = "bridge", val scope: String? = null, val internal: Boolean? = null, val attachable: Boolean? = null, val ingress: Boolean? = null, val configOnly: Boolean? = false, val configFrom: ConfigReference? = null, val IPAM: IPAM? = null, val enableIPv4: Boolean? = null, val enableIPv6: Boolean? = null, val options: Map<String, String>? = null, val labels: Map<String, String>? = null)

Parameters

name

The network's name.

driver

Name of the network driver plugin to use.

scope

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

`internal`

Restrict external access to the network.

attachable

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

ingress

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

configOnly

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.

configFrom

IPAM

enableIPv4

Enable IPv4 on the network.

enableIPv6

Enable IPv6 on the network.

options

Network specific options to be used by the drivers.

labels

User-defined key/value metadata.

Constructors

NetworkCreateRequest

constructor(name: String, driver: String? = "bridge", scope: String? = null, internal: Boolean? = null, attachable: Boolean? = null, ingress: Boolean? = null, configOnly: Boolean? = false, configFrom: ConfigReference? = null, IPAM: IPAM? = null, enableIPv4: Boolean? = null, enableIPv6: Boolean? = null, options: Map<String, String>? = null, labels: Map<String, String>? = null)