DATA MODEL DEFINITION |
|
This Broadband Forum Document is provided AS IS, WITH ALL FAULTS. ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW ANY REPRESENTATION OR WARRANTY, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY:
By using this Broadband Forum Document, users acknowledge that implementation may require licenses to patents. The Broadband Forum encourages but does not require its members to identify such patents. For a list of declarations made by Broadband Forum member companies, please see http://www.broadband-forum.org. No assurance is given that licenses to patents necessary to implement this Document will be available for license at all or on reasonable and non-discriminatory terms.
ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW (A) ANY LIABILITY (INCLUDING DIRECT, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES UNDER ANY LEGAL THEORY) ARISING FROM OR RELATED TO THE USE OF OR RELIANCE UPON THIS DOCUMENT; AND (B) ANY OBLIGATION TO UPDATE OR CORRECT THIS DOCUMENT.
Broadband Forum Documents may be copied, downloaded, stored on a server or otherwise re-distributed in their entirety only, and may not be modified without the advance written permission of the Broadband Forum.
The text of this notice must be included in all copies of this Broadband Forum Document.
| Data Type | Base Type | Description |
|---|---|---|
| Alias | string(64) | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-106a6] | TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2011. |
For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 1.1, then it will indicate support for version 1.1. The version number associated with each object and parameter is shown in the Version column.
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| VoiceService.{i}. | object | - | The top-level object for VoIP CPE.
At most one entry in this table can exist with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.Capabilities. | object | - | The overall capabilities of the VoIP CPE. | - | 1.0 |
| VoiceService.{i}.Capabilities.Codecs.{i}. | object | - | Table to describe the set of supported codecs. The table MUST include a distinct entry for each supported combination of these Codec and BitRate. Applicable only for a VoIP endpoint.
At most one entry in this table can exist with a given value for EntryID, or with the same values for Codec and BitRate, or with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}. | object | W | Object associated with a collection of voice lines with common characteristics. Support for adding and removing profiles is conditional on whether more than one profile is supported as indicated by Capabilities.MaxProfileCount. By default, a single VoiceProfile object SHOULD be present in a VoiceService, initially in the disabled state.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.SIP. | object | - | Voice profile parameters that are specific to SIP user agents. Creation of this object occurs on specification of SIP. |
- | 1.0 |
| VoiceService.{i}.VoiceProfile.{i}.SIP.EventSubscribe.{i}. | object | W | Table to specify the SIP events to which the CPE MUST subscribe. If supported, the value of Capabilities.SIP.EventSubscription MUST be true and VoiceProfile.{i}.SIP.SIPEventSubscribeNumberOfElements MUST be present.
At most one entry in this table can exist with all the same values for Event, Notifier, NotifierPort and NotifierTransport, or with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.SIP.ResponseMap.{i}. | object | W | Each entry in this table specifies the tone and message to be provided to the user for a particular SIP Response received (normally 4xx and 5xx). If supported, the value of Capabilities.SIP.ResponseMap MUST be true and VoiceProfile.{i}.SIP.SIPResponseMapNumberOfElements MUST be present. Applicable only for a VoIP endpoint.
At most one entry in this table can exist with a given value for SIPResponseNumber, or with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.NumberingPlan. | object | - | This object contains information related the numbering plan. This object is applicable only if the device supports a dialing mechanism for which a number plan is needed (for example, a device with an explicit Dial button may not need to be aware of the dialing plan) and if the device does not already support a numbering plan mechanism for this profile (e.g., in-band via MGCP). If supported, the value of Capabilities.NumberingPlan MUST be true. Applicable only for a VoIP endpoint. |
- | 1.0 |
| VoiceService.{i}.VoiceProfile.{i}.NumberingPlan.PrefixInfo.{i}. | object | W | Each entry in this table contains information related to an individual prefix in the numbering plan. It is anticipated that once the minimum number of digits has been received, the VoIP device will search this prefix list every time a new digit is received. If no new entry is found, then the object that was previously found will be used instead. If supported, VoiceProfile.{i}.NumberingPlan.PrefixInfoMaxEntries and VoiceProfile.{i}.NumberingPlan.PrefixInfoNumberOfEntries MUST be present. The defaults given for this object apply only to explicit creation of an instance of this object and not to automatic creation of instances of this object due to creation of a parent object.
At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Tone. | object | - | This object defines the contents of the tones and announcements generated locally by the VoIP device. If this object is supported, Capabilities.ToneGeneration MUST be true. Applicable only for a VoIP endpoint. |
- | 1.0 |
| VoiceService.{i}.VoiceProfile.{i}.Tone.Event.{i}. | object | - | Table of events for which a tone is defined. The table is pre-populated with the list of events for which the CPE supports definition of tones. If this table is supported, VoiceProfile.{i}.Tone.EventNumberOfEntries MUST be present.
At most one entry in this table can exist with a given value for Function, or with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Tone.Description.{i}. | object | W | Each entry in this table defines the contents of an individual tone. If ability to add, delete, and modify entries in this table is supported, Capabilities.ToneDescriptionsEditable MUST be true. If this table is supported, VoiceProfile.{i}.Tone.DescriptionNumberOfEntries MUST be present. The defaults given for this object apply only to explicit creation of an instance of this object and not to automatic creation of instances of this object due to creation of a parent object.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for EntryID. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Tone.Pattern.{i}. | object | W | Each entry in the table defines a single phase in an overall tone pattern. Each phase identifies the entry that corresponds to the next phase. Each entry in the table refers to the entry that corresponds to the next phase of the pattern. The table MAY be set up such that entries form loops, or MAY end after a finite sequence. If this object is supported, Capabilities.PatternBasedToneGeneration MUST be equal to true, and VoiceProfile.{i}.Tone.PatternNumberOfEntries MUST be present. If ability to add, delete, and modify entries in this table is supported, Capabilities.ToneDescriptionsEditable MUST be equal to true. The defaults given for this object apply only to explicit creation of an instance of this object and not to automatic creation of instances of this object due to creation of a parent object.
At most one entry in this table can exist with a given value for EntryID, or with a given value for Alias. On creation of a new table entry, the CPE MUST choose initial values for EntryID and Alias such that the new entry does not conflict with any existing entries. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.ButtonMap. | object | - | This object is provided to permit the purpose of the CPE buttons and function keys to be defined via the ACS. Support of this object is appropriate only for a device that has programmable buttons in its user interface. If this object is supported, Capabilities.ButtonMap MUST be equal to true. Applicable only for a VoIP endpoint. |
- | 1.0 |
| VoiceService.{i}.VoiceProfile.{i}.ButtonMap.Button.{i}. | object | - | Each entry in this table specifies the purpose of each programmable CPE button / function key and whether the user has permission to reprogram the button.
At most one entry in this table can exist with a given value for ButtonName, or with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}. | object | W | Object associated with a distinct voice line. Support for adding and removing lines is conditional on whether the CPE supports more than one line in total as indicated by Capabilities.MaxLineCount. By default, on creation of a given VoiceProfile.{i}., a single Line object MUST be present, initially with value Disabled. Applicable only for a VoIP endpoint.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DirectoryNumber. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.SIP. | object | - | Voice line parameters that are specific to SIP call signaling. | - | 1.0 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.SIP.EventSubscribe.{i}. | object | - | Table of SIP Events automatically populated by the CPE with each of the SIP event subscriptions in VoiceProfile.{i}.SIP.EventSubscribe.{i}.. This table allows specification of the authentication credentials needed for each event subscription. If this table is supported, Capabilities.SIP.EventSubscription MUST be equal to true and VoiceProfile.{i}.Line.{i}.SIP.SIPEventSubscribeNumberOfElements MUST be present.
At most one entry in this table can exist with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Ringer. | object | - | This object defines the ring sequences generated by the VoIP device. If this object is supported, Capabilities.RingGeneration MUST be equal to true. |
- | 1.0 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Ringer.Event.{i}. | object | - | Table of events for which a ring pattern is defined. The table is pre-populated with the complete list of events for which the CPE supports definition of ring patterns. If this table is supported, VoiceProfile.{i}.Line.{i}.Ringer.EventNumberOfEntries MUST be present.
At most one entry in this table can exist with a given value for Function, or with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Ringer.Description.{i}. | object | W | Each entry in this table defines the contents of an individual ring specification. If ability to add, delete, and modify entries in this table is supported, Capabilities.RingDescriptionsEditable MUST be equal to true. If this table is supported, the parameter DescriptionNumberOfEntries in the parent object MUST be present. The defaults given for this object apply only to explicit creation of an instance of this object and not to automatic creation of instances of this object due to creation of a parent object.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for EntryID. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Ringer.Pattern.{i}. | object | W | Each entry in the table defines a single phase in an overall ring pattern. Each phase identifies the entry that corresponds to the next phase. Each entry in the table refers to the entry that corresponds to the next phase of the pattern. The table MAY be set up such that entries form loops, or MAY end after a finite sequence. If this object is supported, Capabilities.PatternBasedRingGeneration MUST be equal to true and VoiceProfile.{i}.Line.{i}.Ringer.PatternNumberOfEntries MUST be present. If ability to add, delete, and modify entries in this table is supported, Capabilities.RingPatternEditable MUST be equal to true. The defaults given for this object apply only to explicit creation of an instance of this object and not to automatic creation of instances of this object due to creation of a parent object.
At most one entry in this table can exist with a given value for EntryID, or with a given value for Alias. On creation of a new table entry, the CPE MUST choose initial values for EntryID and Alias such that the new entry does not conflict with any existing entries. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Codec. | object | - | This object indicates the state of the transmit and receive codec for this voice line instance. | - | 1.0 |
| VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Codec.List.{i}. | object | - | Table to describe the set of codecs enabled for use with this line. Each entry in this table refers to a distinct combination of codec and bit rate. When an instance of VoiceProfile.{i}.Line.{i}. is created, this object MUST be populated with the set of supported codecs matching Capabilities.Codecs.. The ACS MAY restrict and/or prioritize the codec support for this profile using this object. Applicable only for a VoIP endpoint.
At most one entry in this table can exist with a given value for EntryID, or with the same values for Codec and BitRate, or with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| VoiceService.{i}.PhyInterface.{i}. | object | - | Each instance is associated with a distinct physical FXS (Foreign eXchange Station) port. Instances of this object are statically created by the CPE. Applicable only for a VoIP Endpoint.
At most one entry in this table can exist with a given value for InterfaceID, or with a given value for PhyPort, or with a given value for Alias. |
- | 1.0 |
| Alias | string(64) | W | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.1 |
| 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 via AddObject and DeleteObject is REQUIRED. |
| A | Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED. |
| D | Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED. |