pbadmin cluster apikey create

Create an API key

Synopsis

Create an API key for a named cluster.

The secret API key is returned only when creating the API key. You should store the API key in a secure place, as it cannot be retrieved after create.

pbadmin cluster apikey create [flags]

Examples


  Create API key for a Packet Broker Router cluster:
    $ pbadmin cluster apikey create --cluster-id eu1 \
      --rights READ_ROUTING_POLICY,READ_ROUTE_TABLE,READ_TARGET_AUTH

Rights:
  READ_NETWORK              Read networks
  READ_NETWORK_CONTACT      Read network contact information
  READ_JOIN_SERVER          Read Join Servers
  READ_JOIN_SERVER_CONTACT  Read Join Server contact information
  READ_ROUTE_TABLE          Read route table
  READ_ROUTING_POLICY       Read routing policies
  READ_TARGET_AUTH          Read target authentication information

Options

      --cluster-id string          cluster ID
  -h, --help                       help for create
      --net-id netID               LoRa Alliance NetID
      --prompt-key                 prompt custom secret key value
      --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)
      --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