ISO/IEC 29341-24-10:2017

Information technology — UPnP Device Architecture — Part 24-10: Internet gateway device control protocol — Level 2 — Wide area network internet protocol — Connection service

ISO/IEC 29341-24-10:2017 specifies the characteristics of the UPnP networked service named WANIPConnection, version 2. This service definition is compliant with UPnP Device Architecture 1.0 [1] . It is one component of the Device Control Protocol for the UPnP Internet Gateway Device (see [3]). This service enables a UPnP control point to: - configure and control an IP connection between a LAN client on one side of an Internet gateway (see [3]) and a WAN host on the other side; - manage any physical WAN interface?such as DSL or cable?that supports an IP connection. This service is a required in a WANConnectionDevice (see [5]) when the device supports an IP connection.

Technologies de l'information — Architecture de dispositif UPnP — Partie 24-10: Protocole de contrôle de dispositif de passerelle Internet — Niveau 2 — Protocole internet de réseau étendu — Service de connexion

General Information

• Status: Published
• Publication Date: 12-Sep-2017
• ICS: 35.200 - Interface and interconnection equipment
• Technical Committee: ISO/IEC JTC 1 - Information technology
• Drafting Committee: ISO/IEC JTC 1 - Information technology
• Current Stage: 9060 - Close of review
• Start Date: 03-Mar-2028

Standards Content (Sample)

INTERNATIONAL
ISO/IEC
STANDARD
29341-24-10
First edition
2017-09
Information technology — UPnP
Device Architecture —
Part 24-10:
Internet gateway device control
protocol — Level 2 — Wide area
network internet protocol —
Connection service
Technologies de l'information — Architecture de dispositif UPnP —
Partie 24-10: Protocole de contrôle de dispositif de passerelle
Internet — Niveau 2 — Protocole internet de réseau étendu —
Service de connexion
Reference number
ISO/IEC 29341-24-10:2017(E)
©
ISO/IEC 2017

---------------------- Page: 1 ----------------------
ISO/IEC 29341-24-10:2017(E)

COPYRIGHT PROTECTED DOCUMENT
© ISO/IEC 2017, Published in Switzerland
All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form
or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior
written permission. Permission can be requested from either ISO at the address below or ISO’s member body in the country of
the requester.
ISO copyright office
Ch. de Blandonnet 8 • CP 401
CH-1214 Vernier, Geneva, Switzerland
Tel. [phone]
Fax [phone]
[e-mail]
www.iso.org
ii © ISO/IEC 2017 – All rights reserved

---------------------- Page: 2 ----------------------
ISO/IEC 29341-24-10:2017(E)

CONTENTS

1  Scope . 1
2  Normative references . 1
3  Terms, definitions, symbols and abbreviated terms . 2
4  Notations and conventions . 4
4.1  Notation . 4
4.2  Data types . 4
4.2.1  Primary data types . 4
4.2.2  Secondary data types . 5
4.3  Vendor-defined extensions . 6
5  Service model . 6
5.1  Service type . 6
5.2  Changes from WANIPConnection:1 . 6
5.2.1  Backward compatibility . 6
5.2.2  Generic requirements and other changes . 6
5.2.3  New state variables . 6
5.2.4  New actions . 6
5.2.5  Changes in existing actions and procedures . 7
5.3  Service Architecture . 7
5.3.1  Int r oduction . 7
5.3.2  Main feature sets . 8
5.4  State variables . 9
5.4.1  State variable overview . 9
5.4.2  ConnectionType . 11
5.4.3  PossibleConnectionTypes . 11
5.4.4  ConnectionStatus . 11
5.4.5  Uptime . 12
5.4.6  LastConnectionError . 12
5.4.7  AutoDisconnectTime . 12
5.4.8  IdleDisconnectTime . 13
5.4.9  WarnDisconnectDelay . 13
5.4.10  RSIPAvailable . 13
5.4.11  NATEnabled . 13
5.4.12  ExternalIPAddress . 13
5.4.13  PortMappingNumberOfEntries . 13
5.4.14  PortMappingEnabled . 14
5.4.15  PortMappingLeaseDuration . 14
5.4.16  RemoteHost . 14
5.4.17  ExternalPort . 14
5.4.18  InternalPort . 15
5.4.19  PortMappingProtocol . 15
5.4.20  InternalClient . 15
5.4.21  PortMappingDescription . 15
5.4.22  SystemUpdateID . 15
5.4.23  A_ARG_TYPE_Manage . 16
 ISO/IEC 2017 – All rights reserved  iii

---------------------- Page: 3 ----------------------
ISO/IEC 29341-24-10:2017(E)
5.4.24  A_ARG_TYPE_PortListing . 16
5.5  Eventing and Moderation . 17
5.5.1  Eventing of PossibleConnectionTypes . 18
5.5.2  Eventing of ConnectionStatus . 18
5.5.3  Eventing of ExternalIPAddress . 18
5.5.4  Eventing of PortMappingNumberOfEntries . 18
5.5.5  Eventing of SystemUpdateID . 18
5.5.6  Relationships among State Variables . 18
5.6  Actions . 19
5.6.1  SetConnectionType() . 20
5.6.2  GetConnectionTypeInfo() . 21
5.6.3  RequestConnection() . 22
5.6.4  RequestTermination() . 23
5.6.5  ForceTermination() . 24
5.6.6  SetAutoDisconnectTime() . 25
5.6.7  SetIdleDisconnectTime() . 26
5.6.8  SetWarnDisconnectDelay() . 27
5.6.9  GetStatusInfo() . 27
5.6.10  GetAutoDisconnectTime() . 28
5.6.11  GetIdleDisconnectTime() . 29
5.6.12  GetWarnDisconnectDelay() . 30
5.6.13  GetNATRSIPStatus() . 31
5.6.14  GetGenericPortMappingEntry() . 31
5.6.15  GetSpecificPortMappingEntry() . 33
5.6.16  AddPortMapping() . 34
5.6.17  AddAnyPortMapping() . 38
5.6.18  DeletePortMapping() . 40
5.6.19  DeletePortMappingRange() . 42
5.6.20  GetExternalIPAddress() . 43
5.6.21  GetListOfPortMappings() . 44
5.6.22  Relationships Between Actions . 45
5.6.23  Error Code Summary . 45
5.7  Service Behavioral Model . 47
5.7.1  Connection Initiation . 47
5.7.2  Connection Termination . 48
6  XML Service Description . 49
Annex A (informative) Theory of Operation . 61
Annex B (informative) Bibliography . 65

Figure 1 — UPnP IGD component relationships for NAT processing . 10
Figure 2 — Example of relationship between AddPortMapping() action and port
triggering . 35
Figure 3 — Summary of AddPortMapping() results . 37
Figure 4 — Summary of AddAnyPortMapping() results . 40
Figure 5 — State diagram for IP connection . 47
Figure A.1 — NAT is an IP address translator . 63
Figure A.2 — NAT issue with bundled session applications . 64
iv   ISO/IEC 2017 – All rights reserved

---------------------- Page: 4 ----------------------
ISO/IEC 29341-24-10:2017(E)


Table 1 — CSV examples . 5
Table 2 — State Variables . 9
Table 3 — allowedValueList for the ConnectionType state variable . 11
Table 4 — allowedValueList for the ConnectionStatus state variable . 11
Table 5 — allowedValueList for the LastConnectionError state variable . 12
Table 6 — allowedValueRange for the PortMappingLeaseDuration state variable . 14
Table 7 — allowedValueRange for the InternalPort state variable . 15
Table 8 — allowedValueList for the PortMappingProtocol state variable . 15
Table 9 — Eventing and Moderation . 17
Table 10 — Actions . 19
Table 11 — Common parameters . 19
Table 12 — Arguments for SetConnectionType() . 20
Table 13 — Error Codes for SetConnectionType() . 21
Table 14 — Arguments for GetConnectionTypeInfo() . 21
Table 15 — Error Codes for GetConnectionTypeInfo() . 22
Table 16 — Error Codes for RequestConnection() . 23
Table 17 — Error Codes for RequestTermination(). 24
Table 18 — Error Codes for ForceTermination() . 25
Table 19 — Arguments for SetAutoDisconnectTime() . 25
Table 20 — Error Codes for SetAutoDisconnectTime() . 26
Table 21 — Arguments for SetIdleDisconnectTime() . 26
Table 22 — Error Codes for SetIdleDisconnectTime() . 27
Table 23 — Arguments for SetWarnDisconnectDelay() . 27
Table 24 — Error Codes for SetWarnDisconnectDelay() . 27
Table 25 — Arguments for GetStatusInfo() . 28
Table 26 — Error Codes for GetStatusInfo() . 28
Table 27 — Arguments for GetAutoDisconnectTime() . 28
Table 28 — Error Codes for GetAutoDisconnectTime() . 29
Table 29 — Arguments for GetIdleDisconnectTime() . 29
Table 30 — Error Codes for GetIdleDisconnectTime() . 30
Table 31 — Arguments for GetWarnDisconnectDelay() . 30
Table 32 — Error Codes for GetWarnDisconnectDelay() . 30
Table 33 — Arguments for GetNATRSIPStatus() . 31
Table 34 — Error Codes for GetNATRSIPStatus() . 31
Table 35 — Arguments for GetGenericPortMappingEntry() . 32
Table 36 — Error Codes for GetGenericPortMappingEntry() . 33
Table 37 — Arguments for GetSpecificPortMappingEntry() . 33
Table 38 — Error Codes for GetSpecificPortMappingEntry() . 34
Table 39 — Arguments for AddPortMapping() . 35
Table 40 — Error Codes for AddPortMapping() . 37
Table 41 — Arguments for AddAnyPortMapping() . 38
Table 42 — Error Codes for AddAnyPortMapping() . 40
 ISO/IEC 2017 – All rights reserved  v

---------------------- Page: 5 ----------------------
ISO/IEC 29341-24-10:2017(E)
Table 43 — Arguments for DeletePortMapping() . 41
Table 44 — Error Codes for DeletePortMapping() . 41
Table 45 — Arguments for DeletePortMappingRange() . 42
Table 46 — Error Codes for DeletePortMappingRange() . 43
Table 47 — Arguments for GetExternalIPAddress() . 43
Table 48 — Error Codes for GetExternalIPAddress() . 44
Table 49 — Arguments for GetListOfPortMappings() . 44
Table 50 — Error Codes for GetListOfPortMappings() . 45
Table 51 — Error Code Summary . 46
Table A.1 — Connection Procedures . 61


vi   ISO/IEC 2017 – All rights reserved

---------------------- Page: 6 ----------------------
ISO/IEC 29341-24-10:2017(E)

Foreword
ISO (the International Organization for Standardization) and IEC (the International
Electrotechnical Commission) form the specialized system for worldwide standardization.
National bodies that are members of ISO or IEC participate in the development of
International Standards through technical committees established by the respective
organization to deal with particular fields of technical activity. ISO and IEC technical
committees collaborate in fields of mutual interest. Other international organizations,
governmental and non‐governmental, in liaison with ISO and IEC, also take part in the
work. In the field of information technology, ISO and IEC have established a joint technical
committee, ISO/IEC JTC 1.
The procedures used to develop this document and those intended for its further
maintenance are described in the ISO/IEC Directives, Part 1. In particular the different
approval criteria needed for the different types of document should be noted. This
document was drafted in accordance with the editorial rules of the ISO/IEC Directives,
Part 2 (see http://www.iso.org/directives).
Attention is drawn to the possibility that some of the elements of this document may be
the subject of patent rights. ISO and IEC shall not be held responsible for identifying any
or all such patent rights. Details of any patent rights identified during the development of
the document will be in the Introduction and/or on the ISO list of patent declarations
received (see www.iso.org/patents).
Any trade name used in this document is information given for the convenience of users
and does not constitute an endorsement.
For an explanation on the voluntary nature of Standard, the meaning of the ISO specific
terms and expressions related to conformity assessment, as well as information about
ISO’s adherence to the WTO principles in the Technical Barriers to Trade (TBT) see the
following URL: Foreword – Supplementary information
ISO/IEC 29341‐24‐10 was prepared by UPnP Forum and adopted, under the PAS
procedure, by joint technical committee ISO/IEC JTC 1, Information technology, in
parallel with its approval by national bodies of ISO and IEC.
The list of all currently available parts of ISO/IEC 29341 series, under the general title
Information technology — UPnP Device Architecture, can be found on the ISO web site.
 ISO/IEC 2017 – All rights reserved  vii

---------------------- Page: 7 ----------------------
ISO/IEC 29341-24-10:2017(E)
Introduction
ISO and IEC draw attention to the fact that it is claimed that compliance with this document may
involve the use of patents as indicated below.

ISO and IEC take no position concerning the evidence, validity and scope of these patent rights. The
holders of -these patent rights have assured ISO and IEC that they are willing to negotiate licenses
under reasonable and non-discriminatory terms and conditions with applicants throughout the world. In
this respect, the statements of the holders of these patent rights are registered with ISO and IEC.

Intel Corporation has informed IEC and ISO that it has patent applications or granted patents.
Information may be obtained from:
Intel Corporation
Standards Licensing Department
5200 NE Elam Young Parkway
MS: JFS-98
USA – Hillsboro, Oregon 97124
Microsoft Corporation has informed IEC and ISO that it has patent applications or granted
patents as listed below:
6101499 / US; 6687755 / US; 6910068 / US; 7130895 / US; 6725281 / US; 7089307 / US;
7069312 / US; 10/783 524 /US
Information may be obtained from:
Microsoft Corporation
One Microsoft Way
USA – Redmond WA 98052
Philips International B.V. has informed IEC and ISO that it has patent applications or granted
patents.
Information may be obtained from:
Philips International B.V. – IP&S
High Tech campus, building 44 3A21
NL – 5656 Eindhoven
NXP B.V. (NL) has informed IEC and ISO that it has patent applications or granted patents.
Information may be obtained from:
NXP B.V. (NL)
High Tech campus 60
NL – 5656 AG Eindhoven
Matsushita Electric Industrial Co. Ltd. has informed IEC and ISO that it has patent
applications or granted patents.
Information may be obtained from:
Matsushita Electric Industrial Co. Ltd.
1-3-7 Shiromi, Chuoh-ku
JP – Osaka 540-6139
viii   ISO/IEC 2017 – All rights reserved

---------------------- Page: 8 ----------------------
ISO/IEC 29341-24-10:2017(E)

Hewlett Packard Company has informed IEC and ISO that it has patent applications or
granted patents as listed below:
5 956 487 / US; 6 170 007 / US; 6 139 177 / US; 6 529 936 / US; 6 470 339 / US; 6 571 388 /
US; 6 205 466 / US
Information may be obtained from:
Hewlett Packard Company
1501 Page Mill Road
USA – Palo Alto, CA 94304
Samsung Electronics Co. Ltd. has informed IEC and ISO that it has patent applications or
granted patents.
Information may be obtained from:
Digital Media Business, Samsung Electronics Co. Ltd.
416 Maetan-3 Dong, Yeongtang-Gu,
KR – Suwon City 443-742
Huawei Technologies Co., Ltd. has informed IEC and ISO that it has patent applications or
granted patents.
Information may be obtained from:
Huawei Technologies Co., Ltd.
Administration Building, Bantian Longgang District
Shenzhen – China 518129
Qualcomm Incorporated has informed IEC and ISO that it has patent applications or granted
patents.
Information may be obtained from:
Qualcomm Incorporated
5775 Morehouse Drive
San Diego, CA – USA 92121
Telecom Italia S.p.A.has informed IEC and ISO that it has patent applications or granted
patents.
Information may be obtained from:
Telecom Italia S.p.A.
Via Reiss Romoli, 274
Turin - Italy 10148
Cisco Systems informed IEC and ISO that it has patent applications or granted patents.
Information may be obtained from:
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA – USA 95134
Attention is drawn to the possibility that some of the elements of this document may be the subject of
patent rights other than those identified above. ISO and IEC shall not be held responsible for
identifying any or all such patent rights.

 ISO/IEC 2017 – All rights reserved  ix

---------------------- Page: 9 ----------------------
ISO/IEC 29341-24-10:2017(E)
Original UPnP Document
Reference may be made in this document to original UPnP documents. These references are
retained in order to maintain consistency between the specifications as published by ISO/IEC
and by UPnP Implementers Corporation and later by UPnP Forum. The following table
indicates the original UPnP document titles and the corresponding part of ISO/IEC 29341:
UPnP Document Title ISO/IEC 29341 Part
UPnP Device Architecture 1.0 ISO/IEC 29341-1:2008
UPnP Device Architecture Version 1.0 ISO/IEC 29341-1:2011
UPnP Device Architecture 1.1 ISO/IEC 29341-1-1:2011
UPnP Device Architecture 2.0 ISO/IEC 29341-1-2
UPnP Basic:1 Device ISO/IEC 29341-2
UPnP AV Architecture:1 ISO/IEC 29341-3-1:2008
UPnP AV Architecture:1 ISO/IEC 29341-3-1:2011
UPnP AVTransport:1 Service ISO/IEC 29341-3-10
UPnP ConnectionManager:1 Service ISO/IEC 29341-3-11
UPnP ContentDirectory:1 Service ISO/IEC 29341-3-12
UPnP RenderingControl:1 Service ISO/IEC 29341-3-13
UPnP MediaRenderer:1 Device ISO/IEC 29341-3-2
UPnP MediaRenderer:2 Device ISO/IEC 29341-3-2:2011
UPnP MediaServer:1 Device ISO/IEC 29341-3-3
UPnP AVTransport:2 Service ISO/IEC 29341-4-10:2008
UPnP AVTransport:2 Service ISO/IEC 29341-4-10:2011
UPnP ConnectionManager:2 Service ISO/IEC 29341-4-11:2008
UPnP ConnectionManager:2 Service ISO/IEC 29341-4-11:2011
UPnP ContentDirectory:2 Service ISO/IEC 29341-4-12
UPnP RenderingControl:2 Service ISO/IEC 29341-4-13:2008
UPnP RenderingControl:2 Service ISO/IEC 29341-4-13:2011
UPnP ScheduledRecording:1 ISO/IEC 29341-4-14
UPnP ScheduledRecording:2 ISO/IEC 29341-4-14:2011
UPnP MediaRenderer:2 Device ISO/IEC 29341-4-2
UPnP MediaServer:2 Device ISO/IEC 29341-4-3
UPnP AV Datastructure Template:1 ISO/IEC 29341-4-4:2008
UPnP AV Datastructure Template:1 ISO/IEC 29341-4-4:2011
UPnP DigitalSecurityCamera:1 Device ISO/IEC 29341-5-1
UPnP DigitalSecurityCameraMotionImage:1 Service ISO/IEC 29341-5-10
UPnP DigitalSecurityCameraSettings:1 Service ISO/IEC 29341-5-11
UPnP DigitalSecurityCameraStillImage:1 Service ISO/IEC 29341-5-12
UPnP HVAC_System:1 Device ISO/IEC 29341-6-1
UPnP ControlValve:1 Service ISO/IEC 29341-6-10
UPnP HVAC_FanOperatingMode:1 Service ISO/IEC 29341-6-11
UPnP FanSpeed:1 Service ISO/IEC 29341-6-12
UPnP HouseStatus:1 Service ISO/IEC 29341-6-13
UPnP HVAC_SetpointSchedule:1 Service ISO/IEC 29341-6-14
UPnP TemperatureSensor:1 Service ISO/IEC 29341-6-15
UPnP TemperatureSetpoint:1 Service ISO/IEC 29341-6-16
UPnP HVAC_UserOperatingMode:1 Service ISO/IEC 29341-6-17
UPnP HVAC_ZoneThermostat:1 Device ISO/IEC 29341-6-2
x   ISO/IEC 2017 – All rights reserved

---------------------- Page: 10 ----------------------
ISO/IEC 29341-24-10:2017(E)

UPnP BinaryLight:1 Device ISO/IEC 29341-7-1
UPnP Dimming:1 Service ISO/IEC 29341-7-10
UPnP SwitchPower:1 Service ISO/IEC 29341-7-11
UPnP DimmableLight:1 Device ISO/IEC 29341-7-2
UPnP InternetGatewayDevice:1 Device ISO/IEC 29341-8-1
UPnP LANHostConfigManagement:1 Service ISO/IEC 29341-8-10
UPnP Layer3Forwarding:1 Service ISO/IEC 29341-8-11
UPnP LinkAuthentication:1 Service ISO/IEC 29341-8-12
UPnP RadiusClient:1 Service ISO/IEC 29341-8-13
UPnP WANCableLinkConfig:1 Service ISO/IEC 29341-8-14
UPnP WANCommonInterfaceConfig:1 Service ISO/IEC 29341-8-15
UPnP WANDSLLinkConfig:1 Service ISO/IEC 29341-8-16
UPnP WANEthernetLinkConfig:1 Service ISO/IEC 29341-8-17
UPnP WANIPConnection:1 Service ISO/IEC 29341-8-18
UPnP WANPOTSLinkConfig:1 Service ISO/IEC 29341-8-19
UPnP LANDevice:1 Device ISO/IEC 29341-8-2
UPnP WANPPPConnection:1 Service ISO/IEC 29341-8-20
UPnP WLANConfiguration:1 Service ISO/IEC 29341-8-21
UPnP WANDevice:1 Device ISO/IEC 29341-8-3
UPnP WANConnectionDevice:1 Device ISO/IEC 29341-8-4
UPnP WLANAccessPointDevice:1 Device ISO/IEC 29341-8-5
UPnP Printer:1 Device ISO/IEC 29341-9-1
UPnP ExternalActivity:1 Service ISO/IEC 29341-9-10
UPnP Feeder:1.0 Service ISO/IEC 29341-9-11
UPnP PrintBasic:1 Service ISO/IEC 29341-9-12
UPnP Scan:1 Service ISO/IEC 29341-9-13
UPnP Scanner:1.0 Device ISO/IEC 29341-9-2
UPnP QoS Architecture:1.0 ISO/IEC 29341-10-1
UPnP QosDevice:1 Service ISO/IEC 29341-10-10
UPnP QosManager:1 Service ISO/IEC 29341-10-11
UPnP QosPolicyHolder:1 Service ISO/IEC 29341-10-12
UPnP QoS Architecture:2 ISO/IEC 29341-11-1
UPnP QosDevice:2 Service ISO/IEC 29341-11-10
UPnP QosManager:2 Service ISO/IEC 29341-11-11
UPnP QosPolicyHolder:2 Service ISO/IEC 29341-11-12
UPnP QOS v2 Schema Files ISO/IEC 29341-11-2
UPnP RemoteUIClientDevice:1 Device ISO/IEC 29341-12-1
UPnP RemoteUIClient:1 Service ISO/IEC 29341-12-10
UPnP RemoteUIServer:1 Service ISO/IEC 29341-12-11
UPnP RemoteUIServerDevice:1 Device ISO/IEC 29341-12-2
UPnP DeviceSecurity:1 Service ISO/IEC 29341-13-10
UPnP SecurityConsole:1 Service ISO/IEC 29341-13-11
UPnP ContentDirectory:3 Service ISO/IEC 29341-14-12:2011
UPnP MediaServer:3 Device ISO/IEC 29341-14-3:2011
UPnP ContentSync:1 ISO/IEC 29341-15-10:2011
UPnP Low Power Architecture:1 ISO/IEC 29341-16-1:2011
UPnP LowPowerProxy:1 Service ISO/IEC 29341-16-10:2011
 ISO/IEC 2017 – All rights reserved  xi

---------------------- Page: 11 ----------------------
ISO/IEC 29341-24-10:2017(E)
UPnP LowPowerDevice:1 Service ISO/IEC 29341-16-11:2011
UPnP QoS Architecture:3 ISO/IEC 29341-17-1:2011
UPnP QosDevice:3 Service ISO/IEC 29341-17-10:2011
UPnP QosManager:3 Service ISO/IEC 29341-17-11:2011
UPnP QosPolicyHolder:3 Service ISO/IEC 29341-17-12:2011
UPnP QosDevice:3 Addendum ISO/IEC 29341-17-13:2011
UPnP RemoteAccessArchitecture:1 ISO/IEC 29341-18-1:2011
UPnP Inbou
...