network

type IPAMConfigs []dc.IPAMConfig

type Network struct {

	// name of the network
	Name string `export:"name"`

	// network drive configured in the hcl
	Driver string `export:"driver"`

	// labels set on the network
	Labels map[string]string `export:"labels"`

	// driver-specific options that have been configured
	Options map[string]interface{} `export:"options"`

	// docker client IPAM options
	IPAM dc.IPAMOptions `export:"ipam"`

	// restricted to internal networking
	Internal bool `export:"internal"`

	// uses ipv6
	IPv6 bool `export:"ipv6"`

	// the configured state
	State State `export:"state"`

	// true if 'force' was specified in the hcl
	Force bool `export:"force"`
	// contains filtered or unexported fields
}

type Preparer struct {
	// name of the network
	Name string `hcl:"name" required:"true" nonempty:"true"`

	// network driver. default: bridge
	Driver string `hcl:"driver"`

	// labels to set on the network
	Labels map[string]string `hcl:"labels"`

	// driver specific options
	Options map[string]interface{} `hcl:"options"`

	// ip address management driver. default: default
	IPAMDriver string `hcl:"ipam_driver"`

	// optional custom IPAM configuration. multiple IPAM configurations are
	// permitted. Each IPAM configuration block should contain one or more of the
	// following items:
	//
	//   * subnet:      subnet in CIDR format
	//   * gateway:     ipv4 or ipv6 gateway for the corresponding subnet
	//   * ip_range:    container ips are allocated from this sub-ranges (CIDR format)
	//   * aux_address: auxiliary ipv4 or ipv6 addresses used by the network driver.
	//                  Aux addresses are specified as a map with a name key and an IP
	//                  address value
	IPAMConfig []ipamConfigMap `hcl:"ipam_config"`

	// restricts external access to the network
	Internal bool `hcl:"internal"`

	// enable ipv6 networking
	IPv6 bool `hcl:"ipv6"`

	// indicates whether the network should exist. default: present
	State State `hcl:"state" valid_values:"present,absent"`

	// indicates whether or not the network will be recreated if the state is not
	// what is expected. By default, the module will only check to see if the
	// network exists. Specified as a boolean value
	Force bool `hcl:"force"`
}

type State string