Roles in sipXecs
From SIPfoundry sipXecs IP PBX, The Open Source SIP PBX for Linux - Calivia
A Role is a logical collection of sipXecs services. Since some services work closely together, the role abstraction simplifies administration by collecting these related services into groups - rather than having to assign individual services to servers and understand the (constantly changing) relationships between them, the administrator just assigns roles to servers and lets sipXconfig worry about the details.
There are constraints on the number of instances of a role that can be in a sipXecs domain; these constraints and some other information about each role are summarized in the following table:
Version 4.2 and later
| Role | # Allowed | Default | Services | Notes |
|---|---|---|---|---|
| Management | 1 | Enabled |
Configuration ConfigServer |
Defines the Master server; this is always the first server created. This role can not be Disabled. It's currently restricted to run on Primary Server only. |
| Primary SIP Router | 1 | Enabled |
SIP Registrar SIPRegistrar |
Mutually exclusive with Redundant SIP Router - it is invalid to instantiate both on the same server. It's currently restricted to run on Primary Server only. There are several issues in JIRA to remove that restriction. |
| Redundant SIP Router | 0 - 2 | Disabled |
SIP Registrar SIPRegistrar |
Mutually exclusive with Primary SIP Router - it is invalid to instantiate both on the same server. It's currently restricted to run on non Primary servers only. |
| Voicemail | 0 or 1 | Enabled |
Auto Attendant sipXivr |
Has to be enabled even if external voicemail is used to provide MoH, auto-attendant etc. |
| Conference | 0 or more | Disabled? | Media Engine FreeSWITCH |
Must be added to configure conferences. |
| Border Controller | 0 or 1 | Disabled | SIP Trunk SipXbridge |
Must be added to enable an ITSP interface using the built-in SBC. |
| Call Center | 0 or more | Disabled |
ACD ACDServer |
Must be added to create an ACD. |
| Instant Messaging | 0 or 1 | Disabled |
Instant Messaging Openfire |
Version 4.0
| Role | # Allowed | Default | Services | Notes |
|---|---|---|---|---|
| Management | 1 | Enabled |
Configuration ConfigServer |
Defines the Master server; this is always the first server created. This role can not be Disabled. |
| Primary SIP Router | 1 | Enabled |
SIP Registrar SIPRegistrar |
Mutually exclusive with Redundant SIP Router - it is invalid to instantiate both on the same server. For the 4.0 release, does it simplify things to restrict this role to being the same server as the Management role? We do have existing users that have put sipXconfig on a separate system now, so this might create a problem for upgrades. |
| Redundant SIP Router | 0 or 1 | Disabled |
SIP Registrar SIPRegistrar |
Mutually exclusive with Primary SIP Router - it is invalid to instantiate both on the same server. |
| Voicemail | 0 or 1 | Enabled |
Voicemail MediaServer |
Disabled only if an external voicemail service is used. |
| Conference | 0 or 1 | Disabled? | Media Engine FreeSWITCH |
Must be added to configure conferences. |
| Border Controller | 0 or 1 | Disabled | SIP Trunk SipXbridge |
Must be added to enable an ITSP interface using the built-in SBC. |
| Call Center | 0 or 1 | Disabled |
ACD ACDServer |
Must be added to create an ACD. |
Note: If you accidentally delete the Primary SIP Router and Management servers there is currently no mechanism to recover the system through sipXconfig. Do the following: Recover Process
- Type the following commands logged in to the CLI:
* sudo su postgres -c "psql SIPXCONFIG"
* SIPXCONFIG=# INSERT INTO location (location_id, name, fqdn, ip_address, password, primary_location, registered)
* SIPXCONFIG-# VALUES (1, 'Primary', 'myhost.sipxtest.int', '127.0.0.1', 'some_password', true, true);
* Control-C
* sipxproc --stop ConfigServer {"ConfigServer"=>true}
* sipxconfig.sh --first-run
* sipxproc --start ConfigServer
