3CXPhoneSystemCloudServerv12

3CXPhoneSystemCloudServer
AdministrationManual

3CXPhoneSystemCloudServerv12

Copyright20132014,3CXLtd.http://www.3cx.com
Email:info@3cx.com
Information in this document is subject to change without notice.Companiesnamesanddataused
in examples herein are fictitious unless otherwise noted. No part of this document may be
reproduced or transmitted in any form orby any means, electronic or mechanical, for anypurpose,
withouttheexpresswrittenpermissionof3CXLtd.
3CXPhoneSystemCloudServerisacopyrightof3CXLtd.
3CX is a registered trademark, and 3CX Phone System Cloud Server and the 3CX logo are
trademarksof3CXLtd.inEurope,theUnitedStatesandothercountries.
Version1Lastupdated4thFebruary2014

3CXPhoneSystemCloudServerv12

TableofContents
TableofContents
1.Introduction
Whatis3CXPhoneSystemCloudServer?
Howitworks
SpecialHostingEditionFeatures
Manageall3CXinstancesfromacentralconsole
Backupall3CXPhoneSysteminstanceswiththeBackupTool
FullVMwareandHyperVcompatibility
Easilyconfigureanew3CXPhoneSysteminstance
Allowcompaniestomanageusersettingswithgranularuseraccess
Easyremoteprovisioning
EliminatefirewallandbandwidthissueswithinbuiltSessionBorderController
Why3CXPhoneSystemCloudServeroverotherhostedsolutions?
BuiltforWindowsServer2012
RetainControlofYOURCustomers
CustomersPrefertoDealwiththeirTrustedResellers
RetainSupportRevenueofYourCustomer
OfferafullfeaturedhostedPBX
FullvirtualizationofPhoneSystemandData
Licensing
Fulllicenses
Timebasedlicenses
Purchasing3CXPhoneSystemCloudServer
ActivatingYour3CXPhoneSystemCloudServerLicense
2.GettingStarted
SystemRequirements
FirewallConfiguration
CommonPortsforalltenants
ForEachtenant
Tenant1
Tenant2
AdditionalTenants
3.Installing3CXCloudServer
Introduction
Installingthefirsttenant
4.InstallingAdditionalTenants
Introduction
InstallingAnotherTenant
5.ConfiguringaTenantinstanceforaCustomer
Introduction
CreateExtensions
CreateaDedicatedSIPTrunk
CreateanAdministratorfortheTenant(Optional)
Createalimitedaccessuser
Configurethe3CXTunnel
3

3CXPhoneSystemCloudServerv12

6.DeployingAConfigurationforCustomers
Introduction
FirewallConfiguration
3CXSessionBorderController
Installing3CXSessionBorderControllerforWindows
Installing3CXSessionBorderControllerforRaspberryPi
Part1:RaspberryPiPreparationand3CXSBCInstallation
Part2:Configuring3CXSBC
7.PreparingtheIPPhones
Introduction
ProvisioningYealinkPhones
ProvisioningsnomPhones
ProvisioningCiscoSPAPhones
8.TheCentralManagementConsole
Introduction
RunningtheCentralConsole
9.Backingupalltenants
Introduction
RunningtheBackup
RestoringaBackuporawholeCloudServer
PerformingaBackuporRestoreviaCommandLine
BackupviaCommandline
RestoreviaCommandline
10.Updating3CXCloudServerviaServicePackUpdates
Introduction
11.Uninstallation
Introduction

3CXPhoneSystemCloudServerv12

1.Introduction
Whatis3CXPhoneSystemCloudServer?
Cloud based PBX demand is growing. Outsourced PBX is attractive to smaller customers but
comes with a price: Existing Cloud PBXs have a basic feature set and the companies providing
them will take control of YOUR customers and make you dependent on their Quality Control and
supportprocedures.Thisisarecipefordisaster.
3CX Phone System Cloud Server is a special version of 3CX Phone System, designed to allow
companiestohost3CXPhoneSystemforcustomersandretainFULLcontrolofdataandquality.

Howitworks
3CX Phone System Cloud Server allows you to
host up to 50 separate 3CX Phone System
instances on one Windows Server2012machine.
Each instance is entirely separate from the other
and allows you to completely separate
configurationsandresourcesbetweencustomers.
By hosting 50 instances on one Windows Server
machine, you can avoid having to license &
manage individual Windows instances, saving
greatly on licensing, management and hardware
costs.
Connect each instance to its own dedicated SIP
trunkorGatewayportandkeepcallbillingperfectly
separated for each customer. As a reseller,
maintain close customer contact for PBX
services, but outsource telecom call costs and
billing to your SIP trunk provider of choice. As a
SIPtrunk provider,enjoyeconomiesofscalebykeepingcontroloftheSIPtrunks,butoutsourcePBX
supportandservicetoyourresellersallowingyoutoscaleeasily.

SpecialHostingEditionFeatures
The feature set of the actual hosted edition of 3CX Phone System is identical to the onsite edition.
3CX PhoneSystemCloud Server though offers additional features to allow youtoeasilydeployand
managethesehostedinstancesof3CXPhoneSystem.

Manage all 3CX instances from a central console

The central console allows you to quickly manage each 3CX Phone System instance/customer.
Each noderepresents a customer and allows you to switch into thecustomerconfigurationwithout
havingtologinintothatparticularportal.

Backup all 3CX Phone System instances with the Backup Tool
The hosting edition offers a backup and restore tool that is able to backup ALL instances on the
machine and restore all instances on another machineif needbe.Automatebackuponascheduled
basisandrestoreallinstancesinminutesincaseofhardwarefailure.
5

3CXPhoneSystemCloudServerv12

Full VMware and Hyper V compatibility

If you want to leverage your existing Vmware or Hyper V knowledge youcan do sowith3CXPhone
System Cloud Server. It has been verified and testedagainsttheleadingvirtualizationplatformsand
allowsyoutotakefulladvantageofVMwareandHyperVmanagementandredundancyfeatures.

Easily configure a new 3CX Phone System instance

Ability to quickly create a 3CX Phone System configuration using our wizard or from a web input
form:Importusers,configuretrunksandpushouttoanew3CXPhoneSysteminstance.

Allow companies to manage user settings with granular user access

Allow customers to manage their own extensions, but not Trunk, Gateway and other system
configurations.Two additional userlevels:Departmentmanager, whocanmanagetheextensionsof
his/her group, and System manager, who can manage all extensions. The System administrator
level allows the customer full access to the system and can be disabled to avoid any
misconfigurationsbythecustomer.

Easy remote provisioning

3CX PhoneSystemCloud Server can easily provision remoteIPPhonesand3CXPhoneinstances
via the extended SIP Proxy manager which acts as anagentforprovisioningrequests.WiththeSIP
Proxymanageryoucansendphonesreadilyconfiguredfortrueplugandplayatthecustomersite.

Eliminate firewall and bandwidth issues with inbuilt Session Border Controller
3CX Phone System features the unique SIP Proxy Manager, which allows all SIP traffic for the
customer to be tunneled overa single port. Drastically simplify remote installsandeliminatefirewall
configuration issues. Furthermore, the intelligent 3CX Proxy Manager can detect calls being made
between local extensions and avoid sending audio streams to the hosted PBX saving valuable
bandwidthanddrasticallyimprovingaudioquality.

Why3CXPhoneSystemCloudServeroverotherhostedsolutions?
Built for Windows Server 2012
Windows Server 2012 is a stable and manageable platform and allows you to provide 3CX Phone
SystemasahostededitionmuchmoreeffectivelythancompetingsolutionsavailableforLinux.Linux
based multi tenant phone systems are much harder to configure and manage. With 3CX Phone
System,youcan leverageyourexistingknowledgewithouthavingtolearnanewoperatingsystemor
softwareplatformtoofferhostedPBX.

Retain Control of YOUR Customers

3CX Partners dont need to give up control oftheircustomerswhenworkingwitha3rdpartyhosting
company. With 3CX Cloud Server, partners host their customersPBXthemselves.Some3rdparty
companies could previously take controlofcustomeraccounts,cuttingoutthe3CXPartnerfromthe
picture.

Customers Prefer to Deal with their Trusted Resellers

Customers prefer dealing with their trusted local 3CX Partner as they know their needs and have
builtupworkingrelationships,ratherthanwithanunknown3rdpartyhostingcompany.

3CXPhoneSystemCloudServerv12

Retain Support Revenue of Your Customer

Because 3CX Cloud Server gives 3CX Partners complete control over the hosted PBX, they can
generate recurring income by offering technical support to theircustomers. With 3rdparty hosting
companies, the customer will medium to long term deal directly with them without theneed for the
3CXPartner,resultinginalossofsupportrevenue.

Offer a full featured hosted PBX

Rather than ascaleddownbasicPBX,youcanoffercustomers afullvirtualized3CXPhoneSystem
instance, together with the advanced feature set that 3CX is known for. Advanced PBX features,
unifiedcommunicationsandbroadclientsupportfullyvirtualizedandcontrolledpercustomer.

Full virtualization of Phone System and Data

3CX CloudServeractuallyrunsfortyfullyvirtualizedandseparatedinstancesof3CXPhoneSystem.
That means that any applications run by one customer will never affect the3CXPhoneSystemrun
by other customers. Data is fully separated and allows you to meet strict privacy and reporting
requirements

Licensing
3CX Partners can license each tenant individually, dependingon the requirements of thecustomer,
i.e. number of simultaneous calls, whether customer requires PRO edition or not and so on.
Licensesfor3CXPhoneSystemCloudServerareavailableintwotypes:

Full licenses
Customers can buy a full 3CX Phone System license that can be activated either on 3CX Cloud
Serveroronsite.Thisisthemosteconomicalwaytolicense3CXPhoneSystem.

Time based licenses

<Thisfeatureisnotavailableyet>
Customers that prefer to pay per month or per 6 months, can opt for time based licenses.These
licenses can ONLY be activated on 3CX Phone System CloudServer.Timebasedlicensesinclude
maintenance but are more expensive in the long run. However they allowpartners to license 3CX
Phone System for short period of times and reduce the risk when entering into contracts with
customers.

Purchasing3CXPhoneSystemCloudServer
3CX Phone System Cloud Server can be purchased via your distributor. Full pricinginformation is
availablehere:
http://www.3cx.com/Pricing/

Activating Your 3CX Phone System Cloud Server License

Onceyouhavepurchasedalicense,youcanactivateitasfollows.
Step1:LoginasSuperAdministratorinthemainmanagementconsole
Step 2: Click on Activate (top middle section of the screen) or select the System node > License
ActivationandpasteinyourLicensekey.

3CXPhoneSystemCloudServerv12

2.GettingStarted
SystemRequirements
To run 3CX Phone System Cloud Server the following Software and Hardware specifications are
required:
SoftwareRequirements
1. WindowsServer2008R264BitorWindowsServer201264Bit.
2. IMPORTANT:ServercoreeditionsareNOTsupported
3. Microsoft.NETFramework4.5.
4. InternetInformationServices.
5. VMwareESXandHyperVenvironmentsarefullysupported
6. No DNS OR DHCP server installedonthismachine!Thismachinemustbededicated
to3CXPhoneSystemCloudServer
7. Eachtenantcannothavemorethan32simultaneouscalls.
MinimumHardwarerequirements:
1. IntelXeonCPUE55052.00GHz2.00GHz(2processors)orhigher.
2. Memory: 12 GB or higher. Total memory footprintper 3CX Phone System tenantis300500
MBofmemory.
3. Harddisk:SATA100GBorhigher
4. Networkcard:1Gbit/10Gbit

FirewallConfiguration
Each tenanthasitsowndedicatedsetofports that areusedby3CXPhoneSystem.Youwillneedto
openthefollowingportsfor3CXCloudServeronthesystem:

Common Ports for all tenants

Website

Port80&443

MediaServer

From55,00065,000UDPOnly

Note: If your firewall facing the internet is directly the Windows Firewall, you need to do nothing
because the3CXCloudInstallationopens all requiredportsonthetargetserver.Alternativelyyou will
needtoopenandportforwardthebelowmentionedportsonyourfirewall.

For Each tenant

3CX Phone System uses specific ports for different services. 1000 ports are allocated for each
tenant.Tenant1startsfrom50005999,tenant2from60006999,tenant3from70007999etc.

Tenant 1
Tenant1willusethefollowingportsfromtherange5000to5999.

HTTPaccessforallWebsites(80or443)

https://cloud7.3cx.com/t1/management

PhoneSystemSIPPortTCPandUDP

5060

PhoneSystemSecureSIPPortTCP

5061

3CXPhoneSystemCloudServerv12

3CXTunnelServiceTCPandUDP

5090

Tenant 2
Tenant2hastheexactsameportsbutintherange6000to6999:
HTTPaccessforallWebsites(80or443)

https://cloud7.3cx.com/t2/management

PhoneSystemSIPPort

6060

PhoneSystemSecureSIPPort

6061

3CXTunnelService

6090

Additional Tenants
AdditionaltenantswillfollowtheexactsamepatternasTenant2butstartingatthefollowingrange:
Tenant3

7000

Tenant4

8000

Tenant5

9000

Tenant6

10000

Tenant7

11000

etc.

3CXPhoneSystemCloudServerv12

3.Installing3CXCloudServer
Introduction
3CX Cloud Server setup needs to be run for each tenant you wish to install. The installation
procedure for the first tenant isslightly different from the installation procedure for othertenants as
certainsettingsforthewholeCloudServerareconfigured.

Installingthefirsttenant
1. Download3CXPhoneSystemCloudServereditionfromhere:
http://downloads.3cx.com/downloads/3CXPhoneSystemCloudServer12.exe
2. Oncethedownloadiscompleteddoubleclickthesetupfiletolaunchsetup.

3. You will be prompted to enter the name for the first tenant. The first tenant name should
ideally be the name of the company or branch office that youre hosting. The Tenant name
cannot be emptyor longerthan 20 characters and can only consistoflowercaselettersand
numbers, without spaces or any other special characters. In this case we will name the
tenantt1.PressNextwhenyouinputthetenantnametoproceed.
4. The 3CX Phone System CloudServer SystemRequirementswillbedisplayed,pleasemake
sure that you read them and that your system configurationcomplieswiththem.SelectNext
to continue and press Next again in the next screen after youreadthe last part of System
Requirements.
5. ReadtheEndUserLicenceAgreement,acceptthetermsandcontinuethesetup.

10

3CXPhoneSystemCloudServerv12

6. The InstallationFolder dialog will be displayed for thefirst tenant.ThiswillcontaintheTenant

nameintheApplicationFolderPath.Thiscannotbechanged.
7. Type in your Company Name (we used Cloud Services in the example) and insert your
externalFQDNin theappropriatefield.AlsofillintheCertificatepassword thatwillbeusedfor
HTTPS. 3CX Cloud Server Setup will automatically generate self signed certificates using
OpenSSL.

8. SelectNextwhendoneandpressInstallatthenextscreentobeginthefileinstallation.
9. Once setup is complete, the3CXWizarddialogwillcomeup. Selectyourlanguageandclick
Nexttoproceed.

11

3CXPhoneSystemCloudServerv12

10. You will then be prompted to enter the credentials for the super administrator. The Super
administrator will have access to the management consoles of ALL tenants installed on the
server.TypeintheUsernamethatyouwantandaPassword.
11. From this pointonwards,everythingisthesameasanormal3CX PhoneSysteminstallation.
You will be promptedto choose whether you want to restore a backupor installanewPBX.
You will also be asked for thetenantsadminusernameandpassword.Thisistoaccessthe
individual tenants management console and should not be confused with the Sysadmin
credentials. After the installation wizard is complete, the 3CX Management Console web
interfacewillcomeup.NotehowthehttpsURLlinkiscreatedtoaccesstheconsole.

12

3CXPhoneSystemCloudServerv12

4.InstallingAdditionalTenants
Introduction
For each additional tenant that you wish to install on 3CX Phone System CloudServer,youneedto
reruntheCloudServersetupsomakesureyoukeeptheoriginalinstallationsetupsaved.

InstallingAnotherTenant
1. Doubleclickontheinstallationsetupfile.

2. A dialog will appear with a list of instances that the setup can support. The 3CX Phone
System Cloud Server Setuppackage can install up to 50 instancesfromTenant1toTenant
50.
3. Select the Installnewinstanceoption.InthisexamplewewillselectTenant2.PressNextto
continue.

4. Enter the tenant name for tenant 2 in this example we named it t2. Follow the same
installation procedures as outlined for Tenant 1 (except steps 7 sslconfiguration, and 10
wherethesuperadministratorforthe3CXCloudServerwasspecified).
5. ToinstalladditionalTenantsrepeatthestepsshownabove.
13

3CXPhoneSystemCloudServerv12

5.ConfiguringaTenantinstanceforaCustomer
Introduction
Once you have installed one or more tenants, you must continue to configure the 3CX Phone
System instance for the customer. Once configured, you can then roll outthe configuration to the
customer.

CreateExtensions
The process for creating extensions on 3CX Cloud Server is identical tothe standard 3CX Phone
System. You probably wish to use the capability to import extensions and DIDs to speed up the
process.
FormoreinformationonhowtoimportextensionsandDIDspleaseseeChapter5andChapter7
ofthe3CXPhoneSystem12UserManualrespectively

CreateaDedicatedSIPTrunk
For billing purposes, you must create a dedicated SIP trunkfor eachcustomer.3CXPhoneSystem
does not include a billingfeature.Howeveras areselleritsmuchbettertoworkwithoneofthemany
SIP trunk providers that are able to provide you a separate account per customer andsendyou the
bills for each trunk or bill the customer directly. Separating the SIP trunk will greatly reduce the
securityandcreditriskcomparedtohavingoneSIPtrunkforallcustomers.
The procedure to createa dedicated SIP trunk is identical to the standard 3CX Phone System. For
moreinformationpleaseseethe3CXPhoneSystemmanual.

CreateanAdministratorfortheTenant(Optional)
If you wish to allow your customer tobe able to edit ALL 3CX PhoneSystemsettings,includingthe
SIP trunk, then you mustcreate an administratoraccountforthe customerandsendthecredentials
toyourcustomer.Todothis:
1. Logintothetenants3CXCloudServerManagementConsole.
2. Click on the Extensions node and select the Extension that you want to provide with
AdministratorRights.
3. Edit the extension of the user you want to grant administrative rights to and select the
Optionstab.

14

3CXPhoneSystemCloudServerv12

4. Check the Allow 3CX Management Console Access checkbox and then click on Configure
PermissionstosettheextensionsaccessleveltotheManagementConsole

5. Check the options Global Extension Manager (this will allow the user to manage all
extensionsandextensiongroupswithin3CXPhoneSystem).
6. Check the VoIP/ Trunk Administrator option so the user can manage and createSIP trunks
and configure VoIP Provider accounts.YoumayalsoenabletheSystemAdministratoroption
so that the user can modify System Extensions such as Queues, Ring Groups, IVRs,have
accesstoSettingsandperform3CXPhoneSystemUpdates.

15

3CXPhoneSystemCloudServerv12

7. Press OK. Then type in the password in the Access Password for 3CX Web Services and
clickApply.
8. Send the Credentials (extension number and Access Password for 3CX Web Services to
yourclient.TheURLwilllooklikethishttps://cloud7.3cx.test/t2/management

Createalimitedaccessuser
Alternatively, you can create a limiteduser account that allows your customer to change extension
settings only. This way the customer can not accidentally change SIP trunk and other important
systemsettings.Todothis:
1. Logintothetenants3CXCloudServerManagementConsole
2. Click on the Extensions node and select the Extension that you want to provide with
AdministratorRights
3. Edit the extension of the user you want to grant administrative rights to and select the
Optionstab

4. Enable Allows 3CX Management Console Access and click on the Configure Permissions
buttontosettheextensionsaccessleveltotheManagementConsole

16

3CXPhoneSystemCloudServerv12

5. Check the Group / DepartmentManager option (this will allow the user tochange Extension
Settings for all theextensions belonging to the samegroupastheuser).Ifyouwanttheuser
to only be able tochange his ownextensionsettingsenableonlythe Manageown Extension
option.
6. After selecting the level of access press OK . Then type in the password in the Access
Passwordfor3CXWebServicesandclickApply.
7. Send the Credentials (Extension number and Access Password for 3CXWebServices)
toyourclient.

Configurethe3CXTunnel
The 3CX Tunnel configuration forms an important part of the 3CX Cloud Server as itallows you to
send deploy 3CX at your customer without opening any ports at the customer side. In effect it will
functionasaSessionBorderController.
The 3CX Tunnel will bundle all SIP traffic over a single TCPportandavoidanyfirewallconfiguration
issues. Furthermore, all provisioning information can besentviathe3CXTunnelanditwillallowyou
tomanagetheIPPhonesinstalledatthecustomersiteremotely.
Toconfigure3CXTunnel:
1. Accessthe3CXManagementconsole

17

3CXPhoneSystemCloudServerv12

2. ClickonSettings>Network>3CXTunnelTab

3. Enterapasswordforall3CXTunnelConnections.YouwillneedthislaterfortheSBC
4. Select the Tunnel Network Listening interface from the dropdown. (Default interface is
preselected)
5. Take a note of the tunnel listening port. If you restore a backup from a standard 3CX Phone
System Installation onto a cloud tenant, you might need to change the port depending on
whichtenantyouarerestoringthebackupfor.

18

3CXPhoneSystemCloudServerv12

6.DeployingAConfigurationforCustomers
Introduction
Once you have installed a Tenant instance of 3CX Cloud Serverandconfigured it correctly as per
thepreviouschapter,youarenowreadytodeploytheIPPhonesatthecustomersite.

FirewallConfiguration
Ensure that you have correctly configured the ports on your firewall to allow this tenant to function.
YouwillneedtocreatetheappropriateportmappingsasexplainedintheGettingstartedchapter.

3CXSessionBorderController
The 3CX Session Border Controller will bundle all SIP traffic over asingleTCPport.Inaddition3CX
SBC will allow you to easily provision remote IP Phones. 3CX SBC establishes a virtual VPN and
adds a layer of security between the remote site and the hosted 3CX Phone System instance by
encryptingalltraffic.
3CX Session BorderControlleris available forWindowsorasa RaspberryPiLinuxDebianVersion.
If the customer has an existing Windows Server or Desktop that is always on, you can choose to
usethe3CXSBCforWindows.Alternatively,youcanpreloaditonadedicatedRaspberryPIdevice.

Installing3CXSessionBorderControllerforWindows
Toinstall3CXSessionBorderControllerforWindows:
1. Download3CXSBChere.

2. During setup you will be asked whether 3CX Phone System is installed directly on the
internet (with thelocal interface being a public IP Address)orbehindaNAT(Wherethelocal
interface is a local IP Address). Choose the appropriate option. In this example we will
assumethat3CXCloudServerisinstalledbehindaNAT.

19

3CXPhoneSystemCloudServerv12

3. Toconfigure3CXSBCforWindowsyouwillneedtohavethefollowinginformationavailable:
a. PublicIPaddressorFQDNofthe3CXServersite
b. Internal IP address of the 3CX Server. (If Server is not behind a NAT, this step is
skipped)
c. The3CXPhoneSystemtenantTunnelPort
d. The3CXPhoneSystemtenantSIPPort
e. The3CXPhoneSystemtenantTunnelPassword(Chapter5TunnelSection)
4. Installationwill proceedandtheservicewillstart.Toaccesstheconfigurationfileandthelogs
clickontheStartMenu>3CXSBCConfigandlogsShortcut.

Installing3CXSessionBorderControllerforRaspberryPi

When you buythe raspberry Pi device make sure to purchase the'kit'optionwhichincludes

theSDCard.
Not all SD cards work.Someofthemmightnotbecompatible.The SDcard thatcomeswith
thepi isformattedtoworkoutofthebox.Ifyoubuythem separatelyyouneedtofollowguides
ontheinternettogetthecardreadable.

Part 1: Raspberry Pi Preparation and 3CX SBC Installation

1. AssemblethePiandpowerupthedevice

20

3CXPhoneSystemCloudServerv12

2. A window with title 'NOOBS' will come up and select Raspbioan OS. When you are done a
menucomesup.
3. Select 2 to change the default password. Default user name is pi and password is
raspberry.
4. Select option 8 (Advanced Options) and select the Hostname Option. Enter a unique
hostnameforthedeviceexamplerasp1.
5. EnableSSHonthedevicesoyoucanlaterloginusingputtyandSSH.
6. From the main menu select Finish and hit Enter and select Yes to Reboot. (TIP: Whilst the
deviceisbooting,youcanpressandholdShiftkeyinordertoaccessrecoverymode.)
7. After the device is up, it is recommended to update debian OS. Open a terminal and type
sudoaptgetupdate

8. We need to inform DebianOS from where to download 3CX SBC Updates. This is doneby
addingarepositorylink.Typeinthefollowingcommand:
echodebhttp://downloads.3cx.com/downloads/sbc/>>/etc/apt/sources.list

9. After we need to add a digital signature key to ensure 3CX SBC downloads are from a
trustworthysource.Typeinthefollowingcommand:
wgetOhttp://downloads.3cx.com/downloads/sbc/public.key|aptkeyadd
10. Afteryoucantypeaptgetupdatetogetalllatestdownloadsagain.

21

3CXPhoneSystemCloudServerv12

11. Nowyoucaninstall3CXSBC.Typethecommand
aptget install 3cxsbc. 3CX Session Border Controller will be installed and started
automatically.
SomeImportantthingstoknowabout3CXSBConRaspberryPi
Afterinstallationtheapplicationwillhavethefollowingstructure
/etc/3cxsbc.confThe3CXSBCConfigurationfile
/var/log/3cxsbc.log 3CXSBC Log file.Default is disabled. If requiredenabletemporarilyand
then disable. File size can grow and consume limited SD Card space on thePicausingthe
OStocrash.
/usr/sbin/3cxsbcHereistheactualexecutablefile
/etc/init.d/3cxsbcDaemonFile.

Part 2: Configuring 3CX SBC

1. Typeinthefollowingcommandtoconfigure3CXSBCConfigfile
nano/etc/3cxsbc.conf

2. Enterthebelowinformationin3cxsbc.conf
a. [Bridge] section > Password 3CX Tunnel Password taken from the 3CXTunnel
Tabinthetenantsmanagementconsole
22

3CXPhoneSystemCloudServerv12

b. TunnelAddrPublicIPaddressorFQDNofthe3CXServersite
c. TunnelPortThe3CXPhoneSystemtenantTunnelPort
d. Name3CXSBCConnectionName
e. PbxSipIPIPAddressofPBX
f. PbxSipPortThe3CXPhoneSystemtenantSIPPort
g. Saveallmodificationsandexitthefile.(CtrlX)
3. Type in the following command service 3cxsbc restart to restart the 3CX SBC Service so
themodificationscomeintoeffect.

23

3CXPhoneSystemCloudServerv12

7.PreparingtheIPPhones
Introduction
Once 3CX SBCs are configured and connected to the 3CX Cloud Servers, it is time to deploy
phonestotheremotenetworks.
Yealink and snom Phones will send a Plug and Play request. Other phones require the
provisioninglinktobeenteredmanuallyintheirwebinterface.
YealinkandsnomPhonesareprovisionedusingHTTPS.OtherphonesuseHTTP.

ProvisioningYealinkPhones
1. PoweruptheYealinkphoneattheclientssite
2. AccessthewebinterfaceoftheYealinkphoneandlogin

3. Navigate to Security > Trusted Certificates and set the option Only Accept Trusted
CertificatestoDisabled.PressConfirmtoapplythechanges.ThePhonewillreboot.

4. Access the 3CX Tenants Management consoleandnavigatetothePhonesnode.Selectthe

YealinkPhoneentryandrightclicktoaddanextensionorassignanexistingextension.

24

3CXPhoneSystemCloudServerv12

5. Go to the Phone Provisioning tab to ensure that all the settings are correct. Click on the
Select Interface dropdown and confirm that the preselected interfaceiscorrect.TheIPand
PortoftheSessionBorderControllerwillbeautomaticallypopulated.
6. Click OK. 3CX Phone System will instruct the Phone to provision. It may take around 510
minutes for the phone to provision. After you will see the phone registered in the Phones
node.

ProvisioningsnomPhones
1. Power up the snom Phones at the clients site. The snom phonewill send a Plug and Play
Notification.

2. Access the 3CX Tenants Management consoleandnavigatetothePhonesnode.Selectthe

snomPhoneentryandrightclicktoaddanextensionorassignanexistingextension.
3. Go to the Phone Provisioning tab to ensure that all the settings are correct. Click on the
Select Interface dropdown and confirm that the preselected interfaceiscorrect.TheIPand
PortoftheSessionBorderControllerwillbeautomaticallypopulated.
4. ClickOK.3CXPhoneSystemwillinstructthePhonetoprovision.
5. AccesstheremotesiteandopenthewebinterfaceofthesnomPhone.

25

3CXPhoneSystemCloudServerv12

6. Navigate to Certificates > Unknown Certificates andinthesectionTLSServerAuthentication

clickActivate.Thephonewillimmediatelyrebootafterthis.

7. When the phone is back up again, access the web interface again, go to Certificates >
UnknownCertificates,andclickonthelinkAddException.
8. Click Advanced>UpdateandpressReboot.Phonewillrebootandwillregisterto3CXPhone
System.

26

3CXPhoneSystemCloudServerv12

ProvisioningCiscoSPAPhones
TheCiscoSPAPhonesattheremotesitewillrequirethebelowinstructions
1. Logintothe3CXCloudServerTenantManagementconsole.
2. Create oredit anexistingextension.Thistheextensionthatwillbeusedandprovisionedas a
remoteextension.
3. Select the Phone Provisioning tab, insertthe MACaddress and select the Model of the
phonethatyouwanttoprovision.
5. IfyouwantyoucanalsoselectthePhoneDisplayLanguageofyourchoicebyclickingand
selectingfromthedropdownlist.
6. ClickProvisioningMethoddropdownandselect3CXSessionBorderController
7. TheSelectInterfacedropdownwillbeautomaticallyconfiguredtousethePublicInterface.
ConfirmthatyouseetheFQDNoftheServer.
8. InthefieldIPAddressofSessionBorderControllerentertheLocalIPAddressofthe3CX
SBCMachineorRaspberryPi.ThePortshouldremain5060asallSBCsareconfiguredto
workonport5060.Changingthisportwillbreakthesetup.
9. ConfigureanyCodecprioritiesorBLFlampfieldsinthesectionsthatfollow.
10. PressApplyorOKtosavetheconfiguration.
11. AccessthewebinterfaceoftheSIPPhoneontheclientsiteanddependingonthetypeof
phoneused,youwillneedtoconfiguretheprovisioningurlineachphone.Sinceeachphone
hasaspecificURLformat,samplesareprovidedbelowfortheHTTPURLformatusedby
themostpopular3CXsupportedphones:
ProvisioningPopular3CXSupportedPhones
TheprovisioningURLcanbeachievedbyaccessingthe3CXManagementconsole,navigateto
Settings>PhoneProvisioning>GeneralTab.

TheExternalProvisioningURLisvisibleandneedstobeusedandformattedforeachphone.
ThefollowingnotationwillbeusedtodescribetheprovisioningURL
PublicIPofPBXshouldbereplacedwiththepublicIPorFQDNofthe3CXCloudServer.
Tenantnameshouldbereplacedwiththetenantfriendlyname
ProvSubDirvariableshouldbereplacedwiththeProvisioningSubDirectoryfoldername.
ProvisioninglinkforCiscoSPAphones:
ClickonAdminLogon>Advanced>Provisioning>ProfileRuleandenterthefollowingurl:
http://PublicIPofPBX/tenantname/provisioning/%%ProvSubDir%%/$MA.xml
27

3CXPhoneSystemCloudServerv12

ProvisioninglinkforCisco7940/7960phones:
Cisco7940and7960phonesrequireaTFTPserver.
IftheremoteclientsitehasaDHCPthatsupportsoption66,createanoption66ruleandspecifythe
IPAddressofyourTFTPserver.PlacethegeneratedciscofilesintherootoftheTFTPandrestart
thephone.IfDHCPoption66isnotavailable,entertheTFTPservermanuallyintheGUIofthe
phone.

28

3CXPhoneSystemCloudServerv12

8.TheCentralManagementConsole
Introduction
3CX Cloud Serverhas a central management console that allows you to quicklychange settings in
anyofthetenantsinstalledonthesystem.

RunningtheCentralConsole
Toaccessthe3CXCentralAdministratorConsole:

1. Click on the 3CX Cloud Server Management Console shortcut on your Desktop (which is
createdwhenyouinstallthefirsttenant)
29

3CXPhoneSystemCloudServerv12

2. Select your Languageandtypeinthe UsernameandpasswordfortheSystemadministrator.

Thiswasconfiguredduringthe3CXWizardrightafterinstallingthefirsttenant.
3. PressLogintologintotheCentralManagementConsole.

4. Once you log in you can see the various tenants and configure each tenants 3CX Phone
Systemsimplybyselectingthetabwiththetenantsname(t1,t2,t3inthiscase)

30

3CXPhoneSystemCloudServerv12

9.Backingupalltenants
Introduction
3CX Cloud Serverallowsyoutobackupalltenants inoneautomatedprocedure.Thissavesvaluable
administrationtime.

RunningtheBackup
Therearetwomethodsavailabletouserstorunbackupandrestore:

1. Onthedesktop,clickontheicon3CXCloudServerBackupandRestore,or

31

3CXPhoneSystemCloudServerv12

2. Log into the Central Management Console as shown in Chapter 7 . Then click on
MaintenanceatthetopmenuoptionsandselectBackupandRestore

3. AfteryoulaunchtheBackupandRestoretoolyouwillsee2options:
Backup3CXCloudServer
Restore3CXCloudServer.
SelectBackup3CXCloudServer

4. In the Back up Phone System section, select the Tenants that you wantto backup from the
list and also any additional backup options such as Voice prompts, Voice mails, Call
recordings, Call HistoryandPhoneFirmwarefiles.YoucanpresstheSelect allbuttonnextin
eachtenantrowtobulkselectalloptions.ClickNext.

32

3CXPhoneSystemCloudServerv12

5. After selecting your backup options click on Browse to choose the destination directory
whereallthe3CXtenantbackupswillbesaved.PressNexttostartthebackup.

6. 3CX Cloud Backup will start and a progress bar will show the backup progress of each
tenant whilst it is being backedup. Backupsarestandardin.zipfileformat.Eachbackupwill
have the tenants name as file name making it easy to distinguish. Press Close when all
tenantsarebackedup.

33

3CXPhoneSystemCloudServerv12

RestoringaBackuporawholeCloudServer
TorestoreabackupyoufirstneedtostarttheBackupandRestoreToolasdescribedhere.

1. Launch the 3CX Cloud Server Backup and Restore tool from your desktop and select the
Restore3CXCloudServeroption.

2. Select the folder that contains all the backups inside. You cancreateanyfolderandput3CX
Backups in that folder. If you have any backups from standard 3CX Phone System
installations, put them in the directory. The below image is an example ofadirectorynamed
3CXBackupscontainingmultiple3CXPhoneSystemBackupsinside.

34

3CXPhoneSystemCloudServerv12

3. Select the tenant that you want to restore, and map eachtenantwiththeappropriatebackup
file by clicking on the 3CX Backup File dropdown on the far right. Dothis for all the tenants
youplantorestore.PressNexttostarttherestoreprocedure.

35

3CXPhoneSystemCloudServerv12

4. A progress bar willbedisplayed.NoteRestoringmighttakesometime.Alsosomeservices

are common for all tenants so restoring a clients backup should bedone outside of office
hoursandtheotherclientsshouldbeinformedthataperiodofdowntimewillbeexperienced.

PerformingaBackuporRestoreviaCommandLine
3CX Cloud Server Backup and restore can also allow the admin to trigger backup and restore
operations via command line utility. This means that you can make a scheduled task and trigger a
batchfiletoperformdailybackupsofyourcloudserver.

Backup via Command line

1. Open a command promptwindowand navigate to the 3CX Program files > Bin folderof the
FIRST Tenant. Example: cd C:\Program Files\3CX PhoneSystem t1\Bin (Where t1 in this
exampleistheTenantnameofthefirsttenantinstallation.)
2. TheBackupandrestoretoolcanacceptcommandsinthefollowingorder:
3CXBackup.exe[hidden][backup|restore][path_to_backups][options]exit
3. Examplecommandwouldlooklikethis:
3CXBackup.exe hidden backup C:\backup /callrecordings /voicemails /voiceprompts
/callhist/firmwareexit
4. Availableoptionsarethefollowing:
hidden:runstheutilityinhiddenmode
/callrecordings:backupextensioncallrecordings
/voicemails:backupstoredvoicemails
/voiceprompts:backupvoicepromptsandmusiconhold
/callhist:backupcallhistorytablesfromdatabase
/firmware:backupstoredfirmwares
5. The backup will be completed and all the backups of all the tenants will be located in the
folderspecifiedinthisexampleC:\backup
36

3CXPhoneSystemCloudServerv12

Restore via Command line

1. Open a command promptwindowand navigate to the 3CX Program files > Bin folderof the
FIRST Tenant. Example: cd C:\Program Files\3CX PhoneSystem t1\Bin (Where t1 in this
exampleistheTenantnameofthefirsttenantinstallation.)
2. TheRestorefunctionalitycanacceptcommandsinthefollowingorder:
3CXBackup.exe[hidden][backup|restore][path_to_backups]exit
3. Examplecommandwouldlooklikethis:
3CXBackup.exehiddenrestoreC:\backupexit
(WhereC:\backupisadirectorythatcontainsallthebackupstakenpreviously)
4. There is no need tospecify options during restore because data will be restored depending
onthedatathatwasbackedup.
5. The restore procedure will know which backup to restore to which Tenant installation
depending on theTenantName.Thebackupfilenamesshouldnotbemodifiedbecausethey
representtheTenantName.
TIP: An Administrator should makeasimplebatchfileandsaveiton the3CXPhoneSystemServer.
Then a ScheduledTaskinWindowsshouldbecreatedandthebatchfilewillbetriggeredperiodically
ideally after office hours. Keep in mind that a complete backup takes time and also dependsonthe
number of tenantsinstalledand the size of each installation. Sowhen thebackuptaskstarts,make
sure that between one task and another, there is enough time for the backup to complete. Same
appliesforrestoreprocedures.

37

3CXPhoneSystemCloudServerv12

10.Updating3CXCloudServerviaServicePackUpdates
Introduction
It is recommended to update to the latest 3CX Service Packs immediately. To update perform the
followingprocedure.
1. Accessthe3CXCentralManagementConsoleandloginusingtheSysadminAccount.
2. ClickonMaintenanceintheSysadmintoolbar

3. SelectCheckforUpdates

4. Select the service pack and press Update. All 3CX Cloud Tenants will be stopped, updated
andrestartedautomatically.

38

3CXPhoneSystemCloudServerv12

11.Uninstallation
Introduction
Insomecircumstances,itmightberequiredtouninstall3CXCloudServertoeitherperforman
updateorafreshinstallation.Inthiscase,thereisascriptthatwillautomaticallyremoveallinstalled
tenantsexceptthefirstone.Thiswillsaveyoualotoftimeuninstallingeachtenantmanuallyoneby
one.

ClickStartandshowallapps.LaunchCloudServerBulkUninstallerasAdministrator.

39

3CXPhoneSystemCloudServerv12

Selectoption1toremovealltenants.Thiswillquietlyuninstallallinstalledtenantsfrom220.When
alltenantshavebeenremoved,toControlPanel,ProgramsandFeaturesandmanuallyuninstall
3CXPhoneSystemCloudServerTenant1.

40