v3.24.1

Getting Started Devices Gateways Integrations Reference
Get The Things Stack

Getting Started

    Overview
  • Quick Start
  • What Is The Things Stack?
  • Console
  • Subscription and Billing Management
  • Command-line Interface
  • Installing The Things Stack
  • Upgrading The Things Stack
  • Migrating to The Things Stack
  • The Things Stack Cloud
  • The Things Stack AWS Launcher
  • The Things Stack on Kubernetes
  • The Things Join Server
  • The Things Network
  • Server Addresses
  • Packet Broker
    • Connect
    • Configure
      • Routing Policies
      • Gateway Visibility Settings
    • Mapper API
    • Troubleshooting
  • Single Sign-On
  • Users and Organizations
  • Using the API
  • Working with Events
  • Troubleshooting Getting Started

Configure

This section shows you how to configure Packet Broker. You can manage your registration, list other networks, configure routing policies with other networks, and see which networks are forwarding traffic to your network.

To see which routing policies are configured by default for all deployments, see the Packet Broker Routing section.

Prerequisites

  1. Understand how Packet Broker works and what routing policies are. Learn about Packet Broker.
  2. The Things Stack connected to Packet Broker.
  • The Things Stack Cloud is already connected to Packet Broker.
  • The Things Stack Dedicated Cloud can be connected on request. Please contact The Things Industries support.
  • The Things Stack Enterprise and Open Source: see Connect.
  1. An admin account for the The Things Stack deployment. All Packet Broker configuration requires administrative access.

Packet Broker can be configured using either the Console or the CLI.

Configure Packet Broker

  • Console
  • CLI

To configure Packet Broker, click the Packet Broker button in the top right menu.

Packet Broker Menu Button

This will take you to the dedicated Packet Broker configuration page.

Register or Deregister Tenant

Before configuring routing policies, you must first register your tenant with Packet Broker. To register it, toggle the Register network switch and make sure that Forwarder and Home network are enabled.

Register Packet Broker
Note:
Deregistering from Packet Broker will delete any routing policies associated with a tenant. Security settings may disable deregistering a network from Packet Broker.

Network Visibility

To publicly list your tenant, enable the List network publicly switch. This will allow other networks to easily find and configure routing policies with your network.

List Network Publicly

View Registration

To view the current registration with Packet Broker:

ttn-lw-cli packetbroker info
Example output with registration
{
  "registration": {
    "id": {
      "net_id": 19,
      "tenant_id": "my-company"
    },
    "name": "My Company",
    "dev_addr_blocks": [
      {
        "dev_addr_prefix": {
          "dev_addr": "27ABCD00",
          "length": 24
        }
      }
    ],
    "contact_info": [
      {
        "contact_method": "CONTACT_METHOD_EMAIL",
        "value": "admin@example.com"
      },
      {
        "contact_type": "CONTACT_TYPE_TECHNICAL",
        "contact_method": "CONTACT_METHOD_EMAIL",
        "value": "tech@example.com"
      }
    ]
  },
  "forwarder_enabled": true,
  "home_network_enabled": true
}
Example output without registration
{
  "forwarder_enabled": true,
  "home_network_enabled": true
}

Register Tenant

Note:
You can register with Packet Broker if you are a tenant. This is the case for all users of The Things Stack Cloud and in other deployments where you are using a host NetID. If you are using your own NetID without tenancy, please reach out to join@packetbroker.net for registration.

To register or update your existing tenant registration:

ttn-lw-cli packetbroker register --listed

This updates the registration with Packet Broker based on your The Things Stack environment. When using The Things Stack Cloud or Dedicated Cloud, the registration is based on your subscription. When using The Things Stack Enterprise or Open Source, the registration is based on your configuration.

With --listed, you make your network publicly listed so it can be found by other network administrators. This flag is optional.

Deregister Tenant

Warning:
This permanently deletes all routing policies that you configured as Forwarder to other Home Networks. It also permanently deletes all routing policies configured by other Forwarders for you as Home Network.

To deregister from Packet Broker:

ttn-lw-cli packetbroker deregister

Routing Policies

Routing policies define the rules that Forwarders configure for routing messages to Home Networks. Routing policies are peer-to-peer: a Forwarder can define policies with each individual Home Network. Forwarders can also define an optional default routing policy that is used as a fallback when no specific policy is defined. Learn more about routing policies. Packet Broker Router uses a cache of the routing table. It takes up to 10 minutes for changes in routing policies to be fully propagated and effective.
Read

Gateway Visibility Settings

New in 3.15.1

Gateway visibility configuration allows network administrators to configure who sees which gateway-related information. Having gateways listed publicly on the map can help discovering partner networks, but it may also lead to privacy concerns. Therefore, Packet Broker allows configuring gateway visibility with fine-grained settings. Learn more about gateway visibility. Note: The Things Stack currently only allows configuring the default gateway visibility. Configuring visibility per Home Network is not yet supported. Configure Default Gateway Visibility Console CLI In the Packer Broker settings page, navigate to the Default gateway visibility tab to control what information of your gateways will be publicly visible.
Read
← Connect Routing Policies →

On this page

  • Prerequisites
  • Configure Packet Broker

The Things Stack

Getting Started

Devices

Gateways

Integrations

Reference

Contributing

GitHub

Forum

About Us

The Things Network

The Things Industries

About this page

Last changed by Nejra Selimović on 31 Mar 2022.
doc: Update PB doc (#833)

Edit on Github