Skip to content
Documentation
Reference
lasboltctl

lasboltctl

Generated from lasboltctl --help and the command table in server/cmd/lasboltctl/commands.go. Do not edit.

lasboltctl controls a running lasboltd over its control socket. It runs on the host of the server, as the user of lasboltd or as root. It never uses the network.

Usage 

$ lasboltctl --help
lasboltctl controls a running lasboltd over its control socket.

Usage:
  lasboltctl [--socket PATH] [--json] <command> [arguments]

Global flags (they work before or after the command):
  --socket PATH   path of the control socket (env LASBOLTCTL_SOCKET; default /run/lasbolt/ctl.sock)
  --json          print the result as JSON
  --timeout D     longest wait for an answer (default 10s)

Commands:
  status                                                               show version, uptime, users and the registration setting
  users list                                                           list the users
  users disable <username>                                             disable a user and revoke all sessions, devices and keys
  users enable <username>                                              enable a disabled user
  owner add <username>                                                 make an existing user an owner (break-glass)
  invite create [--role member|admin] [--expires 7d] [--base-url URL]  make an invitation and print its link
  invite list                                                          list the open invitations
  invite revoke <id>                                                   revoke an open invitation
  registration show                                                    show who can register
  registration set closed|invite|open                                  set who can register
  version                           print the version
  help                              print this text

Exit codes: 0 ok, 1 error, 2 usage, 3 not found, 4 forbidden or conflict,
5 cannot connect.

The socket has the mode 0600. Run lasboltctl as the user of lasboltd or as root.

Flags for all commands

These flags work before or after the command.

FlagMeaning
--socketpath of the control socket (env LASBOLTCTL_SOCKET; default /run/lasbolt/ctl.sock)
--jsonprint the result as JSON
--timeoutlongest wait for an answer

Exit codes are on the exit codes page.

lasboltctl status

Show version, uptime, users and the registration setting.

lasboltctl status

lasboltctl users list

List the users.

lasboltctl users list

lasboltctl users disable

Disable a user and revoke all sessions, devices and keys.

lasboltctl users disable <username>

lasboltctl users enable

Enable a disabled user.

lasboltctl users enable <username>

lasboltctl owner add

Make an existing user an owner (break-glass).

lasboltctl owner add <username>

lasboltctl invite create

Make an invitation and print its link.

lasboltctl invite create [--role member|admin] [--expires 7d] [--base-url URL]
FlagDefaultMeaning
--rolememberrole of the new user: member or admin
--expires7dhow long the link works, such as 7d or 48h (at most 30d)
--base-url(none)origin of the link, such as https://vault.example.org (default: –public-url of lasboltd)

lasboltctl invite list

List the open invitations.

lasboltctl invite list

lasboltctl invite revoke

Revoke an open invitation.

lasboltctl invite revoke <id>

lasboltctl registration show

Show who can register.

lasboltctl registration show

lasboltctl registration set

Set who can register.

lasboltctl registration set closed|invite|open
lasboltlasboltd