Command-Line Tool bbb-cli

Command reference

bbb-cli

Command-line wrapper for the BigBlueButton API.

bbb-cli [OPTIONS] COMMAND [ARGS]...

Options

-v, --verbosity <verbosity>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

--config <config>

Path to configuration file

--url <url>

Base URL of BigBlueBUtton API

--secret <secret>

Secret salt to authenticate API calls

--group <group>

Name of server group entry in configuration file

--server-name <server_name>

Name of server from group to operate on

--request-timeout <request_timeout>

Timeout

meeting

bbb-cli meeting [OPTIONS] MEETING_ID COMMAND [ARGS]...

Arguments

MEETING_ID

Required argument

attendees

List all current attendees in a meeting in tabular form.

bbb-cli meeting attendees [OPTIONS]

join

Join the meeting by opening the default browser.

bbb-cli meeting join [OPTIONS]

Options

--full-name <full_name>

Full display name to join with

--role <role>

Full display name to join with

Options

VIEWER|MODERATOR

meetings

bbb-cli meetings [OPTIONS] COMMAND [ARGS]...

attendees

List all attendees in all current meetings in tabular form.

bbb-cli meetings attendees [OPTIONS]

create

Create a new meeting.

bbb-cli meetings create [OPTIONS]

Options

--name <name>

Displayed name of new meeting [required]

list

List all current meetings and basic data in tabular form.

bbb-cli meetings list [OPTIONS]

servers

bbb-cli servers [OPTIONS] COMMAND [ARGS]...

list

List all servers in the group and their state.

bbb-cli servers list [OPTIONS]

ssh

Execute command via ssh on all hosts.

bbb-cli servers ssh [OPTIONS] COMMAND...

Arguments

COMMAND

Required argument(s)