Administrator Guide - Code Blue Corporation--Emergency ...Administrator Guide 3 Configuring Server Settings Warning: Advanced knowledge of the ToolVox system is required before making

800.205.7186 • www.codeblue.com

Administrator Guide

Code Blue • 259 Hedcor Street • Holland, MI 49423 USA • 800.205.7186 • www.codeblue.com GU-154-Tpage 2 of 173

ToolVox® X3Administrator Guide

Table of Contents

Section Page

2 IP Network Resources..................................................................... 3 3 Configuring Server Settings........................................................... 5 4 ToolVox® Software Update Procedure.......................................... 11 5 Configuring Digital & Analog (DAHDI) Hardware........................ 13 6 Configuring Trunks........................................................................ 18 7 Configuring Outbound Routes..................................................... 28 8 Configuring Code Blue Devices................................................... 30 9 Configuring Business Phones..................................................... 5510 Configuring Digital Receptionist (IVR)........................................ 5811 Configuring Inbound Routes........................................................ 6212 Configuring System Recordings.................................................. 6513 Configuring License Key Administration.................................... 6614 Configuring Backup & Restore.................................................... 6715 Unit Programming and Diagnostics (UPD) Configuration and Operation....................................................... 6916 Integrations..................................................................................... 85 16.1 Milestone XProtect......................................................85 16.2 Lenel OnGuard®.........................................................102 16.3SIPTrunkConfigurationwithCiscoCM.....................13417 IP Audio Interface Wiring Diagram..............................................13918 Lightning Protection....................................................................14019 ToolVox DHCP Server Configuration..........................................14320 Email - Postfix Setup for ToolVox X3..........................................14521 Virtual Instance Setup Guide.......................................................172 21.1InitialConfiguration....................................................172 21.2ManualNetworkConfiguration...................................172 21.3Licensing....................................................................17222 Download Information..................................................................173



2 IP Network Resources**Please note the below IP Network Ports are specified if you restrict Ports in your network and need to be allowed for the appropriate products listed**

Blue Alert® EMS

TCPoutgoingtoport5038onToolVox RTSPoutgoingtoport554(orotherlocally-configuredport)oncamerasifvideoisinuse

IP1500/2500/5000

HTTP/TCP,HTTPS/TCPincomingtoports80,443forweb-basedmanagement NTP/UDPoutgoingtoport123onToolVoxfortimeservice SNMP/UDPincomingtoport161forUPDtesting SNMPTRAP/UDPoutgoingtoport162forUPDtraps HTTPS/TCPincomingtoport443fromToolVoxforprogramming IAX2/UDPoutgoingtoport4569onToolVox SIP/UDPoutgoingtoport5060onToolVox RTP/UDPincomingfromToolVoxtoUDPports23456-23556(configurable) TFTPoutgoingtoport69forbatchprogramming

ToolVox

DHCPforIP5000unitsifconfigured SSH/TCPincomingtoport22forsecureshellmanagement SMTP/TCPoutgoingtoport25onconfiguredmailserverformailalerts DNS/UDPoutgoingtoport53ifconfiguredtouseDNSservers HTTP/TCP,HTTPS/TCPincomingtoports80,443forweb-basedmanagement NTP/UDPincomingtoport123fromIP1500/2500/5000fortimeservice SNMP/TCPoutgoingtoport161onIP1500/2500/5000forUPDtesting SNMPTRAP/TCPincomingtoport162fromIP1500/2500/5000forUPDtraps H.323/TCPincomingandoutgoingtoandfromport1720forH.323trunks HTTPS/TCPincomingtoport2000forWebminmanagement TCPincomingtoport2840fromBlueAlertclients IAX2/UDPincomingtoport4569fromIAX2phones TCPincomingtoport5038fromEMSclients RTSPoutgoingtoport554(orotherlocally-configuredport)oncamerasifEMS videoisinuse SIP/UDPincomingtoport5060fromSIPphonesandtrunks RTP/UDPincomingtoports10000-20000fromSIPandH.323phonesandtrunks TFTPincomingtoport69fromSIPphonesforbatchprogramming

ToolVox Blue Alert MNS Core Application HTTP/TCPandHTTPS/TCPincomingtoports80and443onToolVox OptionalInternetaccesstotheGoogleMapsAPIoverHTTPandHTTPSforaerialimagery

4U2SEE Digital Signage TCPoutgoingtoport3001on4U2SEEdigitalsigns



Desktop Alert MulticastUDPtoport9264ontheconfiguredIPv4multicastaddress,whichmust beroutedappropriatelytodestinationsystems Email SMTP/TCPoutgoingtoport25onconfiguredmailrelay

PAS DeliveredviatelephonyconnectionstoCodeBluePASunits(seeToolVoxand IP5000networkresources)

RSS HTTP/TCPincomingtoport80toreadfeedcontent ThisaccessshouldbeproxiedinsteadofallowingToolVoxtodirectlyservice requestsfrompublicnetworks

SMS via 2SMS HTTP/TCPtoport80viatheInternettowww.2sms.com

SMS via email See“Email”



3 Configuring Server SettingsWarning: Advanced knowledge of the ToolVox system is required before making any changes other than network settings to the system. Changing settings other than the network settings may result in complete system failure. Hourly support packages are available and require remote access to the system via remote desktop control. TheToolVoxX3hastheIPconfigurationsettoDHCPbydefault.WhilefacingthebackoftheToolVoxX3server,theNIContheleftiseth0andtheNIContherightiseth1.NICeth0istheonlyinterfacethatisactivatedatboot.NICeth1wouldneedtobeactivatedinWebmin,ifitisneeded.AuseraccountwasalsoaddedtorunthefollowingfromtheCLIforthosefamiliarwithLinuxplatforms: TherearemultiplemethodsforloggingintotheToolVoxserver.Initiallyyoumayjustwantakeyboardandmonitordirectlypluggedintotheserver.YoucanthenconfigurethenetworksettingsusingCLIcommandslistedbelow.OnceyouknowtheIPaddressoftheserveryoucanconnectviaSSHoruseawebbrowserandentertheWebminsideoftheservertoeditnetworksettings.Youdonotneedtodobothmethods.

Configuration of Network Settings Via Direct Connect andSSH commands:

ThisisthelogininformationfortheuseraccountontheToolvoxsystems:

Login: cbadminPassword: CodeBlue92

Thesearesomeofthecommoncommandsthisuserisabletorunassudo:

Ifconfig (seecurrentnetworkinfo)TheserverbydefaultisDHCPsoonceyouhaveconnectedanetworkconnectiontotheeth0portontherearoftheserver,itwillpullanIPaddressifDHCPisrunningonyournetwork.

IfthenetworkisnotrunningDHCP,thenrunthebelowcommandtoconfigureastaticIPaddress.

sudo system-config-network (setupDynamic/StaticnetworksettingsfortheToolVox).



1. SelectEditDevicesandeth0(illus.5and6).

2. EnteryourstaticIPaddress,Netmask,andDefaultGateway,thenselectOk,Save,and

Save&Quit(illus.7).

Illustration 5

Illustration 6

Illustration 7



NOTE: Afterchangingthenetworksettings,youMUST restartyournetworkservicesusingthefollowingcommand:

sudo /etc/init.d/network restart

IfyoualreadyknowtheIPaddressofToolVoxyoucansimplybrowsetotheIPaddressofToolVoxyoucansimplybrowsetotheIPaddresstodirectlyaccessthesystemandbeginsettingupCodeBluePhones.Thebelowisanothersideoftheserverifyouwantedtosetupthenetworkdevicesand/orthePostFixMailServersettings.



Webmin commands:

OnceyouconnectToolVoxtoyournetwork,youshouldbeabletologintotheWebminmanagementportalwiththeDHCPassignedaddressorStaticIPthatyousetupintheprecedingsteps:Usingyourwebbrowser,browseto:https://ToolVoxIP:2000.

Enterthedefaultusername‘cbadmin’ andpassword‘codeblue’. ClickLogin

IfyouwishtochangeClickNetworkingontheleftnavigationbar.

ClickonNetworkConfiguration.

ClickonNetworkInterfaces.



ClickonActivatedatBootthenclickoneth0.

EntertheIPAddressandNetmaskthenclick

Click

Click on

EntertheGatewayIPAddressforeth0andclick

Click

Click on

EnterHostnameandDNSserverIPAddressinformation(ifotherthandefault)thenclick



Thisconcludesthenetworkconfiguration.Youmayneedtorebootthesystemforthenewsettingstotakeeffect.BelowisthelistofthesettingsyoucancontrolviaWebminonyourToolVox.

Under Bootup and Shutdown you can shut down or restart your ToolVox. Located at the bottom of the Bootup and Shutdown section.



4 ToolVox® Software Update ProcedureOnly customers under ToolVox Annual Maintenance plans receive Full Hardware & Software Coverage and Software Upgrades/Enhancements/Bug fixes etc. Please inquire to Customer Service if not under a Plan.

ToolVox Software Update

1.1 InserttheToolVoxUpdateCDforyourToolVoxedition(StandardorAdvanced)intotheToolVoxhardware’sDVD-ROMdrive

1.2 BrowsetotheIPaddressofyourToolVoxCommunicationsServer

1.2.1 http://<IPaddressofToolVox>

1.2.2 Click on “Administration”

1.3 Enter“Username”:admin

1.4 Enter“Password”:codeblue(default)oranotherpassword



1.5 Click on Tools nexttoSetup

1.6 WARNING – if you haven’t done a backup recently please consider this a good time to start this practice. See “Configuring Backup & Restore” chapter.

1.7 Under“SystemAdministration”,clickToolVox Update

1.8 Click Update System.

1.9 SelectApply configuration changes (red bar) atthetopofscreenandReload(redbox)

1.10 Afterupdating,youmayneedtorefreshyourscreen.

1.11 LogoutandthenlogbackintoToolVox.

1.12 Theupdateprocessisnowcomplete.



5 Configuring Digital & Analog (DAHDi) Hardware

This is used to display and configure Digital and Analog Hardware that may have been installed in your ToolVox. T1 PRI, FXO, and FXS, depending on what is required in the application.

The Ports will be auto numbered during boot up of the ToolVox.

FXS Ports –FXS’sproducedialtoneandshouldbecrossconnectedtoanalogCodeBluedevicesorphonesthatneeddialtone.TheseFXSPortnumbersareusedwhenyoubuildyourphonesinCodeBlueDevices.

ClicktheBlue“Edit”buttonnexttotheFXSPorts.Theyshouldbeconfiguredasfollows.NotethatyourportnumberingmaybedifferentandtheGroupNumbershouldbe1.DonotchangeKewlStart.



Hitsavethen

ThenContinuewithreload.

If done making adjustments in DAHDi then press the Restart DAHDI button.

PressOK



FXO Ports – FXO’sreceivedialtone,andshouldbecrossconnectedtoBellPOTSphonelinesortoPhonelinesfromcustomerPBX.ThesePortnumbersareusedwhenyoubuildtrunkstotransportcallsintoandoutoftheToolVox. ClicktheBlue“Edit”buttonnexttotheFXOPorts.NotethatyourportnumberingmaybedifferentandtheGroupNumbershouldbe2.DonotchangeKewlStartandmakesuretheportsaresetupasfollows.

Hitsavethen


If done making adjustments in DAHDi then If done making adjustments in DAHDi then press the Restart DAHDI button.

PressOK



T1 PRI – IfyouareinterconnectingToolVoxwithaPBXviaaT1PRIconfigurethissectionprovidedyourhardwaredisplays.

ClicktheBlue“Edit”buttonnexttotheWildcardTE122Card.



SettheToolVoxtotheoppositeofthePRISignalingthenthePBXyourconnectingto.

CustomerPBXneedstobeNetorCPE.Hitsavethen


If done making adjustments in DAHDi then If done making adjustments in DAHDi then If done making adjustments in DAHDi then press the Restart DAHDI button.

PressOK



6 Configuring Trunks

TobeabletopasscallsfromtheToolVoxtoexteriorphoneslinesortoaPBXyoumustconfigureatrunk.

YouroptionsareDahdi(PRIT1,FXOphoneline),IAX2,oraSIPtrunk.IfyourserverhashardwareinstalleditwilldisplayintheDAHDIscreen.



Add ZAP/DAHDI Trunk

General Settings

OutboundCallerID(Optional):ThisistheCallerIDthatwillbeusedforoutboundcallsonthistrunk.Theformatis:“CallerName”<##########>.Youcanusethestring“hidden”todisableCallerIDonthistrunkifitisadigitalline



(PRI/BRI/E1/T1/J1/SIP/IAX).

Never Override Caller ID(Optional): CheckthisboxtodisableusingtheOutboundCIDsetupintheextensionsconfigurationpage.YoumustenteranOutboundCallerIDwhencheckingthisbox. Maximum Channels(Optional): Themaximumnumberofoutgoingcallsthatcanbemadesimultaneouslyonthistrunk.Incomingcallshavenoeffectonthemaximum.Adefaultofblankspecifiesnomaximum. Disable Trunk(Optional): Disablesthetrunkforallroutesconfigured. Monitor Trunk Failures(Optional): IfcheckedentertheAGIscriptthatwillbecalledtoeitherlog,email,ortakeactionduetoatrunkfailureotherthanCANCELorNOANSWER. Outgoing Dial Rules Dial Rules(Optional): ADialRuletosethowcallsaresentoutthistrunk.Ifyouroutboundcalldoesnotmatchanythingthenitwillbedialedasis.

•Xmatchesanydigitfrom0-9 •Zmatchesanydigitfrom1-9 •Nmatchesanydigitfrom2-9 •.isawildcardthatmatchesoneormorecharacters •|removesthedialingprefixfromthenumberdialed.Example9|. oThiswouldsendanynumberbeginningwith9outthisroute.95551212would send5551212outthistrunk. •+addsadialingprefixtothenumberdialed.Example1616+. oThiswouldadd1616toanynumbersentoutthistrunk.5551212wouldbe prependedandsenttothecarrieras16165551212.

Dial Rules Wizards(Optional): UsefulincreatingDialRules.Youcanusethewizardtoaddordeleteaprefixtonumbersorlookupnumbersforlocalcalling.

Outbound Dial Prefix(Optional): EntertheoutbounddialprefixforCentrexorothercustomtypeoftrunkswhereyouhavetodiala9etc.tomakeacalltothePSTN.

Outgoing Settings

ZAP Identifier (trunk name): Thisisthegroupnumberorindividualchannelnumberofthistrunk.AfteryouhavelookedintheDAHDImenuscreenandnotedtheFXOchannelnumbersyouneedtocreateoneofthesetrunksforeachFXOyouwishtouse.

ForexampleifyourFXO’sare1-4enter1intheZapIdentifier(trunkname)field.Thencreate3moretrunks,2,3,and4.YourOutboundRoutewillneedtobecreatedthatwillreferencethesetrunksasavailableroutes.

IfusingaPRIT1,usethegroupnumberyouwereassignedinDAHDI.Exampleg3

Tosaveyoursettingsclick:



Toapplythechangestothesystemclick:

Atthetopofthescreen.Click-Continue with reload-tofinishthechangesotherwiseclick-Cancel reload and go back to editing-tocancelthechangesandcontinueeditingtheextension.



Add IAX2 Trunk

General Settings

Outbound Caller ID(Optional): ThisistheCallerIDthatwillbeusedforoutboundcallsonthistrunk.Theformatis:“CallerName”<##########>.Youcanusethestring“hidden”todisableCallerIDonthistrunkifitisadigitalline(PRI/BRI/E1/T1/J1/SIP/IAX).

Never Override Caller ID(Optional): CheckthisboxtodisableusingtheOutboundCIDsetupintheextensionsconfigurationpage.YoumustenteranOutboundCallerIDwhencheckingthisbox. Maximum Channels(Optional): Themaximumnumberofoutgoingcallsthatcanbemadesimul-taneouslyonthistrunk.Incomingcallshavenoeffectonthemaximum.Adefaultofblankspecifiesnomaximum.

Disable Trunk(Optional): Disablesthetrunkforallroutesconfigured. Monitor Trunk Failures(Optional): IfcheckedentertheAGIscriptthatwillbecalledtoeitherlog,email,ortakeactionduetoatrunkfailureotherthanCANCELorNOANSWER.



Outgoing Dial Rules Dial Rules(Optional): ADialRuletosethowcallsaresentoutthistrunk.Ifyouroutboundcalldoesnotmatchanythingthenitwillbedialedasis.




Outgoing Settings

Trunk Name: Thenameyouwishthetrunktobeidentifiedas.

PEER Details: EnterthedetailsoftheIAX2PEERhere.Theorderofanyallowordenystatementswillbefollowedinorder.

USER Context: TheusernameoraccountidentifierthePEERisexpecting.

USER Details: EnterthedetailsoftheIAX2USERhere.Theorderofanyallowordenystatementswillbefollowedinorder.

Registration

Register String: TheregistrationstringrequiredtoauthenticatewiththeIAX2PEER.Example:username:[email protected]





Atthetopofthescreen.Click-Continue with reload -tofinishthechangesotherwiseclick-Cancel reload and go back to editing-tocancelthechangesandcontinueeditingtheextension.



Add SIP Trunk

General Settings

Outbound Caller ID(Optional): ThisistheCallerIDthatwillbeusedforoutboundcallsonthistrunk.Theformatis:“CallerName”<##########>.Youcanusethestring“hidden”todisableCallerIDonthistrunkifitisadigitalline(PRI/BRI/E1/T1/J1/SIP/IAX).

Never Override Caller ID(Optional): CheckthisboxtodisableusingtheOutboundCIDsetupintheextensionsconfigurationpage.YoumustenteranOutboundCallerIDwhencheckingthisbox. Maximum Channels(Optional): Themaximumnumberofoutgoingcallsthatcanbemadesimul-taneouslyonthistrunk.Incomingcallshavenoeffectonthemaximum.Adefaultofblankspecifiesnomaximum.

Disable Trunk(Optional): Disablesthetrunkforallroutesconfigured. Monitor Trunk Failures(Optional): IfcheckedentertheAGIscriptthatwillbecalledtoeitherlog,email,ortakeactionduetoatrunkfailureotherthanCANCELorNOANSWER.



Outgoing Dial Rules Dial Rules: Dial Rules(Optional): ADialRuletosethowcallsaresentoutthistrunk.Ifyouroutboundcalldoesnotmatchanythingthenitwillbedialedasis.




Outgoing Settings

Trunk Name: Thenameyouwishthetrunktobeidentifiedas.

PEER Details: EnterthedetailsoftheSIPPEERhere.Theorderofanyallowordenystatementswillbefollowedinorder.

Example:

host=X.X.X.X(IpaddressofcorrespondingIPPBX)

type=peer

qualify=yes

context=from-internal

USER Context: TheusernameoraccountidentifierthePEERisexpecting.Mostcasesanameyoumakeupandisnotneeded.

USER Details: EnterthedetailsoftheSIPUSERhere.Theorderofanyallowordenystatementswillbefollowedinorder.

Example:

host=X.X.X.X(IPaddressofcorrespondingIPPBX)

type=user



context=from-trunkRegistration

Register String(Optional): TheregistrationstringrequiredtoauthenticatewiththeIAX2PEER.Example:username:[email protected]



atthetopofthescreen.Click-Continue with reload-tofinishthechangesotherwiseclick-Cancel reload and go back to editing-tocancelthechangesandcontinueeditingtheextension.



7 Configuring Outbound Routes Outbound Routes is the area that you configure the ToolVox to select a Trunk to transport calls out of ToolVox.

Route Name: Describethetypeofroutehere.Exampleswouldbe:LocalCalls,LongDistanceandInternational.

Route Password: (Optional)Usearoutepasswordtohavethesystemprompteachcallertothisroutetoenterthepasswordinordertobeabletomakecalls.Thisisusefultopreventunauthorizedlongdistantorinternationalcalling. Pin Set: (Optional)EnterthePinSetgrouptobeusedforauthenticatingcallsoutonthisroute.IfutilizingaPinSetleavetheRoutePasswordfieldblank. Emergency Dialog: (Optional)ThissettingwillforcetheextensionsEmergencyCIDtobeusedonanoutgoingcall.Thissettingistypicallyusedonroutesto911orpublicsafetydispatchcenters. Intra Company Route: (Optional)ThissettingwillpreservetheinternalExtensionCIDandnotreplaceitwiththeOutboundCIDoftheextensionorthetrunk.Thisisusedfordialingacrosscon-nectedToolVoxsystems. Music on Hold: (Optional)Selectwhichmusiconholdcategorytouseorselectnone.



Dial Patterns: ADialPatternwillbeusedtoselectthistrunkforoutboundcalls.

•Xmatchesanydigitfrom0-9 •Zmatchesanydigitfrom1-9 •Nmatchesanydigitfrom2-9 •.isawildcardthatmatchesoneormorecharacters •|separatesthedialingprefixfromthenumberdialed.Example9|. oThiswouldsendanynumberbeginningwith9outthisroute.95551212would send5551212tothetrunksselectedbythisroute

Dial Patterns Wizard: (Optional)Usethewizardtoselectcommonroutematchingschemes.

Trunk Sequence: Selectthetrunkstobeusedforthisrouteandwhichordertheyshouldbeusedin.



Atthetopofthescreen.

Click-Continue with reload-tofinishthechangesotherwiseclick-Cancel reload and go back to editing-tocancelthechangesandcontinueeditingtheextension.



8 Configuring Code Blue Devices

Device Info

Extension: ThiswillbetheinternalnumberdisplayedonthephonesCallerIDscreenandEMSagentscreen.

Caller ID Display Name: ThiswillbetheinternalnumberNAMEdisplayedonthephonesCallerIDscreenandEMSagentscreen.

Unit Info

Model: ChoosethetypeofCodeBluePhoneyouareconfiguring.

Subtype: ThisfieldonlyappearsifyouareselectinganIP5000modelspeakerphone.

IP5000v1isthelegacyfirmware1.X.Xphone; IP5000v2isthecurrentproductionfirmware2.X.Xphone.

Device Connection Type: ChoosethemethodofconnectiontheCodeBluephoneisusingtoconnecttoToolVox.

FXSAnalogExtension–IA4100,CB3000,CB3100,IA500

SIP&IAXExtensions–IP1500/2500/5000

OffSystemUnit–IA4100,CB3000,CB3100,IA500

ThedifferencebetweenOffSystemandFXSisthatFXSareFXSportsprovidingdialtonedirectlyoffofToolVox.OffSystemUnitmeanstheanalogphonelineisprovidedbyanexternalPBXorlocalBellcompany.



Assigned DID/CID

(Optional) IfyouwishtohaveaninboundDirectDialednumberassociatedtothisphoneandringitwhendialedyoucanfillthisoutanditwillcreateanInboundRoutetothisExtension.

PushtheNextbuttontocontinueconfiguration

Please scroll down in this manual to the appropriate Model of phone you are provisioning. They are titled in RED lettering.

CB3000 & CB3100 Models

Device Options - FXS Analog Extension type

EnterintheFXSPortnumberfromDahdithatyouhavecrossconnectedtheAnalogCodeBluePhoneto.DonotduplicatethisnumberwithanotherCodeBlueDevice.

EveryotherfieldintheDeviceOptionsFXSanalogExtensiontypeSectionleaveasdefault.

Device Options - Off System Unit

EnterintheactualphonenumberToolVoxneedstodialtoreachthisunit.

Example:916163928296or6163928296or4378

ThismayormaynotbethesamenumberyouassigneditasanextensionontheToolVoxsystem



Voicemail Playback Commands

Skip this section if not using Messages. See the System Recording on how to load Messages.

Play Message 1 to Guard – 1stsinglemessagemustbelessthan18secondsandwillbeplayedonlytotheguard.

Play Message 1 at Unit – 1stmessagemustbelessthan18secondsandwillbeplayedattheCBunituntiltheguardanswers.

Play Message 1 at Unit. Play Message 2 to Guard – 1stmessagemustbelessthan9secondsandwillbeplayedattheCBunituntiltheguardanswers.2ndmessagemustbelessthan9secondsandwillbeplayedtotheguardandattheCBunituntiltheguardanswers.

Play Messages to Guard and at Unit – 1stmessagemustbelessthan9secondsandwillbeplayedatbothendsaftertheguardanswers.2ndmessagemustbelessthan9secondsandwillbeplayedatbothendsafterthe1stmessage.

Message 1 & Message 2 – youcanselectSystemRecordingsyouhavepreviouslyloaded.

Message Repeat – Howmanytimestorepeatthemessage.

Playback Volume – 3isthehighest

Other Options



Ring Down and ANI – Ringdownselection&AutomaticNumberidentification(ANI).Selections0-3areavailableonlyforstandardtrunklines,whileselections4-6areavailableonlyforanalogringdownlines.Note:thiswasoriginallyforRPD/CMS.FormostusersyouonlyneedtoselectwhetherthisCBphoneisconnectedonaDialupphonelineoraRingDown/Hotline.

Call Button (CB3100 only) – ThiscommandisusedwiththeCB3100Kkeypadfaceplatetoallowforanumbertobeautomaticallydialedbeforeusingthekeypad.

Ring Back Detection (CB3100 only) – Callprogressmonitorforhangup.

Wink Time (CB3100 only) – ThisistheminimumamountoftimethattalkbatteryisremovedorreversalofpolarityfortheCBphonetohangup.2=200millisecondsetc.0-9

In Call Commands (CB3100 only) – Theoperatorsabilitytosendcommandsduringacall.

Ring Time – Theamountoftimethephonewilltryanumberbeforeresettinganddialingthenextnumber00-60.

Dial Type (CB3000 only) – PhonelineusesPulseorDTMPencoding

Other Options (cont.)

Auxiliary #2 – DetermineswhetherAuxiliaryoutput#2(pins7&8)activatethesameasAuxiliaryoutput#1(pins5&6Slaved)orbypressingthe6keyduringacall(Unslaved).

Auto Connection – IfAuxiliaryoutput#2isunslavedfromAuxiliaryoutput#1,DisablingallowstheuseoftheInCallCommand(DTMF6)toactivateAuxiliaryoutput#2.IfenabledAuxiliaryoutput#2willactivateonanincomingcall.

Auxiliary #2 Active Time – TheamountoftimeAuxiliaryoutput#2willstayactive.00=Activeforthedurationofthecall.01-89=Activefor1-89minutes.90-99=5-50secondsin5secondincrements(90=5seconds,91=10seconds,etc.)



Phone Numbers

EnterinthePhoneNumberyouwishtheCBphonetocall.IfyouhaveadoublebuttonphoneenterintheNumberyouwishfortheInformationNumber.ACadencetableisprovidedifyoudesirecustomtoneintervals.

Cycle Count – NumberofcyclestheCBphonewillcyclethroughtheaboveNumbersifabusytoneisencountered

Command Passwords

Programming Password – Thepasswordusedtoaccessprogrammingmode(2)oninitialcallsintotheunit.

Monitoring Password – Thepasswordusedtoaccess2-waymonitoringmode(1)oninitialcallintotheunit.



Commands

Off Hook Time – MaximumconversationtimeinminutesbeforeCBphonehangsup.

Silent Timeout Alternate Hang-up Method – IfthiscommandisenabledtheCBphonewillhang-upafterhearingsilenceforthesetnumberofseconds.00-disabled05-99seconds.

Auxiliary Input #1 – EnablesAuxiliaryInput#1(pins9&10).Whenactivateditwillactivatearedbuttoncall.

Speaker Operation – Selectthetypeofspeakeroperationhere

Wait for Dial tone – ThisisthemaximumtimethattheCBphonewillwaitforadialtone0-99seconds.

Wait for progress tone – ThisisthemaximumtimethattheCBphonewillwaitforacallprogresstoneafterthelastdigithasbeendialed.

In-Call Commands

ThisisusedtodisplaytheIn-CallCommandsinthePop-UpwindowontheAgentsComputerifusingtheEventManagementSoftware



EMS Unit Location Information

EnterinthemostaccurateLongandLatofthisspecificCBunit.ThiswillpopupaBingSatellitemapontheAgentsComputerifusingtheEventManagementSoftware.Thensetyourpinlocationfortheunit.Youcanalsoenteralocationinthe“Find”boxorusethesatellitemaptonavigateandsetyourpinlocationforthisunit.

Detailed Unit Location – youcanselectacustommaptoplacetheCBunitonto,thatwillPop-UpawindowontheAgentsComputerifusingtheEventManagementSoftware.

Location Description / Notes – CustomDetailedCBUnitlocationinfothatwillPop-UpawindowontheAgentsComputerifusingtheEventManagementSoftware.

Device Camera URL’s

Camera 1 & Camera 2 – Youcanenterupto2camerastreamstotapinto,thatwilldisplayinthePop-UpawindowontheAgentsComputerifusingtheEventManagementSoftware

Unit Address Info

AddressInfothatwillappearinthePop-UpwindowontheAgentsComputerifusingtheEventManagementSoftware

Push“Finish”whendone

Push“ApplyConfigurationChanges”

Push“Continuewithreload”



IfyouhaveUPD(UnitProgrammingandDiagnostics)thenyoucanclick“ProgramExtension”tohaveToolVoxcallouttotheUnitandprogramit,providedtheToolVoxandPhonelinesareallbuilt.

YoumayalsonowcopytheCodeBlueextensionyoujustbuilttosavetime.IfananalogunityouwillhavetoeitherchangetheFXSportortheUnitnumberitcallsoutto,ifoffsystem.IfyouhaveEMSyouwillalsoneedtochangethatinfo.

IA500 Model



EveryotherfieldintheDeviceOptionsSectionforanFXSanalogunitleaveasdefault.



Example:916163928296or6163928296or4378

ThismayormaynotbethesamenumberyouassigneditasanextensionontheToolVoxsystem.



General Options

Programming Password – Thepasswordusedtoaccessprogrammingmode(2)oninitialcallsintotheunit.

Off Hook Time – MaximumconversationtimeinminutesbeforeCBphonehangsup.

Ring Time – Theamountoftimethephonewilltryanumberbeforeresettinganddialingthenextnumber00-60.

Cycle Count – NumberofcyclestheCBphonewillcyclethroughtheaboveNumbersifabusytoneis encountered

Auxiliary Output Closure Time – Thedefaultisforthedurationofthecall.Enter01-99secondstoallowactivationduringacallbypressingthe6keyonthecalledparty’skeypad

Phone Numbers

EnterinhowevermanyphonenumbersyouwishtheCBphonetocall.Ifuponencounteringabusylineitwillrolltothe2ndnumberautomatically.ByDefaulttheCBphoneissettorollthroughthenumberstwice.ThiscanbecontrolledwiththeCallCyclecountoptionabove.Youcanprogramupto6numbersfortheRedHelpbuttonoracombinationof6numbersfortheRedHelpandBlackInfobuttonifyouhaveadoublebuttonphone.

In-Call Commands

ThisisusedtodisplaytheIn-CallCommandsinthePop-UpwindowontheAgentsComputerifusingtheEventManagementSoftware.









Unit Address Info









IA4100 Model



EveryotherfieldintheDeviceOptionsFXSanalogExtensiontypeSectionleaveasdefault.



Example:916163928296or6163928296or4378

ThismayormaynotbethesamenumberyouassigneditasanextensionontheToolVoxsystem

Afterrunningatesttothephone,theToolVoxwillsensewhetheritisrevisionlevel1or2.Thismakescertainfieldsavailableornot.



Phone Numbers

Youcanenterinupto9Phonenumbersintothesememoryslots.Theywillbereferencedfurtherdownintheconfiguration.

Outputs

Output #1 Active Time – 00=Disabled,01-60=1-60seconds,61-90=1-30minutes,91=tillendofcall,92=triggeroninput2.



Recordings

IfyouwishtousemessagesyoucanrecordtheminSystemRecordingsandreferencethemhere.Youhave9memoryslotsandthesewillbecalleduponfurtherdownintheconfiguration.



Buttons and Inputs

Button 1 – thisistheRedbuttononyourCBphone.Bydefaultitwilltrynumbersinmemoryslots1,2,and3fromabove.Itwillalsoplayrecording1fromaboveandactivateOutputs1and3whicharenormallyopencontacts.TheCallCyclecountissetfor2bydefault,soforexampleifyousetPhoneNumbersas11itwouldcallPhoneNumberinmemoryslot1Fourtimesifitencounteredabusysignal.

Button 2 – thisistheBlackbuttononyourCBphone.Choose0asthephonenumberifyourCBphonehasakeypad.Thiswillprovidedialtonewhentheblackbuttonispushedsothekeypadcanbeused.IfthereisnokeypadpresentthenyoucanenteraPhoneNumberslottohaveButton2placeacall.

Button 3,4 – IfyouhaveaCBphonewitha3rdand4thbuttonyoucanprogramthemhere.

Input #1,#2 – selectwhichbuttonyouwanttheinputtomimic

Loss of AC Power – Enterthephonenumbermemoryslot1-9andoutputsthatyouwanttheunittodialshouldtherebealossofACpower.Entertherecordings1-9thattheunitshouldplaywhenthecallisanswered.

Low Battery - Enterthephonenumbermemoryslot1-9andoutputsthatyouwanttheunittodialshouldtherebealowbatterycondition(lessthan11.7VDC).Entertherecordings1-9thattheunitshouldplaywhenthecallisanswered.

AMP SPKR Fault - Enterthephonenumbermemoryslot1-9andoutputsthatyouwanttheunittodialshouldtherebeanAMP/PASfault.Entertherecordings1-9thattheunitshouldplaywhenthecallisanswered.

Call Properties

Wait For Dial Tone – 00=ringdown/Hotline,01to99=1-99seconds.Ifdialtoneisnotdetectedinthistimethephonewillhangup.

Call Progress Detection Delay – 1to99is1-99seconds.Thetimethatthephonewillwaittohearprogresstonesafterdialing.



Wait for Answer - Theamountoftimethephonewilltryanumberbeforeresettinganddialingthenextnumber00-99.Timerbeginsatbuttonpress.

Call Connected – 0or1,0=whenvoiceorDTMFisdetectedbytheCBphone.1=callisassumedconnectedimmediatelyandwillnotretry.(Non-ADA)

Call Loop Cycles – NumberofcyclestheCBphonewillcyclethroughtheaboveNumbersifabusytoneisencountered.

Duplex Operation – AudiooperationoftheCBphone.HalforFull.Halfisgenerallymuchbetterinmostsituations.InveryloadenvironmentsFullmaybenecessarysothemicandspeakerarebothonatthesametime.

Full Duplex Noise Cancellation – IfyouuseFullDuplexthenyoucanincreaseNoisecancellationbutmaysuffersomeaudiodegradation.

Answer Message Repeat – Enablingwillforcemessagesaftertheguardanswerstorepeatuntilthein-callcommand33issenttotheunit.

Acknowledge Beep Delay – Theamountoftimethephonewillwaittoplayacknowledgmenttones.Designatedvalue*20=timeinmilliseconds.ExampleValue15=300ms.

Call In Answer Mode – IntwowayAudiotheunitwillanswerandimmediatelygointo2waytalkmode.In2wayAudio–Passwordrequired,theunitwillpromptthecallerforapasswordbeforeentering2waytalkmode.

Miscellaneous

DTMF On Time – DTMFtoneduration:1to3=100to200ms,4to9=40msto90ms.

DTMF Off Time – SilencebetweenDTMFtoneduration:1to3=100to200ms,4to9=40msto90ms.



DTMF Dialing Volume – SetsthevolumeoftheDTMFtonesduringthedialingsequence

Recording Playback level – Setsthevolumeleveloftherecordingsplayedbackoutoftheunitandtotheguard.

Answer Ring count – NumberofRingsbeforetheunitwillanswer

Ring-In Unit Speaker – Enabletohearincomingcallringoutoftheunitspeaker

Enable Mass Notification System – EnablingwillforcetheIA4100toanswerincomingcallsandpasstheaudiototheamp/speakerarray.

Mass Notification Outputs - Ifdesiredselect1oftheAuxiliaryOutputsandarecordingtoplayfromoneoftherecordingmemoryslotsabove.

Disable Battery Check - Yes-Donotcheckthebattery.No-Checkbatteryandcallnumbersetabovein“LowBattery”Section.

Hang up Methods

Wink Timing – 0=disabled,1-9=100msto900ms.Lengthofthewinksignalcomingfromtheconnectedphoneline.

Revert to dial tone – 00=disabled,01-991to99seconds.Continuoussoundforthisperiodoftimewillcausetheunittohangup.

Silent Time Out – 0to3,0=disabled,1=30sec,2=60sec,3=90sec.Silenceforthisperiodoftimewillcausetheunittohangup.

Reorder/Repeating Tones – 00=disabled,01to99=1to99cycles.Thisisthenumberofrepeatingcyclesthatwillcausetheunittohangup.

Call Time Out – 00=disabled,01-99=1to99minutes.DTMFtonesBBBBBwillplaytobothpartiesduringacallnotifyingthem30secondspriortocalldisconnect.AtthistimethecallcanbeextendedbyenteringtheINcallcommand31.Oncethetimerhasexpired,ifcommand31isnotentered,theunitwillhangup.

Wink Voltage Minimum – MinimumvoltagechangetointerpretasaWINK.0=5Vthru9=14V.

Minimum Ring Voltage Detection – Threshold-0=13Vrms,1=19Vrms,2=40Vrms.

Maximum Ring Frequency – 0=75Hz,1=50Hz,2=35Hz.



Pass Codes Advanced Programming Passcode – 2583isthedefaultforenteringintoprogrammingmode.Youcanchangeit.

Audio Passcode – defaultisblank.Youcanadditifnecessary.

In-Call Commands

ThisisusedtodisplaytheIn-CallCommandsinthePop-UpwindowontheAgentsComputerifusingtheEventManagementSoftware






Camera 1 & Camera 2 – Youcanenterupto2camerastreamstotapinto,thatwilldisplayinthe



Pop-UpawindowontheAgentsComputerifusingtheEventManagementSoftware

Unit Address Info







IP1500/2500 or IP5000 Models

Device Options

Otherthanthesecretpleasedonotchangeanyofthesesettings.ThesecretlistedisthedefaultandissetintheIP1500/2500/5000phonetomatchbydefault.Youcanchangeitifnecessary.



Administration

Youcanchangethedefaultusername&passwordoftheIP1500/2500/5000phoneifdesired.Thisisthesameusernameandpasswordforbothwebandtelnet.

Network – Dynamic IP DefaultSetting

Network – Static IP

Host – DNSHostName(Optional)

Domain – DNSDomainName(Optional)

Connection Type – DynamicorStatic.TheIP1500/2500/5000phonebydefaultissetforDynamic.

Address – StaticIPAddresstoassigntotheCBPhone

Mask – NetworkMaskdefiningthenetworkscope

Default Router – IPaddressofDefaultRouterifroutingtrafficoffthesubnet

DNS Primary, Secondary, Tertiary – IPAddressofDNSServersifdesiredbutnotnecessary

MAC Address – Required–MacAddressofIP1500/2500/5000PhonecanbefoundonrearofthephoneorbybrowsingtothephoneandlookingunderAdministration.

IP Address – IfyouhavetheUPDsoftwarepackage,afteryouprovisionthephoneinToolVoxyoucanrunUnitScanfromUPDAdministration.After2-3minutesyoucanProgramthePhonefromToolVox.



VLAN – EnableorDisableVLANSupport

ID - VLANIdentifier1-4094,0indicatesthisframedoesnotbelongtoanyVLAN

User Priority – Prioritylevel(PCP).Highernumberswilltagframeswilltagframeswithhigherpriority.

Registration Lifetime – inseconds.IfIP1500/2500/5000phoneislosingregistrationtoToolVoxbutisstillaccessibleonthenetworkconsiderloweringdownto60seconds.

Keep-Alive – KeepAlivemethodtouse.WhetherornottosendSIPKeepAlive.

STUN – EnableordisableSTUNforNATtraversal.SettheSTUNserverinadvancedsettings.

DTMF Threshold – LeveltorecognizeDTMFtones.Adjusttoresolveissueswithinadvertentin-callcommandactivation.

SIP – VLANpriorityforSIPtraffic.Defaultis0

RTP Audio - VLANpriorityforRTPaudiotraffic.Defaultis6

Account 2

Youcanconfigurea2ndAccountonthesamephone.



Codec – thisisthepreferredcodecsToolVoxwillcommunicatewithtotheIP5000phones.

Server – STUNserveraddressforNATtraversal.STUNmustbeenabledoneachaccountthatuses it.

Port – STUNServerportforNATtraversal.Thisisanadvancedsetting;itshouldtypicallybeleftatthedefaultof3478

Date & Time

Daylight Savings – enableordisable

Time Zone – Chooseyourtimezone

Enabled (NTP) – enableordisableNTPservice

Server Address – bydefaultyourIP1500/2500/5000willpullNTPfromToolVoxandyoucansettheToolVoxtopullNTPtimefromyourserverorfromanexternalsource.



Numbers

EnterinthePhoneNumbersyouwishtheIP1500/2500/5000phonetocalluponbuttonpress.

EnterNumberandDescriptionthenpressthegreen+icon.Youmayenterinmultiplenumberstohavethephonerolltomorenumbers.

Recordings

EnterinRecordingsanddescriptionsherethenpressthegreen+icontosubmitit.Youcanentermultipleentries.

Hardware Configuration

Button Count – ThenumberofbuttonsonthefaceoftheIP5000

Keypad – DoestheIP5000haveakeypadonthefaceplate

Public Address – Whetherthephonehasapublicaddresssystemconnectedtoit-onlyappliestotheIP5000model.

Public Address Gain – gainindBforthepublicaddressoutput-onlyappliestotheIP5000model.

A/C – specifyifavailableornot-onlyappliestotheIP5000model.

D/C – specifyifavailableornot-onlyappliestotheIP5000model.

PoE – specifyifavailableornot.

Aux Input 1 – specifyifavailableornot.-onlyappliestotheIP5000model.

Aux Output 1 – specifyifavailableornot.

Aux Output 2 – specifyifavailableornot.-onlyappliestotheIP5000model.



General Settings

Answer In – SpecifyhowmanyringstheIP1500/2500/5000shouldreceivebeforeansweringanincomingcall.

Public Address – RouteallincomingcallstothePublicAddressoutput-onlyappliestotheIP5000model.

Aux Output 1 – Enableauxiliaryoutput1whenincomingcallsareactive.

Aux Output 2 – Enableauxiliaryoutput2whenincomingcallsareactive.-onlyappliestotheIP5000model.

Location Recording – Specifyalocationrecordingthatwillbeplayedforin-callcommand1.

Action Scripts

ThisisthesectiontospecifytheactiontheIP5000phonedoesuponbuttonpress.HereisasampleofatypicalsetupforButton1.



TheaboveactiontakesplaceinorderfromtoptobuttonuponaButton1press.TheabovewillactivateAuxOutput1turningastrobelighton,thenplaceacall.Itwilltrycallingthefirstphonenumberfor60secondsifnoanswer.Themaxcalldurationissetat600seconds.DuringdialingthepersonattheCBphonewillhearstandardringback.UponthecallbeingansweredNormal2-wayconversationwillbesetup.InCallcommands(specifiedintheIP1500/2500/5000Manual)willbeallowedtobeinuse.Uponhang-upAuxOutput1willbedisabledstoppingthecombo/beaconlightfromstrobing.

TherearemanyoptionsyoucanuseintheActionsScriptarea.ActionsScriptsarecoveredinmoredetailintheIP1500/2500orIP5000AdministratorsGuides.

Diagnostic Settings

SNMP Traps – enabledbydefaulttosendtrapsforUPDmonitoringoftheIP5000phonebyToolVox

SNMP Server – bydefaulttheToolVoxIPAddress

SNMP Server Port – 62defaultport

12-24 Volt A/C or D/C - timeoutinsecondstonotifybeforeapowerfailureonthemainlineisre-ported-onlyappliestoIP5000model.

12 Volt D/C Battery – imeoutinsecondsbeforeapowerfailureonthebatterylineisreported-onlyappliestoIP5000model.

PoE Failure Timeout – timeoutinsecondsbeforeaPoEfailureisreported.

Microphone Test – frequencytotesttheIP1500/2500/5000Microphone

Microphone Test Hour – WhatHourtotestthemicrophoneat.OnlyappliestoDailyandWeekly.

Microphone Test Days – Whichdaysoftheweektotestthemicrophoneon.OnlyappliestoWeekly.

Microphone Test Max Beeps – Maximumnumberofbeepsusedforthemicrophonetest.

Microphone Test Volume - Microphonesettingforthemicrophonetest



In-Call Commands

ThisisusedtodisplaytheIn-CallCommandsinthePop-UpwindowontheAgentsComputerifus-ingtheEventManagementSoftware.

EnterinthemostaccurateLongandLatofthisspecificCBunit.ThiswillpopupaBingSatellitemapontheAgentsComputerifusingtheEventManagementSoftware.Thensetyourpinlocationfortheunit.Youcanalsoenteralocatinointhe“Find”box.





Unit Address Info

AddressInfothatwillappearinthePop-UpwindowontheAgentsComputerifusingtheEventMan-agementSoftware






IfyouhaveUPD(UnitProgrammingandDiagnostics)thenyoucanclick“ProgramExtension”tohaveToolVoxcommunicateouttotheUnitandprogramit,providedtheToolVoxisprovisioned.MakesureUPDadministrationisconfiguredandUnitscanhasbeenrunsincebuildingyourCodeBlueDevices.

YoumayalsonowcopytheCodeBlueextensionyoujustbuilttosavetime.YouwillhavetoenterinauniqueMacAddressandExtensionnumberaswell.IfyouhaveEMSyouwillalsoneedtochangethatinfo.



9 Configuring Business Phones

Business Phones is the area you would build non-Code Blue devices into. For example: SIP, IAX2, Analog (FXS) or Virtual Extension. Note that the screens when adding a Business Phone look different then when editing an existing one.

Add Extension

User Extension: NumberyouwishtogivethisPhonethatwillbedialed.

Display Name: TheCallerIDnameforcallsfromthisuserwillbesettothisname.Onlyenterthename,notthenumber.

CID Num Alias: (Optional) TheCIDNumbertouseforinternalcalls,ifdifferentfromtheextensionnumber.Thisisusedtoappearasadifferentuser.AcommonexampleisateamofsupportpeoplewhowouldliketheirinternalCallerIDtodisplaythegeneralsupportnumber(aringgrouporqueue).Therewillbenoeffectonexternalcalls.

SIP Alias: (Optional) Ifyouwanttosupportdirectsipdialingofusersinternallyorthroughanony-moussipcallsyoucansupplyafriendlynamethatcanbeusedinadditiontotheuser’sextensiontocallthem.

Extension Options

Outbound CID: (Optional) Overridesthecalleridwhendialingoutatrunk.AnysettingherewilloverridethecommonoutboundcalleridsetintheTrunksadmin.Theformatis“callername”<#######>.LeavethisfieldblanktodisabletheoutboundCallerIDfeatureforthisuser.

Ring Time: (Optional) Numberofsecondstoringtheextensionpriortogoingtovoicemail.DefaultwillusethevaluesetintheGeneralSetting.Ifnovoicemailisconfiguredthiswillbeignored.CallWaiting:(Optional)Allows/Disallowscallwaitingontheextension.

Call Screening: (Optional) CallScreeningrequiresexternalcallerstosaytheirname,whichwillbeplayedbacktotheuserandallowtheusertoacceptorrejectthecall.Screeningwithmemoryonly



verifiesacallerfortheircaller-idonce.Screeningwithoutmemoryalwaysrequiresacallertosaytheirname.EithermodewillalwaysannouncethecallerbasedonthelastintroductionsavedwiththatCallerID.Ifanyuseronthesystemusesthememoryoption,whenthatuseriscalled,thecallerwillberequiredtore-introducethemselvesandallusersonthesystemwillhavethatnewintroduc-tionassociatedwiththecaller’sCallerId.

Pinless Dialing: (Optional) enablingwillallowtheextensiontobypassanypincodesnormallyrequiredonoutboundcalls.

Emergency CID: (Optional) ThisCallerIDwillalwaysbesetwhendialingoutanOutboundRouteflaggedasEmergency.TheEmergencyCIDoverridesallotherCallerIDsettings.

Assigned DID/CID (Optional)

DID Description: (Optional) AdescriptionforthisDID,suchas“Sales”

Add Inbound DID: (Optional) ThisiswhereyouentertheDirectInwardDial(DID)you’dliketoreachthisextension.Theformatshouldbe:XXXXXXXXXXorXXXXorwhateverNumberyourouteintothisGatewayifyouwantittoringthisExtension.IfyoudonotenteravaluehereallcallstothatDIDwillroutetotheinboundroutesettingforthetrunkthecallcomesinon.PuttingavaluehereautomaticallycreatesanInboundRoute.ThiscanalsobedoneinInboundRoutes.

Add Inbound CID: (Optional) AddaCIDformorespecificDID+CIDrouting.ADIDmustbespeci-fiedintheaboveAddInboundDIDbox.Inadditiontostandarddialsequences,youcanalsoputPrivate,Blocked,Unknown,Restricted,AnonymousandUnavailableinordertocatchthesespecialcasesiftheprovidertransmitsthem.

Device Options - FXS Extension EntertheDAHDichannelthatthisextensionwilluse.GointoDAHDitoseeavailableFXSchannels.Donotduplicate.

Device Options -SIP Extension

Secret: alphanumericsecretpasswordyoucreate.ThismustmatchwhatyouprovisioninyourSIPDevice.Thisisthevalueusedtoauthenticatethedevicetothesystem.Thisshouldnotbethesameasthedevicenameorextensionnumber.

Device Options -Custom Extension

Thisdeviceusescustomtechnology.

dial

UtilizedtodialouttoaCustomExtensionwhichisnotdirectlyattachedtotheToolVoxsystem.AnexamplewouldbeanoffsitephoneattachedtoaGSMcellularunitoranalogline.



Language(Optional)

Thissettingwillcauseallmessagesandvoicemailpromptstoutilizethelanguageofchoiceifin-stalledonthesystem. Recording Options

Thiswillallowtherecordingofincomingandoutgoingcalls.Valuesare:Never,OnDemand,Al-ways.Always is Mandatory if using EMS ToolVox Software Tosaveyoursettingsclick:





10 Configuring Digital Receptionist (IVR)

Much can be customized and configured with the IVR options. If you have your Inbound Route set up to point to the IVR your creating you simply just need to make sure “Enable Direct Dial” is checked. No announcements needed, recordings or any other settings. You will then be able to call into the ToolVox and be able to enter in the Extension Number of the Business Phone or Code Blue device you’re trying to reach. If using Blue Alert and want to route inbound calls select Misc Destinations below.



Edit Menu

Change Name: ThisisthenameoftheIVR.

Announcement(Optional): Messagetobeplayedtothecaller.Toaddadditionalrecordingspleaseusethe“SystemRecordings”Menu

Timeout: Theamountoftime(inseconds)beforethe“t”optionifspecifiedisused.

Enable Directory(Optional): LetcallersintotheIVRdial#toaccessthedirectory

VM Return to IVR(Optional): IfcheckeduponexitingvoicemailacallerwillbereturnedtothisIVRiftheygotauser’svoicemail.

Directory Context(Optional): When#isselected,thisisthevoicemaildirectorycontextthatisused

Enable Direct Dial: LetcallersintotheIVRdialanextensiondirectly

Loop Before t-dest(Optional): Ifchecked,andthereisa“t”timeoutdestinationdefinedbelow,theIVRwillloopbacktothebeginningifnoinputisprovidedforthedesignatedloopcountspriortogo-ingtothetimeout“t”destination.

Timeout Message(Optional): Ifatimeoutoccursandamessageisselected,itwillbeplayedinplaceoftheannouncementmessagewhenloopingbacktothetopoftheIVR.Itwillnotbeplayedifthe“t”destinationisthenexttarget.

Loop Before i-dest(Optional): Ifchecked,andthereisan“i”(invalidextension)destinationdefinedbelow,theIVRwillplayinvalidoptionandthenloopbacktothebeginningforthedesignatedloopcountspriortogoingtotheinvalid“i”destination.

Invalid Message(Optional): Ifaninvalidextensionispressedandamessageisselecteditwillbeplayedinplaceoftheannouncementmessage.

Repeat Loops(Optional): Thenumberoftimesweshouldloopwheninvalidinputornoinputhas



beenenteredbeforegoingtothedefinedordefaultgenerated“i”or“t”options.Ifthe“I”or“t”boxesaredefinedtheabovecheckboxesmustbecheckedinordertoloop.

TheseDestinationsrepresentwhattodoifaparticularkeyispushedfromthecallingparty’skeypadonceintotheIVR.Ifyou’rejustusingtheDirectDialthennothingneedbeenteredinthissectionsinceyoucanjustenterintheextensionnumberandwillbetransferredimmediately.IfusingBlueAlertandaretryingtoreachaspecificMiscDestinationchooseithere.Thisisusefulifwantingaspecialpincodeusedtoaccesscertainpagegroups.








11 Configuring Inbound Routes

If you need to call into ToolVox or Phones connected to the ToolVox you will need Inbound Routes configured to control call Routing. Reasons for needing this can include Manual pro-gramming of Analog phones through an IVR, Adjusting In-Call phone settings on phones like speaker and mic gain, or allowing only specific DID and CLID combinations into the system for making Blue Alert Pages. There is a lot of flexibility.

Add Incoming Route

Description: Provideadescriptionnameforthisroutetoberefinedby

DID Number(Optional): DefinetheexpectedDIDNumberifyourtrunkpassesDIDonincomingcalls.LeaveblankifyouwanttoallowALLDID’saccess.Apatterncanalsobeentered(seeDialPatternsintheTrunkssectiontounderstandhowtocreateaDialPattern).

Caller ID Number(Optional): DefinetheCallerIDNumbertobematchedonincomingcalls.LeavethisfieldblanktomatchaspecificCLIDNumbertoallowitorleaveblanktoallowALL.YoucanalsoenterinaDialPattern(seetrunksforinstructions)orputinPrivate,Blocked,Unknown,Restricted,Anonymous,andUnavailabletomatchon,iftheTelcotransmitsthem.

CID Priority Route(Optional): ThiseffectsCIDONLYrouteswherenoDIDisspecified.IfcheckedcallswiththisCIDwillberoutedtothisroute,evenifthereisaroutetotheDIDthatwascalled.Nor-malbehaviorisfortheDIDroutetotakethecalls.IfthereisaspecificDID/CIDrouteforthisCID,thatroutewillstilltakethecallwhenthatDIDiscalled.



Options

Alert Info(Optional): Alert_INFOcanbeusedfordistinctiveringwithSIPdevices.

CID name prefix(Optional): YoucanoptionallyprefixtheCallerIDnamei.e.:IFyouprefixwith“Sales”acallfromJohnDoewoulddisplayas“Sales:JohnDoe”ontheextensionsthatring.

Music on Hold(Optional): SettheMoHclassthatwillbeusedforcallsthatcomeinonthisroute.Forexample,chooseatypeappropriateforroutescominginfromacountrywhichmayhavean-nouncementsintheirlanguage.

Signal RINGING(Optional): SomedevicesorprovidersrequireRINGINGtobesentbeforeAN-SWER.You’llnoticethishappeningifyoucansendcallsdirectlytoaphone,butifyousendittoanIVR,itwon’tconnectthecall.

Pause before Answer(Optional): Anoptionaldelaytowaitbeforeprocessingthisroute.Settingthisvaluewilldelaythechannelfromansweringthecall.Thismaybehandyifexternalfaxequip-mentorsecuritysystemsareinstalledinparallelandyouwouldlikethemtobeabletoseizetheline.

Privacy

Privacy Manager(Optional): IfnoCallerIDhasbeenreceived,PrivacyManagerwillaskthecallertoentertheirphonenumber.Ifauser/extensionhasCallScreeningenabled,theincomingcallerwillbepromptedtosaytheirnamewhenthecallreachestheuser/extension.

Language

Language(Optional): AllowsyoutosetthelanguageforthisDID

Fax Detect

Detect Faxes(Optional): ifsettoyesitTVwilltrytodetermineifthisisafaxcallandroutetotheselecteddestinationbelow.



CID Lookup Source

Source(Optional): SourcescanbeaddedinCallerNameLookupSourcesSection

Set Destination

(Required)UponMatchofDIDand/orCLID,selectintheToolVoxsystemwheretohavethecallroutedto.






12 Configuring System Recordings

RecordingscanbeusefulforpushingmessagestoyourPhones.Theycanbecreatedandcanbedonein2differentways.YoucanuseaphoneconnecteddirectlytoToolVoxorbymakingtherecordingoffsystemandloadingitintoToolVox.Notethattheformatmustbecompatiblethough;PCMEncoded,16Bitsat8MHz.

Add Recording

If using a phone to make the recording, enter in your extension number and hit “Go” Dial *77 on that phone and the system will prompt you on what to do.

After you hang up, name the recording and save it. It will appear on the right side of the screen and will be available throughout the ToolVox system for use.

If uploading a recording from your PC, browse to it and upload. Name the recording and save it. It will appear on the right side of the screen and will be available throughout the Tool-Vox system for use.



13 Configuring License Key Administration

Software Licensing

ThisscreenlistswhatYourToolVoxislicensedfor.IfyounoticeanydiscrepancieswithwhatyouorderedpleasenotifyCodeBlueTechnicalServices.MakenoteofyourSystemUUIDandToolVoxID.



14 Configuring Backup & Restore

YoucanconfigurearegularbackupscheduletoensurethatyouhaveacopyofyourToolVoxconfigurationsettingsandCDR’s.Youcanalsorestoreapreviousbackup,incaseofdatalossoramajorconfigurationfault.Backupsarestoredonthefilesystemat/var/lib/asterisk/backups.Youshouldmakeapointofmakinganofflinecopyofimportantbackups.



Add Backup Schedule

Basic Settings

CreatetheBackupSet

AtaminimumchecktheSystemConfigurationbox.IfyouutilizerecordingsinyourToolVoxthenalsochooseSystemRecordings.Theotheritemsarecompletelyoptional.

FTP & SSH Settings

IfyouhaveanFTPorSSHserveronyournetworkyoucanenterinit’ssettingsheretohaveitauto-maticallyFTPorSSHthebackupfileofftheToolVox.

Email Settings

IfemailisconfiguredonyourToolVoxserveryoucanchoosetohavethebackupsetemailedtothedesignatedaddress.

Run Schedule

Youcanhaveitrun“NOW”orsetupascheduleusingtheseoptions.

Manage/Restore Backups

WhenselectingManage/RestoreBackupsyoucanseeyourbackupsetandrestorefromit.Youwillhavetheoptionofonlyrestoringpartsofyourbackupsetorall.Clickonyourbackupsetwhileinthisscreen.Youcanclickon“DownloadFileSet”viayourwebbrowsertoyourcomputer.It’simportanttogetyourbackupofftheToolVoxincaseit’sneeded.



15 Unit Programming and Diagnostics (UPD) Confi guration and Operation

NOTE: The ToolVox® Media Gateway must be installed and confi gured before the UPD soft-ware can be confi gured. Onsite installation and remote support packages are available from your authorized Code Blue dealer.



UPD End User License Agreement

IMPORTANT – READ CAREFULLY. This is a legal agreement between you (either an individual or an entity), the end user, and Code Blue Cor-poration of Holland, Michigan. By opening the sealed CD-ROM packet(s) and installing or otherwise using the software, you agree to be bound by the terms of this End User License Agreement (EULA). If you do not agree to the terms of this Agreement, promptly return the disk package and accompanying items (including written materials, binders or other containers) to the place you obtained them.

1. GRANT OF LICENSE. This EULA permits you to use one copy of the Code Blue software product (“Software”) on any single computer, provided the software is in use on only one computer at any time. If you have multiple licenses for the software, then at any time you may have as many copies of the software in use as you have Licenses. The software is “in use” in a computer when it is loaded into the temporary memory (i.e., RAM) or is installed into the permanent memory (e.g. hard disk, CD-ROM or other storage device) of that computer. However, a copy installed on a network server for the sole purpose of distribution to other computers is not “in use.” If the anticipated number of users of the software will exceed the number of applicable Licenses, you must have a reasonable mechanism or process in place to assure that the number of persons using the software concurrently does not exceed the number of Licenses. If the software is permanently installed on the hard disk or other storage device of a computer (other than a network server), then the person authorized to use such computer also may use the software on a portable computer, laptop and home computer. If such person’s authorization to use such computer ceases for any reason (e.g. termination of employment), then such person’s authority to use the software on a portable computer, laptop and home computer shall cease.

2. COPYRIGHT. The software is owned by Code Blue Corporation or its suppliers and is protected by United States copyright laws and inter-national treaty provisions. Therefore, you must treat the software like any other copyrighted material (e.g., books or musical recordings), except that you may either: a) make one copy of the software solely for backup or archival purposes, or b) transfer the software to a single hard disk provided you keep the original solely for backup or archival purposes.

3. OTHER RESTRICTIONS. The License is your proof of license to exercise the rights granted herein and must be retained by you. You may not rent or lease the software, but you may transfer your rights under this License on a permanent basis provided that you transfer this License, the software and all accompanying written materials, you retain no copies and the recipient agrees to the terms of this License. You may not decompile or disassemble the software. If the software is an update, any transfer must include the update and all prior versions.

4. MULTIPLE MEDIA SOFTWARE. If the software package contains compact discs or other media, then you may use only the media appropri-ate for your single designated computer or network server. You may not use the other media on another computer or computer network, or loan, rent, lease or transfer them to another user except as part of a transfer or other use expressly permitted by this License.

5. LIMITED WARRANTY. Code Blue warrants that the software will perform substantially in accordance with the accompanying written materials and will be free from defects in materials and workmanship under normal use and service for a period of 90 days from the date of receipt. Any implied warranties on the software are limited to 90 days. Some states do not allow limitations on the duration of an implied warranty, so the above limitations may not apply to you. This limited warranty gives you specific legal rights. You may have others, which vary from state to state.

6. CUSTOMER REMEDIES. Code Blue’s entire liability and your exclusive remedy shall be, at Code Blue’s option, either (a) return of the price paid or (b) repair or replacement of the software that does not meet Code Blue’s Limited Warranty and that is returned to Code Blue with a copy of your receipt.This Limited Warranty is void if failure of the software has resulted from accident, abuse or misapplication. Any replacement software will be warranted for the remainder of the original warranty period or 30 days, whichever is longer. Neither these remedies, nor any product support services offered by Code Blue, are available for this USA version product outside the United States of America.

7. NO OTHER WARRANTIES. Code Blue disclaims all other warranties, either expressed or implied, including but not limited to implied warran-ties of merchantability and fitness for a particular purpose, with respect to the software, the accompanying written materials and any accompa-nying hardware.

8. NO LIABILITY FOR CONSEQUENTIAL DAMAGES. In no event shall Code Blue or its suppliers be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information or other pecuniary loss) arising out of the use of or inability to use the software, even if Code Blue has been advised of the possibility of such damages. Because some states do not allow the exclusion or limitations of consequential or incidental damages, the above limitations may not apply to you.

U. S. GOVERNMENT RESTRICTED RIGHTS. The software and documentation are provided with restricted rights. Use duplication, or disclo-sure by the government, is subject to restrictions as set fort in subparagraph (c) (I) (ii) of the Rights in Technical Data and Computer Software clause as DFARS 252.227-7013 or subparagraphs (c) (1), (2) and (3) of the Commercial Computer Software – Restricted Rights at 48 CFR 52.227-19, as applicable, and any amendments thereto. Contractor/manufacturer is Code Blue Corporation, 259 Hedcor Street, Holland, Michi-gan 49423 USA. This Agreement is governed by the laws of the State of Michigan.

For more information about Code Blue’s licensing policies, please call Code Blue at 800.205.7186.



UPD Activation

1. OpenyourwebbrowserandentertheIPaddressofyourToolVox. Example:http://172.1.100.652. Click TOOLVOX ADMINISTRATIONbutton(Ill.3A).

3. EnteryouradministratorUserNameandPassword(admin and codeblue)atpopupmenu(Ill.3B).

4. ClicktheOKbutton.

Illustration3B

Illustration 3A



5. AnewmenuToolVoxSystemStatuswillinitiate(Ill.3C).

6. UndertheSETUPtab,gotoCodeBlueSoftware>LicenseKeyAdministration.7. SoftwareLicensingscreenwillopen(Ill.3D).

8. EntertheLicenseKeyprovidedfromCodeBlue(onlyneededafteroriginalpurchase).9. Select SUBMITbuttontoapply.

Illustration 3C

Illustration 3D



UPD Page Navigation

NOTE: At the top of the web page you will see this message: To navigate this form, please do not use the browser Back, Forward or Reload buttons (Ill. 4A).

1. UtilizetheNEXT, BACK and FINISHbuttonslocatedatthetopandbottomofeach pagetonavigatethroughtheunitforms.2. Allofthefieldtitlesonthesepageshaveadashedlinebelowthem.Placethemousepointeroverthesefieldstoreceiveadescriptionofitsuse. Example:Description(orangebox)displaysuponuser’smouserolloveronMUSIC ON HOLDtext(Ill.4B).

3. EMS/UPDAdministration •UpdateUnitFailureAddress ○EnteremailaddressandclickUPDATE UNIT FAILURE EMAIL AD DRESS(Ill.4C).

Illustration4C

Illustration4A

Illustration4B



3. •IPUnitInformationMonitor ○Checktheboxesyouwishtomonitor. ○ClickonUPDATE IP MONITORING(Ill.4D).

•IPUnitAddressRange(onlyneededifusingSIPorIAX) ○EnterIP UNIT NETWORK/MESH. ○ClickUPDATE IP SUBNET(Ill.4E).

•MaxAnalogorPriTrunksforTestingAnalogPhones ○EnterMAX TRUNKS USED ○ClickUPDATE TRUNK AMOUNT (Ill.4F).

•UpdateAccessInformationforEMSSoftware ○EnterAuthorizationCode ○EnterAuthorizationIPSubnet/Mask ○ClickUPDATE INFORMATION(Ill.4G).

Illustration4D

Illustration4E

Illustration4F

Illustration4G



UPD - Recording Custom Messages

1. SomeCodeBluemodelshavethecapabilitytostoremessagesthatareplayedinvariousmannerswhentheunitisactivated.Youmaywanttorecordthesemessagespriortoconfig-uringyourunits.ToolVoxallowsyoutoselecttherecordingfromthedropdownmenuonthemodelconfigurationpage(Ill.5A).

2. Torecordyourmessage(s)fromtheSETUPtab,gotoInternalOptions&Configuration>SystemRecordings.3. TheSystemRecordingspagewillinitiate(Ill.5B).

4. Followtheinstructionsonthispage.Youcaneitheruseyourphonetorecordthe message(s)oruploadthemfromyourPC.

NOTE: Recordings uploaded from your PC must be PCM Encoded, 16 bits at 8 kHz.

Illustration 5A

Illustration5B



Adding a Code Blue Unit

1. FromtheSETUPtabgotoCodeBlueSoftware>CodeBlueDevices.2. FollowthesectionbelowthatpertainstoyourCodeBlueinstallationscenario: “7:CreatingaNewUnit” “8:CopyaUnit”

Creating a New Unit

1. FromtheSETUPtabgotoCode Blue Software > Code Blue Devices.2. Whencreatinganewunit,youwillbepromptedtoenterthefollowinginformationonthefirstpage(Ill.7A).

3. DeviceInformation• EXTENSION: Required field.Thisisthenumbergiventoeachunitforsystemidentification.AcarefullythoughtoutdialplanshouldbedevisedbeforeconfiguringyourToolVoxandUPDsystem.• CALLER ID DISPLAY NAME: Required field.Thisisthelocationornameyouwishtolabeltheunit.4. UnitInformation• MODEL: Required field.UPDwillconfigureallCodeBlueunittypes.Selectyourmodelhere.

NOTE: If OTHER is selected in the Model field, then no unit type will be used. Only the extension and EMS information will be configured. This is for EMS database entries of people or non-Code Blue devices to be managed by the Code Blue Emergency Communications System.

• DEVICE CONNECTION TYPE: Required field.SelectioninformsToolVoxunit’sconnectiontype:

○FXSAnalogExtension ○SIPExtension ○IAXExtension ○GSMOffsiteUnit

5. HittheNEXTbuttontocontinueunitconfigurationonthenextpage.

Illustration7A



6. Thefollowingaretherequiredparametersthatwillbepresented,basedontheDeviceTypepreviouslyselected:• FXSAnalogExtension ○CHANNEL: Required field.ThisistheFXSportnumbertheunitisconnectedto. Thisinformationmaybedifferentforeachsystem.RefertotheToolVoxdocu- mentationreceivedwiththesystemforalistofavailableFXSports(ill.7B)Do notchangetheotherfieldsunlessinstructedbyCodeBluetechnicalsupportper- sonnel.

• SIPExtension

NOTE: After the IP phone is connected to the network, click on 1) EMS/UPD ADMINIS- TRATION and 2) RUN IP UNIT SCAN below IP Unit Address Range before creating a unit. Run again after creating a unit.

• SIP SECRET: Required field.UsedforSIPphonesoranalogterminaladapters(seeIll.7C).• ThisisusedtoauthenticatetheSIPphonetotheToolVoxsystem.

NOTE: Strong password methodologies are recommended.

• IAXExtension

Illustration7B

Illustration7C



• IAX SECRET: Required field.UsedforIAXphonesoranalogterminaladapters(seeIll.7D).• OffSystemUnit

NOTE: After IP phone is connected to the network, click on 1) EMS/UPD ADMINITRA- TION and 2) RUN IP UNIT SCAN below IP Unit Address Range before creating a unit. Run again after creating a unit.

○UNIT PHONE NUMBER: Required field.ForGSM/Offsiteunits.Thisnumberwill frequentlyincludeanoutsidelineaccessnumber,suchas9,infrontofthephone number(Ill.7E).

7. ThecommandsatthispointwillbeconfiguredforyourparticularmodelofCodeBluephone.Eachcommandwillgiveyouanexplanationwhenyourollthemouseoverthecommand(ill.7F).

8. Onthelastpageofeachunityouwillbepresentedwiththefollowingcategories:• IN CALL COMMANDS:ThesecommandswillbeutilizedontheEMSAgentscreentocon-troltheunit(Ill.7G).

Illustration7D

Illustration7F

Illustration7G

Illustration7E

This device uses custom technology.Unit Phone Number



9. EMSUnitLocationInformationconsistsofselectingtheLatitude/Longitude onaMSBing™map(Ill.7H).

10. DetailedUnitLocationallowsyoutoselecttheuploadedmap(configured inEMS/UPDAdministration)andplaceaCodeBlueunitonthemapinthe desiredlocation(Ill.7I).

11. LocationDescription/Notesallowsyoutoenterspecificlocation/ unitinformationtobedisplayedontheEMSAgentscreen(Ill.7J).

12. DeviceCameraURL’sallowsfortheentriesoftwoIPcamerastreams, whichwillbedisplayedontheEMSAgentscreen(Ill.7K).

Illustration7I

Illustration7H

Illustration7J

Illustration7K



13. UnitAddressInfoallowsforthephysicaladdresstobedocumentedfor displayontheEMSAgentscreen(Ill.7L).

14. AfterconfiguringyourCodeBlueunit,clicktheFINISHbuttononthelast page.15. Click APPLY CONFIGURATION CHANGESbuttonatthetopofthescreen (Ill.7M).

16. Click CONTINUE WITH RELOADradiobuttontofinishthechanges(Ill.7N).17. CancelthechangesandcontinueeditingtheextensionbyselectingCAN CEL RELOAD AND GO BACK TO EDITING(Ill.7N).

18. TherearetwowaystosendtheconfigurationtotheCodeBlueunits:• SelecttheunitbyclickingontheextensionandclickPROGRAM EXTENSIONatthetopof thepage.• Click PROGRAM ALL UNITS.

Illustration7L

Illustration7M

Illustration7N



UPD - Copying a Unit

1. FromtheSETUPtab,gotoCode Blue Software > Code Blue Devices.2. Selectaunittocopy.3. Click COPY EXTENSIONbutton.4. Whencopyingaunityouwillbepromptedtoenterthefollowinginformation(Ill.8A):

• EXTENSION: Required field.Thisisthenumbergiventoeachunitforsystemidentification.AcarefullythoughtoutdialplanshouldbedevisedbeforeconfiguringyourToolVoxandUPDsystem.• CALLER ID DISPLAY NAME: Required field.Thisisthelocationornameyouwishtolabeltheunit.• CHANNEL: Required field.ThisistheFXSportnumbertheunitisconnectedto.Thisinforma-tionmaybedifferentforeachsystemandisconfiguredatthefactory.RefertotheToolVoxdocu-mentationreceivedwiththesystemforachannellist.• IAX SECRET: Required field.UsedforIAXphonesoranalogterminaladapters.

NOTE: Strong password methodologies are recommended.• UNIT PHONE NUMBER: Required field.ThisisthephonenumberofGSMorOffsiteunits.Thisnumberwillfrequentlyincludeanoutsidelineaccessnumber,suchas9,infrontofthephonenumber.5. Allothervalueswillremainthesameunlesschangedbytheuser.6. AfterconfiguringyourCodeBlueunit,clicktheFINISHbuttononthelastpage.7. Click APPLY CONFIGURATION CHANGESbuttonatthetopofthescreen(Ill.7M).8. Click CONTINUE WITH RELOADradiobuttontofinishthechanges(Ill.7N).9. CancelthechangesandcontinueeditingtheextensionbyselectingCANCEL RELOAD AND GO BACK TO EDITING(Ill.7N).10. TherearetwowaystosendtheconfigurationtoCodeBlueunits:• SelecttheunitbyclickingontheextensionandclickPROGRAM EXTENSIONatthetopofthepage.• Click PROGRAM ALL UNITS.

Illustration 8A



UPD Diagnostic Schedules

1. UPDDiagnosticscanrunasmanyschedulesasyouconfigure.Keepinmindthateachphoneistestedevery2seconds,beginningatthescheduledtime.Ifyouputthesamephonesinmultipletest-ingschedules,ensurethatthetimeperiodwillnotoverlaporyoumaycauseerroneousfaultreports.2. FromtheSETUPtabgotoCode Blue Software > Diagnostic Schedules(seeIll.9A)

3. ScheduleNewAnalogUnitTest• Selecttherangeyouwishtoincludeintheschedule.• Selecttheappropriatescheduleforyourneeds.• Click on Addtocreatetheschedule(Ill.9B).

4. ScheduleNewIPUnitTest• Selecttherangeyouwishtoincludeintheschedule.• Select TEST EVERY 1-59 MINUTES.• Click on Addtocreatetheschedule.

Illustration9A

Illustration9B



5. Repeatsteps7.3through7.4tocreateadditionalschedules.6. DiagnosticReports• Click on Code Blue Software > Diagnostic Reports (Ill.9C).

• Informationpertainingtounitprogrammingandlogsfromtestscheduleswillbedisplayed.ClickonthelogyouwishtoviewunderAvailableLogs.ClickontheShow/Hide Detailed Logstoviewdetailedinformationofthetesting/programmingoftheunits (ill.9D).

• SelectthecheckboxbesideeachlogandclickonDelete Checked Logstodeleteoldlogfiles.

Illustration9C

Illustration9D



UPD Test Options

IA500/IA3000/IA3100 and Non-Code Blue Analog Model Phones that respond with a tone when called

• RFAtone(presence)

IA4100 Analog Model Phone

• RFAtone(presence)• LowBattery• AC/DCPowerFault• PAS Fault

IP1500/2500/5000 Model Phones

• ActionScriptTriggered• AuxiliaryOutToggled(withspecificone,status)• CallIncoming(withNumber)• CallOutgoing(withNumber)• IncomingDTMFCommands• AccountRegistration(SIP/IAX2)• CallFailed(withreason)• AudioPlaybackfailure(withreasonandchannel)• ActionScriptFailure(witherror)• Buttonfailure(withbutton#)• PowerFailure(withpowersourcethatfailed)• PublicAddressFailure• HighTemperature• Mic/SpeakerFailure



16 Integrations

16.1 Milestone XProtect

ThissectioncontainsdetailedinstructionsregardingtheCodeBlueToolVox®/ Milestone XProtect softwareintegrationsopleasereaditinitsentiretybeforebeginninginstallation.

System Requirements

SystemrequirementsforMilestoneproductscanbefoundontheMilestonewebsite:

www.milestonesys.com/Support/Technical-Support/Product-System-Requirements

TheCodeBlueintegrationsoftwarewascreatedwiththeMIPSDK3.0andtestedwithversion2013R2and2016R2oftheXProtectsoftware.

TheintegrationcanbeusedwiththeseeditionsofXProtect:

• Corporate• Expert• Enterprise• Professional• Express

Contents

Theintegrationsoftwareconsistsoftwoplug-ins.Theplug-insaddfunctionalitytoXProtect.Eachplug-inconsistsofaDLLfileanda“plugin.def”files.ThesefilesmustbeplacedinXProtectinstalla-tionfolderstotakeeffect.Notethatthetwo“plugin.def”filesaredifferent.

• EventServerplugin○ CBEventServerPlugin.dll○ plugin.def

• ManagementClientplug-in○ CBManagementClientPlugin.dll○ plugin.def



Installation

Copy Plug-in Files into XProtect Directories

TheinstallationprocessinvolvescopyingtheintegrationsoftwarefilestotheXProtectinstallationdirectories.

Therearetwoplug-instoinstall:

• ManagementClientplug-in• EventServerplug-in

UsetheWindowspathsbelowasaguide.TheexamplesherearebasedondefaultinstallationsofXProtectversion2013R2and2016R2,CorporateEditionandEnterpriseEdition.TheXProtectinstal-lationlocationmaybedifferentforotherversionsorothereditionsofXProtect.Forotherversionsandeditions,contactMilestonesupportorrefertowww.milestonesys.com/support.

InstalltheEventServerplug-inonthecomputerrunningtheEventServer.

InstalltheManagementClientplug-inoncomputerswithManagementClientinstalled.

XProtect 2013 R2 and 2016 R2 Corporate Edition on Windows 7:

C:\ProgramFiles\Milestone\MIPPlugins\CBManagementClientPlugin\CBManagementClientPlugin.dllC:\ProgramFiles\Milestone\MIPPlugins\CBManagementClientPlugin\plugin.defC:\ProgramFiles\Milestone\MIPPlugins\CBEventServerPlugin\CBEventServerPlugin.dllC:\ProgramFiles\Milestone\MIPPlugins\CBEventServerPlugin\plugin.def

XProtect 2013 R2 and 2016 R2 Enterprise Edition on Windows 7:

C:\ProgramFiles(x86)\Milestone\MIPPlugins\CBManagementClientPlugin\CBManagementClient.dllC:\ProgramFiles(x86)\Milestone\MIPPlugins\CBManagementClientPlugin\plugin.defC:\ProgramFiles(x86)\Milestone\MIPPlugins\CBEventServerPlugin\CBEventServerPlugin.dllC:\ProgramFiles(x86)\Milestone\MIPPlugins\CBEventServerPlugin\plugin.def

Youwillneedtocreatethefolders“CBEventServerPlugin”and“CBManagementClientPlugin”.

Eachplug-inhasafilecalled“plugin.def”.Ifyoulosetrackofthe.deffiles,opentheminatexteditorsuchasNotepadtoconfirmwhichDLLtheygowith.



Verifying the Installation

OnceyouhaveconfiguredtelephonesandCodeBluedevicesinToolVox,verifythatXProtectisrecog-nizingtheplug-ins.

OpentheManagementClientapplication,whichiscalledtheManagementApplicationinsomeedi-tionsofXProtect.HereitwillbereferredtoasManagementClient.

LogintoManagementClient.

ED-10041-A

Onceloggedin,youwillseetheSiteNavigationTreeontheleftsideofthewindow:

ED-10042-A

User Guide

Code Blue ● ● ● ● ●

Onceyouhaveconfiguredtelephonesand CodeBluedevicesinToolVox,verifythatXProtectisrecognizingtheplug-ins.

OpentheManagementClientapplication,whichiscalledtheManagementApplicationinsomeeditionsofXProtect.HereitwillbereferredtoasManagementClient.

LogintoManagementClient.

ED-10041-A

Onceloggedin,youwillseetheSiteNavigationTree ontheleftsideofthewindow:

User Guide


ED-10042-A

Find the “MIP Plug-ins” node intheSystemStatusTree:

ED-10043-A



Findthe“MIPPlug-ins”nodeintheSystemStatusTree:

ED-10043-A

User Guide


ED-10042-A

Find the “MIP Plug-ins” node intheSystemStatusTree:

ED-10043-A



User Guide


IftheSystemConnectorplug-infileshavebeenplacedcorrectly,youshouldbeabletoexpandtheMIPPlug-insnodeandseeaCodeBluenodelistedunderit.

ED-10044-A

If you don’t see the Code Blue node listed in the MIP Plug-insnode,theplug-infilesareprobablynotbeingfoundbytheManagementClientapplication.Verifythattheplug-infilesareinthecorrectlocations.RefertotheInstallationchapterofthisdocumentforinstructionsoninstallingtheplug-ins.

IftheSystemConnectorpluginfileshavebeenplacedcorrectly,youshouldbeabletoexpandtheMIPPlug-insnodeandyouwillseeaCodeBluenodelistedunderit.

ED-10044-A

Ifyoudon’tseetheCodeBluenodelistedintheMIPPlug-insnode,thepluginfilesareprobablynotbeingfoundbytheManagementClientapplication.Verifythatthepluginfilesareinthecorrectloca-tions.RefertotheInstallationchapterofthisdocumentforinstructionsoninstallingtheplugins.

Setting up ToolVox

Telephones and Devices

TelephonesandCodeBluedevicesmustbeconfiguredinToolVoxMediaGatewaybeforeusingthesoftwareintegration.

RefertoSection8forstep-by-stepinstructionsonsettinguptelephonesandCodeBluedevicesinToolVox.

EMS Administration

ToolVoxAdministration->EMSAdministration->ToolVoxAPIsection

FillinthefollowingfieldslocatedatthebottomoftheEMSAdministrationpage: DestinationURL:WebURLpointingtoXProtectHostwithport. e.g.:http://192.168.1.50:3333



KeepaliveInterval–Timeinterval(inseconds)topingaheartbeattoXProtectEventserver host. e.g.:60

DataType–MustbesettoXML

Setting up XProtect

Adding ToolVox Media Gateway units to XProtect

ThissectionwillexplainhowtoaddaToolvoxMediaGatewaytotheXProtectsystem.ScreenshotsarefromtheCorporateEditionandmaylookdifferentifyouareusingadifferenteditionofXProtect.

OpenManagementClient(knownasManagementApplicationinsomeeditionsofXProtect).

ExpandtheMIPPlug-insnodeintheSiteNavigationtree.ExpandtheCodeBluenode.Therearetwonodesinside:ToolvoxandDevices.

ED-10045-A

User Guide


ThissectionwillexplainhowtoaddaToolVoxtotheXProtectsystem.ScreenshotsarefromtheCorporateEditionandmaylookdifferentifyouareusingadifferentedition ofXProtect.


ExpandtheMIPPlug-ins node intheSiteNavigationtree. ExpandtheCodeBluenode. Therearetwonodesinside:ToolVoxandDevices.

ED-10045-A

OpentheManagementClient(orManagementApplicationinsomeeditionsofXProtect).Right-clicktheToolVoxnode,then select “Add New...”.



OpentheManagementClient(orManagementApplicationinsomeeditionsofXProtect).Right-clicktheToolvoxnode,thenselect“AddNew...”.

ED-10046-A

TheAddToolvoxformwillappear.

ED-10047-A

User Guide


ThissectionwillexplainhowtoaddaToolVoxtotheXProtectsystem.ScreenshotsarefromtheCorporateEditionandmaylookdifferentifyouareusingadifferentedition ofXProtect.


ExpandtheMIPPlug-ins node intheSiteNavigationtree. ExpandtheCodeBluenode. Therearetwonodesinside:ToolVoxandDevices.

ED-10045-A

OpentheManagementClient(orManagementApplicationinsomeeditionsofXProtect).Right-clicktheToolVoxnode,then select “Add New...”.

User Guide


ED-10047-A

Filloutthefields:

Description – DescriptionofthisparticularToolVox.IfyouhavemultipleToolVoxunits, entersomethingthatwillhelpyouidentifywhichiswhich.

IP Address of server – TheIPAddressoftheToolVoxMediaGatewayisdisplayedinalertsandusedforcalleventtransmission.

Port that events will be sent to (port that Event Server will listen on) – SpecifytheportonthecomputerrunningMilestoneXProtectEventServerthat eventsshouldbesentto.Ifyouare notsurewhattoenter,contacttheServerAdministratorandrequestanavailableport.Youwill need a port that can be used in conjunction with the Event Server’s IP address youareusing.

IP Address that events will be broadcast to (IP address of Event Server) – EntertheIPaddressoftheMilestoneXProtect EventServer.IfyouarenotsurewhattheIPaddressoftheEventServeris,contacttheServerAdministratortorequestanIPaddressthatcanbeusedinconjunctionwiththeportenteredinthePort field.

PresstheOKbuttontosave.

ToolVox unitsthatyouhave configuredwillshowupinalist inaseparatepanel.Inthefollowingscreenshot,youcanseetherearetwoToolVoxunitsconfigured:ToolVox#1andToolVox#2.



Filloutthefields:

• Description–DescriptionofthisparticularToolvoxMediaGateway.IfyouhavemultipleTool-voxMediaGatewayunits,entersomethingthatwillhelpyouidentifywhichiswhich.• IP Address of server –TheIPAddressoftheToolvoxMediaGatewayisdisplayedinalerts,andisusedforcalleventtransmission.• Port that events will be sent to (port that Event Server will listen on) –SpecifytheportonthecomputerrunningMilestoneXProtectEventServertowhicheventsshouldbesentto.Ifyounotsurewhattoenter,contacttheServerAdministratorandrequestanavailableport.YouwillneedaportthatcanbeusedinconjunctionwiththeEventServer’sIPaddressyouareusing.• IP Address that events will be broadcast to (IP addres of Event Server) –EntertheIPaddressoftheMilestoneXProtectEventServer.IfyouarenotsurewhattheIPaddressoftheEventServeris,contacttheServerAdministratortorequestanIPaddressthatcanbeusedinconjunctionwiththeportenteredinthePortfield.

PresstheOKbuttontosave.

ToolVoxunitsthatyouhaveconfiguredshowupinalistinaseparatepanel.Inthefollowingscreen-shot,youcanseetherearetwoToolVoxunitsconfigured:ToolVox#1andToolVox#2.

ED-10048-A

User Guide


ED-10048-A



Adding Devices to XProtect

ThissectionwillexplainhowtoadddevicestotheXProtectsystem.ScreenshotsarefromtheCorpo-rateEditionandmaylookdifferentifyouareusingadifferentedition.

DevicescanbeanyphysicaldevicethatcommunicatesthroughaToolVoxMediaGateway.Examplesofdevicesinclude,butarenotlimitedto:

• TelephonethatsecuritypersonnelusetorespondtocallsfromCodeBlueproducts• CodeBluewallmountedunit• CodeBluepolemountedunit• CodeBluespeakerphone

OpentheManagementClient(orManagementApplicationinsomeeditionsofXProtect).Right-clicktheDevicesnodeintheSiteNavigationtree,andselect“AddNew...”.

ED-10049-A

User Guide


Thissectionwillexplain howtoadddevicestotheXProtectsystem.ScreenshotsarefromtheCorporateEditionandmaylookdifferentifyouareusingadifferentedition.

DevicescanbeanyphysicaldevicethatcommunicatesthroughaToolVox.Examplesofdevicesinclude,butare notlimitedto:

Telephones thatsecuritypersonnel usetorespondtocallsfromCodeBlueproducts

CodeBluewallmountedunits

CodeBluepolemountedunits

CodeBluespeakerphones

OpentheManagementClient(orManagementApplicationinsomeeditionsofXProtect).Right-click the Devices node in the Site Navigation tree, and select “Add New...”.

ED-10049-A



TheAddDeviceformwillappear.

ED-10050-A

FilloutthefieldsandpresstheOKbuttontosave:

• Description–Descriptionofthisparticulardevice.Youcanenterwhateveryoulike,butitisrecommendedthatyouentersomethingthatwillhelpyouidentifythisdevice,suchastheexten-sionoraverbaldescriptionofitsgeographiclocation.• Extension–Theextensionnumberofthisdevice.• Toolvox–ThisdropdownmenuwilllisttheToolvoxMediaGatewayunitsthathavebeenaddedinManagementClient.ToolvoxMediaGatewayunitsmustbeconfiguredfirstbeforetheywillbeinthislist.SelecttheToolvoxthatthisdevicewillcommunicatethrough.

User Guide


TheAddDeviceformwillappear.

ED-10050-A

FilloutthefieldsandpresstheOKbuttontosave:

Description – Descriptionofthisparticulardevice.Youcanenterwhateveryoulike,butitisrecommendedthatyouentersomethingthatwillhelpyouidentifythisdevice,suchastheextensionoraverbaldescriptionofitsgeographiclocation.

Extension – Theextensionnumberofthisdevice.

ToolVox – ThisdropdownmenuwilllisttheToolVoxunits thathavebeenaddedinManagementClient.ToolVox units mustbeconfiguredbeforetheywillbeinthislist.SelecttheToolVoxthatthisdevicewillcommunicatethrough.



Alistofdevicesthathavebeenconfiguredisshowninaseparatepanel.Inthefollowingscreenshot,youcanseethatmanydeviceshavebeenadded:

ED-10051-A

Testeverydevicebefore“goinglive”.

User Guide


Alistofdevicesthathavebeenconfiguredisshowninaseparatepanel.Inthefollowingscreenshot,youcanseethatmanydeviceshavebeenadded:

ED-10051-A

Test every device before “going live”.



Using the Integration Software

Introduction

WhenacallismadeusingaCodeBlueemergencycommunicationdevice,analarmwillbegeneratedinSmartClient.ThisdocumentationshowsexamplesofalarmsgeneratedbytheCodeBlueSystemConnector.ForgeneralguidanceusingtheSmartClientapplication,refertoMilestonedocumentation.

Making a Call

OpentheXProtectSmartClientandlogin.

ED-10052-A

YouwillseetheSmartClientscreen.

ED-10053-A

User Guide


WhenacallismadeusingaCodeBlueemergencycommunicationdevice,analarmwillbegeneratedinSmartClient.ThisdocumentationshowsexamplesofalarmsgeneratedbytheCodeBlueSystemConnector.Forgeneral guidanceusingtheSmartClientapplication, refertoMilestone documentation.

OpentheXProtectSmartClientandlogin.

ED-10052-A

YouwillseetheSmartClient screen.

User Guide


ED-10053-A

ClicktheAlarmManagertabtomonitoralarms.

ED-10054-A

TheAlarmManagerwillappear:




ED-10054-A


ED-10055-A

AlarmsgeneratedbyCodeBluedevicesappearas“New”alarms.ToviewtheNewalarms,clickthe“New”QuickFilter:

ED-10056-A

User Guide


ED-10053-A


ED-10054-A


User Guide


ED-10055-A

Alarms generated by Code Blue devices appear as “New” alarms. To view the New alarms, click the “New” Quick Filter:

ED-10056-A

Alarmsthataregeneratedduringacall showupinthelower-rightportionofthescreen:

User Guide


ED-10055-A

Alarms generated by Code Blue devices appear as “New” alarms. To view the New alarms, click the “New” Quick Filter:

ED-10056-A

Alarmsthataregeneratedduringacall showupinthelower-rightportionofthescreen:



Alarmsthataregeneratedduringacallshowupinthelower-rightportionofthescreen:

ED-10057-A

Themostimportantpartofanalarmisthemessage:

ED-10058-A

Youcanviewmoreinformationaboutthealarmbydouble-clickingit.Thiswillopenanewwindow.

User Guide


ED-10057-A


ED-10058-A

Youcanviewmoreinformationaboutthealarmbydouble-clickingit.Thiswillopen anewwindow.

User Guide


ED-10057-A


ED-10058-A

Youcanviewmoreinformationaboutthealarmbydouble-clickingit.Thiswillopen anewwindow.



Alarms Generated by the Integration Software

Overview

ThereareseveraltypesofalarmsthatcanbegeneratedbyCodeBluedevices.MostalarmswillbetriggeredwhensomeonemakesacallusingaCodeBluespeakerphonedevice.OtheralarmsalertsecuritypersonneltochangesinthestatusofaToolVoxunit.

Call Alarms

AcallinToolVoxcanbedividedintoseparateevents.

1. WhensomeonepressesabuttononaCodeBluedevicetoinitiateacall,thatisthe“dial”event.TheCodeBluedeviceisdialingatelephonethatsecuritypersonnelwillanswer.2. Whensecuritypersonnelansweratelephone,aconnectionisestablishedbetweentheCodeBluespeakerphonedeviceandthetelephone.Whenthishappens,ToolVoxbeginstransmittingaudio.Thisisthe“connect”event.3. Whenthetwopeopletalkingarefinished,thesecuritypersonnelhangsuptheirtelephone.ToolVoxrecognizesthisandstopstransmittingaudio.Thisisthe“hangup”event.The“hangup”eventoccursonceforthespeakerphonedevice,andonceforthetelephone,foratotaloftwohangupevents.4. The“disconnect”happensautomaticallyafterthehangupevents.Thespeakerphonedeviceandtelephonereturntotheiroriginalstate,beforethe“dial”event.

ThealarmsgeneratedinSmartClientcorrespondtotheseevents.Alarmsarenotdisplayedforthehangupevent.Soforatypicalcall,therearethreealarms:Dialing,Connected,andDisconnected.

ToolVox Status Alarms

AnalarmwillbegeneratedifcommunicationislostbetweentheXProtectEventServerandaToolVoxunitformorethan60seconds.Whencommunicationisrestored,anotheralarmwillappear.



Troubleshooting

Log Files

Overview

TheEventServerplug-inwritesmessagestoalogfilewhencertaineventshappen.ThelogfileisanormalpartofXProtectandisnotpartoftheCodeBlueintegrationsoftware.YoucanviewthelogfilestodiagnoseproblemsorverifythattheSystemConnectorisconfiguredproperly.

LogmessagesgeneratedbytheCodeBlueEventServerPluginaremarkedwiththetext“CBEvent-ServerPlugin”.

File Locations

InXProtect2013R2and2016R2,thelogfilesthattheCodeBlueEventServerPlugincanbefoundhere:

C:\ProgramData\Milestone\XProtectEventServer\logs\MIPLogs\

ForotherversionsofXProtectandotheroperatingsystems,contactMilestonesupport.

Sample log messages and what they mean

Theseexamplesareintendedtodemonstratetypicallogentries.Thisisnotacompletelistofpossiblelogentries.

CBEventServerPlugin Attempt to create socket failed for: CBTV16. (IP=192.168.10.21) (Port=8000)

First,weknowthislogentrywasgeneratedbytheCodeBlueEventServerPluginbecauseitstartswith“CBEventServerPlugin”.Therestofthemessageindicatesthatthepluginwasunabletoopenacommuni-cationchannelontheIPaddressandportspecified.CheckthattheIPaddressmatchesthatoftheEventServer,andthattheportisnotinusebyanotherprogramontheEventServer.IfyouneedtochangethesettingsofthatToolvox,youcanseeherethattheunitthatneedstobereconfiguredistheunitcalledCBTV16.

CBEventServerPlugin Configuration changed. 3 Toolvox Media Gateways are now configured.

AchangewasmadetoaToolvoxMediaGatewayunitinManagementClient/ManagementApplication.Maybeonewasadded,removed,oredited;thenumbertellsyouhowmanyToolvoxMediaGatewayunitsarenowpresentintheconfiguration.Youcancomparethistopastnumbers.ThismessagealsoappearswhentheEventServerfirststartsup.

ThefollowingexamplelogentriesjustrepeatwhattheCodeBlueSystemConnectoralarmsinSmartCli-entsay:

CBEventServerPlugin [300] is dialing [200]. (Toolvox IP=192.168.10.2)

CBEventServerPlugin [300] and [200] were connected. (Toolvox IP=192.168.10.3)

CBEventServerPlugin [300] hung up. (Toolvox IP=192.168.10.4)



CBEventServerPlugin Toolvox with IP Address=(192.168.10.5) is inactive.

CBEventServerPlugin Toolvox with IP Address=(192.168.10.5) came back on-line.

Symptoms and resolutions

Alarms are not being generated when calls are made

Datafromthedevice(s)isnotmakingittotheSmartClient.Therearemanypossiblecausesforalapseincommunication,includingbutnotlimitedtohardwareissues,networkconnectivityissues,andincorrectconfigurationsettings.Somepossibilities:

• IstheToolvoxMediaGatewayhardwareconfiguredandrunning?• HasitbeenaddedtotheManagementClient(calledManagementApplicationinsomeeditionsofXProtect)?• AretheconfigurationdetailsoftheToolvoxcorrect(IPaddress,port,etc.)?• IsthedeviceconnectedtotheToolvoxMediaGateway?• HasitbeenaddedtotheManagementClient(calledManagementApplicationinsomeeditionsofXProtect)?• Aretheconfigurationdetailsofthedevicecorrect(IPAddress,port,etc.)?• Checkthelogfilesforanyrelevantinformation.

“ToolVox offl ine” alarm shows up even though the ToolVox is running and connected to the network

• IsEventServerrunning?Ifnot,starttheservice.Ifitisalreadyrunning,tryrestartingit.• Checkthelogfilesforanyrelevantinformation.

Management Client fails to start with the following error: Could not load fi le or assembly ‘fi le:///C:\Program Files\Milestone\MIPPlugins\CBManagementClientPlugin\CBManage-mentClient Plugin.dll’ or one of its dependencies. Operation is not supported.

ThissometimesoccursonhostsrunningThe.NETFrameworkversions4andabove.ThereasonthisoccursisMicrosoftWindowshasflaggedtheCBManagementClientPlugin.dllasoriginatingfromaforeignhost(iefromaremotehost/theinternet).

Toresolvethiserror,tryopeningthefilepropertiesandclicking‘Unblock’:



16.2 Lenel OnGuard®

Technical Specifications

MinimumSystemHardwareRequirements

ThefollowingrequirementsapplytoOnGuard®2013.TheAccessoryAdd-OniscertifiedbyLeneltoworkwithOnGuard®2013.IfyoucanrunOnGuard®2013onyourhardware,youcanalsoruntheAccessoryAdd-On.

• PentiumIV1GHzProcessor• 2GBRAM• DVD-ROM• USBPort• 1024x768colordisplay• 6GBofavailablespace





Supported Operating Systems

Thefollowingproductshavebeenapprovedwiththelistedoperatingsystemsandsystem servicepacks.AllnewsystemsshippedfromLenelwillincludeatleasttheseservicepack versions.Operatingsystemrequirementsarenowenforced.Installationsattemptedonotheroperatingsystemswillnotrun.

Note:OnGuard®isa32-bitapplicationthatcanberunonsome64-bitsystems.64-bit systemsareonlysupportedaslistedinthissection.

Foranup-to-datelistoftestedoperatingsystemsandservicepacks,refertothecompatibilitychartsontheLenelWebsite: http://www.lenel.com/support/downloads/onguard#compatibility-charts.(YouwillneedyourLenellogintogainaccesstothissite.)

Windows XP Professional with Service Pack 3

• WindowsXPProfessionalSP332-bitisapprovedforOnGuard®serverandclientopera-tions.

• WindowsXPisnotsupportedforuseastheWebApplicationServer(LSApplicationServerservice)becausethenumberofclientconnectionstoIISislimitedinthisoperatingsystem.

• WindowsXPProfessionalisapprovedforuseasanyLenelDigitalVideoproducthost operatingsystem.

• WindowsXP64-bitisnotsupported.• WindowsXPSP3issupportedforcommunicationwithHIDEdgeDevices.• WindowsXPSP3willbecalledWindowsXP,fromthispointforward,intheOnGuard®2013

Release Notes.

Windows Server 2003 with Service Pack 2

• WindowsServer2003SP232-bitStandardandEnterpriseareapprovedforallOnGuard®serverandclientoperations.

• WindowsServer200364-bitisnotsupported.• WindowsServer2003SP2StandardandEnterpriseareapprovedforuseasanyLenel

DigitalVideoproducthostoperatingsystem,notincludingtheOnGuard®GO!product.• WindowsServer2003SP2StandardandEnterprisecanbeutilizedastheseparate

OnGuard®serverwithLenelDigitalVideoproducts.• WindowsServer2003StandardandEnterpriseSP2willbecalledWindowsServer2003,

fromthispointforward,intheOnGuard®2013ReleaseNotes.

Windows Server 2003 R2 with Service Pack 2

• WindowsServer2003R2SP232-bitStandardandEnterpriseareapprovedforall OnGuard®serverandclientoperations.

• WindowsServer2003R264-bitisnotsupported.• WindowsServer2003R2SP2StandardandEnterpriseareapprovedforuseasanyLenel

DigitalVideoproducthostoperatingsystem,notincludingtheOnGuard®GO!product.



• WindowsServer2003R2SP2StandardandEnterprisecanbeutilizedastheseparate OnGuard®serverwithLenelDigitalVideoproducts.

• WindowsServer2003R2SP2StandardissupportedforcommunicationwithHIDEdge Devices.

• WindowsServer2003StandardandEnterpriseR2SP2willbecalledWindowsServer2003R2,fromthispointforward,intheOnGuard®2013ReleaseNotes.

Windows Server 2008 with Service Pack 2

• WindowsServer2008StandardandEnterpriseSP232-bitand64-bitareapprovedfor OnGuard®serverandclientoperations.

• WindowsServer2008SP232-bitand64-bitisapprovedforuseasaLenelNVRproducthostoperatingsystem.Note:WindowsServer2008isnotapprovedforuseasanyLenelDigitalVideoproducthostoperatingsystemwhenusingOnGuard®201Oandprior.

• WindowsServer2008SP2isnotsupportedwithVisitorManagementFrontDeskApplica-tion.

• WindowsServer2008SP2StandardEdition32-bitissupportedforcommunicationwithHIDEdgeDevices.

• WindowsServer2008StandardandEnterpriseSP2willbecalledWindowsServer2008, fromthispointforward,intheOnGuard®2013ReleaseNotes.

Windows Server 2008 R2 with Service Pack 1

• WindowsServer2008StandardandEnterpriseR2SP164-bitareapprovedforall OnGuard®serverandclientoperations.

• WindowsServer2008StandardandEnterpriseR2SP1areapprovedforuseasaLenel NVRproducthostoperatingsystem.

• WindowsServer2008StandardandEnterpriseR2SP1canbeutilizedastheseparate OnGuard®serverwithLenelDigitalVideoproducts.Note:WindowsServer2008isnot approvedforuseasanyLenelDigitalVideoproducthostoperatingsystemwhenusing OnGuard®2010andprior.

• WindowsServer2008R2SP1Enterprise64-bitisnotsupportedforcommunicationwithHIDEdgeDevices.

• WindowsServer2008StandardandEnterpriseR2SP1willbecalledWindowsServer2008R2,fromthispointforward,intheOnGuard®2013ReleaseNotes.

Windows 7 with Service Pack 1

• Windows7SP1Enterprise,Professional,andUltimate32-bitand64-bitareapprovedforallOnGuard®serverandclientoperations.

• Windows7isnotrecommendedforuseastheWebApplicationServer(LSApplication Serverservice)becausethenumberofclientconnectionsto11Sislimitedinthisoperatingsystem.

• Windows7Enterprise32-bitissupportedforcommunicationwithHIDEdgeDevices.• Windows7Enterprise64-bitisnotsupportedforcommunicationwithHIDEdgeDevices.• LenelNVRissupportedonWindows7SP132-bitand64-bit.



• Windows7SP1Enterprise,Professional,andUltimatewillbecalledWindows7,fromthispointforward,intheOnGuard®2013ReleaseNotesSupportedOperatingSystems

Contents of Accessory Add-On

TheAccessoryAdd-OnforCodeBlueIntercomSupportisprovidedtothecustomerasaninstallationfile.ThiswilllikelybeprovidedinsideacompressedZIPfile.Thecustomerrunsthisfileasiftheywereinstallinganyotherprogram.Agraphicalinstallationprogramwillwalkthecustomerthroughtheinstallationprocess.

Formoreinformationontheinstallationprocess,seetheInstallationsectionofthisdocument.Lenelcallstheseinstallationfiles“AccessoryAdd-Ons”,sothisishowCodeBluewillrefertothemwhenworkingwithcustomers.ThefullnamefortheAccessoryAdd-OnthatCodeBluecreatedtointegratespeakerphonedeviceswithLenelOnGuard®is:6.6Accesso,yAdd-OnforCodeBlueIntercomSupport.msi

• “6.6”referstotheversionofOnGuard®thisAccessoryAdd-Onhasbeencertifiedwith.• The“.msi”extensiondesignatesthefileasa“MicrosoftInstaller”or“WindowsInstaller”.• Notethatthe“.msi”extensionmaynotbevisibleonacustomer’scomputer.Thisdepends

ontheirsettings,anditshouldnotbeassumedthattheycanseethatpartofthefilename.

Distribution of the Accessory Add-On to Customers

LenelwillprovidetheactualAccessoryAdd-Onfile(s)tocustomers.



Installation

Installing OnGuard®

ForassistanceinstallingtheOnGuard®securitysystem,contactLenel.ThissectiononlydocumentsinstallationoftheAccessoryAdd-On.

Prerequisites

• LenelOnGuard®20136.6mustbeinstalled.• ToolVox®hardwareshouldbeinstalledandoperational.TestingoftheAccessoryAdd-On

willnotbepossibleuntilToolVox®isoperational.• CodeBluespeakerphonehardwareshouldbeinstalledandoperationalforthesamerea-

son.

Step-by-Step Installation

TheAccessoryAdd-OnshouldbeinstalledwherevertheOnGuard®CommunicationServerisinstalled.Thismaybeonlyonecomputeratthecustomer’ssite.OnlyoneinstallationisneededbecausetheAccessoryAdd-OnaddsfunctionalitytotheCommunicationServer,whichthendistributesalarmstoallcomputersrunningtheOnGuard®AlarmMonitoringapplication.ThecustomershouldexecutetheAccessoryAdd-Oninstallerfilebydouble-clickingonit.Thiswillruntheinstalleron-screen.IftheinstallerfileisstillinaZIPfile,thecustomerwillneedtounzipitfirst.

Whentheinstallationwindowappears,pressthe“Install”buttontocontinue.



TheinstallerwillbeinstallingtheAccessoryAdd-Ontothecomputer.Awindowmayappearaskingifthecustomerwantstoallowtheinstallertomakechangestothecomputer.Click“Yes”toallow.





Next,theSQLServerLoginwindowwillappear.Inthe“Password”field,thecustomershouldenterthepasswordforthedatabasethatispartofOnGuard®.ThispasswordwaslikelysetbythecustomerwhenOnGuard®wasinstalled.CodeBluewillnotknowthispassword.

Onthenextscreen,press“Finish”tocompletetheinstallationprocess.



Verify that the Accessory Add-On has been installed

OpentheOnGuard®SystemAdministrationapplication.



OpentheIntercomsconfigurationscreenbyclickingontheyellowrectangleiconwithblackdots

Therearethreetabs:IntercomDevices,IntercomStationandIntercomFunctions.ClickonIntercomDevices.



OntheleftisalistofIntercomExchanges.ThisiswhereToolVox®unitswillbelisted.

Ontherightareconfigurablesettings.

Inthedropdownmenulabeled“Intercomexchangetype”,youshouldsee“CodeBlueIntercom”listed.Ifyouseeit,theAdd-Onwassuccessfullyinstalled.



Confi guration

ConfigurationofCodeBluehardwaremustbeperformedbeforeusingtheAccessoryAdd-On.Thischapterisdividedintofoursections:

• ConfiguringCodeBluespeakerphonedeviceswithinToolVox®• ConfiguringtelephoneswithinToolVox®• ConfiguringToolVox®unitswithinOnGuard®• ConfiguringspeakerphonesandtelephoneswithinOnGuard®

Confi guring ToolVox® units within OnGuard®

Overview

BeforeyoucanuseOnGuard®tomonitorcallsmadewithCodeBluedevices,youmustentertheToolVox®unitsintotheOnGuard®software.ThisisdoneintheOnGuard®SystemAdministrationapplication.

Step-by-StepInstructions

OpentheOnGuard®SystemAdministrationapplicationandlogin.ThecustomerwillhavetheusernameandpasswordtologintotheOnGuard®system.CodeBluewillnotknowthisinformation.

OpentheIntercomsconfigurationscreenbyclickingtheyellowrectangulariconwithblackdots.



Therearethreetabs:IntercomDevices,IntercomStationsandIntercomFunctions.Click“IntercomDevices”.





Ontherightsideofthescreen,youshouldseethreetabs:Location,ConnectionandNotes.Click“Location”.



Inthefieldlabeled‘Workstation,”enterthenameofthecomputerrunningLenelCommunicationServer.



Usingthedropdownmenulabeled“Intercomexchangetype”,select“CodeBlueIntercom”.



ClicktheConnectiontab.



Selectthe“LAN”radiobuttonandentertheIPaddressoftheToolVox®serveryouarecreatingapanelfor.

Inthefieldtotheright,entertheportnumberthatwasconfiguredintheToolVox®APL

RepeatforanyotherToolVox®units.



Confi guring speakerphones and telephones within OnGuard®

Overview

BeforecallscanbemonitoredinOnGuard®,devicesandtelephonesmustbeadded.ThisisdoneusingtheSystemAdministrationapplication.

TheSystemAdministrationapplicationreferstobothCodeBluespeakerphonedevicesandtelephonesas“stations”.Ifacustomerasksabout“stations”,itisanyhardwaredevicethatusersinteractwith.Inthiscase,“users”includesboththepeoplewhopressthespeakerphonebuttonsandthesecuritypersonnelwhoanswerthephone.Allofthese“stations”mustbeenteredinthe“IntercomStations”form.

Step-by-StepInstructions

OpentheOnGuard®SystemAdministrationapplicationandlogin.ThecustomerwillhavetheusernameandpasswordtologintotheOnGuard®system.CodeBluewillnotknowthisinformation.

OpentheIntercomsscreenbyclickingtheyellowrectangulariconwithblackdots.



Thisscreenwillappear:



Therearethreetabs:IntercomDevices,IntercomStationsandIntercomFunctions.Click“IntercomStations”.



Enteradescriptivenameforthedevice/telephoneintothe“Intercomstationname”textfield.Whateveryouenterherewillshowupinalarms.



Usethe“Intercomexchange”dropdownmenutoselecttheToolVox®unitthatthisspeakerphoneortelephonewillconnectthrough.ToolVox®unitswillnotshowupinthedropdownmenuuntiltheyhavebeenenteredinthe“IntercomDevices”tab.



Underthe“Intercomexchange”dropdownmenu,thereisafieldlabeled“Stationnumber’’.Entertheextensionnumberofthedevice/telephone.

Repeatfortherestofthespeakerphonedevicesandtelephones.



Monitoring Alarms in OnGuard®

Introduction

ThecentralpurposeoftheAccessoryAdd-OnforCodeBlueIntercomSupportistonotifysecuritypersonnelwhensomeoneisusingaCodeBluespeakerphonedevice.ThissectiondescribeshowtointerpretthealarmsthataregeneratedbytheAccessoryAdd-On.ThecustomershouldalreadyhaveanunderstandingofhowtousetheOnGuard®AlarmMonitoringapplication.

Anatomy of a Call

Acall,inthecontextofToolVox®,involvestwodevices,typicallyoneCodeBluespeakerphoneandonetelephone.

ToolVox®definesfourphasestoeachcall:

• DIAL-Adeviceisdialinganotherdevice• LINK-Twodevicesareconnectedandaudioisbeingtransmittedbetweenthem• UNLINK-Twodevicesaredisconnectedandaudiostopstransmitting• HANGUP-Adeviceishungupandisnotabletobelinkedorstartdialing

AnalarmissenttotheAlarmMonitoringapplicationforeachofthefourcallphases.SincetheHANGUPeventhappensforbothdevices,fivealarmsaregeneratedwhensomeoneinitiatesacallwithaCodeBluespeakerphonedevice:

• DIAL-Speakerphoneisdialingtelephone• LINK-Speakerphoneislinkedtotelephone• UNLINK-Speakerphoneandtelephoneareunlinked• HANGUP-Speakerphoneishungup(happensautomatically)• HANGUP-Telephonehangsup(hungupbyuser)

Brief Overview of the Alarm Monitoring Interface

ThissectiononlydescribesthepartsoftheGraphicalUserInterface(GUI)thatarerelevanttothisAccessoryAdd-On.



ThisiswhatthemaininterfaceoftheOnGuard®AlarmMonitoringapplicationlookslike:

Youcanseethatinthisscreenshot,twowindowsareopen,oneintheupperhalfandtheotherinthelower.TheSystemStatusTreeisopeninthelowerhalf.ItlistsallToolVox®units,CodeBluedevicesandtelephones.TheseappearoncetheyareconfiguredintheSystemAdministrationapplication.YoumayneedtorestarttheAlarmMonitoringapplicationforconfigurationchangestoappear.



YoucanopentheSystemStatusTreebyclickingthisiconinthetopmenu:

TheSystemStatusTreelistsToolVox®units,speakerphonedevicesandtelephones.DeviceswillonlyshowupiftheyhavebeenconfiguredintheSystemAdministrationapplication.



TheMainAlarmMonitorlistsalarms.



List of Possible Alarms

ThereareseveralalarmsthatcanbegeneratedbyToolVox®.Thisisabriefdescriptionofeach:

• Dialing-Aspeakerphonedevicehasbeenactivatedandisdialingatelephone.• Connected-Aspeakerphonehasdialedatelephoneandthetwoarenowconnected.• Disconnected-Happenswhenonedevicehangsup.Audioisnolongerbeingtransmitted

betweenthedevices.• Hangup-Aspeakerphonewasautomaticallyhunguporatelephonewashungup.• ToolVox®offline-CommunicationappearstohaveceasedfromtheToolVox®unit.• ToolVox®backonline-TheToolVox®unitappearstobebackonlineafterhavingbeenof-

fline.



Troubleshooting

Calls are made, but no events show up in Alarm Monitoring

VerifythatdevicesandtelephoneshavebeenaddedandconfiguredproperlyinbothToolVox®and OnGuard®SystemAdministration.

DeviceextensionsenteredinSystemAdministrationmustmatchextensionsconfiguredinToolVox®. VerifythatallIPAddressesareaccurate.

ToolVox®maybedown.Itmaytakeupto65secondsforthepaneltobemarkedasoffline.

Red X appears over panel icon in Alarm Monitoring

ToolVox®maybedown.Ifitwasrecentlyturnedon,itmaytakeupto65secondsforcommunicationtoberestored.Whencommunicationisrestored,theredXwilldisappear.

Device/Panel/Intercom Exchange/Intercom Station icon doesn’t show up in Alarm Monitoring

VerifythatthemissingitemhasbeenaddedtoOnGuard®SystemAdministration. LogoutofAlarmMonitoring,thenlogbackin.

IftheitemexistsinSystemAdministrationbutcontinuestonotshowupinAlarmMonitoring,youmayneedtocontactLenel.

The “Device” column in Alarm Monitoring/Main Alarm Monitor says <Unknown> or is not showing the device name.

DevicenamesarepulledfromOnGuard®SystemAdministration.MakesurethatthedeviceshavebeenaddedtoSystemAdministration.

TheStationNumberconfiguredinSystemAdministrationmustmatchtheextensionnumberconfiguredinToolVox®.Iftheextensionsdonotmatch,thedevicenamewillnotshowupinAlarmMonitoring.

Unable to place call, call intercom or cancel call

Right-clickingonapanelordeviceinAlarmMonitoringwillbringupamenuwhichmayincludeoptions,suchas:

• Place Call• CancelIntercom• Cancel Call

ThesecurrentlydonothinganditisnotpossibletoplaceorcancelcallsusingtheGraphicalUserInterface(GUI).Thisfunctionalitymaybeaddedinfutureversions.



16.3 Cisco Call Manager

Configure the Cisco Unified Call Manager

• OpenabrowserwindowandtypeintheIPaddressofyourCiscoUnifiedCallManager (CUCM).• LogontoCiscoUnifiedCMAdministrationwiththeproperUsernameandPasswordpro videdbyyourCUCMAdministrator.• Executethefollowingconfiguration:(Parametersnotmentionedshouldbeleftuntouchedto theirdefaultsetting)

Configure a Date/Time Group

System->Date/TimeGroup->AddNew

• GroupName:CodeBlue• TimeZone:Chooseyourtimezone• Separator:-(dash)• DateFormat:Chooseyourdateformat• TimeFormat.Chooseyourtimeformat• PressSave• Press Reset/Restart

Configure a Region

System->Region->AddNew

• Name:CodeBlue• PressSave• Press Reset/Restart



Configure a SIP Trunk Security Profile

System->Security->SIPTrunkSecurityProfile->AddNew

• Name:ToolVox• Description:ToolVoxSIPSecureProfile• DeviceSecurityMode:NonSecure• IncomingTransportType:TCP+UDP• OutgoingTransportType:UDP• Enable:

○ AcceptPresenceSubscription ○ AcceptOut-of-DialogREFER ○ AcceptUnsolicitedNotification ○ AcceptReplacesHeader

• PressSave• Press Reset/Restart

Configure a Route Partition

CallRouting->ClassofControl->Partition->AddNew

• Name:AllLines• PressSave• Press Reset/Restart

Configure a Calling Search Space

CallRouting->ClassofControl->CallingSearchSpace->AddNew

• Name:DefaultUser• Description:DefaultUser• SelectAllLinesinthe”AvailablePartitions”windowandusethe”MoveDown”arrowtomove ittothe”SelectedPartitions”window.• PressSave



Configure a Media Resource Group

MediaResources->MediaResourceGroup->AddNew

• Name:ToolVox• Description:ToolVox_MRG• SelectMTP_2inthe”AvailableMediaResources”windowandusethe”MoveDown”arrow tomoveittothe”SelectedMediaResources”window.• PressSave• Press Reset/Restart

Configure a Media Resource Group List

MediaResources->MediaResourceGroupList->AddNew

• Name:ToolVox_MRGL• SelectToolVox_MRGinthe”AvailableMediaResourceGroups”windowandusethe”Move Down”arrowtomoveittothe”SelectedMediaResourceGroups”window.• PressSave• Press Reset/Restart

Configure a Device Pool

System->DevicePool->AddNew

• DevicePoolName:CodeBlue• CiscoUnifiedCommunicationsManagerGroup:Default• CallingSearchSpaceforAuto-registration:DefaultUser• RevertedCallFocusPriority:Default• Date/TimeGroup:CodeBlue• Region:CodeBlue• MediaResourceGroupList:ToolVox_MRGL• Location:Hub_None• SRSTReference:UseDefaultGateway• PressSave• Press Reset/Restart



Configure a Media Termination Point

MediaResources->MediaTerminationPoint->Find,thenselect:MTP_2

• SetDevicePool:CodeBlue• PressSave• Press Reset/Restart

Configure a SIP Trunk

Device->Trunk->AddNew

• TrunkType:SIPTrunk• DeviceProtocol:SIP• PressNext• DeviceName:ToolVox• Description:ToolVox• DevicePool:CodeBlue• MediaResourceGroupList:ToolVox_MRGL• Enable:‘MediaTerminationPointRequired’• CallingSearchSpace:DefaultUser• DestinationAdress:YourToolVoxIPaddress• SIPTrunkSecurityProfile:ToolVox• SIPProfile:StandardSIPProfile• PressSave• Press Reset/Restart

Configure a Route Group

CallRouting->Route/Hunt->RouteGroup->AddNew

• Name:ToolVox_RG• SelectToolVoxfrom”AvailableDevices”andpress”AddtoRouteGroup”• PressSave



Configure a Route List

CallRouting->Route/Hunt->RouteList->AddNew

• Name:ToolVox_RL• CiscoUnifiedCommunicationsManagerGroup:Default• PressSave• PressAddRouteGroup• RouteGroup:ToolVox_RG[NON-QSIG]• PressSave• PressSave• Press Reset/Restart

Configure a Route Pattern

CallRouting->Route/Hunt->RoutePattern->AddNew

• RoutePattern:2xxx(Thisallowscallstoallnumbersbeginningwith2intheToolVox)• RoutePartition:AllLines• Description:ToolVox_RP• Gateway/RouteList:ToolVox_RL• PressSave

For ToolVox SIP Trunk Configuration, see Chapter 6 - Configuring Trunks.



17 IP Audio Interface Wiring Diagram

Productwiringdiagramshownreasonablyrepresentscurrentofferingandisintendedtoassistincomponentidentificationandservice.Earlierproductproductionmayhavedifferentcomponentsandwiringconnections.ReferencethemodelandserialnumberfromtheunitIDtagandcontact

manufacturertoconfirmreplacementpartversionandavailability.

TipR

ing

RingTip

Ring

Tip

Ring

Tip

SPK

Mic

/LE

D

Pw

r

PA

S

PA

SC

ontro

lLAN

2

LAN

1

WA

NP

oE

Aux

outp

ut1&

2A

uxin

1

Bat

t

6"C

at5e

Phoenix Bulkhead PanelMount Top View

Phoenix Bulkhead PanelFront face

Phoenix Plug Front Facing

Phoenix Plug Top View

PoE LAN OnlyEIA/TIA-568B

Updated: 2/13/2012Production Designcovering internal Wiring

21 3 4 5 6 7 8

21 3 4 5 6 7 8



18 Lightning Protection

Installation procedure for the recommended ToolVox Lightning Protection

ITW SurgeGate CO/25 Module

SurgeGateCO/25modulesareusedtoprotecttheToolVoxAnalogFXO/FXStelephonycard(s)andAdtran624units.

Installation

1. InstalltheVelcroclampsprovidedwiththeprotector.

2. SecurelymounttheSurgeGatebetweenthe66blockandtheToolVoxMedia Gateway.3. ConnectanAmphenolcablefromtheToolVoxtothe“Line”sideoftheSurgeGate.

*Do not connect the SurgeGate directly to the back of the ToolVox. This will not provide adequate protection and will void the warranty.4. ConnectanAmphenolcablefromthe66blocktothe“Equipmentsideofthe SurgeGate.ThiswillbethesidetheCodeBluedevices.

5. SecurebothAmphenolendswiththeVelcromountedontheclampsofthe SurgeGate.

66 Block/Code Blue

devicesToolVox® Media Gateway

25pr Amphenol Cable

LINE

EQUIPMENT

SurgeGate CO/25

25pr Amphenol Cable



Important Safety Points

ITWLinxsurgeprotectorsandtheconnectedequipmentmustbeindoorsinadrylocationandinthesamebuilding.Althoughyourprotectorisdurable,itsinternalcomponentsarenotisolatedfromtheenvironment.Donotinstallanyproductnearanyheat-emittingappliances,suchasaradiatororheatregister.Donotinstallthisproductwhereexcessivemoistureispresent.

*ATTENTION*

To ensure proper protection, the SurgeGate module MUST BE CONNECTED TO EARTH GROUND. There cannot be any exceptions. A minimum #14 green insulated copper wire, with a ring terminal at each end, should be used. Route the wire as directly as possible. Do not make any other connections to the ground terminal of the module.



T1 Crossover Cable Wiring

ForcustomersutilizinganAdTran624or850withToolVox®,aT1pinoutisrequiredtoestablishaT1connectionfromtheToolVox totheAdTran.AcrossovercablemustbeusedortheT1willnotsynchwiththeoppositeend.

Tocreateacrossovercable,usethefollowingpinout:

T1 crossover cable T568B

12345678

12345678

RJ-45 Plug

Pin 1

Oncecomplete,connectyourT1crossovercablefromtheT1portontheT1cardonthebackofyourToolVoxtotheNTWKportontheAdTran624or850.

Ifyouhaveanyquestions,pleasecallCodeBlueCustomerServiceat800-205-7186,[email protected].



19 ToolVox DHCP Server Configuration

Considerations

ThisDHCPconfigurationisbasicandwillonlyworkonthesamesubnettheToolVoxison.Advancedconfigurationsarepossible,butadvancednetworkadministrationisrequired.

ThisprocedurewillclearoutexistingToolVoxDHCPserverconfiguration.

Do not start DHCP servers on networks that already have them. If done improperly, you may have consequences on your ethernet network with devices requesting DHCP.

Prerequisites

Youwillneedthefollowinginformation:

• ToolVoxIPaddress• Networkaddress(e.g.172.1.100.0)• Subnetmask(e.g.255.255.255.0)• Defaultrouterorgatewayaddress(e.g.172.1.100.1)• DNSserveraddresses,ifany

Procedure

1. SignintotheToolVoxserver’sWebmininterface,e.g.https://IPofToolVox:2000/2. UserName=cbadmin;Password=codeblue3. NavigatetoServers>DHCPServer.4. ClicktheConfigfilebutton.5. ClearoutthecontentsoftheEditwindowandreplaceitwiththefollowing,usingtheToolVox server’sIPaddressforthevalueofthetftp-server-nameoption(thisisrequiredforan IP5000topullitsconfigurationfromUPDonboot): ddns-update-style ad-hoc; option tftp-server-name “IPofToolVox”;

6. ClickSave.7. IfyouwishtohaveDHCPconfigureDNSservers,clickEditClientOptions. a.DNSservers:clicktheradiobuttonnexttothetextbox,andentertheDNS serveraddress(es)separatedbyspaces,e.g.DNSIP1 DNSIP28. ClickSave.9. UnderSubnetsandSharedNetworks,addanewsubnetforthenetworktheToolVoxserver willbeservingDHCPfor: a.Subnetdescription:afree-formdescriptivenameforthesubnet b.Networkaddress:thenetworkaddressofthesubnet,e.g.172.1.100.0 c.Netmask:subnetmaskforthesubnet,e.g.255.255.255.0 d.Addressranges:IPaddressestheDHCPserverhastheauthoritytohandout



10. Click Create.11. ClickonyournewlycreatedsubnetandclickEditClientOptionstoedittheoptionsthatwill besenttothissubnet: a.Defaultrouters,ifany(requiredonlyifthedeviceswillbecommunicatingwith othersubnets):clicktheradiobuttonnexttothetextboxandenterthedefault router,e.g.172.1.100.1 b.Subnetmask:clicktheradiobuttonnexttothetextboxandenterthesubnet mask,e.g.255.255.255.012. ClickSave.13. NavigatetoSystem>BootupandShutdown.14.Clickdhcpd.15. ForStartatboottime?,clickYes.16. ClickSave.17.Clickdhcpdagain.18. ClickStartNow.



20 Email - Postfix Setup for ToolVox X3

Logging into Postfix

10. SignintotheToolVoxserver’sWebmininterface,e.g.https://IPofToolVox:2000/11. UserName=cbadmin;Password=codeblue12. NavigatetoServers>Postfix

General Options

TheGeneral OptionspageconfiguresanumberofoptionsregardingthegeneralbehaviorofPostfix.Specifically,mostoftheconfigurationoptionsthatimpactallusersandallmessagesareconfiguredhere.Postfix,keepingwithitsphilosophyofsimplicity,usuallyrequiresonlyafewconfigurationfilechangestogetamailserverrunningefficientlyandsecurely.

TheGeneral Optionspageisdividedintotwoparts.TheuppersectionislabeledMost Useful General OptionsandthelowerOther General Options.Inmanystandardinstallations,itmaybepossibletostartaPostfixinstallationwithjusttheconfigurationofoneormoreofthethreedirectivesintheuppersection.Unlessotherwisestated,alloftheoptionsonthispagecorrespondtodirectivesinthemain.cffileinthePostfixconfigurationdirectory.

Most Useful General Options

Insomeinstallations,thesearetheonlythreeoptionsthatneedtobealteredtogetPostfixrunningforbothsendingandreceivingemail.

Send outgoing mail via

Thisoptionconfigureswhetheroutgoingmailshouldbedelivereddirectlytotherecipient’smailserverorifaparentmailgatewayshouldbeusedasanintermediary.Iftheserverisbehindafirewall,behindanetworkaddresstranslatingrouter/gateway,orsomethingsimilar,itmaybenecessarytouseanintermediaryservertoachievereliableservice.ManymailserversontheInternetwillnotacceptmailfromaserverthatdoesnothaveaworkingDNSentryandroutableIPaddresstohelppreventspamfromforgedaddresses.Also,localnetworkusepolicymayrequiretheuseofanintermediaryforlogging,virusscanningorotherpurposesthatrequireaggregationofoutgoingmailtrafficontoacentralserver.Thisoptioncorrespondstotherelayhostdirectiveanddefaultstosendingmaildirectly.

What domain to use in outbound mail

Hereyoumayspecifythedomainorhostnametoidentifythesourceonoutgoingmail.Postfixdefaultstothehostnameoftheserver,butyoulikelywillwantittoidentifymailascomingfromyourdomainnameinstead.Ifyourmailserverwillbeacceptingmailforalargenumberofusersunderasingledomainname,youwilllikelyconfigureadomainnamehereandcreateadomain-widealiasdatabasetomapusernamestotheirrespectivelocalmailservers.ThisoptioncorrelatestothemyoriginPostfixdirective.

What domain to receive mail for

Thisoptionacceptsalistofdomainsandaddressestoreceivemailasitsfinaldestination.Inotherwords,whenmailreachestheserverdestinedforaddressesinthisfield,itwilldeliverthemailtoa



localuserratherthanforwardittoanothermailserver.Bydefault,thisisallconfiguredaddressesonthemachine,aswellaslocalhostwithinthelocaldomain.Youmayspecifyanynumberofdomainsorhostnamesseparatedbycommas,oryoumayprovideafullpathtoafilecontainingsimilarentries.Thevariables$myhostnameand$mydomainmaybeusedtorepresentthoseconceptstoPostfixautomatically.TheabilityofPostfixtousesuchvariablesthroughoutitsconfigurationfilesmakesiteasiertomaintainanumberofPostfixserverswithsimilarconfigurations.Thisoptioncorrelatestothemydestinationdirective.

What trouble to report to the postmaster

Postfixprovidestheabilitytoselectwhattypesoferrormessageswillbemailedtothedesignatedpostmasterofthemailserver.Assumingyouhavesetupapostmasteraliasthatdirectsmailtoarealperson,Postfixwillsendreportsofalltroubledesignatedhere.Theavailableclassesare:

bounce

Whenthisoptionisselected,wheneveramessageisundeliverable,abouncemessage(calledasinglebouncemessagewillbesenttothemessagesenderandthelocalpostmaster.Forthesakeofprivacy,onlytheheaderswillbesenttothepostmaster.Ifthefirstbounceisreturnedasundeliverable,adoublebouncemessagewillbesenttothepostmasterwiththeentirecontentsofthefirstsinglebouncemessage.

2bounce

Causesdoublebouncemessagestobesenttothepostmaster.

delay

Ifthedeliveryofamessageisdelayed,thepostmasterwillreceiveanotice,alongwiththeheadersofthedelayedmessage.

policy

Notifiesthepostmasterofmessagesthatwererejectedduetoanunsolicitedcommercialemailpolicyrestriction.ThecompletetranscriptoftheSMTPsessionissent.

protocol

Notifiesthepostmasterofprotocolerrorsorclientrequeststhatcontainedunimplementedcommands.ThecompletetranscriptoftheSMTPsessionisincludedinthemessage.

resource

Informsthepostmasterofundeliveredmailduetoresourceproblems,suchasaqueuefilewriteerror.

software

Notifiesthepostmasterofmailnotdeliveredduetosoftwarefailures.

Thisoptioncorrelatestothenotify_classesdirective,anddefaultstoreportingonlyproblemsthatusuallyindicateamisconfigurationorseriousproblem(specificallyresourceandsoftware).Insome



highloadenvironments,alteringthistoincludebouncenotificationscouldleadtoalargenumberofnotices.

Other General Options

Thelowersectionofthispageisdevotedtoglobaloptionsthatarelesslikelytoneedalteration.Inmanyinstallations,theseoptionswillremainattheirdefaults.

Address that receives bcc of each message

Withthisoption,anoptionalemailaddressmaybespecifiedtoreceiveacopyofeverymessagethatentersthePostfixsystem,excludinglocallygeneratedbouncemessages.Thiscanrepresentabreachofprivacyinmanycircumstancesandmaybeillegalinsomecountries.Itisadvisabletobecautiousaboututilizingthisoption.Itcanbeusefulinsomeenvironmentswhereemailarchivesarevaluableforlegalortechnicalreasons.Thisoptioncorrelatestothealways_bccdirectiveanddefaultstonone.

Timeout on handling requests

ThisoptiondetermineshowlongaPostfixdaemonwillwaitonarequesttocompletebeforeitassumesthedaemonhaslockedup,atwhichtimethedaemonwillbekilled.Thisoptioncorrespondstothedaemon_timeoutanddefaultsto18,000seconds.

Default database type

Thisoptiondeterminesthetypeofdatabasetouseinthepostaliasandpostmapcommands,andcorrespondstothedefault_database_typedirective.ThedefaultdependsontheOSandinstalledsystemlibrariesatthetimeofbuildingPostfix.OrdinarilythiswillbehashordbmonUNIXsystems.

Default message delivery transport

Thetermdelivery transportreferstotheprotocol,orlanguage,usedtodeliverthemessagefromonemailservertoanother.Thetransportonmodernsystemsisnearlyalwayssmtp,andthisisthedefaultinPostfix,buttherearestillafewlegacyuucpsystemsinuse.Thisoptionismerelythedefaultchoicewhennotransportisexplicitlyselectedforthedestinationintheoptionaltransporttable.Thisoptioncorrespondstothedefault_transportdirective.

Sender address for bounce mail

Intheeventamessagedouble-bounces,orfirstbouncesfromtherecipientandthenbouncesfromthesenderafterthefirstbouncenoticeissent,itwillbesenttothisaddress.Allmessageswillbesilentlydiscarded.Inthisway,bounce-loopscanbeavoided.Thisoptioncorrelatestothedouble_bounce_senderanddefaultstodouble-bounce.Thenamemaybeanyarbitraryname,butitmustbeunique.

Number of subdir levels below the queue dir

ThisoptionconfiguresthenumberofsubdirectorylevelsbelowtheconfiguredqueuedirectoriesthatwillbeusedbyPostfixformailstorage.BecauseofthedesignofthetraditionalUNIXfilesystem,whichincludesUFSusedbyallmodernBSDsystemsandtheLinuxext2andext3filesystems,performancebecomesmeasurablyslowerwhenanextremelylargenumberoffilesarestoredinasingledirectory.Thus,programsthatgeneratealargenumberoffilesoftenprovidetheabilityto



splitfilesouttoanumberofsubdirectoriestokeeplookupsfast.Thisoptioncorrelatestothehash_queue_depthdirectiveanddefaultsto2,whichissuitableformostmoderateandevenrelativelylargeinstallations.Becausethenumberofdirectoriesinuseincreasesthesearchtimeforobjectseeks,usingtoohighavalueherecanbeharmfultoperformance.

Name of queue dirs split across subdirs

Postfixusesanumberofqueuestoorganizemessageswithvaryingstatesanddestinations.Eachofthesequeuescanbeconfiguredtousehashedsubdirectories.Ifaqueueisselectedhere,itwillbestoredinahashedsubdirectory.Insomecases,aqueuemustnotbelistedhereasperformancewillbeseverelyimpacted,specificallytheworld-writablemaildropdirectory.Thedeferlogfiledirectory,ontheotherhand,mustbestoredinhasheddirectoriesorperformancewillsuffer.Thisoptioncorrespondstothehash_queue_namesdirectiveanddefaultstoincoming,active,deferred,bounce,defer,flushandisrarelynecessaryorbeneficialtoalterthisconfiguration.

Max number of Received: headers

AmessagethatcontainsmoreReceived:headersthanthiswillbounce.Anextremelylargenumbermayindicateamaillooporamisconfiguredmailserversomewhereinthepathofthismessage.Thisoptioncorrelatestothehopcount_limitdirectiveanddefaultsto50.Thisvaluerarelyneedstobealteredfromitsdefault.

Time in hours before sending a warning for no delivery

Ifamessagecannotbedeliveredimmediately,itwillbequeuedforlaterdelivery.Afterthisnumberofhours,ifthemessagestillcannotbedelivered,awarningwillbesenttothesendernotifyingthemthattheserverhasbeenunabletosendthemessageforaspecifiedtime.Thiscorrelatestothedelay_warning_timedirectiveanddefaultstonotsendingawarning.

Network interfaces for receiving mail

ThisoptionconfiguresthenetworkaddressesonwhichPostficwillacceptmaildeliveries.Bydefault,Postfixwillacceptmailoneveryactiveinterface.Here,Postfixwillacceptthevariablesdiscussedearlier.Thisoptionconfigurestheinet_interfacesdirective.

Idle time after internal IPC client disconnects

ThisoptionsetsthetimeinsecondswhenaninternalIPCclientwilldisconnect.Thisallowsserverstoterminatevoluntarily.Thisfeatureisusedbytheaddressresolutionandrewritingclients.Thisoptioncorrelatestotheidle_timedirectiveanddefaultsto100seconds.Thisoptionshouldneverneedtobealteredundernormalcircumstances.

Timeout for I/O on internal comm channels

ThisoptiondeterminestheamountoftimeinsecondstheserverwillwaitforI/Ooninternalcommunicationchannelsbeforebreaking.Ifthetimeoutisexceeded,theserverabortswithafatalerror.Thisdirectivecorrespondstotheipc_timeoutdirectiveanddefaultsto3,600second(60minutes).



Mail system name

Thisoptionidentifiesthemailserversysteminusetoconnectingusers.Itwillbeusedinthesmtpd_banner,whichissentinReceived:headers,theSMTPgreetingbannerandinbouncedmail.Securityexpertswhopromotesecuritythroughobscuritysuggestanonymizingallserversoftwaretopreventpotentialcrackersfromidentifyingthesoftwareontheserver.Itisprobablynotthebestuseofanadministrator’stimeoreffortinmostenvironments,however,andmanyothersecuritytacticsaremoreeffectiveandwon’tnegativelyimpacttheabilitytotracksoftwareproblems.Thisoptioncorrelatestothemail_namedirectiveanddefaultstoPostfix.

Mail owner

ThisoptionspecifiestheownerofthePostfixmailqueueandmostofthePostfixdaemonprocesses.Thisusershouldbeuniqueonthesystemandsharenogroupswithotheraccountsorownanyotherfilesorprocessesonthesystem.AfterbindingtotheSMTPport(25),Postfixcandroprootprivilegesandbecometheuserspecifiedhereforallnewdaemonprocesses.IfthePostfixdaemonisevercompromised,theexploiterwillonlyhaveaccesstomailandafewotherfiles.Obviouslyitisgoodtoavoidthisaswell,butitiscertainlybetterthanarootexploit,whichwouldallowtheexploitertoaccessandalteranythingonthesystem.Thisoptioncorrelatestothemail_ownerdirectiveanddefaultstopostfix.

Official mail system version

ThisparemeterconfigurestheversionnumberthatwillbereportedbyPostfixintheSMTPgreetingbanner,amongotherthings.Thiscorrelatestothemail_versiondirectiveanddefaultstotheversionofPostfixthatisinstalled.Onceagain,security-by-obscuritypromotersmayencourageobfuscationofthisvalue.

Time to wait for next service request

APostfixdaemonprocesswillexitafterthetimespecifiedhereifitdoesnotreceiveanewrequestforserviceduringthattime.Thisoptioncorrespondstothemax_idledirectiveanddefaultsto100seconds.Thisdirectivedoesnotimpactthequeuemanagerdaemonprocess.

Max service requests handled before exiting

ThisoptionconfiguresthemaximumnumberofrequeststhatasinglePostfixdaemonprocesswillanswerbeforeexiting.Thisoptionconfiguresthemax_usedirectiveanddefaultsto100.

Internet hostname of this mail system

ThisoptionspecifiestheInternethostnameofthemailserver.Bydefault,thisvaluewillbesettothefullyqualifiedhostnameoftheserver,asdeterminedbyacalltogethostname().Thisoptionsetsthe$myhostnamevariable,whichisusedinthedefaultstomanyotheroptions.Thisoptioncorrelatestothemyhostnamedirective.

Local Internet domain name

Thisoptioncorrespondstothemydomaindirectiveanddefaultstothecontentsofthe$myhostnamevariableminusthefirstcomponent.Thisoptiondefinesthe$mydomainvariableandisusedinanumberofotherconfigurationoptiondefaults.



Local networks

PostfixprovidesaflexiblesetofoptionstohelppreventUCEorotherunauthorizedusesofthemailserver.ThisoptiondefineswhatnetworkswillbeconsideredtobelocalbyPostfix.Thevalueisusedtodeterminewhetheraclientislocalorremote.Policiescanbemorerelaxedforlocalclients.Thisoptionconfiguresthemynetworksdirectiveanddefaultstoalistofallnetworksattachedtotheserver.Forexample,iftheserverhasanIPof192.168.1.48andanetmaskof255.255.255.0,allofthe192.168.1.0networkwillbeconsideredlocal.Ifyouwouldlikestrictercontrolortheabilitytotreatothernetworkblocksaslocalclients,youcanspecifythemhereintheformofnetwork/maskpairs(i.e.,172.16.0.0/16).Network/maskpairsmaybeinsertedfromaseparatefilebyspecifyingtheabsolutepathtothefilehere.

Send postmaster notice on bounce to...

Thisoptionconfigurestheusernameoremailaddresswherebouncenoticeswillbesent.Thisoptioncorrelatestothebounce_notice_recipientandissettopostmasterbydefault.

Send postmaster notice on 2bounce to...

Thisoptionconfigurestheusernameoremailaddresswheresecondbouncemessageswillbesent.Thisallowsanadministratortowatchforsecondbouncewarningsmorecloselythanfirstbouncemessages,becausefirstbouncesarefarmorecommonandlesslikelytoindicateseriousproblems.Theoptionconfiguresthe2bounce_notice_recipientdirectiveanddefaultstopostmaster.

Send postmaster notice on delay to...

Thisoptionconfigureswheredelaywarningswillbesent.Thisoptioncorrelatestothedelay_notice_recipientdirectiveanddefaultstopostmaster.

Send postmaster notice on error to...

Specifieswhereerrorwarningswillbesent.Thisoptioncorrelatestotheerror_notice_recipientdirectiveanddefaultstopostmaster.

Mail queue directory

ThisspecifiesthedirectorywherePostfixwillstorequeuedmail.ThiswillalsobetherootdirectoryforPostfixdaemonsthatruninachrootenvironment.Thequeueiswheremessagesawaitingdeliveryarestored,providingenoughspacetoaccommodateyourusermailloadinthisdirectory.Thisoptioncorrelatestothequeue_directorydirectiveandusuallydefaultstoasensiblelocationforyourOS.ManyLinuxsystemswillhavethemailqueuein/var/spool/mailor/var/spool/postfix.

Lock file dir, relative to queue dir

ThisoptionconfiguresthelocationofthePostfixlockdirectory.Itshouldbespecifiedrelativetothequeuedirectoryandgenerallywillsimplybeasubdirectoryofthequeuedirectory.Thisoptionconfigurestheprocess_id_directorydirectiveanddefaultstopid.

Separator between user names and address extensions

Thisoptionspecifiestheseparatorcharacterbetweenusernamesandaddressextensions.Thisoptioncorrelatestotherecipient_delimiterdirectiveanddefaultstousingnodelimiter.Thisoption



impactsCanonicalMapping,RelocatedMappingandVirtualDomains. Postfix support programs and daemons dir

ThisoptionspecifiesthedirectorywherePostfixwilllookforitsvarioussupportprogramsanddaemons.Thedirectoryshouldbeownedbyroot.Thisoptioncorrelatestotheprogram_directorydirectiveanddefaultsvarydependingoninstallationmethodandOSvariant.OnmanyLinuxsystemsthiswillbe/usr/libexec/postfix.

Relocated mapping lookup tables

Postfixcanprovidearelocationnoticeinresponsetomessagessenttouserswhonolongerreceivemailfromthisserver.Ifenabled,thisoptionspecifiesthelocationofthefilecontainingatableofcontactinformationforuserswhonolongerexistonthissystem.Bydefault,thisfeatureisdisabled.Thisoptioncorrelatestotherelocated_mapsdirective.Ifenabled,areasonablechoiceforthisoptionmightbe/etc/postfix/relocated.

Disable kernel file lock on mailboxes

OnSunworkstations,kernelfilelockscancauseproblemsbecausethemailtoolprogramholdsanexclusivelockwheneveritswindowisopen.UsersofotherOSvariants,orSunsystemswherenoSunmailsoftwareisinuse,mayignorethisoption.Thisoptioncorrelatestothesun_mailtool_compatibilitydirectiveanddefaultstoNo.

Max time to send a trigger to a daemon

ThisoptionspecifiesthemaximumamountoftimeallowedtosendatriggertoaPostfixdaemon.Thislimithelpspreventprogramsfromgettinghungupwhenthemailsystemisunderanextremelyheavyload.Thisoptioncorrelatestotheopts_trigger_timeoutdirectiveanddefaultsto10seconds.

Address Rewriting and Masquerading

Postfixoffersarelativelyeasytouseandflexibleaddressrewritingsystem,allowingittoactasamailgatewayforalargenetworkorasagatewaybetweenlegacymailsystemsandtheInternetatlarge.

Note

TheoptionsonthispagearealsodiscussedonthePostfixConfiguration-Address ManipulationpageatthePostfixhomepage.Itisworthreadingifadvancedaddress rewritingisrequiredinyourmailsystem.

Rewrite “user%domain” to “user@domain”

Thisoptionisusefulforsomelegacysystemsthatusedstrangeaddresstrickery,suchasuser%[email protected],butitisnotharmfulsoitusuallydefaultstoYes.Thisoptioncorrelatestotheallow_percent_hackdirective.

Rewrite “user” to “user@$mydomain”

ThisoptionconfigureshowPostfixwillhandleanaddressthathasnodomainnameinthedestination.Ifenabled,itwillappendthevalueof$mydomaintotheaddress.Thisoptioncorrelates



totheappend_at_myorigindirectiveanddefaultstoYes.BecausemostPostfixcomponentsexpectaddressestobeintheformofuser@domain,itisprobablynotappropriatetodisablethisfeature.

Rewrite “user@host” to “user@host.$mydomain”

Thisoptionconfiguressimplehostaddressesthathavethevalueof$mydomainappendedtothem.Thisoptioncorrelatestotheappend_dot_mydomaindirectiveanddefaultstoYes.Someadministratorsmayfindthatthisexplicitrewritehasunexpectedconsequences,butitisrarelyaproblem.

Rewrite “site!user” to “user@site”

LegacyUUCPnetworksuseadifferentaddressingformatthanmodernSMTPsystems.ThisoptionenablesPostfixtoconverttheold-styleaddresstoamodernaddressfordeliveryviathestandardSMTPprotocol.Thisoptionconfigurestheswap_bangpathdirectiveanddefaultstoYes.

Send mail with empty recipient to...

Thespecifiesthedestinationofmailthatisundeliverable.Typically,thiswillbebouncenotificationsandothererrormessages.Thisoptioncorrelatestotheempty_address_recipientdirectiveanddefaultstoMAILER-DAEMON,whichbydefaultissimplyanaliastopostmaster.

Address masquerading

Addressmasqueradingisamethodwherehostsbehindthegatewaymailservermaybehidden,andallmailwillappeartohaveoriginatedfromthegatewayserver.Ifenabled,thehostand/orsubdomainportionofanaddresswillbestrippedoffandonlythedomainspecifiedwillbeincludedintheaddress.Forexample,if$mydomainisspecifiedanoutgoingmailfromjoe@[email protected],assumingthe$mydomainvariablecontainsswelltech.com.Thisoptioncorrelatestothemasquerade_domainsdirectiveandisdisabledbydefault.

Masquerade exceptions

Itispossibletoskipoverthemasqueraderulesdefinedaboveforsomeusernames.Thenamestobeexceptedfromthoserulescanbeenteredhere.Thisoptioncorrespondstothemasquerade_exceptionsdirectiveandnoexceptionsaremadebydefault.

Mail Aliases

Mailaliasesprovideameanstoredirectmailtolocalrecipients.Specifically,itallowsmaildestinedforanumberofdifferentaddressestobedeliveredtoasinglemailbox.Acommonuseistodirectmailforuserslikeapostmastertoarealperson.Thispageisdividedintotwosections.TheuppersectionlabeledAliasesOptionscontainsthelocationandformatofthealiasfilesthatPostfixshouldusetoconstructitsaliasdatabasesandspecifiesthetypeofdatabasetouse.Thelowersectionprovidesalistofallconfiguredaliasesonthesystemandwhatthealiasmapsto.

Aliases Options

Alias databases used by the local delivery agent

ThisoptionsetsthefilenamesthatPostfixwilluseforlocaldeliveryaliastranslation.Thefilename



willhaveasuffixappendedtoitbasedonthefiletype.Thisoptioncorrelatestothealias_mapsdirectiveandthedefaultissystemdependent.Commondefaultsincludehash:/etc/aliasesorhash:/etc/postfix/aliases.Thefirstpartoftheentryprecedingthecolonisthetypeofdatabasetouse,whichwillbeoneofhashforsystemswithamodernBerkeleyDBimplementation,dbmforolderstylesystemsthatonlyhavedbmavailable,ornisforsystemsthatrunNIS.Theafter-colonportionoftheentryisthepathtothefilenamewherethedatabasenameisderived.ThedatabaseswillbebuiltfromthecontentsoftheflatfilesbyPostfixonstartuporwhenrunningthenewaliasescommand.

Alias databases built by Postfix

Thisoption,whichiscloselyrelatedtothepreviousAliasoption,specifiesthealiasdatabasefile(s)thatarebuiltwhenthenewaliasesorsendmail-bicommandsarerun.ThesecommandsgeneratethealiasdatabasefromtheflatfileinthepreviousAliasoptioninordertospeedaliaslookupsperformedbyPostfix.Becausetheremaybethousandsofaliasesonalargemailserver,importingthemintoadatabaseisnecessarytomaintainefficiency.Thisoptioncorrelatestothealias_databasedirective.Defaultsaresystemdependent,butwillcommonlybethesameasthepreviousAliasoption,withtheappropriatedatabasefilesuffixappended.

Aliases

Thissectionofthepageprovidesalistofallconfiguredaliases.Toeditanalias,clickonthename.Tocreateanalias,clickontheCreateanewaliasbuttonandfillintheNameandAliasto...fields.Wheneveraliasesfileshavebeenmodified,itisnecessarytorecreatethealiasesdatabasefilesinorderforchangestotakeeffect.WhenusingWebmin,thisisperformedautomaticallyandnoadditionalstepsarerequired.

Note

Ifaddingaliasesfromthecommandline,itispossibletoregeneratethealiasesdatabase usingthecommandpostalias.Themainpageforthiscommandisausefulresourcefor understandinghowaliasesdatabasesarehandledinPostfix.

Canonical Mapping

CanonicalmappinginPostfixisusedformodifyingmailintheincomingqueue.Italtersboththemessageheadersandthemessageenvelopeinformationforlocalorremotemail.ThismappingcanbeusefultoreplaceloginnameswithFirstname.Lastnamestyleaddresses,ortocleanupoddaddressesproducedbylegacymailsystems.

Canonical Mapping Tables

Ifyouuseanycanonicalmappingtables,theymustbespecifiedinthefirstsectionoftheCanonical Mappingmodule.Afterdefiningthem,youcaneditthemfromthesecondsectionofthemodule.

Address mapping lookup tables

Thisoptionspecifiesthelocationoftheoptionalcanonicaladdressmappingtablefile.Thismappingisappliedtobothsenderandrecipientaddresses,inbothenvelopesandheaders.Thisoptionconfiguresthecanonical_mapsdirectiveandisdisabledbydefault.Likethealiasesfilesdiscussedinthelastsection,canonicalmappingfilesarespecifiedbyadatabasetypeandafilename.Theaccepteddatabasetypesdependonyouroperatingsystemandinstalledcomponents.Usuallyhash



anddbmareusedasthedatabasetype.Acommonchoiceforthisvaluemightbehash:/etc/postfix/canonical.

Tables for RECIPIENT addresses

Thisparameterconfiguresaddressmappingonlyonrecipientaddressesandnotsenderaddresses.Mappingisperformedonbothenvelopesandheaders.TheselookupsareperformedbeforetheconfiguredAddress mapping lookup tables.Thisoptioncorrelatestotherecipient_canonical_mapsdirectiveandisdisabledbydefault.

Tables for SENDER addresses

Thisconfiguresmappingforsenderaddressesonlyandnotrecipientaddresses.Bothenvelopeandheaderinformationismodified.Thisoptioncorrelatestothesender_canonical_mapsdirectiveandisdisabledbydefault.

Editing Canonical Mappings

Onceafilenameisselectedforanyofthecanonicalmappingtables,itmaybeeditedbyclickingtheappropriateEdit...buttons.Anewpagewillopen,listinganyexistingmappingsandallowingthecreationofnewmappings.Theformatofmappingsinallfilesisthesame.

Canonicalmappingsmayseem,onthesurface,tobesimilartoaliasesorvirtualdomains.However,theyarequitedistinctandareusefulforotherpurposes.Whilealiasesmerelymakeadecisionaboutwhichuserwillreceiveanemailandvirtualdomainsonlyimpacttheenvelopeaddress,thecanonicalmappingaltersboththeenvelopeaddressandtheSMTPheaderaddress.Thischangecanbeusedtomakemailappeartocomefromadifferentuserordomain,ordirectmailtoadifferentuserordomainbychangingtheaddressonthemessage.

Forexample,ifIhaveanumberoflocalsubdomains,butwouldlikeallmailtoappeartooriginatefromasingledomain,itispossibletocreateacanonicalmappingtomakethetranslations.IntheEdit a Mappage,theNamewillbeasubdomainthatismappedtothedomain,[email protected]’dlikethissubdomainconvertedto,@swelltech.com.Aftersavingthemappingandapplyingchanges,alloutgoingmailfromlab.swelltech.comwillappeartooriginatefromswelltech.com.

Virtual Domains

ThisfunctionalityinPostfixprovidesameanstoredirectmessagestodifferentlocationsbyalteringthemessageenvelopeaddress.Theheaderaddressisnotalteredbyavirtualdomainmapping.Whilesomefunctionalityofvirtualdomainsoverlapswithfeaturesavailableinaliases,itcanbeusedforlocalornon-localaddresses,whilealiasescanonlybeusedforlocaladdress.

Domain mapping lookup tables

Muchlikealiasestablesandcanonicalmappingtables,thisissimplythepathtoafilecontainingthemappingtablesforvirtualdomains.Thisisusuallysomethingalongthelinesofhash:/etc/postfix/virtual,andmustbeconvertedtoadatabaseformatinPostfix.Webminwillperformthedatabasegenerationstepforyou.



Transport Mapping

Thetermtransportreferstothemechanismusedtodeliverapieceofemail.Specifically,SMTPandUUCParemailtransportssupportedbyPostfix.Transportmappingcanbeusedforanumberofpurposes,includingSMTPtoUUCPgatewaying,operatingPostfixonafirewallwithforwardingtoaninternalmailserver,etc.

Transport mapping lookup tables

Thisoptionconfiguresthepathtoafilecontainingoneormoretransportmappings.Thesetablesarelikemappingtables,andareconvertedtoadatabaseandusedbyPostfixinthesameway.Thisoptioncorrelatestothetransport_mapsdirective.Thisfeatureisdisabledbydefault.Acommonvalueforthisoptionis/etc/postfix/transport.

Tocreateanewmapping,firstdefinethemappingfile.ThenclickAdd a mapping.IfyourgoalistoredirectmailtoaprotectedinternalhostfromPostfixrunningonafirewall,youcouldentertheoutsidedomainnameintotheNamefield,swelltech.com,andthenenterintotheMaps to...fieldtheaddressoftheinternalmachine,smtp:privatehost.swelltech.com.Toimproveuponthis,localdeliveryonthismachinecouldbedisabled,andincreasedcontrolsoverwhereandtowhommailshouldbeaccepted.Therearemoreexamplesinthetutorialsectionofthischapter.

Relocated Mapping

Usingthisoption,itispossibletonotifysendersifalocaluserhasmovedtoanotheraddress.Forexample,ifauserleavesanorganizationbutstillreceivesoccasionalmailatherlocaladdress,itmaybeconvenienttonotifyanyonesendingmailtotheuserofthemoveandnewcontactinformationforthatuser.Usageisjustliketheprevioustypesofmappingsandwon’tbedocumentedspecificallyhere,althoughanexampleofarelocatedmappingwillbegiventodisplaythetypesofinformationthatcanbeprovidedbythisfeature.

Let’ssayImovefrommycurrentcompanytothefarmorerelaxedatmosphereoftheOvalOffice.Tomakesureallofmyfriendsandclientscankeepintouchwithme,IcouldprovidearelocatedmappingwithaNameofjoe@swelltech.comwithaMaps [email protected]’tredirectmailtomeatmynewhome,itwillnotifythepeopletryingtocontactmethatI’vechangedemailaddresses.Hopefullytheywillupdatetheiraddressbooksandresendtheirmailtothenewaddress.

Local delivery

LocaldeliveryiswhatPostfixdoeswhenitreachestheendofitslistofmappingsandaccesscontrolsandstillfindsthatthemessageisallowedanddestinedforauseronthelocalmachine(i.e.,amappingcouldpotentiallysendthemessageelsewhereforfinaldelivery,soallmappings,aswellasvariousaccesschecks,areperformedbeforereachingthisstage).ThispageconfiguresanumberofoptionsrelatingtohowPostfixhandlesthedeliveryofmailforlocalusers.

Name of the transport for local deliveries

Thisconfiguresthenameofthetransportthatwillbeusedfordeliverytoadestinationthatwillmatchthe$mydestinationor$inet_interfacesvariables.ThiscanbeasimplemailboxdrophandledbythePostfixlocaldeliveryagent,oranyappropriatedeliverycommand.Thisoptioncorrelatestothelocal_transportdirectiveanddefaultstothedefinedtransporttypenamedlocal.



Shell to use for delivery to external command

Ifacommandshellisrequiredtocommunicateproperlywithyourchosenlocaldeliverytransport,thisoptionselectstheonethatwillbeused.Bydefault,noshellisusedandthetransportcommandwillbeexecuteddirectly.However,ifthecommandcontainsshellmeta-charactersorshellbuilt-incommands,theywillbepassedto/bin/shorwhatevershellyouconfigurehere.Apopularchoiceforthisissmrsh,orSendmail’sRestrictedShell,whichisincludedinrecentSendmaildistributions.smrshallowsmoreprecisecontroloverwhatcommandsuserscanexecutefromtheir.forwardfiles.Thisoptioncorrespondstothelocal_command_shellanddefaultsto/bin/sh.

Search list for forward

Thisisacomma-separatedlistofpossiblelocationsforuserforwardfiles.Postfixwilltryeachentryinthelistuntilaforwardfileisfound,oruntilallhavebeencheckedandnomatchisfound.Theforwardfileallowsuserstoconfiguredeliveryoptionsforthemselves,includingdelivery-timeprocessingbyaprogramlikeprocmail,aswellastheforwardingofmessagestoadifferentserver.Anumberofvariableexpansionsareperformedontheentries.Theexpansions:

Forward search path variable expansions

$user

Theusernameoftherecipient.

$shell

Theshelloftherecipient.

$home

Recipient’shomedirectory.

$recipient

Thefullrecipientaddress.

$extensions

Recipientaddressextensions.Thisisaseparatepartoftheemailaddress,separatedbytheSeparator between user names and address extensionsdefinedontheGeneral Optionspage.

$domain

Therecipient’sdomainname.

$local

Theentirelocalpartoftherecipientaddress.

$recipient_delimiter

Theseparationdelimiterfortherecipient.



Valid mail delivery to external commands

Thisparameterrestrictsmaildeliverytoonlythosecommandsspecifiedhere.Thedefaultistodisallowdeliverytocommandsspecifiedin:include:files,andallowexecutionofcommandsinaliasandforwardfiles.Thisoptioncorrelatestotheallow_mail_to_commanddirective.

Valid mail delivery to external files

Thisoptionrestrictsmaildeliverytoexternalfiles.Thedefaultistodisallowdeliverytofilesspecifiedin:include:buttoallowdeliverytofilesspecifiedinaliasesandforwardfiles.Thisoptioncorrelatestotheallow_mail_to_filesdirective.

Default rights of the local delivery agent

Thisoptionconfigurestheprivilegesthatthedeliveryagentwillhavefordeliverytoafileoracommand.ThisoptionshouldneverbeaprivilegeduserorthePostfixowner.Thisoptioncorrespondstothedefault_privsdirectiveanddefaultstonobody.

Pathname of user mailbox file

Whendeliveringmaillocally,Postfixwilldropmailinthedirectoryconfiguredhereorinitsdefaultmailspooldirectory.Ifyouwishtousethemaildirformatformailstorage,thisvaluecanbeappendedwithatrailingslash.Forexample,tostoremailintheuser’shomedirectoryintheMaildirsubdirectory,thevaluewouldbeMaildir/.Thisoptioncorrelatestothehome_mailboxdirectiveandusuallydefaultstosomelocationunder/var/spool/mailor/var/spool/postfix.

Destination address for unknown recipients

Ifamessageisreceivedforarecipientthatdoesnotexist,themessageisnormallybounced.However,itispossibletoinsteadhavethemessagedeliveredtoanalternateaddress.Thisoptioncorrespondstotheluser_relaydirective.VariableexpansionsmatchingthosediscussedfortheSearch list for forwardarealsovalidforthisdirective.

Spool directory

ThisoptionspecifiesthedirectorywhereUNIX-stylemailboxesarestored.DefaultsvarydependingonOSvariantandversion,butacommonchoiceis/var/spool/mail.Thisoptioncorrelatestothemail_spool_directoryoption.

External command to use instead of mailbox delivery

Thisoptiondefinesacommandtousefordeliveryinsteadofdeliveringstraighttotheuser’smailbox.ThecommandwillberunastherecipientofthemessagewithappropriateHOME,SHELLandLOGNAMEenvironmentvariablesset.Thisoptioniscommonlyusedtosetupsystem-wideusageofprocmail.Ifyouuseacommandtodelivermailtoallusers,youmustconfigureanaliasforroot,asthecommandwillbeexecutedwiththepermissionsofthe$default_user.Thisoptioncorrelatestothemailbox_commanddirectiveandisdisabledbydefault.

Optional actual transport to use

Thisoptionconfiguresthemessagetransporttouseforalllocalusers,whethertheyareintheUNIX



passwddatabaseornot.Ifprovided,thevaluewilloverrideallotherformsoflocaldelivery,includingDestination address for unknown recipients.Thisoptioncorrespondstothemailbox_transportdirectiveandisdisabledbydefault.Thisoptionmaybeusefulinsomeenvironments,forexample,todelegatealldeliveriestoanagentlikethecyrusIMAPD.

Optional transport for unknown recipients

IfausercannotbefoundintheUNIXpasswddatabaseandnoaliasmatchesthename,themessagewillordinarilybebouncedorhandledviatheDestination address for unknown recipients option.However,ifyouwouldlikeunknownuserstobehandledbyaseparatetransportmethod,thisoptionoverridestheDestination address for unknown recipientsoption.Thisoptioncorrelatestothefallback_transportdirectiveandisdisabledbydefault.

Max number of parallel deliveries to the same local recipient

Thisoptionlimitsthenumberofsimultaneousdeliveriestoasinglelocalrecipient.If.forwardfilesareallowedforusers,ausermayrunatime-consumingcommandorshellscript,leadingtooverloadcausedbyseveralprocessesbeingstartedupatonce.Thisoptioncorrelatestothelocal_destination_concurrency_limitdirectiveandthedefaultis2.Alowvalueisrecommendedforthisoption,unlessitiscertainthatnocomplex.forwardfileswillbeinuse.

Max number of recipients per local message delivery

Thisoptionconfiguresthemaximumnumberofrecipientsperlocalmessagedelivery.Thisoptioncorrelatestothelocal_destination_recipient_limitandissettothevalueofMaxnumberofrecipientspermessagedeliverybydefault.

Prepend a Delivered-To: when...

ThisparameterdetermineswhenPostfixshouldinsertaDelivered-to:messageheader.Bydefault,Postfixinsertsthisheaderwhenforwardingmailandwhendeliveringtoafile.Thedefaultsarerecommended,anditisgenerallypreferablenottodisableinsertionintoforwardedmail.Thisoptioncorrespondstotheprepend_delivered_headerdirective.

General resource control

ThispageprovidesaccesstothevariousmemoryandprocesslimitsforthePostfixprocesses.Itisrarelynecessarytoalterthevaluesonthispage,exceptforhighlyloadedserversorverylowresourcemachines. Max size of bounced message

Thisoptionlimitstheamountoforiginalmessagecontentinbytesthatwillbesentinabouncenotification.Thisoptioncorrelatestobounce_size_limitanddefaultsto50000bytes.

Max time for delivery to external commands

Whendeliveringmailtoanexternalcommandratherthanviadirectmailboxdelivery,Postfixwillwaitthisamountoftimeforthedeliverytocomplete.Ifthisvalueistobesettoahighlimit(3,600secondsormore),thevalueofTimeout for I/O on internal comm channels in General Options mustalsobeincreased.Thisoptioncorrelatestothecommand_time_limitdirectiveanddefaultsto1000 seconds.



Max number of Postfix child processes

ThisoptionlimitsthenumberofchildprocessesthatPostfixwillspawn.Onhighloadservers,thedefaultmaybetoolowandneedtoberaisedtoasmuchas500ormore.Formostenvironments,50ismorethanadequateandmayevenbeoverkill.Forexample,ondial-uporconsumerbroadbandservingoneto10users,amoreappropriatelimitmightbe10.Ifindoubt,leaveitsdefaultunlessitcausesproblems.Thisoptioncorrelatestothedefault_process_limitdirectiveanddefaultsto50.

Max number of addresses remembered by the duplicate filter

Whileexpandingaliasesand.forwardfiles,Postfixwillrememberaddressesthatarebeingdeliveredtoandattempttopreventduplicatedeliveriestothesameaddress.Thisoptionlimitsthenumberofrecipientaddressesthatwillberemembered.Itcorrespondstotheduplicate_filter_limitdirectiveanddefaultsto1000.Thereisnocompellingreasontoincreasethisvalue.

Max attempts to acquire file lock

ThisoptionlimitsthenumberofattemptsPostfixwillmakewhenattemptingtoobtainanexclusivelockonamailboxorotherfilerequiringexclusiveaccess.Itcorrespondstothedeliver_lock_attemptsdirectiveanddefaultsto20.

Time in seconds between file lock attempts

Postfixwillwaitaspecifiedtimebetweenattemptstolockagivenfileafterafailedlockattempt.Thisoptionconfiguresthedeliver_lock_delaydirectiveanddefaultsto1second.

Max attempts to fork a process

IfPostfixattemptstoforkanewprocessandfails,duetoerrorsoralackofavailableresources,itwilltryagainaspecifiednumberoftimes.Thisoptioncorrelatestothefork_attemptsdirectiveanddefaultsto5.

Time in seconds between fork attempts

Postfixwilltrytospawnanewprocessaspecifiedtimeafterafailedattempt.Thisoptioncorrelatestothefork_delaydirectiveanddefaultsto1second.

Max memory used for processing headers

ThisoptionlimitstheamountofmemoryinbytesthatPostfixwillusetoprocessmessageheaders.Ifamessageheaderistoolargetofitintothememoryspecified,theheaderswillbetreatedaspartofthemessagebody.Thisoptioncorrelatestotheheader_size_limitdirectiveanddefaultsto102,400.

Max memory used for handling input lines

ThisoptionlimitstheamountofmemoryinbytesthatPostfixwillusetohandleinputlines.Aninputlineisanylinereadfroman:include:or.forwardfile.Inordertopreventthemailserverfromusingexcessiveamountsofmemory,itwillbreakupfilesintochunksofthislength.Thisoptioncorrelatestotheline_length_limitdirectiveanddefaultsto2048.



Max size of a message

Thisoptionlimitsthesizeinbytesofamessagethatwillbedelivered,includingthemessageenvelopeinformation.Thislimitshouldbesethighenoughtosupportanyemailmessagesyouruserswillneedtobeabletosendorreceive.Thisoptioncorrelatestothemessage_size_limitdirectiveanddefaultsto10,240,000.

Max number of messages in the active queue

Thisoptionlimitsthenumberofmessagesthatcanexistinthemessagequeueatanygiventime.Itcorrelatestotheqmgr_message_active_limitdirectiveanddefaultsto10,000.

Max number of in-memory recipients

Thisparameterlimitsthenumberofin-memoryrecipientdatastructures.Thismemorycontainstheshort-termdead list,whichindicatesadestinationwasunavailablewhenlastcontacted,amongotherthings.Thisoptioncorrelatestotheqmgr_message_recipient_limitdirectiveanddefaultsto1000.

Min free space in the queue file system

Postfixwillrefusemailifthefilesystemonwhichthequeueislocatedhaslessavailablespaceinbytesthanthevaluesetinthisoption.Thisoptioncorrelatestothequeue_minfreedirectiveanddefaultsto0.

Max time after which stale lock is released

Thisoptionconfigureshowoldanexternallockfilemaybebeforeitisforciblyremoved.Thisoptioncorrelatestothestale_lock_timeanddefaultsto500seconds.

Time in seconds between attempts to contact a broken MDT

Thisoptionconfiguresthetimeinsecondsbetweenthequeuemanagerattemptstocontactanunresponsivemaildeliverytransport.Thisoptioncorrelatestothetransport_retry_timeanddefaultsto 60 seconds.

SMTP server options

ThispageconfiguresthemajorityofoptionsthatdirectlyaffectthebehavioroftheSMTPserverportionofPostfix,specificallytheportionsthatimpacthowtheserverbehavestowardsanSMTPclientthatconnectstotheserver.

SMTP greeting banner

WhenaclientconnectstoanSMTPserver,agreeting bannerwillbesenttotheclient(notethetermclientinthiscontextisnottheenduser,butrathertheemailsoftwareprogramusedtomaketheconnection).Thisoptionconfiguresthetextthatwillfollowthestatuscodeinthebanner.Itispossibletouseanumberofvariableexpansions,forexample,todisplaythespecificversionoftheserversoftware,thoughPostfixdoesnotincludetheversionbydefault.Ifconfiguringthisoptiontobeotherthanthedefault,youmustinclude$myhostnameatthestartofthisline,asitallowsPostfixtoreportandrespondtoamailerloopratherthanoverloadthesystemwithmultipledeliveries.This



optioncorrelatestothesmtpd_bannerdirectiveandcontains$myhostnameESMTP$mail_namebydefault.

Note

AproposedfederallawintheU.S.wouldmakeitillegaltosendunsolicitedcommercial emailthroughamailserveriftheserverincludedinitsSMTPgreetingthewordsNOUCE.

Max number of recipients accepted for delivery

Thisoptionlimitsthenumberofrecipientsthatmaybespecifiedinasinglemessageheader.Itisusuallyrareforlegitimatemessagestohaveanextremelylargenumberofrecipientsspecifiedinasinglemessageheader,butitisoftendoneinUCEmessages.Thelegitimateexceptionismessagestoamailinglist,possiblysentbymailinglistsoftwarelikemajordomoormailman.Thisoptioncorrelatestothesmtpd_recipient_limitanddefaultsto1000.

Disable SMTP VRFY command

Normally,theSMTPVRFYcommandisusedtoverifytheexistenceofaparticularuser.However,itisalsoillegitimatelyusedbyspammerstoharvestliveemailaddresses.Thus,itissometimesusefultodisablethiscommand.Thisoptioncorrelatestodisable_vrfy_commandanddefaultstoNo.

Timeout in seconds for SMTP transactions

ThisoptionsetsthetimeoutforaclienttorespondtotheSMTPserversresponsewithanSMTPrequest.Theconnectionprocessinvolvestheclientopeningaconnectiontotheserver,theserverreplyingwithagreetingandtheclientmakingitsrequest.Iftheclientrequestdoesnotcomewithinthetimespecifiedhere,theconnectionwillbeclosed.Thisoptioncorrelatestotheopts_smtpd_timeoutdirectiveanddefaultsto300seconds.

Timeout before sending 4xx/5xx error response

Whensendinganerrorresponsetoaclient,theserverwillsleepforaspecifiedtime.Thepurposeofthisfeatureistopreventcertainbuggyclientsfromhittingtheserverwithrepeatedrequestsinrapidsuccession.Thisoptioncorrelatestothesmtpd_error_sleep_timedirectiveanddefaultsto5seconds.

Error count for temporarily ignore a client

ThisoptionconfiguresthenumberoferrorsthataclientmaygeneratebeforePostfixwillstoprespondingtorequestsforaspecifiedtime.Somebuggymailclientsmaysendalargenumberofrequests,whileignoringorrespondingincorrectlytotheerrormessagesthatresult.Postfixattemptstominimizetheimpactofthesebuggyclientsonnormalservice.Thisoptioncorrelatestothesmtpd_soft_error_limitanddefaultsto10.

Error count for closing connection

Ifthenumberexceedsthislimit,theconnectionwillbeclosed.Thisoptioncorrelatestothesmtpd_hard_error_limitanddefaultsto100.



HELO is required

EnablingthisoptioncausesPostfixtorequireclientstointroducethemselveswithaHELOheaderatthebeginningofanSMTPsession.ThismaypreventsomeUCEsoftwarepackagesfromconnecting,althoughitmayalsoimpactotherlegitimateclients.Thisoptioncorrelatestothesmtpd_helo_requiredanddefaultstoNo.

Allow untrusted routing

ThisoptionconfigureswhetherPostfixwillforwardmessageswithsender-specified routingfromuntrustedclientstodestinationswithintheacceptedrelaydomains.Thisfeatureclosesapotentialloopholeinaccesscontrolsthatwouldnormallypreventtheserverfrombeinganopenrelayforspammers.Ifthisbehaviorisallowed,amalicioususercouldexploitabackupMXmailhostintoforwardingjunkmailtoaprimaryMXserverthatbelievesthemailhasoriginatedfromalocaladdress.Thisoptioncorrelatestotheallow_untrusted_routingandisdisabledbydefault.EnablingthisoptionshouldbedonewithextremecautiontopreventturningyourPostfixinstallationintoanopenrelay.

Restrict ETRN command upon...

TheSMTPETRNcommandisaclumsymeansforclientsthatarenotalwaysconnectedtotheInternettoretrievemailfromtheserver.Theusageofthiscommandisratheroutdatedandrarelyused,asPOP3andIMAParebettersuitedtosolvethisproblem.Thisoptioncorrelatestothesmtpd_etrn_restrictionsdirectiveandthedefaultistoallowETRNfromanyhost.Thisoptionacceptsthefollowingdirectives:check_etrn_accessmaptype:mapname,permit_naked_ip_address,reject_invalid_hostname,check_helo_accessmaptype:mapname,reject_maps_rbl,reject_unknown_client,permit_mynetworks,check_client_access,permit,reject,warn_if_reject,andreject_unauth_pipelining.

Thisoption,aswellasthefollowingthreeRestrictions...options,acceptoneorallofthefollowingvaluesinthetextfield.Eachisdescribedonlyoncehereandthespecificentrywillincludethelistofaccepteddirectivesfortheoption.Theimpactofsomeofthesechoicesdependsonconfigurationperformedelsewhere,andcouldpotentiallyopensecurityholesifnotconfiguredcarefully.

permit_mynetworks

Permitthemessageiftherelevantaddress(senderorrecipient,dependingontherestriction)iswithinthelocalnetwork.

reject_unknown_client

TherequestwillberefusediftheclientIPhasnoPTRrecordintheDNS.ThismeansaclientwithanIPaddressthatcannotberesolvedtoahostnamecannotsendmailtothishost.

check_client_accessmaptype:mapname

Thisoptionrequirestheinclusionofanalreadyconfiguredmap.Thiswillrestrict,basedonthecontentsofthemap,allowingonlyclientsthatareallowedbythemap.Themapmaycontainnetworks,parentdomainsorclientaddresses,andPostfixwillstripoffunnecessaryinformationtomatchtheclienttothelevelofspecificityneeded.

check_sender_accessmaptype:mapname



Thiswillrestrict,basedonthecontentsofthemap,allowingonlysendersthatareallowedbythemap.Themapmaycontainnetworks,parentdomains,orlocalpart@.

reject_maps_rbl

reject_invalid_hostname

Iftheclienthostnameisinvalidduetobadsyntax,therequestwillberejected.

permit_naked_ip_address

IftheclientHELOorEHLOcommandcontainsanakedIPaddresswithouttheenclosing[]bracketsasrequiredbythemailRFC,themessagewillberejected.BewarethatsomepopularmailclientssendaHELOgreetingthatisbrokenthisway.

reject_unknown_hostname

RejecttherequestifthehostnameintheclientHELOcommandhasnoAorMXrecordintheDNS.

reject_non_fqdn_hostname

Iftheclienthostnameisnotintheformofafully-qualifieddomainname,asrequiredbytheRFC,themessagewillberejected.

check_helo_accessmaptype:mapname

TheserverwillsearchthenamedaccessdatabasemapfortheHELOhostnameorparentdomains.IftheresultfromthedatabasesearchisREJECTora4xxtextor5xxtexterrorcode,themessagewillberefused.AresponseofOKorRELAYoranallnumericalresponsewillpermitthemessage.

permit

Thissimplypermitsanything.Generally,thiswillbeattheendofasetofrestrictionsinordertoallowanythingthathasnotbeenexplicitlyprohibited.

reject

Rejectseverything.Thiscanbeusedattheendofachainofrestrictionstoprohibitanythingthathasnotbeexplicitlypermitted.

warn_if_reject

Thisisaspecialoptionthatchangesthemeaningofthefollowingrestriction,sothatamessagethatwouldhavebeenrejectedwillbeloggedbutstillaccepted.Thiscanbeusedfortestingnewrulesonproductionmailserverswithouttheriskofdenyingmailduetoaproblemwiththerules.

reject_unauth_pipelining

IftheclientsendscommandsaheadoftimewithoutfirstconfirmingtheserversupportSMTPcommandpipelining,themessagewillberejected.Thiswillpreventmailfrompoorlywrittenbulkemailsoftwarethatusespipeliningtospeedupmassdeliveries.



Restrictions on client hostnames/addresses

Thisrestrictionappliestotheclienthostnameand/oraddress.Bydefault,Postfixwillallowconnectionsfromanyhost,butyoumayaddadditionalrestrictionsusingthefollowing:reject_unknown_client,permit_mynetworks,check_client_accessmaptype:mapname,reject_maps_rbl,maps_rbl_reject_code,permit,reject,warn_if_reject,reject_unauth_pipelining.

Restrictions on sends in HELO commands

ThisoptionspecifiesadditionalrestrictionsoninformationthatcanbesentbyclientintheHELOandEHLOcommands.Thisoptioncorrelatestothesmtpd_helo_restrictionsdirective.BydefaultPostfixacceptsanything,andthefollowingrestrictionsmaybeadded:reject_invalid_hostname,permit_naked_ip_address,reject_unknown_hostname,reject_non_fqdn_hostname,check_helo_accessmaptype:mapname,reject_maps_rbl,reject_unknown_client,check_client_accessmaptype:mapname,permit,reject,warn_if_reject,reject_unauth_pipelining.

Restrictions on sender addresses

ThisoptionrestrictswhatcanbecontainedintheMAILFROMcommandinamessage.Itmaybeusedtopreventspecificemailaddressesfromsendingmail,rejectclientswithoutaresolvablehostname,etc.Thisoptioncorrelatestothesmtpd_sender_restrictionsdirectiveandmaycontainanyofthefollowingrestrictions:permit_mynetworks:,reject_unknown_client,reject_maps_rbl,reject_invalid_hostname,reject_unknown_hostname,reject_unknown_sender_domain,check_sender_access maptype:mapname,check_client_accessmaptype:mapname,check_helo_accessmaptype:mapname,reject_non_fqdn_hostname,reject_non_fqdn_sender,reject,permit.

Restrictions on recipient addresses

ThisparameterplacesrestrictionsontherecipientsthatcanbecontainedintheRCPTTOcommandofasentmessage.Itcanbeusedtodictatewhereemailmaybesent.Thisoptioncorrelatestothesmtpd_recipient_restrictions,andmaycontainanyofthefollowingrestrictions:permit_mynetworks,reject_unknown_client,reject_maps_rbl,reject_invalid_hostname,reject_unknown_hostname,reject_unknown_sender_domain,check_relay_domains,permit_auth_destination,reject_unauth_pipelining,permit_mx_backup,reject_unknown_recipient,check_recipient_access,check_client_access,check_helo_access,check_sender_access,reject_non_fqdn_hostname,reject_non_fqdn_sender,reject_non_fqdn_recipient,reject,permit.

DNS domains for blacklist lookups

ThisoptionconfigurestheoptionalblacklistDNSserversthatwillbeusedforallRBLchecksthathavebeenspecifiedinallaccessrestrictions.Itmaycontainanynumberofserversinawhitespaceseparatedlist.Theseservicescanbeusedtohelppreventspam,asdiscussedearlierinthissection,withtheRestrict ETRN command upon...parameter.Thisoptionconfiguresthemaps_rbl_domainsdirectiveandisemptybydefault.

Restrict mail relaying

Thisoptionspecifieswhichhosts,networks,domains,etc.,Postfixwillrelayemailfor.Thisoptioncorrelatestotherelay_domainsdirectiveanddefaultsto$mydestination.

SMTPserverresponseonaccessmapviolation,SMTPserverresponseonRBLdomainsviolation,SMTPserverresponseonforbiddenrelaying,SMTPserverresponseonunknownclientreject,



SMTPserverresponseoninvalidhostnamereject,SMTPserverresponseonunknowndomainreject,SMTPserverresponseonunknownhostnamereject

Theseoptionsconfiguretheerrorresultcodethatwillbesenttotheclientwhenanyofthespecifiedrestrictionsareapplied.Theseerrorshavesensibledefaultvaluesandgenerallyshouldnotneedtobechanged.ConsultwithRFC822ifyouwishtounderstandmoreabouttheSMTPerrorcodesorhaveareasontochangeanyofthesevalues.

SMTP Client Options

TheSMTPclientoptionsconfigureshowPostfixwillbehavewhendealingwithothermailserversasaclient,i.e.,whensendingmailonbehalfofauser.Thisportionoftheconfigurationprimarilydictateshowtheserverwillrespondtocertainerrorconditions.

Action when listed as best MX server

AsdiscussedintheBINDchapter,amailserverperformsanameserverquerytofindtheMX,ormailserver,recordforthedestinationdomain.Ifthisrecordindicatesthatthelocalserveristheservertowhichmailshouldbesent,itcanrespondinacoupleofways.Thedefaultistobouncethemessagewithanerrorindicatingamailloop.Ifthefieldisselectedandlocalisentered,themailwillbedirectedtothelocaldeliveryagentinsteadofbouncing.Thisoptioncorrelatestothebest_mx_transportdirective.

Hosts/domains to hand off mail to on invalid destination

Bydefault,mailthatcannotbedeliveredbecausethedestinationisinvalidwillbebouncedwithanappropriateerrormessage.However,itispossibletoconfigurePostfixtohandoffemailtoanotherserverinstead.Thisoptioncorrelatestothefallback_relaydirective.

Ignore MX lookup error

IfanameserverqueryfailstoprovideanMXrecord,theserverdefaultstodeferringthemailandtryingagainlater.IfYesisselected,anArecordquerywillbedoneandanattempttodelivertotheresultingaddresswillbemade.Thisoptioncorrelatestotheignore_mx_lookup_errordirective.

Skip 4xx greeting

Ifaremoteserverrespondstoaconnectionwitha4XXstatuscode,Postfixwill,bydefault,selectthenextavailablemailexchangerspecifiedbytheMXrecords.IfsettoNo,maildeliverywillbedeferredafterthefirstmaildeliveryattemptandanotherattemptwillbemadelater.Thisoptioncorrelatestothesmtp_skip_4xx_greetingdirective.

Skip wait for the QUIT command

ThisoptionconfigureswhetherPostfixwillwaitforthereceivingmailservertorespondtotheQUITcommand.Thisoptioncorrelatestothesmtp_skip_quit_responsedirectiveanddefaultstono.

Max number of parallel deliveries to the same destination

ThisoptionspecifiesthemaximumnumberofdeliveriesthatPostfixwillperformtothesamedestinationsimultaneously.Thisoptioncorrelatestothesmtp_destination_concurrency_limitdirectiveanddefaultstothesystem-widelimitforparelleldeliveriesconfiguredintheDelivery



Ratespage.

Max number of recipients per delivery

Limitsthenumberofrecipientsperdelivery.Thisoptioncorrelatestothesmtp_destination_recipient_limitdirectiveanddefaultstothesystem-widelimitforrecipientsperdelivery.

Timeout for completing TCP connections

SpecifiesthetimeinsecondsthatthePostfixdeliveryagentwillwaitbeforetimingoutaTCPconnection.Thisoptioncorrelatestothesmtp_connect_timeoutdirectiveanddefaultsto0,whichdisablesconnectiontimeouts.

Timeout on waiting for the greeting banner

LimitshowlongPostfixwillwaitforagreetingbannertobereceivedfromthedestinationserver.Thisoptioncorrespondstothesmtp_helo_timeoutdirectiveanddefaultsto300seconds.

Timeout on waiting for answer to MAIL FROM

SetsthetimeoutinsecondsforsendingtheSMTPMAILFROMcommandandreceivingthedestinationserver’sresponse.Thisoptioncorrelatestothesmtp_mail_timeoutanddefaultsto300seconds.

Timeout on waiting for answer to RCPT TO

SetsthetimeoutinsecondsforsendingtheSMTPRCPTTOcommandandreceivingthedestinationserver’sresponse.Thisoptioncorrelatestothesmtp_rcpt_timeoutdirectiveanddefaultsto 300 seconds.

Timeout on waiting for answer to DATA

SetsthetimeoutinsecondsforsendingtheSMTPDATAcommandandreceivingthedestinationserver’sresponse.Thisoptioncorrelatestothesmtp_data_init_timeoutanddefaultsto120seconds.

Timeout on waiting for answer to transmit of message content

SpecifiestheSMTPclienttimeoutinsecondsforsendingthecontentsofthemessage.Iftheconnectionstallsforlongerthanthistimeout,thedeliveryagentwillterminatetotransfer.Thisoptioncorrespondstothesmtp_data_xfer_timeoutdirectiveanddefaultsto180seconds.

Timeout on waiting for answer to ending “.”

SpecifiestheSMTPclienttimeoutinsecondsforsendingtheclosingSMTP“.”andreceivingthedestinationserver’sreply.Thisoptioncorrelatestothesmtp_data_done_timeoutdirectiveanddefaultsto600seconds.

Timeout on waiting for answer to QUIT

SetsthetimeoutinsecondsforsendingtheSMTPQUITcommandandreceivingthedestinationserver’sresponse.Thisoptioncorrelatestothesmtp_quit_timeoutanddefaultsto300seconds



Delivery Rates

ThispagecontainstheoptionsforsettingthedefaultrateandconcurrencylimitsforallPostfixcomponents.Theseratescanusuallybeoverriddenwithintheirrespectiveconfigurationsections.

Max number of parallel deliveries to the same destination

ThisoptionspecifiesthemaximumnumberofdeliveriesthatPostfixwillperformtothesamedestinationsimultaneously.Thisoptioncorrelatestothedefault_destination_concurrency_limitdirectiveanddefaultsto10.

Max number of recipients per message delivery

Limitsthenumberofrecipientsperdelivery.Thisoptioncorrelatestothedefault_destination_recipient_limitdirectiveanddefaultsto50.

Initial concurrency level for delivery to the same destination

Specifiestheinitialnumberofsimultaneousdeliveriestothesamedestination.ThislimitappliestoallSMTP,localandpipemailerdeliveries.Aconcurrencyoflessthantwocouldleadtoasingleproblememailbackingupdeliveryofothermailtothesamedestination.Thisoptionconfigurestheinitial_destination_concurrencydirectiveanddefaultsto5.

Max time (days) in queue before message is undeliverable

Definesthenumberofdaysamessagewillremainqueuedfordeliveryintheeventofdeliveryproblemsbeforethemessageissentbackasundeliverable.Thisoptionconfiguresthemaximal_queue_lifetimedirectiveanddefaultsto5days.

Min time (secs) between attempts to deliver a deferred message

Intheeventofadeliverydeferral,Postfixwillwaitaspecifiedamountoftimebeforereattemptingdelivery.Thisvaluealsospecifiesthetimeanunreachabledestinationwillremaininthedestinationstatuscache.Thisoptioncorrelatestotheminimal_backoff_timedirectiveanddefaultsto1000seconds.

Max time (secs) between attempts to deliver a deferred message

Specifiesthemaximumamountoftimebetweendeliveryattemptsintheeventofadeferreddelivery.Thisoptionconfiguresthemaximal_backoff_timedirectiveanddefaultsto4000seconds.

Time (secs) between scanning the deferred queue

Specifiesthetimeinsecondsbetweenqueuescansbythequeuemanagementtask.Thisoptioncorrelatestothequeue_run_delayanddefaultsto1000seconds.

Transports that should not be delivered

Thisfieldspecifieswhichdeliverytransports,ifany,definedintheTransport Mappingsectionwillnothavetheirmessagessentautomatically.Instead,themessageswillbequeuedanddeliveredmanuallyusingthesendmail-qcommand.Thisoptioncorrelatestothedefer_transportsdirectiveandcontainsnothingbydefault.



Debugging features

Postfixhastwolevelsoflogging.Thefirstlevelisthenormalmaillog,whichreportsonallnormalmailactivities,suchasreceivedandsentmail,servererrors,shutdownsandstartups.ThesecondlevelismoreverboseandcanbetunedtologactivityrelatingtospecificSMTPclients,hostnamesoraddresses.Thispagecontainstheconfigurationforthesecondleveloflogging.

List of domain/network patterns for which verbose log is enabled

Thisisalistofpatternsoraddressesthatmatchtheclients,hostsoraddresseswhoseactivityyouwouldliketohavemoreverboseloggingfor.ValuescouldbeanIPaddresslike192.168.1.1oradomainnamelikeswelltech.com.Thisoptioncorrelatestothedebug_peer_listdirectiveandisemptybydefault.

Verbose logging level when matching the above list

Specifiesthelevelofverbosityoftheloggingfortheactivitythatmatchestheabovepatterns.Thisoptioncorrelatestothedebug_peer_leveldirectiveanddefaultsto2.Theabovefieldmusthaveatleastonevalueforthisdebugleveltohaveanyimpact.

Postfix, Unsolicited Commercial Email and Access Controls

Postfixoffersanextremelyflexiblesetofaccesscontrols,primarilytargetedatpreventingunsolicitedcommercialemailfrombeingdeliveredthroughtheserver.Inordertoconstructasuitablesetofcontrols,itisnecessarytounderstandtheorderrulesarecheckedandhowtheyinteract.Bydefault,PostfixwillacceptmailfordeliveryfromortoanyclientonyourlocalnetworkandanydomainsthatarehostedbyPostfix.So,bydefault,Postfixisnotanopenrelay.Thisisagoodbeginningandallthatisneededinmanyenvironments.However,becauseUCEissuchanuisanceforusersandnetworkadministrators,itmaybeworthwhiletoimplementmoreadvancedfiltering.ThissectionwilladdressthebasicsofthePostfixUCEcontrolfeatures.

Access Control List Order

Everymessagethatentersthesmtpddeliverydaemonwillbeprocessedbyaccesscontrollistsandcheckedagainstrulestoensurethatthemessageisonethattheadministratoractuallywantsdelivered.Thegoalformostadministratorsistopreventunsolicitedcommercialemailfrompassingthroughtheserules,yetallowlegitimateemailstobedelivered.Thisisaloftygoal,andadelicatebalance.Noperfectsolutionexistsaslongaspeoplearewillingtostealresourcesfortheirowncommercialgainandgotogreatlengthstoovercometheprotectionsinplacetopreventsuchabuse.However,inmostenvironmentsitispossibletodevelopareasonablesetofrulesthatpreventsmostspamandallowsmostoralllegitimatemailthroughunharmed.

Itisimportanttounderstandtheorderofprocessingifcomplexsetsorrulesaretobeused,asattemptingtousearuletooearlyinthechaincanleadtosubtleerrorsorstrangemailclientbehavior.Becausenotallclientsreactcorrectlytosometypesofrefusals,andnotallclientscreatecorrectlyformedSMTPrequests,itisnotunlikelythatamisplacedrulewilllockoutsomeorallofyourclientsfromsendinglegitimatemail.Itcouldalsoleadtoopeningaholeinyourspamprotectionsearlyintheruleset,whichwouldallowillicitmailtopass.

ThePostfixUCEcontrolsbeginwithacoupleofsimpleyesornochecks,calledsmtpd_helo_requiredandstrict_rfc821_envelopes,bothconfiguredintheSMTP Server Optionspage.Thefirst,ifenabled,requiresaconnectingmailclienttointroduceitselffullybysendingaHELOcommand.



Thiscanstopsomepoorlydesignedbulkemailprograms.ThesecondoptionrequirestheenvelopetofittheSMTPspecificationprecisely,enforcingcompleteheaders.ThoughtheenvelopeandHELOcanbeforgedbyabulkmailer,itmaystopthemorehastilyimplementedvariants.

ThenextstageincludesthefourSMTPrestrictionsalsofoundontheSMTP Server Optionspage.Theselimitfromwhereandtowheremailwillbedelivered.Theorderoftraversalforthesefourlistsofrules:

6. Restrictions on client hostnames/addressesorsmtpd_client_restrictions7. Restrictions on sends in HELO commandsorsmtpd_helo_restrictions8. Restrictions on sender addressesorsmtpd_sender_restrictions9. Restrictions on recipient addressesorsmtpd_recipient_restrictions

EachofthesecheckscanreturnREJECT,OKorDUNNO.IfREJECT,themessagewillberefusedandnofurtherruleswillbechecked.IfOK,nofurtherrulesinthegivenrestrictionwillbecheckedandthenextrestrictionlistwillbechecked.IfDUNNO,thelistwillcontinuetoprocessthecurrentrestrictionuntilitgetsanotherresult(OKorREJECT),oruntilthelistendisreached,whichisanimplicitOK.IfalllistsreturnOK,themessagewillbepassedtotheregularexpressionschecks,otherwiseitwillberejected.

Nextaretheregularexpression-basedheader_checksandbody_checks.Theseoptions,ifenabled,provideameanstotesttheactualcontentsoftheheadersandthebodyoftheemail,respectively.Bothoperateinthesameway,buttheyshouldbeusedsomewhatdifferently.Headercheckscanbeusedtopreventwell-knownspammingdomainsfromsendingyouemail,orforstoppingsomewell-knownbulk-mailersoftware.Byenteringsomesignaturesoftheoffender,likethedomainnameortheX-mailerfieldidentifyingthesoftware,themailcanberejectedbeforethebodyisevensent.Bodychecks,thoughtheyusethesameregularexpressionsandfileformatasheaderchecks,shouldbeusedmoresparingly,asthemailmustbeacceptedbeforeitcanbechecked.Thusbandwidthiswastedonreceiptofthemail,andworse,theserverwillbeoccupiedforapotentiallylongtumeprocessingtheentirecontentsofeveryemail.Inshort,useheadercheckswheneveritisconvenientandusebodychecksonlywhenaneffectiveheadercheckcannotbedevised.OnlyREJECTorOKarepermittedforthereturnedvalues.

Note

Webmin,asofthiswriting(version1.020),doesnotprovideaccesstotheregular expressionsbasedchecks,header_checksandbody_checks.Itislikelythatanearfuture versionwillsupportthesefeatures,however.

Tutorial: Setting up a basic Postfix mail server

Aswithmostoftheserversoftwaredocumentedhere,Postfixhasanintimidatinglylargenumberofoptionsandfeatures.But,aswe’vealreadyseenwithBINDandApache,evencomplexsoftwarecanbeeasyandquicktosetupifyouknowwhattodotogetstarted.Postfixisnodifferent.Attheendofthisshortsection,you’llhaveafullyfunctioningmailservercapableofsendingandreceivingmailonbehalfofoneormoredomains.

Inmostenvironments,onlythreeconfigurationdetailsareneededtobeginprovidingmailservicewithPostfix.First,browsethetheGeneral Optionspageofthemodule.Thetoptwooptions,What domain to use in outbound mail and What domains to receive mail for,needtobeconfiguredtosuityourenvironment.



Forthefirstoption,youwilllikelywanttoselectUsedomainnameinordertoselectthedomainnameofyourserverasthesourceofemailsentfromit.Forexample,ifmymailserverisnamedmail.swelltech.comandIselectedthisoption,mailwillappeartooriginatefromswelltech.com.

Thesecondoptionspecifiesthedomainsforwhichyouwillreceiveemail.Thedefaultisprobablytoorestrictiveinthatitwillonlypermitreceiptofmailto$mydomainnameandlocalhost.$mydomain,ortheserveritself.Whilethisdependsonyourenvironmentandneeds,itislikelyyouwillwanttoaddthe$mydomainvariabletothelistofaccepteddomains.

ThelaststeptomakingPostfixfullyfunctionalforsendingandreceivingmailistoensuretheLocal networksparameterissetappropriately.Ifyouonlyhaveonenetworkblock,thiswillalreadybesetappropriately,asthedefaultistoacceptmailfordeliveryfromallattachednetworks(i.e.,allconfiguredandactivenetworkaddresses).However,ifyouhaveapublicandprivatenetworkinterface,you’lllikelywanttoremovetothepublicinterfacetopreventotherclientsofyourISPfrombeingabletorelaymailthroughyourserver.

ClicktheSave and Applybuttontomakeyourchangestakeeffect.Itisagoodideatotestyourchangestomakesurethingsareworkingasintended.AssuminganappropriateDNSMXrecordhasalreadybeenconfigured,asdiscussedintheBINDtutorials,youcansendyourselfanemailatthenewdomain.WatchthemaillogintheSystem Logsmoduleforerrorsandtoseeifthemessageisdelivered.Next,configureyourmailclienttosendthroughyournewmailservertoensureitisworkingforsendingmail.Themaillogwilllikelygivecluesaboutwhatiswrongintheeventofproblems.

Tutorial: Virtual Hosting email with Postfix

Ifyou’veperformedtheconfigurationintheprevioustutorial,you’llbeabletoacceptmailforanynumberofdomains.However,thisisnotthesameasprovidingindependentvirtualhostingsupportwithPostfix.Youcanonlyhaveoneuserofagivennameandmailsenttothatusernameatanyofthedomainsforwhichyouacceptmailwillbedelivered.Forexample,ifyouhostedswelltech.com,penguinfeet.organdnostarch.comonthesameserver,andmailwassenttouserjoeateachofthosedomains,allthreewouldendupinthesamemailbox.Therefore,youhavetointroduceanotherlayertosolvethisproblem.

Postfixhastwocommonlyusedmethods.ThefirstisthenativePostfixmethod,usingavirtualtabletodirectmailtothecorrectdestination.ThesecondmethodismodeledafterthewaySendmailhandlestheproblemandisalotmorecomplex.Becausesimplicityisbetterthancomplexity,you’lllearnthenativePostfixmechanismexclusively.ThePostfixvirtualmanpagecoversbothmethodsinmoderatedetail.IfyouhaveanolderSendmailinstallationthatisbeingconvertedtoPostfix,youmaywishtousethesecondmethodandmaintainyourcurrentvirtualmailconfiguration.Ifyouwillberunninganextremelylargenumberofvirtualdomains,itislikelypreferabletousethesecondmethod,aswell.

ThefirststepforsettingupvirtualdomaindeliveryistocreateavirtualmaptableusingtheVirtual Domainspage.Enterthemaptype(hash,dbm,etc.),followedbythefilenameoftheflatfilethatwillcontainthetableinformation.Forexample,youcoulduse/etc/postfix/virtualforthispurpose.Thisisaprettycommonlocationforthisfile. Saveandapplythechange,andreturntotheVirtual Domainspage.ClicktheNew mapping button.Youfirsthavetocreateagenericmapforthenewdomain.FortheNamefield,enteryourvirtualdomainname.IntheMaps to...field,youcantechnicallyenteranythingyoulike(aslongasweentersomething).Thecustomseemstobetoenter“virtual”inthisfield,asthatisitspurpose.



ClickSavemappingtoaddittothevirtualtable.

Next,addapostmasteralias,asallmailserversmusthaveafunctioningpostmasteraddresstobecompliantwiththerelevantRFC.ClickNewmappingagain.Thistime,[email protected],wherevirtual.domainisthenameofyourdomain.EnterpostmasterintotheMaps to...fieldsothatmailtothisaddresswillbemappedtothelocalpostmasteraddressfornormaldelivery.

You’rereadytostartaddingyourvirtualdomainuserstothetable.Onceagain,createanewmapping.FillinyournewvirtualdomainmailaddressintheNamefield.Forexample,[email protected],enterthenameofalocaluserthatyouwouldliketoreceivemailforthisaddress.Inthiscase,youwouldusevirtual-joeorperhapsvirtual.domain.joe.Thisnewlocalusermustexistformailtobedelivered,thereforeyou’llneedtoaddthenewusertothesystem.

Now,Save and Applyyourchanges,andtestitout:Thevirtualmapscanbehandledbyvariousdatabasetypes,orexportedtoanLDAPdatabase.Thereisnoreasonablelimittothenumberofvirtualusersanddomainsyoucanhave.



21 Virtual Instance Setup Guide

21.1 Initial Configuration

ToolVox Virtual Machine Specifications: 500 GB Hard Drive, 2 Processor and 1 GB or RAM

Afterimportingtheappliancebutbeforestartingit,youwillneedtotakeafewstepstoconfigureyournewvirtualmachine.

1. Connectthemachine’snetworkporttoyournetwork.SinceyouwillbeconnectingSIPphonestotheinstance,youmustnotconfigurethenetworkportasNAToranothernetworktypethatobstructscommunication.Bridgedmodeorsimilarisagoodchoice.

2. EnsurethatDHCPserviceisavailableonthenetworkthatisconnectedtothevirtualma-chine.ToolVox®willrequestaDHCP-providedIPv4addressbydefault.IfyoudonothaveDHCPservice,youmaymanuallyconfigurenetworkingafterpowerup.

Oncethesestepsarecomplete,youmaypowerupthevirtualmachine.YoumaydeterminetheIPaddressithasobtainedeitherviayourDHCPleasetableorbylogginginviathevirtualmachineconsole.Signinwithyourusername(cbadmin)andpassword(CodeBlue92),andissuethecommand:ifconfigeth0.

TheIPaddress,ifconfigured,willappearafterinternetaddress.

21.2 Manual Network Configuration

Manualnetworkconfigurationcanbeaccomplishedviathevirtualmachineconsoleoncethemachineispoweredup.Signinwithyourusername(cbadmin)andpassword(CodeBlue92),andissuesudosystem-config-networkattheprompt.Fromhere,youcanconfigureeth0withstaticIPv4information,aswellasprovidesystemDNSconfiguration.Onceyou’veenteredyourconfiguration,issuesudo/etc/init.d/networkrestarttoapplychanges.

21.3 Licensing

Thevirtualapplianceisshippedunlicensed.ToolVox®licensekeysaresystem-locked.Becausewecannotpredictyourvirtualizationenvironment,youwillneedtoprovideuswithanidentifierthatletsusprovideyouwithasoftwarelicense.

1. NavigatetotheIPaddresswithyourwebbrowser.2. ClickToolVox®Administration.3. Signinwithusername(admin)andpassword(codeblue).4. Intheleft-handnavigationbar,underCodeBlueSoftware,clickLicenseKeyAdministration.5. CopyandpastethevaluesforSystemUUIDandToolVox®IDandprovideittoCodeBlue

support.Wewillprovideyouwithalicensekeythatyoucanthenpasteintothelicensekeyfield.

Atthispoint,contactSolutionsorTechnicalSupporttoschedulearemoteToolVox®ConfigurationandtrainingSession.technicalsupport@[email protected]



22 Download Information

Download Information

CSC-132-G

Code Blue now has a centralized location where you can find installation, setup, information, configuration and operation instructions. 1. Centry® AdministratorGuide:www.codeblue.com/resources/guides 2. CB1SeriesAdministratorGuide:www.codeblue.com/resources/guides 3. CB2SeriesAdministratorGuide:www.codeblue.com/resources/guides 4. CB4SeriesAdministratorGuide:www.codeblue.com/resources/guides 5. CB5SeriesAdministratorGuide:www.codeblue.com/resources/guides 6. CB9SeriesAdministratorGuide: www.codeblue.com/resources/guides 7. CBRT AdministratorGuide: www.codeblue.com/resources/guides 8. Phone Enclosures AdministratorGuide:www.codeblue.com/resources/guides 9. Stainless Steel Maintenance Guide:www.codeblue.com/support 10. IA4100AdministratorGuide:www.codeblue.com/resources/guides 11. IP5000 AdministratorGuide: www.codeblue.com/resources/guides 12. IP1500/2500 AdministratorGuide: www.codeblue.com/resources/guides 13. ToolVox® X3 AdministratorGuide:www.codeblue.com/resources/guides 14. PublicAddressAdministratorGuide: www.codeblue.com/resources/guides 15. BlueAlert® MNS User Guide: www.codeblue.com/resources/guides 16. BlueAlert® EMS User Guide:www.codeblue.com/resources/guides 17. IP1500/IP2500Firmware: www.codeblue.com/support/firmware 18. IP5000Versions1.X&2.XFirmware: www.codeblue.com/support/firmware

For Legacy Product Information: www.codeblue.com/legacy-products Theseguidesshouldcontainalltheinformationneededforyourapplication.Iffurtherinformation is required, [email protected].

Documents

Administrator Guide - Code Blue Corporation--Emergency ...Administrator Guide 3 Configuring Server Settings Warning: Advanced knowledge of the ToolVox system is required before making