terraform-provider-netbird/docs/data-sources/network_router.md

page_title, subcategory, description

page_title	subcategory	description
netbird_network_router Data Source - netbird		Read Network Router settings and metadata, see NetBird Docs https://docs.netbird.io/how-to/networks#routing-peers for more information.

netbird_network_router (Data Source)

Read Network Router settings and metadata, see NetBird Docs for more information.

Example Usage

data "netbird_network" "example" {
  name = "TF Test"
}

resource "netbird_network_router" "example" {
  id         = "cvr9ic3l0ubs73c11gs0"
  network_id = netbird_network.example.id
}

Schema

Required

• id (String) The unique identifier of a router
• network_id (String) The unique identifier of a network

Read-Only

• 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