UPnP-gw-WANConnectionDevice-v2-Device

WANConnectionDevice:2DeviceTemplateVersion1.01ForUPnPVersions1.0and1.1Status:StandardizedDCP(SDCP),Version1.00Date:September10,2010ThisStandardizedDCPhasbeenadoptedasaStandardizedDCPbytheSteeringCommitteeoftheUPnPForum,pursuanttoSection2.1(c)(ii)oftheUPnPForumMembershipAgreement.UPnPForumMembershaverightsandlicensesdefinedbySection3oftheUPnPForumMembershipAgreementtouseandreproducetheStandardizedDCPinUPnPCompliantDevices.AllsuchuseissubjecttoalloftheprovisionsoftheUPnPForumMembershipAgreement.THEUPNPFORUMTAKESNOPOSITIONASTOWHETHERANYINTELLECTUALPROPERTYRIGHTSEXISTINTHESTANDARDIZEDDCPS.THESTANDARDIZEDDCPSAREPROVIDED"ASIS"AND"WITHALLFAULTS".THEUPNPFORUMMAKESNOWARRANTIES,EXPRESS,IMPLIED,STATUTORY,OROTHERWISEWITHRESPECTTOTHESTANDARDIZEDDCPS,INCLUDINGBUTNOTLIMITEDTOALLIMPLIEDWARRANTIESOFMERCHANTABILITY,NON-INFRINGEMENTANDFITNESSFORAPARTICULARPURPOSE,OFREASONABLECAREORWORKMANLIKEEFFORT,ORRESULTSOROFLACKOFNEGLIGENCE.?2010UPnPForum.AllRightsReserved.Authors*CompanyFrédéricPennerath,GertMarynissenAlcatelFabriceFontaineOrangeLabs*Note:TheUPnPForuminnowayguaranteestheaccuracyorcompletenessofthisauthorlistandinnowayimpliesanyrightsfororsupportfromthosememberslisted.Thislistisnotthespecifications’conkeptontheUPnPForum’swebsite.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.012Contents1.OVERVIEWANDSCOPE.................................................................................................................................31.1.REFERENCES...................................................................................................................................................31.1.1.NormativeReferences............................................................................................................................32.DEVICEDEFINITIONS....................................................................................................................................62.1.DEVICETYPE..................................................................................................................................................62.2.DMODEL..............................................................................................................................................6EVICE2.2.1.DescriptionofDeviceRequirements.....................................................................................................72.2.2.RelationshipsBetweenServices.............................................................................................................72.3.THEORYOFOPERATION.................................................................................................................................83.XMLDEVICEDESCRIPTION.......................................................................................................................114.TEST...................................................................................................................................................................13ListofTablesTable1:DeviceRequirements6Table2:ValidCombinationsofLinkTypeandPossibleConnectionTypes10?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.013OverviewandScopeThisdevicetemplateiscompliantwiththeUniversalPlugandPlayArchitecture,Version1.0and1.1.WANConnectionDeviceisaREQUIREDvirtualdevicedefinedunder:urn:schemas-upnp-org:device:WANDevice:2AninstanceofWANDeviceisspecifiedundertherootdevice:urn:schemas-upnp-org:device:InternetGatewayDevice:2WANConnectionDeviceisacontainerforalinkandconnectionservicesspecifictoalinkonaWANinterface.MosttypesofWANinterfacescanbemodeledbyasingleinstanceofWANConnectionDevice.However,inthecaseofDSL,eachVCcanhaveuniquelinkattributesandcanbeprovisionedforconnectionservicesthataredifferentfromotherVCs.Inthiscase,eachVCwillbemodeledbyaninstanceofWANConnectionDevice.Also,inthecaseofaPOTSmodembasedInternetGatewayDevice(IGD),eachseparateISPinstancecanbemodeledasaninstanceofWANConnectionDevice.TheTheoryofOperationsectiondescribestheservicescontainedinWANConnectionDeviceinmoredetail.Figure1:WANConnectionDeviceDevicesandServicesHierarchy1.1.References1.1.1.NormativeReferencesThissectionliststhenormativereferencesusedinthisspecificationandincludesthetaginsidesquarebracketsthatisusedforeachsuchreference:[IGD2]–UPnPInternetGatewayDevice:2,version1.00,UPnPForum,December10,2010.Availableathttp://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.014[WANDevice]–UPnPWANDevice:2,version1.0,UPnPForum,September10,2010.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANDevice-v2-Device.pdf.[WANIPConnection]–UPnPWANIPConnection:2,version1.00,UPnPForum,September10,2010.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANIPConnection-v2-Service.pdf.WANIPv6FirewallControl]–UPnPWANIPv6FirewallControl:1,version1.0,UPnPForum,December10,2010.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANIPv6FirewallControl-v1-Service.pdf.[LANDevice]–UPnPLANDevice:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-LANDevice-v1-Device.pdf.[LANHostConfigManagement]–UPnPLANHostConfigManagement:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-LANHostConfigManagement-v1-Service.pdf.[L3Forwarding]–UPnPLayer3Forwarding:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-Layer3Forwarding-v1-Service.pdf.[WANCableLinkConfig]–UPnPWANCableLinkConfig:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANCableLinkConfig-v1-Service.pdf.[WANCommonInterfaceConfig]–UPnPWANCommonInterfaceConfig:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANCommonInterfaceConfig-v1-Service.pdf.[WANDSLLinkConfig]–UPnPWANDSLLinkConfig:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANCableLinkConfig-v1-Service.pdf.[WANEthernetLinkConfig]–UPnPWANEthernetLinkConfig:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANEthernetLinkConfig-v1-Service.pdf[WANPOTSLinkConfig]–UPnPWANPOTSLinkConfig:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANPOTSLinkConfig-v1-Service.pdf[WANPPPConnection]–UPnPWANPPPConection:1,version1.0,UPnPForum,November19,2001.Availableat:http://upnp.org/specs/gw/UPnP-gw-WANPPPConnection-v1-Service.pdf[DEVICE]–UPnPDeviceArchitecture,version1.0,UPnPForum,June8,2000.Availableat:http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0.pdf.[ISO8601]–Dataelementsandinterchangeformats–Informationinterchange--RepresentationofdatesandtimesInternationalStandardsOrganization,December21,2000.Availableat:ISO8601:2000.[RFC2119]–IETFRFC2119,KeywordsforuseinRFCstoIndicateRequirementLevels,S.Bradner,March1997.Availableat:http://tools.ietf.org/html/rfc2119.[RFC3986]–IETFRFC3986,UniformResourceIdentifier(URI):GenericSyntax,T.Berners-Lee,R.Fielding,L.Masinter,January2005.Availableat:http://tools.ietf.org/html/rfc3986.[RFC3339]–IETFRFC3339,DateandTimeontheInternet:Timestamps,G.Klyne,ClearswiftCorporation,C.Newman,SunMicrosystems,July2002.Availableat:http://tools.ietf.org/html/rfc3339.[XML]–ExtensibleMarkupLanguage(XML)1.0(ThirdEdition),Fran?oisYergeau,TimBray,JeanPaoli,C.M.Sperberg-McQueen,EveMaler,eds.,W3CRecommendation,February4,2004.Availableat:http://www.w3.org/TR/2004/REC-xml-20040204.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.015[XMLSCHEMA-2]–XMLSchemaPart2:DataTypes,SecondEdition,PaulV.Biron,AshokMalhotra,W3CRecommendation,28October2004.Availableat:http://www.w3.org/TR/2004/REC-xmlschema-2-20041028.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.0162.DeviceDefinitions2.1.DeviceTypeThefollowingdevicetypeidentifiesadevicethatiscompliantwiththistemplate:urn:schemas-upnp-org:device:WANConnectionDevice:22.2.DeviceModelProductsthatexposedevicesofthetypeurn:schemas-upnp-org:device:WANConnectionDevice:2MUSTimplementminimumversionnumbersofallrequiredembeddeddevicesandservicesspecifiedinthetablebelow.Table1:DeviceRequirementsDeviceTypeRootReq.orServiceTypeReq.orOpt.1ServiceID2Opt.1WANPOTSLinkConfig:1OforPOTSWANPOTSLinkC1modemsWANDSLLinkConfig:1OforDSLWANDSLLinkC1modemsWANCableLinkConfig:1OforCableWANCableLinkC1modemsWANEthernetLinkConfig:1OforEthernetWANEthLinkC1attachedmodemsWANPPPConnection:1RformodemsMultipleinstancesthatsupportpossiblewithinaPPPbasedWANConnectionDeviconnectionsce.ServiceIDsformultipleinstanceswillbeWANPPPConn1,WANPPPConn2,WANPPPConn3andsoon.WANIPConnection:2RformodemsOnly1instanceperthatsupportWANConnectionDeviIPv4basedceisenvisionedatconnectionsthistime,althoughthedesigncouldsupportmultipleinstancesinfuture.ServiceIDsformultipleinstanceswillbeWANIPConn1,WANIPConn2,WANIPConn3andsoon.WANIPv6FirewallControl:1OforIPv6Only1instanceperenabledIGDsWANIPv6FirewallCo?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.017ntrolisenvisionedatthistime,althoughthedesigncouldsupportmultipleinstancesinfuture.ServiceIDsformultipleinstanceswillbeWANIPv6Firewall1,WANIPv6Firewall2,WANIPv6Firewall3andsoon.Non-standardservicesembeddedXTBDbyanUPnPvendorgohere.Non-standardTBDXTBDTBDTBDdevicesembeddedbyanUPnPvendorgohere.R=Required,O=Optional,X=Non-standard.Prefixedbyurn:upnp-org:serviceId:.Note:thewordmodeminthetableabovereferstotheWANinterface(orWANDevice).2.2.1.DescriptionofDeviceRequirementsEachWANConnectionDevicemodelsalinkonaphysicalWANinterface.AWANDevicemaycontainoneormoreinstancesofWANConnectionDevicecorrespondingtooneormoreactivelinksonamodem.WANCommonInterfaceConfigisaserviceinWANDevicethatmodelsattributesandactionsthatarecommonacrossalllinksandallconnectioninstancesonalink.2.2.2.RelationshipsBetweenServicesTheDefaultConnectionServicestatevariableintheLayer3ForwardingservicereferstotheUDNofaWANConnectionDeviceinstance–thisisanexternaldependency.TheremayalsobedependenciesbetweenaspecificinstanceofWAN*LinkConfig(where*canbePOTS,DSL,CableorEthernet)andWAN**Connectionservice(where**canbePPPorIP)orWANIPv6FirewallControlserviceinaWANConnectionDevice.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.0182.3.TheoryofOperationConnectionstotheInternetareinitiatedeitherfromtheWANinterfaceofanIGDorarerelayedorbridgedthroughtheWANinterface.DSLcanbeprovisionedtosupportmultipleVirtualCircuits(VCs)simultaneously.EachVCcaninturnbeprovisionedtosupportoneormorePPPconnectionsoranIPconnection.Tohandlethesescenarios,eachWANDeviceincludesoneormoreinstancesofWANConnectionDevice.AWANConnectionDeviceencapsulatesalogicalorphysicallinkonaWANinterfaceoverwhichconnectionsaremodeled.Furthermore,connectionsonaWANinterfacecanbeoftypePPPorIP.ThesearemodeledbycorrespondingWAN{PPP/IP}ConnectionserviceinstancesforIPv4connectionsorWANIPv6FirewallControlserviceinstancesforIPv6connections.PropertiesspecifictoalinkaremodeledinaWAN{POTS/DSL/Cable/Ethernet}LinkConfigservice.ThedefinitionoftheWAN*LinkConfig1,WAN*Connection2andWANIPv6FirewallControlservicesarebasedonthefollowingbroadobjectives:ToallowforthedistinctionbetweenInternetaccessscenariosthataretypicallyindependentofthemodemtypesusedandconfigurationscenariosthatarespecifictomodemtypes.Thisenableseasiermodelingofvariousconnectivityscenariosindependentoftheunderlyingmodemtypeoritsconfiguration.Tosupportmostofthecommonlydeployedconnectiontypes(eitheroriginatingattheWANinterfaceofthegatewayorrelayed/bridgedthroughthegateway).Tosupportmanual(mayneedOut-Of-Bandsecurityandaccesscontrolmechanisms)orautomaticconfigurationofparametersonamodem.Toensureextensibilityfornewconnectiontypesinfuture.Configurationandconnectivityscenariosareindependentofeachother.However,thereisanimpliedrelationshipinthatcontrolpointswillfirstneedtocompleteconfigurationactions(unlessthisprocessiscompletedautomatically)beforeinitiatinganyconnectivityrelatedactions.Itisalsoimportanttonotethatautoandmanualconfigurationofamodemaremutuallyexclusiveoperationsinmostcases.Furthermore,inmostdeploymentscenarios,autoconfigurationisgivenhigherpriorityovermanualconfiguration.TheprocessofconfigurationandsubsequentmanagementofWANconnectionsisvia3variables:?LinkType:Thisvariable,ifdefinedinaWAN*LinkConfigservice,indicatestheprotocolconfiguredona3specificlink.Thisvariablecanbesetmanually,orthroughanautomaticmechanism(forexample,AutoConfigspecifiedbyBroadbandForum).PossibleConnectionTypes:specifiesonlythoseconnectiontypesthatarepermissibleinaparticularimplementationforaspecificmodemlinkconfiguration(asindicatedbythevalueofLinkType).ThisvariableisdefinedinWAN*Connectionservice.ConnectionType:indicatesaspecificconnectiontypeselectedfromthosepermissibleonalink,asindicatedbyPossibleConnectionTypes.ThisvariableisdefinedinWAN*Connectionservice.Figure2illustratestheprocessofconfigurationandconnectionmanagement,usingaDSLmodemasanexample.Notethattheconfiguringagentandsubsequentuser(s)ofconnectionsneednotbethesamenetworkentities.The4conceptualstepsaredescribedbelow.Step1:AconfiguringentitysetsuptheLinkTypetoanappropriatevalue.RefertocompanionDCPdraftsforspecificWAN*LinkConfigdescriptionsanddescriptionofvariablessuchasLinkType.RefertocompanionDCPdraftsforspecificWAN*ConnectionservicedescriptionsandvariablessuchasPossibleConnectionTypesandConnectionType.RefertotheBroadbandForumwebsitehttp://www(.broadband-forum.org)formoredetails.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.019Step2:ThevalueofLinkTypeiscombinedwiththecapabilitiesofthemodemtocomeupwithalistofpossibleconnectiontypesappropriatefortheparticularconfiguration.Step3:ThevariablePossibleConnectionTypesisupdatedwiththelistderivedfromstepabove.Step4:AcontrolpointmaysubsequentlyinitiateaconnectionbysettingConnectionTypetoavaluefromtheallowablelistspecifiedinPossibleConnectionTypes.Inthisstep,acontrolpointevaluatesitsowncapabilitiesvis-à-visthecapabilitiesexposedPossibleConnectionTypesinandselectsonethatisappropriateforitsuse.Insomedeploymentscenarios,thevalueofConnectionTypemaybestrictlyread-onlyfromacontrolpointperspective.ManualConfigurationAutoConfigurationviaUPnPControlPointMechanismORLinkConfigurationStep1WANDSLLinkConfigServiceLinkTypeStep3WANPPPConnectionVP,VC,CombineUpdateServiceReadPossibleConnectionTypesStep2ModemcapabilitiesandrestrictionsStep4ControlPointsetsupconnectionConnectionTypeFigure2:ConfigurationandConnectionManagementThefollowingtablelistsvalidcombinationsofLinkTypeandPossibleConnectionTypesaswellasconnectionservicetypefordifferenttypesofWANinterfaces.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.0110Table2:ValidCombinationsofLinkTypeandPossibleConnectionTypesModemLinkTypeAvailablePossibleConnectionTypesConnectionTypeModemServiceTypeCapabilitiesDSLUnconfiguredNotApplicableUnconfiguredNotApplicableEoA4BridgeIP_BridgedWANIPConnectionRouterIP_RoutedWANIPConnectionIPoARouterIP_RoutedWANIPConnectionCIPRouter+CIPIP_RoutedWANIPConnectionPPPoARouterIP_RoutedWANPPPConnectionPRelayPPTP_RelayWANPPPConnectionPPPoERelayPPPoE_RelayWANPPPConnectionL2TPRelayL2TP_RelayWANPPPConnectionDHCPSpooferDHCP_SpoofedWANPPPConnectionPPPoERouterIP_RoutedWANPPPConnectionPPTPRelayPPTP_RelayWANPPPConnectionL2TPRelayL2TP_RelayWANPPPConnectionBridgePPPoE_BridgedWANPPPConnectionDHCPSpooferDHCP_SpoofedWANPPPConnectionCableEthernetRouterIP_RoutedWANIPConnectionBridgeIP_BridgedWANIPConnectionPOTSPPP_DialupRouterIP_RoutedWANPPPConnectionEthernet-EthernetRouterIP_RoutedWANIPConnectionAttached(External)BridgeIP_BridgedWANIPConnectionRouter*IP_RoutedWANPPPConnection*NOTETOIMPLEMENTERS:PPP-basedconnectedtypes,originatingfromtheWANinterfaceofanIGD,arepossibleforanEthernet-attachedexternalmodem,mostlikelyoveranEthernetorIPlink.Forexample,aPPPoEconnectioncanoriginateontheWANinterfaceoftheIGD,terminatingattheISPhead-end,withtheexternallyattachedmodemactingasapass-throughEthernetbridge.However,modelingthis(orothersimilar)connectiontype(s)mayrequireadditionalvariablesand/oractionsintheWANPPPConnectionservicenotcurrentlydefinedbytheIGDworkingcommittee.Ifneeded,thesefeaturesshouldbeimplementedasvendorextensions.RefertotheWAN*LinkConfigservicedescriptionsforamoredetaileddescriptionofeachoftheLinkTypeandPossibleConnectionTypesvalues,includingacronymexpansions.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.0111XMLDeviceDescriptionmajor>1minor>0baseURLforallrelativeURLsdevice>deviceType>urn:schemas-upnp-org:device:WANConnectionDevice:2<friendlyName>shortuser-friendlytitle<manufacturer>manufacturername<manufacturerURL>URLtomanufacturersite<modelDescription>longuser-friendlytitlemodelName>modelnamemodelnumberURLtomodelsitemanufacturer'sserialnumberUDN>uuid:UUIDUniversalProductCodeicon><mimetype>image/format<width>horizontalpixels<height>verticalpixels<depth>colordepth<url>URLtoiconservice>serviceType>urn:schemas-upnp-org:service:WANDSLLinkConfig5:1urn:upnp-org:serviceId:WANDSLLinkC1URLtoservicedescriptionURLforcontrolURLforeventingservice>serviceType>urn:schemas-upnp-org:service:WANIPConnection6:2urn:upnp-org:serviceId:WANIPConn1URLtoservicedescriptionURLforcontrolURLforeventingNOTEtoimplementers:Thistemplateisrepresentativeofonelinktype;DSLinthiscase.Dependingonthetypeofmodem,substituteoradddevicespecificservicenames.NOTEtoimplementers:Thistemplateisrepresentativeofoneconnectiontype;IPinthiscase.Dependingonthetypeofconnection,substituteoraddservicenames.?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.0112URLforpresentation?2010UPnPForum.Allrightsreserved.UPnPWANConnectionDevice:2,version1.00.DeviceTemplateVersion1.01134.TestNosemantictestsaredefinedforthisdevice.?2010UPnPForum.Allrightsreserved.