Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated using 4PSA automated script


Note

Applies to VoipNow 3 and higher!

When a VoipNow administrator wants to deploy in rapid manner a large number of extensions o or even clientsorganizations , it is much faster to use the CLI scripts described below than the web interface.

This knowledge base article describes the steps you have to follow when using CLI, while also providing an use case for a better understanding of the process.

CLI utilities

In order to create a user from the command line interface, you need to use two scripts located in the /usr/local/voipnow/bin folder:

  • account.sh - It creates the Service Provider, Organization, User accounts.
  • accountprefs.sh - It sets up various settings without which the entities created with account.sh would be limited in use.

  • extension.sh - It creates the extensions.
     

While you can create Service providers, Organizations, Users and extensions of various kinds, at the moment you cannot set up a charging plan using the existing CLI scripts.

For more information on these scripts, please check the VoipNow Command Line Interface guide.

Examples

To get help from any of them, run the following command with the -h option:

Code Block
/usr/local/voipnow/bin/account.sh -h

To create a Phone terminal extension run:

Code Block
 /usr/local/voipnow/bin/extension.sh -c 099 --parent_login test --type term --label "Extension099" --auto
 

In order to create a Queue extension run:

Code Block
/usr/local/voipnow/bin/extension.sh -c 098 --parent_login test --type queue --label "QueueExt" --auto

The above examples creates one extension at a time. In order to create multiple extensions, just reuse the scripts above and iterate over the name and number of the created entities.

To easily manage the created extensions, just make use of the numbering conventions:

  • 001-099 for Phone terminal extensions.
  • 101-150 for Queue extensions.
  • 151-199 for IVR extensions.
  • etc.

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "KB"in ("cli","scripts","account","management") and space = currentSpace()
labelskb-how-to-article

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.