Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
55 lines (41 sloc) 1.31 KB

OpenSIPS CLI - Instance module

This module can be used to list and switch different configuration sets provisioned in the config file.


This module exports the following commands:

  • show - shows the current instance's name
  • list - lists the instances available in the loaded configuration file
  • switch - switches to a new instance


Consider the following configuration file, which sets different prompts for different instances:

prompt_name: instance-1

prompt_name: instance-2

Starting the OpenSIPS CLI without any parameter will start in the default instance, but we can navigate afterwards through each provisioned instance:

$ opensips-cli -f instances.cfg
Welcome to OpenSIPS Command Line Interface!
(opensips-cli): instance list
(opensips-cli): instance switch instance1
(instance-1): instance switch instance2
(instance-2): instance switch default

One can also start OpenSIPS CLI with an instance parameter:

$ opensips-cli -f instances.cfg -i instance1
Welcome to OpenSIPS Command Line Interface!


  • The default instance is always available, even if not provisioned in the configuration file. This is because the default config file is always loaded.
You can’t perform that action at this time.