Broadband Forum

TR-069 VoiceService:2.0 Service Object definition [USP]

tr-104-2-0-1-usp.xml

DATA MODEL DEFINITION

License

Copyright (c) 2009-2019, Broadband Forum

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.

Data Types

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 types.

Data Type Base Type Description
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 [SOAP1.1].
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.

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.

Alias string(:64)

A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.
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:

  • 216.52.29.100
  • 192.168.1.254

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:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

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.

StatsCounter32 unsignedInt

A 32-bit statistics parameter, e.g. a byte counter.

This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters.

The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1.

The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

StatsCounter64 unsignedLong

A 64-bit statistics parameter, e.g. a byte counter.

This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt.

The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

References

[3GPP_TS_24.229] 3GPP TS 24.229, IP Multimedia Call Control Protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3, 3GPP CT WG1.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[ETSI_EN_300_175-5] ETSI EN 300 175-05, Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 5: Network (NWK) layer, ETSI.
[ETSI_EN_300_175-6] ETSI EN 300 175-6, Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 6: Identities and addressing, ETSI.
[ETSI_EN_300_175-7] ETSI 300 175-7, Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 7: Security features, ETSI.
[ETSI_EN_300_175-8] ETSI 300 175-8, Digital Enhanced Cordless Telecommunications (DECT); Common Interface (CI); Part 8: Speech and audio coding and transmission, ETSI.
[ETSI_EN_300_444] ETSI EN 300 444, Digital Enhanced Cordless Telecommunications (DECT); Generic Access Profile (GAP), ETSI.
[ETSI_ES_201_970] ETSI ES 201 970, Access and Terminals (AT); Public Switched Telephone Network (PSTN); Harmonized specification of physical and electrical characteristics at a 2-wire analogue presented Network Termination Point (NTP), ETSI.
[ETSI_ES_203_021] ETSI ES 203 021, Access and Terminals (AT); Harmonized basic attachment requirements for Terminals for connection to analogue interfaces of the Telephone Networks, ETSI.
[ETSI_TR_101_183] ETSI TR 101 183, Public Switched Telephone Network (PSTN); Analogue ringing signals, ETSI.
[ETSI_TS_102_527-1] ETSI TS 102 527-1, Digital Enhanced Cordless Telecommunications (DECT); New Generation DECT; Part 1: Wideband speech, ETSI.
[ETSI_TS_102_527-3] ETSI TS 102 527-3, Digital Enhanced Cordless Telecommunications (DECT); New Generation DECT; Part 3: Extended wideband speech services, ETSI.
[ETSI_TS_102_527-4] ETSI TS 102 527-4, Digital Enhanced Cordless Telecommunications (DECT); New Generation DECT; Part 4: Light Data Services; Software Update Over The Air (SUOTA), content downloading and HTTP based applications, ETSI.
[ETSI_TS_102_527-5] ETSI TS 102 527-5, Digital Enhanced Cordless Telecommunications (DECT); New Generation DECT; Part 5: Additional feature set nr. 1 for extended wideband speech services, ETSI.
[ETSI_TS_181_019] ETSI TS 181 019, Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN), ETSI.
[H.235.1] H.235.1, H.323 security framework: Baseline security profile, ITU-T.
[H.323] H.323, Packet-based multimedia communications systems, ITU-T.
[I.251.1] I.251.1, Number identification supplementary services : Direct-dialling-In, ITU-T.
[I.251.2] I.251.2, Number identification supplementary services : Multiple Subscriber Number, ITU-T.
[I.251.7] I.251.7, Number identification supplementary services : Malicious call Identification, ITU-T.
[I.252.7] I.252.7, Call offering supplementary services : Explicit call transfer, ITU-T.
[I.256.2a] I.256.2a, Charging supplementary services : Advice of charge: charging information at call set-up time (AOC-S), ITU-T.
[I.256.2b] I.256.2b, Charging supplementary services : Advice of charge: charging information during the call (AOC-D), ITU-T.
[I.256.2c] I.256.2c, Charging supplementary services : Advice of charge: charging information at the end of the call (AOC-E), ITU-T.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[IANA_Event_Packages] IANA SIP Event packages and Event-template packages Registry, Session Initiation Protocol (SIP) Event Types Namespace, IANA.
[IANA_SIP_Methods] IANA SIP Methods Registry, Session Initiation Protocol (SIP) Parameters : Methods and Response Codes, IANA.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[ISO3166-1] ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006.
[Q.931] Q.931, ISDN user-network interface layer 3 specification for basic call control., ITU-T.
[RFC2198] RFC 2198, RTP Payload for Redundant Audio Data, IETF.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC3261] RFC 3261, SIP: Session Initiation Protocol, IETF, June 2002.
[RFC3435] RFC 3435, Media Gateway Control Protocol (MGCP) Version 1.0, IETF.
[RFC3550] RFC 3550, RTP: A Transport Protocol for Real-Time Applications, IETF, July 2003.
[RFC3611] RFC 3611, RTP Control Protocol Extended Reports (RTCP XR), IETF.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4733] RFC 4733, RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals, IETF.
[RFC6140] RFC 6140, Registration for Multiple Phone Numbers in the Session Initiation Protocol (SIP), IETF.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[T.38] T.38, Procedures for real-time Group 3 facsimile communication over IP networks., ITU-T.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, July 2011.
[TR-104i2] TR-104 Issue 2, Provisioning Parameters for VoIP CPE, Broadband Forum, March 2014.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2013.
[Y.1540] Y.1540, IP packet transfer and availability performance parameters, ITU-T.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

Object definition.
Mount point definition.
Parameter definition.
Command or Event definition.
Command Input / Output Arguments container.
Command or Event Object Input / Output Argument definition.
Command or Event Parameter Input / Output Argument definition.

VoiceService:2.0 Data Model

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.4, then it will indicate support for version 1.4. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
VoiceServiceNumberOfEntries unsignedInt R The number of entries in the VoiceService table. - 2.0
VoiceService.{i}. object(0:) R

The top-level object for CPE with voice capabilities.

At most one entry in this table can exist with a given value for Alias.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoIPProfileNumberOfEntries unsignedInt R The number of entries in the VoIPProfile table. - 2.0
CodecProfileNumberOfEntries unsignedInt R The number of entries in the CodecProfile table. - 2.0
InterworkNumberOfEntries unsignedInt R The number of entries in the Interwork table. - 2.0
TrunkNumberOfEntries unsignedInt R The number of entries in the Trunk table. - 2.0
CallLogNumberOfEntries unsignedInt R

The number of entries in the CallLog table.

The value MUST be less than or equal to Capabilities.MaxCallLogCount.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
TerminalNumberOfEntries unsignedInt R The number of entries in the Terminal table. - 2.0
VoiceService.{i}.Capabilities. object R The overall capabilities of the VoIP CPE. - 2.0
MaxLineCount int(-1:) R

Maximum total number of CallControl.Line objects supported.

A value of -1 indicates no specific limit on the number of lines.

- 2.0
MaxExtensionCount int(-1:) R

Maximum total number of CallControl.Extension objects supported.

A value of -1 indicates no specific limit on the number of extensions.

- 2.0
MaxCallLogCount int(-1:) R

Maximum total number of CallLog objects supported.

A value of -1 indicates no specific limit on the number of call logs.

- 2.0
MaxSessionsPerLine int(-1:) R

Maximum number of voice sessions supported for any given CallControl.Line object. A value greater than one indicates support for CPE-provided conference calling.

A value of -1 indicates no specific limit on the number of voice sessions per line.

- 2.0
MaxSessionsPerExtension int(-1:) R

Maximum number of voice sessions supported for any given CallControl.Extension object. A value greater than one indicates support for CPE-provided conference calling.

A value of -1 indicates no specific limit on the number of voice sessions per extension.

- 2.0
MaxSessionCount int(-1:) R

Maximum total number of voice sessions supported across all CallControl.Line objects. (This might differ from MaxLineCount if each line can support more than one session for CPE-provided conference calling. This value MAY be less than the product of MaxLineCount and MaxSessionsPerLine.)

A value of -1 indicates no specific limit on the number of voice sessions.

- 2.0
NetworkConnectionModes string[] R

Comma-separated list of strings. Each item is a supported network connection mode. Each list item matches one of:

  • SIP(/\d+\.\d+)?
  • MGCP(/\d+\.\d+)?
  • MGCP-NCS(/\d+\.\d+)?
  • H\.248(/\d+\.\d+)?
  • H\.323(/\d+\.\d+)?
  • DSS1
  • FXO
  • X_.+

Most entries MAY be appended with a version indicator in the form “/X.Y”. For example:

“SIP/2.0”

The list MAY include vendor-specific modes, which MUST be in the format defined in [TR-106]. For example:

“X_EXAMPLE-COM_MyMode”

- 2.0
UserConnectionModes string[] R

Comma-separated list of strings. Each item is a supported user connection mode. Each list item matches one of:

  • SIP(/\d+\.\d+)?
  • DSS1
  • FXS
  • DECT(/\d+\.\d+)?
  • Button
  • Virtual
  • X_.+

Most entries MAY be appended with a version indicator in the form “/X.Y”. For example:

“SIP/2.0”

The list MAY include vendor-specific modes, which MUST be in the format defined in [TR-106]. For example:

“X_EXAMPLE-COM_MyMode”

- 2.0
ToneFileFormats string[] R

Comma-separated list of strings. Each item is a supported tone file format. The specified file formats are raw codec data files, using one of the codecs listed below. Each list item is an enumeration of:

  • G.711MuLaw
  • G.711ALaw
  • G.729
  • MP3
  • WAV
  • AMR

The list MAY include vendor-specific -specific extensions, which MUST use the format defined in [TR-106].

Example:

“G.711MuLaw, MP3, X_EXAMPLE-COM_MyFileFormat”

If the CPE does not support tone files, this parameter MUST be an empty string.

- 2.0
RingFileFormats string[] R

Comma-separated list of strings. Each item is a supported ring file format. Each list item is an enumeration of:

  • MIDI
  • SMAF (MMF)
  • RTTTL (RTTTL or RTX)
  • MP3
  • WAV
  • AMR

The list MAY include vendor-specific-specific extensions, which MUST use the format defined in [TR-106].

Example:

“MIDI, AMR, X_EXAMPLE-COM_MyFileFormat”

If the CPE does not support ring files, this parameter MUST be an empty string.

- 2.0
FacilityActions string[] R

Comma-separated list of strings. The facility actions supported by this VoiceService. Each list item is an enumeration of:

  • AA_REGISTER (Register an “Abbreviated Address” and corresponding destination. Abbreviated Addressing permits a user to define short numbers (within a particular range) to represent commonly used destinations)
  • AA_ERASE (Remove an “Abbreviated Address”)
  • AA_INTERROGATE (Interrogate the status of an “Abbreviated Address”)
  • CA_ACTIVATE (Make this call an anonymous call)
  • CCBS_ACTIVATE (Activation of Call Completion to Busy Subscriber. Call completion to Busy Subscriber is a facility that permits the user to request an automatic call back when a currently busy destination becomes available)
  • CCBS_DEACTIVATE (Deactivation of Call Completion to Busy Subscriber)
  • CCBS_INTERROGATE (Interrogation of the Call Completion to Busy Subscriber status and destination)
  • CCNR_ACTIVATE (Activation of Call Completion on No Reply. Call completion on no reply is a facility that permits the user to request an automatic call back when activity (eg a phone call is made) is detected from a destination from which there is currently no reply)
  • CCNR_DEACTIVATE (Deactivation of Call Completion on No Reply)
  • CCNR_INTERROGATE (Interrogation of the Call Completion on No Reply status and destination)
  • CFB_REGISTER (Register the destination for Call Forwarding on Busy. Set the parameter CallControl.CallingFeatures.Set.{i}.CallForwardOnBusyNumber of this extension. If Call Forwarding on Busy is activated, the call will be forwarded to the specified destination if the extension is “busy”)
  • CFB_ACTIVATE (Activate Call Forwarding on Busy to the registered destination)
  • CFB_DEACTIVATE (Deactivate Call Forwarding on Busy to the registered destination)
  • CFB_ERASE (Erase the registered Call Forwarding on Busy Destination)
  • CFB_INTERROGATE (Interrogate the registered Call Forwarding on Busy Destination)
  • CFNR_REGISTER (Register the destination for Call Forwarding on No Reply. Set the parameter CallControl.CallingFeatures.Set.{i}.CallForwardOnNoAnswerNumber of this extension. If Call Forwarding on No Reply is activated, the call will be forwarded to the specified destination if the extension does not reply before the time expires)
  • CFNR_ACTIVATE (Activate Call Forwarding on No Reply to the registered destination)
  • CFNR_DEACTIVATE (Deactivate Call Forwarding on No Reply to the registered destination)
  • CFNR_ERASE (Erase the registered Call Forwarding on No Reply Destination)
  • CFNR_INTERROGATE (Interrogate the registered Call Forwarding on No Reply Destination)
  • CFNR_TIMER (Set the parameter CallControl.CallingFeatures.Set.{i}.CallForwardOnNoAnswerRingTimeout of this extension)
  • CFT_ACTIVATE (Activate Call Forwarding Timed. This facility permits the user to forward calls to particular destinations depending on the time of day : cf. table CallControl.CallingFeatures.Set.{i}.CFT.{i}.)
  • CFT_DEACTIVATE (Deactivate Call Forwarding Timed)
  • CFT_INTERROGATE (Interrogate the status of Call Forwarding Timed)
  • CFU_REGISTER (Register the destination for Call Forwarding Unconditional. Set the parameter CallControl.CallingFeatures.Set.{i}.CallForwardUnconditionalNumber of this extension. If Call Forwarding on Busy is activated, the call will be forwarded to the specified destination if the extension is “busy”)
  • CFU_ACTIVATE (Activate Call Forwarding Unconditional to the registered destination)
  • CFU_DEACTIVATE (Deactivate Call Forwarding Unconditional to the registered destination)
  • CFU_ERASE (Erase the registered Call Forwarding Unconditional Destination)
  • CFU_INTERROGATE (Interrogate the registered Call Forwarding Unconditional Destination)
  • CLIR_ACTIVATE (Activate Calling Line Identification Restriction (i.e. your calling number will be restricted). Set the parameter CallControl.CallingFeatures.Set.{i}.AnonymousCallEnable to true)
  • CLIR_DEACTIVATE (Deactivate Calling Line Identification Restriction)
  • CLIR_INTERROGATE (Interrogate the Calling Line Identification status)
  • CP_INVOKE (Invoke Carrier Prefix. The prefix is prepended to the destination number. The facility argument will reference the Carrier Prefix)
  • CW_ACTIVATE (Activate Call Waiting. Set the parameter CallControl.CallingFeatures.Set.{i}.CallWaitingEnable to true)
  • CW_DEACTIVATE (Deactivate Call Waiting)
  • CW_INVOKE (Used for answering a waiting call or switching between calls)
  • DND_ACTIVATE (Activate Do Not Disturb on the extension. Set the parameter CallControl.CallingFeatures.Set.{i}.DoNotDisturbEnable of this extension. Selective Ringing is a facility that permits the user to specify the generation of different ring tones depending on the calling number)
  • DND_DEACTIVATE (Deactivate Do Not Desturb)
  • DND_INTERROGATE (Interrogate the status of Do Not Disturb)
  • EXT_INVOKE (Invoke an extension. The extension referenced in the facility argument will be used as destination instead of the line defined in CallControl.OutgoingMap.{i}.)
  • LINE_INVOKE (Invoke a line. The line referenced in the facility argument will be used for an outgoing call instead of the line defined in CallControl.OutgoingMap.{i}.)
  • MAILBOX_INVOKE (Invoke a mailbox. The interactive menu to listen and manipulate voicemail messages will be invoked)
  • OCB_ACTIVATE (Activate Outgoing Call Barring. Outgoing call barring is a facility that permits the user to bar calls to certain destinations—usually depending on the cost of a call)
  • OCB_DEACTIVATE (Deactivate Outgoing Call Barring)
  • OCB_INTERROGATE (Interrogate Outgoing Call Barring)
  • PSO_ACTIVATE (Switch the call to a PSTN line)
  • PW_SET (Set the password used for controlling access to the Facility Actions)
  • SCF_ACTIVATE (Activate Selective Call Forwarding. This facility permits the user to forward calls to different destinations depending on the calling number : cf. table CallControl.CallingFeatures.Set.{i}.SCF.{i}.)
  • SCF_DEACTIVATE (Deactivate Selective Call Forwarding)
  • SCF_INTERROGATE (Interrogate the status of Selective Call Forwarding)
  • SCREJ_ACTIVATE (Activate Selective Call Rejection. This facility permits the user to selectively reject calls depending on the calling number : cf. table CallControl.CallingFeatures.Set.{i}.SCREJ.{i}.)
  • SCREJ_DEACTIVATE (Deactivate Selective Call Rejection)
  • SCREJ_INTERROGATE (Interrogate the status of Selective Call Rejection)
  • SR_ACTIVATE (Activate Selective Ringing. Selective Ringing is a facility that permits the user to specify the generation of different ring tones depending on the calling number)
  • SR_DEACTIVATE (Deactivate Selective Ringing)
  • SR_INTERROGATE (Interrogate the status of Selective Ringing)

The list MAY include vendor-specific Facility Actions, which MUST use the format defined in [TR-106].

Facility Actions are referenced in the VoiceService data model in the objects CallControl.NumberingPlan.{i}.PrefixInfo.{i}. and Terminal.{i}.ButtonMap.Button.{i}..

- 2.0
CodecNumberOfEntries unsignedInt R The number of entries in the Codec table. - 2.0
VoiceService.{i}.Capabilities.SIP. object R SIP-specific capabilities (as defined in [RFC3261]). - 2.0
VoiceService.{i}.Capabilities.SIP.Client. object R SIP client capabilities. - 2.0
Extensions string[] R

Comma-separated list of strings. Each item is a supported SIP extension method among the methods listed in the IANA SIP parameters registry (see [IANA_SIP_Methods]). SIP extension methods MUST be in the form of the method name in upper case.

The list MAY include vendor-specific extensions, which MUST use the format defined in [TR-106].

Examples:

“REFER”
“INFO”
“X_EXAMPLE-COM_MyExt”
- 2.0
URISchemes string[] R

Comma-separated list of strings. Each item is a supported URI scheme beyond the URI schemes REQUIRED by the SIP specification ([RFC3261]). Each URI scheme is given by the URI prefix, without the colon separator. Example:

“tel, fax”

- 2.0
EventTypes string[] R

Comma-separated list of strings. Each item is a supported event package among the event packages listed in the IANA registry for SIP Event Type Namespace (see [IANA_Event_Packages]).

The list MAY include vendor-specific event packages, which MUST use the format defined in [TR-106].

Examples:

“call-completion”
“presence”
“X_EXAMPLE-COM_MyEvtPkg”
- 2.0
TLSAuthenticationProtocols string[] R

Comma-separated list of strings. Each item is a supported authentication protocol for TLS transport. Each list item is an enumeration of:

  • Null
  • MD5
  • SHA-1
  • SHA-2
  • AEAD

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
TLSAuthenticationKeySizes unsignedInt[] R Comma-separated list of unsigned integers. Each item represents a supported TLS authentication key size. - 2.0
TLSEncryptionProtocols string[] R

Comma-separated list of strings. Each item is a supported encryption protocol for TLS transport. Each list item is an enumeration of:

  • Null
  • RC4
  • RC2
  • DES
  • 3DES
  • AES
  • Camellia

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
TLSEncryptionKeySizes unsignedInt[] R Comma-separated list of unsigned integers. Each item is a supported TLS encryption key size. - 2.0
TLSKeyExchangeProtocols string[] R

Comma-separated list of strings. Each item is a supported key exchange protocol for TLS transport. Each list item is an enumeration of:

  • RSA
  • DSS
  • DHE-RSA
  • DHE-DSS
  • ECDHE-RSA
  • ECDHE-ECDSA

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
VoiceService.{i}.Capabilities.SIP.Registrar. object R SIP registrar capabilities. - 2.0
Extensions string[] R

Comma-separated list of strings. Each item is a supported SIP extension method among the methods listed in the IANA SIP parameters registry (see [IANA_SIP_Methods]). SIP extension methods MUST be in the form of the method name in upper case.

The list MAY include vendor-specific extensions, which MUST use the format defined in [TR-106].

Examples:

“REFER”
“INFO”
“X_EXAMPLE-COM_MyExt”
- 2.0
URISchemes string[] R

Comma-separated list of strings. Each item is a supported URI scheme beyond the URI schemes REQUIRED by the SIP specification. Each URI scheme is given by the URI prefix, without the colon separator. Example:

“tel, fax”

- 2.0
EventTypes string[] R

Comma-separated list of strings. Each item is a supported event package among the event packages listed in the IANA registry for SIP Event Type Namespace (see [IANA_Event_Packages]).

The list MAY include vendor-specific event packages, which MUST use the format defined in [TR-106].

Examples:

“call-completion”
“presence”
“X_EXAMPLE-COM_MyEvtPkg”
- 2.0
TLSAuthenticationProtocols string[] R

Comma-separated list of strings. Each item is a supported authentication protocol for TLS transport. Each list item is an enumeration of:

  • Null
  • MD5
  • SHA-1
  • SHA-2
  • AEAD

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
TLSAuthenticationKeySizes unsignedInt[] R Comma-separated list of unsigned integers. Each item represents a supported TLS authentication key size. - 2.0
TLSEncryptionProtocols string[] R

Comma-separated list of strings. Each item is a supported encryption protocol for TLS transport. Each list item is an enumeration of:

  • Null
  • RC4
  • RC2
  • DES
  • 3DES
  • AES
  • Camellia

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
TLSEncryptionKeySizes unsignedInt[] R Comma-separated list of unsigned integers. Each item is a supported TLS encryption key size. - 2.0
TLSKeyExchangeProtocols string[] R

Comma-separated list of strings. Each item is a supported key exchange protocol for TLS transport. Each list item is an enumeration of:

  • RSA
  • DSS
  • DHE-RSA
  • DHE-DSS
  • ECDHE-RSA
  • ECDHE-ECDSA

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
VoiceService.{i}.Capabilities.MGCP. object R MGCP-specific capabilities (as defined in [RFC3435]). - 2.0
Extensions string[] R

Comma-separated list of strings. Each item is a supported optional MGCP package. MGCP packages are listed using the uppercase package abbreviation.

The list MAY include vendor-specific extensions, which MUST use the format defined in [TR-106].

Examples:

“BP”
“X_EXAMPLE-COM_MyExt”
- 2.0
VoiceService.{i}.Capabilities.H323. object R H.323-specific capabilities (as defined in [H.323]). - 2.0
FastStart boolean R Support for H.323 fast start. If true indicates support for fast start. - 2.0
H235AuthenticationMethods string[] R

Comma-separated list of strings. Each item is a supported authentication method. Each list item is an enumeration of:

  • dhExch (Diffie-Hellman)
  • pwdSymEnc (password with symmetric encryption)
  • pwdHash (password with hashing)
  • certSign (certificate with signature)
  • ipsec (IPsec based connection)
  • tls (TLS)

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106a7].

- 2.0
VoiceService.{i}.Capabilities.ISDN. object R The overall ISDN capabilities of external ports of the CPE. - 2.0
MSN boolean R The external ISDN ports support [I.251.2] Number identification supplementary services: Multiple Subscriber Number - 2.0
DDI boolean R The external ISDN ports support [I.251.1] Number identification supplementary services: Direct-dialling-In - 2.0
MCID boolean R The external ISDN ports support [I.251.7] Number identification supplementary services: Malicious call Identification - 2.0
MWI boolean R The external ISDN ports support Message Waiting Indication (MWI) - 2.0
AoC boolean R

The external ISDN ports support one or more of the followings AOC-services:

[I.256.2a] Charging supplementary services: Advice of charge: charging information at call set-up time (AOC-S)

[I.256.2b] Charging supplementary services: Advice of charge: charging information during the call (AOC-D)

[I.256.2c] Charging supplementary services: Advice of charge: charging information at the end of the call (AOC-E)

- 2.0
ECT boolean R

The external ISDN ports support [I.252.7] Call offering supplementary services:

Explicit call transfer (ECT)

- 2.0
VoiceService.{i}.Capabilities.POTS. object R The overall POTS capabilities of external ports of the CPE. - 2.0
DialType string R

The supported supported dial type.

Enumeration of:

  • Tone (Supports Tone dialling)
  • Pulse (Supports Pulse dialling)
  • Tone and Pulse (Supports Tone and Pulse dialling)
- 2.0
ClipGeneration boolean R The external POTS ports support Calling Line identification (CLIP). - 2.0
ChargingPulse boolean R The external POTS ports support transmittal of a charging pulse according to TR1 TR 110. - 2.0
VoiceService.{i}.Capabilities.Codec.{i}. object(0:) R

Table to describe the set of supported codecs.

At most one entry in this table can exist with a given value for Alias, or with the same values for both Codec and BitRate.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Codec string R

Identifier of the type of codec. Enumeration of:

  • AMR
  • Clearmode (RFC4040)
  • EVRC1
  • EVRCB1
  • G.711MuLaw
  • G.711ALaw
  • G.726
  • G.729
  • G.729.1
  • G.729a
  • G.729e
  • G.728
  • G.723.1
  • G.722
  • G.722.1
  • G.722.2
  • Generic Comfort Noise (RFC3389)
  • GSM-FR
  • GSM-HR
  • GSM-EFR
  • iLBC
  • Speex

The parameter MAY instead be a vendor-specific codec, which MUST be in the format defined in [TR-106]. For example:

“X_EXAMPLE-COM_MyCodec”

- 2.0
BitRate unsignedInt R Bit rate, specified in bits per second. The value MUST be among the values appropriate for the specified codec. - 2.0
PacketizationPeriod string(:64)[] R

Comma-separated list of strings (maximum number of characters per item 64). Each item is a supported packetization period, in milliseconds, or a continuous range of packetization periods. Ranges are indicated as a hyphen-separated pair of unsigned integers. Examples:

“20” indicates a single discrete value.
“10, 20, 30” indicates a set of discrete values.
“5-40” indicates a continuous inclusive range.
“5-10, 20, 30” indicates a continuous range in addition to a set of discrete values.

A range MUST only be indicated if all values within the range are supported.

- 2.0
SilenceSuppression boolean R If true indicates support for silence suppression for this codec. - 2.0
VoiceService.{i}.Capabilities.QualityIndicator. object R Specific capabilities concerning quality indicators. - 2.0
QIModelsSupported string R

Comma-separated list of supported models for evaluation of VoIP Quality Indicator. An empty string indicates that CPE does not support evaluation of this indicator.

The entry MAY include vendor-specific models, which MUST be in the format defined in [TR-106].

For example: “P.564,G.107,X_EXAMPLE-COM_MyModel”

- 2.0
MaxQIValues unsignedInt(0:127) R

Specifies the maximum number of QI values which can be reported for a session. If this parameter is empty there is no specified maximum limit.

If possible this limit SHOULD be large enough to handle at least 10 to 15 minutes of call time, which would typically mean 60 to 90 quality values for commonly used quality models.

- 2.0
MaxWorstQIValues unsignedInt(0:127) R Maximum number of worst QI values which the CPE is able to store and report. A value of 0 indicates no specific maximum number of worst QI values. - 2.0
VoiceService.{i}.ReservedPorts. object R The list of IP ports on the CPE WAN and LAN interfaces that will not be allocated by the ACS and therefore are available to be allocated by the CPE. The CPE can dynamically allocate ports from this range for things like signaling listening ports or local RTP ports. - 2.0
WANPortRange string[] W

Range of ports reserved for use by the CPE on any WAN interface. Comma-separated list of strings. Each range consists of a Start part consisting of 1 to n digits (string representation) followed by an OPTIONAL End part consisting of 1 to n digits prefixed by a “-” symbol.

Example:

12345-12350,23580
- 2.0
LANPortRange string[] W

Range of ports reserved for use by the CPE on any LAN interfaces. Comma-separated list of strings. Each range consists of a Start part consisting of 1 to n digits (string representation) followed by an OPTIONAL End part consisting of 1 to n digits prefixed by a “-” symbol.

Example:

12345-12350,23580
- 2.0
VoiceService.{i}.ISDN. object R This object models ISDN physical interfaces (BRI and PRI) supporting [Q.931] based signalling. - 2.0
BRINumberOfEntries unsignedInt R The number of entries in the BRI table. - 2.0
PRINumberOfEntries unsignedInt R The number of entries in the PRI table. - 2.0
VoiceService.{i}.ISDN.BRI.{i}. object(0:) R

ISDN BRI physical interfaces table (a voice physical interface as described in [Section 4.1/TR-104i2]).

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 2.0
Enable boolean W Enables or disables this ISDN BRI interface. - 2.0
Status string R

Indicates the status of this physical interface.

Enumeration of:

  • Up
  • Error
  • Testing
  • Disabled
- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

The textual name of the interface as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

- 2.0
ToneEventProfile string(:256) W The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the Tone.EventProfile to use with this interface. If this parameter is an empty string, the value of Tone.DefaultEventProfile is used instead. - 2.0
ApplicationInterface string W

Specify the type of application that uses the interface.

Enumeration of:

  • VoIP
  • VoATM
  • Data
- 2.0
Protocol string W

Specifies the protocol variant used for the interface. Enumeration of:

  • EuroISDN (ETSI defined Euro ISDN (DSS1))
  • NI-1 (National ISDN-1 (Bellcore))
  • NI-2 (National ISDN-2 (Bellcore)))
  • 5ESS (AT&T ISDN)
  • NTT (Japanese NTT ISDN)
  • VN3 (French VN3 ISDN)
  • VN4 (French VN4 ISDN)
  • Q.SIG

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
ProtocolEmulation string W

Protocol emulation for the interface.

Enumeration of:

  • TE
  • NT
- 2.0
PermanentLayer2 boolean W If true, avoid the disconnection of the ISDN layer 2 when the ISDN terminal or the ISDN network disconnects the layer 2 (in static TEI mode); it will be maintained established. - 2.0
PermanentLayer1 boolean W Maintain the ISDN layer 1 up; it is useful for clocking and management. - 2.0
LapdDisconnectionTimeout boolean W Avoid the disconnection of the ISDN layer 1 or 2 up when there is no call in progress in dynamic TEI mode. - 2.0
TEINegotiation string W

TEI management mode. It MUST be set to Dynamic for ISDN phones or connection to an ISDN network and Static for PBX.

Enumeration of:

  • Static
  • Dynamic
- 2.0
StaticTEI unsignedInt(:63) W TEI value in static mode. - 2.0
LifeLineHold boolean W Enable or disable the lifeline bypass on the BRI S0 voice module. If the interface is used by the VoIP gateway, the bypass is enabled if the CPE is not registered on registration server. - 2.0
PowerSourceOne boolean W To enable (disable) the power source one (PS1) on the BRI interfaces. - 2.0
MaxNumBChannels unsignedInt(:2) W Maximum number of simultaneous B channels. - 2.0
OutboundOnlyBChannels unsignedInt(1:2)[] W Comma-separated list of unsigned integers (1 to 2), reserved B-channels which can be used only for outbound calls. - 2.0
InboundOnlyBChannels unsignedInt(1:2)[] W Comma-separated list of unsigned integers (1 to 2), reserved B-channels which can be used only for inbound calls. - 2.0
BidirectionalBChannels unsignedInt(1:2)[] W Comma-separated list of unsigned integers (1 to 2), reserved B-channels which can be used bidirectional. - 2.0
VoiceService.{i}.ISDN.PRI.{i}. object(0:) R

ISDN PRI physical interfaces table (a voice physical interface as described in [Section 4.1/TR-104i2]).

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 2.0
Enable boolean W Enables or disables this ISDN PRI interface. - 2.0
Status string R

Indicates the status of this physical interface.

Enumeration of:

  • Up
  • Error
  • Testing
  • Disabled
- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

The textual name of the interface as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

- 2.0
ToneEventProfile string(:256) W The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the Tone.EventProfile to use with this interface. If this parameter is an empty string, the value of Tone.DefaultEventProfile is used instead. - 2.0
ApplicationInterface string W

Specify the type of application that uses the interface.

Enumeration of:

  • VoIP
  • VoATM
  • Data
- 2.0
Protocol string W

Specifies the protocol variant used for the interface. Enumeration of:

  • EuroISDN (ETSI defined Euro ISDN (DSS1, E-DSS1))
  • NI-1 (National ISDN-1 (Bellcore))
  • NI-2 (National ISDN-2 (Bellcore)))
  • 4ESS (AT&T 4ESS ISDN)
  • 5ESS (AT&T 5ESS ISDN)
  • NTT (Japanese INS-NET1500 ISDN)
  • Q.SIG

The list MAY include vendor-specific protocols, which MUST use the format defined in [TR-106].

- 2.0
ProtocolEmulation string W

Specify the protocol emulation for this interface.

Enumeration of:

  • TE
  • NT
- 2.0
PermanentLayer2 boolean W If true, avoid the disconnection of the ISDN layer 2 when the ISDN terminal or the ISDN network disconnects the layer 2 (in static TEI mode); it will be maintained established. - 2.0
Linecode string W

Specify the physical line coding to be used.

Enumeration of:

  • ami
  • hdb3
  • b8zs
- 2.0
ESF string W

Specify the framing type.

Enumeration of:

  • None (no framing. Only used for CES / unstructured mode)
  • DF (double frame, no CRC4. For E1 only)
  • MF (multiframe (CRC4). For E1 only)
  • EMF (extended multiframe (CRC4). For E1 only)
  • SF (super-frame. For T1 only)
  • ESF (extended super frame. For T1 only)
  • AutoDetect (used to find automatically ISDN PRI framing by trying all possible detections. This behavior can be set when the configuration of remote)
- 2.0
PhysicalInterfaceType string W

Enumeration of:

  • T1
  • E1
- 2.0
MaxNumBChannels unsignedInt(:30) W Maximum number of simultaneous B channels. - 2.0
OutboundOnlyBChannels unsignedInt(0:31)[] W Comma-separated list of unsigned integers (0 to 31), reserved B-channels which can be used only for outbound calls. - 2.0
InboundOnlyBChannels unsignedInt(0:31)[] W Comma-separated list of unsigned integers (0 to 31), reserved B-channels which can be used only for inbound calls. - 2.0
BidirectionalBChannels unsignedInt(0:31)[] W Comma-separated list of unsigned integers (0 to 31), reserved B-channels which can be used bidirectional. - 2.0
ClockMode string W

Determines the role of the CPE for the purpose of clock synchronisation on this interface.

Enumeration of:

  • Master
  • Slave
- 2.0
VoiceService.{i}.POTS. object R This object models analogue lines. Both FXO and FXS are handled. - 2.0
FXONumberOfEntries unsignedInt R The number of entries in the FXO table. - 2.0
FXSNumberOfEntries unsignedInt R The number of entries in the FXS table. - 2.0
Region string(:2) W

The geographic region associated to POTS (MUST be an alpha-2 (two-character alphabetic) country code as specified by [ISO3166-1]). This MAY be used by the CPE to customize localization settings.

If an empty string, indicates that the region is unspecified and the CPE SHOULD use default localization settings.

- 2.0
VoiceService.{i}.POTS.FXO.{i}. object(0:) R

FXO physical interfaces table (a voice physical interface as described in [Section 4.1/TR-104i2]).

Each entry in the table models an analogue physical interface as defined by [ETSI_ES_203_021]

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 2.0
Enable boolean W Enables or disables this FXO interface. - 2.0
Status string R

Indicates the status of this physical interface.

Enumeration of:

  • Up
  • Error
  • Testing
  • Disabled
- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

The textual name of the interface as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

- 2.0
ToneEventProfile string(:256) W The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the Tone.EventProfile to use with this interface. If this parameter is an empty string, the value of Tone.DefaultEventProfile is used instead. - 2.0
SecondStepDialing boolean W

Enables the second step dialing mode.

If false, incoming dialed digits are processed through the voice routing table.

If true, the FXO port goes directly to the off-hook state and works as a FXS port for the dialing reception (a dial-tone is transmitted). The received digits are processed through the routing table until a match is found. If a match is found, the call is routed to the appropriate subscriber.

The factory default value MUST be false.

- 2.0
TimeoutBeforeDialing unsignedInt(1:60) W Specifies the time in seconds between off-hook and the transmission of the first digit for FXO interface. - 2.0
RingingTimeout unsignedInt(1:30) W Defines the timeout in seconds for incoming call on this FXO port: after receiving a ringing signal, the call is disconnected if no ringing signal is received anymore during this time. - 2.0
RingNumber unsignedInt(1:40) W Defines the number of pulses for ringing signal detection on FXO port. - 2.0
OnHookMinDuration unsignedInt(20:10000) W Specify the minimum duration in milliseconds of the “on-hook” state between two successive calls. - 2.0
SignalingMode string W

Signaling mode used for line seizure by the CPE.

Enumeration of:

  • LoopStart
  • GroundStart

The factory default value MUST be LoopStart.

- 2.0
DTMFDialoutInterval unsignedInt(20:10000) W The time interval in milliseconds between dialing DTMF digits to PSTN. See also [ETSI_ES_203_021] - 2.0
CallerIdDetectionEnable boolean W Enables the detection of CallerId for incoming calls. See also [ETSI_ES_203_021]. - 2.0
Active boolean R Determines if this physical interface is plugged. - 2.0
DiagTests() command - [ASYNC] This command provides access to an FXO Port tests. - 2.0
⇒ Input. arguments - Input arguments. -
TestSelector string W

Indicates which test to perform. Enumeration of:

  • Battery (Tests for the presence of loop feed current; for a ground start line, also tests for polarity, to detect reversal of Tip and Ring)
  • DialTone (Closes the loop and checks for the presence of a dial tone)

The parameter MAY instead indicate a vendor-specific test, which MUST use the format defined in [TR-106]. For example: “X_EXAMPLE-COM_MyTest”

- 2.0
⇐ Output. arguments - Output arguments. -
Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
- 2.0
TestResult string R

Result of the selected test. Enumeration of:

  • Success
  • Failure

The parameter MAY instead indicate a vendor-specific result, which MUST use the format defined in [TR-106]. For example: “X_EXAMPLE-COM_MyResult”

- 2.0
VoiceService.{i}.POTS.FXS.{i}. object(0:) R

FXS physical interfaces table (a voice physical interface as described in [Section 4.1/TR-104i2]).

Each entry in the table models an analogue physical interface as defined by [ETSI_ES_201_970]

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 2.0
Enable boolean W Enables or disables this FXS interface. - 2.0
Status string R

Indicates the status of this physical interface.

Enumeration of:

  • Up
  • Error
  • Testing
  • Disabled
- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

The textual name of the interface as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

- 2.0
ToneEventProfile string(:256) W The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the Tone.EventProfile to use with this interface. If this parameter is an empty string, the value of Tone.DefaultEventProfile is used instead. - 2.0
FaxPassThrough string W

Indicates the support for pass-through of fax data of this interface. Enumeration of:

  • Disable (Prevents the CPE from switching to a fax pass-through mode)
  • Auto (Allows the CPE to automatically detect fax data to determine whether or not to switch to a fax pass-through mode)
  • Force (Forces the CPE to switch to a fax pass-through mode regardless of whether fax signaling is detected)
- 2.0
ModemPassThrough string W

Indicates the support for pass-through of modem data of this interface. Enumeration of:

  • Disable (Prevents the CPE from switching to a modem pass-through mode)
  • Auto (Allows the CPE to automatically detect modem data to determine whether or not to switch to a modem pass-through mode)
  • Force (Forces the CPE to switch to a modem pass-through mode regardless of whether modem signaling is detected)
- 2.0
DialType string W

Dial type used on the line.

Enumeration of:

  • Tone (Set the dial type to Tone dialling)
  • Pulse (Set the dial type to Pulse dialling)
- 2.0
ClipGeneration boolean W Whether the Calling Line identification (CLIP) is enabled. - 2.0
ChargingPulse boolean W Whether a charging pulse is transmitted on the line. - 2.0
Active boolean R Indicates whether a terminal is plugged on this physical interface. - 2.0
TerminalType string W

Defines the terminal type plugged on this interface to determine the correct signaling to be used to contact the terminal.

Enumeration of:

  • Audio
  • Fax
  • Modem
  • Any
- 2.0
DiagTests() command - [ASYNC] This command provides access to an FXS Port tests. - 2.0
⇒ Input. arguments - Input arguments. -
TestSelector string W

Indicates which GR-909 test to perform.

Enumeration of:

  • Hazard Potential (Hazard Potential test is failed if the TIP-GND or RING-GND AC voltage is greater than 50 volts rms or DC voltage is greater than 135 volts)
  • Foreign Voltage (Foreign Voltage test is failed if the TIP-GND or RING-GND AC voltage is greater than 10 volts or the TIP-GND or RING-GND DC voltage is greater than 6 volts)
  • Resistive Faults (Resistive Faults test is failed if a TIP-RING, TIP-GND or RING-GND on-hook DC resistance less than 150 k?)
  • Off-hook (Off-hook test is based upon criteria that permit the system to discriminate between a resistive fault and a receiver-off-hook condition. For example, a failure condition could be based on a non-linearity in the TIP-RING DC resistance of greater than 15% when measured at two different voltage levels)
  • REN (Ringer Equivalence Number test is failed when the equivalent ringer count across TIP and RING is less than 0.175 REN or greater than 5 REN)
- 2.0
⇐ Output. arguments - Output arguments. -
Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
- 2.0
TestResult string R

Result of the selected test.

Enumeration of:

  • Success
  • Failure
- 2.0
VoiceService.{i}.POTS.FXS.{i}.VoiceProcessing. object R Parameters related to voice processing (analogue/digital conversion) capabilities. - 2.0
TransmitGain int W Gain in 0.1 dB to apply to the transmitted voice signal prior to encoding. This gain is a modifier of the default transmit-gain, which is unspecified. - 2.0
ReceiveGain int W Gain in 0.1 dB to apply to the received voice signal after decoding. This gain is a modifier of the default receive-gain, which is unspecified. - 2.0
EchoCancellationEnable boolean W Enable or disable echo cancellation for this line. - 2.0
EchoCancellationInUse boolean R Indication of whether or not echo cancellation is currently in use for this line. - 2.0
EchoCancellationTail unsignedInt R Tail length in milliseconds of the echo canceller associated with this line (whether or not it is currently in use). - 2.0
VoiceService.{i}.POTS.Ringer. object R This object contains the ring sequences configured for analogue lines. - 2.0
EventNumberOfEntries unsignedInt R The number of entries in the Event table. - 2.0
VoiceService.{i}.POTS.Ringer.Event.{i}. object(0:) R

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.

At most one entry in this table can exist with a given value for Alias, or with a given value for Function.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Function string R

The event for which the ring pattern is to apply. Enumeration of:

  • Default
  • CCBSCallBack
  • CCNRCallBack
  • InternalCall
  • RingSplash
  • Group (Used when the FXS is being alerted as part of a call to an CallControl.Group.{i})

The parameter MAY instead indicate a vendor-specific event name, which MUST use the format defined in [TR-106].

- 2.0
Cadence unsignedInt[:10] W

Comma-separated list (up to 10 items) of unsigned integers. The values represent an alternating pattern of times (in milliseconds) when the ringer is ON or OFF.

Example: “1000,5000”

See also [ETSI_TR_101_183].

- 2.0
VoiceService.{i}.DECT. object R This object models DECT bases and portables. - 2.0
BaseNumberOfEntries unsignedInt R The number of entries in the Base table. - 2.0
PortableNumberOfEntries unsignedInt R The number of entries in the Portable table. - 2.0
VoiceService.{i}.DECT.Base.{i}. object(0:) R

DECT base table (a voice physical interface as described in [Section 4.1/TR-104i2]).

At most one entry in this table can exist with a given value for RFPI, or with a given value for Name, or with a given value for Alias.

- 2.0
Enable boolean W Enables or disables this base. - 2.0
Status string R

Indicates the status of this base.

Enumeration of:

  • Up
  • Error
  • Testing
  • Disabled
- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

The textual name of the interface as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

- 2.0
ToneEventProfile string(:256) W The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the Tone.EventProfile to use with this interface. If this parameter is an empty string, the value of Tone.DefaultEventProfile is used instead. - 2.0
Standard string R

The highest DECT protocol version supported by the base.

Enumeration of:

- 2.0
RFPI hexBinary(:5) R The Radio Fixed Part Identity which uniquely identifies the Base. The RFPI is a 40 bits number stored in a hexbinary string. The format of the number is class-dependant and is defined in [Sections 5.1 to 5.5/ETSI_EN_300_175-6]. - 2.0
MaxSupportedPP unsignedInt W The maximum number of Portable Parts (PP) supported by the DECT base of the CPE. - 2.0
PIN hexBinary(:4) W

The PIN is an hexbinary string of 32 bits, as defined in [ETSI_TS_102_527-3].

When read, this parameter returns an empty string, regardless of the actual value.

- 2.0
RepeaterSupportEnabled boolean R If true, the DECT system supports the REP feature, as defined in [ETSI_EN_300_175-8]. - 2.0
NEMOEnable boolean W Enable or disable NEMO (No Emission Mode as defined in [ETSI_TS_102_527-3]) operation of the base. Note: NEMO operations can be successfully enabled only if all PPs registered to the CPE support the NEMO operations. - 2.0
SubscriptionEnable boolean W

Enables the subscription mode of the DECT base. If true, the subscription window is open, otherwise it is closed. When the subscription window is open, a DECT portable part can be subscribed / registered to the DECT base. When written as true, it forces the device to open the subscription window. When the subscription window timeslot expires, the value MUST be changed back to false.

If the CPE user can open the subscription window with a specific command (i.e. via DECT base GUI or pushing a button), the parameter MUST report the correct status (true, while the window is opened).

- 2.0
CipheringEnable boolean W Enable or disable ciphering for the calls on the DECT domain. - 2.0
EncryptionType string R

Algorithm used in the encryption process defined in [ETSI_EN_300_175-7].

Enumeration of:

  • DSC (DECT Standard Cipher)
  • DSC2 (DECT Standard Cipher #2)
  • CCM (CCM Authenticated Encryption Algorithm)
- 2.0
RFPowerControl string W

This parameter is used to control the sending RF power as per the required range within the customer premises.

When set to ‘Reduced’, the CPE SHALL undertake measures to reduce the transmission RF power.

Enumeration of:

  • Normal
  • Reduced
- 2.0
FirmwareVersion string(:20) R Firmware version of the base as defined in [ETSI_TS_102_527-3] - 2.0
EepromVersion string(:20) R EEPROM version of the base as defined in [ETSI_TS_102_527-3] - 2.0
HardwareVersion string(:20) R Hardware version of the base as defined in [ETSI_TS_102_527-3] - 2.0
VoiceService.{i}.DECT.Base.{i}.Stats. object R

This object is associated with statistics collected from the DECT domain of the CPE. The collected statistics are common for all call scenarios.

The CPE MUST reset the DECT base’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the base becomes operationally down due to a previous administrative down (i.e. the base’s Status parameter transitions to a down state after the base is disabled) or when the base becomes administratively up (i.e. the base’s Enable parameter transitions from false to true).

- 2.0
Handovers unsignedInt R

The count of all successful handovers.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
HandoverFailures unsignedInt R

The count of all failed handovers.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ControlFieldErrors unsignedInt R

The count of all bad A-field packets.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
PayloadFieldErrors unsignedInt R

The count of all bad B-field packets.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
SyncFailures unsignedInt R

The count of all synchronization failures during all calls.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.DECT.Portable.{i}. object(0:) R

DECT portable table.

At most one entry in this table can exist with a given value for IPEI, or with a given value for Alias.

- 2.0
Enable boolean W Enables or disables this DECT portable. - 2.0
Status string R

Indicates the status of this DECT portable.

Enumeration of:

  • Up
  • Error
  • Testing
  • Disabled
- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Name string(:32) W The name of the DECT portable as assigned by the CPE. May be used for display on the handset screen. - 2.0.3
CodecList string[] W

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the CodecProfile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

The CPE SHOULD use the first enabled item in the list among those supported by the portable.

- 2.0
RegistrationStatus string R

The current registration status of the DECT portable.

Enumeration of:

  • In reach
  • Not in reach
- 2.0
IPUI hexBinary(:13) R

The International Portable User Identity which uniquely identifies the current user of the portable.

The IPUI is composed of the Portable User Type (PUT), of 4 bits, followed by the Portable User Number (PUN) whose size and format depend on PUT (see [Section 6.2/ETSI_EN_300_175-6]).

The hexbinary string is encoded exactly as it is defined in [Section 7.7.30/ETSI_EN_300_175-5]) :

Examples :

  • Type N (PUT + IPEI) :
  • PUT = 0000 (4 bits) = 0 (hexadecimal)
  • IPEI = 0000 0000 0000 1100 0000 0000 0000 1000 1001 (36 bits) = 00 0C 00 08 9 (hexadecimal)
  • IPUILength = 4 + 36 = 40 (bits)
  • IPUI = 00 00 C0 00 89 (40 bits; multiple of 8 so no bits are ignored)
  • Type O (PUT + binary-coded number) :
  • PUT = 0001 (4 bits) = 1 (hexadecimal)
  • Number (decimal) = 4546812123
  • Number (binary) = 1000 0111 1000 0001 0110 1100 0110 1101 1 (33 bits)
  • Number (hexadecimal) = 87 81 6C 6D 8 (33 bits; last three bits are ignored)
  • IPUILength = 4 + 33 = 37 (bits)
  • IPUI = 18 78 16 C6 D8 (37 bits; last 3 bits are ignored)
  • Type Q (PUT + BCD number) :
  • PUT = 0011 (4 bits) = 3 (hexadecimal)
  • Number (decimal) = 4546812123
  • Number (BCD) = 0100 0101 0100 0110 1000 0001 0010 0001 0010 0011 (40 bits)
  • IPUILength = 4 + 40 = 44 (bits)
  • IPUI = 34 54 68 12 12 30 (40 bits; last 4 bits are ignored)
- 2.0
IPUILength unsignedInt R The length of IPUI, in bits. - 2.0
IPEI hexBinary(:5) R

The International Portable Equipment Identity which is globally unique and identifies the portable.

The IPEI is composed of the Equipment Manufacturer’s Code (EMC), of 16 bits, followed by the Portable equipment Serial Number (PSN) of 20 bits (see [Section 10/ETSI_EN_300_175-6]).

The hexbinary string is encoded as follows :

  • Bits from position 0 to 15 represent the EMC.
  • Bits from position 16 to 35 represent the PSN.
  • The last four bits are unused and are set to 0.
- 2.0
PARK hexBinary(:5) R

The Portable Access Rights Key of this portable.

The PARK is composed of the Access Rights Class (ARC) of 3 bits and the Access Rights Details (ARD) whose size and format depend on the ARC (see [Sections 6.1.1 to 6.1.5/ETSI_EN_300_175-6]).

The hexbinary string is encoded as follows :

  • Bits from position 0 to 2 represent the ARC (as defined in [Section 7.2/ETSI_EN_300_175-6]).
  • For class A :

    • Bits from position 3 to 35 represent the ARD.
    • The last four bits are unused and are set to 0.
  • For other classes :

    • Bits from position 3 to 31 represent the ARD.
- 2.0
BaseAttachedTo string(:256) R The value MUST be the Path Name of a row in the DECT.Base. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Refers to the Base where this portable part is attached to. - 2.0
PortableType string[] R

Comma-separated list of strings. Protocols used for connection.

Each list item is an enumeration of:

  • GAP
  • CAT-iq 1.0
  • CAT-iq 2.0
  • CAT-iq 2.1
  • CAT-iq 3.0
  • CAT-iq 4.0
- 2.0
SubscriptionTime dateTime R

The date and time in which the DECT portable has been subscribed with the base.

If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value.

- 2.0
Control string W

This parameter MAY be used by the ACS to control the registration status of the portable.

Enumeration of:

  • Unregister (the CPE unregisters the portable from the base, but retains the instance in the list. This is a temporary detachment procedure)
  • Disable (the CPE unregisters the portable from the base and removes the instance from the list of registered portables. It is possible for the portable to register again in the future)
- 2.0
HardwareVersion string(:20) R Indicates the Hardware Version of a DECT portable. Corresponds to the portable HW Version identifier parameter, as defined in [ETSI_TS_102_527-4]. - 2.0
SoftwareVersion string(:20) R Indicates the Software Version used by a DECT portable. Maps with the portable SW Version identifier parameter, as defined in [ETSI_TS_102_527-4]. - 2.0
SoftwareUpgrade boolean R This parameter indicates support for SUOTA (Software Update Over The Air). - 2.0
LastUpdateDateTime dateTime R Indicates the last successful SW update of the DECT portable. This is based on the reception of a FACILITY message (being part of the HS version indication procedure) from the portable containing another value of SW version than the current value in this table. This new SW version is then updated in this table. - 2.0
OperatorName string(:32) W The name of the operator that will be displayed on the portable, if it supports this feature. - 2.0
VoiceService.{i}.SIP. object R This object is dedicated to SIP as defined in [RFC3261]. It models SIP networks, clients, proxies and registrars. - 2.0
NetworkNumberOfEntries unsignedInt R The number of entries in the Network table. - 2.0
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.0
ProxyNumberOfEntries unsignedInt R The number of entries in the Proxy table. - 2.0
RegistrarNumberOfEntries unsignedInt R The number of entries in the Registrar table. - 2.0
VoiceService.{i}.SIP.Client.{i}. object(0:) W

SIP client table (a Client as described in [Section 4.2/TR-104i2]). Each SIP client maintains its identity-to-location (i.e., RegisterURI-to-ContactURI) binding for SIP signaling exchanged between the client and the network.

For CPE use cases where CallControl is used to map network-facing to user-facing objects, the relationship between the SIP client object and its associated CallControl.Line object(s) is determined by the RegisterMode parameter, as follows:

  • In case of RFC3261-style explicit registration of SIP AoRs, only a single line shall be associated with each SIP client.
  • In case of RFC6140 or IMS/TISPAN-style registration, multiple lines can be associated with each SIP client. The set of lines associated with a SIP client constitute an ‘identity set’. In this case, registering the single SIP client implicitly registers the identities of all associated lines.
  • In the case where the client does not register with the network (RegisterMode is STATIC), multiple lines can be associated with each SIP client.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this client. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Client is disabled. - 2.0
Status string R

Indicates the status of this client. Unless noted otherwise, the status values apply to both registering and non-registering clients.

Enumeration of:

  • Up (The client is operational and has established connectivity with the network; i.e. the client is currently registered (for clients that register) or the periodic ping test indicates network connectivity (for clients that don’t register))
  • Initializing (Transitional state where the client has been enabled and is waiting an external event to transition to the next state (i.e. IP connectivity, DNS resolution…))
  • Registering (The client is in the process of registering with the network. This state applies only to clients that register)
  • Deregistering (The client is in the process of deregistering over the network. This state applies only to clients that register)
  • Error_Misconfigured (The client is enabled, but is non-operational due a configuration error)
  • Error_Network (A network error occurred)
  • Error_Registration (An error occurred during registration. This state applies only to clients that register)
  • Quiescent (This state indicates that the client has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state)
  • Disabled (The client is disabled)
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which this instance was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates client objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
RegisterMode string W

The registration procedures to apply. For RegisterMode values other than STATIC, the SIP SIP conveys its RegisterURI-to-ContactURI binding to the network using the SIP registration procedure. For the RegisterMode value of STATIC, the SIP client RegisterURI-to-ContactURI binding is conveyed to the network via some out-of-band mechanism not defined by this data model.

This parameter can only be modified if Origin is Static.

Enumeration of:

  • RFC3261 (The client registers with the network using the registration procedures defined in [RFC3261])
  • STATIC (The client does not register with the network)
  • RFC6140 (The client registers with the network using the registration procedures defined in [RFC6140])
  • TISPAN (The client registers with the network using the registration procedures defined in [Section 5.1.1.2/3GPP_TS_24.229])
- 2.0
AuthUserName string(:128) W

Username used to authenticate the connection to the server.

This parameter can only be modified if Origin is Static.

<Empty> 2.0
AuthPassword string(:128) W

Password used to authenticate the connection to the server.

This parameter can only be modified if Origin is Static.

When read, this parameter returns an empty string, regardless of the actual value.

<Empty> 2.0
Network string(:256) W

SIP network with which this SIP client is associated.

The value MUST be the Path Name of a row in the SIP.Network. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

This parameter can only be modified if Origin is Static.

- 2.0
MaxSessions unsignedInt W

Limit on the number of simultaneous voice sessions across this client. This MUST be less than or equal to Capabilities.MaxSessionCount.

A value of zero indicates no explicit limit on the number of sessions.

0 2.0
RegisterURI string(:389) W

The SIP URI that represents the identity of this SIP client. For RegisterMode values where the SIP client registers with the network, this SIP URI is placed in the From and To headers in the REGISTER request.

This parameter can only be modified if Origin is Static.

<Empty> 2.0
E164Format boolean W When true and using a Trunk, the SIP URIs built from the directory numbers in Trunk.{i}.DDIRange SHOULD use E.164 format, using the “user=phone” URI parameter, according to [Section 19.1.6/RFC3261]. true 2.0
T38Enable boolean W Enable or disable the use of T.38. - 2.0
SIPEventSubscribeNumberOfEntries unsignedInt R The number of entries in the EventSubscribe table. - 2.0
ContactNumberOfEntries unsignedInt R The number of entries in the Contact table. - 2.0
VoiceService.{i}.SIP.Client.{i}.Contact.{i}. object(0:) W

Active registrations for this SIP account.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this Contact. false 2.0
Status string R

Indicates the status of this Contact.

Enumeration of:

  • Up
  • Error
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which this Contact was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates Contact objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
IPAddress string(:45) W

[IPAddress] This is the IP address where the Client is listening for SIP requests from the service provider network. This IP address value is populated in the host portion of the ContactURI parameter.

This parameter can only be modified if Origin is Static.

- 2.0
Port unsignedInt(0:65535) W

This is the port where the Client is listening for SIP requests from the service provider network. This IP port value is populated in the port portion of the ContactURI parameter.

This parameter can only be modified if Origin is Static.

- 2.0
ContactURI string(:256) W

The current Contact URI of the Client.

If SIP registration procedures are being used, as determined by the RegisterMode parameter, then this parameter is populated in the Contact header field of the REGISTER request.

This parameter can only be modified if Origin is Static.

<Empty> 2.0
ExpireTime dateTime R

Time when this registration will expire. This parameter is valid only when SIP registration procedures are being used, as determined by the RegisterMode parameter.

If this registration never expires, this parameter SHOULD be set to the Unknown Time value.

- 2.0
PingInterval unsignedInt(0:65535) W The interval in seconds between sending a periodic ping request toward the network (i.e. a SIP OPTIONS ping). The CPE performs the periodic ping request to verify connectivity with the network when SIP registration procedures are not used (i.e. when the SIP client RegisterMode is STATIC). A value of ‘0’ indicates that the CPE should not perform the periodic ping request. - 2.0
UserAgent string(:256) R This is the User-Agent field reported in the SIP header of the REGISTER message. - 2.0
VoiceService.{i}.SIP.Client.{i}.EventSubscribe.{i}. object(0:) W

Table of SIP events automatically populated by the CPE with each of the SIP event subscriptions in SIP.Network.{i}.EventSubscribe.{i}.. This table allows specification of the authentication credentials needed for each event subscription.

At most one entry in this table can exist with a given value for Alias, or with a given value for Event. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Event such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Event string(:32) R

SIP event name corresponding to the value given in SIP.Network.{i}.EventSubscribe.{i}..

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

- 2.0
AuthUserName string(:128) W Username used to authenticate the connection to the event notify server. <Empty> 2.0
AuthPassword string(:128) W

Password used to authenticate the connection to the event notify server.

When read, this parameter returns an empty string, regardless of the actual value.

<Empty> 2.0
VoiceService.{i}.SIP.Network.{i}. object(0:) W

This object models a SIP network (a network as described in [Section 4.2/TR-104i2]). SIP networks are used by SIP Client objects so that common parameters do not have to be provisioned multiple times.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this Network. Starts the DNS resolving when enabled. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Network is disabled. - 2.0
Status string R

Indicates the status of this network.

Enumeration of:

  • Up
  • Resolving
  • Error_DNS
  • Error_Other
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ProxyServer string(:256) W

Host name or IP address of the SIP proxy server.

If not an empty string, all SIP signaling traffic MUST be sent to the host indicated by this parameter and the port indicated by ProxyServerPort unless OutboundProxy is not an empty string or a different route was discovered during normal SIP routing operations.

Regardless of which host the traffic gets sent to (ProxyServer or OutboundProxy), the value of this parameter (unless an empty string) MUST be used to derive the URI placed into the SIP Route header field of all requests originated by this end-point, unless a different proxy host was discovered dynamically during normal SIP routing operations.

<Empty> 2.0
ProxyServerPort unsignedInt(0:65535) W Destination port to be used in connecting to the SIP proxy server. 5060 2.0
ProxyServerTransport string W

Transport protocol to be used in connecting to the SIP proxy server.

Enumeration of:

  • UDP
  • TCP
  • TLS
  • SCTP
UDP 2.0
RegistrarServer string(:256) W

Host name or IP address of the SIP registrar server.

If this parameter is an empty string, the CPE MUST obtain all of the registrar server configuration information, including host name or IP address, port, and transport protocol, from the values in ProxyServer, ProxyServerPort, and ProxyServerTransport.

<Empty> 2.0
RegistrarServerPort unsignedInt(0:65535) W

Destination port to be used in connecting to the SIP registrar server.

If RegistrarServer is empty the CPE MUST obtain all of the registrar server configuration information, including host name or IP address, port, and transport protocol, from the values in ProxyServer, ProxyServerPort, and ProxyServerTransport.

5060 2.0
RegistrarServerTransport string W

Transport protocol to be used in connecting to the registrar server. Enumeration of:

  • UDP
  • TCP
  • TLS
  • SCTP

If RegistrarServer is empty the CPE MUST obtain all of the registrar server configuration information, including host name or IP address, port, and transport protocol, from the values in ProxyServer, ProxyServerPort, and ProxyServerTransport.

UDP 2.0
ServerDomain string(:256) W

If non-empty this ServerDomain is used by the devices in a DNS SRV request to provide FQDNs FQDNServer.{i}. for SIP Server connections.

[RFC2782] Clients ask for a specific service/protocol for a specific domain (the word domain is used here in the strict RFC 1034 sense), and get back the names of any available servers.

<Empty> 2.0
ChosenDomain string(:256) R Domain used by Client objects that reference this Network instance. <Empty> 2.0
ChosenIPAddress string(:45) R [IPAddress] IP address used to reach the ChosenDomain. - 2.0
ChosenPort unsignedInt(0:65535) R Port used to reach the ChosenDomain. - 2.0
UserAgentDomain string(:256) W CPE domain string. If an empty string, the CPE SHOULD use its IP address as the domain. <Empty> 2.0
UserAgentPort unsignedInt(0:65535) W Port used for incoming call control signaling. 0 2.0
UserAgentTransport string W

Transport protocol to be used for incoming call control signaling.

Enumeration of:

  • UDP
  • TCP
  • TLS
  • SCTP
UDP 2.0
OutboundProxy string(:256) W

The Fully Qualified Domain Name (FQDN) or IP Address of the outbound proxy. If the value is not an empty string, the SIP endpoint MUST send all SIP traffic (requests and responses) to the host indicated by this parameter and the port indicated by OutboundProxyPort. This MUST be done regardless of the routes discovered using normal SIP operations, including use of Route headers initialized from Service-Route and Record-Route headers previously received. OutboundProxy is NOT used to generate the URI placed into the Route header of any requests.

When OutboundProxy is assigned, the name is looked up (resolved) and the corresponding address is set in OutboundProxyResolvedAddress.

<Empty> 2.0
OutboundProxyResolvedAddress string(:45) R

[IPAddress] The IP address of the outbound proxy.

This parameter can be assigned statically (e.g. present in the factory default configuration or set by the ACS via OutboundProxy) or assigned dynamically (via DHCP).

When OutboundProxy is assigned, the name is looked up (resolved) and the corresponding address is set in OutboundProxyResolvedAddress.

- 2.0
OutboundProxyPrecedence string R

Indicates whether it is the static configuration or the DHCP configuration that is actually used for OutboundProxyResolvedAddress.

Enumeration of:

  • Static
  • DHCP
- 2.0
OutboundProxyPort unsignedInt(0:65535) W Destination port to be used in connecting to the outbound proxy. This parameter MUST be ignored unless the value of OutboundProxy is non-empty. 5060 2.0
STUNEnable boolean W Enable or disable use of STUN to allow operation through NAT. Note: enabling STUN is to be interpreted as enabling the use of STUN for discovery, not use as a keep-alive mechanism. false 2.0
STUNServer string(:256) W Domain name or IP address of the STUN server. <Empty> 2.0
NonVoiceBandwidthReservedUpstream unsignedInt W For bandwidth-based admission control, a session can proceed only if there is NonVoiceBandwidthReservedUpstream bits per second of upstream bandwidth left available for non-voice traffic. This parameter is appropriate only in implementations in which the actual bandwidth can be known, such as a VoIP device embedded in a DSL B-NT. 0 2.0
NonVoiceBandwidthReservedDownstream unsignedInt W For bandwidth-based admission control, a session can proceed only if there is NonVoiceBandwidthReservedDownstream bits per second of downstream bandwidth left available for non-voice traffic. This parameter is appropriate only in implementations in which the actual bandwidth can be known, such as a VoIP device embedded in a DSL B-NT. 0 2.0
Organization string(:256) W Text string to be used in the Organization header. <Empty> 2.0
RegistrationPeriod unsignedInt(1:) W Duration, in seconds, after which the user agent needs to register again. - 2.0
Realm string W Realm for authentication with the specified values of Client.{i}.AuthUserName and Client.{i}.AuthPassword. - 2.0
TimerT1 unsignedInt(1:) W Value of SIP timer T1, in milliseconds, as defined in [RFC3261]. - 2.0
TimerT2 unsignedInt(1:) W Value of SIP timer T2, in milliseconds, as defined in [RFC3261]. - 2.0
TimerT4 unsignedInt(1:) W Value of SIP timer T4, in milliseconds, as defined in [RFC3261]. - 2.0
TimerA unsignedInt(1:) W Value of SIP timer A, in milliseconds, as defined in [RFC3261]. - 2.0
TimerB unsignedInt(1:) W Value of SIP timer B, in milliseconds, as defined in [RFC3261]. - 2.0
TimerC unsignedInt(1:) W Value of SIP timer C, in milliseconds, as defined in [RFC3261]. - 2.0
TimerD unsignedInt(1:) W Value of SIP timer D, in milliseconds, as defined in [RFC3261]. - 2.0
TimerE unsignedInt(1:) W Value of SIP timer E, in milliseconds, as defined in [RFC3261]. - 2.0
TimerF unsignedInt(1:) W Value of SIP timer F, in milliseconds, as defined in [RFC3261]. - 2.0
TimerG unsignedInt(1:) W Value of SIP timer G, in milliseconds, as defined in [RFC3261]. - 2.0
TimerH unsignedInt(1:) W Value of SIP timer H, in milliseconds, as defined in [RFC3261]. - 2.0
TimerI unsignedInt(1:) W Value of SIP timer I, in milliseconds, as defined in [RFC3261]. - 2.0
TimerJ unsignedInt(1:) W Value of SIP timer J, in milliseconds, as defined in [RFC3261]. - 2.0
TimerK unsignedInt(1:) W Value of SIP timer K, in milliseconds, as defined in [RFC3261]. - 2.0
InviteExpires unsignedInt(1:) W Invite request Expires header value, in seconds. - 2.0
ReInviteExpires unsignedInt(1:) W Re-invite request Expires header value, in seconds. - 2.0
RegisterExpires unsignedInt(1:) W Register request Expires header value, in seconds. - 2.0
RegisterRetryInterval unsignedInt(1:) W Register retry interval, in seconds. - 2.0
InboundAuth string W

Applicable inbound authentication method, if any.

Enumeration of:

None 2.0
InboundAuthUsername string(:256) W If inbound authentication is used, the username credentials. <Empty> 2.0
InboundAuthPassword string(:256) W

If inbound authentication is used, the password credentials.

When read, this parameter returns an empty string, regardless of the actual value.

<Empty> 2.0
UseCodecPriorityInSDPResponse boolean W

When true, in the SDP included in an OK response to an Invite, the first listed codec MUST be the highest priority codec among those offered in the Invite, based on the priorities specified in CodecList. The list of codecs in the SDP MAY also include other lower priority codecs.

When false, there is no specific requirement for choosing the codecs listed in the SDP included in an OK response.

false 2.0
DSCPMark unsignedInt(0:63) W Diffserv code point to be used for outgoing SIP signaling packets. 0 2.0
VLANIDMark int(-1:) W

VLAN ID (as defined in [802.1Q-2005]) to be used for outgoing SIP signaling packets for this network. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
EthernetPriorityMark int(-1:) W

Ethernet priority code (as defined in [802.1Q-2005]) to be used for outgoing SIP signaling packets for this network. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
ConferenceCallDomainURI string(:256) W URI of the network conference bridge for the multiway conference call service. - 2.0
TimerLoginRejected unsignedInt W In case of a 401 (Unauthorized) or a 407 (Proxy Authentication Required) response to a REGISTER request, the CPE shall send REGISTER using credentials. If the second response is a new 401 (Unauthorized) or a 407 (Proxy Authentication Required) with stale=false or no stale value, the CPE shall re-init registration cycle after expiration of this timer (in seconds). If stale=true, the CPE shall send REGISTER using credentials. - 2.0
NoLoginRetry boolean W If true, no retry after a 401 (Unauthorized) or a 407 (Proxy Authentication Required) response to a REGISTER until power cycle or credentials have been changed. - 2.0
TimerRegistrationFailed unsignedInt W

In case of no response to a REGISTER request, the CPE shall retry according to retransmission algorithm defined in [RFC3261], then wait for expiration of this timer (in seconds).

In case of other response, the CPE shall wait for expiration of this timer before sending a new REGISTER request.

- 2.0
TimerSubscriptionFailed unsignedInt W

When starting a MWI subscription, on response of a SUBSCRIBE request

in case of no response or other response than 200 or 423, the CPE shall retry according to retransmission algorithm defined in [RFC3261], then wait for expiration of this timer (in seconds) before sending a new SUBSCRIBE request.
- 2.0
UnansweredRegistrationAttempts unsignedInt R The number of registration timeouts when trying to register the server. - 2.0
VoIPProfile string(:256) W

VoIP profile to use with this Network.

The value MUST be the Path Name of a row in the VoIPProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
CodecList string[] W

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the CodecProfile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.

- 2.0
MaxSessions unsignedInt W

Limit on the number of simultaneous voice sessions across all SIP.Client referencing this Network. This MUST be less than or equal to Capabilities.MaxSessionCount.

A value of zero indicates no explicit limit on the number of sessions.

0 2.0
FQDNServerNumberOfEntries unsignedInt R The number of entries in the FQDNServer table. - 2.0
EventSubscribeNumberOfEntries unsignedInt R The number of entries in the EventSubscribe table. - 2.0
ResponseMapNumberOfEntries unsignedInt(0:999) R The number of entries in the ResponseMap table. - 2.0
VoiceService.{i}.SIP.Network.{i}.FQDNServer.{i}. object(0:) W

Table of Fully Qualified Domain Names for this Network instance in order to connect to the SIP server as described in [RFC2782].

At most one entry in this table can exist with a given value for Alias, or with a given value for Domain. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Domain such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this FQDN server. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which the FQDN server was assigned.

Enumeration of:

  • AutoConfigured (Automatically generated, for example by a CPE that utilizes DNS SRV record requests)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
Domain string(:256) W

The domain name of the target host. This parameter can only be modified if Origin is Static.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

- 2.0
Weight unsignedInt(0:65535) W

A server selection mechanism. The weight field specifies a relative weight for entries with the same priority.

Larger weights SHOULD be given a proportionately higher probability of being selected. This parameter can only be modified if Origin is Static.

0 2.0
Priority unsignedInt(0:65535) W

The priority of this target host. A client MUST attempt to contact the target host with the lowest-numbered priority it can reach;

target hosts with the same priority SHOULD be tried in an order defined by the weight field. This parameter can only be modified if Origin is Static.

0 2.0
Port unsignedInt(0:65535) W The port on this target host of this service. - 2.0
IPAddresses string(:45)[] W

[IPAddress] Comma-separated list of IP Addresses, the IP Addresses that the FQDN resolves to.

The order in which the addresses appear in the list MAY imply priority. This parameter MAY be modified by the ACS only if Origin is Static.

- 2.0
VoiceService.{i}.SIP.Network.{i}.EventSubscribe.{i}. object(0:) W

Table to specify the SIP events to which the CPE MUST subscribe.

At most one entry in this table can exist with a given value for Alias, or with a given value for Event. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Event string(:32) W SIP event name to appear in the EVENT header of the SIP SUBSCRIBE request. <Empty> 2.0
Notifier string(:256) W Host name or IP address of the event notify server. <Empty> 2.0
NotifierPort unsignedInt(0:65535) W Destination port to be used in connecting to the event notifier. 0 2.0
NotifierTransport string W

Transport protocol to be used in connecting to the event notifier.

Enumeration of:

  • UDP
  • TCP
  • TLS
  • SCTP
UDP 2.0
ExpireTime unsignedInt W Subscription refresh timer, in seconds. - 2.0
VoiceService.{i}.SIP.Network.{i}.ResponseMap.{i}. object(0:) 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).

At most one entry in this table can exist with a given value for Alias, or with a given value for SIPResponseNumber. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and SIPResponseNumber such that the new entry does not conflict with any existing entries.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
SIPResponseNumber unsignedInt(101:999) W

The SIP response code number.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
TextMessage string(:64) W

The message to be provided on the screen or display of the VoIP device when the SIP response is received.

If this parameter is not an empty string, display of this text preempts the value of Tone.Description.{i}.ToneText associated with Tone. If this parameter is an empty string, the value of Tone.Description.{i}.ToneText associated with Tone, if any, is displayed instead.

This parameter is applicable only for VoIP devices capable of text display.

<Empty> 2.0
Tone string(:256) W

The tone to be played to the user when the SIP response is received.

The value MUST be the Path Name of a row in the Tone.Description. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

An empty string indicates no tone is to be played for this event.

- 2.0
VoiceService.{i}.SIP.Proxy.{i}. object(0:) W

Global SIP parameters used by the CPE when acting as proxy for SIP user agents.

At most one entry in this table can exist with a given value for Alias, or with the same values for both ProxyIPAddress and ProxyPort. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, ProxyIPAddress and ProxyPort such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable the proxy. false 2.0
Status string R

Indicates the status of this proxy.

Enumeration of:

  • Up
  • Error
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which the IP address was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates Proxy objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
ProxyIPAddress string(:45) W

[IPAddress] The IP address the proxy listens on.

This parameter can only be modified if Origin is Static.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with ProxyPort) doesn’t conflict with any existing entries.

- 2.0
ProxyPort unsignedInt(0:65535) W

The port the proxy listens on.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with ProxyIPAddress) doesn’t conflict with any existing entries.

- 2.0
ContactURI string(:256) R Built by the CPE using ProxyIPAddress and ProxyPort. - 2.0
VoIPProfile string(:256) W

VoIP profile to use with this proxy.

The value MUST be the Path Name of a row in the VoIPProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
VoiceService.{i}.SIP.Registrar.{i}. object(0:) W

Global SIP parameters used by the CPE when acting as registrar server for externally connected SIP user agents. This object also contains the global SIP parameters used by the CPE when it acts as static identity-to-location binding database for externally connected SIP user agents that don’t register (i.e. static-mode SIP-PBX).

At most one entry in this table can exist with a given value for Alias, or with the same values for both RegistrarPort and RegistrarIPAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, RegistrarPort and RegistrarIPAddress such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable the registrar. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Registrar is disabled. - 2.0
Status string R

Indicates the status of this registrar.

Enumeration of:

  • Up
  • Error
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which the IP address was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates Registrar objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
RegistrarIPAddress string(:45) W

[IPAddress] The IP address the registrar listens on for incoming SIP requests from an externally connected SIP user agent.

This parameter can only be modified if Origin is Static.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with RegistrarPort) doesn’t conflict with any existing entries.

- 2.0
RegistrarPort unsignedInt(0:65535) W

The port the registrar listens on.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with RegistrarIPAddress) doesn’t conflict with any existing entries.

- 2.0
RegisterExpires unsignedInt W The minimum register expire time in seconds. This parameter is valid only for SIP user agents that support registration. - 2.0
PingInterval unsignedInt(0:65535) W The interval in seconds between sending a periodic ping request (e.g., a SIP OPTIONS ping) to externally connected SIP user agents. The CPE performs the periodic ping request to verify connectivity with externally connected devices that do not support SIP registration procedures (i.e. a static-mode SIP-PBX). A value of 0 indicates that the CPE should not perform the periodic ping request. - 2.0
Organization string(:256) W Text string to be used in the Organization header. <Empty> 2.0
Realm string W Realm for authentication with the specified values of Account.{i}.AuthUserName and Account.{i}.AuthPassword. - 2.0
VoIPProfile string(:256) W

VoIP profile to use with this registrar.

The value MUST be the Path Name of a row in the VoIPProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
ContactURI string(:256) R Built by the CPE using RegistrarIPAddress and RegistrarPort. - 2.0
AccountNumberOfEntries unsignedInt R The number of entries in the Account table. - 2.0
VoiceService.{i}.SIP.Registrar.{i}.Account.{i}. object(0:) W

SIP account table.

At most one entry in this table can exist with a given value for URI, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for URI and Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable string W

Enables or disables this account, or places it into a quiescent state. Enumeration of:

  • Enable
  • Quiescent (OPTIONAL)
  • Disable

In the Quiescent state, in-progress sessions remain intact, but no new sessions are allowed. If this parameter is set to Quiescent in a CPE that does not support the Quiescent state, it MUST treat it the same as the Disable state (and indicate Disabled in Status).

Disable 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Account is disabled. - 2.0
Status string R

Indicates the status of this account. Unless noted otherwise, the Status values apply to both registering and non-registering external SIP user agents.

Enumeration of:

  • Up (The Account is operational and has established connectivity with the external SIP user agent; i.e. the external device is currently registered (for SIP user agents that register) or the periodic ping test indicates connectivity with the external device (for SIP user agents that don’t register)
  • Initializing (Transitional state where the Account has been enabled and is waiting for an external event to transition to the next state (i.e. IP connectivity, DNS resolution, reception of SIP REGISTER request from external SIP user agent…))
  • Registering (The external SIP user agent is in the process of registering with the CPE. This state applies only to SIP user agents that register)
  • Deregistering (The external SIP user agent is in the process of deregistering with the CPE. This state applies only to SIP user agents that register)
  • ErrorMisconfigured (The Account is enabled, but is non-operational due a configuration error)
  • ErrorNetwork (A network error occurred)
  • ErrorRegistration (An error occurred during registration. This state applies only to Accounts serving SIP user agents that register)
  • Quiescent (This state indicates that the Account has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state)
  • Disabled (The Account is disabled)
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which the Account was created. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates Account objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
CallStatus string R

Indicates the call status for this account.

Enumeration of:

  • Idle
  • Dialing
  • Delivered
  • Connected
  • Alerting
  • Disconnected
- 2.0
AuthUserName string(:128) W

Username used to authenticate the connection to the registrar server.

This parameter can only be modified if Origin is Static.

<Empty> 2.0
AuthPassword string(:128) W

Password used to authenticate the connection to the registrar server.

This parameter can only be modified if Origin is Static.

When read, this parameter returns an empty string, regardless of the actual value.

<Empty> 2.0
RegistrationStatus string R

The current registration status of the externally connected SIP user agent. This parameter is valid only for SIP user agents that support registration.

Enumeration of:

  • Registered
  • Unregistered
- 2.0
URI string(:389) W

The URI (AoR) of the externally connected SIP user agent. For SIP user agents that register, this is the URI that is contained in the To header field of the incoming REGISTER request.

This parameter can only be modified if Origin is Static.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

- 2.0
Domain string(:256) W

The domain name used when the SIP user agent has registered itself.

This parameter can only be modified if Origin is Static.

- 2.0
CodecList string[] W

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the CodecProfile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.

- 2.0
VoIPProfile string(:256) W

Voice profile to use with this Account.

The value MUST be the Path Name of a row in the VoIPProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
ContactNumberOfEntries unsignedInt R The number of entries in the Contact table. - 2.0
VoiceService.{i}.SIP.Registrar.{i}.Account.{i}.Contact.{i}. object(0:) W

Active registrations for this SIP account.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this entry. false 2.0
Status string R

Indicates the status of this entry.

Enumeration of:

  • Up
  • Error
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which the Contact was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates Contact objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
IPAddress string(:45) W

[IPAddress] IP Address of the externally connected SIP user agent. This is the IP address contained in the ContactURI parameter.

This parameter can only be modified if Origin is Static.

- 2.0
Port unsignedInt(0:65535) W

The port of the externally connected SIP user agent. This is the port contained in the ContactURI parameter.

This parameter can only be modified if Origin is Static.

- 2.0
ContactURI string(:256) W

This is the SIP signaling address of the externally connected SIP user agent. If the SIP user agent registers, then ContactURI is the Contact URI contained in the Contact header field of the REGISTER request received from the SIP user agent. If the SIP user agent does not register, then the ContactURI is provisioned by the ACS.

This parameter can only be modified if Origin is Static.

- 2.0
ExpireTime dateTime R

Time when this registration will expire. This parameter is valid only for external SIP user agents that register.

If this registration never expires, this parameter SHOULD be set to the Unknown Time value.

- 2.0
UserAgent string(:64) W This parameter defines the User-Agent header that will be used by the SIP messages send by this user agent. Implementers SHOULD make the User-Agent header field a configurable option. - 2.0
VoiceService.{i}.MGCP. object R This object is dedicated to MGCP as defined in [RFC3435]. It models MGCP clients and networks. - 2.0
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.0
NetworkNumberOfEntries unsignedInt R The number of entries in the Network table. - 2.0
VoiceService.{i}.MGCP.Client.{i}. object(0:) W

MGCP client table (a client as described in [Section 4.2/TR-104i2]). Each MGCP client maintains a registration for the MGCP identities of the associated line with the Network.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this client. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Client is disabled. - 2.0
Status string R

Indicates the status of this client.

Enumeration of:

  • Up (The client is operational and has established connectivity with the network)
  • Initializing (Transitional state where the client has been enabled and is waiting an external event to transition to the next state (i.e. IP connectivity, DNS resolution…))
  • Registering (The client is in the process of registering with the network)
  • Deregistering (The client is in the process of deregistering over the network)
  • Error_Misconfigured (The client is enabled, but is non-operational due a configuration error)
  • Error_Network (A network error occurred)
  • Error_Registration (An error occurred during registration)
  • Quiescent (This state indicates that the client has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state)
  • Disabled (The client is disabled)
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
RegisterMode string W

Register mode.

Enumeration of:

  • Wildcard
  • Individual
Wildcard 2.0
LocalPort unsignedInt(0:65535) W Port listening for incoming call control signaling. 0 2.0
Domain string(:256) W CPE domain string. If an empty string, the CPE SHOULD use its IP address. <Empty> 2.0
User string(:64) W User string used in accessing the call agent. <Empty> 2.0
Network string(:256) W

MGCP network with which this MGCP client is associated.

The value MUST be the Path Name of a row in the MGCP.Network. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
MaxSessions unsignedInt W

Limit on the number of simultaneous voice sessions across this Client. This MUST be less than or equal to Capabilities.MaxSessionCount.

A value of zero indicates no explicit limit on the number of sessions.

0 2.0
VoiceService.{i}.MGCP.Network.{i}. object(0:) W

This object models a MGCP network (a network as described in [Section 4.2/TR-104i2]).

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable the Network. Starts the DNS resolving when enabled. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Network is disabled. - 2.0
Status string R

Indicates the status of this Network.

Enumeration of:

  • Up
  • Resolving
  • Error_DNS
  • Error_Other
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CallAgent1 string(:256) W Host name or IP address of the main MGCP call agent. <Empty> 2.0
CallAgentPort1 unsignedInt(0:65535) W Destination port to be used in connecting with the main MGCP call agent. 0 2.0
CallAgent2 string(:256) W Host name or IP address of the backup MGCP call agent. <Empty> 2.0
CallAgentPort2 unsignedInt(0:65535) W Destination port to be used in connecting with the backup MGCP call agent. 0 2.0
RetranIntervalTimer unsignedInt(0:65535) W Message retransfer interval, in seconds. 1 2.0
MaxRetranCount unsignedInt(0:65535) W Max number of message retransfers. 10 2.0
DSCPMark unsignedInt(0:63) W Diffserv code point to be used for outgoing MGCP signaling packets. - 2.0
VLANIDMark int(-1:) W

VLAN ID (as defined in [802.1Q-2005]) to be used for outgoing MGCP signaling packets for this network. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
EthernetPriorityMark int(-1:) W

Ethernet priority code (as defined in [802.1D-2004]) to be used for outgoing MGCP signaling packets for this network. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark are greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
AllowPiggybackEvents boolean W Indicates whether or not piggyback events are allowed to the MGCP call agent. - 2.0
SendRSIPImmediately boolean W Indicates whether or not to send RSIP immediately on restart. - 2.0
STUNEnable boolean W Enable or disable use of STUN to allow operation through NAT. Note: enabling STUN is to be interpreted as enabling the use of STUN for discovery, not use as a keep-alive mechanism. false 2.0
STUNServer string(:256) W Domain name or IP address of the STUN server. <Empty> 2.0
NonVoiceBandwidthReservedUpstream unsignedInt W For bandwidth-based admission control, a session can proceed only if there is NonVoiceBandwidthReservedUpstream bits per second of upstream bandwidth left available for non-voice traffic. This parameter is appropriate only in implementations in which the actual bandwidth can be known, such as a VoIP device embedded in a DSL B-NT. 0 2.0
NonVoiceBandwidthReservedDownstream unsignedInt W For bandwidth-based admission control, a session can proceed only if there is NonVoiceBandwidthReservedDownstream bits per second of downstream bandwidth left available for non-voice traffic. This parameter is appropriate only in implementations in which the actual bandwidth can be known, such as a VoIP device embedded in a DSL B-NT. 0 2.0
MaxSessions unsignedInt W

Limit on the number of simultaneous voice sessions across all MGCP.Client. referencing this Network. This MUST be less than or equal to Capabilities.MaxSessionCount.

A value of zero indicates no explicit limit on the number of sessions.

0 2.0
VoIPProfile string(:256) W

VoIP profile to use with this network.

The value MUST be the Path Name of a row in the VoIPProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
CodecList string[] W

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the CodecProfile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.

- 2.0
VoiceService.{i}.H323. object R This object is dedicated to H.323 as defined in [H.323]. It models H.323 clients and networks. - 2.0
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.0
NetworkNumberOfEntries unsignedInt R The number of entries in the Network table. - 2.0
VoiceService.{i}.H323.Client.{i}. object(0:) W

H.323 client table (a client as described in [Section 4.2/TR-104i2]). Each H.323 client maintains a registration for the H.323 identities of the associated line with the Network.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this client. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Client is disabled. - 2.0
Status string R

Indicates the status of this client.

Enumeration of:

  • Up (The client is operational and has established connectivity with the network)
  • Initializing (Transitional state where the client has been enabled and is waiting an external event to transition to the next state (i.e. IP connectivity, DNS resolution…))
  • Registering (The client is in the process of registering with the network)
  • Deregistering (The client is in the process of deregistering over the network)
  • Error_Misconfigured (The client is enabled, but is non-operational due a configuration error)
  • Error_Network (A network error occurred)
  • Error_Registration (An error occurred during registration)
  • Quiescent (This state indicates that the client has been disabled and is waiting for active session(s) to terminate before transitioning to the disabled state)
  • Disabled (The client is disabled)
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
H235Authentication boolean W Enables or disables usage of H.235 security baseline security profile as defined in [H.235.1]. false 2.0
AuthPassword string W

Password to be used when H.235 is enabled.

When read, this parameter returns an empty string, regardless of the actual value.

<Empty> 2.0
SendersID string W In ITU-T based H.235 authentication, the sendersID is the ID of the gateway as received from the Gatekeeper. As long as the endpointID is not received from the Gatekeeper, the sendersID will be applied as configured here. The generalID is the GatekeeperID. <Empty> 2.0
Network string(:256) W

H.323 network with which this H.323 client is associated.

The value MUST be the Path Name of a row in the H323.Network. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
H323ID string(:32) W The H.323 ID assigned to the client. <Empty> 2.0
MaxSessions unsignedInt W

Limit on the number of simultaneous voice sessions across this Client. This MUST be less than or equal to Capabilities.MaxSessionCount.

A value of zero indicates no explicit limit on the number of sessions.

0 2.0
VoiceService.{i}.H323.Network.{i}. object(0:) W

This object models a H.323 network (a network as described in [Section 4.2/TR-104i2]).

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this Network. Starts the DNS resolving when enabled. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Network is disabled. - 2.0
Status string R

Indicates the status of this network.

Enumeration of:

  • Up
  • Resolving
  • Error_DNS
  • Error_Other
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Gatekeeper string W Host name or IP address of H.323 Gatekeeper. <Empty> 2.0
GatekeeperPort unsignedInt W Destination port to be used in connecting to the H.323 Gatekeeper. 1719 2.0
GatekeeperID string W Gatekeeper ID. <Empty> 2.0
TimeToLive unsignedInt W Defines the TimeToLive specification in the registration with the Gatekeeper in seconds. 86400 2.0
DSCPMark unsignedInt(0:63) W Diffserv code point to be used for outgoing H.323 signaling packets. 0 2.0
VLANIDMark int(-1:) W

VLAN ID (as defined in [802.1Q-2005]) to be used for outgoing H.323 signaling packets for this network. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
EthernetPriorityMark int(-1:) W

Ethernet priority code (as defined in [802.1D-2004]) to be used for outgoing H.323 signaling packets for this network. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
STUNEnable boolean W Enable or disable use of STUN to allow operation through NAT. Note: enabling STUN is to be interpreted as enabling the use of STUN for discovery, not use as a keep-alive mechanism. false 2.0
STUNServer string(:256) W Domain name or IP address of the STUN server. <Empty> 2.0
NonVoiceBandwidthReservedUpstream unsignedInt W For bandwidth-based admission control, a session can proceed only if there is NonVoiceBandwidthReservedUpstream bits per second of upstream bandwidth left available for non-voice traffic. This parameter is appropriate only in implementations in which the actual bandwidth can be known, such as a VoIP device embedded in a DSL B-NT. 0 2.0
NonVoiceBandwidthReservedDownstream unsignedInt W For bandwidth-based admission control, a session can proceed only if there is NonVoiceBandwidthReservedDownstream bits per second of downstream bandwidth left available for non-voice traffic. This parameter is appropriate only in implementations in which the actual bandwidth can be known, such as a VoIP device embedded in a DSL B-NT. 0 2.0
MaxSessions unsignedInt W

Limit on the number of simultaneous voice sessions across all H323.Client. referencing this Network. This MUST be less than or equal to Capabilities.MaxSessionCount.

A value of zero indicates no explicit limit on the number of sessions.

0 2.0
VoIPProfile string(:256) W

VoIP profile to use with this network.

The value MUST be the Path Name of a row in the VoIPProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
CodecList string[] W

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the CodecProfile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

The CPE SHOULD use the first enabled item in the list among those supported by the remote endpoint and consistent with the available bandwidth.

- 2.0
VoiceService.{i}.Trunk.{i}. object(0:) W

Trunk table.

The Trunk holds all parameters a CPE needs to set up a trunk connection with an NGN, as defined in [ETSI_TS_181_019].

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this trunk. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Trunk is disabled. - 2.0
Status string R

Indicates the status of this trunk.

Enumeration of:

  • Up
  • Initializing
  • Registering
  • Unregistering
  • Error
  • Testing
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Origin string R

Mechanism via which the Trunk was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates Trunk objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
Name string(:16) W Name of the trunk. - 2.0
DDIRange string[] W

Comma-separated list of strings. Each range consists of a Start part consisting of 1 to n digits (string representation) followed by an OPTIONAL End part consisting of 1 to n digits prefixed by a “-” symbol.

Examples:

0123456789
0123456700-0123456720

Each time this value is changed, the table of Lines managed by the Trunk is automatically adapted and each value of the DDIRange MUST be represented in corresponding CallControl.Line.{i}.DirectoryNumber parameter.

If this trunk has a SIP.Client. provider and SIP.Client.{i}.E164Format is set to true, full E.164 numbers with country code (but without “+” prefix) MUST be used.

This parameter can only be modified if Origin is Static.

- 2.0
LineObjectCreation boolean W When true, a CallControl.Line.{i}. instance SHOULD be created automatically for each identity within the ranges specified by DDIRange. - 2.0
MaxChannels unsignedInt W Defines the maximum number of simultaneous communication channels handled by this trunk. A channel is used to convey an information signal, for example a digital bit stream, from one or several senders to one or several receivers. - 2.0
MaxOutboundChannelCount int(-1:) W Maximal number of simultaneous communication channels in outbound direction supported across this trunk. The maximum number cannot exceed MaxChannels - MaxInboundChannelCount. A value n>0 means, that there are no more than n channels allowed, which are used by outbound calls. A value of -1 means that there are no restrictions in this direction. -1 2.0
MaxInboundChannelCount int(-1:) W Maximal number of simultaneous communication channels in inbound direction supported across this trunk. The maximum number cannot exceed MaxChannels - MaxOutboundChannelCount. A value n>0 means, that there are no more than n channels allowed, which are used by inbound calls. A value of -1 means that there are no restrictions in this direction. -1 2.0
CodecPriority string W

The CodecPriority option controls which end of an inbound call leg will have priority over the negotiation of codecs.

Enumeration of:

  • Local
  • Remote
- 2.0
Provider string(:256) W

SIP client or ISDN interface associated with the identities represented by this trunk.

The value MUST be the Path Name of a row in the SIP.Client., ISDN.BRI. or ISDN.PRI. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.

This parameter can only be modified if Origin is Static.

- 2.0
VoiceService.{i}.CallControl. object R

Call control and call routing parameters. This object is a control plane application for the VoiceService that provides numbers or names based routing, local PBX functionalities and advanced telephony features.

It is mutually exclusive with the Interwork table which is used in case of switching capabilities.

- 2.0
MaxNumberOfLines unsignedInt W

Maximum number of Line.{i}. in CallControl.

This value cannot be greater than Capabilities.MaxLineCount.

- 2.0
MaxNumberOfExtensions unsignedInt W

Maximum number of Extension.{i}. in CallControl.

This value cannot be greater than Capabilities.MaxExtensionCount.

- 2.0
LineNumberOfEntries unsignedInt R The number of entries in the Line table. - 2.0
ExtensionNumberOfEntries unsignedInt R The number of entries in the Extension table. - 2.0
MailboxNumberOfEntries unsignedInt R The number of entries in the Mailbox table. - 2.0
IncomingMapNumberOfEntries unsignedInt R The number of entries in the IncomingMap table. - 2.0
OutgoingMapNumberOfEntries unsignedInt R The number of entries in the OutgoingMap table. - 2.0
NumberingPlanNumberOfEntries unsignedInt R The number of entries in the NumberingPlan table. - 2.0
GroupNumberOfEntries unsignedInt R The number of entries in the Group table. - 2.0
VoiceService.{i}.CallControl.Line.{i}. object(0:) W

Voice line table.

Support for adding and removing lines is conditional on whether the CPE supports more than one line in total as indicated by Capabilities.MaxLineCount.

At most one entry in this table can exist with a given value for DirectoryNumber, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this line. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Line is disabled. - 2.0
Status string R

Indicates the status of this line.

Enumeration of:

  • Up
  • Error
  • Testing
  • Quiescent
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CallStatus string R

Indicates the call status for this line.

Enumeration of:

  • Idle
  • Dialing
  • Delivered
  • Connected
  • Alerting
  • Disconnected
- 2.0
Origin string R

Mechanism via which the Line instance was created.

Enumeration of:

  • Static (explicitly created by the ACS or some other management entity, e.g. via a GUI)
  • DDIRange (created by the CPE according to the Trunk.{i}.DDIRange setting of the associated Trunk.{i}. in Provider)
- 2.0
DirectoryNumber string(:32) W Directory number associated with this line. <Empty> 2.0
Provider string(:256) W

Provider for the line. The value MUST be the path name of a row in one of the following tables:

The value MUST be the Path Name of a row in the SIP.Client., H323.Client., ISDN.BRI., ISDN.PRI., POTS.FXO. or Trunk. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
CallingFeatures string(:256) W

Set of calling features to apply to this line.

The value MUST be the Path Name of a row in the CallingFeatures.Set. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
VoiceService.{i}.CallControl.Line.{i}.Stats. object R

Statistics for this Line instance.

The CPE MUST reset the line’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the line becomes operationally down due to a previous administrative down (i.e. the line’s Status parameter transitions to a down state after the line is disabled) or when the line becomes administratively up (i.e. the line’s Enable parameter transitions from false to true).

- 2.0
VoiceService.{i}.CallControl.Line.{i}.Stats.IncomingCalls. object R Statistics for incoming calls. - 2.0
CallsReceived unsignedInt R Total number of received calls to the line. - 2.0
CallsConnected unsignedInt R Total number of calls that successfully completed call setup signaling. - 2.0
CallsFailed unsignedInt R Total number of calls that failed to successfully complete call setup signaling. - 2.0
CallsDropped unsignedInt R Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination. - 2.0
TotalCallTime unsignedInt R

Cumulative call duration in seconds.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Line.{i}.Stats.OutgoingCalls. object R Statistics for outgoing calls. - 2.0
CallsAttempted unsignedInt R Total number of outgoing calls attempted from the line. - 2.0
CallsConnected unsignedInt R Total number of calls that successfully completed call setup signaling. - 2.0
CallsFailed unsignedInt R Total number of calls that failed to successfully complete call setup signaling. - 2.0
CallsDropped unsignedInt R Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination. - 2.0
TotalCallTime unsignedInt R

Cumulative call duration in seconds.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Line.{i}.Stats.RTP. object R RTP statistic parameters. - 2.0
PacketsReceived unsignedInt R

Total number of RTP packets received.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedInt R

Total number of RTP packets sent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
PacketsLost unsignedInt R

Total number of RTP packets that have been lost.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
BytesSent unsignedInt R

Total number of bytes sent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedInt R

Total number of bytes received.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Line.{i}.Stats.DSP. object R DSP statistic parameters. - 2.0
Overruns unsignedInt R

Total number of times the receive jitter buffer has overrun.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Underruns unsignedInt R

Total number of times the receive jitter buffer has underrun.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Extension.{i}. object(0:) W

Extension table containing the local numbers and names.

Support for adding and removing extensions is conditional on whether the CPE supports more than one line in total as indicated by Capabilities.MaxExtensionCount.

At most one entry in this table can exist with a given value for ExtensionNumber, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this extension. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Extension is disabled. - 2.0
Status string R

Indicates the status of this extension.

Enumeration of:

  • Up
  • Initializing
  • Error
  • Testing
  • Quiescent
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CallStatus string R

Indicates the call status for this extension.

Enumeration of:

  • Idle
  • Dialing
  • Delivered
  • Connected
  • Alerting
  • Disconnected
- 2.0
Origin string R

Mechanism via which the Extension object was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates Extension objects)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
Name string(:256) W

The name of this extension.

This name will also be used for CallerIdName functionality and for displaying on screen of handset, etc…

- 2.0
ExtensionNumber string(:32) W The number assigned to this extension for internal calls. <Empty> 2.0
Provider string(:256) W

Provider for the extension. The value MUST be the path name of a row in one of the following tables:

The value MUST be the Path Name of a row in the SIP.Registrar.{i}.Account., ISDN.BRI., ISDN.PRI., POTS.FXS., DECT.Portable., Terminal. or CallControl.Group. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
NumberingPlan string(:256) W

Numbering plan to be used for outgoing calls.

The value MUST be the Path Name of a row in the CallControl.NumberingPlan. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
CallingFeatures string(:256) W

Set of calling features to apply to this extension.

The value MUST be the Path Name of a row in the CallingFeatures.Set. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
CallWaitingStatus string R

Status of endpoint managed call waiting, if supported. Enumeration of:

  • Disabled
  • Idle
  • SecondaryRinging
  • SecondaryConnecting
  • SecondaryConnected

This parameter SHOULD NOT be present if the CPE does not support endpoint managed call waiting.

- 2.0
ConferenceCallingStatus string R

Status of endpoint managed conference calling, if supported. Enumeration of:

  • Disabled
  • Idle
  • SecondaryCalling
  • SecondaryConnecting
  • SecondaryConnected
  • InConferenceCall

This parameter SHOULD NOT be present if the CPE does not support endpoint managed conference calling.

- 2.0
ConferenceCallingSessionCount unsignedInt R

Number of active sessions on this extension.

0 indicates no call is in progress.
1 indicates a single call is in progress.
Higher values indicate a conference call is in progress.

This parameter SHOULD NOT be present if the CPE does not support endpoint managed conference calling.

- 2.0
VoiceMail string(:256) W

Voice mail to use when the Extension is not responding.

The value MUST be the Path Name of a row in the CallControl.Mailbox. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
VoiceService.{i}.CallControl.Extension.{i}.Stats. object R

Statistics for this extension.

The CPE MUST reset the extension’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the extension becomes operationally down due to a previous administrative down (i.e. the extension’s Status parameter transitions to a down state after the extension is disabled) or when the extension becomes administratively up (i.e. the extension’s Enable parameter transitions from false to true).

- 2.0
VoiceService.{i}.CallControl.Extension.{i}.Stats.IncomingCalls. object R Statistics for incoming calls. - 2.0
CallsReceived unsignedInt R Total number of received calls to the extension. - 2.0
CallsConnected unsignedInt R Total number of calls that successfully completed call setup signaling. - 2.0
CallsFailed unsignedInt R Total number of calls that failed to successfully complete call setup signaling. - 2.0
CallsDropped unsignedInt R Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination. - 2.0
TotalCallTime unsignedInt R

Cumulative call duration in seconds.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Extension.{i}.Stats.OutgoingCalls. object R Statistics for outgoing calls. - 2.0
CallsAttempted unsignedInt R Total number of outgoing calls attempted from the extension. - 2.0
CallsConnected unsignedInt R Total number of calls that successfully completed call setup signaling. - 2.0
CallsFailed unsignedInt R Total number of calls that failed to successfully complete call setup signaling. - 2.0
CallsDropped unsignedInt R Total calls that were successfully connected, but dropped unexpectedly while in progress without explicit user termination. - 2.0
TotalCallTime unsignedInt R

Cumulative call duration in seconds.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Extension.{i}.Stats.RTP. object R RTP statistic parameters. - 2.0
PacketsReceived unsignedInt R

Total number of RTP packets received.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedInt R

Total number of RTP packets sent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
PacketsLost unsignedInt R

Total number of RTP packets that have been lost.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
BytesSent unsignedInt R

Total number of bytes sent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedInt R

Total number of bytes received.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Extension.{i}.Stats.DSP. object R DSP statistic parameters. - 2.0
Overruns unsignedInt R

Total number of times the receive jitter buffer has overrun.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Underruns unsignedInt R

Total number of times the receive jitter buffer has underrun.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallControl.Group.{i}. object(0:) W

This object models an extension as a group of extensions.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Extensions string[] W

Comma-separated list of strings. If this parameter is null the group is treated as a group that contains all extensions.

Each list item MUST be the Path Name of a row in the CallControl.Extension. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

- 2.0
RingType string W

Defines the way of ringing for the extensions in this group. Enumeration of:

  • Simultaneous (all extensions ring together)
  • Hierarchical (extensions ring one by one in the order defined in Extensions. If the ringing extension doesn’t answer after RingTimeout, the next extension in the list is tried)
  • Cyclic (as Hierarchical, but the list is not reset between incoming calls)
- 2.0
RingTimeout unsignedInt W

The time (in seconds) to wait for extension reply before trying the next extension.

Only applicable if RingType = Hierarchical or Cyclic.

- 2.0
VoiceService.{i}.CallControl.Mailbox.{i}. object(0:) W

Voice mail configuration related to a particular extension.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
MaxMsg unsignedInt W This limits the number of messages in a voicemail folder. - 2.0
MaxMessageTime unsignedInt W Defines the maximum amount of time in seconds of an incoming message. Use this when there are many users and disk space is limited. A value of 0 means there will be no maximum time limit enforced. - 2.0
MinSize unsignedInt W Minimal size in seconds of the voicemail box. - 2.0
SMTPServerAddress string(:256) W SMTP server FQDN or IP Address used for voicemail notifications. - 2.0
SMTPServerPort unsignedInt(0:65535) W SMTP server port for voicemail notifications. 25 2.0
SMTPUser string(:256) W SMTP user name. - 2.0
SMTPPassword string(:256) W SMTP password. - 2.0
SMTPAuthenticationType string W

Type of authentication used to connect to the SMTP server.

Enumeration of:

  • None
  • SSL
  • TLS
  • Auto
None 2.0
SMTPFrom string(:256) W Sender’s email address. - 2.0
VoiceService.{i}.CallControl.IncomingMap.{i}. object(0:) W

The IncomingMap is a table that is used to control which extensions ring when an incoming call is received.

The map approach separates the call routing aspects from the configuration of the lines and extensions. It support PBX concepts such as DDI (one extension per line) and groups (parallel dialing if extensions have same priority and hunting when extensions have different priority).

At most one entry in this table can exist with the same values for both Line and Extension, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Line, Extension and Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Line string(:256) W

Line used by the call.

The value MUST be the Path Name of a row in the CallControl.Line. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Extension) doesn’t conflict with any existing entries.

- 2.0
Extension string(:256) W

Extension that rings on incoming call.

The value MUST be the Path Name of a row in the CallControl.Extension. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Line) doesn’t conflict with any existing entries.

- 2.0
Order unsignedInt(1:) W

Indicates the order in which extensions ring.

First all extensions with the lowest order value will ring.

When all these extensions have rejected the call or did not reply, the next order value will be attempted.

1 2.0
Timeout unsignedInt W The time in seconds the extension will ring before it is considered that there was no reply. - 2.0
VoiceService.{i}.CallControl.OutgoingMap.{i}. object(0:) W

The OutgoingMap is a table that is used to control which line is used when an extension makes a call.

At most one entry in this table can exist with the same values for both Extension and Line, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Extension, Line and Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CLIPNoScreeningNumber string(:32) W Public number to be presented outgoing calls, instead of the effective extension number. - 2.0
Extension string(:256) W

Extension which makes the outgoing call.

The value MUST be the Path Name of a row in the CallControl.Extension. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Line) doesn’t conflict with any existing entries.

- 2.0
Line string(:256) W

Identifies the Line to be used for outgoing calls.

When applicable in the signaling protocol the DirectoryNumber will be used as source number for this call.

Note: The Line to be used for an outgoing call can be overridden by the NumberingPlan.

The value MUST be the Path Name of a row in the CallControl.Line. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Extension) doesn’t conflict with any existing entries.

- 2.0
Order unsignedInt(1:) W

The order in which using the lines is attempted. This is used to implement a backup mechanism.

If the first line is not available, using the next one will be attempted.

1 2.0
VoiceService.{i}.CallControl.NumberingPlan.{i}. object(0:) W

Information related the numbering plan.

NumberingPlan is applicable only if the device supports a dialing mechanism for which a number plan is needed (for example, some devices with an explicit Dial button do not need to be aware of the dialing plan) and if the device does not already support a numbering plan mechanism for this call control (e.g., in-band via MGCP).

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
MinimumNumberOfDigits unsignedInt(1:32) W

This is the minimum number of digits to be collected before an outgoing request (e.g., a SIP INVITE) can be initiated.

If End of Dialing (as defined in InterDigitTimerStd) occurs before the minimum number of digits has been reached then the number will be considered incomplete and no request will be initiated.

In practice, searching CallControl.NumberingPlan.{i}.PrefixInfo.{i}. commences only once MinimumNumberOfDigits digits has been received.

1 2.0
MaximumNumberOfDigits unsignedInt(1:32) W When this number of digits has been collected, an outgoing request (e.g., a SIP INVITE) MUST be initiated. Any additional dialed digits will be ignored. This parameter is only used in the case that no match in CallControl.NumberingPlan.{i}.PrefixInfo.{i}. has been found. 15 2.0
InterDigitTimerStd unsignedInt(1:50000) W This timer is the maximum allowable time (expressed in milliseconds) between the dialing of digits. This timer is restarted every time a digit is dialed. Expiration of this timer indicates End of Dialing. 15000 2.0
InterDigitTimerOpen unsignedInt(1:50000) W

This timer is the maximum allowable time (expressed in milliseconds) between the dialing of digits once the minimum number of digits defined on a prefix based has been reached.

This timer is only applicable to “open numbering”, where the exact number of digits for a prefix is not known.

3000 2.0
TerminationDigit string(:1) W Digit that can be used by the subscriber to indicate that dialing has completed.

2.0
InvalidNumberTone string(:256) W

The tone that tells the user when the number dialed is determined to be invalid.

The value MUST be the Path Name of a row in the Tone.Description. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
PrefixInfoMaxEntries unsignedInt R This is the maximum number of instances of CallControl.NumberingPlan.{i}.PrefixInfo.{i}. that can be supported. - 2.0
PrefixInfoNumberOfEntries unsignedInt R Indicates the number of instances of CallControl.NumberingPlan.{i}.PrefixInfo.{i}.. - 2.0
VoiceService.{i}.CallControl.NumberingPlan.{i}.PrefixInfo.{i}. object(0:) W

Each entry in this table contains information related to an individual prefix in the NumberingPlan.

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, CallControl.NumberingPlan.{i}.PrefixInfoMaxEntries and CallControl.NumberingPlan.{i}.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 Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
PrefixRange string(:42) W

This is a string representation of a range of prefixes. Each prefix consists of a From part consisting of 1 to n digits (string representation) followed by an OPTIONAL To part consisting of exactly one digit prefixed by a “-” symbol.

All characters in the “From” and “To” parts of the prefix range MUST be “0-9”, “*” or “#”.

A further constraint is that the “To” digit MUST always be numerically greater than the last digit of the “From” part.

Examples:

02
031-5
032
0325
*#34
#22
<Empty> 2.0
PrefixMinNumberOfDigits unsignedInt(1:40) W

This is the minimum number of allowable digits for the prefix range. Once the minimum number of digits has been reached, InterDigitTimerOpen will be used instead of InterDigitTimerStd.

If the minimum number of digits has been reached and the inter-digit timer expires, an outgoing request is initiated.

1 2.0
PrefixMaxNumberOfDigits unsignedInt(1:40) W This is the maximum number of allowable digits for the prefix range. Once the number of digits received reaches this value an outgoing request is initiated. 1 2.0
NumberOfDigitsToRemove unsignedInt(0:40) W

If this parameter has a non-zero value, the specified number of digits will be removed from the internal digit buffer (which contains the dialed digits) from the position specified by PosOfDigitsToRemove.

Subsequently a search of PrefixInfo for a matching prefix using the modified number is performed. Note that this parameter does not have any impact on the number sent in the outgoing request: it is used only for searching within the Numbering Plan.

This parameter has no effect if it is set to 0.

This parameter is provided to handle Carrier override and other codes used as prefix to standard numbers and to ensure that the correct End of Dialing can be specified without significant data duplication.

0 2.0
PosOfDigitsToRemove unsignedInt(0:40) W This parameter is used in conjunction with NumberOfDigitsToRemove. It specifies the position within the internal digit buffer from which the digits are to be removed. 0 2.0
DialTone string(:256) W

The tone to be played by the VoIP device when the user has dialed exactly the same digits as defined in the prefix. The VoIP device will cease playing the tone once an additional digit has been dialed.

The value MUST be the Path Name of a row in the Tone.Description. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
FacilityAction string(:64) W

The value MUST be a member of the list reported by the Capabilities.FacilityActions parameter, or else be an empty string. This is a string representing a Facility Action implemented by the VoIP device.

The parameter MAY instead indicate a vendor-specific Facility Action, which MUST use the format defined in [TR-106].

When an empty string or the value is an unrecognized string (i.e. a Facility Action not supported by the CPE) normal outgoing requests are made.

<Empty> 2.0
FacilityActionArgument string(:256) W Optional argument associated with FacilityAction. The interpretation of the argument is dependent on a specific value of FacilityAction. The value MUST be the Path Name of a row in the CallControl.Line., CallControl.Extension. or CallControl.Mailbox. tables. <Empty> 2.0
VoiceService.{i}.CallControl.CallingFeatures. object R This object models the calling features that can be apply on CallControl.Line or CallControl.Extension. - 2.0
SetNumberOfEntries unsignedInt R The number of entries in the Set table. - 2.0
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}. object(0:) W

This object models a set of calling features that can be applied in CallControl.Line. or CallControl.Extension. objects.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CallerIDEnable boolean W Enable or disable the transmission of caller ID information on incoming calls (CLIP). - 2.0
CallerIDNameEnable boolean W Enable or disable the transmission of caller ID name information on incoming calls (CNIP). - 2.0
CallWaitingEnable boolean W

Enables or disables call waiting in the Endpoint.

This parameter SHOULD NOT be present if the CPE does not support Endpoint managed call waiting.

- 2.0
CallForwardUnconditionalEnable boolean W

Enables or disables unconditional call forwarding by the endpoint.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.

- 2.0
CallForwardUnconditionalNumber string(:32) W

Directory number to which all incoming calls to this line are forwarded when CallForwardUnconditionalEnable is true.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding

- 2.0
CallForwardOnBusyEnable boolean W

Enables or disables call forwarding-on-busy by the Endpoint.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.

- 2.0
CallForwardOnBusyNumber string(:32) W

Directory number to which all incoming calls to this line are forwarded when CallForwardOnBusyEnable is true and the line is busy.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.

- 2.0
CallForwardOnBusyRingTimeout unsignedInt W

Delay in seconds before considering there is no answer for call forwarding-on-busy.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.

- 2.0
CallForwardOnNoAnswerEnable boolean W

Enables or disables call forwarding-on-no-answer by the Endpoint.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.

- 2.0
CallForwardOnNoAnswerNumber string(:32) W

Directory number to which all incoming calls to this line are forwarded when CallForwardOnNoAnswerEnable is true and there is no local answer.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.

- 2.0
CallForwardOnNoAnswerRingTimeout unsignedInt W

Delay in seconds before considering there is no answer for call forwarding-on-no-answer.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call forwarding.

- 2.0
CallTransferEnable boolean W

Enables or disables call transfer by the Endpoint.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based call transfer.

- 2.0
MWIEnable boolean W

Enables or disables Message Waiting Indication by the Endpoint.

This parameter SHOULD NOT be present if the CPE does not support MWI.

- 2.0
VMWIEnable boolean W Enables or disables Visual Message Waiting Indication. - 2.0
LineMessagesWaiting unsignedInt R

Indicates the number of messages which are currently waiting on this line as known by the CPE.

This parameter SHOULD NOT be present if the CPE does not support MWI.

- 2.0
AnonymousCallRejectionEnable boolean W

Enable or disable Anonymous Call Block capability in the endpoint (ACR).

This parameter SHOULD NOT be present if the CPE does not support endpoint based Anonymous Call Block capability.

- 2.0
AnonymousCallEnable boolean W

Enable or disable Anonymous Call capability in the endpoint (CLIR).

This parameter SHOULD NOT be present if the CPE does not support endpoint based Anonymous Call capability.

- 2.0
DoNotDisturbEnable boolean W

Enable or disable Do Not Disturb capability in the Endpoint. When enabled, all calls are forwarded to voice mail.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based Do Not Disturb capability.

- 2.0
RepeatDialEnable boolean W

Enable or disable Repeat Dial capability in the Endpoint.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based Repeat Dial capability.

- 2.0
VoiceMailEnable boolean W

Enable or disable Voice Mail capability in the Endpoint.

This parameter SHOULD NOT be present if the CPE does not support Endpoint based Voice Mail capability.

- 2.0
CallPickUpEnable boolean W Enable or disable Call Interception capability in the Endpoint. - 2.0
CCBSEnable boolean W Enable or disable automatic recall on busy (Completion of Calls to Busy Subscriber) capability in the Endpoint. - 2.0
IIFCEnable boolean W Enable or disable successive forwarding (Inhibition of Incoming Forwarded Calls) from the Endpoint. - 2.0
BlockForwardEnable boolean W Allow or block any internal forward to the Endpoint. - 2.0
SecretForwarderEnable boolean W

Enable or disable secret identity of this Endpoint in case it initiates (on an external incoming call) a forward to another internal phone Endpoint.

If enabled, only the remote caller party can be identified (if not anonymous), not this intermediate via phone extension.

- 2.0
FollowMeEnable boolean W Enable or disable FollowMe capability in the Endpoint. - 2.0
CFTNumberOfEntries unsignedInt R The number of entries in the CFT table. - 2.0
SCFNumberOfEntries unsignedInt R The number of entries in the SCF table. - 2.0
SCREJNumberOfEntries unsignedInt R The number of entries in the SCREJ table. - 2.0
FollowMeNumberOfEntries unsignedInt R The number of entries in the FollowMe table. - 2.0
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.CFT.{i}. object(0:) W

This object defines a Call Forwarding Timed (CFT) that permit the user to forward calls to particular destinations depending on the time of day.

Note: a bad configuration (e.g. timeslots overlapping) could cause unexpected behavior.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Whether this schedule is currently enabled. - 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Day string W

Day where the schedule active.

Enumeration of:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
  • All (For all days schedule)
- 2.0
StartTime string(:5) W Start time of the schedule in the form : hh:mm. - 2.0
EndTime string(:5) W End time of the schedule in the form : hh:mm. - 2.0
ForwardedToNumber string(:32) W Number to forward the call to. - 2.0
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.SCF.{i}. object(0:) W

This object defines a Selective Call Forwarding (SCF) that permit the user to forward calls to different destinations depending on the calling number.

At most one entry in this table can exist with a given value for CallingNumber, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for CallingNumber and Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this Selective Call Forward. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CallingNumber string(:32) W

Calling number concerned by the forward.

The CPE SHOULD perform an exact match with this string without any attempts at number normalization.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

- 2.0
ForwardedToNumber string(:32) W Number to forward the call to. - 2.0
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.SCREJ.{i}. object(0:) W

This object defines a Selective Call Rejection (SCREJ) that permit the user to selectively reject calls depending on the calling number.

At most one entry in this table can exist with a given value for CallingNumber, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for CallingNumber and Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this Selective Call Rejection. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CallingNumber string(:32) W

Calling number concerned by the reject.

The CPE SHOULD perform an exact match with this string without any attempts at number normalization.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

- 2.0
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.FollowMe.{i}. object(0:) W

This object defines the FollowMe destinations mapping definition, in the provided sequence order.

At most one entry in this table can exist with a given value for Alias, or with the same values for both Number and Order. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Number and Order such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this FollowMe sequence item. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Delay unsignedInt W Delay in seconds before next FollowMe sequence item applies. - 2.0
Number string(:32) W

Directory number to which all incoming calls to this line are forwarded to after Delay, when FollowMeEnable is true. In this case, CallForwardOnNoAnswerNumber is not used.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Order) doesn’t conflict with any existing entries.

- 2.0
Order unsignedInt W

For a given Number, defines the order of this item in the FollowMe sequence.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that (together with Number) doesn’t conflict with any existing entries.

- 2.0
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.Voice2Mail. object R Voice to mail specific attributes. Applies only if VoiceMailEnable is set to true. - 2.0
Enable boolean W Enable or disable voice mail notification. - 2.0
MaxMessageLength unsignedInt W Defines the maximum amount of time in seconds of an incoming message. Use this when there are many users and disk space is limited. A value of 0 means there will be no maximum time limit enforced. - 2.0
Attach boolean W Indicates if the message is sent as an attachment in voice mail notification. - 2.0
KeepLocal boolean W Whether the voice to mail message is kept on the CPE after sending the mail. Applicable only if Attach is true. - 2.0
EMailAddress string W E-mail for voice to mail notification messages. - 2.0
VoiceService.{i}.Interwork.{i}. object(0:) W

Each entry in this table configures Inter-Working Function switching features.

It is mutually exclusive with the CallControl object which is used in case of PBX or Endpoint capabilities.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable this Interwork instance. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Interwork is disabled. - 2.0
Status string R

Indicates the status of this Interwork instance.

Enumeration of:

  • Up
  • Error
  • Quiescent
  • Disabled
Disabled 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
OperationalStatus string R

Indicates the operational status of the Interwork connections when Status is Up. Enumeration of:

  • InService (Indicates the Interwork is operational)
  • OutOfService (Indicates the Interwork is not operational)
  • NetworkServersOffline (Indicates the Interwork has lost connection to all of the Network servers)
OutOfService 2.0
OperationalStatusReason string(:256) R Human-readable string identifying the reason or explanation for the current OperationalStatus. - 2.0
NetworkConnectionMode string W

This parameter indicates whether or not the CPE supports a registration procedure that conveys its signaling IP address:port to the network. This parameter also indicates whether the network-facing Client object and its parameters are statically provisioned by the ACS or dynamically created by the CPE. Enumeration of:

  • Static (The CPE does not register toward the service provider network. The ACS creates the Client object and statically provisions the Client parameters, including the signaling address)
  • RegisterDynamic (The CPE registers toward the service provider network. The ACS creates the Client object and statically provisions its parameters, excluding the signaling address which is dynamically assigned by the CPE)
  • RegisterLearn (The CPE registers toward the service provider network. The CPE creates the Client object and dynamically assigns its signaling address)
  • RegisterStatic (The CPE registers toward the service provider network. The ACS creates the Client object and statically provisions the Client parameters, including the signaling address)
- 2.0
UserConnectionMode string W

This parameter indicates whether or not an externally connected user device supports a registration procedure to convey its signaling address to the CPE. This parameter also indicates whether the user-facing objects and parameters that contain the external user device signaling address are statically provisioned by the ACS or dynamically learned by the CPE. Enumeration of:

  • Static (The external user device does not register with the CPE. The ACS creates the object containing the signaling address of the externally connected user device and statically configures the signaling address of the user device)
  • RegisterDynamic (The externally connected user device registers with the CPE. The ACS creates the object that contains the signaling address of the external user device. The CPE sets the signaling address learned when the user device registers)
  • RegisterLearn (The externally connected user device registers with the CPE. The CPE dynamically creates the object that contains the signaling address of the external user device and sets the signaling address learned when the user device registers)
- 2.0
E164Mode boolean W This attribute indicates whether or not the CPE performs E.164 routing of incoming requests received from the service provider network when the target Endpoint is a PBX. - 2.0
NetworkAuthenticationChallengeMode string W

This parameter indicates how the CPE treats authentication challenges received from the service provider network. This parameter only has meaning when the CPE supports an externally connected user device (e.g., the CPE is acting as a gateway between the user device and the network). Enumeration of:

  • PassThru (The CPE transparently passes authentication challenges and challenge responses between the service provider network and the external user device)
  • RespondLocal (The CPE responds to authentication challenges received from the service provider network on behalf of the externally connected user device. The CPE does not send authentication challenges to the externally connected user device)
  • Hop-by-Hop (The CPE responds to authentication challenges received from the service provider network on behalf of the externally connected user device. In addition, the CPE generates authentication challenges toward the externally connected user device)
- 2.0
NetworkIPAddress string(:45) R

[IPAddress] The network IP Address of the CPE. The CPE MUST resolve this when the Interwork.{i}. object is created.

Note: In case of multiple network IP addresses, the choice is left to the CPE.

- 2.0
InterworkingRuleSetURI string(:256) W URI of the Interworking Rule Set for this Interwork instance. - 2.0
InterworkingRuleSetInterval unsignedInt W

The duration in seconds of the interval for which the CPE SHOULD send request to refresh the Interworking Rule Set.

A value of ‘0’ indicates that this feature is disabled.

- 2.0
InterworkingRuleSetTime dateTime W

An absolute time reference in UTC to determine when the CPE will send a request to refresh the Interworking Rule Set. Each refresh request MUST occur at this reference time plus or minus an integer multiple of the InterworkingRuleSetInterval.

InterworkingRuleSetTime is used only to set the phase of refresh requests. The actual value of InterworkingRuleSetTime can be arbitrarily far into the past or future.

For example, if InterworkingRuleSetInterval is 86400 (a day) and if InterworkingRuleSetTime is set to UTC midnight on some day (in the past, present, or future) then the refresh requests will occur every day at UTC midnight. These MUST begin on the very next midnight, even if InterworkingRuleSetTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified InterworkingRuleSetInterval.

If absolute time is not available to the CPE, its behavior MUST be the same as if the InterworkingRuleSetTime parameter was set to the Unknown Time value.

- 2.0
FirewallRuleSetURI string(:256) W URI of the Firewall Rule Set for this Interwork instance. - 2.0
FirewallRuleSetInterval unsignedInt W

The duration in seconds of the interval for which the CPE SHOULD send request to refresh the Firewall Rule Set.

A value of ‘0’ indicates that this feature is disabled.

- 2.0
FirewallRuleSetTime dateTime W

An absolute time reference in UTC to determine when the CPE will send a request to refresh the Firewall Rule Set. Each refresh request MUST occur at this reference time plus or minus an integer multiple of the FirewallRuleSetInterval.

FirewallRuleSetTime is used only to set the phase of refresh requests. The actual value of FirewallRuleSetTime can be arbitrarily far into the past or future.

For example, if FirewallRuleSetInterval is 86400 (a day) and if FirewallRuleSetTime is set to UTC midnight on some day (in the past, present, or future) then the refresh requests will occur every day at UTC midnight. These MUST begin on the very next midnight, even if FirewallRuleSetTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified FirewallRuleSetInterval.

If absolute time is not available to the CPE, its behavior MUST be the same as if the FirewallRuleSetTime parameter was set to the Unknown Time value.

- 2.0
InterworkName string(:256) W Human-readable string identifying the name or explanation for this Interwork. - 2.0
ProxyServer string(:256) W Reference to the SIP.Proxy associated with this Interwork. The value MUST be the Path Name of a row in the SIP.Proxy. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
Networks string[] W

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the SIP.Network. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

List of available Networks for routing calls.

- 2.0
E164Client string(:256) W The value MUST be the Path Name of a row in the SIP.Client. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter is MUST contain the SIP.Client for all Trunk objects referenced in the Map table when E164Mode = true. - 2.0
UserInterfaceNumberOfEntries unsignedInt R The number of entries in the UserInterface table. - 2.0
MapNumberOfEntries unsignedInt R The number of entries in the Map table. - 2.0
VoiceService.{i}.Interwork.{i}.UserInterface.{i}. object(0:) W

Each table entry references a row in the SIP.Registrar table to identify the User IP address and listening port for the Device and the Network to route calls to.

At most one entry in this table can exist with a given value for Alias, or with a given value for Registrar. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Registrar such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable (true) or disable (false) UserInterface. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Registrar string(:256) W

The SIP.Registrar to use with this Interwork. The value of Registrar MUST be unique over all Interwork.{i}..

The value MUST be the Path Name of a row in the SIP.Registrar. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

- 2.0
Network string(:256) W

If not null this provides the appropriate SIP.Network to route calls from this User server to.

The value MUST be the Path Name of a row in the SIP.Network. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
VoiceService.{i}.Interwork.{i}.Map.{i}. object(0:) W

For interworking use cases such as SIP-ISDN PBX plug and ESBC : mapping instance between a Network interface and a User extension.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable (true) or disable (false) this connection mapping. false 2.0
Status string R

Indicates the status of this connection mapping. Enumeration of:

  • Active (indicates the Map is valid)
  • InActive (indicates the Map is valid but either the Network or User connection is not operational)
InActive 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
StatusDescription string(:256) R Human-readable string identifying the reason or explanation of the current mapping Status. - 2.0
LastTime dateTime R The last time the Status was updated. - 2.0
Origin string R

Mechanism via which this connection mapping was assigned. Enumeration of:

  • AutoConfigured (Automatically generated, for example by a ESBC that auto-creates User and Network connections)
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
Static 2.0
NetworkConnection string(:256) W The value MUST be the Path Name of a row in the Trunk., SIP.Client., MGCP.Client., H323.Client. or POTS.FXO. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.. This parameter can only be modified if Origin is Static. - 2.0
UserConnection string(:256) W The value MUST be the Path Name of a row in the Trunk., ISDN.BRI., ISDN.PRI., SIP.Registrar.{i}.Account., POTS.FXS., DECT.Portable., DECT.Base. or Terminal. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.. This parameter can only be modified if Origin is Static. - 2.0
DigitMap string(:256) W

Digit map controlling digit collection on a User interface. The string defines the criteria to be met as digits are collected before an outgoing request (e.g., a SIP INVITE) can be initiated.

The syntax of this parameter is exactly the syntax used by MGCP as defined in [Section 2.1.5/RFC3435].

This parameter is applicable only if the User interface supports per digit dialing and the Network interface supports en-bloc dialing only.

<Empty> 2.0
DigitMapEnable boolean W Enables use of DigitMap. true 2.0
Priority unsignedInt(1:) W Indicates the priority for this combination of Network-to-User mapping, where 1 is the highest priority. Where the priority differs between entries in this table, the CPE SHOULD use the highest priority (lowest numbered) entry. Where the priorities are equal among multiple entries, the CPE MAY apply a local criterion for choosing among them. - 2.0
VoiceService.{i}.CallLog.{i}. object(0:) R

This table contains a list of calls. An entry is similar to a CDR (Call Detail Record) as used in PBX or on mobile phones.

An entry is created each time a call is terminated. If the number of {{object: argument unnecessary when referring to current object}} exceeds Capabilities.MaxCallLogCount, the CPE SHOULD remove the oldest {{object: argument unnecessary when referring to current object}} object on basis of Start parameter.

At most one entry in this table can exist with a given value for Alias.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
CallingPartyNumber string(:256) R Number of the party originating the call. - 2.0
CalledPartyNumber string(:256) R Number of destination party of the call. - 2.0
Source string(:256) R

Party originating the call.

The value MUST be the Path Name of a row in the CallControl.Line., CallControl.Extension., SIP.Registrar.{i}.Account., Trunk. or SIP.Client. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.

Trunk, SIP.Registrar.{i}.Account and SIP.Client objects SHOULD be referenced only when Interwork is in use.

- 2.0
Destination string(:256) R

Destination party of the call.

The value MUST be the Path Name of a row in the CallControl.Line., CallControl.Extension., SIP.Registrar.{i}.Account., Trunk. or SIP.Client. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.

Trunk, SIP.Registrar.{i}.Account and SIP.Client objects SHOULD be only referenced only when Interwork is in use.

- 2.0
RemoteParty string(:32) R The phone number of the remote party after the dial plan has been processed. - 2.0
UsedLine string(:256) R

The CallControl.Line used to process the call.

The value MUST be the Path Name of a row in the CallControl.Line. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

When Interwork is in use, this parameter is an empty string.

- 2.0
UsedExtensions string[] R

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the CallControl.Extension. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

For an incoming call multiple CallControl.Extension objects can be involved till one user answers the call.

When Interwork is in use, this parameter is an empty string.

- 2.0
Direction string R

Direction of the call.

Enumeration of:

  • Incoming
  • Outgoing
- 2.0
Start dateTime R Start of the call. - 2.0
Duration unsignedInt R Length of the call in seconds. - 2.0
CallTerminationCause string R

The call termination cause.

The parameter MAY instead indicate a vendor-specific cause, which MUST use the format defined in [TR-106].

Enumeration of:

  • NoExtensionsMapped
  • NoExtensionsAvailable
  • AnonymousCallRejection
  • CallWaitingRejected
  • CallForwardingUnconditional
  • CallForwardingBusy
  • CallForwardingNoReply
  • LocalDisconnect
  • LocalForbidden
  • LocalTimeout
  • LocalMediaError.
  • LocalPriority.
  • LocalReject
  • LocalTransfer
  • LocalInternalError
  • RemoteDisconnect
  • RemoteBadRequest
  • RemoteForbidden
  • RemoteNotFound
  • RemoteReject
  • RemoteNotAllowed
  • RemoteNotAcceptable
  • RemoteTimeout
  • RemoteUnavailable
  • RemoteBusy
  • RemoteNotSupported
  • RemoteNetworkFailure
- 2.0
SessionNumberOfEntries unsignedInt R Indicates the number of entries in CallLog.{i}.Session.{i}.. Sessions are the equivalent of RTP streams in VoIP calls : a call can have more than one session in sequence when codec changes happen during a call. In multimedia calls, multiple sessions in parallel are possible. - 2.0
SignalingPerformanceNumberOfEntries unsignedInt R The number of entries in the SignalingPerformance table. - 2.0
VoiceService.{i}.CallLog.{i}.SignalingPerformance.{i}. object(1:) R

This table contains signaling performance statistics for each protocol involved in the call.

This table MUST contain at least 1 entry.

At most one entry in this table can exist with a given value for Protocol.

- 2.0
Protocol string R

Protocol for which this signaling performance statistics are available.

Enumeration of:

  • H.323
  • SIP
- 2.0
CallSetupDelay unsignedInt R The time between the instant a system receives a call attempt and the instant of invitation of ringing at the call receiver end instrument in milliseconds. - 2.0
OutgoingMediaEstablishDelay int R

The time in milliseconds between :

  • the instant a system has received information that the called party is connected
  • the instant the first media packet goes out the CPE

The value could be negative if a media packet is sent before the connection establishment.

- 2.0
IncomingMediaEstablishDelay int R

The time in milliseconds between :

  • the instant a system has received information that the called party is connected
  • the instant the first media packet goes into the CPE

The value could be negative if a media packet arrives before the connection establishment.

- 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}. object(0:) R

Session information within one call.

At most one entry in this table can exist with a given value for SessionID.

- 2.0
StreamType string R

The type of media stream used in this session.

Enumeration of:

  • Audio
  • Video
  • Fax
  • Modem
- 2.0
Start dateTime R The time that the session started, in UTC. - 2.0
Duration unsignedInt R Length of the session in seconds. - 2.0
SessionID string(:16) R Session Identifier. For the SIP protocol this corresponds to the SIP SDP session identifier. - 2.0
SIPSessionID string(:32) R SIP Session Identifier - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Source. object R The source of the session information within one call. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.RTP. object R The RTP part of the source session information. - 2.0
FarEndIPAddress string(:45) R [IPAddress] The IP address of far end VoIP device. - 2.0
FarEndUDPPort unsignedInt(0:65535) R The UDP port used for current session in the far end device. - 2.0
LocalUDPPort unsignedInt(0:65535) R The local UDP port used for current session. - 2.0
RTCPCNAME string(:16) R A unique identifier provided in RTCP by the destination. - 2.0.3
MinJitter int(-1:) R

The minimum relative transit time in milliseconds between two packets as defined in [RFC3611].

A value of -1 indicates no reliable value is available.

- 2.0
MaxJitter int(-1:) R

The maximum relative transit time in milliseconds between two packets as defined in [RFC3611].

A value of -1 indicates no reliable value is available.

- 2.0
MeanJitter int(-1:) R

The mean relative transit time in milliseconds between each two packet series as defined in [RFC3611].

A value of -1 indicates no reliable value is available.

- 2.0
PacketDelayVariation int(-1:) R

1-Point Packet Delay Variation according to [Y.1540] in milliseconds.

A value of -1 indicates no reliable value is available.

- 2.0
BufferDelay int(-1:) R

Average delay in microseconds added by buffer processing.

A value of -1 indicates no reliable value is available.

- 2.0
BurstCount unsignedInt R

[StatsCounter32] The number of bursts (as defined in [RFC3611]) that occur during this session (during one burst several packets MAY be lost).

The burst’s threshold is configured with the parameter VoIPProfile.{i}.RTP.Gmin.

- 2.0
PacketsReceived unsignedLong R [StatsCounter64] Total number of RTP packets received for this session. - 2.0
PacketsSent unsignedLong R [StatsCounter64] Total number of RTP packets sent for this session. - 2.0
PacketsLost unsignedInt R [StatsCounter32] Total number of RTP packets that have been lost for this session (see [RFC3611]). - 2.0
PacketsDiscarded unsignedInt R [StatsCounter32] Total number of RTP packets that have been discarded for this session (see [RFC3611]). - 2.0
DuplicatePacketsReceived unsignedLong R [StatsCounter64] Total number of duplicate RTP packets that have been received for this session. Note: duplicate packets are often the result of network configuration errors. - 2.0.3
BytesReceived unsignedLong R [StatsCounter64] Total number of bytes received for this session. - 2.0
BytesSent unsignedLong R [StatsCounter64] Total number of bytes sent for this session. - 2.0
ReceivePacketLossRate unsignedInt(0:100) R

Current receive packet loss rate in percent, calculated as defined in [Section 6.4/RFC3550].

Value Change Notification requests for this parameter MAY be denied.

- 2.0
FarEndPacketLossRate unsignedInt(0:100) R

Current far end receive packet lost rate in percent, calculated as defined in [Section 6.4/RFC3550].

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ReceiveInterarrivalJitter int(-1:) R

Current receive interarrival jitter in timestamp units. Calculated from J(i) as defined in [Section 6.4/RFC3550].

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
FarEndInterarrivalJitter int(-1:) R

Current Interarrival jitter in timestamp units as reported from the far-end device via RTCP. Calculated from J(i) as defined in [Section 6.4/RFC3550].

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
AverageReceiveInterarrivalJitter int(-1:) R

Average receive interarrival jitter in timestamp units since the beginning of the current call. Calculated as the average of the interarrival jitter values reported by the far-end.

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
AverageFarEndInterarrivalJitter int(-1:) R

Average far-end interarrival jitter in timestamp units since the beginning of the current call. Calculated as the average of the interarrival jitter values reported by the far-end.

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
RoundTripDelay int(-1:) R

Current round trip delay in microseconds calculated as defined in [Section 6.4/RFC3550].

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
AverageRoundTripDelay int(-1:) R

Average round trip delay in microseconds since the beginning of the current session.

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
SamplingFrequency unsignedInt R

Sample frequency in Hertz used by the codec for this session.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP. object R The DSP part of the line session information. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.ReceiveCodec. object R The receive codec used in this session. - 2.0
Codec string(:256) R

The codec in use for the incoming voice stream.

The value MUST be the Path Name of a row in the Capabilities.Codec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
SilenceSuppression boolean R Whether or not silence suppression is in use for the incoming voice stream. - 2.0
Overruns unsignedInt R Total number of times the receive jitter buffer has overrun for this session. - 2.0
Underruns unsignedInt R Total number of times the receive jitter buffer has underrun for this session. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.TransmitCodec. object R The transmit codec used in this session. - 2.0
Codec string(:256) R

The codec in use for the outgoing voice stream.

The value MUST be the Path Name of a row in the Capabilities.Codec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
SilenceSuppression boolean R Whether or not silence suppression is in use for the outgoing voice stream. - 2.0
PacketizationPeriod unsignedInt R Current outgoing packetization period in milliseconds. - 2.0
Overruns unsignedInt R Total number of times the transmit jitter buffer has overrun for this session. - 2.0
Underruns unsignedInt R Total number of times the transmit jitter buffer has underrun for this session. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.VoiceQuality. object R VoIP Statistics for current session instance. - 2.0
VoIPQualityIndicator unsignedInt(:65535)[] R

Comma-separated list of unsigned integers (up to 65535), representing the VoIP quality calculated for consecutive intervals of the session. The interval is specified by VoIPProfile.{i}.QICalculationInterval and the quality model used is specified by VoIPProfile.{i}.QIModelUsed.

The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last.

For long sessions the number of values might exceed the limit given by Capabilities.QualityIndicator.MaxQIValues. In that case, the CPE MUST remove the oldest values to keep the number of reported values within the limit.

The interpretation of the QI values are algorithm-specific, the only constraints being the range and the fact that lower values indicate worse quality than do higher values.

For instance, if VoIPQualityIndicator is reported as “78,57,88,79,34,56”, and VoIPProfile.{i}.QICalculationInterval is 10 seconds, the quality during the first ten seconds was 78, the next ten seconds 57, and so on. The last reported value (here 56) might cover a shorter time period than VoIPProfile.{i}.QICalculationInterval, but the length can be deduced using Duration.

- 2.0
WorstVoIPQualityIndicatorsValues unsignedInt(:65535)[] R

Comma-separated list of unsigned integers (up to 65535), representing the worst VoIP quality indicators calculated during the whole session.

Only the N worst values are stored, where N is the limit stored in the VoIPProfile.{i}.NumberOfWorstQIValues attribute.

The values are given in the same algorithm-specific representation as VoIPQualityIndicator, and MUST be in quality-order with the lowest value first.

Example: “34,56,57” are the 3 worst values calculated during the call.

- 2.0
WorstVoIPQualityIndicatorTimestamps unsignedInt(:65535)[] R

Comma-separated list of unsigned integers (up to 65535). Each value represents the timestamp index, given in units of VoIPProfile.{i}.QICalculationInterval, when the corresponding value in WorstVoIPQualityIndicatorsValues was calculated.

The first index is number 1.

Only the N worst values are stored, where N is the limit stored in VoIPProfile.{i}.NumberOfWorstQIValues.

Example: if VoIPProfile.{i}.QICalculationInterval is equal to 10 (seconds), the value “6,2,5” designates the time intervals 50-60 s, 10-20 s, and 40-50 s when the 3 worst values were calculated.

- 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination. object R The destination part of session information within one call. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.RTP. object R The RTP part of the destination session information. - 2.0
FarEndIPAddress string(:45) R [IPAddress] The IP address of far end VoIP device. - 2.0
FarEndUDPPort unsignedInt(0:65535) R The UDP port used for current session in the far end device. - 2.0
LocalUDPPort unsignedInt(0:65535) R The local UDP port used for current session. - 2.0
RTCPCNAME string(:16) R A unique identifier provided in RTCP by the destination. - 2.0.3
MinJitter int(-1:) R

The minimum relative transit time in milliseconds between two packets as defined in [RFC3611].

A value of -1 indicates no reliable value is available.

- 2.0
MaxJitter int(-1:) R

The maximum relative transit time in milliseconds between two packets as defined in [RFC3611].

A value of -1 indicates no reliable value is available.

- 2.0
MeanJitter int(-1:) R

The mean relative transit time in milliseconds between each two packet series as defined in [RFC3611].

A value of -1 indicates no reliable value is available.

- 2.0
PacketDelayVariation int(-1:) R

1-Point Packet Delay Variation according to [Y.1540] in milliseconds.

A value of -1 indicates no reliable value is available.

- 2.0
BufferDelay int(-1:) R

Average delay in microseconds added by buffer processing.

A value of -1 indicates no reliable value is available.

- 2.0
BurstCount unsignedInt R

[StatsCounter32] The number of bursts (as defined in [RFC3611]) that occur during this session (during one burst several packets MAY be lost).

The burst’s threshold is configured with the parameter VoIPProfile.{i}.RTP.Gmin.

- 2.0
PacketsReceived unsignedLong R [StatsCounter64] Total number of RTP packets received for this session. - 2.0
PacketsSent unsignedLong R [StatsCounter64] Total number of RTP packets sent for this session. - 2.0
PacketsLost unsignedInt R [StatsCounter32] Total number of RTP packets that have been lost for this session (see [RFC3611]). - 2.0
PacketsDiscarded unsignedInt R [StatsCounter32] Total number of RTP packets that have been discarded for this session (see [RFC3611]). - 2.0
DuplicatePacketsReceived unsignedLong R [StatsCounter64] Total number of duplicate RTP packets that have been received for this session. Note: duplicate packets are often the result of network configuration errors. - 2.0.3
BytesReceived unsignedLong R [StatsCounter64] Total number of bytes received for this session. - 2.0
BytesSent unsignedLong R [StatsCounter64] Total number of bytes sent for this session. - 2.0
ReceivePacketLossRate unsignedInt(0:100) R

Current receive packet loss rate in percent, calculated as defined in [Section 6.4/RFC3550].

Value Change Notification requests for this parameter MAY be denied.

- 2.0
FarEndPacketLossRate unsignedInt(0:100) R

Current far end receive packet lost rate in percent, calculated as defined in [Section 6.4/RFC3550].

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ReceiveInterarrivalJitter int(-1:) R

Current receive interarrival jitter in timestamp units. Calculated from J(i) as defined in [Section 6.4/RFC3550].

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
FarEndInterarrivalJitter int(-1:) R

Current Interarrival jitter in timestamp units as reported from the far-end device via RTCP. Calculated from J(i) as defined in [Section 6.4/RFC3550].

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
AverageReceiveInterarrivalJitter int(-1:) R

Average receive interarrival jitter in timestamp units since the beginning of the current call. Calculated as the average of the interarrival jitter values reported by the far-end.

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
AverageFarEndInterarrivalJitter int(-1:) R

Average far-end interarrival jitter in timestamp units since the beginning of the current call. Calculated as the average of the interarrival jitter values reported by the far-end.

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
RoundTripDelay int(-1:) R

Current round trip delay in microseconds calculated as defined in [Section 6.4/RFC3550].

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
AverageRoundTripDelay int(-1:) R

Average round trip delay in microseconds since the beginning of the current session.

A value of -1 indicates no reliable value is available.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
SamplingFrequency unsignedInt R

Sample frequency in Hertz used by the codec for this session.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP. object R The DSP part of the destination session information. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.ReceiveCodec. object R The receive codec used in this session. - 2.0
Codec string(:256) R

The codec in use for the incoming voice stream.

The value MUST be the Path Name of a row in the Capabilities.Codec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
SilenceSuppression boolean R Whether or not silence suppression is in use for the incoming voice stream. - 2.0
Overruns unsignedInt R Total number of times the receive jitter buffer has overrun for this session. - 2.0
Underruns unsignedInt R Total number of times the receive jitter buffer has underrun for this session. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.TransmitCodec. object R The transmit codec used in this session. - 2.0
Codec string(:256) R

The codec in use for the outgoing voice stream.

The value MUST be the Path Name of a row in the Capabilities.Codec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
SilenceSuppression boolean R Whether or not silence suppression is in use for the outgoing voice stream. - 2.0
PacketizationPeriod unsignedInt R Current outgoing packetization period in milliseconds. - 2.0
Overruns unsignedInt R Total number of times the transmit jitter buffer has overrun for this session. - 2.0
Underruns unsignedInt R Total number of times the transmit jitter buffer has underrun for this session. - 2.0
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.VoiceQuality. object R VoIP Statistics for current session instance. - 2.0
VoIPQualityIndicator unsignedInt(:65535)[] R

Comma-separated list of unsigned integers (up to 65535), representing the VoIP quality calculated for consecutive intervals of the session. The interval is specified by VoIPProfile.{i}.QICalculationInterval and the quality model used is specified by VoIPProfile.{i}.QIModelUsed.

The statistics values in this list MUST be in time order, with the oldest one first and the most recent one last.

For long sessions the number of values might exceed the limit given by Capabilities.QualityIndicator.MaxQIValues. In that case, the CPE MUST remove the oldest values to keep the number of reported values within the limit.

The interpretation of the QI values are algorithm-specific, the only constraints being the numeric range and the fact that lower values indicate worse quality than do higher values.

For instance, if VoIPQualityIndicator is reported as “78,57,88,79,34,56”, and VoIPProfile.{i}.QICalculationInterval is 10 seconds, the quality during the first ten seconds was 78, the next ten seconds 57, and so on. The last reported value (here 56) might cover a shorter time period than VoIPProfile.{i}.QICalculationInterval, but the length can be deduced using Duration.

- 2.0
WorstVoIPQualityIndicatorsValues unsignedInt(:65535)[] R

Comma-separated list of unsigned integers (up to 65535), representing the worst VoIP quality indicators calculated during the whole session.

Only the N worst values are stored, where N is the limit stored in the VoIPProfile.{i}.NumberOfWorstQIValues attribute.

The values are given in the same algorithm-specific representation as VoIPQualityIndicator, and MUST be in quality-order with the lowest value first.

Example: “34,56,57” are the 3 worst values calculated during the call.

- 2.0
WorstVoIPQualityIndicatorTimestamps unsignedInt(:65535)[] R

Comma-separated list of unsigned integers (up to 65535). Each value represents the timestamp index, given in units of VoIPProfile.{i}.QICalculationInterval, when the corresponding value in WorstVoIPQualityIndicatorsValues was calculated.

The first index is number 1.

Only the N worst values are stored, where N is the limit stored in VoIPProfile.{i}.NumberOfWorstQIValues.

Example: if VoIPProfile.{i}.QICalculationInterval is equal to 10 (seconds), the value “6,2,5” designates the time intervals 50-60 s, 10-20 s, and 40-50 s when the 3 worst values were calculated.

- 2.0
VoiceService.{i}.VoIPProfile.{i}. object(0:) W

Configuration profile that can be shared by VoIP components.

A VoIP Profile contains media transport configuration parameters that are common to different VoIP protocols.

VoIP Profiles could be used by SIP.Network., SIP.Proxy., SIP.Network., H323.Network. and MGCP.Network..

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this VoIP profile. If the value is set to false, all components using the profile are disabled, whatever their status is. false 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the VoIPProfile is disabled. - 2.0
Name string(:64) W Human-readable string to identify the profile instance. <Empty> 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
DTMFMethod string[] W

Comma-separated list of strings. Method by which DTMF digits MUST be passed. Each list item is an enumeration of:

If DTMFMethodG711 is non-empty, then this parameter applies only when the current codec is not G.711.

InBand 2.0
DTMFMethodG711 string W

Method by which DTMF digits MUST be passed if the the current codec is G.711. Enumeration of:

  • InBand
  • RFC4733
  • SIPInfo (Applicable only for SIP.Client.{i}.)
  • <Empty> (an empty string)

If an empty string indicates that the value of DTMFMethod is to apply whether or not the the the current codec is G.711.

<Empty> 2.0
QIModelUsed string(:128) W Quality model which the CPE shall use to calculate the parameters CallLog.{i}.Session.{i}.Source.VoiceQuality.VoIPQualityIndicator and CallLog.{i}.Session.{i}.Destination.VoiceQuality.VoIPQualityIndicator. The value MUST be a member of the list reported by the Capabilities.QualityIndicator.QIModelsSupported parameter. - 2.0
QICalculationInterval unsignedInt W The interval between successive calculations of CallLog.{i}.Session.{i}.Source.VoiceQuality.VoIPQualityIndicator and CallLog.{i}.Session.{i}.Destination.VoiceQuality.VoIPQualityIndicator values (in seconds). If QICalculationInterval is not set then only one final quality value covering the complete session is reported in CallLog.{i}.Session.{i}.Source.VoiceQuality.VoIPQualityIndicator and CallLog.{i}.Session.{i}.Destination.VoiceQuality.VoIPQualityIndicator. - 2.0
NumberOfWorstQIValues unsignedInt W

The maximum number of worst quality indicators to store for each call.

The CPE MUST permit NumberOfWorstQIValues to be set to any value in the range from 0 to Capabilities.QualityIndicator.MaxWorstQIValues.

- 2.0
VoiceService.{i}.VoIPProfile.{i}.RTP. object R VoIP profile parameters related to the voice stream sent via RTP. - 2.0
LocalPortMin unsignedInt(1:65535) W Base of port range to be used for incoming RTP streams for this profile. 1024 2.0
LocalPortMax unsignedInt(1:65535) W Top of port range to be used for incoming RTP streams for this profile. 1024 2.0
Gmin unsignedInt(1:255) W Minimum number of consecutive received packets after the end of an RTP Loss Event. A Loss Event is defined as as a sequence of lost or discarded packets, possibly including islands of received packets. Each island consists of up to (Gmin - 1) received packets (a sequence of Gmin received packets terminates the Loss Event, and so is not an island). 16 2.0
DSCPMark unsignedInt(0:63) W Diffserv code point to be used for outgoing RTP and RTCP packets for this profile. It is RECOMMENDED that by default the DSCP for RTP traffic be set to the value to indicate EF traffic. - 2.0
VLANIDMark int(-1:) W

VLAN ID (as defined in [802.1Q-2005]) to be used for outgoing RTP packets for this profile. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
EthernetPriorityMark int(-1:) W

Ethernet priority code (as defined in [802.1D-2004]) to be used for outgoing RTP packets for this profile. A value of -1 indicates the default value is to be used.

If either VLANIDMark or EthernetPriorityMark is greater than zero, then the outgoing frames MUST be tagged. Otherwise, the outgoing frames MAY be tagged or untagged.

-1 2.0
TelephoneEventPayloadType unsignedInt(0:128) W

Payload type to be used for RTP telephone events.

This parameter indicates the payload type to be used for DTMF events if transmission of DTMF information is in use according to [RFC4733].

- 2.0
JitterBufferType string W

The indicates if the jitte buffer is static or dynamic.

Enumeration of:

  • Static
  • Dynamic
- 2.0
JitterBufferMaxSize unsignedInt W Maximal (or static) jitter buffer size in milliseconds. - 2.0
JitterBufferMinSize unsignedInt W Minimal jitter buffer size in milliseconds, not used if static buffer is used. - 2.0
JitterBufferActualSize unsignedInt W Actual jitter buffer size in milliseconds, if static buffer ist used equal to JitterBufferMaxSize. - 2.0
VoiceService.{i}.VoIPProfile.{i}.RTP.RTCP. object R VoIP profile parameters related to RTCP. - 2.0
Enable boolean W Enable or disable RTCP. - 2.0
TxRepeatInterval unsignedInt(1:) W Transmission repeat interval, in milliseconds. - 2.0
LocalCName string(:64) W Local Cname (canonical name). - 2.0
VoiceService.{i}.VoIPProfile.{i}.RTP.SRTP. object R VoIP profile parameters for secure voice transmission via SRTP. - 2.0
Enable boolean W

Enable or disable the use of SRTP.

If RTCP is enabled, a true value of this parameter also implies the use of SRTCP.

- 2.0
KeyingMethods string[] W

Comma-separated list of strings, available keying methods. Each list item is an enumeration of:

  • Null
  • Static
  • SDP
  • IKE
- 2.0
EncryptionKeySizes unsignedInt[] W Comma-separated list of unsigned integers, available encryption key sizes. - 2.0
VoiceService.{i}.VoIPProfile.{i}.RTP.Redundancy. object R VoIP profile parameters for RTP payload redundancy as defined by [RFC2198]. - 2.0
Enable boolean W Enable or disable the use of RTP payload redundancy as defined by [RFC2198]. false 2.0
PayloadType unsignedInt(0:127) W The Payload Type of RTP packet as defined in [RFC2198]. Values SHOULD be within the range of dynamic Payload Types (96-127). 0 2.0
BlockPayloadType unsignedInt(0:127) R Block Payload Type of redundancy packet. 0 2.0
FaxAndModemRedundancy int(-1:5) W

Specifies the redundancy number for fax and modem pass-through data transmissions.

A non-negative value indicates that [RFC2198] is to be used for fax and modem pass-through data. The value indicates the number of redundant copies to be transmitted (the total number transmitted is one plus this value).

A value of -1 indicates [RFC2198] is not to be used for fax and modem pass-through data.

If ModemRedundancy is present, then FaxAndModemRedundancy applies only to fax transmissions, but not to modem transmissions.

-1 2.0
ModemRedundancy int(-1:5) W

Specifies the redundancy number for modem pass-through data transmissions.

A non-negative value indicates that [RFC2198] is to be used for modem pass-through data. The value indicates the number of redundant copies to be transmitted (the total number transmitted is one plus this value).

A value of -1 indicates [RFC2198] is not to be used for modem pass-through data.

-1 2.0
DTMFRedundancy int(-1:5) W

Specifies the redundancy number for DTMF transmissions.

A non-negative value indicates that [RFC2198] is to be used for DTMF. The value indicates the number of redundant copies to be transmitted (the total number transmitted is one plus this value).

A value of -1 indicates [RFC2198] is not to be used for DTMF.

-1 2.0
VoiceRedundancy int(-1:5) W

Specifies the redundancy number for general voice transmissions.

A non-negative value indicates that [RFC2198] is to be used for voice. The value indicates the number of redundant copies to be transmitted (the total number transmitted is one plus this value).

A value of -1 indicates [RFC2198] is not to be used for voice.

-1 2.0
MaxSessionsUsingRedundancy unsignedInt W

The maximum number of sessions using [RFC2198] payload redundancy simultaneously in this profile.

A value of zero indicates no explicit limit on the number of sessions using redundancy.

0 2.0
VoiceService.{i}.VoIPProfile.{i}.FaxT38. object R T.38 Fax information for devices that support T.38 relay. - 2.0
MaxBitRate unsignedInt(0:65535) W Maximum data rate in bits per second for fax as defined in [T.38]. 14400 2.0
HighSpeedRedundancy unsignedInt(0:3) W Specifies the packet-level redundancy for high-speed data transmissions (i.e., T.4 image data). - 2.0
LowSpeedRedundancy unsignedInt(0:5) W Specifies the packet-level redundancy for low-speed data transmissions (i.e., T.30 handshaking information). - 2.0
TCFMethod string W

The method with which data is handled over the network.

Enumeration of:

  • Local
  • Network
- 2.0
VoiceService.{i}.CodecProfile.{i}. object(0:) W

Table of codec profiles. This table MUST be populated with the set of supported codecs matching Capabilities.Codec.. Additional entries can be added to use different configurations of codec or to use the same codec configuration in different CodecList parameters.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enable or disable the use of this combination of codec parameters. - 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Codec string(:256) R The value MUST be the Path Name of a row in the Capabilities.Codec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
PacketizationPeriod string(:64)[] W

Comma-separated list of strings (maximum number of characters per item 64). Each item is a supported packetization period, in milliseconds, or continuous ranges of packetization periods as defined in Capabilities.Codec.{i}.PacketizationPeriod.

The ACS MAY restrict the set of packetization periods by modifying the value of this parameter to a more restricted set of values than is listed in Capabilities.Codec.{i}.PacketizationPeriod. The CPE MUST ignore any values or portions of ranges outside of those specified in Capabilities.Codec.{i}.PacketizationPeriod.

- 2.0
SilenceSuppression boolean W Indicates support for silence suppression for this codec. If silence suppression is supported, it can be disabled for this codec/bit-rate by setting this parameter to false. - 2.0
VoiceService.{i}.Tone. object R This object defines the contents of the tones and announcements generated locally by the VoIP device. - 2.0
DescriptionNumberOfEntries unsignedInt R The number of entries in the Description table. - 2.0
PatternNumberOfEntries unsignedInt R The number of entries in the Pattern table. - 2.0
EventProfileNumberOfEntries unsignedInt R The number of entries in the EventProfile table. - 2.0
DefautEventProfile string(:256) W
The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the default tone event profile.
This parameter was DEPRECATED in 2.0.3 due to a typo in its name. Use DefaultEventProfile instead.
- 2.0
DefaultEventProfile string(:256) W The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the default tone event profile. - 2.0.3
VoiceService.{i}.Tone.Description.{i}. object(0:) W

Each entry in this table defines the contents of an individual tone.

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 Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
ToneEnable boolean W Enables or disables the tone entry. If a disabled tone entry is referenced, the result is that no tone is played. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ToneName string(:64) W Name of the tone. <Empty> 2.0
TonePattern string(:256) W

This is the Pattern.{i}. object that begins this tone. If the tone is specified by a tone file instead of a tone pattern, this parameter MUST be set to an empty string.

The value MUST be the Path Name of a row in the Pattern. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
ToneFile string(:256) W

The file name of a tone file locally present on the CPE.

An ACS MUST use the Download method with FileType=“4 Tone File” as defined in [Annex A.3.2.8/TR-069a4] to download a tone file.

If the tone is specified by a tone pattern instead of a tone file, this parameter MUST be an empty string.

<Empty> 2.0
ToneRepetitions unsignedInt(0:255) W The default number of times the data in ToneFile is repeated. If the value is 0 (zero) then ToneFile is played indefinitely. 0 2.0
ToneText string(:64) W

The text to be displayed by on the screen of the VoIP device when the tone is played and no specific error message has been provided.

This parameter is applicable only for VoIP devices capable text display.

<Empty> 2.0
VoiceService.{i}.Tone.Pattern.{i}. object(0:) 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.

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 Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ToneOn boolean W Whether or not a tone is on during this phase of the pattern. If the value is false, the frequency and power parameters in this entry MUST be ignored. false 2.0
Frequency1 unsignedInt(0:4095) W

First tone frequency in hertz.

A value of zero indicates this tone component is not used.

0 2.0
Power1 int W First tone power level in units of 0.1 dBm0. 0 2.0
Frequency2 unsignedInt(0:4095) W

Second tone frequency in hertz.

A value of zero indicates this tone component is not used.

0 2.0
Power2 int W Second tone power level in units of 0.1 dBm0. 0 2.0
Frequency3 unsignedInt(0:4095) W

Third tone frequency in hertz.

A value of zero indicates this tone component is not used.

0 2.0
Power3 int W Third tone power level in units of 0.1 dBm0. 0 2.0
Frequency4 unsignedInt(0:4095) W

Fourth tone frequency in herts.

A value of zero indicates this tone component is not used.

0 2.0
Power4 int W Fourth tone power level in units of 0.1 dBm0. 0 2.0
ModulationFrequency unsignedInt(0:4095) W

Modulation frequency in hertz.

A value of zero indicates this tone component is not used.

0 2.0
ModulationPower int W Modulation power level in units of 0.1 dBm0. 0 2.0
Duration unsignedInt W

The duration of this phase of the tone pattern, in milliseconds.

A value of zero indicates an unlimited duration.

0 2.0
NextPattern string(:256) W

The Pattern for the next phase of the tone pattern, after the specified Duration of this phase has completed.

The value MUST be the Path Name of a row in the Pattern. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

An empty string indicates that the tone pattern is to terminate after the current phase is completed.

- 2.0
VoiceService.{i}.Tone.EventProfile.{i}. object(0:) W

Configuration profile for tone events.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
EventNumberOfEntries unsignedInt R The number of entries in the Event table. - 2.0
VoiceService.{i}.Tone.EventProfile.{i}.Event.{i}. object(0:) W

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.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Function string W

The event for which the tone is to apply. Enumeration of:

  • Busy
  • Confirmation
  • Dial
  • LineMessagesWaiting
  • OffHookWarning
  • RingBack
  • ReOrder
  • Stutterdial
  • CallWaiting1
  • CallWaiting2
  • CallWaiting3
  • CallWaiting4
  • AlertingSignal
  • SpecialDial
  • SpecialInfo
  • Release
  • Congestion
  • UserDefined1
  • UserDefined2
  • UserDefined3
  • UserDefined4

The parameter MAY instead indicate a vendor-specific event name, which MUST use the format defined in [TR-106].

- 2.0
Tone string(:256) W

The description for the tone to be associated with the given event.

The value MUST be the Path Name of a row in the Tone.Description. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

An empty string indicates no tone is to be played for this event.

- 2.0
VoiceService.{i}.Terminal.{i}. object(1:) R

This object models a telephony terminal, each object in the table represents an end-user interface.

This object has to be used when the CPE is a voice endpoint itself.

This table MUST contain at least 1 entry.

At most one entry in this table can exist with a given value for Alias.

- 2.0
Enable boolean W Enables or disables this terminal. - 2.0
QuiescentMode boolean W If true, when Enable is set to false in-progress sessions remain intact, but no new sessions are allowed. When all sessions are terminated, the Terminal is disabled. - 2.0
Status string R

Indicates the status of this terminal.

Enumeration of:

  • Up
  • Initializing
  • Registering
  • Unregistering
  • Error
  • Testing
  • Quiescent
  • Disabled
- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ToneEventProfile string(:256) W The value MUST be the Path Name of a row in the Tone.EventProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the Tone.EventProfile to use with this terminal. If this parameter is an empty string, the value of Tone.DefaultEventProfile is used instead. - 2.0
AudioNumberOfEntries unsignedInt R The number of entries in the Audio table. - 2.0
DiagTests() command - [ASYNC] This command provides access to an Terminal Diag tests. - 2.0
⇒ Input. arguments - Input arguments. -
TestSelector string W

Indicates which test to perform.

The parameter MAY instead indicate a vendor-specific test, which MUST use the format defined in [TR-106]. For example:

“X_EXAMPLE-COM_MyTest”

Enumeration of:

  • RingingTest
- 2.0
⇐ Output. arguments - Output arguments. -
Status string R

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other If the value of this parameter is anything other than Complete, the values of the other results parameters for this test are indeterminate.
- 2.0
PhoneRinging boolean R Indicates whether or not the phone associated with this port is ringing. This parameter is applicable only if RingingTest is supported. - 2.0
VoiceService.{i}.Terminal.{i}.Audio.{i}. object(1:) R

This object models the audio outputs of a telephony terminal.(ex. Handset, handsfree, …)

This table MUST contain at least 1 entry.

At most one entry in this table can exist with a given value for Alias.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Name string(:256) W The internal name of this audio. - 2.0
VoiceService.{i}.Terminal.{i}.Audio.{i}.VoiceProcessing. object R Parameters related to voice processing capabilities. - 2.0
TransmitGain int W Gain in 0.1 dB to apply to the transmitted voice signal prior to encoding. This gain is a modifier of the default transmit-gain, which is unspecified. - 2.0
ReceiveGain int W Gain in 0.1 dB to apply to the received voice signal after decoding. This gain is a modifier of the default receive-gain, which is unspecified. - 2.0
EchoCancellationEnable boolean W Enable or disable echo cancellation for this line. - 2.0
EchoCancellationInUse boolean R Indication of whether or not echo cancellation is currently in use for this line. - 2.0
EchoCancellationTail unsignedInt R Tail length in milliseconds of the echo canceller associated with this line (whether or not it is currently in use). - 2.0
VoiceService.{i}.Terminal.{i}.ButtonMap. object R

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.

- 2.0
ButtonNumberOfEntries unsignedInt R The number of entries in the Button table. - 2.0
VoiceService.{i}.Terminal.{i}.ButtonMap.Button.{i}. object(1:) R

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.

This table MUST contain at least 1 entry.

At most one entry in this table can exist with a given value for Alias.

- 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
ButtonName string(:16) R Name of the button. - 2.0
FacilityAction string(:64) W

The value MUST be a member of the list reported by the Capabilities.FacilityActions parameter, or else be an empty string. The value MUST be a member of the list reported by Capabilities.FacilityActions. This is an OPTIONAL parameter that SHOULD NOT be specified for buttons not related to a particular Facility Action (e.g., invocation of Call Return) implemented by the VoIP device.

The parameter MAY instead indicate a vendor-specific Facility Action, which MUST use the format defined in [TR-106].

An empty or unrecognized string (i.e. a Facility Action not supported by the CPE) means that there is no Facility Action to be taken.

If this parameter is specified (not an empty string) then QuickDialNumber SHOULD be an empty string.

- 2.0
FacilityActionArgument string(:256) W Optional argument associated with the specified FacilityAction. The interpretation of the argument is dependent on the specific FacilityAction. - 2.0
QuickDialNumber string(:40) W

This is a string representing a quick dial destination number. Only the characters ‘0-9’, ‘*’ and ‘#’ can be used.

If this parameter is specified (not an empty string) then FacilityAction SHOULD be an empty string.

- 2.0
ButtonMessage string(:64) W This string represents the message to be displayed on the screen when the button or function key is pressed. - 2.0
UserAccess boolean W This parameter indicates whether the user has permission to program the button or function key. If this parameter is set to true then FacilityAction, QuickDialNumber and ButtonMessage MUST all be an empty string. - 2.0
VoiceService.{i}.Terminal.{i}.Ringer. object R This object defines the ring sequences that may be generated by the terminal. - 2.0
DescriptionNumberOfEntries unsignedInt R The number of entries in the Description table. - 2.0
PatternNumberOfEntries unsignedInt R The number of entries in the Pattern table. - 2.0
VoiceService.{i}.Terminal.{i}.Ringer.Description.{i}. object(0:) W

Each entry in this table defines the contents of an individual ring specification.

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 Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
RingEnable boolean W Enables or disables the ring description entry. If a disabled ring description entry is referenced, the result is that no ring is played. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
RingName string(:64) W Name of the ring. <Empty> 2.0
RingPattern string(:256) W

This is the Pattern.{i}. object that begins this ring. If the ring is specified by a ring file instead of a ring pattern, this parameter MUST be set to an empty string.

The value MUST be the Path Name of a row in the Pattern. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
RingFile string(:256) W

The file name of a ring file file locally present on the CPE.

An ACS MUST use the Download method with FileType=“5 Ringer File” as defined in [Annex A.3.2.8/TR-069a4] to download a ring file.

If the ring is specified by a ring pattern instead of a ring file, this parameter MUST be an empty string.

<Empty> 2.0
VoiceService.{i}.Terminal.{i}.Ringer.Pattern.{i}. object(0:) 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.

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 Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables this entry. false 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
RingerOn boolean W Whether or not a ringer is on during this phase of the pattern. false 2.0
Duration unsignedInt W

The duration of this phase of the ring pattern, in milliseconds.

A value of zero indicates an unlimited duration.

0 2.0
NextPattern string(:256) W

The Pattern for the next phase of the ring pattern, after the specified Duration of this phase has completed.

The value MUST be the Path Name of a row in the Pattern. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

An empty string indicates that the ring pattern is to terminate after the current phase is completed.

- 2.0
VoiceService.{i}.ClockSynchronization. object R Clock source configuration for Time-Division multiplexing subsystem. - 2.0
ClockSourceNumberOfEntries unsignedInt R The number of entries in the ClockSource table. - 2.0
CurrentSource string(:256) W

The currently selected external clock source. If the current clock source is not selected from the ClockSource table, e.g. an internal holdover clock, this parameter is set to an empty string.

The value MUST be the Path Name of a row in the ClockSynchronization.ClockSource. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0
Description string(:64) R Human readable description of the current clock synchronization status. - 2.0
AutoRevert boolean W If set to true the CPE automatically reverts back to a higher priority external clock source when it becomes available once again. If set to false, an automatic change between external clock sources only occurs when the current source becomes unavailable. - 2.0
VoiceService.{i}.ClockSynchronization.ClockSource.{i}. object(0:) R

List of eligible external clock sources. The number of entries in this table depends on the maximum number of external clock sources supported by the CPE.

At most one entry in this table can exist with a given value for Alias, or with a given value for Order, or with a given value for Interface.

- 2.0
Enable boolean W Enables or disables this entry. - 2.0
Alias string(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

Value Change Notification requests for this parameter MAY be denied.

- 2.0
Order unsignedInt(1:100) W Position of the ClockSource entry in the order of precedence. A value of “1” indicates the first entry considered (highest precedence). - 2.0
Interface string(:256) W

A reference to a physical interface from which a clock signal can be derived. ISDN.PRI.{i}. is eligible as a clock source when ISDN.PRI.{i}.ClockMode is Slave. ISDN.BRI.{i}. is eligible as a clock source when ISDN.BRI.{i}.ProtocolEmulation is TE.

The value MUST be the Path Name of a row in the ISDN.BRI. or ISDN.PRI. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.0

Notification Requirements

Parameters for which Value Change Notification MAY be Denied

Parameter
VoiceService.{i}.
Alias
CallLogNumberOfEntries
VoiceService.{i}.Capabilities.Codec.{i}.
Alias
VoiceService.{i}.ISDN.BRI.{i}.
Alias
VoiceService.{i}.ISDN.PRI.{i}.
Alias
VoiceService.{i}.POTS.FXO.{i}.
Alias
VoiceService.{i}.POTS.FXS.{i}.
Alias
VoiceService.{i}.POTS.Ringer.Event.{i}.
Alias
VoiceService.{i}.DECT.Base.{i}.
Alias
VoiceService.{i}.DECT.Base.{i}.Stats.
Handovers
HandoverFailures
ControlFieldErrors
PayloadFieldErrors
SyncFailures
VoiceService.{i}.DECT.Portable.{i}.
Alias
VoiceService.{i}.SIP.Client.{i}.
Alias
VoiceService.{i}.SIP.Client.{i}.Contact.{i}.
Alias
VoiceService.{i}.SIP.Client.{i}.EventSubscribe.{i}.
Alias
VoiceService.{i}.SIP.Network.{i}.
Alias
VoiceService.{i}.SIP.Network.{i}.FQDNServer.{i}.
Alias
VoiceService.{i}.SIP.Network.{i}.EventSubscribe.{i}.
Alias
VoiceService.{i}.SIP.Network.{i}.ResponseMap.{i}.
Alias
VoiceService.{i}.SIP.Proxy.{i}.
Alias
VoiceService.{i}.SIP.Registrar.{i}.
Alias
VoiceService.{i}.SIP.Registrar.{i}.Account.{i}.
Alias
VoiceService.{i}.SIP.Registrar.{i}.Account.{i}.Contact.{i}.
Alias
VoiceService.{i}.MGCP.Client.{i}.
Alias
VoiceService.{i}.MGCP.Network.{i}.
Alias
VoiceService.{i}.H323.Client.{i}.
Alias
VoiceService.{i}.H323.Network.{i}.
Alias
VoiceService.{i}.Trunk.{i}.
Alias
VoiceService.{i}.CallControl.Line.{i}.
Alias
VoiceService.{i}.CallControl.Line.{i}.Stats.IncomingCalls.
TotalCallTime
VoiceService.{i}.CallControl.Line.{i}.Stats.OutgoingCalls.
TotalCallTime
VoiceService.{i}.CallControl.Line.{i}.Stats.RTP.
PacketsReceived
PacketsSent
PacketsLost
BytesSent
BytesReceived
VoiceService.{i}.CallControl.Line.{i}.Stats.DSP.
Overruns
Underruns
VoiceService.{i}.CallControl.Extension.{i}.
Alias
VoiceService.{i}.CallControl.Extension.{i}.Stats.IncomingCalls.
TotalCallTime
VoiceService.{i}.CallControl.Extension.{i}.Stats.OutgoingCalls.
TotalCallTime
VoiceService.{i}.CallControl.Extension.{i}.Stats.RTP.
PacketsReceived
PacketsSent
PacketsLost
BytesSent
BytesReceived
VoiceService.{i}.CallControl.Extension.{i}.Stats.DSP.
Overruns
Underruns
VoiceService.{i}.CallControl.Group.{i}.
Alias
VoiceService.{i}.CallControl.Mailbox.{i}.
Alias
VoiceService.{i}.CallControl.IncomingMap.{i}.
Alias
VoiceService.{i}.CallControl.OutgoingMap.{i}.
Alias
VoiceService.{i}.CallControl.NumberingPlan.{i}.
Alias
VoiceService.{i}.CallControl.NumberingPlan.{i}.PrefixInfo.{i}.
Alias
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.
Alias
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.CFT.{i}.
Alias
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.SCF.{i}.
Alias
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.SCREJ.{i}.
Alias
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}.FollowMe.{i}.
Alias
VoiceService.{i}.Interwork.{i}.
Alias
VoiceService.{i}.Interwork.{i}.UserInterface.{i}.
Alias
VoiceService.{i}.Interwork.{i}.Map.{i}.
Alias
VoiceService.{i}.CallLog.{i}.
Alias
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.RTP.
ReceivePacketLossRate
FarEndPacketLossRate
ReceiveInterarrivalJitter
FarEndInterarrivalJitter
AverageReceiveInterarrivalJitter
AverageFarEndInterarrivalJitter
RoundTripDelay
AverageRoundTripDelay
SamplingFrequency
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.RTP.
ReceivePacketLossRate
FarEndPacketLossRate
ReceiveInterarrivalJitter
FarEndInterarrivalJitter
AverageReceiveInterarrivalJitter
AverageFarEndInterarrivalJitter
RoundTripDelay
AverageRoundTripDelay
SamplingFrequency
VoiceService.{i}.VoIPProfile.{i}.
Alias
VoiceService.{i}.CodecProfile.{i}.
Alias
VoiceService.{i}.Tone.Description.{i}.
Alias
VoiceService.{i}.Tone.Pattern.{i}.
Alias
VoiceService.{i}.Tone.EventProfile.{i}.
Alias
VoiceService.{i}.Tone.EventProfile.{i}.Event.{i}.
Alias
VoiceService.{i}.Terminal.{i}.
Alias
VoiceService.{i}.Terminal.{i}.Audio.{i}.
Alias
VoiceService.{i}.Terminal.{i}.ButtonMap.Button.{i}.
Alias
VoiceService.{i}.Terminal.{i}.Ringer.Description.{i}.
Alias
VoiceService.{i}.Terminal.{i}.Ringer.Pattern.{i}.
Alias
VoiceService.{i}.ClockSynchronization.ClockSource.{i}.
Alias

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

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.

Baseline:1 Profile

This table defines the Baseline:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceServiceNumberOfEntries R
VoiceService.{i}. P
CodecProfileNumberOfEntries R
VoiceService.{i}.Capabilities. P
NetworkConnectionModes R
UserConnectionModes R
CodecNumberOfEntries R
ToneFileFormats R
RingFileFormats R
FacilityActions R
VoiceService.{i}.Capabilities.Codec.{i}. P
Codec R
BitRate R
PacketizationPeriod R
SilenceSuppression R
VoiceService.{i}.Capabilities.QualityIndicator. P
MaxQIValues R
MaxWorstQIValues R
VoiceService.{i}.CodecProfile.{i}. P
Enable R
Alias W
Codec R
PacketizationPeriod R
SilenceSuppression R

ISDN:1 Profile

This table defines the ISDN:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.Capabilities.ISDN. P
MSN R
DDI R
MCID R
MWI R
AoC R
ECT R

ISDNBRI:1 Profile

The ISDNBRI:1 profile for the VoiceService:2 data model is defined as the union of the ISDN:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.ISDN. P
BRINumberOfEntries R
VoiceService.{i}.ISDN.BRI.{i}. P
Enable W
Status R
Name R
ApplicationInterface R
Protocol R
ProtocolEmulation R
PermanentLayer2 R
PermanentLayer1 R
LapdDisconnectionTimeout R
TEINegotiation R
StaticTEI R
LifeLineHold W
PowerSourceOne R
MaxNumBChannels R
InboundOnlyBChannels W
OutboundOnlyBChannels W
BidirectionalBChannels W

ISDNPRI:1 Profile

The ISDNPRI:1 profile for the VoiceService:2 data model is defined as the union of the ISDN:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.ISDN. P
PRINumberOfEntries R
VoiceService.{i}.ISDN.PRI.{i}. P
Enable W
Status R
Name R
ApplicationInterface R
Protocol R
ProtocolEmulation R
PermanentLayer2 R
Linecode R
ESF R
PhysicalInterfaceType R
MaxNumBChannels R
InboundOnlyBChannels W
OutboundOnlyBChannels W
BidirectionalBChannels W

POTS:1 Profile

This table defines the POTS:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement

POTSFXO:1 Profile

The POTSFXO:1 profile for the VoiceService:2 data model is defined as the union of the POTS:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.POTS. P
FXONumberOfEntries R
VoiceService.{i}.POTS.FXO.{i}. P
Enable W
Status R
Name R
SecondStepDialing R
TimeoutBeforeDialing R
RingingTimeout R
RingNumber R
OnHookMinDuration R

POTSFXS:1 Profile

The POTSFXS:1 profile for the VoiceService:2 data model is defined as the union of the POTS:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.POTS. P
FXSNumberOfEntries R
VoiceService.{i}.POTS.FXS.{i}. P
Enable W
Status R
Name R
Active R
VoiceService.{i}.POTS.Ringer. P
EventNumberOfEntries R

DECT:1 Profile

This table defines the DECT:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.DECT. P
BaseNumberOfEntries R
PortableNumberOfEntries R
VoiceService.{i}.DECT.Base.{i}. P
Enable W
Status R
Name R
Standard R
RFPI R
VoiceService.{i}.DECT.Portable.{i}. P
Enable W
Status R
CodecList W

VoIPProfile:1 Profile

This table defines the VoIPProfile:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}. P
VoIPProfileNumberOfEntries R
VoiceService.{i}.VoIPProfile.{i}. C
Enable W
Name W
DTMFMethod W
DTMFMethodG711 W
VoiceService.{i}.VoIPProfile.{i}.RTP. P
LocalPortMin W
LocalPortMax W
DSCPMark W
VLANIDMark W
EthernetPriorityMark W
TelephoneEventPayloadType W
JitterBufferType W
JitterBufferMaxSize W
JitterBufferMinSize W
JitterBufferActualSize W

SIPClient:1 Profile

The SIPClient:1 profile for the VoiceService:2 data model is defined as the union of the VoIPProfile:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.Capabilities.SIP.Client. P
Extensions R
URISchemes R
EventTypes R
TLSAuthenticationProtocols R
TLSAuthenticationKeySizes R
TLSEncryptionProtocols R
TLSEncryptionKeySizes R
TLSKeyExchangeProtocols R
VoiceService.{i}.SIP. P
ClientNumberOfEntries R
NetworkNumberOfEntries R
VoiceService.{i}.SIP.Client.{i}. C
Enable W
Status R
RegisterMode W
AuthUserName W
AuthPassword W
Network W
RegisterURI W
VoiceService.{i}.SIP.Network.{i}. C
ProxyServer W
ProxyServerPort W
ProxyServerTransport W
RegistrarServer W
RegistrarServerPort W
RegistrarServerTransport W
UserAgentDomain W
UserAgentPort W
UserAgentTransport W
OutboundProxy W
OutboundProxyResolvedAddress R
OutboundProxyPort W
STUNEnable W
STUNServer W
NonVoiceBandwidthReservedUpstream W
NonVoiceBandwidthReservedDownstream W
Organization W
RegistrationPeriod W
Realm W
TimerT1 W
TimerT2 W
TimerT4 W
TimerA W
TimerB W
TimerC W
TimerD W
TimerE W
TimerF W
TimerG W
TimerH W
TimerI W
TimerJ W
TimerK W
InviteExpires W
ReInviteExpires W
RegisterExpires W
RegisterRetryInterval W
InboundAuth W
InboundAuthUsername W
InboundAuthPassword W
UseCodecPriorityInSDPResponse W
DSCPMark W
VLANIDMark W
EthernetPriorityMark W
ConferenceCallDomainURI W
TimerLoginRejected W
NoLoginRetry W
TimerRegistrationFailed W
TimerSubscriptionFailed W
UnansweredRegistrationAttempts R
CodecList W
ResponseMapNumberOfEntries R
VoiceService.{i}.SIP.Network.{i}.ResponseMap.{i}. P
SIPResponseNumber W
Enable W
TextMessage W
Tone W

SIPRegistrar:1 Profile

The SIPRegistrar:1 profile for the VoiceService:2 data model is defined as the union of the VoIPProfile:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.Capabilities.SIP.Registrar. P
Extensions R
URISchemes R
EventTypes R
TLSAuthenticationProtocols R
TLSAuthenticationKeySizes R
TLSEncryptionProtocols R
TLSEncryptionKeySizes R
TLSKeyExchangeProtocols R
VoiceService.{i}.SIP. P
RegistrarNumberOfEntries R
VoiceService.{i}.SIP.Registrar.{i}. C
Enable W
Status R
Alias W
Origin R
RegistrarIPAddress W
RegistrarPort W
RegisterExpires W
Organization W
Realm W
VoIPProfile W
ContactURI R
AccountNumberOfEntries R
VoiceService.{i}.SIP.Registrar.{i}.Account.{i}. C
Enable W
Status R
Alias W
Origin R
AuthUserName W
AuthPassword W
RegistrationStatus R
URI W
Domain W
CodecList W
VoIPProfile W
ContactNumberOfEntries R
VoiceService.{i}.SIP.Registrar.{i}.Account.{i}.Contact.{i}. C
Enable W
Status R
Alias W
Origin R
IPAddress W
Port W
ContactURI W
ExpireTime R
UserAgent W

SIPProxy:1 Profile

The SIPProxy:1 profile for the VoiceService:2 data model is defined as the union of the VoIPProfile:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.SIP. P
ProxyNumberOfEntries R
VoiceService.{i}.SIP.Proxy.{i}. C
Enable W
Status R
Alias W
Origin R
ProxyIPAddress W
ProxyPort W
ContactURI R
VoIPProfile W

H323:1 Profile

The H323:1 profile for the VoiceService:2 data model is defined as the union of the VoIPProfile:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.Capabilities.H323. P
FastStart R
H235AuthenticationMethods R
VoiceService.{i}.H323. P
ClientNumberOfEntries R
NetworkNumberOfEntries R
VoiceService.{i}.H323.Client.{i}. C
Enable W
Status R
H235Authentication W
AuthPassword W
SendersID W
Network W
VoiceService.{i}.H323.Network.{i}. C
Gatekeeper W
GatekeeperPort W
GatekeeperID W
TimeToLive W
DSCPMark W
VLANIDMark W
EthernetPriorityMark W
STUNEnable W
STUNServer W
NonVoiceBandwidthReservedUpstream W
NonVoiceBandwidthReservedDownstream W
CodecList W

MGCP:1 Profile

The MGCP:1 profile for the VoiceService:2 data model is defined as the union of the VoIPProfile:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.Capabilities.MGCP. P
Extensions R
VoiceService.{i}.MGCP. P
ClientNumberOfEntries R
NetworkNumberOfEntries R
VoiceService.{i}.MGCP.Client.{i}. C
Enable W
Status R
RegisterMode W
LocalPort W
Domain W
User W
Network W
VoiceService.{i}.MGCP.Network.{i}. C
CallAgent1 W
CallAgentPort1 W
CallAgent2 W
CallAgentPort2 W
RetranIntervalTimer W
MaxRetranCount W
DSCPMark W
VLANIDMark W
EthernetPriorityMark W
AllowPiggybackEvents W
SendRSIPImmediately W
STUNEnable W
STUNServer W
NonVoiceBandwidthReservedUpstream W
NonVoiceBandwidthReservedDownstream W
CodecList W

CallControl:1 Profile

This table defines the CallControl:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}. P
CallLogNumberOfEntries R
VoiceService.{i}.Capabilities. P
MaxLineCount R
MaxSessionsPerLine R
MaxSessionsPerExtension R
MaxSessionCount R
VoiceService.{i}.CallControl. P
LineNumberOfEntries R
ExtensionNumberOfEntries R
IncomingMapNumberOfEntries R
OutgoingMapNumberOfEntries R
NumberingPlanNumberOfEntries R
VoiceService.{i}.CallControl.Line.{i}. C
Enable W
Status R
Alias W
CallStatus R
Origin R
DirectoryNumber W
Provider W
VoiceService.{i}.CallControl.Line.{i}.Stats. P
VoiceService.{i}.CallControl.Line.{i}.Stats.IncomingCalls. P
CallsReceived R
CallsConnected R
CallsFailed R
CallsDropped R
TotalCallTime R
VoiceService.{i}.CallControl.Line.{i}.Stats.OutgoingCalls. P
CallsAttempted R
CallsConnected R
CallsFailed R
CallsDropped R
TotalCallTime R
VoiceService.{i}.CallControl.Line.{i}.Stats.RTP. P
PacketsReceived R
PacketsSent R
PacketsLost R
BytesSent R
BytesReceived R
VoiceService.{i}.CallControl.Line.{i}.Stats.DSP. P
Overruns R
Underruns R
VoiceService.{i}.CallControl.Extension.{i}. C
Enable W
Status R
Alias W
CallStatus R
Origin R
ExtensionNumber W
Provider W
VoiceService.{i}.CallControl.Extension.{i}.Stats. P
VoiceService.{i}.CallControl.Extension.{i}.Stats.IncomingCalls. P
CallsReceived R
CallsConnected R
CallsFailed R
CallsDropped R
TotalCallTime R
VoiceService.{i}.CallControl.Extension.{i}.Stats.OutgoingCalls. P
CallsAttempted R
CallsConnected R
CallsFailed R
CallsDropped R
TotalCallTime R
VoiceService.{i}.CallControl.Extension.{i}.Stats.RTP. P
PacketsReceived R
PacketsSent R
PacketsLost R
BytesSent R
BytesReceived R
VoiceService.{i}.CallControl.Extension.{i}.Stats.DSP. P
Overruns R
Underruns R
VoiceService.{i}.CallControl.IncomingMap.{i}. C
Enable W
Line W
Extension W
Order W
Timeout W
VoiceService.{i}.CallControl.OutgoingMap.{i}. C
Enable W
CLIPNoScreeningNumber W
Extension W
Line W
Order W
VoiceService.{i}.CallLog.{i}. P
CallingPartyNumber R
CalledPartyNumber R
Source R
Destination R
RemoteParty R
UsedLine R
UsedExtensions R
Direction R
Start R
Duration R
CallTerminationCause R

CallingFeatures:1 Profile

The CallingFeatures:1 profile for the VoiceService:2 data model is defined as the union of the CallControl:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.CallControl.CallingFeatures. P
SetNumberOfEntries R
VoiceService.{i}.CallControl.CallingFeatures.Set.{i}. C
CallerIDEnable W
CallerIDNameEnable W
CallForwardUnconditionalEnable W
CallForwardUnconditionalNumber W
CallForwardOnBusyEnable W
CallForwardOnBusyNumber W
CallForwardOnBusyRingTimeout W
CallForwardOnNoAnswerEnable W
CallForwardOnNoAnswerNumber W
CallForwardOnNoAnswerRingTimeout W
MWIEnable W
AnonymousCallRejectionEnable W
AnonymousCallEnable W
IIFCEnable W

Interwork:1 Profile

This table defines the Interwork:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}. P
InterworkNumberOfEntries R
VoiceService.{i}.Interwork.{i}. C
Enable W
Status R
Alias W
NetworkConnectionMode W
UserConnectionMode W
E164Mode W
NetworkIPAddress R
ProxyServer W
Networks W
E164Client W
UserInterfaceNumberOfEntries R
MapNumberOfEntries R
VoiceService.{i}.Interwork.{i}.UserInterface.{i}. C
Enable W
Alias W
Registrar W
Network W
VoiceService.{i}.Interwork.{i}.Map.{i}. C
Enable W
Status R
Alias W
Origin R
NetworkConnection W
UserConnection W
DigitMap W
DigitMapEnable W
Priority W

Trunk:1 Profile

This table defines the Trunk:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}. P
TrunkNumberOfEntries R
VoiceService.{i}.Trunk.{i}. C
Name W
Enable W
Status R
DDIRange W
LineObjectCreation W
MaxOutboundChannelCount R
MaxInboundChannelCount R
MaxChannels W
CodecPriority W
Provider W

Terminal:1 Profile

This table defines the Terminal:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}. P
TerminalNumberOfEntries R
VoiceService.{i}.Terminal.{i}. P
Enable W
Status R
Alias W
VoiceService.{i}.Terminal.{i}.ButtonMap. P
ButtonNumberOfEntries R
VoiceService.{i}.Terminal.{i}.ButtonMap.Button.{i}. P
Alias W
ButtonName R
FacilityAction W
FacilityActionArgument W
QuickDialNumber W
ButtonMessage W
UserAccess W

CallStatistics:1 Profile

This table defines the CallStatistics:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}. P
CallLogNumberOfEntries R
VoiceService.{i}.CallLog.{i}. P
SessionNumberOfEntries R
VoiceService.{i}.CallLog.{i}.Session.{i}. P
StreamType R
Start R
Duration R
SessionID R
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.RTP. P
FarEndIPAddress R
FarEndUDPPort R
LocalUDPPort R
MinJitter R
MaxJitter R
MeanJitter R
BufferDelay R
BurstCount R
PacketsReceived R
PacketsLost R
PacketsDiscarded R
ReceiveInterarrivalJitter R
AverageReceiveInterarrivalJitter R
RoundTripDelay R
AverageRoundTripDelay R
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP. P
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.ReceiveCodec. P
Codec R
SilenceSuppression R
Overruns R
Underruns R
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.DSP.TransmitCodec. P
Codec R
SilenceSuppression R
PacketizationPeriod R
Overruns R
Underruns R
VoiceService.{i}.CallLog.{i}.Session.{i}.Source.VoiceQuality. P
VoIPQualityIndicator R
WorstVoIPQualityIndicatorsValues R
WorstVoIPQualityIndicatorTimestamps R
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.RTP. P
FarEndIPAddress R
FarEndUDPPort R
LocalUDPPort R
MinJitter R
MaxJitter R
MeanJitter R
BufferDelay R
BurstCount R
PacketsReceived R
PacketsLost R
PacketsDiscarded R
ReceiveInterarrivalJitter R
AverageReceiveInterarrivalJitter R
RoundTripDelay R
AverageRoundTripDelay R
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP. P
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.ReceiveCodec. P
Codec R
SilenceSuppression R
Overruns R
Underruns R
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.DSP.TransmitCodec. P
Codec R
SilenceSuppression R
PacketizationPeriod R
Overruns R
Underruns R
VoiceService.{i}.CallLog.{i}.Session.{i}.Destination.VoiceQuality. P
VoIPQualityIndicator R
WorstVoIPQualityIndicatorsValues R
WorstVoIPQualityIndicatorTimestamps R

ClockSynchronization:1 Profile

This table defines the ClockSynchronization:1 profile for the VoiceService:2 data model. The minimum REQUIRED version for this profile is VoiceService:2.0.

Name Requirement
VoiceService.{i}.ClockSynchronization. P
ClockSourceNumberOfEntries R
CurrentSource W
Description R
AutoRevert W
VoiceService.{i}.ClockSynchronization.ClockSource.{i}. P
Enable W
Order W
Interface W

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 09:51:41 UTC.
report.py –output –format markdown tr-104-2-0-1-usp.xml

Table of Contents