WANCommonInterfaceConfig:1 Service Template …

1 WANC ommonInterfaceConfig: 1 service template version For UPnP version Status: Standardized DCP. Date: November 12, 2001. This Standardized DCP has been adopted as a Standardized DCP by the Steering Committee of the UPnP Forum, pursuant to Section (c)(ii) of the UPnP Forum Membership Agreement. UPnP Forum Members have rights and licenses defined by Section 3 of the UPnP Forum Membership Agreement to use and reproduce the Standardized DCP in UPnP Compliant Devices. All such use is subject to all of the provisions of the UPnP Forum Membership Agreement. THE UPNP FORUM TAKES NO POSITION AS TO WHETHER ANY. INTELLECTUAL PROPERTY RIGHTS EXIST IN THE STANDARDIZED DCPS. THE STANDARDIZED DCPS ARE PROVIDED "AS IS" AND "WITH ALL. FAULTS". THE UPNP FORUM MAKES NO WARRANTIES, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE STANDARDIZED DCPS, INCLUDING BUT NOT LIMITED TO ALL IMPLIED WARRANTIES OF.

2 MERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A. PARTICULAR PURPOSE, OF REASONABLE CARE OR WORKMANLIKE. EFFORT, OR RESULTS OR OF LACK OF NEGLIGENCE. 1999-2001 Contributing Members of the UPnP Forum. All Rights Reserved. Authors Company Ulhas Warrier, Prakash Iyer Intel Corporation WANC ommonInterfaceConfig: 1 service template version 2. Contents 1. OVERVIEW AND SCOPE ..4. CHANGE LOG ..4. 2. Service MODELING DEFINITIONS ..6. SERVICETYPE ..6. STATE VARIABLES ..6. WANA ccessType ..8. Layer1 DownstreamMaxBitRate ..8. PhysicalLinkStatus ..8. NumberOfActiveConnections ..9. ActiveConnectionDeviceContainer & TotalBytesReceived ..9. TotalPacketsSent ..9. TotalPacketsReceived ..9. EnabledForInternet ..10. Relationships Between State Variables ..10. EVENTING AND MODERATION ..10. Event SetEnabledForInternet.

3 11. GetEnabledForInternet ..12. GetCommonLinkProperties ..13. GetWANA ccessProvider ..13. GetTotalBytesSent ..14. GetTotalBytesReceived ..15. GetTotalPacketsReceived ..16. GetActiveConnection ..17. Non-Standard Actions Implemented by a UPnP Relationships Between Actions ..18. Common Error THEORY OF OPERATION ..18. 3. XML Service DESCRIPTION ..19. 4. List of Tables Table 1: State Variables ..6. Table : allowedValueList for Table : allowedValueList for Table 2: Event 1999-2001 Contributing Members of the UPnP Forum. All Rights Reserved. WANC ommonInterfaceConfig: 1 service template version 3. Table 3: Actions ..11. Table 4: Arguments for SetEnabledForInternet ..12. Table 5: Arguments for GetEnabledForInternet ..12. Table 6: Arguments for Table 7: Arguments for Table 8: Arguments for GetMaximumActiveConnections.

4 14. Table 9: Arguments for Table 10: Arguments for GetTotalBytesReceived ..15. Table 11: Arguments for GetTotalPacketsSent ..16. Table 12: Arguments for Table 13: Arguments for GetActiveConnection ..17. Table 14: Common Error 1999-2001 Contributing Members of the UPnP Forum. All Rights Reserved. WANC ommonInterfaceConfig: 1 service template version 4. 1. Overview and Scope This Service definition is compliant with the UPnP Device Architecture version This Service -type models physical layer properties of a WAN interface on an Internet Gateway used for Internet access. The Service is REQUIRED and is specified in urn:schemas-upnp-org:device:WAND evice one or more instances of which are specified under the root device urn:schemas-upnp-org:device:InternetGate wayDevice Change Log version of this document replaced Changes from Renamed Service to WANC ommonInterfaceConfig Removed LinkStatus state variable (it is now part of the Interface Configuration Service corresponding to a specific WAN access type ,, WANPOTSI nterfaceConfig).

5 Changed error return codes in conformance with latest device Template . Added Ethernet' to list of allowed values for WAN access type. Changes from Added Get' actions per Technical Committee recommendation to not use QueryStateVariable for reading state variables. Changes from (as per WC meeting on 9/6/00). Change ADSL to DSL in SST. Removed (or PPP) from EnabledForInternet description Reduce number of GET functions defining a new aggregate function GetWANA ccessProperties Removed <retval/> and empty defaultvalue tags from XML description doc not needed. Removed values satellite and wireless from AllowedValueList for WANA ccessType Changed Boolean values from true/false to 0/1. Moved LinkStatus from WANXYZI nterfaceConfig Changes from (as per WC meeting on 10/17/00). Changes to reflect required and optional SST variables per discussion at the F2F meeting Added new SST variables TotalBytesSent, TotalBytesReceived, TotalPacketsSent, TotalPacketsReceived Split Get actions into required and optional to reflect changes to SST variables Changed ActiveClients to an array of 2-tuples Updates to Theory of operation section.

6 Changes from Added Initializing to AllowedValueList for PhysicalLinkStatus Changes from Removed urn from ActiveConnectionDeviceContainer value Removed white spaces from XML section Changes from Changed document status to Template design complete Clarification to text in many sections of the draft Added prefix New to formal parameters for actions to distinguish them from related state variables Added action GetEnabledForInternet Removed retval' tags from the XML specification. Changes from Updated to Service Template 1999-2001 Contributing Members of the UPnP Forum. All Rights Reserved. WANC ommonInterfaceConfig: 1 service template version 5. Verified against TDC checklist Down rev'ed document version to comply with TDC requirements Modified NewActiveConnectionDeviceContainer to NewActiveConnDeviceContainer to comply with 32-character limit.

7 Added a note to description of MaximumActiveConnections. Deleted Other from the allowedValueList for WANA ccessType ReplacedGetCommonConnectionProperties with 6 individual Get actions. Changes from Removed default values and updated XML section accordingly Updated allowedValueList tables to clarify Required versus Optional values Deleted Vendor Defined rows from allowedValueList tables Changes from Added XML comment tags to comments text in XML Template Renamed ActiveConnectionIndex to A_ActiveConnectionIndex and updated SST and event tables. Changes from Updated semantic tests section Deleted A_ActiveConnectionIndex and updated related text and XML sections Deleted allowedvaluerange for boolean variables in XML Template Changes from Deleted mention of Other' as an allowed value for WANA ccessType in section Changed variable name string NumberofActiveConnections' to NumberOfActiveConnections'.

8 For naming convention and consistency with xml section. Deleted empty <maximum> tag for MaximumActiveConnections from XML section Changes from version updated to reflect 45-day review completion. No other changes to this draft. Changes from Copyright messages and document status updated. 1999-2001 Contributing Members of the UPnP Forum. All Rights Reserved. WANC ommonInterfaceConfig: 1 service template version 6. 2. Service Modeling Definitions ServiceType The following Service type identifies a Service that is compliant with this Template : urn:schemas-upnp-org: Service :WANC ommonInterfaceConfig:1. State Variables Table 1: State Variables Variable Name Req. or Data Allowed Default Eng. Units Type Value 2 Value 2. WANA ccessType R string See table Empty N/A. below string Layer1 UpstreamMaxBitRate R ui4 Range of Undefined bitspersecond values is WAN device, technology and/or deployment scenario specific Layer1 DownstreamMaxBitRate R ui4 Range of Undefined bitspersecond values is WAN device, technology and/or deployment scenario specific PhysicalLinkStatus R string See table Not N/A.

9 Below specified WANA ccessProvider O string No specific Empty N/A. range of string values defined MaximumActiveConnections O ui2 A fixed A fixed N/A. number, number, product product dependent. dependent NumberOfActiveConnections O ui2 Undefined Not N/A. specified 1999-2001 Contributing Members of the UPnP Forum. All Rights Reserved. WANC ommonInterfaceConfig: 1 service template version 7. Variable Name Req. or Data Allowed Default Eng. Units Type Value 2 Value 2. ActiveConnectionDeviceContainer O string Undefined Empty N/A. string ActiveConnectionServiceID O string Undefined Empty N/A. string TotalBytesSent O ui4 Undefined Not N/A. specified TotalBytesReceived O ui4 Undefined Not N/A. specified TotalPacketsSent O ui4 Undefined Not N/A. specified TotalPacketsReceived O ui4 Undefined Not N/A.

10 Specified EnabledForInternet O boolean 0,1 Not N/A. specified Non-standard state variables implemented by an X TBD TBD TBD TBD. UPnP vendor go here. 1. R = Required, O = Optional, X = Non-standard. 2. Values listed in this column are required. To specify standard optional values or to delegate assignment of values to the vendor, you must reference a specific instance of an appropriate table below. NOTE: Default values are not specified in the DCP. A vendor may however choose to provide default values for SST variables where appropriate. Table : allowedValueList for WANA ccessType Value Req. or Opt. 3 Description DSL R Only applicable for Digital Subscriber Link (DSL) modems POTS R Only applicable for Plain Old Telephone Service (POTS) modems Cable R Only applicable for cable modems Ethernet R Only applicable for external Ethernet-attached modems 3.