Background Deployment 3.

1 (1022)
Installation and Administration Guide

2010 VoIP Integration

May 14, 2013

Table of Contents
ProductOverview.........................................................................................................................................3
Personalization..........................................................................................................................................3
KeyPress...................................................................................................................................................3
Requirements................................................................................................................................................4
ApplicationRequirements........................................................................................................................4
CallManager.............................................................................................................................................4
NetworkConnectivity...............................................................................................................................4
InstallationProcess.......................................................................................................................................5
LoadingBackgroundDeployment.............................................................................................................5
ApplicationUse.............................................................................................................................................7
DeploymentMethodComparison............................................................................................................7
LaunchingBackgroundDeployment.........................................................................................................7
LoadingyourLicenseKey..........................................................................................................................7
ClustersConnectingtoandSaving.........................................................................................................8
CallManagerAdministrationUser........................................................................................................8
UseofBackgroundDeploymentFeatures................................................................................................9
Settings.................................................................................................................................................9
DeviceGroups.....................................................................................................................................10
Groups.............................................................................................................................................10
ImageSelectionandEditing................................................................................................................12
LocalImageSelectionandEditing...................................................................................................12
TFTPImageSelection......................................................................................................................13
UploadtoTFTP................................................................................................................................14
DeployBackgrounds...........................................................................................................................15
Results.................................................................................................................................................16
Summary.........................................................................................................................................16
Completed.......................................................................................................................................16
Failures............................................................................................................................................17
AppendixA:CallManagerPreRequisiteConfiguration.............................................................................18
AXLService..........................................................................................................................................18
AXLUser..............................................................................................................................................19
UsingBackgroundDeploymentwithCallManager8andabove.......................................................21

BackgroundDeployment3.1|InstallationandAdministrationGuide 2

Product Overview

VoIPIntegrationBackgroundDeploymentisautilitywhichallowsyoutodeploybackgroundimagesto
Ciscophonesfromanywherewithnetworkconnectivity.
TheBackgroundDeploymentToolprovidestheabilitytocreategroupsofphonestoreceiveimages,
groupscanencompassindividualdevices,devicepools,locations,partitions,callingsearchspacesand
extensionsorextensionranges.
Asimpleimageeditinginterfaceletsyoucropandzoom,flipandrotateanyimagetothecorrectfile
formatanddimensionsforthedifferentphonemodels.Easilyintegrateyourimagesintotheserver
list.xmlfilewiththeabilitytouploadthelistandimagesbuiltintoBackgroundDeployment.
Anadvancedschedulingengineallowsyoutodeploytheimagetothousandsofphonesasfastasyour
networkwillallow.

Personalization

ThepersonalizationmethodisanonintrusivemethodthatforcestheIPphonestorequesta
backgroundimagefromtheHTTPserverthatrunsinBackgroundDeployment.ThismeansthattheIP
PhonesmusthavenetworkconnectivitytothePCrunningBackgroundDeploymenttodownloadthe
newimage.Usingthepersonalizationmethod,thebackgroundimagesdonotneedtobeuploadedto
theTFTPserver,thismeansthatyoucantestimagesthatotheruserscannotdeploytotheirphones.
ThepersonalizationmethodistherecommendedmethodtousewithBackgroundDeploymentforCall
Managerserversstartingatversion6.0(1)

Key Press

Thekeypressmethodisaslightlymoreintrusivemethodthatimitatesauserpressingthe
requiredkeysonthephonetochangethebackgroundimage.TheimagesmustbeplacedontheTFTP
serverbeforeusingthismethodasthephonesgettheimagedirectlyfromtheCallManagerserver.This
methodcanbeinterruptedifauserpressesanykeyswhiletheimageisbeingdeployed.
ThekeypressmethodistherecommendedmethodfordeployingbackgroundimagesbeforeCall
Manager6.0(1)

BackgroundDeployment3.1|InstallationandAdministrationGuide 3

Requirements
Application Requirements

WindowsPCwithMicrosoftDotNet3.5orgreater

Note:WindowsemulationonMacintoshisnotsupported

Call Manager

CallManager5+(TestedonCallManager5through9)
CallManageruserwithAXL,RISandUserAdminpermissions
AXLServiceactivatedandrunningonCallManagerServer.

Network Connectivity

ThePCrunningBackgroundDeploymentmustbeabletoconnecttothephoneonaTCP80.

ThePCrunningBackgroundDeploymentmustbeabletoconnecttotheCallManageronTCPport8443

ThephonemustbeabletoreachitsAuthenticationURLandthePCrunningBackgroundDeploymenton
aportthattheusercanchoose.Thedefaultportis80
(Seethetroubleshootingsectionformoreinformation)

BackgroundDeploymentshouldworkthroughNATandoverVPN.IfusingNATyoumustknowyourNAT
addressthephonescanreachyourPC.

BackgroundDeployment3.1|InstallationandAdministrationGuide 4

Installation Process
Loading Background Deployment
Tobegintheinstallation,downloadtheinstallerfromourwebsiteathttp://www.voipintegration.com.
Thendoubleclickthesavedfile.

ClickNext>

EntertheinstallationpathyouwouldlikeBackgroundDeploymentinstalledinandclick>.

BackgroundDeployment3.1|InstallationandAdministrationGuide 5


TocompletetheinstallationclickInstall.

Whentheinstallhascompleted,clickFinishtoclosetheinstaller.

BackgroundDeployment3.1|InstallationandAdministrationGuide 6

Application Use
Deployment Method Comparison
LocalImage
(Personalization)

ImageHostedonLocalPC
(RequiresNetworkConnectivityfromPhone
toPC)

CallManagerTFTP
(Personalization)

ImageHostedfromCMServer

ImagesAvailableforEndUsersthrough
PhoneSettings
DoesNotRequireTFTPServerRestartafter
EditingImages

CallManagerTFTP
(KeyPress)

NonInvasivetophoneoperation

GreatforImagePerfecting

LocalEditingofImagesBeforeDeployment

Imagesdonotneedtobelocatedonthe
CallManagerTFTPServer

SupportedonallversionofCallManager

*Requirestheimagesandlist.xmltobeuploadedtotheTFTPserver(whichcanbedonewithBackgroundDeployment3.1)

Launching Background Deployment

NavigatethroughWindowsStart>Programs>VoIPIntegrationTools>BackgroundDeployment3and
selectBackgroundDeployment.

BackgroundDeploymentwillstartupandcheckforanupgrade,itisstronglyrecommendedthatyou
clickyestodownloadtheupgradeifanyarefound.

Loading your License Key

Toenteryourlicensekeyinformation,clickontheSettingstabandlocatetheRegistrationInformation
section.EnteryourName,CompanyandRegistrationKeyexactlyasyoureceivethemintheregistration
email.Theregisteredusernameandcompanyarecasesensitive.
RegistrationInformation

BackgroundDeployment3.1|InstallationandAdministrationGuide 7

Clusters Connecting to and Saving

InordertouseBackgroundDeploymentyoumustfirstconnecttoacluster.Theclusterinformationis
savedforfutureuse.Ifyoudonotwanttosavethepasswordfieldforsecuritypurposesyoumayleave
itblankandyouwillbepromptedforthepasswordeachtimeyouconnecttothecluster.
ClusterInformation

OptionalPasswordQuery

Call Manager Administration User

EnsureyouhavemettherequirementsforenablingAXL
andassigningpermissiondescribedinAppendixA.

EnteraClusterNametodescribetheCluster.
IntheintheUsernamefield,entertheusername
withAdmin/AXLpermissions.
InthePasswordfield,enterthepassword.
ClicktheDefaultClusteroptiontoconnecttothisClusteratstartup.(optional)
EntertheOSUsernameandPassword.(optionalforuploadingtotheTFTPserverontheCall
Managerservers)
ClickSaveorConnect.
ThestatuswillindicateasuccessfulconnectionanddisplaytheversionoftheconnectedCallManager.

BackgroundDeployment3.1|InstallationandAdministrationGuide 8

Use of Background Deployment Features

Settings
TheSettingspagecontainsthefollowingsections

RegistrationInformation
Thisareaallowsyoutoenteryourregistrationinformationtounlockallofthefeaturesin
BackgroundDeployment.

UserFeedback
FeedbackForm
Thefeedbackformcanbeusedtonotifyusof
featurerequestsorsoftwarebugs.Please
includeasmuchdetailaspossibleinbugreports
includingwhatyouweredoing,howthe
applicationreactedandanythingelsethatyou
thinkmightberelevant.

ProgramVersion
TheProgramVersionsectionshowsyouwhat
versionofBackgroundDeploymentyouare
runningandallowsyoutoshutofftheupgrade
checkatprogramstartup.Youcanalsodoa
manualupgradecheckhere.

BackgroundDeployment3.1|InstallationandAdministrationGuide 9

Device Groups
Groups
BackgroundDeploymentallowsyoutocreatespecificgroupsofphonestodeployimagestobygrouping
phonesbyseveralcriteria.Tostartcategorizingyourphonesyouneedtoaddagroup.

Inclusions
TheInclusionstabiswhereyouaddrulesthatwillincludephonesintothegroup.UsetheCallManager
treeonthelefttodrilldownandaddtherulesthatencompassallofthephonesyouwanttodeployto
inasinglegroup.Toaddruleseitherdoubleclickontheruleordragitintothelistontheright.To
removearulethathasbeenaddedsimplydoubleclicktheitemorselecttheitemandpressthedelete
key.

BackgroundDeployment3.1|InstallationandAdministrationGuide 10

Exclusions
TheExclusionstabiswhereyouaddrulesthatwillexcludephonesfromthegroupofinclusionsthat
havebeenconfigured.Thisgivesyoutheabilitytoaddanentiredevicepoolandexcludeanindividual
deviceinsteadoftryingtoaddallofthephonesindividually.Toaddruleseitherdoubleclickontherule
ordragitintothelistontheright.

Refresh

Arefreshbuttonisfoundontheinclusionandexclusiontabs.Therefreshbuttonwillpolltheclusterto
updatethedevicesinthelists.

BackgroundDeployment3.1|InstallationandAdministrationGuide 11


Image Selection and Editing
BackgroundDeploymenthastwomethodsofselectinganimagetodeploytothephones.Youcan
selectandimagefromyourlocalPC/networklocationoryoucanselectanimagefromtheTFTPseveron
theCallMangerCluster.

Local Image Selection and Editing

TheLocalImageSelectionandEditingtaballowsyoutobrowseforanimageonyourlocalPCornetwork
locationandedittheselectionareaoftheimagetodeployouttothephones.
Iftheimageisnotperfectyoucanusethemousetoselectanareatouseasaselectiontodeploytothe
phone.Theupperrighthandcornerdisplaysandexampleoftheexactimagethatwilldisplayonthe
devicesthatwillbedeployedto.Ifyouselectedthewrongareayoucanzoominoroutormovethe
selectionareatosuityourneeds.

Byclickingoutsideoftheselectionareayoucancleartheselection.Byrightclickingonthepictureyou
canfliporrotatetheimageifnecessary.
Imagefilescanalsobedraggedanddroppeddirectlyfromthedesktoporfromwebbrowsersdirectly
ontothesourceimagelocation.
ImagescanalsobecopiedandpasteddirectlyintoBackgroundDeployment.

BackgroundDeployment3.1|InstallationandAdministrationGuide 12

TFTP Image Selection

TheTFTPImageSelectiontaballowsyoutoselectanimagethatislocatedontheTFTPserver.First
selectthephonetypeandthenselecttheimagetodeployouttothephones.

AfterselectingtheimagefromtheTFTPserveryoucanalsochoosetoedittheimageanddeployoutthe
imageusingthepersonalizationmethod.

YoucanalsouploadtheeditedimagetotheTFTPserverforthekeypressoption.

BackgroundDeployment3.1|InstallationandAdministrationGuide 13

Upload to TFTP
Upload
BackgroundDeploymentcanuploadyourimagesdirectlytotheTFTPserverandaddtherequired
configurationtotheList.xmlfilesothatuserscanselecttheimagesmanuallyorallowingyoutousethe
keypressoption.
Afterselectingandeditinganimageyouwillneedtochooseafilenameforthefullsizeimageandthe
thumbnailimagetobeuploadedtotheTFTPserver.Theimagescanbeuploadedtoanyserverinthe
clusterbutshouldbeuploadedtoeveryserverthatisconfiguredasTFTPsourcesforyourphones.

Edit List XML

ItemsmayberemovedfromtheList.xmlfileforeachTFTPDirectory.Toremoveoneormorerecords
fromaListfileselecttheTFTPserverandDirectorytodownloadthefile.Oncethefilecontentshave
beendisplayedselecttherecordsfordeletionandthenclicksave.

YouwillneedtorestarteachTFTPserverthathasanyfileuploadedoreditedbeforethechangeswill
takeeffectontheserver.

BackgroundDeployment3.1|InstallationandAdministrationGuide 14

Deploy Backgrounds

Todeployanimagetoagroupofphonesyouneedpopulateallofthefieldsonthedeploymentpage.
Thesefieldswilldeterminethemethodofdeployment,imageandphonesthatwillbeusedinthe
process.TheClusterName,PhoneType,andImageNamearepopulatedfromselectionsmadein
differentareasofthesoftware.
OnceaPhoneTypeandDeploymentGrouphavebeenchosenthenumberofdevicesthatmatchthe
selectedcriteriawillbedisplayedunderthesampledeploymentimage.
LocalImageDeploymentConfiguration

CallManagerImageDeploymentConfiguration

BackgroundDeployment3.1|InstallationandAdministrationGuide 15

Results
Theresultstabdisplaysinformationfromthelastorcurrentdeployment.
Summary
TheSummarypageshowstheoverallstatisticsofthedeploymentinprogressorthathasjust
completed.

Completed
TheCompletedpagedisplaysthedevicesthatreportedtohavesuccessfullyupdatedtheirbackground
image.

BackgroundDeployment3.1|InstallationandAdministrationGuide 16

Failures
TheFailurepagedisplaysthedevicesthatBackgroundDeploymentwasunabletoupdatethe
backgroundimage.Thelistwillcontainthedevicename,thedeviceIPaddressifwewereableto
determineitandthereasonforthefailure.

BackgroundDeployment3.1|InstallationandAdministrationGuide 17

Appendix A: Call Manager Pre Requisite Configuration

AXL Service

ForBackgroundDeploymenttofunctionwithCallManageryouwillneedtoensureyouhavetheAXL
serviceactiveandrunningonyourserverandwillneed.

ToValidateyouhavetheAXLservicerunning:

UseawebbrowsertoaccesstheCallManagerServiceabilitywebpage.
https://<CallManager>/ccmservice
SelecttheTools>ServiceActivationmenu
UndertheDatabaseandAdminSection
EnsurethattheCiscoAXLWebServiceisactivated.Ifnot,clickthecheckboxandthenclickthe
savebuttonatthetopofthepage.
SelectTools>ControlCenterFeatureServicesmenu
EnsurethattheCiscoAXLWebServiceisrunning.Ifnot,clicktheradiobuttonandthenclick
thestartservicebuttonatthetopofthepage.

ServiceActivation

ControlCenterFeatureServices

BackgroundDeployment3.1|InstallationandAdministrationGuide 18

AXL User

YoumaychoosetouseaCallManageradministratorusernameandpasswordwithBackground
Deploymentorassigntherequiredpermissionstoneworexistingusers.

AnyuserwhohasthegroupmembershipofStandardCCMSuperUserswillbeabletouseBackground
Deploymenttosearchandcontrolphoneswithoutaddingthefollowingprocess.

Ifyouchoosetoaddausernewgroupforpermissionsandwanttorestrictpermissionstotheminimum
required.Youwillneedtoworkthroughthefollowingprocess.Thisnewgroupcanthenbeaddedto
neworexistingendusersinCallManager.

FromwithinCallManagerAdministration

SelectUserManagement
SelectUserGroups
ClickAddNew

EnteraGroupNamesuchas(AXLAccess)
ClickSave
SelecttheAssignRoletoUserGroupfromtherelatedlinks

ClickAssignRoletoGroupbutton
AddthefollowingRole
StandardAXLAPIAccess

BackgroundDeployment3.1|InstallationandAdministrationGuide 19


ClickSave

NowfindyouruserinCallManagerAdministration,UserManagement,EndUsersandaddthegroup
createdabove,theStandardCCMAdminUsersgroupandtheStandardRealtimeAndTraceCollection
group.ThiswillallowtheusertoaccesstheAXLservicebutnoaccesstoanyoftheCallManagerAdmin
webpages.

ClickSave.

BackgroundDeployment3.1|InstallationandAdministrationGuide 20

Using Background Deployment with Call Manager 8 and above

CallManager8introducedtheabilitytoconnecttothephoneusinghttpsonsecurephones.
TheAuthorizationURL(foundundersystem>EnterpriseParameters)shouldbereachablefromthe
phone.
IfyouhaveanyhttpssettingintheSecureAuthenticationURLfield,thephonewillusethisoverthe
URLAuthenticationsetting.
IfthephoneisnotconfiguredforCAPF(CertificationAuthorityProxyFunction)thenthephonewillfail
whenattemptingtoaccesstheconfiguredHTTPSAuthenticationURL.
Ifnotusingencryptionwithinyourclusterthenitisrecommendedtoclearoutthedefaultsettingunder
System>EnterpriseParameters>SecuredPhoneParameters.

BackgroundDeployment3.1|InstallationandAdministrationGuide 21