github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/docker/r/network.html.markdown (about)

     1  ---
     2  layout: "docker"
     3  page_title: "Docker: docker_network"
     4  sidebar_current: "docs-docker-resource-network"
     5  description: |-
     6    Manages a Docker Network.
     7  ---
     8  
     9  # docker\_network
    10  
    11  Manages a Docker Network. This can be used alongside
    12  [docker\_container](/docs/providers/docker/r/container.html)
    13  to create virtual networks within the docker environment.
    14  
    15  ## Example Usage
    16  
    17  ```hcl
    18  # Find the latest Ubuntu precise image.
    19  resource "docker_network" "private_network" {
    20    name = "my_network"
    21  }
    22  
    23  # Access it somewhere else with ${docker_network.private_network.name}
    24  
    25  ```
    26  
    27  ## Argument Reference
    28  
    29  The following arguments are supported:
    30  
    31  * `name` - (Required, string) The name of the Docker network.
    32  * `check_duplicate` - (Optional, boolean) Requests daemon to check for networks
    33    with same name.
    34  * `driver` - (Optional, string) Name of the network driver to use. Defaults to
    35    `bridge` driver.
    36  * `options` - (Optional, map of strings) Network specific options to be used by
    37    the drivers.
    38  * `internal` - (Optional, boolean) Restrict external access to the network.
    39    Defaults to `false`.
    40  * `ipam_driver` - (Optional, string) Driver used by the custom IP scheme of the
    41    network.
    42  * `ipam_config` - (Optional, block) See [IPAM config](#ipam_config) below for
    43    details.
    44  
    45  <a id="ipam_config"></a>
    46  ### IPAM config
    47  Configuration of the custom IP scheme of the network.
    48  
    49  The `ipam_config` block supports:
    50  
    51  * `subnet` - (Optional, string)
    52  * `ip_range` - (Optional, string)
    53  * `gateway` - (Optional, string)
    54  * `aux_address` - (Optional, map of string)
    55  
    56  ## Attributes Reference
    57  
    58  The following attributes are exported in addition to the above configuration:
    59  
    60  * `id` (string)
    61  * `scope` (string)