github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/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  ```
    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  ## Argument Reference
    27  
    28  The following arguments are supported:
    29  
    30  * `name` - (Required, string) The name of the Docker network.
    31  * `check_duplicate` - (Optional, boolean) Requests daemon to check for networks
    32    with same name.
    33  * `driver` - (Optional, string) Name of the network driver to use. Defaults to
    34    `bridge` driver.
    35  * `options` - (Optional, map of strings) Network specific options to be used by
    36    the drivers.
    37  * `ipam_driver` - (Optional, string) Driver used by the custom IP scheme of the
    38    network.
    39  * `ipam_config` - (Optional, block) See [IPAM config](#ipam_config) below for
    40    details.
    41  
    42  <a id="ipam_config"></a>
    43  ### IPAM config
    44  Configuration of the custom IP scheme of the network.
    45  
    46  The `ipam_config` block supports:
    47  
    48  * `subnet` - (Optional, string)
    49  * `ip_range` - (Optional, string)
    50  * `gateway` - (Optional, string)
    51  * `aux_address` - (Optional, map of string)
    52  
    53  ## Attributes Reference
    54  
    55  The following attributes are exported in addition to the above configuration:
    56  
    57  * `id` (string)
    58  * `scope` (string)