1. Packages
  2. Packages
  3. Docker Provider
  4. API Docs
  5. getNetwork
Viewing docs for Docker v5.0.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-docker

docker.getNetwork

docker logo
Viewing docs for Docker v5.0.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-docker

    docker.Network provides details about a specific Docker Network.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const main = docker.getNetwork({
    name: "main",
});

    import pulumi
import pulumi_docker as docker

main = docker.get_network(name="main")

    package main

import (
	"github.com/pulumi/pulumi-docker/sdk/v5/go/docker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docker.GetNetwork(ctx, &docker.LookupNetworkArgs{
			Name: "main",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Docker = Pulumi.Docker;

return await Deployment.RunAsync(() => 
{
    var main = Docker.Index.GetNetwork.Invoke(new()
    {
        Name = "main",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.DockerFunctions;
import com.pulumi.docker.inputs.GetNetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var main = DockerFunctions.getNetwork(GetNetworkArgs.builder()
            .name("main")
            .build());

    }
}

    variables:
  main:
    fn::invoke:
      function: docker:getNetwork
      arguments:
        name: main

    Using getNetwork

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>
    def get_network(name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetNetworkResult
def get_network_output(name: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]
    func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput

    > Note: This function is named LookupNetwork in the Go SDK.

    public static class GetNetwork 
{
    public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)

    fn::invoke:
  function: docker:index/getNetwork:getNetwork
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the Docker network.
    Name string
    The name of the Docker network.
    name String
    The name of the Docker network.
    name string
    The name of the Docker network.
    name str
    The name of the Docker network.
    name String
    The name of the Docker network.

    getNetwork Result

    The following output properties are available:

    Containers List<GetNetworkContainer>
    Containers attached to the network.
    Driver string
    The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See network docs for more details.
    Id string
    The ID of this resource.
    Internal bool
    If true, the network is internal.
    IpamConfigs List<GetNetworkIpamConfig>
    The IPAM configuration options
    Name string
    The name of the Docker network.
    Options Dictionary<string, string>
    Only available with bridge networks. See bridge options docs for more details.
    Scope string
    Scope of the network. One of swarm, global, or local.
    Containers []GetNetworkContainer
    Containers attached to the network.
    Driver string
    The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See network docs for more details.
    Id string
    The ID of this resource.
    Internal bool
    If true, the network is internal.
    IpamConfigs []GetNetworkIpamConfig
    The IPAM configuration options
    Name string
    The name of the Docker network.
    Options map[string]string
    Only available with bridge networks. See bridge options docs for more details.
    Scope string
    Scope of the network. One of swarm, global, or local.
    containers List<GetNetworkContainer>
    Containers attached to the network.
    driver String
    The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See network docs for more details.
    id String
    The ID of this resource.
    internal Boolean
    If true, the network is internal.
    ipamConfigs List<GetNetworkIpamConfig>
    The IPAM configuration options
    name String
    The name of the Docker network.
    options Map<String,String>
    Only available with bridge networks. See bridge options docs for more details.
    scope String
    Scope of the network. One of swarm, global, or local.
    containers GetNetworkContainer[]
    Containers attached to the network.
    driver string
    The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See network docs for more details.
    id string
    The ID of this resource.
    internal boolean
    If true, the network is internal.
    ipamConfigs GetNetworkIpamConfig[]
    The IPAM configuration options
    name string
    The name of the Docker network.
    options {[key: string]: string}
    Only available with bridge networks. See bridge options docs for more details.
    scope string
    Scope of the network. One of swarm, global, or local.
    containers Sequence[GetNetworkContainer]
    Containers attached to the network.
    driver str
    The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See network docs for more details.
    id str
    The ID of this resource.
    internal bool
    If true, the network is internal.
    ipam_configs Sequence[GetNetworkIpamConfig]
    The IPAM configuration options
    name str
    The name of the Docker network.
    options Mapping[str, str]
    Only available with bridge networks. See bridge options docs for more details.
    scope str
    Scope of the network. One of swarm, global, or local.
    containers List<Property Map>
    Containers attached to the network.
    driver String
    The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See network docs for more details.
    id String
    The ID of this resource.
    internal Boolean
    If true, the network is internal.
    ipamConfigs List<Property Map>
    The IPAM configuration options
    name String
    The name of the Docker network.
    options Map<String>
    Only available with bridge networks. See bridge options docs for more details.
    scope String
    Scope of the network. One of swarm, global, or local.

    Supporting Types

    GetNetworkContainer

    ContainerId string
    The container id.
    EndpointId string
    The endpoint id.
    Ipv4Address string
    The IPv4 address.
    Ipv6Address string
    The IPv6 address.
    MacAddress string
    The MAC address.
    Name string
    The container name.
    ContainerId string
    The container id.
    EndpointId string
    The endpoint id.
    Ipv4Address string
    The IPv4 address.
    Ipv6Address string
    The IPv6 address.
    MacAddress string
    The MAC address.
    Name string
    The container name.
    containerId String
    The container id.
    endpointId String
    The endpoint id.
    ipv4Address String
    The IPv4 address.
    ipv6Address String
    The IPv6 address.
    macAddress String
    The MAC address.
    name String
    The container name.
    containerId string
    The container id.
    endpointId string
    The endpoint id.
    ipv4Address string
    The IPv4 address.
    ipv6Address string
    The IPv6 address.
    macAddress string
    The MAC address.
    name string
    The container name.
    container_id str
    The container id.
    endpoint_id str
    The endpoint id.
    ipv4_address str
    The IPv4 address.
    ipv6_address str
    The IPv6 address.
    mac_address str
    The MAC address.
    name str
    The container name.
    containerId String
    The container id.
    endpointId String
    The endpoint id.
    ipv4Address String
    The IPv4 address.
    ipv6Address String
    The IPv6 address.
    macAddress String
    The MAC address.
    name String
    The container name.

    GetNetworkIpamConfig

    AuxAddress Dictionary<string, string>
    Auxiliary IPv4 or IPv6 addresses used by Network driver
    Gateway string
    The IP address of the gateway
    IpRange string
    The ip range in CIDR form
    Subnet string
    The subnet in CIDR form
    AuxAddress map[string]string
    Auxiliary IPv4 or IPv6 addresses used by Network driver
    Gateway string
    The IP address of the gateway
    IpRange string
    The ip range in CIDR form
    Subnet string
    The subnet in CIDR form
    auxAddress Map<String,String>
    Auxiliary IPv4 or IPv6 addresses used by Network driver
    gateway String
    The IP address of the gateway
    ipRange String
    The ip range in CIDR form
    subnet String
    The subnet in CIDR form
    auxAddress {[key: string]: string}
    Auxiliary IPv4 or IPv6 addresses used by Network driver
    gateway string
    The IP address of the gateway
    ipRange string
    The ip range in CIDR form
    subnet string
    The subnet in CIDR form
    aux_address Mapping[str, str]
    Auxiliary IPv4 or IPv6 addresses used by Network driver
    gateway str
    The IP address of the gateway
    ip_range str
    The ip range in CIDR form
    subnet str
    The subnet in CIDR form
    auxAddress Map<String>
    Auxiliary IPv4 or IPv6 addresses used by Network driver
    gateway String
    The IP address of the gateway
    ipRange String
    The ip range in CIDR form
    subnet String
    The subnet in CIDR form

    Package Details

    Repository
    Docker pulumi/pulumi-docker
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the docker Terraform Provider.
    docker logo
    Viewing docs for Docker v5.0.0
    published on Tuesday, Apr 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-docker
      Try Pulumi Cloud free. Your team will thank you.