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

Command-Line Interface

Packet Broker has a command-line interface for management, configuration, reporting and testing traffic flows. This section contains instructions for installing, configuring, and using them.

For a full list of Packet Broker client commands, see the Commands section.

Which CLI client does what?

Action Service Client Basic Auth OAuth 2.0
Manage networks IAM pbadmin administrator
Manage tenants IAM pbadmin administrator network
Manage network API keys IAM pbadmin administrator network
Manage cluster API keys IAM pbadmin administrator
List networks and tenants IAM pbadmin cluster, network
Manage routing policies Control Plane pbctl network, tenant
List routes Control Plane pbctl cluster, network, tenant
List routing policies Control Plane pbctl cluster, network, tenant
Get reports Reporter pbctl network, tenant
Publish and subscribe Data Plane pbpub, pbsub network, tenant

Cluster regions

IAM and Control Plane are deployed in a global cluster:

Cluster Address
IAM iam.packetbroker.net
Control Plane cp.packetbroker.net
Reporter reports.packetbroker.net

Routers (with Data Plane) are deployed in regional clusters:

Region Address LoRaWAN Backend Interfaces URL
Europe eu.packetbroker.io https://eu.packetbroker.io:5138
North America nam.packetbroker.io https://nam.packetbroker.io:5138
Asia Pacific apac.packetbroker.io https://apac.packetbroker.io:5138
← ChirpStack Installation →

On this page

  • Which CLI client does what?
  • Cluster regions

Packet Broker

Packet Broker

Getting Started

Commands

About Us

The Things Network

The Things Industries

About this page

Last changed on 01 Jan 0001.