DATA MODEL DEFINITION |
|
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.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.
Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.
| Data Type | Base Type | Description |
|---|---|---|
| IPAddress | string(45) | IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address. All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:
All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:
IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007]. Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition. |
| base64 | - | Base64 encoded binary (no line-length limitation). A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges. |
| boolean | - | Boolean, where the allowed values are 0 or 1 (or equivalently, true or false). |
| dateTime | - | The subset of the ISO 8601 date-time format defined by the SOAP dateTime type. |
| hexBinary | - | Hex encoded binary. A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges. |
| int | - | Integer in the range -2147483648 to +2147483647, inclusive. For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
| long | - | Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive. For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
| object | - | A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within. |
| string | - | For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges. |
| unsignedInt | - | Unsigned integer in the range 0 to 4294967295, inclusive. For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
| unsignedLong | - | Unsigned long integer in the range 0 to 18446744073709551615, inclusive. For some unsignedLong types, a value range is given using the form unsignedLong[Min:Max] or unsignedLong[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
| [RFC862] | RFC 862, Echo Protocol, IETF, 1983. |
| [RFC959] | RFC 959, File Transfer Protocol, IETF, 1985. |
| [RFC2616] | RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999. |
| [RFC3986] | RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF. |
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-143] | TR-143, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, 2008. |
For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.3, then it will indicate support for version 1.3. The version number associated with each object and parameter is shown in the Version column.
| Name | Type | Write | Description | Object Default | Version |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Abbreviation | Description |
|---|---|
| R | Read support is REQUIRED. |
| W | Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only. |
| P | The object is REQUIRED to be present. |
| C | Creation and deletion of instances of the object is REQUIRED. |
| A | Creation of instances of the object is REQUIRED, but deletion is not REQUIRED. |
| D | Deletion of instances of the object is REQUIRED, but creation is not REQUIRED. |
| Name | Requirement |
|---|---|
| InternetGatewayDevice.Capabilities.PerformanceDiagnostic. | P |
| DownloadTransports | R |
| InternetGatewayDevice.DownloadDiagnostics. | P |
| DiagnosticsState | W |
| Interface | W |
| DownloadURL | W |
| DSCP | W |
| EthernetPriority | W |
| ROMTime | R |
| BOMTime | R |
| EOMTime | R |
| TestBytesReceived | R |
| TotalBytesReceived | R |
| Name | Requirement |
|---|---|
| InternetGatewayDevice.DownloadDiagnostics. | P |
| TCPOpenRequestTime | R |
| TCPOpenResponseTime | R |
| Name | Requirement |
|---|---|
| InternetGatewayDevice.Capabilities.PerformanceDiagnostic. | P |
| UploadTransports | R |
| InternetGatewayDevice.UploadDiagnostics. | P |
| DiagnosticsState | W |
| Interface | W |
| UploadURL | W |
| DSCP | W |
| EthernetPriority | W |
| ROMTime | R |
| BOMTime | R |
| EOMTime | R |
| TestFileLength | R |
| TotalBytesSent | R |
| Name | Requirement |
|---|---|
| InternetGatewayDevice.UploadDiagnostics. | P |
| TCPOpenRequestTime | R |
| TCPOpenResponseTime | R |
| Name | Requirement |
|---|---|
| InternetGatewayDevice.UDPEchoConfig. | P |
| Enable | W |
| Interface | W |
| SourceIPAddress | W |
| UDPPort | W |
| PacketsReceived | R |
| PacketsResponded | R |
| BytesReceived | R |
| BytesResponded | R |
| TimeFirstPacketReceived | R |
| TimeLastPacketReceived | R |
| EchoPlusSupported | R |
| Name | Requirement |
|---|---|
| InternetGatewayDevice.UDPEchoConfig. | P |
| EchoPlusEnabled | W |