Packet Broker Getting Started Commands

Commands

pbadmin
cluster
apikey
create
delete
list
update-state
completion
bash
fish
powershell
zsh
gen
hugodoc
tree
join-server
create
delete
get
list
update
target
network
apikey
create
delete
list
update-state
create
delete
get
init
list
tenant
create
delete
get
list
update
target
update
target
pbctl
catalog
home-networks
join-servers
networks
completion
bash
fish
powershell
zsh
gateway-visibility
delete
get
set
gen
hugodoc
tree
policy
delete
get
list
networks
set
report
routed-messages
route
targets
pbpub
completion
bash
fish
powershell
zsh
gen
hugodoc
tree
pbsub
completion
bash
fish
powershell
zsh
gen
hugodoc
tree

pbadmin network init

Initialize network configuration

Synopsis

Initialize network configuration

This stores the router address and a newly requested network API key in a local configuration file (.pb.yaml). This configuration can be used by Packet Broker command-line interfaces.

pbadmin network init [flags]

Examples


  Initialize configuration for a network:
    $ pbadmin network init --net-id 000013 \
        --router-address eu.packetbroker.io

  Initialize configuration for a tenant:
    $ pbadmin network init --net-id 000013 --tenant-id ttn \
        --router-address eu.packetbroker.io

  Initialize configuration for a named cluster in a tenant:
    $ pbadmin network init --net-id 000013 --tenant-id ttn --cluster-id eu1 \
        --router-address eu.packetbroker.io

  Initialize configuration for network with rights to read networks:
    $ pbadmin network init --net-id 000013 --rights READ_NETWORK \
        --router-address eu.packetbroker.io

Rights:
  READ_NETWORK              Read networks
  READ_JOIN_SERVER          Read Join Servers
  READ_NETWORK_CONTACT      Read network contact information
  READ_ROUTING_POLICY       Read routing policies
  WRITE_ROUTING_POLICY      Write routing policies
  READ_GATEWAY_VISIBILITY   Read gateway visibilities
  WRITE_GATEWAY_VISIBILITY  Write gateway visibilities
  READ_TRAFFIC              Read traffic
  WRITE_TRAFFIC             Write traffic

Router addresses:
  apac.packetbroker.io  Asia Pacific
  eu.packetbroker.io    Europe, Middle East and Africa
  nam.packetbroker.io   Americas

Options

      --cluster-id string             cluster ID
      --controlplane-address string   Packet Broker Control Plane address "host[:port]" (default "cp.packetbroker.net:443")
  -h, --help                          help for init
      --net-id netID                  LoRa Alliance NetID
      --reports-address string        Packet Broker Reporter address "host[:port]" (default "reports.packetbroker.net:443")
      --rights apiKeyRightsValue      API key rights (READ_GATEWAY_VISIBILITY,READ_JOIN_SERVER,READ_JOIN_SERVER_CONTACT,READ_NETWORK,READ_NETWORK_CONTACT,READ_REPORT,READ_ROUTE_TABLE,READ_ROUTING_POLICY,READ_TARGET_AUTH,READ_TRAFFIC,WRITE_GATEWAY_VISIBILITY,WRITE_ROUTING_POLICY,WRITE_TRAFFIC) (default READ_NETWORK,READ_JOIN_SERVER,READ_ROUTING_POLICY,WRITE_ROUTING_POLICY,READ_GATEWAY_VISIBILITY,WRITE_GATEWAY_VISIBILITY,READ_TRAFFIC,WRITE_TRAFFIC,READ_REPORT)
      --router-address string         Packet Broker Router address "host[:port]"
      --tenant-id string              tenant ID

Options inherited from parent commands

      --client-id string       OAuth 2.0 client ID
      --client-secret string   OAuth 2.0 client secret
      --config string          config file (default is .pb.yaml, $HOME/.pb.yaml)
  -d, --debug                  debug mode
      --iam-address string     address of the server "host[:port]" (default "iam.packetbroker.net:443")
      --iam-password string    IAM password
      --iam-username string    IAM username
      --insecure               insecure
      --token-url string       OAuth 2.0 token URL (default "https://iam.packetbroker.net/token")

SEE ALSO

  • pbadmin network - Manage Packet Broker networks

Packet Broker

Packet Broker

Getting Started

Commands

About Us

The Things Network

The Things Industries

About this page

Last changed on 01 Jan 0001.