terraform-provider-netbird/docs/resources/network_router.md

page_title, subcategory, description

page_title	subcategory	description
netbird_network_router Resource - netbird		Create and manage Network Routers, see NetBird Docs https://docs.netbird.io/how-to/networks#routing-peers for more information.

netbird_network_router (Resource)

Create and manage Network Routers, see NetBird Docs for more information.

Example Usage

resource "netbird_group" "example" {
  name = "Test"
}

resource "netbird_network" "example" {
  name        = "TF Test"
  description = "TF Test"
}

resource "netbird_network_router" "example" {
  network_id  = netbird_network.example.id
  peer_groups = [netbird_group.example.id]
  metric      = 9999
  enabled     = true
  masquerade  = true
}

Schema

Required

• network_id (String) The unique identifier of a network

Optional

• enabled (Boolean) Network router status
• masquerade (Boolean) Indicate if peer should masquerade traffic to this route's prefix
• metric (Number) Route metric number. Lowest number has higher priority
• peer (String) Peer Identifier associated with route. This property can not be set together with peer_groups
• peer_groups (List of String) Peers Group Identifier associated with route. This property can not be set together with peer

Read-Only

• id (String) The unique identifier of a router

Import

Import is supported using the following syntax:

terraform import netbird_network_router.example network_id/network_router_id

# For example

terraform import netbird_network_router.example cvr9ibrl0ubs73c11gr0/cvr9ic3l0ubs73c11gs0