Skip to main content

Overview

The netbird networks command (also available as netbird routes) manages connections to NetBird networks and resources. Use this to view available network routes and control which networks your peer can access.

Description

NetBird networks allow you to:
  • Access remote networks and resources through exit nodes
  • Route traffic to specific IP ranges or domains
  • Control which networks your peer connects to
  • View domain-based routes with resolved IPs
Network routes are managed by administrators in the NetBird Management Dashboard. Peers can select which routes to use.

Subcommands

  • list (alias: ls) - List all available network routes
  • select - Select network routes to use
  • deselect - Deselect network routes

list

List all available network routes.

Description

Displays all network routes available to your peer, including:
  • Network routes: IP ranges (CIDR notation)
  • Domain routes: Domain names with resolved IPs
  • Selection status: Whether each route is selected

Examples

List all routes:
Example output:

Understanding the Output

Network Routes:
  • ID: Unique identifier for the route
  • Network: IP range in CIDR notation (e.g., 10.0.0.0/24)
  • Status: Selected or Not Selected
Domain Routes:
  • ID: Unique identifier for the route
  • Domains: One or more domain names (can include wildcards)
  • Status: Selected or Not Selected
  • Resolved IPs: Current DNS resolution results for each domain

No Routes Available

If no routes are configured:
Contact your NetBird administrator to configure network routes.

select

Select network routes to use.

Description

Selecting a route enables your peer to:
  • Access the network/domain through the designated exit node
  • Route traffic for that network through NetBird
  • Apply any associated firewall or access policies

Flags

boolean
default:"false"
Append to current network selection instead of replacingShort form: -aBy default, select replaces your current selection. Use this flag to add routes without removing existing ones.

Arguments

  • <network_id>... - One or more route IDs to select
  • all - Select all available routes (clears all selections and accepts all including new routes)

Examples

Select a single route:
Select multiple routes:
Select all routes:
Selecting all is special: it not only selects all current routes but also automatically selects any new routes added in the future.
Add routes to existing selection (append mode):
Replace selection with new routes:

Behavior

Default mode (replace):
  • Deselects all previously selected routes
  • Selects only the specified routes
Append mode (-a):
  • Keeps existing selections
  • Adds new routes to the selection

deselect

Deselect network routes.

Description

Deselecting a route stops routing traffic for that network through NetBird.

Arguments

  • <network_id>... - One or more route IDs to deselect
  • all - Deselect all routes (disable accepting any networks)

Examples

Deselect a single route:
Deselect multiple routes:
Deselect all routes:
Deselecting all disables accepting any network routes, including future ones. You won’t receive any network routes until you select them again.

Complete Workflow Examples

View and Select Routes

Add Route to Existing Selection

Remove Specific Routes

Accept All Routes (Including Future)

Disable All Routes

Network Types

IP Range Routes (Network Routes)

Route traffic to specific IP ranges:
Use cases:
  • Access office LAN
  • Connect to private cloud networks
  • Reach internal infrastructure

Domain Routes

Route traffic to specific domains:
Features:
  • Supports wildcards (e.g., *.internal.com)
  • Automatically resolves DNS
  • Updates when IPs change
Use cases:
  • Access internal web applications
  • Route API traffic
  • Connect to dynamic services

Route Selection Strategies

Minimal Selection

Select only routes you actively use:
Pros:
  • Reduced routing complexity
  • Explicit control
  • Easy troubleshooting
Cons:
  • Must manually add new routes
  • May miss newly added networks

Accept All

Automatically accept all routes:
Pros:
  • Automatic access to new networks
  • No maintenance needed
  • Complete network access
Cons:
  • May route unneeded traffic
  • Less explicit control

Selective Append

Start with specific routes, add as needed:
Pros:
  • Balanced approach
  • Grows with needs
  • Maintains control

Verification

Check Route Status

Look for Status: Selected on routes you expect to use.

Test Connectivity

Ping through route:
Check routing table:
Verify DNS resolution (domain routes):

Check via Status

Look for network routes in the output.

Troubleshooting

Route Not Working After Selection

  1. Verify selection:
  2. Check connection:
  3. Restart connection:
  4. Check exit node connectivity:

Domain Route Not Resolving

Check DNS configuration:
Verify NetBird DNS:

Can’t Select Route

Possible causes:
  • Route ID typo
  • Route was deleted by admin
  • Insufficient permissions
  • Daemon not running
Solutions:

Routes Disappeared

If routes are no longer listed:
  1. Check management connection:
  2. Refresh connection:
  3. Contact administrator - routes may have been removed

Administration

Network routes are configured by administrators in the NetBird Management Dashboard:
  1. Navigate to Network Routes
  2. Click Add Route
  3. Configure:
    • Network (CIDR) or Domains
    • Exit node/peer
    • Distribution groups
    • Access control policies
See: Network Routes Guide

See Also