# Cloud VPN Dynamic Module
## Example
This example shows how to configure a single VPN tunnel using a couple of extra features
- custom advertisement on the tunnel's BGP session; if custom advertisement is not needed, simply set the `bgp_peer_options` attribute to `null`
- internally generated shared secret, which can be fetched from the module's `random_secret` output for reuse; a predefined secret can be used instead by assigning it to the `shared_secret` attribute
```hcl
module "vm" {
source = "./fabric/modules/compute-vm"
project_id = "my-project"
zone = "europe-west1-b"
name = "my-vm"
network_interfaces = [{
nat = true
network = var.vpc.self_link
subnetwork = var.subnet.self_link
}]
service_account_create = true
}
module "vpn-dynamic" {
source = "./fabric/modules/net-vpn-dynamic"
project_id = "my-project"
region = "europe-west1"
network = var.vpc.name
name = "gateway-1"
router_config = {
asn = 64514
}
tunnels = {
remote-1 = {
bgp_peer = {
address = "169.254.139.134"
asn = 64513
custom_advertise = {
all_subnets = true
all_vpc_subnets = false
all_peer_vpc_subnets = false
ip_ranges = {
"192.168.0.0/24" = "Advertised range description"
}
}
}
bgp_session_range = "169.254.139.133/30"
peer_ip = module.vm.external_ip
}
}
}
# tftest modules=2 resources=12
```
## Variables
| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
| [name](variables.tf#L29) | VPN gateway name, and prefix used for dependent resources. | string
| ✓ | |
| [network](variables.tf#L34) | VPC used for the gateway and routes. | string
| ✓ | |
| [project_id](variables.tf#L39) | Project where resources will be created. | string
| ✓ | |
| [region](variables.tf#L44) | Region used for resources. | string
| ✓ | |
| [router_config](variables.tf#L49) | Cloud Router configuration for the VPN. If you want to reuse an existing router, set create to false and use name to specify the desired router. | object({…})
| ✓ | |
| [gateway_address](variables.tf#L17) | Optional address assigned to the VPN gateway. Ignored unless gateway_address_create is set to false. | string
| | null
|
| [gateway_address_create](variables.tf#L23) | Create external address assigned to the VPN gateway. Needs to be explicitly set to false to use address in gateway_address variable. | bool
| | true
|
| [tunnels](variables.tf#L64) | VPN tunnel configurations. | map(object({…}))
| | {}
|
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [address](outputs.tf#L17) | VPN gateway address. | |
| [gateway](outputs.tf#L22) | VPN gateway resource. | |
| [name](outputs.tf#L27) | VPN gateway name. | |
| [random_secret](outputs.tf#L32) | Generated secret. | |
| [router](outputs.tf#L38) | Router resource (only if auto-created). | |
| [router_name](outputs.tf#L43) | Router name. | |
| [self_link](outputs.tf#L48) | VPN gateway self link. | |
| [tunnel_names](outputs.tf#L53) | VPN tunnel names. | |
| [tunnel_self_links](outputs.tf#L61) | VPN tunnel self links. | |
| [tunnels](outputs.tf#L69) | VPN tunnel resources. | |