traffic_shaper_wizard.xml
part of pfSense (http://www.pfsense.org/)
Copyright (C) 2005 Bill Marquette - bill.marquette@gmail.com.
Copyright (C) 2008 Ermal Luci
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/91pfSense Traffic Shaper WizardtrueThis wizard will guide you through setting up the pfSense traffic shaper.Enter number of WAN connectionsnumberofconnectionsinput^[0-9]+$Number of connections you haveezshaper->step1->numberofconnectionsNextsubmitstep1_submitphpaction();/usr/local/www/wizards/traffic_shaper_wizard.inc2pfSense Traffic Shaper WizardShaper configurationstep2_stepbeforeformdisplay();step2_stepsubmitphpaction();/usr/local/www/wizards/traffic_shaper_wizard.incNextsubmit3pfSense Traffic Shaper WizardVoice over IPEnablecheckboxPrioritize Voice over IP trafficThis will raise the priority of VOIP traffic above all other traffic.ezshaper->step3->enableNextsubmitVOIP specific settingslisttopicProviderselectChoose Generic if your provider isn't listed.ezshaper->step3->providerAddressinputalias(Optional) If this is chosen, the provider field will be overridden. This allows you to just provide the IP address of the VOIP adaptor to prioritize. NOTE: You can also use a Firewall Alias in this location.ezshaper->step3->addressIP Address field is non-blank and doesn't look like an IP address.Bandwidthinput^[0-9]*$Total bandwidth in percentage(%)(should be between 5 and 40) guarantee for VOIP traffic.ezshaper->step3->bandwidthNextsubmitstep3_stepbeforeformdisplay();step3_stepsubmitphpaction();/usr/local/www/wizards/traffic_shaper_wizard.inc4pfSense Traffic Shaper WizardPenalty BoxtruetrueEnablecheckboxPenalize IP or AliasThis will lower the priority of traffic from this IP or alias.address,bandwidth,bandwidthspeedezshaper->step4->enableNextsubmitPenaltyBox specific settingslisttopicAddressinputaliasThis allows you to just provide the IP address of the computer(s) to Penalize. NOTE: You can also use a Firewall Alias in this location.ezshaper->step4->addressIP Address field is non-blank and doesn't look like an IP address.Bandwidthinput^[0-9]*$Speed must be numerical.ezshaper->step4->bandwidthtruetruetruetruetrueBandwidthSpeedThe limit you want to apply.selectezshaper->step4->bandwidthunitNextsubmitstep4_stepsubmitphpaction();/usr/local/www/wizards/traffic_shaper_wizard.inc5pfSense Traffic Shaper WizardPeer to Peer networkingtruetrueEnablecheckboxLower priority of Peer-to-Peer trafficThis will lower the priority of P2P traffic below all other traffic. Please check the items that you would like to prioritize lower than normal traffic.p2pCatchAll,Bandwidth,Aimster,BitTorrent,BuddyShare,CuteMX,DCplusplus,dcc,DirectConnect,DirectFileExpress,EDonkey2000,FastTrack,Gnutella,grouper,hotComm,HotlineConnect,iMesh,Napster,OpenNap,Scour,Shareaza,SongSpy,WinMXezshaper->step5->enableNextsubmitp2p Catch alllisttopicp2pCatchAllcheckboxWhen enabled, all uncategorized traffic is fed to the p2p queue.ezshaper->step5->p2pcatchallBandwidthinput^[0-9]*$Speed must be numerical.ezshaper->step5->bandwidthtruetruetruetruetrueBandwidthSpeedThe limit you want to apply.selectezshaper->step5->bandwidthunitEnable/Disable specific P2P protocolslisttopicAimstercheckboxAimster and other P2P using the Aimster protocol and portsezshaper->step5->aimsterBitTorrentcheckboxBittorrent and other P2P using the Torrent protocol and portsezshaper->step5->bittorrentBuddySharecheckboxBuddyShare and other P2P using the BuddyShare protocol and portsezshaper->step5->buddyshareCuteMXcheckboxCuteMX and other P2P using the CuteMX protocol and portsezshaper->step5->cutemxDCpluspluscheckboxDC++ and other P2P using the DC++ protocol and portsezshaper->step5->dcplusplusDCCcheckboxirc DCC file transfersezshaper->step5->dccDirectConnectcheckboxDirectConnect and other P2P using the DirectConnect protocol and portsezshaper->step5->directconnectDirectFileExpresscheckboxDirectFileExpress and other P2P using the DirectFileExpress protocol and portsezshaper->step5->directfileexpresseDonkey2000checkboxeDonkey and other P2P using the eDonkey protocol and portsezshaper->step5->edonkey2000FastTrackcheckboxFastTrack and other P2P using the FastTrack protocol and portsezshaper->step5->fasttrackGnutellacheckboxGnutella and other P2P using the Gnutella protocol and portsezshaper->step5->gnutellagroupercheckboxgrouper and other P2P using the grouper protocol and portsezshaper->step5->grouperhotCommcheckboxhotComm and other P2P using the hotComm protocol and portsezshaper->step5->hotcommHotlineConnectcheckboxHotlineConnect and other P2P using the HotlineConnect protocol and portsezshaper->step5->hotlineconnectiMeshcheckboxiMesh and other P2P using the iMesh protocol and portsezshaper->step5->imeshNapstercheckboxNapster and other P2P using the Napster protocol and portsezshaper->step5->napsterOpenNapcheckboxOpenNap and other P2P using the OpenNap protocol and portsezshaper->step5->opennapScourcheckboxScour and other P2P using the Scour protocol and portsezshaper->step5->scourShareazacheckboxShareaza and other P2P using the Shareaza protocol and portsezshaper->step5->shareazaSongSpycheckboxSongSpy and other P2P using the SongSpy protocol and portsezshaper->step5->songspyWinMXcheckboxWinMX and other P2P using the WinMX protocol and portsezshaper->step5->winmxNextsubmitstep5_stepsubmitphpaction();/usr/local/www/wizards/traffic_shaper_wizard.inc6pfSense Traffic Shaper WizardtrueNetwork GamesEnablecheckboxPrioritize network gaming trafficThis will raise the priority of gaming traffic to higher than most traffic.BattleNET,Battlefield2,CallOfDuty,Counterstrike,DeltaForce,DOOM3,EmpireEarth,Everquest,Everquest2,FarCry,GunZOnline,HalfLife,HalfLife2,Halo2,Lineage2,PlanetSide,QuakeIII,TigerWoods2004PS2,UnrealTournament,WolfensteinEnemyTerritory,WorldOfWarcraft,XBox360trueezshaper->step6->enableNextsubmitEnable/Disable specific gameslisttopicBattleNETcheckboxBattle.net - Virtually every game from Blizzard publishing should match this. This includes the following game series: Starcraft, Diablo, Warcraft. Guild Wars also uses this port.ezshaper->step6->battlenetBattlefield2checkboxBattlefield 2 - this game uses a LARGE port range, be aware that you may need to manually rearrange the resulting rules to correctly prioritize other traffic.ezshaper->step6->battlefield2CallOfDutycheckboxCall Of Duty (United Offensive)ezshaper->step6->callofdutyCounterstrikecheckboxCounterstrike. The ultimate 1st person shooter.ezshaper->step6->counterstrikeDeltaForcecheckboxDelta Forceezshaper->step6->deltaforceDOOM3checkboxDOOM3ezshaper->step6->doom3EmpireEarthcheckboxEmpire Earthezshaper->step6->empireearthEverquestcheckboxEverquest - this game uses a LARGE port range, be aware that you may need to manually rearrange the resulting rules to correctly prioritize other traffic.ezshaper->step6->everquestEverquest2checkboxEverquest IIezshaper->step6->everquest2GunZOnlinecheckboxGunZ Onlineezshaper->step6->gunzonlineFarCrycheckboxFar Cryezshaper->step6->farcryHalfLifecheckboxHalfLifeezshaper->step6->halflifeHalfLife2checkboxHalfLife 2ezshaper->step6->halflife2Halo2checkboxHalo2 via Xbox liveezshaper->step6->halo2xboxLineage2checkboxLineage IIezshaper->step6->lineage2PlanetSidecheckboxPlanetSideezshaper->step6->planetsideQuakeIIIcheckboxQuake IIIezshaper->step6->quakeiiiTigerWoods2004PS2checkboxTiger Woods 2004 for PS2ezshaper->step6->tigerwoods2004ps2UnrealTournamentcheckboxUnreal Tournamentezshaper->step6->unrealtournamentWolfensteinEnemyTerritorycheckboxWolfenstein Enemy Territoryezshaper->step6->wolfetWorldOfWarcraftcheckboxWorld of Warcraftezshaper->step6->wowXbox360checkboxXBox 360ezshaper->step6->xbox360Nextsubmit/usr/local/www/wizards/traffic_shaper_wizard.inc7pfSense Traffic Shaper WizardtrueRaise or lower other ApplicationsEnablecheckboxOther networking protocolsThis will help raise or lower the priority of other protocols higher than most traffic.AIM,AppleRemoteDesktop,DNS,HTTP,ICMP,ICQ,IMAP,IPSEC,IRC,Jabber,LotusNotes,MSN,MSRDP,MySqlServer,PCAnywhere,POP3,PPTP,RTSP,SMB,SMTP,SNMP,StreamingMP3,TeamSpeak,VNC,NNTP,CVSUP,Slingbox,HBCItrueezshaper->step7->enableNextsubmitRemote Service / Terminal emulationlisttopicMSRDPselectezshaper->step7->msrdpMicrosoft Remote Desktop ProtocolVNCezshaper->step7->vncselectVirtual Network ComputingAppleRemoteDesktopezshaper->step7->appleremotedesktopselectApple Remote DesktopPCAnywhereezshaper->step7->pcanywhereselectSymantec PC AnywhereMessengerslisttopicIRCselectezshaper->step7->ircInternet Relay ChatJabberselectezshaper->step7->jabberJabber instant messangerICQezshaper->step7->icqselectICQAIMezshaper->step7->aolinstantmessengerselectAOL Instant MessengerMSNezshaper->step7->msnmessengerselectMSN MessengerTeamspeakezshaper->step7->teamspeakselectTeamSpeakVPNlisttopicPPTPselectezshaper->step7->pptpMicrosoft Point to Point tunneling protocolIPSECselectezshaper->step7->ipsecIPSEC VPN trafficMultimedia/StreaminglisttopicStreamingMP3selectezshaper->step7->streamingmp3Streaming MediaRTSPezshaper->step7->rtspselectRealTime streaming protocolWeblisttopicHTTPselectezshaper->step7->httpHTTP and HTTPS aka Web TrafficMaillisttopicSMTPselectezshaper->step7->smtpMail ProtocolPOP3selectezshaper->step7->pop3POP3 ProtocolIMAPezshaper->step7->imapselectIMAP ProtocolLotusNotesezshaper->step7->lotusnotesselectLotus NotesMiscellaneouslisttopicDNSselectezshaper->step7->dnsDomain Name ServicesICMPezshaper->step7->icmpselectICMP ProtocolSMBezshaper->step7->smbselectMicrosoft SMB Protocol and friendsSNMPezshaper->step7->snmpselectSimple Network Management ProtocolMySQLServerezshaper->step7->mysqlserverselectMySQL ServerNNTPezshaper->step7->nntpselectInternet NewsCVSUPezshaper->step7->cvsupselectCVSUPSlingboxezshaper->step7->slingboxselectSlingboxHBCIezshaper->step7->hbciselectHBCINextsubmit/usr/local/www/wizards/traffic_shaper_wizard.inc8pfSense Traffic Shaper WizardReload profile noticelisttopic After pressing Finish the system will load the new profile.<br/> Please note that this may take a moment.<br/> Also note that the traffic shaper is stateful meaning that only new connections will be shaped.<br/> If this is an issue please reset the state table after loading the profile.<br/>Finishsubmitstep8_stepsubmitphpaction();/usr/local/www/wizards/traffic_shaper_wizard.inc9pfSense Traffic Shaper WizardFinishsubmit/usr/local/www/wizards/traffic_shaper_wizard.incstep9_stepsubmitphpaction();