Packet Broker Getting Started Commands

Getting Started

    Overview
  • Quick Start
  • What Is Packet Broker?
  • Network Configuration
  • Command-Line Interface
    • Installation
    • Configuration
    • Networks and Tenants
    • Routing Policies
    • Reports
    • Test Traffic
  • Terminology
  • API

Networks and Tenants

Networks are uniquely identified by a LoRa Alliance NetID. Currently, only LoRa Alliance members can obtain a NetID.

Tenants are part of a Network. Tenants typically use a unique DevAddr block. Networks can manage their Tenants. Tenants are uniquely identified by a Tenant ID.

Manage Tenants as Network Administrator

Network administrators may create, list, get, and delete tenants.

Packet Broker Identity and Access Management (IAM) stores networks and tenants. Networks are LoRaWAN networks with a NetID, i.e. 000013 (with DevAddr prefix 26000000/7). Tenants make use of one or more DevAddr blocks within a NetID, i.e. NetID 000013 with prefix 26AA0000/16. Tenants have a unique identifier within the NetID, called the tenant ID.

Create Tenant

To create a tenant, use pbadmin network tenant create. For example, as NetID 000013, to create tenant tenant-a with DevAddr blocks 26AA0000/16 and 26BB0000/16:

$ pbadmin network tenant create --net-id 000013 --tenant-id tenant-a \
    --name "Tenant A" --dev-addr-blocks 26AA0000/16,26BB0000/16

The prefixes indicate the base DevAddr and the bit length, like CIDR notation. For example, 26AA0000/16 matches all DevAddr from 26AA0000 to 26AAFFFF.

Optionally, you can specify a Home Network cluster. If your network uses multiple clusters, you can let Packet Broker route traffic to these clusters:

$ pbadmin network tenant update --net-id 000013 --tenant-id tenant a \
    --dev-addr-blocks 26AA0000/16=eu1,26BB0000/16=eu2

List Tenants

To list tenants:

$ pbadmin network tenant list --net-id 000013

Get Tenant

To get a tenant:

$ pbadmin network tenant get --net-id 000013 --tenant-id tenant-a

Delete Tenant

To delete a tenant:

$ pbadmin network tenant delete --net-id 000013 --tenant-id tenant-a

Manage Network and Tenant API Keys

Network API keys are used by clients of Packet Broker Router: LoRaWAN network servers and the command-line utilities pbpub and pbsub.

You can create API keys for a network, a tenant, a named cluster in a network and a named cluster in a tenant. For example, to create an API key for a tenant:

$ pbadmin network apikey create --net-id 000042 --tenant-id tenant-a

And for a named cluster in a tenant:

$ pbadmin network apikey create --net-id 000042 --tenant-id tenant-a --cluster-id eu1
← Configuration Routing Policies →

On this page

  • Manage Tenants as Network Administrator
  • Manage Network and Tenant API Keys

Packet Broker

Packet Broker

Getting Started

Commands

About Us

The Things Network

The Things Industries

About this page

Last changed on 01 Jan 0001.