CreateNetworkOptions

Defined in: src/network.ts:11

Properties

driver?

optional driver?: "bridge";

Defined in: src/network.ts:13

Docker network driver. Defaults to 'bridge'.

exclusive?

optional exclusive?: boolean;

Defined in: src/network.ts:24

When true, fail (return false) if the network already exists. Default false = idempotent: returns true whether we created it or it already existed.

iccEnabled?

optional iccEnabled?: boolean;

Defined in: src/network.ts:18

Inter-container communication. Defaults to false: containers attached to the network cannot reach each other. Only honored for bridge driver.

ipam?

optional ipam?: {
  gateway?: string;
  ipRange?: string;
  subnet?: string;
};

Defined in: src/network.ts:33

Explicit IPAM (IP Address Management) config. When omitted, Docker auto-assigns a subnet from its default pool. Pass this to let a higher layer (typically light-process) allocate a specific subnet per run from a CGNAT pool or any other range.

gateway?

optional gateway?: string;

Gateway IP. Docker picks the first usable address when omitted.

ipRange?

optional ipRange?: string;

Optional sub-range within subnet where Docker is allowed to auto-assign IPs. Outside this range stays reserved for static assignment. Rare.

subnet?

optional subnet?: string;

CIDR de la plage IP du réseau, ex: '100.64.42.0/24'.

labels?

optional labels?: Record<string, string>;

Defined in: src/network.ts:26

Optional Docker labels (helpful for downstream tooling / cleanup).