PBX

Provides support for managing PBX's.

A platform can have many PBX's associated with it and each PBX may have multiple client accounts added to it.

Commands are available for managing PBX definitions plus commands for checking status information about a PBX.

cip pbx
Usage: cip pbx [OPTIONS] COMMAND [ARGS]...

  PBX service

Options:
  --help  Show this message and exit.

Commands:
  add       Add a new PBX
  calls     Show calls on a PBX
  channels  Show PBX channels
  describe  Describe all PBXs
  find      Find PBX details
  list      List all PBXs
  remove    Remove a PBX
  status    Show PBX status
  update    Update a PBX
  version   Show PBX version

add

Add a new PBX definition to the CIP database.

cip pbx add --help
Usage: cip pbx add [OPTIONS]

  Add a new PBX

Options:
  --name TEXT             PBX name
  --description TEXT      PBX description
  --server_domain TEXT    PBX server domain
  --server_address TEXT   PBX server address
  --server_path TEXT      PBX server path
  --server_username TEXT  PBX server user name
  --server_password TEXT  Server password
  --server_key_path TEXT  PBX server key path
  --cli_path TEXT         PBX command line path
  --user_password TEXT    PBX user password
  --admin_password TEXT   PBX admin password
  --show
  --yes                   Confirm the action without prompting.
  --help                  Show this message and exit.

calls

Displays active calls on a specified PBX.

cip pbx calls --help
Usage: cip pbx calls [OPTIONS]

  Show calls on a PBX

Options:
  --pbx_id TEXT  PBX name or CRN
  --help         Show this message and exit.

channels

Display channels associated with a specified PBX.

cip pbx channels --help
Usage: cip pbx channels [OPTIONS]

  Show PBX channels

Options:
  --pbx_id TEXT  PBX name or CRN
  --help         Show this message and exit.

describe

Displays a list of all of the PBX's and their associated accounts.

cip pbx describe --help
Usage: cip pbx describe [OPTIONS]

  Describe all PBXs

Options:
  --help  Show this message and exit.

find

Find the details of a specified PBX.

cip pbx find --help
Usage: cip pbx find [OPTIONS]

  Find PBX details

Options:
  --pbx_id TEXT  PBX name or CRN
  --show
  --help         Show this message and exit.

list

Lists details of all PBX's defined in this platform and environment.

cip pbx list --help
Usage: cip pbx list [OPTIONS]

  List all PBXs

Options:
  --show
  --help  Show this message and exit.

remove

Remove a PBX definition from the CIP database.

cip pbx remove --help
Usage: cip pbx remove [OPTIONS]

  Remove a PBX

Options:
  --pbx_id TEXT  PBX name or CRN
  --yes          Confirm the action without prompting.
  --help         Show this message and exit.

status

Shows the status of a specified PBX.

cip pbx status --help
Usage: cip pbx status [OPTIONS]

  Show PBX status

Options:
  --pbx_id TEXT  PBX name or CRN
  --help         Show this message and exit.

update

Update the definition of a specified PBX.

cip pbx update --help
Usage: cip pbx update [OPTIONS]

  Update a PBX

Options:
  --pbx-id TEXT           PBX name or CRN  [required]
  --name TEXT             PBX name
  --description TEXT      PBX description
  --server_domain TEXT    PBX server domain
  --server_address TEXT   PBX server address
  --server_path TEXT      PBX server path
  --server_username TEXT  PBX server user name
  --server_password TEXT  Server password
  --server_key_path TEXT  PBX server key path
  --cli_path TEXT         PBX command line path
  --user_password TEXT    PBX user password
  --admin_password TEXT   PBX admin password
  --show
  --yes                   Confirm the action without prompting.
  --help                  Show this message and exit.

version

Returns the version details of the specified PBX. Use the list command to display all PBX identifiers.

cip pbx version --help
Usage: cip pbx version [OPTIONS]

  Show PBX version

Options:
  --pbx_id TEXT  PBX name or CRN
  --help         Show this message and exit.

Example

cip pbx version
Pbx id: pbx0001
FreeSWITCH Version 1.8.2-3-a98a958ac3~64bit (-3-a98a958ac3 64bit)