MultiDirectory Installation and Configuration Guide

Transcription

1 MultiDirectry Installatin and Cnfiguratin Guide Versin 1.03 STANDARD and PRO Versins

2 What des the applicatin d? MultiDirectry applicatin frm DminCmms allws Cisc IP Telephnes t have a single directry displayed t the end users whilst prviding hidden back end cmplex algrithms frm multiple Cisc Unified CallManager (CUCM) clusters and / r multiple LDAP/AD servers. The directry applicatin lks identical t the Cisc directry search. The fllwing scenari s are easily available within the applicatin: - Scenari 1 Custmer has a single CUCM cluster and has 5 LDAP/AD servers wrldwide. The custmer has then cnfigured a single search screen available t all users. Scenari 2 Custmer has 2 CUCM clusters and has 2 LDAP/AD servers. The custmer has then cnfigured users in the 1 cluster t nly see users in the LDAP/AD servers and users in the Department Sales n the CUCM clusters. Users cnfigured in the 2 nd cluster can nly see the results frm 1 AD server and any user acrss the 2 CUCM clusters that have Alan White as their Manager. Scenari 3 Custmer nly has CUCM clusters within the slutin and wishes t search live data frm these clusters r alternatively may wish t have each cluster s directry acquired t the applicatin server and stred lcally. Scenari 4 Custmer has 3 clusters wrldwide; hwever n user details are laded t these clusters. All user searches are perfrmed against the 3 LDAP/AD servers lcated in each regin. Each user can specifically request t search this lcal regin r all regins as required. In this cnfiguratin n LDAP servers are searched and n Cisc Unified CallManager servers will be cnfigured. Installatin Overview This dcument describes the installatin f the MultiDirectry Phne Applicatin frm DminCmms. Dwnlad the required packages as instructed n the website. The fllwing shuld have been dwnladed t a temprary lcatin n yur machine: -

3 PhneDirectryGuide.dc Apache_ win32.x86-penssl-0.9.8i.msi Php win32-installer.msi MultiDirectry.zip Web Server Prt Availability Ensure that prt 80 is available n the machine, t check perfrm the fllwing: - Run cmd.exe Nw run netstat an The fllwing shuld nt be displayed: - Prt Lcal Address Freign Address State TCP : :0 Listening If it is displayed then typically this is the standard Micrsft Web Publishing. T disable run services.msc and navigate t Wrld Wide Publishing Service then set this t disabled. Yu may clse the CMD.exe windw T install Apache Duble click the Apache_ win32.x86-penssl-0.9.8i.msi file t start the Apache Install Click Next Read (as required) the license agreement, accept and click next Read (as required) the Read This First and click next Enter the fllwing details, r change t yur cmpanies crrect settings: - Netwrk Dmain: Server Name: SERVER Administratr test@test.cm Leave as set fr all users Select typical installatin (unless advanced user) Leave the installatin lcatin as is (unless advanced user) Click Install Once cmplete click Finish Installatin f the PHP Framewrk Launch the Php win32-installer.msi Click Next Accept the terms and cnditins, click next Leave PHP installatin lcatin at default (unless advanced user) and click next

4 Select Apache 2.2.X Mdule and click next Nw brwse t the fllwing lcatin (Flder Name) and say k: - C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\cnf\ Click Next t cnfirm lcatin Careful: Nw expand extras by clicking n the (+) symbl n the tree, this will list the available extras. Nw click n the fllwing entries (will currently have a red crss next t it, then select Will be installed n lcal hard drive. Bcmpiler Curl GD2 Pecl_http LDAP OpenSSL SMTP SNMP SOAP Sckets Ssh2 Click Next Click Install and then Finish Yu shuld nw restart Apache. This is usually achieved thrugh the Apache icn in the right hand system tray Running all Apache Services. Once pened a restart ptin is presented and shuld be selected. Nw acquire the MultiDirectry.zip file frm DminCmms and expand in the fllwing directry: - C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\ The expansin f this zip will created the fllwing directry and file structure (check that this is the case): - C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\dcmmsdir.php C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\inip.php C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\axl60\ C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\axl61\ C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\axl70\ C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\axl71\ C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\axl80\ C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\axl85\ Nte: The abve axlxx directries will cntain a number f files related t the versin f Cisc Unified CallManager. Further axlxx files will be released when new versins f Cisc

5 Unified CallManager are released. Fr further infrmatin n this please cntact supprt@dmincmms.cm Licensing The applicatin will run withut a valid license key fr the purpses f building and testing the applicatin. The cmplete applicatin will perfrm, hwever every 2 nd name displayed n the IP Telephne will be preceded by the wrd DEMO. I hpe yu like the applicatin please test it and then purchase it. The license key shuld be installed in the fllwing directry: - C:\dmincmms\PhneDirectry\dcmmsdir.txt The fllwing sectin shws where t add the crrect licensedt, licensetype and licensekey fields. Cnfiguratin The fllwing sectin prvides details n the cnfiguratin file required fr this applicatin t successfully run. The cnfiguratin file is lcated at the fllwing lcatin: - C:\dmincmms\PhneDirectry\dcmmsdir.txt There are 5 sectins t the cnfiguratin file as fllws: - Sectin 1: Default glbal parameters Sectin 2: CUCM parameters Sectin 3: LDAP parameters Sectin 4: Grupings Sectin 5: Digit manipulatin rules (PRO versin nly) Nte: Each variable within the cnfiguratin must be lwercase and each variable must be cnfigured. The applicatin will fail returning a XML parse errr t the user where a cnfiguratin errr is made. Please see the debugs fr mre infrmatin as t what is missing. Sectin 1: Default Glbal Parameters The 1st part being the general cnfiguratin and wuld typically lk like the fllwing: -! 05/03/2012 Versin validsubnets= /32, /8, /12, /16

6 serverip= serverprt=80 debug=7 licensedt=dmincmms licensetype=pro licensekey=a3c81bba212f9576fa5a79cbd84e64e76a44582e searchlimit=50 maxruntime=60 minsearch=2 Key Descriptin! Any line prceeded with this symbl will be ignred. Useful fr ntes within the cnfiguratin file validsubnets= Specific the subnets that the applicatin can respnd t. A default wuld be: /32, /8, /12, /16 serverip= The IP Address f the server running the dcmmsdir.php applicatin serverprt= The Apache prt where the service is running. This is typically prt 80. debug= The debug level, useful fr understanding what is happening within the applicatin licensedt= Wh is the registered wner f the sftware. licensetype= This is the license type either STANDARD r PRO. The data shuld be entered exactly as supplied. The PRO versin prvides the ability t perfrm extensive digit manipulatin ver the STANARD versin. licensekey= The key supplied by Dmincmms t remve the applicatin frm Dem mde. The value can be left blank in dem mde. In dem mde every 2 nd entry within the return screen t the IP telephne will add the wrd dem searchlimit= The maximum amunt f returns frm EACH f the specific search lcatins maxruntime= Hw many secnds shuld the applicatin run fr befre stpping. Smetimes there can be big delays befre an LDAP server respnds. This parameter will stp executin after X secnds. It is un-advisable t set this value t anything t large r 0 (which means n timeut). minsearch= The minimum amunt f characters supplied t all fields befre a valid search will be perfrmed. This message will display in the bttm f the search screen. It is recmmended that a value f 2 is supplied.

7 The 2 nd part f the cnfiguratin file cntains the Cisc Unified CallManager (CUCM) r LDAP searches. Yu can have multiple f either (r nne at all). Each gruping starts with an ascending number which can be used later t build the search prfiles. Sectin 2: CUCM Parameters Use this sectin if yu wish t cnfigure a single r multiple CUCM cluster(s) t yur search base. The fllwing shws the build f a CUCM parameters: - 2.callmanager= , axlusername=administratr 2.axlpasswrd=*SECURED*Q%81%C0%8Csd%CEpf%AD%B1sssud%8E 2.axlversin=7.1 2.field=Manager 2.fieldvalue=Manager1 2.numchange=4,555 2.stre=LOCAL Nte: The prceeding number (in this case 2) fllwed by a full stp indicates that this is CUCM (r later LDAP) cluster number is 2. Each separate cluster shuld be allcated a unique number. Key Descriptin callmanager= The IP addresses f CUCM servers in a single cluster that the applicatin shuld g thrugh until a successful cnnectin is made. axlusername= A username within the cluster that has AXL rights axlpasswrd= The passwrd fr the user with axl rights. The passwrd shuld be entered here immediately after the = sign in clear text. The next time the applicatin runs it will encrypt the passwrd and infrm the user f this by prefixing with *SECURED* axlversin The versin f the CUCM cluster, i.e. 6.0 r 8.5 field= The field within the CUCM directry that yu specifically wish t search fr, fr this entry. This typically wuld be Manager r Department. This can and typically is left blank (but the variable must exist within the cnfiguratin file) fieldvalue= The value t specifically search fr within the Manager r Department as abve. This can be and is typically left blank (but the variable must exist within the cnfiguratin file) numchange= Allws the manipulatin f the recvered telephne number. The first value is quantity f digits frm the right, the secnd value is the

8 stre= number t add the frnt f the recvered number. Therefre if the recvered number is and the numchange=4,555 the displayed and number t dial wuld be This ptin shuld nly be used in the STANDARD versin A blank value here will frce each required search t a remte cluster t be perfrmed live. Where the Lcal Stre prcedure is being fllwed (i.e. a prcess that can be cnfirmed t retrieve infrmatin frm certain remte clusters and set times in the day) then the parameter shuld be set t lcal. Lcal data is stred in the lcalstre.txt file. Sectin 3: LDAP Parameters Use this sectin if yu wish t cnfigure a single r multiple LDAP server(s) t yur search base. The fllwing shws the build f a LDAP search: - 5.ldaphst= ldapprt=389 5.ldaprdn=LcalUser 5.ldappasswrd=*SECURED*A%F1%FdF%CCffd%8Frp 5.ldapsearch=dc=dmincmms,dc=lcal 5.ldapreturn=I>telephnenumber,H>hmephne,M>mbile,P>pager Nte: The prceeding number (in this case 5) fllwed by a full stp indicates that this is LDAP (r earlier CUCM) cluster number is 5. Each separate cluster shuld be allcated a unique number. Key ldaphst= ldapprt= ldaprdn= ldappasswrd= ldapsearch= Descriptin The IP addresses f the LDAP server The prt number f the LDAP server. The is typically 389 The cmmn name f a user with read access rights t the LDAP server The passwrd f the user as abve. The passwrd shuld be entered here immediately after the = sign in clear text. The next time the applicatin runs it will encrypt the passwrd and infrm the user f this by prefixing with *SECURED* The search base within the LDAP scheme fr this entry

9 ldapreturn= The fields within the LDAP database that yu wish t return when a match is made prceed by a brief descriptin (such as M> r Mb>). The > character determines the delimiter between the descriptin and the actual LDAP name, i.e. IP>telephnenumber wuld return the values frm the telephnenumber field in LDAP. Sectin 4: Gruping f clusters and LDAP servers The next part f the cnfiguratin is the build f the search grups. Search grups allw yu t specifically cnfigure certain users t be limited t certain searches, typically used where security r reginal requirements are needed. Each grup is allcated an ascending number The fllwing shws 2 typically entries: - 1.grupref=1,2,3,4,6 1.grupname=CallManagers Only 2.grupref=5,7,8 2.grupname=Wrldwide LDAP nly Key grupref= grupname= Descriptin This prvides a list f grups (r single entry), separated by cmmas f the CUCM and LDAP entries that can be searched as created in sectin 2 This prvides a shrt descriptin f the grup and is displayed t the user nly when a specific grup has nt been cnfigured fr them in the services applicatin Nte: In a basic single search slutin all clusters (CUCM and LDAP servers) shuld be created in a single entry f 1 Sectin 5: Digit Manipulatin Rules This sectin is nly relevant t the PRO versin f the applicatin. Please ignre if yu are cnsidering r have purchased the STANDARD versin. The purpse f this sectin is t allw administratrs t build up a cmprehensive list f digit manipulatins that shuld be perfrmed n the returned and displayed numbers t the users. The frmat is as fllws: -

10 X.rule=Y:<pattern t search fr>:<remve qty frm left>:<remve qty frm right>:<digits t add t left>:<digits t add t right> Where: - X = the cluster number which is perfrming the search Y = the lcatin frm where the number was fund The fllwing prvides a wrking example: - 1.rule=1:0X?:0:0:9:# 1.rule=2:6XXXXX:1:0:802 1.rule=2:0X?:1:0: rule=3:5XXXX:0:0:803 1.rule=3:6XXXX:0:0:803 1.rule=9:6XXXXX:1:1:8099 S cnsider a telephne cnnected t cluster 1 (&c=1) perfrms a search (assuming here that the grup allws a search thrugh all clusters/ldap servers). The fllwing table shuld prvide an understanding f a search frm cluster 1: - Users Name The searched users hme cluster The searched users lcal number in their hme cluster Number prvided as a search result t users in cluster 1 Matches the rule n line Jhn Parker # 1 Steve Smith Steve Smith Paul Hind Paul Davis Sally Queen James Pen There is n rule n cluster 1 s n change Creatin and cnfiguratin f a lcal stre A lcal stre prvides a slutin that allws the CUCM user directry t be pulled daily (r mre frequently if required) t the lcal server t allw speed enhancements where clusters are lcated

11 sme distance apart (and where bandwidths t nt prvide sufficient nw speeds). This ptin is nly available in the PRO versin. A windws scheduled task service shuld be created t launch a web brwser t the fllwing lcatin: - Where there is a requirement t lad different clusters at different times (typically due t internatinal time differences, ensuring that sufficient bandwidth is available in dwn perids), yu may wish t lad the clusters separately. The fllwing line specifically nly prelads infrmatin frm cluster 1 (hwever it can be repeated in separate scheduled tasks fr ther clusters as required): - The infrmatin is stred in the lcal server as the file lcalstre.txt. The prcess will remve legacy data fr the cluster that it is retrieving at that time. This ensures that the data is always fresh, hwever it is imprtant the cluster is reachable at the pull time. Cnfiguratin f IP Phnes Services A typical IP Phne Service URL wuld be cnfigured as s: - Ntes: Replace the A.B.C.D with the IP Address (r name if DNS is supprted in yur netwrk and n the IP Telephnes) f the server running the dcmmsdir.php applicatin. The &g=1 can be mdified depending n what grup the user will be assigned t, r set t 0 fr ffer all grups. Fr instance if g=1 is set in the abve grupref example the CUCM r LDAP servers referenced as 1,2,3,4 and 6 will be interrgated. Where g=0 r nt set, 2 ptins will be displayed (CallManagers Only and Wrldwide LDAP Only) where the user can then select which search they wish t perfrm. The &c=1 select specifies that this service (which then is applied t the telephne) is cnnected t cluster 1. This is imprtant when using the digit manipulatin as the telephne needs t knw which rule sets t lk thrugh. Debugging

12 Setting the debug value in the cnfiguratin file higher than 0 will result in debugs being created in the fllwing directry: - C:\dmincmms\PhneDirectry\debug The debug file autmatically rles ver at a preset level and therefre there is n chance f the disk being filled by leaving this set t a value higher than 0. Therefre a maximum f 2 files will be created f size 10Mb each fr the capture f debugging infrmatin. The debug variable within the cnfiguratin file can be set between values 0 t 7. It can be useful t level the debug at level 1. Suggestins / Develpment DminCmms are always happy t receive feedback r suggestins fr any f its prducts and will happily review any special r bespke requirements t help yu gain the best integratin between the prducts. Supprt Fr any supprt queries please cntact ur supprt desk at supprt@dmincmms.cm