Account

Provides support for managing PBX client accounts. Many accounts can be associated with a single PBX and the typical order commands are called in is:

• add an account record to a PBX. This creates a record in the database for this account.
• deploy the account to the PBX. This creates the account on the PBX.
• activate the account on the PBX. This makes the account active.

Other commands are available for listing accounts and checking status information about an account on a PBX.

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

  Account service

Options:
  --help  Show this message and exit.

Commands:
  activate    Activate an account
  add         Add a new account
  deactivate  Deactivate an account
  deploy      Deploy an account
  find        Find an account
  list        List PBX accounts
  remove      Remove an account
  status      Show account status
  undeploy    Undeploy an account
  update      Update an account

activate

Activates an account on the PBX it has been deployed to.

cip account activate --help
Usage: cip account activate [OPTIONS]

  Activate an account

Options:
  --pbx_id TEXT      [required]
  --account_id TEXT  [required]
  --yes              Confirm the action without prompting.
  --help             Show this message and exit.

add

Add a new account to the PBX configuration.

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

  Add a new account

Options:
  --pbx_id TEXT                   PBX name or CRN
  --name TEXT                     [required]
  --customer_id INTEGER           [required]
  --gateway_number TEXT           [required]
  --outbound_name TEXT            [required]
  --outbound_number TEXT          [required]
  --sip_authentication_password TEXT
                                  [required]
  --ext_start INTEGER             [required]
  --ext_count INTEGER             [required]
  --show
  --yes                           Confirm the action without prompting.
  --help                          Show this message and exit.

deactivate

Deactivates a specific account on a particular PBX.

cip account deactivate --help
Usage: cip account deactivate [OPTIONS]

  Deactivate an account

Options:
  --pbx_id TEXT            [required]
  --account_id TEXT        [required]
  --telephone_number TEXT  [required]
  --yes                    Confirm the action without prompting.
  --help                   Show this message and exit.

deploy

Deploy an account to a specified PBX.

cip account deploy --help
Usage: cip account deploy [OPTIONS]

  Deploy an account

Options:
  --pbx_id TEXT      [required]
  --account_id TEXT  [required]
  --yes              Confirm the action without prompting.
  --help             Show this message and exit.

find

Find a specified account associated with a PBX.

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

  Find an account

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

list

List the accounts associated with a PBX.

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

  List PBX accounts

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

remove

Remove a specified account definition associated with a PBX.

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

  Remove an account

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

status

Display the status of a specified account associated with a PBX.

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

  Show account status

Options:
  --pbx_id TEXT      [required]
  --account_id TEXT  [required]
  --help             Show this message and exit.

undeploy

Undeploy a specified account associated with a PBX.

cip account undeploy --help
Usage: cip account undeploy [OPTIONS]

  Undeploy an account

Options:
  --pbx_id TEXT      [required]
  --account_id TEXT  [required]
  --yes              Confirm the action without prompting.
  --help             Show this message and exit.

update

Update the definition of a specified account associated with a PBX.

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

  Update an account

Options:
  --pbx_id TEXT                   PBX name or CRN
  --account_id TEXT               Account name or CRN
  --name TEXT                     [required]
  --customer_id INTEGER           [required]
  --gateway_number TEXT           [required]
  --outbound_name TEXT            [required]
  --outbound_number TEXT          [required]
  --sip_authentication_password TEXT
  --ext_start INTEGER
  --ext_count INTEGER
  --show
  --yes                           Confirm the action without prompting.
  --help                          Show this message and exit.