DC Remte Cntrl Installatin and Cnfiguratin Guide Versin 1.2
What des the applicatin d? The DminCmms Remte Cntrl applicatin allws the bulk re-cnfiguratin f Cisc IP Telephnes as if the user was present directly at the telephne. The applicatin is typically used t change n-phne cnfiguratin items such as the speed and the duplex. Alternative versins f the applicatin are available fr the cnfiguratin f 802.1x settings (as this separate applicatin als cntrls the generatin and deplyment f the secrets that are required). Installatin Overview This dcument describes the installatin f the Remte Cntrl Phne Applicatin frm DminCmms. Dwnlad the required packages as instructed n the www.dmincmms.cm website. T access the site and dwnlads yu need t have registered first. The fllwing shuld have been dwnladed t a temprary lcatin n yur machine: - DC-Remtecntrl-Manual-v1.0.dc Apache_2.2.11-win32.x86-penssl-0.9.8i.msi Php-5.2.5-win32-installer.msi RemteCntrl.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.0.0.0:80 0.0.0.0: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_2.2.11-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: 127.0.0.1 Server Name: SERVER Administratr Email: 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-5.2.5-win32-installer.msi Click Next Accept the terms and cnditins, click next Leave PHP installatin lcatin at default (unless advanced user) and click next 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 RemteCntrl.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: - C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\remtecntrl.php C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\inip.php C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\dcauthenticate.php C:\Prgram Files\Apache Sftware Fundatin\Apache2.2\htdcs\dmincmmsheader.jpg 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: - During the cnfiguratin prcess a maximum f 2 telephnes can be cnfigured at any ne time During the retrieve prcess either ther return will state DEMO The license key is available frm DminCmms supprt team nce payment has been received. 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\RemteCntrl\cnfig.txt The fllwing prvides a standard cnfiguratin: - ipaddressthisapp=172.30.1.3 appusername=admin apppasswrd=*secured*%10%7b%b1%1e%e0%28%98%16 webprtthisapp=80
debug=7 cucmip=9.1.1.1,9.1.1.2 snmppasswrd=*secured*%23y%8f%5b%e7%26%99%01%06s%d9 licensedt=dmincmmstestserver licensekey= phneusername= phnepasswrd=*secured* acquiretimeut=3 stepdelay=5 Key ipaddressthisapp= appusername= apppasswrd= webprtthisapp= debug= cucmip= snmppasswrd= licensedt= licensekey= phneusername= phnepasswrd= acquiretimeut= Descriptin The primary IP address f the server running the remtecntrl.php applicatin. Enter a username such as admin here. This will be the username t access the applicatin. Enter a passwrd wrd in clear text. This passwrd will allw access t the applicatin. Once the applicatin has run nce the passwrd in the cnfiguratin file will becme encrypted. This is the web TCP scket number fr Apache. This is nrmal set t 80. This is the debug level fr the applicatin. It is recmmended t leave this value at 7. The debug prcess cntinually ensures that a maximum f 10Mb is created befre archiving nce and starting a new file. Therefre the maximum amunt f lgging is 20Mb fr the applicatin. Enter the IP Addresses f all CUCM s within the cluster separated with cmmas. This is imprtant as IP Telephnes register t different servers depending n the cnfiguratin f the DEVICE POOL. Enter the cluster SNMP read passwrd here. Once the applicatin has run nce the passwrd in the cnfiguratin file will becme encrypted. See the sectin SNMP cnfiguratin fr mre details. Wh is the registered wner f the sftware. The key supplied by Dmincmms t remve the applicatin frm Dem mde. The value shuld be left blank in dem mde. Please see the Authenticatin Methds sectin fr mre infrmatin. Please see the Authenticatin Methds sectin fr mre infrmatin. This is the timeut when trying t cnnect t an IP telephne. A standard value f 3 (secnds) shuld be entered hwever n busy netwrks this can be
stepdelay= pwlength= increased as required. This is the delay between actins n each IP Telephne. The minimum that this value shuld be is 5 (secnds) hwever 8 (secnds) can be cnfigured n busy netwrks. Length f passwrd if the AUTO: ptin is used Creating the script files Script files shuld be created using a cmbinatin f the standard Cisc key sets cmbined with the DminCmms key sets. The key sets are pretty easy t understand and are dcumented within the Cisc website under XSI. A script must exist befre any actins can be perfrmed. Scripts shuld always start with the file name script- and be lcated in the fllwing directry: - c:/dmincmms/remtecntrl/ The fllwing demnstratin script script-100speedduplex.txt cnfigures a standard 796X phne with 100 Speed and Full Duplex: -! Init the Phne Init:Services! Get int the Settings Key:Settings! Netwrk Cnfiguratin Key:KeyPad2! G int SW Prt Cnfiguratin Key:KeyPad8! unlck the phne Key:KeyPadPund! wait 3 secnds! Press Edit Key:Sft2! Set 100/Full Key:KeyPad5! Select it Key:Sft1! Save it Key:Sft3! Select PC Prt cnfiguratin Key:KeyPad9
! Edit Key:Sft2! Select 100 Full Key:KeyPad5! Select it Key:Sft1! Save It Key:Sft3! Lck Menu Key:KeyPadPund! wait 3 secnds! Edit Key:Sft3! wait 3 secnds! Hard Reset Phne Key:KeyPadPund N.B.: A line starting with an exclamatin mark is ignred and is nly used fr anntatin within the file. N.B.: The abve file is included in the zipped release f the sftware, hwever it shuld be mved t the crrect directry as indicated abve. Premium Scripts The premium versin f the applicatin allws the aut creatin r imprt f data that can then be entered int the phne. This apprach can be extremely useful fr the remte cnfiguratin f EAP- MD5 passwrds t Cisc IP Telephnes. It is pssible via the script t either aut create a new passwrd fr each telephne whilst creating a cmma delimited file with the SEP name and the new passwrd, r alternative a pre-cnfigured file can be used fr matching SEP names t new passwrds. As an example the fllwing script will aut create new passwrds fr the telephne (in this case a Cisc 7962 handset) and create a file with the new passwrds: -! Init the Phne
Init:Services! Get int the Settings Key:Settings! Security Cnfiguratin Key:KeyPad4! G t 802.1x authenticatin Key:KeyPad6! unlck the phne Key:KeyPadPund! wait 3 secnds! Press 1 Device Authenticatin Key:KeyPad1! select enabled Key:KeyPad2! Select it Key:Sft1! Save it Key:Sft3! Select EAP-MD5 Key:KeyPad2! Enter AUTO passwrd (must be 6 chars r greater) AUTO:newfile.txt! Save It Key:Sft3! Lck Menu Key:KeyPadPund! wait 3 secnds! Edit Key:Sft3! wait 3 secnds! Hard Reset Phne Key:KeyPadPund Yu will ntice in the abve script the line AUTO:newfile.txt. This will specifically create a new file cntaining the device name and a new passwrd f the length cnfigured in the parameter pwlength.
The fllwing shws the device [SEP001C58F9BC7C] cnfigured with the passwrd [CG5q763s]: - SEP001C58F9BC7C,CG5q763s If yu already have a file with the required names and passwrds cnfigured then yu shuld use the SEARCH: functin. The fllwing script shws the SEARCH functin in actin: -! Init the Phne Init:Services! Get int the Settings Key:Settings! Security Cnfiguratin Key:KeyPad4! G t 802.1x authenticatin Key:KeyPad6! unlck the phne Key:KeyPadPund! wait 3 secnds! Press 1 Device Authenticatin Key:KeyPad1! select enabled Key:KeyPad2! Select it Key:Sft1! Save it Key:Sft3! Select EAP-MD5 Key:KeyPad2! Search thrugh the file searchfile: devicename,passwrd SEARCH:searchfile.txt! Save It Key:Sft3! Lck Menu Key:KeyPadPund! wait 3 secnds! Edit Key:Sft3! wait 3 secnds! Hard Reset Phne
Key:KeyPadPund The fllwing shws a typical searchfile.txt frmat: - SEP001C58F9BC7C,AB74as Using the abve script if the device name is fund in the file searchfile.txt then the passwrd AB74as wuld be cnfigured n the device. Authenticatin Methds There are 2 methds fr prviding authenticatin t the IP telephnes. Methd 2 is the recmmended cnfiguratin Methd 1: Within CUCM assciate every phne with a username and passwrd. If this methd is selected enter a username in the phneusername and a passwrd in the phnepasswrd parameter within the cnfiguratin file. Methd 2: Allw DminCmms t prvide secure authenticatin. T allw this t happen leave the phneusername and phnepasswrd parameters blank within the cnfiguratin file. Then n the CUCM under System > Enterprise parameters cnfigure the fllwing line replacing the address 10.1.1.1 with the IP Address f the RemteCntrl.php applicatin. Please refer t lcal system supprt t understand whether phne authenticatin is used within yur rganisatin. The DC Authenticatin Sectin prvides mre details n ways in which this methd can be incrprated with ther methds f authenticatin that may already be in place. It is als pssible (usually nly fr the purpses f testing individual phnes) t cnfigure the authenticatin n a per phne basis. The parameter can be fund n the telephne device page. The fllwing shws the required parameter under Cisc Unified CallManager 8.0: -
Please nte that typically every IP Telephne needs t have received a sft reset t accept this value. SNMP Cnfiguratin The RemteCntrl applicatin uses SNMP t gather the infrmatin f IP Telephnes cnnected within the cluster. The applicatin therefre requires t knw... Navigate t the Cisc Unified Serviceability page which can be fund at the tp right hand f the CUCM brwser. Nw navigate t the SNMP > V1/V2c > Cmmunity String and create a single read nly passwrd fr each server within the cluster. These changes are nt typically service affecting hwever cnsult yur lcal supprt teams fr mre infrmatin. The passwrd fr all servers must be the same and then cnfigured in the cnfig.txt file under the parameter: snmppasswrd
DC Authenticatin The DC Authenticatin applicatin has been included within the build f this applicatin. DC authenticatin prvides a high speed, lw cnfiguratin slutin t the authenticatin f the IP telephnes using specially created usernames and passwrds hidden frm the CUCM. The applicatin cnfiguratin file shuld be created in the fllwing lcatin: - C:/DminCmms/DCauthenticatin/ The cnfiguratin file must be called dcauthenticate.txt. The fllwing shws a typical cnfiguratin: - validsubnets=127.0.0.1/32,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16 debug=7 cucmipaddr=172.30.1.110 cucmipprt=8080 verride=0 The fllwing table shws what the abve parameters d within the applicatin: - N.B. It is imprtant t check when creating new text (.txt) files whether Windws is currently hiding the extensin frm yu. If yu are hiding extensins (which is default) then it can be easy t incrrectly create the file dcauthenticate.txt.txt, which will cause the file nt t be fund and thus the authenticatin will fail. Key validsubnets= debug= cucmipaddr= cucmipprt= Descriptin These are the valid subnets f the telephnes wishing t authenticate against this applicatin This is the debug level fr the applicatin. It is recmmended t leave this value at 7. The debug prcess cntinually ensures that a maximum f 10Mb is created befre archiving nce and starting a new file. Therefre the maximum amunt f lgging is 20Mb fr the applicatin. This the IP address f a valid CUCM server that can prvide further authenticatin if the applicatin detects that the authenticatin was nt created internally. This is the authenticatin web prt f the CUCM, usually cnfigured at prt 8080.
verride= A default value f 0 frces full security. Fr testing purpses a value f 1 will ALWAYS return authenticated which is nt recmmended in a prductin envirnment. Launching the applicatin Open a web brwser n the server where the applicatin is installed and brwse t the fllwing lcatin: - http://10.1.1.1/remtecntrl.php N.B. Replace the 10.1.1.1 with the primary IP address f the server. Once yu have navigated t the crrect page, the fllwing shuld be displayed: - Debugging Setting the debug value in the cnfiguratin file higher than 0 will result in debugs being created in the fllwing directry: - C:/dmincmms/RemteCntrl/debugs
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. 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